brutal 0.4.1 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 491dc26f34135ff61ceb54bc64b4dc5793e8b2610d545b3025b8c7aaf53b3064
-  data.tar.gz: e7c379c45ce23f0886041ec8a4b6ab4c493a91e450230b64968e45a92214a62e
+  metadata.gz: 332c8755656f334781310460780dd233d621ddac83bc7d7dc5f0c555f4d1f955
+  data.tar.gz: c49ae44f98432fb3839bcf7c76ac3929bfee3eac82113bc4903e6d288863865e
 SHA512:
-  metadata.gz: 8791614f90a92630a28aa3fb8b6d2a9d1921404b1cc614302bfeb8a87970186c33b935d81db81b7c1d8751475a59d5f32c17ea80627d32755daece880b93ace4
-  data.tar.gz: 19cf4fcbe94766983442f0f47b2651b5b675d5ade1c9b306e4213421d21253035545a23f8e6c988a8967db182b4de59a4158a545278684b4104039729963574c
+  metadata.gz: f015f9cbc3f478c66374b72a3c6e7340863b472eac796833700aa11a501c3361b2519939f0e407308a6800df23bb7ba959ec60d70f5b16acb86f3d30ae0440e2
+  data.tar.gz: 90c7d4fef875977bd991a16405675e424524d2478318d33e694d073a47348986a2bb93bc27f9ff5cdfb5d5d48120d334f55733ad0ff6a3880c401ba901c85391

data/README.md

@@ -8,29 +8,30 @@
 
 > A _code-first_ approach to automate the writing of unit tests.
 
-## Why
+## Intro
 
 [![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
+## Overview
 
-Let __Brutal__ shape for you the actual behavior of your code against as many combinations of challenges as needed.
+Let __Brutal__ shape for you in no time the actual behavior of your code through as many combinations of contexts 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.
+By delegating to __Brutal__ the repetitive (and redundant) task of writing tests, you'll be able to focus on your core business: the code itself.
 
 ## 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.
+__Brutal__ development process does not prevent from bugs.
 
-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.
+As a _picture of the behavior of the code_,
+a generated test suite is wrong as long as the code is wrong,
+regardless of whether all true expectations.
 
-This is the cost to enter the _Brutal-Driven Development_ with confidence.
+However, this document becomes relevant when it shows that the code behaves as it is supposed to.
+It is therefore important to read it well.
+This is the price for _Brutal-Driven Development_.
 
 ## Installation
 
@@ -54,113 +55,63 @@ Just type `brutal` in a Ruby project's folder and watch the magic happen.
 
 ## Usage
 
-__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.
-* `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
+The `brutal.yml` file is a manifest you can use to define your __Brutal__ meta-spec.
+It has 4 top-level sections:
 
-It would also be possible to ask for an RSpec template by passing "`rspec`" argument:
+* `header` - Specifies the code to execute before generating the test suite.
+* `subject` - Specifies the template of the code to be declined across contexts.
+* `contexts` - Specifies a list of variables to populate the subject's template.
+* `actuals` - Specifies templates to challenge evaluated subjects & get results.
 
-```sh
-brutal rspec
-```
-
-## Example
+### Getting started
 
-Given this config file:
+1. Create a `brutal.yml` file in your application's root directory.
+The following example `brutal.yml` defines the shape of a Hello test suite:
 
 ```yaml
 ---
-front_object: |
-  "Hello "
-
 subject: |
-  %{front_object} + %{string}
+  "Hello " + "%{string}"
 
-variables:
+contexts:
   string:
-    - "'Alice'"
-    - "'Bob'"
+    - Alice
+    - Bob
 
-actual_values:
+actuals:
   - "%{subject}.to_s"
   - "%{subject}.length"
 ```
 
-The `brutal` command would generate and write in to a `test.rb` file the following "Plain Old Ruby":
+2. Run the `brutal` command from the same directory.
+
+3. Read the generated `test.rb` file in the same directory:
 
 ```ruby
-front_object = "Hello "
+# Brutal test suite
 
 # ------------------------------------------------------------------------------
 
-actual = front_object + 'Alice'
+actual = begin
+  "Hello " + "Alice"
+end
 
-raise unless actual.to_s == "Hello Alice"
-raise unless actual.length == 11
+raise if actual.to_s != "Hello Alice"
+raise if actual.length != 11
 
 # ------------------------------------------------------------------------------
 
-actual = front_object + 'Bob'
+actual = begin
+  "Hello " + "Bob"
+end
 
-raise unless actual.to_s == "Hello Bob"
-raise unless actual.length == 9
+raise if actual.to_s != "Hello Bob"
+raise if actual.length != 9
 ```
 
-And the `brutal rspec` command would generate and write in to a `test_spec.rb` file the following spec:
-
-```ruby
-RSpec.describe do
-  let(:front_object) { "Hello " }
-
-  context do
-    let(:actual) { front_object + 'Alice' }
-
-    it { expect(actual.to_s).to eq("Hello Alice") }
-    it { expect(actual.length).to eq(11) }
-  end
-
-  context do
-    let(:actual) { front_object + 'Bob' }
-
-    it { expect(actual.to_s).to eq("Hello Bob") }
-    it { expect(actual.length).to eq(9) }
-  end
-end
-```
+### More examples
 
-More examples are available [here](https://github.com/fixrb/brutal/raw/master/examples/).
+https://github.com/fixrb/brutal/raw/master/examples/
 
 ## Rake integration example
 

data/bin/brutal

@@ -1,45 +1,6 @@
 #!/usr/bin/env ruby
 # frozen_string_literal: true
 
-require 'yaml'
+require_relative File.join('..', 'lib', 'brutal')
 
-FILE_NAME = '.brutal.yml'
-CONF_PATH = ::File.join(::Dir.pwd, FILE_NAME)
-
-abort "File #{CONF_PATH} not found!" unless ::File.exist?(CONF_PATH)
-
-conf = ::YAML.load_file(CONF_PATH)
-
-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 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')
-
-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) # rubocop:disable Security/Eval
-
-doc = [
-  header,
-  scaffold.new(front_object, subject, *actual_values, **variables).to_s
-].reject(&:empty?).join("\n\n")
-
-file = ::File.open(file_name, 'w')
-file.write(doc)
-file.close
+Brutal.generate!

data/lib/brutal.rb

@@ -1,11 +1,26 @@
 # frozen_string_literal: true
 
-# Main namespace
-#
-# @api public
+%w[
+  configuration
+  scaffold
+].each { |file_name| require_relative(File.join('brutal', file_name)) }
+
+# The Brutal namespace
 module Brutal
-end
+  def self.settings
+    Configuration.load!
+  end
+
+  def self.generate
+    Scaffold.new(*settings)
+  end
+
+  def self.generate!
+    file = ::File.open('test.rb', 'w')
+    file.write(generate)
 
-Dir[File.join File.dirname(__FILE__), 'brutal', 'scaffold_generator', '*.rb'].each do |fname|
-  require_relative fname
+    true
+  ensure
+    file.close
+  end
 end

data/lib/brutal/configuration.rb

@@ -0,0 +1,45 @@
+# frozen_string_literal: true
+
+require 'yaml'
+
+module Brutal
+  # Brutal::Configuration
+  #
+  # @since 1.0.0
+  class Configuration
+    NAME = '.brutal.yml'
+    PATH = ::File.join(::Dir.pwd, NAME).freeze
+
+    def self.load!
+      new.to_a
+    end
+
+    def self.file!
+      ::YAML.load_file(PATH)
+    rescue ::Errno::ENOENT => _e
+      abort("File #{PATH} not found!")
+    end
+
+    attr_reader(:header, :subject, :contexts, :actuals)
+
+    # rubocop:disable Metrics/AbcSize
+    def initialize
+      settings = self.class.file!
+
+      @header   = settings.fetch('header',   '# Brutal test suite')
+      @subject  = settings.fetch('subject',  '')
+      @contexts = settings.fetch('contexts', {})
+      @actuals  = settings.fetch('actuals',  [])
+
+      raise ::TypeError, @header.inspect   unless @header.is_a?(::String)
+      raise ::TypeError, @subject.inspect  unless @subject.is_a?(::String)
+      raise ::TypeError, @contexts.inspect unless @contexts.is_a?(::Hash)
+      raise ::TypeError, @actuals.inspect  unless @actuals.is_a?(::Array)
+    end
+    # rubocop:enable Metrics/AbcSize
+
+    def to_a
+      [header, subject, *actuals, **contexts]
+    end
+  end
+end

data/lib/brutal/scaffold.rb

@@ -0,0 +1,81 @@
+# frozen_string_literal: true
+
+module Brutal
+  # Brutal::Scaffold
+  #
+  # @since 1.0.0
+  class Scaffold
+    attr_reader(:header, :subject, :actuals, :contexts)
+
+    # Initialize a new scaffold generator
+    def initialize(header, subject, *actuals, **contexts)
+      warn('Empty subject!')        if subject.empty?
+      warn('Empty actual values!')  if actuals.empty?
+      warn('Empty contexts!')       if contexts.empty?
+
+      eval(header) # rubocop:disable Security/Eval
+
+      @header   = header
+      @subject  = subject
+      @actuals  = actuals
+      @contexts = contexts
+    end
+
+    # Return a Ruby string that can be evaluated.
+    def inspect(object)
+      return object.to_s unless object.is_a?(::String)
+
+      object.strip
+    end
+
+    # Return a string representation
+    #
+    # @return [String]
+    #
+    # rubocop:disable Metrics/AbcSize, Metrics/MethodLength
+    def to_s
+      header.chomp + "\n" + blank_line + combinations_values.map do |values|
+        attributes = context_names.each_with_index.inject({}) 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
+
+        actuals.each do |actual_value|
+          result_str = format(actual_value, subject: 'actual')
+          string += "raise if #{result_str} != #{eval(result_str).inspect}\n" # rubocop:disable Security/Eval
+        end
+
+        string
+      end.join(blank_line)
+    end
+    # rubocop:enable Metrics/AbcSize, Metrics/MethodLength
+
+    def blank_line
+      "\n"                \
+      "# #{('-' * 78)}\n" \
+      "\n"
+    end
+
+    def context_names
+      contexts.keys.sort
+    end
+
+    def contexts_values
+      context_names.map { |context_name| contexts.fetch(context_name) }
+    end
+
+    def combinations_values
+      Array(contexts_values[0]).product(*Array(contexts_values[1..-1]))
+    end
+  end
+end

metadata

@@ -1,113 +1,99 @@
 --- !ruby/object:Gem::Specification
 name: brutal
 version: !ruby/object:Gem::Version
-  version: 0.4.1
+  version: 1.0.0
 platform: ruby
 authors:
 - Cyril Kato
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-01-23 00:00:00.000000000 Z
+date: 2020-03-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '2.1'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '2.1'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '13.0'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '13.0'
-- !ruby/object:Gem::Dependency
-  name: rubocop
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.79'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.79'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rubocop-performance
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.5'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.5'
+        version: '0'
 - !ruby/object:Gem::Dependency
-  name: simplecov
+  name: rubocop-thread_safety
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '0.17'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '0.17'
+        version: '0'
 - !ruby/object:Gem::Dependency
-  name: spectus
+  name: simplecov
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '3.1'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '3.1'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: yard
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '0.9'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '0.9'
+        version: '0'
 description: A code-first approach to automate the writing of unit tests.
 email: contact@cyril.email
 executables:
@@ -119,9 +105,8 @@ files:
 - README.md
 - bin/brutal
 - lib/brutal.rb
-- lib/brutal/scaffold_generator/base.rb
-- lib/brutal/scaffold_generator/por.rb
-- lib/brutal/scaffold_generator/rspec.rb
+- lib/brutal/configuration.rb
+- lib/brutal/scaffold.rb
 homepage: https://github.com/fixrb/brutal
 licenses:
 - MIT

data/lib/brutal/scaffold_generator/base.rb

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

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

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