gemsmith 18.1.0 → 18.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 28fb66ba1ffc978d88dad82d5b14e898581da78cb8c599c9ba702b6a68c6ad21
-  data.tar.gz: 8cb98c3f67fcbc64cac58706430431b14429a7a5ad0399f14d03db04eb3f9215
+  metadata.gz: 338623748228d9c9d9560b315ca568e01b2aa0e261f83215d3b55dc0eae22074
+  data.tar.gz: 07cc383d025d2dc06574fb6e5b5b9b6784bea87f8108387bcb6a0fff1e0c7599
 SHA512:
-  metadata.gz: afe90b17b858eae6e574b1f41af7b5ed9f7b95b421ff52a4726ce2a837116a3ceb759ab610e2a5eef06a088070773c96ce7467449e18ac3f6354a86efef18fbb
-  data.tar.gz: 47302fcdba57685e3c5b1f46cc082974194eb81217e350960aed20fd696c75a0741dc795cea271b1266955035b86e8c719ea5d1ef56fcbbf1842e9fb71654b63
+  metadata.gz: cb882950b11cb0b27a74e4ecffe3b48038b538a94fe02c4e5b68c5e501004b5e8439860efd6aba51dd634197d6062a7808daef84217b23bce83a961c14d2741b
+  data.tar.gz: 181b13d0cd991d906c4e92f4668ee0b2ca27aa47de3b84fefa1ecdf5d0a0dfeb1f5d64998d33ccd9221c2abc653def248508261f9907b0e09bb41f7ec9a38b2f

data/README.adoc

@@ -25,15 +25,6 @@ toc::[]
 . link:https://www.ruby-lang.org[Ruby].
 . link:https://rubygems.org[RubyGems].
 
-== Setup
-
-To install, run:
-
-[source,bash]
-----
-gem install gemsmith
-----
-
 == Upgrade
 
 If upgrading from 17.0.0 to 18.0.0, you'll want to be aware of the following changes:
@@ -43,6 +34,15 @@ If upgrading from 17.0.0 to 18.0.0, you'll want to be aware of the following cha
   ability to sign tags has been removed (this happens dynamically based on your Git configuration
   which gives you more flexibility).
 
+== Setup
+
+To install, run:
+
+[source,bash]
+----
+gem install gemsmith
+----
+
 == Usage
 
 === Command Line Interface (CLI)
@@ -222,6 +222,20 @@ the following:
 Feel free to take the combined Rubysmith + Gemsmith configuration, modify, and save as your own
 custom `configuration.yml`.
 
+It is recommended that you provide URLs for your project which would be all keys found in this
+section:
+
+[source,yaml]
+----
+:project:
+  :url:
+    # Add sub-key values here.
+----
+
+When these values exist, you'll benefit from having this information added to your generated
+`gemspec` and project documentation. Otherwise -- if these values are empty -- they are removed from
+new gem generation.
+
 === Workflows
 
 When building/testing your gem locally, a typical workflow is:
@@ -324,7 +338,7 @@ specification and RubyGems credentials.
 
 === Gem Specification Metadata
 
-Add the following metadata to your gemspec:
+Add the following gemspec metadata to privately publish new versions of your gem:
 
 [source,ruby]
 ----
@@ -365,10 +379,10 @@ to our private server. This is important because this is how we link our gem spe
 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.
+# Gem Specification: The 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.
+# Gem Credentials: The URL value -- shown above -- which becomes the key for enabling authentication.
 https://private.example.com: Basic dXNlcjpwYXNzd29yZA==
 ....
 
@@ -397,6 +411,49 @@ Lastly, should you need to delete a credential (due to a bad login/password for
 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.
 
+=== Bundler Configuration
+
+So far, I've shown how to privately _publish_ a gem but now we need to teach Bundler how to install
+the gem as dependency within your upstream project. For demonstration purposes, I'm going to assume
+you are using GitHub Packages as your private gem server. You should be able to quickly translate
+this documentation if using an alternate private gem server, though.
+
+The first step is to create your own GitHub Personal Access Token (PAT) which is fast to do by
+following GitHub's own
+link:https://docs.github.com/en/authentication/keeping-your-account-and-data-secure/creating-a-personal-access-token[documentation].
+At a minimum, you'll need to enable _repo_ and _packages_ scopes with read/write access.
+
+With your PAT in hand, you'll need to ensure link:https://bundler.io[Bundler] can authenticate to
+the private GitHub Packages gem server by running the following:
+
+[source,bash]
+----
+bundle config set --global rubygems.pkg.github.com <your GitHub handle>:<PAT>
+# Example: bundle config set --global rubygems.pkg.github.com jdoe:ghp_c5b8d394abefebbf45c7b27b379c74978923
+----
+
+💡 Using Bundler's `--global` flag ensures you only have to define these credentials once for _all_
+projects which reduces maintenance burden on you. The path to this global configuration can be found
+here: `$HOME/.config/bundler/configuration.yml`.
+
+Lastly, you can add this gem to your `Gemfile` as follows:
+
+[source,ruby]
+----
+source "https://rubygems.pkg.github.com/alchemists" do
+  gem "demo", "~> 0.0"
+end
+----
+
+At this point -- if you run `bundle install` -- you should see the following in your console:
+
+....
+Fetching gem metadata from https://rubygems.pkg.github.com/alchemists/...
+Resolving dependencies...Fetching gem metadata from https://rubygems.org/.....
+....
+
+If so, you're all set!
+
 === GitHub Actions/Packages Automation
 
 Earlier, I hinted at using GitHub Packages but what if you could automate the entire publishing

data/gemsmith.gemspec

@@ -2,7 +2,7 @@
 
 Gem::Specification.new do |spec|
   spec.name = "gemsmith"
-  spec.version = "18.1.0"
+  spec.version = "18.3.0"
   spec.authors = ["Brooke Kuhlmann"]
   spec.email = ["brooke@alchemists.io"]
   spec.homepage = "https://www.alchemists.io/projects/gemsmith"
@@ -23,16 +23,16 @@ 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 "auto_injector", "~> 0.5"
+  spec.add_dependency "cogger", "~> 0.1"
   spec.add_dependency "dry-container", "~> 0.9"
   spec.add_dependency "dry-monads", "~> 1.4"
   spec.add_dependency "milestoner", "~> 14.0"
-  spec.add_dependency "refinements", "~> 9.2"
-  spec.add_dependency "rubysmith", "~> 3.1"
-  spec.add_dependency "runcom", "~> 8.2"
-  spec.add_dependency "spek", "~> 0.2"
-  spec.add_dependency "versionaire", "~> 10.0"
+  spec.add_dependency "refinements", "~> 9.4"
+  spec.add_dependency "rubysmith", "~> 3.3"
+  spec.add_dependency "runcom", "~> 8.4"
+  spec.add_dependency "spek", "~> 0.3"
+  spec.add_dependency "versionaire", "~> 10.3"
   spec.add_dependency "zeitwerk", "~> 2.5"
 
   spec.bindir = "exe"

data/lib/gemsmith/builders/specification.rb

@@ -20,6 +20,8 @@ module Gemsmith
 
         builder.call(config)
                .render
+               .replace("    \n", "")
+               .replace("      ", "    ")
                .replace("  \n", "")
                .replace("    spec", "  spec")
                .replace(/\}\s+s/m, "}\n\n  s")

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

@@ -5,6 +5,8 @@ module Gemsmith
     module Actions
       # Handles the build action.
       class Build
+        include Gemsmith::Import[:logger]
+
         # Order is important.
         BUILDERS = [
           Rubysmith::Builders::Core,
@@ -40,15 +42,22 @@ module Gemsmith
           Builders::Git::Commit
         ].freeze
 
-        def initialize builders: BUILDERS
+        def initialize builders: BUILDERS, **dependencies
+          super(**dependencies)
           @builders = builders
         end
 
-        def call(configuration) = builders.each { |builder| builder.call configuration }
+        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 :configuration, :builders
+        attr_reader :builders
+
+        def log_info(message) = logger.info { message }
       end
     end
   end

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

@@ -8,13 +8,25 @@ Gem::Specification.new do |spec|
   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 %>",
-    "funding_uri" => "<%= configuration.computed_project_url_funding %>",
+    <% unless configuration.computed_project_url_issues.empty? %>
+      "bug_tracker_uri" => "<%= configuration.computed_project_url_issues %>",
+    <% end %>
+    <% unless configuration.computed_project_url_versions.empty? %>
+      "changelog_uri" => "<%= configuration.computed_project_url_versions %>",
+    <% end %>
+    <% unless configuration.computed_project_url_home.empty? %>
+      "documentation_uri" => "<%= configuration.computed_project_url_home %>",
+    <% end %>
+    <% unless configuration.computed_project_url_funding.empty? %>
+      "funding_uri" => "<%= configuration.computed_project_url_funding %>",
+    <% end %>
     "label" => "<%= configuration.project_label %>",
-    "rubygems_mfa_required" => "true",
-    "source_code_uri" => "<%= configuration.computed_project_url_source %>"
+    <% if configuration.computed_project_url_source.empty? %>
+      "rubygems_mfa_required" => "true"
+    <% else %>
+      "rubygems_mfa_required" => "true",
+      "source_code_uri" => "<%= configuration.computed_project_url_source %>"
+    <% end %>
   }
 
   <% if configuration.build_security %>
@@ -24,19 +36,19 @@ Gem::Specification.new do |spec|
 
   spec.required_ruby_version = "~> <%= RUBY_VERSION[/\d+\.\d+/] %>"
   <% if configuration.build_cli %>
-    spec.add_dependency "auto_injector", "~> 0.4"
+    spec.add_dependency "auto_injector", "~> 0.5"
   <% end %>
   <% if configuration.build_cli %>
     spec.add_dependency "dry-container", "~> 0.9"
   <% end %>
   <% if configuration.build_refinements %>
-    spec.add_dependency "refinements", "~> 9.2"
+    spec.add_dependency "refinements", "~> 9.4"
   <% end %>
   <% if configuration.build_cli %>
-    spec.add_dependency "runcom", "~> 8.2"
+    spec.add_dependency "runcom", "~> 8.4"
   <% end %>
   <% if configuration.build_cli %>
-    spec.add_dependency "spek", "~> 0.2"
+    spec.add_dependency "spek", "~> 0.3"
   <% end %>
   <% if configuration.build_zeitwerk %>
     spec.add_dependency "zeitwerk", "~> 2.5"

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: gemsmith
 version: !ruby/object:Gem::Version
-  version: 18.1.0
+  version: 18.3.0
 platform: ruby
 authors:
 - Brooke Kuhlmann
@@ -28,7 +28,7 @@ cert_chain:
   CxDe2+VuChj4I1nvIHdu+E6XoEVlanUPKmSg6nddhkKn2gC45Kyzh6FZqnzH/CRp
   RFE=
   -----END CERTIFICATE-----
-date: 2022-04-30 00:00:00.000000000 Z
+date: 2022-05-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: auto_injector
@@ -36,28 +36,28 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.4'
+        version: '0.5'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.4'
+        version: '0.5'
 - !ruby/object:Gem::Dependency
   name: cogger
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.0'
+        version: '0.1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.0'
+        version: '0.1'
 - !ruby/object:Gem::Dependency
   name: dry-container
   requirement: !ruby/object:Gem::Requirement
@@ -106,70 +106,70 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '9.2'
+        version: '9.4'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '9.2'
+        version: '9.4'
 - !ruby/object:Gem::Dependency
   name: rubysmith
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.1'
+        version: '3.3'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.1'
+        version: '3.3'
 - !ruby/object:Gem::Dependency
   name: runcom
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '8.2'
+        version: '8.4'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '8.2'
+        version: '8.4'
 - !ruby/object:Gem::Dependency
   name: spek
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.2'
+        version: '0.3'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.2'
+        version: '0.3'
 - !ruby/object:Gem::Dependency
   name: versionaire
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '10.3'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '10.3'
 - !ruby/object:Gem::Dependency
   name: zeitwerk
   requirement: !ruby/object:Gem::Requirement
@@ -280,7 +280,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.12
+rubygems_version: 3.3.14
 signing_key:
 specification_version: 4
 summary: A command line interface for smithing Ruby gems.