oversee 0.2.0 → 0.3.0

data/app/models/oversee/resource.rb

@@ -1,8 +1,15 @@
 class Oversee::Resource
-  def initialize(resource_class:, resource: nil)
+  attr_reader :resource_class
+  attr_reader :resource_class_name
+  attr_reader :instance
+  attr_reader :rich_text_associations
+
+  attr_accessor :associations
+
+  def initialize(resource_class:, instance: nil)
     @resource_class = resource_class
-    @resource = resource
     @resource_class_name = resource_class.to_s
+    @instance = instance
   end
 
   # Route helpers
@@ -13,24 +20,43 @@ class Oversee::Resource
   def resource_path
   end
 
+  # Columns
+  def columns_for_create
+    excluded_columns = [resource_class.primary_key, "created_at", "updated_at"]
+    resource_class.columns_hash.except(*excluded_columns)
+  end
+
+  def columns_for_show
+
+  end
+
   # Associations
+  # Structured by association macro
   def associations
-    map = {
-      belongs_to: [],
-      has_many: [],
-      has_one: [],
-      has_and_belongs_to_many: []
-    }
-
-    @resource_class.reflect_on_all_associations.each do |association|
-      map[association.macro] << {
-        name: association.name,
-        class_name: association.class_name,
-        foreign_key: association.foreign_key,
-        optional: association.macro == :belongs_to ? !!association.options[:optional] : true
-      }
+    @associations ||= begin
+      map = Hash.new { |hash, key| hash[key] = [] }
+
+      @resource_class.reflect_on_all_associations.each do |association|
+        map[association.macro] << {
+          name: association.name,
+          class_name: association.class_name,
+          foreign_key: association.foreign_key,
+          optional: association.macro == :belongs_to ? !!association.options[:optional] : true,
+          through: association.options[:through],
+          rich_text: association.name.to_s.start_with?("rich_text_"),
+        }
+      end
+      map
     end
+  end
+
+  def foreign_keys
+    resource_class.reflections.map do |name, reflection|
+      reflection.foreign_key if reflection.belongs_to?
+    end.compact
+  end
 
-    return map
+  def rich_text_associations
+    @rich_text_associations ||= associations[:has_one].select { |association| association[:rich_text] }
   end
 end

data/app/{oversee → service/oversee}/filter.rb

@@ -1,4 +1,4 @@
-class Filter
+class Oversee::Filter
   ALLOWED_OPERATORS = %w[eq in gt gte lt lte].freeze
 
   def initialize(collection:, params: nil)
@@ -23,7 +23,7 @@ class Filter
   private
 
   # Example params hash:
-  # filters[kind][is][]=get => {"kind"=>{"is"=>["get"]}}
+  # filters[kind][eq][]=get => {"kind"=>{"is"=>["get"]}}
   def filters
     @filters ||= @params[:filters]
   end

data/app/{oversee → service/oversee}/search.rb

@@ -1,4 +1,4 @@
-class Search
+class Oversee::Search
   DEFAULT_SEARCHABLE_ATTRIBUTES = %w[name title email email_address]
 
   def initialize(collection:, resource_class:, query: nil)

data/app/views/oversee/base.rb

@@ -0,0 +1,5 @@
+class Oversee::Views::Base < Phlex::HTML
+  def around_template
+    render Oversee::Layout::Application.new { super }
+  end
+end

data/config/importmap.rb

@@ -0,0 +1,14 @@
+# Application
+pin "application", to: "oversee/application.js", preload: true
+
+# Rich text editor
+pin "trix", to: "https://unpkg.com/trix@2.1.8"
+pin "@rails/actiontext", to: "https://unpkg.com/@rails/actiontext@8.0.0"
+
+# Turbo
+pin "@hotwired/turbo-rails", to: "https://unpkg.com/@hotwired/turbo-rails"
+
+# Stimulus
+pin "@hotwired/stimulus", to: "https://unpkg.com/@hotwired/stimulus/dist/stimulus.js"
+pin "@hotwired/stimulus-loading", to: "stimulus-loading.js", preload: true
+pin_all_from Oversee::Engine.root.join("app/javascript/oversee/controllers"), under: "controllers", to: "oversee/controllers"

data/config/routes.rb

@@ -1,15 +1,21 @@
 Oversee::Engine.routes.draw do
   # Resources
-  scope :resources, controller: "resources" do
-    get ":resource_class_name/", action: :index, as: :resources
-    get ":resource_class_name/table", action: :table, as: :resources_table
-    get ":resource_class_name/new", action: :new, as: :new_resource
-    post ":resource_class_name/", action: :create, as: :create_resource
-    get ":resource_class_name/:id", action: :show, as: :resource
-    get ":resource_class_name/:id/edit", action: :edit, as: :edit_resource
-    patch ":resource_class_name/:id", action: :update, as: :update_resource
-    delete ":resource_class_name/:id", action: :destroy, as: :destroy_resource
-    get ":resource_class_name/:id/input_field", action: :input_field, as: :resource_input_field
+  scope ":resource_class_name", controller: "resources" do
+    get "/", action: :index, as: :resources
+    post "/", action: :create, as: :create_resource
+    get "/new", action: :new, as: :new_resource
+    get "/:id", action: :show, as: :resource
+    get "/:id/edit", action: :edit, as: :edit_resource
+    patch "/:id", action: :update, as: :update_resource
+    delete "/:id", action: :destroy, as: :destroy_resource
+    get "/table", action: :table, as: :resources_table
+
+    get "/:id/input_field", action: :input_field, as: :resource_input_field
+    get "/:id/association", action: :association, as: :resource_association
+
+
+    # To reach this route using Rails' route helpers, use resource_input_path(:resource_class_name, :id)
+    get "/:id/input", controller: "resources/fields", action: :input, as: :resource_input
   end
 
   root to: "dashboard#index"

data/lib/generators/oversee/install_generator.rb

@@ -0,0 +1,7 @@
+class Oversee::InstallGenerator < Rails::Generators::Base
+  source_root File.expand_path('templates', __dir__)
+
+  def add_routes
+    route 'mount Oversee::Engine => "/oversee"'
+  end
+end

data/lib/oversee/engine.rb

@@ -1,3 +1,5 @@
+require "importmap-rails"
+
 module Oversee
   class Engine < ::Rails::Engine
     isolate_namespace Oversee
@@ -6,5 +8,22 @@ module Oversee
       # Eager-loading to fetch all resources
       Rails.application.eager_load!
     end
+
+    initializer "oversee.assets" do |app|
+      if app.config.respond_to?(:assets)
+        app.config.assets.paths << root.join("app/assets/stylesheets")
+        app.config.assets.paths << root.join("app/javascript")
+        app.config.assets.precompile += %w[oversee_manifest]
+      end
+    end
+
+    initializer "oversee.importmap", before: "importmap" do |app|
+      Oversee.importmap.draw(root.join("config/importmap.rb"))
+      Oversee.importmap.cache_sweeper(watches: root.join("app/javascript"))
+
+      ActiveSupport.on_load(:action_controller_base) do
+        before_action { Oversee.importmap.cache_sweeper.execute_if_updated }
+      end
+    end
   end
 end

data/lib/oversee/version.rb

@@ -1,3 +1,3 @@
 module Oversee
-  VERSION = "0.2.0"
+  VERSION = "0.3.0"
 end

data/lib/oversee.rb

@@ -18,6 +18,9 @@ loader.ignore("#{__dir__}/generators")
 loader.setup
 
 module Oversee
+
+  mattr_accessor :importmap, default: Importmap::Map.new
+
   class << self
 
     def application_name
@@ -41,4 +44,13 @@ module Oversee
       files.map! { |f| f.split(root.to_s).last.delete_suffix(".rb").classify.prepend("Cards::") }
     end
   end
+
+  # VIEWS
+  module Views
+  end
+
+  # COMPONENTS
+  module Components
+    extend Phlex::Kit
+  end
 end

data/lib/tasks/oversee_tasks.rake

@@ -1,4 +1,6 @@
-# desc "Explaining what the task does"
-# task :oversee do
-#   # Task goes here
-# end
+namespace :oversee do
+  desc "Installs Oversee into your application"
+  task :install do
+    # TODO Add route mounting
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: oversee
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Elvinas Predkelis
@@ -9,7 +9,7 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-10-18 00:00:00.000000000 Z
+date: 2024-12-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -25,6 +25,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 7.0.0
+- !ruby/object:Gem::Dependency
+  name: importmap-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: pagy
   requirement: !ruby/object:Gem::Requirement
@@ -105,6 +119,7 @@ files:
 - LICENCE
 - README.md
 - Rakefile
+- app/assets/config/oversee_manifest.js
 - app/components/oversee/base.rb
 - app/components/oversee/card.rb
 - app/components/oversee/dashboard/filters.rb
@@ -117,18 +132,23 @@ files:
 - app/components/oversee/field/display.rb
 - app/components/oversee/field/form.rb
 - app/components/oversee/field/input.rb
+- app/components/oversee/field/input/belongs_to.rb
 - app/components/oversee/field/input/boolean.rb
 - app/components/oversee/field/input/datetime.rb
 - app/components/oversee/field/input/integer.rb
+- app/components/oversee/field/input/rich_text.rb
 - app/components/oversee/field/input/string.rb
 - app/components/oversee/field/label.rb
 - app/components/oversee/field/value.rb
+- app/components/oversee/field/value/belongs_to.rb
 - app/components/oversee/field/value/boolean.rb
 - app/components/oversee/field/value/datetime.rb
 - app/components/oversee/field/value/enum.rb
 - app/components/oversee/field/value/integer.rb
+- app/components/oversee/field/value/rich_text.rb
 - app/components/oversee/field/value/string.rb
 - app/components/oversee/field/value/text.rb
+- app/components/oversee/layout/application.rb
 - app/components/oversee/resources/base.rb
 - app/components/oversee/resources/errors.rb
 - app/components/oversee/resources/form.rb
@@ -146,17 +166,20 @@ files:
 - app/controllers/oversee/dashboard_controller.rb
 - app/controllers/oversee/resources/fields_controller.rb
 - app/controllers/oversee/resources_controller.rb
-- app/jobs/oversee/application_job.rb
+- app/javascript/oversee/application.js
+- app/javascript/oversee/controllers/index.js
+- app/javascript/oversee/controllers/reveal_controller.js
+- app/javascript/oversee/controllers/sidebar/state_controller.js
 - app/models/oversee/application_record.rb
 - app/models/oversee/resource.rb
-- app/oversee/cards.rb
-- app/oversee/filter.rb
-- app/oversee/resource.rb
-- app/oversee/search.rb
-- app/views/layouts/oversee/application.html.erb
+- app/service/oversee/filter.rb
+- app/service/oversee/search.rb
+- app/views/oversee/base.rb
+- config/importmap.rb
 - config/locales/en.yml
 - config/locales/oversee.en.yml
 - config/routes.rb
+- lib/generators/oversee/install_generator.rb
 - lib/oversee.rb
 - lib/oversee/configuration.rb
 - lib/oversee/engine.rb

data/app/jobs/oversee/application_job.rb

@@ -1,4 +0,0 @@
-module Oversee
-  class ApplicationJob < ActiveJob::Base
-  end
-end

data/app/oversee/cards.rb

@@ -1,2 +0,0 @@
-class Cards
-end

data/app/oversee/resource.rb

@@ -1,10 +0,0 @@
-class Resource
-  def initialize(resource)
-    @resource = resource
-  end
-
-  def columns_for_create
-    excluded_columns = [@resource.class.primary_key, "created_at", "updated_at"]
-    @resource.columns_hash.except(*excluded_columns)
-  end
-end

data/app/views/layouts/oversee/application.html.erb

@@ -1,26 +0,0 @@
-<!DOCTYPE html>
-<html>
-<head>
-  <meta name="viewport" content="width=device-width, initial-scale=1.0">
-  <meta name="ROBOTS" content="NOODP">
-
-  <title>Oversee | <%= Oversee.application_name %></title>
-  <%= csrf_meta_tags %>
-  <%= csp_meta_tag %>
-  <%= render Oversee::Dashboard::Javascript.new %>
-  <%= render Oversee::Dashboard::Tailwind.new %>
-</head>
-<body class="min-h-screen bg-gray-100 p-8">
-  <pre><%#= Oversee.filtered_resources.to_yaml %></pre>
-  <div class="flex gap-4 w-full">
-    <div class="w-72 shrink-0">
-			<%= render Oversee::Dashboard::Sidebar.new %>
-		</div>
-		<div class="w-full overflow-scroll">
-			<div class="bg-white rounded-lg overflow-clip">
-  			<%= yield %>
-   	  </div>
-		</div>
-	</div>
-</body>
-</html>