pay_dirt 1.0.6 → 1.0.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 497b43e39556e1bd2161989fc36d09fd5bf90198
-  data.tar.gz: a32175d9aca9538979e4136b5284cf8cb7e1d45f
+  metadata.gz: 80daedc2e23621dd1692c5092c9cce375baf07a3
+  data.tar.gz: 6db425bb6a5785adb71396cfa42ef26fdc29ecf0
 SHA512:
-  metadata.gz: 833a274e4dd2970dc8c2c658f79c9e68750d3209d6b9d2ffb7ce269afdd6e48e8463be589a91e799236904edaadc7bab0ad2fab10412922d6cb78376403fa3ba
-  data.tar.gz: b9057b19d1f34058b458b6c8f82b634cb676f003a8ccf65f55d5a3dff5d4593aa44b7d8de62bcb6294a24f0f74403da1bedc519eb5c8c40bffcaafd7554e8790
+  metadata.gz: 6d5956acf790c96f0086e66b0312cbfe4037e421ff3f902a23386f937fe265f458738c299c8d0fd183efd942e860a2cc305cbf25bbf0f8d749806f95c05b6277
+  data.tar.gz: 6cb08a75659b00259a7b273d6c0107c9f30a669817710fb97c2814984788cacb9065e4c4b000fa70622039eea600d7d6aaf20334197254123b687d7e8bda1183

data/README.md

@@ -65,7 +65,7 @@ module ServiceObjects
     end
 
     def execute!
-      return PayDirt::Result.new(success: true, data: nil)
+      result(true)
     end
   end
 end

data/lib/pay_dirt/use_case.rb

@@ -20,6 +20,19 @@ module PayDirt
         options.each_key  { |o| options = load_option(o, options) }
       end
 
+      # Returns a result object representing success.
+      #
+      # @param [List<String,Symbol>]
+      #   success should the result be +#successful?+
+      #
+      # @param [Object]
+      #   data (nil) optional, an object containing information
+      #
+      # @public
+      def result(success, data = nil)
+        PayDirt::Result.new(success: success, data: data)
+      end
+
       private
       # @private
       def load_option(option, options)

data/lib/pay_dirt/version.rb

@@ -1,3 +1,3 @@
 module PayDirt
-  VERSION = "1.0.6"
+  VERSION = "1.0.7"
 end

data/pay_dirt.thor

@@ -68,7 +68,7 @@ module PayDirt
     def write_execute_method
       # The execute! method
       @append.call(@inner_depth, "def execute!\n")
-      @append.call(@inner_depth.next, "return PayDirt::Result.new(success: true, data: nil)\n")
+      @append.call(@inner_depth.next, "return result(true)\n")
       @append.call(@inner_depth, "end\n")
     end
 

data/test/unit/pay_dirt/base_test.rb

@@ -10,15 +10,12 @@ describe PayDirt::Base do
             the_question: "What is the secret to life, the universe, and everything?"
           }.merge(options)
 
-          load_options(:the_question, :the_secret_to_life_the_universe_and_everything, options)
+          load_options(:the_question, :the_secret, 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
+          @the_secret == 42 and return result(true, @the_secret )
+          return result(false)
         end
       end
     end
@@ -31,17 +28,17 @@ describe PayDirt::Base do
     assert lineage.include?("PayDirt::Base")
   end
 
-  it "must error when initialized without required options" do
+  it "will error when initialized without required options" do
     proc { @use_case.new }.must_raise ArgumentError
   end
 
-  it "it won't error if defaults were supplied for an omitted option" do
-    @use_case.new(the_secret_to_life_the_universe_and_everything: :not_telling).must_respond_to :execute!
+  it "won't error if defaults were supplied for an omitted option" do
+    @use_case.new(the_secret: :not_telling).must_respond_to :execute!
   end
 
   it "can execute successfully" do
     dependencies = {
-      the_secret_to_life_the_universe_and_everything: 42
+      the_secret: 42
     }
 
     result = @use_case.new(dependencies).execute!
@@ -52,7 +49,7 @@ describe PayDirt::Base do
 
   it "can execute unsuccessfully" do
     dependencies = {
-      the_secret_to_life_the_universe_and_everything: :i_dunno
+      the_secret: :i_dunno
     }
 
     result = @use_case.new(dependencies).execute!

data/test/unit/pay_dirt/result_test.rb

@@ -11,4 +11,32 @@ describe PayDirt::Result do
     pay_dirt = PayDirt::Result.new(data: 'foo')
     pay_dirt.data.must_equal 'foo'
   end
+
+  describe "has a little helper method" do
+    before do
+      class Subject < PayDirt::Base
+        def initialize(options)
+          load_options(:success, :data, options)
+        end
+
+        def execute!
+          result(@success, @data)
+        end
+      end
+
+      @pay_dirt = Subject
+    end
+
+    it "can succeed" do
+      @pay_dirt.new(success: true, data: "yum").execute!.successful?.must_equal true
+    end
+
+    it "can be unsuccessful" do
+      @pay_dirt.new(success: false, data: "gross").execute!.successful?.must_equal false
+    end
+
+    it "provides access to data" do
+      @pay_dirt.new(success: true, data: "yum").execute!.data.must_equal "yum"
+    end
+  end
 end

metadata

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