rest_my_case 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 4c970f203b3b22d52c6722769641cbb473816fd0
+  data.tar.gz: 0a8078be8d6ed74ff5c8107eb647f19d4db96090
+SHA512:
+  metadata.gz: c3cbe0da32ebd73ffe647b19e984ed60bc2ee1782bade92ad35172fedf2e20ce460f55b79195625b8e5133ce1271a05847ea69f5952aa2aebfdd016f7f83f01b
+  data.tar.gz: 899768ca4c9a86720102ce5eadd60d7e957fd32cfd7551dcc22f2f2ee62b4c771a8d2856d4091713c3a8d85584a0fe3ca93efc73b7a0d307afa8660546d77519

data/.gitignore

@@ -0,0 +1,41 @@
+*.gem
+*.rbc
+/.config
+/coverage/
+/InstalledFiles
+/pkg/
+/spec/reports/
+/test/tmp/
+/test/version_tmp/
+/tmp/
+
+## Specific to RubyMotion:
+.dat*
+.repl_history
+build/
+
+## Documentation cache and generated files:
+/.yardoc/
+/_yardoc/
+/doc/
+/rdoc/
+
+## Environment normalisation:
+/.bundle/
+/vendor/bundle
+/lib/bundler/man/
+
+# for a library or gem, you might want to ignore these files since the code is
+# intended to run in multiple environments; otherwise, check them in:
+Gemfile.lock
+.ruby-version
+.ruby-gemset
+
+# unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
+.rvmrc
+
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/Gemfile

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

data/LICENSE

@@ -0,0 +1,22 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 João
+
+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/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2015 goncalvesjoao
+
+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,2 @@
+# rest_my_case
+Quick and light "The Clean Architecture" use case implementation

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+

data/lib/rest_my_case/base.rb

@@ -0,0 +1,82 @@
+module RestMyCase
+
+  class Base
+
+    def self.depends(*use_cases)
+      local_dependencies.push *use_cases
+    end
+
+    # List of use case classes that the current class depends on
+    def self.local_dependencies
+      @local_dependencies ||= []
+    end
+
+    # List of use cases that the current class depends on, plus its parent class
+    # This list will be used during .perform
+    def self.dependencies
+      local_dependencies.concat superclass.dependencies
+    end
+
+    def self.perform(attributes = {})
+      Judge.execute_the_sentence self, Context.new(attributes)
+    end
+
+    attr_reader :context, :should_abort, :should_skip
+
+    def initialize(context)
+      @context = context
+
+      @should_abort = @should_skip = false
+    end
+
+    def before;  end
+
+    def perform;  end
+
+    def rollback; end
+
+    def final; end
+
+    # Calls #abort and populates the context's errors
+    def fail(message = '')
+      abort
+
+      @context.errors[self.class.name].push message
+    end
+
+    # Calls #fail and also prevents the next line of code to be ran
+    def fail!(message = '')
+      fail message
+
+      raise Errors::Abort
+    end
+
+    # Prevents the next use case to be ran and will trigger the rollback process
+    def abort
+      @should_abort = true
+    end
+
+    # Calls #abort and prevents the next line of code to be ran
+    def abort!
+      abort
+
+      raise Errors::Abort
+    end
+
+    # To be used during the #before method:
+    #   Prevents the current use case to be
+    #   ran (during perform), but not the next ones
+    def skip
+      @should_skip = true
+    end
+
+    # Calls #skip and prevents the next line of code to be ran
+    def skip!
+      skip
+
+      raise Errors::Skip
+    end
+
+  end
+
+end

data/lib/rest_my_case/context.rb

@@ -0,0 +1,29 @@
+module RestMyCase
+
+  class Context < OpenStruct
+
+    attr_reader :errors
+
+    def initialize(attributes)
+      if !attributes.is_a?(::Hash) && !attributes.is_a?(Context)
+        raise ArgumentError.new('Must be a Hash or Context')
+      end
+
+      super Helpers.stringify_keys(attributes)
+
+      @errors = Hash.new { |hash, key| hash[key] = [] }
+    end
+
+    def valid?
+      @errors.empty?
+    end
+
+    def serializable_hash(options = nil)
+      marshal_dump
+    end
+
+    alias :to_hash :serializable_hash
+
+  end
+
+end

data/lib/rest_my_case/defense_attorney.rb

@@ -0,0 +1,13 @@
+module RestMyCase
+
+  module DefenseAttorney
+
+    extend self
+
+    def build_use_cases_for_the(defendant, context)
+
+    end
+
+  end
+
+end

data/lib/rest_my_case/errors.rb

@@ -0,0 +1,11 @@
+module RestMyCase
+  module Errors
+
+    class Base < StandardError; end
+
+    class Skip < Base; end
+
+    class Abort < Base; end
+
+  end
+end

data/lib/rest_my_case/helpers.rb

@@ -0,0 +1,11 @@
+module RestMyCase
+
+  module Helpers
+
+    def self.stringify_keys(attributes)
+      attributes.to_hash
+    end
+
+  end
+
+end

data/lib/rest_my_case/judge.rb

@@ -0,0 +1,70 @@
+require "rest_my_case/defense_attorney"
+
+module RestMyCase
+
+  module Judge
+
+    extend self
+
+    def execute_the_sentence(defendant, context)
+      @use_case_that_aborted = false
+
+      @use_cases = DefenseAttorney.build_use_cases_for_the defendant, context
+
+      run_before_methods
+
+      run_perform_methods
+
+      run_rollback_methods
+
+      run_final_methods
+    end
+
+    protected #################### PROTECTED ####################
+
+    def run_before_methods
+      @use_cases.each do |use_case|
+        break if run_method(:before, use_case) == 'abort'
+      end
+    end
+
+    def run_perform_methods
+      return nil if @use_case_that_aborted
+
+      @use_cases.each do |use_case|
+        break if run_method(:perform, use_case) == 'abort'
+      end
+    end
+
+    def run_rollback_methods
+      return nil unless @use_case_that_aborted
+
+      # Revert the list, remove all use cases until you find
+      # the use_case_that_aborted and run .map(&:rollback)
+      # on the remaining elements
+    end
+
+    def run_final_methods
+      @use_cases.map(&:final)
+    end
+
+    private #################### PRIVATE ######################
+
+    def run_method(method_name, use_case)
+      begin
+        return 'skip' if use_case.should_skip
+
+        use_case.send(method_name)
+
+        use_case.should_abort ? 'abort' : 'ok'
+      rescue Errors::Skip => exception
+        'skip'
+      rescue Errors::Abort => exception
+        @use_case_that_aborted = use_case
+        'abort'
+      end
+    end
+
+  end
+
+end

data/lib/rest_my_case/version.rb

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

data/lib/rest_my_case.rb

@@ -0,0 +1,7 @@
+require "rest_my_case/version"
+require "rest_my_case/context"
+require "rest_my_case/errors"
+require "rest_my_case/judge"
+require "rest_my_case/base"
+
+module RestMyCase; end

data/rest_my_case.gemspec

@@ -0,0 +1,23 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'rest_my_case/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "rest_my_case"
+  spec.version       = RestMyCase::VERSION
+  spec.authors       = ["goncalvesjoao"]
+  spec.email         = ["goncalves.joao@gmail.com"]
+  spec.summary       = %q{Quick and light "The Clean Architecture" use case implementation.}
+  spec.description   = %q{Very light Ruby gem with everything you need in a "The Clean Architecture" use case scenario}
+  spec.homepage      = "https://github.com/goncalvesjoao/rest_my_case"
+  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.7"
+  spec.add_development_dependency "rake", "~> 10.0"
+end

metadata

@@ -0,0 +1,88 @@
+--- !ruby/object:Gem::Specification
+name: rest_my_case
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- goncalvesjoao
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-04-10 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+description: Very light Ruby gem with everything you need in a "The Clean Architecture"
+  use case scenario
+email:
+- goncalves.joao@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/rest_my_case.rb
+- lib/rest_my_case/base.rb
+- lib/rest_my_case/context.rb
+- lib/rest_my_case/defense_attorney.rb
+- lib/rest_my_case/errors.rb
+- lib/rest_my_case/helpers.rb
+- lib/rest_my_case/judge.rb
+- lib/rest_my_case/version.rb
+- rest_my_case.gemspec
+homepage: https://github.com/goncalvesjoao/rest_my_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: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.2
+signing_key: 
+specification_version: 4
+summary: Quick and light "The Clean Architecture" use case implementation.
+test_files: []