hanamismith 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 95bcf45f1ad28134657402afeab54487757c5269166ee13cbddd23571cf749ca
-  data.tar.gz: ed18cbcf1ea054fb8cc7794590cd89006738f8ea08495e7a26e1ff7c146c3531
+  metadata.gz: cf1e7802201b63905939929ff7014adcd106767ffdb951e2a8a312ec6abfeb2a
+  data.tar.gz: 8720f041a7d69d3eed3307f156941a0e444a952c711169decc588b4e6612ece4
 SHA512:
-  metadata.gz: 138d4fddb7fbbdeb608ca6f218b32006c851679197c36a63ceadcbb62954a88c5b05995dc7de2e24e06d80ea60b7c4c278d8db0c581038d478f4a67cb0fcff16
-  data.tar.gz: 15b01e9c02efbe60f6f0aad5137a952040ad8edb9cdfd832f76508cb134dcd4405a9f60a3285c8c57b1619695f5566a6a2ce5ade60356715a98af990c80bb2f2
+  metadata.gz: 336891443203d370011c047e118882edfc37e3f2e2e0c4b48331613b96d7837a5896dcc7123384ba15e7294dc464cc07a5ed809e5e918918f9a7fc86581fa10c
+  data.tar.gz: fd075996ec4289fdc853a0c9fd3836f028a5527d413b498ac2f4ed09ffcb27969cf86697cadd566acecbfa5e0c36047145199b630d961486a8380636383d70ae

data/README.adoc

@@ -11,6 +11,7 @@
 :htmx_link: link:https://htmx.org[HTMX]
 :pg_link: link:https://github.com/ged/ruby-pg[pg]
 :puma_link: link:https://puma.io[Puma]
+:rack_link: link:https://github.com/rack/rack[Rack]
 :rom_link: link:https://rom-rb.org[ROM]
 :rubysmith_link: link:https://www.alchemists.io/projects/rubysmith[Rubysmith]
 
@@ -34,6 +35,7 @@ toc::[]
 * Uses {hanami_link} for web application development.
 * Uses {htmx_link} for proper REST (hypermedia) architectures (i.e. HTML over the wire) so you can write less code and avoid bloated JavaScript stacks.
 * Uses {pg_link} coupled with {rom_link} for database management.
+* Uses {rack_link}, specifically: `Rack::Deflater`, `Rack::Static`, and link:https://github.com/rack/rack-attack[Rack::Attack].
 * Uses {puma_link} as the default web server and 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.
@@ -136,7 +138,10 @@ hanamismith --build demo
 
 # Run code quality and test coverage checks
 cd demo
-bundle exec rake
+bin/setup
+hanami db create
+HANAMI_ENV=test hanami db create
+bin/rake
 
 # Develop (red, green, refactor)
 bin/guard
@@ -152,6 +157,11 @@ hanami server
 git push
 ----
 
+Once the server is running you can visit (or ping) the following endpoints:
+
+* `/`: The default welcome page.
+* `/status`: The health status of the application. This will be _green_ (200 OK) when the server is up or _red_ (503 Service Unavailable) when the server is down.
+
 === Aliases
 
 For link:https://www.gnu.org/software/bash[Bash] users -- or other shell users -- you might find the following aliases helpful in reducing terminal keystrokes when using this gem:
@@ -195,7 +205,7 @@ To test, run:
 
 [source,bash]
 ----
-bundle exec rake
+bin/rake
 ----
 
 == link:https://www.alchemists.io/policies/license[License]

data/hanamismith.gemspec

@@ -2,7 +2,7 @@
 
 Gem::Specification.new do |spec|
   spec.name = "hanamismith"
-  spec.version = "0.1.0"
+  spec.version = "0.2.0"
   spec.authors = ["Brooke Kuhlmann"]
   spec.email = ["brooke@alchemists.io"]
   spec.homepage = "https://www.alchemists.io/projects/hanamismith"
@@ -30,7 +30,7 @@ Gem::Specification.new do |spec|
   spec.add_dependency "hanami", "~> 2.0"
   spec.add_dependency "infusible", "~> 1.0"
   spec.add_dependency "refinements", "~> 10.0"
-  spec.add_dependency "rubysmith", "~> 4.3"
+  spec.add_dependency "rubysmith", "~> 4.4"
   spec.add_dependency "runcom", "~> 9.0"
   spec.add_dependency "spek", "~> 1.0"
   spec.add_dependency "zeitwerk", "~> 2.6"

data/lib/hanamismith/builders/bundler.rb

@@ -31,6 +31,7 @@ module Hanamismith
                      .insert_after("source", %(gem "erbse", "~> 0.1"\n))
                      .insert_after("source", %(gem "hanami", "~> 2.0"\n))
                      .insert_after("source", %(gem "hanami-controller", "~> 2.0"\n))
+                     .insert_after("source", %(gem "hanami-helpers", "~> 0.0"\n))
                      .insert_after("source", %(gem "hanami-router", "~> 2.0"\n))
                      .insert_after("source", %(gem "hanami-validations", "~> 2.0"\n))
                      .insert_after(
@@ -38,6 +39,7 @@ module Hanamismith
                        %(gem "hanami-view", github: "hanami/view", branch: "main"\n)
                      )
                      .insert_after("source", %(gem "puma", "~> 6.0"\n))
+                     .insert_after("source", %(gem "rack-attack", "~> 6.6"\n))
       end
       # rubocop:enable Metrics/MethodLength
 

data/lib/hanamismith/builders/core.rb

@@ -24,15 +24,16 @@ module Hanamismith
 
       attr_reader :configuration, :builder
 
-      def add_application_action
+      def add_action
         builder.call(configuration.merge(template_path: "%project_name%/app/action.rb.erb")).render
       end
 
-      def add_application_repository
-        builder.call(configuration.merge(template_path: "%project_name%/app/repo.rb.erb")).render
+      def add_repository
+        builder.call(configuration.merge(template_path: "%project_name%/app/repository.rb.erb"))
+               .render
       end
 
-      def add_application_view
+      def add_view
         builder.call(configuration.merge(template_path: "%project_name%/app/view.rb.erb")).render
       end
 

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

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+require "refinements/structs"
+
+module Hanamismith
+  module Builders
+    module Rack
+      # Builds project skeleton with Rack Attack provider.
+      class Attack
+        using Refinements::Structs
+
+        def self.call(...) = new(...).call
+
+        def initialize configuration, builder: Rubysmith::Builder
+          @configuration = configuration
+          @builder = builder
+        end
+
+        def call
+          path = "%project_name%/config/providers/rack_attack.rb.erb"
+          builder.call(configuration.merge(template_path: path)).render
+
+          configuration
+        end
+
+        private
+
+        attr_reader :configuration, :builder
+      end
+    end
+  end
+end

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

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+require "refinements/structs"
+
+module Hanamismith
+  module Builders
+    module Rack
+      # Builds project skeleton Rack support.
+      class Config
+        using Refinements::Structs
+
+        def self.call(...) = new(...).call
+
+        def initialize configuration, builder: Rubysmith::Builder
+          @configuration = configuration
+          @builder = builder
+        end
+
+        def call
+          builder.call(configuration.merge(template_path: "%project_name%/config.ru.erb")).render
+          configuration
+        end
+
+        private
+
+        attr_reader :configuration, :builder
+      end
+    end
+  end
+end

data/lib/hanamismith/builders/refinement.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+require "refinements/structs"
+
+module Hanamismith
+  module Builders
+    # Builds project skeleton foundation.
+    class Refinement
+      using Refinements::Structs
+
+      def self.call(...) = new(...).call
+
+      def initialize configuration, builder: Rubysmith::Builder
+        @configuration = configuration
+        @builder = builder
+      end
+
+      def call
+        %w[
+          %project_name%/lib/%project_path%/refinements/actions/response.rb.erb
+          %project_name%/spec/lib/%project_path%/refinements/actions/response_spec.rb.erb
+        ].each do |path|
+          builder.call(configuration.merge(template_path: path)).render
+        end
+
+        configuration
+      end
+
+      private
+
+      attr_reader :configuration, :builder
+    end
+  end
+end

data/lib/hanamismith/builders/slices/health.rb

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+require "refinements/structs"
+
+module Hanamismith
+  module Builders
+    module Slices
+      # Builds project health slice skeleton.
+      class Health
+        using Refinements::Structs
+
+        def self.call(...) = new(...).call
+
+        def initialize configuration, builder: Rubysmith::Builder
+          @configuration = configuration
+          @builder = builder
+        end
+
+        def call
+          add_action
+          configuration
+        end
+
+        private
+
+        attr_reader :configuration, :builder
+
+        def add_action
+          %w[
+            %project_name%/slices/health/actions/show.rb.erb
+            %project_name%/spec/slices/health/actions/show_spec.rb.erb
+          ].each do |path|
+            builder.call(configuration.merge(template_path: path)).render
+          end
+        end
+      end
+    end
+  end
+end

data/lib/hanamismith/builders/slices/main.rb

@@ -31,7 +31,7 @@ module Hanamismith
         end
 
         def add_repository
-          path = "%project_name%/slices/main/repo.rb.erb"
+          path = "%project_name%/slices/main/repository.rb.erb"
           builder.call(configuration.merge(template_path: path)).render
         end
 

data/lib/hanamismith/builders/{rack.rb → stylesheet.rb}

@@ -4,8 +4,8 @@ require "refinements/structs"
 
 module Hanamismith
   module Builders
-    # Builds project skeleton Rack support.
-    class Rack
+    # Builds project skeleton stylesheet.
+    class Stylesheet
       using Refinements::Structs
 
       def self.call(...) = new(...).call
@@ -16,7 +16,8 @@ module Hanamismith
       end
 
       def call
-        builder.call(configuration.merge(template_path: "%project_name%/config.ru.erb")).render
+        path = "%project_name%/public/stylesheets/site.css.erb"
+        builder.call(configuration.merge(template_path: path)).render
         configuration
       end
 

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

@@ -10,7 +10,10 @@ module Hanamismith
         # Order is important.
         BUILDERS = [
           Builders::Core,
+          Builders::Refinement,
+          Builders::Stylesheet,
           Builders::Slices::Main,
+          Builders::Slices::Health,
           Rubysmith::Builders::Version,
           Builders::Documentation::Readme,
           Rubysmith::Builders::Documentation::Citation,
@@ -35,7 +38,8 @@ module Hanamismith
           Builders::RSpec::Factory,
           Builders::RSpec::Helper,
           Builders::RSpec::Hanami,
-          Builders::Rack,
+          Builders::Rack::Config,
+          Builders::Rack::Attack,
           Builders::Puma::Configuration,
           Builders::Puma::Procfile,
           Builders::Caliber,

data/lib/hanamismith/templates/%project_name%/Guardfile.erb

@@ -1,4 +1,4 @@
-guard :rspec, cmd: "NO_COVERAGE=true bundle exec rspec --format documentation" do
+guard :rspec, cmd: "NO_COVERAGE=true bin/rspec --format documentation" do
   require "guard/rspec/dsl"
 
   dsl = Guard::RSpec::Dsl.new self

data/lib/hanamismith/templates/%project_name%/app/{repo.rb.erb → repository.rb.erb}

@@ -4,7 +4,7 @@ require "rom-repository"
 
 <% namespace do %>
   # The application repository.
-  class Repo < ROM::Repository::Root
+  class Repository < ROM::Repository::Root
     include Deps[container: "persistence.rom"]
   end
 <% end %>

data/lib/hanamismith/templates/%project_name%/config/app.rb.erb

@@ -4,5 +4,8 @@ require "hanami"
   # Handles HTTP requests.
   class App < Hanami::App
     config.actions.content_security_policy[:script_src] = "https://unpkg.com"
+
+    config.middleware.use Rack::Deflater
+    config.middleware.use Rack::Static, {urls: %w[/stylesheets javascript], root: "public"}
   end
 <% end %>

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

@@ -0,0 +1,11 @@
+Hanami.app.register_provider :rack_attack do
+  prepare { require "rack/attack" }
+
+  start do
+    Rack::Attack.safelist "allow from localhost" do |request|
+      %w[127.0.0.1 ::1].include? request.ip
+    end
+
+    Rack::Attack.throttle("requests by IP", limit: 100, period: 60, &:ip)
+  end
+end

data/lib/hanamismith/templates/%project_name%/config/routes.rb.erb

@@ -1,8 +1,7 @@
 <% namespace do %>
   # Configures application routes.
   class Routes < Hanami::Routes
-    slice :main, at: "/" do
-      root to: "home.show"
-    end
+    slice(:health, at: "/status") { root to: "show" }
+    slice(:main, at: "/") { root to: "home.show" }
   end
 <% end %>

data/lib/hanamismith/templates/%project_name%/config.ru.erb

@@ -1,4 +1,6 @@
 require "hanami/boot"
 Bundler.require :tools if Hanami.env? :development
 
-run Hanami.app
+app = Rack::Builder.app { run Hanami.app }
+
+run app

data/lib/hanamismith/templates/%project_name%/lib/%project_path%/refinements/actions/response.rb.erb

@@ -0,0 +1,16 @@
+<% namespace do %>
+  module Refinements
+    module Actions
+      # Modifies and enhances default Hanami action response behavior.
+      module Response
+        refine Hanami::Action::Response do
+          def with body:, status:
+            @body = [body]
+            @status = status
+            self
+          end
+        end
+      end
+    end
+  end
+<% end %>

data/lib/hanamismith/templates/%project_name%/public/stylesheets/site.css.erb

@@ -0,0 +1,11 @@
+:root {
+  --site-font-family: Verdana;
+}
+
+.page {
+  align-items: center;
+  display: flex;
+  flex-direction: column;
+  font-family: var(--site-font-family);
+  margin: 1rem 5rem;
+}

data/lib/hanamismith/templates/%project_name%/slices/health/actions/show.rb.erb

@@ -0,0 +1,18 @@
+module Health
+  module Actions
+    # The show action.
+    class Show < <%= configuration.project_namespaced_class %>::Action
+      using <%= configuration.project_namespaced_class %>::Refinements::Actions::Response
+
+      handle_exception Exception => :down
+
+      def handle(*, response) = response.with body: body(:green), status: 200
+
+      private
+
+      def down(*, response, _exception) = response.with body: body(:red), status: 503
+
+      def body(color) = %(<html><body style="background-color: #{color}"></body></html>)
+    end
+  end
+end

data/lib/hanamismith/templates/%project_name%/slices/main/repository.rb.erb

@@ -0,0 +1,7 @@
+# auto_register: false
+
+module Main
+  # The main repository.
+  class Repository < <%= configuration.project_namespaced_class %>::Repository
+  end
+end

data/lib/hanamismith/templates/%project_name%/slices/main/templates/layouts/app.html.erb.erb

@@ -4,29 +4,15 @@
     <title><%= configuration.project_label %></title>
     <meta name="viewport" content="width=device-width,initial-scale=1">
 
-    <style type="text/css">
-      :root {
-        --site-font-family: Verdana;
-        --site-color-black: hsl(0, 0%, 0%);
-        --site-color-white: hsl(0, 0%, 100%);
-      }
+    <link title="<%= configuration.project_label %> - Stylesheet" rel="stylesheet" href="/stylesheets/site.css" type="text/css">
 
-      body {
-        align-items: center;
-        display: flex;
-        flex-direction: column;
-        font-family: var(--site-font-family);
-        margin: 1rem 5rem;
-      }
-    </style>
-
-    <script src="https://unpkg.com/htmx.org@1.8.4/dist/htmx.min.js"
+    <script src="https://unpkg.com/htmx.org@1.8.5"
             crossorigin="anonymous"
-            integrity="sha384-wg5Y/JwF7VxGk4zLsJEcAojRtlVp1FKKdGy1qN+OMtdq72WRvX/EdRdqg/LOhYeV">
+            integrity="sha384-7aHh9lqPYGYZ7sTHvzP1t3BAfLhYSTy9ArHdP3Xsr9/3TlGurYgcPBoFmXX2TX/w">
     </script>
   </head>
 
-  <body>
+  <body class="page">
     <!-- yield -->
   </body>
 </html>

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

@@ -0,0 +1,24 @@
+require "hanami_helper"
+
+RSpec.describe <%= configuration.project_namespaced_class %>::Refinements::Actions::Response do
+  using described_class
+
+  subject(:response) { Hanami::Action::Response.new request:, config: {} }
+
+  let :request do
+    Rack::MockRequest.env_for("/").then { |env| Hanami::Action::Request.new env:, params: {} }
+  end
+
+  describe "#with" do
+    it "answers response with given body and status" do
+      expect(response.with(body: "Danger!", status: 400)).to have_attributes(
+        body: ["Danger!"],
+        status: 400
+      )
+    end
+
+    it "answers itself" do
+      expect(response.with(body: "Danger!", status: 400)).to be_a(Hanami::Action::Response)
+    end
+  end
+end

data/lib/hanamismith/templates/%project_name%/spec/slices/health/actions/show_spec.rb.erb

@@ -0,0 +1,14 @@
+require "hanami_helper"
+
+RSpec.describe Health::Actions::Show do
+  subject(:action) { described_class.new }
+
+  describe "#call" do
+    it "answers 200 OK status with green background" do
+      expect(action.call({})).to have_attributes(
+        body: [%(<html><body style="background-color: green"></body></html>)],
+        status: 200
+      )
+    end
+  end
+end

data.tar.gz.sig

@@ -1,2 +1,3 @@
-uxvT�B� 
-�h�!�6LV��IIJ!��1P?�͜��*m�;�'�=~�Ŭ"��
+��j5芖d,�%��>�<�$�{�X`�j���郓���mj�K�7ty#�@���
+��
+��O����3�!�������%��b�%�T7��E�J��l�

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: hanamismith
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Brooke Kuhlmann
@@ -28,7 +28,7 @@ cert_chain:
   CxDe2+VuChj4I1nvIHdu+E6XoEVlanUPKmSg6nddhkKn2gC45Kyzh6FZqnzH/CRp
   RFE=
   -----END CERTIFICATE-----
-date: 2023-01-19 00:00:00.000000000 Z
+date: 2023-01-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: cogger
@@ -134,14 +134,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '4.3'
+        version: '4.4'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '4.3'
+        version: '4.4'
 - !ruby/object:Gem::Dependency
   name: runcom
   requirement: !ruby/object:Gem::Requirement
@@ -211,14 +211,18 @@ files:
 - lib/hanamismith/builders/guard.rb
 - lib/hanamismith/builders/puma/configuration.rb
 - lib/hanamismith/builders/puma/procfile.rb
-- lib/hanamismith/builders/rack.rb
+- lib/hanamismith/builders/rack/attack.rb
+- lib/hanamismith/builders/rack/config.rb
 - lib/hanamismith/builders/rake.rb
+- lib/hanamismith/builders/refinement.rb
 - lib/hanamismith/builders/rspec/application_shared_context.rb
 - lib/hanamismith/builders/rspec/database.rb
 - lib/hanamismith/builders/rspec/factory.rb
 - lib/hanamismith/builders/rspec/hanami.rb
 - lib/hanamismith/builders/rspec/helper.rb
+- lib/hanamismith/builders/slices/health.rb
 - lib/hanamismith/builders/slices/main.rb
+- lib/hanamismith/builders/stylesheet.rb
 - lib/hanamismith/cli/actions/build.rb
 - lib/hanamismith/cli/actions/config.rb
 - lib/hanamismith/cli/actions/container.rb
@@ -235,26 +239,32 @@ 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/repo.rb.erb
+- lib/hanamismith/templates/%project_name%/app/repository.rb.erb
 - lib/hanamismith/templates/%project_name%/app/view.rb.erb
 - lib/hanamismith/templates/%project_name%/bin/hanami.erb
 - lib/hanamismith/templates/%project_name%/config.ru.erb
 - lib/hanamismith/templates/%project_name%/config/app.rb.erb
 - lib/hanamismith/templates/%project_name%/config/providers/persistence.rb.erb
+- lib/hanamismith/templates/%project_name%/config/providers/rack_attack.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
 - lib/hanamismith/templates/%project_name%/env.development.erb
 - lib/hanamismith/templates/%project_name%/env.test.erb
+- lib/hanamismith/templates/%project_name%/lib/%project_path%/refinements/actions/response.rb.erb
 - lib/hanamismith/templates/%project_name%/lib/%project_path%/types.rb.erb
+- lib/hanamismith/templates/%project_name%/public/stylesheets/site.css.erb
+- lib/hanamismith/templates/%project_name%/slices/health/actions/show.rb.erb
 - lib/hanamismith/templates/%project_name%/slices/main/action.rb.erb
 - lib/hanamismith/templates/%project_name%/slices/main/actions/home/show.rb.erb
-- lib/hanamismith/templates/%project_name%/slices/main/repo.rb.erb
+- lib/hanamismith/templates/%project_name%/slices/main/repository.rb.erb
 - lib/hanamismith/templates/%project_name%/slices/main/templates/home/show.html.erb.erb
 - lib/hanamismith/templates/%project_name%/slices/main/templates/layouts/app.html.erb.erb
 - lib/hanamismith/templates/%project_name%/slices/main/view.rb.erb
 - lib/hanamismith/templates/%project_name%/slices/main/views/home/show.rb.erb
 - lib/hanamismith/templates/%project_name%/spec/hanami_helper.rb.erb
+- lib/hanamismith/templates/%project_name%/spec/lib/%project_path%/refinements/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/database.rb.erb
 - lib/hanamismith/templates/%project_name%/spec/support/factory.rb.erb
 - lib/hanamismith/templates/%project_name%/spec/support/shared_contexts/application.rb.erb

data/lib/hanamismith/templates/%project_name%/slices/main/repo.rb.erb

@@ -1,7 +0,0 @@
-# auto_register: false
-
-module Main
-  # The main repository.
-  class Repo < <%= configuration.project_namespaced_class %>::Repo
-  end
-end