roda-project 0.1.6 → 0.1.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a0848c0ffefb79c9a29e0f914ade9409ed3da6f94523afa9fd686647eb49c401
-  data.tar.gz: 9a100a0a6781bdd0c9d0a005f473db621f4f28749e95523186bddf338b0acd10
+  metadata.gz: 235c82e6d3bae7eebc1b331a1d74272222f3e5a6a0957536a68b4d766f82a34c
+  data.tar.gz: e8ee5c63d19ad043c2f0c55647b6534b6bc0186d2a92e67335ec9319e9a7c93a
 SHA512:
-  metadata.gz: 883ecbdc87121a984469a003ab1f2350ef3aa998bdda14efb6443d151b9378adf56f0704b66eb40c8e9765d193a2b3fdce521fc3cae4b3faf0de0039a8822136
-  data.tar.gz: 06b3aeba438bb755926afff42b68a66303f42332c97fcb9bca23f96e47399a16cda090e42d6835837ee091bcefb135d6f5f2a6ba54d2070164616be113e4e3be
+  metadata.gz: d371e15403ffec2a67ff2577a2044d671334380af4188b3b2cd828ef61f181a48ba30e30d2640042c6d534d41e4fba9acaa5aa553e27d1e50de7946f054c2762
+  data.tar.gz: 9413055aab700d47ecf17442ab7e2fff22d6db8d0fb7a3a94e9237b16a2b718763a14453f1b1eb36230561068e9c66c10c556478ee3f46e909d8177241028034

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

@@ -0,0 +1,11 @@
+class Roda
+  module Project
+    module Bin
+      class Generator < Roda::Project::Generator
+        def templates_root
+          @templates_root ||= "../bin/generators/templates"
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,49 @@
+class Roda
+  module Project
+    module Bin
+      class Generators < ::Thor
+        class Migration < Roda::Project::Bin::Generator
+          def call
+            if migration_name.nil? || migration_name.empty?
+              puts "Usage: bin/roda g migration your_migration_name"
+              exit 1
+            end
+
+            FileUtils.mkdir_p(migrations_path) unless File.directory?(migrations_path)
+
+            existing_migrations = Dir.glob(File.join(migrations_path, "*.rb"))
+            max_number = existing_migrations.map do |file|
+              File.basename(file).match(/^(\d+)/)&.captures&.first.to_i
+            end.max || 0
+            next_number = (max_number + 1).to_s.rjust(3, "0")
+
+            filename = File.join(migrations_path, "#{next_number}_#{migration_name}.rb")
+
+            content = <<~RUBY
+      Sequel.migration do
+        up do
+          # add your migration here
+        end
+
+        down do
+          # remove your migration here
+        end
+      end
+            RUBY
+
+            File.write(filename, content)
+            puts "* created migration: #{filename}"
+          end
+
+          def migrations_path
+            "db/migrations"
+          end
+
+          def migration_name
+            @migration_name ||= @args[0]
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,105 @@
+class Roda
+  module Project
+    module Bin
+      class Generators < ::Thor
+        class Routes < Roda::Project::Bin::Generator
+          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"
+              exit 1
+            end
+
+            generate_routes
+            generate_views
+            generate_tests
+          end
+
+          private
+
+          def generate_routes
+            filename = File.join(ensure_and_get_path("app/routes"), "#{branch_name}.rb")
+            route_definitions = routes_list.map do |route_str|
+              method, name = parse_route_string(route_str)
+              view_line = (method == "get" && must_generate_views?) ? "\n      view('#{name}')" : ""
+              "    r.#{method} \"#{name}\" do#{view_line}\n    end"
+            end.join("\n\n")
+
+            content = <<~RUBY
+      class #{@context.const_project_name}
+        hash_branch "#{branch_name}" do |r|
+      #{route_definitions}
+        end
+      end
+            RUBY
+            File.write(filename, content)
+            puts "* created routes file: #{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"
+                  view_filename = File.join(branch_views_dir, "#{name}.erb")
+                  File.write(view_filename, "")
+                  puts "* created view file: #{view_filename}"
+                end
+              end
+            end
+          end
+
+          def generate_tests
+            test_filename = File.join(ensure_and_get_path("spec/app/routes"), "#{branch_name}_spec.rb")
+            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)
+              "  it \"responds to #{method.upcase} /#{branch_name}/#{name}\" do\n" \
+                "    #{method} \"/#{branch_name}/#{name}\"\n" \
+                "    expect(last_response.status).to eq(200)\n" \
+                "  end"
+            end.join("\n")
+
+            test_content = <<~RUBY
+      require_relative "#{relative_spec_helper_path}"
+
+      describe "Routes for #{branch_name}" do
+      #{test_route_definitions}
+      end
+            RUBY
+            File.write(test_filename, test_content)
+            puts "* created test file: #{test_filename}"
+          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]
+          end
+
+          def ensure_and_get_path(path)
+            full_path_dir = File.join(path, File.dirname(branch_name))
+            FileUtils.mkdir_p(full_path_dir) unless File.directory?(full_path_dir)
+
+            path
+          end
+
+          def routes_list
+            @routes_list ||= @args[1..-1]
+          end
+
+          def branch_name
+            @branch_name ||= @args[0]
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,36 @@
+require_relative "../../project"
+
+class Roda
+  module Project
+    module Bin
+      class Generators < ::Thor
+        desc "migration", "Create a database migration"
+        def migration(*args)
+          Migration.new(context:, args:, options:).call
+        end
+
+        desc "routes", "Create routes inside hash_branches, views and tests"
+        option :views, type: :boolean, default: true
+        def routes(*args)
+          Routes.new(context:, args:, options:).call
+        end
+
+        private
+
+        def context
+          return @context if @context
+
+          @context = Roda::Project::MainContext.new
+          @context.project_name = options[:main_context][:project_name]
+          @context.base = options[:main_context][:base]
+          @context.database = options[:main_context][:database]
+          @context.database_type = options[:main_context][:database_type]
+          @context.rodauth = options[:main_context][:rodauth]
+          @context.tests = options[:main_context][:tests]
+
+          @context
+        end
+      end
+    end
+  end
+end

data/lib/roda/project/cli.rb

@@ -1,25 +1,17 @@
 # frozen_string_literal: true
 
-module Roda
+class Roda
   module Project
-    class CLI
-      include Helpers::Template
-      include Helpers::Input
-      include Helpers::Ids
-
-      def initialize(context: Context.new, pastel: Pastel.new, dir: nil)
-        @context = context
-        @pastel = pastel
-        @dir = dir
-      end
+    class CLI < Generator
+      include Helpers::InteractiveInput
 
       def call
-        puts @pastel.bright_black("[roda-project v#{Roda::Project::VERSION}]\n")
-        puts @pastel.italic("#{Roda::Project.messages.sample.first}\n")
+        puts pastel.bright_black("[roda-project v#{Roda::Project::VERSION}]\n")
+        puts pastel.italic("#{Roda::Project.messages.sample.first}\n")
 
         get_user_context
 
-        puts @pastel.bright_black("\n[project: #{@context.project_name}]\n")
+        puts pastel.bright_black("\n[project: #{@context.project_name}]\n")
 
         create_base_project
         add_front_end
@@ -34,15 +26,15 @@ module Roda
             puts "\n* put your dev database credentials in app/config/config.rb\n"
           end
           puts "\nmigrate the database (use RACK_ENV to migrate 'test' or 'production' environments):\n\n"
-          puts "$ rake db:migrate"
+          puts "$ bin/roda db migrate"
         end
         puts "\nrun and watch the project in dev mode:\n"
-        puts "\n$ rake dev"
+        puts "\n$ bin/roda dev"
         if @context.fullstack?
           puts "\ncompile and watch assets:\n"
-          puts "\n$ rake dev:assets"
+          puts "\n$ bin/roda assets:dev"
         end
-        puts "\nrun 'rake' inside #{@context.project_name} to see all available tasks\n\n"
+        puts "\nrun 'bin/roda' inside #{@context.project_name} to see all available tasks\n\n"
       rescue TTY::Reader::InputInterrupt
         puts "\n\nGoodbye"
       end
@@ -70,19 +62,11 @@ module Roda
         end
       end
 
-      def retry_on_error
-        yield
-      rescue Roda::Project::Context::InvalidValue => e
-        puts "\n #{@pastel.red(e.message)} \n\n"
-
-        yield
-      end
-
       def create_base_project
         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
           )
@@ -91,16 +75,18 @@ module 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
         )
 
         TTY::File.copy_file(
-          File.expand_path("../templates/base/app/app.rb.erb", __dir__),
+          File.expand_path("templates/base/app/app.rb.erb", __dir__),
           "#{@dir}#{@context.project_name}/app/#{@context.project_name}.rb",
           context: @context
         )
+
+        TTY::File.chmod("#{@dir}#{@context.project_name}/bin/roda", "+x")
       end
 
       def add_front_end
@@ -110,7 +96,6 @@ module Roda
           erb_cp_file("front-end", "esbuild.js")
           erb_cp_file("front-end", "package.json")
           cp_dir("front-end", "app/views")
-          cp_dir("front-end", "app/views")
           cp_dir("front-end", "public/assets")
           cp_dir("front-end", "public/images")
         end

data/lib/roda/project/generator.rb

@@ -0,0 +1,19 @@
+class Roda
+  module Project
+    class Generator
+      include Helpers::Template
+      include Helpers::Ids
+
+      def initialize(context: MainContext.new, args: [], options: {}, dir: nil)
+        @context = context
+        @args = args
+        @options = options
+        @dir = dir
+      end
+
+      def call
+        false
+      end
+    end
+  end
+end

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

@@ -1,4 +1,4 @@
-module Roda
+class Roda
   module Project
     module Helpers
       module Ids
@@ -10,6 +10,39 @@ module Roda
         def postgresql_id = Roda::Project::POSTGRESQL
         def rspec_id = Roda::Project::RSPEC
         def minitest_id = Roda::Project::MINITEST
+
+        def id_to_string(id, type)
+          const =
+            case type
+            when :base
+              case id
+              when fullstack_id
+                "FULLSTACK"
+              when api_id
+                "API"
+              when minimal_id
+                "MINIMAL"
+              end
+            when :database
+              case id
+              when mysql_id
+                "MYSQL"
+              when sqlite_id
+                "SQLITE"
+              when postgresql_id
+                "POSTGRESQL"
+              end
+            when :tests
+              case id
+              when rspec_id
+                "RSPEC"
+              when minitest_id
+                "MINITEST"
+              end
+            end
+
+          "Roda::Project::" << const
+        end
       end
     end
   end

data/lib/roda/project/helpers/{input.rb → interactive_input.rb}

@@ -1,7 +1,7 @@
-module Roda
+class Roda
   module Project
     module Helpers
-      module Input
+      module InteractiveInput
         def read_line(prompt, default)
           val = reader.read_line(prompt).chomp
           return default if val == ""
@@ -14,6 +14,18 @@ module Roda
         def reader
           @reader ||= TTY::Reader.new
         end
+
+        def retry_on_error
+          yield
+        rescue Roda::Project::Error => e
+          puts "\n #{pastel.red(e.message)} \n\n"
+
+          yield
+        end
+
+        def pastel
+          @pastel ||= Pastel.new
+        end
       end
     end
   end

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

@@ -1,10 +1,10 @@
-module Roda
+class Roda
   module Project
     module Helpers
       module Template
         def erb_cp_dir(type, path)
           TTY::File.copy_directory(
-            File.expand_path("../../templates/#{type}/#{path}", __dir__),
+            File.expand_path("#{templates_root}/#{type}/#{path}", __dir__),
             "#{@dir}#{@context.project_name}/#{path}",
             context: @context
           )
@@ -12,7 +12,7 @@ module Roda
 
         def erb_cp_file(type, path)
           TTY::File.copy_file(
-            File.expand_path("../../templates/#{type}/#{path}", __dir__),
+            File.expand_path("#{templates_root}/#{type}/#{path}", __dir__),
             "#{@dir}#{@context.project_name}/#{path}",
             context: @context
           )
@@ -21,7 +21,7 @@ module Roda
         # For copy without parse ERB files
         def cp_dir(type, path)
           FileUtils.cp_r(
-            File.expand_path("../../templates/#{type}/#{path}", __dir__),
+            File.expand_path("#{templates_root}/#{type}/#{path}", __dir__),
             "#{@dir}#{@context.project_name}/#{path}"
           )
         end
@@ -30,9 +30,13 @@ module Roda
         def cp_file(type, path)
           File.write(
             "#{@dir}#{@context.project_name}/#{path}",
-            File.read(File.expand_path("../../templates/#{type}/#{path}", __dir__))
+            File.read(File.expand_path("#{templates_root}/#{type}/#{path}", __dir__))
           )
         end
+
+        def templates_root
+          @templates_root ||= "../templates"
+        end
       end
     end
   end

data/lib/roda/project/{context.rb → main_context.rb}

@@ -1,9 +1,9 @@
-module Roda
+class Roda
   module Project
-    class Context
+    class MainContext
       include Helpers::Ids
 
-      class InvalidValue < StandardError; end
+      class InvalidValue < Roda::Project::Error; end
       VALID_PROJECT_NAME_REGEX = /^[a-zA-Z][a-zA-Z0-9_]*$/
 
       attr_reader(
@@ -11,15 +11,30 @@ module Roda
         :rodauth,
         :database,
         :database_type,
-        :dev_db_url,
+        :default_db_url,
         :db_gem,
         :project_name,
         :base
       )
 
+      def to_thor_option
+        option = <<~RUBY
+  option :main_context, type: :hash, default: {
+      project_name: "#{project_name}",
+      base: #{id_to_string(base, :base)},
+      rodauth: #{rodauth},
+      tests: #{id_to_string(tests, :tests)},
+      database: #{database},
+        RUBY
+        if database?
+          option << "    database_type: #{id_to_string(database_type, :database)},"
+        end
+        option << "\n    }"
+      end
+
       def tests=(val)
         if ![minitest_id, rspec_id].include?(val)
-          raise InvalidValue, "Invalid test framework option"
+          raise InvalidValue, "Invalid test framework option: #{val}"
         end
 
         @tests = val
@@ -27,7 +42,7 @@ module Roda
 
       def base=(val)
         if ![fullstack_id, api_id, minimal_id].include?(val)
-          raise InvalidValue, "Invalid project option"
+          raise InvalidValue, "Invalid project base option: #{val}"
         end
 
         @base = val
@@ -48,19 +63,19 @@ module Roda
       # rubocop:disable Lint/InterpolationCheck
       def database_type=(val)
         if ![mysql_id, postgresql_id, sqlite_id].include?(val)
-          raise InvalidValue, "Invalid database option"
+          raise InvalidValue, "Invalid database type option: #{val}"
         end
 
         @database_type = val
 
         if mysql?
-          @dev_db_url = '"mysql2://user:password@localhost/app_#{environment}"'
+          @default_db_url = '"mysql2://user:password@localhost/app_#{environment}"'
           @db_gem = "mysql2"
         elsif postgresql?
-          @dev_db_url = '"postgres://user:password@localhost:5432/app_#{environment}"'
+          @default_db_url = '"postgres://user:password@localhost:5432/app_#{environment}"'
           @db_gem = "pg"
         else
-          @dev_db_url = '"sqlite://db/#{environment}.db"'
+          @default_db_url = '"sqlite://db/#{environment}.db"'
           @db_gem = "sqlite3"
         end
       end

data/lib/roda/{templates → project/templates}/base/app/app.rb.erb

@@ -11,6 +11,7 @@ class <%= context.const_project_name %> < Roda
   plugin :render, layout: "./layout"
   plugin :content_for, append: false
   plugin :flash
+  plugin :assets_manifest
   <% end %>
   # Request / Response
   plugin :halt
@@ -37,8 +38,8 @@ class <%= context.const_project_name %> < Roda
   # Other
   plugin :common_logger, Providers::Logger.get
   plugin :json_parser
-  plugin :sessions, secret: Config.get[:secret]
-  plugin :i18n, **Config.get[:i18n]
+  plugin :sessions, secret: Config.get[:secret]<% if context.fullstack? %>
+  plugin :i18n, **Config.get[:i18n]<% end %>
 <% if context.rodauth? %><% if context.api? %>
   # Authentication
   plugin :rodauth, json: :only do
@@ -60,13 +61,12 @@ class <%= context.const_project_name %> < Roda
     hmac_secret Config.get[:hmac_secret]
   end
 <% end %>
-  def config = @config ||= Config.get<% if context.fullstack? %>
-  def html = @html ||= Views::Html.new(t)<% end %>
+  def config = @config ||= Config.get
 
   route do |r|
-    r.hash_branches
+    r.hash_branches<% if context.fullstack? %>
     # session[:locale] = 'pt-br'
-    # r.i18n_set_locale_from(:session)
+    # r.i18n_set_locale_from(:session)<% end %>
     <% if context.rodauth? %>
     r.rodauth
     rodauth.require_authentication
@@ -77,7 +77,10 @@ class <%= context.const_project_name %> < Roda
   end
 
   error do |e|
-    next exception_page(e, css_file: "/public/exception_page.css") if Config.not_production?
+    if Config.not_production?
+      puts e
+      next exception_page(e, css_file: "/public/exception_page.css")
+    end
   end
 
   not_found do

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

@@ -23,6 +23,7 @@ gem "oj"
 gem "bcrypt"
 
 group :development do
+  gem "thor"
   gem "guard-puma"
   gem "rack-test"
   gem "debug"
@@ -30,7 +31,6 @@ group :development do
   gem "standard"<% if context.minitest? %>
   gem "minitest"
   gem "minitest-hooks"
-  gem "rake"
 <% else %>
   gem "rspec"<% end %>
 end

data/lib/roda/{templates → project/templates}/base/minimal/app.rb

@@ -19,7 +19,10 @@ class App < Roda
   end
 
   error do |e|
-    next exception_page(e, css_file: "/public/exception_page.css") if NOT_PRODUCTION
+    if NOT_PRODUCTION
+      puts e
+      next exception_page(e, css_file: "/public/exception_page.css")
+    end
   end
 
   not_found do

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

@@ -0,0 +1,47 @@
+#!/usr/bin/env ruby
+require "thor"
+
+class CLI < Thor
+  desc "console", "Open a console with application context, alias: roda c"
+  def console
+    system("irb -r ./boot.rb")
+  end
+  map "c" => "console"
+
+  desc "lint", "Run lint"
+  option :fix, type: :boolean, aliases: "-w", desc: "Auto fix lint warnings"
+  def lint
+    if options[:fix]
+      system("bundle exec standardrb --fix")
+    else
+      system("bundle exec standardrb")
+    end
+  end
+
+  desc "test", "Run tests"
+  def test<% if context.rspec? %>
+    system("RACK_ENV=test bundle exec rspec")<% else %>
+    system("RACK_ENV=test bundle exec minitest spec/")<% end %>
+  end
+
+  desc "dev", "Exec development server watching for changes"
+  def dev
+    system("RACK_ENV=development bundle exec guard")
+  end
+
+  desc "server", "Runs the project, alias roda s"
+  def server
+    if ENV["RACK_ENV"] == "production"
+      if ENV["SESSION_SECRET"].nil?
+        puts("SESSION_SECRET is empty")
+        exit 1
+      end
+      system("RUBYOPT=--yjit RUBY_YJIT_ENABLE=1 RACK_ENV=production bundle exec puma --port 4000")
+    else
+      system("RACK_ENV=development bundle exec puma --port 4000")
+    end
+  end
+  map "s" => "server"
+end
+
+CLI.start(ARGV)