rubysmith 3.0.1 → 3.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 28d9da463ce61272245120154c2aefcf3b25a7f03ef1df0317ab1ceff296adfc
-  data.tar.gz: 9e9a11cd02ce232eba3b0cc4c952fdd2a8874d457f53bf5c2749bacce43cb809
+  metadata.gz: 8782be480f3bd0158ed695d554cc914848c84184522b56592ea7a9502d0cb08b
+  data.tar.gz: 433862359a53831ab86bfa749058c0a354e3f60beae94fbce701cefdb1239a87
 SHA512:
-  metadata.gz: '09a1e6fe56a7a6f50809be782facc05cdd99329c5dcccfed8bc260d874d65bdb1a0105b5bee7f26e698cdf625b3e52a18e219cda80f3154a8d09aa13c583b01c'
-  data.tar.gz: 74315335eae556669c75b0e091d5491fc5ceb35755906f5c8217a3d922b3ca87973360a3de60f5283d46cdf3e61c8bf91ab3f44bdf88fa4bc5125285cb41e101
+  metadata.gz: e6cc4230cdbe3ebdd878d18ccb22b7d52d67988808c068d6dcc927a2bf5d635d674a0fda503a28b08a146278780843421a20847189a5e7511080e60c136be697
+  data.tar.gz: 40b490e0db3497120660c4916a3f66453be792b687e595dc275671ddb93e7561aec0856af9e67a73dfac8b4d460e508d145ffab02211750009697bac328543c5

data/README.adoc

@@ -1,3 +1,5 @@
+:gemsmith_link: link:https://www.alchemists.io/projects/gemsmith[Gemsmith]
+
 :toc: macro
 :toclevels: 5
 :figure-caption!:
@@ -8,11 +10,10 @@ Rubysmith is a command line interface for smithing Ruby projects.
 
 This gem is useful in situations in which you need something more sophisticated than a
 link:https://bundler.io/guides/bundler_in_a_single_file_ruby_script.html[Bundler Inline] script but
-less than a link:https://www.alchemists.io/projects/gemsmith[Gemsmith] gem. Rubysmith is the
-foundation of Gemsmith and provides much of the same functionality as Gemsmith but is solely
-tailored for pure Ruby projects. Again, this is a great tool for spiking quick Ruby implementations,
-sharing code snippets with others, or building full blown Ruby projects for collaboration with
-others.
+less than a {gemsmith_link} gem. Rubysmith is the foundation of Gemsmith and provides much of the
+same functionality as Gemsmith but is solely tailored for pure Ruby projects. Again, this is a great
+tool for spiking quick Ruby implementations, sharing code snippets with others, or building full
+blown Ruby projects for collaboration with others.
 
 toc::[]
 
@@ -99,6 +100,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.
@@ -229,6 +231,12 @@ The `--debug` option allows you add the link:https://github.com/ruby/debug[Debug
 project for debugging your code by setting breakpoints, remotely connecting to running code, and
 much more.
 
+==== Funding
+
+The `--funding` option allows you add a link:https://github.com[GitHub] funding configuration to
+your project so you can attract link:https://docs.github.com/en/sponsors[sponsors]. This option
+doesn't require use of the `--git_hub` option but is encouraged.
+
 ==== Git
 
 The `--git` option allows you add link:https://git-scm.com[Git] repository support.
@@ -363,6 +371,7 @@ variables. The default configuration is as follows:
   :console: true
   :contributions: true
   :debug: true
+  :funding: false
   :git: true
   :git_hub: false
   :git_lint: true
@@ -428,6 +437,7 @@ variables. The default configuration is as follows:
     :conduct:
     :contributions:
     :download:
+    :funding:
     :home:
     :issues:
     :license:
@@ -463,11 +473,11 @@ custom values as desired. The URL is the only value that can't be automatically
 ==== Build
 
 All build options accept booleans values only and can be customized as desired. When changing your
-build options, they will dynamically render when display usage (i.e. `rubysmith --help`). All of
-these options are explained in greater detail above.
+build options, they will dynamically render when displaying usage (i.e. `rubysmith --help`). All of
+these options have been explained in greater detail in the _Usage_ section.
 
-ℹ️ There is a `cli` configuration option but is only used to support
-link:https://www.alchemists.io/projects/gemsmith[Gemsmith].
+ℹ️ The `cli` option is provided to support the {gemsmith_link} gem but is not, currently, used by
+this project.
 
 ==== Citations
 
@@ -498,7 +508,7 @@ Follow the above links to learn more about each extension's gem configuration.
 ==== GitHub
 
 Your GitHub user is the handle you setup when creating your GitHub account. This information is used
-for template and/or URL construction purposes.
+for template, funding, and/or URL construction purposes.
 
 ==== License
 
@@ -512,8 +522,11 @@ license are available:
 ==== Project
 
 There are two sub-categories within this section: URLs and version. The URLs allow you to link to
-specific documentation related to your project. You'll definitely want to customize these as makes
-sense since these URLs are used for documentation, citations, and general project information. You
+specific documentation related to your project. You'll want to customize these URLs since they are
+used for documentation, citations, and general project information. Some of the URLs are also used
+by the {gemsmith_link} gem.
+
+You
 can also use `%project_name%` as a placeholder anywhere in your URL and Rubysmith will ensure your
 place holder is replaced with your project name when generating a new project. Example:
 
@@ -574,5 +587,5 @@ bundle exec rake
 
 == Credits
 
-* Built with link:https://www.alchemists.io/projects/gemsmith[Gemsmith].
+* Built with {gemsmith_link}.
 * Engineered by link:https://www.alchemists.io/team/brooke_kuhlmann[Brooke Kuhlmann].

data/lib/rubysmith/builder.rb

@@ -22,49 +22,49 @@ module Rubysmith
     end
 
     def append content
-      logger.info "Appending: #{relative_build_path}"
+      log_debug "Appending: #{relative_build_path}"
       build_path.rewrite { |body| body + content }
       self
     end
 
     def delete
-      logger.info "Deleting: #{relative_build_path}"
+      log_debug "Deleting: #{relative_build_path}"
       build_path.delete
       self
     end
 
     def insert_before pattern, content
-      logger.info "Inserting content before pattern in: #{relative_build_path}"
+      log_debug "Inserting content before pattern in: #{relative_build_path}"
       build_path.write inserter.new(build_path.readlines, :before).call(content, pattern).join
       self
     end
 
     def insert_after pattern, content
-      logger.info "Inserting content after pattern in: #{relative_build_path}"
+      log_debug "Inserting content after pattern in: #{relative_build_path}"
       build_path.write inserter.new(build_path.readlines, :after).call(content, pattern).join
       self
     end
 
     def permit mode
-      logger.info "Changing permissions for: #{relative_build_path}"
+      log_debug "Changing permissions for: #{relative_build_path}"
       build_path.chmod mode
       self
     end
 
     def prepend content
-      logger.info "Prepending content to: #{relative_build_path}"
+      log_debug "Prepending content to: #{relative_build_path}"
       build_path.rewrite { |body| content + body }
       self
     end
 
     def rename name
-      logger.info "Renaming: #{build_path.basename} to #{name}"
+      log_debug "Renaming: #{build_path.basename} to #{name}"
       build_path.rename build_path.parent.join(name)
       self
     end
 
     def render
-      logger.info "Rendering: #{relative_build_path}"
+      log_debug "Rendering: #{relative_build_path}"
 
       pathway.start_path.read.then do |content|
         build_path.make_ancestors.write renderer.call(content)
@@ -74,21 +74,21 @@ module Rubysmith
     end
 
     def replace pattern, content
-      logger.info "Replacing content for patterns in: #{relative_build_path}"
+      log_debug "Replacing content for patterns in: #{relative_build_path}"
       build_path.rewrite { |body| body.gsub pattern, content }
       self
     end
 
     def run *command
-      logger.info "Running: #{command}"
+      log_debug "Running: #{command}"
       execute(*command)
       self
     rescue StandardError => error
-      logger.error error and self
+      log_error error and self
     end
 
     def touch
-      logger.info "Touching: #{relative_build_path}"
+      log_debug "Touching: #{relative_build_path}"
       build_path.deep_touch
       self
     end
@@ -99,7 +99,7 @@ module Rubysmith
 
     def execute *command
       kernel.capture2e(*command).then do |result, status|
-        logger.error result unless status.success?
+        log_error result unless status.success?
       end
     end
 
@@ -119,5 +119,9 @@ module Rubysmith
     end
 
     def pathway = configuration.pathway
+
+    def log_debug(message) = logger.debug { message }
+
+    def log_error(message) = logger.error { message }
   end
 end

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

@@ -5,9 +5,13 @@ module Rubysmith
     module Git
       # Builds project skeleton initial Git commit message.
       class Commit
+        include Import[:specification]
+
         def self.call(...) = new(...).call
 
-        def initialize configuration, builder: Builder
+        def initialize configuration, builder: Builder, **dependencies
+          super(**dependencies)
+
           @configuration = configuration
           @builder = builder
         end
@@ -31,8 +35,8 @@ module Rubysmith
 
         def body
           <<~CONTENT
-            Generated with [Rubysmith](https://www.alchemists.io/projects/rubysmith)
-            1.1.1.
+            Generated with [#{specification.label}](#{specification.homepage_url})
+            #{specification.version}.
           CONTENT
         end
 

data/lib/rubysmith/builders/git_hub.rb

@@ -16,6 +16,8 @@ module Rubysmith
       end
 
       def call
+        render_funding
+
         return configuration unless configuration.build_git_hub
 
         builder.call(with_issue_template).render
@@ -27,6 +29,13 @@ module Rubysmith
 
       attr_reader :configuration, :builder
 
+      def render_funding
+        return unless configuration.build_funding
+
+        configuration.merge(template_path: "%project_name%/.github/FUNDING.yml.erb")
+                     .then { |updated_configuration| builder.call(updated_configuration).render }
+      end
+
       def with_issue_template
         configuration.merge template_path: "%project_name%/.github/ISSUE_TEMPLATE.md.erb"
       end

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

@@ -5,6 +5,8 @@ module Rubysmith
     module Actions
       # Handles the build action.
       class Build
+        include Rubysmith::Import[:logger]
+
         # Order is important.
         BUILDERS = [
           Builders::Core,
@@ -33,15 +35,22 @@ module Rubysmith
           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/rubysmith/cli/parsers/build.rb

@@ -124,6 +124,15 @@ module Rubysmith
           end
         end
 
+        def add_funding
+          client.on(
+            "--[no-]funding",
+            "Add GitHub funding configuration. #{default __method__}."
+          ) do |value|
+            configuration.merge! build_funding: value
+          end
+        end
+
         def add_git
           client.on(
             "--[no-]git",

data/lib/rubysmith/configuration/content.rb

@@ -33,6 +33,7 @@ module Rubysmith
       :build_console,
       :build_contributions,
       :build_debug,
+      :build_funding,
       :build_git,
       :build_git_hub,
       :build_git_lint,
@@ -71,6 +72,7 @@ module Rubysmith
       :project_url_conduct,
       :project_url_contributions,
       :project_url_download,
+      :project_url_funding,
       :project_url_home,
       :project_url_issues,
       :project_url_license,
@@ -129,6 +131,8 @@ module Rubysmith
 
       def computed_project_url_download = format_url(__method__)
 
+      def computed_project_url_funding = format_url(__method__)
+
       def computed_project_url_home = format_url(__method__)
 
       def computed_project_url_issues = format_url(__method__)

data/lib/rubysmith/configuration/defaults.yml

@@ -15,6 +15,7 @@
   :console: true
   :contributions: true
   :debug: true
+  :funding: false
   :git: true
   :git_hub: false
   :git_lint: true
@@ -80,6 +81,7 @@
     :conduct:
     :contributions:
     :download:
+    :funding:
     :home:
     :issues:
     :license:

data/lib/rubysmith/extensions/rubocop.rb

@@ -17,7 +17,7 @@ module Rubysmith
       end
 
       def call
-        STDOUT.squelch { client.run ["--auto-correct", configuration.project_root.to_s] }
+        STDOUT.squelch { client.run ["--autocorrect", configuration.project_root.to_s] }
         configuration
       end
 

data/lib/rubysmith/templates/%project_name%/.github/FUNDING.yml.erb

@@ -0,0 +1 @@
+github: [<%= configuration.git_hub_user %>]

data/lib/rubysmith/templates/%project_name%/Gemfile.erb

@@ -3,7 +3,7 @@ ruby File.read(".ruby-version").strip
 source "https://rubygems.org"
 
 <% if configuration.build_refinements %>
-  gem "refinements", "~> 9.2"
+  gem "refinements", "~> 9.4"
 <% end %>
 <% if configuration.build_zeitwerk %>
   gem "zeitwerk", "~> 2.5"
@@ -14,7 +14,7 @@ group :code_quality do
     gem "bundler-leak", "~> 0.2"
   <% end %>
   <% if configuration.build_caliber %>
-    gem "caliber", "~> 0.7"
+    gem "caliber", "~> 0.9"
   <% end %>
   <% if configuration.build_git && configuration.build_git_lint %>
     gem "git-lint", "~> 4.0"
@@ -35,7 +35,7 @@ group :development do
     gem "rake", "~> 13.0"
   <% end %>
   <% if configuration.markdown? %>
-    gem "tocer", "~> 13.2"
+    gem "tocer", "~> 14.1"
   <% end %>
   <% if configuration.build_yard %>
     gem "yard", "~> 0.9"

data/rubysmith.gemspec

@@ -2,7 +2,7 @@
 
 Gem::Specification.new do |spec|
   spec.name = "rubysmith"
-  spec.version = "3.0.1"
+  spec.version = "3.3.0"
   spec.authors = ["Brooke Kuhlmann"]
   spec.email = ["brooke@alchemists.io"]
   spec.homepage = "https://github.com/bkuhlmann/rubysmith"
@@ -13,6 +13,7 @@ Gem::Specification.new do |spec|
     "bug_tracker_uri" => "https://github.com/bkuhlmann/rubysmith/issues",
     "changelog_uri" => "https://www.alchemists.io/projects/rubysmith/versions",
     "documentation_uri" => "https://www.alchemists.io/projects/rubysmith",
+    "funding_uri" => "https://github.com/sponsors/bkuhlmann",
     "label" => "Rubysmith",
     "rubygems_mfa_required" => "true",
     "source_code_uri" => "https://github.com/bkuhlmann/rubysmith"
@@ -22,18 +23,18 @@ 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 "git_plus", "~> 1.3"
   spec.add_dependency "milestoner", "~> 14.0"
   spec.add_dependency "pastel", "~> 0.8"
-  spec.add_dependency "pragmater", "~> 11.0"
-  spec.add_dependency "refinements", "~> 9.2"
-  spec.add_dependency "rubocop", "~> 1.27"
-  spec.add_dependency "runcom", "~> 8.2"
-  spec.add_dependency "spek", "~> 0.2"
-  spec.add_dependency "tocer", "~> 14.0"
+  spec.add_dependency "pragmater", "~> 11.1"
+  spec.add_dependency "refinements", "~> 9.4"
+  spec.add_dependency "rubocop", "~> 1.30"
+  spec.add_dependency "runcom", "~> 8.4"
+  spec.add_dependency "spek", "~> 0.3"
+  spec.add_dependency "tocer", "~> 14.1"
   spec.add_dependency "zeitwerk", "~> 2.5"
 
   spec.bindir = "exe"

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rubysmith
 version: !ruby/object:Gem::Version
-  version: 3.0.1
+  version: 3.3.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-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
@@ -120,84 +120,84 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '11.0'
+        version: '11.1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '11.0'
+        version: '11.1'
 - !ruby/object:Gem::Dependency
   name: refinements
   requirement: !ruby/object:Gem::Requirement
     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: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.27'
+        version: '1.30'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.27'
+        version: '1.30'
 - !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: tocer
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '14.0'
+        version: '14.1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '14.0'
+        version: '14.1'
 - !ruby/object:Gem::Dependency
   name: zeitwerk
   requirement: !ruby/object:Gem::Requirement
@@ -274,6 +274,7 @@ files:
 - lib/rubysmith/renderers/erb.rb
 - lib/rubysmith/renderers/namespace.rb
 - lib/rubysmith/templates/%project_name%/.circleci/config.yml.erb
+- lib/rubysmith/templates/%project_name%/.github/FUNDING.yml.erb
 - lib/rubysmith/templates/%project_name%/.github/ISSUE_TEMPLATE.md.erb
 - lib/rubysmith/templates/%project_name%/.github/PULL_REQUEST_TEMPLATE.md.erb
 - lib/rubysmith/templates/%project_name%/.gitignore.erb
@@ -310,6 +311,7 @@ metadata:
   bug_tracker_uri: https://github.com/bkuhlmann/rubysmith/issues
   changelog_uri: https://www.alchemists.io/projects/rubysmith/versions
   documentation_uri: https://www.alchemists.io/projects/rubysmith
+  funding_uri: https://github.com/sponsors/bkuhlmann
   label: Rubysmith
   rubygems_mfa_required: 'true'
   source_code_uri: https://github.com/bkuhlmann/rubysmith
@@ -328,7 +330,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.11
+rubygems_version: 3.3.14
 signing_key:
 specification_version: 4
 summary: A command line interface for smithing Ruby projects.