hanamismith 1.9.0 → 1.11.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d1d15f62423c7145f26fb391000e14852da8584671697e05c8a47466fa8aeede
-  data.tar.gz: d6ea33248d186e29d468e6ad2c53dfca29be1835f14f6efc19cc720a8912cb89
+  metadata.gz: 99d8a44f11d0435d1a4a42b5fe9cccb713ffa2cea43da1ce7291cfaabc926b17
+  data.tar.gz: 0e802783aededd9c3779551d0204f8ad246615940586c3eb60262a8fc29caaf1
 SHA512:
-  metadata.gz: 2b57fa52c6a81f4b9f80b77b08a13c26194a802a4843c387e3830bb7be4f55d3a1f4ba617c7dc95ea7f27d221a19c6679f5c16e7922752ee151021eedd8cbd9d
-  data.tar.gz: 0f849fda00afed8e14432527b96110efb11f448d741cf2c1ce9342ab3ba65fa658745d6481d647f149fb225f855353d4cb8d12b18e2f5e2951efda8b72fa1f90
+  metadata.gz: f3d77a113ad86e3a95528667b2c5c217a3580b0a7fc4f27a899e02335c7a9a92a688fc1bed007f0ca29afcfcac434cf5c591f49565016c1b7696210357b7b4b0
+  data.tar.gz: 949f259fc32d8fad670a2c8d0ee627817c87348a66699298899b80d7a5347cf18f6c73157f20b78f9350852a7d36d13b4e609743ced1c6bae5bd444d035de11a

data/README.adoc

@@ -7,8 +7,10 @@
 :dotenv_link: link:https://github.com/bkeepers/dotenv[Dotenv]
 :dotfiles_link: link:https://alchemists.io/projects/dotfiles[Dotfiles]
 :hanami_link: link:https://hanamirb.org[Hanami]
-:htmx_link: link:https://alchemists.io/projects/htmx[HTMX]
+:htmx_gem_link: link:https://alchemists.io/projects/htmx[HTMX]
+:htmx_link: link:https://htmx.org[htmx]
 :pg_link: link:https://github.com/ged/ruby-pg[pg]
+:postgresql_link: link:https://www.postgresql.org[PostgreSQL]
 :puma_link: link:https://puma.io[Puma]
 :rack_link: link:https://github.com/rack/rack[Rack]
 :rom_link: link:https://rom-rb.org[ROM]
@@ -22,18 +24,18 @@ toc::[]
 
 == Features
 
-* Built atop {rubysmith_link} for building project skeleton.
+* Built atop {rubysmith_link} for building project skeletons.
 * Uses {hanami_link} for web application development.
-* Uses {htmx_link} for Hypermedia REST so you can write less code and avoid bloated JavaScript stacks.
-* Uses {pg_link} coupled with {rom_link} for database management.
+* Uses {htmx_link} (along with the {htmx_gem_link} gem) for Hypermedia REST so you can write less code and avoid bloated JavaScript stacks.
+* Uses {postgresql_link} for the database, {pg_link} for the client, and {rom_link} Ruby object mapper.
 * Uses {rack_link}, specifically: link:https://github.com/rack/rack-attack[Rack::Attack], `Rack::Deflater`, and `Rack::Static`.
-* Uses {puma_link} as the default web server and fully configured for local and production environments.
+* Uses {puma_link} for the web server including being fully configured for local and production environments.
 * Uses {capybara_link} with {cuprite_link} (driver) for full, headless, feature testing.
 * Uses {dotenv_link} for managing your environment configurations.
 * Provides support for Continuous Integration systems like link:https://circleci.com[Circle CI] (default) and link:https://docs.github.com/en/actions[GitHub Actions].
 * Provides the `/up` health check endpoint via the `Health` slice.
 * Configures link:https://github.com/ruby/ruby/blob/master/doc/yjit/yjit.md[YJIT] so you can deploy with YJIT disabled (i.e. `RUBYOPT=--yjit-disable --yjit-exec-mem-size=192`) and let the application enable upon boot.
-* Disables link:https://github.com/ruby/irb[IRB] console autocomplete when used in production-like environments. You can re-enable IRB autocomplete by setting `IRB_USE_AUTOCOMPLETE=true` before launching your console in non development or test environments.
+* Ensures link:https://github.com/ruby/irb[IRB] console autocomplete is disabled when used in production-like environments. You can re-enable IRB autocomplete by setting `IRB_USE_AUTOCOMPLETE=true` before launching your console in non development or test environments.
 
 == Screenshots/Screencasts
 

data/hanamismith.gemspec

@@ -2,7 +2,7 @@
 
 Gem::Specification.new do |spec|
   spec.name = "hanamismith"
-  spec.version = "1.9.0"
+  spec.version = "1.11.0"
   spec.authors = ["Brooke Kuhlmann"]
   spec.email = ["brooke@alchemists.io"]
   spec.homepage = "https://alchemists.io/projects/hanamismith"
@@ -30,8 +30,8 @@ Gem::Specification.new do |spec|
   spec.add_dependency "etcher", "~> 3.0"
   spec.add_dependency "htmx", "~> 2.0"
   spec.add_dependency "infusible", "~> 4.0"
-  spec.add_dependency "refinements", "~> 13.3"
-  spec.add_dependency "rubysmith", "~> 8.6"
+  spec.add_dependency "refinements", "~> 13.5"
+  spec.add_dependency "rubysmith", "~> 8.7"
   spec.add_dependency "runcom", "~> 12.0"
   spec.add_dependency "sod", "~> 1.0"
   spec.add_dependency "spek", "~> 4.0"

data/lib/hanamismith/builders/asset.rb

@@ -10,7 +10,7 @@ module Hanamismith
 
       def call
         path = "%project_name%/config/assets.js.erb"
-        builder.call(settings.merge(template_path: path)).render
+        builder.call(settings.with(template_path: path)).render
         true
       end
     end

data/lib/hanamismith/builders/binstub.rb

@@ -9,7 +9,7 @@ module Hanamismith
       using Refinements::Struct
 
       def call
-        builder.call(settings.merge(template_path: "%project_name%/bin/hanami.erb"))
+        builder.call(settings.with(template_path: "%project_name%/bin/hanami.erb"))
                .render
                .permit 0o755
 

data/lib/hanamismith/builders/bundler.rb

@@ -52,7 +52,7 @@ module Hanamismith
           gem "dry-validation", "~> 1.10"
           gem "htmx", "~> 2.1"
           gem "overmind", "~> 2.5"
-          gem "puma", "~> 6.6"
+          gem "puma", "~> 7.0"
           gem "rack-attack", "~> 6.7"
         CONTENT
       end
@@ -104,7 +104,7 @@ module Hanamismith
       def remove_zeitwerk = with_template.replace(/.+zeitwerk.+\n\n/, "\n")
 
       def with_template
-        builder.call settings.merge(template_path: "%project_name%/Gemfile.erb")
+        builder.call settings.with(template_path: "%project_name%/Gemfile.erb")
       end
     end
   end

data/lib/hanamismith/builders/caliber.rb

@@ -13,7 +13,7 @@ module Hanamismith
 
         super
         path = "%project_name%/.config/rubocop/config.yml.erb"
-        builder.call(settings.merge(template_path: path))
+        builder.call(settings.with(template_path: path))
                .append("\nplugins: rubocop-sequel\n")
 
         true

data/lib/hanamismith/builders/circle_ci.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 require "refinements/struct"
+require "securerandom"
 
 module Hanamismith
   module Builders
@@ -8,13 +9,27 @@ module Hanamismith
     class CircleCI < Rubysmith::Builders::Abstract
       using Refinements::Struct
 
+      def initialize(generator: SecureRandom, **)
+        @generator = generator
+        super(**)
+      end
+
       def call
         return false unless settings.build_circle_ci
 
         path = "%project_name%/.circleci/config.yml.erb"
-        builder.call(settings.merge(template_path: path)).render.replace(/\n\n\Z/, "\n")
+
+        builder.call(settings.with(template_path: path))
+               .render
+               .replace("<app_secret>", generator.hex(30))
+               .replace(/\n\n\Z/, "\n")
+
         true
       end
+
+      private
+
+      attr_reader :generator
     end
   end
 end

data/lib/hanamismith/builders/console.rb

@@ -12,7 +12,7 @@ module Hanamismith
         return false unless settings.build_console
 
         super
-        builder.call(settings.merge(template_path: "%project_name%/bin/console.erb"))
+        builder.call(settings.with(template_path: "%project_name%/bin/console.erb"))
                .replace(/require Bundler.root.+/, %(require "hanami/prepare"))
 
         add_irb_autocomplete
@@ -33,7 +33,7 @@ module Hanamismith
       end
 
       def with_template
-        builder.call settings.merge(template_path: "%project_name%/bin/console.erb")
+        builder.call settings.with(template_path: "%project_name%/bin/console.erb")
       end
     end
   end

data/lib/hanamismith/builders/core.rb

@@ -16,63 +16,62 @@ module Hanamismith
       private
 
       def add_db_relation
-        builder.call(settings.merge(template_path: "%project_name%/app/db/relation.rb.erb")).render
+        builder.call(settings.with(template_path: "%project_name%/app/db/relation.rb.erb")).render
       end
 
       def add_db_repository
-        builder.call(settings.merge(template_path: "%project_name%/app/db/repository.rb.erb"))
-               .render
+        builder.call(settings.with(template_path: "%project_name%/app/db/repository.rb.erb")).render
       end
 
       def add_db_struct
-        builder.call(settings.merge(template_path: "%project_name%/app/db/struct.rb.erb")).render
+        builder.call(settings.with(template_path: "%project_name%/app/db/struct.rb.erb")).render
       end
 
       def add_action
-        builder.call(settings.merge(template_path: "%project_name%/app/action.rb.erb")).render
+        builder.call(settings.with(template_path: "%project_name%/app/action.rb.erb")).render
       end
 
       def add_view
-        builder.call(settings.merge(template_path: "%project_name%/app/view.rb.erb")).render
+        builder.call(settings.with(template_path: "%project_name%/app/view.rb.erb")).render
       end
 
       def add_application_configuration
-        builder.call(settings.merge(template_path: "%project_name%/config/app.rb.erb")).render
+        builder.call(settings.with(template_path: "%project_name%/config/app.rb.erb")).render
       end
 
       def add_routes_configuration
-        builder.call(settings.merge(template_path: "%project_name%/config/routes.rb.erb")).render
+        builder.call(settings.with(template_path: "%project_name%/config/routes.rb.erb")).render
       end
 
       def add_settings_configuration
-        builder.call(settings.merge(template_path: "%project_name%/config/settings.rb.erb")).render
+        builder.call(settings.with(template_path: "%project_name%/config/settings.rb.erb")).render
       end
 
       def add_types
         path = "%project_name%/lib/%project_path%/types.rb.erb"
-        builder.call(settings.merge(template_path: path)).render
+        builder.call(settings.with(template_path: path)).render
       end
 
       def add_migrate_directory
-        builder.call(settings.merge(template_path: "%project_name%/db/migrate")).make_path
+        builder.call(settings.with(template_path: "%project_name%/db/migrate")).make_path
       end
 
       def add_well_known_security_text
         return unless settings.build_security
 
         path = "%project_name%/public/.well-known/security.txt.erb"
-        builder.call(settings.merge(template_path: path)).render
+        builder.call(settings.with(template_path: path)).render
       end
 
       def add_public_http_errors
         %w[404 500].each do |code|
           path = "%project_name%/public/#{code}.html.erb"
-          builder.call(settings.merge(template_path: path)).render
+          builder.call(settings.with(template_path: path)).render
         end
       end
 
       def add_temp_directory
-        builder.call(settings.merge(template_path: "%project_name%/tmp")).make_path
+        builder.call(settings.with(template_path: "%project_name%/tmp")).make_path
       end
     end
   end

data/lib/hanamismith/builders/docker/compose.rb

@@ -12,7 +12,7 @@ module Hanamismith
         def call
           return false unless settings.build_docker
 
-          builder.call(settings.merge(template_path: "%project_name%/compose.yml.erb")).render
+          builder.call(settings.with(template_path: "%project_name%/compose.yml.erb")).render
           true
         end
       end

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

@@ -12,7 +12,7 @@ module Hanamismith
         def call
           return false unless settings.build_docker
 
-          builder.call(settings.merge(template_path: "%project_name%/Dockerfile.erb")).render
+          builder.call(settings.with(template_path: "%project_name%/Dockerfile.erb")).render
           true
         end
       end

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

@@ -13,7 +13,7 @@ module Hanamismith
           return false unless settings.build_readme
 
           super
-          builder.call(settings.merge(template_path: "%project_name%/README.#{kind}.erb"))
+          builder.call(settings.with(template_path: "%project_name%/README.#{kind}.erb"))
                  .replace("Rubysmith", "Hanamismith")
                  .replace("rubysmith", "hanamismith")
 

data/lib/hanamismith/builders/environments/all.rb

@@ -16,9 +16,10 @@ module Hanamismith
         end
 
         def call
-          builder.call(settings.merge(template_path: "%project_name%/env.erb"))
+          builder.call(settings.with(template_path: "%project_name%/env.erb"))
                  .render
-                 .replace("<password>", generator.hex(15))
+                 .replace("<app_secret>", generator.hex(40))
+                 .replace("<pg_password>", generator.hex(15))
                  .rename(".env")
 
           true

data/lib/hanamismith/builders/environments/development.rb

@@ -10,7 +10,7 @@ module Hanamismith
         using Refinements::Struct
 
         def call
-          builder.call(settings.merge(template_path: "%project_name%/env.development.erb"))
+          builder.call(settings.with(template_path: "%project_name%/env.development.erb"))
                  .render
                  .rename(".env.development")
 

data/lib/hanamismith/builders/environments/test.rb

@@ -10,7 +10,7 @@ module Hanamismith
         using Refinements::Struct
 
         def call
-          builder.call(settings.merge(template_path: "%project_name%/env.test.erb"))
+          builder.call(settings.with(template_path: "%project_name%/env.test.erb"))
                  .render
                  .rename(".env.test")
 

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

@@ -13,7 +13,7 @@ module Hanamismith
           return false unless settings.build_git
 
           super
-          builder.call(settings.merge(template_path: "%project_name%/.gitignore.erb"))
+          builder.call(settings.with(template_path: "%project_name%/.gitignore.erb"))
                  .insert_before "tmp\n", <<~CONTENT
                    node_modules
                    public/assets

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

@@ -13,7 +13,7 @@ module Hanamismith
           return false unless settings.build_git_hub_ci
 
           path = "%project_name%/.github/workflows/ci.yml.erb"
-          builder.call(settings.merge(template_path: path)).render.replace(/\n\n\Z/, "\n")
+          builder.call(settings.with(template_path: path)).render.replace(/\n\n\Z/, "\n")
           true
         end
       end

data/lib/hanamismith/builders/icon.rb

@@ -10,7 +10,7 @@ module Hanamismith
 
       def call
         path = "%project_name%/app/assets/images/icon.svg.erb"
-        builder.call(settings.merge(template_path: path)).render
+        builder.call(settings.with(template_path: path)).render
         true
       end
     end

data/lib/hanamismith/builders/javascript.rb

@@ -10,7 +10,7 @@ module Hanamismith
 
       def call
         path = "%project_name%/app/assets/js/app.js.erb"
-        builder.call(settings.merge(template_path: path)).render
+        builder.call(settings.with(template_path: path)).render
         true
       end
     end

data/lib/hanamismith/builders/layout.rb

@@ -10,19 +10,33 @@ module Hanamismith
 
       def call
         path = "%project_name%/app/templates/layouts/app.html.erb.erb"
-        builder.call(settings.merge(template_path: path))
+        builder.call(settings.with(template_path: path))
                .render
                .replace("<!-- title -->", "<%= content_for :title %>")
+               .replace("<!-- favicon -->", favicon)
                .replace("<!-- icon -->", icon)
+               .replace("<!-- apple_icon -->", apple_icon)
                .replace("<!-- manifest -->", manifest)
                .replace("<!-- stylesheet -->", stylesheet)
+               .replace("<!-- javascript -->", javascript)
                .replace("<!-- yield -->", "<%= yield %>")
+               .replace("<!-- flash:alert -->", flash(:alert))
+               .replace("<!-- flash:notice -->", flash(:notice))
 
         true
       end
 
       private
 
+      def favicon
+        uri = "https://alchemists.io/images/projects/hanamismith/icons/favicon.ico"
+
+        %(<%= tag.link title: "#{settings.project_label}: Favicon",\n) +
+          %(                 rel: :icon,\n) +
+          %(                 href: "#{uri}",\n) +
+          %(                 sizes: "32x32" %>)
+      end
+
       def icon
         %(<%= tag.link title: "#{settings.project_label}: Icon",\n) +
           %(                 rel: :icon,\n) +
@@ -30,6 +44,24 @@ module Hanamismith
           %(                 type: "image/svg+xml" %>)
       end
 
+      def apple_icon
+        uri = "https://alchemists.io/images/projects/hanamismith/icons/apple.png"
+
+        %(<%= tag.link title: "#{settings.project_label}: Apple Icon",\n) +
+          %(                 rel: "apple-touch-icon",\n) +
+          %(                 href: "#{uri}",\n) +
+          %(                 type: "image/png" %>)
+      end
+
+      # :reek:UtilityFunction
+      def flash kind
+        %(<% if flash[:#{kind}] %>\n) +
+          %(      <div class="site-#{kind}">\n) +
+          %(        <p><%= flash[:#{kind}] %></p>\n) +
+          %(      </div>\n) +
+          %(    <% end %>\n)
+      end
+
       def manifest
         %(<%= tag.link title: "#{settings.project_label}: Manifest",\n) +
           %(                 rel: :manifest,\n) +
@@ -40,6 +72,8 @@ module Hanamismith
         %(<%= tag.link title: "#{settings.project_label}: Stylesheet", rel: :stylesheet, ) +
           %(href: app_assets["app.css"] %>)
       end
+
+      def javascript = %(<%= tag.script src: app_assets["app.js"], type: "text/javascript" %>)
     end
   end
 end

data/lib/hanamismith/builders/node.rb

@@ -20,7 +20,7 @@ module Hanamismith
 
       def call
         build_version
-        builder.call(settings.merge(template_path: "%project_name%/package.json.erb")).render
+        builder.call(settings.with(template_path: "%project_name%/package.json.erb")).render
         true
       end
 

data/lib/hanamismith/builders/providers/htmx.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+require "refinements/struct"
+
+module Hanamismith
+  module Builders
+    module Providers
+      # Builds project skeleton for HTMX provider.
+      class HTMX < Rubysmith::Builders::Abstract
+        using Refinements::Struct
+
+        def call
+          path = "%project_name%/config/providers/htmx.rb.erb"
+          builder.call(settings.with(template_path: path)).render
+          true
+        end
+      end
+    end
+  end
+end

data/lib/hanamismith/builders/puma/configuration.rb

@@ -10,7 +10,7 @@ module Hanamismith
         using Refinements::Struct
 
         def call
-          builder.call(settings.merge(template_path: "%project_name%/config/puma.rb.erb")).render
+          builder.call(settings.with(template_path: "%project_name%/config/puma.rb.erb")).render
 
           true
         end

data/lib/hanamismith/builders/puma/procfile.rb

@@ -10,8 +10,8 @@ module Hanamismith
         using Refinements::Struct
 
         def call
-          builder.call(settings.merge(template_path: "%project_name%/Procfile.erb")).render
-          builder.call(settings.merge(template_path: "%project_name%/Procfile.dev.erb")).render
+          builder.call(settings.with(template_path: "%project_name%/Procfile.erb")).render
+          builder.call(settings.with(template_path: "%project_name%/Procfile.dev.erb")).render
           true
         end
       end

data/lib/hanamismith/builders/pwa.rb

@@ -10,7 +10,7 @@ module Hanamismith
 
       def call
         path = "%project_name%/app/assets/pwa/manifest.webmanifest.erb"
-        builder.call(settings.merge(template_path: path)).render
+        builder.call(settings.with(template_path: path)).render
         true
       end
     end

data/lib/hanamismith/builders/rack/attack.rb

@@ -19,11 +19,11 @@ module Hanamismith
 
         def add_configuration
           template_path = "%project_name%/config/initializers/rack_attack.rb.erb"
-          builder.call(settings.merge(template_path:)).render
+          builder.call(settings.with(template_path:)).render
         end
 
         def add_middleware
-          builder.call(settings.merge(template_path: "%project_name%/config/app.rb.erb"))
+          builder.call(settings.with(template_path: "%project_name%/config/app.rb.erb"))
                  .insert_after(/require/, %(\nrequire_relative "initializers/rack_attack"\n))
                  .insert_before(/environment/, "    config.middleware.use Rack::Attack\n\n")
         end

data/lib/hanamismith/builders/rack/configuration.rb

@@ -10,7 +10,7 @@ module Hanamismith
         using Refinements::Struct
 
         def call
-          builder.call(settings.merge(template_path: "%project_name%/config.ru.erb")).render
+          builder.call(settings.with(template_path: "%project_name%/config.ru.erb")).render
           true
         end
       end

data/lib/hanamismith/builders/rack/deflater.rb

@@ -10,7 +10,7 @@ module Hanamismith
         using Refinements::Struct
 
         def call
-          builder.call(settings.merge(template_path: "%project_name%/config/app.rb.erb"))
+          builder.call(settings.with(template_path: "%project_name%/config/app.rb.erb"))
                  .insert_after(/Rack::Attack/, "    config.middleware.use Rack::Deflater\n")
 
           true

data/lib/hanamismith/builders/rake/configuration.rb

@@ -13,7 +13,7 @@ module Hanamismith
           return false unless settings.build_rake
 
           super
-          builder.call(settings.merge(template_path: "%project_name%/Rakefile.erb"))
+          builder.call(settings.with(template_path: "%project_name%/Rakefile.erb"))
                  .render
                  .insert_after(%r(bundler/setup), %(require "hanami/rake_tasks"))
 

data/lib/hanamismith/builders/refinement.rb

@@ -13,7 +13,7 @@ module Hanamismith
           %project_name%/lib/%project_path%/refines/actions/response.rb.erb
           %project_name%/spec/lib/%project_path%/refines/actions/response_spec.rb.erb
         ].each do |path|
-          builder.call(settings.merge(template_path: path)).render
+          builder.call(settings.with(template_path: path)).render
         end
 
         true

data/lib/hanamismith/builders/rspec/application_shared_context.rb

@@ -13,7 +13,7 @@ module Hanamismith
           return false unless settings.build_rspec
 
           path = "%project_name%/spec/support/shared_contexts/application.rb.erb"
-          builder.call(settings.merge(template_path: path)).render
+          builder.call(settings.with(template_path: path)).render
 
           true
         end

data/lib/hanamismith/builders/rspec/hanami.rb

@@ -13,7 +13,7 @@ module Hanamismith
           return false unless settings.build_rspec
 
           path = "%project_name%/spec/hanami_helper.rb.erb"
-          builder.call(settings.merge(template_path: path)).render
+          builder.call(settings.with(template_path: path)).render
 
           true
         end

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

@@ -11,7 +11,7 @@ module Hanamismith
 
         def initialize(...)
           super
-          @template = builder.call settings.merge(
+          @template = builder.call settings.with(
             template_path: "%project_name%/spec/spec_helper.rb.erb"
           )
         end

data/lib/hanamismith/builders/setup.rb

@@ -19,7 +19,7 @@ module Hanamismith
       private
 
       def append
-        builder.call(settings.merge(template_path: "%project_name%/bin/setup.erb"))
+        builder.call(settings.with(template_path: "%project_name%/bin/setup.erb"))
                .insert_after(%(Runner.call "bundle install"\n), <<~CONTENT.gsub(/^(?=\w)/, "  "))
 
                  puts "Installing packages..."