rubysmith 0.16.1 → 1.0.0

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

@@ -1,33 +1,43 @@
 # frozen_string_literal: true
 
+require "refinements/structs"
+
 module Rubysmith
   module CLI
     module Parsers
       # Handles parsing of Command Line Interface (CLI) build options.
       class Build
+        using Refinements::Structs
+
         def self.call(...) = new(...).call
 
-        def initialize client: CLIENT, container: Container
+        def initialize configuration = Container[:configuration],
+                       client: Parser::CLIENT,
+                       container: Container
+          @configuration = configuration
           @client = client
           @container = container
         end
 
         def call arguments = []
           client.separator "\nBUILD OPTIONS:\n"
-          private_methods.sort.grep(/add_/).each { |method| __send__ method }
-          arguments.empty? ? arguments : client.parse!(arguments)
+          collate
+          client.parse arguments
+          configuration
         end
 
         private
 
-        attr_reader :client, :container
+        attr_reader :configuration, :client, :container
+
+        def collate = private_methods.sort.grep(/add_/).each { |method| __send__ method }
 
         def add_amazing_print
           client.on(
             "--[no-]amazing_print",
             "Add Amazing Print gem. #{default __method__}."
           ) do |value|
-            configuration.build_amazing_print = value
+            configuration.merge! build_amazing_print: value
           end
         end
 
@@ -36,16 +46,7 @@ module Rubysmith
             "--[no-]bundler-leak",
             "Add Bundler Leak gem. #{default __method__}."
           ) do |value|
-            configuration.build_bundler_leak = value
-          end
-        end
-
-        def add_changes
-          client.on(
-            "--[no-]changes",
-            "Add CHANGES documentation. #{default __method__}."
-          ) do |value|
-            configuration.build_changes = value
+            configuration.merge! build_bundler_leak: value
           end
         end
 
@@ -54,16 +55,16 @@ module Rubysmith
             "--[no-]console",
             "Add console script. #{default __method__}."
           ) do |value|
-            configuration.build_console = value
+            configuration.merge! build_console: value
           end
         end
 
         def add_contributions
           client.on(
             "--[no-]contributions",
-            "Add CONTRIBUTING documentation. #{default __method__}."
+            "Add contributions documentation. #{default __method__}."
           ) do |value|
-            configuration.build_contributions = value
+            configuration.merge! build_contributions: value
           end
         end
 
@@ -72,16 +73,43 @@ module Rubysmith
             "--[no-]circle_ci",
             "Add Circle CI configuration and badge. #{default __method__}."
           ) do |value|
-            configuration.build_circle_ci = value
+            configuration.merge! build_circle_ci: value
+          end
+        end
+
+        def add_citation
+          client.on(
+            "--[no-]citation",
+            "Add citation documentation. #{default __method__}."
+          ) do |value|
+            configuration.merge! build_citation: value
+          end
+        end
+
+        def add_community
+          client.on(
+            "--[no-]community",
+            "Add community documentation. #{default __method__}."
+          ) do |value|
+            configuration.merge! build_community: value
           end
         end
 
         def add_conduct
           client.on(
             "--[no-]conduct",
-            "Add CODE_OF_CONDUCT documentation. #{default __method__}."
+            "Add code of conduct documentation. #{default __method__}."
+          ) do |value|
+            configuration.merge! build_conduct: value
+          end
+        end
+
+        def add_dead_end
+          client.on(
+            "--[no-]dead_end",
+            "Add Dead End gem. #{default __method__}."
           ) do |value|
-            configuration.build_conduct = value
+            configuration.merge! build_dead_end: value
           end
         end
 
@@ -90,7 +118,7 @@ module Rubysmith
             "--[no-]debug",
             "Add Debug gem. #{default __method__}."
           ) do |value|
-            configuration.build_debug = value
+            configuration.merge! build_debug: value
           end
         end
 
@@ -99,7 +127,7 @@ module Rubysmith
             "--[no-]git",
             "Add Git. #{default __method__}."
           ) do |value|
-            configuration.build_git = value
+            configuration.merge! build_git: value
           end
         end
 
@@ -108,7 +136,7 @@ module Rubysmith
             "--[no-]git_hub",
             "Add GitHub templates. #{default __method__}."
           ) do |value|
-            configuration.build_git_hub = value
+            configuration.merge! build_git_hub: value
           end
         end
 
@@ -117,7 +145,7 @@ module Rubysmith
             "--[no-]git-lint",
             "Add Git Lint gem. #{default __method__}."
           ) do |value|
-            configuration.build_git_lint = value
+            configuration.merge! build_git_lint: value
           end
         end
 
@@ -126,16 +154,16 @@ module Rubysmith
             "--[no-]guard",
             "Add Guard gem. #{default __method__}."
           ) do |value|
-            configuration.build_guard = value
+            configuration.merge! build_guard: value
           end
         end
 
         def add_license
           client.on(
             "--[no-]license",
-            "Add LICENSE documentation. #{default __method__}."
+            "Add license documentation. #{default __method__}."
           ) do |value|
-            configuration.build_license = value
+            configuration.merge! build_license: value
           end
         end
 
@@ -143,8 +171,8 @@ module Rubysmith
           client.on(
             "--max",
             "Use maximum/enabled options. #{default __method__}."
-          ) do |value|
-            configuration.maximize.build_maximum = value
+          ) do
+            configuration.merge!(**configuration.maximize.to_h)
           end
         end
 
@@ -152,8 +180,8 @@ module Rubysmith
           client.on(
             "--min",
             "Use minimum/disabled options. #{default __method__}."
-          ) do |value|
-            configuration.minimize.build_minimum = value
+          ) do
+            configuration.merge!(**configuration.minimize.to_h)
           end
         end
 
@@ -162,16 +190,16 @@ module Rubysmith
             "--[no-]rake",
             "Add Rake gem. #{default __method__}."
           ) do |value|
-            configuration.build_rake = value
+            configuration.merge! build_rake: value
           end
         end
 
         def add_readme
           client.on(
             "--[no-]readme",
-            "Add README documentation. #{default __method__}."
+            "Add readme documentation. #{default __method__}."
           ) do |value|
-            configuration.build_readme = value
+            configuration.merge! build_readme: value
           end
         end
 
@@ -180,7 +208,7 @@ module Rubysmith
             "--[no-]reek",
             "Add Reek gem. #{default __method__}."
           ) do |value|
-            configuration.build_reek = value
+            configuration.merge! build_reek: value
           end
         end
 
@@ -189,7 +217,7 @@ module Rubysmith
             "--[no-]refinements",
             "Add Refinements gem. #{default __method__}."
           ) do |value|
-            configuration.build_refinements = value
+            configuration.merge! build_refinements: value
           end
         end
 
@@ -198,16 +226,16 @@ module Rubysmith
             "--[no-]rspec",
             "Add RSpec gem. #{default __method__}."
           ) do |value|
-            configuration.build_rspec = value
+            configuration.merge! build_rspec: value
           end
         end
 
         def add_rubocop
           client.on(
             "--[no-]rubocop",
-            "Add Rubocop gems. #{default __method__}."
+            "Add RuboCop gems. #{default __method__}."
           ) do |value|
-            configuration.build_rubocop = value
+            configuration.merge! build_rubocop: value
           end
         end
 
@@ -216,7 +244,7 @@ module Rubysmith
             "--[no-]setup",
             "Add setup script. #{default __method__}."
           ) do |value|
-            configuration.build_setup = value
+            configuration.merge! build_setup: value
           end
         end
 
@@ -225,7 +253,16 @@ module Rubysmith
             "--[no-]simple_cov",
             "Add SimpleCov gem. #{default __method__}."
           ) do |value|
-            configuration.build_simple_cov = value
+            configuration.merge! build_simple_cov: value
+          end
+        end
+
+        def add_versions
+          client.on(
+            "--[no-]versions",
+            "Add version history. #{default __method__}."
+          ) do |value|
+            configuration.merge! build_versions: value
           end
         end
 
@@ -234,7 +271,7 @@ module Rubysmith
             "--[no-]zeitwerk",
             "Add Zeitwerk gem. #{default __method__}."
           ) do |value|
-            configuration.build_zeitwerk = value
+            configuration.merge! build_zeitwerk: value
           end
         end
 
@@ -246,8 +283,6 @@ module Rubysmith
                 .then { |colored_boolean| "Default: #{colored_boolean}" }
         end
 
-        def configuration = container[__method__]
-
         def colorizer = container[__method__]
       end
     end

data/lib/rubysmith/cli/parsers/core.rb

@@ -1,6 +1,5 @@
 # frozen_string_literal: true
 
-require "rubysmith/identity"
 require "refinements/structs"
 
 module Rubysmith
@@ -12,21 +11,22 @@ module Rubysmith
 
         def self.call(...) = new(...).call
 
-        def initialize client: CLIENT, container: Container
+        def initialize configuration = Container[:configuration], client: Parser::CLIENT
+          @configuration = configuration
           @client = client
-          @container = container
         end
 
         def call arguments = []
           client.banner = "#{Identity::LABEL} - #{Identity::SUMMARY}"
           client.separator "\nUSAGE:\n"
           collate
-          arguments.empty? ? arguments : client.parse!(arguments)
+          client.parse arguments
+          configuration
         end
 
         private
 
-        attr_reader :client, :container
+        attr_reader :configuration, :client
 
         def collate = private_methods.sort.grep(/add_/).each { |method| __send__ method }
 
@@ -35,7 +35,7 @@ module Rubysmith
                     "--config ACTION",
                     %i[edit view],
                     "Manage gem configuration: edit or view." do |action|
-            configuration.action_config = action
+            configuration.merge! action_config: action
           end
         end
 
@@ -45,19 +45,23 @@ module Rubysmith
           end
         end
 
+        def add_publish
+          client.on "-p", "--publish VERSION", "Publish project." do |version|
+            configuration.merge! action_publish: true, project_version: version
+          end
+        end
+
         def add_version
           client.on "-v", "--version", "Show gem version." do
-            configuration.action_version = true
+            configuration.merge! action_version: true
           end
         end
 
         def add_help
           client.on "-h", "--help", "Show this message." do
-            configuration.action_help = true
+            configuration.merge! action_help: true
           end
         end
-
-        def configuration = container[__method__]
       end
     end
   end

data/lib/rubysmith/cli/shell.rb

@@ -1,43 +1,50 @@
 # frozen_string_literal: true
 
+require "milestoner"
+
 module Rubysmith
   module CLI
     # The main Command Line Interface (CLI) object.
     class Shell
-      ACTIONS = {config: Actions::Config.new, build: Actions::Build.new}.freeze
+      ACTIONS = {
+        config: Actions::Config.new,
+        build: Actions::Build.new,
+        publish: Actions::Publish.new
+      }.freeze
 
-      def initialize parser: Parsers::Assembler.new, actions: ACTIONS, container: Container
+      def initialize parser: Parser.new, actions: ACTIONS, container: Container
         @parser = parser
         @actions = actions
         @container = container
       end
 
       def call arguments = []
-        case parse arguments
-          in action_config: Symbol => action then config action
-          in action_build: true then build
-          in action_version: true then logger.info configuration.version
-          else usage
-        end
+        perform parser.call(arguments)
+      rescue OptionParser::ParseError, Milestoner::Error => error
+        logger.error { error.message }
       end
 
       private
 
       attr_reader :parser, :actions, :container
 
-      def parse arguments = []
-        parser.call arguments
-      rescue StandardError => error
-        logger.error error.message
+      def perform configuration
+        case configuration
+          in action_config: Symbol => action then config action
+          in action_build: true then build configuration
+          in action_publish: true then publish configuration
+          in action_version: true then logger.info Identity::VERSION_LABEL
+          else usage
+        end
       end
 
       def config(action) = actions.fetch(__method__).call(action)
 
-      def build = actions.fetch(__method__).call
+      def build(configuration) = actions.fetch(__method__).call(configuration)
 
-      def usage = logger.unknown(parser.to_s)
+      def publish(configuration) = actions.fetch(__method__).call(configuration)
 
-      def configuration = container[__method__]
+      def usage = logger.unknown(parser.to_s)
 
       def logger = container[__method__]
     end

data/lib/rubysmith/configuration/content.rb

@@ -0,0 +1,170 @@
+# 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_help,
+      :action_publish,
+      :action_version,
+      :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_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,88 @@
+: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
+  :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