rubysmith 6.10.0 → 7.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ed5911cc50ea1b09a9084b3978e8c52b0ac912fa12a3cd588653ed485a48df40
-  data.tar.gz: 92f240e6c4f43ca45361f83273436f15d0554552c47270d1adb53178e8a396b5
+  metadata.gz: 3ba99960f8d5238ff9f23bc08b866c1d2e808bb7704f2d745b28254ecda1aaab
+  data.tar.gz: 420ef6ebfc7751d9aa490a2abbe2a24fe09206ef5a4735da6e9f3bb4aaf673b1
 SHA512:
-  metadata.gz: 38057a03922b7aff2554ec616ca93d8e1ca5104eb36e802c6ffa9fd266c7a2f4c8f1dd351deecd5b144452cce825abcd643351d9e44c31960f07ffdf4ba76d35
-  data.tar.gz: 937fa75a994a09541e041a4c163fc90613652909c2db285629862dd37398b249be2dffe71c62fa0d54485f04e4c488157886a366919179869cedd0b0f87ae626
+  metadata.gz: 53f5f436d69f6218b4eaee550f844fab11c1667666d6bbf19ad01b3ab463fcfcbc0d8e3bd36f2da0e6c384ddea2f1e585311ce3706c87a30246b14a1508af493
+  data.tar.gz: 69d5ece05c1d3017d01d615dbd4c7efca795dfd863c8ba1149e0057d978095665c8d14f1f877e8c60d35bc2d4279265f5619cee06807e1d7a7b7936e752ec2da

data/README.adoc

@@ -4,6 +4,7 @@
 
 :gemsmith_link: link:https://alchemists.io/projects/gemsmith[Gemsmith]
 :bundler_inline_link: link:https://alchemists.io/articles/ruby_bundler_inline[Bundler Inline]
+:string_formats_link: link:https://docs.ruby-lang.org/en/3.3/format_specifications_rdoc.html[String Formats]
 
 = Rubysmith
 
@@ -77,7 +78,7 @@ gem install rubysmith
 
 From the command line, type: `rubysmith --help`
 
-image:https://alchemists.io/images/projects/rubysmith/screenshots/usage.png[Usage,width=604,height=345,role=focal_point]
+image:https://alchemists.io/images/projects/rubysmith/screenshots/usage.png[Usage,width=554,height=301,role=focal_point]
 
 ==== Build
 
@@ -279,21 +280,6 @@ The `--zeitwerk` option allows you add the link:https://github.com/fxn/zeitwerk[
 
 This includes having access to your project's Zeitwerk loader for inspection and debugging purposes. This means if you built a `Demo` project, you'd immediately have access to your project's loader via `Demo.loader` when using the project console (i.e. `bin/console`, assuming you built your project with the `--console` flag enabled which is default behavior).
 
-==== Publish
-
-Rubysmith can be used to publish your Ruby projects. This is done via the `--publish` command. If,
-for example, you want to publish `0.1.0` of your `demo` project you could do that as follows:
-
-[source,bash]
-----
-cd demo
-rubysmith --publish 0.1.0
-----
-
-This will publish (tag) your `demo` project as `0.1.0` both locally and on your remote Git repository.
-Rubysmith uses link:https://alchemists.io/projects/milestoner[Milestoner] to handle publishing
-of your project for you. You can use either but the convenience is built in for you.
-
 === Configuration
 
 This gem can be configured via a global configuration:
@@ -308,10 +294,8 @@ variables. The default configuration is as follows:
 [source,yaml]
 ----
 author:
-  email:
-  family_name:
-  given_name:
-  url:
+  handle: undefined
+  uri: "%<organization_uri>s/team/%<author_handle>s"
 build:
   amazing_print: true
   caliber: true
@@ -329,7 +313,7 @@ build:
   git_hub_ci: false
   git_lint: true
   guard: true
-  irb_kit: false
+  irb_kit: true
   license: true
   maximum: false
   minimum: false
@@ -345,64 +329,69 @@ build:
   versions: true
   zeitwerk: true
 citation:
-  affiliation:
   message: Please use the following metadata when citing this project in your work.
-  orcid:
 documentation:
   format: "adoc"
-git_hub:
-  user:
 license:
   label: Hippocratic
   name: hippocratic
   version: "2.1"
 organization:
-  url:
+  uri: https://undefined.io
 project:
-  url:
-    community:
-    conduct:
-    contributions:
-    download:
-    funding:
-    home:
-    issues:
-    license:
-    security:
-    source:
-    versions:
+  uri:
+    community: "%<organization_uri>s/community"
+    conduct: "%<organization_uri>s/policies/code_of_conduct"
+    contributions: "%<organization_uri>s/policies/contributions"
+    download: "https://rubygems.org/gems/%<project_name>s"
+    funding: "%<repository_uri>s/sponsors/%<repository_handle>s"
+    home: "%<organization_uri>s/projects/%<project_name>s"
+    issues: "%<repository_uri>s/%<repository_handle>s/%<project_name>s/issues"
+    license: "%<organization_uri>s/policies/license"
+    security: "%<organization_uri>s/policies/security"
+    source: "%<repository_uri>s/%<repository_handle>s/%<project_name>s"
+    versions: "%<organization_uri>s/projects/%<project_name>s/versions"
   version: 0.0.0
+repository:
+  handle: undefined
+  uri: https://github.com
 ----
 
-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 build options. The next sections will walk you through each configuration so you can learn more.
+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 build options.
+
+You'll also notice some of the values use {string_formats_link} which means you can use any fully qualified key as a string specifier for supported keys like those found in the `author` and `project` sections.
+
+The next sections will walk you through each configuration so you can learn more.
 
 ==== Author
 
 Author information is used when generating project documentation and is recommended you fill this
 information in before building a project. Example:
 
-    author:
-      email: jsmith@example.com
-      family_name: Smith
-      given_name: Jill
-      url: https://www.exmaple.com/team/jsmith
+[source,yaml]
+----
+author:
+  email: jsmith@example.com
+  family_name: Smith
+  given_name: Jill
+----
 
 If your global link:https://git-scm.com[Git] configuration is properly configured, your given name;
 family name; and email will be used by default. Should you not want to defer to Git, you can supply
-custom values as desired. The URL is the only value that can't be automatically computed for you.
+custom values as desired. The URI is the only value that can't be automatically computed for you.
 
 ==== Build
 
 All build options only accept booleans values and can be customized as desired. When changing your build options, they will dynamically render when displaying usage (i.e. `rubysmith --help`). All of these options have been explained in greater detail in the _Usage_ section.
 
-ℹ️ The `cli` option is provided to support the {gemsmith_link} gem but is not, currently, used by
+ℹ️ The `cli` option is provided to support {gemsmith_link} but is not, currently, used by
 this project.
 
 ==== Citations
 
 This section allows you to configure your link:https://orcid.org[ORCID]
 link:https://citation-file-format.github.io[citation] information used by the research community.
-You should definitely fill this in. Your author information, detailed above, will be used as well.
+You should definitely fill this in. Your author information, detailed above, will also be used when building this file.
 
 ==== Documentation
 
@@ -412,10 +401,6 @@ following options are available:
 * `adoc` - Uses link:https://asciidoctor.org[ASCII Doc] format.
 * `md` - Uses link:https://asciidoctor.org[Markdown] format.
 
-==== GitHub
-
-Your GitHub user is the handle you setup when creating your GitHub account (i.e. `+https://github.com/<your_handle>+`). This information is used for template, funding, and/or URL construction purposes.
-
 ==== License
 
 Use this section to define the license you want to use for your project. The following are available:
@@ -428,20 +413,20 @@ When picking a license, you can also supply the appropriate label and version in
 
 ==== Organization
 
-Use this section to define URL information that points to your organization. This is useful for information that isn't project specific but related to all projects within your organization. You'll want to customize this URL especially for documentation purposes.
+Use this section to define URI information that points to your organization. This is useful for information that isn't project specific but related to all projects within your organization. You'll want to customize this URI especially for documentation purposes.
 
 ==== Project
 
-There are two sub-categories within this section: URLs and version. The URLs allow you to link to
-specific documentation related to your project. You'll want to customize these URLs since they are
-used for documentation, citations, and general project information. Some of the URLs are also used
+There are two sub-categories within this section: URIs and version. The URIs allow you to link to
+specific documentation related to your project. You'll want to customize these URIs since they are
+used for documentation, citations, and general project information. Some of the URIs are also used
 by the {gemsmith_link} gem.
 
-One powerful feature of this configuration is that you can use `%project_name%` as a placeholder _anywhere_ in your URLs and Rubysmith will ensure your place holder is replaced with your project name when generating a new project. Example:
+One powerful feature of this configuration is that you can use `%<project_name>s` as a placeholder _anywhere_ in your URIs and Rubysmith will ensure your place holder is replaced with your project name when generating a new project. Example:
 
 ....
 # Configuration
-https://www.example.com/%project_name%
+https://www.example.com/%<project_name>s
 
 # Command
 rubysmith build --name demo
@@ -452,6 +437,10 @@ https://www.example.com/demo
 
 As for the `version` key, this defines the default version of newly created projects. `0.0.0` is the default but you can use a higher version number like `0.1.0` or even `1.0.0` if you are super confident in your work. That said, a lower the number is recommended when building your initial project which is why `0.0.0` is the default.
 
+==== Repository
+
+Your repisotry handle is the handle you setup when creating your account (i.e. `+https://github.com/<your_handle>+`). This information is used for template, funding, and/or URI construction purposes.
+
 == Development
 
 To contribute, run:

data/lib/rubysmith/builder.rb

@@ -15,10 +15,10 @@ module Rubysmith
 
     def self.call(...) = new(...)
 
-    def initialize(configuration, helpers: HELPERS, **)
-      super(**)
-      @configuration = configuration
+    def initialize(settings, helpers: HELPERS, **)
+      @settings = settings
       @helpers = helpers
+      super(**)
     end
 
     def append content
@@ -107,7 +107,7 @@ module Rubysmith
 
     private
 
-    attr_reader :configuration, :helpers
+    attr_reader :settings, :helpers
 
     def execute *command
       executor.capture2e(*command).then do |result, status|
@@ -117,20 +117,20 @@ module Rubysmith
 
     def inserter = helpers.fetch(__method__)
 
-    def renderer = helpers.fetch(__method__).new(configuration)
+    def renderer = helpers.fetch(__method__).new(settings)
 
     def executor = helpers.fetch(__method__)
 
-    def relative_build_path = build_path.relative_path_from(configuration.target_root)
+    def relative_build_path = build_path.relative_path_from(settings.target_root)
 
     def build_path
       pathway.end_path
-             .gsub("%project_name%", configuration.project_name)
-             .sub("%project_path%", configuration.project_path)
+             .gsub("%project_name%", settings.project_name)
+             .sub("%project_path%", settings.project_path)
              .sub ".erb", ""
     end
 
-    def pathway = configuration.pathway
+    def pathway = settings.pathway
 
     def log_debug(message) = logger.debug { message }
 

data/lib/rubysmith/builders/abstract.rb

@@ -4,11 +4,11 @@ module Rubysmith
   module Builders
     # Provides default implementation from which builders can inherit from.
     class Abstract
-      def self.call(...) = new(...).call
+      include Import[:settings]
 
-      def initialize configuration, builder: Builder
-        @configuration = configuration
+      def initialize(builder: Builder, **)
         @builder = builder
+        super(**)
       end
 
       def call
@@ -18,7 +18,7 @@ module Rubysmith
 
       protected
 
-      attr_reader :configuration, :builder
+      attr_reader :builder
     end
   end
 end

data/lib/rubysmith/builders/bundler.rb

@@ -9,7 +9,7 @@ module Rubysmith
       using Refinements::Struct
 
       def call
-        builder.call(configuration.merge(template_path: "%project_name%/Gemfile.erb"))
+        builder.call(settings.merge(template_path: "%project_name%/Gemfile.erb"))
                .render
                .replace(/\n\s+group/, "\n\ngroup")
                .replace(/\n\s+gem/, "\n  gem")
@@ -18,7 +18,7 @@ module Rubysmith
                .replace(/\n\ngroup :(quality|development|test|tools) do\nend/, "")
                .replace(/org"\n+/, "org\"\n\n")
 
-        configuration
+        true
       end
     end
   end

data/lib/rubysmith/builders/caliber.rb

@@ -9,15 +9,15 @@ module Rubysmith
       using Refinements::Struct
 
       def call
-        return configuration unless configuration.build_caliber
+        return false unless settings.build_caliber
 
-        builder.call(configuration.merge(template_path: "%project_name%/bin/rubocop.erb"))
+        builder.call(settings.merge(template_path: "%project_name%/bin/rubocop.erb"))
                .render
                .permit 0o755
 
         path = "%project_name%/.config/rubocop/config.yml.erb"
-        builder.call(configuration.merge(template_path: path)).render
-        configuration
+        builder.call(settings.merge(template_path: path)).render
+        true
       end
     end
   end

data/lib/rubysmith/builders/circle_ci.rb

@@ -9,13 +9,13 @@ module Rubysmith
       using Refinements::Struct
 
       def call
-        return configuration unless configuration.build_circle_ci
+        return false unless settings.build_circle_ci
 
-        builder.call(configuration.merge(template_path: "%project_name%/.circleci/config.yml.erb"))
+        builder.call(settings.merge(template_path: "%project_name%/.circleci/config.yml.erb"))
                .render
                .replace(/\n\n\Z/, "\n")
 
-        configuration
+        true
       end
     end
   end

data/lib/rubysmith/builders/console.rb

@@ -9,13 +9,13 @@ module Rubysmith
       using Refinements::Struct
 
       def call
-        return configuration unless configuration.build_console
+        return false unless settings.build_console
 
-        builder.call(configuration.merge(template_path: "%project_name%/bin/console.erb"))
+        builder.call(settings.merge(template_path: "%project_name%/bin/console.erb"))
                .render
                .permit 0o755
 
-        configuration
+        true
       end
     end
   end

data/lib/rubysmith/builders/core.rb

@@ -13,13 +13,13 @@ module Rubysmith
       def call
         render_implementation
         render_specification
-        configuration
+        true
       end
 
       private
 
       def render_implementation
-        builder.call(configuration.merge(template_path: "%project_name%/lib/%project_path%.rb.erb"))
+        builder.call(settings.merge(template_path: "%project_name%/lib/%project_path%.rb.erb"))
                .render
                .replace("  require", "require")
                .replace(/    (?=(Zeit|loader|end))/, "")
@@ -28,15 +28,15 @@ module Rubysmith
       end
 
       def render_specification
-        return unless configuration.build_zeitwerk
+        return unless settings.build_zeitwerk
 
         path = "%project_name%/spec/lib/%project_path%_spec.rb.erb"
-        builder.call(configuration.merge(template_path: path)).render
+        builder.call(settings.merge(template_path: path)).render
       end
 
-      def indentation = ::Core::EMPTY_STRING.indent configuration.project_levels
+      def indentation = ::Core::EMPTY_STRING.indent settings.project_levels
 
-      def module_name = configuration.project_class
+      def module_name = settings.project_class
     end
   end
 end

data/lib/rubysmith/builders/documentation/citation.rb

@@ -10,10 +10,10 @@ module Rubysmith
         using Refinements::Struct
 
         def call
-          return configuration unless configuration.build_citation
+          return false unless settings.build_citation
 
-          builder.call(configuration.merge(template_path: "%project_name%/CITATION.cff.erb")).render
-          configuration
+          builder.call(settings.merge(template_path: "%project_name%/CITATION.cff.erb")).render
+          true
         end
       end
     end

data/lib/rubysmith/builders/documentation/license.rb

@@ -1,7 +1,6 @@
 # frozen_string_literal: true
 
 require "refinements/struct"
-require "tocer"
 
 module Rubysmith
   module Builders
@@ -11,21 +10,21 @@ module Rubysmith
         using Refinements::Struct
 
         def call
-          return configuration unless configuration.build_license
+          return false unless settings.build_license
 
-          configuration.merge(template_path: "%project_name%/LICENSE-#{license}.#{kind}.erb")
-                       .then do |updated_configuration|
-                         builder.call(updated_configuration).render.rename "LICENSE.#{kind}"
-                       end
+          settings.merge(template_path: "%project_name%/LICENSE-#{license}.#{kind}.erb")
+                  .then do |updated_settings|
+                    builder.call(updated_settings).render.rename "LICENSE.#{kind}"
+                  end
 
-          configuration
+          true
         end
 
         private
 
-        def kind = configuration.documentation_format
+        def kind = settings.documentation_format
 
-        def license = configuration.license_name
+        def license = settings.license_name
       end
     end
   end

data/lib/rubysmith/builders/documentation/readme.rb

@@ -10,19 +10,19 @@ module Rubysmith
         using Refinements::Struct
 
         def call
-          return configuration unless configuration.build_readme
+          return false unless settings.build_readme
 
-          builder.call(configuration.merge(template_path: "%project_name%/README.#{kind}.erb"))
+          builder.call(settings.merge(template_path: "%project_name%/README.#{kind}.erb"))
                  .render
                  .replace(/\n{2,}/, "\n\n")
                  .replace("\n    \n", "\n")
 
-          configuration
+          true
         end
 
         protected
 
-        def kind = configuration.documentation_format
+        def kind = settings.documentation_format
       end
     end
   end

data/lib/rubysmith/builders/documentation/version.rb

@@ -11,17 +11,16 @@ module Rubysmith
         using Refinements::Struct
 
         def call
-          return configuration unless configuration.build_versions
+          return false unless settings.build_versions
 
-          builder.call(configuration.merge(template_path: "%project_name%/VERSIONS.#{kind}.erb"))
-                 .render
+          builder.call(settings.merge(template_path: "%project_name%/VERSIONS.#{kind}.erb")).render
 
-          configuration
+          true
         end
 
         private
 
-        def kind = configuration.documentation_format
+        def kind = settings.documentation_format
       end
     end
   end

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

@@ -7,21 +7,17 @@ module Rubysmith
       class Commit < Abstract
         include Import[:specification]
 
-        def initialize(configuration, builder: Builder, **)
-          super
-        end
-
         def call
-          return configuration unless configuration.build_git
+          return false unless settings.build_git
 
-          builder.call(configuration)
+          builder.call(settings)
                  .run("git add .", chdir: project_name)
                  .run(
                    %(git commit --all --message "Added project skeleton" --message "#{body}"),
                    chdir: project_name
                  )
 
-          configuration
+          true
         end
 
         private
@@ -31,7 +27,7 @@ module Rubysmith
           "#{specification.version}."
         end
 
-        def project_name = configuration.project_name
+        def project_name = settings.project_name
       end
     end
   end

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

@@ -10,13 +10,13 @@ module Rubysmith
         using Refinements::Struct
 
         def call
-          return configuration unless configuration.build_git
+          return false unless settings.build_git
 
-          builder.call(configuration.merge(template_path: "%project_name%/.gitignore.erb"))
+          builder.call(settings.merge(template_path: "%project_name%/.gitignore.erb"))
                  .render
                  .replace("  ", "")
 
-          configuration
+          true
         end
       end
     end

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

@@ -10,10 +10,10 @@ module Rubysmith
         using Refinements::Struct
 
         def call
-          return configuration unless configuration.build_git
+          return false unless settings.build_git
 
-          builder.call(configuration.merge(template_path: "%project_name%/.git/safe")).make_path
-          configuration
+          builder.call(settings.merge(template_path: "%project_name%/.git/safe")).make_path
+          true
         end
       end
     end

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

@@ -6,10 +6,10 @@ module Rubysmith
       # Initializes project skeleton as a Git repository.
       class Setup < Abstract
         def call
-          return configuration unless configuration.build_git
+          return false unless settings.build_git
 
-          builder.call(configuration).run("git init", chdir: configuration.project_name)
-          configuration
+          builder.call(settings).run("git init", chdir: settings.project_name)
+          true
         end
       end
     end

data/lib/rubysmith/builders/git_hub/ci.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+require "refinements/struct"
+
+module Rubysmith
+  module Builders
+    module GitHub
+      # Builds project skeleton GitHub CI template.
+      class CI < Abstract
+        using Refinements::Struct
+
+        def call
+          return false unless settings.build_git_hub_ci
+
+          builder.call(with_template).render.replace(/\n\n\Z/, "\n")
+          true
+        end
+
+        private
+
+        def with_template
+          settings.merge template_path: "%project_name%/.github/workflows/ci.yml.erb"
+        end
+      end
+    end
+  end
+end

data/lib/rubysmith/builders/git_hub/funding.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+require "refinements/struct"
+
+module Rubysmith
+  module Builders
+    module GitHub
+      # Builds project skeleton GitHub funding template.
+      class Funding < Abstract
+        using Refinements::Struct
+
+        def call
+          return false unless settings.build_git_hub && settings.build_funding
+
+          settings.merge(template_path: "%project_name%/.github/FUNDING.yml.erb")
+                  .then { |updated_configuration| builder.call(updated_configuration).render }
+
+          true
+        end
+      end
+    end
+  end
+end