hanamismith 0.0.0 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1547f2b3305d29362da3bfc4779fd1093aba4834ddf8ab7a09d684722325b708
-  data.tar.gz: 9b83495269ac455d6eca644ff635127746bef385bda1ce0593a389cdfe421175
+  metadata.gz: 95bcf45f1ad28134657402afeab54487757c5269166ee13cbddd23571cf749ca
+  data.tar.gz: ed18cbcf1ea054fb8cc7794590cd89006738f8ea08495e7a26e1ff7c146c3531
 SHA512:
-  metadata.gz: c351b54ab430d6c0f54e5b9bfa562fc052bd532ac1f95af6d9ddac58a957d49330eb5da490336fc2e72ad245fef324965fd05a25c633845c2f3dea0a40fb6c70
-  data.tar.gz: 73767e229d91778bb6f21df1edf5cafebd94794c9f7ae97471eaca9876fe0d39cd242cb1b70f194af067a3cf1c3511f2445a7a5f36f28119eb0ab8716b09ba72
+  metadata.gz: 138d4fddb7fbbdeb608ca6f218b32006c851679197c36a63ceadcbb62954a88c5b05995dc7de2e24e06d80ea60b7c4c278d8db0c581038d478f4a67cb0fcff16
+  data.tar.gz: 15b01e9c02efbe60f6f0aad5137a952040ad8edb9cdfd832f76508cb134dcd4405a9f60a3285c8c57b1619695f5566a6a2ce5ade60356715a98af990c80bb2f2

data/README.adoc

@@ -2,16 +2,21 @@
 :toclevels: 5
 :figure-caption!:
 
+:capybara_link: link:https://github.com/teamcapybara/capybara[Capybara]
 :cuprite_link: link:https://cuprite.rubycdp.com[Cuprite]
 :dry_link: link:https://dry-rb.org[Dry RB]
+:dotenv_link: link:https://github.com/bkeepers/dotenv[Dotenv]
 :dotfiles_link: link:https://www.alchemists.io/projects/dotfiles[Dotfiles]
 :hanami_link: link:https://hanamirb.org[Hanami]
 :htmx_link: link:https://htmx.org[HTMX]
+:pg_link: link:https://github.com/ged/ruby-pg[pg]
+:puma_link: link:https://puma.io[Puma]
+:rom_link: link:https://rom-rb.org[ROM]
 :rubysmith_link: link:https://www.alchemists.io/projects/rubysmith[Rubysmith]
 
 = Hanamismith
 
-Hanamismith is a Command Line Interface (CLI) for smithing Hanami projects. Perfect for when you need a professional and robust tool for building new project skeletons. To quote from the {dry_link} and {hanami_link} team:
+Hanamismith is a Command Line Interface (CLI) for smithing Hanami projects. Perfect for when you need a professional and robust tool for building new project skeletons. To quote from the {dry_link} and {hanami_link} teams:
 ____
 If you're looking for new ways to build maintainable, secure, faster and testable Ruby applications, you're in for a treat. *Hanami is built for people like you*.
 
@@ -24,11 +29,14 @@ toc::[]
 
 == Features
 
-* Supports all {rubysmith_link} features.
-* Supports {dry_link} functional programming.
-* Supports {hanami_link} for web application development.
-* Supports {htmx_link} for proper REST (hypermedia) architectures (i.e. HTML over the wire) so you can write less code and avoid bloated JavaScript stacks.
-* Supports {cuprite_link} for full, headless, feature testing.
+* Built atop {rubysmith_link} and leverages all features.
+* Uses {dry_link} functional programming.
+* 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 {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.
 
 == Requirements
 
@@ -138,7 +146,7 @@ git commit  # (repeat until finished with implementation)
 overmind start --port-step 10 --procfile Procfile.dev
 
 # Run: Without Overmind
-hanami start
+hanami server
 
 # Deploy
 git push
@@ -159,7 +167,9 @@ The above is what I use via my {dotfiles_link} project.
 
 === Demonstration
 
-If you'd like a fully working demonstration appliation -- as built by this gem -- then check ouh the link:https://github.com/bkuhlmann/hemo[Hemo] project.
+If you'd like a fully working demonstration application -- as built by this gem -- then check out the link:https://github.com/bkuhlmann/hemo[Hemo] project. Here's a quick screencast overview of demonstration application:
+
+video::https://www.alchemists.io/videos/projects/hemo/demo.mp4[poster=https://www.alchemists.io/images/projects/hemo/demo.png,width=1028,height=854,role=focal_point]
 
 == Development
 

data/hanamismith.gemspec

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

data/lib/hanamismith/builders/bundler.rb

@@ -16,6 +16,7 @@ module Hanamismith
         alter_groups
         append_development_group
         append_test_group
+        insert_development_and_test_group
         remove_zeitwerk
         configuration
       end
@@ -49,10 +50,12 @@ module Hanamismith
 
       def alter_groups
         with_template.insert_after(/group :code_quality/, %(  gem "rubocop-sequel", "~> 0.3"\n))
-                     .insert_after(/group :development/, %(  gem "localhost", "~> 1.1"\n))
-                     .insert_after(/group :development/, %(  gem "rerun", "~> 0.14"\n))
+                     .insert_after(/group :development do/, %(  gem "localhost", "~> 1.1"\n))
+                     .insert_after(/group :development do/, %(  gem "rerun", "~> 0.14"\n))
                      .insert_after(/group :test/, %(  gem "capybara", "~> 3.38"\n))
                      .insert_after(/group :test/, %(  gem "cuprite", "~> 0.14"\n))
+                     .insert_after(/group :test/, %(  gem "database_cleaner-sequel", "~> 2.0"\n))
+                     .insert_after(/group :test/, %(  gem "launchy", "~> 2.5"\n))
                      .insert_after(/group :test/, %(  gem "rack-test", "~> 2.0"\n))
                      .insert_after(/group :test/, %(  gem "rom-factory", "~> 0.11"\n))
                      .replace(/gem "rspec.+/, %(gem "hanami-rspec", "~> 2.0"))
@@ -62,7 +65,6 @@ module Hanamismith
         return if configuration.markdown? || configuration.build_rake || configuration.build_yard
 
         with_template.append <<~CONTENT
-
           group :development do
             gem "localhost", "~> 1.1"
             gem "rerun", "~> 0.14"
@@ -78,13 +80,25 @@ module Hanamismith
           group :test do
             gem "capybara", "~> 3.38"
             gem "cuprite", "~> 0.14"
+            gem "database_cleaner-sequel", "~> 2.0"
             gem "hanami-rspec", "~> 2.0"
+            gem "launchy", "~> 2.5"
             gem "rack-test", "~> 2.0"
             gem "rom-factory", "~> 0.11"
           end
         CONTENT
       end
 
+      def insert_development_and_test_group
+        with_template.insert_before(/group :development/, <<~CONTENT)
+
+          group :development, :test do
+            gem "dotenv", "~> 2.8"
+          end
+
+        CONTENT
+      end
+
       def remove_zeitwerk = with_template.replace(/.+zeitwerk.+\n\n/, "\n")
 
       def with_template

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

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+require "refinements/structs"
+
+module Hanamismith
+  module Builders
+    module Environments
+      # Builds development environment skeleton.
+      class Development
+        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%/env.development.erb"))
+                 .render
+                 .rename(".env.development")
+
+          configuration
+        end
+
+        private
+
+        attr_reader :configuration, :builder
+      end
+    end
+  end
+end

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

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+require "refinements/structs"
+
+module Hanamismith
+  module Builders
+    module Environments
+      # Builds test environment skeleton.
+      class Test
+        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%/env.test.erb"))
+                 .render
+                 .rename(".env.test")
+
+          configuration
+        end
+
+        private
+
+        attr_reader :configuration, :builder
+      end
+    end
+  end
+end

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

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+require "refinements/structs"
+
+module Hanamismith
+  module Builders
+    module RSpec
+      # Builds project skeleton RSpec application shared context.
+      class ApplicationSharedContext
+        using Refinements::Structs
+
+        def self.call(...) = new(...).call
+
+        def initialize configuration, builder: Rubysmith::Builder
+          @configuration = configuration
+          @builder = builder
+        end
+
+        def call
+          return configuration unless configuration.build_rspec
+
+          path = "%project_name%/spec/support/shared_contexts/application.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/rspec/database.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+require "refinements/structs"
+
+module Hanamismith
+  module Builders
+    module RSpec
+      # Builds project skeleton RSpec application database support.
+      class Database
+        using Refinements::Structs
+
+        def self.call(...) = new(...).call
+
+        def initialize configuration, builder: Rubysmith::Builder
+          @configuration = configuration
+          @builder = builder
+        end
+
+        def call
+          return configuration unless configuration.build_rspec
+
+          path = "%project_name%/spec/support/database.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/rspec/factory.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+require "refinements/structs"
+
+module Hanamismith
+  module Builders
+    module RSpec
+      # Builds project skeleton RSpec application database support.
+      class Factory
+        using Refinements::Structs
+
+        def self.call(...) = new(...).call
+
+        def initialize configuration, builder: Rubysmith::Builder
+          @configuration = configuration
+          @builder = builder
+        end
+
+        def call
+          return configuration unless configuration.build_rspec
+
+          path = "%project_name%/spec/support/factory.rb.erb"
+          builder.call(configuration.merge(template_path: path)).render
+
+          configuration
+        end
+
+        private
+
+        attr_reader :configuration, :builder
+      end
+    end
+  end
+end

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

@@ -30,6 +30,9 @@ module Hanamismith
           Rubysmith::Builders::Reek,
           Rubysmith::Builders::RSpec::Binstub,
           Rubysmith::Builders::RSpec::Context,
+          Builders::RSpec::ApplicationSharedContext,
+          Builders::RSpec::Database,
+          Builders::RSpec::Factory,
           Builders::RSpec::Helper,
           Builders::RSpec::Hanami,
           Builders::Rack,
@@ -40,7 +43,8 @@ module Hanamismith
           Rubysmith::Extensions::Pragmater,
           Rubysmith::Extensions::Tocer,
           Rubysmith::Extensions::Rubocop,
-          Builders::Environment,
+          Builders::Environments::Development,
+          Builders::Environments::Test,
           Builders::Git::Commit
         ].freeze
 

data/lib/hanamismith/templates/%project_name%/Procfile.dev.erb

@@ -1 +1 @@
-web: rerun --pattern="**/*.{css,erb,js,rb}" -- bundle exec puma --config ./config/puma.rb
+web: rerun --dir app,config,lib,slices --pattern="**/*.{css,erb,js,rb}" -- bundle exec puma --config ./config/puma.rb

data/lib/hanamismith/templates/%project_name%/env.development.erb

@@ -0,0 +1 @@
+DATABASE_URL=postgres://localhost/<%= configuration.project_name %>_development

data/lib/hanamismith/templates/%project_name%/env.test.erb

@@ -0,0 +1 @@
+DATABASE_URL=postgres://localhost/<%= configuration.project_name %>_test

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

@@ -1,22 +1,44 @@
 require "capybara/cuprite"
 require "capybara/rspec"
+require "database_cleaner/sequel"
 require "rack/test"
 require "spec_helper"
 
 ENV["HANAMI_ENV"] = "test"
+
 require "hanami/prepare"
+require_relative "support/database"
+require_relative "support/factory"
+
+using Refinements::Pathnames
 
+Capybara.app = Hanami.app
 Capybara.server = :puma, {Silent: true}
 Capybara.javascript_driver = :cuprite
+Capybara.save_path = Hanami.app.root.join "tmp/capybara"
 Capybara.register_driver :cuprite do |app|
   Capybara::Cuprite::Driver.new app, window_size: [1200, 800]
 end
 
-RSpec.shared_context "with Hanami application" do
-  let(:app) { Hanami.app }
-end
+DatabaseCleaner[:sequel].strategy = :transaction
+
+Pathname.require_tree SPEC_ROOT, "support/factories/**/*.rb"
 
 RSpec.configure do |config|
+  config.include Capybara::DSL, Capybara::RSpecMatchers, :web
   config.include Rack::Test::Methods, type: :request
+  config.include Test::Database, :db
   config.include_context "with Hanami application", type: :request
+
+  config.before :suite do
+    Hanami.app.start :persistence
+    DatabaseCleaner[:sequel].clean_with :truncation
+  end
+
+  config.prepend_before :each, :db do |example|
+    DatabaseCleaner[:sequel].strategy = example.metadata[:js] ? :truncation : :transaction
+    DatabaseCleaner[:sequel].start
+  end
+
+  config.append_after(:each, :db) { DatabaseCleaner[:sequel].clean }
 end

data/lib/hanamismith/templates/%project_name%/spec/support/database.rb.erb

@@ -0,0 +1,10 @@
+module Test
+  # Provides convenience methods for testing purposes.
+  module Database
+    def self.relations = rom.relations
+
+    def self.rom = Hanami.app["persistence.rom"]
+
+    def self.db = Hanami.app["persistence.db"]
+  end
+end

data/lib/hanamismith/templates/%project_name%/spec/support/factory.rb.erb

@@ -0,0 +1,6 @@
+require "rom-factory"
+require_relative "database"
+
+module Test
+  Factory = ROM::Factory.configure { |config| config.rom = Test::Database.rom }
+end

data/lib/hanamismith/templates/%project_name%/spec/support/shared_contexts/application.rb.erb

@@ -0,0 +1,3 @@
+RSpec.shared_context "with Hanami application" do
+  let(:app) { Hanami.app }
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: hanamismith
 version: !ruby/object:Gem::Version
-  version: 0.0.0
+  version: 0.1.0
 platform: ruby
 authors:
 - Brooke Kuhlmann
@@ -28,7 +28,7 @@ cert_chain:
   CxDe2+VuChj4I1nvIHdu+E6XoEVlanUPKmSg6nddhkKn2gC45Kyzh6FZqnzH/CRp
   RFE=
   -----END CERTIFICATE-----
-date: 2023-01-18 00:00:00.000000000 Z
+date: 2023-01-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: cogger
@@ -205,13 +205,17 @@ files:
 - lib/hanamismith/builders/console.rb
 - lib/hanamismith/builders/core.rb
 - lib/hanamismith/builders/documentation/readme.rb
-- lib/hanamismith/builders/environment.rb
+- lib/hanamismith/builders/environments/development.rb
+- lib/hanamismith/builders/environments/test.rb
 - lib/hanamismith/builders/git/commit.rb
 - 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/rake.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/main.rb
@@ -240,7 +244,8 @@ files:
 - 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%/envrc.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%/types.rb.erb
 - lib/hanamismith/templates/%project_name%/slices/main/action.rb.erb
 - lib/hanamismith/templates/%project_name%/slices/main/actions/home/show.rb.erb
@@ -250,6 +255,9 @@ files:
 - 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/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
 homepage: https://www.alchemists.io/projects/hanamismith
 licenses:
 - Hippocratic-2.1

data/lib/hanamismith/builders/environment.rb

@@ -1,31 +0,0 @@
-# frozen_string_literal: true
-
-require "refinements/structs"
-
-module Hanamismith
-  module Builders
-    # Builds project environment skeleton.
-    class Environment
-      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%/envrc.erb"))
-               .render
-               .rename(".envrc")
-
-        configuration
-      end
-
-      private
-
-      attr_reader :configuration, :builder
-    end
-  end
-end

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

@@ -1 +0,0 @@
-export DATABASE_URL=postgres://localhost/<%= configuration.project_name %>_development