rubysmith 0.13.0 → 0.16.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: aa3e01ddcd6743f57757311a125d1e8ab39c44e09c1f1186a53b4a0ca6388d7d
-  data.tar.gz: d0725b76c5829d64fbd5e648506ae2e57adbb9882e992b84bfddaa879f166a0b
+  metadata.gz: 21ba13c365014da4af272c863f73039576988a70be1902d1f1ad40ea582c0a2e
+  data.tar.gz: ddf90e3d3926ddba623408dac31fd6c03c9fbddcbc16c816a9c4ef5936636e5c
 SHA512:
-  metadata.gz: 1e14344b8a18601ef9e05ab3463491977eb81a62027dad1658a7cb1012f94f982296fe1981eea3bd90f35aa88668d3b553d3ef4bed5e77c7dddd060a8a2e444a
-  data.tar.gz: 7b1d999af3527fdd1a182dc2405d19b852cfb93ab8d8c70fa2f1b1e5c3261daa8548d13966d062e266911817e53e394f20442c778c59aad4f89fe4b33402380a
+  metadata.gz: 25b33429b1a31468b5d725ac0871344ff243077be87eb6c7f253665856dc8cf4f9d5851d3252841d13a6d112ee0e3fc5f90d28ee3fd8bc0b41a1896cae03412b
+  data.tar.gz: 3aa34ce901418a4be760dd6a34bab1199cd562e6784a08503f294d47f93234628db017adf06a221e33645c2babb704034d65cc1a256dcca8067a9e1cc9937e2d

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:
@@ -252,6 +308,11 @@ participating in this project you agree to abide by its terms.
 
 Read link:CONTRIBUTING.adoc[CONTRIBUTING] for details.
 
+== Community
+
+Feel free to link:https://www.alchemists.io/community[join the commmunity] for discussions related
+to this project and much more.
+
 == License
 
 Read link:LICENSE.adoc[LICENSE] for details.

data/lib/rubysmith/builder.rb

@@ -88,7 +88,7 @@ module Rubysmith
 
     def touch
       logger.info "Touching: #{relative_build_path}"
-      build_path.make_ancestors.touch
+      build_path.deep_touch
       self
     end
 

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