rubysmith 4.9.0 → 5.1.0

data/lib/rubysmith/configuration/defaults.yml

@@ -1,59 +1,52 @@
-:author:
-  :email:
-  :family_name:
-  :given_name:
-  :url:
-:build:
-  :amazing_print: true
-  :caliber: true
-  :circle_ci: false
-  :citation: true
-  :cli: false
-  :community: false
-  :conduct: true
-  :console: true
-  :contributions: true
-  :debug: true
-  :funding: false
-  :git: true
-  :git_hub: false
-  :git_hub_ci: false
-  :git_lint: true
-  :guard: true
-  :license: true
-  :maximum: false
-  :minimum: false
-  :rake: true
-  :readme: true
-  :reek: true
-  :refinements: true
-  :rspec: true
-  :security: true
-  :setup: true
-  :simple_cov: true
-  :versions: true
-  :yard: false
-  :zeitwerk: true
-:citation:
-  :affiliation:
-  :message: Please use the following metadata when citing this project in your work.
-  :orcid:
-:documentation:
-  :format: "adoc"
-:extensions:
-  :milestoner:
-    :documentation:
-      :format: "adoc"
-    :prefixes:
+build:
+  amazing_print: true
+  caliber: true
+  circle_ci: false
+  citation: true
+  cli: false
+  community: false
+  conduct: true
+  console: true
+  contributions: true
+  debug: true
+  funding: false
+  git: true
+  git_hub: false
+  git_hub_ci: false
+  git_lint: true
+  guard: true
+  license: true
+  maximum: false
+  minimum: false
+  rake: true
+  readme: true
+  reek: true
+  refinements: true
+  rspec: true
+  security: true
+  setup: true
+  simple_cov: true
+  versions: true
+  yard: false
+  zeitwerk: true
+citation:
+  message: Please use the following metadata when citing this project in your work.
+documentation:
+  format: "adoc"
+extensions:
+  milestoner:
+    documentation:
+      format: "adoc"
+    prefixes:
       - Fixed
       - Added
       - Updated
       - Removed
       - Refactored
-  :pragmater:
-    :comments:
+  pragmater:
+    comments:
       - "# frozen_string_literal: true"
-    :includes:
+    patterns:
       - "**/*.rake"
       - "**/*.rb"
       - "*.gemspec"
@@ -65,27 +58,13 @@
       - Gemfile
       - Guardfile
       - Rakefile
-  :tocer:
-    :includes:
+  tocer:
+    label: "## Table of Contents"
+    patterns:
       - "README.md"
-    :label: "## Table of Contents"
-:git_hub:
-  :user:
-:license:
-  :label: Hippocratic
-  :name: hippocratic
-  :version: 2.1
-:project:
-  :url:
-    :community:
-    :conduct:
-    :contributions:
-    :download:
-    :funding:
-    :home:
-    :issues:
-    :license:
-    :security:
-    :source:
-    :versions:
-  :version: 0.0.0
+license:
+  label: Hippocratic
+  name: hippocratic
+  version: "2.1"
+project:
+  version: 0.0.0

data/lib/rubysmith/configuration/{content.rb → model.rb}

@@ -9,15 +9,7 @@ module Rubysmith
   # rubocop:disable Metrics/ModuleLength
   module Configuration
     # Defines the common configuration content for use throughout the gem.
-    Content = Struct.new(
-      :action_build,
-      :action_config,
-      :action_edit,
-      :action_help,
-      :action_install,
-      :action_publish,
-      :action_version,
-      :action_view,
+    Model = Struct.new(
       :author_email,
       :author_family_name,
       :author_given_name,
@@ -59,8 +51,8 @@ module Rubysmith
       :extensions_milestoner_documentation_format,
       :extensions_milestoner_prefixes,
       :extensions_pragmater_comments,
-      :extensions_pragmater_includes,
-      :extensions_tocer_includes,
+      :extensions_pragmater_patterns,
+      :extensions_tocer_patterns,
       :extensions_tocer_label,
       :git_hub_user,
       :license_label,
@@ -88,20 +80,14 @@ module Rubysmith
       using Refinements::Strings
       using Refinements::Structs
 
-      def initialize target_root: Pathname.pwd, template_roots: [], **arguments
+      def initialize(**)
         super
         freeze
       end
 
-      def add_template_roots *paths
-        paths.map { |path| Pathname path }
-             .including(template_roots)
-             .then { |roots| dup.merge! template_roots: roots }
-      end
-
-      def maximize = update_build_options(true)
+      def maximize = update_build_options true
 
-      def minimize = update_build_options(false)
+      def minimize = update_build_options false
 
       def author_name = [author_given_name, author_family_name].compress.join(" ")
 
@@ -150,8 +136,8 @@ module Rubysmith
       end
 
       def template_root
-        template_roots.map(&:expand_path)
-                      .find { |path| path.join(String(template_path)).exist? }
+        Array(template_roots).map(&:expand_path)
+                             .find { |path| path.join(String(template_path)).exist? }
       end
 
       private

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

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+require "dry/monads"
+
+module Rubysmith
+  module Configuration
+    # Adds current time to content.
+    module Transformers
+      include Dry::Monads[:result]
+
+      CurrentTime = lambda do |content, at: Time.now|
+        content.fetch(:now) { at }
+               .then { |now| content.merge! now: }
+               .then { |updated_content| Dry::Monads::Success updated_content }
+      end
+    end
+  end
+end

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

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+require "dry/monads"
+
+module Rubysmith
+  module Configuration
+    module Transformers
+      # Dynamically adds Git email if defined.
+      class GitEmail
+        include Import[:git]
+        include Dry::Monads[:result]
+
+        def call content
+          return Success content if content[:author_email]
+
+          git.get("user.email").fmap { |email| content.merge! author_email: email }
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+require "dry/monads"
+
+module Rubysmith
+  module Configuration
+    module Transformers
+      # Dynamically adds GitHub user if user is defined.
+      class GitHubUser
+        include Import[:git]
+        include Dry::Monads[:result]
+
+        def call content
+          return Success content if content[:git_hub_user]
+
+          git.get("github.user").fmap { |user| content.merge! git_hub_user: user }
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+require "dry/monads"
+
+module Rubysmith
+  module Configuration
+    module Transformers
+      # Dynamically adds Git user if defined.
+      class GitUser
+        include Import[:git]
+        include Dry::Monads[:result]
+
+        def call content
+          return Success content if content[:author_given_name] || content[:author_family_name]
+
+          git.get("user.name").fmap do |name|
+            first, last = String(name).split
+            content.merge author_given_name: first, author_family_name: last
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+require "dry/monads"
+
+module Rubysmith
+  module Configuration
+    # Sets target root which defaults to current directory when key is missing.
+    module Transformers
+      include Dry::Monads[:result]
+
+      TargetRoot = lambda do |content, path: Pathname.pwd|
+        content.fetch(:target_root) { path }
+               .then { |root| content.merge! target_root: root }
+               .then { |updated_content| Dry::Monads::Success updated_content }
+      end
+    end
+  end
+end

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

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+require "dry/monads"
+require "refinements/arrays"
+
+module Rubysmith
+  module Configuration
+    module Transformers
+      # Appends custom content to default template roots.
+      class TemplateRoot
+        include Dry::Monads[:result]
+
+        using Refinements::Arrays
+
+        def initialize default = Pathname(__dir__).join("../../templates")
+          @default = default
+        end
+
+        def call content
+          Array(default).map { |path| Pathname path }
+                        .including(content[:template_roots])
+                        .compact
+                        .then { |paths| Success content.merge!(template_roots: paths) }
+        end
+
+        private
+
+        attr_reader :default
+      end
+    end
+  end
+end

data/lib/rubysmith/container.rb

@@ -2,17 +2,37 @@
 
 require "cogger"
 require "dry-container"
+require "etcher"
+require "gitt"
+require "runcom"
 require "spek"
-require "tone"
 
 module Rubysmith
   # Provides a global gem container for injection into other objects.
   module Container
     extend Dry::Container::Mixin
 
-    register(:color) { Tone.new }
-    register(:configuration) { Configuration::Loader.call }
+    register :configuration do
+      self[:defaults].add_loader(Etcher::Loaders::YAML.new(self[:xdg_config].active))
+                     .then { |registry| Etcher.call registry }
+    end
+
+    register :defaults do
+      Etcher::Registry.new(contract: Configuration::Contract, model: Configuration::Model)
+                      .add_loader(Etcher::Loaders::YAML.new(self[:defaults_path]))
+                      .add_transformer(Configuration::Transformers::CurrentTime)
+                      .add_transformer(Configuration::Transformers::GitHubUser.new)
+                      .add_transformer(Configuration::Transformers::GitEmail.new)
+                      .add_transformer(Configuration::Transformers::GitUser.new)
+                      .add_transformer(Configuration::Transformers::TemplateRoot.new)
+                      .add_transformer(Configuration::Transformers::TargetRoot)
+    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 }
   end

data/lib/rubysmith/extensions/milestoner.rb

@@ -13,7 +13,7 @@ module Rubysmith
 
       def initialize configuration,
                      client: ::Milestoner::Tags::Publisher.new,
-                     content: ::Milestoner::Configuration::Content.new
+                     content: ::Milestoner::Configuration::Model.new
         @configuration = configuration
         @client = client
         @content = content

data/lib/rubysmith/extensions/pragmater.rb

@@ -12,24 +12,24 @@ module Rubysmith
       def self.call(...) = new(...).call
 
       def initialize configuration,
-                     client: ::Pragmater::Runner.new,
-                     content: ::Pragmater::Configuration::Content.new
+                     client: ::Pragmater::Inserter.new,
+                     record: ::Pragmater::Configuration::Model.new
         @configuration = configuration
         @client = client
-        @content = content
+        @record = record
       end
 
       def call = client.call(settings) && configuration
 
       private
 
-      attr_reader :configuration, :client, :content
+      attr_reader :configuration, :client, :record
 
       def settings
-        content.merge(action_insert: true, root_dir: configuration.project_root)
-               .transmute! configuration,
-                           comments: :extensions_pragmater_comments,
-                           includes: :extensions_pragmater_includes
+        record.merge(root_dir: configuration.project_root)
+              .transmute! configuration,
+                          comments: :extensions_pragmater_comments,
+                          patterns: :extensions_pragmater_patterns
       end
     end
   end

data/lib/rubysmith/extensions/tocer.rb

@@ -5,7 +5,7 @@ require "tocer"
 
 module Rubysmith
   module Extensions
-    # Ensures project skeleton documentation has table of contents.
+    # Ensures project skeleton documentation has table of content.
     class Tocer
       using Refinements::Structs
 
@@ -13,10 +13,10 @@ module Rubysmith
 
       def initialize configuration,
                      client: ::Tocer::Runner.new,
-                     content: ::Tocer::Configuration::Content.new
+                     record: ::Tocer::Configuration::Model.new
         @configuration = configuration
         @client = client
-        @content = content
+        @record = record
       end
 
       def call
@@ -26,13 +26,13 @@ module Rubysmith
 
       private
 
-      attr_reader :configuration, :client, :content
+      attr_reader :configuration, :client, :record
 
       def settings
-        content.merge(root_dir: configuration.project_root)
-               .transmute! configuration,
-                           includes: :extensions_tocer_includes,
-                           label: :extensions_tocer_label
+        record.merge(root_dir: configuration.project_root)
+              .transmute! configuration,
+                          label: :extensions_tocer_label,
+                          patterns: :extensions_tocer_patterns
       end
     end
   end

data/lib/rubysmith/pathway.rb

@@ -7,6 +7,7 @@ module Rubysmith
   Pathway = Struct.new :start_root, :start_path, :end_root, keyword_init: true do
     using Refinements::Pathnames
 
+    # :reek:TooManyStatements
     def initialize *arguments
       super
       each_pair { |key, value| self[key] = Pathname value }

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", "~> 10.0"
+  gem "refinements", "~> 11.0"
 <% end %>
 <% if configuration.build_zeitwerk %>
   gem "zeitwerk", "~> 2.6"
@@ -11,10 +11,10 @@ source "https://rubygems.org"
 
 group :code_quality do
   <% if configuration.build_caliber %>
-    gem "caliber", "~> 0.30"
+    gem "caliber", "~> 0.35"
   <% end %>
   <% if configuration.build_git && configuration.build_git_lint %>
-    gem "git-lint", "~> 5.0"
+    gem "git-lint", "~> 6.0"
   <% end %>
   <% if configuration.build_reek %>
     gem "reek", "~> 6.1", require: false
@@ -32,7 +32,7 @@ group :development do
     gem "rake", "~> 13.0"
   <% end %>
   <% if configuration.markdown? %>
-    gem "tocer", "~> 15.0"
+    gem "tocer", "~> 16.0"
   <% 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 = "4.9.0"
+  spec.version = "5.1.0"
   spec.authors = ["Brooke Kuhlmann"]
   spec.email = ["brooke@alchemists.io"]
   spec.homepage = "https://github.com/bkuhlmann/rubysmith"
@@ -23,19 +23,22 @@ Gem::Specification.new do |spec|
   spec.cert_chain = [Gem.default_cert_path]
 
   spec.required_ruby_version = "~> 3.2"
-  spec.add_dependency "cogger", "~> 0.8"
-  spec.add_dependency "core", "~> 0.1"
+  spec.add_dependency "cogger", "~> 0.10"
   spec.add_dependency "dry-container", "~> 0.11"
-  spec.add_dependency "gitt", "~> 1.1"
-  spec.add_dependency "infusible", "~> 1.0"
-  spec.add_dependency "milestoner", "~> 15.3"
-  spec.add_dependency "pragmater", "~> 12.2"
-  spec.add_dependency "refinements", "~> 10.0"
-  spec.add_dependency "rubocop", "~> 1.41"
-  spec.add_dependency "runcom", "~> 9.0"
-  spec.add_dependency "spek", "~> 1.1"
-  spec.add_dependency "tocer", "~> 15.2"
-  spec.add_dependency "tone", "~> 0.1"
+  spec.add_dependency "dry-monads", "~> 1.6"
+  spec.add_dependency "dry-schema", "~> 1.13"
+  spec.add_dependency "etcher", "~> 0.2"
+  spec.add_dependency "gitt", "~> 2.0"
+  spec.add_dependency "infusible", "~> 2.0"
+  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 "runcom", "~> 10.0"
+  spec.add_dependency "sod", "~> 0.0"
+  spec.add_dependency "spek", "~> 2.0"
+  spec.add_dependency "tocer", "~> 16.0"
+  spec.add_dependency "tone", "~> 0.3"
   spec.add_dependency "zeitwerk", "~> 2.6"
 
   spec.bindir = "exe"