brutal 1.1.0 → 1.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 31950aed12f6f2f8a292c6df194cbab35c832f649597df8a96f73a7852688da9
-  data.tar.gz: 5300bdf71607debf6de06e4ddf37e8f7c7d4104822b18784cffed24451df8f30
+  metadata.gz: 958cf59b6aea2f5e323b849c83a86399cd9ad99e2433b899160a2422275a319e
+  data.tar.gz: bdb36f749b6bfcb87683f12d3db9e74c716bdbfbf41e21c845864bf1e17f7a7e
 SHA512:
-  metadata.gz: fd76ba0d91ce4a7df5c477906970e1affb5459d2dcffa03709d6078089e95b82a0a80b372d659e6306a870b5c6f73469c6bcf95e7c8367d09f833f53941fa0de
-  data.tar.gz: 5cc889579792f8d836de4327eb83007c490e204016da975fdbe60792eea096d41c5906127a5210a5d2899cfc565024eede92d566ad69afe0b4f748fdbd46e8f1
+  metadata.gz: 6f4b098047917136946c7bb88b111b5e6facf2a13ab70677bf0bce480bc2b4f0931f89f0be8ad2dc6db152abaaeffbdece5993d7ac5fba2ca85fde601df0c4c2
+  data.tar.gz: 7d5d125189afacf46a008a6b12c79ec68ffeb6e15c4324c1a6924a19be9061dac5760224225a564a8a1d9410b18a3da80591beeb30e5abc15995a5094326fab4

data/LICENSE.md

@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright (c) 2020 Cyril Kato
+Copyright (c) 2020-2022 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,53 +1,57 @@
 # Brutal 💎🔨
 
-[![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/fixrb/brutal.svg?branch=master)][inchpages]
-[![Documentation](http://img.shields.io/:yard-docs-38c800.svg)][rubydoc]
+[![Version](https://img.shields.io/github/v/tag/fixrb/brutal?label=Version&logo=github)](https://github.com/fixrb/brutal/releases)
+[![Yard documentation](https://img.shields.io/badge/Yard-documentation-blue.svg?logo=github)](https://rubydoc.info/github/fixrb/brutal/main)
+[![CI](https://github.com/fixrb/brutal/workflows/CI/badge.svg?branch=main)](https://github.com/fixrb/brutal/actions?query=workflow%3Aci+branch%3Amain)
+[![RuboCop](https://github.com/fixrb/brutal/workflows/RuboCop/badge.svg?branch=main)](https://github.com/fixrb/brutal/actions?query=workflow%3Arubocop+branch%3Amain)
+[![License](https://img.shields.io/github/license/fixrb/brutal?label=License&logo=github)](https://github.com/fixrb/brutal/raw/main/LICENSE.md)
 
 > 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 Hate Tests](https://github.com/fixrb/brutal/raw/main/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/>
+> I don't like tests. It's not DRY.
 > -- [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.
+Let __Brutal__ craft for you in no time a (potentially huge) framework-less vanilla Ruby file describing the actual behavior of your code across as many context combinations as necessary.
 
-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.
+By delegating to __Brutal__ the repetitive (and redundant) task of writing tests, you will be able to focus on your core business: the code itself.
+
+![Brutal-Driven Development](https://github.com/fixrb/brutal/raw/main/img/brutal-driven-development.jpg)
 
 ## Warning
 
-__Brutal__ development process does not prevent from bugs.
+The _Brutal-Driven Development_ process does not prevent bugs from appearing in the code.
+
+A generated test suite acts as a _picture of the code's behavior_. Therefore, if the code is wrong, the picture of the code's behavior will also be wrong.
 
-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.
+The mere fact that all expectations are true does not mean that the code behaves as it should.
 
-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_.
+It is therefore the responsibility of the developer to analyze the generated behavioral pictures to ensure that the code reacts as it is supposed to according to the contexts in which it is evaluated.
 
 ## Installation
 
 Add this line to your application's Gemfile:
 
 ```ruby
-gem 'brutal'
+gem "brutal"
 ```
 
 And then execute:
 
-    $ bundle install
+```sh
+bundle install
+```
 
 Or install it yourself as:
 
-    $ gem install brutal
+```sh
+gem install brutal
+```
 
 ## Quick Start
 
@@ -111,7 +115,7 @@ raise if actual.length != 9
 
 ### More examples
 
-https://github.com/fixrb/brutal/raw/master/examples/
+https://github.com/fixrb/brutal/raw/main/examples/
 
 ## Rake integration example
 
@@ -119,10 +123,14 @@ A generated `test.rb` file could be matched as follows:
 
 ```ruby
 Rake::TestTask.new do |t|
-  t.pattern = 'test.rb'
+  t.pattern = "test.rb"
 end
 ```
 
+## Test suite
+
+__Brutal__'s test set is brutally self-generated here: [./test.rb](https://github.com/fixrb/brutal/blob/main/test.rb)
+
 ## Contact
 
 * Source code: https://github.com/fixrb/brutal
@@ -133,19 +141,13 @@ __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).
+The [gem](https://rubygems.org/gems/brutal) is available as open source under the terms of the [MIT License](https://github.com/fixrb/brutal/raw/main/LICENSE.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"
+    src="https://github.com/fixrb/brutal/raw/main/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/fixrb/brutal
-[inchpages]: https://inch-ci.org/github/fixrb/brutal
-[rubydoc]: https://rubydoc.info/gems/brutal/frames

data/bin/brutal

@@ -1,6 +1,6 @@
 #!/usr/bin/env ruby
 # frozen_string_literal: true
 
-require_relative File.join('..', 'lib', 'brutal')
+require_relative File.join("..", "lib", "brutal")
 
 Brutal.generate!

data/lib/brutal/configuration.rb

@@ -5,17 +5,48 @@ module Brutal
   #
   # @since 1.0.0
   class Configuration
-    HEAD = '# Brutal test suite'
+    ACTUALS_KEY   = "actuals"
+    CONTEXTS_KEY  = "contexts"
+    HEADER_KEY    = "header"
+    SUBJECT_KEY   = "subject"
 
-    attr_reader(:actuals, :contexts, :header, :subject)
+    DEFAULT_ACTUALS   = [].freeze
+    DEFAULT_CONTEXTS  = {}.freeze
+    DEFAULT_HEADER    = "# Brutal test suite"
+    DEFAULT_SUBJECT   = ""
 
-    def initialize(actuals: [], contexts: {}, header: HEAD, subject: '')
+    # Load the configuration parameters.
+    #
+    # @param params [Hash] Receive the 4 top-level section parameters.
+    def self.load(params)
+      new(
+        actuals:  params.fetch(ACTUALS_KEY, DEFAULT_ACTUALS),
+        contexts: params.fetch(CONTEXTS_KEY, DEFAULT_CONTEXTS),
+        header:   params.fetch(HEADER_KEY, DEFAULT_HEADER),
+        subject:  params.fetch(SUBJECT_KEY, DEFAULT_SUBJECT)
+      )
+    end
+
+    # Specifies templates to challenge evaluated subjects & get results.
+    attr_reader :actuals
+
+    # Specifies a list of variables to populate the subject's template.
+    attr_reader :contexts
+
+    # Specifies the code to execute before generating the test suite.
+    attr_reader :header
+
+    # Specifies the template of the code to be declined across contexts.
+    attr_reader :subject
+
+    # Initialize a new configuration.
+    def initialize(actuals:, contexts:, header:, subject:)
       raise ::TypeError, actuals.inspect  unless actuals.is_a?(::Array)
       raise ::TypeError, contexts.inspect unless contexts.is_a?(::Hash)
       raise ::TypeError, header.inspect   unless header.is_a?(::String)
       raise ::TypeError, subject.inspect  unless subject.is_a?(::String)
 
-      @actuals  = actuals
+      @actuals  = actuals.sort
       @contexts = contexts
       @header   = header
       @subject  = subject

data/lib/brutal/file/read.rb

@@ -9,7 +9,7 @@ module Brutal
     #
     # @since 1.1.0
     class Read
-      NAME = '.brutal.yml'
+      NAME = ".brutal.yml"
 
       attr_reader :name
 

data/lib/brutal/file/write.rb

@@ -9,7 +9,7 @@ module Brutal
     #
     # @since 1.1.0
     class Write
-      NAME = 'test.rb'
+      NAME = "test.rb"
 
       attr_reader :name
 
@@ -18,7 +18,7 @@ module Brutal
       end
 
       def call(scaffold)
-        file = ::File.open(path, 'w')
+        file = ::File.open(path, "w")
         file.write(scaffold)
 
         true

data/lib/brutal/scaffold.rb

@@ -5,13 +5,23 @@ module Brutal
   #
   # @since 1.0.0
   class Scaffold
-    attr_reader(:header, :subject, :actuals, :contexts)
+    # Specifies templates to challenge evaluated subjects & get results.
+    attr_reader :actuals
 
-    # Initialize a new scaffold generator
+    # Specifies a list of variables to populate the subject's template.
+    attr_reader :contexts
+
+    # Specifies the code to execute before generating the test suite.
+    attr_reader :header
+
+    # Specifies the template of the code to be declined across contexts.
+    attr_reader :subject
+
+    # 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?
+      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
 
@@ -28,13 +38,11 @@ module Brutal
       object.strip
     end
 
-    # Return a string representation
+    # 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|
+      "#{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
@@ -43,7 +51,7 @@ module Brutal
 
         string = <<~CODE
           actual = begin
-          #{actual_str.gsub(/^/, '  ')}
+          #{actual_str.gsub(/^/, "  ")}
           end
 
         CODE
@@ -51,19 +59,18 @@ module Brutal
         actual = eval(actual_str) # rubocop:disable Security/Eval, Lint/UselessAssignment
 
         actuals.each do |actual_value|
-          result_str = format(actual_value, subject: 'actual')
+          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"
+      "\n"              \
+        "# #{"-" * 78}\n" \
+        "\n"
     end
 
     def context_names
@@ -75,7 +82,7 @@ module Brutal
     end
 
     def combinations_values
-      Array(contexts_values[0]).product(*Array(contexts_values[1..-1]))
+      Array(contexts_values[0]).product(*Array(contexts_values[1..]))
     end
   end
 end

data/lib/brutal/yaml.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require 'yaml'
+require "yaml"
 
 module Brutal
   # Brutal::Yaml
@@ -8,7 +8,7 @@ module Brutal
   # @since 1.1.0
   module Yaml
     def self.parse(yaml)
-      ::YAML.safe_load(yaml, symbolize_names: true)
+      ::YAML.safe_load(yaml, symbolize_names: false)
     end
   end
 end

data/lib/brutal.rb

@@ -6,14 +6,15 @@
   file/write
   scaffold
   yaml
-].each { |file_name| require_relative(File.join('brutal', file_name)) }
+].each { |file_name| require_relative(File.join("brutal", file_name)) }
 
-# The Brutal namespace
+# The Brutal namespace.
 module Brutal
   def self.generate!
     yaml = File::Read.new.call
     hash = Yaml.parse(yaml)
-    conf = Configuration.new(**hash)
+    conf = Configuration.load(hash)
+
     ruby = Scaffold.new(conf.header,
                         conf.subject,
                         *conf.actuals,

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: brutal
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 1.2.1
 platform: ruby
 authors:
 - Cyril Kato
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-03-14 00:00:00.000000000 Z
+date: 2022-04-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -38,6 +38,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubocop-md
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rubocop-performance
   requirement: !ruby/object:Gem::Requirement
@@ -52,6 +66,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubocop-rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rubocop-thread_safety
   requirement: !ruby/object:Gem::Requirement
@@ -113,7 +141,8 @@ files:
 homepage: https://github.com/fixrb/brutal
 licenses:
 - MIT
-metadata: {}
+metadata:
+  rubygems_mfa_required: 'true'
 post_install_message: 
 rdoc_options: []
 require_paths:
@@ -122,14 +151,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.6.0
+      version: 2.7.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.1
+rubygems_version: 3.1.6
 signing_key: 
 specification_version: 4
 summary: A code-first approach to automate the writing of unit tests.