gemsmith 18.1.1 → 18.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: efa40f1261ef7850d3675a9a7ce4dc529a9440767c74ea7ac51737367feb176a
-  data.tar.gz: b7d00bdacacd6031710d3c60867db5a76c23af9043916baf5c97c8b86a455fb3
+  metadata.gz: f46e60199854be3dd1eb4bb2c19964558efd399abdd5ee92fb6f0301bcf29478
+  data.tar.gz: aef41826ceceaefae5047debd54054ef9d50ca132f782664df3cd3afc56092de
 SHA512:
-  metadata.gz: 4a0bb9fb6b20c9314b513a6c63b0d7e0f508ad968df59e4e50c2b31f28e1de0b25ab0e277ddc2ec3f203247394b93f930cc4cd5f347a8cd2a407d220030395e4
-  data.tar.gz: 2bab2e73aaf57e439302744e2a0099130b4da472eba6908abf78bfbb3f0ca0df34d1cd6190e8ba7c300a0d580a5ffefde31782e137426c41ec033467a9f06e6f
+  metadata.gz: 8d1f47132e8b86cdca3e6203dbee344a47552f02c24bc30ce77bbdecc2d86c17819367da4bcdd63d9c5cabf49c926d2c188644136931bceb294844e93bfc59da
+  data.tar.gz: e99a9467c8e2fd71fd356fc3b9abcae35f60d35b2171b61f6bdd8d550fe34b0581de78261259ec379c24b454c5d67c5dd830fe1c12e6d3c0e2881a29fabd0b6c

data/README.adoc

@@ -338,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]
 ----
@@ -379,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==
 ....
 
@@ -411,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.1"
+  spec.version = "18.2.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.2"
+  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/templates/%project_name%/%project_name%.gemspec.erb

@@ -36,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.1
+  version: 18.2.0
 platform: ruby
 authors:
 - Brooke Kuhlmann
@@ -28,7 +28,7 @@ cert_chain:
   CxDe2+VuChj4I1nvIHdu+E6XoEVlanUPKmSg6nddhkKn2gC45Kyzh6FZqnzH/CRp
   RFE=
   -----END CERTIFICATE-----
-date: 2022-05-01 00:00:00.000000000 Z
+date: 2022-05-07 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.2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.1'
+        version: '3.2'
 - !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.13
 signing_key:
 specification_version: 4
 summary: A command line interface for smithing Ruby gems.