rubysmith 6.6.0 → 6.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b8971c91c536a34ae73babda51a1958dd8676e64f66c7886fd9df251da52e79f
-  data.tar.gz: 2373c1ae9db556f3018aa8cd760deef877e55e28e1a7e79ad48381c0b29460d1
+  metadata.gz: 0f20822bfa5fc0def1a71fa52c0baf8d9888bb0ea85ead200ed7a00412ffe96b
+  data.tar.gz: e92c7f25a98acc995384f4154f806008144e4879b96b583214269f9a7bb15f11
 SHA512:
-  metadata.gz: 4da5c0307b7351af83bf0da75e9661753d0b7e8eb8c03cc2556cd1ff479d6d90aa35a726d8639102c4626e691da9f8d87fbe6ec9ea011e0dd1cb3c33cf4a496a
-  data.tar.gz: 966e676b749c20a54f9d3a1d6eb8de766781002f47ba4412a05965cc8f0cb13f829822dde333445cf8a563fcc5c80ea14da25627cbb625f02065528b059dd137
+  metadata.gz: 61765546bec88e56137acd995023780d29b8356f6abcd6d782a91e6c8e9bbda616bb0374dcb73ed43607ff1680c26d63a266e922ee7c597caaf9e4b4260dfba3
+  data.tar.gz: 926375d0d30b427c0bda7f024f5e55ef29f7fed4a5621807e77ad553964369297c11b64b32521e3decdac1172c93902313ba81517b14da5b5d514a66fc9cfab8

data/README.adoc

@@ -29,13 +29,14 @@ toc::[]
 * Supports link:https://github.com[GitHub].
 * Supports link:https://alchemists.io/projects/git-lint[Git Lint].
 * Supports link:https://github.com/guard/guard[Guard].
+* Supports link:https://alchemists.io/projects/irb-kit[IRB Kit].
 * Supports link:https://github.com/ruby/rake[Rake].
 * Supports link:https://github.com/troessner/reek[Reek].
 * Supports link:https://alchemists.io/projects/refinements[Refinements].
 * Supports link:https://rspec.info[RSpec].
+* Supports link:https://github.com/ruby/repl_type_completor[ReplTypeCompletor].
 * Supports setup script for project setup.
 * Supports link:https://github.com/simplecov-ruby/simplecov[SimpleCov].
-* Supports link:https://github.com/ruby/repl_type_completor[ReplTypeCompletor].
 * Supports link:https://github.com/fxn/zeitwerk[Zeitwerk].
 * Supports common settings and a structured layout for building projects.
 * Provides common documentation:
@@ -210,6 +211,10 @@ manner.
 The `--guard` option allows you add the link:https://github.com/guard/guard[Guard] gem to your
 project for rapid red, green, refactor development cycles.
 
+===== IRB Kit
+
+The `--irb-kit` option allows you add the link:https://alchemists.io/projects/irb-kit[IRB Kit] gem to your project for additional extensions you can use within IRB to improve your workflow.
+
 ===== License
 
 The `--license` option ensures you build your project with a license.
@@ -248,6 +253,10 @@ Ruby core objects without monkey patching your code.
 The `--rspec` option allows you add the link:https://rspec.info[RSpec] gem to your project for
 defining your project specifications and have a framework for testing your code.
 
+===== Repl Type Completor (RTC)
+
+The `--rtc` option allows you add the link:https://github.com/ruby/repl_type_completor[Repl Type Completor] gem to your project for improved type completion when using link:https://github.com/ruby/irb[IRB].
+
 ===== Setup
 
 The `--setup` option allows you to configure you project with automated setup instructions so anyone
@@ -320,6 +329,7 @@ build:
   git_hub_ci: false
   git_lint: true
   guard: true
+  irb_kit: false
   license: true
   maximum: false
   minimum: false
@@ -328,6 +338,7 @@ build:
   reek: true
   refinements: true
   rspec: true
+  rtc: true
   security: true
   setup: true
   simple_cov: true
@@ -345,6 +356,8 @@ license:
   label: Hippocratic
   name: hippocratic
   version: "2.1"
+organization:
+  url:
 project:
   url:
     community:
@@ -413,6 +426,10 @@ Use this section to define the license you want to use for your project. The fol
 
 When picking a license, you can also supply the appropriate label and version in addition to the name.
 
+==== Organization
+
+Use this section to define URL information that points to your organization. This is useful for information that isn't project specific but related to all projects within your organization. You'll want to customize this URL especially for documentation purposes.
+
 ==== Project
 
 There are two sub-categories within this section: URLs and version. The URLs allow you to link to

data/lib/rubysmith/builders/abstract.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+module Rubysmith
+  module Builders
+    # Provides default implementation from which builders can inherit from.
+    class Abstract
+      def self.call(...) = new(...).call
+
+      def initialize configuration, builder: Builder
+        @configuration = configuration
+        @builder = builder
+      end
+
+      def call
+        fail NoMethodError,
+             "`#{self.class}##{__method__} #{method(__method__).parameters}` must be implemented."
+      end
+
+      protected
+
+      attr_reader :configuration, :builder
+    end
+  end
+end

data/lib/rubysmith/builders/bundler.rb

@@ -5,16 +5,9 @@ require "refinements/struct"
 module Rubysmith
   module Builders
     # Builds Bundler Gemfile configuration for project skeleton.
-    class Bundler
+    class Bundler < Abstract
       using Refinements::Struct
 
-      def self.call(...) = new(...).call
-
-      def initialize configuration, builder: Builder
-        @configuration = configuration
-        @builder = builder
-      end
-
       def call
         builder.call(configuration.merge(template_path: "%project_name%/Gemfile.erb"))
                .render
@@ -27,10 +20,6 @@ module Rubysmith
 
         configuration
       end
-
-      private
-
-      attr_reader :configuration, :builder
     end
   end
 end

data/lib/rubysmith/builders/caliber.rb

@@ -5,16 +5,9 @@ require "refinements/struct"
 module Rubysmith
   module Builders
     # Builds project skeleton with Caliber style support.
-    class Caliber
+    class Caliber < Abstract
       using Refinements::Struct
 
-      def self.call(...) = new(...).call
-
-      def initialize configuration, builder: Builder
-        @configuration = configuration
-        @builder = builder
-      end
-
       def call
         return configuration unless configuration.build_caliber
 
@@ -26,10 +19,6 @@ module Rubysmith
         builder.call(configuration.merge(template_path: path)).render
         configuration
       end
-
-      private
-
-      attr_reader :configuration, :builder
     end
   end
 end

data/lib/rubysmith/builders/circle_ci.rb

@@ -5,16 +5,9 @@ require "refinements/struct"
 module Rubysmith
   module Builders
     # Builds project skeleton Circle CI configuration.
-    class CircleCI
+    class CircleCI < Abstract
       using Refinements::Struct
 
-      def self.call(...) = new(...).call
-
-      def initialize configuration, builder: Builder
-        @configuration = configuration
-        @builder = builder
-      end
-
       def call
         return configuration unless configuration.build_circle_ci
 
@@ -24,10 +17,6 @@ module Rubysmith
 
         configuration
       end
-
-      private
-
-      attr_reader :configuration, :builder
     end
   end
 end

data/lib/rubysmith/builders/console.rb

@@ -5,16 +5,9 @@ require "refinements/struct"
 module Rubysmith
   module Builders
     # Builds project skeleton console for object inspection and exploration.
-    class Console
+    class Console < Abstract
       using Refinements::Struct
 
-      def self.call(...) = new(...).call
-
-      def initialize configuration, builder: Builder
-        @configuration = configuration
-        @builder = builder
-      end
-
       def call
         return configuration unless configuration.build_console
 
@@ -24,10 +17,6 @@ module Rubysmith
 
         configuration
       end
-
-      private
-
-      attr_reader :configuration, :builder
     end
   end
 end

data/lib/rubysmith/builders/core.rb

@@ -6,17 +6,10 @@ require "refinements/struct"
 module Rubysmith
   module Builders
     # Builds project skeleton core structure and minimum file support.
-    class Core
+    class Core < Abstract
       using Refinements::String
       using Refinements::Struct
 
-      def self.call(...) = new(...).call
-
-      def initialize configuration, builder: Builder
-        @configuration = configuration
-        @builder = builder
-      end
-
       def call
         render_implementation
         render_specification
@@ -44,8 +37,6 @@ module Rubysmith
       def indentation = ::Core::EMPTY_STRING.indent configuration.project_levels
 
       def module_name = configuration.project_class
-
-      attr_reader :configuration, :builder
     end
   end
 end

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

@@ -6,26 +6,15 @@ module Rubysmith
   module Builders
     module Documentation
       # Builds project skeleton citation documentation.
-      class Citation
+      class Citation < Abstract
         using Refinements::Struct
 
-        def self.call(...) = new(...).call
-
-        def initialize configuration, builder: Builder
-          @configuration = configuration
-          @builder = builder
-        end
-
         def call
           return configuration unless configuration.build_citation
 
           builder.call(configuration.merge(template_path: "%project_name%/CITATION.cff.erb")).render
           configuration
         end
-
-        private
-
-        attr_reader :configuration, :builder
       end
     end
   end

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

@@ -7,16 +7,9 @@ module Rubysmith
   module Builders
     module Documentation
       # Builds project skeleton LICENSE documentation.
-      class License
+      class License < Abstract
         using Refinements::Struct
 
-        def self.call(...) = new(...).call
-
-        def initialize configuration, builder: Builder
-          @configuration = configuration
-          @builder = builder
-        end
-
         def call
           return configuration unless configuration.build_license
 
@@ -30,8 +23,6 @@ module Rubysmith
 
         private
 
-        attr_reader :configuration, :builder
-
         def kind = configuration.documentation_format
 
         def license = configuration.license_name

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

@@ -6,16 +6,9 @@ module Rubysmith
   module Builders
     module Documentation
       # Builds project skeleton README documentation.
-      class Readme
+      class Readme < Abstract
         using Refinements::Struct
 
-        def self.call(...) = new(...).call
-
-        def initialize configuration, builder: Builder
-          @configuration = configuration
-          @builder = builder
-        end
-
         def call
           return configuration unless configuration.build_readme
 
@@ -27,9 +20,7 @@ module Rubysmith
           configuration
         end
 
-        private
-
-        attr_reader :configuration, :builder
+        protected
 
         def kind = configuration.documentation_format
       end

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

@@ -7,16 +7,9 @@ module Rubysmith
   module Builders
     module Documentation
       # Builds project skeleton version history.
-      class Version
+      class Version < Abstract
         using Refinements::Struct
 
-        def self.call(...) = new(...).call
-
-        def initialize configuration, builder: Builder
-          @configuration = configuration
-          @builder = builder
-        end
-
         def call
           return configuration unless configuration.build_versions
 
@@ -28,8 +21,6 @@ module Rubysmith
 
         private
 
-        attr_reader :configuration, :builder
-
         def kind = configuration.documentation_format
       end
     end

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

@@ -4,15 +4,11 @@ module Rubysmith
   module Builders
     module Git
       # Builds project skeleton initial Git commit message.
-      class Commit
+      class Commit < Abstract
         include Import[:specification]
 
-        def self.call(...) = new(...).call
-
         def initialize(configuration, builder: Builder, **)
-          super(**)
-          @configuration = configuration
-          @builder = builder
+          super
         end
 
         def call
@@ -30,8 +26,6 @@ module Rubysmith
 
         private
 
-        attr_reader :configuration, :builder
-
         def body
           "Generated with link:#{specification.homepage_url}[#{specification.label}] " \
           "#{specification.version}."

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

@@ -6,16 +6,9 @@ module Rubysmith
   module Builders
     module Git
       # Builds Git repository directory and file ignore configuration.
-      class Ignore
+      class Ignore < Abstract
         using Refinements::Struct
 
-        def self.call(...) = new(...).call
-
-        def initialize configuration, builder: Builder
-          @configuration = configuration
-          @builder = builder
-        end
-
         def call
           return configuration unless configuration.build_git
 
@@ -25,10 +18,6 @@ module Rubysmith
 
           configuration
         end
-
-        private
-
-        attr_reader :configuration, :builder
       end
     end
   end

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

@@ -6,26 +6,15 @@ module Rubysmith
   module Builders
     module Git
       # Initializes project skeleton with Git Safe support.
-      class Safe
+      class Safe < Abstract
         using Refinements::Struct
 
-        def self.call(...) = new(...).call
-
-        def initialize configuration, builder: Builder
-          @configuration = configuration
-          @builder = builder
-        end
-
         def call
           return configuration unless configuration.build_git
 
           builder.call(configuration.merge(template_path: "%project_name%/.git/safe")).make_path
           configuration
         end
-
-        private
-
-        attr_reader :configuration, :builder
       end
     end
   end

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

@@ -4,24 +4,13 @@ module Rubysmith
   module Builders
     module Git
       # Initializes project skeleton as a Git repository.
-      class Setup
-        def self.call(...) = new(...).call
-
-        def initialize configuration, builder: Builder
-          @configuration = configuration
-          @builder = builder
-        end
-
+      class Setup < Abstract
         def call
           return configuration unless configuration.build_git
 
           builder.call(configuration).run("git init", chdir: configuration.project_name)
           configuration
         end
-
-        private
-
-        attr_reader :configuration, :builder
       end
     end
   end

data/lib/rubysmith/builders/git_hub.rb

@@ -5,16 +5,9 @@ require "refinements/struct"
 module Rubysmith
   module Builders
     # Builds project skeleton GitHub templates.
-    class GitHub
+    class GitHub < Abstract
       using Refinements::Struct
 
-      def self.call(...) = new(...).call
-
-      def initialize configuration, builder: Builder
-        @configuration = configuration
-        @builder = builder
-      end
-
       def call
         render_funding
 
@@ -27,8 +20,6 @@ module Rubysmith
 
       private
 
-      attr_reader :configuration, :builder
-
       def render_funding
         return unless configuration.build_funding
 

data/lib/rubysmith/builders/git_hub_ci.rb

@@ -5,16 +5,9 @@ require "refinements/struct"
 module Rubysmith
   module Builders
     # Builds project skeleton GitHub CI template.
-    class GitHubCI
+    class GitHubCI < Abstract
       using Refinements::Struct
 
-      def self.call(...) = new(...).call
-
-      def initialize configuration, builder: Builder
-        @configuration = configuration
-        @builder = builder
-      end
-
       def call
         return configuration unless configuration.build_git_hub_ci
 
@@ -24,8 +17,6 @@ module Rubysmith
 
       private
 
-      attr_reader :configuration, :builder
-
       def configuration_with_template
         configuration.merge template_path: "%project_name%/.github/workflows/ci.yml.erb"
       end

data/lib/rubysmith/builders/guard.rb

@@ -5,16 +5,9 @@ require "refinements/struct"
 module Rubysmith
   module Builders
     # Builds project skeleton Guard support for a red, green, refactor loop.
-    class Guard
+    class Guard < Abstract
       using Refinements::Struct
 
-      def self.call(...) = new(...).call
-
-      def initialize configuration, builder: Builder
-        @configuration = configuration
-        @builder = builder
-      end
-
       def call
         return configuration unless configuration.build_guard
 
@@ -25,10 +18,6 @@ module Rubysmith
         builder.call(configuration.merge(template_path: "%project_name%/Guardfile.erb")).render
         configuration
       end
-
-      private
-
-      attr_reader :configuration, :builder
     end
   end
 end

data/lib/rubysmith/builders/init.rb

@@ -6,24 +6,13 @@ require "refinements/struct"
 module Rubysmith
   module Builders
     # Initializes building of project by checking for existence first.
-    class Init
+    class Init < Abstract
       using Refinements::Struct
 
-      def self.call(...) = new(...).call
-
-      def initialize configuration, builder: Builder
-        @configuration = configuration
-        @builder = builder
-      end
-
       def call
         builder.call(configuration.merge(template_path: "%project_name%")).check
         configuration
       end
-
-      private
-
-      attr_reader :configuration, :builder
     end
   end
 end

data/lib/rubysmith/builders/rake.rb

@@ -5,16 +5,9 @@ require "refinements/struct"
 module Rubysmith
   module Builders
     # Builds project skeleton Rake support.
-    class Rake
+    class Rake < Abstract
       using Refinements::Struct
 
-      def self.call(...) = new(...).call
-
-      def initialize configuration, builder: Builder
-        @configuration = configuration
-        @builder = builder
-      end
-
       def call
         return configuration unless configuration.build_rake
 
@@ -25,8 +18,6 @@ module Rubysmith
 
       private
 
-      attr_reader :configuration, :builder
-
       def add_binstub
         builder.call(configuration.merge(template_path: "%project_name%/bin/rake.erb"))
                .render

data/lib/rubysmith/builders/reek.rb

@@ -5,26 +5,15 @@ require "refinements/struct"
 module Rubysmith
   module Builders
     # Builds project skeleton Reek code quality support.
-    class Reek
+    class Reek < Abstract
       using Refinements::Struct
 
-      def self.call(...) = new(...).call
-
-      def initialize configuration, builder: Builder
-        @configuration = configuration
-        @builder = builder
-      end
-
       def call
         return configuration unless configuration.build_reek
 
         builder.call(configuration.merge(template_path: "%project_name%/.reek.yml.erb")).render
         configuration
       end
-
-      private
-
-      attr_reader :configuration, :builder
     end
   end
 end

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

@@ -6,16 +6,9 @@ module Rubysmith
   module Builders
     module RSpec
       # Builds RSpec binstub for project skeleton.
-      class Binstub
+      class Binstub < Abstract
         using Refinements::Struct
 
-        def self.call(...) = new(...).call
-
-        def initialize configuration, builder: Builder
-          @configuration = configuration
-          @builder = builder
-        end
-
         def call
           return configuration unless configuration.build_rspec
 
@@ -25,10 +18,6 @@ module Rubysmith
 
           configuration
         end
-
-        private
-
-        attr_reader :configuration, :builder
       end
     end
   end