options_hash-method_object 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: c905985693808cabd9a0925d45c76358664f666e
+  data.tar.gz: fb96dce849a0ff02ffd34d577b53f391e06b3bfc
+SHA512:
+  metadata.gz: 73d3e22e24591b6b2c12640a7c0867ddfb615caf8dcf3d40b61b95cdab2c5c50064f0aa1d68be0c06d7d1ed54048183ba0fa3e04580ee8ebb230c34bb4692bc6
+  data.tar.gz: f38eff8163adc3294aca7ace796b97301ed62cdf123ce0dbbc6631c22b9492255fdbe260be22eb655dc1d8e2d56331888fb54152ef4378921fb9665175f638dd

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/.rspec

@@ -0,0 +1,2 @@
+--color
+--format progress

data/.travis.yml

@@ -0,0 +1,12 @@
+language: ruby
+rvm:
+  - 2.0.0
+  - 1.9.3
+  - 1.9.2
+  - jruby-18mode
+  - jruby-19mode
+  - rbx-2.1.1
+  - ruby-head
+  - jruby-head
+  - 1.8.7
+  - ree

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in options_hash-method_object.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Jared Grippe
+
+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,58 @@
+# OptionsHash::MethodObject
+
+A MethodObject with an OptionsHash built in
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'options_hash-method_object'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install options_hash-method_object
+
+## Usage
+
+```ruby
+class CreatePerson < OptionsHash::MethodObject
+
+  required :name
+  optional :favorite_color, default: ->{ 'blue' }
+
+  def call
+    build_person!
+    validate_person!
+    create_person!
+    @person
+  end
+
+  def build_person!
+    @person = Person.new(options.to_hash)
+  end
+
+  def validate_person!
+    @person.valid? or raise 'invalid person'
+  end
+
+  def create_person!
+    @person.save!
+  end
+
+end
+
+```
+
+**For details about the `require` and `optional` methods see [OptionsHash](https://github.com/deadlyicon/options_hash)**
+
+## 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 @@
+require "bundler/gem_tasks"

data/lib/options_hash/method_object.rb

@@ -0,0 +1,54 @@
+require 'options_hash'
+
+class OptionsHash::MethodObject
+
+  VERSION = '0.0.1'
+
+  def self.inherited(subclass)
+    subclass.send :extend,  ClassMethods
+    subclass.send :include, InstanceMethods
+    subclass
+  end
+
+  module ClassMethods
+    def call options={}
+      new(options).call
+    end
+
+    def to_proc
+      method(:call).to_proc
+    end
+
+    def options
+      @options ||= Class.new(superclass.respond_to?(:options) ?
+        superclass.options : OptionsHash)
+    end
+
+    def required *keys, &block
+      options.required *keys, &block
+    end
+
+    def optional *keys, &block
+      options.optional *keys, &block
+    end
+
+    def options_reader *keys
+      keys.each do |key|
+        options.option?(key) or raise KeyError, "#{key} is not an option", caller(2)
+        define_method(key){ self.options[key] }
+      end
+    end
+
+    def option_readers!
+      options_reader *options.keys
+    end
+  end
+
+  module InstanceMethods
+    def initialize options={}
+      @options = self.class.options.parse(options)
+    end
+    attr_reader :options
+  end
+
+end

data/options_hash-method_object.gemspec

@@ -0,0 +1,26 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'options_hash/method_object'
+
+Gem::Specification.new do |spec|
+  spec.name          = "options_hash-method_object"
+  spec.version       = OptionsHash::MethodObject::VERSION
+  spec.authors       = ["Jared Grippe"]
+  spec.email         = ["jared@deadlyicon.com"]
+  spec.description   = %q{A MethodObject with an OptionsHash built in}
+  spec.summary       = %q{A MethodObject with an OptionsHash built in}
+  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_runtime_dependency     'options_hash'
+  spec.add_development_dependency 'bundler', '~> 1.3'
+  spec.add_development_dependency 'rake'
+  spec.add_development_dependency 'rspec'
+  spec.add_development_dependency 'pry-debugger'
+end

data/spec/options_hash/method_object_spec.rb

@@ -0,0 +1,63 @@
+require 'spec_helper'
+
+class CreatePerson < OptionsHash::MethodObject
+
+  required :name
+  optional :favorite_color, default: ->{ 'blue' }
+
+  options_reader :name, :favorite_color
+
+  def call
+    options
+  end
+
+end
+
+class CreateRobot < CreatePerson
+
+  required :model_number
+
+  option_readers!
+
+  def call
+    [name, favorite_color, model_number]
+  end
+
+end
+
+describe OptionsHash::MethodObject do
+  subject{ OptionsHash::MethodObject }
+
+  it { should_not respond_to :call         }
+  it { should_not respond_to :options_hash }
+  it { should_not respond_to :required     }
+  it { should_not respond_to :optional     }
+  it { should_not respond_to :options      }
+
+  describe CreatePerson do
+    describe '.call' do
+      it 'should take one optional argument' do
+        expect( CreatePerson.method(:call).arity ).to eq -1
+        expect{ CreatePerson.call }.to raise_error ArgumentError, 'required options: :name'
+        expect{ CreatePerson.call name: 'Jared' }.to_not raise_error
+        options = CreatePerson.call name: 'Jared'
+        expect(options.name).to eq 'Jared'
+        expect(options.favorite_color).to eq 'blue'
+      end
+    end
+    describe '.options' do
+      it 'should return a hash of the possible arguments' do
+        expect( CreatePerson.options.keys.to_set ).to eq Set[:favorite_color, :name]
+        expect( CreatePerson.options[:name] ).to be_required
+        expect( CreatePerson.options[:favorite_color] ).to_not be_required
+      end
+    end
+  end
+
+  it 'should be subclassable' do
+    expect( CreateRobot.options.keys.to_set ).to eq Set[:favorite_color, :name, :model_number]
+    expect{ CreateRobot.call }.to raise_error ArgumentError, 'required options: :model_number, :name'
+    expect( CreateRobot.call(name: 'Hal', model_number: 14) ).to eq ['Hal', 'blue', 14]
+  end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,19 @@
+require 'options_hash/method_object'
+require 'pry'
+# This file was generated by the `rspec --init` command. Conventionally, all
+# specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.
+# Require this file using `require "spec_helper"` to ensure that it is only
+# loaded once.
+#
+# See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
+RSpec.configure do |config|
+  config.treat_symbols_as_metadata_keys_with_true_values = true
+  config.run_all_when_everything_filtered = true
+  config.filter_run :focus
+
+  # Run specs in random order to surface order dependencies. If you find an
+  # order dependency and want to debug it, you can fix the order by providing
+  # the seed, which is printed after each run.
+  #     --seed 1234
+  config.order = 'random'
+end

metadata

@@ -0,0 +1,127 @@
+--- !ruby/object:Gem::Specification
+name: options_hash-method_object
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Jared Grippe
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-11-06 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: options_hash
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry-debugger
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: A MethodObject with an OptionsHash built in
+email:
+- jared@deadlyicon.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- .travis.yml
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/options_hash/method_object.rb
+- options_hash-method_object.gemspec
+- spec/options_hash/method_object_spec.rb
+- spec/spec_helper.rb
+homepage: ''
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.1.10
+signing_key: 
+specification_version: 4
+summary: A MethodObject with an OptionsHash built in
+test_files:
+- spec/options_hash/method_object_spec.rb
+- spec/spec_helper.rb