toolbelt 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a7afd7745cf8454490939df0c70494c9607e56d7
-  data.tar.gz: 4cf8e403fd73e10e5f38d7574d607d8285919140
+  metadata.gz: 12bb6c26bbb60833d04dd08d3e31f2e759f0bf31
+  data.tar.gz: a57efa4ad0393db69a9d4d3783a07e4bd9de5a98
 SHA512:
-  metadata.gz: 460ce56fd6d50ccd4638ea447847bcf728112a76678b8e17ac7de8143e2f5de7f3d243b7b58a422ff338a2ddc84af42dacb57346d89d6ca12e9a050a46062901
-  data.tar.gz: 6f403237c9310f9d5a356dcecac2ae692ce9326cbd734ac67608b8125e17ae4434d2f0a3fc5f574e4fb8e0e4dfca81e53c783518222c213668b78d961179a33a
+  metadata.gz: 7b8e755e1b4c4ed6ce9626180ef346df6ca3f2d212219b46a664108fc36ddc6ffce8c3636db2fcde623dd98974d829ee89613e4683e909166ff8c57b23f6bdc0
+  data.tar.gz: 8bf95f7c0d2de5a16b9f2a902ec57a7e1bc9cf44281a0e4c8807f121b85c7ef364511f2abb4e99bc5487d89d2fa6bef01981331fcfe51294dc89b5d8112045af

data/.ruby-version

@@ -1 +1 @@
-2.0.0-p247
+2.1.2

data/.travis.yml

@@ -4,8 +4,7 @@ cache: bundler
 rvm:
   - 1.9.3
   - 2.0.0
-  - 2.1.1
+  - 2.1.2
 
 script:
-  - bundle exec rubocop
   - CODECLIMATE_REPO_TOKEN=2874a735738a5bd9b54d2a05acd81d988d54e3c68902282b1e316214489b2708 bundle exec rake

data/lib/toolbelt.rb

@@ -1,6 +1,8 @@
 require 'toolbelt/version'
 require 'hashie'
+require 'hash_validator'
 
+require 'toolbelt/util/option_validator'
 require 'toolbelt/service'
 require 'toolbelt/policy'
 
@@ -10,4 +12,11 @@ module Toolbelt
 
   class OverrideInSubclassError < ToolbeltError
   end
+
+  class RequiredOptionsError < ToolbeltError
+    # Internal
+    def initialize(errors)
+      super("Missing required options '#{errors.inspect}'")
+    end
+  end
 end

data/lib/toolbelt/policy.rb

@@ -1,5 +1,7 @@
 module Toolbelt
   class Policy
+    include Util::OptionValidator
+
     attr_reader :options
 
     def self.pass?(options = {})
@@ -11,6 +13,7 @@ module Toolbelt
     end
 
     def initialize(options = {})
+      validate_options!(options)
       @options = Hashie::Mash.new(options)
     end
 

data/lib/toolbelt/service.rb

@@ -1,5 +1,7 @@
 module Toolbelt
   class Service
+    include Util::OptionValidator
+
     attr_reader :options
 
     def self.call(options = {})
@@ -7,6 +9,7 @@ module Toolbelt
     end
 
     def initialize(options = {})
+      validate_options!(options)
       @options = Hashie::Mash.new(options)
     end
 

data/lib/toolbelt/util/option_validator.rb

@@ -0,0 +1,14 @@
+module Toolbelt
+  module Util
+    module OptionValidator
+      def validate_options!(options)
+        validator = HashValidator.validate(options, required_options)
+        fail Toolbelt::RequiredOptionsError, validator.errors unless validator.valid?
+      end
+
+      def required_options
+        {}
+      end
+    end
+  end
+end

data/lib/toolbelt/version.rb

@@ -1,3 +1,3 @@
 module Toolbelt
-  VERSION = '0.0.1'
+  VERSION = '0.0.2'
 end

data/spec/lib/toolbelt/policy_spec.rb

@@ -1,12 +1,30 @@
 require 'spec_helper'
 
 describe 'Toolbelt::Policy' do
-  class ValidWidget < Toolbelt::Policy
+  class ValidWidgetPolicy < Toolbelt::Policy
     def pass?
       true
     end
   end
 
+  class PassingStudentPolicy < Toolbelt::Policy
+    def pass?
+      true
+    end
+
+    protected
+
+    def required_options
+      {
+        :grade => 'required'
+      }
+    end
+  end
+
+  it_behaves_like 'an object with required options' do
+    let(:callable) { PassingStudentPolicy.pass? }
+  end
+
   describe '.pass?' do
     context 'when interacted with on the base class' do
       it 'raises an exception' do
@@ -16,14 +34,14 @@ describe 'Toolbelt::Policy' do
     end
 
     describe 'when properly overriden from a subclass' do
-      subject { ValidWidget.pass? }
+      subject { ValidWidgetPolicy.pass? }
       it { should eq(true) }
     end
   end
 
   describe '.fail?' do
     describe 'when properly overriden from a subclass' do
-      let(:policy) { ValidWidget.new }
+      let(:policy) { ValidWidgetPolicy.new }
 
       it 'returns the opposite of #pass?' do
         expect(policy.fail?).to eq(!policy.pass?)

data/spec/lib/toolbelt/service_spec.rb

@@ -5,6 +5,14 @@ describe 'Toolbelt::Service' do
     def call
       true
     end
+
+    protected
+
+    def required_options
+      {
+        :object => 'required'
+      }
+    end
   end
 
   describe '.call' do
@@ -15,8 +23,12 @@ describe 'Toolbelt::Service' do
       end
     end
 
+    it_behaves_like 'an object with required options' do
+      let(:callable) { CreateWidget.call }
+    end
+
     describe 'when properly overriden from a subclass' do
-      subject { CreateWidget.call }
+      subject { CreateWidget.call(:object => 'mock') }
       it { should eq(true) }
     end
   end

data/spec/lib/toolbelt/version_spec.rb

@@ -2,6 +2,6 @@ require 'spec_helper'
 
 describe 'Toolbelt::VERSION' do
   it 'should be the correct version' do
-    expect(Toolbelt::VERSION).to eq('0.0.1')
+    expect(Toolbelt::VERSION).to eq('0.0.2')
   end
 end

data/spec/support/shared_examples_for_option_validator.rb

@@ -0,0 +1,21 @@
+shared_examples_for 'an object with required options' do
+  let(:validator) { double('hash_validator', :valid? => true) }
+
+  it 'validates the options passed in against #required_options' do
+    expect(HashValidator).to receive(:validate).and_return(validator)
+    callable
+  end
+
+  it 'validates the options passed in against #required_options' do
+    allow(HashValidator).to receive(:validate).and_return(validator)
+    expect(validator).to receive(:valid?)
+    callable
+  end
+
+  context 'when missing required options' do
+    it 'raises an exception' do
+      expect { callable }
+        .to raise_error { Toolbelt::RequiredOptionsError }
+    end
+  end
+end

data/toolbelt.gemspec

@@ -21,6 +21,7 @@ Gem::Specification.new do |spec|
   spec.require_paths = ['lib']
 
   spec.add_dependency('hashie')
+  spec.add_dependency('hash_validator')
   spec.add_development_dependency 'bundler', '~> 1.3'
   spec.add_development_dependency('pry')
   spec.add_development_dependency('rake')

metadata

@@ -1,153 +1,167 @@
 --- !ruby/object:Gem::Specification
 name: toolbelt
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - PJ Kelly
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-08-05 00:00:00.000000000 Z
+date: 2014-09-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: hashie
   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: hash_validator
+  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: pry
   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: 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: rubocop
   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: guard
   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: guard-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: guard-rubocop
   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: codeclimate-test-reporter
   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 collection of POROs to use in your applications.
@@ -157,10 +171,10 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- .gitignore
-- .rubocop.yml
-- .ruby-version
-- .travis.yml
+- ".gitignore"
+- ".rubocop.yml"
+- ".ruby-version"
+- ".travis.yml"
 - CHANGELOG.md
 - Gemfile
 - Guardfile
@@ -170,12 +184,14 @@ files:
 - lib/toolbelt.rb
 - lib/toolbelt/policy.rb
 - lib/toolbelt/service.rb
+- lib/toolbelt/util/option_validator.rb
 - lib/toolbelt/version.rb
 - spec/lib/toolbelt/policy_spec.rb
 - spec/lib/toolbelt/service_spec.rb
 - spec/lib/toolbelt/version_spec.rb
 - spec/lib/toolbelt_spec.rb
 - spec/spec_helper.rb
+- spec/support/shared_examples_for_option_validator.rb
 - toolbelt.gemspec
 homepage: https://github.com/crushlovely/toolbelt
 licenses: []
@@ -186,17 +202,17 @@ 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: toolbelt
-rubygems_version: 2.0.3
+rubygems_version: 2.2.2
 signing_key: 
 specification_version: 4
 summary: A collection of POROs to use in your applications.
@@ -206,4 +222,4 @@ test_files:
 - spec/lib/toolbelt/version_spec.rb
 - spec/lib/toolbelt_spec.rb
 - spec/spec_helper.rb
-has_rdoc: 
+- spec/support/shared_examples_for_option_validator.rb