deep_double 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 10da248b3fdf8a64407a89a83c6f77e6df110f55c44bf3c5be5a2ae1c1924066
+  data.tar.gz: 73bb4881d11356d2ec95f810b7446e51e6b0c516c1066258eee7b04e74a0c158
+SHA512:
+  metadata.gz: 95ec83eeaec878133e679e327bc16f7c18623a5822df6eaf48a99634a30df7e6f9f643c372ca006502be02002ad733191d3b8ce6fb59ab95f5a9ffceeb07d9ca
+  data.tar.gz: dc383f873d38b97b9be99c107efb7ea0331f2021c5795d3b3a89b1b17f92c745349613b6895f4f7afd5e9ec628104d5124a854f12ccb28f29b2b9f2fa164812f

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.5.1
+before_install: gem install bundler -v 1.16.1

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in deep_double.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,35 @@
+PATH
+  remote: .
+  specs:
+    deep_double (0.1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    diff-lcs (1.3)
+    rake (10.5.0)
+    rspec (3.8.0)
+      rspec-core (~> 3.8.0)
+      rspec-expectations (~> 3.8.0)
+      rspec-mocks (~> 3.8.0)
+    rspec-core (3.8.0)
+      rspec-support (~> 3.8.0)
+    rspec-expectations (3.8.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-mocks (3.8.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-support (3.8.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.16)
+  deep_double!
+  rake (~> 10.0)
+  rspec (~> 3.0)
+
+BUNDLED WITH
+   1.16.1

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 Jonah
+
+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

@@ -0,0 +1,57 @@
+# DeepDouble
+
+Proper README Coming Soon...
+
+For now, please see the spec file for how to use.
+
+TODO: Motivation
+TODO: Compare with RSpec doubles
+TODO: Add example use in README
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'deep_double'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install deep_double
+
+## Usage
+
+See the spec file for more examples.  Here's a basic double:
+
+```ruby
+require 'deep_double'
+
+DeepDouble::Double.new(
+  methA: {
+    [] => "methA()",
+    [1] => "methA(1)",
+    [2] => "methA(2)",
+    [1, 2] => "methA(1, 2)",
+    [2, 1] => "methA(2, 1)"
+  },
+  methB: {[] => "methB()"},
+  methC: {[{a: 1, b: 2}] => "methC(a: 1, b: 2)"},
+  methD: {[] => proc { raise ZeroDivisionError }},
+  methE: {[] => -> { raise TypeError }},
+)
+```
+
+## Development
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/deep_double.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "deep_double"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/deep_double.gemspec

@@ -0,0 +1,26 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "deep_double/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "deep_double"
+  spec.version       = DeepDouble::VERSION
+  spec.authors       = ["Jonah"]
+  spec.email         = ["jonahx@gmail.com"]
+
+  spec.summary       = %q{Fast, declarative test doubles that support nesting.}
+  spec.homepage      = "https://github.com/jonahx/deep_double"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test)/})
+  end
+  spec.bindir        = "bin"
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.16"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+end

data/lib/deep_double/function/validate_result_table.rb

@@ -0,0 +1,47 @@
+# A "function" in the mathematical sense: a mapping of input values to output
+# values.  This (argument -> value) mapping is specified by a "result_table" --
+# just an ordinary ruby hash -- passed to the constructor.
+#
+# If the return value is itself a hash, it's interpreted as the definition of
+# another double, and so another `DeepDouble` instance is returned.
+#
+module DeepDouble
+  class Function
+
+    class ValidateResultTable
+      def initialize(result_table)
+        @result_table = result_table
+      end
+
+      def call
+        validate_result_table_type
+        validate_result_table_keys
+      end
+
+      private
+
+      def validate_result_table_type
+        return if @result_table.is_a?(Hash)
+        raise ArgumentError,
+          "The result table defining a Function must be a Hash"
+      end
+
+      def validate_result_table_keys
+        @result_table.keys.each { |key| validate_key(key) }
+      end
+
+      def validate_key(key)
+        return if valid_key?(key)
+        raise ArgumentError,
+          "Keys in a result table must by Arrays representing argument " +
+          "lists (the empty array represents 0 arguments). The following " +
+          "key was invalid: #{key.inspect}"
+      end
+
+      def valid_key?(key)
+        key.is_a?(Array) || key == :default
+      end
+    end
+
+  end
+end

data/lib/deep_double/function.rb

@@ -0,0 +1,46 @@
+require 'deep_double/function/validate_result_table'
+
+# A "function" in the mathematical sense: a mapping of input values to output
+# values.  This (argument -> value) mapping is specified by a "result_table" --
+# just an ordinary ruby hash -- passed to the constructor.
+#
+# If the return value is itself a hash, it's interpreted as the definition of
+# another double, and so another `DeepDouble` instance is returned.
+#
+module DeepDouble
+  class Function
+
+    def initialize(result_table)
+      @result_table = result_table
+      validate_result_table
+    end
+
+    def call(*args)
+      validate_result_exists(args)
+      result(args)
+    end
+
+    private
+
+    def validate_result_table
+      ValidateResultTable.new(@result_table).call
+    end
+
+    def validate_result_exists(args)
+      return if value_defined_for?(args)
+      raise ArgumentError, "Function not defined for args: #{args}"
+    end
+
+    def result(args)
+      if @result_table.key?(args)
+        @result_table[args]
+      else
+        @result_table[:default]
+      end
+    end
+
+    def value_defined_for?(args)
+      @result_table.key?(args) || @result_table.key?(:default)
+    end
+  end
+end

data/lib/deep_double/literal.rb

@@ -0,0 +1,21 @@
+# Because a Hash in the context of a DeepDouble definition is considered to be
+# the definition of a *nested* DeepDouble, we need a way to "escape" a Hash for
+# methods that actually return Hash values.
+#
+# Likewise, a Proc in the context of a DeepDouble definition is invoked
+# automatically. (This lets us, eg, create methods that raise errors.)  Again,
+# we need a way to "escape" a Proc for methods that actually return literal
+# Proc values.
+#
+# This class provides a general mechanism to "escape" special values in
+# Function definitions.
+#
+module DeepDouble
+  class Literal
+    attr_reader :value
+
+    def initialize(value)
+      @value = value
+    end
+  end
+end

data/lib/deep_double/recursive_function.rb

@@ -0,0 +1,36 @@
+# Makes a `DeepDouble::Function` recursive, so that `Hash` results are
+# automatically converted to `DeepDouble` instances in their own right.
+#
+module DeepDouble
+  class RecursiveFunction
+
+    def initialize(function)
+      @function = function
+    end
+
+    def call(*args)
+      result = @function.call(*args)
+      special_case_transforms(result)
+    end
+
+    def to_proc
+      method(:call).to_proc
+    end
+
+    private
+
+    def special_case_transforms(result)
+      class_name = result.class.name.split('::').last
+      case class_name
+      when 'Hash'
+        Double.new(result) # recursive case
+      when 'Proc'
+        result.call
+      when 'Literal'
+        result.value
+      else
+        result
+      end
+    end
+  end
+end

data/lib/deep_double/version.rb

@@ -0,0 +1,3 @@
+module DeepDouble
+  VERSION = "0.1.0"
+end

data/lib/deep_double.rb

@@ -0,0 +1,56 @@
+# This is a utility class for quickly and declaratively creating doubles of
+# arbitrarily nested depth.
+#
+# It drastically reduces the amount of boilerplate compared with rspec.
+#
+
+require 'deep_double/function'
+require 'deep_double/literal'
+require 'deep_double/recursive_function'
+require "deep_double/version"
+
+module DeepDouble
+  class Double
+
+    # In this case, having an optional name first makes for a cleaner API
+    #
+    # rubocop:disable OptionalArguments
+    def initialize(name = 'Anonymous', definition)
+      @name = name
+      @definition = definition
+      validate_definition
+      create_methods_in_definition
+    end
+    # rubocop:enable OptionalArguments
+
+    private
+
+    def validate_definition
+      @definition.keys.each { |key| validate_method_name(key) }
+    end
+
+    def validate_method_name(name)
+      return if valid_method_name?(name)
+      raise ArgumentError,
+        "Method names in DeepDouble definition must be Symbols or Strings. " +
+        "The following name is invalid: #{name.inspect}"
+    end
+
+    def valid_method_name?(name)
+      name.is_a?(Symbol) || name.is_a?(String)
+    end
+
+    def create_methods_in_definition
+      @definition.keys.each { |meth| create_method(meth) }
+    end
+
+    def create_method(meth)
+      define_singleton_method(meth.to_sym, &function(meth))
+    end
+
+    def function(meth)
+      raw_fn = Function.new(@definition[meth])
+      RecursiveFunction.new(raw_fn)
+    end
+  end
+end

data/spec/deep_double_spec.rb

@@ -0,0 +1,178 @@
+require 'spec_helper'
+
+RSpec.describe 'DeepDouble' do
+
+  def deep_double(definition)
+    DeepDouble::Double.new(definition)
+  end
+
+  def literal(value)
+    DeepDouble::Literal.new(value)
+  end
+
+  context 'with valid unnested definition' do
+
+    subject(:valid) do
+      deep_double(
+        methA: {
+          [] => "methA()",
+          [1] => "methA(1)",
+          [2] => "methA(2)",
+          [1, 2] => "methA(1, 2)",
+          [2, 1] => "methA(2, 1)"
+        },
+        methB: {[] => "methB()"},
+        methC: {[{a: 1, b: 2}] => "methC(a: 1, b: 2)"},
+        methD: {[] => proc { raise ZeroDivisionError }},
+        methE: {[] => -> { raise TypeError }},
+      )
+    end
+
+    it 'returns correct value for zero args' do
+      expect(valid.methA).to eq('methA()')
+    end
+
+    it 'handles multiple 0 argument methods' do
+      expect(valid.methB).to eq('methB()')
+    end
+
+    it 'returns correct value for 1 argument methods' do
+      expect(valid.methA(1)).to eq('methA(1)')
+    end
+
+    it 'uses the argument to find the correct value' do
+      expect(valid.methA(2)).to eq('methA(2)')
+    end
+
+    it 'returns correct value for many-argument methods' do
+      expect(valid.methA(1, 2)).to eq('methA(1, 2)')
+    end
+
+    it 'uses both arguments to find the correct value' do
+      expect(valid.methA(2, 1)).to eq('methA(2, 1)')
+    end
+
+    it 'works with named arguments' do
+      expect(valid.methC(a: 1, b: 2)).to eq('methC(a: 1, b: 2)')
+    end
+
+    it 'requires all named arguments to match' do
+      expect{ valid.methC(a: 1, b: 3) }.to raise_error(ArgumentError)
+    end
+
+    it 'invokes procs when they are specified as the return value' do
+      expect{ valid.methD }.to raise_error(ZeroDivisionError)
+    end
+
+    it 'invokes lambdas when they are specified as the return value' do
+      expect{ valid.methE }.to raise_error(TypeError)
+    end
+
+    it 'raises NoMethodError when you call a non-existent method' do
+      expect { valid.blah }.to raise_error(NoMethodError)
+    end
+
+    it "raises ArgumentError when you haven't configured args" do
+      expect { valid.methA(3) }.to raise_error(ArgumentError)
+      expect { valid.methA(1, 2, 3) }.to raise_error(ArgumentError)
+      expect { valid.methA(1, 3) }.to raise_error(ArgumentError)
+    end
+  end
+
+  context 'with valid definition and default value' do
+
+    subject(:valid) do
+      deep_double(
+        methA: {
+          [] => "methA()",
+          [1] => "methA(1)",
+          :default => "Default Value"
+        }
+      )
+    end
+
+    it 'lets you set a default value for unspecified args' do
+      expect(valid.methA('blah')).to eq('Default Value')
+    end
+
+    it 'gives precedence to specific args' do
+      expect(valid.methA).to eq('methA()')
+      expect(valid.methA(1)).to eq('methA(1)')
+    end
+  end
+
+  context 'with valid nested definition' do
+
+    subject(:valid) do
+      deep_double(
+        methA: {
+          [] => {
+            methAA: {[] => 'methAA()'},
+            methAB: {[] => {
+              methABA: {[] => 'methABA()'}}
+            }
+          }
+        }
+      )
+    end
+
+    it 'automatically creates nested DeepDouble instances' do
+      expect(valid.methA.methAA).to eq('methAA()')
+    end
+
+    it 'handles deep nesting too' do
+      expect(valid.methA.methAB.methABA).to eq('methABA()')
+    end
+  end
+
+  context 'with an invalid definition' do
+
+    let(:invalid_method_name) do
+      deep_double(
+        methA: {[] => 'methA()'},
+        [] => {[] => 'will not work'},
+      )
+    end
+
+    let(:invalid_result_type) do
+      deep_double(methA: 'methA()')
+    end
+
+    let(:invalid_result_key) do
+      deep_double(methA: {non_array_key: 'methA()'})
+    end
+
+    it 'raises when the method name is not a string or symbol' do
+      expect{ invalid_method_name }.to raise_error(ArgumentError)
+    end
+
+    it 'raises when the result is not a Hash' do
+      expect{ invalid_result_type }.to raise_error(ArgumentError)
+    end
+
+    it 'raises if a result key is not an array (a list of args)' do
+      expect{ invalid_result_key }.to raise_error(ArgumentError)
+    end
+  end
+
+  context 'when returning literal values' do
+
+    literal_hash = {a: 1}
+    literal_proc = -> { raise ArgumentError }
+
+    let(:literal_results) do
+      deep_double(
+        methA: {[] => literal(literal_hash)},
+        methB: {[] => literal(literal_proc)},
+      )
+    end
+
+    it 'provides a way to return a literal Hash' do
+      expect(literal_results.methA).to eq(literal_hash)
+    end
+
+    it 'provides a way to return a literal Proc' do
+      expect(literal_results.methB).to eq(literal_proc)
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,15 @@
+require "bundler/setup"
+require "rspec"
+require "deep_double"
+
+RSpec.configure do |config|
+  # Enable flags like --only-failures and --next-failure
+  config.example_status_persistence_file_path = ".rspec_status"
+
+  # Disable RSpec exposing methods globally on `Module` and `main`
+  config.disable_monkey_patching!
+
+  config.expect_with :rspec do |c|
+    c.syntax = :expect
+  end
+end

metadata

@@ -0,0 +1,107 @@
+--- !ruby/object:Gem::Specification
+name: deep_double
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Jonah
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2018-10-10 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: 
+email:
+- jonahx@gmail.com
+executables:
+- console
+- setup
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- deep_double.gemspec
+- lib/deep_double.rb
+- lib/deep_double/function.rb
+- lib/deep_double/function/validate_result_table.rb
+- lib/deep_double/literal.rb
+- lib/deep_double/recursive_function.rb
+- lib/deep_double/version.rb
+- spec/deep_double_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/jonahx/deep_double
+licenses:
+- MIT
+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.7.6
+signing_key: 
+specification_version: 4
+summary: Fast, declarative test doubles that support nesting.
+test_files: []