roda-project 0.1.17 → 0.1.18

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6fa6f449cc4a6f6e7342135d2de859c481b517dc9666ca9e9d64bbc5141b27b5
-  data.tar.gz: f95248f05abe4a1df4b5cd1018823c9243d1fa27fab9904b6f3c9dc966f972e4
+  metadata.gz: f0b645d449bd52931506a9e9ee0ef203d14f8b6606cee831d1570bae7e8b8e66
+  data.tar.gz: ca8c1717d95f3bb0aebe8f698df9dee7306eb687b2c7d763a2f6d3d4ea46a746
 SHA512:
-  metadata.gz: 9022aca6837ac8803328e3d785514fe3c93d9bdbd2a272c1eee5c1ea231298543db5ef3840fd53f83ba5a6f56d92199a1750d8462635b3146ddb6adea4407067
-  data.tar.gz: a589f4edadacd2f4aa54a5ef53526764c6bebefbacc16553768fc0d24a38851c7744577c843279d84a8976a287aeb0208f37e66f15e6f2ec5a8e4c0a4a060645
+  metadata.gz: f60f531f4683da41ba01d19e67ded642ffb4cf8e828044287354d11362bb31a07cdb6ff4affd75483ebc384d11140b4c9014173af24116b95c4efaaba93173c5
+  data.tar.gz: 0d87b9e35efedb3f34dd250edfbdf12bae629d1c92562d9a0652aff2c6dd741a67515119ec08ac79855a7626f5f65766c5a59c13a2399cdeef126b3a58a42717

data/lib/roda/project/bin/generators/routes.rb

@@ -4,9 +4,12 @@ class Roda
     module Bin
       class Generators < ::Thor
         class Routes < Roda::Project::Bin::Generator
+          DEFAULT_VIEW_NAME = "index"
+          VALID_METHODS = %w[get post delete put patch].freeze
+
           def call
             if branch_name.nil? || branch_name.empty? || routes_list.nil? || routes_list.empty?
-              puts "Usage: bin/roda g routes branch_name route1 route2:method"
+              puts "Usage: bin/roda g routes branch_name route1 method:route2"
               exit 1
             end
 
@@ -21,52 +24,40 @@ class Roda
 
           def generate_routes
             filename = File.join(ensure_and_get_path("app/routes", branch_name), "#{branch_name}.rb")
-            route_definitions = routes_list.map do |route_str|
+            route_definitions = routes_list.map { |route_str| build_route_definition(route_str) }.join("\n\n")
+
+            write_file(filename, routes_file_content(route_definitions))
+          end
+
+          def generate_views
+            return unless must_generate_views?
+
+            @context.inertia? ? generate_inertia_views : generate_erb_views
+          end
+
+          def generate_erb_views
+            branch_views_dir = File.join("app/views", branch_name)
+            FileUtils.mkdir_p(branch_views_dir)
+            routes_list.each do |route_str|
               method, name = parse_route_string(route_str)
-              view_name = name
-              view_name = "index" if view_name == nil
-              view_line = (method == "get" && must_generate_views?) ? "\n      view('#{view_name}')" : ""
-
-              if name != nil
-                "    r.#{method} \"#{name}\" do#{view_line}\n    end"
-              else
-                "    r.#{method} do#{view_line}\n    end"
-              end
-            end.join("\n\n")
+              next unless method == "get"
 
-            hash_branch_header = if branch_name.include?("/")
-              parts = branch_name.split("/")
-              sub_path = parts[0..-2].join("/")
-              branch_segment = parts.last
-              "hash_branch #{namespace_for(sub_path)}, \"#{branch_segment}\" do |r|"
-            else
-              "hash_branch \"#{branch_name}\" do |r|"
+              name = DEFAULT_VIEW_NAME if name.nil?
+              write_file(File.join(branch_views_dir, "#{name}.erb"), "")
             end
-
-            content = <<~RUBY
-      class #{@context.const_project_name}
-        #{hash_branch_header}
-      #{route_definitions}
-        end
-      end
-            RUBY
-            File.write(filename, content)
-            action_success_message(filename)
           end
 
-          def generate_views
-            if must_generate_views?
-              branch_views_dir = File.join("app/views", branch_name)
-              FileUtils.mkdir_p(branch_views_dir)
-              routes_list.each do |route_str|
-                method, name = parse_route_string(route_str)
-                if method == "get"
-                  name = "index" if name == nil
-                  view_filename = File.join(branch_views_dir, "#{name}.erb")
-                  File.write(view_filename, "")
-                  action_success_message(view_filename)
-                end
-              end
+          def generate_inertia_views
+            views_dir = "app/assets/js/inertia/views"
+            FileUtils.mkdir_p(views_dir)
+            routes_list.each do |route_str|
+              method, name = parse_route_string(route_str)
+              next unless method == "get"
+
+              path = InertiaPath.new(branch_name, name)
+              view_filename = File.join(views_dir, "#{path.view_path}.jsx")
+              FileUtils.mkdir_p(File.dirname(view_filename))
+              write_file(view_filename, inertia_component_content(path))
             end
           end
 
@@ -75,31 +66,16 @@ class Roda
             nesting_level = branch_name.count("/")
             relative_spec_helper_path = "../" * (2 + nesting_level) + "spec_helper"
 
-            test_route_definitions = routes_list.map do |route_str|
-              method, name = parse_route_string(route_str)
-
-              if name != nil
-                "  it \"responds to #{method.upcase} /#{branch_name}/#{name}\" do\n" \
-                  "    #{method} \"/#{branch_name}/#{name}\"\n" \
-                  "    expect(last_response.status).to eq(200)\n" \
-                  "  end"
-              else
-                "  it \"responds to #{method.upcase} /#{branch_name}\" do\n" \
-                  "    #{method} \"/#{branch_name}\"\n" \
-                  "    expect(last_response.status).to eq(200)\n" \
-                  "  end"
-              end
-            end.join("\n")
+            test_route_definitions = routes_list.map { |route_str| build_test_definition(route_str) }.join("\n")
 
             test_content = <<~RUBY
-      require_relative "#{relative_spec_helper_path}"
+              require_relative "#{relative_spec_helper_path}"
 
-      describe "Routes for #{branch_name}" do
-      #{test_route_definitions}
-      end
+              describe "Routes for #{branch_name}" do
+              #{test_route_definitions}
+              end
             RUBY
-            File.write(test_filename, test_content)
-            action_success_message(test_filename)
+            write_file(test_filename, test_content)
           end
 
           def generate_nested_branch_files
@@ -117,11 +93,61 @@ class Roda
 
               dir = File.dirname(filename)
               FileUtils.mkdir_p(dir) unless File.directory?(dir)
-              File.write(filename, nested_branch_file_content(prefix, index))
-              action_success_message(filename)
+              write_file(filename, nested_branch_file_content(prefix, index))
+            end
+          end
+
+          def build_route_definition(route_str)
+            method, name = parse_route_string(route_str)
+            view_line = build_view_line(method, name)
+            route_block(method, name, view_line)
+          end
+
+          def build_view_line(method, name)
+            return "" unless method == "get" && must_generate_views?
+
+            if @context.inertia?
+              "\n      inertia('#{InertiaPath.new(branch_name, name).view_path}')"
+            else
+              "\n      view('#{name || DEFAULT_VIEW_NAME}')"
             end
           end
 
+          def route_block(method, name, view_line)
+            route_name = name ? " \"#{name}\"" : ""
+            "    r.#{method}#{route_name} do#{view_line}\n    end"
+          end
+
+          def build_test_definition(route_str)
+            method, name = parse_route_string(route_str)
+            test_name = name ? " /#{branch_name}/#{name}" : " /#{branch_name}"
+            test_path = name ? " \"/#{branch_name}/#{name}\"" : " \"/#{branch_name}\""
+
+            "  it \"responds to #{method.upcase}#{test_name}\" do\n" \
+              "    #{method}#{test_path}\n" \
+              "    expect(last_response.status).to eq(200)\n" \
+              "  end"
+          end
+
+          def routes_file_content(route_definitions)
+            <<~RUBY
+      class #{@context.const_project_name}
+        #{build_hash_branch_header}
+      #{route_definitions}
+        end
+      end
+            RUBY
+          end
+
+          def build_hash_branch_header
+            return "hash_branch \"#{branch_name}\" do |r|" unless branch_name.include?("/")
+
+            parts = branch_name.split("/")
+            sub_path = parts[0..-2].join("/")
+            branch_segment = parts.last
+            "hash_branch #{namespace_for(sub_path)}, \"#{branch_segment}\" do |r|"
+          end
+
           def nested_branch_file_content(prefix, index)
             parts = prefix.split("/")
             segment = parts.last
@@ -133,11 +159,11 @@ class Roda
             end
 
             <<~RUBY
-              class #{@context.const_project_name}
-                #{header} # #{prefix} branch
-                  r.hash_branches(#{namespace_for(prefix)}) # #{prefix}/ +1 routes
-                end
-              end
+      class #{@context.const_project_name}
+        #{header} # #{prefix} branch
+          r.hash_branches(#{namespace_for(prefix)}) # #{prefix}/ +1 routes
+        end
+      end
             RUBY
           end
 
@@ -154,12 +180,47 @@ class Roda
           end
 
           def must_generate_views?
-            @options[:views] && Dir.exist?("app/views")
+            return false unless @options[:views]
+
+            if @context.inertia?
+              Dir.exist?("app/assets/js/inertia/views")
+            else
+              Dir.exist?("app/views")
+            end
+          end
+
+          def inertia_component_content(path)
+            <<~JSX
+              import React from 'react'
+              import { Link } from '@inertiajs/react'
+              import Layout from '../components/Layout'
+
+              const #{path.component_name} = props => {
+                return (<Layout>
+                  <div>
+                    #{path.display_path}
+                  </div>
+                </Layout>)
+              }
+
+              export default #{path.component_name}
+            JSX
           end
 
           def parse_route_string(route_str)
             method, name = route_str.split(":", 2)
-            [method, name]
+            if name && VALID_METHODS.include?(method)
+              [method, name]
+            elsif name.nil? && VALID_METHODS.include?(route_str)
+              [route_str, nil]
+            else
+              ["get", route_str]
+            end
+          end
+
+          def write_file(filename, content)
+            File.write(filename, content)
+            action_success_message(filename)
           end
 
           def routes_list
@@ -169,6 +230,34 @@ class Roda
           def branch_name
             @branch_name ||= @args[0]
           end
+
+          class InertiaPath
+            attr_reader :view_path, :component_name, :display_path
+
+            def initialize(branch_name, name)
+              @view_path = build_view_path(branch_name, name)
+              @component_name = build_component_name(name)
+              @display_path = build_display_path(branch_name, name)
+            end
+
+            private
+
+            def build_view_path(branch_name, name)
+              segments = branch_name.split("/")
+              segments << (name || "index")
+              (segments[0..-2] + [segments.last.capitalize]).join("/")
+            end
+
+            def build_component_name(name)
+              (name || "index").capitalize
+            end
+
+            def build_display_path(branch_name, name)
+              segments = branch_name.split("/")
+              segments << (name || "index")
+              segments.join("/")
+            end
+          end
         end
       end
     end

data/lib/roda/project/bin/generators.rb

@@ -37,6 +37,7 @@ class Roda
           @context = Roda::Project::MainContext.new
           @context.project_name = options[:main_context][:project_name]
           @context.base = options[:main_context][:base]
+          @context.frontend = options[:main_context][:frontend]
           @context.database = options[:main_context][:database]
           @context.database_type = options[:main_context][:database_type]
           @context.rodauth = options[:main_context][:rodauth]

data/lib/roda/project/cli.rb

@@ -49,6 +49,10 @@ class Roda
         return if jeremy?
 
         retry_on_error { @context.base = read_line("(#{fullstack_id}) Fullstack (#{api_id}) API (#{minimal_id}) Minimal › ", fullstack_id).to_i }
+        if @context.fullstack?
+          retry_on_error { @context.frontend = read_line("(#{erb_id}) only ERB (#{inertia_id}) Inertia.js › ", erb_id).to_i }
+        end
+
         retry_on_error { @context.tests = read_line("(#{rspec_id}) RSpec (#{minitest_id}) Minitest › ", rspec_id).to_i }
 
         unless @context.minimal?
@@ -75,7 +79,7 @@ class Roda
         puts "* creating base project"
         if @context.minimal?
           TTY::File.copy_directory(
-            File.expand_path("templates/base/minimal", __dir__),
+            File.expand_path("templates/base-minimal", __dir__),
             "#{@dir}#{@context.project_name}",
             context: @context
           )
@@ -84,7 +88,7 @@ class Roda
         end
 
         TTY::File.copy_directory(
-          File.expand_path("templates/base/scaffold", __dir__),
+          File.expand_path("templates/base-scaffold", __dir__),
           "#{@dir}#{@context.project_name}",
           context: @context
         )
@@ -101,16 +105,19 @@ class Roda
       def add_front_end
         if @context.fullstack?
           puts "* adding front-end"
-          erb_cp_dir("front-end", "app/assets")
-          erb_cp_file("front-end", "esbuild.js")
-          erb_cp_file("front-end", "package.json")
-          cp_dir("front-end", "app/config/locales")
+          from_template = "front-end"
+          from_template = "front-end-inertia" if @context.inertia?
+
+          erb_cp_dir(from_template, "app/assets")
+          erb_cp_file(from_template, "esbuild.js")
+          erb_cp_file(from_template, "package.json")
+          cp_dir(from_template, "app/config/locales")
           action_success_message("app/config/locales")
-          cp_dir("front-end", "app/views")
+          cp_dir(from_template, "app/views")
           action_success_message("app/views")
-          cp_dir("front-end", "public/assets")
+          cp_dir(from_template, "public/assets")
           action_success_message("public/assets")
-          cp_dir("front-end", "public/images")
+          cp_dir(from_template, "public/images")
           action_success_message("public/images")
         end
       end
@@ -138,12 +145,12 @@ class Roda
 
       def add_test_files
         puts "* adding test files"
-        minimal_dir = @context.minimal? ? "minimal/" : ""
+        minimal_dir = @context.minimal? ? "minimal-" : ""
 
         if @context.rspec?
-          erb_cp_dir("tests/#{minimal_dir}rspec", "spec")
+          erb_cp_dir("tests-#{minimal_dir}rspec", "spec")
         else
-          erb_cp_dir("tests/#{minimal_dir}minitest", "spec")
+          erb_cp_dir("tests-#{minimal_dir}minitest", "spec")
         end
       end
     end

data/lib/roda/project/helpers/ids.rb

@@ -3,6 +3,8 @@ class Roda
     module Helpers
       module Ids
         def fullstack_id = Roda::Project::FULLSTACK
+        def erb_id = Roda::Project::ERB
+        def inertia_id = Roda::Project::INERTIA
         def api_id = Roda::Project::API
         def minimal_id = Roda::Project::MINIMAL
         def mysql_id = Roda::Project::MYSQL
@@ -23,6 +25,13 @@ class Roda
               when minimal_id
                 "MINIMAL"
               end
+            when :frontend
+              case id
+              when erb_id
+                "ERB"
+              when inertia_id
+                "INERTIA"
+              end
             when :database
               case id
               when mysql_id

data/lib/roda/project/main_context.rb

@@ -15,7 +15,8 @@ class Roda
         :default_db_url,
         :db_gem,
         :project_name,
-        :base
+        :base,
+        :frontend
       )
 
       def to_thor_option
@@ -30,6 +31,9 @@ class Roda
         if database?
           option << "    database_type: #{id_to_string(database_type, :database)},"
         end
+        if fullstack?
+          option << "\n    frontend: #{id_to_string(frontend, :frontend)},"
+        end
         option << "\n    }"
       end
 
@@ -49,6 +53,14 @@ class Roda
         @base = val
       end
 
+      def frontend=(val)
+        if ![erb_id, inertia_id].include?(val)
+          raise InvalidValue, "Invalid frontend option: #{val}"
+        end
+
+        @frontend = val
+      end
+
       def rodauth=(val)
         val = false if ![true, false].include?(val)
 
@@ -106,6 +118,7 @@ class Roda
       end
 
       def root_example
+        return 'inertia("Index")' if inertia?
         return 'view("index")' if fullstack?
 
         '{ message: "hello world" }'
@@ -124,6 +137,14 @@ class Roda
         base == minimal_id
       end
 
+      def inertia?
+        frontend == inertia_id
+      end
+
+      def erb?
+        frontend == erb_id
+      end
+
       def rodauth?
         rodauth == true
       end

data/lib/roda/project/templates/base/app/app.rb.erb

@@ -12,8 +12,17 @@ class <%= context.const_project_name %> < Roda
   plugin :render, **Config.get[:render]
   plugin :content_for, append: false
   plugin :flash
-  plugin :assets_manifest
-  <% end %>
+  plugin :assets_manifest<% if context.inertia? %>
+  plugin :inertia,
+    version: assets_version,
+    layout: {
+      head: [
+        '<meta http-equiv="x-ua-compatible" content="ie=edge">',
+        css_entrypoint_tag(:app)
+      ].join,
+      body: js_entrypoint_tag(:app)
+    }
+  <% end %><% end %>
   # Request / Response
   plugin :halt
   plugin :json

data/lib/roda/project/templates/{base/scaffold → base-scaffold}/AGENTS.md.erb

@@ -5,8 +5,9 @@
 - **Web Framework**: Roda (STRICT: Do NOT use Rails, ActionController, or Sinatra conventions).
 - **No Rails Magic:** Do not use `ActiveSupport` methods (like `.present?` or `.blank?`) unless the gem is explicitly in the Gemfile.<% if context.database %>
 - **ORM**: Sequel (STRICT: Do NOT use ActiveRecord. Use Sequel Models, Datasets, and Migrations).<% end %>
-- **Autoloader**: Zeitwerk (Do NOT manually `require` files located in the `app/` directory. Only require standard libraries or gems).<% if context.fullstack? %>
-- **Frontend**: esbuild + ERB (Fullstack mode).<% end %>
+- **Autoloader**: Zeitwerk (Do NOT manually `require` files located in the `app/` directory. Only require standard libraries or gems).<% if context.fullstack? && context.erb? %>
+- **Frontend**: esbuild + ERB (Fullstack mode).<% else %>
+- **Frontend**: esbuild + Inertia.js + React.js (Fullstack mode).<% end %>
 
 ## Code Style & Conventions<%= i = 0 %>
 
@@ -15,13 +16,18 @@
 - Rely on standard Ruby 3.x patterns. Use explicit YARD docs for method signatures.
 
 <% if context.fullstack? %>### <%= i=i+1 %>. Views & Presentation
-
+<% if context.erb? %>
 - ERB templates go in `app/views/`.
 - The `view` method inside a route block will match the hash branch to find the view path location:
 - For `hash_branch "foo/bar", "zas" do |r|`, calling `view('something')` will search an erb file in "views/foo/bar/zas/something.erb".
-- For `hash_branch "zas" do |r|`, calling `view('something')` will search an erb file in "views/zas/something.erb".
-
-<% end %>### <%= i=i+1 %>. Routing
+- For `hash_branch "zas" do |r|`, calling `view('something')` will search an erb file in "views/zas/something.erb".<% else %>
+- Inertia.js views go in `app/assets/js/inertia/views/`.
+- The `inertia` method inside a route block will find the inertia view location and pass the props to the component:
+- Calling `inertia('Something')` will search an inertia view file in "app/assets/js/inertia/views/Something.jsx".
+- Calling `inertia('Zoo', { name: "foo", age: 3 })` will search an inertia view file in "app/assets/js/inertia/views/Zoo.jsx" and set the props data in the React function component.
+- Calling `inertia('Foo/Bar')` will search an inertia view file in "app/assets/js/inertia/views/Foo/Bar.jsx".<% end %>
+<% end %>
+### <%= i=i+1 %>. Routing
 
 - The main app resides in `app/[project_name].rb`.
 - Sub-routes MUST be implemented using Roda **Hash Branches** (`hash_branches` plugin) and placed in `app/routes/`.

data/lib/roda/project/templates/{base/scaffold → base-scaffold}/Gemfile.erb

@@ -22,8 +22,9 @@ gem "puma"
 # gem 'thin'<% if context.fullstack? %>
 
 # Views
-gem 'roda-assets_manifest'
-<% end %>
+gem 'roda-assets_manifest'<% if context.inertia? %>
+gem 'roda-inertia-lite'
+<% end %><% end %>
 # Performance
 gem "oj"
 # gem 'async'

data/lib/roda/project/templates/front-end-inertia/app/assets/css/app.css

@@ -0,0 +1,20 @@
+body {
+  background: black;
+  color: white;
+  margin: 1em 2em;
+  font-family: monospace;
+}
+
+a {
+  color: #ef4348;
+  margin-right: 1em;
+}
+
+img {
+  width: 25%;
+  margin-bottom: 1em;
+}
+
+.navbar {
+  margin-bottom: 1em;
+}

data/lib/roda/project/templates/front-end-inertia/app/assets/js/app.js

@@ -0,0 +1,11 @@
+import React from 'react'
+import { createInertiaApp } from '@inertiajs/react'
+import { createRoot } from 'react-dom/client'
+
+createInertiaApp({
+  resolve: name => import(`./inertia/views/${name}.jsx`),
+  page: JSON.parse(document.getElementById('app').dataset.page),
+  setup({ el, App, props }) {
+    createRoot(el).render(<App {...props} />)
+  },
+})

data/lib/roda/project/templates/front-end-inertia/app/assets/js/inertia/components/Layout.jsx

@@ -0,0 +1,11 @@
+import React from 'react'
+//import { Link } from "@inertiajs/react"
+
+export default function Layout({ children }) {
+  return (
+    <div>
+      (Layout)
+      {children}
+    </div>
+  )
+}

data/lib/roda/project/templates/front-end-inertia/app/assets/js/inertia/views/Index.jsx

@@ -0,0 +1,13 @@
+import React from 'react'
+import Layout from '../components/Layout'
+//import { Link } from '@inertiajs/react'
+
+const Index = props => {
+  return (<Layout>
+    <div>
+      Hello from Roda + Inertia.js!
+    </div>
+  </Layout>)
+}
+
+export default Index