brutal 0.3.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8e7af479b185bf19e8cb7050360c79d216af2916668e76efb0d7c550e553af4b
-  data.tar.gz: e917683e2edd247429cb9776444e6a97c10b9930265459a10ac8a3b4dbcf2cf6
+  metadata.gz: 4b21dc72c3687aa3893272f404e01d0329a528a61caa2b6f5ec251b5de66a3a4
+  data.tar.gz: 9aeb0ad4c455bb747700dc3af6bdf8957376e100af6e7b11bc6b377218e12426
 SHA512:
-  metadata.gz: ad95d20234be22ed17de738afa0f1f1e0a5518cbf967fe87f9f1932f571e13d683a454354dd792f07d55010033dfd257b888422a880a4bd6c0f04ed19cf284ed
-  data.tar.gz: c4e82e9a5036e134e83f86c313277573926fe0773ef3e2e43145d30fb725ba6a7a196f881f090f083589ac447889b7aa10d1d7e450ec550f468792991bffb824
+  metadata.gz: 7a818e0951d2993387caf80e699a989ffecca901f43ebf00b430b1de2ce330eb8da486c75800fd936a32b6f9b3286703d5ce4e85995b1a652f945ee9261162d3
+  data.tar.gz: afeedf7b04fc5be914e400a2b1a2149b0f82fb45f069654f2cc0bcf72e64cc84fc1c906b52c780d5199c2897059e1fc8e6125c6667e32c8a26fd656ae645a0c8

data/README.md

@@ -1,22 +1,77 @@
-# Brutal 👹
-
-> I don't like testing because it's redundant. If we are smart enough, we can avoid it. <br/>
-> -- Matz
+# Brutal 💎🔨
 
 [![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)
+
+## Purpose
+
+Take a break and let __Brutal__ shape for you the actual behavior of your code against as many combinations of challenges 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__ the repetitive and redundant task of writing tests, you'll be able to focus on your core business: writing code.
+
+## Warning
+
+__Brutal__ does not prevent from bugs.
+As a picture of the behavior of the code, its generated tests would be wrong if the code is wrong.
+
+This is why it is important to carefully read the generated test suite, to ensure that it describes the behavior of the code as it is supposed to behave.
+
+However, when the `brutal` command is executed successfully,
+we can consider that both __Brutal__'s configuration file (`.brutal.yml`) and evaluated code as syntactically correct.
+
+In the context of a versioned project, to avoid regressions,
+the integrity of the behavior of the code can easily be checked by re-generating a picture to be compared with the previous one.
+Here is an example with [The Greeter class](https://github.com/fixrb/brutal/raw/master/examples/the_greeter_class/) code:
+
+```sh
+git diff
+```
+
+The code:
+
+```diff
+  # The Greeter class
+  class Greeter
+    def initialize(name)
+-     @name = name
++     @name = name.capitalize
+    end
+
+    def salute
+      "Hello #{@name}!"
+    end
+  end
+```
+
+The generated test of the code:
+
+```diff
+  require './greeter'
+
+  # ------------------------------------------------------------------------------
+
+  front_object = Greeter
+
+  # ------------------------------------------------------------------------------
+
+  actual = front_object.new('world')
+
+- raise unless actual.salute == "Hello world!"
++ raise unless actual.salute == "Hello World!"
+```
 
 ## Installation
 
@@ -40,7 +95,8 @@ Just type `brutal` in a Ruby project's folder and watch the magic happen.
 
 ## Usage
 
-The Brutal YAML file handles 4 keys:
+__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.
@@ -48,9 +104,15 @@ The Brutal YAML file handles 4 keys:
 * `variables` (required): A hash to generate the subject of each context.
 * `actual_values` (required): A list of tests to challenge the subject.
 
+### Optional parameters
+
+It would also be possible to ask for an RSpec template by passing "`rspec`" argument:
+
+> brutal rspec
+
 ## Example
 
-Given this `.brutal.yml` config file:
+Given this config file:
 
 ```yaml
 ---
@@ -70,7 +132,7 @@ actual_values:
   - "%{subject}.length"
 ```
 
-The `brutal` command would save this Plain Old Ruby in to a `test.rb` file:
+The `brutal` command would generate and write in to a `test.rb` file the following "Plain Old Ruby":
 
 ```ruby
 front_object = "Hello "
@@ -88,7 +150,29 @@ raise unless actual.to_s == "Hello Bob"
 raise unless actual.length == 9
 ```
 
-[More examples](examples/) are available.
+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 are available [here](https://github.com/fixrb/brutal/raw/master/examples/).
 
 ## Rake integration example
 
@@ -115,23 +199,10 @@ end
 
 __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
-
 ***
 
 <p>
@@ -140,3 +211,8 @@ 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>
+
+[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

@@ -24,20 +24,22 @@ 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
+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")
+].reject(&:empty?).join("\n\n")
 
-file = ::File.open('test.rb', 'w')
+file = ::File.open(file_name, 'w')
 file.write(doc)
 file.close

data/lib/brutal/scaffold_generator/por.rb

@@ -20,7 +20,7 @@ module Brutal
 
         test_params = Array(values_arr[0]).product(*Array(values_arr[1..-1]))
 
-        blank_line +
+        blank_line.gsub(/\A\n/, '') +
         "front_object = #{front_object_str}\n" +
         blank_line +
         test_params.map do |values|
@@ -30,7 +30,7 @@ module Brutal
 
           actual_str = format(inspect(subject), **attributes)
 
-          string = "actual = #{actual_str}\n"
+          string = "actual = #{actual_str}\n\n"
           actual = eval(actual_str) # rubocop:disable Security/Eval, Lint/UselessAssignment
 
           actual_values.each do |actual_value|

data/lib/brutal/scaffold_generator/rspec.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: brutal
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.4.0
 platform: ruby
 authors:
 - Cyril Kato
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-12-24 00:00:00.000000000 Z
+date: 2019-12-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.0'
+        version: '2.1'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.0'
+        version: '2.1'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -94,7 +94,7 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.9'
-description: Scaffolds test cases from the code itself.
+description: A code-first approach to automate the writing of unit tests.
 email: contact@cyril.email
 executables:
 - brutal
@@ -107,6 +107,7 @@ files:
 - lib/brutal.rb
 - lib/brutal/scaffold_generator/base.rb
 - lib/brutal/scaffold_generator/por.rb
+- lib/brutal/scaffold_generator/rspec.rb
 homepage: https://github.com/fixrb/brutal
 licenses:
 - MIT
@@ -129,5 +130,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: []