rubysmith 5.4.0 → 5.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6ca20956e5827addc7ea3c38045c599e3d19ad99ef215a7315ea1eef5466a8f3
-  data.tar.gz: 26564d4ba7f197f7e1be21bed743909cf165e1d3d73891a93a44af0fa5594900
+  metadata.gz: d2bdc94b13e74451e18224bdfff1cf41e744a4b9c75813d590b2fb9cd37b3a10
+  data.tar.gz: bd1d1451951971227e8883b0871b02906b675148c0cec20483f7b77da4a2b9ac
 SHA512:
-  metadata.gz: 5cc50e74678c032abbc0f2cf9dd1f1a8428e74f07bf270805b8d986976496ffff4f5dd51756f599153ebe7df07ccaef29b34ea882f4c132501568ca161c414a2
-  data.tar.gz: 653349bb0b747094bb2b66558e592419a6236c753acb547210383e4a89a4f9d3260a6f9c9d3f34030205984454fc79660729c310d8413696e5692bb483fa8280
+  metadata.gz: 788dbee80b7f0028f0cc597b470be7255d4cfb30f7cbdb5845f49534d4ee0bfe6d74124b8cbd4d0c3274808b0dc33e33047d47fb80afcc224d32850c18eb8c76
+  data.tar.gz: c0c6bb8ae504209f8552614e9bdaaef4765d3e35e0c7007bde8acfc49b9b40a871b3cd47cd21e8185b9cd8160eb5ca1472b87b394f47f1ef75798beb5d18ac9d

data/README.adoc

@@ -76,21 +76,7 @@ gem install rubysmith
 
 From the command line, type: `rubysmith --help`
 
-....
-USAGE
-  rubysmith [OPTIONS]
-  rubysmith COMMAND [OPTIONS]
-
-OPTIONS
-  -p, --publish VERSION     Publish project.
-  -v, --version             Show version.
-  -h, --help [COMMAND]      Show this message.
-
-COMMANDS
-  config                    Manage configuration.
-                            Path is dynamic per current directory.
-  build                     Build new project.
-....
+image:https://alchemists.io/images/projects/rubysmith/screenshots/usage.png[Usage,width=588,height=345,role=focal_point]
 
 ==== Build
 
@@ -287,9 +273,9 @@ Additional customization is possible via the YARD Rake task as found in the `Rak
 
 ===== Zeitwerk
 
-The `--zeitwerk` option allows you add the link:https://github.com/fxn/zeitwerk[Zeitwerk] gem to
-your project so you can reduce the maintence burden of managing requirements when adding new objects
-to your project.
+The `--zeitwerk` option allows you add the link:https://github.com/fxn/zeitwerk[Zeitwerk] gem to your project so you can reduce the maintenance burden of managing requirements when adding new objects to your project.
+
+This includes having access to your project's Zeitwerk loader for inspection and debugging purposes. This means if you built a `Demo` project, you'd immediately have access to your project's loader via `Demo.loader` when using the project console (i.e. `bin/console`, assuming you built your project with the `--console` flag enabled which is default behavior).
 
 ==== Publish
 

data/lib/rubysmith/builders/documentation/readme.rb

@@ -1,7 +1,6 @@
 # frozen_string_literal: true
 
 require "refinements/structs"
-require "tocer"
 
 module Rubysmith
   module Builders

data/lib/rubysmith/configuration/transformers/current_time.rb

@@ -8,9 +8,9 @@ module Rubysmith
     module Transformers
       include Dry::Monads[:result]
 
-      CurrentTime = lambda do |content, at: Time.now|
-        content.fetch(:now) { at }
-               .then { |now| content.merge! now: }
+      CurrentTime = lambda do |content, key = :now, at: Time.now|
+        content.fetch(key) { at }
+               .then { |value| content.merge! key => value }
                .then { |updated_content| Dry::Monads::Success updated_content }
       end
     end

data/lib/rubysmith/configuration/transformers/git_email.rb

@@ -10,13 +10,20 @@ module Rubysmith
         include Import[:git]
         include Dry::Monads[:result]
 
-        def call(content) = content[:author_email] ? Success(content) : email_or(content)
+        def initialize(key = :author_email, **)
+          @key = key
+          super(**)
+        end
+
+        def call(content) = content[key] ? Success(content) : email_or(content)
 
         private
 
+        attr_reader :key
+
         def email_or content
           git.get("user.email", nil)
-             .fmap { |email| email ? content.merge!(author_email: email) : content }
+             .fmap { |value| value ? content.merge!(key => value) : content }
              .or { Success content }
         end
       end

data/lib/rubysmith/configuration/transformers/git_hub_user.rb

@@ -10,13 +10,20 @@ module Rubysmith
         include Import[:git]
         include Dry::Monads[:result]
 
-        def call(content) = content[:git_hub_user] ? Success(content) : user_or(content)
+        def initialize(key = :git_hub_user, **)
+          @key = key
+          super(**)
+        end
+
+        def call(content) = content[key] ? Success(content) : user_or(content)
 
         private
 
+        attr_reader :key
+
         def user_or content
           git.get("github.user", nil)
-             .fmap { |user| user ? content.merge!(git_hub_user: user) : content }
+             .fmap { |value| value ? content.merge!(key => value) : content }
              .or { Success content }
         end
       end

data/lib/rubysmith/configuration/transformers/target_root.rb

@@ -8,9 +8,9 @@ module Rubysmith
     module Transformers
       include Dry::Monads[:result]
 
-      TargetRoot = lambda do |content, path: Pathname.pwd|
+      TargetRoot = lambda do |content, key = :target_root, path: Pathname.pwd|
         content.fetch(:target_root) { path }
-               .then { |root| content.merge! target_root: root }
+               .then { |value| content.merge! key => value }
                .then { |updated_content| Dry::Monads::Success updated_content }
       end
     end

data/lib/rubysmith/configuration/transformers/template_root.rb

@@ -12,20 +12,21 @@ module Rubysmith
 
         using Refinements::Arrays
 
-        def initialize default = Pathname(__dir__).join("../../templates")
+        def initialize key = :template_roots, default: Pathname(__dir__).join("../../templates")
+          @key = key
           @default = default
         end
 
         def call content
           Array(default).map { |path| Pathname path }
-                        .including(content[:template_roots])
+                        .including(content[key])
                         .compact
-                        .then { |paths| Success content.merge!(template_roots: paths) }
+                        .then { |value| Success content.merge!(key => value) }
         end
 
         private
 
-        attr_reader :default
+        attr_reader :key, :default
       end
     end
   end

data/lib/rubysmith/container.rb

@@ -12,12 +12,12 @@ module Rubysmith
   module Container
     extend Dry::Container::Mixin
 
-    register :configuration do
+    register :configuration, memoize: true do
       self[:defaults].add_loader(Etcher::Loaders::YAML.new(self[:xdg_config].active))
                      .then { |registry| Etcher.call registry }
     end
 
-    register :defaults do
+    register :defaults, memoize: true do
       Etcher::Registry.new(contract: Configuration::Contract, model: Configuration::Model)
                       .add_loader(Etcher::Loaders::YAML.new(self[:defaults_path]))
                       .add_transformer(Configuration::Transformers::CurrentTime)
@@ -28,12 +28,15 @@ module Rubysmith
                       .add_transformer(Configuration::Transformers::TargetRoot)
     end
 
+    register :specification, memoize: true do
+      Spek::Loader.call "#{__dir__}/../../rubysmith.gemspec"
+    end
+
     register(:input, memoize: true) { self[:configuration].dup }
-    register(:defaults_path) { Pathname(__dir__).join("configuration/defaults.yml") }
-    register(:xdg_config) { Runcom::Config.new "rubysmith/configuration.yml" }
-    register(:specification) { Spek::Loader.call "#{__dir__}/../../rubysmith.gemspec" }
-    register(:git) { Gitt::Repository.new }
-    register(:kernel) { Kernel }
-    register(:logger) { Cogger.new formatter: :emoji }
+    register(:defaults_path, memoize: true) { Pathname(__dir__).join("configuration/defaults.yml") }
+    register(:xdg_config, memoize: true) { Runcom::Config.new "rubysmith/configuration.yml" }
+    register(:git, memoize: true) { Gitt::Repository.new }
+    register(:logger, memoize: true) { Cogger.new formatter: :emoji }
+    register :kernel, Kernel
   end
 end

data/lib/rubysmith/templates/%project_name%/.github/ISSUE_TEMPLATE.md.erb

@@ -1,11 +1,8 @@
-## Overview
-<!-- Required. Describe, briefly, the behavior experienced and desired. -->
+## Why
+<!-- Required. Describe, briefly, why this issue is important. -->
 
-## Screenshots/Screencasts
-<!-- Optional. Attach screenshot(s) and/or screencast(s) that demo the behavior. -->
+## How
+<!-- Optional. List exact steps (numbered) to implement or reproduce behavior. Screen shots/casts are welcome. -->
 
-## Steps to Recreate
-<!-- Required. List exact steps (numbered list) to reproduce errant behavior. -->
-
-## Environment
-<!-- Required. What is your operating system, software version(s), etc. -->
+## Notes
+<!-- Optional. Provide additional details (i.e operating system, software version(s), stack dump, etc.) -->

data/lib/rubysmith/templates/%project_name%/bin/console.erb

@@ -3,7 +3,7 @@
 require "bundler/setup"
 Bundler.require :tools
 
-require "<%= configuration.project_path %>"
+require Bundler.root.join("lib/<%= configuration.project_path %>").to_s
 require "irb"
 
 IRB.start __FILE__

data/lib/rubysmith/templates/%project_name%/lib/%project_path%.rb.erb

@@ -2,11 +2,22 @@
   require "zeitwerk"
   <% if configuration.project_levels.positive? %>
     Zeitwerk::Loader.new.then do |loader|
+      loader.tag = "<%= configuration.project_name %>"
       loader.push_dir "#{__dir__}<%= Array.new(configuration.project_levels, "/..").join %>"
       loader.setup
     end
   <% else %>
-    Zeitwerk::Loader.for_gem.setup
+    Zeitwerk::Loader.new.then do |loader|
+      loader.tag = File.basename __FILE__, ".rb"
+      loader.push_dir __dir__
+      loader.setup
+    end
   <% end %>
 <% end %>
+<% if configuration.build_zeitwerk %>
+<% namespace do %>
+  def self.loader(registry = Zeitwerk::Registry) = registry.loader_for __FILE__
+<% end %>
+<% else %>
 <% namespace %>
+<% end %>

data/lib/rubysmith.rb

@@ -2,15 +2,18 @@
 
 require "zeitwerk"
 
-Zeitwerk::Loader.for_gem.then do |loader|
+Zeitwerk::Loader.new.then do |loader|
   loader.inflector.inflect "cli" => "CLI",
                            "circle_ci" => "CircleCI",
                            "erb" => "ERB",
                            "git_hub_ci" => "GitHubCI",
                            "rspec" => "RSpec"
+  loader.tag = File.basename __FILE__, ".rb"
+  loader.push_dir __dir__
   loader.setup
 end
 
 # Main namespace.
 module Rubysmith
+  def self.loader(registry = Zeitwerk::Registry) = registry.loader_for __FILE__
 end

data/rubysmith.gemspec

@@ -2,10 +2,10 @@
 
 Gem::Specification.new do |spec|
   spec.name = "rubysmith"
-  spec.version = "5.4.0"
+  spec.version = "5.6.0"
   spec.authors = ["Brooke Kuhlmann"]
   spec.email = ["brooke@alchemists.io"]
-  spec.homepage = "https://github.com/bkuhlmann/rubysmith"
+  spec.homepage = "https://alchemists.io/projects/rubysmith"
   spec.summary = "A command line interface for smithing Ruby projects."
   spec.license = "Hippocratic-2.1"
 
@@ -33,7 +33,7 @@ Gem::Specification.new do |spec|
   spec.add_dependency "milestoner", "~> 16.0"
   spec.add_dependency "pragmater", "~> 13.0"
   spec.add_dependency "refinements", "~> 11.0"
-  spec.add_dependency "rubocop", "~> 1.52"
+  spec.add_dependency "rubocop", "~> 1.55"
   spec.add_dependency "runcom", "~> 10.0"
   spec.add_dependency "sod", "~> 0.0"
   spec.add_dependency "spek", "~> 2.0"

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rubysmith
 version: !ruby/object:Gem::Version
-  version: 5.4.0
+  version: 5.6.0
 platform: ruby
 authors:
 - Brooke Kuhlmann
@@ -35,7 +35,7 @@ cert_chain:
   3n5C8/6Zh9DYTkpcwPSuIfAga6wf4nXc9m6JAw8AuMLaiWN/r/2s4zJsUHYERJEu
   gZGm4JqtuSg8pYjPeIJxS960owq+SfuC+jxqmRA54BisFCv/0VOJi7tiJVY=
   -----END CERTIFICATE-----
-date: 2023-07-15 00:00:00.000000000 Z
+date: 2023-10-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: cogger
@@ -183,14 +183,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.52'
+        version: '1.55'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.52'
+        version: '1.55'
 - !ruby/object:Gem::Dependency
   name: runcom
   requirement: !ruby/object:Gem::Requirement
@@ -400,7 +400,7 @@ files:
 - lib/rubysmith/templates/%project_name%/spec/support/shared_contexts/temp_dir.rb.erb
 - lib/rubysmith/text/inserter.rb
 - rubysmith.gemspec
-homepage: https://github.com/bkuhlmann/rubysmith
+homepage: https://alchemists.io/projects/rubysmith
 licenses:
 - Hippocratic-2.1
 metadata:
@@ -426,7 +426,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.17
+rubygems_version: 3.4.20
 signing_key:
 specification_version: 4
 summary: A command line interface for smithing Ruby projects.