quarrel 0.0.1

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

@@ -0,0 +1,3 @@
+source "https://rubygems.org"
+
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Christian Bradley
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,29 @@
+# Quarrel
+
+Simple named parameters for Ruby
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'quarrel'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install quarrel
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,7 @@
+require "bundler/gem_tasks"
+
+task :default => [:test]
+task :test do
+  $LOAD_PATH.unshift "lib", "spec"
+  Dir.glob("./spec/**/*_spec.rb") { |f| require f }
+end

data/lib/quarrel/duck.rb

@@ -0,0 +1,7 @@
+module Quarrel
+  module Duck 
+    def self.symbolic? subject
+      subject.respond_to?(:to_sym) && subject.to_sym == subject
+    end
+  end
+end

data/lib/quarrel/iterator.rb

@@ -0,0 +1,27 @@
+module Quarrel
+
+  class Iterator
+    attr_reader :position
+
+    def initialize subject
+      @subject = subject
+      rewind
+    end
+
+    def rewind
+      @position = -1
+    end
+
+    def next?
+      position < @subject.size-1
+    end
+
+    def next
+      raise StopIteration, "Iteration reached an end" unless next?
+      @position += 1
+      @subject.at position
+    end
+
+  end
+
+end

data/lib/quarrel/parameter.rb

@@ -0,0 +1,78 @@
+require 'singleton'
+
+module Quarrel
+
+  module Parameter
+
+    class UnsetValue
+      include Singleton
+    end
+
+    def self.unset? value
+      value == UnsetValue.instance
+    end
+
+    def self.required name
+      Required.new name
+    end
+
+    def self.optional name
+      Optional.new name
+    end
+
+    def self.defaulted name, default
+      Defaulted.new name, default
+    end
+
+    module Base
+      attr_reader :name
+
+      def initialize name
+	@name = name
+      end
+
+      def apply data
+	data.has_key?(name) && set(data[name]) or unset
+      end
+
+      def set value
+	value
+      end
+
+      def unset 
+	nil
+      end
+
+    end
+
+    class Required
+      include Base
+
+      def unset
+	raise ArgumentError, "No value provided for required parameter :#{name}"
+      end
+    end
+
+    class Optional
+      include Base
+
+      def unset
+	UnsetValue.instance
+      end
+    end
+
+    class Defaulted
+      include Base
+
+      def initialize name, default
+	@name, @default = name, default
+      end
+
+      def unset
+	@default
+      end
+    end
+
+  end
+
+end

data/lib/quarrel/parser.rb

@@ -0,0 +1,51 @@
+require 'quarrel/duck'
+require 'quarrel/iterator'
+
+module Quarrel
+
+  class Parser
+
+    def self.parse words, factory
+      new(words, factory).parse
+    end
+
+    attr_reader :words, :factory
+
+    def initialize words, factory
+      @words = words
+      @factory = factory
+    end
+
+    def parse
+      i = Quarrel::Iterator.new @words
+      results = []
+
+      loop do
+	word = i.next
+
+	if Quarrel::Duck.symbolic?(word) && name = word[/^([a-z_]\w*)$/, 1]
+	  results << factory.required(name.to_sym)
+
+	elsif Quarrel::Duck.symbolic?(word) && name = word[/^([a-z_]\w*)\?$/, 1]
+	  results << factory.optional(name.to_sym)
+
+	elsif Quarrel::Duck.symbolic?(word) && name = word[/^([a-z_]\w*)\=$/, 1]
+	  raise SyntaxError,
+	    "Expected default value for :#{name} " +
+	  "at position #{i.position+1}: #{words.inspect}" unless i.next?
+
+	  results << factory.defaulted(name.to_sym, i.next)
+	else 
+	  raise SyntaxError,
+	    "Expected parameter specification at position #{i.position}, " +
+	    "got #{word.inspect}: #{words.inspect}"
+	end
+
+      end
+
+      results
+    end
+
+  end
+
+end

data/lib/quarrel/version.rb

@@ -0,0 +1,3 @@
+module Quarrel
+  VERSION = "0.0.1"
+end

data/lib/quarrel.rb

@@ -0,0 +1,50 @@
+require 'quarrel/version'
+require 'quarrel/parser'
+require 'quarrel/parameter'
+
+module Quarrel
+
+  def self.unset? value
+    Quarrel::Parameter.unset? value
+  end
+
+  def self.values data, *args
+    Quarrel::Controller.new(data, *args).values
+  end
+
+  def self.set_instance_variables target, data, *args
+    Quarrel::Controller.new(data, *args).set_instance_variables target
+  end
+
+  class Controller 
+    attr_reader :data, :args
+
+    def initialize data, *args
+      raise ArgumentError,
+	"Must provide one or more specifications for named parameters." if args.empty?
+      @data, @args = data, args
+    end
+
+    def params
+      Quarrel::Parser.parse(args, Quarrel::Parameter)
+    end
+
+    def values
+      params.each_with_object(data).map &:apply
+    end
+
+    def pairs
+      params.each_with_object(data).map do |param, data|
+	[param.name, param.apply(data)]
+      end
+    end
+
+    def set_instance_variables target
+      pairs.each do |(name, value)|
+	target.instance_variable_set :"@#{name}", value
+      end
+    end
+
+  end
+
+end

data/quarrel.gemspec

@@ -0,0 +1,24 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'quarrel/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "quarrel"
+  spec.version       = Quarrel::VERSION
+  spec.authors       = ["Christian Bradley"]
+  spec.email         = ["christianbradley@gmail.com"]
+  spec.description   = %q{Simple named parameters for ruby}
+  spec.summary       = %q{Simple named parameters for ruby}
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "mocha"
+end

data/spec/quarrel/duck_spec.rb

@@ -0,0 +1,11 @@
+require 'spec_helper'
+require 'quarrel/duck'
+
+describe "Duck" do
+
+  it "determines whether or not a value is symbolic" do
+    Quarrel::Duck.symbolic?(:foo?).must_equal true
+    Quarrel::Duck.symbolic?(":foo?").must_equal false
+  end
+
+end

data/spec/quarrel/iterator_spec.rb

@@ -0,0 +1,34 @@
+require 'spec_helper'
+require 'quarrel/iterator'
+
+describe "Iterator" do
+
+  let(:array) { %w(The rain in Spain) }
+  let(:iterator) { Quarrel::Iterator.new array }
+
+  subject { iterator }
+
+  it "retrieves the next value in the array" do
+    subject.next.must_equal "The"
+    subject.next.must_equal "rain"
+    subject.next.must_equal "in"
+    subject.next.must_equal "Spain"
+  end
+
+  it "knows whether or not there is a next value" do
+    assert subject.next?, "Must have a next value"
+    4.times { subject.next }
+    refute subject.next?, "Should not have a next value"
+  end
+
+  it "raises when it reaches the end" do
+    4.times { subject.next }
+    e = lambda { subject.next }.must_raise StopIteration
+  end
+
+  it "rewinds" do
+    4.times { subject.next }
+    subject.rewind
+    subject.next.must_equal "The"
+  end
+end

data/spec/quarrel/parameter_spec.rb

@@ -0,0 +1,38 @@
+require 'spec_helper'
+require 'quarrel/parameter'
+
+describe "Required Parameter" do
+
+  subject { Quarrel::Parameter.required :city }
+
+  it "sets the value from supplied data" do
+    subject.apply(:city => "Austin").must_equal "Austin"
+  end
+
+  it "can be set" do
+    subject.set("Austin").must_equal "Austin"
+  end
+
+  it "cannot be unset" do
+    e = lambda { subject.unset }.must_raise ArgumentError
+  end
+
+end
+
+describe "Optional Parameter" do
+
+  subject { Quarrel::Parameter.optional :city }
+
+  it "can be unset" do
+    Quarrel::Parameter.unset?(subject.unset).must_equal true
+  end
+
+end
+
+describe "Defaulted Parameter" do
+  subject { Quarrel::Parameter.defaulted :city, "Austin" }
+
+  it "uses the default value when unset" do
+    subject.unset.must_equal "Austin"
+  end
+end

data/spec/quarrel/parser_spec.rb

@@ -0,0 +1,42 @@
+require 'spec_helper'
+require 'quarrel/parser'
+
+describe "Parser" do
+  let(:city) { stub :city }
+  let(:state) { stub :state }
+  let(:zip) {  stub :zip }
+  let(:country) { stub :country }
+  let(:factory) { mock }
+  let(:words) { [:city, :state, :zip?, :country=, "US"] }
+  let(:parser) { Quarrel::Parser.new words, factory }
+
+  before do
+    factory.stubs(:required)
+    factory.stubs(:optional)
+    factory.stubs(:defaulted)
+  end
+
+  it "parses words into associated parameter types" do
+    factory.expects(:required).with(:city).returns city
+    factory.expects(:required).with(:state).returns state
+    factory.expects(:optional).with(:zip).returns zip
+    factory.expects(:defaulted).with(:country, "US").returns country
+    parser.parse.must_equal [city, state, zip, country]
+  end
+
+  describe "no default value provided" do
+    let(:words) { [:city, :state, :zip?, :country=] }
+
+    it "raises a syntax error" do
+      e = lambda { parser.parse }.must_raise SyntaxError
+    end
+  end
+
+  describe "invalid syntax" do
+    let(:words) { [:city, "some value", :state, :zip?] }
+    it "raises a syntax error" do
+      e = lambda { parser.parse }.must_raise SyntaxError
+    end
+  end
+
+end

data/spec/quarrel_spec.rb

@@ -0,0 +1,41 @@
+require 'spec_helper'
+require 'quarrel'
+
+describe "Quarrel" do
+
+  it "returns values from named parameters" do
+    city, state, zip, country = Quarrel.values({
+      :city => "Austin", :state => "TX", :zip => "78756"
+    }, :city, :state, :zip?, :country=, "US")
+
+    city.must_equal "Austin"
+    state.must_equal "TX"
+    zip.must_equal "78756"
+    country.must_equal "US"
+  end
+
+  it "sets instance variables from named parameters" do
+    instance = mock
+    instance.expects(:instance_variable_set).with(:@city, "Austin")
+    instance.expects(:instance_variable_set).with(:@state, "TX")
+    instance.expects(:instance_variable_set).with(:@zip, "78756")
+    instance.expects(:instance_variable_set).with(:@country, "US")
+
+    Quarrel.set_instance_variables(instance, {
+      :city => "Austin", :state => "TX", :zip => "78756"
+    }, :city, :state, :zip?, :country=, "US")
+  end
+
+  it "checks for unset values" do
+    city, state, zip, country = Quarrel.values({
+      :city => "Austin", :state => "TX"
+    }, :city, :state, :zip?, :country=, "US")
+
+    Quarrel.unset?(zip).must_equal true
+  end
+
+  it "raises when parameters are unspecified" do
+    e = lambda { Quarrel.values :foo => "bar" }.must_raise ArgumentError
+    e.message.must_equal "Must provide one or more specifications for named parameters."
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,3 @@
+require 'minitest/spec'
+require 'minitest/autorun'
+require 'mocha/setup'

metadata

@@ -0,0 +1,124 @@
+--- !ruby/object:Gem::Specification
+name: quarrel
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Christian Bradley
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-07-22 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: mocha
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Simple named parameters for ruby
+email:
+- christianbradley@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/quarrel.rb
+- lib/quarrel/duck.rb
+- lib/quarrel/iterator.rb
+- lib/quarrel/parameter.rb
+- lib/quarrel/parser.rb
+- lib/quarrel/version.rb
+- quarrel.gemspec
+- spec/quarrel/duck_spec.rb
+- spec/quarrel/iterator_spec.rb
+- spec/quarrel/parameter_spec.rb
+- spec/quarrel/parser_spec.rb
+- spec/quarrel_spec.rb
+- spec/spec_helper.rb
+homepage: ''
+licenses:
+- MIT
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: 1841157489760787547
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: 1841157489760787547
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.25
+signing_key: 
+specification_version: 3
+summary: Simple named parameters for ruby
+test_files:
+- spec/quarrel/duck_spec.rb
+- spec/quarrel/iterator_spec.rb
+- spec/quarrel/parameter_spec.rb
+- spec/quarrel/parser_spec.rb
+- spec/quarrel_spec.rb
+- spec/spec_helper.rb