rubysmith 0.12.0 → 0.16.0

data/lib/rubysmith/cli/configuration/content.rb

@@ -8,27 +8,30 @@ module Rubysmith
     module Configuration
       # Defines the common configuration content for use throughout the gem.
       Content = Struct.new(
-        :config,
-        :template_root,
-        :template_path,
-        :build_root,
-        :project_name,
-        :author_name,
+        :action_build,
+        :action_config,
+        :action_help,
+        :action_version,
         :author_email,
+        :author_name,
         :author_url,
-        :now,
-        :documentation_format,
-        :documentation_license,
-        :build_minimum,
         :build_amazing_print,
         :build_bundler_leak,
+        :build_changes,
+        :build_circle_ci,
+        :build_conduct,
         :build_console,
-        :build_documentation,
+        :build_contributions,
+        :build_debug,
         :build_git,
+        :build_git_hub,
         :build_git_lint,
         :build_guard,
-        :build_pry,
+        :build_license,
+        :build_maximum,
+        :build_minimum,
         :build_rake,
+        :build_readme,
         :build_reek,
         :build_refinements,
         :build_rspec,
@@ -38,8 +41,15 @@ module Rubysmith
         :build_zeitwerk,
         :builders_pragmater_comments,
         :builders_pragmater_includes,
+        :documentation_format,
+        :documentation_license,
+        :git_hub_user,
+        :now,
+        :project_name,
+        :target_root,
+        :template_path,
+        :template_root,
         :version,
-        :help,
         keyword_init: true
       ) do
         using Refinements::Strings
@@ -48,22 +58,38 @@ module Rubysmith
           super
 
           self[:template_root] ||= Pathname(__dir__).join("../../templates").expand_path
-          self[:build_root] ||= Pathname.pwd
-          freeze
+          self[:target_root] ||= Pathname.pwd
         end
 
         def with(attributes) = self.class.new(to_h.merge(attributes))
 
+        def maximize = update_build_options(true)
+
+        def minimize = update_build_options(false)
+
         def project_label = project_name.titleize
 
         def project_class = project_name.camelcase
 
-        def project_root = build_root.join(project_name)
+        def project_root = target_root.join(project_name)
 
         def project_path = project_name.snakecase
 
+        def ascii_doc? = documentation_format == "adoc"
+
+        def markdown? = documentation_format == "md"
+
         def to_pathway
-          Pathway[start_root: template_root, start_path: template_path, end_root: build_root]
+          Pathway[start_root: template_root, start_path: template_path, end_root: target_root]
+        end
+
+        private
+
+        def update_build_options value
+          to_h.except(:build_minimum)
+              .select { |key, _value| key.start_with? "build_" }
+              .each { |key, _value| self[key] = value }
+              .then { self }
         end
       end
     end

data/lib/rubysmith/cli/configuration/defaults.yml

@@ -1,23 +1,25 @@
-:project:
-  :name:
 :author:
   :name:
   :email:
   :url:
-:documentation:
-  :format: "md"
-  :license: "mit"
 :build:
   :amazing_print: true
   :bundler_leak: true
+  :changes: true
+  :circle_ci: false
+  :conduct: true
   :console: true
-  :documentation: true
+  :contributions: true
+  :debug: true
   :git: true
+  :git_hub: false
   :git_lint: true
   :guard: true
+  :license: true
+  :maximum: false
   :minimum: false
-  :pry: true
   :rake: true
+  :readme: true
   :reek: true
   :refinements: true
   :rspec: true
@@ -37,3 +39,8 @@
       - "**/*Gemfile"
       - "**/*Guardfile"
       - "**/*Rakefile"
+:documentation:
+  :format: "md"
+  :license: "mit"
+:git_hub:
+  :user:

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

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+require "refinements/structs"
+
+module Rubysmith
+  module CLI
+    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: now)
+
+          private
+
+          attr_reader :now
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+require "git_plus"
+require "refinements/strings"
+require "refinements/structs"
+
+module Rubysmith
+  module CLI
+    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
+end

data/lib/rubysmith/cli/configuration/enhancers/version.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+require "refinements/structs"
+
+module Rubysmith
+  module CLI
+    module Configuration
+      module Enhancers
+        # Adds this gem's version to content.
+        class Version
+          using Refinements::Structs
+
+          def initialize version = Identity::VERSION_LABEL
+            @version = version
+          end
+
+          def call(content) = content.merge(version: version)
+
+          private
+
+          attr_reader :version
+        end
+      end
+    end
+  end
+end

data/lib/rubysmith/cli/configuration/loader.rb

@@ -17,18 +17,29 @@ module Rubysmith
         DEFAULTS = YAML.load_file(Pathname(__dir__).join("defaults.yml")).freeze
         CLIENT = Runcom::Config.new "#{Identity::NAME}/configuration.yml", defaults: DEFAULTS
 
-        def self.call = new.call
+        ENHANCERS = [
+          Enhancers::GitHubUser.new,
+          Enhancers::CurrentTime.new,
+          Enhancers::Version.new
+        ].freeze
 
-        def initialize content: Content.new, client: CLIENT
+        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 = content.merge(**client.to_h.flatten_keys)
+        def call = enhancers.reduce(preload_content) { |preload, enhancer| enhancer.call preload }
 
         private
 
-        attr_reader :content, :client
+        attr_reader :content, :client, :enhancers
+
+        def preload_content = content.merge(**client.to_h.flatten_keys)
       end
     end
   end

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

@@ -7,27 +7,25 @@ module Rubysmith
       class Assembler
         SECTIONS = [Core, Build].freeze # Order is important.
 
-        def initialize configuration: CLI::Configuration::Loader.call,
-                       sections: SECTIONS,
-                       client: CLIENT
-          @options = configuration.to_h
+        def initialize sections: SECTIONS, client: CLIENT, container: Container
           @sections = sections
           @client = client
+          @container = container
         end
 
         def call arguments = []
-          sections.each { |parser| parser.call client: client, options: options }
+          sections.each { |parser| parser.call client: client }
           client.parse! arguments
-          options
+          configuration
         end
 
-        def to_h = options
-
         def to_s = client.to_s
 
         private
 
-        attr_reader :options, :sections, :client
+        attr_reader :sections, :client, :container
+
+        def configuration = container[__method__]
       end
     end
   end

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

@@ -7,9 +7,9 @@ module Rubysmith
       class Build
         def self.call(...) = new(...).call
 
-        def initialize options: {}, client: CLIENT
-          @options = options
+        def initialize client: CLIENT, container: Container
           @client = client
+          @container = container
         end
 
         def call arguments = []
@@ -20,109 +20,235 @@ module Rubysmith
 
         private
 
-        attr_reader :options, :client
+        attr_reader :client, :container
 
-        def add_minimum
-          client.on "--min", "Use minimum/no options." do |value|
-            options[:build_minimum] = value
+        def add_amazing_print
+          client.on(
+            "--[no-]amazing_print",
+            "Add Amazing Print gem. #{default __method__}."
+          ) do |value|
+            configuration.build_amazing_print = value
           end
         end
 
-        def add_amazing_print
-          client.on "--[no-]amazing_print", "Add Amazing Print." do |value|
-            options[:build_amazing_print] = value
+        def add_bundler_leak
+          client.on(
+            "--[no-]bundler-leak",
+            "Add Bundler Leak gem. #{default __method__}."
+          ) do |value|
+            configuration.build_bundler_leak = value
           end
         end
 
-        def add_bundler_leak
-          client.on "--[no-]bundler-leak", "Add Bundler Leak." do |value|
-            options[:build_bundler_leak] = value
+        def add_changes
+          client.on(
+            "--[no-]changes",
+            "Add CHANGES documentation. #{default __method__}."
+          ) do |value|
+            configuration.build_changes = value
           end
         end
 
         def add_console
-          client.on "--[no-]console", "Add console script." do |value|
-            options[:build_console] = value
+          client.on(
+            "--[no-]console",
+            "Add console script. #{default __method__}."
+          ) do |value|
+            configuration.build_console = value
+          end
+        end
+
+        def add_contributions
+          client.on(
+            "--[no-]contributions",
+            "Add CONTRIBUTING documentation. #{default __method__}."
+          ) do |value|
+            configuration.build_contributions = value
           end
         end
 
-        def add_documentation
-          client.on "--[no-]documentation", "Add documentation." do |value|
-            options[:build_documentation] = value
+        def add_circle_ci
+          client.on(
+            "--[no-]circle_ci",
+            "Add Circle CI configuration and badge. #{default __method__}."
+          ) do |value|
+            configuration.build_circle_ci = value
+          end
+        end
+
+        def add_conduct
+          client.on(
+            "--[no-]conduct",
+            "Add CODE_OF_CONDUCT documentation. #{default __method__}."
+          ) do |value|
+            configuration.build_conduct = value
+          end
+        end
+
+        def add_debug
+          client.on(
+            "--[no-]debug",
+            "Add Debug gem. #{default __method__}."
+          ) do |value|
+            configuration.build_debug = value
           end
         end
 
         def add_git
-          client.on "--[no-]git", "Add Git." do |value|
-            options[:build_git] = value
+          client.on(
+            "--[no-]git",
+            "Add Git. #{default __method__}."
+          ) do |value|
+            configuration.build_git = value
+          end
+        end
+
+        def add_git_hub
+          client.on(
+            "--[no-]git_hub",
+            "Add GitHub templates. #{default __method__}."
+          ) do |value|
+            configuration.build_git_hub = value
           end
         end
 
         def add_git_lint
-          client.on "--[no-]git-lint", "Add Git Lint." do |value|
-            options[:build_git_lint] = value
+          client.on(
+            "--[no-]git-lint",
+            "Add Git Lint gem. #{default __method__}."
+          ) do |value|
+            configuration.build_git_lint = value
           end
         end
 
         def add_guard
-          client.on "--[no-]guard", "Add Guard." do |value|
-            options[:build_guard] = value
+          client.on(
+            "--[no-]guard",
+            "Add Guard gem. #{default __method__}."
+          ) do |value|
+            configuration.build_guard = value
+          end
+        end
+
+        def add_license
+          client.on(
+            "--[no-]license",
+            "Add LICENSE documentation. #{default __method__}."
+          ) do |value|
+            configuration.build_license = value
           end
         end
 
-        def add_pry
-          client.on "--[no-]pry", "Add Pry." do |value|
-            options[:build_pry] = value
+        def add_maximum
+          client.on(
+            "--max",
+            "Use maximum/enabled options. #{default __method__}."
+          ) do |value|
+            configuration.maximize.build_maximum = value
+          end
+        end
+
+        def add_minimum
+          client.on(
+            "--min",
+            "Use minimum/disabled options. #{default __method__}."
+          ) do |value|
+            configuration.minimize.build_minimum = value
           end
         end
 
         def add_rake
-          client.on "--[no-]rake", "Add Rake." do |value|
-            options[:build_rake] = value
+          client.on(
+            "--[no-]rake",
+            "Add Rake gem. #{default __method__}."
+          ) do |value|
+            configuration.build_rake = value
+          end
+        end
+
+        def add_readme
+          client.on(
+            "--[no-]readme",
+            "Add README documentation. #{default __method__}."
+          ) do |value|
+            configuration.build_readme = value
           end
         end
 
         def add_reek
-          client.on "--[no-]reek", "Add Reek." do |value|
-            options[:build_reek] = value
+          client.on(
+            "--[no-]reek",
+            "Add Reek gem. #{default __method__}."
+          ) do |value|
+            configuration.build_reek = value
           end
         end
 
         def add_refinements
-          client.on "--[no-]refinements", "Add Refinements." do |value|
-            options[:build_refinements] = value
+          client.on(
+            "--[no-]refinements",
+            "Add Refinements gem. #{default __method__}."
+          ) do |value|
+            configuration.build_refinements = value
           end
         end
 
         def add_rspec
-          client.on "--[no-]rspec", "Add RSpec." do |value|
-            options[:build_rspec] = value
+          client.on(
+            "--[no-]rspec",
+            "Add RSpec gem. #{default __method__}."
+          ) do |value|
+            configuration.build_rspec = value
           end
         end
 
         def add_rubocop
-          client.on "--[no-]rubocop", "Add Rubocop." do |value|
-            options[:build_rubocop] = value
+          client.on(
+            "--[no-]rubocop",
+            "Add Rubocop gems. #{default __method__}."
+          ) do |value|
+            configuration.build_rubocop = value
           end
         end
 
         def add_setup
-          client.on "--[no-]setup", "Add setup script." do |value|
-            options[:build_setup] = value
+          client.on(
+            "--[no-]setup",
+            "Add setup script. #{default __method__}."
+          ) do |value|
+            configuration.build_setup = value
           end
         end
 
         def add_simple_cov
-          client.on "--[no-]simple_cov", "Add SimpleCov." do |value|
-            options[:build_simple_cov] = value
+          client.on(
+            "--[no-]simple_cov",
+            "Add SimpleCov gem. #{default __method__}."
+          ) do |value|
+            configuration.build_simple_cov = value
           end
         end
 
         def add_zeitwerk
-          client.on "--[no-]zeitwerk", "Add Zeitwerk." do |value|
-            options[:build_zeitwerk] = value
+          client.on(
+            "--[no-]zeitwerk",
+            "Add Zeitwerk gem. #{default __method__}."
+          ) do |value|
+            configuration.build_zeitwerk = value
           end
         end
+
+        def default option
+          option.to_s
+                .sub("add_", "build_")
+                .then { |attribute| configuration.public_send attribute }
+                .then { |boolean| boolean ? colorizer.green(boolean) : colorizer.red(boolean) }
+                .then { |colored_boolean| "Default: #{colored_boolean}" }
+        end
+
+        def configuration = container[__method__]
+
+        def colorizer = container[__method__]
       end
     end
   end

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

@@ -1,17 +1,20 @@
 # frozen_string_literal: true
 
 require "rubysmith/identity"
+require "refinements/structs"
 
 module Rubysmith
   module CLI
     module Parsers
       # Handles parsing of Command Line Interface (CLI) core options.
       class Core
+        using Refinements::Structs
+
         def self.call(...) = new(...).call
 
-        def initialize options: {}, client: CLIENT
-          @options = options
+        def initialize client: CLIENT, container: Container
           @client = client
+          @container = container
         end
 
         def call arguments = []
@@ -23,7 +26,7 @@ module Rubysmith
 
         private
 
-        attr_reader :options, :client
+        attr_reader :client, :container
 
         def collate = private_methods.sort.grep(/add_/).each { |method| __send__ method }
 
@@ -32,27 +35,29 @@ module Rubysmith
                     "--config ACTION",
                     %i[edit view],
                     "Manage gem configuration: edit or view." do |action|
-            options[:config] = action
+            configuration.action_config = action
           end
         end
 
         def add_build
-          client.on "-b", "--build NAME [options]", "Build new project." do |value|
-            options[:build] = value
+          client.on "-b", "--build NAME [options]", "Build new project." do |name|
+            configuration.merge! action_build: true, project_name: name
           end
         end
 
         def add_version
           client.on "-v", "--version", "Show gem version." do
-            options[:version] = Identity::VERSION_LABEL
+            configuration.action_version = true
           end
         end
 
         def add_help
           client.on "-h", "--help", "Show this message." do
-            options[:help] = true
+            configuration.action_help = true
           end
         end
+
+        def configuration = container[__method__]
       end
     end
   end