pay_dirt 0.0.2 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f7ff86dfbc9179c07a08070206bc43f1715d0e36
-  data.tar.gz: eab83e620f4897c405cf4f3fa5a0cb949978da7e
+  metadata.gz: 07dc40d695e2b51aa09cac2f1accd89c2cd1579e
+  data.tar.gz: 53388f63da7158e9bb2cfe408699ab35ad8717a4
 SHA512:
-  metadata.gz: 75104e49d44c143d955932427e8e89cb6b4b05ba1e7c7840228d32889f500eb7d05c2e51476c00b2b6849d0e11692fef058292d64bcda6c6a1bf2436d5dd5951
-  data.tar.gz: 5560575c53412632cc24eedfc015c0d81cb38d67bab4084f9fc7c75c87d105092afed5a91aefddb8c06b25b99e78f0b4004e706ff2cae753c6444eff7480f7b4
+  metadata.gz: c9462187bf0aad679b35c874a2406f30af1b579a46d85b57f6f3adf5d9875f61271555b2c7ae65b027cd14a903086668402ef9d78999732529668d9651005f43
+  data.tar.gz: a70f7bfa4b89d89d96adacd574206ee76e7750df99f3b192cec26b7400ce721f9030e62900c4949191f82cf837dc8b043d7ea1178bfef3da4e2d28f16f33618b

data/README.md

@@ -3,60 +3,59 @@
 
 Provides the basic building blocks of a pattern capable of reducing a towering codebase to modular rubble (or more Ruby gems)
 
-The [pay_dirt/base_test](https://github.com/rthbound/pay_dirt/blob/master/test/unit/pay_dirt/base_test.rb) provides a complete working example. It's all plain old Ruby, but you can require any dependency you like to be injected as an option via [load_options](https://github.com/rthbound/pay_dirt/blob/master/test/unit/pay_dirt/base_test.rb#L8)
-
-    describe PayDirt::Base do
-      before do
-
-        # A sample use case
-        module UseCase
-          class UltimateQuestion < PayDirt::Base
-            def initialize(options)
-              load_options(:the_secret_to_life_the_universe_and_everything, options)
-            end
-
-            def execute!
-              if @the_secret_to_life_the_universe_and_everything == 42
-                return PayDirt::Result.new(data: @the_secret_to_life_the_universe_and_everything, success: true)
-              else
-                return PayDirt::Result.new(data: @the_secret_to_life_the_universe_and_everything, success: false)
-              end
-            end
-          end
-        end
-
-        @use_case = UseCase::UltimateQuestion
-      end
-
-      it "must inherit from PayDirt::Base" do
-         assert_operator @use_case, :<, PayDirt::Base
-      end
-
-      it "must error when initialized without required options" do
-        begin
-          @use_case.new
-        rescue => e
-          e.must_be_kind_of ArgumentError
-        end
-      end
-
-      it "can execute successfully" do
-        dependencies = {
-          the_secret_to_life_the_universe_and_everything: 42
-        }
-
-        result = @use_case.new(dependencies).execute!
-
-        result.successful?.must_equal true
-      end
-
-      it "can execute successfully" do
-        dependencies = {
-          the_secret_to_life_the_universe_and_everything: :i_dunno
-        }
-
-        result = @use_case.new(dependencies).execute!
-
-        result.successful?.must_equal false
-      end
+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
+
+  def initialize(options)
+    options = {
+      required_option_with_default_value: true
+    }.merge(options)
+
+    load_options(:required_option_with_default_value, :required_option, options)
+  end
+
+  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
+
+  private
+  def return_value
+    {
+      optional_option:  @optional_option,
+      required_option1: @required_option_with_default_value,
+      required_option2: @required_option
+    }
+  end
+end
+```
+
+Example class usage:
+
+```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
+```

data/lib/pay_dirt/use_case.rb

@@ -6,10 +6,15 @@ module PayDirt
         instance_variable_set("@#{option}", options.fetch(option.to_sym) {
           raise "Missing required option: #{option}"
         })
+
+        options.delete(option)
+
+        return options
       end
 
       def load_options(*option_names, options)
-        option_names.each { |o| load_option(o, options) }
+        option_names.each { |o| options = load_option(o, options) }
+        options.each_key      { |o| options = load_option(o, options) }
       end
     end
   end

data/lib/pay_dirt/version.rb

@@ -1,3 +1,3 @@
 module PayDirt
-  VERSION = "0.0.2"
+  VERSION = "0.0.3"
 end

data/test/unit/pay_dirt/use_case_test.rb

@@ -3,6 +3,7 @@ require_relative "../../../lib/pay_dirt/use_case"
 
 describe PayDirt::UseCase do
   before do
+
     module UseCase
       class UltimateQuestion
         include PayDirt::UseCase
@@ -17,11 +18,20 @@ describe PayDirt::UseCase do
 
         def execute!
           if @the_secret_to_life_the_universe_and_everything == 42
-            return PayDirt::Result.new(data: @the_secret_to_life_the_universe_and_everything, success: true)
+            return PayDirt::Result.new(data: return_value, success: true)
           else
             return PayDirt::Result.new(data: @the_secret_to_life_the_universe_and_everything, success: false)
           end
         end
+
+        private
+
+        def return_value
+          {
+            secret: @the_secret_to_life_the_universe_and_everything,
+            some_random_option: @some_random_option
+          }
+        end
       end
     end
 
@@ -39,6 +49,11 @@ describe PayDirt::UseCase do
     @use_case.new({}).must_respond_to :execute!
   end
 
+  it "loads options that are not required" do
+    result = @use_case.new({ some_random_option: true }).execute!
+    assert result.data[:some_random_option]
+  end
+
   it "can execute successfully" do
     dependencies = {
     }
@@ -58,4 +73,48 @@ describe PayDirt::UseCase do
 
     result.successful?.must_equal false
   end
+
+  it "has optional options" do
+    class SomeThing
+      include PayDirt::UseCase
+
+      def initialize(options)
+        options = {
+          required_option_with_default_value: true
+        }.merge(options)
+
+        load_options(:required_option_with_default_value, :required_option, options)
+      end
+
+      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
+
+      private
+      def return_value
+        {
+          optional_option:  @optional_option,
+          required_option1: @required_option_with_default_value,
+          required_option2: @required_option
+        }
+      end
+    end
+
+    # Cheating by not injecting all dependencies
+    result = SomeThing.new(required_option: true).execute! # Returns a PayDirt::Result
+    assert !result.successful?                             #=> false
+    result.data[:optional_option].must_be_nil              #=> nil
+    # Playing nice and injecting all required dependencies
+    result = SomeThing.new(required_option: true, required_option_with_default_value: false).execute!
+    assert result.successful?                              #=> true
+    result.data[:optional_option].must_be_nil              #=> nil
+    # Making use of an optional option
+    result = SomeThing.new(required_option: true, optional_option: true).execute!
+    assert !result.successful?                             #=> false
+    assert result.data[:optional_option]                   #=> true
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: pay_dirt
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
 platform: ruby
 authors:
 - Tad Hosford
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-04-28 00:00:00.000000000 Z
+date: 2013-04-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: minitest