rubysmith 0.16.1 → 1.0.0

data/lib/rubysmith/configuration/enhancers/current_time.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+require "refinements/structs"
+
+module Rubysmith
+  module Configuration
+    module Enhancers
+      # Adds current time to content.
+      class CurrentTime
+        using Refinements::Structs
+
+        def initialize now = Time.now
+          @now = now
+        end
+
+        def call(content) = content.merge(now:)
+
+        private
+
+        attr_reader :now
+      end
+    end
+  end
+end

data/lib/rubysmith/configuration/enhancers/git_email.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+require "git_plus"
+require "refinements/strings"
+require "refinements/structs"
+
+module Rubysmith
+  module Configuration
+    module Enhancers
+      # Dynamically adds Git email if defined.
+      class GitEmail
+        using Refinements::Strings
+        using Refinements::Structs
+
+        def initialize repository: GitPlus::Repository.new
+          @repository = repository
+        end
+
+        def call content
+          String(content.author_email).blank? ? content.merge(author_email: email) : content
+        end
+
+        private
+
+        attr_reader :repository
+
+        def email = repository.config_get("user.email")
+      end
+    end
+  end
+end

data/lib/rubysmith/configuration/enhancers/git_hub_user.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+require "git_plus"
+require "refinements/strings"
+require "refinements/structs"
+
+module Rubysmith
+  module Configuration
+    module Enhancers
+      # Dynamically adds GitHub user if user is defined.
+      class GitHubUser
+        using Refinements::Strings
+        using Refinements::Structs
+
+        def initialize repository: GitPlus::Repository.new
+          @repository = repository
+        end
+
+        def call content
+          String(content.git_hub_user).blank? ? content.merge(git_hub_user: user) : content
+        end
+
+        private
+
+        attr_reader :repository
+
+        def user = repository.config_get("github.user")
+      end
+    end
+  end
+end

data/lib/rubysmith/configuration/enhancers/git_user.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+require "git_plus"
+require "refinements/strings"
+require "refinements/structs"
+
+module Rubysmith
+  module Configuration
+    module Enhancers
+      # Dynamically adds Git user if defined.
+      class GitUser
+        using Refinements::Strings
+        using Refinements::Structs
+
+        def initialize repository: GitPlus::Repository.new
+          @repository = repository
+        end
+
+        def call(content) = String(content.author_name).blank? ? content.merge(**user) : content
+
+        private
+
+        attr_reader :repository
+
+        def user
+          repository.config_get("user.name")
+                    .then { |name| String(name).split }
+                    .then { |first, last| {author_given_name: first, author_family_name: last} }
+        end
+      end
+    end
+  end
+end

data/lib/rubysmith/configuration/loader.rb

@@ -0,0 +1,48 @@
+# frozen_string_literal: true
+
+require "pathname"
+require "refinements/hashes"
+require "refinements/structs"
+require "runcom"
+require "yaml"
+
+module Rubysmith
+  module Configuration
+    # Represents the fully assembled Command Line Interface (CLI) configuration.
+    class Loader
+      using Refinements::Hashes
+      using Refinements::Structs
+
+      DEFAULTS = YAML.load_file(Pathname(__dir__).join("defaults.yml")).freeze
+      CLIENT = Runcom::Config.new "#{Identity::NAME}/configuration.yml", defaults: DEFAULTS
+
+      ENHANCERS = [
+        Enhancers::CurrentTime.new,
+        Enhancers::GitEmail.new,
+        Enhancers::GitHubUser.new,
+        Enhancers::GitUser.new
+      ].freeze
+
+      def self.call(...) = new(...).call
+
+      def self.with_defaults = new(client: DEFAULTS, enhancers: [])
+
+      def initialize content: Content.new, client: CLIENT, enhancers: ENHANCERS
+        @content = content
+        @client = client
+        @enhancers = enhancers
+      end
+
+      def call
+        enhancers.reduce(preload_content) { |preload, enhancer| enhancer.call preload }
+                 .freeze
+      end
+
+      private
+
+      attr_reader :content, :client, :enhancers
+
+      def preload_content = content.merge(**client.to_h.flatten_keys)
+    end
+  end
+end

data/lib/rubysmith/container.rb

@@ -9,7 +9,7 @@ module Rubysmith
   module Container
     extend Dry::Container::Mixin
 
-    register(:configuration, memoize: true) { CLI::Configuration::Loader.call }
+    register(:configuration) { Configuration::Loader.call }
     register(:colorizer) { Pastel.new enabled: $stdout.tty? }
     register(:kernel) { Kernel }
 

data/lib/rubysmith/extensions/bundler.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+require "bundler"
+require "bundler/cli"
+require "refinements/pathnames"
+
+module Rubysmith
+  module Extensions
+    # Ensures gem dependencies are installed.
+    class Bundler
+      using Refinements::Pathnames
+
+      def self.call(...) = new(...).call
+
+      def initialize configuration, client: ::Bundler::CLI
+        @configuration = configuration
+        @client = client
+      end
+
+      def call
+        configuration.project_root.change_dir { client.start %w[install --quiet] }
+        configuration
+      end
+
+      private
+
+      attr_reader :configuration, :client
+    end
+  end
+end

data/lib/rubysmith/extensions/milestoner.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+require "milestoner"
+
+module Rubysmith
+  module Extensions
+    # Ensures project can be published (tagged) in a reliable and consistent fashion.
+    class Milestoner
+      def self.call(...) = new(...).call
+
+      def initialize configuration,
+                     client: ::Milestoner::Tags::Publisher.new,
+                     content: ::Milestoner::Configuration::Content
+        @configuration = configuration
+        @client = client
+        @content = content
+      end
+
+      def call = client.call(settings) && configuration
+
+      private
+
+      attr_reader :configuration, :client, :content
+
+      def settings
+        content[
+          documentation_format: configuration.extensions_milestoner_documentation_format,
+          prefixes: configuration.extensions_milestoner_prefixes,
+          sign: configuration.extensions_milestoner_sign,
+          version: configuration.project_version
+        ]
+      end
+    end
+  end
+end

data/lib/rubysmith/extensions/pragmater.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+require "pragmater"
+
+module Rubysmith
+  module Extensions
+    # Ensures project skeleton has pragmas.
+    class Pragmater
+      def self.call(...) = new(...).call
+
+      def initialize configuration,
+                     client: ::Pragmater::Runner.new,
+                     content: ::Pragmater::Configuration::Content
+        @configuration = configuration
+        @client = client
+        @content = content
+      end
+
+      def call = client.call(settings) && configuration
+
+      private
+
+      attr_reader :configuration, :client, :content
+
+      def settings
+        content[
+          action_insert: true,
+          comments: configuration.extensions_pragmater_comments,
+          includes: configuration.extensions_pragmater_includes,
+          root_dir: configuration.project_root
+        ]
+      end
+    end
+  end
+end

data/lib/rubysmith/extensions/rubocop.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+require "rubocop"
+require "refinements/ios"
+
+module Rubysmith
+  module Extensions
+    # Ensures project skeleton adheres to style guide.
+    class Rubocop
+      using Refinements::IOs
+
+      def self.call(...) = new(...).call
+
+      def initialize configuration, client: ::RuboCop::CLI.new
+        @configuration = configuration
+        @client = client
+      end
+
+      def call
+        STDOUT.squelch { client.run ["--auto-correct", configuration.project_root.to_s] }
+        configuration
+      end
+
+      private
+
+      attr_reader :configuration, :client
+    end
+  end
+end

data/lib/rubysmith/extensions/tocer.rb

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+require "tocer"
+
+module Rubysmith
+  module Extensions
+    # Ensures project skeleton documentation has table of contents.
+    class Tocer
+      def self.call(...) = new(...).call
+
+      def initialize configuration,
+                     client: ::Tocer::Runner.new,
+                     content: ::Tocer::Configuration::Content
+        @configuration = configuration
+        @client = client
+        @content = content
+      end
+
+      def call
+        client.call(settings) if configuration.build_readme
+        configuration
+      end
+
+      private
+
+      attr_reader :configuration, :client, :content
+
+      def settings
+        content[
+          includes: configuration.extensions_tocer_includes,
+          label: configuration.extensions_tocer_label,
+          root_dir: configuration.project_root
+        ]
+      end
+    end
+  end
+end

data/lib/rubysmith/identity.rb

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

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

@@ -1,5 +1,5 @@
 ## Overview
-<!-- Required. Describe, briefly, the behavior experienced. -->
+<!-- Required. Describe, briefly, the behavior experienced and desired. -->
 
 ## Screenshots/Screencasts
 <!-- Optional. Attach screenshot(s) and/or screencast(s) that demo the behavior. -->
@@ -7,8 +7,5 @@
 ## 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%/.rubocop.yml.erb

@@ -1,6 +1,8 @@
 inherit_from:
   - https://raw.githubusercontent.com/bkuhlmann/code_quality/main/configurations/rubocop/ruby.yml
+<% if configuration.build_rake %>
   - https://raw.githubusercontent.com/bkuhlmann/code_quality/main/configurations/rubocop/rake.yml
+<% end %>
   - https://raw.githubusercontent.com/bkuhlmann/code_quality/main/configurations/rubocop/performance.yml
 <% if configuration.build_rspec %>
   - https://raw.githubusercontent.com/bkuhlmann/code_quality/main/configurations/rubocop/rspec.yml

data/lib/rubysmith/templates/%project_name%/CITATION.cff.erb

@@ -0,0 +1,16 @@
+cff-version: 1.2.0
+message: <%= configuration.citation_message %>
+title: <%= configuration.project_label %>
+abstract:
+version: <%= configuration.project_version %>
+license: <%= configuration.license_label_version %>
+date-released: <%= configuration.now.strftime "%Y-%m-%d" %>
+authors:
+  - family-names: <%= configuration.author_family_name %>
+    given-names: <%= configuration.author_given_name %>
+    affiliation: <%= configuration.citation_affiliation %>
+    orcid: https://orcid.org/<%= configuration.citation_orcid %>
+keywords:
+ - ruby
+repository-code: <%= configuration.computed_project_url_source %>
+repository-artifact: <%= configuration.computed_project_url_download %>

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

@@ -3,7 +3,7 @@ ruby File.read(".ruby-version").strip
 source "https://rubygems.org"
 
 <% if configuration.build_refinements %>
-  gem "refinements", "~> 8.5"
+  gem "refinements", "~> 9.0"
 <% end %>
 <% if configuration.build_zeitwerk %>
   gem "zeitwerk", "~> 2.5"
@@ -13,22 +13,25 @@ group :code_quality do
   <% if configuration.build_bundler_leak %>
     gem "bundler-leak", "~> 0.2"
   <% end %>
+  <% if configuration.build_dead_end %>
+    gem "dead_end", "~> 3.0"
+  <% end %>
   <% if configuration.build_git && configuration.build_git_lint %>
-    gem "git-lint", "~> 2.0"
+    gem "git-lint", "~> 3.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", "~> 1.24"
+    gem "rubocop-performance", "~> 1.12"
     gem "rubocop-rake", "~> 0.6"
   <% end %>
   <% if configuration.build_rspec && configuration.build_rubocop %>
-    gem "rubocop-rspec", "~> 2.4"
+    gem "rubocop-rspec", "~> 2.6"
   <% end %>
   <% if configuration.build_simple_cov %>
-    gem "simplecov", "~> 0.20"
+    gem "simplecov", "~> 0.21"
   <% end %>
 end
 
@@ -37,7 +40,7 @@ group :development do
     gem "rake", "~> 13.0"
   <% end %>
   <% if configuration.markdown? %>
-    gem "tocer", "~> 12.1"
+    gem "tocer", "~> 13.0"
   <% end %>
 end
 
@@ -52,9 +55,9 @@ end
 
 group :tools do
   <% if configuration.build_amazing_print %>
-    gem "amazing_print", "~> 1.3"
+    gem "amazing_print", "~> 1.4"
   <% end %>
   <% if configuration.build_debug %>
-    gem "debug", "~> 1.1"
+    gem "debug", "~> 1.4"
   <% end %>
 end