gemsmith 17.0.1 → 18.0.0

data/lib/gemsmith/cli/shell.rb

@@ -4,19 +4,20 @@ 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
+      include Actions::Import[
+        :config,
+        :build,
+        :install,
+        :publish,
+        :edit,
+        :view,
+        :specification,
+        :logger
+      ]
+
+      def initialize parser: Parser.new, **dependencies
+        super(**dependencies)
         @parser = parser
-        @actions = actions
-        @container = container
       end
 
       def call arguments = []
@@ -27,40 +28,20 @@ module Gemsmith
 
       private
 
-      attr_reader :parser, :actions, :container
+      attr_reader :parser
 
       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_config: Symbol => action then config.call action
+          in action_build: true then build.call configuration
+          in action_install: true then install.call configuration
+          in action_publish: true then publish.call configuration
+          in action_edit: String => gem_name then edit.call gem_name
+          in action_view: String => gem_name then view.call gem_name
           in action_version: true then logger.info { specification.labeled_version }
-          else usage
+          else logger.any { parser.to_s }
         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/container.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require "dry-container"
+require "dry/container"
 require "open3"
 require "spek"
 

data/lib/gemsmith/import.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+require "auto_injector"
+
+module Gemsmith
+  Import = AutoInjector[Container]
+end

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

@@ -22,6 +22,9 @@ Gem::Specification.new do |spec|
   <% end %>
 
   spec.required_ruby_version = "~> <%= RUBY_VERSION[/\d+\.\d+/] %>"
+  <% if configuration.build_cli %>
+    spec.add_dependency "auto_injector", "~> 0.4"
+  <% end %>
   <% if configuration.build_cli %>
     spec.add_dependency "dry-container", "~> 0.9"
   <% end %>

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

@@ -1,13 +1,14 @@
-# frozen_string_literal: true
-
 <% namespace do %>
   module CLI
     module Actions
       # Handles the config action.
       class Config
-        def initialize client: Configuration::Loader::CLIENT, container: Container
+        include <%= configuration.project_class %>::Import[:kernel, :logger]
+
+        def initialize client: Configuration::Loader::CLIENT, **dependencies
+          super(**dependencies)
+
           @client = client
-          @container = container
         end
 
         def call selection
@@ -20,15 +21,11 @@
 
         private
 
-        attr_reader :client, :container
+        attr_reader :client
 
         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

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

@@ -0,0 +1,18 @@
+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
+
+        config.registry = ->(container, key, value, _options) { container[key.to_s] = value }
+
+        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

@@ -0,0 +1,9 @@
+require "auto_injector"
+
+<% namespace do %>
+  module CLI
+    module Actions
+      Import = AutoInjector[Container]
+    end
+  end
+<% end %>

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

@@ -4,28 +4,32 @@ require "optparse"
   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, container: Container
+      def initialize sections: SECTIONS, client: CLIENT, **dependencies
+        super(**dependencies)
+
         @sections = sections
         @client = client
-        @configuration = container[:configuration].dup
+        @configuration_duplicate = configuration.dup
       end
 
       def call arguments = []
-        sections.each { |section| section.call configuration, client: }
+        sections.each { |section| section.call configuration_duplicate, client: }
         client.parse arguments
-        configuration.freeze
+        configuration_duplicate.freeze
       end
 
       def to_s = client.to_s
 
       private
 
-      attr_reader :sections, :client, :configuration
+      attr_reader :sections, :client, :configuration_duplicate
     end
   end
 <% end %>

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

@@ -5,16 +5,19 @@ require "refinements/structs"
     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,
-                       container: Container
+                       **dependencies
+
+          super(**dependencies)
           @configuration = configuration
           @client = client
-          @container = container
         end
 
         def call arguments = []
@@ -27,7 +30,7 @@ require "refinements/structs"
 
         private
 
-        attr_reader :configuration, :client, :container
+        attr_reader :configuration, :client
 
         def collate = private_methods.sort.grep(/add_/).each { |method| __send__ method }
 
@@ -51,8 +54,6 @@ require "refinements/structs"
             configuration.merge! action_help: true
           end
         end
-
-        def specification = container[__method__]
       end
     end
   end

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

@@ -2,12 +2,11 @@
   module CLI
     # The main Command Line Interface (CLI) object.
     class Shell
-      ACTIONS = {config: Actions::Config.new}.freeze
+      include Actions::Import[:config, :specification, :logger]
 
-      def initialize parser: Parser.new, actions: ACTIONS, container: Container
+      def initialize parser: Parser.new, **dependencies
+        super(**dependencies)
         @parser = parser
-        @actions = actions
-        @container = container
       end
 
       def call arguments = []
@@ -18,23 +17,15 @@
 
       private
 
-      attr_reader :parser, :actions, :container
+      attr_reader :parser
 
       def perform configuration
         case configuration
-          in action_config: Symbol => action then config action
+          in action_config: Symbol => action then config.call action
           in action_version: true then logger.info { specification.labeled_version }
-          else usage
+          else logger.any { parser.to_s }
         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%/container.rb.erb

@@ -1,6 +1,5 @@
-require "dry-container"
-require "logger"
-require "pastel"
+require "cogger"
+require "dry/container"
 require "spek"
 
 <% namespace do %>
@@ -10,28 +9,7 @@ require "spek"
 
     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
+    register(:logger) { Cogger::Client.new }
   end
 <% end %>

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

@@ -0,0 +1,5 @@
+require "auto_injector"
+
+<% namespace do %>
+  Import = AutoInjector[Container]
+<% end %>

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

@@ -3,7 +3,7 @@ require "spec_helper"
 RSpec.describe <%= configuration.project_namespaced_class %>::CLI::Actions::Config do
   subject(:action) { described_class.new }
 
-  include_context "with application container"
+  include_context "with application dependencies"
 
   describe "#call" do
     it "edits configuration" do
@@ -17,8 +17,8 @@ RSpec.describe <%= configuration.project_namespaced_class %>::CLI::Actions::Conf
     end
 
     it "logs invalid configuration" do
-      expectation = proc { action.call :bogus }
-      expect(&expectation).to output(/Invalid configuration selection: bogus./).to_stdout
+      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

@@ -3,7 +3,7 @@ require "spec_helper"
 RSpec.describe <%= configuration.project_namespaced_class %>::CLI::Parser do
   subject(:parser) { described_class.new }
 
-  include_context "with application container"
+  include_context "with application dependencies"
 
   describe "#call" do
     it "answers hash with valid option" do

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

@@ -3,7 +3,7 @@ require "spec_helper"
 RSpec.describe <%= configuration.project_namespaced_class %>::CLI::Parsers::Core do
   subject(:parser) { described_class.new configuration.dup }
 
-  include_context "with application container"
+  include_context "with application dependencies"
 
   it_behaves_like "a parser"
 

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

@@ -2,42 +2,45 @@ require "spec_helper"
 
 RSpec.describe <%= configuration.project_namespaced_class %>::CLI::Shell do
   using Refinements::Pathnames
+  using AutoInjector::Stub
 
-  subject(:shell) { described_class.new actions: described_class::ACTIONS.merge(config:) }
+  subject(:shell) { described_class.new }
 
-  include_context "with temporary directory"
+  include_context "with application dependencies"
 
-  let(:config) { instance_spy <%= configuration.project_namespaced_class %>::CLI::Actions::Config }
+  before { <%= configuration.project_namespaced_class %>::CLI::Actions::Import.stub configuration:, kernel:, logger: }
+
+  after { <%= configuration.project_namespaced_class %>::CLI::Actions::Import.unstub :configuration, :kernel, :logger }
 
   describe "#call" do
     it "edits configuration" do
       shell.call %w[--config edit]
-      expect(config).to have_received(:call).with(:edit)
+      expect(kernel).to have_received(:system).with("$EDITOR ")
     end
 
     it "views configuration" do
       shell.call %w[--config view]
-      expect(config).to have_received(:call).with(:view)
+      expect(kernel).to have_received(:system).with("cat ")
     end
 
     it "prints version" do
-      expectation = proc { shell.call %w[--version] }
-      expect(&expectation).to output(/<%= configuration.project_label %>\s\d+\.\d+\.\d+/).to_stdout
+      shell.call %w[--version]
+      expect(logger.reread).to match(/<%= configuration.project_label %>\s\d+\.\d+\.\d+/)
     end
 
     it "prints help (usage)" do
-      expectation = proc { shell.call %w[--help] }
-      expect(&expectation).to output(/<%= configuration.project_label %>.+USAGE.+/m).to_stdout
+      shell.call %w[--help]
+      expect(logger.reread).to match(/<%= configuration.project_label %>.+USAGE.+/m)
     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
+      shell.call
+      expect(logger.reread).to match(/<%= configuration.project_label %>.+USAGE.+/m)
     end
 
     it "prints error with invalid option" do
-      expectation = proc { shell.call %w[--bogus] }
-      expect(&expectation).to output(/invalid option.+bogus/).to_stdout
+      shell.call %w[--bogus]
+      expect(logger.reread).to match(/invalid option.+bogus/)
     end
   end
 end

data/lib/gemsmith/templates/%project_name%/spec/support/shared_contexts/application_dependencies.rb.erb

@@ -0,0 +1,21 @@
+require "dry/container/stub"
+require "auto_injector/stub"
+
+RSpec.shared_context "with application dependencies" do
+  using Refinements::Structs
+  using AutoInjector::Stub
+
+  include_context "with temporary directory"
+
+  let(:configuration) { <%= configuration.project_namespaced_class %>::Configuration::Loader.with_defaults.call }
+  let(:kernel) { class_spy Kernel }
+
+  let :logger do
+    Cogger::Client.new Logger.new(StringIO.new),
+                       formatter: ->(_severity, _name, _at, message) { "#{message}\n" }
+  end
+
+  before { <%= configuration.project_namespaced_class %>::Import.stub configuration:, kernel:, logger: }
+
+  after { <%= configuration.project_namespaced_class %>::Import.unstub :configuration, :kernel, :logger }
+end

data/lib/gemsmith/tools/editor.rb

@@ -6,12 +6,9 @@ module Gemsmith
   module Tools
     # Edits a gem within default editor.
     class Editor
+      include Import[:executor, :environment]
       include Dry::Monads[:result]
 
-      def initialize container: Container
-        @container = container
-      end
-
       def call specification
         executor.capture3(client, specification.source_path.to_s).then do |_stdout, stderr, status|
           status.success? ? Success(specification) : Failure(stderr)
@@ -20,11 +17,7 @@ module Gemsmith
 
       private
 
-      attr_reader :container
-
-      def executor = container[__method__]
-
-      def client = container[:environment].fetch("EDITOR")
+      def client = environment.fetch("EDITOR")
     end
   end
 end

data/lib/gemsmith/tools/installer.rb

@@ -6,14 +6,16 @@ module Gemsmith
   module Tools
     # Installs a locally built gem.
     class Installer
+      include Import[:executor]
       include Dry::Monads[:result, :do]
 
       # Order matters.
       STEPS = [Tools::Cleaner.new, Tools::Packager.new].freeze
 
-      def initialize steps: STEPS, container: Container
+      def initialize steps: STEPS, **dependencies
+        super(**dependencies)
+
         @steps = steps
-        @container = container
       end
 
       def call specification
@@ -23,7 +25,7 @@ module Gemsmith
 
       private
 
-      attr_reader :steps, :container
+      attr_reader :steps
 
       def run specification
         path = specification.package_path
@@ -32,8 +34,6 @@ module Gemsmith
           status.success? ? Success(specification) : Failure("Unable to install: #{path}.")
         end
       end
-
-      def executor = container[__method__]
     end
   end
 end

data/lib/gemsmith/tools/pusher.rb

@@ -7,11 +7,13 @@ module Gemsmith
   module Tools
     # Pushes a gem package to remote gem server.
     class Pusher
+      include Import[:executor, :logger]
       include Dry::Monads[:result]
 
-      def initialize command: Gem::CommandManager.new, container: Container
+      def initialize command: Gem::CommandManager.new, **dependencies
+        super(**dependencies)
+
         @command = command
-        @container = container
       end
 
       def call specification
@@ -23,14 +25,30 @@ module Gemsmith
 
       private
 
-      attr_reader :command, :container
+      attr_reader :command
 
+      # :reek:TooManyStatements
       def one_time_password
-        executor.capture3("ykman", "oath", "accounts", "code", "--single", "RubyGems")
+        return [] if check_yubikey.failure?
+
+        executor.capture3(check_yubikey.success, "oath", "accounts", "code", "--single", "RubyGems")
                 .then { |stdout, _stderr, status| status.success? ? ["--otp", stdout.chomp] : [] }
+      rescue Errno::ENOENT => error
+        logger.warn { "Unable to obtain YubiKey One-Time Password. #{error}." }
+        []
       end
 
-      def executor = container[__method__]
+      def check_yubikey
+        executor.capture3("command", "-v", "ykman")
+                .then do |stdout, stderr, status|
+                  if status.success?
+                    Success stdout.chomp
+                  else
+                    logger.warn { "Unable to find YubiKey Manager. #{stderr}." }
+                    Failure()
+                  end
+                end
+      end
     end
   end
 end

data/lib/gemsmith/tools/validator.rb

@@ -6,23 +6,14 @@ module Gemsmith
   module Tools
     # Validates whether a gem can be published or not.
     class Validator
+      include Import[:executor]
       include Dry::Monads[:result]
 
-      def initialize container: Container
-        @container = container
-      end
-
       def call specification
         executor.capture3("git", "status", "--porcelain").then do |_stdout, _stderr, status|
           status.success? ? Success(specification) : Failure("Project has uncommitted changes.")
         end
       end
-
-      private
-
-      attr_reader :container
-
-      def executor = container[__method__]
     end
   end
 end

data/lib/gemsmith/tools/versioner.rb

@@ -7,14 +7,17 @@ module Gemsmith
   module Tools
     # Versions (tags) current project (local and remote).
     class Versioner
+      include Import[:configuration]
       include Dry::Monads[:result]
 
       def initialize client: Milestoner::Tags::Publisher.new,
                      content: Milestoner::Configuration::Content,
-                     container: Container
+                     **dependencies
+
+        super(**dependencies)
+
         @client = client
         @content = content
-        @container = container
       end
 
       def call specification
@@ -26,18 +29,15 @@ module Gemsmith
 
       private
 
-      attr_reader :client, :content, :container
+      attr_reader :client, :content
 
       def settings specification
         content[
           documentation_format: configuration.extensions_milestoner_documentation_format,
           prefixes: configuration.extensions_milestoner_prefixes,
-          sign: configuration.extensions_milestoner_sign,
           version: specification.version
         ]
       end
-
-      def configuration = container[__method__]
     end
   end
 end

data/lib/gemsmith/tools/viewer.rb

@@ -6,23 +6,14 @@ module Gemsmith
   module Tools
     # Views a gem within default browser.
     class Viewer
+      include Import[:executor]
       include Dry::Monads[:result]
 
-      def initialize container: Container
-        @container = container
-      end
-
       def call specification
         executor.capture3("open", specification.homepage_url).then do |_stdout, stderr, status|
           status.success? ? Success(specification) : Failure(stderr)
         end
       end
-
-      private
-
-      attr_reader :container
-
-      def executor = container[__method__]
     end
   end
 end