rogue-objects 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c58f3c07599c88b2d74a99c3c3d28773c2a1b93a960f710de7ffcedfae18465e
-  data.tar.gz: 89b38e4437dff20aaede7ac2b4d1cf73da4a4f4785fd5cdcb62728e154b77314
+  metadata.gz: 8a00d660d2fa64fb76770f2ea019a8499004e8e11a063c41fe6451e80bf4e5e4
+  data.tar.gz: f9a168d5eddab272e1bf64e60699a71ef1ab58cc1a86842b38bc2a24056777b5
 SHA512:
-  metadata.gz: 62eaf057ee2f413906349cdec1d66c178d0ee21a03aacf3948255ee2e93df309ac0dbefdccd677921a8facab147d74a6278b01952dc039cd61faf30636bbb2ea
-  data.tar.gz: 5ade40a2340f6cae1ce7e95b03595296e5925e23f90f44d31879bd67d9599cf24b2f7caa451b8503a6ab1893905a533e6fc847e9a1710f362247651a04eaeb15
+  metadata.gz: 46517199996109d101d02331ccb0dd90e53cb1eb0d8deffb21647d83496679c4412efa39912d7ed228c2c07d69351d3a5414e6ed8e5cdf63ccc71801dec546d8
+  data.tar.gz: a7bcdf49ed289f8d6d063d9e2282218fdead7e603796c2d94227d323cf2a02d36036f942e1cf30747560e84390378281e32eca3033f80ccffa03440ff2223c40

data/Gemfile.lock

@@ -0,0 +1,21 @@
+PATH
+  remote: .
+  specs:
+    rogue-objects (0.2.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    minitest (5.8.5)
+    rake (10.4.2)
+
+PLATFORMS
+  x86_64-darwin-19
+
+DEPENDENCIES
+  minitest (~> 5.0)
+  rake (~> 10.0)
+  rogue-objects!
+
+BUNDLED WITH
+   2.2.11

data/README.md

@@ -1,8 +1,8 @@
-# Rogue
+# Rogue-Objects
 
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/rogue`. To experiment with that code, run `bin/console` for an interactive prompt.
-
-TODO: Delete this and the text above, and describe your gem
+Rogue-Objects is a set of utilities to help developers write focused unit tests. It includes 
+a Rogue-Object component which is a dynamic object that can be created with properties & functions
+that can be accessed via dot notation.
 
 ## Installation
 
@@ -22,7 +22,34 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+Scenario:
+You need to test a DuckHunter which requires an object that looks like a duck and quacks like a duck
+but you don't want to create an actual duck. Rogue-Objects give you an `obj` expression you can use
+to create a lightweight object that looks like a duck and quacks like a duck. This is an object with
+all the properties/methods of a duck. See the following:
+
+```ruby
+duck = obj(feathers:true, color:'black', name: 'Daffy',
+           speak: proc{ "Quack!"},
+           fly: proc {|location| location.y += 100})
+```
+
+Consider a DuckHunter which looks for this animal and calls methods and accesses properties via dot
+notation.
+```ruby
+class DuckHunter
+  def hunt
+    if @duck.feathers && @duck.color == 'black'
+      @duck.fly
+      while @duck.speak == 'Quack!'
+        shoot(@duck)
+      end
+    end
+  end
+end
+```
+This hunter can be supplied with our duck without the need to load the actual Duck class, formally create
+a Duck class substitution class, or use too much noise code from mock frameworks.
 
 ## Development
 

data/lib/rogue/support/mock_methods.rb

@@ -0,0 +1,39 @@
+require 'minitest/autorun'
+
+module Rogue
+  module Support
+    module MockMethods
+      # Chained method calls in the form of mock.first.second.third
+      # can be made on a mock with this auxillary method
+      def expect_chained_call(mock, chain_call, ret_val, args = [])
+        calls = chain_call.split('.')
+        calls[0, calls.length - 1].each do |each|
+          mock.expect(each.to_sym, mock)
+        end
+        mock.expect(calls.last, ret_val, args) unless block_given?
+        if block_given?
+          mock.expect(calls.last, ret_val) do |*var_args|
+            yield var_args
+          end
+        end
+      end
+
+      # A Mock context allows us to code the mock expectations AFTER the tested method
+      class MockContext
+        def initialize(block)
+          @block = block
+          @mock = ::Minitest::Mock.new
+        end
+
+        def verify_the_mock(&verify_block)
+          verify_block&.call(@mock)
+          @block.call(@mock)
+          @mock.verify
+        end
+      end
+      def with_new_mock(&block)
+        MockContext.new(block)
+      end
+    end
+  end
+end

data/lib/rogue/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Rogue
-  VERSION = "0.1.0"
+  VERSION = "0.2.0"
 end

data/rogue-objects.gemspec

@@ -10,13 +10,13 @@ Gem::Specification.new do |spec|
 
   spec.summary       = "A gem to augment unit testing"
   spec.description   = "Ruby MiniTest utilities"
-  spec.homepage      = "https://github.com/cliff76/rogue"
+  spec.homepage      = "https://github.com/cliff76/rogue-objects"
   spec.license       = "MIT"
   spec.required_ruby_version = Gem::Requirement.new(">= 2.3.0")
 
   spec.metadata["homepage_uri"] = spec.homepage
-  spec.metadata["source_code_uri"] = "https://github.com/cliff76/rogue"
-  spec.metadata["changelog_uri"] = "https://github.com/cliff76/rogue/CHANGELOG.md"
+  spec.metadata["source_code_uri"] = "https://github.com/cliff76/rogue-objects"
+  spec.metadata["changelog_uri"] = "https://github.com/cliff76/rogue-objects/CHANGELOG.md"
 
   # Specify which files should be added to the gem when it is released.
   # The `git ls-files -z` loads the files in the RubyGem that have been added into git.

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rogue-objects
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Clifton Craig
@@ -21,21 +21,23 @@ files:
 - CHANGELOG.md
 - CODE_OF_CONDUCT.md
 - Gemfile
+- Gemfile.lock
 - LICENSE.txt
 - README.md
 - Rakefile
 - bin/console
 - bin/setup
 - lib/rogue.rb
+- lib/rogue/support/mock_methods.rb
 - lib/rogue/version.rb
 - rogue-objects.gemspec
-homepage: https://github.com/cliff76/rogue
+homepage: https://github.com/cliff76/rogue-objects
 licenses:
 - MIT
 metadata:
-  homepage_uri: https://github.com/cliff76/rogue
-  source_code_uri: https://github.com/cliff76/rogue
-  changelog_uri: https://github.com/cliff76/rogue/CHANGELOG.md
+  homepage_uri: https://github.com/cliff76/rogue-objects
+  source_code_uri: https://github.com/cliff76/rogue-objects
+  changelog_uri: https://github.com/cliff76/rogue-objects/CHANGELOG.md
 post_install_message:
 rdoc_options: []
 require_paths: