pay_dirt 1.0.1 → 1.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 0b0248574c00871f3ef6676055ad9fb7c48acd35
-  data.tar.gz: 8337f0b5fe6377dfaa00183b62465ecec055f17a
+  metadata.gz: cf8344185d4a1298169b244cf23f489243eace6b
+  data.tar.gz: 32a3740b097d5e552821911207567a0a2bfa91c2
 SHA512:
-  metadata.gz: 7f21b11cf6ae2914e06fdc48c7ae2e7e3de1f6f4f6f47ea79ecbc22ea3ce6cb8e1325e380e7bb97ed4237333810b820cb6d9d1d017c3c51adda455dec8e5ff4d
-  data.tar.gz: bc92bbb77e64ad90bad2c5a0a521174d5b6f38c0e3ae827927f62f8d1698ca89f9d2d4a43d8b88557739e10c026123f95e23e3d26b0ebfd0de9c276aeb640283
+  metadata.gz: fc804ad76e3d60ad5afb2426a19f6880cec4768261e4406859ee8227ff8ff2da891502dba57765177570889490e7726ced468ab7d7dedddb6a97d6d53c05d04d
+  data.tar.gz: dd906232ef74d54c6248d2fbfe844929822b4c08fd65b110b16ed1e290b7f64ce6520111a5205e7dec6574730defd2dc0dd99ed63f491b55c2e951c397c1de60

data/.travis.yml

@@ -1,4 +1,9 @@
 language: ruby
+
+matrix:
+  allow_failures:
+    - rvm: ruby-head
+
 rvm:
   - 2.0.0
   - 1.9.3
@@ -6,4 +11,5 @@ rvm:
   - jruby-19mode
   - ruby-head
   - jruby-head
+
 script: bundle exec rake test

data/README.md

@@ -2,27 +2,35 @@
 
 #### A Ruby gem based on the "use case" pattern set forth in [opencurriculum-flashcards](https://github.com/isotope11/opencurriculum-flashcards)
 
-Provides the basic building blocks of a pattern capable of reducing a towering codebase to modular rubble (or more Ruby gems)
+Reduce a towering codebase to modular rubble (or more Ruby gems) with **PayDirt**
 
 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)
 
-### Generators
-
-PayDirt now provides a service object generator, powered by [thor](https://github.com/erikhuda/thor). It takes a few options
-
-`--dependencies` or `-d` : An array of required dependencies (this option is required)
-
-`--defaults` or `-D` : An optional hash of default values for dependencies
-
-`--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:
+service object generator
+------------------------
+pay_dirt now provides a service object generator,
+powered by [thor](https://github.com/erikhuda/thor).
+It'll tell you **how it's used**:
+```
+$ thor help pay_dirt:service_object:new
+Usage:
+  thor pay_dirt:service_object:new FILE -d, --dependencies=one two three
+
+Options:
+  -d, --dependencies=one two three  # specify required dependencies
+  -D, [--defaults=key:value]        # Specify default dependencies
+  -i, [--inherit]                   # inherit from PayDirt::Base class
+                                    # Default: true
+  -m, [--include]                   # include the PayDirt::UseCase module (overrides --inherit)
+
+create a service object
+```
 
+example
+-------
 ```
 $ thor pay_dirt:service_object:new digit_check -d fingers toes -D fingers:10 toes:10
   create  lib/service_objects/digit_check.rb
@@ -49,10 +57,18 @@ module ServiceObjects
   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
+### Usage:
+```ruby
+require "service_objects/digit_check"  #=> true
+ServiceObjects::DigitCheck.new.execute!
+ #=> #<PayDirt::Result:0xa0be85c @data=nil, @success=true>
+```
+As you can see, we can now call `ServiceObjects::DigitCheck.new(fingers: 10, toes: 10).execute!`
+and expect a successful return object. Where you take it from there is up to you.
+
+more examples
+-------------
 1. [rubeuler](https://github.com/rthbound/rubeuler)
 2. [protected_record](https://github.com/rthbound/protected_record)
 3. [konamio](https://github.com/rthbound/konamio)

data/lib/pay_dirt/version.rb

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

data/pay_dirt.thor

@@ -3,80 +3,78 @@ module PayDirt
     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",
+      desc: "specify required dependencies",
       required: true
-
+    method_option :defaults,
+      type: :hash,
+      aliases: "-D",
+      desc: "Specify default dependencies"
     method_option :inherit,
       type:         :boolean,
-      desc:         "Should inherit from PayDirt::Base (default)",
+      desc:         "inherit from PayDirt::Base class",
       aliases:      "-i",
       default:      true,
       lazy_default: true
-
     method_option :include,
       type:         :boolean,
-      desc:         "Should include the PayDirt::UseCase module",
+      desc:         "include the PayDirt::UseCase module (overrides --inherit)",
       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]
 
+      # Favor 2 spaces
+      append = Proc.new { |depth, string, rets| rets << ("  " * depth) + string }
+
       create_file "lib/service_objects/#{file}.rb" do
-        rets << "require 'pay_dirt'\n\n"
-        rets << "module ServiceObjects\n"
+        rets = append.call(0, "require 'pay_dirt'\n\nmodule ServiceObjects\n", rets)
         class_names[0..-2].each_with_index do |mod,i|
-          rets << (" " * ( (i+1) * 2 )) + "module #{mod}\n"
+          rets = append.call(i.next, "module #{mod}\n", rets)
         end
 
-        klass, klass_index = class_names[-1], class_names.length
+        class_name, class_depth = class_names.last, class_names.length
 
         if options[:include]
-          rets << (" " * ( klass_index * 2)) + "class #{class_names[-1]}\n"
-          rets << (" " * ((klass_index + 1) * 2)) + "include PayDirt::UseCase\n"
+          rets = append.call(class_depth, "class #{class_name}\n", rets)
+          rets = append.call(class_depth.next, "include PayDirt::UseCase\n", rets)
         elsif options[:inherit]
-          rets << (" " * ( klass_index * 2)) + "class #{class_names[-1]} < PayDirt::Base\n"
+          rets = append.call(class_depth, "class #{class_name} < PayDirt::Base\n", rets)
         end
 
-        inner_index = klass_index + 1
+        inner_depth = class_depth.next
 
         # The initialize method
-        rets << (" " * ( inner_index * 2 )) + "def initialize(options = {})\n"
+        rets = append.call(inner_depth, "def initialize(options = {})\n", rets)
 
         # Configure dependencies' default values
         if options[:defaults]
-          rets << (" " * ( (inner_index + 1) * 2 )) + "options = {\n"
+          rets = append.call(inner_depth.next, "options = {\n", rets)
 
           defaults.each do |k,v|
-            rets << (" " * ( (inner_index + 2) * 2 )) + "#{k}: #{v}" + ",\n"
+            rets = append.call(inner_depth + 2, "#{k}: #{v}" + ",\n", rets)
           end
 
-          rets << (" " * ( (inner_index + 1) * 2 )) + "}.merge(options)\n\n"
+          rets = append.call(inner_depth.next, "}.merge(options)\n\n", rets)
         end
 
-        rets << (" " * ( (inner_index + 1) * 2 )) + "load_options(:#{dependencies.join(', :')}, options)\n"
-        rets << (" " * ( inner_index * 2 )) + "end\n\n"
+        rets = append.call(inner_depth.next, "load_options(:#{dependencies.join(', :')}, options)\n", rets)
+        rets = append.call(inner_depth, "end\n\n", rets)
 
         # 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 = append.call(inner_depth, "def execute!\n", rets)
+        rets = append.call(inner_depth.next, "return PayDirt::Result.new(success: true, data: nil)\n", rets)
+        rets = append.call(inner_depth, "end\n", rets)
 
-        rets << (" " * ( klass_index * 2)) + "end\n"
+        rets = append.call(class_depth, "end\n", rets) # Closes innermost class definition
 
         class_names[0..-1].each_with_index do |mod,i|
-          rets << (" " * ( (class_names.length - (i + 1)).abs * 2 )) + "end\n"
+          rets = append.call(class_depth - (i + 1), "end\n", rets)
         end
 
         rets

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: pay_dirt
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 1.0.2
 platform: ruby
 authors:
 - Tad Hosford
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-06-21 00:00:00.000000000 Z
+date: 2013-06-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: minitest