rubysmith 7.1.0 → 7.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 98de14cb0b27d946e2c34e742a2d8c41a35be86d0a807a43d5d269c556f5ecf9
-  data.tar.gz: e3374105862254535024815aadf97a8e22a6ec95aac89f4abb3d1149c846896d
+  metadata.gz: 1529b428758e620a07651f58648e9347d6285ae658c5ba7f4e60ec445958b279
+  data.tar.gz: 7efa1cd58738e11138bc31209ee0b6a2b0ab30a710f54016b8ad3c17b8f6a993
 SHA512:
-  metadata.gz: 22444127ca4b4ef35b36b5aac3cf54d936c71de4bb72c36ae9fc0e7713145f978048910036c450a96d2c1bfce026338965bd781eb26bd36e5edc56b4327868eb
-  data.tar.gz: b162fa1f1f7aff11957208ba4b43ac8d4b0e59c7eb87d9228328630c12bc1ee311df84a895d10c64b376474976b1123aa229b578f7b7c323e415319f8a11b199
+  metadata.gz: bb59f4e7490b4e8298a9c14d31923f8e46d1f1ed28cc2ae0f6778d8269d4ee08eab8c304aef3c276439eb447ae5fb43d9b63cf6f9239d64a6e17bfaf70f81a7c
+  data.tar.gz: 51d8e56f5b799df3b03a9a20c8331004d5f44f0bbdf4371c8299f8a8f75a17719c74c11d2d9d4bc9159cd535f0c3bf26c86e6c1d93ece452a18d149490f490c6

data/README.adoc

@@ -2,8 +2,10 @@
 :toclevels: 5
 :figure-caption!:
 
-:gemsmith_link: link:https://alchemists.io/projects/gemsmith[Gemsmith]
 :bundler_inline_link: link:https://alchemists.io/articles/ruby_bundler_inline[Bundler Inline]
+:development_containers_link: link:https://containers.dev[Development Containers]
+:docker_link: link:https://www.docker.com[Docker]
+:gemsmith_link: link:https://alchemists.io/projects/gemsmith[Gemsmith]
 :string_formats_link: link:https://docs.ruby-lang.org/en/3.3/format_specifications_rdoc.html[String Formats]
 
 = Rubysmith
@@ -26,6 +28,8 @@ toc::[]
 * Supports link:https://orcid.org[Citations (ORCID)].
 * Supports console script for local development.
 * Supports link:https://github.com/ruby/debug[Debug].
+* Supports {development_containers_link}.
+* Supports {docker_link}.
 * Supports link:https://git-scm.com[Git].
 * Supports link:https://github.com[GitHub].
 * Supports link:https://alchemists.io/projects/git-lint[Git Lint].
@@ -46,6 +50,7 @@ toc::[]
 ** Security
 ** Code of Conduct
 ** Contributions
+** Developer Certificate of Origin
 ** Communities
 
 == Requirements
@@ -135,6 +140,11 @@ link:https://github.com/amazing-print/amazing_print[Amazing Print] gem for debug
 a handy debugging tool when inspecting your Ruby objects and printing details in a quick to read
 format.
 
+===== Bootsnap
+
+The `--bootsnap` option allows you to build your project with the
+link:https://github.com/Shopify/bootsnap[Bootsnap] gem for improved performance. This is best used for pure, non-gem, Ruby projects and/or web applications in general.
+
 ===== Caliber
 
 The `--caliber` option allows you to build your project with the
@@ -175,12 +185,26 @@ loaded.
 The `--contributions` option allows you to link to contributing documentation so people know to
 contribute back to your work.
 
+===== Developer Certificate of Origin
+
+The `--dcoo` option allows to you add link:https://developercertificate.org[Developer Certificate of Origin] documentation so all contributors are aware of how their contributions are applied in terms of ownership, copyright, and licensing.
+
+ℹ️ This is disabled by default but will be enabled by default in the next major version.
+
 ===== Debug
 
 The `--debug` option allows you add the link:https://github.com/ruby/debug[Debug] gem to your
 project for debugging your code by setting breakpoints, remotely connecting to running code, and
 much more.
 
+===== Docker
+
+The `--docker` option allows you add {docker_link} to your project so you can build and deploy to production.
+
+===== Development Containers
+
+The `--devcontainer` option allows you add {development_containers_link} support to your project so you can develop locally by running your project within a {docker_link} container.
+
 ===== Funding
 
 The `--funding` option allows you add a link:https://github.com[GitHub] funding configuration to
@@ -299,6 +323,7 @@ author:
   uri: "%<organization_uri>s/team/%<author_handle>s"
 build:
   amazing_print: true
+  bootsnap: false
   caliber: true
   circle_ci: false
   citation: true
@@ -307,7 +332,10 @@ build:
   conduct: true
   console: true
   contributions: true
+  dcoo: false
   debug: true
+  devcontainer: false
+  docker: false
   funding: false
   git: true
   git_hub: false
@@ -344,6 +372,7 @@ project:
     community: "%<organization_uri>s/community"
     conduct: "%<organization_uri>s/policies/code_of_conduct"
     contributions: "%<organization_uri>s/policies/contributions"
+    dcoo: "%<organization_uri>s/policies/developer_certificate_of_origin"
     download: "https://rubygems.org/gems/%<project_name>s"
     funding: "%<repository_uri>s/sponsors/%<repository_handle>s"
     home: "%<organization_uri>s/projects/%<project_name>s"
@@ -404,17 +433,68 @@ following options are available:
 
 ==== License
 
-Use this section to define the license you want to use for your project. The following are available:
+Use this section to define the license you want to use for your project. When picking a license, you can supply the appropriate `label` and `version` in addition to the `name`. The `name` is the only value you _can't_ customize. The following details all supported licenses.
+
+===== Apache
 
-* `apache`: Uses the link:https://www.apache.org/licenses/LICENSE-2.0[Apache] license.
-* `hippocratic`: Uses the link:https://firstdonoharm.dev[Hippocratic] license.
-* `mit`: Uses the link:https://mit-license.org[MIT] license.
+To use the link:https://www.apache.org/licenses/LICENSE-2.0[Apache] license, apply this configuration:
 
-When picking a license, you can also supply the appropriate label and version in addition to the name.
+[source,yaml]
+----
+license:
+  label: "Apache"
+  name: "apache"
+  version: "2.0"
+----
+
+===== Fair Source
+
+To use the link:https://fsl.software[Fair Source] license, apply this configuration:
+
+[source,yaml]
+----
+license:
+  label: "Fair Source"
+  name: "fair"
+  version: "FSL-1.1-Apache-2.0"
+----
+
+===== Hippocratic
+
+To use the link:https://firstdonoharm.dev[Hippocratic] license, apply this configuration:
+
+[source,yaml]
+----
+license:
+  label: "Hippocratic"
+  name: "hippocratic"
+  version: "2.1"
+----
+
+ℹ️ This is the default license unless you customize.
+
+===== MIT
+
+To use the  link:https://mit-license.org[MIT] license, apply this configuration:
+
+[source,yaml]
+----
+license:
+  label: "MIT"
+  name: "mit"
+  version: ""
+----
 
 ==== Organization
 
-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.
+Use this section to define organization specific information. This is useful for information that isn't project specific but related to all projects within your organization. You'll want -- highly recommended -- to supply configuration details. For example, here's what a fictional organization might look like:
+
+[source,yaml]
+----
+organization:
+  label: ACME
+  uri: https://acme.io
+----
 
 ==== Project
 
@@ -477,6 +557,8 @@ bin/rake
 
 == link:https://alchemists.io/policies/contributions[Contributions]
 
+== link:https://alchemists.io/policies/developer_certificate_of_origin[Developer Certificate of Origin]
+
 == link:https://alchemists.io/projects/rubysmith/versions[Versions]
 
 == link:https://alchemists.io/community[Community]

data/lib/rubysmith/builders/bundler.rb

@@ -13,7 +13,7 @@ module Rubysmith
                .render
                .replace(/\n\s+group/, "\n\ngroup")
                .replace(/\n\s+gem/, "\n  gem")
-               .replace(/  (?=.+(refinements|zeitwerk))/, "")
+               .replace(/  (?=.+(bootsnap|refinements|zeitwerk))/, "")
                .replace(/(\n+|\s+)end/, "\nend")
                .replace(/\n\ngroup :(quality|development|test|tools) do\nend/, "")
                .replace(/org"\n+/, "org\"\n\n")

data/lib/rubysmith/builders/dev_container/compose.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+require "refinements/struct"
+
+module Rubysmith
+  module Builders
+    module DevContainer
+      # Builds Docker Compose configuration for container.
+      class Compose < Abstract
+        using Refinements::Struct
+
+        def call
+          return false unless settings.build_devcontainer
+
+          path = "%project_name%/.devcontainer/compose.yaml.erb"
+          builder.call(settings.merge(template_path: path)).render
+          true
+        end
+      end
+    end
+  end
+end

data/lib/rubysmith/builders/dev_container/configuration.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+require "refinements/struct"
+
+module Rubysmith
+  module Builders
+    module DevContainer
+      # Builds container configuration.
+      class Configuration < Abstract
+        using Refinements::Struct
+
+        def call
+          return false unless settings.build_devcontainer
+
+          path = "%project_name%/.devcontainer/devcontainer.json.erb"
+          builder.call(settings.merge(template_path: path)).render
+          true
+        end
+      end
+    end
+  end
+end

data/lib/rubysmith/builders/dev_container/dockerfile.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+require "refinements/struct"
+
+module Rubysmith
+  module Builders
+    module DevContainer
+      # Builds Dockerfile for container.
+      class Dockerfile < Abstract
+        using Refinements::Struct
+
+        def call
+          return false unless settings.build_devcontainer
+
+          builder.call(settings.merge(template_path: "%project_name%/.devcontainer/Dockerfile.erb"))
+                 .render
+          true
+        end
+      end
+    end
+  end
+end

data/lib/rubysmith/builders/docker/build.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+require "refinements/struct"
+
+module Rubysmith
+  module Builders
+    module Docker
+      # Builds Docker build script.
+      class Build < Abstract
+        using Refinements::Struct
+
+        def call
+          return false unless settings.build_docker
+
+          builder.call(settings.merge(template_path: "%project_name%/bin/docker/build.erb"))
+                 .render
+                 .permit 0o755
+
+          true
+        end
+      end
+    end
+  end
+end

data/lib/rubysmith/builders/docker/console.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+require "refinements/struct"
+
+module Rubysmith
+  module Builders
+    module Docker
+      # Builds Docker console script.
+      class Console < Abstract
+        using Refinements::Struct
+
+        def call
+          return false unless settings.build_docker
+
+          builder.call(settings.merge(template_path: "%project_name%/bin/docker/console.erb"))
+                 .render
+                 .permit 0o755
+
+          true
+        end
+      end
+    end
+  end
+end

data/lib/rubysmith/builders/docker/entrypoint.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+require "refinements/struct"
+
+module Rubysmith
+  module Builders
+    module Docker
+      # Builds Docker entrypoint script.
+      class Entrypoint < Abstract
+        using Refinements::Struct
+
+        def call
+          return false unless settings.build_docker
+
+          builder.call(settings.merge(template_path: "%project_name%/bin/docker/entrypoint.erb"))
+                 .render
+                 .permit 0o755
+
+          true
+        end
+      end
+    end
+  end
+end

data/lib/rubysmith/builders/docker/file.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+require "refinements/struct"
+
+module Rubysmith
+  module Builders
+    module Docker
+      # Builds Dockerfile configuration.
+      class File < Abstract
+        using Refinements::Struct
+
+        def call
+          return false unless settings.build_docker
+
+          builder.call(settings.merge(template_path: "%project_name%/Dockerfile.erb")).render
+          true
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+require "refinements/struct"
+
+module Rubysmith
+  module Builders
+    module Docker
+      # Builds Docker ignore configuration.
+      class Ignore < Abstract
+        using Refinements::Struct
+
+        def call
+          return false unless settings.build_git
+
+          builder.call(settings.merge(template_path: "%project_name%/.dockerignore.erb")).render
+          true
+        end
+      end
+    end
+  end
+end

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

@@ -15,7 +15,7 @@ module Rubysmith
 
         default { Container[:settings].build_amazing_print }
 
-        def call(value = nil) = settings.build_amazing_print = value
+        def call(boolean) = settings.build_amazing_print = boolean
       end
     end
   end

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

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+require "sod"
+
+module Rubysmith
+  module CLI
+    module Actions
+      # Stores Bootsnap flag.
+      class Bootsnap < Sod::Action
+        include Import[:settings]
+
+        description "Add Bootsnap gem."
+
+        on "--[no-]bootsnap"
+
+        default { Container[:settings].build_bootsnap }
+
+        def call(boolean) = settings.build_bootsnap = boolean
+      end
+    end
+  end
+end

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

@@ -15,7 +15,7 @@ module Rubysmith
 
         default { Container[:settings].build_caliber }
 
-        def call(value = nil) = settings.build_caliber = value
+        def call(boolean) = settings.build_caliber = boolean
       end
     end
   end

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

@@ -9,13 +9,13 @@ module Rubysmith
       class CircleCI < Sod::Action
         include Import[:settings]
 
-        description "Add Circle CI settings."
+        description "Add Circle CI support."
 
         on "--[no-]circle_ci"
 
         default { Container[:settings].build_circle_ci }
 
-        def call(value = nil) = settings.build_circle_ci = value
+        def call(boolean) = settings.build_circle_ci = boolean
       end
     end
   end

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

@@ -15,7 +15,7 @@ module Rubysmith
 
         default { Container[:settings].build_citation }
 
-        def call(value = nil) = settings.build_citation = value
+        def call(boolean) = settings.build_citation = boolean
       end
     end
   end

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

@@ -15,7 +15,7 @@ module Rubysmith
 
         default { Container[:settings].build_community }
 
-        def call(value = nil) = settings.build_community = value
+        def call(boolean) = settings.build_community = boolean
       end
     end
   end

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

@@ -15,7 +15,7 @@ module Rubysmith
 
         default { Container[:settings].build_conduct }
 
-        def call(value = nil) = settings.build_conduct = value
+        def call(boolean) = settings.build_conduct = boolean
       end
     end
   end

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

@@ -15,7 +15,7 @@ module Rubysmith
 
         default { Container[:settings].build_console }
 
-        def call(value = nil) = settings.build_console = value
+        def call(boolean) = settings.build_console = boolean
       end
     end
   end

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

@@ -15,7 +15,7 @@ module Rubysmith
 
         default { Container[:settings].build_contributions }
 
-        def call(value = nil) = settings.build_contributions = value
+        def call(boolean) = settings.build_contributions = boolean
       end
     end
   end

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

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+require "sod"
+
+module Rubysmith
+  module CLI
+    module Actions
+      # Stores Developer Certificate of Origin flag.
+      class DCOO < Sod::Action
+        include Import[:settings]
+
+        description "Add Developer Certificate of Origin documentation."
+
+        on "--[no-]dcoo"
+
+        default { Container[:settings].build_dcoo }
+
+        def call(boolean) = settings.build_dcoo = boolean
+      end
+    end
+  end
+end

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

@@ -15,7 +15,7 @@ module Rubysmith
 
         default { Container[:settings].build_debug }
 
-        def call(value = nil) = settings.build_debug = value
+        def call(boolean) = settings.build_debug = boolean
       end
     end
   end

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

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+require "sod"
+
+module Rubysmith
+  module CLI
+    module Actions
+      # Stores Development Container flag.
+      class DevContainer < Sod::Action
+        include Import[:settings]
+
+        description "Add Development Container support."
+
+        on "--[no-]devcontainer"
+
+        default { Container[:settings].build_devcontainer }
+
+        def call(boolean) = settings.build_devcontainer = boolean
+      end
+    end
+  end
+end

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

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+require "sod"
+
+module Rubysmith
+  module CLI
+    module Actions
+      # Stores Docker flag.
+      class Docker < Sod::Action
+        include Import[:settings]
+
+        description "Add Docker support."
+
+        on "--[no-]docker"
+
+        default { Container[:settings].build_docker }
+
+        def call(boolean) = settings.build_docker = boolean
+      end
+    end
+  end
+end

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

@@ -9,13 +9,13 @@ module Rubysmith
       class Funding < Sod::Action
         include Import[:settings]
 
-        description "Add GitHub funding settings."
+        description "Add GitHub funding."
 
         on "--[no-]funding"
 
         default { Container[:settings].build_funding }
 
-        def call(value = nil) = settings.build_funding = value
+        def call(boolean) = settings.build_funding = boolean
       end
     end
   end

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

@@ -15,7 +15,7 @@ module Rubysmith
 
         default { Container[:settings].build_git }
 
-        def call(value = nil) = settings.build_git = value
+        def call(boolean) = settings.build_git = boolean
       end
     end
   end

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

@@ -9,13 +9,13 @@ module Rubysmith
       class GitHub < Sod::Action
         include Import[:settings]
 
-        description "Add GitHub templates."
+        description "Add GitHub code review and issue templates."
 
         on "--[no-]git_hub"
 
         default { Container[:settings].build_git_hub }
 
-        def call(value = nil) = settings.build_git_hub = value
+        def call(boolean) = settings.build_git_hub = boolean
       end
     end
   end

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

@@ -9,13 +9,13 @@ module Rubysmith
       class GitHubCI < Sod::Action
         include Import[:settings]
 
-        description "Add GitHub continuous integration."
+        description "Add GitHub continuous integration support."
 
         on "--[no-]git_hub_ci"
 
         default { Container[:settings].build_git_hub_ci }
 
-        def call(value = nil) = settings.build_git_hub_ci = value
+        def call(boolean) = settings.build_git_hub_ci = boolean
       end
     end
   end

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

@@ -15,7 +15,7 @@ module Rubysmith
 
         default { Container[:settings].build_git_lint }
 
-        def call(value = nil) = settings.build_git_lint = value
+        def call(boolean) = settings.build_git_lint = boolean
       end
     end
   end

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

@@ -17,7 +17,7 @@ module Rubysmith
 
         default { Container[:settings].build_guard }
 
-        def call(value = nil) = settings.build_guard = value
+        def call(boolean) = settings.build_guard = boolean
       end
     end
   end

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

@@ -15,7 +15,7 @@ module Rubysmith
 
         default { Container[:settings].build_irb_kit }
 
-        def call(value = nil) = settings.build_irb_kit = value
+        def call(boolean) = settings.build_irb_kit = boolean
       end
     end
   end