brutal 1.2.1 → 1.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 958cf59b6aea2f5e323b849c83a86399cd9ad99e2433b899160a2422275a319e
-  data.tar.gz: bdb36f749b6bfcb87683f12d3db9e74c716bdbfbf41e21c845864bf1e17f7a7e
+  metadata.gz: ea124053ebeef681c2e046022936f9d67ca97778733a23bd2d81781e90daa9a8
+  data.tar.gz: 677089454fece7f60aedfc4693b53c132f057bbeeaca5e651f88ec52d026ea34
 SHA512:
-  metadata.gz: 6f4b098047917136946c7bb88b111b5e6facf2a13ab70677bf0bce480bc2b4f0931f89f0be8ad2dc6db152abaaeffbdece5993d7ac5fba2ca85fde601df0c4c2
-  data.tar.gz: 7d5d125189afacf46a008a6b12c79ec68ffeb6e15c4324c1a6924a19be9061dac5760224225a564a8a1d9410b18a3da80591beeb30e5abc15995a5094326fab4
+  metadata.gz: b1d043d4740db1987c188755e9b339da566034a3cc2a43f99ced12fb3de26a93df0f93d669b20700ba662a935d9be662a25bffba8f8ae92aae3e01deade92d9b
+  data.tar.gz: 5abc20c46849f69b20de5b89848f8fed831b2d92641f57cfa349be4e0a975c8630c27268d16a022911693d403af8262b4f0d1099dcf468879392e9c2d7fe7ec0

data/LICENSE.md

@@ -1,4 +1,4 @@
-The MIT License (MIT)
+# The MIT License
 
 Copyright (c) 2020-2022 Cyril Kato
 

data/README.md

@@ -1,8 +1,8 @@
 # Brutal 💎🔨
 
-[![Version](https://img.shields.io/github/v/tag/fixrb/brutal?label=Version&logo=github)](https://github.com/fixrb/brutal/releases)
+[![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)
-[![CI](https://github.com/fixrb/brutal/workflows/CI/badge.svg?branch=main)](https://github.com/fixrb/brutal/actions?query=workflow%3Aci+branch%3Amain)
+[![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)
 
@@ -59,63 +59,60 @@ 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 to know how to write your tests.
+Currently, only the YAML format is supported.
+This file is by default named `.brutal.yml` and 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.
 
-### Getting started
+When the configuration file is present, the generation of a test suite can be done with the command:
 
-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:
+```sh
+brutal .brutal.yml
+```
 
-```yaml
----
-subject: |
-  "Hello " + "%{string}"
+or:
+
+```sh
+brutal .
+```
 
-contexts:
-  string:
-    - Alice
-    - Bob
+or even:
 
-actuals:
-  - "%{subject}.to_s"
-  - "%{subject}.length"
+```sh
+brutal
 ```
 
-2. Run the `brutal` command from the same directory.
+This would create a `test.rb` file containing the test suite.
 
-3. Read the generated `test.rb` file in the same directory:
+Configuration files can also be named differently:
 
-```ruby
-# Brutal test suite
+```sh
+brutal path/to/test_hello_world.yml
+```
 
-# ------------------------------------------------------------------------------
+This would create a `path/to/test_hello_world.rb` file containing the test suite.
 
-actual = begin
-  "Hello " + "Alice"
-end
+To avoid accidentally overwriting a file, the `--no-force` option can be used:
 
-raise if actual.to_s != "Hello Alice"
-raise if actual.length != 11
+```sh
+brutal path/to/test_hello_world.yml --no-force
+```
 
-# ------------------------------------------------------------------------------
+> A path/to/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
 
@@ -145,9 +142,7 @@ The [gem](https://rubygems.org/gems/brutal) is available as open source under th
 
 ***
 
-<p>
-  This project is sponsored by:<br />
-  <a href="https://sashite.com/"><img
-    src="https://github.com/fixrb/brutal/raw/main/img/sashite.png"
-    alt="Sashite" /></a>
-</p>
+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,12 @@
 #!/usr/bin/env ruby
 # frozen_string_literal: true
 
+require "pathname"
 require_relative File.join("..", "lib", "brutal")
 
-Brutal.generate!
+path = ARGV.fetch(0, Brutal::File::DEFAULT_CONFIG_FILENAME)
+pathname = Pathname.new(path)
+pathname += Brutal::File::DEFAULT_CONFIG_FILENAME if pathname.directory?
+force_opt = ARGV.none?("--no-force")
+
+Brutal.generate!(pathname, force: force_opt)

data/lib/brutal/file/read.rb

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

data/lib/brutal/file/write.rb

@@ -1,19 +1,14 @@
 # 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
 

data/lib/brutal/file.rb

@@ -0,0 +1,31 @@
+# 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"
+    RUBY_EXTENSION = ".rb"
+
+    def self.generated_pathname(pathname)
+      filename = pathname.basename
+      return pathname.dirname + DEFAULT_GENERATED_FILENAME if default_config_filename?(filename)
+
+      pathname.sub_ext(RUBY_EXTENSION)
+    end
+
+    def self.override_protection(pathname)
+      abort "A #{pathname} file already exists!" if pathname.exist?
+    end
+
+    def self.default_config_filename?(filename)
+      filename.to_s == DEFAULT_CONFIG_FILENAME
+    end
+    private_class_method :default_config_filename?
+  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

@@ -7,8 +7,18 @@ module Brutal
   #
   # @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?(pathname)
+      filename_extension = pathname.extname
+      FILENAME_EXTENSIONS.include?(filename_extension)
+    end
   end
 end

data/lib/brutal.rb

@@ -2,17 +2,15 @@
 
 %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!(pathname, force: true)
+    hash = parse(pathname)
     conf = Configuration.load(hash)
 
     ruby = Scaffold.new(conf.header,
@@ -20,6 +18,26 @@ module Brutal
                         *conf.actuals,
                         **conf.contexts)
 
-    File::Write.new.call(ruby)
+    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
+
+  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.2.1
+  version: 1.5.0
 platform: ruby
 authors:
 - Cyril Kato
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-04-03 00:00:00.000000000 Z
+date: 2022-08-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -38,6 +38,20 @@ 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
@@ -134,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