brutal 1.3.0 → 1.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7f98c650c2e97438b0cedcebdb5b01da84af29f7cbc0c324a4b3416b3da68114
-  data.tar.gz: 696e8e96639a62e046f138c10f3d5181a3265c90bb10306481bc0d2b2fd9d3d0
+  metadata.gz: 31ea2d6a9b38faaa03aaed25dfc8b18158a8d243b9aed42e0f4a3a488c8386a3
+  data.tar.gz: f73e4a2798de7a55deb006898919498a9d6344fcd3ec94728a379bf723370ae2
 SHA512:
-  metadata.gz: b6279a503eba6120d29cd8855fab48c725f46671bd8efa7d6fd73158e68d0cf6de9fed01e4f5ae83cf04417b0551ab9598d6c615d25b164fbefec1d3b7ce262f
-  data.tar.gz: 8aebd74fd0a2c9bda6b418980dd627645f9b1c85f3e92e753ba2c03bd642d0dd63393dfd8923ef25e470269e3b6645fa3428a54cd7b2128ca53ee2b5c9e5de63
+  metadata.gz: f5a9b52b8608bdf327bb14ad782cde378901285a3d9de0b28d273184480586f868da0b10bf32ac47980bfbc0b637b6bc058de2c42bdb600b4add7bb1865207e0
+  data.tar.gz: 302e2bf37546bc813caa05eedb38f2ad496123e6ba37b186d449ea2e5782945ef5d652d8cdc05a25c08045a472144ad6efa30f4316c23f5e3ca9ecdbdd8c8818

data/README.md

@@ -59,7 +59,8 @@ Just type `brutal` in a Ruby project's folder and watch the magic happen.
 
 ## Usage
 
-__Brutal__ needs a configuration file, it's a kind of manifest, or a meta-spec if you prefer.
+__Brutal__ needs a configuration file to know how to write your tests.
+Currently, only the YAML format is supported.
 This file is composed of 4 top-level sections:
 
 * `header` - Specifies the code to execute before generating the test suite.
@@ -67,59 +68,31 @@ This file is composed of 4 top-level sections:
 * `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:
+This file is by default called `.brutal.yml`, but it would be possible to name it differently by passing it as an argument to the brutal command such as:
 
-```yaml
----
-subject: |
-  "Hello " + "%{string}"
-
-contexts:
-  string:
-    - Alice
-    - Bob
-
-actuals:
-  - "%{subject}.to_s"
-  - "%{subject}.length"
+```sh
+brutal test_hello_world.yml
 ```
 
-2. Run the `brutal` command from the same directory.
+This would create a `test_hello_world.rb` file containing the test suite.
 
-3. Read the generated `test.rb` file in the same directory:
+To avoid accidentally overwriting a file, the `--no-force` option can be used:
 
-```ruby
-# Brutal test suite
-
-# ------------------------------------------------------------------------------
-
-actual = begin
-  "Hello " + "Alice"
-end
-
-raise if actual.to_s != "Hello Alice"
-raise if actual.length != 11
+```sh
+brutal test_hello_world.yml --no-force
+```
 
-# ------------------------------------------------------------------------------
+> A test_hello_world.rb file already exists!
 
-actual = begin
-  "Hello " + "Bob"
-end
+### Getting started
 
-raise if actual.to_s != "Hello Bob"
-raise if actual.length != 9
-```
+1. Create a `.brutal.yml` file in your application's root directory. For example: <https://github.com/fixrb/brutal/blob/v1.4.0/examples/hello_world_v1/.brutal.yml>
+2. Run the `brutal` command from the same directory.
+3. Read the generated `test.rb` file in the same directory: <https://github.com/fixrb/brutal/blob/v1.4.0/examples/hello_world_v1/test.rb>
 
 ### More examples
 
-https://github.com/fixrb/brutal/raw/main/examples/
+<https://github.com/fixrb/brutal/blob/v1.4.0/examples/>
 
 ## Rake integration example
 

data/bin/brutal

@@ -3,4 +3,4 @@
 
 require_relative File.join("..", "lib", "brutal")
 
-Brutal.generate! ARGV.fetch(0, Brutal::File::DEFAULT_CONFIG_FILENAME)
+Brutal.generate! ARGV.fetch(0, Brutal::File::DEFAULT_CONFIG_FILENAME), force: ARGV.none?("--no-force")

data/lib/brutal/file.rb

@@ -11,10 +11,27 @@ module Brutal
     DEFAULT_CONFIG_FILENAME = ".brutal.yml"
     DEFAULT_GENERATED_FILENAME = "test.rb"
 
-    def self.generated_filename(filename)
-      return DEFAULT_GENERATED_FILENAME if filename == DEFAULT_CONFIG_FILENAME
+    def self.generated_pathname(pathname)
+      filename = pathname.split(separator).fetch(-1)
 
-      filename.gsub(/.[^.]+\z/, ".rb")
+      if filename == DEFAULT_CONFIG_FILENAME
+        directory_parts = pathname.split(separator)[..-2]
+        path_parts = directory_parts + [DEFAULT_GENERATED_FILENAME]
+        return path_parts.join(separator)
+      end
+
+      pathname.gsub(/.[^.]+\z/, ".rb")
+    end
+
+    def self.override_protection(pathname)
+      return true unless ::File.exist?(pathname)
+
+      abort "A #{pathname} file already exists!"
+    end
+
+    def self.separator
+      ::File::SEPARATOR
     end
+    private_class_method :separator
   end
 end

data/lib/brutal/scaffold.rb

@@ -42,20 +42,35 @@ module Brutal
     #
     # @return [String]
     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
+      ruby_lines.join(separator_ruby_code)
+    end
+
+    def attributes(*values)
+      context_names.each_with_index.inject({}) do |h, (name, i)|
+        h.merge(name.to_sym => inspect(values.fetch(i)))
+      end
+    end
+
+    def context_names
+      contexts.keys.sort
+    end
 
-        actual_str = format(inspect(subject), **attributes)
+    def contexts_values
+      context_names.map { |context_name| contexts.fetch(context_name) }
+    end
 
-        string = <<~CODE
-          actual = begin
-          #{actual_str.gsub(/^/, '  ')}
-          end
+    def combinations_values
+      Array(contexts_values[0]).product(*Array(contexts_values[1..]))
+    end
 
-        CODE
+    def ruby_lines
+      [header_ruby_code] + actual_ruby_codes
+    end
 
+    def actual_ruby_codes
+      combinations_values.map do |values|
+        actual_str = format(inspect(subject), **attributes(*values))
+        string = actual_ruby_code(actual_str)
         actual = eval(actual_str) # rubocop:disable Security/Eval, Lint/UselessAssignment
 
         actuals.each do |actual_value|
@@ -64,25 +79,35 @@ module Brutal
         end
 
         string
-      end.join(blank_line)
+      end
     end
 
-    def blank_line
-      "\n" \
-        "# #{'-' * 78}\n" \
-        "\n"
+    def actual_ruby_code(actual_str)
+      <<~RUBY_CODE
+        actual = begin
+        #{actual_str.gsub(/^/, '  ')}
+        end
+
+      RUBY_CODE
     end
 
-    def context_names
-      contexts.keys.sort
+    def header_ruby_code
+      <<~RUBY_CODE
+        #{header.chomp}
+      RUBY_CODE
     end
 
-    def contexts_values
-      context_names.map { |context_name| contexts.fetch(context_name) }
+    def separator_ruby_code
+      <<~RUBY_CODE
+
+        #{thematic_break_ruby_code}
+      RUBY_CODE
     end
 
-    def combinations_values
-      Array(contexts_values[0]).product(*Array(contexts_values[1..]))
+    def thematic_break_ruby_code
+      <<~RUBY_CODE
+        # #{'-' * 78}
+      RUBY_CODE
     end
   end
 end

data/lib/brutal/yaml.rb

@@ -16,8 +16,8 @@ module Brutal
       ::YAML.safe_load(yaml, symbolize_names: false)
     end
 
-    def self.parse?(filename)
-      filename_extension = filename.split(".")[1..][-1]
+    def self.parse?(pathname)
+      filename_extension = pathname.split(".")[1..][-1]
       FILENAME_EXTENSIONS.include?(filename_extension)
     end
   end

data/lib/brutal.rb

@@ -9,16 +9,8 @@
 
 # The Brutal namespace.
 module Brutal
-  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
-
+  def self.generate!(pathname, force: true)
+    hash = parse(pathname)
     conf = Configuration.load(hash)
 
     ruby = Scaffold.new(conf.header,
@@ -26,8 +18,26 @@ module Brutal
                         *conf.actuals,
                         **conf.contexts)
 
-    new_filename = File.generated_filename(filename)
+    write(pathname, ruby, force: force)
+  end
+
+  def self.parse(pathname)
+    return Yaml.parse(read(pathname)) if Yaml.parse?(pathname)
+
+    raise ::ArgumentError, "Unrecognized extension.  " \
+                           "Impossible to parse #{pathname.inspect}."
+  end
+  private_class_method :parse
+
+  def self.read(pathname)
+    File::Read.new(pathname).call
+  end
+  private_class_method :read
 
-    File::Write.new(new_filename).call(ruby)
+  def self.write(pathname, ruby, force:)
+    new_pathname = File.generated_pathname(pathname)
+    File.override_protection(new_pathname) unless force
+    File::Write.new(new_pathname).call(ruby)
   end
+  private_class_method :write
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: brutal
 version: !ruby/object:Gem::Version
-  version: 1.3.0
+  version: 1.4.0
 platform: ruby
 authors:
 - Cyril Kato
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-08-21 00:00:00.000000000 Z
+date: 2022-08-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler