cases 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: d1ff1b176f95aee6273a5c6430aeb8526556d86d
+  data.tar.gz: d000af86cf1971ae3eab07daa4eabc1d4efc9d47
+SHA512:
+  metadata.gz: 012aa1a1164f252d9acb9005f3de8fb76cdf2f00cb019216ea3fa09f5ac561fcfaece33eb3efe3fbda85335a8eb8bbf23313ab138790a9292e236e5b4df49205
+  data.tar.gz: 3c3d4398e97b29311a030d305cb15a7c24924919e2e9670febdaf1d52743dbf346c06bf2b874c733ee9d59f142aed8cf944d95c556611b7019446fe02a7a7f1e

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/.travis.yml

@@ -0,0 +1,15 @@
+language: ruby
+cache: bundler
+
+rvm:
+  - 1.9.3
+  - 2.0.0
+
+script: 'bundle exec rake'
+
+notifications:
+  email:
+    recipients:
+      - morganshowman@gmail.com
+    on_failure: change
+    on_success: never

data/Gemfile

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

data/Guardfile

@@ -0,0 +1,9 @@
+guard 'rspec' do
+  watch(%r{^lib/(.+).rb$}) do |m|
+    "spec/#{m[1]}_spec.rb"
+  end
+
+  watch(%r{^spec/(.+).rb$}) do |m|
+    "spec/#{m[1]}.rb"
+  end
+end

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Morgan Showman
+
+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,116 @@
+# Cases
+
+Define case, and caseable callbacks for your methods in ruby. By defining cases
+you can add callbacks to your methods where different callbacks will happen
+based on the result of the method.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'cases'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install cases
+
+## Usage
+
+```rb
+class TestResponse
+  attr_reader :options
+
+  def initialize(options)
+    @options = options
+  end
+
+  def failed?
+    options[:failed]
+  end
+
+  def failed_message
+    "failed message from test response"
+  end
+
+  def success?
+    options[:success]
+  end
+
+  def success_message
+    "success message from test response"
+  end
+end
+
+class TestCases
+  include Cases
+
+  attr_reader :response
+
+  def initialize(response)
+    @response = response
+  end
+
+  def failed_message
+    "failed message from cased object"
+  end
+
+  def success_message
+    "success message from cased object"
+  end
+
+  def test_with_block
+    response
+  end
+  define_case(:test_with_block, :success?) { |response| response.success_message }
+  define_case(:test_with_block, :failed?) { |response| response.failed_message }
+
+  def test_without_block
+    response
+  end
+  define_case(:test_without_block, success?: :success_message)
+  define_case(:test_without_block, failed?: :failed_message)
+
+  def test_caseable
+    response
+  end
+  define_caseable(:test_caseable)
+end
+
+> # When the test response was a success
+> test_response = TestResponse.new(success: true, failed: false)
+> test_case = TestCases.new(test_response)
+> test_case.test_with_block
+ => "success message from test response"
+> test_case.test_without_block
+ => "success message from cased object"
+> test_case.test_caseable do |on|
+    on.success? { |response| "#{response.success_message} through caseable"
+    on.failed? { |response| "#{response.failed_message} through caseable"
+  end
+ => "success message from test response through caseable"
+>
+> # When the test response failed
+> test_response = TestResponse.new(success: false, failed: true)
+> test_case = TestCases.new(test_response)
+> test_case.test_with_block
+ => "failed message from test response"
+> test_case.test_without_block
+ => "failed message from cased object"
+> test_case.test_caseable do |on|
+    on.success? { |response| "#{response.success_message} through caseable"
+    on.failed? { |response| "#{response.failed_message} through caseable"
+  end
+ => "failed message from test response through caseable"
+```
+
+## Contributing
+
+1. Fork it ( http://github.com/MorganShowman/cases/fork )
+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,8 @@
+require 'rspec/core/rake_task'
+require "bundler/gem_tasks"
+
+RSpec::Core::RakeTask.new(:spec) do |task|
+  task.rspec_opts = ['--color', '--format', 'documentation']
+end
+
+task default: :spec

data/cases.gemspec

@@ -0,0 +1,28 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'cases/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "cases"
+  spec.version       = Cases::VERSION
+  spec.authors       = ["Morgan Showman"]
+  spec.email         = ["mshowman@squaremouth.com"]
+  spec.summary       = %q{Define cases on methods that execute different callbacks for different scenarios}
+  spec.description   = %q{Define case, and caseable callbacks for your methods in ruby. By defining cases you can add callbacks
+                          to your methods where different callbacks will happen based on the result of the method}
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  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.5"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec"
+  spec.add_development_dependency "guard"
+  spec.add_development_dependency "guard-rspec"
+  spec.add_development_dependency "method_callbacks"
+end

data/lib/cases/case.rb

@@ -0,0 +1,44 @@
+module Cases
+  class Case
+    attr_accessor :result
+    attr_reader :method, :event, :options, :block
+
+    def self.all
+      @_all ||= {}
+    end
+
+    def initialize(method, event, options = {}, &block)
+      @method = method
+      @event = event
+      @block = block
+      @options = options
+
+      register
+    end
+
+    def ==(other)
+      method == other.method &&
+        event == other.event
+    end
+
+    def execute(object, result)
+      return if !result.send(event)
+
+      self.result = block.call(options[:on_self] ? object : result)
+    end
+
+    private
+
+    def register
+      cases << self if !registered?
+    end
+
+    def registered?
+      cases.any? { |kase| kase == self }
+    end
+
+    def cases
+      self.class.all[method] ||= []
+    end
+  end
+end

data/lib/cases/caseable.rb

@@ -0,0 +1,27 @@
+class Caseable
+  attr_reader :object
+
+  def self.execute(result, &block)
+    new(result).execute(result, &block)
+  end
+
+  def initialize(object)
+    @object = object
+  end
+
+  def execute(original_result, &block)
+    block.call(self)
+    case_blocks.reduce(original_result) { |result, case_block| case_block.call(result) }
+  end
+
+  def method_missing(method, &block)
+    case_blocks << block if object.send(method)
+    case_blocks
+  end
+
+  private
+
+  def case_blocks
+    @_case_blocks ||= []
+  end
+end

data/lib/cases/version.rb

@@ -0,0 +1,3 @@
+module Cases
+  VERSION = "1.0.0"
+end

data/lib/cases.rb

@@ -0,0 +1,47 @@
+require "method_callbacks"
+require "cases/case"
+require "cases/caseable"
+require "cases/version"
+
+module Cases
+  def self.included(base)
+    base.extend(MethodCallbacks::ClassMethods)
+    base.extend(ClassMethods)
+  end
+
+  module ClassMethods
+    def define_case(method, cases)
+      if block_given?
+        define_case_with_block(method, cases, &Proc.new)
+      else
+        cases.each_pair do |event, action|
+          Case.new(method, event, { on_self: true }, &Proc.new { |object| object.send(action) })
+        end
+      end
+
+      define_execute_cases(method)
+    end
+
+    def define_caseable(method)
+      proxy_result(method) { |result, &block| Caseable.execute(result, &block) }
+    end
+
+    def cases
+      Case.all
+    end
+
+    private
+
+    def define_case_with_block(method, event, &block)
+      Case.new(method, event, &block)
+    end
+
+    def define_execute_cases(method)
+      define_method "execute_#{method}_cases" do |&block|
+        self.class.cases[method].find { |kase| kase.execute(self, block.call) }.result
+      end
+
+      around_method(method, "execute_#{method}_cases")
+    end
+  end
+end

data/spec/cases_spec.rb

@@ -0,0 +1,104 @@
+require "spec_helper"
+
+describe Cases do
+  context "when response is success" do
+    let(:message) { "success response" }
+    let(:response) { TestResponse.new(success: true, failed: false) }
+    let(:test_cases) { TestCases.new(response) }
+
+    it "should respond from test response" do
+      expect(test_cases.test_with_block).to eq("success message from test response")
+    end
+
+    it "should respond from cased object" do
+      expect(test_cases.test_without_block).to eq("success message from cased object")
+    end
+
+    it "should respond from the given block" do
+      expect(test_cases.test_caseable do |on|
+        on.success? { |object| "#{object.success_message} through caseable" }
+        on.failed? { |object| "#{object.failed_message} through caseable" }
+      end).to eq("success message from test response through caseable")
+    end
+  end
+
+  context "when response is failed" do
+    let(:message) { "failed response" }
+    let(:response) { TestResponse.new(success: false, failed: true) }
+    let(:test_cases) { TestCases.new(response) }
+
+    it "should respond from test response" do
+      expect(test_cases.test_with_block).to eq("failed message from test response")
+    end
+
+    it "should respond from cased object" do
+      expect(test_cases.test_without_block).to eq("failed message from cased object")
+    end
+
+    it "should respond from the given block" do
+      expect(test_cases.test_caseable do |on|
+        on.success? { |object| "#{object.success_message} through caseable" }
+        on.failed? { |object| "#{object.failed_message} through caseable" }
+      end).to eq("failed message from test response through caseable")
+    end
+  end
+end
+
+class TestResponse
+  attr_reader :options
+
+  def initialize(options)
+    @options = options
+  end
+
+  def failed?
+    options[:failed]
+  end
+
+  def failed_message
+    "failed message from test response"
+  end
+
+  def success?
+    options[:success]
+  end
+
+  def success_message
+    "success message from test response"
+  end
+end
+
+class TestCases
+  include Cases
+
+  attr_reader :response
+
+  def initialize(response)
+    @response = response
+  end
+
+  def failed_message
+    "failed message from cased object"
+  end
+
+  def success_message
+    "success message from cased object"
+  end
+
+  def test_with_block
+    response
+  end
+  define_case(:test_with_block, :success?) { |response| response.success_message }
+  define_case(:test_with_block, :failed?) { |response| response.failed_message }
+
+  def test_without_block
+    response
+  end
+  define_case(:test_without_block, success?: :success_message)
+  define_case(:test_without_block, failed?: :failed_message)
+
+  def test_caseable
+    response
+  end
+  define_caseable(:test_caseable)
+end

data/spec/spec_helper.rb

@@ -0,0 +1 @@
+require "cases"

metadata

@@ -0,0 +1,146 @@
+--- !ruby/object:Gem::Specification
+name: cases
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Morgan Showman
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-06-12 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.5'
+  prerelease: false
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.5'
+  type: :development
+- !ruby/object:Gem::Dependency
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  prerelease: false
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+- !ruby/object:Gem::Dependency
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  prerelease: false
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+- !ruby/object:Gem::Dependency
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  prerelease: false
+  name: guard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+- !ruby/object:Gem::Dependency
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  prerelease: false
+  name: guard-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+- !ruby/object:Gem::Dependency
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  prerelease: false
+  name: method_callbacks
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+description: |-
+  Define case, and caseable callbacks for your methods in ruby. By defining cases you can add callbacks
+                            to your methods where different callbacks will happen based on the result of the method
+email:
+- mshowman@squaremouth.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .travis.yml
+- Gemfile
+- Guardfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- cases.gemspec
+- lib/cases.rb
+- lib/cases/case.rb
+- lib/cases/caseable.rb
+- lib/cases/version.rb
+- spec/cases_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.2.2
+signing_key: 
+specification_version: 4
+summary: Define cases on methods that execute different callbacks for different scenarios
+test_files:
+- spec/cases_spec.rb
+- spec/spec_helper.rb