gemsmith 15.5.0 → 17.0.0

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

@@ -0,0 +1,94 @@
+# frozen_string_literal: true
+
+require "pathname"
+require "refinements/structs"
+
+module Gemsmith
+  module CLI
+    module Parsers
+      # Handles parsing of Command Line Interface (CLI) core options.
+      class Core
+        using Refinements::Structs
+
+        def self.call(...) = new(...).call
+
+        def initialize configuration = Container[:configuration],
+                       client: Parser::CLIENT,
+                       container: Container
+          @configuration = configuration
+          @client = client
+          @container = container
+        end
+
+        def call arguments = []
+          client.banner = specification.labeled_summary
+          client.separator "\nUSAGE:\n"
+          collate
+          client.parse arguments
+          configuration
+        end
+
+        private
+
+        attr_reader :configuration, :client, :container
+
+        def collate = private_methods.sort.grep(/add_/).each { |method| __send__ method }
+
+        def add_config
+          client.on "-c",
+                    "--config ACTION",
+                    %i[edit view],
+                    "Manage gem configuration: edit or view." do |action|
+            configuration.merge! action_config: action
+          end
+        end
+
+        def add_build
+          client.on "-b", "--build NAME [options]", "Build new project." do |name|
+            configuration.merge! action_build: true, project_name: name
+          end
+        end
+
+        def add_edit
+          client.on "--edit GEM", "Edit installed gem in default editor." do |gem_name|
+            configuration.merge! action_edit: gem_name
+          end
+        end
+
+        def add_install
+          client.on "-i", "--install [NAME]", "Install gem for local development." do |name|
+            configuration.merge! action_install: true,
+                                 project_name: name || Pathname.pwd.basename.to_s
+          end
+        end
+
+        def add_publish
+          client.on "-p", "--publish [NAME]", "Publish gem to remote gem server." do |name|
+            configuration.merge! action_publish: true,
+                                 project_name: name || Pathname.pwd.basename.to_s
+          end
+        end
+
+        def add_view
+          client.on "--view GEM", "View installed gem in default browser." do |gem_name|
+            configuration.merge! action_view: gem_name
+          end
+        end
+
+        def add_version
+          client.on "-v", "--version", "Show gem version." do
+            configuration.merge! action_version: true
+          end
+        end
+
+        def add_help
+          client.on "-h", "--help", "Show this message." do
+            configuration.merge! action_help: true
+          end
+        end
+
+        def specification = container[__method__]
+      end
+    end
+  end
+end

data/lib/gemsmith/cli/shell.rb

@@ -0,0 +1,66 @@
+# frozen_string_literal: true
+
+module Gemsmith
+  module CLI
+    # The main Command Line Interface (CLI) object.
+    class Shell
+      ACTIONS = {
+        config: Actions::Config.new,
+        build: Actions::Build.new,
+        install: Actions::Install.new,
+        publish: Actions::Publish.new,
+        edit: Actions::Edit.new,
+        view: Actions::View.new
+      }.freeze
+
+      def initialize parser: Parser.new, actions: ACTIONS, container: Container
+        @parser = parser
+        @actions = actions
+        @container = container
+      end
+
+      def call arguments = []
+        perform parser.call(arguments)
+      rescue OptionParser::ParseError => error
+        logger.error { error.message }
+      end
+
+      private
+
+      attr_reader :parser, :actions, :container
+
+      def perform configuration
+        case configuration
+          in action_config: Symbol => action then config action
+          in action_build: true then build configuration
+          in action_install: true then install configuration
+          in action_publish: true then publish configuration
+          in action_edit: String => gem_name then edit gem_name
+          in action_view: String => gem_name then view gem_name
+          in action_version: true then logger.info { specification.labeled_version }
+          else usage
+        end
+      end
+
+      def config(action) = actions.fetch(__method__).call(action)
+
+      def build(configuration) = actions.fetch(__method__).call(configuration)
+
+      def install(configuration) = actions.fetch(__method__).call(configuration)
+
+      def publish(configuration) = actions.fetch(__method__).call(configuration)
+
+      def edit(gem_name) = actions.fetch(__method__).call(gem_name)
+
+      def view(gem_name) = actions.fetch(__method__).call(gem_name)
+
+      def usage = logger.unknown { parser.to_s }
+
+      def logger = container[__method__]
+
+      def specification = container[__method__]
+
+      def process = container[__method__]
+    end
+  end
+end

data/lib/gemsmith/configuration/enhancers/template_root.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module Gemsmith
+  module Configuration
+    module Enhancers
+      # Adds gem specific roots to existing content.
+      class TemplateRoot
+        def initialize overrides = Pathname(__dir__).join("../../templates")
+          @overrides = Array overrides
+        end
+
+        def call(content) = content.add_template_roots(overrides)
+
+        private
+
+        attr_reader :overrides
+      end
+    end
+  end
+end

data/lib/gemsmith/configuration/loader.rb

@@ -0,0 +1,50 @@
+# frozen_string_literal: true
+
+require "pathname"
+require "refinements/arrays"
+require "refinements/hashes"
+require "refinements/structs"
+require "runcom"
+require "yaml"
+
+module Gemsmith
+  module Configuration
+    # Represents the fully assembled Command Line Interface (CLI) configuration.
+    class Loader
+      using Refinements::Arrays
+      using Refinements::Hashes
+      using Refinements::Structs
+
+      DEFAULTS = Rubysmith::Configuration::Loader::DEFAULTS
+      CLIENT = Runcom::Config.new "gemsmith/configuration.yml", defaults: DEFAULTS
+
+      ENHANCERS = Rubysmith::Configuration::Loader::ENHANCERS.including(Enhancers::TemplateRoot.new)
+                                                             .freeze
+
+      def self.call(...) = new(...).call
+
+      def self.with_defaults = new(client: DEFAULTS, enhancers: [])
+
+      def self.with_overrides = new(client: DEFAULTS, enhancers: [Enhancers::TemplateRoot.new])
+
+      def initialize content: Rubysmith::Configuration::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/gemsmith/container.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+require "dry-container"
+require "open3"
+require "spek"
+
+module Gemsmith
+  # Provides a global gem container for injection into other objects.
+  module Container
+    extend Dry::Container::Mixin
+
+    config.registry = ->(container, key, value, _options) { container[key.to_s] = value }
+
+    merge Rubysmith::Container
+
+    register(:configuration) { Gemsmith::Configuration::Loader.call }
+    register(:specification) { Spek::Loader.call "#{__dir__}/../../gemsmith.gemspec" }
+    register(:environment) { ENV }
+    register(:executor) { Open3 }
+    register(:kernel) { Kernel }
+  end
+end

data/lib/gemsmith/templates/%project_name%/%project_name%.gemspec.erb

@@ -0,0 +1,50 @@
+Gem::Specification.new do |spec|
+  spec.name = "<%= configuration.project_name %>"
+  spec.version = "<%= configuration.project_version %>"
+  spec.authors = ["<%= configuration.author_name %>"]
+  spec.email = ["<%= configuration.author_email %>"]
+  spec.homepage = "<%= configuration.computed_project_url_home %>"
+  spec.summary = ""
+  spec.license = "<%= configuration.license_label_version %>"
+
+  spec.metadata = {
+    "bug_tracker_uri" => "<%= configuration.computed_project_url_issues %>",
+    "changelog_uri" => "<%= configuration.computed_project_url_versions %>",
+    "documentation_uri" => "<%= configuration.computed_project_url_home %>",
+    "label" => "<%= configuration.project_label %>",
+    "rubygems_mfa_required" => "true",
+    "source_code_uri" => "<%= configuration.computed_project_url_source %>"
+  }
+
+  <% if configuration.build_security %>
+    spec.signing_key = Gem.default_key_path
+    spec.cert_chain = [Gem.default_cert_path]
+  <% end %>
+
+  spec.required_ruby_version = "~> <%= RUBY_VERSION[/\d+\.\d+/] %>"
+  <% if configuration.build_cli %>
+    spec.add_dependency "dry-container", "~> 0.9"
+  <% end %>
+  <% if configuration.build_cli %>
+    spec.add_dependency "pastel", "~> 0.8"
+  <% end %>
+  <% if configuration.build_refinements %>
+    spec.add_dependency "refinements", "~> 9.2"
+  <% end %>
+  <% if configuration.build_cli %>
+    spec.add_dependency "runcom", "~> 8.2"
+  <% end %>
+  <% if configuration.build_cli %>
+    spec.add_dependency "spek", "~> 0.0"
+  <% end %>
+  <% if configuration.build_zeitwerk %>
+    spec.add_dependency "zeitwerk", "~> 2.5"
+  <% end %>
+
+  <% if configuration.build_cli %>
+    spec.bindir = "exe"
+    spec.executables << "<%= configuration.project_name %>"
+  <% end %>
+  spec.extra_rdoc_files = Dir["README*", "LICENSE*"]
+  spec.files = Dir["*.gemspec", "lib/**/*"]
+end

data/lib/gemsmith/templates/%project_name%/exe/%project_name%.erb

@@ -0,0 +1,5 @@
+#! /usr/bin/env ruby
+
+require "<%= configuration.project_name %>"
+
+<%= configuration.project_namespaced_class %>::CLI::Shell.new.call ARGV

data/lib/gemsmith/templates/%project_name%/lib/%project_path%/cli/actions/config.rb.erb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+<% namespace do %>
+  module CLI
+    module Actions
+      # Handles the config action.
+      class Config
+        def initialize client: Configuration::Loader::CLIENT, container: Container
+          @client = client
+          @container = container
+        end
+
+        def call selection
+          case selection
+            when :edit then edit
+            when :view then view
+            else logger.error { "Invalid configuration selection: #{selection}." }
+          end
+        end
+
+        private
+
+        attr_reader :client, :container
+
+        def edit = kernel.system("$EDITOR #{client.current}")
+
+        def view = kernel.system("cat #{client.current}")
+
+        def kernel = container[__method__]
+
+        def logger = container[__method__]
+      end
+    end
+  end
+<% end %>

data/lib/gemsmith/templates/%project_name%/lib/%project_path%/cli/parser.rb.erb

@@ -0,0 +1,31 @@
+require "optparse"
+
+<% namespace do %>
+  module CLI
+    # Assembles and parses all Command Line Interface (CLI) options.
+    class Parser
+      CLIENT = OptionParser.new nil, 40, "  "
+
+      # Order is important.
+      SECTIONS = [Parsers::Core].freeze
+
+      def initialize sections: SECTIONS, client: CLIENT, container: Container
+        @sections = sections
+        @client = client
+        @configuration = container[:configuration].dup
+      end
+
+      def call arguments = []
+        sections.each { |section| section.call configuration, client: }
+        client.parse arguments
+        configuration.freeze
+      end
+
+      def to_s = client.to_s
+
+      private
+
+      attr_reader :sections, :client, :configuration
+    end
+  end
+<% end %>

data/lib/gemsmith/templates/%project_name%/lib/%project_path%/cli/parsers/core.rb.erb

@@ -0,0 +1,59 @@
+require "refinements/structs"
+
+<% namespace do %>
+  module CLI
+    module Parsers
+      # Handles parsing of Command Line Interface (CLI) core options.
+      class Core
+        using Refinements::Structs
+
+        def self.call(...) = new(...).call
+
+        def initialize configuration = Container[:configuration],
+                       client: Parser::CLIENT,
+                       container: Container
+          @configuration = configuration
+          @client = client
+          @container = container
+        end
+
+        def call arguments = []
+          client.banner = specification.labeled_summary
+          client.separator "\nUSAGE:\n"
+          collate
+          client.parse arguments
+          configuration
+        end
+
+        private
+
+        attr_reader :configuration, :client, :container
+
+        def collate = private_methods.sort.grep(/add_/).each { |method| __send__ method }
+
+        def add_config
+          client.on "-c",
+                    "--config ACTION",
+                    %i[edit view],
+                    "Manage gem configuration: edit or view." do |action|
+            configuration.merge! action_config: action
+          end
+        end
+
+        def add_version
+          client.on "-v", "--version", "Show gem version." do
+            configuration.merge! action_version: true
+          end
+        end
+
+        def add_help
+          client.on "-h", "--help", "Show this message." do
+            configuration.merge! action_help: true
+          end
+        end
+
+        def specification = container[__method__]
+      end
+    end
+  end
+<% end %>

data/lib/gemsmith/templates/%project_name%/lib/%project_path%/cli/shell.rb.erb

@@ -0,0 +1,40 @@
+<% namespace do %>
+  module CLI
+    # The main Command Line Interface (CLI) object.
+    class Shell
+      ACTIONS = {config: Actions::Config.new}.freeze
+
+      def initialize parser: Parser.new, actions: ACTIONS, container: Container
+        @parser = parser
+        @actions = actions
+        @container = container
+      end
+
+      def call arguments = []
+        perform parser.call(arguments)
+      rescue OptionParser::ParseError => error
+        logger.error { error.message }
+      end
+
+      private
+
+      attr_reader :parser, :actions, :container
+
+      def perform configuration
+        case configuration
+          in action_config: Symbol => action then config action
+          in action_version: true then logger.info { specification.labeled_version }
+          else usage
+        end
+      end
+
+      def config(action) = actions.fetch(__method__).call(action)
+
+      def usage = logger.unknown { parser.to_s }
+
+      def specification = container[__method__]
+
+      def logger = container[__method__]
+    end
+  end
+<% end %>

data/lib/gemsmith/templates/%project_name%/lib/%project_path%/configuration/content.rb.erb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+<% namespace do %>
+  module Configuration
+    # Defines the content of the configuration for use throughout the gem.
+    Content = Struct.new(
+      :action_config,
+      :action_help,
+      :action_version,
+      keyword_init: true
+    ) do
+      def initialize *arguments
+        super
+        freeze
+      end
+    end
+  end
+<% end %>

data/lib/gemsmith/templates/%project_name%/lib/%project_path%/configuration/loader.rb.erb

@@ -0,0 +1,33 @@
+require "pathname"
+require "refinements/hashes"
+require "refinements/structs"
+require "runcom"
+require "yaml"
+
+<% namespace do %>
+  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 "<%= configuration.project_name %>/configuration.yml", defaults: DEFAULTS
+
+      def self.call = new.call
+
+      def self.with_defaults = new client: DEFAULTS
+
+      def initialize content: Content.new, client: CLIENT
+        @content = content
+        @client = client
+      end
+
+      def call = content.merge(**client.to_h.flatten_keys).freeze
+
+      private
+
+      attr_reader :content, :client
+    end
+  end
+<% end %>

data/lib/gemsmith/templates/%project_name%/lib/%project_path%/container.rb.erb

@@ -0,0 +1,37 @@
+require "dry-container"
+require "logger"
+require "pastel"
+require "spek"
+
+<% namespace do %>
+  # Provides a global gem container for injection into other objects.
+  module Container
+    extend Dry::Container::Mixin
+
+    register(:configuration) { Configuration::Loader.call }
+    register(:specification) { Spek::Loader.call "#{__dir__}/<%= Array.new(2 + configuration.project_levels, "../").join %><%= configuration.project_name %>.gemspec" }
+    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/gemsmith/templates/{%gem_name%/lib/%gem_path%/identity.rb.tt → %project_name%/lib/%project_path%/identity.rb.erb}

@@ -4,6 +4,6 @@
     NAME = "<%= config.dig(:gem, :name) %>"
     LABEL = "<%= config.dig(:gem, :label) %>"
     VERSION = "0.1.0"
-    VERSION_LABEL = "#{LABEL} #{VERSION}"
+    VERSION_LABEL = "#{LABEL} #{VERSION}".freeze
   end
 <% end %>

data/lib/gemsmith/templates/%project_name%/spec/lib/%project_path%/cli/actions/config_spec.rb.erb

@@ -0,0 +1,24 @@
+require "spec_helper"
+
+RSpec.describe <%= configuration.project_namespaced_class %>::CLI::Actions::Config do
+  subject(:action) { described_class.new }
+
+  include_context "with application container"
+
+  describe "#call" do
+    it "edits configuration" do
+      action.call :edit
+      expect(kernel).to have_received(:system).with(include("EDITOR"))
+    end
+
+    it "views configuration" do
+      action.call :view
+      expect(kernel).to have_received(:system).with(include("cat"))
+    end
+
+    it "logs invalid configuration" do
+      expectation = proc { action.call :bogus }
+      expect(&expectation).to output(/Invalid configuration selection: bogus./).to_stdout
+    end
+  end
+end

data/lib/gemsmith/templates/%project_name%/spec/lib/%project_path%/cli/parser_spec.rb.erb

@@ -0,0 +1,25 @@
+require "spec_helper"
+
+RSpec.describe <%= configuration.project_namespaced_class %>::CLI::Parser do
+  subject(:parser) { described_class.new }
+
+  include_context "with application container"
+
+  describe "#call" do
+    it "answers hash with valid option" do
+      expect(parser.call(%w[--help])).to have_attributes(action_help: true)
+    end
+
+    it "fails with invalid option" do
+      expectation = proc { parser.call %w[--bogus] }
+      expect(&expectation).to raise_error(OptionParser::InvalidOption, /--bogus/)
+    end
+  end
+
+  describe "#to_s" do
+    it "answers usage" do
+      parser.call
+      expect(parser.to_s).to match(/.+USAGE.+/m)
+    end
+  end
+end