brutal 0.3.0 → 1.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8e7af479b185bf19e8cb7050360c79d216af2916668e76efb0d7c550e553af4b
-  data.tar.gz: e917683e2edd247429cb9776444e6a97c10b9930265459a10ac8a3b4dbcf2cf6
+  metadata.gz: 98d43784db59dbf4d8263ec4730d302832e7e5edc46ebafc1a13d95935e9b697
+  data.tar.gz: e2d37b31d5b37387437e6ac80afb11b5b1a6d104cb677629ec3aafa9aae153af
 SHA512:
-  metadata.gz: ad95d20234be22ed17de738afa0f1f1e0a5518cbf967fe87f9f1932f571e13d683a454354dd792f07d55010033dfd257b888422a880a4bd6c0f04ed19cf284ed
-  data.tar.gz: c4e82e9a5036e134e83f86c313277573926fe0773ef3e2e43145d30fb725ba6a7a196f881f090f083589ac447889b7aa10d1d7e450ec550f468792991bffb824
+  metadata.gz: d3af04c68e89e7bdd965163066db2b99a4e3df78846ea6f33a0a89b9fe443e477376a6108a31c8b69d86d45f04459991d503f56c345b5089b7233a22b0d831bd
+  data.tar.gz: 55e326bf5cdcba338c63d7e57a8f75378f9869fe0f986867a86ece479850dd78745a2a568c3e0b89c8080f343e977b17d42b714e80dbbe3543b980204fd67c4d

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,22 +1,37 @@
-# Brutal 👹
-
-> I don't like testing because it's redundant. If we are smart enough, we can avoid it. <br/>
-> -- Matz
+# 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]
 
-__Brutal__ is a _code-first_ approach that automates the writing of unit tests.
+> A _code-first_ approach to automate the writing of unit tests.
 
-By being able to generate test cases from the code itself, developers can focus on their creation, save time and energy, for more happiness.
+## Intro
 
-<p>
-  <img
-    src="https://github.com/fixrb/brutal/raw/master/img/Ferdinand_Hodler_-_Woodcutter_-_Google_Art_Project.jpg"
-    alt="A lumberjack brutally cutting a tree" />
-</p>
+[![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
 
@@ -40,59 +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.
-* `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.
+* `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
 ---
-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 save this Plain Old Ruby in to a `test.rb` file:
+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'
-raise unless actual.to_s == "Hello Alice"
-raise unless actual.length == 11
+actual = begin
+  "Hello " + "Alice"
+end
+
+raise if actual.to_s != "Hello Alice"
+raise if actual.length != 11
 
 # ------------------------------------------------------------------------------
 
-actual = front_object + 'Bob'
-raise unless actual.to_s == "Hello Bob"
-raise unless actual.length == 9
+actual = begin
+  "Hello " + "Bob"
+end
+
+raise if actual.to_s != "Hello Bob"
+raise if actual.length != 9
 ```
 
-[More examples](examples/) are available.
+### More examples
+
+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|
@@ -102,35 +125,15 @@ end
 
 ## Contact
 
-* Home page: https://github.com/fixrb/brutal
-* Bugs/issues: https://github.com/fixrb/brutal/issues
-
-## Rubies
-
-* [MRI](https://www.ruby-lang.org/)
-* [Rubinius](https://rubinius.com/)
-* [JRuby](https://www.jruby.org/)
+* Source code: https://github.com/fixrb/brutal
 
 ## Versioning
 
 __Brutal__ follows [Semantic Versioning 2.0](https://semver.org/).
 
-## Contributing
-
-Bug reports and pull requests are welcome on GitHub at https://github.com/fixrb/brutal. 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/fixrb/brutal/blob/master/CODE_OF_CONDUCT.md).
-
 ## 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/fixrb/brutal/blob/master/CODE_OF_CONDUCT.md).
-
-[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
+The [gem](https://rubygems.org/gems/brutal) is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
 
 ***
 
@@ -140,3 +143,9 @@ Everyone interacting in the GreatGuardian project's codebases, issue trackers, c
     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

data/bin/brutal

@@ -1,43 +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 = case ARGV.fetch(0, nil)
-           when nil
-             ::Brutal::ScaffoldGenerator::Por
-           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")
-
-file = ::File.open('test.rb', 'w')
-file.write(doc)
-file.close
+Brutal.generate!

data/lib/brutal.rb

@@ -1,11 +1,24 @@
 # frozen_string_literal: true
 
-# Main namespace
-#
-# @api public
+%w[
+  configuration
+  file/read
+  file/write
+  scaffold
+  yaml
+].each { |file_name| require_relative(File.join('brutal', file_name)) }
+
+# The Brutal namespace.
 module Brutal
-end
+  def self.generate!
+    yaml = File::Read.new.call
+    hash = Yaml.parse(yaml)
+    conf = Configuration.load(hash)
+    ruby = Scaffold.new(conf.header,
+                        conf.subject,
+                        *conf.actuals,
+                        **conf.contexts)
 
-Dir[File.join File.dirname(__FILE__), 'brutal', 'scaffold_generator', '*.rb'].each do |fname|
-  require_relative fname
+    File::Write.new.call(ruby)
+  end
 end

data/lib/brutal/configuration.rb

@@ -0,0 +1,50 @@
+# frozen_string_literal: true
+
+module Brutal
+  # Brutal::Configuration
+  #
+  # @since 1.0.0
+  class Configuration
+    DEFAULT_ACTUALS   = [].freeze
+    DEFAULT_CONTEXTS  = {}.freeze
+    DEFAULT_HEAD      = '# 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)
+      )
+    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
+      @contexts = contexts
+      @header   = header
+      @subject  = subject
+    end
+  end
+end

data/lib/brutal/file/read.rb

@@ -0,0 +1,33 @@
+# 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)
+        @name = name
+      end
+
+      def call
+        ::File.read(path)
+      rescue ::Errno::ENOENT => _e
+        abort("File #{path} not found!")
+      end
+
+      protected
+
+      def path
+        ::File.join(::Dir.pwd, name)
+      end
+    end
+  end
+end

data/lib/brutal/file/write.rb

@@ -0,0 +1,36 @@
+# 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)
+        @name = name
+      end
+
+      def call(scaffold)
+        file = ::File.open(path, 'w')
+        file.write(scaffold)
+
+        true
+      ensure
+        file.close
+      end
+
+      protected
+
+      def path
+        ::File.join(::Dir.pwd, name)
+      end
+    end
+  end
+end

data/lib/brutal/scaffold.rb

@@ -0,0 +1,91 @@
+# frozen_string_literal: true
+
+module Brutal
+  # Brutal::Scaffold
+  #
+  # @since 1.0.0
+  class Scaffold
+    # 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 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..]))
+    end
+  end
+end

data/lib/brutal/yaml.rb

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

metadata

@@ -1,45 +1,45 @@
 --- !ruby/object:Gem::Specification
 name: brutal
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 1.1.1
 platform: ruby
 authors:
 - Cyril Kato
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-12-24 00:00:00.000000000 Z
+date: 2020-09-08 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,31 +70,31 @@ 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: Scaffolds test cases from the code itself.
+        version: '0'
+description: A code-first approach to automate the writing of unit tests.
 email: contact@cyril.email
 executables:
 - brutal
@@ -105,8 +105,11 @@ files:
 - README.md
 - bin/brutal
 - lib/brutal.rb
-- lib/brutal/scaffold_generator/base.rb
-- lib/brutal/scaffold_generator/por.rb
+- lib/brutal/configuration.rb
+- lib/brutal/file/read.rb
+- lib/brutal/file/write.rb
+- lib/brutal/scaffold.rb
+- lib/brutal/yaml.rb
 homepage: https://github.com/fixrb/brutal
 licenses:
 - MIT
@@ -119,7 +122,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 2.7.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
@@ -129,5 +132,5 @@ requirements: []
 rubygems_version: 3.1.2
 signing_key: 
 specification_version: 4
-summary: Scaffolds test cases from the code itself.
+summary: A code-first approach to automate the writing of unit tests.
 test_files: []

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,52 +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 +
-        "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 = "actual = #{actual_str}\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 += "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