pay_dirt 1.0.9 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b57e758bcc9b93c274185526b7aab9e36088447d
-  data.tar.gz: 06b703b2c97f3d2d9073e2b72a15e1b5f3400b74
+  metadata.gz: ffeeff8d4440f09161c3c3e2a6640f408e94e836
+  data.tar.gz: 2eb8d29fce1ef75e051cabf54f629ccb5dbc911e
 SHA512:
-  metadata.gz: d4fc4a28cd10416757ef6a6eae0da1c47c655493f445ef1f51146f080fee3ae331d8f18bef6d8fafe5f2960cbc1b515aa78289c9c4c54d2720ac0745d0b28be2
-  data.tar.gz: bb56fe12bc73ea1cbdb5bf18cc25343d00bcd6acdd7630e75d666e45ddf3fee3fd2eebef71c0909eb85e60f0d468693f2d743c2f30afa7708ffa01d0c899b8b1
+  metadata.gz: 5aea0e06d716def907dd6c9e2f0ea1e1d173dcea68daa4675a4aaf8c6422a7ad83f1d40e7d77835f1ac1c190fba834063b4c9ab75099c8b55c5556d0a9db951b
+  data.tar.gz: 97a406eef26f42a45083db37ce6e102f1ca4369953d24b8c7ea3772e34bb21a7950575dc50e42c75a88c1432a7df8493a598a8bed0f9c86698b9830c0bc04643

data/.travis.yml

@@ -1,18 +1,12 @@
 language: ruby
 
-matrix:
-  allow_failures:
-    - rvm: ree
-
-
 rvm:
-  - 2.2.1
-  - 2.1.4
+  - 2.4.0
+  - 2.3.3
+  - 2.2.6
+  - 2.1.10
   - 2.0.0
-  - 1.9.3
-  - 1.9.2
   - jruby
   - ruby-head
-  - rbx
 
-script: bundle exec rake test; bundle exec rake test # run twice to test generated classest & tests
+script: bundle exec rake test; bundle exec rake test # run twice to test the generator (thor scripts) via generated classes & tests

data/README.md

@@ -53,16 +53,18 @@ After installing, you can use your new generator *anywhere* you can use thor. It
 ```
 $ thor help pay_dirt:service_object:new
 Usage:
-  thor pay_dirt:service_object:new FILE -d, --dependencies=one two three
+  thor pay_dirt:service_object:new FILE
 
 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
+  -d, [--dependencies=one two three]     # specify required dependencies
+      [--test-framework=TEST_FRAMEWORK]  # choose a testing framework
+  -D, [--defaults=key:value]             # Specify default dependencies
+  -V, [--validations=VALIDATIONS]        # Add validations
+  -i, [--inherit], [--no-inherit]        # inherit from PayDirt::Base class
+                                         # Default: true
+  -m, [--include], [--no-include]        # include the PayDirt::UseCase module (overrides --inherit)
+
+create a fully tested object (optionally, requires dependencies)
 ```
 
 example
@@ -141,6 +143,25 @@ Quick::DigitCheck.new(nose: true).call
 As you can see, we can now call `Quick::DigitCheck.new(nose: true).call`
 and expect a successful return object. Where you take it from there is up to you.
 
+### Validations
+
+Version 1.1.0 adds validations, and does so in a backward compatible way. This was accomplished by
+modifying the `#load_options` to yield a block if given, otherwise it will return the options hash
+as normal. The following shows how to validate service objects using the example from class earlier
+in this README.
+
+    def initialize(options = {})
+      options = {
+        fingers: 10,
+        toes: 10,
+      }.merge(options)
+
+      load_options(:fingers, :toes, :nose, options) do
+        raise "Oh noes!" unless @fingers == @toes
+        raise "No nose?" if !!@nose
+      end
+    end
+
 more examples
 -------------
 1. [rubeuler](https://github.com/rthbound/rubeuler)

data/lib/pay_dirt/use_case.rb

@@ -5,6 +5,7 @@ module PayDirt
     # Load instance variables from the provided hash of dependencies.
     #
     # Raises if any required dependencies (+required_options+) are missing from +options+ hash.
+    # Optionally, takes and yields a block after loading options. Use this to validate dependencies.
     #
     # @param [List<String,Symbol>]
     #   option_names list of keys representing required dependencies
@@ -19,6 +20,8 @@ module PayDirt
 
       # Load remaining options
       options.each_key  { |k| options = load_option(k, options) }
+
+      block_given? ? yield : options
     end
 
     # Returns a result object conveying success or failure (+success+)

data/lib/pay_dirt/version.rb

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

data/pay_dirt.thor

@@ -4,16 +4,21 @@ module PayDirt
 
     desc "new FILE", "create a fully tested object (optionally, requires dependencies)"
     method_option :dependencies,
-      type: :array,
-      aliases: "-d",
-      desc:    "specify required dependencies"
+      type:         :array,
+      aliases:      "-d",
+      desc:         "specify required dependencies"
     method_option :test_framework,
-      type: :string,
-      desc:    "choose a testing framework"
+      type:         :string,
+      desc:         "choose a testing framework"
     method_option :defaults,
-      type: :hash,
-      aliases: "-D",
-      desc: "Specify default dependencies"
+      type:         :hash,
+      aliases:      "-D",
+      desc:         "Specify default dependencies"
+    method_option :validations,
+      type:         :boolean,
+      aliases:      "-V",
+      lazy_default: true,
+      desc:         "Add validations"
     method_option :inherit,
       type:         :boolean,
       desc:         "inherit from PayDirt::Base class",
@@ -77,7 +82,15 @@ module PayDirt
       append(@inner_depth.next, "# will fail if any keys given before options aren't in options\n")
       append(@inner_depth.next, "load_options(")
       @dependencies.each { |dep| append(0, ":#{dep}, ") }
-      append(0, "options)\n")
+      append(0, "options)")
+
+      if options[:validations]
+        append(0, " do\n")
+        append(@inner_depth.next, "end\n")
+      else
+        append(0,"\n")
+      end
+
     end
 
     def set_defaults

data/test/test_helper.rb

@@ -7,5 +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`
-
+`thor pay_dirt:service_object:new quick/digit_check     -d fingers toes nose -D fingers:10 toes:10`
+`thor pay_dirt:service_object:new quick/digit_guarantee -d fingers toes nose -D fingers:10 toes:10 -V`

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: pay_dirt
 version: !ruby/object:Gem::Version
-  version: 1.0.9
+  version: 1.1.0
 platform: ruby
 authors:
 - Tad Hosford
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-07-04 00:00:00.000000000 Z
+date: 2017-03-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: minitest
@@ -114,8 +114,13 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.5
+rubygems_version: 2.6.8
 signing_key: 
 specification_version: 4
 summary: Reduce a towering codebase to modular rubble (or more rubygems) with pay_dirt
-test_files: []
+test_files:
+- test/test_helper.rb
+- test/unit/.gitkeep
+- test/unit/pay_dirt/base_test.rb
+- test/unit/pay_dirt/result_test.rb
+- test/unit/pay_dirt/use_case_test.rb