rubysmith 0.12.0 → 0.16.0

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,7 +4,7 @@ module Rubysmith
   module Identity
     NAME = "rubysmith"
     LABEL = "Rubysmith"
-    VERSION = "0.12.0"
+    VERSION = "0.16.0"
     VERSION_LABEL = "#{LABEL} #{VERSION}".freeze
     SUMMARY = "A command line interface for smithing Ruby projects."
   end

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,8 @@
+## 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. -->

data/lib/rubysmith/templates/%project_name%/Gemfile.erb

@@ -2,59 +2,59 @@ ruby File.read(".ruby-version").strip
 
 source "https://rubygems.org"
 
-<% unless configuration.build_minimum %>
-  <% if configuration.build_refinements %>
-    gem "refinements", "~> 8.0"
+<% if configuration.build_refinements %>
+  gem "refinements", "~> 8.5"
+<% end %>
+<% if configuration.build_zeitwerk %>
+  gem "zeitwerk", "~> 2.5"
+<% end %>
+
+group :code_quality do
+  <% if configuration.build_bundler_leak %>
+    gem "bundler-leak", "~> 0.2"
   <% end %>
-  <% if configuration.build_zeitwerk %>
-    gem "zeitwerk", "~> 2.4"
+  <% if configuration.build_git && configuration.build_git_lint %>
+    gem "git-lint", "~> 2.0"
   <% end %>
+  <% if configuration.build_reek %>
+    gem "reek", "~> 6.0"
+  <% end %>
+  <% if configuration.build_rubocop %>
+    gem "rubocop", "~> 1.20"
+    gem "rubocop-performance", "~> 1.11"
+    gem "rubocop-rake", "~> 0.6"
+  <% end %>
+  <% if configuration.build_rspec && configuration.build_rubocop %>
+    gem "rubocop-rspec", "~> 2.4"
+  <% end %>
+  <% if configuration.build_simple_cov %>
+    gem "simplecov", "~> 0.20"
+  <% end %>
+end
 
-  group :code_quality do
-    <% if configuration.build_bundler_leak %>
-      gem "bundler-leak", "~> 0.2"
-    <% end %>
-    <% if configuration.build_git && configuration.build_git_lint %>
-      gem "git-lint", "~> 2.0"
-    <% end %>
-    <% if configuration.build_reek %>
-      gem "reek", "~> 6.0"
-    <% end %>
-    <% if configuration.build_rubocop %>
-      gem "rubocop", "~> 1.20"
-      gem "rubocop-performance", "~> 1.11"
-      gem "rubocop-rake", "~> 0.6"
-    <% end %>
-    <% if configuration.build_rspec && configuration.build_rubocop %>
-      gem "rubocop-rspec", "~> 2.4"
-    <% end %>
-    <% if configuration.build_simple_cov %>
-      gem "simplecov", "~> 0.20"
-    <% end %>
-  end
-
+group :development do
   <% if configuration.build_rake %>
-    group :development do
-      gem "rake", "~> 13.0"
-    end
+    gem "rake", "~> 13.0"
+  <% end %>
+  <% if configuration.markdown? %>
+    gem "tocer", "~> 12.1"
   <% end %>
+end
 
-  group :test do
-    <% if configuration.build_guard %>
-      gem "guard-rspec", "~> 4.7", require: false
-    <% end %>
-    <% if configuration.build_rspec %>
-      gem "rspec", "~> 3.10"
-    <% end %>
-  end
+group :test do
+  <% if configuration.build_guard %>
+    gem "guard-rspec", "~> 4.7", require: false
+  <% end %>
+  <% if configuration.build_rspec %>
+    gem "rspec", "~> 3.10"
+  <% end %>
+end
 
-  group :tools do
-    <% if configuration.build_amazing_print %>
-      gem "amazing_print", "~> 1.3"
-    <% end %>
-    <% if configuration.build_pry %>
-      gem "pry", "~> 0.13"
-      gem "pry-byebug", "~> 3.9"
-    <% end %>
-  end
-<% end %>
+group :tools do
+  <% if configuration.build_amazing_print %>
+    gem "amazing_print", "~> 1.3"
+  <% end %>
+  <% if configuration.build_debug %>
+    gem "debug", "~> 1.1"
+  <% end %>
+end

data/lib/rubysmith/templates/%project_name%/README.adoc.erb

@@ -8,6 +8,10 @@
 [link=https://www.alchemists.io/projects/code_quality]
 image::https://img.shields.io/badge/code_style-alchemists-brightgreen.svg[Alchemists Style Guide]
 <% end %>
+<% if configuration.build_circle_ci %>
+[link=https://circleci.com/gh/<%= configuration.git_hub_user %>/<%= configuration.project_name %>]
+image::https://circleci.com/gh/<%= configuration.git_hub_user %>/<%= configuration.project_name %>.svg?style=svg[Circle CI Status]
+<% end %>
 
 toc::[]
 

data/lib/rubysmith/templates/%project_name%/README.md.erb

@@ -3,6 +3,9 @@
 <% if configuration.build_rubocop %>
 [![Alchemists Style Guide](https://img.shields.io/badge/code_style-alchemists-brightgreen.svg)](https://www.alchemists.io/projects/code_quality)
 <% end %>
+<% if configuration.build_circle_ci %>
+[![Circle CI Status](https://circleci.com/gh/<%= configuration.git_hub_user %>/<%= configuration.project_name %>.svg?style=svg)](https://circleci.com/gh/<%= configuration.git_hub_user %>/<%= configuration.project_name %>)
+<% end %>
 
 <!-- Tocer[start]: Auto-generated, don't remove. -->
 <!-- Tocer[finish]: Auto-generated, don't remove. -->

data/lib/rubysmith/templates/%project_name%/lib/%project_path%.rb.erb

@@ -1,12 +1,11 @@
 <% if configuration.build_zeitwerk %>
   require "zeitwerk"
   <% if configuration.project_path.include? "/" %>
-    loader = Zeitwerk::Loader.new
-    loader.push_dir "#{__dir__}/.."
-    loader.setup
+    Zeitwerk::Loader.new
+                    .tap { |loader| loader.push_dir "#{__dir__}/.." }
+                    .setup
   <% else %>
-    loader = Zeitwerk::Loader.for_gem
-    loader.setup
+    Zeitwerk::Loader.for_gem.setup
   <% end %>
 <% end %>
 # Main namespace.

data/lib/rubysmith/templates/%project_name%/spec/spec_helper.rb.erb

@@ -11,9 +11,6 @@ require "<%= configuration.project_path %>"
   require "refinements"
 <% end %>
 
-GC.auto_compact = true
-GC.verify_compaction_references double_heap: true, toward: :empty
-
 <% if configuration.build_refinements %>
   using Refinements::Pathnames
 

data/lib/rubysmith.rb

@@ -2,9 +2,13 @@
 
 require "zeitwerk"
 
-loader = Zeitwerk::Loader.for_gem
-loader.inflector.inflect "cli" => "CLI", "erb" => "ERB", "rspec" => "RSpec"
-loader.setup
+Zeitwerk::Loader.for_gem.then do |loader|
+  loader.inflector.inflect "cli" => "CLI",
+                           "circle_ci" => "CircleCI",
+                           "erb" => "ERB",
+                           "rspec" => "RSpec"
+  loader.setup
+end
 
 # Main namespace.
 module Rubysmith

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rubysmith
 version: !ruby/object:Gem::Version
-  version: 0.12.0
+  version: 0.16.0
 platform: ruby
 authors:
 - Brooke Kuhlmann
@@ -28,8 +28,50 @@ cert_chain:
   lkHilIrX69jq8wMPpBhlaw2mRmeSL50Wv5u6xVBvOHhXFSP1crXM95vfLhLyRYod
   W2A=
   -----END CERTIFICATE-----
-date: 2021-09-06 00:00:00.000000000 Z
+date: 2021-10-21 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: dry-container
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+- !ruby/object:Gem::Dependency
+  name: git_plus
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.6'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.6'
+- !ruby/object:Gem::Dependency
+  name: pastel
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.8'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.8'
 - !ruby/object:Gem::Dependency
   name: pragmater
   requirement: !ruby/object:Gem::Requirement
@@ -50,14 +92,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '8.0'
+        version: '8.5'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '8.0'
+        version: '8.5'
 - !ruby/object:Gem::Dependency
   name: rubocop
   requirement: !ruby/object:Gem::Requirement
@@ -86,20 +128,34 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '7.0'
+- !ruby/object:Gem::Dependency
+  name: tocer
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.1'
 - !ruby/object:Gem::Dependency
   name: zeitwerk
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.4'
+        version: '2.5'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.4'
+        version: '2.5'
 description:
 email:
 - brooke@alchemists.io
@@ -116,11 +172,17 @@ files:
 - lib/rubysmith.rb
 - lib/rubysmith/builder.rb
 - lib/rubysmith/builders/bundler.rb
+- lib/rubysmith/builders/circle_ci.rb
 - lib/rubysmith/builders/console.rb
 - lib/rubysmith/builders/core.rb
-- lib/rubysmith/builders/documentation.rb
+- lib/rubysmith/builders/documentation/change.rb
+- lib/rubysmith/builders/documentation/conduct.rb
+- lib/rubysmith/builders/documentation/contribution.rb
+- lib/rubysmith/builders/documentation/license.rb
+- lib/rubysmith/builders/documentation/readme.rb
 - lib/rubysmith/builders/git/commit.rb
 - lib/rubysmith/builders/git/setup.rb
+- lib/rubysmith/builders/git_hub.rb
 - lib/rubysmith/builders/guard.rb
 - lib/rubysmith/builders/pragma.rb
 - lib/rubysmith/builders/rake.rb
@@ -130,20 +192,27 @@ files:
 - lib/rubysmith/builders/rubocop/formatter.rb
 - lib/rubysmith/builders/rubocop/setup.rb
 - lib/rubysmith/builders/setup.rb
+- lib/rubysmith/cli/actions/build.rb
+- lib/rubysmith/cli/actions/config.rb
 - lib/rubysmith/cli/configuration/content.rb
 - lib/rubysmith/cli/configuration/defaults.yml
+- lib/rubysmith/cli/configuration/enhancers/current_time.rb
+- lib/rubysmith/cli/configuration/enhancers/git_hub_user.rb
+- lib/rubysmith/cli/configuration/enhancers/version.rb
 - lib/rubysmith/cli/configuration/loader.rb
 - lib/rubysmith/cli/parsers.rb
 - lib/rubysmith/cli/parsers/assembler.rb
 - lib/rubysmith/cli/parsers/build.rb
 - lib/rubysmith/cli/parsers/core.rb
-- lib/rubysmith/cli/processors/build.rb
-- lib/rubysmith/cli/processors/config.rb
 - lib/rubysmith/cli/shell.rb
+- lib/rubysmith/container.rb
 - lib/rubysmith/identity.rb
 - lib/rubysmith/pathway.rb
 - lib/rubysmith/renderers/erb.rb
 - lib/rubysmith/renderers/namespace.rb
+- lib/rubysmith/templates/%project_name%/.circleci/config.yml.erb
+- lib/rubysmith/templates/%project_name%/.github/ISSUE_TEMPLATE.md.erb
+- lib/rubysmith/templates/%project_name%/.github/PULL_REQUEST_TEMPLATE.md.erb
 - lib/rubysmith/templates/%project_name%/.reek.yml.erb
 - lib/rubysmith/templates/%project_name%/.rubocop.yml.erb
 - lib/rubysmith/templates/%project_name%/.ruby-version.erb
@@ -193,7 +262,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.27
+rubygems_version: 3.2.29
 signing_key:
 specification_version: 4
 summary: A command line interface for smithing Ruby projects.

data/lib/rubysmith/builders/documentation.rb

@@ -1,57 +0,0 @@
-# frozen_string_literal: true
-
-module Rubysmith
-  module Builders
-    # Builds project skeleton documentation.
-    class Documentation
-      def self.call(...) = new(...).call
-
-      def initialize configuration, builder: Builder
-        @configuration = configuration
-        @builder = builder
-      end
-
-      def call
-        return unless configuration.build_documentation
-
-        private_methods.sort.grep(/render_/).each { |method| __send__ method }
-      end
-
-      private
-
-      attr_reader :configuration, :builder
-
-      def render_changes
-        builder.call(configuration.with(template_path: "%project_name%/CHANGES.#{kind}.erb"))
-               .render
-      end
-
-      def render_conduct
-        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(configuration.with(template_path: "%project_name%/CONTRIBUTING.#{kind}.erb"))
-               .render
-      end
-
-      def render_license
-        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(configuration.with(template_path: "%project_name%/README.#{kind}.erb"))
-               .render
-               .replace("\n\n\n", "\n\n")
-      end
-
-      def kind = configuration.documentation_format || "md"
-
-      def license = configuration.documentation_license || "mit"
-    end
-  end
-end

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

@@ -1,56 +0,0 @@
-# frozen_string_literal: true
-
-require "refinements/structs"
-
-module Rubysmith
-  module CLI
-    module Processors
-      # Handles the Command Line Interface (CLI) for building of a project skeleton.
-      class Build
-        using Refinements::Structs
-
-        # Order is important.
-        MINIMUM = [
-          Builders::Core,
-          Builders::Bundler,
-          Builders::Pragma,
-          Builders::Rubocop::Formatter
-        ].freeze
-
-        # Order is important.
-        MAXIMUM = [
-          Builders::Core,
-          Builders::Documentation,
-          Builders::Git::Setup,
-          Builders::Bundler,
-          Builders::Rake,
-          Builders::Console,
-          Builders::Setup,
-          Builders::Guard,
-          Builders::Reek,
-          Builders::RSpec::Context,
-          Builders::RSpec::Helper,
-          Builders::Pragma,
-          Builders::Rubocop::Setup,
-          Builders::Rubocop::Formatter,
-          Builders::Git::Commit
-        ].freeze
-
-        def self.with_minimum = new(builders: MINIMUM)
-
-        def initialize configuration: Configuration::Loader.call, builders: MAXIMUM
-          @configuration = configuration
-          @builders = builders
-        end
-
-        def call(options) = configuration.merge(**options).then { |config| process config }
-
-        private
-
-        attr_reader :configuration, :builders
-
-        def process(config) = builders.each { |builder| builder.call config }
-      end
-    end
-  end
-end

data/lib/rubysmith/cli/processors/config.rb

@@ -1,31 +0,0 @@
-# frozen_string_literal: true
-
-module Rubysmith
-  module CLI
-    module Processors
-      # Handles the Command Line Interface (CLI) configuration processing.
-      class Config
-        def initialize configuration: CLI::Configuration::Loader::CLIENT, kernel: Kernel
-          @configuration = configuration
-          @kernel = kernel
-        end
-
-        def call action
-          case action
-            when :edit then edit
-            when :view then view
-            else fail StandardError, "Invalid configuration action: #{action}."
-          end
-        end
-
-        private
-
-        attr_reader :configuration, :kernel
-
-        def edit = kernel.system("$EDITOR #{configuration.current}")
-
-        def view = kernel.system("cat #{configuration.current}")
-      end
-    end
-  end
-end