gemsmith 15.5.0 → 16.0.0

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

@@ -0,0 +1,15 @@
+require "spec_helper"
+
+RSpec.describe <%= configuration.project_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

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

@@ -0,0 +1,29 @@
+require "spec_helper"
+
+RSpec.describe <%= configuration.project_class %>::Configuration::Loader do
+  subject(:loader) { described_class.with_defaults }
+
+  let(:content) { <%= configuration.project_class %>::Configuration::Content.new }
+
+  describe ".call" do
+    it "answers default configuration" do
+      expect(described_class.call).to be_a(<%= configuration.project_class %>::Configuration::Content)
+    end
+  end
+
+  describe ".with_defaults" do
+    it "answers default configuration" do
+      expect(described_class.with_defaults.call).to eq(content)
+    end
+  end
+
+  describe "#call" do
+    it "answers default configuration" do
+      expect(loader.call).to eq(content)
+    end
+
+    it "answers frozen configuration" do
+      expect(loader.call).to be_frozen
+    end
+  end
+end

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

@@ -0,0 +1,22 @@
+require "dry/container/stub"
+
+RSpec.shared_context "with application container" do
+  using Refinements::Structs
+
+  include_context "with temporary directory"
+
+  let(:container) { <%= configuration.project_class %>::Container }
+  let(:configuration) { <%= configuration.project_class %>::Configuration::Loader.with_defaults.call }
+  let(:kernel) { class_spy Kernel }
+
+  before do
+    container.enable_stubs!
+    container.stub :configuration, configuration
+    container.stub :kernel, kernel
+  end
+
+  after do
+    container.unstub :configuration
+    container.unstub :kernel
+  end
+end

data/lib/gemsmith/templates/%project_name%/spec/support/shared_examples/a_parser.rb.erb

@@ -0,0 +1,7 @@
+RSpec.shared_examples "a parser" do
+  describe ".call" do
+    it "answers configuration" do
+      expect(described_class.call).to be_a(<%= configuration.project_class %>::Configuration::Content)
+    end
+  end
+end

data/lib/gemsmith/tools/cleaner.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+require "dry/monads"
+require "refinements/pathnames"
+
+module Gemsmith
+  module Tools
+    # Cleans gem artifacts.
+    class Cleaner
+      include Dry::Monads[:result]
+
+      using Refinements::Pathnames
+
+      def initialize root_dir: Pathname.pwd
+        @root_dir = root_dir
+      end
+
+      def call specification
+        root_dir.join("pkg").remove_tree
+        root_dir.files("**/*.gem").each(&:delete)
+        Success specification
+      end
+
+      private
+
+      attr_reader :root_dir
+    end
+  end
+end

data/lib/gemsmith/tools/editor.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+require "dry/monads"
+
+module Gemsmith
+  module Tools
+    # Edits a gem within default editor.
+    class Editor
+      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)
+        end
+      end
+
+      private
+
+      attr_reader :container
+
+      def executor = container[__method__]
+
+      def client = container[:environment].fetch("EDITOR")
+    end
+  end
+end

data/lib/gemsmith/tools/installer.rb

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+require "dry/monads"
+
+module Gemsmith
+  module Tools
+    # Installs a locally built gem.
+    class Installer
+      include Dry::Monads[:result, :do]
+
+      # Order matters.
+      STEPS = [Tools::Cleaner.new, Tools::Packager.new].freeze
+
+      def initialize steps: STEPS, container: Container
+        @steps = steps
+        @container = container
+      end
+
+      def call specification
+        steps.each { |step| yield step.call(specification) }
+        run specification
+      end
+
+      private
+
+      attr_reader :steps, :container
+
+      def run specification
+        path = specification.package_path
+
+        executor.capture3("gem", "install", path.to_s).then do |_stdout, _stderr, status|
+          status.success? ? Success(specification) : Failure("Unable to install: #{path}.")
+        end
+      end
+
+      def executor = container[__method__]
+    end
+  end
+end

data/lib/gemsmith/tools/packager.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+require "dry/monads"
+require "refinements/pathnames"
+require "rubygems/command_manager"
+
+module Gemsmith
+  module Tools
+    # Builds a gem package for distribution.
+    class Packager
+      include Dry::Monads[:result]
+
+      using Refinements::Pathnames
+
+      def initialize command: Gem::CommandManager.new
+        @command = command
+      end
+
+      # :reek:TooManyStatements
+      def call specification
+        command.run ["build", "#{specification.name}.gemspec"]
+        specification.package_path.then { |path| path.make_ancestors.basename.copy path.parent }
+        Success specification
+      rescue Gem::Exception => error
+        Failure error.message
+      end
+
+      private
+
+      attr_reader :command
+    end
+  end
+end

data/lib/gemsmith/tools/publisher.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+require "dry/monads"
+
+module Gemsmith
+  module Tools
+    # Handles the publication of a gem version.
+    class Publisher
+      include Dry::Monads[:result, :do]
+
+      # Order matters.
+      STEPS = [
+        Tools::Cleaner.new,
+        Tools::Validator.new,
+        Tools::Packager.new,
+        Tools::Versioner.new,
+        Tools::Pusher.new
+      ].freeze
+
+      def initialize steps: STEPS
+        @steps = steps
+      end
+
+      def call specification
+        steps.each { |step| yield step.call(specification) }
+        Success specification
+      end
+
+      private
+
+      attr_reader :steps
+    end
+  end
+end

data/lib/gemsmith/tools/pusher.rb

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+require "dry/monads"
+require "rubygems/command_manager"
+
+module Gemsmith
+  module Tools
+    # Pushes a gem package to remote gem server.
+    class Pusher
+      include Dry::Monads[:result]
+
+      def initialize command: Gem::CommandManager.new, container: Container
+        @command = command
+        @container = container
+      end
+
+      def call specification
+        command.run ["push", specification.package_path.to_s, *one_time_password]
+        Success specification
+      rescue Gem::Exception => error
+        Failure error.message
+      end
+
+      private
+
+      attr_reader :command, :container
+
+      def one_time_password
+        executor.capture3("ykman", "oath", "accounts", "code", "--single", "RubyGems")
+                .then { |stdout, _stderr, status| status.success? ? ["--otp", stdout.chomp] : [] }
+      end
+
+      def executor = container[__method__]
+    end
+  end
+end

data/lib/gemsmith/tools/validator.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+require "dry/monads"
+
+module Gemsmith
+  module Tools
+    # Validates whether a gem can be published or not.
+    class Validator
+      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

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+
+require "dry/monads"
+require "milestoner"
+
+module Gemsmith
+  module Tools
+    # Versions (tags) current project (local and remote).
+    class Versioner
+      include Dry::Monads[:result]
+
+      def initialize client: Milestoner::Tags::Publisher.new,
+                     content: Milestoner::Configuration::Content,
+                     container: Container
+        @client = client
+        @content = content
+        @container = container
+      end
+
+      def call specification
+        client.call settings(specification)
+        Success specification
+      rescue Milestoner::Error => error
+        Failure error.message
+      end
+
+      private
+
+      attr_reader :client, :content, :container
+
+      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

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+require "dry/monads"
+
+module Gemsmith
+  module Tools
+    # Views a gem within default browser.
+    class Viewer
+      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

data/lib/gemsmith.rb

@@ -1,10 +1,12 @@
 # frozen_string_literal: true
 
 require "zeitwerk"
+require "rubysmith"
 
-loader = Zeitwerk::Loader.for_gem
-loader.inflector.inflect "cli" => "CLI", "circle_ci" => "CircleCI"
-loader.setup
+Zeitwerk::Loader.for_gem.then do |loader|
+  loader.inflector.inflect "cli" => "CLI", "circle_ci" => "CircleCI", "rspec" => "RSpec"
+  loader.setup
+end
 
 # Main namespace.
 module Gemsmith