rubysmith 0.13.0 → 0.14.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: aa3e01ddcd6743f57757311a125d1e8ab39c44e09c1f1186a53b4a0ca6388d7d
-  data.tar.gz: d0725b76c5829d64fbd5e648506ae2e57adbb9882e992b84bfddaa879f166a0b
+  metadata.gz: '0803a284b4191d1a3e08664747ddbb8bc743529a93d8d7f393b21dc0b488bead'
+  data.tar.gz: 1769e77743e2d90d262fc609dc0ca80a3b60f53400e977bde321d5b0b24e8e9a
 SHA512:
-  metadata.gz: 1e14344b8a18601ef9e05ab3463491977eb81a62027dad1658a7cb1012f94f982296fe1981eea3bd90f35aa88668d3b553d3ef4bed5e77c7dddd060a8a2e444a
-  data.tar.gz: 7b1d999af3527fdd1a182dc2405d19b852cfb93ab8d8c70fa2f1b1e5c3261daa8548d13966d062e266911817e53e394f20442c778c59aad4f89fe4b33402380a
+  metadata.gz: b1e9a371e502cb7f14359b2d9c9c4ead3703f2c02b70864e192a1a894a4e5e046e8146d8698edc4ea89570edba94e610b2108a7736ce13341fd08dcd858e705a
+  data.tar.gz: 297b580c0a5c44a53d705d3b27f1f3da6590cd067da2d36d7bbbd630f5debb03aea8bd37e858ec79038f3db25cbe5cd28ec5406a6bd7f389ef6877aafd68c455

checksums.yaml.gz.sig

@@ -1,4 +1,2 @@
-�;��ݺ�a o�g%��?��}�N1ʜE�@�׀���E��F��W����@
-�T[ZvЎ��c*��!��9z�M_�!��$B�Do4N���E�G�����5�#���w%	�#�d�`�me.縚�}W�X��bJ�C$M���t7�$���qd��
-�P/�ߢ�h�=`�@�B��w,&zr�I���c�p1\=/�a Y�!^��h��Q�Z���1����Q
-�4)�`I������8.`�(
+��h0yO�rg���a�K��[2F��'�FcτY�ʵ>W5�QLJ }$�Dg���|:�P��ՈI�S�62o-�F�	S���e5� ۩9�.�:�3��K�]���6ؗ��.}m:)�V��d(2O������A6ޢ���$�qڶ��̋3��.D�^�:�W&���+�j'o�E�+�4��i1-)ߡk����b��C1����W�z?��تX<
+U�G�8�ŜXa��p-(Y��������jB��`�#

data/README.adoc

@@ -30,8 +30,10 @@ toc::[]
 * Uses link:https://www.alchemists.io/projects/pragmater[Pragmater] for Ruby source pragma directives.
 * Supports link:https://github.com/amazing-print/amazing_print[Amazing Print].
 * Supports link:https://github.com/rubymem/bundler-leak[Bundler Leak].
+* Supports link:https://circleci.com[Circle CI].
 * Supports link:https://github.com/ruby/debug[Debug].
 * Supports link:https://git-scm.com[Git].
+* Supports link:https://github.com[GitHub].
 * Supports link:https://www.alchemists.io/projects/git-lint[Git Lint].
 * Supports link:https://github.com/guard/guard[Guard].
 * Supports link:https://github.com/ruby/rake[Rake].
@@ -48,8 +50,8 @@ toc::[]
 * Provides common documentation:
 ** README
 ** CHANGES
-** CONTRIBUTING
 ** CODE OF CONDUCT
+** CONTRIBUTING
 ** LICENSE
 
 // == Screencasts
@@ -87,23 +89,30 @@ USAGE:
   -v, --version                            Show gem version.
 
 BUILD OPTIONS:
-  --[no-]amazing_print                 Add Amazing Print.
-  --[no-]bundler-leak                  Add Bundler Leak.
-  --[no-]console                       Add console script.
-  --[no-]debug                         Add Debug.
-  --[no-]documentation                 Add documentation.
-  --[no-]git                           Add Git.
-  --[no-]git-lint                      Add Git Lint.
-  --[no-]guard                         Add Guard.
-  --min                                Use minimum/no options.
-  --[no-]rake                          Add Rake.
-  --[no-]reek                          Add Reek.
-  --[no-]refinements                   Add Refinements.
-  --[no-]rspec                         Add RSpec.
-  --[no-]rubocop                       Add Rubocop.
-  --[no-]setup                         Add setup script.
-  --[no-]simple_cov                    Add SimpleCov.
-  --[no-]zeitwerk                      Add Zeitwerk.
+  --[no-]amazing_print                 Add Amazing Print gem. Default: true.
+  --[no-]bundler-leak                  Add Bundler Leak gem. Default: true.
+  --[no-]changes                       Add CHANGES documentation. Default: true.
+  --[no-]circle_ci                     Add Circle CI configuration and badge. Default: false.
+  --[no-]conduct                       Add CODE_OF_CONDUCT documentation. Default: true.
+  --[no-]console                       Add console script. Default: true.
+  --[no-]contributions                 Add CONTRIBUTING documentation. Default: true.
+  --[no-]debug                         Add Debug gem. Default: true.
+  --[no-]git                           Add Git. Default: true.
+  --[no-]git_hub                       Add GitHub templates. Default: false.
+  --[no-]git-lint                      Add Git Lint gem. Default: true.
+  --[no-]guard                         Add Guard gem. Default: true.
+  --[no-]license                       Add LICENSE documentation. Default: true.
+  --max                                Use maximum/enabled options. Default: false.
+  --min                                Use minimum/disabled options. Default: false.
+  --[no-]rake                          Add Rake gem. Default: true.
+  --[no-]readme                        Add README documentation. Default: true.
+  --[no-]reek                          Add Reek gem. Default: true.
+  --[no-]refinements                   Add Refinements gem. Default: true.
+  --[no-]rspec                         Add RSpec gem. Default: true.
+  --[no-]rubocop                       Add Rubocop gems. Default: true.
+  --[no-]setup                         Add setup script. Default: true.
+  --[no-]simple_cov                    Add SimpleCov gem. Default: true.
+  --[no-]zeitwerk                      Add Zeitwerk gem. Default: true.
 ....
 
 === Building
@@ -137,19 +146,20 @@ The above is essentially the same as building with _all_ options disabled. This
 situations where you need to quickly script something up for sharing with others yet still want to
 avoid using a Bundler Inline script so gem dependencies are not installed each time the code is run.
 
-As shown earlier, you can combine options but the order options can be handy in certain situations
-especially when used with the minimum build option. Example:
+As shown earlier, you can combine options but be aware that order matters. Take the following, for
+example, where both minimum and maximum options are used in conjunction with other options:
 
 [source,bash]
 ----
 rubysmith --build demo --min --zeitwerk
+rubysmith --build demo --max --no-debug
 ----
 
-The above will disable _all_ options except for Zeitwerk which will be enabled in this situation.
-This can be a handy way to build a new project with all options disabled with only a few select
-options enabled. To have specific options enabled/disabled _every time_ you build a new Ruby
-project, you can edit your global configuration for making these settings permanent (see below for
-details).
+With the above examples, the first line will _disable_ all options except for Zeitwerk while the
+second line will _enable_ all options except for Debug. This can be a handy way to build a new
+project with all options either disabled or enabled with only a few select options modified. To have
+specific options enabled/disabled _every time_ you build a new Ruby project, you can edit your
+global configuration for making these settings permanent (see below for details).
 
 === Configuration
 
@@ -160,9 +170,7 @@ $HOME/.config/rubysmith/configuration.yml
 ....
 
 It can also be configured via link:https://www.alchemists.io/projects/xdg[XDG] environment
-variables.
-
-The default configuration is as follows:
+variables. The default configuration is as follows:
 
 [source,yaml]
 ----
@@ -170,20 +178,24 @@ The default configuration is as follows:
   :name:
   :email:
   :url:
-:documentation:
-  :format: "md"
-  :license: "mit"
 :build:
   :amazing_print: true
   :bundler_leak: true
+  :changes: true
+  :circle_ci: false
+  :conduct: true
   :console: true
+  :contributions: true
   :debug: true
-  :documentation: 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
@@ -203,11 +215,55 @@ The default configuration is as follows:
       - "**/*Gemfile"
       - "**/*Guardfile"
       - "**/*Rakefile"
+:documentation:
+  :format: "md"
+  :license: "mit"
+:git_hub:
+  :user:
 ----
 
 Feel free to take this default configuration, modify, and save as your own custom
 `configuration.yml`.
 
+==== Author
+
+Author information is used when generating project documentation and is recommended you fill this
+information in before building a project. Example:
+
+    :author:
+      :name: Jill Smith
+      :email: jsmith@example.com
+      :url: https://www.exmaple.com/team/jsmith
+
+==== Build
+
+Build options are booleans so can only be `true` or `false` by default. Should you want a different
+configuration than what is enabled/disabled by default, you'll want to customize these options as
+you see fit. When changing build options, they will dynamically show up when viewing usage (i.e.
+`rubysmith --help`).
+
+==== Builders
+
+Builders are additional tooling which can be configured specifically for Rubysmith. At the moment,
+only link:https://www.alchemists.io/projects/pragmater[Pragmater] is supported so view the Pragmater
+project page to learn more.
+
+==== Documentation
+
+Documentation can be configured as follows:
+
+* *Format*: Use `md` for Markdown or `adoc` for ASCCI Doc.
+* *License*: Use `mit` for MIT or `Apache` for Apache 2.0.0 license.
+
+No other licenses are supported at this time but might be expanded up on in the future.
+
+==== GitHub
+
+Your GitHub user is whatever handle you setup when you creating your GitHub account. This
+information is used for documentation purposes and Circle CI badge association. If you don't define
+this information, Rubysmith will automatically fallback to pulling this information from your Git
+configuration (i.e. `github.user`). If all else fails, then nothing will be used.
+
 == Development
 
 To contribute, run:

data/lib/rubysmith/builders/bundler.rb

@@ -25,7 +25,7 @@ module Rubysmith
                .replace(/\n\s+gem/, "\n  gem")
                .replace(/  (?=.+(refinements|zeitwerk))/, "")
                .replace(/(\n+|\s+)end/, "\nend")
-               .replace(/\n\ngroup :(code_quality|test|tools) do\nend/, "")
+               .replace(/\n\ngroup :(code_quality|development|test|tools) do\nend/, "")
                .replace(/org"\n+/, "org\"\n\n")
 
         configuration.project_root.change_dir { client.start %w[install --quiet] }

data/lib/rubysmith/builders/circle_ci.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+module Rubysmith
+  module Builders
+    # Builds project skeleton Circle CI configuration.
+    class CircleCI
+      def self.call(...) = new(...).call
+
+      def initialize configuration, builder: Builder
+        @configuration = configuration
+        @builder = builder
+      end
+
+      def call
+        return unless configuration.build_circle_ci
+
+        builder.call(configuration.with(template_path: "%project_name%/.circleci/config.yml.erb"))
+               .render
+      end
+
+      private
+
+      attr_reader :configuration, :builder
+    end
+  end
+end

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

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+require "tocer"
+
+module Rubysmith
+  module Builders
+    module Documentation
+      # Builds project skeleton CHANGES documentation.
+      class Change
+        def self.call(...) = new(...).call
+
+        def initialize configuration, builder: Builder
+          @configuration = configuration
+          @builder = builder
+        end
+
+        def call
+          return unless configuration.build_changes
+
+          builder.call(configuration.with(template_path: "%project_name%/CHANGES.#{kind}.erb"))
+                 .render
+        end
+
+        private
+
+        attr_reader :configuration, :builder
+
+        def kind = configuration.documentation_format || "md"
+      end
+    end
+  end
+end

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

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+require "tocer"
+
+module Rubysmith
+  module Builders
+    module Documentation
+      # Builds project skeleton CODE_OF_CONDUCT documentation.
+      class Conduct
+        def self.call(...) = new(...).call
+
+        def initialize configuration, builder: Builder
+          @configuration = configuration
+          @builder = builder
+        end
+
+        def call
+          return unless configuration.build_conduct
+
+          configuration.with(template_path: "%project_name%/CODE_OF_CONDUCT.#{kind}.erb")
+                       .then { |updated_configuration| builder.call(updated_configuration).render }
+        end
+
+        private
+
+        attr_reader :configuration, :builder
+
+        def kind = configuration.documentation_format || "md"
+      end
+    end
+  end
+end

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

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+require "tocer"
+
+module Rubysmith
+  module Builders
+    module Documentation
+      # Builds project skeleton CONTRIBUTING documentation.
+      class Contribution
+        def self.call(...) = new(...).call
+
+        def initialize configuration, builder: Builder
+          @configuration = configuration
+          @builder = builder
+        end
+
+        def call
+          return unless configuration.build_contributions
+
+          builder.call(configuration.with(template_path: "%project_name%/CONTRIBUTING.#{kind}.erb"))
+                 .render
+        end
+
+        private
+
+        attr_reader :configuration, :builder
+
+        def kind = configuration.documentation_format || "md"
+      end
+    end
+  end
+end

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

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+require "tocer"
+
+module Rubysmith
+  module Builders
+    module Documentation
+      # Builds project skeleton LICENSE documentation.
+      class License
+        def self.call(...) = new(...).call
+
+        def initialize configuration, builder: Builder
+          @configuration = configuration
+          @builder = builder
+        end
+
+        def call
+          return unless configuration.build_license
+
+          configuration.with(template_path: "%project_name%/LICENSE-#{license}.#{kind}.erb")
+                       .then do |updated_configuration|
+                         builder.call(updated_configuration).render.rename "LICENSE.#{kind}"
+                       end
+        end
+
+        private
+
+        attr_reader :configuration, :builder
+
+        def kind = configuration.documentation_format || "md"
+
+        def license = configuration.documentation_license || "mit"
+      end
+    end
+  end
+end

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

@@ -0,0 +1,44 @@
+# frozen_string_literal: true
+
+require "tocer"
+
+module Rubysmith
+  module Builders
+    module Documentation
+      # Builds project skeleton README documentation.
+      class Readme
+        def self.call(...) = new(...).call
+
+        def initialize configuration, builder: Builder, tocer: Tocer::Writer.new
+          @configuration = configuration
+          @builder = builder
+          @tocer = tocer
+        end
+
+        def call
+          return unless configuration.build_readme
+
+          private_methods.sort.grep(/render_/).each { |method| __send__ method }
+        end
+
+        private
+
+        attr_reader :configuration, :builder, :tocer
+
+        def render_content
+          builder.call(configuration.with(template_path: "%project_name%/README.#{kind}.erb"))
+                 .render
+                 .replace("\n\n\n", "\n\n")
+        end
+
+        def render_table_of_contents
+          configuration.project_root
+                       .join("README.md")
+                       .then { |path| tocer.call path if path.exist? }
+        end
+
+        def kind = configuration.documentation_format || "md"
+      end
+    end
+  end
+end

data/lib/rubysmith/builders/git_hub.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+module Rubysmith
+  module Builders
+    # Builds project skeleton GitHub templates.
+    class GitHub
+      def self.call(...) = new(...).call
+
+      def initialize configuration, builder: Builder
+        @configuration = configuration
+        @builder = builder
+      end
+
+      def call
+        return unless configuration.build_git_hub
+
+        builder.call(with_issue_template).render
+        builder.call(with_pull_request_template).render
+      end
+
+      private
+
+      attr_reader :configuration, :builder
+
+      def with_issue_template
+        configuration.with template_path: "%project_name%/.github/ISSUE_TEMPLATE.md.erb"
+      end
+
+      def with_pull_request_template
+        configuration.with template_path: "%project_name%/.github/PULL_REQUEST_TEMPLATE.md.erb"
+      end
+    end
+  end
+end

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

@@ -8,12 +8,18 @@ module Rubysmith
         # Order is important.
         BUILDERS = [
           Builders::Core,
-          Builders::Documentation,
+          Builders::Documentation::Readme,
+          Builders::Documentation::Change,
+          Builders::Documentation::Conduct,
+          Builders::Documentation::Contribution,
+          Builders::Documentation::License,
           Builders::Git::Setup,
           Builders::Bundler,
           Builders::Rake,
           Builders::Console,
+          Builders::CircleCI,
           Builders::Setup,
+          Builders::GitHub,
           Builders::Guard,
           Builders::Reek,
           Builders::RSpec::Context,

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

@@ -17,14 +17,21 @@ module Rubysmith
         :author_url,
         :build_amazing_print,
         :build_bundler_leak,
+        :build_changes,
+        :build_circle_ci,
+        :build_conduct,
         :build_console,
+        :build_contributions,
         :build_debug,
-        :build_documentation,
         :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,
@@ -36,11 +43,13 @@ module Rubysmith
         :builders_pragmater_includes,
         :documentation_format,
         :documentation_license,
+        :git_hub_user,
         :now,
         :project_name,
         :target_root,
         :template_path,
         :template_root,
+        :version,
         keyword_init: true
       ) do
         using Refinements::Strings
@@ -54,12 +63,9 @@ module Rubysmith
 
         def with(attributes) = self.class.new(to_h.merge(attributes))
 
-        def minimize
-          to_h.except(:build_minimum)
-              .select { |key, _value| key.start_with? "build_" }
-              .each { |key, _value| self[key] = false }
-              .then { self }
-        end
+        def maximize = update_build_options(true)
+
+        def minimize = update_build_options(false)
 
         def project_label = project_name.titleize
 
@@ -69,9 +75,22 @@ module Rubysmith
 
         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: 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
   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
+  :contributions: true
   :debug: true
-  :documentation: 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
@@ -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,21 +17,29 @@ module Rubysmith
         DEFAULTS = YAML.load_file(Pathname(__dir__).join("defaults.yml")).freeze
         CLIENT = Runcom::Config.new "#{Identity::NAME}/configuration.yml", defaults: DEFAULTS
 
+        ENHANCERS = [
+          Enhancers::GitHubUser.new,
+          Enhancers::CurrentTime.new,
+          Enhancers::Version.new
+        ].freeze
+
         def self.call(...) = new(...).call
 
-        def self.with_defaults(now: Time.now) = new(now: now, client: DEFAULTS)
+        def self.with_defaults = new(client: DEFAULTS, enhancers: [])
 
-        def initialize now: Time.now, content: Content.new, client: CLIENT
-          @now = now
+        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, now: now)
+        def call = enhancers.reduce(preload_content) { |preload, enhancer| enhancer.call preload }
 
         private
 
-        attr_reader :now, :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/build.rb

@@ -23,108 +23,232 @@ module Rubysmith
         attr_reader :client, :container
 
         def add_amazing_print
-          client.on "--[no-]amazing_print", "Add Amazing Print." do |value|
+          client.on(
+            "--[no-]amazing_print",
+            "Add Amazing Print gem. #{default __method__}."
+          ) do |value|
             configuration.build_amazing_print = value
           end
         end
 
         def add_bundler_leak
-          client.on "--[no-]bundler-leak", "Add Bundler Leak." do |value|
+          client.on(
+            "--[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
+          end
+        end
+
         def add_console
-          client.on "--[no-]console", "Add console script." do |value|
+          client.on(
+            "--[no-]console",
+            "Add console script. #{default __method__}."
+          ) do |value|
             configuration.build_console = value
           end
         end
 
-        def add_debug
-          client.on "--[no-]debug", "Add Debug." do |value|
-            configuration.build_debug = value
+        def add_contributions
+          client.on(
+            "--[no-]contributions",
+            "Add CONTRIBUTING documentation. #{default __method__}."
+          ) do |value|
+            configuration.build_contributions = value
+          end
+        end
+
+        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_documentation
-          client.on "--[no-]documentation", "Add documentation." do |value|
-            configuration.build_documentation = value
+        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|
+          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|
+          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|
+          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_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/no options." do |value|
+          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|
+          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|
+          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|
+          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|
+          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|
+          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|
+          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|
+          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|
+          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

@@ -47,7 +47,7 @@ module Rubysmith
 
         def add_version
           client.on "-v", "--version", "Show gem version." do
-            configuration.action_version = Identity::VERSION_LABEL
+            configuration.action_version = true
           end
         end
 

data/lib/rubysmith/cli/shell.rb

@@ -16,7 +16,7 @@ module Rubysmith
         case parse arguments
           in action_config: Symbol => action then config action
           in action_build: true then build
-          in action_version: String => version then puts version
+          in action_version: true then logger.info configuration.version
           else usage
         end
       end
@@ -28,7 +28,7 @@ module Rubysmith
       def parse arguments = []
         parser.call arguments
       rescue StandardError => error
-        puts error.message
+        logger.error error.message
       end
 
       def config(action) = actions.fetch(__method__).call(action)
@@ -37,6 +37,8 @@ module Rubysmith
 
       def usage = logger.unknown(parser.to_s)
 
+      def configuration = container[__method__]
+
       def logger = container[__method__]
     end
   end

data/lib/rubysmith/identity.rb

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

data/lib/rubysmith/templates/%project_name%/.circleci/config.yml.erb

@@ -0,0 +1,31 @@
+version: 2.1
+jobs:
+  build:
+    working_directory: ~/project
+    docker:
+      - image: bkuhlmann/alpine-ruby:latest
+    steps:
+      - checkout
+
+      - restore_cache:
+          name: Bundler Restore
+          keys:
+            - gem-cache-{{.Branch}}-{{checksum "Gemfile.lock"}}
+            - gem-cache-
+
+      - run:
+          name: Bundler Install
+          command: |
+            gem update --system
+            bundle config set path "vendor/bundle"
+            bundle install
+
+      - save_cache:
+          name: Bundler Store
+          key: gem-cache-{{.Branch}}-{{checksum "Gemfile.lock"}}
+          paths:
+            - vendor/bundle
+
+      - run:
+          name: Build
+          command: bundle exec rake

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

@@ -0,0 +1,14 @@
+## Overview
+<!-- Required. Describe, briefly, the behavior experienced. -->
+
+## Screenshots/Screencasts
+<!-- Optional. Attach screenshot(s) and/or screencast(s) that demo the behavior. -->
+
+## 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

@@ -0,0 +1,11 @@
+## Overview
+<!-- Required. Why is this important/necessary and what is the overarching architecture. -->
+
+## Screenshots/Screencasts
+<!-- Optional. Provide supporting image/video. -->
+
+## 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%/Gemfile.erb

@@ -32,11 +32,14 @@ group :code_quality do
   <% end %>
 end
 
-<% if configuration.build_rake %>
-  group :development do
+group :development do
+  <% if configuration.build_rake %>
     gem "rake", "~> 13.0"
-  end
-<% end %>
+  <% end %>
+  <% if configuration.markdown? %>
+    gem "tocer", "~> 12.0"
+  <% end %>
+end
 
 group :test do
   <% if configuration.build_guard %>

data/lib/rubysmith/templates/%project_name%/README.adoc.erb

@@ -8,6 +8,10 @@
 [link=https://www.alchemists.io/projects/code_quality]
 image::https://img.shields.io/badge/code_style-alchemists-brightgreen.svg[Alchemists Style Guide]
 <% end %>
+<% if configuration.build_circle_ci %>
+[link=https://circleci.com/gh/<%= configuration.git_hub_user %>/<%= configuration.project_name %>]
+image::https://circleci.com/gh/<%= configuration.git_hub_user %>/<%= configuration.project_name %>.svg?style=svg[Circle CI Status]
+<% end %>
 
 toc::[]
 

data/lib/rubysmith/templates/%project_name%/README.md.erb

@@ -3,6 +3,9 @@
 <% if configuration.build_rubocop %>
 [![Alchemists Style Guide](https://img.shields.io/badge/code_style-alchemists-brightgreen.svg)](https://www.alchemists.io/projects/code_quality)
 <% end %>
+<% if configuration.build_circle_ci %>
+[![Circle CI Status](https://circleci.com/gh/<%= configuration.git_hub_user %>/<%= configuration.project_name %>.svg?style=svg)](https://circleci.com/gh/<%= configuration.git_hub_user %>/<%= configuration.project_name %>)
+<% end %>
 
 <!-- Tocer[start]: Auto-generated, don't remove. -->
 <!-- Tocer[finish]: Auto-generated, don't remove. -->

data/lib/rubysmith.rb

@@ -3,7 +3,10 @@
 require "zeitwerk"
 
 Zeitwerk::Loader.for_gem.then do |loader|
-  loader.inflector.inflect "cli" => "CLI", "erb" => "ERB", "rspec" => "RSpec"
+  loader.inflector.inflect "cli" => "CLI",
+                           "circle_ci" => "CircleCI",
+                           "erb" => "ERB",
+                           "rspec" => "RSpec"
   loader.setup
 end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rubysmith
 version: !ruby/object:Gem::Version
-  version: 0.13.0
+  version: 0.14.0
 platform: ruby
 authors:
 - Brooke Kuhlmann
@@ -28,7 +28,7 @@ cert_chain:
   lkHilIrX69jq8wMPpBhlaw2mRmeSL50Wv5u6xVBvOHhXFSP1crXM95vfLhLyRYod
   W2A=
   -----END CERTIFICATE-----
-date: 2021-09-16 00:00:00.000000000 Z
+date: 2021-09-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: dry-container
@@ -44,6 +44,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.9'
+- !ruby/object:Gem::Dependency
+  name: git_plus
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.6'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.6'
 - !ruby/object:Gem::Dependency
   name: pastel
   requirement: !ruby/object:Gem::Requirement
@@ -114,6 +128,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '7.0'
+- !ruby/object:Gem::Dependency
+  name: tocer
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.0'
 - !ruby/object:Gem::Dependency
   name: zeitwerk
   requirement: !ruby/object:Gem::Requirement
@@ -144,11 +172,17 @@ files:
 - lib/rubysmith.rb
 - lib/rubysmith/builder.rb
 - lib/rubysmith/builders/bundler.rb
+- lib/rubysmith/builders/circle_ci.rb
 - lib/rubysmith/builders/console.rb
 - lib/rubysmith/builders/core.rb
-- lib/rubysmith/builders/documentation.rb
+- lib/rubysmith/builders/documentation/change.rb
+- lib/rubysmith/builders/documentation/conduct.rb
+- lib/rubysmith/builders/documentation/contribution.rb
+- lib/rubysmith/builders/documentation/license.rb
+- lib/rubysmith/builders/documentation/readme.rb
 - lib/rubysmith/builders/git/commit.rb
 - lib/rubysmith/builders/git/setup.rb
+- lib/rubysmith/builders/git_hub.rb
 - lib/rubysmith/builders/guard.rb
 - lib/rubysmith/builders/pragma.rb
 - lib/rubysmith/builders/rake.rb
@@ -162,6 +196,9 @@ files:
 - lib/rubysmith/cli/actions/config.rb
 - lib/rubysmith/cli/configuration/content.rb
 - lib/rubysmith/cli/configuration/defaults.yml
+- lib/rubysmith/cli/configuration/enhancers/current_time.rb
+- lib/rubysmith/cli/configuration/enhancers/git_hub_user.rb
+- lib/rubysmith/cli/configuration/enhancers/version.rb
 - lib/rubysmith/cli/configuration/loader.rb
 - lib/rubysmith/cli/parsers.rb
 - lib/rubysmith/cli/parsers/assembler.rb
@@ -173,6 +210,9 @@ files:
 - lib/rubysmith/pathway.rb
 - lib/rubysmith/renderers/erb.rb
 - lib/rubysmith/renderers/namespace.rb
+- lib/rubysmith/templates/%project_name%/.circleci/config.yml.erb
+- lib/rubysmith/templates/%project_name%/.github/ISSUE_TEMPLATE.md.erb
+- lib/rubysmith/templates/%project_name%/.github/PULL_REQUEST_TEMPLATE.md.erb
 - lib/rubysmith/templates/%project_name%/.reek.yml.erb
 - lib/rubysmith/templates/%project_name%/.rubocop.yml.erb
 - lib/rubysmith/templates/%project_name%/.ruby-version.erb

data/lib/rubysmith/builders/documentation.rb

@@ -1,57 +0,0 @@
-# frozen_string_literal: true
-
-module Rubysmith
-  module Builders
-    # Builds project skeleton documentation.
-    class Documentation
-      def self.call(...) = new(...).call
-
-      def initialize configuration, builder: Builder
-        @configuration = configuration
-        @builder = builder
-      end
-
-      def call
-        return unless configuration.build_documentation
-
-        private_methods.sort.grep(/render_/).each { |method| __send__ method }
-      end
-
-      private
-
-      attr_reader :configuration, :builder
-
-      def render_changes
-        builder.call(configuration.with(template_path: "%project_name%/CHANGES.#{kind}.erb"))
-               .render
-      end
-
-      def render_conduct
-        configuration.with(template_path: "%project_name%/CODE_OF_CONDUCT.#{kind}.erb")
-                     .then { |updated_configuration| builder.call(updated_configuration).render }
-      end
-
-      def render_contributions
-        builder.call(configuration.with(template_path: "%project_name%/CONTRIBUTING.#{kind}.erb"))
-               .render
-      end
-
-      def render_license
-        configuration.with(template_path: "%project_name%/LICENSE-#{license}.#{kind}.erb")
-                     .then do |updated_configuration|
-                       builder.call(updated_configuration).render.rename "LICENSE.#{kind}"
-                     end
-      end
-
-      def render_readme
-        builder.call(configuration.with(template_path: "%project_name%/README.#{kind}.erb"))
-               .render
-               .replace("\n\n\n", "\n\n")
-      end
-
-      def kind = configuration.documentation_format || "md"
-
-      def license = configuration.documentation_license || "mit"
-    end
-  end
-end