brutal 1.2.1 → 1.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 958cf59b6aea2f5e323b849c83a86399cd9ad99e2433b899160a2422275a319e
-  data.tar.gz: bdb36f749b6bfcb87683f12d3db9e74c716bdbfbf41e21c845864bf1e17f7a7e
+  metadata.gz: 7f98c650c2e97438b0cedcebdb5b01da84af29f7cbc0c324a4b3416b3da68114
+  data.tar.gz: 696e8e96639a62e046f138c10f3d5181a3265c90bb10306481bc0d2b2fd9d3d0
 SHA512:
-  metadata.gz: 6f4b098047917136946c7bb88b111b5e6facf2a13ab70677bf0bce480bc2b4f0931f89f0be8ad2dc6db152abaaeffbdece5993d7ac5fba2ca85fde601df0c4c2
-  data.tar.gz: 7d5d125189afacf46a008a6b12c79ec68ffeb6e15c4324c1a6924a19be9061dac5760224225a564a8a1d9410b18a3da80591beeb30e5abc15995a5094326fab4
+  metadata.gz: b6279a503eba6120d29cd8855fab48c725f46671bd8efa7d6fd73158e68d0cf6de9fed01e4f5ae83cf04417b0551ab9598d6c615d25b164fbefec1d3b7ce262f
+  data.tar.gz: 8aebd74fd0a2c9bda6b418980dd627645f9b1c85f3e92e753ba2c03bd642d0dd63393dfd8923ef25e470269e3b6645fa3428a54cd7b2128ca53ee2b5c9e5de63

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,18 +59,22 @@ 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, it's a kind of manifest, or a meta-spec if you prefer.
+This file 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.
 
+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:
+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
 ---
@@ -145,9 +149,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

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

data/lib/brutal/file/read.rb

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

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,20 @@
+# 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"
+
+    def self.generated_filename(filename)
+      return DEFAULT_GENERATED_FILENAME if filename == DEFAULT_CONFIG_FILENAME
+
+      filename.gsub(/.[^.]+\z/, ".rb")
+    end
+  end
+end

data/lib/brutal/scaffold.rb

@@ -51,7 +51,7 @@ module Brutal
 
         string = <<~CODE
           actual = begin
-          #{actual_str.gsub(/^/, "  ")}
+          #{actual_str.gsub(/^/, '  ')}
           end
 
         CODE
@@ -68,8 +68,8 @@ module Brutal
     end
 
     def blank_line
-      "\n"              \
-        "# #{"-" * 78}\n" \
+      "\n" \
+        "# #{'-' * 78}\n" \
         "\n"
     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?(filename)
+      filename_extension = filename.split(".")[1..][-1]
+      FILENAME_EXTENSIONS.include?(filename_extension)
+    end
   end
 end

data/lib/brutal.rb

@@ -2,17 +2,23 @@
 
 %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!(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
+
     conf = Configuration.load(hash)
 
     ruby = Scaffold.new(conf.header,
@@ -20,6 +26,8 @@ module Brutal
                         *conf.actuals,
                         **conf.contexts)
 
-    File::Write.new.call(ruby)
+    new_filename = File.generated_filename(filename)
+
+    File::Write.new(new_filename).call(ruby)
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: brutal
 version: !ruby/object:Gem::Version
-  version: 1.2.1
+  version: 1.3.0
 platform: ruby
 authors:
 - Cyril Kato
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-04-03 00:00:00.000000000 Z
+date: 2022-08-21 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