glimmer-dsl-specification 0.0.3 → 0.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 556bf58aecd8e40196f529480790e60cb7bfe375e168f57193a0e00d1f93379d
-  data.tar.gz: 259c09a631831d1c85c2e7dec0221a02d5730aafd61dd1e85b491e91a25e8d64
+  metadata.gz: b90c13783d40d051398b8cbdd70b567125424df2a62a15aa3405786f0cb6da48
+  data.tar.gz: c10821dfd0ace2d29390be14206f5ef6c502d714c90924d12cb46d7584e15da5
 SHA512:
-  metadata.gz: 0d636e00d1c07011d4d2781aa8b4db8e680dbaa68b24497daddef1ada5a2c2e1f6b6fd96bf59fa85064af83965eae7e687998423eac09fee32c99efaa3016b1c
-  data.tar.gz: e9e728a0aa54f82e1df57c4821592fcd205b31e9066365dd0dd8adcdb4ce31846ce4b1f97bd250634820000972510167481d444fa38e84cd6386cb498328d8e8
+  metadata.gz: d44d6a7dc1e17e9f78f346d7050182d97148ce2ffe21d9f941aa9d8320c89e1da57436b0396fc0acdf5fed9e9da147ff3926f0b7dc9af442c1eb69c4e75a5fcb
+  data.tar.gz: 29723cf049ee41fb5b2cf383fbadbb187a5103ecec3ddbfa97d0e68553d5bbd5de8503e6d602f07a7b1fc80f82739dcbdfc289b1c610e6e783c385b210d3a532

data/CHANGELOG.md

@@ -1,5 +1,10 @@
 # Change Log
 
+## 0.0.4
+
+- On `fact` failure of `Object` `==`/`!=`, display the involved objects
+- On `fact` failure of `Array` `==`/`!=`/`empty?`/`include?`, display the involved objects
+
 ## 0.0.3
 
 - On `fact` failure of `String` `#empty?` and `#include?`, display the involved objects

data/README.md

@@ -1,4 +1,4 @@
-# [<img src="https://raw.githubusercontent.com/AndyObtiva/glimmer/master/images/glimmer-logo-hi-res.png" height=85 />](https://github.com/AndyObtiva/glimmer) Glimmer DSL for Specification 0.0.2
+# [<img src="https://raw.githubusercontent.com/AndyObtiva/glimmer/master/images/glimmer-logo-hi-res.png" height=85 />](https://github.com/AndyObtiva/glimmer) Glimmer DSL for Specification 0.0.4
 ## Pure Ruby Declarative Use Case Specification and Automated Verification
 [![Gem Version](https://badge.fury.io/rb/glimmer-dsl-specification.svg)](http://badge.fury.io/rb/glimmer-dsl-specification)
 [![Join the chat at https://gitter.im/AndyObtiva/glimmer](https://badges.gitter.im/AndyObtiva/glimmer.svg)](https://gitter.im/AndyObtiva/glimmer?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
@@ -114,7 +114,71 @@ VERIFIED: Glimmer DSL for Specification - Verify Multiple Facts
 VERIFIED: Glimmer DSL for Specification
 ```
 
-Failure output when fudging some code (colored in actual usage):
+Suppose we fudge some code in `Verify Multiple Facts` use case:
+
+```ruby
+require 'glimmer-dsl-specification'
+
+class Person
+  attr_reader :first_name, :last_name
+  
+  def initialize(first_name: , last_name: )
+    @first_name = first_name
+    @last_name = last_name
+  end
+  
+  def name
+    "#{first_name} #{last_name}"
+  end
+end
+
+module Glimmer::Specification
+  specification('Glimmer DSL for Specification') {
+    use_case('Compare Two Objects for Equality') {
+      scenario 'Same-content strings are equal' do
+        'string' == 'string'
+      end
+      
+      scenario 'Different-content strings are not equal' do
+        'string1' != 'string2'
+      end
+
+      scenario 'Same-number integers are equal' do
+        1 == 1
+      end
+
+      scenario 'Different-number integers are not equal' do
+        1 != 2
+      end
+    }
+    
+    use_case('Verify Multiple Facts') {
+      scenario 'person name consists of first name and last name' do
+        person = Person.new(first_name: 'Bob', last_name: 'Winfrey')
+
+        fact { person.first_name == 'Bob' }
+        fact { person.last_name == 'Winfrey' }
+        fact { person.last_name == 'aWinfrey' }
+        fact { person.last_name != 'Winfrey' }
+        fact { person.last_name.empty? }
+        fact { person.last_name.include?('fda') }
+        fact { person.last_name.nil? }
+        fact { [person.last_name] == ['aWinfrey'] }
+        fact { [person.last_name] != ['Winfrey'] }
+        fact { [person.last_name].empty? }
+        fact { [person.last_name].include?('ha') }
+        fact { [person.last_name].nil? }
+        fact { person == nil }
+        fact { person.nil? }
+        fact { person != person }
+        person.name == 'Bob Winfrey'
+      end
+    }
+  }
+end
+```
+
+Failure output (colored in actual usage):
 
 ```
 VERIFIED: Glimmer DSL for Specification - Compare Two Objects for Equality - Same-content strings are equal
@@ -123,10 +187,33 @@ VERIFIED: Glimmer DSL for Specification - Compare Two Objects for Equality - Sam
 VERIFIED: Glimmer DSL for Specification - Compare Two Objects for Equality - Different-number integers are not equal
 VERIFIED: Glimmer DSL for Specification - Compare Two Objects for Equality
 VERIFIED: Glimmer DSL for Specification - Verify Multiple Facts - person name consists of first name and last name - fact { person.first_name == 'Bob' }
-FAILED: 'Winfrey' == 'Baxter'
-NOT VERIFIED: Glimmer DSL for Specification - Verify Multiple Facts - person name consists of first name and last name - fact { person.last_name == 'Baxter' }
-FAILED: 'Winfrey' != 'Winfrey'
+VERIFIED: Glimmer DSL for Specification - Verify Multiple Facts - person name consists of first name and last name - fact { person.last_name == 'Winfrey' }
+FAILED: "Winfrey" == "aWinfrey"
+NOT VERIFIED: Glimmer DSL for Specification - Verify Multiple Facts - person name consists of first name and last name - fact { person.last_name == 'aWinfrey' }
+FAILED: "Winfrey" != "Winfrey"
 NOT VERIFIED: Glimmer DSL for Specification - Verify Multiple Facts - person name consists of first name and last name - fact { person.last_name != 'Winfrey' }
+FAILED: "Winfrey".empty?
+NOT VERIFIED: Glimmer DSL for Specification - Verify Multiple Facts - person name consists of first name and last name - fact { person.last_name.empty? }
+FAILED: "Winfrey".include?("fda")
+NOT VERIFIED: Glimmer DSL for Specification - Verify Multiple Facts - person name consists of first name and last name - fact { person.last_name.include?('fda') }
+FAILED: "Winfrey".nil?
+NOT VERIFIED: Glimmer DSL for Specification - Verify Multiple Facts - person name consists of first name and last name - fact { person.last_name.nil? }
+FAILED: ["Winfrey"] == ["aWinfrey"]
+NOT VERIFIED: Glimmer DSL for Specification - Verify Multiple Facts - person name consists of first name and last name - fact { [person.last_name] == ['aWinfrey'] }
+FAILED: ["Winfrey"] != ["Winfrey"]
+NOT VERIFIED: Glimmer DSL for Specification - Verify Multiple Facts - person name consists of first name and last name - fact { [person.last_name] != ['Winfrey'] }
+FAILED: ["Winfrey"].empty?
+NOT VERIFIED: Glimmer DSL for Specification - Verify Multiple Facts - person name consists of first name and last name - fact { [person.last_name].empty? }
+FAILED: ["Winfrey"].include?("ha")
+NOT VERIFIED: Glimmer DSL for Specification - Verify Multiple Facts - person name consists of first name and last name - fact { [person.last_name].include?('ha') }
+FAILED: ["Winfrey"].nil?
+NOT VERIFIED: Glimmer DSL for Specification - Verify Multiple Facts - person name consists of first name and last name - fact { [person.last_name].nil? }
+FAILED: #<Person:0x00007f832a93b778 @first_name="Bob", @last_name="Winfrey"> == nil
+NOT VERIFIED: Glimmer DSL for Specification - Verify Multiple Facts - person name consists of first name and last name - fact { person == nil }
+FAILED: #<Person:0x00007f832a93b778 @first_name="Bob", @last_name="Winfrey">.nil?
+NOT VERIFIED: Glimmer DSL for Specification - Verify Multiple Facts - person name consists of first name and last name - fact { person.nil? }
+FAILED: #<Person:0x00007f832a93b778 @first_name="Bob", @last_name="Winfrey"> != #<Person:0x00007f832a93b778 @first_name="Bob", @last_name="Winfrey">
+NOT VERIFIED: Glimmer DSL for Specification - Verify Multiple Facts - person name consists of first name and last name - fact { person != person }
 NOT VERIFIED: Glimmer DSL for Specification - Verify Multiple Facts - person name consists of first name and last name
 NOT VERIFIED: Glimmer DSL for Specification - Verify Multiple Facts
 NOT VERIFIED: Glimmer DSL for Specification
@@ -137,7 +224,7 @@ NOT VERIFIED: Glimmer DSL for Specification
 1 - Include in `Gemfile` (`:development` or `:test` group):
 
 ```ruby
-gem 'glimmer-dsl-specification', '~> 0.0.2'
+gem 'glimmer-dsl-specification', '~> 0.0.4'
 ```
 
 And, run:
@@ -224,7 +311,9 @@ Specifications do not care about what specific "classes" or "methods" are execut
 
 `fact {}` states a fact embodied by a boolean result for the passed block of code.
 
-Upon failure of a `fact` with `String` `==`/`!=`/`#empty?`/`#include?` verification methods, the library will automatically print the values of the involved objects.
+- Upon failure of a `fact` with `String` `==`/`!=`/`#empty?`/`#include?` verification methods, the library will automatically print the values of the involved objects.
+- Upon failure of a `fact` with `Array` `==`/`!=`/`#empty?`/`#include?` verification methods, the library will automatically print the values of the involved objects.
+- Upon failure of a `fact` with `Object` `==`/`!=` verification methods, the library will automatically print the values of the involved objects.
 
 ## Process
 

data/TODO.md

@@ -1,5 +1,6 @@
 # TODO
 
+- Support `fact` printout on `Object`/`String`/`Array` `#nil?`
 - Detect if you are the last line of a `scenario` when performing a verification comparison and print compared objects upon failure
 - Ensure that each element is only nestable under specific types of elements (e.g. `use_case` can go under `specification` only and `fact` can go under `scenario` only)
 - Support setting up common `scenario`, `use case` or `specification` preconditions by adding code directly under their block or inside a `before`/`after` block

data/VERSION

@@ -1 +1 @@
-0.0.3
+0.0.4

data/glimmer-dsl-specification.gemspec

@@ -2,11 +2,11 @@
 # DO NOT EDIT THIS FILE DIRECTLY
 # Instead, edit Juwelier::Tasks in Rakefile, and run 'rake gemspec'
 # -*- encoding: utf-8 -*-
-# stub: glimmer-dsl-specification 0.0.3 ruby lib
+# stub: glimmer-dsl-specification 0.0.4 ruby lib
 
 Gem::Specification.new do |s|
   s.name = "glimmer-dsl-specification".freeze
-  s.version = "0.0.3"
+  s.version = "0.0.4"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0".freeze) if s.respond_to? :required_rubygems_version=
   s.require_paths = ["lib".freeze]
@@ -38,6 +38,8 @@ Gem::Specification.new do |s|
     "lib/glimmer/specification/element/specification.rb",
     "lib/glimmer/specification/element/use_case.rb",
     "lib/glimmer/specification/ext.rb",
+    "lib/glimmer/specification/ext/array.rb",
+    "lib/glimmer/specification/ext/object.rb",
     "lib/glimmer/specification/ext/string.rb",
     "lib/glimmer/specification/rake_tasks.rb"
   ]

data/lib/glimmer/specification/ext/array.rb

@@ -0,0 +1,27 @@
+# Copyright (c) 2021 Andy Maleh
+#
+# 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.
+
+class Array
+  Glimmer::Specification::Ext.log_failure_of_method(self, '==', 'double_equal_without_glimmer') { |this, method_name, args| "#{this.inspect} == #{args.first.inspect}" }
+  Glimmer::Specification::Ext.log_failure_of_method(self, '!=', 'double_non_equal_without_glimmer') { |this, method_name, args| "#{this.inspect} != #{args.first.inspect}" }
+  Glimmer::Specification::Ext.log_failure_of_method(self, 'empty?')
+  Glimmer::Specification::Ext.log_failure_of_method(self, 'include?')
+end

data/lib/glimmer/specification/ext/object.rb

@@ -0,0 +1,26 @@
+# Copyright (c) 2021 Andy Maleh
+#
+# 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.
+
+class Object
+  Glimmer::Specification::Ext.log_failure_of_method(self, '==', 'double_equal_without_glimmer') { |this, method_name, args| "#{this.inspect} == #{args.first.inspect}" }
+  Glimmer::Specification::Ext.log_failure_of_method(self, '!=', 'double_non_equal_without_glimmer') { |this, method_name, args| "#{this.inspect} != #{args.first.inspect}" }
+  Glimmer::Specification::Ext.log_failure_of_method(self, 'nil?')
+end

data/lib/glimmer/specification/ext/string.rb

@@ -20,33 +20,8 @@
 # WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
 
 class String
-  alias double_equal_sign_without_glimmer ==
-  def ==(other)
-    double_equal_sign_without_glimmer(other).tap do |result|
-      puts Colours::RED + "FAILED: '#{self}' == '#{other}'" if Glimmer::Specification::Element::Fact.fact_block_in_progress && !result && !@non_equal_in_progress
-    end
-  end
-  
-  alias double_non_equal_sign_without_glimmer !=
-  def !=(other)
-    @non_equal_in_progress = true
-    double_non_equal_sign_without_glimmer(other).tap do |result|
-      puts Colours::RED + "FAILED: '#{self}' != '#{other}'" if Glimmer::Specification::Element::Fact.fact_block_in_progress && !result
-      @non_equal_in_progress = false
-    end
-  end
-  
-  alias empty_without_glimmer? empty?
-  def empty?
-    empty_without_glimmer?.tap do |result|
-      puts Colours::RED + "FAILED: '#{self}'.empty?" if Glimmer::Specification::Element::Fact.fact_block_in_progress && !result
-    end
-  end
-  
-  alias include_without_glimmer? include?
-  def include?(other)
-    include_without_glimmer?(other).tap do |result|
-      puts Colours::RED + "FAILED: '#{self}'.include?('#{other}')" if Glimmer::Specification::Element::Fact.fact_block_in_progress && !result
-    end
-  end
+  Glimmer::Specification::Ext.log_failure_of_method(self, '==', 'double_equal_without_glimmer') { |this, method_name, args| "#{this.inspect} == #{args.first.inspect}" }
+  Glimmer::Specification::Ext.log_failure_of_method(self, '!=', 'double_non_equal_without_glimmer') { |this, method_name, args| "#{this.inspect} != #{args.first.inspect}" }
+  Glimmer::Specification::Ext.log_failure_of_method(self, 'empty?')
+  Glimmer::Specification::Ext.log_failure_of_method(self, 'include?')
 end

data/lib/glimmer/specification/ext.rb

@@ -19,4 +19,39 @@
 # OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
 # WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
 
+using ArrayIncludeMethods
+
+module Glimmer
+  module Specification
+    module Ext
+      class << self
+        attr_accessor :log_failure_of_method_in_progress
+        alias log_failure_of_method_in_progress? log_failure_of_method_in_progress
+        
+        def log_failure_of_method(klass, method_name, method_alias = nil, &output_formatter)
+          klass.class_eval do
+            method_alias ||= "without_glimmer_#{method_name}"
+            method_alias = "#{name.split('::').last.underscore}_#{method_alias}"
+            alias_method method_alias, method_name
+            define_method(method_name) do |*args|
+              logging = false
+              logging = Ext.log_failure_of_method_in_progress = true if !frozen? && !Ext.log_failure_of_method_in_progress?
+              send(method_alias, *args).tap do |result|
+                unless frozen?
+                  if logging
+                    output = output_formatter&.call(self, method_name, args)
+                    output ||= "#{self.inspect}.#{method_name}#{"(#{args.map(&:inspect).join(',')})" unless args.array_without_glimmer_empty?}"
+                    puts Colours::RED + "FAILED: #{output}" if Glimmer::Specification::Element::Fact.fact_block_in_progress && !result
+                    Ext.log_failure_of_method_in_progress = false
+                  end
+                end
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end
+
 Dir[File.expand_path('./ext/*.rb', __dir__)].each {|f| require f}

data/lib/glimmer-dsl-specification.rb

@@ -22,6 +22,7 @@
 $LOAD_PATH.unshift(File.expand_path('.', __dir__))
 
 require 'facets/string/camelcase'
+require 'facets/string/underscore'
 require 'puts_debuggerer'
 require 'colours'
 require 'glimmer'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: glimmer-dsl-specification
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.0.4
 platform: ruby
 authors:
 - Andy Maleh
@@ -122,6 +122,8 @@ files:
 - lib/glimmer/specification/element/specification.rb
 - lib/glimmer/specification/element/use_case.rb
 - lib/glimmer/specification/ext.rb
+- lib/glimmer/specification/ext/array.rb
+- lib/glimmer/specification/ext/object.rb
 - lib/glimmer/specification/ext/string.rb
 - lib/glimmer/specification/rake_tasks.rb
 homepage: http://github.com/AndyObtiva/glimmer-dsl-specification