brutal 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6a587ca80409c91605c6f0045e4f3b8b40f517b755e196748f0fc8dba6bff6e9
-  data.tar.gz: 722b740531d4046ef5c3a639e93aa0c9edcfa362f63d43dfe77ae37ab9ee9062
+  metadata.gz: 52cb0e853f0cb1644e497b1566b675da404cf9e0570ef449862b03edc8764bac
+  data.tar.gz: 99cd7cb1d648fc3275d811eb41cb5a820bc5c82bce9c9a19b6834677c5626e6a
 SHA512:
-  metadata.gz: e3147d44673898eee50b89db97c2f6ad19a48dd64b1c5df8c023ca64fe554a7d0a787f0f3241eb8e613aec2af59b50cda7331814807c80c1d2fed6ab833fac85
-  data.tar.gz: 5e5d91e3d1139fae44f148632d6c94c944e407bf75c684db73ebc7cc15fa804855d90f2e6606280cafdf42d0a630a5a48068a0df45c32311ec2f85096345576c
+  metadata.gz: d7605a2eb8219c17786724d1129b64a0863e6113c07025d07c5e9a67c16dc6ff42234d553fbfa9e1f940b31142cae729a36749a841496d92f520cd2342e54f44
+  data.tar.gz: f6418c02326b3d52c8436ea640575b154e0c4299940e5907f8842af9d49c68854d5cc2b33b27d212e76c373946833ee7e0f52b22cffbf0665117b82aae2866c7

data/README.md

@@ -2,7 +2,7 @@
 
 > Brutal test suite scaffold generator
 
-![A lumberjack brutally cutting a tree.](img/Ferdinand_Hodler_-_Woodcutter_-_Google_Art_Project.jpg)
+![A lumberjack brutally cutting a tree.](https://raw.githubusercontent.com/cyril/brutal.rb/master/img/Ferdinand_Hodler_-_Woodcutter_-_Google_Art_Project.jpg)
 
 [![Build Status](https://api.travis-ci.org/cyril/brutal.rb.svg?branch=master)][travis]
 [![Gem Version](https://badge.fury.io/rb/brutal.svg)][gem]
@@ -25,7 +25,7 @@ Or install it yourself as:
 
     $ gem install brutal
 
-## QuickStart
+## Quick Start
 
 Just type `brutal` in a Ruby project's folder and watch the magic happen.
 
@@ -43,6 +43,7 @@ The Brutal YAML file handles 4 keys:
 Given this `.brutal.yml` config file:
 
 ```yaml
+---
 header: |
   # Some string concatenation unit tests
 
@@ -59,8 +60,8 @@ variables:
     - ...
 
 challenges:
-  - .to_s
-  - .length
+  - "%{actual}.to_s"
+  - "%{actual}.length"
 ```
 
 The `brutal` command would generate the following file:
@@ -70,31 +71,31 @@ The `brutal` command would generate the following file:
 
 # ------------------------------------------------------------------------------
 
-result = "Hello" + "!"
+actual = "Hello" + "!"
 
-raise unless result.to_s == "Hello!"
-raise unless result.length == 6
+raise unless actual.to_s == "Hello!"
+raise unless actual.length == 6
 
 # ------------------------------------------------------------------------------
 
-result = "Hello" + "..."
+actual = "Hello" + "..."
 
-raise unless result.to_s == "Hello..."
-raise unless result.length == 8
+raise unless actual.to_s == "Hello..."
+raise unless actual.length == 8
 
 # ------------------------------------------------------------------------------
 
-result = "Hello" + ", Bob!"
+actual = "Hello" + ", Bob!"
 
-raise unless result.to_s == "Hello, Bob!"
-raise unless result.length == 11
+raise unless actual.to_s == "Hello, Bob!"
+raise unless actual.length == 11
 
 # ------------------------------------------------------------------------------
 
-result = "Hello" + ", Bob..."
+actual = "Hello" + ", Bob..."
 
-raise unless result.to_s == "Hello, Bob..."
-raise unless result.length == 13
+raise unless actual.to_s == "Hello, Bob..."
+raise unless actual.length == 13
 ```
 
 ## Integration with Rake

data/bin/brutal

@@ -23,7 +23,7 @@ require_relative ::File.join('..', 'lib', 'brutal')
 
 brutal_scaffold = case ARGV.fetch(0, nil)
                   when nil
-                    ::Brutal::Framework::Poro
+                    ::Brutal::Framework::Por
                   else
                     abort "Framework #{ARGV[0].inspect} not (yet) supported!"
                   end

data/lib/brutal.rb

@@ -1,5 +1,8 @@
 # frozen_string_literal: true
 
+# Main namespace
+#
+# @api public
 module Brutal
 end
 

data/lib/brutal/framework/base.rb

@@ -1,14 +1,19 @@
 module Brutal
   module Framework
     class Base
+      # @api private
       attr_reader :subject, :challenges, :variables
 
+      # Initialize a new framework
       def initialize(subject, *challenges, **variables)
         @subject    = subject
         @challenges = challenges
         @variables  = variables
       end
 
+      # Return a string representation
+      #
+      # @api private
       def to_s
         raise ::NotImplementedError
       end

data/lib/brutal/framework/por.rb

@@ -0,0 +1,41 @@
+require_relative 'base'
+
+module Brutal
+  module Framework
+    # Plain Old Ruby
+    class Por < Base
+      # Return a string representation
+      #
+      # @return [String]
+      #
+      # @api public
+      def to_s
+        names       = variables.keys.sort
+        values_arr  = names.map { |name| variables.fetch(name) }
+        test_params = Array(values_arr[0]).product(*Array(values_arr[1..-1]))
+
+        test_params.inject('') do |string, values|
+          attributes = names.each_with_index.inject({}) do |h, (name, i)|
+            h.merge(name.to_sym => values.fetch(i))
+          end
+
+          actual_str = subject % attributes
+
+          string += "\n"                \
+                    "# #{('-' * 78)}\n" \
+                    "\n"                \
+                    "actual = #{actual_str}\n"
+
+          actual = eval(actual_str)
+
+          challenges.each do |challenge|
+            result  = challenge % { actual: 'actual' }
+            string += "raise unless #{result} == #{eval(result).inspect}\n"
+          end
+
+          string
+        end
+      end
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: brutal
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Cyril Kato
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-12-15 00:00:00.000000000 Z
+date: 2019-12-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -110,7 +110,7 @@ files:
 - bin/setup
 - lib/brutal.rb
 - lib/brutal/framework/base.rb
-- lib/brutal/framework/poro.rb
+- lib/brutal/framework/por.rb
 homepage: https://github.com/cyril/brutal.rb
 licenses:
 - MIT

data/lib/brutal/framework/poro.rb

@@ -1,31 +0,0 @@
-require_relative 'base'
-
-module Brutal
-  module Framework
-    class Poro < Base
-      def to_s
-        names       = variables.keys.sort
-        values_arr  = names.map { |name| variables.fetch(name) }
-        test_params = Array(values_arr[0]).product(*Array(values_arr[1..-1]))
-
-        test_params.inject('') do |scaffold, values|
-          attributes = names.each_with_index.inject({}) do |h, (name, i)|
-            h.merge(name.to_sym => values.fetch(i))
-          end
-
-          populated_subject = subject % attributes
-          result = eval(populated_subject)
-
-          scaffold += "\n# " + ('-' * 78) + "\n\nresult = #{populated_subject}\n"
-
-          challenges.each do |challenge|
-            value = "result#{challenge}"
-            scaffold += "raise unless #{value} == #{eval(value).inspect}\n"
-          end
-
-          scaffold
-        end
-      end
-    end
-  end
-end