brutal 0.2.1 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 68550f0dd2c889c98a665a1ddd83dc0dccad1142858f5520af54f9ef3e0bd8e2
-  data.tar.gz: 9756e39c673ef3a85b4556e85f8fff0d0841e207dfe414a2c230dc02c21a40e6
+  metadata.gz: 8e7af479b185bf19e8cb7050360c79d216af2916668e76efb0d7c550e553af4b
+  data.tar.gz: e917683e2edd247429cb9776444e6a97c10b9930265459a10ac8a3b4dbcf2cf6
 SHA512:
-  metadata.gz: de1dd6a46db62eddebabc9f0211d99378f0770be1d096499de82c4a427fcde3eadc4e438e8752adafbf03feb1198e2d95134b7176c925d7995c15445a072d30c
-  data.tar.gz: 14f650e0b87ef69d5e95b75e1beedc3ded6db3f8b21c20a675dfe1dd423dd2fc3f282af6056fdd0eedbf15f740b27dd30013b05a9aab95545bda59c9bc596392
+  metadata.gz: ad95d20234be22ed17de738afa0f1f1e0a5518cbf967fe87f9f1932f571e13d683a454354dd792f07d55010033dfd257b888422a880a4bd6c0f04ed19cf284ed
+  data.tar.gz: c4e82e9a5036e134e83f86c313277573926fe0773ef3e2e43145d30fb725ba6a7a196f881f090f083589ac447889b7aa10d1d7e450ec550f468792991bffb824

data/README.md

@@ -1,14 +1,23 @@
-# Brutal
+# Brutal 👹
 
-> Brutal test suite scaffold generator
-
-![A lumberjack brutally cutting a tree.](https://raw.githubusercontent.com/fixrb/brutal/master/img/Ferdinand_Hodler_-_Woodcutter_-_Google_Art_Project.jpg)
+> I don't like testing because it's redundant. If we are smart enough, we can avoid it. <br/>
+> -- Matz
 
 [![Build Status](https://api.travis-ci.org/fixrb/brutal.svg?branch=master)][travis]
 [![Gem Version](https://badge.fury.io/rb/brutal.svg)][gem]
 [![Inline docs](https://inch-ci.org/github/fixrb/brutal.svg?branch=master)][inchpages]
 [![Documentation](http://img.shields.io/:yard-docs-38c800.svg)][rubydoc]
 
+__Brutal__ is a _code-first_ approach that automates the writing of unit tests.
+
+By being able to generate test cases from the code itself, developers can focus on their creation, save time and energy, for more happiness.
+
+<p>
+  <img
+    src="https://github.com/fixrb/brutal/raw/master/img/Ferdinand_Hodler_-_Woodcutter_-_Google_Art_Project.jpg"
+    alt="A lumberjack brutally cutting a tree" />
+</p>
+
 ## Installation
 
 Add this line to your application's Gemfile:
@@ -34,9 +43,10 @@ Just type `brutal` in a Ruby project's folder and watch the magic happen.
 The Brutal YAML file handles 4 keys:
 
 * `header` (optional): Some code to execute before the test suite.
-* `subject` (required): The front object of the test suite.
-* `variables` (required): A hash to decline the subject in to various contexts.
-* `challenges` (required): An array of methods to apply to each result.
+* `front_object` (required): The front object of the test suite.
+* `subject` (required): The object of each context.
+* `variables` (required): A hash to generate the subject of each context.
+* `actual_values` (required): A list of tests to challenge the subject.
 
 ## Example
 
@@ -44,61 +54,43 @@ Given this `.brutal.yml` config file:
 
 ```yaml
 ---
-header: |
-  # Some string concatenation unit tests
+front_object: |
+  "Hello "
 
 subject: |
-  "Hello" + "%{hello_target}%{punctuation_mark}"
+  %{front_object} + %{string}
 
 variables:
-  :hello_target:
-    -
-    - ", Bob"
-
-  :punctuation_mark:
-    - "!"
-    - ...
+  string:
+    - "'Alice'"
+    - "'Bob'"
 
-challenges:
-  - "%{actual}.to_s"
-  - "%{actual}.length"
+actual_values:
+  - "%{subject}.to_s"
+  - "%{subject}.length"
 ```
 
-The `brutal` command would generate the following file:
+The `brutal` command would save this Plain Old Ruby in to a `test.rb` file:
 
 ```ruby
-# Some string concatenation unit tests
-
-# ------------------------------------------------------------------------------
-
-actual = "Hello" + "!"
-
-raise unless actual.to_s == "Hello!"
-raise unless actual.length == 6
-
-# ------------------------------------------------------------------------------
-
-actual = "Hello" + "..."
-
-raise unless actual.to_s == "Hello..."
-raise unless actual.length == 8
+front_object = "Hello "
 
 # ------------------------------------------------------------------------------
 
-actual = "Hello" + ", Bob!"
-
-raise unless actual.to_s == "Hello, Bob!"
+actual = front_object + 'Alice'
+raise unless actual.to_s == "Hello Alice"
 raise unless actual.length == 11
 
 # ------------------------------------------------------------------------------
 
-actual = "Hello" + ", Bob..."
-
-raise unless actual.to_s == "Hello, Bob..."
-raise unless actual.length == 13
+actual = front_object + 'Bob'
+raise unless actual.to_s == "Hello Bob"
+raise unless actual.length == 9
 ```
 
-## Integration with Rake
+[More examples](examples/) are available.
+
+## Rake integration example
 
 The generated brutal test suite `test.rb` file can be declared as follows:
 
@@ -119,6 +111,10 @@ end
 * [Rubinius](https://rubinius.com/)
 * [JRuby](https://www.jruby.org/)
 
+## Versioning
+
+__Brutal__ follows [Semantic Versioning 2.0](https://semver.org/).
+
 ## Contributing
 
 Bug reports and pull requests are welcome on GitHub at https://github.com/fixrb/brutal. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/fixrb/brutal/blob/master/CODE_OF_CONDUCT.md).
@@ -135,3 +131,12 @@ Everyone interacting in the GreatGuardian project's codebases, issue trackers, c
 [travis]: https://travis-ci.org/fixrb/brutal
 [inchpages]: https://inch-ci.org/github/fixrb/brutal
 [rubydoc]: https://rubydoc.info/gems/brutal/frames
+
+***
+
+<p>
+  This project is sponsored by:<br />
+  <a href="https://sashite.com/"><img
+    src="https://github.com/fixrb/brutal/raw/master/img/sashite.png"
+    alt="Sashite" /></a>
+</p>

data/bin/brutal

@@ -10,29 +10,34 @@ abort "File #{CONF_PATH} not found!" unless ::File.exist?(CONF_PATH)
 
 conf = ::YAML.load_file(CONF_PATH)
 
-header      = conf.fetch('header', '')
-subject     = conf.fetch('subject')
-challenges  = conf.fetch('challenges')
-variables   = conf.fetch('variables')
+header        = conf.fetch('header', '').to_s.chomp
+front_object  = conf.fetch('front_object')
+subject       = conf.fetch('subject')
+variables     = conf.fetch('variables', {})
+actual_values = conf.fetch('actual_values')
 
-raise ::TypeError unless header.is_a?(::String)
-raise ::TypeError unless challenges.is_a?(::Array)
+raise ::TypeError unless subject.is_a?(::String)
 raise ::TypeError unless variables.is_a?(::Hash)
+raise ::TypeError unless actual_values.is_a?(::Array)
+
+front_object = front_object.chomp if front_object.is_a?(::String)
 
 require_relative ::File.join('..', 'lib', 'brutal')
 
-brutal_scaffold = case ARGV.fetch(0, nil)
-                  when nil
-                    ::Brutal::Framework::Por
-                  else
-                    abort "Framework #{ARGV[0].inspect} not (yet) supported!"
-                  end
+scaffold = case ARGV.fetch(0, nil)
+           when nil
+             ::Brutal::ScaffoldGenerator::Por
+           else
+             abort "#{ARGV[0].inspect} not (yet) supported!"
+           end
 
-eval(header)
+eval(header) # rubocop:disable Security/Eval
 
-brutal_specs = header + brutal_scaffold.new(subject, *challenges, **variables)
-                                       .to_s
+doc = [
+  header,
+  scaffold.new(front_object, subject, *actual_values, **variables).to_s
+].reject(&:empty?).join("\n")
 
 file = ::File.open('test.rb', 'w')
-file.write(brutal_specs)
+file.write(doc)
 file.close

data/lib/brutal.rb

@@ -6,6 +6,6 @@
 module Brutal
 end
 
-Dir[File.join File.dirname(__FILE__), 'brutal', 'framework', '*.rb'].each do |fname|
+Dir[File.join File.dirname(__FILE__), 'brutal', 'scaffold_generator', '*.rb'].each do |fname|
   require_relative fname
 end

data/lib/brutal/scaffold_generator/base.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+module Brutal
+  module ScaffoldGenerator
+    # Base class
+    class Base
+      # @api private
+      attr_reader :front_object_str, :front_object, :subject, :actual_values, :variables
+
+      # Initialize a new scaffold generator
+      def initialize(front_object, subject, *actual_values, **variables)
+        raise 'Empty actual values!'  if actual_values.empty?
+        raise 'Empty variables!'      if variables.empty?
+
+        @front_object_str = inspect(front_object)
+        @front_object     = eval(@front_object_str) # rubocop:disable Security/Eval
+        @subject          = subject
+        @actual_values    = actual_values
+        @variables        = variables
+      end
+
+      # Return a Ruby string that can be evaluated.
+      def inspect(object)
+        return object.to_s unless object.is_a?(::String)
+
+        object.strip
+      end
+    end
+  end
+end

data/lib/brutal/scaffold_generator/por.rb

@@ -0,0 +1,52 @@
+# frozen_string_literal: true
+
+require_relative 'base'
+
+module Brutal
+  module ScaffoldGenerator
+    # Plain Old Ruby.
+    #
+    # @api private
+    #
+    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]))
+
+        blank_line +
+        "front_object = #{front_object_str}\n" +
+        blank_line +
+        test_params.map do |values|
+          attributes = names.each_with_index.inject(front_object: 'front_object') do |h, (name, i)|
+            h.merge(name.to_sym => inspect(values.fetch(i)))
+          end
+
+          actual_str = format(inspect(subject), **attributes)
+
+          string = "actual = #{actual_str}\n"
+          actual = eval(actual_str) # rubocop:disable Security/Eval, Lint/UselessAssignment
+
+          actual_values.each do |actual_value|
+            result_str = format(actual_value, subject: 'actual')
+            string += "raise unless #{result_str} == #{eval(result_str).inspect}\n" # rubocop:disable Security/Eval
+          end
+
+          string
+        end.join(blank_line)
+      end
+
+      def blank_line
+        "\n"                \
+        "# #{('-' * 78)}\n" \
+        "\n"
+      end
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: brutal
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.3.0
 platform: ruby
 authors:
 - Cyril Kato
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-12-17 00:00:00.000000000 Z
+date: 2019-12-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -94,7 +94,7 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.9'
-description: Brutal test suite scaffold generator
+description: Scaffolds test cases from the code itself.
 email: contact@cyril.email
 executables:
 - brutal
@@ -105,8 +105,8 @@ files:
 - README.md
 - bin/brutal
 - lib/brutal.rb
-- lib/brutal/framework/base.rb
-- lib/brutal/framework/por.rb
+- lib/brutal/scaffold_generator/base.rb
+- lib/brutal/scaffold_generator/por.rb
 homepage: https://github.com/fixrb/brutal
 licenses:
 - MIT
@@ -126,8 +126,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.6
+rubygems_version: 3.1.2
 signing_key: 
 specification_version: 4
-summary: Brutal test suite scaffold generator
+summary: Scaffolds test cases from the code itself.
 test_files: []

data/lib/brutal/framework/base.rb

@@ -1,22 +0,0 @@
-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
-    end
-  end
-end

data/lib/brutal/framework/por.rb

@@ -1,41 +0,0 @@
-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