rubysmith 0.12.0 → 0.16.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 628bf912ecce44ded950cf18f54d54a3a8ca13430ccc300f7db53062da718716
-  data.tar.gz: cbefec98da88d0e1b6198789805eeed82ea6b5238bee41ca9341c7d6114ed84c
+  metadata.gz: f9a0a688a7aac995bdcecc7153253eadb06a4b0c883583c6793b5a4a29232fec
+  data.tar.gz: 87eaca3e036a5609b5d5a6525ea05d3e3527095be792f23976899967f13c93a2
 SHA512:
-  metadata.gz: 4b7bb2b58f60f60057c12e9f9358d720a10fe4825eefcefb8231d4998647c1d44523a550a05a2938b8d16536954ba2cb6f9fa3a4d5a484a0536f24420cb51991
-  data.tar.gz: 315a9e28cd8231629bb17fce77051f0fb42b86c25d1fb04245437333b20171c5b5dc40b1e3cbca33cce6c611761fea3ec31493a6dad2e34c56982a598e66785d
+  metadata.gz: b3c6fa39d2d40c8465a9652ea0679d20d886e27d18657c4d218d67d4849106721fe527c4e26fd8b91382de04a61277f5ad500ad361e40e3560a6dbceb3bdd5e3
+  data.tar.gz: 402d7063461dc2a4d5fdedbd2a17e18d7158988785089e16ff5d7bfce47e63a60679cb78297748668e7fdf9bd5855e064ddc59528ecc34625b09e7a552af8951

data/README.adoc

@@ -30,10 +30,12 @@ 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:http://pryrepl.org[Pry].
 * Supports link:https://github.com/ruby/rake[Rake].
 * Supports link:https://github.com/troessner/reek[Reek].
 * Supports link:https://www.alchemists.io/projects/refinements[Refinements].
@@ -43,12 +45,13 @@ toc::[]
 * Supports link:https://github.com/rubocop-hq/rubocop-rake[Rubocop Rake].
 * Supports link:https://github.com/rubocop-hq/rubocop-rspec[Rubocop RSpec].
 * Supports link:https://github.com/simplecov-ruby/simplecov[SimpleCov].
+* Supports link:https://github.com/fxn/zeitwerk[Zeitwerk].
 * Supports common settings and a structured layout for building projects.
 * Provides common documentation:
 ** README
 ** CHANGES
-** CONTRIBUTING
 ** CODE OF CONDUCT
+** CONTRIBUTING
 ** LICENSE
 
 // == Screencasts
@@ -86,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-]documentation                 Add documentation.
-  --[no-]git                           Add Git.
-  --[no-]git-lint                      Add Git Lint.
-  --[no-]guard                         Add Guard.
-  --min                                Use minimum/no options.
-  --[no-]pry                           Add Pry.
-  --[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
@@ -120,12 +130,12 @@ to disable specific options, you can use the `--no-*` prefix. Example:
 
 [source,bash]
 ----
-rubysmith --build demo --no-pry --no-guard
+rubysmith --build demo --no-debug --no-guard
 ----
 
-With the above example, both Pry and Guard support would have been disabled when building the `demo`
-project. Taking this a step further, you can also use the `--min` option to generate a project with
-bare minimum of options. Example:
+With the above example, both Debug and Guard support would have been disabled when building the
+`demo` project. Taking this a step further, you can also use the `--min` option to generate a
+project with bare minimum of options. Example:
 
 [source,bash]
 ----
@@ -136,8 +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.
 
-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).
+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
+----
+
+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
 
@@ -148,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]
 ----
@@ -158,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
-  :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
@@ -191,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/builder.rb

@@ -10,20 +10,14 @@ module Rubysmith
   class Builder
     using Refinements::Pathnames
 
-    LOGGER = Logger.new(STDOUT, formatter: ->(_severity, _at, _program, message) { "#{message}\n" })
-
-    HELPERS = {
-      inserter: Text::Inserter,
-      renderer: Renderers::ERB,
-      kernel: Open3,
-      logger: LOGGER
-    }.freeze
+    HELPERS = {inserter: Text::Inserter, renderer: Renderers::ERB, kernel: Open3}.freeze
 
     def self.call(...) = new(...)
 
-    def initialize configuration, helpers: HELPERS
+    def initialize configuration, helpers: HELPERS, container: Container
       @configuration = configuration
       @helpers = helpers
+      @container = container
     end
 
     def append content
@@ -94,13 +88,13 @@ module Rubysmith
 
     def touch
       logger.info "Touching: #{relative_build_path}"
-      build_path.make_ancestors.touch
+      build_path.deep_touch
       self
     end
 
     private
 
-    attr_reader :configuration, :helpers
+    attr_reader :configuration, :helpers, :container
 
     def execute *command
       kernel.capture2e(*command).then do |result, status|
@@ -114,9 +108,9 @@ module Rubysmith
 
     def kernel = helpers.fetch(__method__)
 
-    def logger = helpers.fetch(__method__)
+    def logger = container[__method__]
 
-    def relative_build_path = build_path.relative_path_from(configuration.build_root)
+    def relative_build_path = build_path.relative_path_from(configuration.target_root)
 
     def build_path
       pathway.end_path

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/core.rb

@@ -14,7 +14,9 @@ module Rubysmith
       def call
         builder.call(configuration.with(template_path: "%project_name%/lib/%project_path%.rb.erb"))
                .render
-               .replace(/  (?!(module|end))/, "")
+               .replace("  require", "require")
+               .replace(/    (?=(Zeit|\.tap|\.setup))/, "")
+               .replace("\n  \n", "\n\n")
 
         builder.call(configuration.with(template_path: "%project_name%/.ruby-version.erb")).render
         nil

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

@@ -0,0 +1,48 @@
+# frozen_string_literal: true
+
+module Rubysmith
+  module CLI
+    module Actions
+      # Handles the build action.
+      class Build
+        # Order is important.
+        BUILDERS = [
+          Builders::Core,
+          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,
+          Builders::RSpec::Helper,
+          Builders::Pragma,
+          Builders::Rubocop::Setup,
+          Builders::Rubocop::Formatter,
+          Builders::Git::Commit
+        ].freeze
+
+        def initialize builders: BUILDERS, container: Container
+          @builders = builders
+          @container = container
+        end
+
+        def call = builders.each { |builder| builder.call configuration }
+
+        private
+
+        attr_reader :builders, :container
+
+        def configuration = container[__method__]
+      end
+    end
+  end
+end

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

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+module Rubysmith
+  module CLI
+    module Actions
+      # Handles the config action.
+      class Config
+        def initialize client: CLI::Configuration::Loader::CLIENT, container: Container
+          @client = client
+          @container = container
+        end
+
+        def call selection
+          case selection
+            when :edit then edit
+            when :view then view
+            else fail StandardError, "Invalid configuration selection: #{selection}."
+          end
+        end
+
+        private
+
+        attr_reader :client, :container
+
+        def edit = kernel.system("$EDITOR #{client.current}")
+
+        def view = kernel.system("cat #{client.current}")
+
+        def kernel = container[__method__]
+      end
+    end
+  end
+end