brutal 1.1.1 → 1.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 98d43784db59dbf4d8263ec4730d302832e7e5edc46ebafc1a13d95935e9b697
-  data.tar.gz: e2d37b31d5b37387437e6ac80afb11b5b1a6d104cb677629ec3aafa9aae153af
+  metadata.gz: 7f98c650c2e97438b0cedcebdb5b01da84af29f7cbc0c324a4b3416b3da68114
+  data.tar.gz: 696e8e96639a62e046f138c10f3d5181a3265c90bb10306481bc0d2b2fd9d3d0
 SHA512:
-  metadata.gz: d3af04c68e89e7bdd965163066db2b99a4e3df78846ea6f33a0a89b9fe443e477376a6108a31c8b69d86d45f04459991d503f56c345b5089b7233a22b0d831bd
-  data.tar.gz: 55e326bf5cdcba338c63d7e57a8f75378f9869fe0f986867a86ece479850dd78745a2a568c3e0b89c8080f343e977b17d42b714e80dbbe3543b980204fd67c4d
+  metadata.gz: b6279a503eba6120d29cd8855fab48c725f46671bd8efa7d6fd73158e68d0cf6de9fed01e4f5ae83cf04417b0551ab9598d6c615d25b164fbefec1d3b7ce262f
+  data.tar.gz: 8aebd74fd0a2c9bda6b418980dd627645f9b1c85f3e92e753ba2c03bd642d0dd63393dfd8923ef25e470269e3b6645fa3428a54cd7b2128ca53ee2b5c9e5de63

data/LICENSE.md

@@ -1,6 +1,6 @@
-The MIT License (MIT)
+# The MIT License
 
-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/tags)
+[![Yard documentation](https://img.shields.io/badge/Yard-documentation-blue.svg?logo=github)](https://rubydoc.info/github/fixrb/brutal/main)
+[![Ruby](https://github.com/fixrb/brutal/workflows/Ruby/badge.svg?branch=main)](https://github.com/fixrb/brutal/actions?query=workflow%3Aruby+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
 
@@ -55,18 +59,22 @@ Just type `brutal` in a Ruby project's folder and watch the magic happen.
 
 ## Usage
 
-The `brutal.yml` file is a manifest you can use to define your __Brutal__ meta-spec.
-It has 4 top-level sections:
+__Brutal__ needs a configuration file, it's a kind of manifest, or a meta-spec if you prefer.
+This file is composed of 4 top-level sections:
 
 * `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.
 
+By default, this file is called `.brutal.yml`, but it would be possible to call it differently by passing it as an argument to the brutal command.
+
+Currently, only the YAML format is supported.
+
 ### Getting started
 
-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:
+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
 ---
@@ -111,7 +119,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 +127,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 +145,11 @@ __Brutal__ follows [Semantic Versioning 2.0](https://semver.org/).
 
 ## License
 
-The [gem](https://rubygems.org/gems/brutal) 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"
-    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
+This project is sponsored by [Sashité](https://github.com/sashite/):
+
+![Sashité logo](https://github.com/fixrb/brutal/raw/main/img/sponsor/dark/en/sashite.png#gh-dark-mode-only "Sashité")
+![Sashité logo](https://github.com/fixrb/brutal/raw/main/img/sponsor/light/en/sashite.png#gh-light-mode-only "Sashité")

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!
+Brutal.generate! ARGV.fetch(0, Brutal::File::DEFAULT_CONFIG_FILENAME)

data/lib/brutal/configuration.rb

@@ -5,20 +5,25 @@ module Brutal
   #
   # @since 1.0.0
   class Configuration
+    ACTUALS_KEY   = "actuals"
+    CONTEXTS_KEY  = "contexts"
+    HEADER_KEY    = "header"
+    SUBJECT_KEY   = "subject"
+
     DEFAULT_ACTUALS   = [].freeze
     DEFAULT_CONTEXTS  = {}.freeze
-    DEFAULT_HEAD      = '# Brutal test suite'
-    DEFAULT_SUBJECT   = ''
+    DEFAULT_HEADER    = "# Brutal test suite"
+    DEFAULT_SUBJECT   = ""
 
     # Load the configuration parameters.
     #
     # @param params [Hash] Receive the 4 top-level section parameters.
     def self.load(params)
       new(
-        actuals: params.fetch('actuals', DEFAULT_ACTUALS),
-        contexts: params.fetch('contexts', DEFAULT_CONTEXTS),
-        header: params.fetch('header', DEFAULT_HEAD),
-        subject: params.fetch('subject', DEFAULT_SUBJECT)
+        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
 
@@ -41,7 +46,7 @@ module Brutal
       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

@@ -1,19 +1,14 @@
 # frozen_string_literal: true
 
 module Brutal
-  # Brutal::File
-  #
-  # @since 1.1.0
   module File
     # Brutal::File::Read
     #
     # @since 1.1.0
     class Read
-      NAME = '.brutal.yml'
-
       attr_reader :name
 
-      def initialize(name = NAME)
+      def initialize(name)
         @name = name
       end
 

data/lib/brutal/file/write.rb

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

data/lib/brutal/file.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+%w[
+  read
+  write
+].each { |filename| require_relative(File.join("file", filename)) }
+
+module Brutal
+  # Brutal::File
+  module File
+    DEFAULT_CONFIG_FILENAME = ".brutal.yml"
+    DEFAULT_GENERATED_FILENAME = "test.rb"
+
+    def self.generated_filename(filename)
+      return DEFAULT_GENERATED_FILENAME if filename == DEFAULT_CONFIG_FILENAME
+
+      filename.gsub(/.[^.]+\z/, ".rb")
+    end
+  end
+end

data/lib/brutal/scaffold.rb

@@ -19,9 +19,9 @@ module Brutal
 
     # 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
 
@@ -41,8 +41,6 @@ module Brutal
     # 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)|
@@ -61,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

data/lib/brutal/yaml.rb

@@ -1,14 +1,24 @@
 # frozen_string_literal: true
 
-require 'yaml'
+require "yaml"
 
 module Brutal
   # Brutal::Yaml
   #
   # @since 1.1.0
   module Yaml
+    FILENAME_EXTENSIONS = %w[
+      yaml
+      yml
+    ].freeze
+
     def self.parse(yaml)
       ::YAML.safe_load(yaml, symbolize_names: false)
     end
+
+    def self.parse?(filename)
+      filename_extension = filename.split(".")[1..][-1]
+      FILENAME_EXTENSIONS.include?(filename_extension)
+    end
   end
 end

data/lib/brutal.rb

@@ -2,23 +2,32 @@
 
 %w[
   configuration
-  file/read
-  file/write
+  file
   scaffold
   yaml
-].each { |file_name| require_relative(File.join('brutal', file_name)) }
+].each { |filename| require_relative(File.join("brutal", filename)) }
 
 # The Brutal namespace.
 module Brutal
-  def self.generate!
-    yaml = File::Read.new.call
-    hash = Yaml.parse(yaml)
+  def self.generate!(filename)
+    file = File::Read.new(filename).call
+
+    hash = if Yaml.parse?(filename)
+             Yaml.parse(file)
+           else
+             raise ::ArgumentError, "Unrecognized extension.  " \
+                                    "Impossible to parse #{filename.inspect}."
+           end
+
     conf = Configuration.load(hash)
+
     ruby = Scaffold.new(conf.header,
                         conf.subject,
                         *conf.actuals,
                         **conf.contexts)
 
-    File::Write.new.call(ruby)
+    new_filename = File.generated_filename(filename)
+
+    File::Write.new(new_filename).call(ruby)
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: brutal
 version: !ruby/object:Gem::Version
-  version: 1.1.1
+  version: 1.3.0
 platform: ruby
 authors:
 - Cyril Kato
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-09-08 00:00:00.000000000 Z
+date: 2022-08-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -38,6 +38,34 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubocop-gitlab-security
+  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-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 +80,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
@@ -106,6 +148,7 @@ files:
 - bin/brutal
 - lib/brutal.rb
 - lib/brutal/configuration.rb
+- lib/brutal/file.rb
 - lib/brutal/file/read.rb
 - lib/brutal/file/write.rb
 - lib/brutal/scaffold.rb
@@ -113,7 +156,8 @@ files:
 homepage: https://github.com/fixrb/brutal
 licenses:
 - MIT
-metadata: {}
+metadata:
+  rubygems_mfa_required: 'true'
 post_install_message: 
 rdoc_options: []
 require_paths:
@@ -129,7 +173,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.2
+rubygems_version: 3.1.6
 signing_key: 
 specification_version: 4
 summary: A code-first approach to automate the writing of unit tests.