solid_use_case 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: cb8bb82fa087ffe6fba31b8f8e8753537a3d32c8
+  data.tar.gz: 0dc0ea23f89441e88959892a6e0ae8c201023cae
+SHA512:
+  metadata.gz: b841281bb8558dc27c46c905c22cdb651752f6e8ac60861fcd04696633bb89f666c3985bab1a9fb6adebeb190a818a47843b23feb0be8e7d6af466320ba9437a
+  data.tar.gz: 8f48815ec737c7d537c3af38f8de2f193df4629929e5aefbb5238e35ddc63d603b110cc5594265c08887f83698092d671fdaba4cb2741ad588c050f010e46c8e

data/.gitignore

@@ -0,0 +1,18 @@
+*.gem
+*.rbc
+.bundle
+.config
+.DS_Store
+.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 documentation

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Gilbert
+
+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,109 @@
+# Solid Use Case
+
+**Solid Use Case** is a gem to help you implement well-tested and flexible use cases. Solid Use Case is not a framework - it's a **design pattern library**. This means it works *with* your app's workflow, not against it.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'solid_use_case'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install solid_use_case
+
+## Usage
+
+At its core, this library is a light wrapper around [Deterministic](https://github.com/pzol/deterministic), a practical abstraction over the Either monad. Don't let that scare you - you don't have to understand monad theory to reap its benefits.
+
+The only required method is the `#run` method.
+
+### Rails Example
+
+```ruby
+class UserSignup < SolidUseCase::Command
+  def run(params)
+    attempt_all do
+      step { validate(params) }
+      step {|params| save_user(params) }
+      try {|params| email_user(params) }
+    end
+  end
+
+  def validate(params)
+    user = User.new(params[:user])
+    if user.valid?
+      fail :invalid_user, :user => user
+    else
+      params[:user] = user
+      Success(params)
+    end
+  end
+
+  def save_user(params)
+    user = params[:user]
+    if user.save
+      fail :user_save_failed, :user => user
+    else
+      Success(params)
+    end
+  end
+
+  def email_user(params)
+    UserMailer.async.deliver(:welcome, params[:user].id)
+    Success(params[:user])
+  end
+end
+```
+
+Now you can run your use case in your controller and easily respond to the different outcomes (with **pattern matching**!):
+
+```ruby
+class UsersController < ApplicationController
+  def create
+    UserSignup.run(params).match do
+      success do |user|
+        flash[:success] = "Thanks for signing up!"
+        redirect_to profile_path(user)
+      end
+
+      failure(:invalid_user) do |error_data|
+        render_new(error_data, "Oops, fix your mistakes and try again")
+      end
+
+      failure(:user_save_failed) do |error_data|
+        render_new(error_data, "Sorry, something went wrong on our side.")
+      end
+
+      failure do |exception|
+        flash[:error] = "Something went terribly wrong"
+        render 'new'
+      end
+    end
+  end
+
+  private
+
+  def render_new(user, error_message)
+    @user = user
+    @error_message = error_message
+    render 'new'
+  end
+end
+```
+
+## Testing
+
+    $ bundle exec rspec
+
+## 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/solid_use_case.rb

@@ -0,0 +1,16 @@
+require "deterministic"
+require "deterministic/core_ext/either"
+
+require "solid_use_case/version"
+require 'solid_use_case/command/util.rb'
+require 'solid_use_case/command/error_struct.rb'
+require 'solid_use_case/command.rb'
+
+module SolidUseCase
+end
+
+class Deterministic::Either
+  class AttemptAll
+    alias :step :let
+  end
+end

data/lib/solid_use_case/command.rb

@@ -0,0 +1,19 @@
+module SolidUseCase
+  class Command
+    include Deterministic::CoreExt::Either
+    include CommandUtil
+
+    def self.run(input_hash={})
+      self.new.run(input_hash)
+    end
+
+    # # # # # # # # #
+    # Monad-related #
+    # # # # # # # # #
+
+    def fail(type, data={})
+      data[:type] = type
+      Failure(ErrorStruct.new(data))
+    end
+  end
+end

data/lib/solid_use_case/command/error_struct.rb

@@ -0,0 +1,7 @@
+module SolidUseCase
+  class ErrorStruct < OpenStruct
+    def ==(error_type_symbol)
+      self[:type] == error_type_symbol
+    end
+  end
+end

data/lib/solid_use_case/command/util.rb

@@ -0,0 +1,21 @@
+module SolidUseCase
+  module CommandUtil
+
+    def symbolize_names(object)
+      case object
+      when Hash
+        new = {}
+        object.each do |key, value|
+          key = (key.to_sym rescue key) || key
+          new[key] = symbolize_names(value)
+        end
+        new
+      when Array
+        object.map { |value| symbolize_names(value) }
+      else
+        object
+      end
+    end
+
+  end
+end

data/lib/solid_use_case/rspec_matchers.rb

@@ -0,0 +1,24 @@
+module SolidUseCase
+  module RSpecMatchers
+
+    def be_a_success
+      ValidateSuccess.new
+    end
+
+    class ValidateSuccess
+      def matches?(result)
+        @result = result
+        @result.is_a? Deterministic::Success
+      end
+
+      def failure_message_for_should
+        "expected result to be a success\nError & Data:\n    #{@result.value.type} - #{@result.value.inspect}"
+      end
+
+      def failure_message_for_should_not
+        "expected result to not be a success"
+      end
+    end
+
+  end
+end

data/lib/solid_use_case/version.rb

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

data/solid_use_case.gemspec

@@ -0,0 +1,28 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'solid_use_case/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "solid_use_case"
+  spec.version       = SolidUseCase::VERSION
+  spec.authors       = ["Gilbert"]
+  spec.email         = ["gilbertbgarza@gmail.com"]
+  spec.description   = %q{Create use cases the way they were meant to be. Easily verify inputs at each step and seamlessly fail with custom error data and convenient pattern matching.}
+  spec.summary       = %q{A flexible UseCase pattern that works *with* your workflow, not against it.}
+  spec.homepage      = "https://github.com/mindeavor/solid_use_case"
+  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.required_ruby_version = '~> 2.0'
+
+  spec.add_dependency "deterministic", '~> 0.2.0'
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec", "~> 2.14.1"
+end

data/spec/command_spec.rb

@@ -0,0 +1,30 @@
+require 'spec_helper'
+
+describe SolidUseCase::Command do
+
+  describe 'Stepping' do
+    class TestA < SolidUseCase::Command
+      def run(inputs)
+        attempt_all do
+          step { step_1(inputs) }
+          step {|inputs| step_2(inputs) }
+        end
+      end
+
+      def step_1(inputs)
+        inputs[:number] += 10
+        Success(inputs)
+      end
+
+      def step_2(inputs)
+        inputs[:number] *= 2
+        Success(inputs)
+      end
+    end
+
+    it "pipes one step result to the next step" do
+      result = TestA.run(:number => 10)
+      expect(result).to be_a_success
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,18 @@
+require 'solid_use_case'
+require 'solid_use_case/rspec_matchers'
+
+RSpec.configure do |config|
+  config.include(SolidUseCase::RSpecMatchers)
+end
+
+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,119 @@
+--- !ruby/object:Gem::Specification
+name: solid_use_case
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Gilbert
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-03-30 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: deterministic
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.2.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.2.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: 2.14.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.14.1
+description: Create use cases the way they were meant to be. Easily verify inputs
+  at each step and seamlessly fail with custom error data and convenient pattern matching.
+email:
+- gilbertbgarza@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/solid_use_case.rb
+- lib/solid_use_case/command.rb
+- lib/solid_use_case/command/error_struct.rb
+- lib/solid_use_case/command/util.rb
+- lib/solid_use_case/rspec_matchers.rb
+- lib/solid_use_case/version.rb
+- solid_use_case.gemspec
+- spec/command_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/mindeavor/solid_use_case
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ~>
+    - !ruby/object:Gem::Version
+      version: '2.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: A flexible UseCase pattern that works *with* your workflow, not against it.
+test_files:
+- spec/command_spec.rb
+- spec/spec_helper.rb
+has_rdoc: