cafe_car 0.1.0 → 0.1.2

data/lib/cafe_car/resolver.rb

@@ -0,0 +1,27 @@
+module CafeCar
+  module Resolver
+    extend ActiveSupport::Concern
+
+    def const(name)  = self.class.const(name)
+    def const!(name) = self.class.const!(name)
+
+    class_methods do
+      def const_scopes = [ self, *module_parents ]
+
+      def [](const_name) = const(const_name)
+
+      def const_try(name)
+        const_get(name) if const_defined?(name)
+      end
+
+      def const(name)
+        const_scopes.detect { _1.const_defined?(name) }
+                    &.then { _1.const_get(name) }
+      end
+
+      def const!(name)
+        const(name) or raise NameError, "uninitialized constant #{name}"
+      end
+    end
+  end
+end

data/lib/cafe_car/routing.rb

@@ -0,0 +1,17 @@
+module CafeCar
+  module Routing
+    extend ActiveSupport::Concern
+
+    def resources(*, concerns: [], **, &)
+      @concerns[:batchable] || begin
+        concern :batchable do
+          collection do
+            patch :update_all
+          end
+        end
+      end
+
+      super(*, **, concerns: [ :batchable, *concerns ], &)
+    end
+  end
+end

data/lib/cafe_car/table/body_builder.rb

@@ -0,0 +1,12 @@
+module CafeCar::Table
+  class BodyBuilder < ObjectsBuilder
+    def to_html
+      ui.Body id: @objects.model_name.plural do |body|
+        body << @template.turbo_stream_from(model_name.plural)
+        @objects.each do |object|
+          body << RowBuilder.new(@template, object:, **@options, &@block)
+        end
+      end
+    end
+  end
+end

data/lib/cafe_car/table/builder.rb

@@ -0,0 +1,52 @@
+module CafeCar::Table
+  class Builder
+    include CafeCar::ProcHelpers
+    include CafeCar::OptionHelpers
+
+    attr_reader :ui
+    delegate :capture, :link_to, :href_for, :params, :present, :request, :safe_join, to: :@template
+
+    def initialize(template, **options, &block)
+      @template         = template
+      @options          = options
+      @block            = block
+      @ui               = @template.ui.Table
+      @shown_attributes = {}
+      assign_options!
+    end
+
+    def model_name = model.model_name
+
+    def cell(method, ...) = shown!(method).then { nil }
+    def shown!(method)    = @shown_attributes[method] = true
+    def shown             = @shown_attributes
+
+    def has?(method) = model.info.fields.has?(method)
+
+    def title(method = policy.title_attribute, *, **, &)
+      cell(method, *, href: true, blank: "(none)", **, &)
+    end
+
+    def logo(method = policy.logo_attribute, *, **, &)
+      cell(method, *, label: nil, blank: "", **, &) if method
+    end
+
+    def timestamps(...) = cell(timestamp_attribute, ...)
+
+    def timestamp_attribute = %w[updated_at created_at].find { has? _1 }
+
+    def remaining_attributes = policy.listable_attributes - @shown_attributes.keys
+
+    def remaining(except: [])
+      capture do
+        (remaining_attributes - [ *except ]).each do |attr|
+          ui << cell(policy.info(attr).displayable.method)
+        end
+      end
+    end
+
+    def html_safe? = true
+    def to_s       = @to_s ||= to_html.to_s
+    def ~@         = @template.concat(to_s)
+  end
+end

data/lib/cafe_car/table/foot_builder.rb

@@ -0,0 +1,14 @@
+module CafeCar::Table
+  class FootBuilder < ObjectsBuilder
+    def initialize(...)
+      super
+      @count   = 0
+    end
+
+    def cell!           = (@count += 1; nil)
+    def cell(...)       = (super; cell!)
+    def controls(...)   = cell!
+
+    def to_html = ""
+  end
+end

data/lib/cafe_car/table/head_builder.rb

@@ -0,0 +1,26 @@
+module CafeCar::Table
+  class HeadBuilder < ObjectsBuilder
+    attr_reader :fields
+
+    def initialize(...)
+      @fields = []
+      super
+    end
+
+    def cell(method, *flags, label: label(method), **, &)
+      super
+      @fields << model.info.field(method)
+      ui.Cell(*flags) { label }
+    end
+
+    def label(method)
+      l = LabelBuilder.new(@template, objects: @objects, method:)
+      @objects.includes!(method) if l.association?
+      l
+    end
+
+    def controls(*, **) = cell(:controls, :controls, *, label: nil, **)
+
+    def to_html = ui.Head(:sticky) { capture(self, &@block) }
+  end
+end

data/lib/cafe_car/table/label_builder.rb

@@ -0,0 +1,48 @@
+module CafeCar::Table
+  class LabelBuilder < ObjectsBuilder
+    def initialize(...)
+      super
+      @method  = @options.delete(:method) { raise }
+      @key     = @method.to_s
+      @key    += ?. + title if belongs_to?
+    end
+
+    def field        = policy.info(@method)
+    def title        = reflection&.klass&.then { policy(_1).title_attribute&.to_s } rescue ""
+    def column?      = @objects.columns_hash.key? @key
+    def sortable?    = column? || belongs_to?
+    def reflection   = field.reflection
+    def association? = field.association?
+    def belongs_to?  = reflection&.belongs_to?
+    def order_value  = @objects.order_values.first&.then { _1.expr.name }
+    def existing     = params.fetch(:sort) { order_value }
+
+    def sort
+      @sort ||=
+        case existing
+        when @key then "-#{existing}"
+        else @key
+        end
+    end
+
+    def href
+      @template.url_for(**request.params.merge(sort:)) if sortable?
+    end
+
+    def label_sort
+      @template.tag.span(symbol) if sortable?
+    end
+
+    def symbol
+      case existing
+      when @key       then "↑" # ▴↑▲
+      when "-#{@key}" then "↓" # ▾↓▼
+      else "•"
+      end
+    end
+
+    def label   = @method&.then { present(@objects).human(_1) }
+    def content = @template.safe_join([ label, label_sort ], "&nbsp;".html_safe)
+    def to_html = @template.link_to_unless(!sortable?, content, href)
+  end
+end

data/lib/cafe_car/table/objects_builder.rb

@@ -0,0 +1,8 @@
+module CafeCar::Table
+  class ObjectsBuilder < Builder
+    option :objects, default: -> { raise }
+
+    def model                = @objects
+    def policy(o = @objects) = @template.policy(o)
+  end
+end

data/lib/cafe_car/table/row_builder.rb

@@ -0,0 +1,39 @@
+module CafeCar::Table
+  class RowBuilder < Builder
+    option :object, default: -> { raise }
+
+    def href!
+      @href = @options.delete(:href) { true }
+
+      @href = @href.to_proc.(@object)     if @href.respond_to?(:to_proc)
+      @href = nil                         if @href == false
+    end
+
+    def href                = @href
+    def model               = @object.class
+    def policy(o = @object) = @template.policy(o)
+
+    def value(method) = @object.try(method)
+    def show(...)  = present(@object).show(...)
+
+    def cell(method, *flags, **options, &)
+      super
+      options[:href] = @object if options[:href] == true
+      call_procs!(options, @object)
+      ui.Cell(*flags, **options) { show(method, **options.slice(:blank), &) }
+    end
+
+    def timestamps(**options)
+      tip = show(:created_at).string&.then { "Created: #{_1}" }
+      cell(timestamp_attribute, :shrink, tip:, **options)
+    end
+
+    def controls(*args, **options)
+      ui.Cell(:shrink, :shy, :controls, *args) { present(@object).controls(*args, **options) }
+    end
+
+    def to_html
+      ui.Row { safe_join [ capture(self, &@block), @template.turbo_stream_from(@object) ] }
+    end
+  end
+end

data/lib/cafe_car/table_builder.rb

@@ -0,0 +1,13 @@
+module CafeCar
+  class TableBuilder < Table::Builder
+    def to_html
+      head    = Table::HeadBuilder.new(@template, **@options, &@block).tap(&:to_s)
+      columns = head.fields.map(&:width).join(" ")
+      @template.ui.Table style: "grid-template-columns: #{columns}" do |table|
+        ~head
+        ~Table::BodyBuilder.new(@template, **@options, &@block)
+        ~Table::FootBuilder.new(@template, **@options, &@block)
+      end
+    end
+  end
+end

data/lib/cafe_car/turbo_tag_builder.rb

@@ -0,0 +1,7 @@
+module CafeCar
+  module TurboTagBuilder
+    def navigate(href)
+      action(:navigate, href)
+    end
+  end
+end

data/lib/cafe_car/ui.rb

@@ -0,0 +1,11 @@
+module CafeCar
+  module UI
+    include Resolver
+
+    module_function
+
+    def component(name, **, &)
+      define_class(name, CafeCar[:Component], **, &)
+    end
+  end
+end

data/lib/cafe_car/version.rb

@@ -1,3 +1,3 @@
 module CafeCar
-  VERSION = "0.1.0"
+  VERSION = "0.1.2"
 end

data/lib/cafe_car/visitors.rb

@@ -0,0 +1,21 @@
+module CafeCar::Visitors
+  module SQLite
+    def function(name, args, collector)
+      collector << "#{name}("
+      inject_join(args, collector, ", ") << ")"
+    end
+
+    def bool(value)
+      value ? Arel::Nodes::True.new : Arel::Nodes::False.new
+    end
+
+    def visit_Arel_Nodes_Regexp(o, collector)
+      function("regexp", [ o.right, o.left, bool(o.case_sensitive) ], collector)
+    end
+
+    def visit_Arel_Nodes_NotRegexp(o, collector)
+      collector << "NOT "
+      function("regexp", [ o.right, o.left, bool(o.case_sensitive) ], collector)
+    end
+  end
+end

data/lib/cafe_car.rb

@@ -1,181 +1,38 @@
+require "cafe_car/core_ext"
+
 require "cafe_car/version"
-require "cafe_car/railtie"
+require "cafe_car/engine"
+require "cafe_car/resolver"
+require "cafe_car/auto_resolver"
+require "cafe_car/proc_helpers"
 
 module CafeCar
-  extend ActiveSupport::Concern
-
-  class_methods do
-    def model(model)
-      define_method(:record_model) { @record_model ||= model }
-    end
-  end
-
-  included do
-    helper_method :record_model, :record_name, :records_name, :record, :records, :record_policy
-    rescue_from ActiveRecord::RecordInvalid, with: :render_invalid_record
-    prepend_view_path 'app/views/cafe_car'
-  end
-
-  def index
-    self.records = records.page(params[:page]).per(params[:per] || 100)
-    self.records = filtered(records) if respond_to?(:filtered, true)
-    self.records = paginated(records) if respond_to?(:paginated, true)
-    self.records = sorted(records) if respond_to?(:sorted, true)
-    self.records = records.includes(*includes) if respond_to?(:includes, true)
-
-    validate_filter_scope(records)
-
-    authorize records
-  end
-
-  def show
-    self.record = record!
-    authorize record
-  end
-
-  def new
-    self.record = new_record
-    authorize record
-  end
+  include Resolver
+  extend AutoResolver
+  extend ProcHelpers
 
-  def edit
-    self.record = record!
-    authorize record
+  class MissingAttributeError < StandardError
   end
 
-  def create
-    self.record = new_record
-    authorize record
-    record.assign_attributes(permitted_attributes(record))
-
-    record.save!
-    created
-
-    respond_to do |f|
-      f.js { created_js }
-      f.html { created_redirect }
-      f.json {}
-    end
+  class AuthenticationFailed < StandardError
   end
 
-  def update
-    self.record = record!
-    authorize record
-
-    record.update!(permitted_attributes(record))
-    updated
-    respond_to do |f|
-      f.js { updated_js }
-      f.html { updated_redirect }
-      f.json {}
-    end
-  end
+  def self.use_relative_model_naming? = true
 
-  def destroy
-    self.record = record!
-    authorize record
-
-    destroy_record
-
-    destroyed
-    respond_to do |f|
-      f.js { destroyed_js }
-      f.html { destroyed_redirect }
-      f.json {}
-    end
-  end
+  # Name of the host application's user model. Hosts with a differently named
+  # user model can override this (e.g. `CafeCar.user_class_name = "Account"`).
+  mattr_accessor :user_class_name, default: "User"
 
-  def alter_tags
-    self.record = record!
-    authorize record
-    # tag_list compares tags case-insensitively when adding, but not when removing
-    remove = [*params[:remove]].map { |t| record.tag_list.find { |t2| t.casecmp(t2).zero? } }
-    tags = record.tag_list.remove(*remove).add(*params[:add])
-    if record.save
-      render json: { tags: }
-    else
-      render json: { errors: record.errors.full_messages }, status: :bad_request
-    end
-  end
-
-  private
-
-  def new_record
-    record_scope.new
-  end
-
-  def record!
-    if record_model.respond_to?(:[])
-      record_scope[params[:id]]
-    else
-      record_scope.find(params[:id])
-    end
-  end
+  # The host's user model, resolved lazily so the constant need not exist at
+  # boot. Used by CafeCar::Session for authentication.
+  def self.user_class = user_class_name.to_s.constantize
 
-  def record_scope
-    record_model.all
+  # Whether the opt-in sessions/login infrastructure is available. True only
+  # when the sessions table exists, so a CRUD-only host (no sessions migration)
+  # degrades to 403 Forbidden instead of redirecting to a nonexistent login.
+  def self.sessions_available?
+    CafeCar[:Session].table_exists?
+  rescue StandardError
+    false
   end
-
-  def destroy_record
-    record.destroy
-  end
-
-  def records!
-    policy_scope(record_scope.all)
-  end
-
-  def records
-    instance_variable_get("@#{records_name}") || (self.records = records!)
-  end
-
-  def records=(value)
-    instance_variable_set("@#{records_name}", value)
-  end
-
-  def record
-    instance_variable_get("@#{record_name}") || (self.record = record!)
-  end
-
-  def record=(value)
-    instance_variable_set("@#{record_name}", value)
-  end
-
-  def record_model
-    @record_model ||= self.class.name.gsub(/.*::|Controller$/, '').singularize.constantize
-  end
-
-  def record_policy = @policy ||= policy record
-  def record_name = record_model.model_name.singular
-  def records_name = record_model.model_name.plural
-  def render_invalid_record = render record.persisted? ? 'edit' : 'new'
-
-  def created_redirect = redirect_back fallback_location: [records_name.to_sym]
-  def destroyed_redirect = redirect_to [records_name.to_sym]
-
-  def updated_redirect
-    return destroyed_redirect if record.destroyed?
-    redirect_to record
-  end
-
-  def created_js
-    render 'create'
-  rescue ActionView::MissingTemplate
-    created_redirect
-  end
-
-  def updated_js
-    render 'update'
-  rescue ActionView::MissingTemplate
-    updated_redirect
-  end
-
-  def destroyed_js
-    render 'destroy'
-  rescue ActionView::MissingTemplate
-    destroyed_redirect
-  end
-
-  def created; end
-  def updated; end
-  def destroyed; end
 end

data/lib/generators/cafe_car/controller/USAGE

@@ -0,0 +1,11 @@
+Description:
+    Generates a new controller and routes for use with CafeCar.
+
+    Pass --skip-routes to generate only the controller.
+
+Example:
+    `bin/rails generate cafe_car:controller admin/invoices`
+
+        This creates:
+            Controller: app/controllers/admin/invoices_controller.rb
+            Routes:     resources :invoices, namespace: :admin

data/lib/generators/cafe_car/controller/controller_generator.rb

@@ -0,0 +1,26 @@
+class CafeCar::ControllerGenerator < Rails::Generators::NamedBase
+  include CafeCar[:Generators]
+
+  source_root File.expand_path("templates", __dir__)
+
+  class_option :skip_routes, type: :boolean, desc: "Don't add routes to config/routes.rb."
+
+  check_class_collision suffix: "Controller"
+
+  def create_controller
+    template "controller.rb", File.join("app/controllers", class_path, "#{file_name}_controller.rb")
+  end
+
+  def add_resource_route
+    return if options.skip_routes?
+    route "#{resources} :#{file_name}", namespace: regular_class_path
+  end
+
+  private
+
+  def class_name           = file_name.camelize
+  def plural?              = file_name == plural_file_name
+  def plural_count         = plural? ? 2 : 1
+  def resources            = "resource".pluralize(plural_count)
+  def base_controller_name = "ApplicationController"
+end

data/lib/generators/cafe_car/controller/templates/controller.rb.tt

@@ -0,0 +1,5 @@
+<% module_namespacing do -%>
+class <%= class_name %>Controller < <%= base_controller_name %>
+  cafe_car
+end
+<% end -%>

data/lib/generators/cafe_car/install/USAGE

@@ -0,0 +1,8 @@
+Description:
+    Explain the generator
+
+Example:
+    bin/rails generate install Thing
+
+    This will create:
+        what/will/it/create

data/lib/generators/cafe_car/install/install_generator.rb

@@ -0,0 +1,46 @@
+class CafeCar::InstallGenerator < Rails::Generators::Base
+  include CafeCar::Generators
+
+  source_root File.expand_path("templates", __dir__)
+
+  def install_deps
+    gem "bcrypt"
+    gem "paper_trail"
+    gem "factory_bot_rails"
+    gem "faker"
+    gem "rouge"
+
+    gem_group :development do
+      gem "hotwire-livereload"
+      gem "better_errors"
+      gem "binding_of_caller"
+      gem "chrome_devtools_rails"
+      gem "i18n-debug"
+    end
+    bundle_command "install"
+  end
+
+  def routes
+    route %(mount CafeCar::Engine => "/"), namespace: :admin
+  end
+
+  def install_pundit
+    template "application_policy.rb", "app/policies/application_policy.rb"
+  end
+
+  def install_js
+    inside "app/javascript" do
+      append_to_file "application.js", <<~JS
+        import "cafe_car"
+        import "trix"
+        import "@rails/actiontext"
+      JS
+    end
+  end
+
+  def install_controller
+    inject_into_class "app/controllers/application_controller.rb", "ApplicationController" do
+      "  include CafeCar::Controller\n"
+    end
+  end
+end

data/lib/generators/cafe_car/install/templates/application_policy.rb.tt

@@ -0,0 +1,7 @@
+class ApplicationPolicy < CafeCar::ApplicationPolicy
+  def admin? = Rails.env.development?
+
+  class Scope < Scope
+    def admin? = Rails.env.development?
+  end
+end

data/lib/generators/cafe_car/notes/USAGE

@@ -0,0 +1,12 @@
+Description:
+    Generates a Note resource that enables internal notes on any model with
+    `include Notable`. Permissions can be customized via the generated policy.
+
+Example:
+    bin/rails generate cafe_car:notes
+
+    This will create:
+        app/models/note.rb
+        app/models/concerns/notable.rb
+        app/policies/note_policy.rb
+        app/controllers/admin/notes_controller.rb

data/lib/generators/cafe_car/notes/notes_generator.rb

@@ -0,0 +1,13 @@
+class CafeCar::NotesGenerator < Rails::Generators::Base
+  include CafeCar::Generators
+
+  source_root File.expand_path("templates", __dir__)
+
+  def create_notes
+    migration "create_notes"
+    template "note.rb", "app/models/note.rb"
+    template "notable.rb", "app/models/concerns/notable.rb"
+    generate "cafe_car:policy", "Note notable_id notable_type body", ("--force" if options.force?)
+    generate "cafe_car:controller", "admin/notes"
+  end
+end

data/lib/generators/cafe_car/notes/templates/create_notes.rb.tt

@@ -0,0 +1,12 @@
+# Generated via `rails cafe_car:notes`
+class CreateNotes < ActiveRecord::Migration[8.0]
+  def change
+    create_table :notes do |t|
+      t.references :notable, polymorphic: true, null: false
+      t.references :author, null: false, foreign_key: {to_table: :users}
+      t.text :body
+
+      t.timestamps
+    end
+  end
+end

data/lib/generators/cafe_car/notes/templates/notable.rb.tt

@@ -0,0 +1,7 @@
+module Notable
+  extend ActiveSupport::Concern
+
+  included do
+    has_many :notes, as: :notable
+  end
+end