rubysmith 0.6.1 → 0.10.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 613f818841d26d35d707a4a014d7ce18f35b63167cc6e7f830ea045ee9987a53
-  data.tar.gz: c755c4375d9e6f784a570bbe69189529fe5a57d8ee402bda473e1a69534d5baf
+  metadata.gz: c99851111508a1453340fd292981281260eb2b197e1c3685fd40207078cfeee5
+  data.tar.gz: e5781a5bf2f57c8129b1049ac817abdb60a2a2548f7a52fcbd29596587f4701c
 SHA512:
-  metadata.gz: 1c89a8f4692ec295585b752b14cb45ce3e20cece58287f98874ca65af25fd2ff87b227d862e880ceb6296eecd46f5aecb9825f43f5a87cf9a1a3cad05be6dc37
-  data.tar.gz: 6d8f894ee75c1e840442982ffd2534c233ab97406e1f8f85c3a00e8fda8feab57e3fc5c1f248665bf85e59ab1e602c0557d8f7d5cac50d01fa6b64c59bfa7ef5
+  metadata.gz: 9dcbcf78f012f5fc4eb2409bd7d69ecb42e6033df93a227c510226621d56f8d291458c5528c33bf89673bf81f9849017a003fb8a8fdab649f706c725af862ffe
+  data.tar.gz: f6f050ce4b479505bbdff25a34a880e8ce72afc48524c283692f34d255686dd4eab037b365019b4fbd83fce9dccce9e1394ea1b47295908b0c29d7d27db56c55

data/README.adoc

@@ -23,7 +23,6 @@ toc::[]
 == Features
 
 * Builds a Ruby project skeleton for custom design and development.
-* Uses link:https://www.alchemists.io/projects/refinements[Refinements] Ruby core library enhancements.
 * 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].
@@ -40,6 +39,7 @@ 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 common settings and a structured layout for building projects.
 * Provides common documentation:
@@ -97,8 +97,9 @@ BUILD OPTIONS:
   --[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
+  --[no-]simple_cov                    Add SimpleCov.
   --min                                Use minimum/no options.
 ....
 
@@ -173,6 +174,7 @@ The default configuration is as follows:
   :refinements: true
   :rspec: true
   :rubocop: true
+  :ruby_critic: true
   :setup: true
   :simple_cov: true
 :builders:

data/bin/rubysmith

@@ -1,11 +1,7 @@
 #! /usr/bin/env ruby
 # frozen_string_literal: true
 
-# TODO: Remove once the Pattern Matching feature is fully supported.
-Warning[:experimental] = false
-
 require "rubysmith"
-require "rubysmith/cli/shell"
 
 Process.setproctitle Rubysmith::Identity::VERSION_LABEL
 Rubysmith::CLI::Shell.new.call ARGV

data/lib/rubysmith.rb

@@ -2,7 +2,6 @@
 
 require "rubysmith/identity"
 require "rubysmith/pathway"
-require "rubysmith/realm"
 require "rubysmith/renderers/namespace"
 require "rubysmith/renderers/erb"
 require "rubysmith/text/inserter"
@@ -22,10 +21,13 @@ require "rubysmith/builders/rspec/helper"
 require "rubysmith/builders/pragma"
 require "rubysmith/builders/rubocop/setup"
 require "rubysmith/builders/rubocop/formatter"
+require "rubysmith/builders/ruby_critic"
+require "rubysmith/cli/configuration/content"
+require "rubysmith/cli/configuration/loader"
+require "rubysmith/cli/parsers"
 require "rubysmith/cli/parsers/core"
 require "rubysmith/cli/parsers/build"
 require "rubysmith/cli/parsers/assembler"
 require "rubysmith/cli/processors/config"
 require "rubysmith/cli/processors/build"
-require "rubysmith/cli/configuration"
 require "rubysmith/cli/shell"

data/lib/rubysmith/builder.rb

@@ -6,14 +6,11 @@ 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) { "#{severity} #{message}\n" }
-    )
+    LOGGER = Logger.new(STDOUT, formatter: ->(_severity, _at, _program, message) { "#{message}\n" })
 
     HELPERS = {
       inserter: Text::Inserter,
@@ -22,12 +19,12 @@ module Rubysmith
       logger: LOGGER
     }.freeze
 
-    def self.call realm, helpers: HELPERS
-      new realm, helpers: helpers
+    def self.call configuration, helpers: HELPERS
+      new configuration, helpers: helpers
     end
 
-    def initialize realm, helpers: HELPERS
-      @realm = realm
+    def initialize configuration, helpers: HELPERS
+      @configuration = configuration
       @helpers = helpers
     end
 
@@ -105,7 +102,7 @@ module Rubysmith
 
     private
 
-    attr_reader :realm, :helpers
+    attr_reader :configuration, :helpers
 
     def execute *command
       kernel.capture2e(*command).then do |result, status|
@@ -113,33 +110,20 @@ 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 = helpers.fetch(__method__)
 
-    def relative_build_path
-      build_path.relative_path_from realm.build_root
-    end
+    def relative_build_path = build_path.relative_path_from(configuration.build_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 ".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

@@ -2,23 +2,24 @@
 
 require "bundler"
 require "bundler/cli"
+require "refinements/pathnames"
 
 module Rubysmith
   module Builders
     # Builds Bundler Gemfile configuration and installs gem dependencies for project skeleton.
     class Bundler
-      def self.call realm, builder: Builder
-        new(realm, builder: builder).call
-      end
+      using Refinements::Pathnames
+
+      def self.call(configuration, builder: Builder) = new(configuration, builder: builder).call
 
-      def initialize realm, builder: Builder, runner: ::Bundler::CLI
-        @realm = realm
+      def initialize configuration, builder: Builder, client: ::Bundler::CLI
+        @configuration = configuration
         @builder = builder
-        @runner = runner
+        @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")
@@ -26,13 +27,14 @@ module Rubysmith
                .replace(/(\n+|\s+)end/, "\nend")
                .replace(/\n\ngroup :(code_quality|test|tools) do\nend/, "")
                .replace(/org"\n+/, "org\"\n\n")
-        Dir.chdir(realm.project_root) { runner.start %w[install --quiet] }
+
+        configuration.project_root.change_dir { client.start %w[install --quiet] }
         nil
       end
 
       private
 
-      attr_reader :realm, :builder, :runner
+      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(configuration, builder: Builder) = new(configuration, builder: builder).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,23 @@ 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(configuration, builder: Builder) = new(configuration, builder: builder).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_name%.rb.erb"))
+               .render
+        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(configuration, builder: Builder) = new(configuration, builder: builder).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.grep(/render_/).each { |method| __send__ method }
+        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(configuration, builder: Builder) = new(configuration, builder: builder).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

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

@@ -5,24 +5,22 @@ module Rubysmith
     module Git
       # Initializes project skeleton as a Git repository.
       class Setup
-        def self.call realm, builder: Builder
-          new(realm, builder: builder).call
-        end
+        def self.call(configuration, builder: Builder) = new(configuration, builder: builder).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).run("git init", chdir: realm.project_name)
+          builder.call(configuration).run("git init", chdir: configuration.project_name)
         end
 
         private
 
-        attr_reader :realm, :builder
+        attr_reader :configuration, :builder
       end
     end
   end

data/lib/rubysmith/builders/guard.rb

@@ -4,25 +4,25 @@ module Rubysmith
   module Builders
     # Builds project skeleton Guard support for a red, green, refactor loop.
     class Guard
-      def self.call realm, builder: Builder
-        new(realm, builder: builder).call
-      end
+      def self.call(configuration, builder: Builder) = new(configuration, builder: builder).call
 
-      def initialize realm, builder: Builder
-        @realm = realm
+      def initialize configuration, builder: Builder
+        @configuration = configuration
         @builder = builder
       end
 
       def call
-        return unless realm.build_guard
+        return unless configuration.build_guard
 
-        builder.call(realm.with(template_path: "%project_name%/bin/guard.erb")).render.permit 0o755
-        builder.call(realm.with(template_path: "%project_name%/Guardfile.erb")).render
+        builder.call(configuration.with(template_path: "%project_name%/bin/guard.erb"))
+               .render
+               .permit 0o755
+        builder.call(configuration.with(template_path: "%project_name%/Guardfile.erb")).render
       end
 
       private
 
-      attr_reader :realm, :builder
+      attr_reader :configuration, :builder
     end
   end
 end