gemsmith 18.0.2 → 18.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: badab9b933b3cc8009dcce38b6c849c38e7b6d90fb849bda9ba3426e9d8c76fe
-  data.tar.gz: 48386d0058700e7ab46b0ce1189b8264f7c0dcf75f4e2d11b0a702c5bb82a858
+  metadata.gz: f46e60199854be3dd1eb4bb2c19964558efd399abdd5ee92fb6f0301bcf29478
+  data.tar.gz: aef41826ceceaefae5047debd54054ef9d50ca132f782664df3cd3afc56092de
 SHA512:
-  metadata.gz: 3dcd01d2e1c468062c19c060e080140eb6fd5da9dbbc408bdd0a4bdaa2db6e45e7bfdf066d94719380410a3f96d268a38632ff67bd01f4bfe07cc7fa1899e063
-  data.tar.gz: e43ce7b51bb41176925c911f80d40e8c88d464ce84e7effdf03ef4f0d1a09dc40737bf605aefa3db816e8fed511a7a56cef94b82b06f9ee1c90845b58ae6b4a5
+  metadata.gz: 8d1f47132e8b86cdca3e6203dbee344a47552f02c24bc30ce77bbdecc2d86c17819367da4bcdd63d9c5cabf49c926d2c188644136931bceb294844e93bfc59da
+  data.tar.gz: e99a9467c8e2fd71fd356fc3b9abcae35f60d35b2171b61f6bdd8d550fe34b0581de78261259ec379c24b454c5d67c5dd830fe1c12e6d3c0e2881a29fabd0b6c

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)
@@ -71,6 +71,7 @@ BUILD OPTIONS:
       --[no-]console                       Add console script. Default: true.
       --[no-]contributions                 Add contributions documentation. Default: true.
       --[no-]debug                         Add Debug gem. Default: true.
+      --[no-]funding                       Add GitHub funding configuration. Default: false.
       --[no-]git                           Add Git. Default: true.
       --[no-]git_hub                       Add GitHub templates. Default: false.
       --[no-]git-lint                      Add Git Lint gem. Default: true.
@@ -221,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:
@@ -290,8 +305,8 @@ gem cert --build you@example.com
 chmod 600 gem-*.pem
 ----
 
-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:
+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]
 ----
@@ -323,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]
 ----
@@ -332,7 +347,7 @@ Gem::Specification.new do |spec|
 end
 ----
 
-💡 The gemspec metadata _must_ be strings per the
+💡 The gemspec metadata (i.e. keys and values) _must_ be strings per the
 link:https://guides.rubygems.org/specification-reference/#metadata[RubyGems Specification].
 
 Use of the `allowed_push_host` key provides two important capabilities:
@@ -360,19 +375,19 @@ https://private.example.com: Basic dXNlcjpwYXNzd29yZA==
 
 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:
+to our private server. This is important because 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.
+# 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==
 ....
 
-When the above are linked together like this, you enable Gemsmith to publish your gem using only the
-following command:
+When the above are linked together, you enable Gemsmith to publish your gem using only the following
+command:
 
 [source,bash]
 ----
@@ -380,8 +395,9 @@ 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):
+link:https://docs.github.com/en/packages/working-with-a-github-packages-registry/working-with-the-rubygems-registry[GitHub
+Packages] which would look like this when properly configured (truncated for brevity while using
+fake data):
 
 ....
 # Gem specification
@@ -395,6 +411,105 @@ 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
+process? Well, good news, you can by using GitHub Actions to publish your packages. Here's the YAML
+necessary to accomplish this endeavor:
+
+``` yaml
+name: Gemsmith
+
+on:
+  push:
+    branches: main
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    container:
+      image: ruby:latest
+    permissions:
+      contents: write
+      packages: write
+
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v3
+        with:
+          fetch-depth: '0'
+          ref: ${{github.head_ref}}
+      - name: Setup
+        run: |
+          git config user.email "engineering@example.com"
+          git config user.name "Gemsmith Publisher"
+          mkdir -p $HOME/.gem
+          printf "%s\n" "https://rubygems.pkg.github.com/example: Bearer ${{secrets.GITHUB_TOKEN}}" > $HOME/.gem/credentials
+          chmod 0600 $HOME/.gem/credentials
+      - name: Install
+        run: gem install gemsmith
+      - name: Publish
+        run: |
+          if git describe --tags --abbrev=0 > /dev/null 2>&1; then
+            gemsmith --publish
+          else
+            printf "%s\n" "First gem version must be manually created. Skipping."
+          fi
+```
+
+The above will ensure the following:
+
+* Only the first version requires manual publishing (hence the check for existing Git tags).
+* Duplicate versions are always skipped.
+* Only when a new version is detected (by changing your gemspec version) and you are on the `main`
+  branch will a new version be automatically published.
+
+This entire workflow is explained in my
+link:https://www.alchemists.io/talks/ruby_git_hub_packages[talk] on this exact subject too.
+
 == Promotion
 
 Once your gem is released, let the world know about your accomplishment by posting an update to
@@ -402,7 +517,6 @@ these sites:
 
 * link:https://rubyflow.com[RubyFlow]
 * link:https://ruby.libhunt.com[Ruby Library Hunt]
-* link:https://rubydaily.org[RubyDaily]
 * link:https://awesome-ruby.com[Awesome Ruby]
 * link:https://www.ruby-toolbox.com[Ruby Toolbox]
 * link:https://www.ruby-lang.org/en/community[Ruby Community]

data/gemsmith.gemspec

@@ -2,7 +2,7 @@
 
 Gem::Specification.new do |spec|
   spec.name = "gemsmith"
-  spec.version = "18.0.2"
+  spec.version = "18.2.0"
   spec.authors = ["Brooke Kuhlmann"]
   spec.email = ["brooke@alchemists.io"]
   spec.homepage = "https://www.alchemists.io/projects/gemsmith"
@@ -13,6 +13,7 @@ Gem::Specification.new do |spec|
     "bug_tracker_uri" => "https://github.com/bkuhlmann/gemsmith/issues",
     "changelog_uri" => "https://www.alchemists.io/projects/gemsmith/versions",
     "documentation_uri" => "https://www.alchemists.io/projects/gemsmith",
+    "funding_uri" => "https://github.com/sponsors/bkuhlmann",
     "label" => "Gemsmith",
     "rubygems_mfa_required" => "true",
     "source_code_uri" => "https://github.com/bkuhlmann/gemsmith"
@@ -22,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.0"
-  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/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/templates/%project_name%/%project_name%.gemspec.erb

@@ -8,12 +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 %>",
+    <% 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 %>
@@ -23,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.0.2
+  version: 18.2.0
 platform: ruby
 authors:
 - Brooke Kuhlmann
@@ -28,7 +28,7 @@ cert_chain:
   CxDe2+VuChj4I1nvIHdu+E6XoEVlanUPKmSg6nddhkKn2gC45Kyzh6FZqnzH/CRp
   RFE=
   -----END CERTIFICATE-----
-date: 2022-04-22 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.0'
+        version: '3.2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.0'
+        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
@@ -261,6 +261,7 @@ metadata:
   bug_tracker_uri: https://github.com/bkuhlmann/gemsmith/issues
   changelog_uri: https://www.alchemists.io/projects/gemsmith/versions
   documentation_uri: https://www.alchemists.io/projects/gemsmith
+  funding_uri: https://github.com/sponsors/bkuhlmann
   label: Gemsmith
   rubygems_mfa_required: 'true'
   source_code_uri: https://github.com/bkuhlmann/gemsmith
@@ -279,7 +280,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.11
+rubygems_version: 3.3.13
 signing_key:
 specification_version: 4
 summary: A command line interface for smithing Ruby gems.