rubysmith 0.11.0 → 0.15.0

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

@@ -4,13 +4,12 @@ module Rubysmith
   module CLI
     module Parsers
       # Handles parsing of Command Line Interface (CLI) build options.
-      # :reek:TooManyMethods
       class Build
-        def self.call(options: {}, client: CLIENT) = new(options: options, client: client).call
+        def self.call(...) = new(...).call
 
-        def initialize options: {}, client: CLIENT
-          @options = options
+        def initialize client: CLIENT, container: Container
           @client = client
+          @container = container
         end
 
         def call arguments = []
@@ -21,103 +20,235 @@ module Rubysmith
 
         private
 
-        attr_reader :options, :client
+        attr_reader :client, :container
 
-        def add_minimum
-          client.on "--min", "Use minimum/no options." do |value|
-            options[:build_minimum] = value
+        def add_amazing_print
+          client.on(
+            "--[no-]amazing_print",
+            "Add Amazing Print gem. #{default __method__}."
+          ) do |value|
+            configuration.build_amazing_print = value
           end
         end
 
-        def add_amazing_print
-          client.on "--[no-]amazing_print", "Add Amazing Print." do |value|
-            options[:build_amazing_print] = value
+        def add_bundler_leak
+          client.on(
+            "--[no-]bundler-leak",
+            "Add Bundler Leak gem. #{default __method__}."
+          ) do |value|
+            configuration.build_bundler_leak = value
           end
         end
 
-        def add_bundler_leak
-          client.on "--[no-]bundler-leak", "Add Bundler Leak." do |value|
-            options[:build_bundler_leak] = value
+        def add_changes
+          client.on(
+            "--[no-]changes",
+            "Add CHANGES documentation. #{default __method__}."
+          ) do |value|
+            configuration.build_changes = value
           end
         end
 
         def add_console
-          client.on "--[no-]console", "Add console script." do |value|
-            options[:build_console] = value
+          client.on(
+            "--[no-]console",
+            "Add console script. #{default __method__}."
+          ) do |value|
+            configuration.build_console = value
           end
         end
 
-        def add_documentation
-          client.on "--[no-]documentation", "Add documentation." do |value|
-            options[:build_documentation] = value
+        def add_contributions
+          client.on(
+            "--[no-]contributions",
+            "Add CONTRIBUTING documentation. #{default __method__}."
+          ) do |value|
+            configuration.build_contributions = value
+          end
+        end
+
+        def add_circle_ci
+          client.on(
+            "--[no-]circle_ci",
+            "Add Circle CI configuration and badge. #{default __method__}."
+          ) do |value|
+            configuration.build_circle_ci = value
+          end
+        end
+
+        def add_conduct
+          client.on(
+            "--[no-]conduct",
+            "Add CODE_OF_CONDUCT documentation. #{default __method__}."
+          ) do |value|
+            configuration.build_conduct = value
+          end
+        end
+
+        def add_debug
+          client.on(
+            "--[no-]debug",
+            "Add Debug gem. #{default __method__}."
+          ) do |value|
+            configuration.build_debug = value
           end
         end
 
         def add_git
-          client.on "--[no-]git", "Add Git." do |value|
-            options[:build_git] = value
+          client.on(
+            "--[no-]git",
+            "Add Git. #{default __method__}."
+          ) do |value|
+            configuration.build_git = value
+          end
+        end
+
+        def add_git_hub
+          client.on(
+            "--[no-]git_hub",
+            "Add GitHub templates. #{default __method__}."
+          ) do |value|
+            configuration.build_git_hub = value
           end
         end
 
         def add_git_lint
-          client.on "--[no-]git-lint", "Add Git Lint." do |value|
-            options[:build_git_lint] = value
+          client.on(
+            "--[no-]git-lint",
+            "Add Git Lint gem. #{default __method__}."
+          ) do |value|
+            configuration.build_git_lint = value
           end
         end
 
         def add_guard
-          client.on "--[no-]guard", "Add Guard." do |value|
-            options[:build_guard] = value
+          client.on(
+            "--[no-]guard",
+            "Add Guard gem. #{default __method__}."
+          ) do |value|
+            configuration.build_guard = value
+          end
+        end
+
+        def add_license
+          client.on(
+            "--[no-]license",
+            "Add LICENSE documentation. #{default __method__}."
+          ) do |value|
+            configuration.build_license = value
+          end
+        end
+
+        def add_maximum
+          client.on(
+            "--max",
+            "Use maximum/enabled options. #{default __method__}."
+          ) do |value|
+            configuration.maximize.build_maximum = value
+          end
+        end
+
+        def add_minimum
+          client.on(
+            "--min",
+            "Use minimum/disabled options. #{default __method__}."
+          ) do |value|
+            configuration.minimize.build_minimum = value
           end
         end
 
-        def add_pry
-          client.on "--[no-]pry", "Add Pry." do |value|
-            options[:build_pry] = value
+        def add_rake
+          client.on(
+            "--[no-]rake",
+            "Add Rake gem. #{default __method__}."
+          ) do |value|
+            configuration.build_rake = value
+          end
+        end
+
+        def add_readme
+          client.on(
+            "--[no-]readme",
+            "Add README documentation. #{default __method__}."
+          ) do |value|
+            configuration.build_readme = value
           end
         end
 
         def add_reek
-          client.on "--[no-]reek", "Add Reek." do |value|
-            options[:build_reek] = value
+          client.on(
+            "--[no-]reek",
+            "Add Reek gem. #{default __method__}."
+          ) do |value|
+            configuration.build_reek = value
           end
         end
 
         def add_refinements
-          client.on "--[no-]refinements", "Add Refinements." do |value|
-            options[:build_refinements] = value
+          client.on(
+            "--[no-]refinements",
+            "Add Refinements gem. #{default __method__}."
+          ) do |value|
+            configuration.build_refinements = value
           end
         end
 
         def add_rspec
-          client.on "--[no-]rspec", "Add RSpec." do |value|
-            options[:build_rspec] = value
+          client.on(
+            "--[no-]rspec",
+            "Add RSpec gem. #{default __method__}."
+          ) do |value|
+            configuration.build_rspec = value
           end
         end
 
         def add_rubocop
-          client.on "--[no-]rubocop", "Add Rubocop." do |value|
-            options[:build_rubocop] = value
+          client.on(
+            "--[no-]rubocop",
+            "Add Rubocop gems. #{default __method__}."
+          ) do |value|
+            configuration.build_rubocop = value
           end
         end
 
-        def add_ruby_critic
-          client.on "--[no-]ruby_critic", "Add RubyCritic." do |value|
-            options[:build_ruby_critic] = value
+        def add_setup
+          client.on(
+            "--[no-]setup",
+            "Add setup script. #{default __method__}."
+          ) do |value|
+            configuration.build_setup = value
           end
         end
 
-        def add_setup
-          client.on "--[no-]setup", "Add setup script." do |value|
-            options[:build_setup] = value
+        def add_simple_cov
+          client.on(
+            "--[no-]simple_cov",
+            "Add SimpleCov gem. #{default __method__}."
+          ) do |value|
+            configuration.build_simple_cov = value
           end
         end
 
-        def add_simple_cov
-          client.on "--[no-]simple_cov", "Add SimpleCov." do |value|
-            options[:build_simple_cov] = value
+        def add_zeitwerk
+          client.on(
+            "--[no-]zeitwerk",
+            "Add Zeitwerk gem. #{default __method__}."
+          ) do |value|
+            configuration.build_zeitwerk = value
           end
         end
+
+        def default option
+          option.to_s
+                .sub("add_", "build_")
+                .then { |attribute| configuration.public_send attribute }
+                .then { |boolean| boolean ? colorizer.green(boolean) : colorizer.red(boolean) }
+                .then { |colored_boolean| "Default: #{colored_boolean}" }
+        end
+
+        def configuration = container[__method__]
+
+        def colorizer = container[__method__]
       end
     end
   end

data/lib/rubysmith/cli/parsers/core.rb

@@ -1,17 +1,20 @@
 # frozen_string_literal: true
 
 require "rubysmith/identity"
+require "refinements/structs"
 
 module Rubysmith
   module CLI
     module Parsers
       # Handles parsing of Command Line Interface (CLI) core options.
       class Core
-        def self.call(options: {}, client: CLIENT) = new(options: options, client: client).call
+        using Refinements::Structs
 
-        def initialize options: {}, client: CLIENT
-          @options = options
+        def self.call(...) = new(...).call
+
+        def initialize client: CLIENT, container: Container
           @client = client
+          @container = container
         end
 
         def call arguments = []
@@ -23,7 +26,7 @@ module Rubysmith
 
         private
 
-        attr_reader :options, :client
+        attr_reader :client, :container
 
         def collate = private_methods.sort.grep(/add_/).each { |method| __send__ method }
 
@@ -32,27 +35,29 @@ module Rubysmith
                     "--config ACTION",
                     %i[edit view],
                     "Manage gem configuration: edit or view." do |action|
-            options[:config] = action
+            configuration.action_config = action
           end
         end
 
         def add_build
-          client.on "-b", "--build NAME [options]", "Build new project." do |value|
-            options[:build] = value
+          client.on "-b", "--build NAME [options]", "Build new project." do |name|
+            configuration.merge! action_build: true, project_name: name
           end
         end
 
         def add_version
           client.on "-v", "--version", "Show gem version." do
-            options[:version] = Identity::VERSION_LABEL
+            configuration.action_version = true
           end
         end
 
         def add_help
           client.on "-h", "--help", "Show this message." do
-            options[:help] = true
+            configuration.action_help = true
           end
         end
+
+        def configuration = container[__method__]
       end
     end
   end

data/lib/rubysmith/cli/shell.rb

@@ -1,56 +1,45 @@
 # frozen_string_literal: true
 
-require "refinements/hashes"
-
 module Rubysmith
   module CLI
     # The main Command Line Interface (CLI) object.
     class Shell
-      using Refinements::Hashes
-
-      PROCESSORS = {
-        config: Processors::Config.new,
-        build_minimum: Processors::Build.with_minimum,
-        build_maximum: Processors::Build.new
-      }.freeze
+      ACTIONS = {config: Actions::Config.new, build: Actions::Build.new}.freeze
 
-      def initialize parser: Parsers::Assembler.new, processors: PROCESSORS
+      def initialize parser: Parsers::Assembler.new, actions: ACTIONS, container: Container
         @parser = parser
-        @processors = processors
+        @actions = actions
+        @container = container
       end
 
       def call arguments = []
-        parse arguments
-
-        case options
-          in config: Symbol => action then process_config action
-          in build_minimum: true then process_build :build_minimum, options
-          in build: then process_build :build_maximum, options
-          in version: String => version then puts version
+        case parse arguments
+          in action_config: Symbol => action then config action
+          in action_build: true then build
+          in action_version: true then logger.info configuration.version
           else usage
         end
       end
 
       private
 
-      attr_reader :parser, :processors
+      attr_reader :parser, :actions, :container
 
       def parse arguments = []
         parser.call arguments
       rescue StandardError => error
-        puts error.message
+        logger.error error.message
       end
 
-      def process_config(action) = processors.fetch(:config).call(action)
+      def config(action) = actions.fetch(__method__).call(action)
 
-      def process_build kind, settings
-        processors.fetch(kind).call settings.transform_keys(build: :project_name)
-                                            .merge(now: Time.now)
-      end
+      def build = actions.fetch(__method__).call
+
+      def usage = logger.unknown(parser.to_s)
 
-      def options = parser.to_h
+      def configuration = container[__method__]
 
-      def usage = puts(parser.to_s)
+      def logger = container[__method__]
     end
   end
 end

data/lib/rubysmith/container.rb

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+require "dry-container"
+require "logger"
+require "pastel"
+
+module Rubysmith
+  # Provides a global gem container for injection into other objects.
+  module Container
+    extend Dry::Container::Mixin
+
+    register(:configuration, memoize: true) { CLI::Configuration::Loader.call }
+    register(:colorizer) { Pastel.new enabled: $stdout.tty? }
+    register(:kernel) { Kernel }
+
+    register :log_colors do
+      {
+        "DEBUG" => self[:colorizer].white.detach,
+        "INFO" => self[:colorizer].green.detach,
+        "WARN" => self[:colorizer].yellow.detach,
+        "ERROR" => self[:colorizer].red.detach,
+        "FATAL" => self[:colorizer].white.bold.on_red.detach,
+        "ANY" => self[:colorizer].white.bold.detach
+      }
+    end
+
+    register :logger do
+      Logger.new $stdout,
+                 level: Logger.const_get(ENV.fetch("LOG_LEVEL", "INFO")),
+                 formatter: (
+                   lambda do |severity, _at, _name, message|
+                     self[:log_colors][severity].call "#{message}\n"
+                   end
+                 )
+    end
+  end
+end

data/lib/rubysmith/identity.rb

@@ -4,8 +4,8 @@ module Rubysmith
   module Identity
     NAME = "rubysmith"
     LABEL = "Rubysmith"
-    VERSION = "0.11.0"
-    VERSION_LABEL = "#{LABEL} #{VERSION}"
+    VERSION = "0.15.0"
+    VERSION_LABEL = "#{LABEL} #{VERSION}".freeze
     SUMMARY = "A command line interface for smithing Ruby projects."
   end
 end

data/lib/rubysmith/renderers/erb.rb

@@ -21,7 +21,7 @@ module Rubysmith
       attr_accessor :buffer
       attr_reader :configuration, :scope, :client
 
-      def namespace = self.buffer = scope.call(yield)
+      def namespace = self.buffer = block_given? ? scope.call(yield) : buffer + scope.call
     end
   end
 end

data/lib/rubysmith/renderers/namespace.rb

@@ -14,7 +14,7 @@ module Rubysmith
         @depth = namespace.scan("::").length
       end
 
-      def call(content) = "#{prefix}#{body content}#{suffix.chomp}"
+      def call(content = nil) = "#{prefix}#{body content}#{suffix}"
 
       private
 
@@ -28,7 +28,7 @@ module Rubysmith
 
       # :reek:FeatureEnvy
       def body content
-        content.lstrip.split("\n").reduce "" do |snippet, line|
+        String(content).lstrip.split("\n").reduce "" do |snippet, line|
           next "#{snippet}\n" if line.blank?
 
           "#{snippet}#{line.gsub(/^\s{2}/, "").indent depth + 1}\n"

data/lib/rubysmith/templates/%project_name%/.circleci/config.yml.erb

@@ -0,0 +1,31 @@
+version: 2.1
+jobs:
+  build:
+    working_directory: ~/project
+    docker:
+      - image: bkuhlmann/alpine-ruby:latest
+    steps:
+      - checkout
+
+      - restore_cache:
+          name: Bundler Restore
+          keys:
+            - gem-cache-{{.Branch}}-{{checksum "Gemfile.lock"}}
+            - gem-cache-
+
+      - run:
+          name: Bundler Install
+          command: |
+            gem update --system
+            bundle config set path "vendor/bundle"
+            bundle install
+
+      - save_cache:
+          name: Bundler Store
+          key: gem-cache-{{.Branch}}-{{checksum "Gemfile.lock"}}
+          paths:
+            - vendor/bundle
+
+      - run:
+          name: Build
+          command: bundle exec rake

data/lib/rubysmith/templates/%project_name%/.github/ISSUE_TEMPLATE.md.erb

@@ -0,0 +1,14 @@
+## Overview
+<!-- Required. Describe, briefly, the behavior experienced. -->
+
+## Screenshots/Screencasts
+<!-- Optional. Attach screenshot(s) and/or screencast(s) that demo the behavior. -->
+
+## Steps to Recreate
+<!-- Required. List exact steps (numbered list) to reproduce errant behavior. -->
+
+## Desired Behavior
+<!-- Required. Describe the behavior you'd like to see or your idea of a proposed solution. -->
+
+## Environment
+<!-- Required. What is your operating system, software version(s), etc. -->

data/lib/rubysmith/templates/%project_name%/.github/PULL_REQUEST_TEMPLATE.md.erb

@@ -0,0 +1,11 @@
+## Overview
+<!-- Required. Why is this important/necessary and what is the overarching architecture. -->
+
+## Screenshots/Screencasts
+<!-- Optional. Provide supporting image/video. -->
+
+## Details
+<!-- Optional. List the key features/highlights as bullet points. -->
+
+## Notes
+<!-- Optional. List additional notes/references as bullet points. -->