rubysmith 7.2.0 → 7.4.0

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_docker
+
+          builder.call(settings.merge(template_path: "%project_name%/.dockerignore.erb")).render
+          true
+        end
+      end
+    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/circle_ci.rb

@@ -9,7 +9,7 @@ module Rubysmith
       class CircleCI < Sod::Action
         include Import[:settings]
 
-        description "Add Circle CI settings."
+        description "Add Circle CI support."
 
         on "--[no-]circle_ci"
 

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/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,7 +9,7 @@ module Rubysmith
       class Funding < Sod::Action
         include Import[:settings]
 
-        description "Add GitHub funding settings."
+        description "Add GitHub funding."
 
         on "--[no-]funding"
 

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

@@ -9,7 +9,7 @@ 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"
 

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

@@ -9,7 +9,7 @@ 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"
 

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

@@ -12,7 +12,7 @@ module Rubysmith
 
         using ::Refinements::Struct
 
-        description "Use maximum options."
+        description "Use maximum configuration."
 
         on "--max"
 

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

@@ -12,7 +12,7 @@ module Rubysmith
 
         using ::Refinements::Struct
 
-        description "Use minimum options."
+        description "Use minimum configuration."
 
         on "--min"
 

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

@@ -12,36 +12,44 @@ module Rubysmith
 
         # Order is important.
         BUILDERS = [
-          Builders::Init.new,
-          Builders::Core.new,
-          Builders::Version.new,
-          Builders::Documentation::Readme.new,
-          Builders::Documentation::Citation.new,
-          Builders::Documentation::License.new,
-          Builders::Documentation::Version.new,
-          Builders::Git::Setup.new,
-          Builders::Git::Ignore.new,
-          Builders::Git::Safe.new,
-          Builders::Bundler.new,
-          Builders::Rake::Binstub.new,
-          Builders::Rake::Configuration.new,
-          Builders::Console.new,
-          Builders::CircleCI.new,
-          Builders::Setup.new,
-          Builders::GitHub::Template.new,
-          Builders::GitHub::Funding.new,
-          Builders::GitHub::CI.new,
-          Builders::Guard.new,
-          Builders::Reek.new,
-          Builders::RSpec::Binstub.new,
-          Builders::RSpec::Context.new,
-          Builders::RSpec::Helper.new,
-          Builders::Caliber.new,
-          Extensions::Bundler.new,
-          Extensions::Pragmater.new,
-          Extensions::Tocer.new,
-          Extensions::Rubocop.new,
-          Builders::Git::Commit.new
+          Builders::Init,
+          Builders::Core,
+          Builders::Version,
+          Builders::Documentation::Readme,
+          Builders::Documentation::Citation,
+          Builders::Documentation::License,
+          Builders::Documentation::Version,
+          Builders::Git::Setup,
+          Builders::Git::Ignore,
+          Builders::Git::Safe,
+          Builders::Bundler,
+          Builders::Rake::Binstub,
+          Builders::Rake::Configuration,
+          Builders::Console,
+          Builders::CircleCI,
+          Builders::Setup,
+          Builders::GitHub::Template,
+          Builders::GitHub::Funding,
+          Builders::GitHub::CI,
+          Builders::Guard,
+          Builders::Reek,
+          Builders::RSpec::Binstub,
+          Builders::RSpec::Context,
+          Builders::RSpec::Helper,
+          Builders::Caliber,
+          Builders::DevContainer::Dockerfile,
+          Builders::DevContainer::Compose,
+          Builders::DevContainer::Configuration,
+          Builders::Docker::Build,
+          Builders::Docker::Console,
+          Builders::Docker::Entrypoint,
+          Builders::Docker::File,
+          Builders::Docker::Ignore,
+          Extensions::Bundler,
+          Extensions::Pragmater,
+          Extensions::Tocer,
+          Extensions::Rubocop,
+          Builders::Git::Commit
         ].freeze
 
         handle "build"
@@ -50,14 +58,18 @@ module Rubysmith
 
         on Actions::Name
         on Actions::AmazingPrint
+        on Actions::Bootsnap
         on Actions::Caliber
-        on Actions::Console
-        on Actions::Contributions
         on Actions::CircleCI
         on Actions::Citation
         on Actions::Community
         on Actions::Conduct
+        on Actions::Console
+        on Actions::Contributions
+        on Actions::DCOO
         on Actions::Debug
+        on Actions::DevContainer
+        on Actions::Docker
         on Actions::Funding
         on Actions::Git
         on Actions::GitHub
@@ -87,7 +99,7 @@ module Rubysmith
 
         def call
           log_info "Building project skeleton: #{settings.project_name}..."
-          builders.each(&:call)
+          builders.each { |builder| builder.new(settings:, logger:).call }
           log_info "Project skeleton complete!"
         end
 

data/lib/rubysmith/configuration/contract.rb

@@ -14,6 +14,7 @@ module Rubysmith
       required(:author_handle).filled :string
       required(:author_uri).filled :string
       required(:build_amazing_print).filled :bool
+      required(:build_bootsnap).filled :bool
       required(:build_caliber).filled :bool
       required(:build_circle_ci).filled :bool
       required(:build_citation).filled :bool
@@ -22,7 +23,10 @@ module Rubysmith
       required(:build_conduct).filled :bool
       required(:build_console).filled :bool
       required(:build_contributions).filled :bool
+      required(:build_dcoo).filled :bool
       required(:build_debug).filled :bool
+      required(:build_devcontainer).filled :bool
+      required(:build_docker).filled :bool
       required(:build_funding).filled :bool
       required(:build_git).filled :bool
       required(:build_git_hub).filled :bool
@@ -52,11 +56,13 @@ module Rubysmith
       required(:license_label).filled :string
       required(:license_name).filled :string
       required(:license_version).filled :string
+      optional(:organization_label).filled :string
       required(:organization_uri).filled :string
       optional(:project_name).filled :string
       optional(:project_uri_community).filled :string
       optional(:project_uri_conduct).filled :string
       optional(:project_uri_contributions).filled :string
+      optional(:project_uri_dcoo).filled :string
       optional(:project_uri_download).filled :string
       optional(:project_uri_funding).filled :string
       optional(:project_uri_home).filled :string

data/lib/rubysmith/configuration/defaults.yml

@@ -3,6 +3,7 @@ author:
   uri: "%<organization_uri>s/team/%<author_handle>s"
 build:
   amazing_print: true
+  bootsnap: false
   caliber: true
   circle_ci: false
   citation: true
@@ -11,7 +12,10 @@ build:
   conduct: true
   console: true
   contributions: true
+  dcoo: false
   debug: true
+  devcontainer: false
+  docker: false
   funding: false
   git: true
   git_hub: false
@@ -34,6 +38,7 @@ build:
   versions: true
   zeitwerk: true
 citation:
+  affiliation: "%<organization_label>s"
   message: Please use the following metadata when citing this project in your work.
 documentation:
   format: "adoc"
@@ -48,6 +53,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"

data/lib/rubysmith/configuration/model.rb

@@ -15,6 +15,7 @@ module Rubysmith
       :author_handle,
       :author_uri,
       :build_amazing_print,
+      :build_bootsnap,
       :build_caliber,
       :build_circle_ci,
       :build_citation,
@@ -23,7 +24,10 @@ module Rubysmith
       :build_conduct,
       :build_console,
       :build_contributions,
+      :build_dcoo,
       :build_debug,
+      :build_devcontainer,
+      :build_docker,
       :build_funding,
       :build_git,
       :build_git_hub,
@@ -53,11 +57,13 @@ module Rubysmith
       :license_name,
       :license_version,
       :loaded_at,
+      :organization_label,
       :organization_uri,
       :project_name,
       :project_uri_community,
       :project_uri_conduct,
       :project_uri_contributions,
+      :project_uri_dcoo,
       :project_uri_download,
       :project_uri_funding,
       :project_uri_home,
@@ -103,6 +109,8 @@ module Rubysmith
 
       def computed_project_uri_contributions = format_uri(__method__)
 
+      def computed_project_uri_dcoo = format_uri(__method__)
+
       def computed_project_uri_download = format_uri(__method__)
 
       def computed_project_uri_funding = format_uri(__method__)

data/lib/rubysmith/container.rb

@@ -22,9 +22,11 @@ module Rubysmith
                       .add_transformer(Configuration::Transformers::TemplateRoot.new)
                       .add_transformer(:root, :target_root)
                       .add_transformer(:format, :author_uri)
+                      .add_transformer(:format, :citation_affiliation)
                       .add_transformer(:format, :project_uri_community)
                       .add_transformer(:format, :project_uri_conduct)
                       .add_transformer(:format, :project_uri_contributions)
+                      .add_transformer(:format, :project_uri_dcoo)
                       .add_transformer(:format, :project_uri_download, :project_name)
                       .add_transformer(:format, :project_uri_funding)
                       .add_transformer(:format, :project_uri_home, :project_name)

data/lib/rubysmith/extensions/bundler.rb

@@ -9,7 +9,7 @@ module Rubysmith
   module Extensions
     # Ensures gem dependencies are installed.
     class Bundler
-      include Import[:settings]
+      include Import[:settings, :logger]
 
       using Refinements::IO
       using Refinements::Pathname
@@ -20,6 +20,17 @@ module Rubysmith
       end
 
       def call
+        logger.info { "Installing gem dependencies..." }
+        install
+      rescue ::Bundler::HTTPError
+        log_error
+      end
+
+      private
+
+      attr_reader :client
+
+      def install
         settings.project_root.change_dir do
           client.start %w[install --quiet]
           STDOUT.squelch { client.start %w[lock --add-platform x86_64-linux --update] }
@@ -28,9 +39,10 @@ module Rubysmith
         true
       end
 
-      private
-
-      attr_reader :client
+      def log_error
+        logger.error { "Unable to install gem dependencies. Is your network stable?" }
+        false
+      end
     end
   end
 end

data/lib/rubysmith/extensions/pragmater.rb

@@ -7,14 +7,27 @@ module Rubysmith
   module Extensions
     # Ensures project skeleton has pragmas.
     class Pragmater
-      include Import[:settings]
+      include Import[:settings, :logger]
 
       using Refinements::Pathname
 
       CLIENT = ::Pragmater::Inserter.new(
         settings: ::Pragmater::Configuration::Model[
           comments: ["# frozen_string_literal: true"],
-          patterns: %w[**/*.rake **/*.rb *.gemspec exe/* bin/* config.ru *file]
+          patterns: %w[
+            **/*.rake
+            **/*.rb
+            *.gemspec
+            exe/*
+            bin/console
+            bin/rake
+            bin/rspec
+            bin/rubocop
+            bin/setup
+            config.ru
+            Gemfile
+            Rakefile
+          ]
         ]
       ).freeze
 
@@ -24,6 +37,7 @@ module Rubysmith
       end
 
       def call
+        logger.info { "Adding frozen string literal pragmas..." }
         settings.project_root.change_dir { client.call }
         true
       end

data/lib/rubysmith/extensions/rubocop.rb

@@ -8,7 +8,7 @@ module Rubysmith
   module Extensions
     # Ensures project skeleton adheres to style guide.
     class Rubocop
-      include Import[:settings]
+      include Import[:settings, :logger]
 
       using Refinements::IO
       using Refinements::Pathname
@@ -19,18 +19,22 @@ module Rubysmith
       end
 
       def call
-        project_root = settings.project_root
-
-        project_root.change_dir do
-          STDOUT.squelch { client.run ["--autocorrect-all", project_root.to_s] }
-        end
-
+        logger.info { "Running RuboCop autocorrect..." }
+        autocorrect
         true
       end
 
       private
 
       attr_reader :client
+
+      def autocorrect
+        project_root = settings.project_root
+
+        project_root.change_dir do
+          STDOUT.squelch { client.run ["--autocorrect-all", project_root.to_s] }
+        end
+      end
     end
   end
 end

data/lib/rubysmith/extensions/tocer.rb

@@ -1,31 +1,35 @@
 # frozen_string_literal: true
 
 require "refinements/pathname"
+require "stringio"
 require "tocer"
 
 module Rubysmith
   module Extensions
     # Ensures project skeleton documentation has table of content.
     class Tocer
-      include Import[:settings]
+      include Import[:settings, :logger]
 
       using Refinements::Pathname
 
-      def initialize(client: ::Tocer::Runner.new, **)
+      def initialize(client: ::Tocer::Runner.new(io: StringIO.new), **)
         @client = client
         super(**)
       end
 
       def call
-        return false unless settings.build_readme
+        return false unless settings.build_readme && settings.markdown?
 
-        settings.project_root.change_dir { client.call }
+        logger.info { "Adding table of contents..." }
+        upsert
         true
       end
 
       private
 
       attr_reader :client
+
+      def upsert = settings.project_root.change_dir { client.call }
     end
   end
 end

data/lib/rubysmith/templates/%project_name%/.devcontainer/Dockerfile.erb

@@ -0,0 +1 @@
+FROM bkuhlmann/alpine-ruby:latest

data/lib/rubysmith/templates/%project_name%/.devcontainer/compose.yaml.erb

@@ -0,0 +1,35 @@
+name: "<%= settings.project_name %>"
+
+services:
+  app:
+    build:
+      context: ..
+      dockerfile: .devcontainer/Dockerfile
+    volumes:
+      - ../..:/workspaces:cached
+    environment:
+      DATABASE_URL: postgres://postgres:postgres@postgres:5432/postgres
+    command: sleep infinity
+    depends_on:
+      - postgres
+      - redis
+
+  postgres:
+    image: postgres:latest
+    restart: unless-stopped
+    volumes:
+      - postgres-data:/var/lib/postgresql/data
+    environment:
+      POSTGRES_USER: postgres
+      POSTGRES_DB: postgres
+      POSTGRES_PASSWORD: postgres
+
+  redis:
+    image: redis:latest
+    restart: unless-stopped
+    volumes:
+      - redis-data:/data
+
+volumes:
+  postgres-data:
+  redis-data: