pay_dirt 0.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 02ffbebfd616ea3615894973a41e9c54844fc270
+  data.tar.gz: 13ae80297a56e44103e3f95633b67445dd08543c
+SHA512:
+  metadata.gz: b5fcfcbd57874ab7e28232ff5fa2b913981fd187e1dfaffd22563717c3e98690a08491e86dbc9d22958092c5d8d67a528edff8017e48a840e05d66398996de64
+  data.tar.gz: 6144b015159bccc341ddf46d86341d540945cc23bf68afddcf5504a6281ec5bd2f7d5817debbeae3993cd324665ab7047c7d2983ba7201f11b2fa6bc2f03faca

data/.gitignore

@@ -0,0 +1,11 @@
+# See http://help.github.com/ignore-files/ for more about ignoring files.
+#
+# If you find yourself ignoring temporary files generated by your text editor
+# or operating system, you probably want to add a global ignore instead:
+#   git config --global core.excludesfile ~/.gitignore_global
+
+# Ignore bundler config
+/.bundle
+
+*.sw?
+.sw?

data/.ruby-gemset

@@ -0,0 +1 @@
+pay_dirt

data/.ruby-version

@@ -0,0 +1 @@
+ruby-2.0.0-p0

data/Gemfile

@@ -0,0 +1,3 @@
+source "http://rubygems.org"
+
+gemspec

data/README.md

@@ -0,0 +1,4 @@
+## pay_dirt
+#### 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)

data/Rakefile

@@ -0,0 +1,9 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new do |t|
+  t.pattern = 'test/**/*_test.rb'
+  t.libs.push 'test'
+end
+
+task :default => :test

data/lib/pay_dirt/base.rb

@@ -0,0 +1,11 @@
+module PayDirt
+  class Base
+    def load_option(option, options)
+      instance_variable_set("@#{option}", options.fetch(option.to_sym) { raise "Missing required option: #{option}" } )
+    end
+
+    def load_options(*option_names, options)
+      option_names.each{|o| load_option(o, options) }
+    end
+  end
+end

data/lib/pay_dirt/result.rb

@@ -0,0 +1,33 @@
+module PayDirt
+  class Result
+    # The response from a use case execution
+    #
+    # Every use case should return a Result after it runs.
+    #
+    # @param [options] options_hash
+    #   A hash specifying the appropriate options
+    #
+    # @return [PayDirt::Result]
+    #   the Result instance
+    #
+    # @example
+    #   PayDirt::Result.new(success: true, data: {})
+    #   # => <PayDirt::Result>
+    #
+    # @api public
+    def initialize(options)
+      @success = options[:success]
+      @data = options[:data]
+    end
+
+    # @api public
+    def successful?
+      !!@success
+    end
+
+    # @api public
+    def data
+      @data
+    end
+  end
+end

data/lib/pay_dirt/version.rb

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

data/lib/pay_dirt.rb

@@ -0,0 +1,3 @@
+# Load use case files
+require "#{File.dirname(__FILE__)}/pay_dirt/base.rb"
+Dir["#{File.dirname(__FILE__)}/pay_dirt/**/*.rb"].each { |f| require f }

data/pay_dirt.gemspec

@@ -0,0 +1,30 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "pay_dirt/version"
+
+Gem::Specification.new do |s|
+  s.name        = "pay_dirt"
+  s.version     = PayDirt::VERSION
+  s.authors     = ["Tad Hosford"]
+  s.email       = ["tad.hosford@gmail.com"]
+  s.homepage    = "http://github.com/rthbound/pay_dirt"
+  s.description = %q{
+                      Provides the basic building blocks
+                      of a pattern capable of reducing a
+                      towering codebase to modular rubble
+                      (or more Ruby gems)
+                    }
+  s.summary     = %q{
+                      Based on a pattern introduced to me
+                      by knewter.
+                    }
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+
+  s.add_development_dependency "minitest"
+  s.add_development_dependency "rake"
+  s.add_development_dependency "pry"
+end

data/test/test_helper.rb

@@ -0,0 +1,14 @@
+# Set up simplecov
+ENV["RAILS_ENV"] = "test"
+
+require "minitest/spec"
+require "minitest/autorun"
+
+# Debugger
+require "pry"
+
+# The gem
+$: << File.dirname(__FILE__) + "/../lib"
+$: << File.dirname(__FILE__)
+
+require "pay_dirt"

data/test/unit/pay_dirt/base_test.rb

@@ -0,0 +1,55 @@
+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

data/test/unit/pay_dirt/result_test.rb

@@ -0,0 +1,13 @@
+require 'test_helper'
+
+describe PayDirt::Result do
+  it "knows whether it was successful or not" do
+    pay_dirt = PayDirt::Result.new(success: true)
+    pay_dirt.successful?.must_equal true
+  end
+
+  it "provides access to its data" do
+    pay_dirt = PayDirt::Result.new(data: 'foo')
+    pay_dirt.data.must_equal 'foo'
+  end
+end

data/test/unit/pay_dirt/use_case.rb

@@ -0,0 +1,55 @@
+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

metadata

@@ -0,0 +1,103 @@
+--- !ruby/object:Gem::Specification
+name: pay_dirt
+version: !ruby/object:Gem::Version
+  version: 0.0.0
+platform: ruby
+authors:
+- Tad Hosford
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-04-23 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: 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'
+- !ruby/object:Gem::Dependency
+  name: pry
+  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: "\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:
+- tad.hosford@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .ruby-gemset
+- .ruby-version
+- Gemfile
+- README.md
+- Rakefile
+- lib/pay_dirt.rb
+- lib/pay_dirt/base.rb
+- lib/pay_dirt/result.rb
+- lib/pay_dirt/version.rb
+- pay_dirt.gemspec
+- 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.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
+  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.0.rc.2
+signing_key: 
+specification_version: 4
+summary: Based on a pattern introduced to me by knewter.
+test_files: []