gemsmith 15.5.0 → 16.0.0

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,21 @@
+# frozen_string_literal: true
+
+require "dry-container"
+require "open3"
+
+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) { Gemsmith::Gems::Loader.call "#{__dir__}/../../gemsmith.gemspec" }
+    register(:environment) { ENV }
+    register(:executor) { Open3 }
+    register(:kernel) { Kernel }
+  end
+end

data/lib/gemsmith/gems/finder.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module Gemsmith
+  module Gems
+    # Finds multiple versions of an installed gem (if any) and answers found specifications.
+    class Finder
+      def self.call(path, ...) = new(...).call path
+
+      def initialize client: ::Gem::Specification, presenter: Gems::Presenter
+        @client = client
+        @presenter = presenter
+      end
+
+      def call(name) = client.find_all_by_name(name).map { |record| presenter.new record }
+
+      private
+
+      attr_reader :client, :presenter
+    end
+  end
+end

data/lib/gemsmith/gems/loader.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module Gemsmith
+  module Gems
+    # Loads a gem's specification.
+    class Loader
+      def self.call(path, ...) = new(...).call path
+
+      def initialize client: ::Gem::Specification, presenter: Gems::Presenter
+        @client = client
+        @presenter = presenter
+      end
+
+      def call(path) = client.load(path.to_s).then { |record| presenter.new record }
+
+      private
+
+      attr_reader :client, :presenter
+    end
+  end
+end

data/lib/gemsmith/gems/picker.rb

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+
+require "dry/monads"
+
+module Gemsmith
+  module Gems
+    # Picks a gem specification.
+    class Picker
+      include Dry::Monads[:result]
+
+      def self.call(name, ...) = new(...).call name
+
+      def initialize finder: Finder.new, kernel: Kernel
+        @finder = finder
+        @kernel = kernel
+      end
+
+      def call name
+        specifications = finder.call name
+
+        case specifications.size
+          when 1 then Success specifications.first
+          when 2.. then Success choose(specifications)
+          else Failure "Unknown gem or gem is not installed: #{name}."
+        end
+      end
+
+      def choose specifications
+        specifications.each.with_index 1 do |specification, index|
+          kernel.puts "#{index}. #{specification.named_version}"
+        end
+
+        kernel.puts "\nPlease enter gem selection:"
+        ARGV.clear
+        specifications[kernel.gets.chomp.to_i - 1]
+      end
+
+      private
+
+      attr_reader :finder, :kernel
+    end
+  end
+end

data/lib/gemsmith/gems/presenter.rb

@@ -0,0 +1,50 @@
+# frozen_string_literal: true
+
+require "forwardable"
+require "pathname"
+require "refinements/arrays"
+require "versionaire"
+
+module Gemsmith
+  module Gems
+    # Provides a gem specification that is more useful than what is provided Ruby Gems.
+    class Presenter
+      extend Forwardable
+
+      using Refinements::Arrays
+      using Versionaire::Cast
+
+      delegate %i[metadata name summary] => :record
+
+      def initialize record
+        @record = record
+      end
+
+      def allowed_push_key = metadata.fetch "allowed_push_key", "rubygems_api_key"
+
+      def allowed_push_host = metadata.fetch "allowed_push_host", ::Gem::DEFAULT_HOST
+
+      def homepage_url = String record.homepage
+
+      def label = metadata.fetch "label", "Undefined"
+
+      def labeled_summary(delimiter: " - ") = [label, summary].compress.join delimiter
+
+      def labeled_version = "#{label} #{version}"
+
+      def named_version = "#{name} #{version}"
+
+      def package_path = Pathname("tmp").join package_name
+
+      def package_name = "#{name}-#{version}.gem"
+
+      def source_path = Pathname record.full_gem_path
+
+      def version = Version record.version.to_s
+
+      private
+
+      attr_reader :record
+    end
+  end
+end

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

@@ -0,0 +1,49 @@
+Gem::Specification.new do |spec|
+  spec.name = "<%= configuration.project_name %>"
+  spec.version = "<%= configuration.project_version %>"
+  spec.platform = Gem::Platform::RUBY
+  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.1"
+  <% end %>
+  <% if configuration.build_cli %>
+    spec.add_dependency "runcom", "~> 8.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/**/*"]
+  spec.require_paths = ["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_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,54 @@
+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
+          @configuration = configuration
+          @client = client
+        end
+
+        def call arguments = []
+          client.banner = "<%= configuration.project_label %>"
+          client.separator "\nUSAGE:\n"
+          collate
+          client.parse arguments
+          configuration
+        end
+
+        private
+
+        attr_reader :configuration, :client
+
+        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
+      end
+    end
+  end
+<% end %>

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

@@ -0,0 +1,38 @@
+<% 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 { "<%= configuration.project_label %> <%= configuration.project_version %>" }
+          else usage
+        end
+      end
+
+      def config(action) = actions.fetch(__method__).call(action)
+
+      def usage = logger.unknown(parser.to_s)
+
+      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,35 @@
+require "dry-container"
+require "logger"
+require "pastel"
+
+<% namespace do %>
+  # Provides a global gem container for injection into other objects.
+  module Container
+    extend Dry::Container::Mixin
+
+    register(:configuration) { 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/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_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_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

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

@@ -0,0 +1,53 @@
+require "spec_helper"
+
+RSpec.describe <%= configuration.project_class %>::CLI::Parsers::Core do
+  subject(:parser) { described_class.new configuration.dup }
+
+  include_context "with application container"
+
+  it_behaves_like "a parser"
+
+  describe "#call" do
+    it "answers config edit (short)" do
+      expect(parser.call(%w[-c edit])).to have_attributes(action_config: :edit)
+    end
+
+    it "answers config edit (long)" do
+      expect(parser.call(%w[--config edit])).to have_attributes(action_config: :edit)
+    end
+
+    it "answers config view (short)" do
+      expect(parser.call(%w[-c view])).to have_attributes(action_config: :view)
+    end
+
+    it "answers config view (long)" do
+      expect(parser.call(%w[--config view])).to have_attributes(action_config: :view)
+    end
+
+    it "fails with missing config action" do
+      expectation = proc { parser.call %w[--config] }
+      expect(&expectation).to raise_error(OptionParser::MissingArgument, /--config/)
+    end
+
+    it "fails with invalid config action" do
+      expectation = proc { parser.call %w[--config bogus] }
+      expect(&expectation).to raise_error(OptionParser::InvalidArgument, /bogus/)
+    end
+
+    it "answers version (short)" do
+      expect(parser.call(%w[-v])).to have_attributes(action_version: true)
+    end
+
+    it "answers version (long)" do
+      expect(parser.call(%w[--version])).to have_attributes(action_version: true)
+    end
+
+    it "enables help (short)" do
+      expect(parser.call(%w[-h])).to have_attributes(action_help: true)
+    end
+
+    it "enables help (long)" do
+      expect(parser.call(%w[--help])).to have_attributes(action_help: true)
+    end
+  end
+end

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

@@ -0,0 +1,43 @@
+require "spec_helper"
+
+RSpec.describe <%= configuration.project_class %>::CLI::Shell do
+  using Refinements::Pathnames
+
+  subject(:shell) { described_class.new actions: described_class::ACTIONS.merge(config:) }
+
+  include_context "with temporary directory"
+
+  let(:config) { instance_spy <%= configuration.project_class %>::CLI::Actions::Config }
+
+  describe "#call" do
+    it "edits configuration" do
+      shell.call %w[--config edit]
+      expect(config).to have_received(:call).with(:edit)
+    end
+
+    it "views configuration" do
+      shell.call %w[--config view]
+      expect(config).to have_received(:call).with(:view)
+    end
+
+    it "prints version" do
+      expectation = proc { shell.call %w[--version] }
+      expect(&expectation).to output(/<%= configuration.project_label %>\s\d+\.\d+\.\d+/).to_stdout
+    end
+
+    it "prints help (usage)" do
+      expectation = proc { shell.call %w[--help] }
+      expect(&expectation).to output(/<%= configuration.project_label %>.+USAGE.+/m).to_stdout
+    end
+
+    it "prints usage when no options are given" do
+      expectation = proc { shell.call }
+      expect(&expectation).to output(/<%= configuration.project_label %>.+USAGE.+/m).to_stdout
+    end
+
+    it "prints error with invalid option" do
+      expectation = proc { shell.call %w[--bogus] }
+      expect(&expectation).to output(/invalid option.+bogus/).to_stdout
+    end
+  end
+end