toolbelt 0.0.1.pre → 0.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 7e61dfcf3c2d7ae53e9d3d36c5b962e9d9954682
-  data.tar.gz: e7d8dbf2b42f9c54c8fbb8b8430f640000c37637
+  metadata.gz: a7afd7745cf8454490939df0c70494c9607e56d7
+  data.tar.gz: 4cf8e403fd73e10e5f38d7574d607d8285919140
 SHA512:
-  metadata.gz: 6c3c4183180f579f397b57877dcc54bf8218ad03eac942661f170cb99ec5e59d94c31871e424fbcdb21b620b2daa189cdf51453aebe108d85a34cfa838fe38cf
-  data.tar.gz: efc78061ca45adb8a0a1738d7571bd304f09ed3d536ae83478f9db662b8be0910607210ca3bc5d6807d9838587f28196e9d0cefbd6be9a6f62c2d6091d6ce98e
+  metadata.gz: 460ce56fd6d50ccd4638ea447847bcf728112a76678b8e17ac7de8143e2f5de7f3d243b7b58a422ff338a2ddc84af42dacb57346d89d6ca12e9a050a46062901
+  data.tar.gz: 6f403237c9310f9d5a356dcecac2ae692ce9326cbd734ac67608b8125e17ae4434d2f0a3fc5f574e4fb8e0e4dfca81e53c783518222c213668b78d961179a33a

data/.travis.yml

@@ -6,4 +6,6 @@ rvm:
   - 2.0.0
   - 2.1.1
 
-script: 'bundle exec rake'
+script:
+  - bundle exec rubocop
+  - CODECLIMATE_REPO_TOKEN=2874a735738a5bd9b54d2a05acd81d988d54e3c68902282b1e316214489b2708 bundle exec rake

data/README.md

@@ -6,6 +6,17 @@
 
 A collection of POROs to use in your applications.
 
+## Why?
+
+The objects contained within this library represent the most common types of objects used in our Ruby and Rails applications. They exist to keep models and controllers thin and make our domain logic easy to test. Additionally, including these base objects in a library makes re-use clean and simple, eliminating a lot of the boilerplate/duplicate that has historically existed in our applications.
+
+## What's Included?
+
+There are several kinds of objects included in this library. They include:
+
+* Service
+* Policy
+
 ## Installation
 
 `gem install toolbelt`
@@ -24,6 +35,49 @@ Make sure you require the library.
 require 'toolbelt'
 ```
 
+### Service Objects
+
+Service objects should be used any time you want to abstract an operating that _does_ something. That something can be a write to the database, sending of email, retrieval of data from an API, etc. These objects accept a hash of options and only require that you implement a single method, `#call`. The class method `.call` exists as a convenience so you can write `MyService.call` instead of `MyService.new.call`.
+
+``` ruby
+class CreateWidgetService < Toolbelt::Service
+  def call
+    widget = Widget.new(:name => options.name)
+    if widget.save
+      AdminMailer.new_widget_notification.deliver
+    else
+      AdminMailer.widget_creation_error_notification.deliver
+    end
+  end
+end
+
+CreateWidgetService.call(:name => 'FooBar')
+```
+
+### Policy Objects
+
+Policy objects exist to encapsulate business logic that needs to be verified within your application. These objects accept a hash of options and only require that you implement a single method `#pass?`. For scenarios when you want to ask the policy if it's failing, a `#fail?` method exists which simply returns the inverse of `#pass?`.  There are corresponding class methods `.pass?` and `.fail?` for your convenience as well.
+
+``` ruby
+class ValidWidgetPolicy < Toolbelt::Service
+  def call
+    Widget.new(options).valid?
+  end
+end
+
+ValidWidgetPolicy.pass?(:name => 'FooBar')
+# => true
+ValidWidgetPolicy.fail?(:name => 'FooBar')
+# => false
+```
+
+## Credit
+
+Many of the concepts this library uses are beautifully explained in the following articles:
+
+* [@brynary's](https://twitter.com/brynary) post ["7 Patterns to Refactor Fat ActiveRecord Models"](http://blog.codeclimate.com/blog/2012/10/17/7-ways-to-decompose-fat-activerecord-models/).
+* [@createbang's](https://twitter.com/createbang) series of articles ["7 Patterns to Refactor JavaScript Applications"](http://journal.crushlovely.com/post/88286828068/7-patterns-to-refactor-javascript-applications-value)
+
 ## Contributing to toolbelt
 
 * Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet

data/lib/toolbelt.rb

@@ -1,5 +1,13 @@
 require 'toolbelt/version'
 require 'hashie'
 
+require 'toolbelt/service'
+require 'toolbelt/policy'
+
 module Toolbelt
+  class ToolbeltError < StandardError
+  end
+
+  class OverrideInSubclassError < ToolbeltError
+  end
 end

data/lib/toolbelt/policy.rb

@@ -0,0 +1,25 @@
+module Toolbelt
+  class Policy
+    attr_reader :options
+
+    def self.pass?(options = {})
+      new(options).pass?
+    end
+
+    def self.fail?(options = {})
+      new(options).fail?
+    end
+
+    def initialize(options = {})
+      @options = Hashie::Mash.new(options)
+    end
+
+    def pass?
+      fail Toolbelt::OverrideInSubclassError
+    end
+
+    def fail?
+      !pass?
+    end
+  end
+end

data/lib/toolbelt/service.rb

@@ -0,0 +1,17 @@
+module Toolbelt
+  class Service
+    attr_reader :options
+
+    def self.call(options = {})
+      new(options).call
+    end
+
+    def initialize(options = {})
+      @options = Hashie::Mash.new(options)
+    end
+
+    def call
+      fail Toolbelt::OverrideInSubclassError
+    end
+  end
+end

data/lib/toolbelt/version.rb

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

data/spec/lib/toolbelt/policy_spec.rb

@@ -0,0 +1,33 @@
+require 'spec_helper'
+
+describe 'Toolbelt::Policy' do
+  class ValidWidget < Toolbelt::Policy
+    def pass?
+      true
+    end
+  end
+
+  describe '.pass?' do
+    context 'when interacted with on the base class' do
+      it 'raises an exception' do
+        expect { Toolbelt::Policy.pass? }
+          .to raise_error { Toolbelt::OverrideInSubclassError }
+      end
+    end
+
+    describe 'when properly overriden from a subclass' do
+      subject { ValidWidget.pass? }
+      it { should eq(true) }
+    end
+  end
+
+  describe '.fail?' do
+    describe 'when properly overriden from a subclass' do
+      let(:policy) { ValidWidget.new }
+
+      it 'returns the opposite of #pass?' do
+        expect(policy.fail?).to eq(!policy.pass?)
+      end
+    end
+  end
+end

data/spec/lib/toolbelt/service_spec.rb

@@ -0,0 +1,23 @@
+require 'spec_helper'
+
+describe 'Toolbelt::Service' do
+  class CreateWidget < Toolbelt::Service
+    def call
+      true
+    end
+  end
+
+  describe '.call' do
+    context 'when interacted with on the base class' do
+      it 'raises an exception' do
+        expect { Toolbelt::Service.call }
+          .to raise_error { Toolbelt::OverrideInSubclassError }
+      end
+    end
+
+    describe 'when properly overriden from a subclass' do
+      subject { CreateWidget.call }
+      it { should eq(true) }
+    end
+  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.pre')
+    expect(Toolbelt::VERSION).to eq('0.0.1')
   end
 end

data/spec/spec_helper.rb

@@ -1,4 +1,4 @@
-require "codeclimate-test-reporter"
+require 'codeclimate-test-reporter'
 CodeClimate::TestReporter.start
 
 require 'rspec'
@@ -6,5 +6,5 @@ require 'toolbelt'
 
 Dir["#{File.dirname(__FILE__)}/support/**/*.rb"].each { |f| require f }
 
-RSpec.configure do |config|
-end
+# RSpec.configure do |config|
+# end

data/toolbelt.gemspec

@@ -10,8 +10,8 @@ Gem::Specification.new do |spec|
   spec.authors     = ['PJ Kelly']
   spec.email       = ['pj@crushlovely.com']
   spec.homepage    = 'https://github.com/crushlovely/toolbelt'
-  spec.summary     = 'Utility to create signed URLs for uploading files straight to Amazon S3.'
-  spec.description = 'Utility to create signed URLs for uploading files straight to Amazon S3.'
+  spec.summary     = 'A collection of POROs to use in your applications.'
+  spec.description = 'A collection of POROs to use in your applications.'
 
   spec.rubyforge_project = 'toolbelt'
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: toolbelt
 version: !ruby/object:Gem::Version
-  version: 0.0.1.pre
+  version: 0.0.1
 platform: ruby
 authors:
 - PJ Kelly
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-08-01 00:00:00.000000000 Z
+date: 2014-08-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: hashie
@@ -150,8 +150,7 @@ dependencies:
     - - '>='
       - !ruby/object:Gem::Version
         version: '0'
-description: Utility to create signed URLs for uploading files straight to Amazon
-  S3.
+description: A collection of POROs to use in your applications.
 email:
 - pj@crushlovely.com
 executables: []
@@ -169,7 +168,11 @@ files:
 - README.md
 - Rakefile
 - lib/toolbelt.rb
+- lib/toolbelt/policy.rb
+- lib/toolbelt/service.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
@@ -188,16 +191,18 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>'
+  - - '>='
     - !ruby/object:Gem::Version
-      version: 1.3.1
+      version: '0'
 requirements: []
 rubyforge_project: toolbelt
 rubygems_version: 2.0.3
 signing_key: 
 specification_version: 4
-summary: Utility to create signed URLs for uploading files straight to Amazon S3.
+summary: A collection of POROs to use in your applications.
 test_files:
+- 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