brutal 0.2.0 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 52cb0e853f0cb1644e497b1566b675da404cf9e0570ef449862b03edc8764bac
-  data.tar.gz: 99cd7cb1d648fc3275d811eb41cb5a820bc5c82bce9c9a19b6834677c5626e6a
+  metadata.gz: 332c8755656f334781310460780dd233d621ddac83bc7d7dc5f0c555f4d1f955
+  data.tar.gz: c49ae44f98432fb3839bcf7c76ac3929bfee3eac82113bc4903e6d288863865e
 SHA512:
-  metadata.gz: d7605a2eb8219c17786724d1129b64a0863e6113c07025d07c5e9a67c16dc6ff42234d553fbfa9e1f940b31142cae729a36749a841496d92f520cd2342e54f44
-  data.tar.gz: f6418c02326b3d52c8436ea640575b154e0c4299940e5907f8842af9d49c68854d5cc2b33b27d212e76c373946833ee7e0f52b22cffbf0665117b82aae2866c7
+  metadata.gz: f015f9cbc3f478c66374b72a3c6e7340863b472eac796833700aa11a501c3361b2519939f0e407308a6800df23bb7ba959ec60d70f5b16acb86f3d30ae0440e2
+  data.tar.gz: 90c7d4fef875977bd991a16405675e424524d2478318d33e694d073a47348986a2bb93bc27f9ff5cdfb5d5d48120d334f55733ad0ff6a3880c401ba901c85391

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,38 @@
-# Brutal
+# Brutal 💎🔨
 
-> Brutal test suite scaffold generator
-
-![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]
+[![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.
+
+## 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)
+
+## Overview
+
+Let __Brutal__ shape for you in no time the actual behavior of your code through as many combinations of contexts as needed.
+
+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__ development process does not prevent from bugs.
+
+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.
+
+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
 
 Add this line to your application's Gemfile:
@@ -31,76 +55,67 @@ Just type `brutal` in a Ruby project's folder and watch the magic happen.
 
 ## Usage
 
-The Brutal YAML file handles 4 keys:
+The `brutal.yml` file is a manifest you can use to define your __Brutal__ meta-spec.
+It has 4 top-level sections:
 
-* `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.
+* `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.
 
-## Example
+### Getting started
 
-Given this `.brutal.yml` 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
 ---
-header: |
-  # Some string concatenation unit tests
-
 subject: |
-  "Hello" + "%{hello_target}%{punctuation_mark}"
+  "Hello " + "%{string}"
 
-variables:
-  :hello_target:
-    -
-    - ", Bob"
+contexts:
+  string:
+    - Alice
+    - Bob
 
-  :punctuation_mark:
-    - "!"
-    - ...
-
-challenges:
-  - "%{actual}.to_s"
-  - "%{actual}.length"
+actuals:
+  - "%{subject}.to_s"
+  - "%{subject}.length"
 ```
 
-The `brutal` command would generate the following file:
-
-```ruby
-# Some string concatenation unit tests
+2. Run the `brutal` command from the same directory.
 
-# ------------------------------------------------------------------------------
+3. Read the generated `test.rb` file in the same directory:
 
-actual = "Hello" + "!"
-
-raise unless actual.to_s == "Hello!"
-raise unless actual.length == 6
+```ruby
+# Brutal test suite
 
 # ------------------------------------------------------------------------------
 
-actual = "Hello" + "..."
+actual = begin
+  "Hello " + "Alice"
+end
 
-raise unless actual.to_s == "Hello..."
-raise unless actual.length == 8
+raise if actual.to_s != "Hello Alice"
+raise if actual.length != 11
 
 # ------------------------------------------------------------------------------
 
-actual = "Hello" + ", Bob!"
+actual = begin
+  "Hello " + "Bob"
+end
 
-raise unless actual.to_s == "Hello, Bob!"
-raise unless actual.length == 11
+raise if actual.to_s != "Hello Bob"
+raise if actual.length != 9
+```
 
-# ------------------------------------------------------------------------------
+### More examples
 
-actual = "Hello" + ", Bob..."
+https://github.com/fixrb/brutal/raw/master/examples/
 
-raise unless actual.to_s == "Hello, Bob..."
-raise unless actual.length == 13
-```
+## Rake integration example
 
-## Integration with Rake
-
-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|
@@ -110,28 +125,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

@@ -1,38 +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', '')
-subject     = conf.fetch('subject')
-challenges  = conf.fetch('challenges')
-variables   = conf.fetch('variables')
-
-raise ::TypeError unless header.is_a?(::String)
-raise ::TypeError unless challenges.is_a?(::Array)
-raise ::TypeError unless variables.is_a?(::Hash)
-
-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
-
-eval(header)
-
-brutal_specs = header + brutal_scaffold.new(subject, *challenges, **variables)
-                                       .to_s
-
-file = ::File.open('test.rb', 'w')
-file.write(brutal_specs)
-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', 'framework', '*.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,45 +1,45 @@
 --- !ruby/object:Gem::Specification
 name: brutal
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 1.0.0
 platform: ruby
 authors:
 - Cyril Kato
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-12-16 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.0'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '2.0'
+        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'
+        version: '0'
 - !ruby/object:Gem::Dependency
-  name: rubocop
+  name: rubocop-performance
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -53,7 +53,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: rubocop-performance
+  name: rubocop-thread_safety
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -70,48 +70,44 @@ dependencies:
   name: simplecov
   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: 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'
-description: Brutal test suite scaffold generator
+        version: '0'
+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/por.rb
-homepage: https://github.com/cyril/brutal.rb
+- lib/brutal/configuration.rb
+- lib/brutal/scaffold.rb
+homepage: https://github.com/fixrb/brutal
 licenses:
 - MIT
 metadata: {}
@@ -130,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: 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,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