brutal 0.4.0 → 0.4.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4b21dc72c3687aa3893272f404e01d0329a528a61caa2b6f5ec251b5de66a3a4
-  data.tar.gz: 9aeb0ad4c455bb747700dc3af6bdf8957376e100af6e7b11bc6b377218e12426
+  metadata.gz: 491dc26f34135ff61ceb54bc64b4dc5793e8b2610d545b3025b8c7aaf53b3064
+  data.tar.gz: e7c379c45ce23f0886041ec8a4b6ab4c493a91e450230b64968e45a92214a62e
 SHA512:
-  metadata.gz: 7a818e0951d2993387caf80e699a989ffecca901f43ebf00b430b1de2ce330eb8da486c75800fd936a32b6f9b3286703d5ce4e85995b1a652f945ee9261162d3
-  data.tar.gz: afeedf7b04fc5be914e400a2b1a2149b0f82fb45f069654f2cc0bcf72e64cc84fc1c906b52c780d5199c2897059e1fc8e6125c6667e32c8a26fd656ae645a0c8
+  metadata.gz: 8791614f90a92630a28aa3fb8b6d2a9d1921404b1cc614302bfeb8a87970186c33b935d81db81b7c1d8751475a59d5f32c17ea80627d32755daece880b93ace4
+  data.tar.gz: 19cf4fcbe94766983442f0f47b2651b5b675d5ade1c9b306e4213421d21253035545a23f8e6c988a8967db182b4de59a4158a545278684b4104039729963574c

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,5 +1,6 @@
 # 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]
@@ -7,7 +8,7 @@
 
 > A _code-first_ approach to automate the writing of unit tests.
 
-## Intro
+## Why
 
 [![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.")
 
@@ -16,62 +17,20 @@
 
 ## Purpose
 
-Take a break and let __Brutal__ shape for you the actual behavior of your code against as many combinations of challenges as needed.
+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.
+By delegating to __Brutal__ this repetitive (and redundant) job 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.
+As a picture of the behavior of the code, 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.
+This is why it is important to carefully read a generated test suite, to ensure that it describes the behavior of the code as it is expected 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!"
-```
+This is the cost to enter the _Brutal-Driven Development_ with confidence.
 
 ## Installation
 
@@ -104,11 +63,38 @@ This YAML file can contains the following keys:
 * `variables` (required): A hash to generate the subject of each context.
 * `actual_values` (required): A list of tests to challenge the subject.
 
+### Behavioral integrity
+
+In versioned projects,
+the integrity of the behavior of the code could easily be compared by executing `brutal` after changes.
+
+Assuming a project is versioned with git,
+if something goes wrong, the `git diff test.rb` command should instantly show changes between the behavior of the previous code and the behavior of the new one.
+
+Example of regression from [The Greeter class](https://github.com/fixrb/brutal/raw/master/examples/the_greeter_class/):
+
+```diff
+  require './greeter'
+
+  # ------------------------------------------------------------------------------
+
+  front_object = Greeter
+
+  # ------------------------------------------------------------------------------
+
+  actual = front_object.new('world')
+
+- raise unless actual.salute == "Hello World!"
++ raise unless actual.salute == "Hello !"
+```
+
 ### Optional parameters
 
 It would also be possible to ask for an RSpec template by passing "`rspec`" argument:
 
-> brutal rspec
+```sh
+brutal rspec
+```
 
 ## Example
 
@@ -140,12 +126,14 @@ front_object = "Hello "
 # ------------------------------------------------------------------------------
 
 actual = front_object + 'Alice'
+
 raise unless actual.to_s == "Hello Alice"
 raise unless actual.length == 11
 
 # ------------------------------------------------------------------------------
 
 actual = front_object + 'Bob'
+
 raise unless actual.to_s == "Hello Bob"
 raise unless actual.length == 9
 ```
@@ -176,7 +164,7 @@ More examples are available [here](https://github.com/fixrb/brutal/raw/master/ex
 
 ## 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|
@@ -186,14 +174,7 @@ 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
 
@@ -212,6 +193,7 @@ The gem is available as open source under the terms of the [MIT License](https:/
     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

data/lib/brutal/scaffold_generator/por.rb

@@ -30,7 +30,13 @@ module Brutal
 
           actual_str = format(inspect(subject), **attributes)
 
-          string = "actual = #{actual_str}\n\n"
+          string = <<~CODE
+            actual = begin
+            #{actual_str.gsub(/^/, '  ')}
+            end
+
+          CODE
+
           actual = eval(actual_str) # rubocop:disable Security/Eval, Lint/UselessAssignment
 
           actual_values.each do |actual_value|

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: brutal
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.4.1
 platform: ruby
 authors:
 - Cyril Kato
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-12-28 00:00:00.000000000 Z
+date: 2020-01-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -42,30 +42,30 @@ dependencies:
   name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '0.79'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '0.79'
 - !ruby/object:Gem::Dependency
   name: rubocop-performance
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.5'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.5'
 - !ruby/object:Gem::Dependency
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
@@ -80,6 +80,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.17'
+- !ruby/object:Gem::Dependency
+  name: spectus
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.1'
 - !ruby/object:Gem::Dependency
   name: yard
   requirement: !ruby/object:Gem::Requirement