roda-project 0.1.12 → 0.1.13

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ba772c511bc001bfa35bf4345638652b7291dd2e144003922fa85880e7dc03f3
-  data.tar.gz: be9c85ed58652607a5614d7f37d0878085f7834f257cd2053d766d067fd71a44
+  metadata.gz: 3156e8ffc1fbf7c48c30c1224bfccd2bf66c775b90cb802ada325c2ef2a5607e
+  data.tar.gz: 02e04e9cb18a32f82cad2fceb59f1d567d33fe61330f1f0a26bb6e38ebf3b618
 SHA512:
-  metadata.gz: 63ef03a38f04ae88bda73eb7d890c3d80fda95521695a4e7ad6f19bd30a84630bff9f4daa4b7a8d08818fe77a235241bcb60f48e58e060646b2cd8c3dad62fd0
-  data.tar.gz: 9737a1545992102d0e82c5563cc0a29ae6c0c15d6b24bf07f16f493f5421b043b77be2b15ca2894157358f89b077e9cc9e7f42f84ed114fb9e59d8da0c92be38
+  metadata.gz: b2a91d0af7f801951d65f288a3fcbc0012b3779e6736dfdd94d7703377834cad15d8a8680293b1800a8293e90cfb59d8d3f971e1e67abedf682b32a432e9920a
+  data.tar.gz: b80916d58cdd4a167f8be8a9e5e43f4c56730457818b6cfee081ac4946d1e353284c7b6d087f9d030a03d7a705426e78fe871610dd5438dfe3c1c9bb1d426563

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

@@ -0,0 +1,120 @@
+class Roda
+  module Project
+    module Bin
+      class Generators < ::Thor
+        class Service < Roda::Project::Bin::Generator
+          include Roda::Project::Helpers::Inflections
+
+          def call
+            unless valid_args?
+              puts "Usage: bin/roda g service <module|class> <name>"
+              exit 1
+            end
+
+            puts "* creating service"
+            create_service
+            create_service_spec
+          end
+
+          def create_service
+            ensure_and_get_path("app/services", service_relative_path)
+            filename = File.join("app/services", *name_segments[0..-2], "#{service_file_basename}.rb")
+            File.write(filename, code)
+
+            action_success_message(filename)
+          end
+
+          def create_service_spec
+            ensure_and_get_path("spec/app/services", service_relative_path)
+            filename = File.join("spec/app/services", *name_segments[0..-2], "#{service_file_basename}_spec.rb")
+            File.write(filename, spec_code)
+
+            action_success_message(filename)
+          end
+
+          def spec_code
+            depth = 2 + name_segments.length - 1
+            relative_prefix = "../" * depth
+            <<~RUBY
+              require_relative "#{relative_prefix}spec_helper"
+
+              describe #{qualified_class_name} do
+              end
+            RUBY
+          end
+
+          def code
+            leaf_keyword = service_type
+            if name_segments.length == 1
+              <<~RUBY
+                #{leaf_keyword} #{camelize(name_segments.last)}
+                end
+              RUBY
+            else
+              depth = name_segments.length - 1
+              leaf_indent = "  " * depth
+              lines = [
+                "#{leaf_indent}#{leaf_keyword} #{camelize(name_segments.last)}",
+                "#{leaf_indent}end"
+              ]
+
+              name_segments[0..-2].map { |s| camelize(s) }.reverse.each_with_index do |mod, idx|
+                mod_indent = "  " * (depth - 1 - idx)
+                lines = ["#{mod_indent}module #{mod}"] + lines + ["#{mod_indent}end"]
+              end
+
+              lines.join("\n") + "\n"
+            end
+          end
+
+          def name_segments
+            @name_segments ||= service_name.split("/")
+          end
+
+          def qualified_class_name
+            @qualified_class_name ||= name_segments.map { |s| camelize(s) }.join("::")
+          end
+
+          def service_relative_path
+            @service_relative_path ||= if name_segments.length > 1
+              File.join(*name_segments[0..-2], service_file_basename)
+            else
+              service_file_basename
+            end
+          end
+
+          def service_file_basename
+            @service_file_basename ||= underscore(name_segments.last)
+          end
+
+          def service_type
+            @service_type ||= parse_args[:type]
+          end
+
+          def service_name
+            @service_name ||= parse_args[:name]
+          end
+
+          def parse_args
+            @parse_args ||= begin
+              if %w[module class].include?(@args[0].to_s.downcase)
+                { type: @args[0].to_s.downcase, name: @args[1].to_s }
+              else
+                { type: "class", name: @args[0].to_s }
+              end
+            end
+          end
+
+          def valid_args?
+            return false unless %w[module class].include?(service_type)
+            return false if service_name.empty?
+            return false if service_name.include?(" ")
+            return false if service_name.match?(/\A\d/)
+
+            true
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -20,6 +20,15 @@ class Roda
           Model.new(context:, args:, options:).call
         end
 
+        desc "service", "Create service module or class and test scaffold"
+        def service(*args)
+          Service.new(context:, args:, options:).call
+        end
+
+        def self.exit_on_failure?
+          true
+        end
+
         private
 
         def context

data/lib/roda/project/cli.rb

@@ -26,14 +26,16 @@ class Roda
             puts "\n* create your database\n"
             puts "$ bin/roda db create"
           end
-          puts "\nmigrate the database (use RACK_ENV to migrate 'test' or 'production' environments):\n\n"
-          puts "$ bin/roda db migrate"
+          if @context.rodauth?
+            puts "\nmigrate the database (use RACK_ENV to migrate 'test' or 'production' environments):\n\n"
+            puts "$ bin/roda db migrate"
+          end
         end
         puts "\nrun and watch the project in dev mode:\n"
         puts "\n$ bin/roda dev"
         if @context.fullstack?
           puts "\ncompile and watch assets:\n"
-          puts "\n$ bin/roda assets:dev"
+          puts "\n$ bin/roda assets -w"
         end
         puts "\nrun 'bin/roda' inside #{@context.project_name} to see all available tasks\n\n"
       rescue TTY::Reader::InputInterrupt
@@ -102,6 +104,8 @@ class Roda
           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")
+          action_success_message("app/config/locales")
           cp_dir("front-end", "app/views")
           action_success_message("app/views")
           cp_dir("front-end", "public/assets")

data/lib/roda/project/jeremy_template_creator.rb

@@ -1,4 +1,4 @@
-require 'fileutils'
+require "fileutils"
 
 class Roda
   module Project
@@ -12,7 +12,7 @@ class Roda
         success = system("git clone --depth 1 #{repo_url} #{@context.project_name}")
         abort("\nCould not download the template.") unless success
 
-        git_dir = File.join(@context.project_name, '.git')
+        git_dir = File.join(@context.project_name, ".git")
         if Dir.exist?(git_dir)
           FileUtils.rm_rf(git_dir)
           puts "\n* Cleaned up template git history.\n\n"
@@ -24,10 +24,9 @@ class Roda
         system(setup_command)
 
         action_success_message(setup_command, "run")
-        puts "\n Setup is done! follow the link below to learn about this template:"
-        puts "\n #{repo}"
+        puts "\nSetup is done! follow the link below to learn about this template:"
+        puts "\n#{repo_url}"
       end
     end
   end
 end
-

data/lib/roda/project/main_context.rb

@@ -108,7 +108,7 @@ class Roda
       def root_example
         return 'view("index")' if fullstack?
 
-        '{ message: "#{t.hello.message}" }'
+        '{ message: "hello world" }'
       end
       # rubocop:enable Lint/InterpolationCheck
 

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

@@ -69,7 +69,6 @@ class <%= context.const_project_name %> < Roda
     # r.i18n_set_locale_from(:session)<% end %>
     <% if context.rodauth? %>
     r.rodauth
-    rodauth.require_authentication
     <% end  %>
     r.root do
       <%= context.root_example %>

data/lib/roda/project/templates/base/minimal/AGENTS.md

@@ -1,9 +1,18 @@
-Act as a Ruby specialist.
+# Project Code Generation Rules
 
-This is a web application written using the Roda web framework
+## Core Stack
+- **Web Framework**: Roda (STRICT: Do NOT use Rails, ActionController, or Sinatra conventions).
+- **Autoloader**: Zeitwerk (Do NOT manually `require` files located in the `app/` directory. Only require standard libraries or gems).
+- **No Rails Magic:** Do not use `ActiveSupport` methods (like `.present?` or `.blank?`) unless the gem is explicitly in the Gemfile.
 
-## Project guidelines
+## Code Style & Conventions
 
-- **Never** deliver code without tests validating the code (execute with `rake test`)
-- **Never** write long comments in the code
-- **Always** use clean code
+### 1. Types
+- Rely on standard Ruby 3.x patterns. Use explicit YARD docs for method signatures.
+
+### 2. Routing (Roda)
+- Do not create deep routing blocks. Use Roda's tree routing efficiently (`r.on`, `r.is`, `r.get`, `r.post`).
+
+### 3. Boot Sequence & Initialization
+- **`boot.rb`**: The absolute starting point. It sets up `Bundler` and boots `Zeitwerk`.
+- **`config.ru`**: The Rack entrypoint. It defines middleware and mounts the primary Roda application class defined in `app.rb`.

data/lib/roda/project/templates/base/minimal/bin/roda.erb

@@ -42,6 +42,10 @@ class CLI < Thor
     end
   end
   map "s" => "server"
+
+  def self.exit_on_failure?
+    true
+  end
 end
 
 CLI.start(ARGV)

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

@@ -0,0 +1,47 @@
+# 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
+
+### 1. Types
+- Rely on standard Ruby 3.x patterns. Use explicit YARD docs for method signatures.
+
+### 2. Routing (Roda)
+- 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 %>
+
+### 3. Database & Models (Sequel)
+- Models reside in `app/models/`.
+- Migrations reside in `db/migrations/` and MUST use sequential numbering (e.g., `001_...`).
+- 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 %>### 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`).
+
+### 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/`.
+- **`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).
+
+#### Generators
+- 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

@@ -48,5 +48,6 @@ group :development do
   gem "minitest"
   gem "minitest-hooks"
 <% else %>
-  gem "rspec"<% end %>
+  gem "rspec"<% end %><% if context.database? %>
+  gem "sequel-annotate"<% end %>
 end

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

@@ -5,7 +5,7 @@ module Config
         secret: ENV["SESSION_SECRET"] || 'DEV-ONLY-8<FQF8HiF)>l0hbPk£vBQ#IrYsoO}14k\l+-/gIU[j}l0hbPk£vBQ#IrY',
         environment:,<% if context.rodauth? %>
         hmac_secret: ENV["RODAUTH_HMAC_SECRET"] || 'DEV-ONLY',
-        jwt_secret: ENV["JWT_SECRET"] || 'DEV-ONLY',<% end %><% if context.fullstack? %>
+        jwt_secret: ENV["JWT_SECRET"] || 'DEV-ONLY'<% end %><% if context.fullstack? %>,
         i18n: {
           translations: ["app/config/locales", "app/config/locales/foo"],
           locale: ["en", "pt-br"]
@@ -24,8 +24,8 @@ module Config
             escape: true,               # For Erubi templates, escapes %= by default (use %== for unescaped
             chain_appends: true,        # For Erubi templates, improves performance
             skip_compiled_encoding_detection: true, # Unless you need encodings explicitly specified
-          }<% end %>
-        }
+          }
+        }<% end %>
       }
     end
 

data/lib/roda/project/templates/base/scaffold/app/routes/foo.rb.erb

@@ -1,5 +1,6 @@
 class <%= context.const_project_name %>
-  hash_branch "foo" do |r|
+  hash_branch "foo" do |r|<% if context.rodauth? %>
+    rodauth.require_authentication<% end  %>
     r.get "bar" do
       <%= context.foo_bar_example %>
     end

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

@@ -3,7 +3,7 @@ require "thor"
 require "roda/project/bin/generators"
 <% if context.database? %>
 class Db < Thor
-  desc "migrate", "Migrate the database. Optional: provide target version, e.g., 'roda db:migrate 1'"
+  desc "migrate", "Migrate the database (use RACK_ENV to migrate 'test' or 'production' environments). Optional: provide target version, e.g., 'roda db:migrate 1'"
   option :target, type: :numeric, aliases: "-t", desc: "provide target version"
   def migrate
     require_db_deps
@@ -148,6 +148,10 @@ class CLI < Thor
   desc "generate", "Commands to generate code"
   <%= context.to_thor_option %>
   subcommand "generate", Roda::Project::Bin::Generators
+
+  def self.exit_on_failure?
+    true
+  end
 end
 
 CLI.start(ARGV)

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

@@ -32,4 +32,10 @@ Providers::Mailer.boot
 Providers::Logger.boot
 
 # Consts<% if context.database %>
-DB = Providers::DB::Conn.get<% end %>
+DB = Providers::DB::Conn.get
+
+# Automatic models annotations in dev environment
+if Config.not_production?
+  require 'sequel/annotate'
+  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.12"
+    VERSION = "0.1.13"
   end
 end

data/lib/roda/project.rb

@@ -71,6 +71,8 @@ require_relative "project/bin/generators/migration/code_builder"
 require_relative "project/bin/generators/model"
 # Generators/routes
 require_relative "project/bin/generators/routes"
+# Generators/service
+require_relative "project/bin/generators/service"
 # Generators/base
 require_relative "project/bin/generators"
 # Version

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: roda-project
 version: !ruby/object:Gem::Version
-  version: 0.1.12
+  version: 0.1.13
 platform: ruby
 authors:
 - Henrique F. Teixeira
@@ -85,6 +85,7 @@ files:
 - lib/roda/project/bin/generators/migration/field_parser.rb
 - lib/roda/project/bin/generators/model.rb
 - lib/roda/project/bin/generators/routes.rb
+- lib/roda/project/bin/generators/service.rb
 - lib/roda/project/cli.rb
 - lib/roda/project/generator.rb
 - lib/roda/project/helpers/ids.rb
@@ -104,15 +105,11 @@ files:
 - lib/roda/project/templates/base/minimal/boot.rb
 - lib/roda/project/templates/base/minimal/config.ru
 - lib/roda/project/templates/base/minimal/public/exception_page.css
-- lib/roda/project/templates/base/scaffold/AGENTS.md
+- lib/roda/project/templates/base/scaffold/AGENTS.md.erb
 - lib/roda/project/templates/base/scaffold/Gemfile.erb
 - lib/roda/project/templates/base/scaffold/Guardfile
 - lib/roda/project/templates/base/scaffold/README.md
 - lib/roda/project/templates/base/scaffold/app/config/config.rb.erb
-- lib/roda/project/templates/base/scaffold/app/config/locales/en.yml
-- lib/roda/project/templates/base/scaffold/app/config/locales/foo/en.yml
-- lib/roda/project/templates/base/scaffold/app/config/locales/foo/pt-br.yml
-- lib/roda/project/templates/base/scaffold/app/config/locales/pt-br.yml
 - lib/roda/project/templates/base/scaffold/app/config/providers/logger.rb
 - lib/roda/project/templates/base/scaffold/app/config/providers/mailer.rb
 - lib/roda/project/templates/base/scaffold/app/routes/foo.rb.erb
@@ -125,6 +122,10 @@ files:
 - lib/roda/project/templates/front-end/app/assets/css/app.css
 - lib/roda/project/templates/front-end/app/assets/js/app.js
 - lib/roda/project/templates/front-end/app/assets/js/some/foo.js
+- lib/roda/project/templates/front-end/app/config/locales/en.yml
+- lib/roda/project/templates/front-end/app/config/locales/foo/en.yml
+- lib/roda/project/templates/front-end/app/config/locales/foo/pt-br.yml
+- lib/roda/project/templates/front-end/app/config/locales/pt-br.yml
 - lib/roda/project/templates/front-end/app/views/foo/bar.erb
 - lib/roda/project/templates/front-end/app/views/index.erb
 - lib/roda/project/templates/front-end/app/views/layout.erb

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

@@ -1,9 +0,0 @@
-Act as a Ruby specialist.
-
-This is a web application written using the Roda web framework
-
-## Project guidelines
-
-- **Never** deliver code without tests validating the code (execute with `rake test`)
-- **Never** write long comments in the code
-- **Always** use clean code