🚀 modernize gemspec

pboling · pboling · commit 10cfffd9f3f8 · 2025-08-07T15:11:05.000-06:00
diff --git a/.rubocop_gradual.lock b/.rubocop_gradual.lock
@@ -2,6 +2,9 @@
   "lib/month/serializer.rb:1935564184": [
     [8, 5, 63, "Style/ClassMethodsDefinitions: Use `class << self` to define a class method.", 2901108034]
   ],
+  "month-serializer.gemspec:2514259740": [
+    [4, 6, 12, "Gemspec/RubyVersionGlobalsUsage: Do not use `RUBY_VERSION` in gemspec file.", 31296028]
+  ],
   "spec/month/serializer_spec.rb:4160227772": [
     [67, 15, 6, "RSpec/ContextWording: Context description should match /^when\\b/, /^with\\b/, or /^without\\b/.", 3211358934],
     [67, 15, 6, "Style/RedundantInterpolation: Prefer `to_s` over string interpolation.", 3211358934],
diff --git a/docs/Month.html b/docs/Month.html
@@ -269,7 +269,7 @@ <h3 class="signature " id="to_i-instance_method">
 </div>
 
       <div id="footer">
-  Generated on Thu Aug  7 14:15:29 2025 by
+  Generated on Thu Aug  7 15:10:28 2025 by
   <a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   0.9.37 (ruby-3.4.5).
 </div>
diff --git a/docs/Month/Serializer.html b/docs/Month/Serializer.html
@@ -193,7 +193,7 @@ <h3 class="signature first" id="included-class_method">
 </div>
 
       <div id="footer">
-  Generated on Thu Aug  7 14:15:29 2025 by
+  Generated on Thu Aug  7 15:10:28 2025 by
   <a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   0.9.37 (ruby-3.4.5).
 </div>
diff --git a/docs/Month/Serializer/ClassMethods.html b/docs/Month/Serializer/ClassMethods.html
@@ -316,7 +316,7 @@ <h3 class="signature " id="load-instance_method">
 </div>
 
       <div id="footer">
-  Generated on Thu Aug  7 14:15:29 2025 by
+  Generated on Thu Aug  7 15:10:28 2025 by
   <a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   0.9.37 (ruby-3.4.5).
 </div>
diff --git a/docs/_index.html b/docs/_index.html
@@ -142,7 +142,7 @@ <h2>Namespace Listing A-Z</h2>
 </div>
 
       <div id="footer">
-  Generated on Thu Aug  7 14:15:29 2025 by
+  Generated on Thu Aug  7 15:10:28 2025 by
   <a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   0.9.37 (ruby-3.4.5).
 </div>
diff --git a/docs/file.CITATION.html b/docs/file.CITATION.html
@@ -82,7 +82,7 @@
 </div></div>
 
       <div id="footer">
-  Generated on Thu Aug  7 14:15:29 2025 by
+  Generated on Thu Aug  7 15:10:28 2025 by
   <a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   0.9.37 (ruby-3.4.5).
 </div>
diff --git a/docs/file.CODE_OF_CONDUCT.html b/docs/file.CODE_OF_CONDUCT.html
@@ -192,7 +192,7 @@ <h2 id="attribution">Attribution</h2>
 </div></div>
 
       <div id="footer">
-  Generated on Thu Aug  7 14:15:29 2025 by
+  Generated on Thu Aug  7 15:10:28 2025 by
   <a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   0.9.37 (ruby-3.4.5).
 </div>
diff --git a/docs/file.CONTRIBUTING.html b/docs/file.CONTRIBUTING.html
@@ -190,7 +190,7 @@ <h3 id="to-release-a-new-version">To release a new version:</h3>
 </div></div>
 
       <div id="footer">
-  Generated on Thu Aug  7 14:15:29 2025 by
+  Generated on Thu Aug  7 15:10:28 2025 by
   <a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   0.9.37 (ruby-3.4.5).
 </div>
diff --git a/docs/file.LICENSE.html b/docs/file.LICENSE.html
@@ -60,7 +60,7 @@
       <div id="content"><div id='filecontents'>Copyright (c) 2018 Peter H. Boling of RailsBling.com<br><br>MIT License<br><br>Permission is hereby granted, free of charge, to any person obtaining<br>a copy of this software and associated documentation files (the<br>"Software"), to deal in the Software without restriction, including<br>without limitation the rights to use, copy, modify, merge, publish,<br>distribute, sublicense, and/or sell copies of the Software, and to<br>permit persons to whom the Software is furnished to do so, subject to<br>the following conditions:<br><br>The above copyright notice and this permission notice shall be<br>included in all copies or substantial portions of the Software.<br><br>THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,<br>EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF<br>MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND<br>NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE<br>LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION<br>OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION<br>WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.</div></div>
 
       <div id="footer">
-  Generated on Thu Aug  7 14:15:29 2025 by
+  Generated on Thu Aug  7 15:10:28 2025 by
   <a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   0.9.37 (ruby-3.4.5).
 </div>
diff --git a/docs/file.README.html b/docs/file.README.html
@@ -417,7 +417,7 @@ <h2 id="-one-more-thing">🤑 One more thing</h2>
 </div></div>
 
       <div id="footer">
-  Generated on Thu Aug  7 14:15:29 2025 by
+  Generated on Thu Aug  7 15:10:28 2025 by
   <a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   0.9.37 (ruby-3.4.5).
 </div>
diff --git a/docs/file.SECURITY.html b/docs/file.SECURITY.html
@@ -91,7 +91,7 @@ <h2 id="additional-support">Additional Support</h2>
 </div></div>
 
       <div id="footer">
-  Generated on Thu Aug  7 14:15:29 2025 by
+  Generated on Thu Aug  7 15:10:28 2025 by
   <a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   0.9.37 (ruby-3.4.5).
 </div>
diff --git a/docs/index.html b/docs/index.html
@@ -417,7 +417,7 @@ <h2 id="-one-more-thing">🤑 One more thing</h2>
 </div></div>
 
       <div id="footer">
-  Generated on Thu Aug  7 14:15:29 2025 by
+  Generated on Thu Aug  7 15:10:28 2025 by
   <a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   0.9.37 (ruby-3.4.5).
 </div>
diff --git a/docs/top-level-namespace.html b/docs/top-level-namespace.html
@@ -100,7 +100,7 @@ <h2>Defined Under Namespace</h2>
 </div>
 
       <div id="footer">
-  Generated on Thu Aug  7 14:15:29 2025 by
+  Generated on Thu Aug  7 15:10:28 2025 by
   <a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   0.9.37 (ruby-3.4.5).
 </div>
diff --git a/month-serializer.gemspec b/month-serializer.gemspec
@@ -1,29 +1,108 @@
-# NOTE: Have to use __FILE__ until Ruby 1.x support is dropped
-lib = File.expand_path("../lib", __FILE__)
-$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require "month/serializer/version"
+# frozen_string_literal: true
+
+gem_version =
+  if RUBY_VERSION >= "3.1"
+    # Loading Version into an anonymous module allows version.rb to get code coverage from SimpleCov!
+    # See: https://github.com/simplecov-ruby/simplecov/issues/557#issuecomment-2630782358
+    Module.new.tap { |mod| Kernel.load("lib/month/serializer/version.rb", mod) }::Month::Serializer::VERSION
+  else
+    # __dir__ introduced in Ruby 1.9.1
+    lib = File.expand_path("lib", __dir__)
+    $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+    require "month/serializer/version"
+    Month::Serializer::VERSION
+  end
 
 Gem::Specification.new do |spec|
   spec.name = "month-serializer"
-  spec.version = Month::Serializer::VERSION
+  spec.version = gem_version
   spec.authors = ["Peter Boling"]
-  spec.email = ["peter.boling@gmail.com"]
+  spec.email = ["floss@galtzo.com"]
+
+  # Linux distros often package gems and securely certify them independent
+  #   of the official RubyGem certification process. Allowed via ENV["SKIP_GEM_SIGNING"]
+  # Ref: https://gitlab.com/oauth-xx/version_gem/-/issues/3
+  # Hence, only enable signing if `SKIP_GEM_SIGNING` is not set in ENV.
+  # See CONTRIBUTING.md
+  unless ENV.include?("SKIP_GEM_SIGNING")
+    user_cert = "certs/#{ENV.fetch("GEM_CERT_USER", ENV["USER"])}.pem"
+    cert_file_path = File.join(__dir__, user_cert)
+    cert_chain = cert_file_path.split(",")
+    cert_chain.select! { |fp| File.exist?(fp) }
+    if cert_file_path && cert_chain.any?
+      spec.cert_chain = cert_chain
+      if $PROGRAM_NAME.end_with?("gem") && ARGV[0] == "build"
+        spec.signing_key = File.join(Gem.user_home, ".ssh", "gem-private_key.pem")
+      end
+    end
+  end
 
   spec.summary = "Serialize Month objects to Integer"
   spec.description = "Serialize Month objects to Integer"
-  spec.homepage = "https://github.com/pboling/month-serializer"
+  spec.homepage = "https://github.com/galtzo-floss/#{spec.name}"
   spec.license = "MIT"
+  spec.required_ruby_version = ">= 1.9.3"
 
-  # Specify which files should be added to the gem when it is released.
-  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
-  spec.files = %x(git ls-files -z).split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
-  spec.bindir = "exe"
-  spec.executables = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.metadata["homepage_uri"] = "https://#{spec.name.tr("_", "-")}.galtzo.com/"
+  spec.metadata["source_code_uri"] = "#{spec.homepage}/tree/v#{spec.version}"
+  spec.metadata["changelog_uri"] = "#{spec.homepage}/blob/v#{spec.version}/CHANGELOG.md"
+  spec.metadata["bug_tracker_uri"] = "#{spec.homepage}/issues"
+  spec.metadata["documentation_uri"] = "https://www.rubydoc.info/gems/#{spec.name}/#{spec.version}"
+  spec.metadata["funding_uri"] = "https://github.com/sponsors/pboling"
+  spec.metadata["wiki_uri"] = "#{spec.homepage}/wiki"
+  spec.metadata["news_uri"] = "https://www.railsbling.com/tags/#{spec.name}"
+  spec.metadata["discord_uri"] = "https://discord.gg/3qme4XHNKN"
+  spec.metadata["rubygems_mfa_required"] = "true"
+
+  # Specify which files are part of each release.
+  spec.files = Dir[
+    # Splats (alphabetical)
+    "lib/**/*.rb",
+  ]
+  # Automatically included with gem package, no need to list again in files.
+  spec.extra_rdoc_files = Dir[
+    # Files (alphabetical)
+    "CHANGELOG.md",
+    "CODE_OF_CONDUCT.md",
+    "CONTRIBUTING.md",
+    "LICENSE.txt",
+    "README.md",
+    "SECURITY.md",
+  ]
+  spec.rdoc_options += [
+    "--title",
+    "#{spec.name} - #{spec.summary}",
+    "--main",
+    "CHANGELOG.md",
+    "CODE_OF_CONDUCT.md",
+    "CONTRIBUTING.md",
+    "LICENSE.txt",
+    "README.md",
+    "SECURITY.md",
+    "--line-numbers",
+    "--inline-source",
+    "--quiet",
+  ]
   spec.require_paths = ["lib"]
-  spec.required_ruby_version = ">= 1.9.3"
+  spec.bindir = "exe"
+  spec.executables = []
 
   spec.add_runtime_dependency("month", ">= 1.4.0")                      # ruby >= 1.9.3, v2 is ruby >= 2.6
 
+  # NOTE: It is preferable to list development dependencies in the gemspec due to increased
+  #       visibility and discoverability on RubyGems.org.
+  #       However, development dependencies in gemspec will install on
+  #       all versions of Ruby that will run in CI.
+  #       This gem, and its runtime dependencies, will install on Ruby down to 1.9.3.
+  #       This gem, and its development dependencies, will install on Ruby down to 2.3.x.
+  #       This is because in CI easy installation of Ruby, via setup-ruby, is for >= 2.3.
+  #       Thus, dev dependencies in gemspec must have
+  #
+  #       required_ruby_version ">= 2.3" (or lower)
+  #
+  #       Development dependencies that require strictly newer Ruby versions should be in a "gemfile",
+  #       and preferably a modular one (see gemfiles/modular/*.gemfile).
+
   # Release Tasks
   spec.add_development_dependency("stone_checksums", "~> 1.0")          # ruby >= 2.2.0
 
