hanamismith 0.4.0 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: acfcec1bca4aa46dcdf1938f6fe7de5df8dcb369e1cdccf70c1c50a0b091376e
-  data.tar.gz: fb359b86de74b3bcfdf8a2b5da38fb1008938cd681f7afd6e8cf734dbe8436ae
+  metadata.gz: ccc945b74eb6e9d07c16a9cbaf15bd90f00e23ee2a4a4f4da0d42186d7b48f65
+  data.tar.gz: 1a14e5d6244c87171a8857d63605d1b8d21c8ab1a7fd8a70a649dcd56fe1ad18
 SHA512:
-  metadata.gz: ea87d728df34d6ace0cb8110350f6828c859ed4d75f0a439d208fe1ffb883fd7798a57a5830977c99dcac3301ffb41beb48a4ec4271ea3595597bb89260c5669
-  data.tar.gz: 4bf40a3ed2f9b000ea5d34fc6614a063d89cad15f98e2b283f75d11ead82b2f875b51e608723aeae148ea08ff1d345b41149e9977c4e90906dc6c281e96f6682
+  metadata.gz: be31386a7711bef55f38b756c66186f1e337648f675208e07713311f523abb367ee1a0075eba5245e807e6b8e6d63d5e6c34d4ac457c2467ac1864dfc45a6373
+  data.tar.gz: 8376b37b8645b49eeb764aa820298c1041645aa174fa7a16e34ff76f82d79bcc788aaa52e905e368952f03c2753d9507ef9852d71cf2d410e03736f4a85e538c

data/README.adoc

@@ -6,14 +6,14 @@
 :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]
+:dotfiles_link: link:https://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]
 :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]
+:rubysmith_link: link:https://alchemists.io/projects/rubysmith[Rubysmith]
 
 = Hanamismith
 
@@ -30,8 +30,8 @@ toc::[]
 
 == Features
 
-* Built atop {rubysmith_link} and leverages all features.
-* Uses {dry_link} functional programming.
+* Built atop {rubysmith_link} for building project skeleton.
+* Uses {dry_link} for 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.
@@ -40,6 +40,8 @@ toc::[]
 * 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.
+* 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.
 
 == Requirements
 
@@ -99,7 +101,7 @@ BUILD OPTIONS:
       --[no-]zeitwerk                      Add Zeitwerk gem. Default: true.
 ....
 
-The core functionality of this gem centers around the `--build` command and associated flags. The build options allow you to further customize the kind of gem you want to build. Most build options are enabled by default. For detailed documentation on all supported flags, see the link:https://www.alchemists.io/projects/rubysmith/#_build[Rubysmith] documentation.
+The core functionality of this gem centers around the `--build` command and associated flags. The build options allow you to further customize the kind of gem you want to build. Most build options are enabled by default. For detailed documentation on all supported flags, see the link:https://alchemists.io/projects/rubysmith/#_build[Rubysmith] documentation.
 
 ℹ️ Use of the `--zeitwerk` or `--no-zeitwerk` flags will have no effect so you can ignore them since {hanami_link} builds in this functionality for you by default. At the moment, this flag is a carry over from the {rubysmith_link} project and will be removed in the future.
 
@@ -111,11 +113,11 @@ This gem can be configured via a global configuration:
 $HOME/.config/hanamismith/configuration.yml
 ....
 
-It can also be configured via link:https://www.alchemists.io/projects/xdg[XDG] environment
+It can also be configured via link:https://alchemists.io/projects/xdg[XDG] environment
 variables.
 
 The default configuration is everything provided in the
-link:https://www.alchemists.io/projects/rubysmith/#_configuration[Rubysmith].
+link:https://alchemists.io/projects/rubysmith/#_configuration[Rubysmith].
 
 Feel free to modify the default and save as your own custom `configuration.yml`. It is recommended that you provide common URLs for your project which would be all keys found in this section:
 
@@ -164,7 +166,7 @@ bin/hanami --help
 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.
+* `/up`: 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
 
@@ -183,7 +185,7 @@ The above is what I use via my {dotfiles_link} project.
 
 For a fully working demonstration application -- as built by this gem -- check out the link:https://github.com/bkuhlmann/hemo[Hemo] project. Here's a quick screencast overview of this demonstration application in action:
 
-video::https://www.alchemists.io/videos/projects/hemo/demo.mp4[poster=https://www.alchemists.io/images/projects/hemo/demo.png,width=800,height=450,role=focal_point]
+video::https://alchemists.io/videos/projects/hemo/demo.mp4[poster=https://alchemists.io/images/projects/hemo/demo.png,width=800,height=450,role=focal_point]
 
 In case you are not aware of link:https://hanamimastery.com[Hanami Mastery], now would be a good time to introduce you. link:https://hanamimastery.com/about[Seb Wilgosz] -- the creator of Hanami Mastery -- recently published link:https://hanamimastery.com/episodes/40-hanamismith[Episode 40] (see below) which features this gem. _Please note that multiple advancements have been applied since the original recording of this video_. That said, this'll give you another perspective on usage which you might enjoy:
 
@@ -216,19 +218,19 @@ To test, run:
 bin/rake
 ----
 
-== link:https://www.alchemists.io/policies/license[License]
+== link:https://alchemists.io/policies/license[License]
 
-== link:https://www.alchemists.io/policies/security[Security]
+== link:https://alchemists.io/policies/security[Security]
 
-== link:https://www.alchemists.io/policies/code_of_conduct[Code of Conduct]
+== link:https://alchemists.io/policies/code_of_conduct[Code of Conduct]
 
-== link:https://www.alchemists.io/policies/contributions[Contributions]
+== link:https://alchemists.io/policies/contributions[Contributions]
 
-== link:https://www.alchemists.io/projects/hanamismith/versions[Versions]
+== link:https://alchemists.io/projects/hanamismith/versions[Versions]
 
-== link:https://www.alchemists.io/community[Community]
+== link:https://alchemists.io/community[Community]
 
 == Credits
 
-* Built with link:https://www.alchemists.io/projects/gemsmith[Gemsmith].
-* Engineered by link:https://www.alchemists.io/team/brooke_kuhlmann[Brooke Kuhlmann].
+* Built with link:https://alchemists.io/projects/gemsmith[Gemsmith].
+* Engineered by link:https://alchemists.io/team/brooke_kuhlmann[Brooke Kuhlmann].

data/hanamismith.gemspec

@@ -2,17 +2,17 @@
 
 Gem::Specification.new do |spec|
   spec.name = "hanamismith"
-  spec.version = "0.4.0"
+  spec.version = "0.6.0"
   spec.authors = ["Brooke Kuhlmann"]
   spec.email = ["brooke@alchemists.io"]
-  spec.homepage = "https://www.alchemists.io/projects/hanamismith"
+  spec.homepage = "https://alchemists.io/projects/hanamismith"
   spec.summary = "A command line interface for smithing Hanami projects."
   spec.license = "Hippocratic-2.1"
 
   spec.metadata = {
     "bug_tracker_uri" => "https://github.com/bkuhlmann/hanamismith/issues",
-    "changelog_uri" => "https://www.alchemists.io/projects/hanamismith/versions",
-    "documentation_uri" => "https://www.alchemists.io/projects/hanamismith",
+    "changelog_uri" => "https://alchemists.io/projects/hanamismith/versions",
+    "documentation_uri" => "https://alchemists.io/projects/hanamismith",
     "funding_uri" => "https://github.com/sponsors/bkuhlmann",
     "label" => "Hanamismith",
     "rubygems_mfa_required" => "true",
@@ -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.5"
+  spec.add_dependency "rubysmith", "~> 4.6"
   spec.add_dependency "runcom", "~> 9.0"
   spec.add_dependency "spek", "~> 1.0"
   spec.add_dependency "zeitwerk", "~> 2.6"

data/lib/hanamismith/builders/console.rb

@@ -14,9 +14,27 @@ module Hanamismith
         super
         builder.call(configuration.merge(template_path: "%project_name%/bin/console.erb"))
                .replace(/require_relative.+/, %(require "hanami/prepare"))
+        add_irb_autocomplete
 
         configuration
       end
+
+      private
+
+      def add_irb_autocomplete
+        with_template.insert_before "IRB.start",
+                                    <<~CODE
+                                      unless Hanami.env? :development, :test
+                                        ENV["IRB_USE_AUTOCOMPLETE"] ||= "false"
+                                        puts "IRB autocomplete disabled."
+                                      end
+
+                                    CODE
+      end
+
+      def with_template
+        builder.call configuration.merge(template_path: "%project_name%/bin/console.erb")
+      end
     end
   end
 end

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

@@ -8,6 +8,7 @@ module Hanamismith
         include Hanamismith::Import[:logger]
 
         # Order is important.
+        # rubocop:todo Metrics/CollectionLiteralLength
         BUILDERS = [
           Builders::Core,
           Builders::Providers::Persistence,
@@ -24,6 +25,7 @@ module Hanamismith
           Rubysmith::Builders::Documentation::Version,
           Rubysmith::Builders::Git::Setup,
           Rubysmith::Builders::Git::Ignore,
+          Rubysmith::Builders::Git::Safe,
           Builders::Bundler,
           Builders::Rake,
           Builders::Binstub,
@@ -53,6 +55,7 @@ module Hanamismith
           Builders::Environments::Test,
           Builders::Git::Commit
         ].freeze
+        # rubocop:enable Metrics/CollectionLiteralLength
 
         def initialize(builders: BUILDERS, **)
           super(**)

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

@@ -1 +1 @@
-web: bundle exec puma --port $PORT --config ./config/puma.rb
+web: bundle exec puma --config ./config/puma.rb

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

@@ -1,11 +1,20 @@
 require "hanami"
 
 <% namespace do %>
-  # Handles HTTP requests.
+  # Defines global application configuration.
   class App < Hanami::App
     config.actions.content_security_policy[:script_src] = "'self' 'unsafe-eval'"
 
     config.middleware.use Rack::Deflater
     config.middleware.use Rack::Static, {urls: %w[/stylesheets /javascript], root: "public"}
+
+    environment :development do
+      config.logger.options[:colorize] = true
+
+      config.logger = config.logger.instance.add_backend(
+        colorize: false,
+        stream: Hanami.app.root.join("log/development.log")
+      )
+    end
   end
 <% end %>

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

@@ -15,12 +15,20 @@ Hanami.app.register_provider :persistence, namespace: true do
 
     configuration.plugin :sql, relations: :auto_restrictions
 
+    database = configuration.gateways[:default].connection
+
     register "config", configuration
-    register "db", configuration.gateways[:default].connection
+    register "db", database
+
+    Sequel::Migrator.is_current? database, Hanami.app.root.join("db/migrate")
+  rescue NoMethodError, Sequel::Migrator::Error => error
+    message = error.message
+    Hanami.logger.error message unless error.is_a?(NoMethodError) && message.include?("migration")
   end
 
   start do
     configuration = target["persistence.config"]
+
     configuration.auto_registration(
       target.root.join("lib/<%= configuration.project_path %>/persistence"),
       namespace: "<%= configuration.project_namespaced_class %>::Persistence"

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

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

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

@@ -1,6 +1,6 @@
 <% namespace do %>
-  # Configures application settings.
+  # Defines application settings.
   class Settings < Hanami::Settings
-    setting :database_url
+    setting :database_url, constructor: Types::Params::String
   end
 <% end %>

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: hanamismith
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.6.0
 platform: ruby
 authors:
 - Brooke Kuhlmann
@@ -28,7 +28,7 @@ cert_chain:
   CxDe2+VuChj4I1nvIHdu+E6XoEVlanUPKmSg6nddhkKn2gC45Kyzh6FZqnzH/CRp
   RFE=
   -----END CERTIFICATE-----
-date: 2023-02-05 00:00:00.000000000 Z
+date: 2023-03-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: cogger
@@ -134,14 +134,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '4.5'
+        version: '4.6'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '4.5'
+        version: '4.6'
 - !ruby/object:Gem::Dependency
   name: runcom
   requirement: !ruby/object:Gem::Requirement
@@ -275,13 +275,13 @@ files:
 - 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
+homepage: https://alchemists.io/projects/hanamismith
 licenses:
 - Hippocratic-2.1
 metadata:
   bug_tracker_uri: https://github.com/bkuhlmann/hanamismith/issues
-  changelog_uri: https://www.alchemists.io/projects/hanamismith/versions
-  documentation_uri: https://www.alchemists.io/projects/hanamismith
+  changelog_uri: https://alchemists.io/projects/hanamismith/versions
+  documentation_uri: https://alchemists.io/projects/hanamismith
   funding_uri: https://github.com/sponsors/bkuhlmann
   label: Hanamismith
   rubygems_mfa_required: 'true'
@@ -301,7 +301,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.6
+rubygems_version: 3.4.7
 signing_key:
 specification_version: 4
 summary: A command line interface for smithing Hanami projects.