rubysmith 0.9.1 → 0.13.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: fc61b29f7631893021128bf858b1c47354185e7b14785b21d7efa6a3af8f96c4
-  data.tar.gz: 1592e203b7d83a3a212611b01a968794d75dd463eaf786761733ba021f133d4b
+  metadata.gz: aa3e01ddcd6743f57757311a125d1e8ab39c44e09c1f1186a53b4a0ca6388d7d
+  data.tar.gz: d0725b76c5829d64fbd5e648506ae2e57adbb9882e992b84bfddaa879f166a0b
 SHA512:
-  metadata.gz: f2e10c908b918b136141151257730dc990863e6cebb86f5d8475995d858cabdc89e0350d21903246fde8ec0d58b1013feae96b2cac7db06de151d3936d744569
-  data.tar.gz: d656ebff7d7de45f21cceb610718bfb81cb796647fc325677075dcf6ea5ae2e7b348b770ec217c8b548096f1645a8dd40156d3a9b848b19044f93277e1f284a4
+  metadata.gz: 1e14344b8a18601ef9e05ab3463491977eb81a62027dad1658a7cb1012f94f982296fe1981eea3bd90f35aa88668d3b553d3ef4bed5e77c7dddd060a8a2e444a
+  data.tar.gz: 7b1d999af3527fdd1a182dc2405d19b852cfb93ab8d8c70fa2f1b1e5c3261daa8548d13966d062e266911817e53e394f20442c778c59aad4f89fe4b33402380a

data/README.adoc

@@ -15,8 +15,11 @@ Rubysmith is a command line interface for smithing Ruby projects.
 
 This gem is useful in situations in which you need something more sophisticated than a
 link:https://bundler.io/guides/bundler_in_a_single_file_ruby_script.html[Bundler Inline] script but
-less complicated than a Ruby Gem as provided by
-link:https://www.alchemists.io/projects/gemsmith[Gemsmith].
+less complicated than a link:https://www.alchemists.io/projects/gemsmith[Gemsmith] gem. Rubysmith is
+the foundation of Gemsmith and provides a lot of the same functionality as Gemsmith but solely
+tailored for pure Ruby projects. Again, this is a great tool for spiking quick Ruby implementations,
+sharing code snippets with others, or building full blown Ruby projects for collaboration with
+others.
 
 toc::[]
 
@@ -26,12 +29,12 @@ toc::[]
 * Uses link:https://www.alchemists.io/projects/runcom[Runcom] for resource configuration management.
 * Uses link:https://www.alchemists.io/projects/pragmater[Pragmater] for Ruby source pragma directives.
 * Supports link:https://github.com/amazing-print/amazing_print[Amazing Print].
-* Supports link:https://github.com/rubysec/bundler-audit[Bundler Audit].
 * Supports link:https://github.com/rubymem/bundler-leak[Bundler Leak].
+* Supports link:https://github.com/ruby/debug[Debug].
 * Supports link:https://git-scm.com[Git].
 * Supports link:https://www.alchemists.io/projects/git-lint[Git Lint].
 * Supports link:https://github.com/guard/guard[Guard].
-* Supports link:http://pryrepl.org[Pry].
+* Supports link:https://github.com/ruby/rake[Rake].
 * Supports link:https://github.com/troessner/reek[Reek].
 * Supports link:https://www.alchemists.io/projects/refinements[Refinements].
 * Supports link:https://rspec.info[RSpec].
@@ -39,8 +42,8 @@ toc::[]
 * Supports link:https://docs.rubocop.org/rubocop-performance[Rubocop Performance].
 * Supports link:https://github.com/rubocop-hq/rubocop-rake[Rubocop Rake].
 * Supports link:https://github.com/rubocop-hq/rubocop-rspec[Rubocop RSpec].
-* Supports link:https://github.com/whitesmith/RubyCritic[RubyCritic].
 * Supports link:https://github.com/simplecov-ruby/simplecov[SimpleCov].
+* Supports link:https://github.com/fxn/zeitwerk[Zeitwerk].
 * Supports common settings and a structured layout for building projects.
 * Provides common documentation:
 ** README
@@ -79,28 +82,28 @@ From the command line, type: `rubysmith --help`
 ....
 USAGE:
   -b, --build NAME [options]               Build new project.
-  -v, --version                            Show gem version.
-  -h, --help                               Show this message.
   -c, --config ACTION                      Manage gem configuration: edit or view.
+  -h, --help                               Show this message.
+  -v, --version                            Show gem version.
 
 BUILD OPTIONS:
   --[no-]amazing_print                 Add Amazing Print.
-  --[no-]bundler-audit                 Add Bundler Audit.
   --[no-]bundler-leak                  Add Bundler Leak.
   --[no-]console                       Add console script.
+  --[no-]debug                         Add Debug.
   --[no-]documentation                 Add documentation.
   --[no-]git                           Add Git.
   --[no-]git-lint                      Add Git Lint.
   --[no-]guard                         Add Guard.
-  --[no-]pry                           Add Pry.
+  --min                                Use minimum/no options.
+  --[no-]rake                          Add Rake.
   --[no-]reek                          Add Reek.
   --[no-]refinements                   Add Refinements.
   --[no-]rspec                         Add RSpec.
   --[no-]rubocop                       Add Rubocop.
-  --[no-]ruby_critic                   Add RubyCritic.
   --[no-]setup                         Add setup script.
   --[no-]simple_cov                    Add SimpleCov.
-  --min                                Use minimum/no options.
+  --[no-]zeitwerk                      Add Zeitwerk.
 ....
 
 === Building
@@ -118,12 +121,12 @@ to disable specific options, you can use the `--no-*` prefix. Example:
 
 [source,bash]
 ----
-rubysmith --build demo --no-pry --no-guard
+rubysmith --build demo --no-debug --no-guard
 ----
 
-With the above example, both Pry and Guard support would have been disabled when building the `demo`
-project. Taking this a step further, you can also use the `--min` option to generate a project with
-bare minimum of options. Example:
+With the above example, both Debug and Guard support would have been disabled when building the
+`demo` project. Taking this a step further, you can also use the `--min` option to generate a
+project with bare minimum of options. Example:
 
 [source,bash]
 ----
@@ -134,8 +137,19 @@ The above is essentially the same as building with _all_ options disabled. This
 situations where you need to quickly script something up for sharing with others yet still want to
 avoid using a Bundler Inline script so gem dependencies are not installed each time the code is run.
 
-To have specific options enabled/disabled _every time_ you build a new Ruby project, you can edit
-your global configuration for making these settings permanent (see below for details).
+As shown earlier, you can combine options but the order options can be handy in certain situations
+especially when used with the minimum build option. Example:
+
+[source,bash]
+----
+rubysmith --build demo --min --zeitwerk
+----
+
+The above will disable _all_ options except for Zeitwerk which will be enabled in this situation.
+This can be a handy way to build a new project with all options disabled with only a few select
+options enabled. To have specific options enabled/disabled _every time_ you build a new Ruby
+project, you can edit your global configuration for making these settings permanent (see below for
+details).
 
 === Configuration
 
@@ -161,22 +175,22 @@ The default configuration is as follows:
   :license: "mit"
 :build:
   :amazing_print: true
-  :bundler_audit: true
   :bundler_leak: true
   :console: true
+  :debug: true
   :documentation: true
   :git: true
   :git_lint: true
   :guard: true
   :minimum: false
-  :pry: true
+  :rake: true
   :reek: true
   :refinements: true
   :rspec: true
   :rubocop: true
-  :ruby_critic: true
   :setup: true
   :simple_cov: true
+  :zeitwerk: true
 :builders:
   :pragmater:
     :comments:

data/bin/rubysmith

@@ -2,7 +2,6 @@
 # frozen_string_literal: true
 
 require "rubysmith"
-require "rubysmith/cli/shell"
 
 Process.setproctitle Rubysmith::Identity::VERSION_LABEL
 Rubysmith::CLI::Shell.new.call ARGV

data/lib/rubysmith/builder.rb

@@ -6,26 +6,18 @@ require "logger"
 
 module Rubysmith
   # :reek:TooManyMethods
-  # rubocop:disable Metrics/ClassLength
+  # Provides common functionality necessary for all builders.
   class Builder
     using Refinements::Pathnames
 
-    LOGGER = Logger.new(STDOUT, formatter: ->(_severity, _at, _program, message) { "#{message}\n" })
+    HELPERS = {inserter: Text::Inserter, renderer: Renderers::ERB, kernel: Open3}.freeze
 
-    HELPERS = {
-      inserter: Text::Inserter,
-      renderer: Renderers::ERB,
-      kernel: Open3,
-      logger: LOGGER
-    }.freeze
+    def self.call(...) = new(...)
 
-    def self.call realm, helpers: HELPERS
-      new realm, helpers: helpers
-    end
-
-    def initialize realm, helpers: HELPERS
-      @realm = realm
+    def initialize configuration, helpers: HELPERS, container: Container
+      @configuration = configuration
       @helpers = helpers
+      @container = container
     end
 
     def append content
@@ -102,7 +94,7 @@ module Rubysmith
 
     private
 
-    attr_reader :realm, :helpers
+    attr_reader :configuration, :helpers, :container
 
     def execute *command
       kernel.capture2e(*command).then do |result, status|
@@ -110,33 +102,23 @@ module Rubysmith
       end
     end
 
-    def inserter
-      helpers.fetch __method__
-    end
+    def inserter = helpers.fetch(__method__)
 
-    def renderer
-      helpers.fetch(__method__).new realm
-    end
+    def renderer = helpers.fetch(__method__).new(configuration)
 
-    def kernel
-      helpers.fetch __method__
-    end
+    def kernel = helpers.fetch(__method__)
 
-    def logger
-      helpers.fetch __method__
-    end
+    def logger = container[__method__]
 
-    def relative_build_path
-      build_path.relative_path_from realm.build_root
-    end
+    def relative_build_path = build_path.relative_path_from(configuration.target_root)
 
     def build_path
-      pathway.end_path.gsub("%project_name%", realm.project_name).sub(".erb", "")
+      pathway.end_path
+             .gsub("%project_name%", configuration.project_name)
+             .sub("%project_path%", configuration.project_path)
+             .sub ".erb", ""
     end
 
-    def pathway
-      realm.to_pathway
-    end
+    def pathway = configuration.to_pathway
   end
-  # rubocop:enable Metrics/ClassLength
 end

data/lib/rubysmith/builders/bundler.rb

@@ -10,33 +10,31 @@ module Rubysmith
     class Bundler
       using Refinements::Pathnames
 
-      def self.call realm, builder: Builder
-        new(realm, builder: builder).call
-      end
+      def self.call(...) = new(...).call
 
-      def initialize realm, builder: Builder, client: ::Bundler::CLI
-        @realm = realm
+      def initialize configuration, builder: Builder, client: ::Bundler::CLI
+        @configuration = configuration
         @builder = builder
         @client = client
       end
 
       def call
-        builder.call(realm.with(template_path: "%project_name%/Gemfile.erb"))
+        builder.call(configuration.with(template_path: "%project_name%/Gemfile.erb"))
                .render
                .replace(/\n\s+group/, "\n\ngroup")
                .replace(/\n\s+gem/, "\n  gem")
-               .replace(/  (?=.+refinements)/, "")
+               .replace(/  (?=.+(refinements|zeitwerk))/, "")
                .replace(/(\n+|\s+)end/, "\nend")
                .replace(/\n\ngroup :(code_quality|test|tools) do\nend/, "")
                .replace(/org"\n+/, "org\"\n\n")
 
-        realm.project_root.change_dir { client.start %w[install --quiet] }
+        configuration.project_root.change_dir { client.start %w[install --quiet] }
         nil
       end
 
       private
 
-      attr_reader :realm, :builder, :client
+      attr_reader :configuration, :builder, :client
     end
   end
 end

data/lib/rubysmith/builders/console.rb

@@ -4,26 +4,24 @@ module Rubysmith
   module Builders
     # Builds project skeleton console for object inspection and exploration.
     class Console
-      def self.call realm, builder: Builder
-        new(realm, builder: builder).call
-      end
+      def self.call(...) = new(...).call
 
-      def initialize realm, builder: Builder
-        @realm = realm
+      def initialize configuration, builder: Builder
+        @configuration = configuration
         @builder = builder
       end
 
       def call
-        return unless realm.build_console
+        return unless configuration.build_console
 
-        builder.call(realm.with(template_path: "%project_name%/bin/console.erb"))
+        builder.call(configuration.with(template_path: "%project_name%/bin/console.erb"))
                .render
                .permit 0o755
       end
 
       private
 
-      attr_reader :realm, :builder
+      attr_reader :configuration, :builder
     end
   end
 end

data/lib/rubysmith/builders/core.rb

@@ -4,24 +4,27 @@ module Rubysmith
   module Builders
     # Builds project skeleton core structure and minimum file support.
     class Core
-      def self.call realm, builder: Builder
-        new(realm, builder: builder).call
-      end
+      def self.call(...) = new(...).call
 
-      def initialize realm, builder: Builder
-        @realm = realm
+      def initialize configuration, builder: Builder
+        @configuration = configuration
         @builder = builder
       end
 
       def call
-        builder.call(realm.with(template_path: "%project_name%/lib/%project_name%.rb.erb")).render
-        builder.call(realm.with(template_path: "%project_name%/.ruby-version.erb")).render
+        builder.call(configuration.with(template_path: "%project_name%/lib/%project_path%.rb.erb"))
+               .render
+               .replace("  require", "require")
+               .replace(/    (?=(Zeit|\.tap|\.setup))/, "")
+               .replace("\n  \n", "\n\n")
+
+        builder.call(configuration.with(template_path: "%project_name%/.ruby-version.erb")).render
         nil
       end
 
       private
 
-      attr_reader :realm, :builder
+      attr_reader :configuration, :builder
     end
   end
 end

data/lib/rubysmith/builders/documentation.rb

@@ -4,59 +4,54 @@ module Rubysmith
   module Builders
     # Builds project skeleton documentation.
     class Documentation
-      def self.call realm, builder: Builder
-        new(realm, builder: builder).call
-      end
+      def self.call(...) = new(...).call
 
-      def initialize realm, builder: Builder
-        @realm = realm
+      def initialize configuration, builder: Builder
+        @configuration = configuration
         @builder = builder
       end
 
       def call
-        return unless realm.build_documentation
+        return unless configuration.build_documentation
 
         private_methods.sort.grep(/render_/).each { |method| __send__ method }
       end
 
       private
 
-      attr_reader :realm, :builder
+      attr_reader :configuration, :builder
 
       def render_changes
-        builder.call(realm.with(template_path: "%project_name%/CHANGES.#{kind}.erb"))
+        builder.call(configuration.with(template_path: "%project_name%/CHANGES.#{kind}.erb"))
                .render
       end
 
       def render_conduct
-        builder.call(realm.with(template_path: "%project_name%/CODE_OF_CONDUCT.#{kind}.erb"))
-               .render
+        configuration.with(template_path: "%project_name%/CODE_OF_CONDUCT.#{kind}.erb")
+                     .then { |updated_configuration| builder.call(updated_configuration).render }
       end
 
       def render_contributions
-        builder.call(realm.with(template_path: "%project_name%/CONTRIBUTING.#{kind}.erb"))
+        builder.call(configuration.with(template_path: "%project_name%/CONTRIBUTING.#{kind}.erb"))
                .render
       end
 
       def render_license
-        builder.call(realm.with(template_path: "%project_name%/LICENSE-#{license}.#{kind}.erb"))
-               .render
-               .rename "LICENSE.#{kind}"
+        configuration.with(template_path: "%project_name%/LICENSE-#{license}.#{kind}.erb")
+                     .then do |updated_configuration|
+                       builder.call(updated_configuration).render.rename "LICENSE.#{kind}"
+                     end
       end
 
       def render_readme
-        builder.call(realm.with(template_path: "%project_name%/README.#{kind}.erb"))
+        builder.call(configuration.with(template_path: "%project_name%/README.#{kind}.erb"))
                .render
                .replace("\n\n\n", "\n\n")
       end
 
-      def kind
-        realm.documentation_format || "md"
-      end
+      def kind = configuration.documentation_format || "md"
 
-      def license
-        realm.documentation_license || "mit"
-      end
+      def license = configuration.documentation_license || "mit"
     end
   end
 end

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

@@ -5,19 +5,17 @@ module Rubysmith
     module Git
       # Builds project skeleton initial Git commit message.
       class Commit
-        def self.call realm, builder: Builder
-          new(realm, builder: builder).call
-        end
+        def self.call(...) = new(...).call
 
-        def initialize realm, builder: Builder
-          @realm = realm
+        def initialize configuration, builder: Builder
+          @configuration = configuration
           @builder = builder
         end
 
         def call
-          return unless realm.build_git
+          return unless configuration.build_git
 
-          builder.call(realm)
+          builder.call(configuration)
                  .run("git add .", chdir: project_name)
                  .run(
                    %(git commit --all --message "Added project skeleton" --message "#{body}"),
@@ -27,7 +25,7 @@ module Rubysmith
 
         private
 
-        attr_reader :realm, :builder
+        attr_reader :configuration, :builder
 
         def body
           <<~CONTENT
@@ -36,9 +34,7 @@ module Rubysmith
           CONTENT
         end
 
-        def project_name
-          realm.project_name
-        end
+        def project_name = configuration.project_name
       end
     end
   end