roda-project 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 9ee06fbd7dc545302e76dae3d4a7b6bf1dfbc96bcd93069192898ae42260cc69
+  data.tar.gz: 6b25df32eeac0001a9aecf1bacf15b47b100e03a5d7ce48066b0d50e0c2e1e3a
+SHA512:
+  metadata.gz: 626e1417abaad740b5e687ebb46179a1cb72c83d70e3388251cf80d48a0003fc758a0ced41089ea7f44adf9e79a15410ed61ec4222c7b38cd0f4029a12cfc638
+  data.tar.gz: f6746dde88bb1896bf238d0d250b9c2b1fd368f35b9bab7be3c9f74fee14e35fc1152f24f43e3ea58912ed27543b9d77036d586fd8d9d2209a4fbf0183cc592a

data/bin/console

@@ -0,0 +1,11 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require "bundler/setup"
+require "roda/project"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+require "irb"
+IRB.start(__FILE__)

data/bin/roda-project

@@ -0,0 +1,6 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'roda/project'
+
+Roda::Project::CLI.new.call

data/bin/roda-project.rb

@@ -0,0 +1,9 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require_relative '../lib/roda/project'
+
+Roda::Project::CLI.new.call
+
+
+

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/roda/project/cli.rb

@@ -0,0 +1,134 @@
+# frozen_string_literal: true
+
+module 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
+
+      def call
+        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")
+
+        create_base_project
+        add_front_end
+        add_database
+        add_test_files
+
+        puts "\ninstall dependences:\n\n"
+        puts "$ cd #{@context.project_name} && bundle"
+        if @context.database?
+          unless @context.sqlite?
+            puts "\n* create your database\n"
+            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"
+        end
+        puts "\nrun and watch the project in dev mode:\n"
+        puts "\n$ rake dev:watch"
+        if @context.fullstack?
+          puts "\ncompile and watch assets:\n"
+          puts "\n$ rake assets:watch"
+        end
+        puts "\nrun 'rake' inside #{@context.project_name} to see all available tasks\n\n"
+      rescue TTY::Reader::InputInterrupt
+        puts "\n\nGoodbye"
+      end
+
+      private
+
+      def get_user_context
+        retry_on_error { @context.project_name = read_line("Project name › ", "project") }
+        retry_on_error { @context.base = read_line("(#{fullstack_id}) Fullstack (#{api_id}) API › ", fullstack_id).to_i }
+        retry_on_error { @context.tests = read_line("(#{rspec_id}) RSpec (#{minitest_id}) Minitest › ", rspec_id).to_i }
+        retry_on_error { @context.database = read_line("Database? (Y/n) › ", true) }
+
+        if @context.database?
+          retry_on_error {
+            @context.database_type = read_line(
+              "(#{sqlite_id}) SQlite (#{postgresql_id}) PostgreSQL (#{mysql_id}) MySQL › ",
+              sqlite_id
+            ).to_i
+          }
+
+          retry_on_error { @context.rodauth = read_line("Rodauth? (authentication) (Y/n) › ", true) }
+        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"
+        TTY::File.copy_directory(
+          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__),
+          "#{@dir}#{@context.project_name}/app/#{@context.project_name}.rb",
+          context: @context
+        )
+      end
+
+      def add_front_end
+        if @context.fullstack?
+          puts "* adding front-end"
+          tty_cp_r("front-end", "app/assets")
+          tty_cp("front-end", "esbuild.js")
+          tty_cp("front-end", "package.json")
+          cp_r("front-end", "app/views")
+        end
+      end
+
+      def add_database
+        if @context.database?
+          puts "* adding database"
+          tty_cp_r("database", "db")
+          tty_cp("database", "app/config/providers/db/conn.rb")
+          add_rodauth
+        end
+      end
+
+      def add_rodauth
+        if @context.rodauth?
+          puts "* adding rodauth"
+          tty_cp_r("rodauth", "app/models")
+          tty_cp("rodauth", "db/migrations/001_add_rodauth.rb")
+          if @context.fullstack?
+            cp("rodauth", "app/views/create-account.erb")
+          end
+        end
+      end
+
+      def add_test_files
+        puts "* adding test files"
+
+        if @context.rspec?
+          tty_cp_r("tests/rspec", "spec")
+        else
+          tty_cp_r("tests/minitest", "spec")
+        end
+      end
+    end
+  end
+end

data/lib/roda/project/context.rb

@@ -0,0 +1,136 @@
+module Roda
+  module Project
+    class Context
+      include Helpers::Ids
+
+      class InvalidValue < StandardError; end
+      VALID_PROJECT_NAME_REGEX = /^[a-zA-Z][a-zA-Z0-9_]*$/
+
+      attr_reader(
+        :tests,
+        :rodauth,
+        :database,
+        :database_type,
+        :dev_db_url,
+        :db_gem,
+        :project_name,
+        :base
+      )
+
+      def tests=(val)
+        if ![minitest_id, rspec_id].include?(val)
+          raise InvalidValue, "Invalid test framework option"
+        end
+
+        @tests = val
+      end
+
+      def base=(val)
+        if ![fullstack_id, api_id].include?(val)
+          raise InvalidValue, "Invalid project option"
+        end
+
+        @base = val
+      end
+
+      def rodauth=(val)
+        val = false if ![true, false].include?(val)
+
+        @rodauth = val
+      end
+
+      def database=(val)
+        val = false if ![true, false].include?(val)
+
+        @database = val
+      end
+
+      def database_type=(val)
+        if ![mysql_id, postgresql_id, sqlite_id].include?(val)
+          raise InvalidValue, "Invalid database option"
+        end
+
+        @database_type = val
+
+        if mysql?
+          @dev_db_url = '"mysql2://user:password@localhost/app_#{environment}"'
+          @db_gem = "mysql2"
+        elsif postgresql?
+          @dev_db_url = '"postgres://user:password@localhost:5432/app_#{environment}"'
+          @db_gem = "pg"
+        else
+          @dev_db_url = '"sqlite://db/#{environment}.db"'
+          @db_gem = "sqlite3"
+        end
+      end
+
+      def project_name=(val)
+        if !(val =~ VALID_PROJECT_NAME_REGEX)
+          raise InvalidValue, "Project name must start with a letter and contains only letters, numbers and _"
+        end
+
+        @project_name = val
+      end
+
+      def rspec?
+        tests == rspec_id
+      end
+
+      def minitest?
+        tests == minitest_id
+      end
+
+      # rubocop:disable Lint/InterpolationCheck
+      def foo_bar_example
+        return 'view("bar")' if fullstack?
+
+        '{ foo: "bar" }'
+      end
+
+      def root_example
+        return 'view("index")' if fullstack?
+
+        '{ message: "#{t.hello.message}" }'
+      end
+      # rubocop:enable Lint/InterpolationCheck
+
+      def fullstack?
+        base == fullstack_id
+      end
+
+      def api?
+        base == api_id
+      end
+
+      def rodauth?
+        rodauth == true
+      end
+
+      def database?
+        database == true
+      end
+
+      def mysql?
+        return false unless database?
+
+        database_type == mysql_id
+      end
+
+      def postgresql?
+        return false unless database?
+
+        database_type == postgresql_id
+      end
+
+      def sqlite?
+        return false unless database?
+
+        database_type == sqlite_id
+      end
+
+      def const_project_name
+        @const_project_name ||= project_name.split('_').map(&:capitalize).join
+      end
+    end
+  end
+end

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

@@ -0,0 +1,15 @@
+module Roda
+  module Project
+    module Helpers
+      module Ids
+        def fullstack_id = Roda::Project::FULLSTACK
+        def mysql_id = Roda::Project::MYSQL
+        def sqlite_id = Roda::Project::SQLITE
+        def postgresql_id = Roda::Project::POSTGRESQL
+        def api_id = Roda::Project::API
+        def rspec_id = Roda::Project::RSPEC
+        def minitest_id = Roda::Project::MINITEST
+      end
+    end
+  end
+end

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

@@ -0,0 +1,20 @@
+module Roda
+  module Project
+    module Helpers
+      module Input
+        def read_line(prompt, default)
+          val = reader.read_line(prompt).chomp
+          return default if val == ""
+          return false if val == "n"
+          return true if val == "Y" || val == "y"
+
+          val
+        end
+
+        def reader
+          @reader ||= TTY::Reader.new
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,37 @@
+module Roda
+  module Project
+    module Helpers
+      module Template
+        def tty_cp_r(type, path)
+          TTY::File.copy_directory(
+            File.expand_path("../../templates/#{type}/#{path}", __dir__),
+            "#{@dir}#{@context.project_name}/#{path}",
+            context: @context
+          )
+        end
+
+        def tty_cp(type, path)
+          TTY::File.copy_file(
+            File.expand_path("../../templates/#{type}/#{path}", __dir__),
+            "#{@dir}#{@context.project_name}/#{path}",
+            context: @context
+          )
+        end
+
+        def cp_r(type, path)
+          FileUtils.cp_r(
+            File.expand_path("../../templates/#{type}/#{path}", __dir__),
+            "#{@dir}#{@context.project_name}/#{path}"
+          )
+        end
+
+        def cp(type, path)
+          File.write(
+            "#{@dir}#{@context.project_name}/#{path}",
+            File.read(File.expand_path("../../templates/#{type}/#{path}", __dir__))
+          )
+        end
+      end
+    end
+  end
+end

data/lib/roda/project/version.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module Roda
+  module Project
+    VERSION = "0.1.0"
+  end
+end

data/lib/roda/project.rb

@@ -0,0 +1,54 @@
+# frozen_string_literal: true
+
+require "tty-file"
+require "fileutils"
+require "tty-reader"
+require "pastel"
+require_relative "project/version"
+require_relative "project/helpers/ids"
+require_relative "project/context"
+require_relative "project/helpers/input"
+require_relative "project/helpers/template"
+require_relative "project/cli"
+
+module Roda
+  module Project
+    class Error < StandardError; end
+
+    FULLSTACK = 1
+    API = 2
+    SQLITE = 1
+    POSTGRESQL = 2
+    MYSQL = 3
+    RSPEC = 1
+    MINITEST = 2
+
+    def self.messages
+      [
+        ['"What you do today can improve all your tomorrows." - Ralph Marston'],
+        ['"What you get by achieving your goals is not as important as what you become by achieving your goals." - Zig Ziglar'],
+        ['"Intelligence without ambition is a bird without wings." - Salvador Dali'],
+        ['"We may encounter many defeats but we must not be defeated." - May Angelou'],
+        ['"A creative man is motivated by the desire to achieve, not by the desire to beat others." - Ayn Rand'],
+        ['"A somebody was once a nobody who wanted to and did." - John Burroughs'],
+        ['"Courage is the first of human qualities because it is the quality which guarantees all others." - Winston Churchill'],
+        ['"The journey of a thousand miles begins with one step." - Lao Tzu'],
+        ['"Don’t worry about failures, worry about the chances you miss when you don’t even try." - Jack Canfield'],
+        ['"The secret to getting ahead is getting started." - Mark Twain'],
+        ['"The power of imagination makes us infinite." - John Muir'],
+        ['"Creativity is intelligence having fun." - Albert Einstein'],
+        ['"People who are crazy enough to think they can change the world, are the ones who do." - Rob Siltanen'],
+        ['"The way to get started is to quit talking and begin doing." - Walt Disney'],
+        ['"Success is not final, failure is not fatal: it is the courage to continue that counts." - Winston Churchill'],
+        ['"Less is almost always more. Simplicity is almost always the answer." - Zat Rana'],
+        ['"It all starts and ends in the mind. The most crucial skill is how you think." - Zat Rana'],
+        ['"It is never too late to be what you might have been." - George Eliot'],
+        ['"It does not matter how slowly you go, so long as you do not stop." - Confucius'],
+        ['"Start where you are. Use what you have. Do what you can." - Arthur Ashe'],
+        ['"A goal is a dream with a deadline." - Napoleon Hill'],
+        ['"Things do not happen. Things are made to happen." - John F. Kennedy'],
+        ['"Quality is not an act, it is a habit." - Aristotle'],
+      ]
+    end
+  end
+end

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

@@ -0,0 +1,87 @@
+class <%= context.const_project_name %> < Roda
+  # Routing<% if context.fullstack? %>
+  plugin :hash_branch_view_subdir<% end %>
+  plugin :autoload_hash_branches
+  autoload_hash_branch_dir("./app/routes")
+  plugin :all_verbs
+  plugin :not_found
+  <% if context.fullstack? %>
+  # Views
+  plugin :partials, views: "app/views"
+  plugin :render, layout: "./layout"
+  plugin :content_for, append: false
+  plugin :flash
+  <% end %>
+  # Request / Response
+  plugin :halt
+  plugin :json
+  plugin :exception_page
+  plugin :caching
+  plugin :cookies
+  plugin :default_headers
+  plugin :content_security_policy do |csp|
+    # csp.default_src :none
+    # csp.img_src :self
+    # csp.style_src :self
+    # csp.script_src :self
+    # csp.font_src :self
+    # csp.form_action :self
+    # csp.base_uri :none
+    # csp.frame_ancestors :none
+    # csp.block_all_mixed_content
+  end
+
+  # CSRF Protection
+  plugin :route_csrf
+
+  # Other
+  plugin :common_logger, Providers::Logger.get
+  plugin :json_parser
+  plugin :sessions, secret: Config.get[:secret]
+  plugin :i18n, **Config.get[:i18n]
+<% if context.rodauth? %><% if context.api? %>
+  # Authentication
+  plugin :rodauth, json: :only do
+    enable :jwt
+    jwt_secret Config.get[:jwt_secret]
+<% else %>
+  # Authentication
+  plugin :rodauth do
+    enable :login, :logout, :create_account, :verify_account
+<% end %>
+    accounts_table :accounts
+    password_hash_table :account_password_hashes
+    use_database_authentication_functions? false
+    # base_url "http://localhost:9292"
+    login_column :email
+    # Redirect logged in users to the wherever login redirects to
+    already_logged_in { redirect "/" }
+
+    hmac_secret Config.get[:hmac_secret]
+  end
+<% end %>
+  def config = @config ||= Config.get
+  def self.branch(args, &) = hash_branch(args, &)<% if context.fullstack? %>
+  def html = @html ||= Views::Html.new(t)<% end %>
+
+  route do |r|
+    r.hash_branches
+    # session[:locale] = 'pt-br'
+    # r.i18n_set_locale_from(:session)
+    <% if context.rodauth? %>
+    r.rodauth
+    rodauth.require_authentication
+    <% end  %>
+    r.root do
+      <%= context.root_example %>
+    end
+  end
+
+  error do |e|
+    next exception_page(e, css_file: "/public/exception_page.css") if Config.not_production?
+  end
+
+  not_found do
+    "not found"
+  end
+end

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

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

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

@@ -0,0 +1,51 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+# Base
+gem "roda"
+gem "roda-i18n"
+gem "zeitwerk"
+<% if context.rodauth? %>
+# Authentication
+gem "rodauth"
+gem "jwt"
+<% end %>
+# Database
+gem "sequel"
+<%= "gem \"#{context.db_gem}\"" if context.database? %>
+
+# Web Server
+gem "puma"
+# gem "falcon"
+# gem 'iodine'
+# gem 'thin'
+
+# Performance
+gem "oj"
+# gem 'async'
+
+# CLI
+gem "rake"
+
+# Security
+# gem "rack-attack"
+
+# Misc
+gem "html_slice"
+gem "mail"
+gem "bcrypt"
+
+group :development do
+  gem "guard-puma"
+  gem "guard-livereload"
+  gem "rack-livereload"
+  gem "rack-test"
+  gem "debug"
+  gem "base64"
+  gem "standard"<% if context.minitest? %>
+  gem "minitest"
+  gem "minitest-hooks"
+<% else %>
+  gem "rspec"<% end %>
+end

data/lib/roda/templates/base/scaffold/Guardfile

@@ -0,0 +1,25 @@
+# A sample Guardfile
+# More info at https://github.com/guard/guard#readme
+
+## Uncomment and set this to only include directories you want to watch
+# directories %w(app lib config test spec features) \
+#  .select{|d| Dir.exist?(d) ? d : UI.warning("Directory #{d} does not exist")}
+
+## Note: if you are using the `directories` clause above and you are not
+## watching the project directory ('.'), then you will want to move
+## the Guardfile to a watched dir and symlink it back, e.g.
+#
+#  $ mkdir config
+#  $ mv Guardfile config/
+#  $ ln -s config/Guardfile .
+#
+# and, you'll have to watch "config/Guardfile" instead of "Guardfile"
+
+guard "puma" do
+  watch("Gemfile.lock")
+  watch(%r{^app|i18n|public/.*})
+end
+
+guard "livereload" do
+  watch(%r{^app|i18n|public/.*})
+end

data/lib/roda/templates/base/scaffold/README.md

@@ -0,0 +1,29 @@
+# Rackr project scaffold
+
+### Running
+
+1. `$ bundle install`
+2. `$ yarn`
+3. `$ bin/dev`
+
+for watch and compile assets:
+1. `$ bin/dev-assets`
+
+### Migrations
+
+- `$ bin/db/migrate`
+
+### Included
+
+gems:
+- `roda` for routes
+- `sequel` + `sqlite3` for database work
+- `rerun` for reload after changes
+- `rspec` for tests
+- `zeitwerk` for code load
+
+js:
+- `@hotwired/turbo`
+
+assets:
+- `esbuild` for bundle js assets