gemsmith 17.0.1 → 18.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4f37d4347b54a5dd52f7aa24d649a94566f7eee546fe25eacd74084b0157029c
-  data.tar.gz: a4f23dfa0c5c5d1588508a1e0f4aa7f81408102d9903b6abe0f6f1b60e2c8164
+  metadata.gz: badab9b933b3cc8009dcce38b6c849c38e7b6d90fb849bda9ba3426e9d8c76fe
+  data.tar.gz: 48386d0058700e7ab46b0ce1189b8264f7c0dcf75f4e2d11b0a702c5bb82a858
 SHA512:
-  metadata.gz: 7ef45d382883ca6064a343aae7a16932c529a6761a2d6ecb927d63c52df6c5dc28a026e85317b6fbb161572771f8e36a01860ae14320ecd460b042111eb1aa08
-  data.tar.gz: a7ddacd605e91f3a5de61b83acc4aba91e09db226554c255ccf3d5014ffe47a7f029070b539bd5b0e38cb4a68d4daece6cc92f5955e4621fd77fa74acc2ca229
+  metadata.gz: 3dcd01d2e1c468062c19c060e080140eb6fd5da9dbbc408bdd0a4bdaa2db6e45e7bfdf066d94719380410a3f96d268a38632ff67bd01f4bfe07cc7fa1899e063
+  data.tar.gz: e43ce7b51bb41176925c911f80d40e8c88d464ce84e7effdf03ef4f0d1a09dc40737bf605aefa3db816e8fed511a7a56cef94b82b06f9ee1c90845b58ae6b4a5

data/README.adoc

@@ -14,8 +14,7 @@ toc::[]
 
 == Features
 
-* Supports all features provided by link:https://www.alchemists.io/projects/rubysmith[Rubysmith]
-  which is used for smithing Ruby projects.
+* Supports all link:https://www.alchemists.io/projects/rubysmith[Rubysmith] features.
 * Supports basic gem skeletons or more advanced Command Line Interface (CLI) skeletons.
 * Supports gem building, installing for local development, and publishing.
 * Supports the editing and viewing of installed gems.
@@ -37,13 +36,12 @@ gem install gemsmith
 
 == Upgrade
 
-If upgrading from 16.0.0 to 17.0.0, you'll need to make the following changes:
+If upgrading from 17.0.0 to 18.0.0, you'll want to be aware of the following changes:
 
-* README badges are no longer injected so you can customize as desired.
-* The `:rubocop:` build configuration has been removed. Use `:caliber:` instead.
-* The `--rubocop` build option has been removed. Use `--caliber` instead.
-* You no longer have to Git ignore RuboCop cached configurations since this is handled by the
-  link:https://www.alchemists.io/projects/caliber[Caliber] gem now.
+* The `--dead_end` build option has been removed.
+* The Milestoner configuration has been updated to support ASCII Doc format by default and the
+  ability to sign tags has been removed (this happens dynamically based on your Git configuration
+  which gives you more flexibility).
 
 == Usage
 
@@ -72,7 +70,6 @@ BUILD OPTIONS:
       --[no-]conduct                       Add code of conduct documentation. Default: true.
       --[no-]console                       Add console script. Default: true.
       --[no-]contributions                 Add contributions documentation. Default: true.
-      --[no-]dead_end                      Add Dead End gem. Default: true.
       --[no-]debug                         Add Debug gem. Default: true.
       --[no-]git                           Add Git. Default: true.
       --[no-]git_hub                       Add GitHub templates. Default: false.
@@ -102,7 +99,7 @@ build options allow you to further customize the kind of gem you want to build.
 are enabled by default. For detailed documentation on all supported flags, see the
 link:https://www.alchemists.io/projects/rubysmith/#_build[Rubysmith] documentation.
 
-The build option, which is unique to Gemsmith, is the `--cli` option. This allows you to build a gem
+The build option which is unique to Gemsmith is the `--cli` option. This allows you to build a gem
 which has a Command Line Interface (CLI). There are multiple ways a CLI can be built in Ruby but
 Gemsmith takes an approach which builds upon Ruby's native `OptionParser` with help from
 link:https://dry-rb.org/gems/dry-container[Dry Container]. All of this culminates in a design that
@@ -293,15 +290,27 @@ gem cert --build you@example.com
 chmod 600 gem-*.pem
 ----
 
-The resulting `.pem` key files can be referenced via the `:private_key:` and `:public_key:` keys
-within the `$HOME/.gemsmithrc` file.
+The resulting `*.pem` key files can be referenced via the `signing_key` and `cert_chain` of your
+`*.gemspec` which Gemsmith provides for you via the `--security` build option. Example:
+
+[source,ruby]
+----
+# frozen_string_literal: true
+
+Gem::Specification.new do |spec|
+  # Truncated for brevity.
+  spec.signing_key = Gem.default_key_path
+  spec.cert_chain = [Gem.default_cert_path]
+end
+----
 
 To learn more about gem certificates, read about RubyGems
 link:https://guides.rubygems.org/security[Security].
 
 == Private Gem Servers
 
-By default, the following Rake task will publish your gem to link:https://rubygems.org[RubyGems]:
+By default, the following command will publicly publish your gem to
+link:https://rubygems.org[RubyGems]:
 
 [source,bash]
 ----
@@ -319,20 +328,19 @@ Add the following metadata to your gemspec:
 [source,ruby]
 ----
 Gem::Specification.new do |spec|
-  spec.metadata = {
-    "allowed_push_key" => "example_key",
-    "allowed_push_host" => "https://gems.example.com"
-  }
+  spec.metadata = {"allowed_push_host" => "https://private.example.com"}
 end
 ----
 
-The gemspec metadata keys and values _must_ be strings per the
-link:https://guides.rubygems.org/specification-reference/#metadata[RubyGems Specification]. Each key
-represents the following:
+💡 The gemspec metadata _must_ be strings per the
+link:https://guides.rubygems.org/specification-reference/#metadata[RubyGems Specification].
 
-* `allowed_push_key`: Provides a reference (look up) to the key defined the RubyGems credentials
-  file so that sensitive credentials are not used within your gemspec.
-* `allowed_push_host`: Provides the URL of the private gem server to push your gem to.
+Use of the `allowed_push_host` key provides two important capabilities:
+
+* Prevents you from accidentally publishing your private gem to the public RubyGems server (default
+  behavior).
+* Defines the lookup key in your `$HOME/.gem/credentials` file which contains your private
+  credentials for authentication to your private server (more on this below).
 
 === Gem Credentials
 
@@ -340,18 +348,52 @@ With your gem specification metadata established, you are ready to publish your
 private server. If this is your first time publishing a gem and no gem credentials have been
 configured, you'll be prompted for them. Gem credentials are stored in the RubyGems
 `$HOME/.gem/credentials` file. From this point forward, future gem publishing will use your stored
-credentials instead. Multiple credentials can be stored in the `$HOME/.gem/credentials` file.
-Example:
+credentials instead.
+
+Multiple credentials can be stored in the `$HOME/.gem/credentials` file as well. Example:
 
 [source,yaml]
 ----
 :rubygems_api_key: 2a0b460650e67d9b85a60e183defa376
-:some_custom_key: "Basic dXNlcjpwYXNzd29yZA=="
+https://private.example.com: Basic dXNlcjpwYXNzd29yZA==
 ----
 
-Should you need to delete a credential (due to a bad login/password for example), you can open the
-`$HOME/.gem/credentials` in your default editor and remove the line(s) you don't need. Upon next
-publish of your gem, you'll be prompted for the missing credentials.
+Notice how the first line contains credentials for the public RubyGems server while the second line
+is for our private example server. You'll also notice that the key is not a symbol but a URL string
+to our private server. This is important as this is how we link our gem specification metadata to
+our private credentials. To illustrate further, here are both files truncated and shown together:
+
+....
+# Gem specification metadata which defines the private host to publish to.
+spec.metadata = {"allowed_push_host" => "https://private.example.com"}
+
+# Gem credentials where the URL value above becomes the key which enables authentication.
+https://private.example.com: Basic dXNlcjpwYXNzd29yZA==
+....
+
+When the above are linked together like this, you enable Gemsmith to publish your gem using only the
+following command:
+
+[source,bash]
+----
+gemsmith --publish
+----
+
+This is especially powerful when publishing to
+link:https://docs.github.com/en/packages/working-with-a-github-packages-registry/working-with-the-rubygems-registry[GitHub's
+Packages registory] which would look like this when properly configured (truncated for brevity):
+
+....
+# Gem specification
+spec.metadata = {"allowed_push_host" => "https://rubygems.pkg.github.com/alchemists"}
+
+# Gem credentials
+https://rubygems.pkg.github.com/alchemists: Bearer ghp_c5b8d394abefebbf45c7b27b379c74978923
+....
+
+Lastly, should you need to delete a credential (due to a bad login/password for example), you can
+open the `$HOME/.gem/credentials` in your default editor and remove the line(s) you don't need. Upon
+next publish of your gem, you'll be prompted for the missing credentials.
 
 == Promotion
 
@@ -359,7 +401,6 @@ Once your gem is released, let the world know about your accomplishment by posti
 these sites:
 
 * link:https://rubyflow.com[RubyFlow]
-* link:https://rubyradar.dev[Ruby Radar]
 * link:https://ruby.libhunt.com[Ruby Library Hunt]
 * link:https://rubydaily.org[RubyDaily]
 * link:https://awesome-ruby.com[Awesome Ruby]

data/gemsmith.gemspec

@@ -2,7 +2,7 @@
 
 Gem::Specification.new do |spec|
   spec.name = "gemsmith"
-  spec.version = "17.0.1"
+  spec.version = "18.0.2"
   spec.authors = ["Brooke Kuhlmann"]
   spec.email = ["brooke@alchemists.io"]
   spec.homepage = "https://www.alchemists.io/projects/gemsmith"
@@ -22,12 +22,13 @@ Gem::Specification.new do |spec|
   spec.cert_chain = [Gem.default_cert_path]
 
   spec.required_ruby_version = "~> 3.1"
+  spec.add_dependency "auto_injector", "~> 0.4"
+  spec.add_dependency "cogger", "~> 0.0"
   spec.add_dependency "dry-container", "~> 0.9"
   spec.add_dependency "dry-monads", "~> 1.4"
-  spec.add_dependency "milestoner", "~> 13.3"
-  spec.add_dependency "pastel", "~> 0.8"
+  spec.add_dependency "milestoner", "~> 14.0"
   spec.add_dependency "refinements", "~> 9.2"
-  spec.add_dependency "rubysmith", "~> 2.0"
+  spec.add_dependency "rubysmith", "~> 3.0"
   spec.add_dependency "runcom", "~> 8.2"
   spec.add_dependency "spek", "~> 0.2"
   spec.add_dependency "versionaire", "~> 10.0"

data/lib/gemsmith/builders/circle_ci.rb

@@ -19,7 +19,8 @@ module Gemsmith
         return configuration unless configuration.build_circle_ci
 
         builder.call(configuration.merge(template_path: "%project_name%/.circleci/config.yml.erb"))
-               .replace("Gemfile.lock", "#{configuration.project_name}.gemspec")
+               .replace %({{checksum "Gemfile.lock"}}),
+                        %({{checksum "Gemfile"}}-{{checksum "#{project_name}.gemspec"}})
 
         configuration
       end
@@ -27,6 +28,8 @@ module Gemsmith
       private
 
       attr_reader :configuration, :builder
+
+      def project_name = configuration.project_name
     end
   end
 end

data/lib/gemsmith/builders/cli.rb

@@ -47,16 +47,24 @@ module Gemsmith
                CONTENT
       end
 
-      def render_library
+      def render_configuration
         [
-          "%project_name%/lib/%project_path%/cli/actions/config.rb.erb",
-          "%project_name%/lib/%project_path%/cli/parser.rb.erb",
-          "%project_name%/lib/%project_path%/cli/parsers/core.rb.erb",
-          "%project_name%/lib/%project_path%/cli/shell.rb.erb",
           "%project_name%/lib/%project_path%/configuration/content.rb.erb",
           "%project_name%/lib/%project_path%/configuration/defaults.yml.erb",
           "%project_name%/lib/%project_path%/configuration/loader.rb.erb",
-          "%project_name%/lib/%project_path%/container.rb.erb"
+          "%project_name%/lib/%project_path%/container.rb.erb",
+          "%project_name%/lib/%project_path%/import.rb.erb"
+        ].each { |path| builder.call(configuration.merge(template_path: path)).render }
+      end
+
+      def render_cli
+        [
+          "%project_name%/lib/%project_path%/cli/actions/config.rb.erb",
+          "%project_name%/lib/%project_path%/cli/actions/container.rb.erb",
+          "%project_name%/lib/%project_path%/cli/actions/import.rb.erb",
+          "%project_name%/lib/%project_path%/cli/parser.rb.erb",
+          "%project_name%/lib/%project_path%/cli/parsers/core.rb.erb",
+          "%project_name%/lib/%project_path%/cli/shell.rb.erb"
         ].each { |path| builder.call(configuration.merge(template_path: path)).render }
       end
 
@@ -77,7 +85,7 @@ module Gemsmith
         return unless configuration.build_rspec
 
         [
-          "%project_name%/spec/support/shared_contexts/application_container.rb.erb",
+          "%project_name%/spec/support/shared_contexts/application_dependencies.rb.erb",
           "%project_name%/spec/support/shared_examples/a_parser.rb.erb"
         ].each { |path| builder.call(configuration.merge(template_path: path)).render }
       end

data/lib/gemsmith/builders/git/commit.rb

@@ -5,12 +5,15 @@ module Gemsmith
     module Git
       # Builds project skeleton initial Git commit message.
       class Commit
+        include Import[:specification]
+
         def self.call(...) = new(...).call
 
-        def initialize configuration, builder: Rubysmith::Builder, container: Container
+        def initialize configuration, builder: Rubysmith::Builder, **dependencies
+          super(**dependencies)
+
           @configuration = configuration
           @builder = builder
-          @container = container
         end
 
         def call
@@ -28,7 +31,7 @@ module Gemsmith
 
         private
 
-        attr_reader :configuration, :builder, :container
+        attr_reader :configuration, :builder
 
         def body
           <<~CONTENT
@@ -38,8 +41,6 @@ module Gemsmith
         end
 
         def project_name = configuration.project_name
-
-        def specification = container[__method__]
       end
     end
   end

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

@@ -5,9 +5,12 @@ module Gemsmith
     module Actions
       # Handles the config action.
       class Config
-        def initialize client: Configuration::Loader::CLIENT, container: Container
+        include Gemsmith::Import[:kernel, :logger]
+
+        def initialize client: Configuration::Loader::CLIENT, **dependencies
+          super(**dependencies)
+
           @client = client
-          @container = container
         end
 
         def call selection
@@ -20,15 +23,11 @@ module Gemsmith
 
         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/cli/actions/container.rb

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

@@ -8,12 +8,14 @@ module Gemsmith
     module Actions
       # Handles the edit action for editing an installed gem.
       class Edit
+        include Gemsmith::Import[:kernel, :logger]
         include Dry::Monads[:result]
 
-        def initialize picker: Spek::Picker, editor: Tools::Editor.new, container: Container
+        def initialize picker: Spek::Picker, editor: Tools::Editor.new, **dependencies
+          super(**dependencies)
+
           @picker = picker
           @editor = editor
-          @container = container
         end
 
         def call gem_name
@@ -26,13 +28,9 @@ module Gemsmith
 
         private
 
-        attr_reader :picker, :editor, :container
+        attr_reader :picker, :editor
 
         def error(&) = logger.error(&)
-
-        def kernel = container[__method__]
-
-        def logger = container[__method__]
       end
     end
   end

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

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

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

@@ -8,12 +8,14 @@ module Gemsmith
     module Actions
       # Handles the install action.
       class Install
+        include Gemsmith::Import[:logger]
         include Dry::Monads[:result]
 
-        def initialize installer: Tools::Installer.new, loader: Spek::Loader, container: Container
+        def initialize installer: Tools::Installer.new, loader: Spek::Loader, **dependencies
+          super(**dependencies)
+
           @installer = installer
           @loader = loader
-          @container = container
         end
 
         def call configuration
@@ -26,11 +28,9 @@ module Gemsmith
 
         private
 
-        attr_reader :installer, :loader, :container
+        attr_reader :installer, :loader
 
         def error(&) = logger.error(&)
-
-        def logger = container[__method__]
       end
     end
   end

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

@@ -8,12 +8,14 @@ module Gemsmith
     module Actions
       # Handles the publish action.
       class Publish
+        include Gemsmith::Import[:logger]
         include Dry::Monads[:result]
 
-        def initialize publisher: Tools::Publisher.new, loader: Spek::Loader, container: Container
+        def initialize publisher: Tools::Publisher.new, loader: Spek::Loader, **dependencies
+          super(**dependencies)
+
           @publisher = publisher
           @loader = loader
-          @container = container
         end
 
         def call configuration
@@ -26,11 +28,9 @@ module Gemsmith
 
         private
 
-        attr_reader :publisher, :loader, :container
+        attr_reader :publisher, :loader
 
         def error(&) = logger.error(&)
-
-        def logger = container[__method__]
       end
     end
   end

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

@@ -8,12 +8,14 @@ module Gemsmith
     module Actions
       # Handles the view action for viewing an installed gem in default browser.
       class View
+        include Gemsmith::Import[:kernel, :logger]
         include Dry::Monads[:result]
 
-        def initialize picker: Spek::Picker, viewer: Tools::Viewer.new, container: Container
+        def initialize picker: Spek::Picker, viewer: Tools::Viewer.new, **dependencies
+          super(**dependencies)
+
           @picker = picker
           @viewer = viewer
-          @container = container
         end
 
         def call gem_name
@@ -26,13 +28,9 @@ module Gemsmith
 
         private
 
-        attr_reader :picker, :viewer, :container
+        attr_reader :picker, :viewer
 
         def error(&) = logger.error(&)
-
-        def kernel = container[__method__]
-
-        def logger = container[__method__]
       end
     end
   end

data/lib/gemsmith/cli/parser.rb

@@ -6,28 +6,32 @@ 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, 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/cli/parsers/build.rb

@@ -7,16 +7,20 @@ module Gemsmith
     module Parsers
       # Handles parsing of Command Line Interface (CLI) build options.
       class Build
+        include Import[:colorizer]
+
         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 +31,7 @@ module Gemsmith
 
         private
 
-        attr_reader :configuration, :client, :container
+        attr_reader :configuration, :client
 
         def add_cli
           client.on(
@@ -46,8 +50,6 @@ module Gemsmith
                 .then { |boolean| boolean ? colorizer.green(boolean) : colorizer.red(boolean) }
                 .then { |colored_boolean| "Default: #{colored_boolean}" }
         end
-
-        def colorizer = container[__method__]
       end
     end
   end

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

@@ -8,16 +8,19 @@ module Gemsmith
     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 = []
@@ -30,7 +33,7 @@ module Gemsmith
 
         private
 
-        attr_reader :configuration, :client, :container
+        attr_reader :configuration, :client
 
         def collate = private_methods.sort.grep(/add_/).each { |method| __send__ method }
 
@@ -86,8 +89,6 @@ module Gemsmith
             configuration.merge! action_help: true
           end
         end
-
-        def specification = container[__method__]
       end
     end
   end