rogue-objects 0.2.0 → 0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8a00d660d2fa64fb76770f2ea019a8499004e8e11a063c41fe6451e80bf4e5e4
-  data.tar.gz: f9a168d5eddab272e1bf64e60699a71ef1ab58cc1a86842b38bc2a24056777b5
+  metadata.gz: 42ae355b7cf52f90793cc7d7bc8591c21e6b57e9bbe04f643af50c26d62a9ca8
+  data.tar.gz: ef05fafb0fa0087dcd7cabbfa05020b71a88c6d315043ed71aac6b45d579c315
 SHA512:
-  metadata.gz: 46517199996109d101d02331ccb0dd90e53cb1eb0d8deffb21647d83496679c4412efa39912d7ed228c2c07d69351d3a5414e6ed8e5cdf63ccc71801dec546d8
-  data.tar.gz: a7bcdf49ed289f8d6d063d9e2282218fdead7e603796c2d94227d323cf2a02d36036f942e1cf30747560e84390378281e32eca3033f80ccffa03440ff2223c40
+  metadata.gz: 85fa83300efd8d911b5f6cc928509123f25711d9fa3e10525e05d5a6b33683de064f61daf45ba820ab6de599cc26f1357da18bb8f4592126c3d1f97d66467171
+  data.tar.gz: f2748be9fa753f8a995198aff59e518f58a562c0a01c9203f2b699517535b0d51b062fbd0557d2cf5b0f3fc8e18819e6e7c58ce766cfc51a0df61e44a3dfd968

data/CHANGELOG.md

@@ -1,5 +1,13 @@
 ## [Unreleased]
 
+## [0.2.1] - 2021-02-24
+
+- Relocates the repository into Adgear
+
+## [0.2.0] - 2021-02-22
+
+- Adds mock object supporting methods
+
 ## [0.1.0] - 2021-02-22
 
 - Initial release

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    rogue-objects (0.2.0)
+    rogue-objects (0.2.1)
 
 GEM
   remote: https://rubygems.org/

data/README.md

@@ -2,14 +2,15 @@
 
 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.
+that can be accessed via dot notation. It also includes various helper functions to to make MiniTest
+mock objects slightly simpler.
 
 ## Installation
 
 Add this line to your application's Gemfile:
 
 ```ruby
-gem 'rogue'
+gem 'rogue-objects'
 ```
 
 And then execute:
@@ -18,10 +19,11 @@ And then execute:
 
 Or install it yourself as:
 
-    $ gem install rogue
+    $ gem install rogue-objects
 
 ## Usage
 
+### Rogue-Object use
 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
@@ -51,6 +53,78 @@ 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.
 
+### Minitest Mocking use
+Mini test mocks allow you to create objects that expect calls. However your code can get noisy when the object
+you're testing makes several chained method calls. Consider the following irresponsible teacher that only 
+teaches the first student in class:
+
+```ruby
+class IrresponsibleTeacher
+  def teach
+    @students.first.find_first_lesson.learn(self)
+  end
+end
+```
+If we wanted to use mocks we would have to mock the students object and get it to return a mock student.
+We would have to tell this mocked student to return a mocked first lesson then tell that mocked lesson 
+to expect a call to its learn method. 
+```ruby
+irresponsible_teacher = IrresponsibleTeacher.new
+mock_students = ::Minitest::Mock.new
+mock_first_student = ::Minitest::Mock.new
+mock_lesson = ::Minitest::Mock.new
+mock_students.expect(:first,mock_first_student)
+mock_first_student.expect(:find_first_lesson,mock_lesson)
+mock_lesson.expect(:learn,nil,[irresponsible_teacher])
+```
+This code can be simplified by using the `::Rogue::Support::MockMethods.expect_chained_call` method over
+the mock. 
+```ruby
+include ::Rogue::Support::MockMethods
+irresponsible_teacher = IrresponsibleTeacher.new
+mock_students = ::Minitest::Mock.new
+expect_chained_call(mock_students, 'first.find_first_lesson.learn', nil, irresponsible_teacher)
+```
+
+In each step of this chained method call our mock will return itself with an expectation to receive the 
+next call in the chain.
+
+Mocking in Minitest (as well as other mock object frameworks) reverses the Given/When/Then pattern
+in your code. That is, you have to set your assertions/expectations up front (the then part), followed
+by the action you want to test. This can make code slightly harder to follow because the thing you want
+to test can get lost beneath the mock setup. Consider the following scenario.
+We have an order processor which should get the cost and ship our delicate item to San Fransisco.
+
+```ruby
+mock_order = ::Minitest::Mock.new
+mock_order.expect(:total_cost,29.99)
+mock_order.expect(:special_instructions,"handle with care")
+mock_order.expect(:ship, nil, "San Fransisco")
+@order_processor.process(mock_order)
+mock_order.verify
+```
+Here we are starting with the given, then setting the expectations, and finally taking our action
+Following Given/When/Then you woud want to code the expectations after you take the action
+of processing the order. With `::Rogue::Support::MockMethods.expect_chained_call` we can reverse
+the order of code conceptually but still maintain the order of operations semantically. This is 
+supported via a bit of syntax sugar as follows:
+
+```ruby
+with_new_mock { |mock_order| @order_processor.process(mock_order) }
+  .verify_the_mock do |mock_order|
+    mock_order.expect(:total_cost,29.99)
+    mock_order.expect(:special_instructions,"handle with care")
+    mock_order.expect(:ship, nil, "San Fransisco")
+end
+```
+
+In the above example we make use of blocks to group the sections and order them
+conceptually while the semantic order of execution is preserved. Internally the 
+Rogue-Objects API will create a mock object and execute the `verify_the_mock` 
+block with this new mock first. This allows all expectations to be set initially.
+Control is then delegated to the `with_new_mock` block with this same internal 
+mock. The mock is automatically verified after the `with_new_mock` block completes.
+
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.

data/lib/rogue/version.rb

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

data/rogue-objects.gemspec

@@ -6,7 +6,7 @@ Gem::Specification.new do |spec|
   spec.name          = "rogue-objects"
   spec.version       = Rogue::VERSION
   spec.authors       = ["Clifton Craig"]
-  spec.email         = ["clifton.craig@gmail.com"]
+  spec.email         = ["c.craig@samsung.com"]
 
   spec.summary       = "A gem to augment unit testing"
   spec.description   = "Ruby MiniTest utilities"
@@ -15,8 +15,8 @@ Gem::Specification.new do |spec|
   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-objects"
-  spec.metadata["changelog_uri"] = "https://github.com/cliff76/rogue-objects/CHANGELOG.md"
+  spec.metadata["source_code_uri"] = "https://github.com/adgear/rogue-objects"
+  spec.metadata["changelog_uri"] = "https://github.com/adgear/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,18 +1,18 @@
 --- !ruby/object:Gem::Specification
 name: rogue-objects
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.2.1
 platform: ruby
 authors:
 - Clifton Craig
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-02-23 00:00:00.000000000 Z
+date: 2021-02-24 00:00:00.000000000 Z
 dependencies: []
 description: Ruby MiniTest utilities
 email:
-- clifton.craig@gmail.com
+- c.craig@samsung.com
 executables: []
 extensions: []
 extra_rdoc_files: []
@@ -36,8 +36,8 @@ licenses:
 - MIT
 metadata:
   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
+  source_code_uri: https://github.com/adgear/rogue-objects
+  changelog_uri: https://github.com/adgear/rogue-objects/CHANGELOG.md
 post_install_message:
 rdoc_options: []
 require_paths: