rubysmith 0.15.0 → 1.1.0

data/lib/rubysmith/configuration/content.rb

@@ -0,0 +1,174 @@
+# frozen_string_literal: true
+
+require "pathname"
+require "refinements/arrays"
+require "refinements/strings"
+require "refinements/structs"
+
+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,
+      :author_email,
+      :author_family_name,
+      :author_given_name,
+      :author_url,
+      :build_amazing_print,
+      :build_bundler_leak,
+      :build_circle_ci,
+      :build_citation,
+      :build_cli,
+      :build_community,
+      :build_conduct,
+      :build_console,
+      :build_contributions,
+      :build_dead_end,
+      :build_debug,
+      :build_git,
+      :build_git_hub,
+      :build_git_lint,
+      :build_guard,
+      :build_license,
+      :build_maximum,
+      :build_minimum,
+      :build_rake,
+      :build_readme,
+      :build_reek,
+      :build_refinements,
+      :build_rspec,
+      :build_rubocop,
+      :build_security,
+      :build_setup,
+      :build_simple_cov,
+      :build_versions,
+      :build_yard,
+      :build_zeitwerk,
+      :citation_affiliation,
+      :citation_message,
+      :citation_orcid,
+      :documentation_format,
+      :extensions_milestoner_documentation_format,
+      :extensions_milestoner_prefixes,
+      :extensions_milestoner_sign,
+      :extensions_pragmater_comments,
+      :extensions_pragmater_includes,
+      :extensions_tocer_includes,
+      :extensions_tocer_label,
+      :git_hub_user,
+      :license_label,
+      :license_name,
+      :license_version,
+      :now,
+      :project_name,
+      :project_url_community,
+      :project_url_conduct,
+      :project_url_contributions,
+      :project_url_download,
+      :project_url_home,
+      :project_url_issues,
+      :project_url_license,
+      :project_url_security,
+      :project_url_source,
+      :project_url_versions,
+      :project_version,
+      :target_root,
+      :template_path,
+      :template_roots,
+      keyword_init: true
+    ) do
+      using Refinements::Arrays
+      using Refinements::Strings
+      using Refinements::Structs
+
+      def initialize *arguments
+        super
+
+        self[:template_roots] ||= [Pathname(__dir__).join("../templates")]
+        self[:target_root] ||= Pathname.pwd
+        freeze
+      end
+
+      def add_template_roots paths
+        Array(paths).map { |path| Pathname path }
+                    .including(template_roots)
+                    .then { |roots| dup.merge! template_roots: roots }
+      end
+
+      def maximize = update_build_options(true)
+
+      def minimize = update_build_options(false)
+
+      def author_name = [author_given_name, author_family_name].compress.join(" ")
+
+      def license_label_version = [license_label, license_version].compress.join("-")
+
+      def project_label = project_name.titleize
+
+      def project_class = project_name.camelcase
+
+      def project_root = target_root.join(project_name)
+
+      def project_path = project_name.snakecase
+
+      def computed_project_url_community = format_url(__method__)
+
+      def computed_project_url_conduct = format_url(__method__)
+
+      def computed_project_url_contributions = format_url(__method__)
+
+      def computed_project_url_download = format_url(__method__)
+
+      def computed_project_url_home = format_url(__method__)
+
+      def computed_project_url_issues = format_url(__method__)
+
+      def computed_project_url_license = format_url(__method__)
+
+      def computed_project_url_security = format_url(__method__)
+
+      def computed_project_url_source = format_url(__method__)
+
+      def computed_project_url_versions = format_url(__method__)
+
+      def ascii_doc? = documentation_format == "adoc"
+
+      def markdown? = documentation_format == "md"
+
+      def pathway
+        Pathway[start_root: template_root, start_path: template_path, end_root: target_root]
+      end
+
+      def template_root
+        template_roots.map(&:expand_path)
+                      .find { |path| path.join(String(template_path)).exist? }
+      end
+
+      private
+
+      def format_url kind
+        kind.to_s
+            .sub("computed_", "")
+            .then { |method| public_send method }
+            .then { |url| String url }
+            .then { |url| url.sub "%project_name%", project_name }
+      end
+
+      def update_build_options value
+        to_h.select { |key, _value| key.start_with? "build_" }
+            .transform_values { value }
+            .then { |attributes| dup.merge!(**attributes, build_minimum: !value) }
+            .freeze
+      end
+    end
+  end
+  # rubocop:enable Metrics/ModuleLength
+end

data/lib/rubysmith/configuration/defaults.yml

@@ -0,0 +1,89 @@
+:author:
+  :email:
+  :family_name:
+  :given_name:
+  :url:
+:build:
+  :amazing_print: true
+  :bundler_leak: true
+  :circle_ci: false
+  :citation: true
+  :cli: false
+  :community: false
+  :conduct: true
+  :console: true
+  :contributions: true
+  :dead_end: true
+  :debug: true
+  :git: true
+  :git_hub: false
+  :git_lint: true
+  :guard: true
+  :license: true
+  :maximum: false
+  :minimum: false
+  :rake: true
+  :readme: true
+  :reek: true
+  :refinements: true
+  :rspec: true
+  :rubocop: 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: "md"
+    :prefixes:
+      - Fixed
+      - Added
+      - Updated
+      - Removed
+      - Refactored
+    :sign: false
+  :pragmater:
+    :comments:
+      - "# frozen_string_literal: true"
+    :includes:
+      - "**/*.gemspec"
+      - "**/*.rake"
+      - "**/*.rb"
+      - "**/*bin/console"
+      - "**/*bin/guard"
+      - "**/*bin/rubocop"
+      - "**/*Gemfile"
+      - "**/*Guardfile"
+      - "**/*Rakefile"
+  :tocer:
+    :includes:
+      - "README.md"
+    :label: "## Table of Contents"
+:git_hub:
+  :user:
+:license:
+  :label: Hippocratic
+  :name: hippocratic
+  :version: 3.0
+:project:
+  :url:
+    :community:
+    :conduct:
+    :contributions:
+    :download:
+    :home:
+    :issues:
+    :license:
+    :security:
+    :source:
+    :versions:
+  :version: 0.0.0

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

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+require "refinements/structs"
+
+module Rubysmith
+  module Configuration
+    module Enhancers
+      # Adds current time to content.
+      class CurrentTime
+        using Refinements::Structs
+
+        def initialize now = Time.now
+          @now = now
+        end
+
+        def call(content) = content.merge(now:)
+
+        private
+
+        attr_reader :now
+      end
+    end
+  end
+end

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

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+require "git_plus"
+require "refinements/strings"
+require "refinements/structs"
+
+module Rubysmith
+  module Configuration
+    module Enhancers
+      # Dynamically adds Git email if defined.
+      class GitEmail
+        using Refinements::Strings
+        using Refinements::Structs
+
+        def initialize repository: GitPlus::Repository.new
+          @repository = repository
+        end
+
+        def call content
+          String(content.author_email).blank? ? content.merge(author_email: email) : content
+        end
+
+        private
+
+        attr_reader :repository
+
+        def email = repository.config_get("user.email")
+      end
+    end
+  end
+end

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

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+require "git_plus"
+require "refinements/strings"
+require "refinements/structs"
+
+module Rubysmith
+  module Configuration
+    module Enhancers
+      # Dynamically adds GitHub user if user is defined.
+      class GitHubUser
+        using Refinements::Strings
+        using Refinements::Structs
+
+        def initialize repository: GitPlus::Repository.new
+          @repository = repository
+        end
+
+        def call content
+          String(content.git_hub_user).blank? ? content.merge(git_hub_user: user) : content
+        end
+
+        private
+
+        attr_reader :repository
+
+        def user = repository.config_get("github.user")
+      end
+    end
+  end
+end

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

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+require "git_plus"
+require "refinements/strings"
+require "refinements/structs"
+
+module Rubysmith
+  module Configuration
+    module Enhancers
+      # Dynamically adds Git user if defined.
+      class GitUser
+        using Refinements::Strings
+        using Refinements::Structs
+
+        def initialize repository: GitPlus::Repository.new
+          @repository = repository
+        end
+
+        def call(content) = String(content.author_name).blank? ? content.merge(**user) : content
+
+        private
+
+        attr_reader :repository
+
+        def user
+          repository.config_get("user.name")
+                    .then { |name| String(name).split }
+                    .then { |first, last| {author_given_name: first, author_family_name: last} }
+        end
+      end
+    end
+  end
+end

data/lib/rubysmith/configuration/loader.rb

@@ -0,0 +1,48 @@
+# frozen_string_literal: true
+
+require "pathname"
+require "refinements/hashes"
+require "refinements/structs"
+require "runcom"
+require "yaml"
+
+module Rubysmith
+  module Configuration
+    # Represents the fully assembled Command Line Interface (CLI) configuration.
+    class Loader
+      using Refinements::Hashes
+      using Refinements::Structs
+
+      DEFAULTS = YAML.load_file(Pathname(__dir__).join("defaults.yml")).freeze
+      CLIENT = Runcom::Config.new "#{Identity::NAME}/configuration.yml", defaults: DEFAULTS
+
+      ENHANCERS = [
+        Enhancers::CurrentTime.new,
+        Enhancers::GitEmail.new,
+        Enhancers::GitHubUser.new,
+        Enhancers::GitUser.new
+      ].freeze
+
+      def self.call(...) = new(...).call
+
+      def self.with_defaults = new(client: DEFAULTS, enhancers: [])
+
+      def initialize content: Content.new, client: CLIENT, enhancers: ENHANCERS
+        @content = content
+        @client = client
+        @enhancers = enhancers
+      end
+
+      def call
+        enhancers.reduce(preload_content) { |preload, enhancer| enhancer.call preload }
+                 .freeze
+      end
+
+      private
+
+      attr_reader :content, :client, :enhancers
+
+      def preload_content = content.merge(**client.to_h.flatten_keys)
+    end
+  end
+end

data/lib/rubysmith/container.rb

@@ -9,7 +9,7 @@ module Rubysmith
   module Container
     extend Dry::Container::Mixin
 
-    register(:configuration, memoize: true) { CLI::Configuration::Loader.call }
+    register(:configuration) { Configuration::Loader.call }
     register(:colorizer) { Pastel.new enabled: $stdout.tty? }
     register(:kernel) { Kernel }
 

data/lib/rubysmith/extensions/bundler.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+require "bundler"
+require "bundler/cli"
+require "refinements/pathnames"
+
+module Rubysmith
+  module Extensions
+    # Ensures gem dependencies are installed.
+    class Bundler
+      using Refinements::Pathnames
+
+      def self.call(...) = new(...).call
+
+      def initialize configuration, client: ::Bundler::CLI
+        @configuration = configuration
+        @client = client
+      end
+
+      def call
+        configuration.project_root.change_dir { client.start %w[install --quiet] }
+        configuration
+      end
+
+      private
+
+      attr_reader :configuration, :client
+    end
+  end
+end

data/lib/rubysmith/extensions/milestoner.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+require "milestoner"
+
+module Rubysmith
+  module Extensions
+    # Ensures project can be published (tagged) in a reliable and consistent fashion.
+    class Milestoner
+      def self.call(...) = new(...).call
+
+      def initialize configuration,
+                     client: ::Milestoner::Tags::Publisher.new,
+                     content: ::Milestoner::Configuration::Content
+        @configuration = configuration
+        @client = client
+        @content = content
+      end
+
+      def call = client.call(settings) && configuration
+
+      private
+
+      attr_reader :configuration, :client, :content
+
+      def settings
+        content[
+          documentation_format: configuration.extensions_milestoner_documentation_format,
+          prefixes: configuration.extensions_milestoner_prefixes,
+          sign: configuration.extensions_milestoner_sign,
+          version: configuration.project_version
+        ]
+      end
+    end
+  end
+end

data/lib/rubysmith/extensions/pragmater.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+require "pragmater"
+
+module Rubysmith
+  module Extensions
+    # Ensures project skeleton has pragmas.
+    class Pragmater
+      def self.call(...) = new(...).call
+
+      def initialize configuration,
+                     client: ::Pragmater::Runner.new,
+                     content: ::Pragmater::Configuration::Content
+        @configuration = configuration
+        @client = client
+        @content = content
+      end
+
+      def call = client.call(settings) && configuration
+
+      private
+
+      attr_reader :configuration, :client, :content
+
+      def settings
+        content[
+          action_insert: true,
+          comments: configuration.extensions_pragmater_comments,
+          includes: configuration.extensions_pragmater_includes,
+          root_dir: configuration.project_root
+        ]
+      end
+    end
+  end
+end

data/lib/rubysmith/extensions/rubocop.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+require "rubocop"
+require "refinements/ios"
+
+module Rubysmith
+  module Extensions
+    # Ensures project skeleton adheres to style guide.
+    class Rubocop
+      using Refinements::IOs
+
+      def self.call(...) = new(...).call
+
+      def initialize configuration, client: ::RuboCop::CLI.new
+        @configuration = configuration
+        @client = client
+      end
+
+      def call
+        STDOUT.squelch { client.run ["--auto-correct", configuration.project_root.to_s] }
+        configuration
+      end
+
+      private
+
+      attr_reader :configuration, :client
+    end
+  end
+end

data/lib/rubysmith/extensions/tocer.rb

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+require "tocer"
+
+module Rubysmith
+  module Extensions
+    # Ensures project skeleton documentation has table of contents.
+    class Tocer
+      def self.call(...) = new(...).call
+
+      def initialize configuration,
+                     client: ::Tocer::Runner.new,
+                     content: ::Tocer::Configuration::Content
+        @configuration = configuration
+        @client = client
+        @content = content
+      end
+
+      def call
+        client.call(settings) if configuration.build_readme
+        configuration
+      end
+
+      private
+
+      attr_reader :configuration, :client, :content
+
+      def settings
+        content[
+          includes: configuration.extensions_tocer_includes,
+          label: configuration.extensions_tocer_label,
+          root_dir: configuration.project_root
+        ]
+      end
+    end
+  end
+end

data/lib/rubysmith/identity.rb

@@ -4,7 +4,7 @@ module Rubysmith
   module Identity
     NAME = "rubysmith"
     LABEL = "Rubysmith"
-    VERSION = "0.15.0"
+    VERSION = "1.1.0"
     VERSION_LABEL = "#{LABEL} #{VERSION}".freeze
     SUMMARY = "A command line interface for smithing Ruby projects."
   end

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

@@ -1,5 +1,5 @@
 ## Overview
-<!-- Required. Describe, briefly, the behavior experienced. -->
+<!-- Required. Describe, briefly, the behavior experienced and desired. -->
 
 ## Screenshots/Screencasts
 <!-- Optional. Attach screenshot(s) and/or screencast(s) that demo the behavior. -->
@@ -7,8 +7,5 @@
 ## Steps to Recreate
 <!-- Required. List exact steps (numbered list) to reproduce errant behavior. -->
 
-## Desired Behavior
-<!-- Required. Describe the behavior you'd like to see or your idea of a proposed solution. -->
-
 ## Environment
 <!-- Required. What is your operating system, software version(s), etc. -->

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

@@ -6,6 +6,3 @@
 
 ## Details
 <!-- Optional. List the key features/highlights as bullet points. -->
-
-## Notes
-<!-- Optional. List additional notes/references as bullet points. -->

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

@@ -0,0 +1,11 @@
+.bundle
+<% if configuration.build_rubocop %>
+  .rubocop-http*
+<% end %>
+<% if configuration.build_yard %>
+  .yardoc
+<% end %>
+<% if configuration.build_yard %>
+  doc/yard
+<% end %>
+tmp

data/lib/rubysmith/templates/%project_name%/.rubocop.yml.erb

@@ -1,6 +1,8 @@
 inherit_from:
   - https://raw.githubusercontent.com/bkuhlmann/code_quality/main/configurations/rubocop/ruby.yml
+<% if configuration.build_rake %>
   - https://raw.githubusercontent.com/bkuhlmann/code_quality/main/configurations/rubocop/rake.yml
+<% end %>
   - https://raw.githubusercontent.com/bkuhlmann/code_quality/main/configurations/rubocop/performance.yml
 <% if configuration.build_rspec %>
   - https://raw.githubusercontent.com/bkuhlmann/code_quality/main/configurations/rubocop/rspec.yml

data/lib/rubysmith/templates/%project_name%/CITATION.cff.erb

@@ -0,0 +1,16 @@
+cff-version: 1.2.0
+message: <%= configuration.citation_message %>
+title: <%= configuration.project_label %>
+abstract:
+version: <%= configuration.project_version %>
+license: <%= configuration.license_label_version %>
+date-released: <%= configuration.now.strftime "%Y-%m-%d" %>
+authors:
+  - family-names: <%= configuration.author_family_name %>
+    given-names: <%= configuration.author_given_name %>
+    affiliation: <%= configuration.citation_affiliation %>
+    orcid: https://orcid.org/<%= configuration.citation_orcid %>
+keywords:
+ - ruby
+repository-code: <%= configuration.computed_project_url_source %>
+repository-artifact: <%= configuration.computed_project_url_download %>