pay_dirt 1.0.0 → 1.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 2ba73dd9244ee21438def9485c64bbefaf5f16fc
-  data.tar.gz: 800d06d810a814e537a7e7cbe8990a98e44e6bd8
+  metadata.gz: 0b0248574c00871f3ef6676055ad9fb7c48acd35
+  data.tar.gz: 8337f0b5fe6377dfaa00183b62465ecec055f17a
 SHA512:
-  metadata.gz: 808c005f50e9eeaefc148900d19d3d34dfe37784bdac0feeb9505496f4a131e4fcf23c39e618463bc27ab46a10621ea600e73c731b9d834de06f047af97edd91
-  data.tar.gz: 7e1c8b35bec2fd5d1096712c6ecdb9f7f9dbeb65d01607ea12a3cd250924a07d466b6d88e956c44bcbf98aa903fa5e4aaec23b5f14fbae5974dffba22dc50f42
+  metadata.gz: 7f21b11cf6ae2914e06fdc48c7ae2e7e3de1f6f4f6f47ea79ecbc22ea3ce6cb8e1325e380e7bb97ed4237333810b820cb6d9d1d017c3c51adda455dec8e5ff4d
+  data.tar.gz: bc92bbb77e64ad90bad2c5a0a521174d5b6f38c0e3ae827927f62f8d1698ca89f9d2d4a43d8b88557739e10c026123f95e23e3d26b0ebfd0de9c276aeb640283

data/.gitignore

@@ -9,5 +9,7 @@
 .ruby-gemset
 /.bundle
 
+lib/service_objects
+
 *.sw?
 .sw?

data/README.md

@@ -4,62 +4,53 @@
 
 Provides the basic building blocks of a pattern capable of reducing a towering codebase to modular rubble (or more Ruby gems)
 
-There are two ways to employ the pattern: 
+There are two ways to employ the pattern:
 
 1. use a class that inherits from [PayDirt::Base](https://github.com/rthbound/pay_dirt/blob/master/test/unit/pay_dirt/base_test.rb#L6-L24)
 2. use a class or module that includes [PayDirt::UseCase](https://github.com/rthbound/pay_dirt/blob/master/test/unit/pay_dirt/use_case_test.rb#L6-L26)
 
-### Sample PayDirt use case
-Example class:
-```ruby
-class UseCase
-  include PayDirt::UseCase
+### Generators
 
-  def initialize(options)
-    options = {
-      required_option_with_default_value: true
-    }.merge(options)
+PayDirt now provides a service object generator, powered by [thor](https://github.com/erikhuda/thor). It takes a few options
 
-    load_options(:required_option_with_default_value, :required_option, options)
-  end
+`--dependencies` or `-d` : An array of required dependencies (this option is required)
 
-  def execute!
-    if !@required_option_with_default_value
-      return PayDirt::Result.new(data: return_value, success: true)
-    else
-      return PayDirt::Result.new(data: return_value, success: false)
-    end
-  end
+`--defaults` or `-D` : An optional hash of default values for dependencies
 
-  private
-  def return_value
-    {
-      optional_option:  @optional_option,
-      required_option1: @required_option_with_default_value,
-      required_option2: @required_option
-    }
-  end
-end
-```
+`--inherit` or `-i` : A boolean flag, raise it for an implementation that inherits from `PayDirt::Base` (this is default behavior)
+
+`--include` or `-m` : A boolean flag, raise it for an implementation that includes `PayDirt::UseCase`
+
+Example:
 
-Example class usage:
+```
+$ thor pay_dirt:service_object:new digit_check -d fingers toes -D fingers:10 toes:10
+  create  lib/service_objects/digit_check.rb
+```
 
+Running the above generator will create the following file
 ```ruby
-# Cheating by not injecting all dependencies
-result = SomeThing.new(required_option: true).execute! # Returns a PayDirt::Result
-!result.successful?                                    #=> false
-result.data[:optional_option]                          #=> nil
-
-# Playing nice and injecting all required dependencies
-result = SomeThing.new(required_option: true, required_option_with_default_value: false).execute!
-result.successful?                                     #=> true
-result.data[:optional_option]                          #=> nil
-
-# Making use of an optional option
-result = SomeThing.new(required_option: true, optional_option: true).execute!
-!result.successful?                                    #=> false
-result.data[:optional_option]                          #=> true
+require 'pay_dirt'
+
+module ServiceObjects
+  class DigitCheck < PayDirt::Base
+    def initialize(options = {})
+      options = {
+        fingers: 10,
+        toes: 10,
+      }.merge(options)
+
+      load_options(:fingers, :toes, options)
+    end
+
+    def execute!
+      return PayDirt::Result.new(success: true, data: nil)
+    end
+  end
+end
 ```
+We can now call `ServiceObjects::DigitCheck.new(fingers: 10, toes: 10).execute!`
+and see a successful return object. Where you take it from there is up to you.
 
 ### Other examples
 1. [rubeuler](https://github.com/rthbound/rubeuler)

data/lib/pay_dirt/version.rb

@@ -1,3 +1,3 @@
 module PayDirt
-  VERSION = "1.0.0"
+  VERSION = "1.0.1"
 end

data/pay_dirt.gemspec

@@ -25,6 +25,7 @@ Gem::Specification.new do |s|
   s.require_paths = ["lib"]
 
   s.add_development_dependency "minitest"
+  s.add_development_dependency "thor"
   s.add_development_dependency "coveralls"
   s.add_development_dependency "rake"
 end

data/pay_dirt.thor

@@ -0,0 +1,86 @@
+module PayDirt
+  class ServiceObject < Thor
+    include Thor::Actions
+
+    desc "new FILE", "create a service object"
+    method_option :defaults,
+      type: :hash,
+      aliases: "-D",
+      desc: "Specify default dependencies"
+
+    method_option :dependencies,
+      type: :array,
+      aliases: "-d",
+      desc: "Specify required dependencies",
+      required: true
+
+    method_option :inherit,
+      type:         :boolean,
+      desc:         "Should inherit from PayDirt::Base (default)",
+      aliases:      "-i",
+      default:      true,
+      lazy_default: true
+
+    method_option :include,
+      type:         :boolean,
+      desc:         "Should include the PayDirt::UseCase module",
+      aliases:      "-m",
+      lazy_default: true
+
+    def new(file)
+      rets = ""
+      class_names = file.split("/").map { |str| str.split("_").map{ |s| (s[0].upcase + s[1..-1]) }.join("") }
+      defaults     = options[:defaults] || []
+      dependencies = options[:dependencies]
+
+      create_file "lib/service_objects/#{file}.rb" do
+        rets << "require 'pay_dirt'\n\n"
+        rets << "module ServiceObjects\n"
+        class_names[0..-2].each_with_index do |mod,i|
+          rets << (" " * ( (i+1) * 2 )) + "module #{mod}\n"
+        end
+
+        klass, klass_index = class_names[-1], class_names.length
+
+        if options[:include]
+          rets << (" " * ( klass_index * 2)) + "class #{class_names[-1]}\n"
+          rets << (" " * ((klass_index + 1) * 2)) + "include PayDirt::UseCase\n"
+        elsif options[:inherit]
+          rets << (" " * ( klass_index * 2)) + "class #{class_names[-1]} < PayDirt::Base\n"
+        end
+
+        inner_index = klass_index + 1
+
+        # The initialize method
+        rets << (" " * ( inner_index * 2 )) + "def initialize(options = {})\n"
+
+        # Configure dependencies' default values
+        if options[:defaults]
+          rets << (" " * ( (inner_index + 1) * 2 )) + "options = {\n"
+
+          defaults.each do |k,v|
+            rets << (" " * ( (inner_index + 2) * 2 )) + "#{k}: #{v}" + ",\n"
+          end
+
+          rets << (" " * ( (inner_index + 1) * 2 )) + "}.merge(options)\n\n"
+        end
+
+        rets << (" " * ( (inner_index + 1) * 2 )) + "load_options(:#{dependencies.join(', :')}, options)\n"
+        rets << (" " * ( inner_index * 2 )) + "end\n\n"
+
+        # The execute! method
+        rets << (" " * ( inner_index * 2 )) + "def execute!\n"
+        rets << (" " * ( (inner_index + 1) * 2 )) + "return PayDirt::Result.new(success: true, data: nil)\n"
+        rets << (" " * ( inner_index * 2 )) + "end\n"
+
+        rets << (" " * ( klass_index * 2)) + "end\n"
+
+        class_names[0..-1].each_with_index do |mod,i|
+          rets << (" " * ( (class_names.length - (i + 1)).abs * 2 )) + "end\n"
+        end
+
+        rets
+      end
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: pay_dirt
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.0.1
 platform: ruby
 authors:
 - Tad Hosford
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-06-07 00:00:00.000000000 Z
+date: 2013-06-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: minitest
@@ -24,6 +24,20 @@ dependencies:
     - - '>='
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: thor
+  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: coveralls
   requirement: !ruby/object:Gem::Requirement
@@ -73,6 +87,7 @@ files:
 - lib/pay_dirt/use_case.rb
 - lib/pay_dirt/version.rb
 - pay_dirt.gemspec
+- pay_dirt.thor
 - test/test_helper.rb
 - test/unit/.gitkeep
 - test/unit/pay_dirt/base_test.rb