terrazzo 0.1.0

data/lib/generators/terrazzo/dashboard/templates/dashboard.rb.erb

@@ -0,0 +1,36 @@
+require "terrazzo/base_dashboard"
+
+class <%= class_name %>Dashboard < Terrazzo::BaseDashboard
+  ATTRIBUTE_TYPES = {
+<% attribute_types.each do |attr, type| -%>
+<% if has_enum?(attr.to_s) -%>
+    <%= attr %>: Terrazzo::<%= type %>.with_options(collection: <%= enum_collection(attr.to_s).inspect %>),
+<% else -%>
+    <%= attr %>: Terrazzo::<%= type %>,
+<% end -%>
+<% end -%>
+  }.freeze
+
+  COLLECTION_ATTRIBUTES = %i[
+<% collection_attributes.each do |attr| -%>
+    <%= attr %>
+<% end -%>
+  ].freeze
+
+  SHOW_PAGE_ATTRIBUTES = %i[
+<% show_page_attributes.each do |attr| -%>
+    <%= attr %>
+<% end -%>
+  ].freeze
+
+  FORM_ATTRIBUTES = %i[
+<% form_attributes.each do |attr| -%>
+    <%= attr %>
+<% end -%>
+  ].freeze
+
+  # COLLECTION_FILTERS = {
+  #   active: ->(resources) { resources.where(active: true) },
+  #   recent: ->(resources) { resources.where("created_at > ?", 30.days.ago) },
+  # }.freeze
+end

data/lib/generators/terrazzo/field/field_generator.rb

@@ -0,0 +1,42 @@
+require "rails/generators"
+
+module Terrazzo
+  module Generators
+    class FieldGenerator < Rails::Generators::NamedBase
+      source_root File.expand_path("templates", __dir__)
+
+      class_option :namespace, type: :string, default: "admin",
+        desc: "Admin namespace"
+
+      def create_field_class
+        template "field.rb.erb",
+          "app/fields/#{file_name}_field.rb"
+      end
+
+      def create_jsx_components
+        %w[IndexField ShowField FormField].each do |component|
+          template "#{component}.jsx.erb",
+            "app/views/#{namespace_name}/fields/#{file_name}/#{component}.jsx"
+        end
+      end
+
+      def show_registration_instructions
+        say "\nTo use your custom field, register it in your FieldRenderer.jsx:", :green
+        say "  import { IndexField as #{class_name}Index } from \"./#{file_name}/IndexField\";"
+        say "  import { ShowField as #{class_name}Show } from \"./#{file_name}/ShowField\";"
+        say "  import { FormField as #{class_name}Form } from \"./#{file_name}/FormField\";"
+        say ""
+        say "  registerFieldType(\"#{file_name}\", { index: #{class_name}Index, show: #{class_name}Show, form: #{class_name}Form });"
+        say ""
+        say "Then use it in your dashboard:"
+        say "  #{file_name}: Terrazzo::Field::#{class_name},"
+      end
+
+      private
+
+      def namespace_name
+        options[:namespace]
+      end
+    end
+  end
+end

data/lib/generators/terrazzo/field/templates/FormField.jsx.erb

@@ -0,0 +1,19 @@
+import React from "react";
+import { Input } from "../../components/ui/input";
+import { Label } from "../../components/ui/label";
+
+export function FormField({ attribute, label, value, input, required }) {
+  return (
+    <div className="space-y-2">
+      <Label htmlFor={input.id}>
+        {label}{required && <span className="text-red-500 ml-1">*</span>}
+      </Label>
+      <Input
+        type="text"
+        id={input.id}
+        name={input.name}
+        defaultValue={value ?? ""}
+      />
+    </div>
+  );
+}

data/lib/generators/terrazzo/field/templates/IndexField.jsx.erb

@@ -0,0 +1,5 @@
+import React from "react";
+
+export function IndexField({ value }) {
+  return <span>{String(value ?? "")}</span>;
+}

data/lib/generators/terrazzo/field/templates/ShowField.jsx.erb

@@ -0,0 +1,5 @@
+import React from "react";
+
+export function ShowField({ value }) {
+  return <span>{String(value ?? "")}</span>;
+}

data/lib/generators/terrazzo/field/templates/field.rb.erb

@@ -0,0 +1,23 @@
+module Terrazzo
+  module Field
+    class <%= class_name %> < Base
+      def serialize_value(mode)
+        data
+      end
+
+      def serializable_options
+        {}
+      end
+
+      class << self
+        def searchable?
+          false
+        end
+
+        def sortable?
+          true
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,85 @@
+require "rails/generators"
+
+module Terrazzo
+  module Generators
+    class InstallGenerator < Rails::Generators::Base
+      source_root File.expand_path("templates", __dir__)
+
+      class_option :namespace, type: :string, default: "admin",
+        desc: "Admin namespace"
+      class_option :bundler, type: :string, default: "vite",
+        desc: "JavaScript bundler (vite or sprockets)"
+
+      def create_application_controller
+        template "application_controller.rb.erb",
+          "app/controllers/#{namespace_name}/application_controller.rb"
+      end
+
+      def create_layout
+        template "superglue.html.erb.erb",
+          "app/views/layouts/#{namespace_name}/application.html.erb"
+      end
+
+      def create_json_props_layout
+        copy_file "application.json.props",
+          "app/views/layouts/#{namespace_name}/application.json.props"
+      end
+
+      def create_js_entry_point
+        template "application.js.erb",
+          "app/javascript/#{namespace_name}/application.jsx"
+      end
+
+      def create_store
+        template "store.js.erb",
+          "app/javascript/#{namespace_name}/store.js"
+      end
+
+      def create_page_to_page_mapping
+        template "page_to_page_mapping.js.erb",
+          "app/javascript/#{namespace_name}/page_to_page_mapping.js"
+      end
+
+      def create_application_visit
+        template "application_visit.js.erb",
+          "app/javascript/#{namespace_name}/application_visit.js"
+      end
+
+      def create_flash_slice
+        template "flash_slice.js.erb",
+          "app/javascript/#{namespace_name}/slices/flash.js"
+      end
+
+      def run_views_generator
+        generate "terrazzo:views", "--namespace=#{namespace_name}"
+      end
+
+      def run_routes_generator
+        generate "terrazzo:routes", "--namespace=#{namespace_name}"
+      end
+
+      def run_dashboard_generators
+        application_models.each do |model|
+          generate "terrazzo:dashboard", model.name, "--namespace=#{namespace_name}", "--bundler=#{options[:bundler]}"
+        end
+      end
+
+      private
+
+      def namespace_name
+        options[:namespace]
+      end
+
+      def vite?
+        options[:bundler] == "vite"
+      end
+
+      def application_models
+        Rails.application.eager_load! if defined?(Rails)
+        ApplicationRecord.descendants.reject(&:abstract_class?)
+      rescue
+        []
+      end
+    end
+  end
+end

data/lib/generators/terrazzo/install/templates/application.js.erb

@@ -0,0 +1,27 @@
+import React from "react"
+import { createRoot } from "react-dom/client"
+import { Application } from "@thoughtbot/superglue"
+import { buildVisitAndRemote } from "./application_visit"
+import { pageToPageMapping } from "./page_to_page_mapping"
+import { store } from "./store"
+
+if (typeof window !== "undefined") {
+  document.addEventListener("DOMContentLoaded", function () {
+    const appEl = document.getElementById("superglue-app")
+    const location = window.location
+
+    if (appEl) {
+      const root = createRoot(appEl)
+      root.render(
+        <Application
+          initialPage={window.SUPERGLUE_INITIAL_PAGE_STATE}
+          baseUrl={location.origin}
+          path={location.pathname + location.search + location.hash}
+          store={store}
+          mapping={pageToPageMapping}
+          buildVisitAndRemote={buildVisitAndRemote}
+        />
+      )
+    }
+  })
+}

data/lib/generators/terrazzo/install/templates/application.json.props

@@ -0,0 +1,27 @@
+path = request.format.json? ? param_to_dig_path(params[:props_at]) : nil
+
+json.data(dig: path) do
+  yield
+end
+
+json.componentIdentifier terrazzo_page_identifier
+json.defers json.deferred!
+json.fragments json.fragments!
+json.assets []
+
+if protect_against_forgery?
+  json.csrfToken form_authenticity_token
+end
+
+if path
+  json.action "graft"
+  json.path params[:props_at]
+end
+
+json.restoreStrategy "fromCacheAndRevisitInBackground"
+
+json.renderedAt Time.now.to_i
+
+json.slices do
+  json.flash flash.to_h
+end

data/lib/generators/terrazzo/install/templates/application.json.props.erb

@@ -0,0 +1,17 @@
+json.data(search: request.path) do
+  yield
+end
+
+json.componentIdentifier local_assigns[:virtual_path_of_template]
+json.assets do
+  json.array! []
+end
+
+json.csrfToken form_authenticity_token
+json.restoreStrategy "fromCacheAndRevisitInBackground"
+
+json.flash do
+  flash.each do |type, message|
+    json.set!(type, message)
+  end
+end

data/lib/generators/terrazzo/install/templates/application_controller.rb.erb

@@ -0,0 +1,24 @@
+module <%= namespace_name.camelize %>
+  class ApplicationController < Terrazzo::ApplicationController
+    layout "<%= namespace_name %>/application"
+    superglue_template "terrazzo/application/superglue"
+
+    # before_action :authenticate_admin
+
+    # Override to limit which records are visible
+    # def scoped_resource
+    #   resource_class.all
+    # end
+
+    # Override to control access to actions
+    # def authorized_action?(resource, action)
+    #   true
+    # end
+
+    private
+
+    # def authenticate_admin
+    #   redirect_to root_path unless current_user&.admin?
+    # end
+  end
+end

data/lib/generators/terrazzo/install/templates/application_visit.js.erb

@@ -0,0 +1,8 @@
+import { visit, remote } from "@thoughtbot/superglue/action_creators"
+
+export function buildVisitAndRemote(ref, store, pageToPageMapping) {
+  const appVisit = visit(ref, store, pageToPageMapping)
+  const appRemote = remote(ref, store, pageToPageMapping)
+
+  return { visit: appVisit, remote: appRemote }
+}

data/lib/generators/terrazzo/install/templates/flash_slice.js.erb

@@ -0,0 +1,42 @@
+import { createSlice } from "@reduxjs/toolkit"
+import { saveResponse, beforeVisit } from "@thoughtbot/superglue"
+
+export const flashSlice = createSlice({
+  name: "flash",
+  initialState: {},
+  reducers: {
+    clearFlash(state, { payload }) {
+      const key = payload
+      if (!key) {
+        return {}
+      }
+
+      delete state[key]
+
+      return {
+        ...state
+      }
+    },
+    flash(state, { payload }) {
+      return {
+        ...state,
+        ...payload
+      }
+    }
+  },
+  extraReducers: builder => {
+    builder.addCase(beforeVisit, (_state, _action) => {
+      return {}
+    })
+    builder.addCase(saveResponse, (state, action) => {
+      const { page } = action.payload
+
+      return {
+        ...state,
+        ...page.slices.flash
+      }
+    })
+  }
+})
+
+export const { clearFlash, flash } = flashSlice.actions

data/lib/generators/terrazzo/install/templates/page_to_page_mapping.js.erb

@@ -0,0 +1,22 @@
+<% if vite? -%>
+const pages = import.meta.glob("../../views/<%= namespace_name %>/**/*.jsx", { eager: true })
+
+export const pageToPageMapping = {}
+
+for (const key in pages) {
+  const identifier = key.replace("../../views/", "").replace(/\.jsx$/, "")
+  pageToPageMapping[identifier] = pages[key].default
+}
+<% else -%>
+import AdminIndex from "../../views/<%= namespace_name %>/application/index"
+import AdminShow from "../../views/<%= namespace_name %>/application/show"
+import AdminNew from "../../views/<%= namespace_name %>/application/new"
+import AdminEdit from "../../views/<%= namespace_name %>/application/edit"
+
+export const pageToPageMapping = {
+  '<%= namespace_name %>/application/index': AdminIndex,
+  '<%= namespace_name %>/application/show': AdminShow,
+  '<%= namespace_name %>/application/new': AdminNew,
+  '<%= namespace_name %>/application/edit': AdminEdit,
+}
+<% end -%>

data/lib/generators/terrazzo/install/templates/store.js.erb

@@ -0,0 +1,24 @@
+import { configureStore } from "@reduxjs/toolkit"
+import { flashSlice } from "./slices/flash"
+import {
+  beforeVisit,
+  beforeFetch,
+  beforeRemote,
+  rootReducer,
+} from "@thoughtbot/superglue"
+
+const { pages, superglue } = rootReducer
+
+export const store = configureStore({
+  middleware: (getDefaultMiddleware) =>
+    getDefaultMiddleware({
+      serializableCheck: {
+        ignoredActions: [beforeFetch.type, beforeVisit.type, beforeRemote.type],
+      },
+    }),
+  reducer: {
+    superglue,
+    pages,
+    flash: flashSlice.reducer,
+  },
+})

data/lib/generators/terrazzo/install/templates/superglue.html.erb.erb

@@ -0,0 +1,20 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <meta charset="utf-8">
+  <meta name="viewport" content="width=device-width, initial-scale=1">
+  <%%= csrf_meta_tags %>
+  <%%= csp_meta_tag %>
+  <%%= yield :head %>
+<% if vite? -%>
+  <%%= vite_react_refresh_tag %>
+  <%%= vite_javascript_tag "<%= namespace_name %>/application" %>
+<% else -%>
+  <%%= javascript_include_tag "<%= namespace_name %>", type: "module" %>
+<% end -%>
+  <%%= stylesheet_link_tag "<%= namespace_name %>", "data-turbo-track": "reload" %>
+</head>
+<body>
+  <%%= yield %>
+</body>
+</html>

data/lib/generators/terrazzo/routes/routes_generator.rb

@@ -0,0 +1,38 @@
+require "rails/generators"
+
+module Terrazzo
+  module Generators
+    class RoutesGenerator < Rails::Generators::Base
+      source_root File.expand_path("templates", __dir__)
+
+      class_option :namespace, type: :string, default: "admin",
+        desc: "Admin namespace"
+
+      def insert_routes
+        namespace_name = options[:namespace]
+        route_content = <<~RUBY.indent(2)
+          namespace :#{namespace_name} do
+            root to: "#{first_resource}#index"
+          end
+        RUBY
+
+        route route_content.strip
+      end
+
+      private
+
+      def first_resource
+        # Default to "customers" if no models found
+        models = application_models
+        models.any? ? models.first.model_name.plural : "dashboard"
+      end
+
+      def application_models
+        Rails.application.eager_load! if defined?(Rails)
+        ApplicationRecord.descendants.reject(&:abstract_class?)
+      rescue
+        []
+      end
+    end
+  end
+end

data/lib/generators/terrazzo/views/edit_generator.rb

@@ -0,0 +1,28 @@
+require "rails/generators"
+
+module Terrazzo
+  module Generators
+    module Views
+      class EditGenerator < Rails::Generators::Base
+        source_root File.expand_path("templates", __dir__)
+
+        class_option :namespace, type: :string, default: "admin",
+          desc: "Admin namespace"
+
+        def copy_edit_template
+          copy_file "pages/edit.jsx", "app/views/#{namespace_name}/application/edit.jsx"
+        end
+
+        def copy_form_partial
+          copy_file "pages/_form.jsx", "app/views/#{namespace_name}/application/_form.jsx"
+        end
+
+        private
+
+        def namespace_name
+          options[:namespace]
+        end
+      end
+    end
+  end
+end

data/lib/generators/terrazzo/views/field_generator.rb

@@ -0,0 +1,32 @@
+require "rails/generators"
+
+module Terrazzo
+  module Generators
+    module Views
+      class FieldGenerator < Rails::Generators::Base
+        source_root File.expand_path("templates", __dir__)
+
+        class_option :namespace, type: :string, default: "admin",
+          desc: "Admin namespace"
+
+        argument :field_type, type: :string, required: false, default: "all",
+          desc: "Specific field type to copy (e.g., string, number) or 'all'"
+
+        def copy_field_templates
+          if field_type == "all"
+            directory "fields", "app/views/#{namespace_name}/fields"
+          else
+            directory "fields/shared", "app/views/#{namespace_name}/fields/shared"
+            directory "fields/#{field_type}", "app/views/#{namespace_name}/fields/#{field_type}"
+          end
+        end
+
+        private
+
+        def namespace_name
+          options[:namespace]
+        end
+      end
+    end
+  end
+end

data/lib/generators/terrazzo/views/index_generator.rb

@@ -0,0 +1,24 @@
+require "rails/generators"
+
+module Terrazzo
+  module Generators
+    module Views
+      class IndexGenerator < Rails::Generators::Base
+        source_root File.expand_path("templates", __dir__)
+
+        class_option :namespace, type: :string, default: "admin",
+          desc: "Admin namespace"
+
+        def copy_index_template
+          copy_file "pages/index.jsx", "app/views/#{namespace_name}/application/index.jsx"
+        end
+
+        private
+
+        def namespace_name
+          options[:namespace]
+        end
+      end
+    end
+  end
+end

data/lib/generators/terrazzo/views/layout_generator.rb

@@ -0,0 +1,26 @@
+require "rails/generators"
+
+module Terrazzo
+  module Generators
+    module Views
+      class LayoutGenerator < Rails::Generators::Base
+        source_root File.expand_path("templates", __dir__)
+
+        class_option :namespace, type: :string, default: "admin",
+          desc: "Admin namespace"
+
+        def copy_layout_components
+          %w[Layout.jsx app-sidebar.jsx site-header.jsx FlashMessages.jsx].each do |file|
+            copy_file "components/#{file}", "app/views/#{namespace_name}/components/#{file}"
+          end
+        end
+
+        private
+
+        def namespace_name
+          options[:namespace]
+        end
+      end
+    end
+  end
+end

data/lib/generators/terrazzo/views/navigation_generator.rb

@@ -0,0 +1,24 @@
+require "rails/generators"
+
+module Terrazzo
+  module Generators
+    module Views
+      class NavigationGenerator < Rails::Generators::Base
+        source_root File.expand_path("templates", __dir__)
+
+        class_option :namespace, type: :string, default: "admin",
+          desc: "Admin namespace"
+
+        def copy_navigation
+          copy_file "components/app-sidebar.jsx", "app/views/#{namespace_name}/components/app-sidebar.jsx"
+        end
+
+        private
+
+        def namespace_name
+          options[:namespace]
+        end
+      end
+    end
+  end
+end

data/lib/generators/terrazzo/views/new_generator.rb

@@ -0,0 +1,28 @@
+require "rails/generators"
+
+module Terrazzo
+  module Generators
+    module Views
+      class NewGenerator < Rails::Generators::Base
+        source_root File.expand_path("templates", __dir__)
+
+        class_option :namespace, type: :string, default: "admin",
+          desc: "Admin namespace"
+
+        def copy_new_template
+          copy_file "pages/new.jsx", "app/views/#{namespace_name}/application/new.jsx"
+        end
+
+        def copy_form_partial
+          copy_file "pages/_form.jsx", "app/views/#{namespace_name}/application/_form.jsx"
+        end
+
+        private
+
+        def namespace_name
+          options[:namespace]
+        end
+      end
+    end
+  end
+end

data/lib/generators/terrazzo/views/show_generator.rb

@@ -0,0 +1,24 @@
+require "rails/generators"
+
+module Terrazzo
+  module Generators
+    module Views
+      class ShowGenerator < Rails::Generators::Base
+        source_root File.expand_path("templates", __dir__)
+
+        class_option :namespace, type: :string, default: "admin",
+          desc: "Admin namespace"
+
+        def copy_show_template
+          copy_file "pages/show.jsx", "app/views/#{namespace_name}/application/show.jsx"
+        end
+
+        private
+
+        def namespace_name
+          options[:namespace]
+        end
+      end
+    end
+  end
+end