pay_dirt 1.0.8 → 1.0.9

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: deb62d56966b35151bb79ca90be9ef8782668bb7
-  data.tar.gz: daec7ce9dc30b8c260de4e0eabac949c92e24401
+  metadata.gz: b57e758bcc9b93c274185526b7aab9e36088447d
+  data.tar.gz: 06b703b2c97f3d2d9073e2b72a15e1b5f3400b74
 SHA512:
-  metadata.gz: 55677cf4e2a832677f672c8b9e332a2f40ca3df46c1c517bbc0cef4365f5c90b4726da53b4cd4f48a556f3e83596860d98c08f9db4ca377ffbef765c8292f43a
-  data.tar.gz: b422b2fbf53018bd23d471cfebb351645d845459fe1298d225ea4ee643ed6f184c1c7e71dfbfbc92b5e1cd4dae57bc8bf058a3ab0cf90c7400e80e848147803c
+  metadata.gz: d4fc4a28cd10416757ef6a6eae0da1c47c655493f445ef1f51146f080fee3ae331d8f18bef6d8fafe5f2960cbc1b515aa78289c9c4c54d2720ac0745d0b28be2
+  data.tar.gz: bb56fe12bc73ea1cbdb5bf18cc25343d00bcd6acdd7630e75d666e45ddf3fee3fd2eebef71c0909eb85e60f0d468693f2d743c2f30afa7708ffa01d0c899b8b1

data/.gitignore

@@ -9,7 +9,8 @@
 .ruby-gemset
 /.bundle
 
-lib/service_objects
+lib/quick
+test/unit/quick
 
 *.sw?
 .sw?

data/.travis.yml

@@ -2,13 +2,17 @@ language: ruby
 
 matrix:
   allow_failures:
-    - rvm: ruby-head
+    - rvm: ree
+
 
 rvm:
+  - 2.2.1
+  - 2.1.4
   - 2.0.0
   - 1.9.3
   - 1.9.2
   - jruby
   - ruby-head
+  - rbx
 
-script: bundle exec rake test
+script: bundle exec rake test; bundle exec rake test # run twice to test generated classest & tests

data/lib/pay_dirt/base.rb

@@ -1,7 +1,10 @@
 require_relative 'use_case'
 
-# Here's something to inherit from
 module PayDirt
+  # A developer can optionally inherit from this base class, rather than include the PayDirt::UseCase module --
+  # this is obviously not possible if your service object's class is already inheriting from another class.
+  #
+  # @since 0.0.0
   class Base
     include PayDirt::UseCase
   end

data/lib/pay_dirt/result.rb

@@ -1,4 +1,5 @@
 module PayDirt
+  # Provides developers with a [re]usable result object for their service objects to return.
   class Result
     # The response from a use case execution
     #

data/lib/pay_dirt/use_case.rb

@@ -1,51 +1,52 @@
 module PayDirt
+  # Provides the basic functionality every PayDirt service object should have.
+  # @since 0.0.2
   module UseCase
-    def self.included(base)
-      # Load instance variables from the provided hash of dependencies.
-      #
-      # Raises if any required dependencies are missing from +options+ hash.
-      #
-      # @param [List<String,Symbol>]
-      #   option_names list of keys representing required dependencies
-      #
-      # @param [Hash]
-      #   options A hash of dependencies
-      #
-      # @public
-      def load_options(*option_names, options)
-        # Load required options
-        option_names.each { |o| options = load_option(o, options) }
+    # Load instance variables from the provided hash of dependencies.
+    #
+    # Raises if any required dependencies (+required_options+) are missing from +options+ hash.
+    #
+    # @param [List<String,Symbol>]
+    #   option_names list of keys representing required dependencies
+    #
+    # @param [Hash]
+    #   options A hash of dependencies
+    #
+    # @public
+    def load_options(*required_options, options)
+      # Load required options
+      required_options.each { |o| options = load_option(o, options) }
 
-        # Load remaining options
-        options.each_key  { |o| options = load_option(o, options) }
-      end
+      # Load remaining options
+      options.each_key  { |k| options = load_option(k, 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
+    # Returns a result object conveying success or failure (+success+)
+    # and any +data+. See PayDirt::Result.
+    #
+    # @param [Boolean]
+    #   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)
-        instance_variable_set("@#{option}", fetch(option, options))
-        options.delete(option)
+    private
+    # @private
+    def load_option(option, options)
+      instance_variable_set("@#{option}", fetch(option, options))
+      options.delete(option)
 
-        return options
-      end
+      return options
+    end
 
-      # @private
-      def fetch(opt, opts)
-        opts.fetch(opt.to_sym) { raise "Missing required option: #{opt}" }
-      end
+    # @private
+    def fetch(opt, opts)
+      opts.fetch(opt.to_sym) { raise "Missing required option: #{opt}" }
     end
   end
 end

data/lib/pay_dirt/version.rb

@@ -1,3 +1,3 @@
 module PayDirt
-  VERSION = "1.0.8"
+  VERSION = "1.0.9"
 end

data/pay_dirt.thor

@@ -89,19 +89,27 @@ module PayDirt
     end
 
     # TESTS!
+    def boiler_plate_test_classes(helper_name, file)
+      append(0, "require '#{helper_name}'\n\n")
+
+      File.file? "test/#{helper_name}.rb" or create_file "test/#{helper_name}.rb"
+
+      prepend_to_file "test/#{helper_name}.rb" do
+        "require \"minitest/autorun\"\n"
+      end
+      append_to_file "test/#{helper_name}.rb" do
+        "require \"#{file}\"\n"
+      end
+    end
+
     def open_test_class(class_names, file)
       case options[:test_framework]
       when "minitest", "mini_test"
-        append(0, "require 'minitest_helper'\n\n")
-        append_to_file "test/minitest_helper.rb" do
-          "require \"#{file}\"\n"
-        end
+        boiler_plate_test_classes("minitest_helper", file)
       else
-        append(0, "require 'test_helper'\n\n")
-        append_to_file "test/test_helper.rb" do
-          "require \"#{file}\"\n"
-        end
+        boiler_plate_test_classes("test_helper", file)
       end
+
       append(0, "describe #{ class_string(class_names) } do\n")
     end
 

data/test/test_helper.rb

@@ -7,3 +7,5 @@ require "minitest/autorun"
 $: << File.dirname(__FILE__) + "/../lib"
 $: << File.dirname(__FILE__)
 
+`thor pay_dirt:service_object:new quick/digit_check -d fingers toes nose -D fingers:10 toes:10`
+

data/test/unit/pay_dirt/base_test.rb

@@ -4,7 +4,7 @@ require_relative "../../../lib/pay_dirt/base"
 describe PayDirt::Base do
   before do
     module UseCase
-      class UltimateQuestion < PayDirt::Base
+      class UltimateQuestionBase < PayDirt::Base
         def initialize(options)
           options = {
             the_question: "What is the secret to life, the universe, and everything?"
@@ -20,11 +20,11 @@ describe PayDirt::Base do
       end
     end
 
-    @use_case = UseCase::UltimateQuestion
+    @use_case = UseCase::UltimateQuestionBase
   end
 
   it "must inherit from PayDirt::Base" do
-    lineage = UseCase::UltimateQuestion.ancestors.map(&:to_s)
+    lineage = UseCase::UltimateQuestionBase.ancestors.map(&:to_s)
     assert lineage.include?("PayDirt::Base")
   end
 

data/test/unit/pay_dirt/use_case_test.rb

@@ -5,7 +5,7 @@ describe PayDirt::UseCase do
   before do
 
     module UseCase
-      class UltimateQuestion
+      class UltimateQuestionInclude
         include PayDirt::UseCase
 
         def initialize(options)
@@ -35,7 +35,7 @@ describe PayDirt::UseCase do
       end
     end
 
-    @use_case = UseCase::UltimateQuestion
+    @use_case = UseCase::UltimateQuestionInclude
   end
 
   it "need not inherit from PayDirt::Base" do

metadata

@@ -1,69 +1,69 @@
 --- !ruby/object:Gem::Specification
 name: pay_dirt
 version: !ruby/object:Gem::Version
-  version: 1.0.8
+  version: 1.0.9
 platform: ruby
 authors:
 - Tad Hosford
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-10-13 00:00:00.000000000 Z
+date: 2015-07-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: minitest
   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: 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
     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: rake
   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'
 description: |2
@@ -77,8 +77,8 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- .gitignore
-- .travis.yml
+- ".gitignore"
+- ".travis.yml"
 - Gemfile
 - LICENSE
 - README.md
@@ -104,17 +104,17 @@ 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.0.3
+rubygems_version: 2.4.5
 signing_key: 
 specification_version: 4
 summary: Reduce a towering codebase to modular rubble (or more rubygems) with pay_dirt