roda-project 0.1.15 → 0.1.17

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5c22151c8712cbc374521e061d5c91e5b4dae3b55ab5d55fc3227fbf57ef49c6
-  data.tar.gz: 31f190125960494423689e00f70fe16fb32c05da6ea5a5c356fa33b99792d8f3
+  metadata.gz: 6fa6f449cc4a6f6e7342135d2de859c481b517dc9666ca9e9d64bbc5141b27b5
+  data.tar.gz: f95248f05abe4a1df4b5cd1018823c9243d1fa27fab9904b6f3c9dc966f972e4
 SHA512:
-  metadata.gz: 5533eef1235cbbf17bdee8305595a2eee7b32f298960a2b70b080f3ef633f329115d96ae8dcad13490cdfcbc03e092b1ed4559df1fb696604b482e3283ac0ef1
-  data.tar.gz: 74c4da7361e380d5eb8af1c16f61f06c7540e5fd5464b9df12c184aa4bea4b171f9903e8800bba8c99fcca5f792b67b1b914c1a9a65a86a360fb49c7ec6e586f
+  metadata.gz: 9022aca6837ac8803328e3d785514fe3c93d9bdbd2a272c1eee5c1ea231298543db5ef3840fd53f83ba5a6f56d92199a1750d8462635b3146ddb6adea4407067
+  data.tar.gz: a589f4edadacd2f4aa54a5ef53526764c6bebefbacc16553768fc0d24a38851c7744577c843279d84a8976a287aeb0208f37e66f15e6f2ec5a8e4c0a4a060645

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

@@ -12,9 +12,9 @@ class Roda
 
             puts "* creating routes"
             generate_routes
+            generate_nested_branch_files
             generate_views
             generate_tests
-            print_nested_branch_reminder
           end
 
           private
@@ -24,10 +24,10 @@ class Roda
             route_definitions = routes_list.map do |route_str|
               method, name = parse_route_string(route_str)
               view_name = name
-              view_name = "index" if view_name == ""
+              view_name = "index" if view_name == nil
               view_line = (method == "get" && must_generate_views?) ? "\n      view('#{view_name}')" : ""
 
-              if name != ""
+              if name != nil
                 "    r.#{method} \"#{name}\" do#{view_line}\n    end"
               else
                 "    r.#{method} do#{view_line}\n    end"
@@ -37,9 +37,8 @@ class Roda
             hash_branch_header = if branch_name.include?("/")
               parts = branch_name.split("/")
               sub_path = parts[0..-2].join("/")
-              namespace = sub_path.include?("/") ? ":\"#{sub_path}\"" : ":#{sub_path}"
               branch_segment = parts.last
-              "hash_branch #{namespace}, \"#{branch_segment}\" do |r|"
+              "hash_branch #{namespace_for(sub_path)}, \"#{branch_segment}\" do |r|"
             else
               "hash_branch \"#{branch_name}\" do |r|"
             end
@@ -62,7 +61,7 @@ class Roda
               routes_list.each do |route_str|
                 method, name = parse_route_string(route_str)
                 if method == "get"
-                  name = "index" if name == ""
+                  name = "index" if name == nil
                   view_filename = File.join(branch_views_dir, "#{name}.erb")
                   File.write(view_filename, "")
                   action_success_message(view_filename)
@@ -79,14 +78,14 @@ class Roda
             test_route_definitions = routes_list.map do |route_str|
               method, name = parse_route_string(route_str)
 
-              if name != ""
+              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" \
+                "  it \"responds to #{method.upcase} /#{branch_name}\" do\n" \
+                  "    #{method} \"/#{branch_name}\"\n" \
                   "    expect(last_response.status).to eq(200)\n" \
                   "  end"
               end
@@ -103,13 +102,63 @@ class Roda
             action_success_message(test_filename)
           end
 
+          def generate_nested_branch_files
+            return unless branch_name.include?("/")
+
+            parts = branch_name.split("/")
+            parts[0..-2].each_with_index do |_segment, index|
+              prefix = parts[0..index].join("/")
+              filename = File.join("app/routes", "#{prefix}.rb")
+
+              if File.exist?(filename)
+                ensure_hash_branches_line(filename, namespace_for(prefix))
+                next
+              end
+
+              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)
+            end
+          end
+
+          def nested_branch_file_content(prefix, index)
+            parts = prefix.split("/")
+            segment = parts.last
+            header = if index.zero?
+              "hash_branch \"#{segment}\" do |r|"
+            else
+              parent_path = parts[0..-2].join("/")
+              "hash_branch #{namespace_for(parent_path)}, \"#{segment}\" do |r|"
+            end
+
+            <<~RUBY
+              class #{@context.const_project_name}
+                #{header} # #{prefix} branch
+                  r.hash_branches(#{namespace_for(prefix)}) # #{prefix}/ +1 routes
+                end
+              end
+            RUBY
+          end
+
+          def ensure_hash_branches_line(filename, namespace)
+            expected_line = "r.hash_branches(#{namespace})"
+            return if File.read(filename).include?(expected_line)
+
+            puts "  warning: #{filename} already exists — please add:"
+            puts "    #{expected_line}"
+          end
+
+          def namespace_for(sub_path)
+            sub_path.include?("/") ? ":\"#{sub_path}\"" : ":#{sub_path}"
+          end
+
           def must_generate_views?
             @options[:views] && Dir.exist?("app/views")
           end
 
           def parse_route_string(route_str)
-            name, method = route_str.split(":", 2)
-            method ||= "get"
+            method, name = route_str.split(":", 2)
             [method, name]
           end
 
@@ -120,20 +169,6 @@ class Roda
           def branch_name
             @branch_name ||= @args[0]
           end
-
-          def print_nested_branch_reminder
-            return unless branch_name.include?("/")
-
-            parts = branch_name.split("/")
-            sub_path = parts[0..-2].join("/")
-            namespace = sub_path.include?("/") ? ":\"#{sub_path}\"" : ":#{sub_path}"
-
-            puts "\ndont forget to add:\n\n" \
-                 "autoload_hash_branch_dir(#{namespace}, \"./app/routes/#{sub_path}\")\n\n" \
-                 "route do |r|\n" \
-                 " r.on(\"#{sub_path}\") { r.hash_branches(#{namespace}) }\n" \
-                 "end\n"
-          end
         end
       end
     end

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

@@ -1,8 +1,9 @@
 class <%= context.const_project_name %> < Roda
   # Routing<% if context.fullstack? %>
-  plugin :hash_branch_view_namespace<% end %>
+  plugin :hash_branch_view_subdir<% end %>
   plugin :autoload_hash_branches
-  autoload_hash_branch_dir("./app/routes")
+  HASH_BRANCHES.each { |args| autoload_hash_branch_dir(*args) }
+
   plugin :all_verbs
   plugin :not_found
   <% if context.fullstack? %>

data/lib/roda/project/templates/base/scaffold/AGENTS.md.erb

@@ -1,47 +1,66 @@
 # Project Code Generation Rules
 
 ## Core Stack
+
 - **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 %>
 
-## Code Style & Conventions
+## Code Style & Conventions<%= i = 0 %>
+
+### <%= i=i+1 %>. Types
 
-### 1. Types
 - Rely on standard Ruby 3.x patterns. Use explicit YARD docs for method signatures.
 
-### 2. Routing (Roda)
+<% if context.fullstack? %>### <%= i=i+1 %>. Views & Presentation
+
+- 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
+
 - 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/`.
-- Do not create deep routing blocks. Use Roda's tree routing efficiently (`r.on`, `r.is`, `r.get`, `r.post`).<% if context.database %>
+- **Strict Segment Limit per Branch:** Each hash branch must contain only **one** additional route segment and only **one** CRUD. Do not create deep routing blocks, examples:
+- **Allowed** inside `hash_branch "foo" do |r|`: Handling `GET "foo/bar"`, `POST "foo/bar"`, `GET "foo/something"`, UPDATE `foo/[id]/bar`, GET `foo/[id]/bar` or `GET "foo"`.
+- **FORBIDDEN** inside `hash_branch "foo" do |r|`: Handling deeper segments like `GET "foo/bar/zas"` or `GET "foo/resource/[id]/edit"`.
+- **Solution for Deep Routes:** For deeper paths, you MUST create a new, nested hash branch (e.g., `hash_branch "foo", "bar" do |r|`), in a new nested directory like "app/routes/foo/bar" with views (if any) inside a new view directory like "views/foo/bar".
+- Use Roda's tree routing efficiently (`r.on`, `r.is`, `r.get`, `r.post`).
+- You **MUST** use the `bin/roda g routes` generator for create new route files, examples:
+- `bin/roda g routes branch/name get:foo post:bar` creates a file containing `GET "branch/name/foo"` and `POST "branch/name/bar"` routes.
+- `bin/roda g routes branch_name get post delete:foo` creates a file containing `GET "branch_name"`, `POST "branch_name"` and `DELETE "branch_name/foo"` routes.<% if context.database %>
+
+### <%= i=i+1 %>. Database & Models (Sequel)
 
-### 3. Database & Models (Sequel)
 - Models reside in `app/models/`.
 - Migrations reside in `db/migrations/` and MUST use sequential numbering (e.g., `001_...`).
+- Seeds reside in db/migrations/seeds.rb.
 - When writing database queries, use Sequel's dataset methods (e.g., `where`, `select`, `exclude`, `join`). Do not use string interpolation for SQL queries.
 
-<% end %><% if context.fullstack? %>### 4. Views & Presentation
-- ERB templates go in `app/views/`.
+<% end %>### <%= i=i+1 %>. Testing
 
-<% end %>### 5. Testing
 - Specs reside in `spec/app/`.
 - Use `rack-test` for route testing.
 - Ensure database transactions are rolled back after each test block.
 - Mirror the file structure of `app/` inside `spec/app/` (e.g., `app/models/user.rb` -> `spec/app/models/user_spec.rb`).
+- Each route **MUST** have tests for each behavior.
+- Each model custom public method **MUST** have tests.
+
+### <%= i=i+1 %>. Config
 
-### 6. Boot Sequence & Initialization
-- **`boot.rb`**: The absolute starting point. It sets up `Bundler`, boots `Zeitwerk` for autoloading the `app/` directory, and loads service providers from `app/config/providers/`.
+- **STRICT:** Config values and ENV **MUST** be centralized in `app/config/config.rb`.
+- External tools, gems or services that need a single initialization or/and specific configuration reside in `app/config/providers/*`.
+
+### <%= i=i+1 %>. Boot Sequence & Initialization
+
+- **`boot.rb`**: The absolute starting point. It sets up `Bundler`, global constants, boots `Zeitwerk` for autoloading the `app/` directory, and loads tools, gems or service providers from `app/config/providers/`.
 - **`config.ru`**: The Rack entrypoint. It defines middleware (like `Rack::LiveReload` in development) and mounts the primary Roda application class defined in `app/[project_name].rb`.
 
-### 7. Tooling
-- Do NOT run `bundle exec rake` for scaffolding/servers. The project uses a custom CLI: `bin/roda`. Suggest commands using `bin/roda` (e.g., generators, running the server).
+### <%= i=i+1 %>. Tooling
 
-#### Generators
+- Do NOT run `bundle exec rake` for scaffolding/servers. The project uses a custom CLI: `bin/roda`.
 - To maintain consistency and avoid manual boilerplate, the project uses custom generators for scaffolding new features. These automatically hook into Zeitwerk's expectations, Sequel's DSL, and Roda's Hash Branches.
-- **`bin/roda g routes <branch> [options]`**: Scaffolds a Roda hash branch file in `app/routes/`, matching spec files, and ERB views (for GET routes). Supports nested paths (e.g., `api/v1`) and bare verbs (e.g., `books :get :post`).<% if context.database %>
-- **`bin/roda g model <name> [fields]`**: Generates a Sequel ORM model class, a matching model spec, and a timestamped Sequel migration. Supports namespacing (`Admin/User`) and auto-pluralizes table names.
-- **`bin/roda g migration <name> [fields]`**: Creates a timestamped Sequel migration. It automatically detects intent from the name (e.g., `add_status_to_users` generates the `alter_table` block) and maps Rails-like field types (e.g., `user:references`, `body:text`) to Sequel schema methods.
-<% end %>- **`bin/roda g service <type> <name>`**: Scaffolds a class or module service in `app/services/` and a matching spec. Defaults to `class` if type is omitted.
-

data/lib/roda/project/templates/base/scaffold/Gemfile.erb

@@ -23,7 +23,6 @@ gem "puma"
 
 # Views
 gem 'roda-assets_manifest'
-gem 'roda-hash_branch_view_namespace'
 <% end %>
 # Performance
 gem "oj"

data/lib/roda/project/templates/base/scaffold/boot.rb.erb

@@ -31,11 +31,23 @@ Providers::Mailer.boot
 Providers::Logger.boot
 
 # Consts<% if context.database %>
-DB = Providers::DB::Conn.get
+DB = Providers::DB::Conn.get<% end %>
+ROUTES_DIR = "./app/routes"
+base_path = Pathname.new(ROUTES_DIR)
+HASH_BRANCHES = []
+HASH_BRANCHES << [base_path]
+Dir.glob(File.join(ROUTES_DIR, "**/*")).each do |dir_path|
+  next unless File.directory?(dir_path)
+
+  path = Pathname.new(dir_path)
+  relative_path = path.relative_path_from(base_path).to_s
+
+  HASH_BRANCHES << [relative_path.to_sym, path.to_s]
+end
 
 if Config.not_production?
-  require "debug"
+  require "debug"<% if context.database %>
   # Automatic models annotations in dev environment
   require 'sequel/annotate'
-  Sequel::Annotate.annotate(Dir['app/models/*.rb'], position: :before, border: true) rescue nil
-end<% end %>
+  Sequel::Annotate.annotate(Dir['app/models/*.rb'], position: :before, border: true) rescue nil<% end %>
+end

data/lib/roda/project/version.rb

@@ -2,6 +2,6 @@
 
 class Roda
   module Project
-    VERSION = "0.1.15"
+    VERSION = "0.1.17"
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: roda-project
 version: !ruby/object:Gem::Version
-  version: 0.1.15
+  version: 0.1.17
 platform: ruby
 authors:
 - Henrique F. Teixeira