rubysmith 5.8.1 → 6.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3d6463a4b66a1668979f5d825065d7fda7c49f211db2db7f5bd9a0cc317a7629
-  data.tar.gz: a790806d30c4e8c06093717aefd934136f2b76b8efac56f80cdf5f44edf28818
+  metadata.gz: 93c262c72026410ba6e824bd4b929c59b7fdad7e14c85e32296291f1f3c26b7d
+  data.tar.gz: 36f7597c6da34a8d8289bd9b12ea677ae4333b0aae65dd295f03ad1ac6fa37db
 SHA512:
-  metadata.gz: 8664418401e1ab60e8a22fac22e773937b707b6857202b90baf802e4929cf17547d109426ba5083a259d1306f3aa65972be7589c1e050abd231307e64dff74cb
-  data.tar.gz: ad461380ff16989af7e8fbaf1c9e1f57e85dfb8f17f5f001dcd4a2f03ecf6c23a5a46abb818c9fa0b608ec4749d84b204d03c27103a5562b1d2f02325be6c7a7
+  metadata.gz: c97d215e67d97574f0bde790e5a57e31a630d203deb7ad9c2fdcc9c5d37db225101d316d9bb759ae8826a5e7465a5cf946fef9508360c153e8eb3f47bc2f8884
+  data.tar.gz: 77ae12c7308be608744fd327af44a127d10c0fe5b9278b76fb93a5b7b601ea8cda18d0080010b2bb395e50fd85efaa901b82f6665e5babcbab8c9d49dfbc2c56

checksums.yaml.gz.sig

@@ -1,2 +1,3 @@
-	I֠&E�uV�U�z��iJw��?�����tIev2��%;�/S�O��	��o�%gm]*M�{�|����r�MJ��]j�����:[+�$�%)Cr3���8p"4�YD��
����_z�����K���
-�S
+=�D���	�ѭ�_��*��~
�>73� XK;�0<�peB5AS��Dw�eǼ�)�Q���5�
+*2B�b�/���|��q���|t�y�Pk�#�B2/
���oȅ�g�����������E9��.}��9��:��"�P�U������{���s:E�,���>\:'J�p%
+gv���u+�HS��%�t�j�w�@|ȗ��s����X�
G�Z	��g�����q�

data/README.adoc

@@ -35,7 +35,6 @@ toc::[]
 * Supports link:https://rspec.info[RSpec].
 * Supports setup script for project setup.
 * Supports link:https://github.com/simplecov-ruby/simplecov[SimpleCov].
-* Supports link:https://yardoc.org[YARD].
 * Supports link:https://github.com/fxn/zeitwerk[Zeitwerk].
 * Supports common settings and a structured layout for building projects.
 * Provides common documentation:
@@ -76,7 +75,7 @@ gem install rubysmith
 
 From the command line, type: `rubysmith --help`
 
-image:https://alchemists.io/images/projects/rubysmith/screenshots/usage.png[Usage,width=588,height=345,role=focal_point]
+image:https://alchemists.io/images/projects/rubysmith/screenshots/usage.png[Usage,width=604,height=345,role=focal_point]
 
 ==== Build
 
@@ -264,13 +263,6 @@ analysis of what your quality of code is for the project.
 The `--versions` option allows you add a `VERSIONS` file to your project to provide details about
 all published versions of your project.
 
-===== YARD
-
-The `--yard` option allows you add the link:https://yardoc.org/[YARD] gem to your project so you can
-automate the generation of project documentation. Once your project is built, you can use `rake
-yard` to build documentation into the `doc/yard` folder. This folder is ignored by Git by default.
-Additional customization is possible via the YARD Rake task as found in the `Rakefile`.
-
 ===== Zeitwerk
 
 The `--zeitwerk` option allows you add the link:https://github.com/fxn/zeitwerk[Zeitwerk] gem to your project so you can reduce the maintenance burden of managing requirements when adding new objects to your project.
@@ -339,7 +331,6 @@ build:
   setup: true
   simple_cov: true
   versions: true
-  yard: false
   zeitwerk: true
 citation:
   affiliation:
@@ -347,35 +338,6 @@ citation:
   orcid:
 documentation:
   format: "adoc"
-extensions:
-  milestoner:
-    documentation:
-      format: "adoc"
-    prefixes:
-      - Fixed
-      - Added
-      - Updated
-      - Removed
-      - Refactored
-  pragmater:
-    comments:
-      - "# frozen_string_literal: true"
-    patterns:
-      - "**/*.rake"
-      - "**/*.rb"
-      - "*.gemspec"
-      - "exe/*"
-      - bin/console
-      - bin/guard
-      - bin/rubocop
-      - config.ru
-      - Gemfile
-      - Guardfile
-      - Rakefile
-  tocer:
-    label: "## Table of Contents"
-    patterns:
-      - "README.md"
 git_hub:
   user:
 license:

data/lib/rubysmith/builder.rb

@@ -2,14 +2,14 @@
 
 require "logger"
 require "open3"
-require "refinements/pathnames"
+require "refinements/pathname"
 
 module Rubysmith
   # Provides common functionality necessary for all builders.
   class Builder
     include Import[:kernel, :logger]
 
-    using Refinements::Pathnames
+    using Refinements::Pathname
 
     HELPERS = {inserter: Text::Inserter, renderer: Renderers::ERB, executor: Open3}.freeze
 

data/lib/rubysmith/builders/bundler.rb

@@ -1,12 +1,12 @@
 # frozen_string_literal: true
 
-require "refinements/structs"
+require "refinements/struct"
 
 module Rubysmith
   module Builders
     # Builds Bundler Gemfile configuration for project skeleton.
     class Bundler
-      using Refinements::Structs
+      using Refinements::Struct
 
       def self.call(...) = new(...).call
 
@@ -22,7 +22,7 @@ module Rubysmith
                .replace(/\n\s+gem/, "\n  gem")
                .replace(/  (?=.+(refinements|zeitwerk))/, "")
                .replace(/(\n+|\s+)end/, "\nend")
-               .replace(/\n\ngroup :(code_quality|development|test|tools) do\nend/, "")
+               .replace(/\n\ngroup :(quality|development|test|tools) do\nend/, "")
                .replace(/org"\n+/, "org\"\n\n")
 
         configuration

data/lib/rubysmith/builders/caliber.rb

@@ -1,12 +1,12 @@
 # frozen_string_literal: true
 
-require "refinements/structs"
+require "refinements/struct"
 
 module Rubysmith
   module Builders
     # Builds project skeleton with Caliber style support.
     class Caliber
-      using Refinements::Structs
+      using Refinements::Struct
 
       def self.call(...) = new(...).call
 

data/lib/rubysmith/builders/circle_ci.rb

@@ -1,12 +1,12 @@
 # frozen_string_literal: true
 
-require "refinements/structs"
+require "refinements/struct"
 
 module Rubysmith
   module Builders
     # Builds project skeleton Circle CI configuration.
     class CircleCI
-      using Refinements::Structs
+      using Refinements::Struct
 
       def self.call(...) = new(...).call
 

data/lib/rubysmith/builders/console.rb

@@ -1,12 +1,12 @@
 # frozen_string_literal: true
 
-require "refinements/structs"
+require "refinements/struct"
 
 module Rubysmith
   module Builders
     # Builds project skeleton console for object inspection and exploration.
     class Console
-      using Refinements::Structs
+      using Refinements::Struct
 
       def self.call(...) = new(...).call
 

data/lib/rubysmith/builders/core.rb

@@ -1,14 +1,14 @@
 # frozen_string_literal: true
 
-require "refinements/strings"
-require "refinements/structs"
+require "refinements/string"
+require "refinements/struct"
 
 module Rubysmith
   module Builders
     # Builds project skeleton core structure and minimum file support.
     class Core
-      using Refinements::Strings
-      using Refinements::Structs
+      using Refinements::String
+      using Refinements::Struct
 
       def self.call(...) = new(...).call
 
@@ -18,16 +18,28 @@ module Rubysmith
       end
 
       def call
+        render_implementation
+        render_specification
+        configuration
+      end
+
+      private
+
+      def render_implementation
         builder.call(configuration.merge(template_path: "%project_name%/lib/%project_path%.rb.erb"))
                .render
                .replace("  require", "require")
                .replace(/    (?=(Zeit|loader|end))/, "")
                .replace("\n  \n", "\n\n")
                .insert_before("module #{module_name}", "#{indentation}# Main namespace.\n")
-        configuration
       end
 
-      private
+      def render_specification
+        return unless configuration.build_zeitwerk
+
+        path = "%project_name%/spec/lib/%project_path%_spec.rb.erb"
+        builder.call(configuration.merge(template_path: path)).render
+      end
 
       def indentation = ::Core::EMPTY_STRING.indent configuration.project_levels
 

data/lib/rubysmith/builders/documentation/citation.rb

@@ -1,13 +1,13 @@
 # frozen_string_literal: true
 
-require "refinements/structs"
+require "refinements/struct"
 
 module Rubysmith
   module Builders
     module Documentation
       # Builds project skeleton citation documentation.
       class Citation
-        using Refinements::Structs
+        using Refinements::Struct
 
         def self.call(...) = new(...).call
 

data/lib/rubysmith/builders/documentation/license.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require "refinements/structs"
+require "refinements/struct"
 require "tocer"
 
 module Rubysmith
@@ -8,7 +8,7 @@ module Rubysmith
     module Documentation
       # Builds project skeleton LICENSE documentation.
       class License
-        using Refinements::Structs
+        using Refinements::Struct
 
         def self.call(...) = new(...).call
 

data/lib/rubysmith/builders/documentation/readme.rb

@@ -1,13 +1,13 @@
 # frozen_string_literal: true
 
-require "refinements/structs"
+require "refinements/struct"
 
 module Rubysmith
   module Builders
     module Documentation
       # Builds project skeleton README documentation.
       class Readme
-        using Refinements::Structs
+        using Refinements::Struct
 
         def self.call(...) = new(...).call
 

data/lib/rubysmith/builders/documentation/version.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require "refinements/structs"
+require "refinements/struct"
 require "tocer"
 
 module Rubysmith
@@ -8,7 +8,7 @@ module Rubysmith
     module Documentation
       # Builds project skeleton version history.
       class Version
-        using Refinements::Structs
+        using Refinements::Struct
 
         def self.call(...) = new(...).call
 

data/lib/rubysmith/builders/git/ignore.rb

@@ -1,13 +1,13 @@
 # frozen_string_literal: true
 
-require "refinements/structs"
+require "refinements/struct"
 
 module Rubysmith
   module Builders
     module Git
       # Builds Git repository directory and file ignore configuration.
       class Ignore
-        using Refinements::Structs
+        using Refinements::Struct
 
         def self.call(...) = new(...).call
 

data/lib/rubysmith/builders/git/safe.rb

@@ -1,13 +1,13 @@
 # frozen_string_literal: true
 
-require "refinements/structs"
+require "refinements/struct"
 
 module Rubysmith
   module Builders
     module Git
       # Initializes project skeleton with Git Safe support.
       class Safe
-        using Refinements::Structs
+        using Refinements::Struct
 
         def self.call(...) = new(...).call
 

data/lib/rubysmith/builders/git_hub.rb

@@ -1,12 +1,12 @@
 # frozen_string_literal: true
 
-require "refinements/structs"
+require "refinements/struct"
 
 module Rubysmith
   module Builders
     # Builds project skeleton GitHub templates.
     class GitHub
-      using Refinements::Structs
+      using Refinements::Struct
 
       def self.call(...) = new(...).call
 

data/lib/rubysmith/builders/git_hub_ci.rb

@@ -1,12 +1,12 @@
 # frozen_string_literal: true
 
-require "refinements/structs"
+require "refinements/struct"
 
 module Rubysmith
   module Builders
     # Builds project skeleton GitHub CI template.
     class GitHubCI
-      using Refinements::Structs
+      using Refinements::Struct
 
       def self.call(...) = new(...).call
 

data/lib/rubysmith/builders/guard.rb

@@ -1,12 +1,12 @@
 # frozen_string_literal: true
 
-require "refinements/structs"
+require "refinements/struct"
 
 module Rubysmith
   module Builders
     # Builds project skeleton Guard support for a red, green, refactor loop.
     class Guard
-      using Refinements::Structs
+      using Refinements::Struct
 
       def self.call(...) = new(...).call
 

data/lib/rubysmith/builders/init.rb

@@ -1,13 +1,13 @@
 # frozen_string_literal: true
 
 require "pathname"
-require "refinements/structs"
+require "refinements/struct"
 
 module Rubysmith
   module Builders
     # Initializes building of project by checking for existence first.
     class Init
-      using Refinements::Structs
+      using Refinements::Struct
 
       def self.call(...) = new(...).call
 

data/lib/rubysmith/builders/rake.rb

@@ -1,12 +1,12 @@
 # frozen_string_literal: true
 
-require "refinements/structs"
+require "refinements/struct"
 
 module Rubysmith
   module Builders
     # Builds project skeleton Rake support.
     class Rake
-      using Refinements::Structs
+      using Refinements::Struct
 
       def self.call(...) = new(...).call
 

data/lib/rubysmith/builders/reek.rb

@@ -1,12 +1,12 @@
 # frozen_string_literal: true
 
-require "refinements/structs"
+require "refinements/struct"
 
 module Rubysmith
   module Builders
     # Builds project skeleton Reek code quality support.
     class Reek
-      using Refinements::Structs
+      using Refinements::Struct
 
       def self.call(...) = new(...).call
 

data/lib/rubysmith/builders/rspec/binstub.rb

@@ -1,13 +1,13 @@
 # frozen_string_literal: true
 
-require "refinements/structs"
+require "refinements/struct"
 
 module Rubysmith
   module Builders
     module RSpec
       # Builds RSpec binstub for project skeleton.
       class Binstub
-        using Refinements::Structs
+        using Refinements::Struct
 
         def self.call(...) = new(...).call
 

data/lib/rubysmith/builders/rspec/context.rb

@@ -1,13 +1,13 @@
 # frozen_string_literal: true
 
-require "refinements/structs"
+require "refinements/struct"
 
 module Rubysmith
   module Builders
     module RSpec
       # Builds RSpec shared context for temporary directories.
       class Context
-        using Refinements::Structs
+        using Refinements::Struct
 
         def self.call(...) = new(...).call
 

data/lib/rubysmith/builders/rspec/helper.rb

@@ -1,13 +1,13 @@
 # frozen_string_literal: true
 
-require "refinements/structs"
+require "refinements/struct"
 
 module Rubysmith
   module Builders
     module RSpec
       # Builds RSpec spec helper for project skeleton.
       class Helper
-        using Refinements::Structs
+        using Refinements::Struct
 
         def self.call(...) = new(...).call
 

data/lib/rubysmith/builders/setup.rb

@@ -1,12 +1,12 @@
 # frozen_string_literal: true
 
-require "refinements/structs"
+require "refinements/struct"
 
 module Rubysmith
   module Builders
     # Builds project skeleton setup script.
     class Setup
-      using Refinements::Structs
+      using Refinements::Struct
 
       def self.call(...) = new(...).call
 

data/lib/rubysmith/builders/version.rb

@@ -1,12 +1,12 @@
 # frozen_string_literal: true
 
-require "refinements/structs"
+require "refinements/struct"
 
 module Rubysmith
   module Builders
     # Builds project skeleton Ruby version file.
     class Version
-      using Refinements::Structs
+      using Refinements::Struct
 
       def self.call(...) = new(...).call
 

data/lib/rubysmith/cli/actions/maximum.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require "refinements/structs"
+require "refinements/struct"
 require "sod"
 
 module Rubysmith
@@ -10,7 +10,7 @@ module Rubysmith
       class Maximum < Sod::Action
         include Import[:input]
 
-        using ::Refinements::Structs
+        using ::Refinements::Struct
 
         description "Use maximum options."
 

data/lib/rubysmith/cli/actions/minimum.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require "refinements/structs"
+require "refinements/struct"
 require "sod"
 
 module Rubysmith
@@ -10,7 +10,7 @@ module Rubysmith
       class Minimum < Sod::Action
         include Import[:input]
 
-        using ::Refinements::Structs
+        using ::Refinements::Struct
 
         description "Use minimum options."
 

data/lib/rubysmith/cli/actions/publish.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
-require "refinements/structs"
+require "milestoner"
+require "refinements/struct"
 require "sod"
 
 module Rubysmith
@@ -10,18 +11,20 @@ module Rubysmith
       class Publish < Sod::Action
         include Import[:input]
 
-        using ::Refinements::Structs
+        using ::Refinements::Struct
 
-        description "Publish project."
+        description "Publish milestone."
 
-        on %w[-p --publish], argument: "VERSION"
+        on %w[-p --publish], argument: "[VERSION]"
+
+        default { Milestoner::Commits::Versioner.new.call }
 
         def initialize(extension: Extensions::Milestoner, **)
           super(**)
           @extension = extension
         end
 
-        def call(version) = extension.call input.merge(project_version: version)
+        def call(version = nil) = extension.call input.merge(project_version: version || default)
 
         private
 

data/lib/rubysmith/cli/commands/build.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require "refinements/structs"
+require "refinements/struct"
 require "sod"
 
 module Rubysmith
@@ -74,7 +74,6 @@ module Rubysmith
         on Actions::Setup
         on Actions::SimpleCov
         on Actions::Versions
-        on Actions::Yard
         on Actions::Zeitwerk
 
         def initialize(builders: BUILDERS, **)

data/lib/rubysmith/configuration/contract.rb

@@ -40,18 +40,11 @@ module Rubysmith
       required(:build_setup).filled :bool
       required(:build_simple_cov).filled :bool
       required(:build_versions).filled :bool
-      required(:build_yard).filled :bool
       required(:build_zeitwerk).filled :bool
       optional(:citation_affiliation).filled :string
       optional(:citation_message).filled :string
       optional(:citation_orcid).filled :string
       required(:documentation_format).filled :string
-      required(:extensions_milestoner_documentation_format).filled :string
-      required(:extensions_milestoner_prefixes).array :string
-      required(:extensions_pragmater_comments).array :string
-      required(:extensions_pragmater_patterns).array :string
-      required(:extensions_tocer_label).filled :string
-      required(:extensions_tocer_patterns).array :string
       optional(:git_hub_user).filled :string
       required(:license_label).filled :string
       required(:license_name).filled :string

data/lib/rubysmith/configuration/defaults.yml

@@ -27,41 +27,11 @@ build:
   setup: true
   simple_cov: true
   versions: true
-  yard: false
   zeitwerk: true
 citation:
   message: Please use the following metadata when citing this project in your work.
 documentation:
   format: "adoc"
-extensions:
-  milestoner:
-    documentation:
-      format: "adoc"
-    prefixes:
-      - Fixed
-      - Added
-      - Updated
-      - Removed
-      - Refactored
-  pragmater:
-    comments:
-      - "# frozen_string_literal: true"
-    patterns:
-      - "**/*.rake"
-      - "**/*.rb"
-      - "*.gemspec"
-      - "exe/*"
-      - bin/console
-      - bin/guard
-      - bin/rubocop
-      - config.ru
-      - Gemfile
-      - Guardfile
-      - Rakefile
-  tocer:
-    label: "## Table of Contents"
-    patterns:
-      - "README.md"
 license:
   label: Hippocratic
   name: hippocratic