pay_dirt 1.0.4 → 1.0.5

data/lib/pay_dirt/base.rb

@@ -1,6 +1,6 @@
 require_relative 'use_case'
 
-# Here's something you can inherit from
+# Here's something to inherit from
 module PayDirt
   class Base
     include PayDirt::UseCase

data/lib/pay_dirt/use_case.rb

@@ -1,15 +1,28 @@
 module PayDirt
   module UseCase
     def self.included(base)
+      # @overload load_options(keys, options)
+      #   Sets instance variables for all provided key value pairs in +options+.
+      #   Raises error if required keys cannot be fond in options.
+      #   @param [List<String,Symbol>] keys a List of (Strings or Symbols) that must be contained in +options+
+      #   @param [Hash] options hash of options (dependencies)
+      # @overload load_options(options)
+      #   Sets instance variables for all provided key value pairs in +options+
+      #   @param [Hash] options hash of options (dependencies)
+      # @api public
       def load_options(*option_names, options)
         # Load required options
         option_names.each { |o| options = load_option(o, options) }
-        
+
         # Load remaining options
         options.each_key  { |o| options = load_option(o, options) }
       end
 
       private
+      # @param [Symbol,String] option The option to load from the provided options hash.
+      # @param [Hash] options The provided hash of options
+      # @return [Hash] Deletes the key value pair at `option` and returns the remaining options hash
+      # @api private
       def load_option(option, options)
         instance_variable_set("@#{option}", fetch(option, options))
         options.delete(option)
@@ -17,6 +30,9 @@ module PayDirt
         return options
       end
 
+      # @param [Symbol, String] opt the key to fetch from +opts+
+      # @param [Hash] opts the hash of options from which +opt+ will be fetched
+      # @api private
       def fetch(opt, opts)
         opts.fetch(opt.to_sym) { raise "Missing required option: #{opt}" }
       end

data/lib/pay_dirt/version.rb

@@ -1,3 +1,3 @@
 module PayDirt
-  VERSION = "1.0.4"
+  VERSION = "1.0.5"
 end

data/pay_dirt.gemspec

@@ -15,8 +15,8 @@ Gem::Specification.new do |s|
                       (or more Ruby gems)
                     }
   s.summary     = %q{
-                      Based on a pattern introduced to me
-                      by knewter.
+                      Reduce a towering codebase to modular
+                      rubble (or more rubygems) with pay_dirt
                     }
 
   s.files         = `git ls-files`.split("\n")

metadata

@@ -1,72 +1,81 @@
 --- !ruby/object:Gem::Specification
 name: pay_dirt
 version: !ruby/object:Gem::Version
-  version: 1.0.4
+  version: 1.0.5
+  prerelease: 
 platform: ruby
 authors:
 - Tad Hosford
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-06-24 00:00:00.000000000 Z
+date: 2013-06-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: minitest
   requirement: !ruby/object:Gem::Requirement
+    none: false
     requirements:
-    - - '>='
+    - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
+    none: false
     requirements:
-    - - '>='
+    - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: thor
   requirement: !ruby/object:Gem::Requirement
+    none: false
     requirements:
-    - - '>='
+    - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
+    none: false
     requirements:
-    - - '>='
+    - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: coveralls
   requirement: !ruby/object:Gem::Requirement
+    none: false
     requirements:
-    - - '>='
+    - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
+    none: false
     requirements:
-    - - '>='
+    - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
+    none: false
     requirements:
-    - - '>='
+    - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
+    none: false
     requirements:
-    - - '>='
+    - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
-description: "\n                      Provides the basic building blocks\n                      of
+description: ! "\n                      Provides the basic building blocks\n                      of
   a pattern capable of reducing a\n                      towering codebase to modular
   rubble\n                      (or more Ruby gems)\n                    "
 email:
@@ -95,25 +104,32 @@ files:
 - test/unit/pay_dirt/use_case_test.rb
 homepage: http://github.com/rthbound/pay_dirt
 licenses: []
-metadata: {}
 post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
   requirements:
-  - - '>='
+  - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
+      segments:
+      - 0
+      hash: -935381315
 required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
   requirements:
-  - - '>='
+  - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
+      segments:
+      - 0
+      hash: -935381315
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.0.3
+rubygems_version: 1.8.25
 signing_key: 
-specification_version: 4
-summary: Based on a pattern introduced to me by knewter.
+specification_version: 3
+summary: Reduce a towering codebase to modular rubble (or more rubygems) with pay_dirt
 test_files: []

checksums.yaml

@@ -1,7 +0,0 @@
----
-SHA1:
-  metadata.gz: c384f986821d54bb9a87d60d500ca599162c33d0
-  data.tar.gz: b608fe834f4050ccabac596c2f577cd32b380b9f
-SHA512:
-  metadata.gz: 8fc872999a33075bf0d80de2ae90c1d0b4f5fa47cd0229e168ee826d3c16ae02c6966cda408c04ca56761381b2ed04e5ec0cb4c8388ad605dba54366ff553fda
-  data.tar.gz: d44a64394081bd6ede1a1359606c00ed3e0e073fb43252d12a4303ce025aca60444b3e906163df30e3b68598a36e2cc6ecdb2a14bcc9b8de44c8ab65a2835270