gemsmith 19.8.0 → 20.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 63e7b251454d69b9c36b44095d48d86e5dbe86dd8246e0775fbdcf58f2f06221
-  data.tar.gz: '094d44ce73d8c44cc238299a393250fe2fa4c2ccf4de8494e69779e3d13e4c00'
+  metadata.gz: 1e0b2d89efd43adce74b6fbed669777763f954f2b0b6f0f0c5832f12d2f8d883
+  data.tar.gz: a17145a647271cd6286b72b5c52574c34ab613e012a35b147223cb12109554b1
 SHA512:
-  metadata.gz: ee953574be4c32f6a014382a95f4e9192db46e6e20bb81f25acd33f7d843a72bea6838276b1b8f1b4b28ef996d9eed854be7940e4f6a09f5e25d09c48fc88260
-  data.tar.gz: 4ec6e2fea53134d4a1f499d98368dc0d1bbb929dfd313daf50a9dbf11e9df9f194b7a6577f0078d0c32fd0cc7c196a6c147795b31461d019f29f79086160a862
+  metadata.gz: 46aa1cc207d47fe6c768d8b4f581992536166126df49944b2de2b249bb56923e22e28fd969c799e5c3e2e7e58c8ad7a2dbf858af4a59652377c0c106de8085da
+  data.tar.gz: d074cba35efa1a8b40c6c58225a4ffbc8ad317d05838e906e4ffc6d94cb9395973800bea861ef1c85be2f9074fba1e0ec6804152c8a1be148b8beb45178613d5

data/README.adoc

@@ -3,6 +3,7 @@
 :figure-caption!:
 
 :ruby_gems_link: link:https://rubygems.org[RubyGems]
+:sod_link: link:https://alchemists.io/projects/sod[Sod]
 
 = Gemsmith
 
@@ -17,7 +18,7 @@ toc::[]
 == Features
 
 * Supports all link:https://alchemists.io/projects/rubysmith[Rubysmith] features.
-* Supports basic gem skeletons or more advanced Command Line Interface (CLI) skeletons.
+* Supports basic gem or more advanced {sod_link}-based Command Line Interface (CLI) skeletons.
 * Supports gem building, installing for local development, and publishing.
 * Supports the editing and viewing of installed gems.
 
@@ -52,52 +53,30 @@ gem install gemsmith
 From the command line, type: `gemsmith --help`
 
 ....
-USAGE:
-  -b, --build NAME [options]               Build new project.
-  -c, --config ACTION                      Manage gem configuration: edit or view.
-      --edit GEM                           Edit installed gem in default editor.
-  -h, --help                               Show this message.
-  -i, --install [NAME]                     Install gem for local development.
-  -p, --publish [NAME]                     Publish gem to remote gem server.
-  -v, --version                            Show gem version.
-      --view GEM                           View installed gem in default browser.
-
-BUILD OPTIONS:
-      --[no-]amazing_print                 Add Amazing Print gem. Default: true.
-      --[no-]caliber                       Add Caliber gem. Default: true.
-      --[no-]circle_ci                     Add Circle CI configuration and badge. Default: false.
-      --[no-]citation                      Add citation documentation. Default: true.
-      --[no-]community                     Add community documentation. Default: false.
-      --[no-]conduct                       Add code of conduct documentation. Default: true.
-      --[no-]console                       Add console script. Default: true.
-      --[no-]contributions                 Add contributions documentation. Default: true.
-      --[no-]debug                         Add Debug gem. Default: true.
-      --[no-]funding                       Add GitHub funding configuration. Default: false.
-      --[no-]git                           Add Git. Default: true.
-      --[no-]git_hub                       Add GitHub templates. Default: false.
-      --[no-]git_hub_ci                    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-]security                      Add security. Default: true.
-      --[no-]setup                         Add setup script. Default: true.
-      --[no-]simple_cov                    Add SimpleCov gem. Default: true.
-      --[no-]versions                      Add version history. Default: true.
-      --[no-]yard                          Add Yard gem. Default: false.
-      --[no-]zeitwerk                      Add Zeitwerk gem. Default: true.
-      --[no-]cli                           Add command line interface. Default: false.
+USAGE
+  gemsmith [OPTIONS]
+  gemsmith COMMAND [OPTIONS]
+
+OPTIONS
+  -i, --install [GEM]      Install gem for local development.
+                           Optionally computes gem package based on current directory.
+  -p, --publish [GEM]      Publish gem to remote gem server.
+                           Optionally computes gem package based on current directory.
+                           Default: gemsmith.
+  -e, --edit GEM           Edit installed gem in default editor.
+  -V, --view GEM           View installed gem in default browser.
+  -v, --version            Show version.
+  -h, --help [COMMAND]     Show this message.
+
+COMMANDS
+  config                   Manage configuration.
+                           Path is dynamic per current directory.
+  build                    Build new project.
 ....
 
 ==== Build
 
-The core functionality of this gem centers around the `--build` command and associated flags. The
+The core functionality of this gem centers around the `build` command and associated flags. The
 build options allow you to further customize the kind of gem you want to build. Most build options
 are enabled by default. For detailed documentation on all supported flags, see the
 link:https://alchemists.io/projects/rubysmith/#_build[Rubysmith] documentation.
@@ -111,7 +90,7 @@ simple as running:
 
 [source,bash]
 ----
-gemsmith --build demo --cli
+gemsmith build --name demo --cli
 ----
 
 The above will give you a new gem with CLI support which includes working specs. It's the same
@@ -120,9 +99,9 @@ configuring your gem and adding additional CLI support. Out of the box, the CLI
 you supports the following options:
 
 ....
-  -c, --config ACTION                      Manage gem configuration: edit or view.
-  -h, --help                               Show this message.
-  -v, --version                            Show gem version.
+  -v, --version     Show version.
+  -h, --help        Show this message.
+  config            Manage configuration.
 ....
 
 From here you can add whatever you wish to make an awesome CLI gem for others to enjoy.
@@ -221,9 +200,6 @@ the following:
   :cli: false
 ----
 
-Feel free to take the combined Rubysmith + Gemsmith configuration, modify, and save as your own
-custom `configuration.yml`.
-
 It is recommended that you provide URLs for your project which would be all keys found in this
 section:
 
@@ -245,7 +221,7 @@ When building/testing your gem locally, a typical workflow is:
 [source,bash]
 ----
 # Build
-gemsmith --build demo
+gemsmith build --name demo
 
 # Design, Implement and Test.
 cd demo
@@ -303,7 +279,7 @@ To create a certificate for your gems, run the following:
 [source,bash]
 ----
 cd ~/.gem
-gem cert --build you@example.com --days 730
+gem cert build you@example.com --days 730
 gem cert --add gem-public_cert.pem
 cp gem-public_cert.pem <path/to/server/public/folder>/gems.pem
 ----

data/gemsmith.gemspec

@@ -2,7 +2,7 @@
 
 Gem::Specification.new do |spec|
   spec.name = "gemsmith"
-  spec.version = "19.8.0"
+  spec.version = "20.0.0"
   spec.authors = ["Brooke Kuhlmann"]
   spec.email = ["brooke@alchemists.io"]
   spec.homepage = "https://alchemists.io/projects/gemsmith"
@@ -23,17 +23,20 @@ Gem::Specification.new do |spec|
   spec.cert_chain = [Gem.default_cert_path]
 
   spec.required_ruby_version = "~> 3.2"
-  spec.add_dependency "cogger", "~> 0.8"
+  spec.add_dependency "cogger", "~> 0.10"
   spec.add_dependency "core", "~> 0.1"
   spec.add_dependency "dry-container", "~> 0.11"
   spec.add_dependency "dry-monads", "~> 1.6"
-  spec.add_dependency "infusible", "~> 1.0"
-  spec.add_dependency "milestoner", "~> 15.3"
-  spec.add_dependency "refinements", "~> 10.0"
-  spec.add_dependency "rubysmith", "~> 4.9"
-  spec.add_dependency "runcom", "~> 9.0"
-  spec.add_dependency "spek", "~> 1.1"
-  spec.add_dependency "versionaire", "~> 11.0"
+  spec.add_dependency "dry-schema", "~> 1.13"
+  spec.add_dependency "etcher", "~> 0.2"
+  spec.add_dependency "infusible", "~> 2.0"
+  spec.add_dependency "milestoner", "~> 16.0"
+  spec.add_dependency "refinements", "~> 11.0"
+  spec.add_dependency "rubysmith", "~> 5.1"
+  spec.add_dependency "runcom", "~> 10.0"
+  spec.add_dependency "sod", "~> 0.0"
+  spec.add_dependency "spek", "~> 2.0"
+  spec.add_dependency "versionaire", "~> 12.0"
   spec.add_dependency "zeitwerk", "~> 2.6"
 
   spec.bindir = "exe"

data/lib/gemsmith/builders/cli.rb

@@ -49,44 +49,25 @@ module Gemsmith
 
       def render_configuration
         [
-          "%project_name%/lib/%project_path%/configuration/content.rb.erb",
+          "%project_name%/lib/%project_path%/configuration/contract.rb.erb",
+          "%project_name%/lib/%project_path%/configuration/model.rb.erb",
           "%project_name%/lib/%project_path%/configuration/defaults.yml.erb",
-          "%project_name%/lib/%project_path%/configuration/loader.rb.erb",
           "%project_name%/lib/%project_path%/container.rb.erb",
           "%project_name%/lib/%project_path%/import.rb.erb"
         ].each { |path| builder.call(configuration.merge(template_path: path)).render }
       end
 
-      def render_cli
-        [
-          "%project_name%/lib/%project_path%/cli/actions/config.rb.erb",
-          "%project_name%/lib/%project_path%/cli/actions/container.rb.erb",
-          "%project_name%/lib/%project_path%/cli/actions/import.rb.erb",
-          "%project_name%/lib/%project_path%/cli/parser.rb.erb",
-          "%project_name%/lib/%project_path%/cli/parsers/core.rb.erb",
-          "%project_name%/lib/%project_path%/cli/shell.rb.erb"
-        ].each { |path| builder.call(configuration.merge(template_path: path)).render }
+      def render_shell
+        path = "%project_name%/lib/%project_path%/cli/shell.rb.erb"
+        builder.call(configuration.merge(template_path: path)).render
       end
 
       def render_specs
         return unless configuration.build_rspec
 
         [
-          "%project_name%/spec/lib/%project_path%/cli/actions/config_spec.rb.erb",
-          "%project_name%/spec/lib/%project_path%/cli/parser_spec.rb.erb",
-          "%project_name%/spec/lib/%project_path%/cli/parsers/core_spec.rb.erb",
           "%project_name%/spec/lib/%project_path%/cli/shell_spec.rb.erb",
-          "%project_name%/spec/lib/%project_path%/configuration/content_spec.rb.erb",
-          "%project_name%/spec/lib/%project_path%/configuration/loader_spec.rb.erb"
-        ].each { |path| builder.call(configuration.merge(template_path: path)).render }
-      end
-
-      def render_rspec_support
-        return unless configuration.build_rspec
-
-        [
-          "%project_name%/spec/support/shared_contexts/application_dependencies.rb.erb",
-          "%project_name%/spec/support/shared_examples/a_parser.rb.erb"
+          "%project_name%/spec/support/shared_contexts/application_dependencies.rb.erb"
         ].each { |path| builder.call(configuration.merge(template_path: path)).render }
       end
     end

data/lib/gemsmith/builders/rspec/helper.rb

@@ -19,28 +19,15 @@ module Gemsmith
         def call
           return configuration unless configuration.build_rspec && configuration.build_cli
 
-          update_spec_helper
-          render_shared_example
+          builder.call(configuration.merge(template_path: "%project_name%/spec/spec_helper.rb.erb"))
+                 .touch
+                 .replace("%r(^/spec/)", "%r((.+/container\\.rb|^/spec/))")
           configuration
         end
 
         private
 
         attr_reader :configuration, :builder
-
-        def update_spec_helper
-          builder.call(configuration.merge(template_path: "%project_name%/spec/spec_helper.rb.erb"))
-                 .touch
-                 .insert_after(
-                   %r(support/shared_contexts),
-                   %(Pathname.require_tree SPEC_ROOT.join("support/shared_examples")\n)
-                 )
-        end
-
-        def render_shared_example
-          path = "%project_name%/spec/support/shared_examples/a_parser.rb.erb"
-          builder.call(configuration.merge(template_path: path)).render
-        end
       end
     end
   end

data/lib/gemsmith/cli/actions/cli.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+require "sod"
+
+module Gemsmith
+  module CLI
+    module Actions
+      # Stores CLI flag.
+      class CLI < Sod::Action
+        include Import[:input]
+
+        description "Add command line interface."
+
+        on "--[no-]cli"
+
+        default { Container[:configuration].build_cli }
+
+        def call(value = default) = input.build_cli = value
+      end
+    end
+  end
+end

data/lib/gemsmith/cli/actions/edit.rb

@@ -1,16 +1,21 @@
 # frozen_string_literal: true
 
 require "dry/monads"
+require "sod"
 require "spek"
 
 module Gemsmith
   module CLI
     module Actions
       # Handles the edit action for editing an installed gem.
-      class Edit
+      class Edit < Sod::Action
         include Gemsmith::Import[:kernel, :logger]
         include Dry::Monads[:result]
 
+        description "Edit installed gem in default editor."
+
+        on %w[-e --edit], argument: "GEM"
+
         def initialize(picker: Spek::Picker, editor: Tools::Editor.new, **)
           super(**)
           @picker = picker
@@ -20,8 +25,8 @@ module Gemsmith
         def call gem_name
           case picker.call(gem_name).bind { |spec| editor.call spec }
             in Success(spec) then logger.info { "Editing: #{spec.named_version}." }
-            in Failure(message) then error { message }
-            else error { "Unable to handle edit action." }
+            in Failure(message) then log_error { message }
+            else log_error { "Unable to handle edit action." }
           end
         end
 
@@ -29,7 +34,7 @@ module Gemsmith
 
         attr_reader :picker, :editor
 
-        def error(&) = logger.error(&)
+        def log_error(&) = logger.error(&)
       end
     end
   end

data/lib/gemsmith/cli/actions/install.rb

@@ -1,27 +1,38 @@
 # frozen_string_literal: true
 
 require "dry/monads"
+require "pathname"
+require "sod"
 require "spek"
 
 module Gemsmith
   module CLI
     module Actions
       # Handles the install action.
-      class Install
+      class Install < Sod::Action
         include Gemsmith::Import[:logger]
         include Dry::Monads[:result]
 
+        description "Install gem for local development."
+
+        ancillary "Optionally computes gem package based on current directory."
+
+        on %w[-i --install], argument: "[GEM]"
+
+        default { Pathname.pwd.basename }
+
         def initialize(installer: Tools::Installer.new, loader: Spek::Loader, **)
           super(**)
           @installer = installer
           @loader = loader
         end
 
-        def call configuration
-          case installer.call loader.call("#{configuration.project_name}.gemspec")
+        # :reek:ControlParameter
+        def call name = nil
+          case installer.call loader.call("#{name || default}.gemspec")
             in Success(spec) then logger.info { "Installed: #{spec.package_name}." }
-            in Failure(message) then error { message }
-            else error { "Unable to handle install action." }
+            in Failure(message) then log_error { message }
+            else log_error { "Unable to handle install action." }
           end
         end
 
@@ -29,7 +40,7 @@ module Gemsmith
 
         attr_reader :installer, :loader
 
-        def error(&) = logger.error(&)
+        def log_error(&) = logger.error(&)
       end
     end
   end

data/lib/gemsmith/cli/actions/publish.rb

@@ -1,27 +1,38 @@
 # frozen_string_literal: true
 
 require "dry/monads"
+require "pathname"
+require "sod"
 require "spek"
 
 module Gemsmith
   module CLI
     module Actions
       # Handles the publish action.
-      class Publish
+      class Publish < Sod::Action
         include Gemsmith::Import[:logger]
         include Dry::Monads[:result]
 
+        description "Publish gem to remote gem server."
+
+        ancillary "Optionally computes gem package based on current directory."
+
+        on %w[-p --publish], argument: "[GEM]"
+
+        default { Pathname.pwd.basename }
+
         def initialize(publisher: Tools::Publisher.new, loader: Spek::Loader, **)
           super(**)
           @publisher = publisher
           @loader = loader
         end
 
-        def call configuration
-          case publisher.call loader.call("#{configuration.project_name}.gemspec")
+        # :reek:ControlParameter
+        def call name = nil
+          case publisher.call loader.call("#{name || default}.gemspec")
             in Success(spec) then logger.info { "Published: #{spec.package_name}." }
-            in Failure(message) then error { message }
-            else error { "Unable to handle publish action." }
+            in Failure(message) then log_error { message }
+            else log_error { "Unable to handle publish action." }
           end
         end
 
@@ -29,7 +40,7 @@ module Gemsmith
 
         attr_reader :publisher, :loader
 
-        def error(&) = logger.error(&)
+        def log_error(&) = logger.error(&)
       end
     end
   end

data/lib/gemsmith/cli/actions/view.rb

@@ -1,16 +1,21 @@
 # frozen_string_literal: true
 
 require "dry/monads"
+require "sod"
 require "spek"
 
 module Gemsmith
   module CLI
     module Actions
       # Handles the view action for viewing an installed gem in default browser.
-      class View
+      class View < Sod::Action
         include Gemsmith::Import[:kernel, :logger]
         include Dry::Monads[:result]
 
+        description "View installed gem in default browser."
+
+        on %w[-V --view], argument: "GEM"
+
         def initialize(picker: Spek::Picker, viewer: Tools::Viewer.new, **)
           super(**)
           @picker = picker
@@ -20,8 +25,8 @@ module Gemsmith
         def call gem_name
           case picker.call(gem_name).bind { |spec| viewer.call spec }
             in Success(spec) then logger.info { "Viewing: #{spec.named_version}." }
-            in Failure(message) then error { message }
-            else error { "Unable to handle view action." }
+            in Failure(message) then log_error { message }
+            else log_error { "Unable to handle view action." }
           end
         end
 
@@ -29,7 +34,7 @@ module Gemsmith
 
         attr_reader :picker, :viewer
 
-        def error(&) = logger.error(&)
+        def log_error(&) = logger.error(&)
       end
     end
   end

data/lib/gemsmith/cli/commands/build.rb

@@ -0,0 +1,106 @@
+# frozen_string_literal: true
+
+require "sod"
+
+module Gemsmith
+  module CLI
+    module Commands
+      # Handles the build action.
+      class Build < Sod::Command
+        include Gemsmith::Import[:input, :logger]
+
+        # Order is important.
+        # rubocop:todo Metrics/CollectionLiteralLength
+        BUILDERS = [
+          Rubysmith::Builders::Core,
+          Rubysmith::Builders::Version,
+          Builders::Specification,
+          Rubysmith::Builders::Documentation::Readme,
+          Builders::Documentation::Readme,
+          Rubysmith::Builders::Documentation::Citation,
+          Rubysmith::Builders::Documentation::License,
+          Rubysmith::Builders::Documentation::Version,
+          Rubysmith::Builders::Git::Setup,
+          Rubysmith::Builders::Git::Ignore,
+          Rubysmith::Builders::Git::Safe,
+          Builders::Git::Ignore,
+          Rubysmith::Builders::Bundler,
+          Builders::Bundler,
+          Builders::CLI,
+          Rubysmith::Builders::Rake,
+          Rubysmith::Builders::Console,
+          Rubysmith::Builders::CircleCI,
+          Builders::CircleCI,
+          Rubysmith::Builders::Setup,
+          Rubysmith::Builders::GitHub,
+          Rubysmith::Builders::Guard,
+          Rubysmith::Builders::Reek,
+          Rubysmith::Builders::RSpec::Binstub,
+          Rubysmith::Builders::RSpec::Context,
+          Rubysmith::Builders::RSpec::Helper,
+          Builders::RSpec::Helper,
+          Rubysmith::Builders::Caliber,
+          Rubysmith::Extensions::Bundler,
+          Rubysmith::Extensions::Pragmater,
+          Rubysmith::Extensions::Tocer,
+          Rubysmith::Extensions::Rubocop,
+          Builders::Git::Commit
+        ].freeze
+        # rubocop:enable Metrics/CollectionLiteralLength
+
+        handle "build"
+
+        description "Build new project."
+
+        on Rubysmith::CLI::Actions::Name, input: Container[:input]
+        on Rubysmith::CLI::Actions::AmazingPrint, input: Container[:input]
+        on Rubysmith::CLI::Actions::Caliber, input: Container[:input]
+        on Rubysmith::CLI::Actions::CircleCI, input: Container[:input]
+        on Rubysmith::CLI::Actions::Citation, input: Container[:input]
+        on Actions::CLI, input: Container[:input]
+        on Rubysmith::CLI::Actions::Community, input: Container[:input]
+        on Rubysmith::CLI::Actions::Conduct, input: Container[:input]
+        on Rubysmith::CLI::Actions::Console, input: Container[:input]
+        on Rubysmith::CLI::Actions::Contributions, input: Container[:input]
+        on Rubysmith::CLI::Actions::Debug, input: Container[:input]
+        on Rubysmith::CLI::Actions::Funding, input: Container[:input]
+        on Rubysmith::CLI::Actions::Git, input: Container[:input]
+        on Rubysmith::CLI::Actions::GitHub, input: Container[:input]
+        on Rubysmith::CLI::Actions::GitHubCI, input: Container[:input]
+        on Rubysmith::CLI::Actions::GitLint, input: Container[:input]
+        on Rubysmith::CLI::Actions::Guard, input: Container[:input]
+        on Rubysmith::CLI::Actions::License, input: Container[:input]
+        on Rubysmith::CLI::Actions::Maximum, input: Container[:input]
+        on Rubysmith::CLI::Actions::Minimum, input: Container[:input]
+        on Rubysmith::CLI::Actions::Rake, input: Container[:input]
+        on Rubysmith::CLI::Actions::Readme, input: Container[:input]
+        on Rubysmith::CLI::Actions::Reek, input: Container[:input]
+        on Rubysmith::CLI::Actions::Refinements, input: Container[:input]
+        on Rubysmith::CLI::Actions::RSpec, input: Container[:input]
+        on Rubysmith::CLI::Actions::Security, input: Container[:input]
+        on Rubysmith::CLI::Actions::Setup, input: Container[:input]
+        on Rubysmith::CLI::Actions::SimpleCov, input: Container[:input]
+        on Rubysmith::CLI::Actions::Versions, input: Container[:input]
+        on Rubysmith::CLI::Actions::Yard, input: Container[:input]
+        on Rubysmith::CLI::Actions::Zeitwerk, input: Container[:input]
+
+        def initialize(builders: BUILDERS, **)
+          super(**)
+          @builders = builders
+        end
+
+        def call
+          log_info "Building project skeleton: #{input.project_name}..."
+          builders.each { |builder| builder.call input }
+          log_info "Project skeleton complete!"
+        end
+
+        private
+
+        attr_reader :builders
+
+        def log_info(message) = logger.info { message }
+      end
+    end
+  end
+end