brutal 0.1.0 → 0.4.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6a587ca80409c91605c6f0045e4f3b8b40f517b755e196748f0fc8dba6bff6e9
-  data.tar.gz: 722b740531d4046ef5c3a639e93aa0c9edcfa362f63d43dfe77ae37ab9ee9062
+  metadata.gz: 491dc26f34135ff61ceb54bc64b4dc5793e8b2610d545b3025b8c7aaf53b3064
+  data.tar.gz: e7c379c45ce23f0886041ec8a4b6ab4c493a91e450230b64968e45a92214a62e
 SHA512:
-  metadata.gz: e3147d44673898eee50b89db97c2f6ad19a48dd64b1c5df8c023ca64fe554a7d0a787f0f3241eb8e613aec2af59b50cda7331814807c80c1d2fed6ab833fac85
-  data.tar.gz: 5e5d91e3d1139fae44f148632d6c94c944e407bf75c684db73ebc7cc15fa804855d90f2e6606280cafdf42d0a630a5a48068a0df45c32311ec2f85096345576c
+  metadata.gz: 8791614f90a92630a28aa3fb8b6d2a9d1921404b1cc614302bfeb8a87970186c33b935d81db81b7c1d8751475a59d5f32c17ea80627d32755daece880b93ace4
+  data.tar.gz: 19cf4fcbe94766983442f0f47b2651b5b675d5ade1c9b306e4213421d21253035545a23f8e6c988a8967db182b4de59a4158a545278684b4104039729963574c

data/LICENSE.md

@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright (c) 2019 Cyril Kato
+Copyright (c) 2020 Cyril Kato
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

data/README.md

@@ -1,14 +1,37 @@
-# Brutal
+# Brutal 💎🔨
 
-> Brutal test suite scaffold generator
-
-![A lumberjack brutally cutting a tree.](img/Ferdinand_Hodler_-_Woodcutter_-_Google_Art_Project.jpg)
-
-[![Build Status](https://api.travis-ci.org/cyril/brutal.rb.svg?branch=master)][travis]
+[![RuboCop Status](https://github.com/fixrb/brutal/workflows/RuboCop/badge.svg)][workflow_rubocop]
+[![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/cyril/brutal.rb.svg?branch=master)][inchpages]
+[![Inline docs](https://inch-ci.org/github/fixrb/brutal.svg?branch=master)][inchpages]
 [![Documentation](http://img.shields.io/:yard-docs-38c800.svg)][rubydoc]
 
+> A _code-first_ approach to automate the writing of unit tests.
+
+## Why
+
+[![I Hate Tests](https://github.com/fixrb/brutal/raw/master/img/rubyhack-2019-ruby3-what-s-missing-by-yukihiro-matsumoto.jpg)](https://www.youtube.com/embed/cmOt9HhszCI?start=1732&end=1736 "I don't like tests. It's not DRY.")
+
+> I don't like tests. It's not DRY.<br/>
+> -- [Matz](https://github.com/matz)
+
+## Purpose
+
+Let __Brutal__ shape for you the actual behavior of your code against as many combinations of challenges as needed.
+
+Without giving the power to test everything, it makes it easy to generate in no time a set of tests for all relevant contexts.
+
+By delegating to __Brutal__ this repetitive (and redundant) job of writing tests, you'll be able to focus on your core business: writing code.
+
+## Warning
+
+__Brutal__ does not prevent from bugs.
+As a picture of the behavior of the code, generated tests would be wrong if the code is wrong.
+
+This is why it is important to carefully read a generated test suite, to ensure that it describes the behavior of the code as it is expected to behave.
+
+This is the cost to enter the _Brutal-Driven Development_ with confidence.
+
 ## Installation
 
 Add this line to your application's Gemfile:
@@ -25,81 +48,123 @@ 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.
 
 ## Usage
 
-The Brutal YAML file handles 4 keys:
+__Brutal__'s configuration file is `.brutal.yml`, which acts like a meta-spec.
+This YAML file can contains the following 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.
+
+### Behavioral integrity
+
+In versioned projects,
+the integrity of the behavior of the code could easily be compared by executing `brutal` after changes.
+
+Assuming a project is versioned with git,
+if something goes wrong, the `git diff test.rb` command should instantly show changes between the behavior of the previous code and the behavior of the new one.
+
+Example of regression from [The Greeter class](https://github.com/fixrb/brutal/raw/master/examples/the_greeter_class/):
+
+```diff
+  require './greeter'
+
+  # ------------------------------------------------------------------------------
+
+  front_object = Greeter
+
+  # ------------------------------------------------------------------------------
+
+  actual = front_object.new('world')
+
+- raise unless actual.salute == "Hello World!"
++ raise unless actual.salute == "Hello !"
+```
+
+### Optional parameters
+
+It would also be possible to ask for an RSpec template by passing "`rspec`" argument:
+
+```sh
+brutal rspec
+```
 
 ## Example
 
-Given this `.brutal.yml` config file:
+Given this 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"
+  string:
+    - "'Alice'"
+    - "'Bob'"
 
-  :punctuation_mark:
-    - "!"
-    - ...
-
-challenges:
-  - .to_s
-  - .length
+actual_values:
+  - "%{subject}.to_s"
+  - "%{subject}.length"
 ```
 
-The `brutal` command would generate the following file:
+The `brutal` command would generate and write in to a `test.rb` file the following "Plain Old Ruby":
 
 ```ruby
-# Some string concatenation unit tests
+front_object = "Hello "
 
 # ------------------------------------------------------------------------------
 
-result = "Hello" + "!"
+actual = front_object + 'Alice'
 
-raise unless result.to_s == "Hello!"
-raise unless result.length == 6
+raise unless actual.to_s == "Hello Alice"
+raise unless actual.length == 11
 
 # ------------------------------------------------------------------------------
 
-result = "Hello" + "..."
+actual = front_object + 'Bob'
 
-raise unless result.to_s == "Hello..."
-raise unless result.length == 8
+raise unless actual.to_s == "Hello Bob"
+raise unless actual.length == 9
+```
 
-# ------------------------------------------------------------------------------
+And the `brutal rspec` command would generate and write in to a `test_spec.rb` file the following spec:
 
-result = "Hello" + ", Bob!"
+```ruby
+RSpec.describe do
+  let(:front_object) { "Hello " }
 
-raise unless result.to_s == "Hello, Bob!"
-raise unless result.length == 11
+  context do
+    let(:actual) { front_object + 'Alice' }
 
-# ------------------------------------------------------------------------------
+    it { expect(actual.to_s).to eq("Hello Alice") }
+    it { expect(actual.length).to eq(11) }
+  end
 
-result = "Hello" + ", Bob..."
+  context do
+    let(:actual) { front_object + 'Bob' }
 
-raise unless result.to_s == "Hello, Bob..."
-raise unless result.length == 13
+    it { expect(actual.to_s).to eq("Hello Bob") }
+    it { expect(actual.length).to eq(9) }
+  end
+end
 ```
 
-## Integration with Rake
+More examples are available [here](https://github.com/fixrb/brutal/raw/master/examples/).
+
+## Rake integration example
 
-The generated brutal test suite `test.rb` file can be declared as follows:
+A generated `test.rb` file could be matched as follows:
 
 ```ruby
 Rake::TestTask.new do |t|
@@ -109,28 +174,27 @@ end
 
 ## Contact
 
-* Home page: https://github.com/cyril/brutal.rb
-* Bugs/issues: https://github.com/cyril/brutal.rb/issues
-
-## Rubies
-
-* [MRI](https://www.ruby-lang.org/)
-* [Rubinius](https://rubinius.com/)
-* [JRuby](https://www.jruby.org/)
+* Source code: https://github.com/fixrb/brutal
 
-## Contributing
+## Versioning
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/cyril/brutal.rb. 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/cyril/brutal.rb/blob/master/CODE_OF_CONDUCT.md).
+__Brutal__ follows [Semantic Versioning 2.0](https://semver.org/).
 
 ## License
 
 The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
 
-## Code of Conduct
+***
 
-Everyone interacting in the GreatGuardian project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/cyril/brutal.rb/blob/master/CODE_OF_CONDUCT.md).
+<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>
 
+[workflow_rubocop]: https://github.com/fixrb/brutal/actions?query=workflow%3ARuboCop
 [gem]: https://rubygems.org/gems/brutal
-[travis]: https://travis-ci.org/cyril/brutal.rb
-[inchpages]: https://inch-ci.org/github/cyril/brutal.rb
+[travis]: https://travis-ci.org/fixrb/brutal
+[inchpages]: https://inch-ci.org/github/fixrb/brutal
 [rubydoc]: https://rubydoc.info/gems/brutal/frames

data/bin/brutal

@@ -10,29 +10,36 @@ 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::Poro
-                  else
-                    abort "Framework #{ARGV[0].inspect} not (yet) supported!"
-                  end
+scaffold, file_name  = case ARGV.fetch(0, nil)
+                       when nil
+                         [::Brutal::ScaffoldGenerator::Por, 'test.rb']
+                       when 'rspec'
+                         [::Brutal::ScaffoldGenerator::RSpec, 'test_spec.rb']
+                       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\n")
 
-file = ::File.open('test.rb', 'w')
-file.write(brutal_specs)
+file = ::File.open(file_name, 'w')
+file.write(doc)
 file.close

data/lib/brutal.rb

@@ -1,8 +1,11 @@
 # frozen_string_literal: true
 
+# Main namespace
+#
+# @api public
 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,58 @@
+# 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.gsub(/\A\n/, '') +
+        "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 = <<~CODE
+            actual = begin
+            #{actual_str.gsub(/^/, '  ')}
+            end
+
+          CODE
+
+          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

data/lib/brutal/scaffold_generator/rspec.rb

@@ -0,0 +1,55 @@
+# frozen_string_literal: true
+
+require_relative 'base'
+
+module Brutal
+  module ScaffoldGenerator
+    # Plain Old Ruby.
+    #
+    # @api private
+    #
+    class RSpec < 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]))
+
+        "RSpec.describe do\n"                             \
+        "  let(:front_object) { #{front_object_str} }\n"  \
+        "\n" +
+        test_params.map do |values|
+          string = "  context do\n"
+
+          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 += "    let(:actual) { #{actual_str} }\n\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 += "    it { expect(#{result_str}).to eq(#{eval(result_str).inspect}) }\n" # rubocop:disable Security/Eval
+          end
+
+          string += "  end\n"
+
+          string
+        end.join(blank_line) +
+        "end\n"
+      end
+
+      def blank_line
+        "\n"
+      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.4.1
 platform: ruby
 authors:
 - Cyril Kato
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-12-15 00:00:00.000000000 Z
+date: 2020-01-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.0'
+        version: '2.1'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.0'
+        version: '2.1'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -42,30 +42,30 @@ dependencies:
   name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '0.79'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '0.79'
 - !ruby/object:Gem::Dependency
   name: rubocop-performance
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.5'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.5'
 - !ruby/object:Gem::Dependency
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
@@ -80,6 +80,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.17'
+- !ruby/object:Gem::Dependency
+  name: spectus
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.1'
 - !ruby/object:Gem::Dependency
   name: yard
   requirement: !ruby/object:Gem::Requirement
@@ -94,24 +108,21 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.9'
-description: Brutal test suite scaffold generator
+description: A code-first approach to automate the writing of unit tests.
 email: contact@cyril.email
 executables:
 - brutal
-- console
-- setup
 extensions: []
 extra_rdoc_files: []
 files:
 - LICENSE.md
 - README.md
 - bin/brutal
-- bin/console
-- bin/setup
 - lib/brutal.rb
-- lib/brutal/framework/base.rb
-- lib/brutal/framework/poro.rb
-homepage: https://github.com/cyril/brutal.rb
+- lib/brutal/scaffold_generator/base.rb
+- lib/brutal/scaffold_generator/por.rb
+- lib/brutal/scaffold_generator/rspec.rb
+homepage: https://github.com/fixrb/brutal
 licenses:
 - MIT
 metadata: {}
@@ -130,8 +141,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: A code-first approach to automate the writing of unit tests.
 test_files: []

data/bin/console

@@ -1,7 +0,0 @@
-#!/usr/bin/env ruby
-# frozen_string_literal: true
-
-require_relative ::File.join('..', 'lib', 'brutal')
-
-require 'irb'
-IRB.start(__FILE__)

data/bin/setup

@@ -1,7 +0,0 @@
-#!/usr/bin/env bash
-
-set -euo pipefail
-IFS=$'\n\t'
-set -vx
-
-bundle install

data/lib/brutal/framework/base.rb

@@ -1,17 +0,0 @@
-module Brutal
-  module Framework
-    class Base
-      attr_reader :subject, :challenges, :variables
-
-      def initialize(subject, *challenges, **variables)
-        @subject    = subject
-        @challenges = challenges
-        @variables  = variables
-      end
-
-      def to_s
-        raise ::NotImplementedError
-      end
-    end
-  end
-end

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