hanamismith 1.12.0 → 1.13.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4b5e8109a939f5ccabf64c02342735ef9f8ac8977d89b7afdf59b4da83abcabb
-  data.tar.gz: b98bdcdf6ea97b081cebab354d7708fc7a3a2ce13f4906e5fc2323622fde4854
+  metadata.gz: 87776c02595114ae39a7d0c425c7f9dc1d5b9ff333e0e09de68372658e77cedc
+  data.tar.gz: 549dd6871dafc8b0e94202bc7de49389489f92971cfbd620ba621ddfc41f7f58
 SHA512:
-  metadata.gz: 85d98a0302f03e9b52bf1f610eddff4669a39b201415f15785b89e5a51c96cfb70518917e2d58df44d75a43a2ff17993d253cfeeee6dda5eea98d8584dfe33ef
-  data.tar.gz: 13d1e2b5565352a970b265d8f0ee23d6ad84afe2e9cc938b9e4638bb896cf3805a19dd110fa3c82df774863ef3885b3a9d2fe052c1ce9a828ef198ff6cdab20c
+  metadata.gz: 3f748c097fe691ec3ba89b66585c5d53aee1741e2a4d686728f6f34f42864a7b854320718e158bc4be7a4c7520ce156316fd468bd646d0c997d754b9aed2c40e
+  data.tar.gz: e648dd2a4bf625fe551a244ab478e36a64fc94132869b5c04f3003a68ef1ef44ad977be3c740d1fb67e0434b3d87dd0b632e5e413d5d5008d20c0de9c13b5a62

data/hanamismith.gemspec

@@ -2,7 +2,7 @@
 
 Gem::Specification.new do |spec|
   spec.name = "hanamismith"
-  spec.version = "1.12.0"
+  spec.version = "1.13.0"
   spec.authors = ["Brooke Kuhlmann"]
   spec.email = ["brooke@alchemists.io"]
   spec.homepage = "https://alchemists.io/projects/hanamismith"

data/lib/hanamismith/builders/bundler.rb

@@ -35,13 +35,13 @@ module Hanamismith
 
       def insert_hanami
         with_template.insert_after "source", <<~CONTENT.strip
-          gem "hanami", "~> 2.2.0"
-          gem "hanami-assets", "~> 2.2.0"
-          gem "hanami-controller", "~> 2.2.0"
-          gem "hanami-db", "~> 2.2.0"
-          gem "hanami-router", "~> 2.2.0"
-          gem "hanami-validations", "~> 2.2.0"
-          gem "hanami-view", "~> 2.2.0"
+          gem "hanami", "~> 2.3"
+          gem "hanami-assets", "~> 2.3"
+          gem "hanami-controller", "~> 2.3"
+          gem "hanami-db", "~> 2.3"
+          gem "hanami-router", "~> 2.3"
+          gem "hanami-validations", "~> 2.3"
+          gem "hanami-view", "~> 2.3"
         CONTENT
       end
 
@@ -83,7 +83,7 @@ module Hanamismith
 
       def insert_development
         with_template.insert_after(/group :development do/, <<~CONTENT.gsub("gem", "  gem"))
-          gem "hanami-webconsole", "~> 2.2.0"
+          gem "hanami-webconsole", "~> 2.3"
           gem "localhost", "~> 1.3"
           gem "rerun", "~> 0.14"
         CONTENT

data/lib/hanamismith/builders/caliber.rb

@@ -14,7 +14,12 @@ module Hanamismith
         super
         path = "%project_name%/.config/rubocop/config.yml.erb"
         builder.call(settings.with(template_path: path))
-               .append("\nplugins: rubocop-sequel\n")
+               .append("\nplugins: rubocop-sequel\n\n")
+               .append(<<~CONTENT)
+                 RSpec/SpecFilePathFormat:
+                   CustomTransform:
+                     #{settings.project_namespaced_class}: ""
+               CONTENT
 
         true
       end

data/lib/hanamismith/builders/core.rb

@@ -53,7 +53,7 @@ module Hanamismith
       end
 
       def add_migrate_directory
-        builder.call(settings.with(template_path: "%project_name%/db/migrate")).make_path
+        builder.call(settings.with(template_path: "%project_name%/config/db/migrate")).make_path
       end
 
       def add_well_known_security_text
@@ -70,6 +70,10 @@ module Hanamismith
         end
       end
 
+      def add_log_directory
+        builder.call(settings.with(template_path: "%project_name%/log")).make_path
+      end
+
       def add_temp_directory
         builder.call(settings.with(template_path: "%project_name%/tmp")).make_path
       end

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

@@ -13,14 +13,21 @@ module Hanamismith
           return false unless settings.build_git
 
           super
+          add_entries
+          true
+        end
+
+        private
+
+        def add_entries
           builder.call(settings.with(template_path: "%project_name%/.gitignore.erb"))
                  .insert_before "tmp\n", <<~CONTENT
                    node_modules
-                   public/assets
-                   public/assets.json
+                   public/*
+                   !public/.well-known
+                   !public/404.html
+                   !public/500.html
                  CONTENT
-
-          true
         end
       end
     end

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

@@ -0,0 +1,48 @@
+# frozen_string_literal: true
+
+require "refinements/struct"
+
+module Hanamismith
+  module Builders
+    module Providers
+      # Builds project skeleton for logger provider.
+      class Logger < Rubysmith::Builders::Abstract
+        using Refinements::Struct
+
+        def call
+          build_all
+          add_initializers
+          true
+        end
+
+        private
+
+        def build_all
+          %w[
+            %project_name%/app/providers/logger.rb.erb
+            %project_name%/spec/app/providers/logger_spec.rb.erb
+            %project_name%/config/providers/logger.rb.erb
+            %project_name%/app/aspects/logging/rack_adapter.rb.erb
+            %project_name%/spec/app/aspects/logging/rack_adapter_spec.rb.erb
+            %project_name%/config/initializers/rack_logger_patch.rb.erb
+            %project_name%/config/initializers/sql_logger_patch.rb.erb
+          ].each { build it }
+        end
+
+        def build(path) = builder.call(settings.with(template_path: path)).render
+
+        def add_initializers
+          builder.call(settings.with(template_path: "%project_name%/config/app.rb.erb"))
+                 .insert_after(
+                   /require/,
+                   <<~REQUIRES
+
+                     require_relative "initializers/rack_logger_patch"
+                     require_relative "initializers/sql_logger_patch"
+                   REQUIRES
+                 )
+        end
+      end
+    end
+  end
+end

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

@@ -16,6 +16,7 @@ module Hanamismith
           builder.call(settings.with(template_path: "%project_name%/Rakefile.erb"))
                  .render
                  .insert_after(%r(bundler/setup), %(require "hanami/rake_tasks"))
+                 .insert_after(/RuboCop::RakeTask/, %(\nRake.add_rakelib "lib/tasks"\n))
 
           true
         end

data/lib/hanamismith/builders/reek.rb

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+require "refinements/struct"
+
+module Hanamismith
+  module Builders
+    # Builds project skeleton Reek code quality support.
+    class Reek < Rubysmith::Builders::Reek
+      using Refinements::Struct
+
+      def call
+        return false unless settings.build_reek
+
+        super
+        add_detectors
+        true
+      end
+
+      def add_detectors
+        with_template.insert_after(
+          /enabled:\sfalse\n/,
+          <<~DETECTORS.gsub(/^/, "  ")
+            TooManyStatements:
+              exclude:
+                - RackLoggerPatch#prepare_app_providers
+            UtilityFunction:
+              exclude:
+                - SQLLoggerPatch#log_query
+          DETECTORS
+        )
+      end
+
+      def with_template
+        builder.call settings.with(template_path: "%project_name%/.reek.yml.erb")
+      end
+    end
+  end
+end

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

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

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

@@ -14,6 +14,7 @@ module Hanamismith
           Rubysmith::Builders::Init,
           Builders::Core,
           Builders::Providers::HTMX,
+          Builders::Providers::Logger,
           Builders::Refinement,
           Builders::Icon,
           Builders::Stylesheet,
@@ -42,7 +43,7 @@ module Hanamismith
           Rubysmith::Builders::GitHub::Funding,
           Builders::GitHub::CI,
           Builders::Setup,
-          Rubysmith::Builders::Reek,
+          Builders::Reek,
           Rubysmith::Builders::RSpec::Binstub,
           Rubysmith::Builders::RSpec::Context,
           Builders::RSpec::ApplicationSharedContext,

data/lib/hanamismith/templates/%project_name%/app/aspects/logging/rack_adapter.rb.erb

@@ -0,0 +1,21 @@
+<% namespace do %>
+  module Aspects
+    module Logging
+      # Adapts Cogger Rack middleware for provider registration.
+      module RackAdapter
+        module_function
+
+        def with logger
+          @logger = logger
+          self
+        end
+
+        def new application
+          @application = Cogger::Rack::Logger.new application, {logger: @logger}
+        end
+
+        def call(environment) = @application.call environment
+      end
+    end
+  end
+<% end %>

data/lib/hanamismith/templates/%project_name%/app/providers/logger.rb.erb

@@ -0,0 +1,43 @@
+<% namespace do %>
+  module Providers
+    # The logger provider.
+    class Logger < Hanami::Provider::Source
+      RESOLVER = proc { Object.const_get "Cogger" }
+
+      def initialize(environment: Hanami.env, resolver: RESOLVER, **)
+        @environment = environment
+        @resolver = resolver
+        @id = Hanami.app.namespace.to_s.downcase.to_sym
+        super(**)
+      end
+
+      def prepare = require "cogger"
+
+      def start
+        add_filters
+        register :logger, build_instance
+      end
+
+      private
+
+      attr_reader :environment, :resolver, :id
+
+      def add_filters = cogger.add_filters :api_key, :csrf, :password, :password_confirmation
+
+      def build_instance
+        io = "log/#{environment}.log"
+
+        case environment
+          when :test
+            cogger.new(id:, io: StringIO.new, formatter: :json, level: :debug).add_stream io:
+          when :development then cogger.new(id:).add_stream(io:, formatter: :json)
+          else cogger.new id:, formatter: :json
+        end
+      end
+
+      def cogger
+        @cogger ||= resolver.call
+      end
+    end
+  end
+<% end %>

data/lib/hanamismith/templates/%project_name%/config/initializers/rack_logger_patch.rb.erb

@@ -0,0 +1,21 @@
+require "dry/system"
+
+# Patches Hanami's default providers.
+module RackLoggerPatch
+  def prepare_app_providers
+    require "hanami/providers/inflector"
+
+    logger = Class.new Hanami::Provider::Source do
+      def start
+        slice.start :logger
+        register :monitor, <%= settings.project_namespaced_class %>::Aspects::Logging::RackAdapter.with(slice[:logger])
+      end
+    end
+
+    register_provider :inflector, source: Hanami::Providers::Inflector
+    register_provider :rack, source: logger, namespace: true
+    register_provider :db_logging, source: Hanami::Providers::DBLogging
+  end
+end
+
+Hanami::App::ClassMethods.prepend RackLoggerPatch

data/lib/hanamismith/templates/%project_name%/config/initializers/sql_logger_patch.rb.erb

@@ -0,0 +1,13 @@
+require "dry-monitor"
+require "dry/monitor/sql/logger"
+
+# Patches Hanami's default SQL logger.
+module SQLLoggerPatch
+  def log_query time:, name:, query:
+    # :nocov:
+    Hanami.app[:logger].info { {message: query, tags: [{db: name, duration: time}]} }
+    # :nocov:
+  end
+end
+
+Dry::Monitor::SQL::Logger.prepend SQLLoggerPatch

data/lib/hanamismith/templates/%project_name%/config/providers/logger.rb.erb

@@ -0,0 +1,3 @@
+require_relative "../../app/providers/logger"
+
+Hanami.app.register_provider :logger, source: <%= settings.project_namespaced_class %>::Providers::Logger

data/lib/hanamismith/templates/%project_name%/package.json.erb

@@ -8,7 +8,7 @@
   "type": "module",
   "keywords": ["hanami", "htmx", "ruby"],
   "dependencies": {
-    "hanami-assets": "^2.2.0",
+    "hanami-assets": "^2.3.0",
     "htmx.org": "^2.0.8"
   }
 }

data/lib/hanamismith/templates/%project_name%/spec/app/aspects/logging/rack_adapter_spec.rb.erb

@@ -0,0 +1,34 @@
+require "hanami_helper"
+
+RSpec.describe <%= settings.project_namespaced_class %>::Aspects::Logging::RackAdapter do
+  subject(:adapter) { described_class }
+
+  include_context "with application dependencies"
+
+  let(:application) { proc { [200, {"Content-Type" => "text/plain"}, "test"] } }
+
+  describe ".with" do
+    it "answers itself" do
+      expect(adapter.with(nil)).to eq(adapter)
+    end
+  end
+
+  describe ".new" do
+    it "answers Cogger middleware" do
+      expect(adapter.with(logger).new(application)).to be_a(Cogger::Rack::Logger)
+    end
+  end
+
+  describe ".call" do
+    let(:middleware) { adapter.with(logger).new application }
+
+    it "answers application" do
+      expect(middleware.call({})).to eq([200, {"Content-Type" => "text/plain"}, "test"])
+    end
+
+    it "logs request" do
+      middleware.call({})
+      expect(logger.reread).to match(/level.+INFO.+status.+200/)
+    end
+  end
+end

data/lib/hanamismith/templates/%project_name%/spec/app/providers/logger_spec.rb.erb

@@ -0,0 +1,101 @@
+require "hanami_helper"
+
+RSpec.describe <%= settings.project_namespaced_class %>::Providers::Logger do
+  subject(:provider) { described_class.new provider_container:, target_container:, slice: }
+
+  let(:provider_container) { Dry::Core::Container.new }
+  let(:target_container) { Dry::Core::Container.new }
+  let(:slice) { Hanami.app }
+
+  describe "#prepare" do
+    it "answers false due to already being loaded" do
+      expect(provider.prepare).to be(false)
+    end
+  end
+
+  describe "#start" do
+    let(:cogger) { class_spy Cogger }
+    let(:hub) { instance_spy Cogger::Hub }
+
+    before { allow(cogger).to receive(:new).and_return hub }
+
+    it "adds filters" do
+      provider = described_class.new(
+        environment: :test,
+        resolver: proc { cogger },
+        provider_container:,
+        target_container:,
+        slice:
+      )
+
+      provider.start
+      expect(cogger).to have_received(:add_filters).with(any_args)
+    end
+
+    context "with test environment" do
+      subject :provider do
+        described_class.new environment: :test,
+                            resolver: proc { cogger },
+                            provider_container:,
+                            target_container:,
+                            slice:
+      end
+
+      it "initializes" do
+        provider.start
+
+        expect(cogger).to have_received(:new).with(
+          id: :<%= settings.project_name %>,
+          io: kind_of(StringIO),
+          formatter: :json,
+          level: :debug
+        )
+      end
+
+      it "adds stream" do
+        provider.start
+        expect(hub).to have_received(:add_stream).with(io: "log/test.log")
+      end
+    end
+
+    context "with development environment" do
+      subject :provider do
+        described_class.new environment: :development,
+                            resolver: proc { cogger },
+                            provider_container:,
+                            target_container:,
+                            slice:
+      end
+
+      it "initializes" do
+        provider.start
+        expect(cogger).to have_received(:new).with(id: :<%= settings.project_name %>)
+      end
+
+      it "adds stream" do
+        provider.start
+        expect(hub).to have_received(:add_stream).with(io: "log/development.log", formatter: :json)
+      end
+    end
+
+    context "with any other environment" do
+      subject :provider do
+        described_class.new environment: :production,
+                            resolver: proc { cogger },
+                            provider_container:,
+                            target_container:,
+                            slice:
+      end
+
+      it "initializes" do
+        provider.start
+        expect(cogger).to have_received(:new).with(id: :<%= settings.project_name %>, formatter: :json)
+      end
+    end
+
+    it "registers logger" do
+      provider.start
+      expect(provider_container.key?(:logger)).to be(true)
+    end
+  end
+end

data/lib/hanamismith/templates/%project_name%/spec/hanami_helper.rb.erb

@@ -32,8 +32,8 @@ RSpec.configure do |config|
   config.define_derived_metadata(file_path: %r(/spec/features/)) { it[:type] = :feature }
   config.define_derived_metadata(file_path: %r(/spec/requests/)) { it[:type] = :request }
 
-  config.include_context "with application", type: :request
-  config.include_context "with application", type: :feature
+  config.include_context "with application dependencies", type: :request
+  config.include_context "with application dependencies", type: :feature
 
   databases = proc do
     Hanami.app.slices.with_nested.prepend(Hanami.app).each.with_object Set.new do |slice, dbs|

data/lib/hanamismith/templates/%project_name%/spec/lib/%project_path%/refines/actions/response_spec.rb.erb

@@ -4,7 +4,7 @@ RSpec.describe <%= settings.project_namespaced_class %>::Refines::Actions::Respo
   using described_class
 
   subject :response do
-    config = Class.new(Hanami::Action).config.tap { it.format :json }
+    config = Class.new(Hanami::Action).config.tap { it.formats.accept :json }
     Hanami::Action::Response.new request:, config:
   end
 

data/lib/hanamismith/templates/%project_name%/spec/support/shared_contexts/{application.rb.erb → application_dependencies.rb.erb}

@@ -1,6 +1,7 @@
-RSpec.shared_context "with application" do
+RSpec.shared_context "with application dependencies" do
   let(:app) { Hanami.app }
   let(:json_payload) { JSON last_response.body, symbolize_names: true }
+  let(:logger) { app[:logger] }
   let(:routes) { app[:routes] }
   let(:settings) { app[:settings] }
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: hanamismith
 version: !ruby/object:Gem::Version
-  version: 1.12.0
+  version: 1.13.0
 platform: ruby
 authors:
 - Brooke Kuhlmann
@@ -252,6 +252,7 @@ files:
 - lib/hanamismith/builders/layout.rb
 - lib/hanamismith/builders/node.rb
 - lib/hanamismith/builders/providers/htmx.rb
+- lib/hanamismith/builders/providers/logger.rb
 - lib/hanamismith/builders/puma/configuration.rb
 - lib/hanamismith/builders/puma/procfile.rb
 - lib/hanamismith/builders/pwa.rb
@@ -259,6 +260,7 @@ files:
 - lib/hanamismith/builders/rack/configuration.rb
 - lib/hanamismith/builders/rack/deflater.rb
 - lib/hanamismith/builders/rake/configuration.rb
+- lib/hanamismith/builders/reek.rb
 - lib/hanamismith/builders/refinement.rb
 - lib/hanamismith/builders/rspec/application_shared_context.rb
 - lib/hanamismith/builders/rspec/hanami.rb
@@ -280,6 +282,7 @@ files:
 - lib/hanamismith/templates/%project_name%/Procfile.dev.erb
 - lib/hanamismith/templates/%project_name%/Procfile.erb
 - lib/hanamismith/templates/%project_name%/app/action.rb.erb
+- lib/hanamismith/templates/%project_name%/app/aspects/logging/rack_adapter.rb.erb
 - lib/hanamismith/templates/%project_name%/app/assets/css/colors.css.erb
 - lib/hanamismith/templates/%project_name%/app/assets/css/defaults.css.erb
 - lib/hanamismith/templates/%project_name%/app/assets/css/layout.css.erb
@@ -291,6 +294,7 @@ files:
 - lib/hanamismith/templates/%project_name%/app/db/relation.rb.erb
 - lib/hanamismith/templates/%project_name%/app/db/repository.rb.erb
 - lib/hanamismith/templates/%project_name%/app/db/struct.rb.erb
+- lib/hanamismith/templates/%project_name%/app/providers/logger.rb.erb
 - lib/hanamismith/templates/%project_name%/app/templates/layouts/app.html.erb.erb
 - lib/hanamismith/templates/%project_name%/app/view.rb.erb
 - lib/hanamismith/templates/%project_name%/bin/hanami.erb
@@ -299,7 +303,10 @@ files:
 - lib/hanamismith/templates/%project_name%/config/app.rb.erb
 - lib/hanamismith/templates/%project_name%/config/assets.js.erb
 - lib/hanamismith/templates/%project_name%/config/initializers/rack_attack.rb.erb
+- lib/hanamismith/templates/%project_name%/config/initializers/rack_logger_patch.rb.erb
+- lib/hanamismith/templates/%project_name%/config/initializers/sql_logger_patch.rb.erb
 - lib/hanamismith/templates/%project_name%/config/providers/htmx.rb.erb
+- lib/hanamismith/templates/%project_name%/config/providers/logger.rb.erb
 - lib/hanamismith/templates/%project_name%/config/puma.rb.erb
 - lib/hanamismith/templates/%project_name%/config/routes.rb.erb
 - lib/hanamismith/templates/%project_name%/config/settings.rb.erb
@@ -327,11 +334,13 @@ files:
 - lib/hanamismith/templates/%project_name%/slices/home/view.rb.erb
 - lib/hanamismith/templates/%project_name%/slices/home/views/context.rb.erb
 - lib/hanamismith/templates/%project_name%/slices/home/views/show.rb.erb
+- lib/hanamismith/templates/%project_name%/spec/app/aspects/logging/rack_adapter_spec.rb.erb
+- lib/hanamismith/templates/%project_name%/spec/app/providers/logger_spec.rb.erb
 - lib/hanamismith/templates/%project_name%/spec/features/home_spec.rb.erb
 - lib/hanamismith/templates/%project_name%/spec/hanami_helper.rb.erb
 - lib/hanamismith/templates/%project_name%/spec/lib/%project_path%/refines/actions/response_spec.rb.erb
 - lib/hanamismith/templates/%project_name%/spec/slices/health/actions/show_spec.rb.erb
-- lib/hanamismith/templates/%project_name%/spec/support/shared_contexts/application.rb.erb
+- lib/hanamismith/templates/%project_name%/spec/support/shared_contexts/application_dependencies.rb.erb
 homepage: https://alchemists.io/projects/hanamismith
 licenses:
 - Hippocratic-2.1