gemsmith 19.8.0 → 20.0.0

data/lib/gemsmith/cli/actions/build.rb

@@ -1,68 +0,0 @@
-# frozen_string_literal: true
-
-module Gemsmith
-  module CLI
-    module Actions
-      # Handles the build action.
-      class Build
-        include Gemsmith::Import[:logger]
-
-        # Order is important.
-        # rubocop:todo Metrics/CollectionLiteralLength
-        BUILDERS = [
-          Rubysmith::Builders::Core,
-          Rubysmith::Builders::Version,
-          Builders::Specification,
-          Rubysmith::Builders::Documentation::Readme,
-          Builders::Documentation::Readme,
-          Rubysmith::Builders::Documentation::Citation,
-          Rubysmith::Builders::Documentation::License,
-          Rubysmith::Builders::Documentation::Version,
-          Rubysmith::Builders::Git::Setup,
-          Rubysmith::Builders::Git::Ignore,
-          Rubysmith::Builders::Git::Safe,
-          Builders::Git::Ignore,
-          Rubysmith::Builders::Bundler,
-          Builders::Bundler,
-          Builders::CLI,
-          Rubysmith::Builders::Rake,
-          Rubysmith::Builders::Console,
-          Rubysmith::Builders::CircleCI,
-          Builders::CircleCI,
-          Rubysmith::Builders::Setup,
-          Rubysmith::Builders::GitHub,
-          Rubysmith::Builders::Guard,
-          Rubysmith::Builders::Reek,
-          Rubysmith::Builders::RSpec::Binstub,
-          Rubysmith::Builders::RSpec::Context,
-          Rubysmith::Builders::RSpec::Helper,
-          Builders::RSpec::Helper,
-          Rubysmith::Builders::Caliber,
-          Rubysmith::Extensions::Bundler,
-          Rubysmith::Extensions::Pragmater,
-          Rubysmith::Extensions::Tocer,
-          Rubysmith::Extensions::Rubocop,
-          Builders::Git::Commit
-        ].freeze
-        # rubocop:enable Metrics/CollectionLiteralLength
-
-        def initialize(builders: BUILDERS, **)
-          super(**)
-          @builders = builders
-        end
-
-        def call configuration
-          log_info "Building project skeleton: #{configuration.project_name}..."
-          builders.each { |builder| builder.call configuration }
-          log_info "Project skeleton complete!"
-        end
-
-        private
-
-        attr_reader :builders
-
-        def log_info(message) = logger.info { message }
-      end
-    end
-  end
-end

data/lib/gemsmith/cli/actions/config.rb

@@ -1,33 +0,0 @@
-# frozen_string_literal: true
-
-module Gemsmith
-  module CLI
-    module Actions
-      # Handles the config action.
-      class Config
-        include Gemsmith::Import[:kernel, :logger]
-
-        def initialize(client: Configuration::Loader::CLIENT, **)
-          super(**)
-          @client = client
-        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
-
-        def edit = kernel.system("$EDITOR #{client.current}")
-
-        def view = kernel.system("cat #{client.current}")
-      end
-    end
-  end
-end

data/lib/gemsmith/cli/actions/container.rb

@@ -1,23 +0,0 @@
-# frozen_string_literal: true
-
-require "dry/container"
-
-module Gemsmith
-  module CLI
-    module Actions
-      # Provides a single container with application and action specific dependencies.
-      module Container
-        extend Dry::Container::Mixin
-
-        merge Gemsmith::Container
-
-        register(:config) { Config.new }
-        register(:build) { Build.new }
-        register(:install) { Install.new }
-        register(:publish) { Publish.new }
-        register(:edit) { Edit.new }
-        register(:view) { View.new }
-      end
-    end
-  end
-end

data/lib/gemsmith/cli/actions/import.rb

@@ -1,11 +0,0 @@
-# frozen_string_literal: true
-
-require "infusible"
-
-module Gemsmith
-  module CLI
-    module Actions
-      Import = Infusible.with Container
-    end
-  end
-end

data/lib/gemsmith/cli/parser.rb

@@ -1,37 +0,0 @@
-# frozen_string_literal: true
-
-require "core"
-require "optparse"
-
-module Gemsmith
-  module CLI
-    # Assembles and parses all Command Line Interface (CLI) options.
-    class Parser
-      include Import[:configuration]
-
-      CLIENT = OptionParser.new nil, 40, "  "
-
-      # Order is important.
-      SECTIONS = [Parsers::Core, Rubysmith::CLI::Parsers::Build, Parsers::Build].freeze
-
-      def initialize(sections: SECTIONS, client: CLIENT, **)
-        super(**)
-        @sections = sections
-        @client = client
-        @configuration_duplicate = configuration.dup
-      end
-
-      def call arguments = Core::EMPTY_ARRAY
-        sections.each { |section| section.call configuration_duplicate, client: }
-        client.parse arguments
-        configuration_duplicate.freeze
-      end
-
-      def to_s = client.to_s
-
-      private
-
-      attr_reader :sections, :client, :configuration_duplicate
-    end
-  end
-end

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

@@ -1,53 +0,0 @@
-# frozen_string_literal: true
-
-require "core"
-require "refinements/structs"
-
-module Gemsmith
-  module CLI
-    module Parsers
-      # Handles parsing of Command Line Interface (CLI) build options.
-      class Build
-        include Import[:color]
-
-        using Refinements::Structs
-
-        def self.call(...) = new(...).call
-
-        def initialize(configuration = Container[:configuration], client: Parser::CLIENT, **)
-          super(**)
-          @configuration = configuration
-          @client = client
-        end
-
-        def call arguments = ::Core::EMPTY_ARRAY
-          add_cli
-          client.parse arguments
-          configuration
-        end
-
-        private
-
-        attr_reader :configuration, :client
-
-        def add_cli
-          client.on(
-            "--[no-]cli",
-            "Add command line interface. #{default __method__}."
-          ) do |value|
-            configuration.merge! build_refinements: value, build_zeitwerk: value if value
-            configuration.merge! build_cli: value
-          end
-        end
-
-        def default option
-          option.to_s
-                .sub("add_", "build_")
-                .then { |attribute| configuration.public_send attribute }
-                .then { |boolean| boolean ? color[boolean, :green] : color[boolean, :red] }
-                .then { |colored_boolean| "Default: #{colored_boolean}" }
-        end
-      end
-    end
-  end
-end

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

@@ -1,93 +0,0 @@
-# frozen_string_literal: true
-
-require "core"
-require "pathname"
-require "refinements/structs"
-
-module Gemsmith
-  module CLI
-    module Parsers
-      # Handles parsing of Command Line Interface (CLI) core options.
-      class Core
-        include Import[:specification]
-
-        using Refinements::Structs
-
-        def self.call(...) = new(...).call
-
-        def initialize(configuration = Container[:configuration], client: Parser::CLIENT, **)
-          super(**)
-          @configuration = configuration
-          @client = client
-        end
-
-        def call arguments = ::Core::EMPTY_ARRAY
-          client.banner = specification.labeled_summary
-          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_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
-      end
-    end
-  end
-end

data/lib/gemsmith/configuration/loader.rb

@@ -1,27 +0,0 @@
-# frozen_string_literal: true
-
-require "runcom"
-
-module Gemsmith
-  module Configuration
-    # Represents the fully assembled Command Line Interface (CLI) configuration.
-    class Loader < Rubysmith::Configuration::Loader
-      DEFAULTS = Rubysmith::Configuration::Loader::DEFAULTS
-      CLIENT = Runcom::Config.new "gemsmith/configuration.yml", defaults: DEFAULTS
-
-      def self.with_overrides
-        new client: DEFAULTS,
-            enhancers: {template_root: Rubysmith::Configuration::Enhancers::TemplateRoot}
-      end
-
-      def initialize(client: CLIENT, **) = super
-
-      def call
-        return super unless enhancers.key? :template_root
-
-        enhancers[:template_root].call(super, overrides: Pathname(__dir__).join("../templates"))
-                                 .freeze
-      end
-    end
-  end
-end

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

@@ -1,31 +0,0 @@
-<% namespace do %>
-  module CLI
-    module Actions
-      # Handles the config action.
-      class Config
-        include <%= configuration.project_class %>::Import[:kernel, :logger]
-
-        def initialize(client: Configuration::Loader::CLIENT, **)
-          super(**)
-          @client = client
-        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
-
-        def edit = kernel.system("$EDITOR #{client.current}")
-
-        def view = kernel.system("cat #{client.current}")
-      end
-    end
-  end
-<% end %>

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

@@ -1,16 +0,0 @@
-require "dry/container"
-
-<% namespace do %>
-  module CLI
-    module Actions
-      # Provides a single container of application and action specific dependencies.
-      module Container
-        extend Dry::Container::Mixin
-
-        merge <%= configuration.project_namespaced_class %>::Container
-
-        register(:config) { Config.new }
-      end
-    end
-  end
-<% end %>

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

@@ -1,9 +0,0 @@
-require "infusible"
-
-<% namespace do %>
-  module CLI
-    module Actions
-      Import = Infusible.with Container
-    end
-  end
-<% end %>

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

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

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

@@ -1,58 +0,0 @@
-require "core"
-require "refinements/structs"
-
-<% namespace do %>
-  module CLI
-    module Parsers
-      # Handles parsing of Command Line Interface (CLI) core options.
-      class Core
-        include Import[:specification]
-
-        using Refinements::Structs
-
-        def self.call(...) = new(...).call
-
-        def initialize(configuration = Container[:configuration], client: Parser::CLIENT, **)
-          super(**)
-          @configuration = configuration
-          @client = client
-        end
-
-        def call arguments = ::Core::EMPTY_ARRAY
-          client.banner = specification.labeled_summary
-          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%/configuration/content.rb.erb

@@ -1,18 +0,0 @@
-# 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

@@ -1,33 +0,0 @@
-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%/spec/lib/%project_path%/cli/actions/config_spec.rb.erb

@@ -1,24 +0,0 @@
-require "spec_helper"
-
-RSpec.describe <%= configuration.project_namespaced_class %>::CLI::Actions::Config do
-  subject(:action) { described_class.new }
-
-  include_context "with application dependencies"
-
-  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
-      action.call :bogus
-      expect(logger.reread).to match(/🛑.+Invalid configuration selection: bogus./)
-    end
-  end
-end

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

@@ -1,25 +0,0 @@
-require "spec_helper"
-
-RSpec.describe <%= configuration.project_namespaced_class %>::CLI::Parser do
-  subject(:parser) { described_class.new }
-
-  include_context "with application dependencies"
-
-  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

@@ -1,53 +0,0 @@
-require "spec_helper"
-
-RSpec.describe <%= configuration.project_namespaced_class %>::CLI::Parsers::Core do
-  subject(:parser) { described_class.new configuration.dup }
-
-  include_context "with application dependencies"
-
-  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%/configuration/content_spec.rb.erb

@@ -1,15 +0,0 @@
-require "spec_helper"
-
-RSpec.describe <%= configuration.project_namespaced_class %>::Configuration::Content do
-  subject(:content) { described_class.new }
-
-  describe "#initialize" do
-    it "answers default hash" do
-      expect(content).to have_attributes(
-        action_config: nil,
-        action_help: nil,
-        action_version: nil
-      )
-    end
-  end
-end