rubysmith 4.9.0 → 5.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 595a6ea4d274a07490a2ef71eccfe8f678c2c349546e5f596d95d23921ba7ff3
-  data.tar.gz: b35e376c6136530a72b9dfc3a43b5ee24ed2b08d209113bb2de8fb44c736e07d
+  metadata.gz: 4bf7aff137172ca7f7959152c9a6550f1453ae79c9f0947048b3f829ae118b5c
+  data.tar.gz: 97a5b9c2fcf8204aa77b84bd159888f93808aa0dcc7693547d0aa3104cb226b2
 SHA512:
-  metadata.gz: 26b2e0dbd086305663ecadaa39d9b392c0a46cb005ef649e0a34f404f9b582cb12b54d6f7c68bc156c6abf191b71c56101123b53f3d12f71d4c6cf45e9a967c8
-  data.tar.gz: '059af4e5cf18b71606c7fca70ac435fce856705044fea089408090be2b26df54e39ad04775fbf76ca9419627d626abf25d2a67ab014f228c4370f36422b70250'
+  metadata.gz: cfbbafd5a69876cd04a2d6d980c3ffccf95efe7a70d595983953bf62efcd557e49433f34dc954069b135e90372f601837c9b9f7ee50534fb0c0b61c2b73c86b9
+  data.tar.gz: 520c7dccfd4bde72ceb2678fbc6e7ceb1d5a246c17261858d22577b92965463998968dbf3cf50e44847c64484aff1fee4795d220364ceeef749fb4bee967450e

data/README.adoc

@@ -77,43 +77,19 @@ gem install rubysmith
 From the command line, type: `rubysmith --help`
 
 ....
-USAGE:
-  -b, --build NAME [options]               Build new project.
-  -c, --config ACTION                      Manage gem configuration: edit or view.
-  -h, --help                               Show this message.
-  -p, --publish VERSION                    Publish project.
-  -v, --version                            Show gem version.
-
-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.
+USAGE
+  rubysmith [OPTIONS]
+  rubysmith COMMAND [OPTIONS]
+
+OPTIONS
+  -p, --publish VERSION     Publish project.
+  -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
@@ -124,7 +100,7 @@ Most build options are enabled by default. Example:
 
 [source,bash]
 ----
-rubysmith --build demo
+rubysmith build --name demo
 ----
 
 Running the above will generate a new `demo` Ruby project. Should you wish to disable specific
@@ -132,7 +108,7 @@ options, you can use `--no-*` prefixes. Example:
 
 [source,bash]
 ----
-rubysmith --build demo --no-debug --no-guard
+rubysmith build --name demo --no-debug --no-guard
 ----
 
 With the above example, both Debug and Guard support would have been disabled when building the
@@ -141,7 +117,7 @@ project with bare minimum of options. Example:
 
 [source,bash]
 ----
-rubysmith --build demo --min
+rubysmith build --name demo --min
 ----
 
 The above is essentially the same as building with _all_ options disabled. This is handy in situations where you need to quickly script something up for sharing with others yet still want to avoid using a {bundler_inline_link} script so gem dependencies are not installed each time the code is run.
@@ -151,8 +127,8 @@ example, where both minimum and maximum options are used in conjunction with oth
 
 [source,bash]
 ----
-rubysmith --build demo --min --zeitwerk
-rubysmith --build demo --max --no-debug
+rubysmith build --name demo --min --zeitwerk
+rubysmith build --name demo --max --no-debug
 ----
 
 With the above examples, the first line will _disable_ all options except Zeitwerk while the second
@@ -344,60 +320,61 @@ variables. The default configuration is as follows:
 [source,yaml]
 ----
 :author:
-  :email:
-  :family_name:
-  :given_name:
-  :url:
-:build:
-  :amazing_print: true
-  :caliber: true
-  :circle_ci: false
-  :citation: true
-  :cli: false
-  :community: false
-  :conduct: true
-  :console: true
-  :contributions: true
-  :debug: true
-  :funding: false
-  :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
-  :security: true
-  :setup: true
-  :simple_cov: true
-  :versions: true
-  :yard: false
-  :zeitwerk: true
-:citation:
-  :affiliation:
-  :message: Please use the following metadata when citing this project in your work.
-  :orcid:
-:documentation:
-  :format: "adoc"
-:extensions:
-  :milestoner:
-    :documentation:
-      :format: "adoc"
-    :prefixes:
+  email:
+  family_name:
+  given_name:
+  url:
+build:
+  amazing_print: true
+  caliber: true
+  circle_ci: false
+  citation: true
+  cli: false
+  community: false
+  conduct: true
+  console: true
+  contributions: true
+  debug: true
+  funding: false
+  git: true
+  git_hub: false
+  git_hub_ci: false
+  git_lint: true
+  guard: true
+  license: true
+  maximum: false
+  minimum: false
+  rake: true
+  readme: true
+  reek: true
+  refinements: true
+  rspec: true
+  security: true
+  setup: true
+  simple_cov: true
+  versions: true
+  yard: false
+  zeitwerk: true
+citation:
+  affiliation:
+  message: Please use the following metadata when citing this project in your work.
+  orcid:
+documentation:
+  format: "adoc"
+extensions:
+  milestoner:
+    documentation:
+      format: "adoc"
+    prefixes:
       - Fixed
       - Added
       - Updated
       - Removed
       - Refactored
-  :pragmater:
-    :comments:
+  pragmater:
+    comments:
       - "# frozen_string_literal: true"
-    :includes:
+    patterns:
       - "**/*.rake"
       - "**/*.rb"
       - "*.gemspec"
@@ -409,35 +386,32 @@ variables. The default configuration is as follows:
       - Gemfile
       - Guardfile
       - Rakefile
-  :tocer:
-    :includes:
+  tocer:
+    label: "## Table of Contents"
+    patterns:
       - "README.md"
-    :label: "## Table of Contents"
-:git_hub:
-  :user:
-:license:
-  :label: Hippocratic
-  :name: hippocratic
-  :version: 2.1
-:project:
-  :url:
-    :community:
-    :conduct:
-    :contributions:
-    :download:
-    :funding:
-    :home:
-    :issues:
-    :license:
-    :security:
-    :source:
-    :versions:
-  :version: 0.0.0
+git_hub:
+  user:
+license:
+  label: Hippocratic
+  name: hippocratic
+  version: "2.1"
+project:
+  url:
+    community:
+    conduct:
+    contributions:
+    download:
+    funding:
+    home:
+    issues:
+    license:
+    security:
+    source:
+    versions:
+  version: 0.0.0
 ----
 
-Feel free to take this default configuration, modify, and save as your own custom
-`configuration.yml`.
-
 By customizing your configuration, you can change Rubysmith's default behavior when building
 projects. This is a great way to define your own specialized settings other than what is provide for
 you by default. This is also a handy way to provide additional information needed for some of the
@@ -523,7 +497,7 @@ place holder is replaced with your project name when generating a new project. E
 https://www.example.com/%project_name%
 
 # Command
-rubysmith --build demo
+rubysmith build --name demo
 
 # Actual (computed result)
 https://www.example.com/demo

data/lib/rubysmith/builders/core.rb

@@ -1,6 +1,5 @@
 # frozen_string_literal: true
 
-require "core"
 require "refinements/strings"
 require "refinements/structs"
 

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

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+require "refinements/structs"
+require "sod"
+
+module Rubysmith
+  module CLI
+    module Actions
+      # Stores Amazing Print flag.
+      class AmazingPrint < Sod::Action
+        include Import[:input]
+
+        using ::Refinements::Structs
+
+        description "Add Amazing Print gem."
+
+        on "--[no-]amazing_print"
+
+        default { Container[:configuration].build_amazing_print }
+
+        def call(value = default) = input.merge!(build_amazing_print: value)
+      end
+    end
+  end
+end

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

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+require "refinements/structs"
+require "sod"
+
+module Rubysmith
+  module CLI
+    module Actions
+      # Stores Caliber flag.
+      class Caliber < Sod::Action
+        include Import[:input]
+
+        using ::Refinements::Structs
+
+        description "Add Caliber gem."
+
+        on "--[no-]caliber"
+
+        default { Container[:configuration].build_caliber }
+
+        def call(value = default) = input.merge!(build_caliber: value)
+      end
+    end
+  end
+end

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

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+require "refinements/structs"
+require "sod"
+
+module Rubysmith
+  module CLI
+    module Actions
+      # Stores Circle CI flag.
+      class CircleCI < Sod::Action
+        include Import[:input]
+
+        using ::Refinements::Structs
+
+        description "Add Circle CI configuration."
+
+        on "--[no-]circle_ci"
+
+        default { Container[:configuration].build_circle_ci }
+
+        def call(value = default) = input.merge!(build_circle_ci: value)
+      end
+    end
+  end
+end

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

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+require "refinements/structs"
+require "sod"
+
+module Rubysmith
+  module CLI
+    module Actions
+      # Stores citation flag.
+      class Citation < Sod::Action
+        include Import[:input]
+
+        using ::Refinements::Structs
+
+        description "Add citation documentation."
+
+        on "--[no-]citation"
+
+        default { Container[:configuration].build_citation }
+
+        def call(value = default) = input.merge!(build_citation: value)
+      end
+    end
+  end
+end

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

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+require "refinements/structs"
+require "sod"
+
+module Rubysmith
+  module CLI
+    module Actions
+      # Stores community flag.
+      class Community < Sod::Action
+        include Import[:input]
+
+        using ::Refinements::Structs
+
+        description "Add community documentation."
+
+        on "--[no-]community"
+
+        default { Container[:configuration].build_community }
+
+        def call(value = default) = input.merge!(build_community: value)
+      end
+    end
+  end
+end

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

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+require "refinements/structs"
+require "sod"
+
+module Rubysmith
+  module CLI
+    module Actions
+      # Stores conduct flag.
+      class Conduct < Sod::Action
+        include Import[:input]
+
+        using ::Refinements::Structs
+
+        description "Add code of conduct documentation."
+
+        on "--[no-]conduct"
+
+        default { Container[:configuration].build_conduct }
+
+        def call(value = default) = input.merge!(build_conduct: value)
+      end
+    end
+  end
+end

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

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+require "refinements/structs"
+require "sod"
+
+module Rubysmith
+  module CLI
+    module Actions
+      # Stores console flag.
+      class Console < Sod::Action
+        include Import[:input]
+
+        using ::Refinements::Structs
+
+        description "Add console script."
+
+        on "--[no-]console"
+
+        default { Container[:configuration].build_console }
+
+        def call(value = default) = input.merge!(build_console: value)
+      end
+    end
+  end
+end

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

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+require "refinements/structs"
+require "sod"
+
+module Rubysmith
+  module CLI
+    module Actions
+      # Stores contributions flag.
+      class Contributions < Sod::Action
+        include Import[:input]
+
+        using ::Refinements::Structs
+
+        description "Add contributions documentation."
+
+        on "--[no-]contributions"
+
+        default { Container[:configuration].build_contributions }
+
+        def call(value = default) = input.merge!(build_contributions: value)
+      end
+    end
+  end
+end

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

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+require "refinements/structs"
+require "sod"
+
+module Rubysmith
+  module CLI
+    module Actions
+      # Stores Debug flag.
+      class Debug < Sod::Action
+        include Import[:input]
+
+        using ::Refinements::Structs
+
+        description "Add Debug gem."
+
+        on "--[no-]debug"
+
+        default { Container[:configuration].build_debug }
+
+        def call(value = default) = input.merge!(build_debug: value)
+      end
+    end
+  end
+end

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

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+require "refinements/structs"
+require "sod"
+
+module Rubysmith
+  module CLI
+    module Actions
+      # Stores funding flag.
+      class Funding < Sod::Action
+        include Import[:input]
+
+        using ::Refinements::Structs
+
+        description "Add GitHub funding configuration."
+
+        on "--[no-]funding"
+
+        default { Container[:configuration].build_funding }
+
+        def call(value = default) = input.merge!(build_funding: value)
+      end
+    end
+  end
+end

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

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+require "refinements/structs"
+require "sod"
+
+module Rubysmith
+  module CLI
+    module Actions
+      # Stores Git flag.
+      class Git < Sod::Action
+        include Import[:input]
+
+        using ::Refinements::Structs
+
+        description "Add Git repository."
+
+        on "--[no-]git"
+
+        default { Container[:configuration].build_git }
+
+        def call(value = default) = input.merge!(build_git: value)
+      end
+    end
+  end
+end

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

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+require "refinements/structs"
+require "sod"
+
+module Rubysmith
+  module CLI
+    module Actions
+      # Stores GitHub flag.
+      class GitHub < Sod::Action
+        include Import[:input]
+
+        using ::Refinements::Structs
+
+        description "Add GitHub templates."
+
+        on "--[no-]git_hub"
+
+        default { Container[:configuration].build_git_hub }
+
+        def call(value = default) = input.merge!(build_git_hub: value)
+      end
+    end
+  end
+end

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

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+require "refinements/structs"
+require "sod"
+
+module Rubysmith
+  module CLI
+    module Actions
+      # Stores GitHub CI flag.
+      class GitHubCI < Sod::Action
+        include Import[:input]
+
+        using ::Refinements::Structs
+
+        description "Add GitHub continuous integration."
+
+        on "--[no-]git_hub_ci"
+
+        default { Container[:configuration].build_git_hub_ci }
+
+        def call(value = default) = input.merge!(build_git_hub_ci: value)
+      end
+    end
+  end
+end

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

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+require "refinements/structs"
+require "sod"
+
+module Rubysmith
+  module CLI
+    module Actions
+      # Stores Git Lint flag.
+      class GitLint < Sod::Action
+        include Import[:input]
+
+        using ::Refinements::Structs
+
+        description "Add Git Lint gem."
+
+        on "--[no-]git-lint"
+
+        default { Container[:configuration].build_git_lint }
+
+        def call(value = default) = input.merge!(build_git_lint: value)
+      end
+    end
+  end
+end