hanami-cli 2.0.0 → 2.1.0

data/lib/hanami/cli/generators/app/slice.rb

@@ -19,7 +19,7 @@ module Hanami
 
           # @since 2.0.0
           # @api private
-          def call(app, slice, url, context: SliceContext.new(inflector, app, slice, url))
+          def call(app, slice, url, context: SliceContext.new(inflector, app, slice, url)) # rubocop:disable Metrics/AbcSize
             fs.inject_line_at_class_bottom(
               fs.join("config", "routes.rb"), "class Routes", t("routes.erb", context).chomp
             )
@@ -28,14 +28,23 @@ module Hanami
 
             # fs.write("#{directory}/config/slice.rb", t("slice.erb", context))
             fs.write(fs.join(directory, "action.rb"), t("action.erb", context))
-            # fs.write(fs.join(directory, "/view.rb"), t("view.erb", context))
+            fs.write(fs.join(directory, "view.rb"), t("view.erb", context))
+            fs.write(fs.join(directory, "views", "helpers.rb"), t("helpers.erb", context))
+            fs.write(fs.join(directory, "templates", "layouts", "app.html.erb"), t("app_layout.erb", context))
+
+            if context.bundled_assets?
+              fs.write(fs.join(directory, "assets", "js", "app.js"), t("app_js.erb", context))
+              fs.write(fs.join(directory, "assets", "css", "app.css"), t("app_css.erb", context))
+              fs.write(fs.join(directory, "assets", "images", "favicon.ico"), file("favicon.ico"))
+            end
+
             # fs.write(fs.join(directory, "/entities.rb"), t("entities.erb", context))
             # fs.write(fs.join(directory, "/repository.rb"), t("repository.erb", context))
 
             fs.write(fs.join(directory, "actions/.keep"), t("keep.erb", context))
-            # fs.write(fs.join(directory, views/.keep"), t("keep.erb", context))
-            # fs.write(fs.join(directory, templates/.keep"), t("keep.erb", context))
-            # fs.write(fs.join(directory, templates/layouts/.keep"), t("keep.erb", context))
+            fs.write(fs.join(directory, "views/.keep"), t("keep.erb", context))
+            fs.write(fs.join(directory, "templates/.keep"), t("keep.erb", context))
+            fs.write(fs.join(directory, "templates/layouts/.keep"), t("keep.erb", context))
             # fs.write(fs.join(directory, entities/.keep"), t("keep.erb", context))
             # fs.write(fs.join(directory, repositories/.keep"), t("keep.erb", context))
           end
@@ -50,11 +59,16 @@ module Hanami
             require "erb"
 
             ERB.new(
-              File.read(__dir__ + "/slice/#{path}")
+              File.read(__dir__ + "/slice/#{path}"),
+              trim_mode: "-"
             ).result(context.ctx)
           end
 
           alias_method :t, :template
+
+          def file(path)
+            File.read(File.join(__dir__, "slice", path))
+          end
         end
       end
     end

data/lib/hanami/cli/generators/app/slice_context.rb

@@ -29,6 +29,24 @@ module Hanami
             inflector.underscore(slice)
           end
 
+          # @since 2.1.0
+          # @api private
+          def humanized_slice_name
+            inflector.humanize(slice)
+          end
+
+          # @since 2.1.0
+          # @api private
+          def stylesheet_erb_tag
+            %(<%= stylesheet_tag "app" %>)
+          end
+
+          # @since 2.1.0
+          # @api private
+          def javascript_erb_tag
+            %(<%= javascript_tag "app" %>)
+          end
+
           private
 
           attr_reader :slice

data/lib/hanami/cli/generators/app/view/app_template.html.erb

@@ -0,0 +1 @@
+<h1><%= camelized_app_name %>::Views::<%= camelized_namespace %>::<%= camelized_name %></h1>

data/lib/hanami/cli/generators/app/view/app_view.erb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+module <%= camelized_app_name %>
+  module Views
+<%= module_namespace_declaration %>
+<%= module_namespace_offset %>class <%= camelized_name %> < <%= camelized_app_name %>::View
+<%= module_namespace_offset %>end
+<%= module_namespace_end %>
+  end
+end

data/lib/hanami/cli/generators/app/view/slice_template.html.erb

@@ -0,0 +1 @@
+<h1><%= camelized_slice_name %>::Views::<%= camelized_namespace %>::<%= camelized_name %></h1>

data/lib/hanami/cli/generators/app/view/slice_view.erb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+module <%= camelized_slice_name %>
+  module Views
+<%= module_namespace_declaration %>
+<%= module_namespace_offset %>class <%= camelized_name %> < <%= camelized_slice_name %>::View
+<%= module_namespace_offset %>end
+<%= module_namespace_end %>
+  end
+end

data/lib/hanami/cli/generators/app/view.rb

@@ -0,0 +1,89 @@
+# frozen_string_literal: true
+
+require "erb"
+require "dry/files"
+require_relative "../../errors"
+
+module Hanami
+  module CLI
+    module Generators
+      module App
+        # @since 2.0.0
+        # @api private
+        class View
+          # @since 2.0.0
+          # @api private
+          def initialize(fs:, inflector:)
+            @fs = fs
+            @inflector = inflector
+          end
+
+          # @since 2.0.0
+          # @api private
+          def call(app, key, format, slice)
+            context = ViewContext.new(inflector, app, slice, key)
+
+            if slice
+              generate_for_slice(context, format, slice)
+            else
+              generate_for_app(context, format, slice)
+            end
+          end
+
+          private
+
+          attr_reader :fs
+
+          attr_reader :inflector
+
+          # rubocop:disable Metrics/AbcSize
+
+          def generate_for_slice(context, format, slice)
+            slice_directory = fs.join("slices", slice)
+            raise MissingSliceError.new(slice) unless fs.directory?(slice_directory)
+
+            fs.mkdir(directory = fs.join(slice_directory, "views", context.namespaces))
+            fs.write(fs.join(directory, "#{context.name}.rb"), t("slice_view.erb", context))
+
+            fs.mkdir(directory = fs.join(slice_directory, "templates", context.namespaces))
+            fs.write(fs.join(directory, "#{context.name}.#{format}.erb"),
+                     t(template_with_format_ext("slice_template", format), context))
+          end
+
+          def generate_for_app(context, format, _slice)
+            fs.mkdir(directory = fs.join("app", "views", context.namespaces))
+            fs.write(fs.join(directory, "#{context.name}.rb"), t("app_view.erb", context))
+
+            fs.mkdir(directory = fs.join("app", "templates", context.namespaces))
+            fs.write(fs.join(directory, "#{context.name}.#{format}.erb"),
+                     t(template_with_format_ext("app_template", format), context))
+          end
+
+          # rubocop:enable Metrics/AbcSize
+
+          def template_with_format_ext(name, format)
+            ext =
+              case format.to_sym
+              when :html
+                ".html.erb"
+              else
+                ".erb"
+              end
+
+            "#{name}#{ext}"
+          end
+
+          def template(path, context)
+            require "erb"
+
+            ERB.new(
+              File.read(__dir__ + "/view/#{path}")
+            ).result(context.ctx)
+          end
+
+          alias_method :t, :template
+        end
+      end
+    end
+  end
+end

data/lib/hanami/cli/generators/app/view_context.rb

@@ -0,0 +1,100 @@
+# frozen_string_literal: true
+
+require_relative "slice_context"
+require "dry/files/path"
+
+module Hanami
+  module CLI
+    module Generators
+      # @since 2.1.0
+      # @api private
+      module App
+        # @since 2.1.0
+        # @api private
+        class ViewContext < SliceContext
+          # TODO: move these constants somewhere that will let us reuse them
+          KEY_SEPARATOR = "."
+          private_constant :KEY_SEPARATOR
+
+          NAMESPACE_SEPARATOR = "::"
+          private_constant :NAMESPACE_SEPARATOR
+
+          INDENTATION = "  "
+          private_constant :INDENTATION
+
+          OFFSET = INDENTATION * 2
+          private_constant :OFFSET
+
+          # @since 2.1.0
+          # @api private
+          attr_reader :key
+
+          # @since 2.1.0
+          # @api private
+          def initialize(inflector, app, slice, key)
+            @key = key
+            super(inflector, app, slice, nil)
+          end
+
+          # @since 2.1.0
+          # @api private
+          def namespaces
+            @namespaces ||= key.split(KEY_SEPARATOR)[..-2]
+          end
+
+          # @since 2.1.0
+          # @api private
+          def name
+            @name ||= key.split(KEY_SEPARATOR)[-1]
+          end
+
+          # @since 2.1.0
+          # @api private
+          def camelized_namespace
+            namespaces.map { inflector.camelize(_1) }.join(NAMESPACE_SEPARATOR)
+          end
+
+          # @since 2.1.0
+          # @api private
+          def camelized_name
+            inflector.camelize(name)
+          end
+
+          # @since 2.1.0
+          # @api private
+          def underscored_namespace
+            namespaces.map { inflector.underscore(_1) }
+          end
+
+          # @since 2.1.0
+          # @api private
+          def underscored_name
+            inflector.underscore(name)
+          end
+
+          # @since 2.1.0
+          # @api private
+          def module_namespace_declaration
+            namespaces.each_with_index.map { |token, i|
+              "#{OFFSET}#{INDENTATION * i}module #{inflector.camelize(token)}"
+            }.join($/)
+          end
+
+          # @since 2.1.0
+          # @api private
+          def module_namespace_end
+            namespaces.each_with_index.map { |_, i|
+              "#{OFFSET}#{INDENTATION * i}end"
+            }.reverse.join($/)
+          end
+
+          # @since 2.1.0
+          # @api private
+          def module_namespace_offset
+            "#{OFFSET}#{INDENTATION * namespaces.count}"
+          end
+        end
+      end
+    end
+  end
+end

data/lib/hanami/cli/generators/context.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require_relative "./version"
+require_relative "version"
 
 module Hanami
   module CLI
@@ -12,9 +12,10 @@ module Hanami
       class Context
         # @since 2.0.0
         # @api private
-        def initialize(inflector, app)
+        def initialize(inflector, app, **options)
           @inflector = inflector
           @app = app
+          @options = options
         end
 
         # @since 2.0.0
@@ -23,16 +24,36 @@ module Hanami
           binding
         end
 
+        def hanami_gem(name)
+          gem_name = name == "hanami" ? "hanami" : "hanami-#{name}"
+
+          %(gem "#{gem_name}", #{hanami_gem_version(name)})
+        end
+
         # @since 2.0.0
         # @api private
-        def hanami_version
-          Version.gem_requirement
+        def hanami_gem_version(gem_name)
+          if hanami_head?
+            %(github: "hanami/#{gem_name}", branch: "main")
+          else
+            %("#{Version.gem_requirement}")
+          end
+        end
+
+        # @since 2.1.0
+        # @api private
+        def hanami_assets_npm_package
+          if hanami_head?
+            %("hanami-assets": "hanami/assets-js#main")
+          else
+            %("hanami-assets": "#{Version.npm_package_requirement}")
+          end
         end
 
         # @since 2.0.0
         # @api private
         def camelized_app_name
-          inflector.camelize(app)
+          inflector.camelize(app).gsub(/[^\p{Alnum}]/, "")
         end
 
         # @since 2.0.0
@@ -41,11 +62,57 @@ module Hanami
           inflector.underscore(app)
         end
 
+        # @since 2.1.0
+        # @api private
+        def humanized_app_name
+          inflector.humanize(app)
+        end
+
+        # @since 2.1.0
+        # @api private
+        def hanami_head?
+          options.fetch(:head)
+        end
+
+        # @since 2.1.0
+        # @api private
+        def generate_assets?
+          !options.fetch(:skip_assets, false)
+        end
+
+        # @since 2.1.0
+        # @api private
+        def bundled_views?
+          Hanami.bundled?("hanami-view")
+        end
+
+        # @since 2.1.0
+        # @api private
+        def bundled_assets?
+          Hanami.bundled?("hanami-assets")
+        end
+
+        # @since 2.1.0
+        # @api private
+        #
+        # @see https://rubyreferences.github.io/rubychanges/3.1.html#values-in-hash-literals-and-keyword-arguments-can-be-omitted
+        def ruby_omit_hash_values?
+          RUBY_VERSION >= "3.1"
+        end
+
         private
 
+        # @since 2.0.0
+        # @api private
         attr_reader :inflector
 
+        # @since 2.0.0
+        # @api private
         attr_reader :app
+
+        # @since 2.1.0
+        # @api private
+        attr_reader :options
       end
     end
   end

data/lib/hanami/cli/generators/gem/app/404.html

@@ -0,0 +1,82 @@
+<!DOCTYPE html>
+<html lang="en">
+<head>
+  <meta charset="UTF-8">
+  <meta name="viewport" content="width=device-width, initial-scale=1.0">
+  <title>The page you were looking for doesn’t exist (404)</title>
+  <style>
+    :root {
+      --foreground-rgb: 0, 0, 0;
+      --background-rgb: 255, 255, 255;
+      --font-sans: ui-sans-serif,system-ui,-apple-system,BlinkMacSystemFont,Segoe UI,Roboto,Helvetica Neue,Arial,Noto Sans,sans-serif,Apple Color Emoji,Segoe UI Emoji,Segoe UI Symbol,Noto Color Emoji;
+    }
+
+    @media (prefers-color-scheme: dark) {
+      :root {
+        --foreground-rgb: 255, 255, 255;
+        --background-rgb: 0, 0, 0;
+      }
+    }
+
+    * {
+      box-sizing: border-box;
+      margin: 0;
+      padding: 0;
+    }
+
+    body,
+    html {
+      max-width: 100vw;
+      overflow-x: hidden;
+      font-size: 100%;
+    }
+
+    body {
+      color: rgb(var(--foreground-rgb));
+      background: rgb(var(--background-rgb));
+      font-family: var(--font-sans);
+      font-style: normal;
+    }
+
+    main {
+      display: flex;
+      flex-direction: column;
+      align-items: center;
+      justify-content: center;
+      height: 100vh;
+      padding: 0 4vw;
+    }
+
+    .message {
+      display: flex;
+      gap: 1rem;
+      flex-direction: column;
+      text-align: center;
+    }
+
+    .message h1 {
+      font-size: 2rem;
+      font-weight: 500;
+    }
+
+    p {
+      line-height: 1.6;
+    }
+
+    @media (prefers-color-scheme: dark) {
+      html {
+        color-scheme: dark;
+      }
+    }
+  </style>
+  </head>
+  <body>
+    <!-- This file lives in public/404.html -->
+    <main>
+      <div class="message">
+        <h1>404</h1>
+        <p>The page you were looking for doesn’t exist.</p>
+      </div>
+    </main>
+  </body>
+</html>

data/lib/hanami/cli/generators/gem/app/500.html

@@ -0,0 +1,82 @@
+<!DOCTYPE html>
+<html lang="en">
+<head>
+  <meta charset="UTF-8">
+  <meta name="viewport" content="width=device-width, initial-scale=1.0">
+  <title>We’re sorry, but something went wrong (500)</title>
+  <style>
+    :root {
+      --foreground-rgb: 0, 0, 0;
+      --background-rgb: 255, 255, 255;
+      --font-sans: ui-sans-serif,system-ui,-apple-system,BlinkMacSystemFont,Segoe UI,Roboto,Helvetica Neue,Arial,Noto Sans,sans-serif,Apple Color Emoji,Segoe UI Emoji,Segoe UI Symbol,Noto Color Emoji;
+    }
+
+    @media (prefers-color-scheme: dark) {
+      :root {
+        --foreground-rgb: 255, 255, 255;
+        --background-rgb: 0, 0, 0;
+      }
+    }
+
+    * {
+      box-sizing: border-box;
+      margin: 0;
+      padding: 0;
+    }
+
+    body,
+    html {
+      max-width: 100vw;
+      overflow-x: hidden;
+      font-size: 100%;
+    }
+
+    body {
+      color: rgb(var(--foreground-rgb));
+      background: rgb(var(--background-rgb));
+      font-family: var(--font-sans);
+      font-style: normal;
+    }
+
+    main {
+      display: flex;
+      flex-direction: column;
+      align-items: center;
+      justify-content: center;
+      height: 100vh;
+      padding: 0 4vw;
+    }
+
+    .message {
+      display: flex;
+      gap: 1rem;
+      flex-direction: column;
+      text-align: center;
+    }
+
+    .message h1 {
+      font-size: 2rem;
+      font-weight: 500;
+    }
+
+    p {
+      line-height: 1.6;
+    }
+
+    @media (prefers-color-scheme: dark) {
+      html {
+        color-scheme: dark;
+      }
+    }
+  </style>
+  </head>
+  <body>
+    <!-- This file lives in public/500.html -->
+    <main>
+      <div class="message">
+        <h1>500</h1>
+        <p>We’re sorry, but something went wrong.</p>
+      </div>
+    </main>
+  </body>
+</html>

data/lib/hanami/cli/generators/gem/app/app_css.erb

@@ -0,0 +1,5 @@
+body {
+  background-color: #fff;
+  color: #000;
+  font-family: sans-serif;
+}

data/lib/hanami/cli/generators/gem/app/app_js.erb

@@ -0,0 +1 @@
+import "../css/app.css";

data/lib/hanami/cli/generators/gem/app/app_layout.erb

@@ -0,0 +1,18 @@
+<!DOCTYPE html>
+<html lang="en">
+  <head>
+    <meta charset="UTF-8">
+    <meta name="viewport" content="width=device-width, initial-scale=1.0">
+    <title><%= humanized_app_name %></title>
+    <%- if generate_assets? -%>
+    <%%= favicon_tag %>
+    <%%= stylesheet_tag "app" %>
+    <%- end -%>
+  </head>
+  <body>
+    <%%= yield %>
+    <%- if generate_assets? -%>
+    <%%= javascript_tag "app" %>
+    <%- end -%>
+  </body>
+</html>

data/lib/hanami/cli/generators/gem/app/assets.js

@@ -0,0 +1,16 @@
+import * as assets from "hanami-assets";
+
+await assets.run();
+
+// To provide additional esbuild (https://esbuild.github.io) options, use the following:
+//
+// Read more at: https://guides.hanamirb.org/assets/customization/
+//
+// await assets.run({
+//   esbuildOptionsFn: (args, esbuildOptions) => {
+//     // Add to esbuildOptions here. Use `args.watch` as a condition for different options for
+//     // compile vs watch.
+//
+//     return esbuildOptions;
+//   }
+// });

data/lib/hanami/cli/generators/gem/app/dev

@@ -0,0 +1,8 @@
+#!/usr/bin/env sh
+
+if ! gem list foreman -i --silent; then
+  echo "Installing foreman..."
+  gem install foreman
+fi
+
+exec foreman start -f Procfile.dev "$@"

data/lib/hanami/cli/generators/gem/app/gemfile.erb

@@ -2,23 +2,31 @@
 
 source "https://rubygems.org"
 
-gem "hanami", "<%= hanami_version %>"
-gem "hanami-router", "<%= hanami_version %>"
-gem "hanami-controller", "<%= hanami_version %>"
-gem "hanami-validations", "<%= hanami_version %>"
+<%= hanami_gem("hanami") %>
+<%- if generate_assets? -%>
+<%= hanami_gem("assets") %>
+<%- end -%>
+<%= hanami_gem("controller") %>
+<%= hanami_gem("router") %>
+<%= hanami_gem("validations") %>
+<%= hanami_gem("view") %>
 
 gem "dry-types", "~> 1.0", ">= 1.6.1"
 gem "puma"
 gem "rake"
 
+group :development do
+  <%= hanami_gem("webconsole") %>
+end
+
 group :development, :test do
   gem "dotenv"
 end
 
 group :cli, :development do
-  gem "hanami-reloader"
+  <%= hanami_gem("reloader") %>
 end
 
 group :cli, :development, :test do
-  gem "hanami-rspec"
+  <%= hanami_gem("rspec") %>
 end

data/lib/hanami/cli/generators/gem/app/gitignore.erb

@@ -0,0 +1,6 @@
+.env
+log/*
+<%- if generate_assets? -%>
+public/
+node_modules/
+<%- end -%>