action_case 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: ffed6d5cb843ec416c48865277de0d4b5ce894a3
+  data.tar.gz: 9292fd2b0a872331447cdee2de14ceb422de2ab9
+SHA512:
+  metadata.gz: d76cc46be8db56ca2c8eb87cec55aa4ee6ef67fad36775cdca897f457fc1f88c27c61b97c624336282812b45a268938ca3bf9cca8045a02dc08eac8a9d47611d
+  data.tar.gz: 2c04454834cb8adddaba211cee287cf429f5003f3b6d125084ae47707cefdbacf1a2bec2111393d53a6205addf31eb540964b9afb9deb95445a61409ff2cbd16

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,3 @@
+--color
+--format documentation
+--require spec_helper

data/.travis.yml

@@ -0,0 +1,7 @@
+language: ruby
+rvm:
+  - "2.2.1"
+  - "2.2.0"
+  - "2.1.0"
+  - "2.0.0"
+  - "1.9.3"

data/Gemfile

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

data/Guardfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2015 Winton DeShong
+
+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,137 @@
+# ActionCase
+
+Implementation of use-case driven design for ruby projects. Keep your business logic in the right place!
+
+Supports: Ruby 1.9.3 +
+
+[![Build Status](https://travis-ci.org/wintondeshong/action_case.svg?branch=master)](https://travis-ci.org/wintondeshong/action_case)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'action_case'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install action_case
+
+## Usage
+
+There are a variety of classes available to implement use-case driven design principles and patterns in your project.
+
+### Creating use-case class
+
+```ruby
+# /app/use_cases/survey_exporter.rb
+require "csv"
+
+module UseCases
+  module Surveys
+    class SurveyExporter < ActionCase::Base
+
+      def export_csv survey_id
+        begin
+          survey = resource.find(survey_id)
+
+          return respond CSV.generate({}) { |csv|
+            csv << [:id, :title, :created_at]
+            survey.entries.each do |entry|
+              csv << [entry.id, entry.title, entry.created_at]
+            end
+          }
+        rescue Exception => exception
+          log :error, exception.message
+        end
+
+        respond "Unable to export the survey due to errors", false
+      end
+
+      def resource
+        Survey
+      end
+
+    end
+  end
+end
+```
+
+#### Items of note:
+1. Injection of concrete implementation via 'resource'
+2. Use of #resource in #export_csv method, not concrete implementation
+3. Use of inherited respond method to handle both successful and error responses
+4. While it isn't required, it is recommended to namespace your use-cases with a [matching folder structure](http://cl.ly/image/1K3U120I1k0j).
+
+### Leveraging Use-case (perhaps in a Rails controller)
+
+#### Generic Handler Syntax
+In many cases, you'll only have one operation in a given use case. When that is the case, you can cut down on verbosity by using the generic handler syntax.
+Format: ```[use_case_class_name_snake_cased]_[success_or_error]```
+
+```ruby
+# /app/controllers/surveys_controller.rb
+
+class SurveyController < ActionController::Base
+
+  # POST /surveys/:id/export
+  def export
+    UseCases::Surveys::SurveyExporter.new(self).export_csv params[:id]
+  end
+
+  def survey_exporter_success csv_output
+    flash[:notice] = "Survey successfully exported!"
+    send_data csv_output, type: "text/plain", filename: "survey-export.csv", disposition: "attachment"
+  end
+
+  def survey_exporter_error error_output
+    flash[:alert] = "There were issues exporting the survey - #{error_output}"
+  end
+
+end
+```
+
+#### Items of note:
+1. We set the controller as the listener for the use-case, via 'self'
+2. SurveyController#export stays short, sweet and to the point.
+3. We avoid coupling by using a very event-like callback (tell don't ask) communication pattern.
+
+#### Explicit Handler Syntax
+As your application scales and business rules change, you may have related but slightly different method signatures on a given use-case with each requiring different responses. In those cases the more verbose explicit handler syntax is necessary.
+Format: ```[class_name_snake_cased]_[method_name_snake_cased]_[success_or_error]```
+
+```ruby
+# /app/controllers/surveys_controller.rb
+
+class SurveyController < ActionController::Base
+
+  # POST /surveys/:id/export
+  def export
+    UseCases::Surveys::SurveyExporter.new(self).export_csv params[:id]
+  end
+
+  def survey_exporter_export_csv_success csv_output
+    flash[:notice] = "Survey successfully exported!"
+    send_data csv_output, type: "text/plain", filename: "survey-export.csv", disposition: "attachment"
+  end
+
+  def survey_exporter_export_csv_error error_output
+    flash[:alert] = "There were issues exporting the survey - #{error_output}"
+  end
+
+end
+```
+#### Items of note:
+1. The expanded method signatures including the ```_export_csv``` component
+
+
+## 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,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new :spec
+
+task default: :spec

data/action_case.gemspec

@@ -0,0 +1,27 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "action_case/version"
+
+Gem::Specification.new do |gem|
+  gem.name          = "action_case"
+  gem.version       = ActionCase::VERSION
+  gem.authors       = ["Winton DeShong"]
+  gem.email         = ["contact@wintondeshong.com"]
+  gem.description   = %q{Use-case driven design for ruby projects. Keeps your business logic in the right place!}
+  gem.summary       = %q{Use-case driven design for ruby projects. Keeps your business logic in the right place!}
+  gem.homepage      = "https://github.com/wintondeshong/action_case"
+
+  gem.files         = `git ls-files`.split("\n")
+  gem.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  gem.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  gem.require_paths = ["lib"]
+
+  gem.add_dependency "activesupport"
+
+  gem.add_development_dependency "guard"
+  gem.add_development_dependency "guard-rspec"
+  gem.add_development_dependency "rake"
+  gem.add_development_dependency "rspec"
+  gem.add_development_dependency "travis-lint"
+end

data/lib/action_case.rb

@@ -0,0 +1,9 @@
+## 3rd party libraries
+require 'active_support/core_ext/string'
+
+## UseCase pattern classes
+require "action_case/base"
+require "action_case/version"
+
+module ActionCase
+end

data/lib/action_case/base.rb

@@ -0,0 +1,50 @@
+module ActionCase
+  class Base
+
+    attr_accessor :listener
+
+    def initialize(listener = nil)
+      @listener = listener
+    end
+
+    def resource
+      raise "ActionCase::Base#resource must be overridden"
+    end
+
+
+    #####################################
+
+    protected
+
+    #####################################
+
+    def get_class_name
+      self.class.name.underscore.split("/").last # accounts for namespaces
+    end
+
+    def get_explicit_handler(method_name, is_success = true)
+      "#{get_class_name}_#{method_name}_#{is_success ? "success" : "error"}"
+    end
+
+    def get_generic_handler(is_success = true)
+      "#{get_class_name}_#{is_success ? "success" : "error"}"
+    end
+
+    def respond(response, is_success = true)
+      return response if @listener.nil?
+
+      caller_name           = defined?(caller_locations) ? caller_locations(1,1)[0].label : caller[0][/`([^']*)'/, 1] # we use the ruby 2.0+ approach whenever possible being it is significantly faster
+      generic_handler_name  = get_generic_handler(is_success)
+      explicit_handler_name = get_explicit_handler(caller_name, is_success)
+
+      if @listener.respond_to?(explicit_handler_name)
+        @listener.send explicit_handler_name, response
+      elsif @listener.respond_to?(generic_handler_name)
+        @listener.send generic_handler_name, response
+      else
+        response
+      end
+    end
+
+  end
+end

data/lib/action_case/version.rb

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

data/spec/action_case/base_spec.rb

@@ -0,0 +1,146 @@
+require "spec_helper"
+
+describe ActionCase::Base do
+
+  # Mocks
+  # -----
+
+  class NonOverriddenUseCase < ActionCase::Base
+  end
+
+  class TestUseCase < ActionCase::Base
+    def method_that_succeeds
+      respond "some-successful-value"
+    end
+
+    def method_that_fails
+      respond "some-error-message", false
+    end
+  end
+
+  module Namespaced
+    class TestUseCase < TestUseCase
+    end
+  end
+
+  class TestListenerWithGenericHandlers
+    def test_use_case_success response
+    end
+
+    def test_use_case_error response
+    end
+  end
+
+  class TestListenerWithExplicitHandlers
+    def test_use_case_method_that_succeeds_success response
+    end
+
+    def test_use_case_method_that_fails_error response
+    end
+  end
+
+  class TestListenerWithoutHandlers
+  end
+
+
+  # Tests
+  # -----
+
+  context "#initialize" do
+    it "sets listener to nil by default" do
+      use_case = NonOverriddenUseCase.new
+      expect(use_case.listener).to be_nil
+    end
+
+    it "sets listener to supplied object" do
+      use_case = NonOverriddenUseCase.new(10)
+      expect(use_case.listener).to eq 10
+    end
+  end # initialize
+
+  context "#listener" do
+    let(:use_case) { TestUseCase.new }
+
+    describe "when listener provided" do
+      describe "contains catch-all handler methods" do
+        let(:listener) { TestListenerWithGenericHandlers.new }
+
+        before(:each) do
+          use_case.listener = listener
+        end
+
+        it "invokes success properly" do
+          expect(listener).to receive(:test_use_case_success).with("some-successful-value")
+          use_case.method_that_succeeds
+        end
+
+        it "invokes error properly" do
+          expect(listener).to receive(:test_use_case_error).with("some-error-message")
+          use_case.method_that_fails
+        end
+      end
+
+      describe "contains explicit handler methods" do
+        describe "when use-case not namespaced" do
+          let(:listener) { TestListenerWithExplicitHandlers.new }
+
+          before(:each) do
+            use_case.listener = listener
+          end
+
+          it "invokes success properly" do
+            expect(listener).to receive(:test_use_case_method_that_succeeds_success).with("some-successful-value")
+            use_case.method_that_succeeds
+          end
+
+          it "invokes error properly" do
+            expect(listener).to receive(:test_use_case_method_that_fails_error).with("some-error-message")
+            use_case.method_that_fails
+          end
+        end
+
+        describe "when use-case not namespaced" do
+          let(:listener) { TestListenerWithExplicitHandlers.new }
+          let(:use_case) { Namespaced::TestUseCase.new }
+
+          before(:each) do
+            use_case.listener = listener
+          end
+
+          it "invokes success properly" do
+            expect(listener).to receive(:test_use_case_method_that_succeeds_success).with("some-successful-value")
+            use_case.method_that_succeeds
+          end
+
+          it "invokes error properly" do
+            expect(listener).to receive(:test_use_case_method_that_fails_error).with("some-error-message")
+            use_case.method_that_fails
+          end
+        end
+      end
+
+      describe "hasn't supplied handler methods" do
+        it "returns immediate result" do
+          use_case.listener = TestListenerWithoutHandlers.new
+          expect(use_case.method_that_succeeds).to eq "some-successful-value"
+          expect(use_case.method_that_fails).to eq "some-error-message"
+        end
+      end
+    end
+
+    describe "when listener nil" do
+      it "returns immediate result" do
+        expect(use_case.method_that_succeeds).to eq "some-successful-value"
+        expect(use_case.method_that_fails).to eq "some-error-message"
+      end
+    end
+  end # listener
+
+  context "#resource" do
+    it "when not overridden it raises an exception" do
+      use_case = NonOverriddenUseCase.new
+      expect{ use_case.resource }.to raise_error
+    end
+  end # resource
+
+end

data/spec/spec_helper.rb

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

metadata

@@ -0,0 +1,145 @@
+--- !ruby/object:Gem::Specification
+name: action_case
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Winton DeShong
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-03-29 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  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: 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: 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: travis-lint
+  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: Use-case driven design for ruby projects. Keeps your business logic in
+  the right place!
+email:
+- contact@wintondeshong.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- Guardfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- action_case.gemspec
+- lib/action_case.rb
+- lib/action_case/base.rb
+- lib/action_case/version.rb
+- spec/action_case/base_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/wintondeshong/action_case
+licenses: []
+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.4.6
+signing_key: 
+specification_version: 4
+summary: Use-case driven design for ruby projects. Keeps your business logic in the
+  right place!
+test_files:
+- spec/action_case/base_spec.rb
+- spec/spec_helper.rb