pay_dirt 0.0.0 → 0.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 02ffbebfd616ea3615894973a41e9c54844fc270
-  data.tar.gz: 13ae80297a56e44103e3f95633b67445dd08543c
+  metadata.gz: 225b334258cfa4c5dc7836bcc7bd8b58a19c6119
+  data.tar.gz: ec7e1f4d3e4aa5e210d33a239eb95279e9fe7f9d
 SHA512:
-  metadata.gz: b5fcfcbd57874ab7e28232ff5fa2b913981fd187e1dfaffd22563717c3e98690a08491e86dbc9d22958092c5d8d67a528edff8017e48a840e05d66398996de64
-  data.tar.gz: 6144b015159bccc341ddf46d86341d540945cc23bf68afddcf5504a6281ec5bd2f7d5817debbeae3993cd324665ab7047c7d2983ba7201f11b2fa6bc2f03faca
+  metadata.gz: f78dbd7abbe33e65260f9b823dcb9f0c0cfbacad5ad36517cf30bc9064e2785c7ab99a0f419989390c198fa44c36b6840d2c21d98142aef3f8114c148b46bb7e
+  data.tar.gz: c5aa125838ca42dda0c14a1857eafba7ed60322c9d8fb10120b0fcb9b2f1e30a8fc675fc0f100afa6604e68660fa6b5eb1111814d88558e2d8be33bbc9b6dddf

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT license:
+
+Copyright (c) 2013 Tad Hosford
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE

data/README.md

@@ -2,3 +2,61 @@
 #### A Ruby gem based on the "use case" pattern set forth in [opencurriculum-flashcards](https://github.com/isotope11/opencurriculum-flashcards)
 
 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
+    end

data/lib/pay_dirt/version.rb

@@ -1,3 +1,3 @@
 module PayDirt
-  VERSION = "0.0.0"
+  VERSION = "0.0.1"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: pay_dirt
 version: !ruby/object:Gem::Version
-  version: 0.0.0
+  version: 0.0.1
 platform: ruby
 authors:
 - Tad Hosford
@@ -65,6 +65,7 @@ files:
 - .ruby-gemset
 - .ruby-version
 - Gemfile
+- LICENSE
 - README.md
 - Rakefile
 - lib/pay_dirt.rb
@@ -76,7 +77,6 @@ files:
 - test/unit/.gitkeep
 - test/unit/pay_dirt/base_test.rb
 - test/unit/pay_dirt/result_test.rb
-- test/unit/pay_dirt/use_case.rb
 homepage: http://github.com/rthbound/pay_dirt
 licenses: []
 metadata: {}

data/test/unit/pay_dirt/use_case.rb

@@ -1,55 +0,0 @@
-require 'test_helper'
-
-describe PayDirt::Base do
-  before do
-    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
-end