rubysmith 0.11.0 → 0.15.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ae1f7e375e5e5d37e378cb82620d52dead76d846f2ea22cbbd32b76f714fc076
-  data.tar.gz: c2fb2727fd8af69b4cbbc35e55b9ff3dc1cdc96f0d05609d505ffaf10ba2e444
+  metadata.gz: dad99d389fc745abc0ee0cbb8543dfee116f171950640c84bfd80bfd9d4cd171
+  data.tar.gz: 9b504d057fad0f6fc1a3d5bc55fb61670df147304e12d27ad80541635cad3677
 SHA512:
-  metadata.gz: 8ee1ad6e82cac22883971e4cf1ff46c606173385f507908be37cc2839fe9c4b9fd8104c1354a74fb7784c592f2cf0bcae44ae5feee71f4db12892c4a971b9fef
-  data.tar.gz: e29e0e144ca76fe0819bfceb8ca936171b0267c67c144acfd6c5aebc6cca8d84f3ecb165cd9f7f69f142a6c28685d2be20c45b68f605d741dfaec25e782eb459
+  metadata.gz: 354cbaa3b247d4e12439f3d5927fa1d1c13542d8ae791e80660632910e3caf22abb748c4572baf565ca44ff89fe6a312bae8aafe9898329f1e28beadfbe1984c
+  data.tar.gz: 19098dd6c0b04959583c241628c71126adf97b6f0e0d5023c28828aeab92a7fd4d55c0c01361222bcc809052ebb5a90b3ea1e4ee2548ee9050e7bcedce07cce8

data/README.adoc

@@ -15,8 +15,11 @@ Rubysmith is a command line interface for smithing Ruby projects.
 
 This gem is useful in situations in which you need something more sophisticated than a
 link:https://bundler.io/guides/bundler_in_a_single_file_ruby_script.html[Bundler Inline] script but
-less complicated than a Ruby Gem as provided by
-link:https://www.alchemists.io/projects/gemsmith[Gemsmith].
+less complicated than a link:https://www.alchemists.io/projects/gemsmith[Gemsmith] gem. Rubysmith is
+the foundation of Gemsmith and provides a lot of the same functionality as Gemsmith but solely
+tailored for pure Ruby projects. Again, this is a great tool for spiking quick Ruby implementations,
+sharing code snippets with others, or building full blown Ruby projects for collaboration with
+others.
 
 toc::[]
 
@@ -27,10 +30,13 @@ 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].
 * Supports link:https://rspec.info[RSpec].
@@ -38,14 +44,14 @@ toc::[]
 * Supports link:https://docs.rubocop.org/rubocop-performance[Rubocop Performance].
 * 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/whitesmith/RubyCritic[RubyCritic].
 * 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
@@ -83,22 +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.
-  --[no-]pry                           Add Pry.
-  --[no-]reek                          Add Reek.
-  --[no-]refinements                   Add Refinements.
-  --[no-]rspec                         Add RSpec.
-  --[no-]rubocop                       Add Rubocop.
-  --[no-]ruby_critic                   Add RubyCritic.
-  --[no-]setup                         Add setup script.
-  --[no-]simple_cov                    Add SimpleCov.
-  --min                                Use minimum/no options.
+  --[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
@@ -116,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]
 ----
@@ -132,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
 
@@ -144,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]
 ----
@@ -154,26 +178,31 @@ 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
   :rubocop: true
-  :ruby_critic: true
   :setup: true
   :simple_cov: true
+  :zeitwerk: true
 :builders:
   :pragmater:
     :comments:
@@ -186,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}.freeze
 
-    HELPERS = {
-      inserter: Text::Inserter,
-      renderer: Renderers::ERB,
-      kernel: Open3,
-      logger: LOGGER
-    }.freeze
+    def self.call(...) = new(...)
 
-    def self.call(configuration, helpers: HELPERS) = new(configuration, helpers: helpers)
-
-    def initialize configuration, helpers: HELPERS
+    def initialize configuration, helpers: HELPERS, container: Container
       @configuration = configuration
       @helpers = helpers
+      @container = container
     end
 
     def append content
@@ -100,7 +94,7 @@ module Rubysmith
 
     private
 
-    attr_reader :configuration, :helpers
+    attr_reader :configuration, :helpers, :container
 
     def execute *command
       kernel.capture2e(*command).then do |result, status|
@@ -114,12 +108,15 @@ 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.gsub("%project_name%", configuration.project_name).sub ".erb", ""
+      pathway.end_path
+             .gsub("%project_name%", configuration.project_name)
+             .sub("%project_path%", configuration.project_path)
+             .sub ".erb", ""
     end
 
     def pathway = configuration.to_pathway

data/lib/rubysmith/builders/bundler.rb

@@ -10,7 +10,7 @@ module Rubysmith
     class Bundler
       using Refinements::Pathnames
 
-      def self.call(configuration, builder: Builder) = new(configuration, builder: builder).call
+      def self.call(...) = new(...).call
 
       def initialize configuration, builder: Builder, client: ::Bundler::CLI
         @configuration = configuration
@@ -23,9 +23,9 @@ module Rubysmith
                .render
                .replace(/\n\s+group/, "\n\ngroup")
                .replace(/\n\s+gem/, "\n  gem")
-               .replace(/  (?=.+refinements)/, "")
+               .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/{ruby_critic.rb → circle_ci.rb}

@@ -2,9 +2,9 @@
 
 module Rubysmith
   module Builders
-    # Builds project skeleton RubyCritic code quality support.
-    class RubyCritic
-      def self.call(configuration, builder: Builder) = new(configuration, builder: builder).call
+    # Builds project skeleton Circle CI configuration.
+    class CircleCI
+      def self.call(...) = new(...).call
 
       def initialize configuration, builder: Builder
         @configuration = configuration
@@ -12,9 +12,10 @@ module Rubysmith
       end
 
       def call
-        return unless configuration.build_ruby_critic
+        return unless configuration.build_circle_ci
 
-        builder.call(configuration.with(template_path: "%project_name%/.rubycritic.yml.erb")).render
+        builder.call(configuration.with(template_path: "%project_name%/.circleci/config.yml.erb"))
+               .render
       end
 
       private

data/lib/rubysmith/builders/console.rb

@@ -4,7 +4,7 @@ module Rubysmith
   module Builders
     # Builds project skeleton console for object inspection and exploration.
     class Console
-      def self.call(configuration, builder: Builder) = new(configuration, builder: builder).call
+      def self.call(...) = new(...).call
 
       def initialize configuration, builder: Builder
         @configuration = configuration

data/lib/rubysmith/builders/core.rb

@@ -4,7 +4,7 @@ module Rubysmith
   module Builders
     # Builds project skeleton core structure and minimum file support.
     class Core
-      def self.call(configuration, builder: Builder) = new(configuration, builder: builder).call
+      def self.call(...) = new(...).call
 
       def initialize configuration, builder: Builder
         @configuration = configuration
@@ -12,8 +12,12 @@ module Rubysmith
       end
 
       def call
-        builder.call(configuration.with(template_path: "%project_name%/lib/%project_name%.rb.erb"))
+        builder.call(configuration.with(template_path: "%project_name%/lib/%project_path%.rb.erb"))
                .render
+               .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
       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/commit.rb

@@ -5,7 +5,7 @@ module Rubysmith
     module Git
       # Builds project skeleton initial Git commit message.
       class Commit
-        def self.call(configuration, builder: Builder) = new(configuration, builder: builder).call
+        def self.call(...) = new(...).call
 
         def initialize configuration, builder: Builder
           @configuration = configuration

data/lib/rubysmith/builders/git/setup.rb

@@ -5,7 +5,7 @@ module Rubysmith
     module Git
       # Initializes project skeleton as a Git repository.
       class Setup
-        def self.call(configuration, builder: Builder) = new(configuration, builder: builder).call
+        def self.call(...) = new(...).call
 
         def initialize configuration, builder: Builder
           @configuration = configuration

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/builders/guard.rb

@@ -4,7 +4,7 @@ module Rubysmith
   module Builders
     # Builds project skeleton Guard support for a red, green, refactor loop.
     class Guard
-      def self.call(configuration, builder: Builder) = new(configuration, builder: builder).call
+      def self.call(...) = new(...).call
 
       def initialize configuration, builder: Builder
         @configuration = configuration

data/lib/rubysmith/builders/pragma.rb

@@ -6,7 +6,7 @@ module Rubysmith
   module Builders
     # Builds project skeleton pragmas so all Ruby strings are frozen by default.
     class Pragma
-      def self.call(configuration) = new(configuration).call
+      def self.call(...) = new(...).call
 
       def initialize configuration, client: Pragmater::Runner
         @configuration = configuration

data/lib/rubysmith/builders/rake.rb

@@ -4,7 +4,7 @@ module Rubysmith
   module Builders
     # Builds project skeleton Rake support.
     class Rake
-      def self.call(configuration, builder: Builder) = new(configuration, builder: builder).call
+      def self.call(...) = new(...).call
 
       def initialize configuration, builder: Builder
         @configuration = configuration
@@ -12,6 +12,8 @@ module Rubysmith
       end
 
       def call
+        return unless configuration.build_rake
+
         builder.call(configuration.with(template_path: "%project_name%/Rakefile.erb"))
                .render
                .replace(/\[\s+/, "[")

data/lib/rubysmith/builders/reek.rb

@@ -4,7 +4,7 @@ module Rubysmith
   module Builders
     # Builds project skeleton Reek code quality support.
     class Reek
-      def self.call(configuration, builder: Builder) = new(configuration, builder: builder).call
+      def self.call(...) = new(...).call
 
       def initialize configuration, builder: Builder
         @configuration = configuration