oversee 0.1.1 → 0.3.0

data/lib/oversee/configuration.rb

@@ -2,14 +2,17 @@
 
 module Oversee
   class Configuration
+    # Attributes
     attr_accessor :excluded_resources
     attr_accessor :filter_sensitive_columns
     attr_accessor :sensitive_column_titles
+    attr_accessor :per_page
 
     def initialize
       @excluded_resources = []
       @filter_sensitive_columns = true
       @sensitive_column_titles = %w[password password_digest access_token]
+      @per_page = 24
     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.1.1"
+  VERSION = "0.3.0"
 end

data/lib/oversee.rb

@@ -1,10 +1,15 @@
+# Zeitwerk
 require "zeitwerk"
 
+# Oversee
 require "oversee/version"
 require "oversee/engine"
 require "oversee/configuration"
 
+# Phlex
 require "phlex-rails"
+
+# Pagy
 require "pagy"
 
 # Zeitwerk
@@ -13,20 +18,39 @@ loader.ignore("#{__dir__}/generators")
 loader.setup
 
 module Oversee
+
+  mattr_accessor :importmap, default: Importmap::Map.new
+
   class << self
 
     def application_name
       Rails.application.class.to_s.gsub("::Application", "")
     end
 
-    def allowed_resource_list
-      ApplicationRecord.descendants
+    # Resources
+    def application_resources(filtered: true)
+      resources = ::ApplicationRecord.descendants
+      resources = resources.filter { |klass| !Oversee.configuration.excluded_resources.include?(klass.to_s) } if filtered
+    end
+
+    def application_resource_names(filtered: true)
+      application_resources(filtered:).map(&:to_s)
     end
 
+    # Cards
     def card_class_names
       root = Rails.root.join("app/oversee/cards/")
       files = Dir.glob(root.join("**/*.rb"))
       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.1.1
+  version: 0.3.0
 platform: ruby
 authors:
 - Elvinas Predkelis
@@ -9,7 +9,7 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-10-10 00:00:00.000000000 Z
+date: 2024-12-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -17,70 +17,98 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 7.0.3
+        version: 7.0.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 7.0.3
+        version: 7.0.0
 - !ruby/object:Gem::Dependency
-  name: zeitwerk
+  name: importmap-rails
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 2.6.12
+        version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 2.6.12
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: pagy
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '3.5'
+        version: 7.0.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '3.5'
+        version: 7.0.0
 - !ruby/object:Gem::Dependency
   name: phlex-rails
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 1.1.1
+        version: 2.0.0.beta2
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 1.1.1
+        version: 2.0.0.beta2
+- !ruby/object:Gem::Dependency
+  name: phlex-icons-iconoir
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.1.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.1.0
 - !ruby/object:Gem::Dependency
   name: turbo-rails
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 2.0.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 2.0.0
+- !ruby/object:Gem::Dependency
+  name: zeitwerk
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.6.12
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.6.12
 description: Lightweight admin dashboard for Rails
 email:
 - info@primevise.com
@@ -92,47 +120,66 @@ files:
 - README.md
 - Rakefile
 - app/assets/config/oversee_manifest.js
-- app/assets/stylesheets/oversee/application.css
-- app/components/oversee/application_component.rb
-- app/components/oversee/card_component.rb
-- app/components/oversee/dashboard/sidebar_component.rb
-- app/components/oversee/field_component.rb
-- app/components/oversee/field_label_component.rb
-- app/components/oversee/fields/display_row_component.rb
-- app/components/oversee/fields/input/boolean_component.rb
-- app/components/oversee/fields/input/datetime_component.rb
-- app/components/oversee/fields/input/integer_component.rb
-- app/components/oversee/fields/input/string_component.rb
-- app/components/oversee/fields/value/boolean_component.rb
-- app/components/oversee/fields/value/datetime_component.rb
-- app/components/oversee/fields/value/enum_component.rb
-- app/components/oversee/fields/value/integer_component.rb
-- app/components/oversee/fields/value/string_component.rb
-- app/components/oversee/fields/value/text_component.rb
+- app/components/oversee/base.rb
+- app/components/oversee/card.rb
+- app/components/oversee/dashboard/filters.rb
+- app/components/oversee/dashboard/header.rb
+- app/components/oversee/dashboard/index.rb
+- app/components/oversee/dashboard/javascript.rb
+- app/components/oversee/dashboard/pagination.rb
+- app/components/oversee/dashboard/sidebar.rb
+- app/components/oversee/dashboard/tailwind.rb
+- 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
+- app/components/oversee/resources/index.rb
+- app/components/oversee/resources/new.rb
+- app/components/oversee/resources/show.rb
+- app/components/oversee/resources/table.rb
+- app/components/oversee/table.rb
+- app/components/oversee/table/body.rb
+- app/components/oversee/table/data.rb
+- app/components/oversee/table/head.rb
+- app/components/oversee/table/row.rb
 - app/controllers/oversee/application_controller.rb
 - app/controllers/oversee/base_controller.rb
 - app/controllers/oversee/dashboard_controller.rb
 - app/controllers/oversee/resources/fields_controller.rb
 - app/controllers/oversee/resources_controller.rb
-- app/helpers/oversee/application_helper.rb
-- app/jobs/oversee/application_job.rb
-- app/mailers/oversee/application_mailer.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/oversee/cards.rb
-- app/oversee/resource.rb
-- app/views/layouts/oversee/application.html.erb
-- app/views/oversee/application/_javascript.html.erb
-- app/views/oversee/dashboard/show.html.erb
-- app/views/oversee/resources/_form.html.erb
-- app/views/oversee/resources/_input_field.html.erb
-- app/views/oversee/resources/edit.html.erb
-- app/views/oversee/resources/index.html.erb
-- app/views/oversee/resources/input_field.html.erb
-- app/views/oversee/resources/new.html.erb
-- app/views/oversee/resources/show.html.erb
-- app/views/oversee/resources/update.turbo_stream.erb
-- app/views/shared/_sidebar.html.erb
+- app/models/oversee/resource.rb
+- 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
@@ -152,7 +199,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 3.3.1
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="

data/app/assets/stylesheets/oversee/application.css

@@ -1,15 +0,0 @@
-/*
- * This is a manifest file that'll be compiled into application.css, which will include all the files
- * listed below.
- *
- * Any CSS and SCSS file within this directory, lib/assets/stylesheets, vendor/assets/stylesheets,
- * or any plugin's vendor/assets/stylesheets directory can be referenced here using a relative path.
- *
- * You're free to add application-wide styles to this file and they'll appear at the bottom of the
- * compiled file so the styles you add here take precedence over styles defined in any other CSS/SCSS
- * files in this directory. Styles in this file should be added after the last require_* statement.
- * It is generally better to create a new file per style scope.
- *
- *= require_tree .
- *= require_self
- */

data/app/components/oversee/card_component.rb

@@ -1,15 +0,0 @@
-module Oversee
-  class CardComponent < Phlex::HTML
-    def initialize(card_name: )
-      @card_name = card_name
-      @card = card_name.constantize.new
-    end
-
-    def view_template
-      div(class: "bg-white rounded-md border shadow-sm p-4") do
-        p(class: "text-xs uppercase font-medium text-gray-400") { @card.label }
-        h4(class: "mt-2 text-gray-900 text-2xl") { @card.value }
-      end
-    end
-  end
-end

data/app/components/oversee/dashboard/sidebar_component.rb

@@ -1,127 +0,0 @@
-# frozen_string_literal: true
-
-class Oversee::Dashboard::SidebarComponent < Oversee::ApplicationComponent
-  include Phlex::Rails::Helpers::LinkTo
-  include Phlex::Rails::Helpers::ButtonTo
-
-  def view_template
-    div(class: "bg-white border p-4 rounded-lg") do
-
-      p(class: "text-[0.7rem] uppercase text-gray-400 font-medium mb-2") { "Menu" }
-      ul(class: "text-sm text-gray-700") do
-        li do
-          link_to root_path,
-            class:
-              "flex items-center gap-2 hover:bg-gray-50 p-2 rounded-lg" do
-            layout_icon
-            span { "Dashboard" }
-          end
-        end
-        li do
-          link_to helpers.main_app.root_path,
-            class:
-              "flex items-center gap-2 hover:bg-gray-50 p-2 rounded-lg" do
-            main_app_icon
-            span { "Return to app" }
-          end
-        end
-      end
-
-      hr(class: "my-4")
-      p(class: "text-[0.7rem] uppercase text-gray-400 font-medium mb-2") { "Resources" }
-      ul(class: "text-sm text-gray-700") do
-        ApplicationRecord.descendants.map(&:to_s).sort.each do |resource_name|
-          li do
-            link_to helpers.resources_path(resource: resource_name), class: "flex items-center gap-2 hover:bg-gray-50 p-2 rounded-lg" do
-              folder_icon
-              span { resource_name }
-            end
-          end
-        end
-      end
-
-      hr(class: "my-4")
-      p(class: "text-xs text-gray-500") do
-        plain("Powered by ")
-        a(
-            href: "https://github.com/primevise/oversee",
-            class: "text-blue-500 hover:underline",
-            target: "_blank"
-          ) { "Oversee" }
-      end
-    end
-  end
-
-  private
-
-  def folder_icon
-    svg(
-      xmlns: "http://www.w3.org/2000/svg",
-      width: "24",
-      height: "24",
-      viewbox: "0 0 24 24",
-      fill: "none",
-      stroke: "currentColor",
-      stroke_width: "2",
-      stroke_linecap: "round",
-      stroke_linejoin: "round",
-      class: "h-4 w-4 text-gray-400"
-    ) do |s|
-      s.path(stroke: "none", d: "M0 0h24v24H0z", fill: "none")
-      s.path(
-        d:
-          "M5 4h4l3 3h7a2 2 0 0 1 2 2v8a2 2 0 0 1 -2 2h-14a2 2 0 0 1 -2 -2v-11a2 2 0 0 1 2 -2"
-      )
-    end
-  end
-
-  def main_app_icon
-    svg(
-      xmlns: "http://www.w3.org/2000/svg",
-      width: "24",
-      height: "24",
-      viewbox: "0 0 24 24",
-      fill: "none",
-      stroke: "currentColor",
-      stroke_width: "2",
-      stroke_linecap: "round",
-      stroke_linejoin: "round",
-      class: "h-4 w-4 text-gray-400"
-    ) do |s|
-      s.path(stroke: "none", d: "M0 0h24v24H0z", fill: "none")
-      s.path(d: "M9 21v-6a2 2 0 0 1 2 -2h2c.247 0 .484 .045 .702 .127")
-      s.path(d: "M19 12h2l-9 -9l-9 9h2v7a2 2 0 0 0 2 2h5")
-      s.path(d: "M16 22l5 -5")
-      s.path(d: "M21 21.5v-4.5h-4.5")
-    end
-  end
-
-  def layout_icon
-    svg(
-      xmlns: "http://www.w3.org/2000/svg",
-      width: "24",
-      height: "24",
-      viewbox: "0 0 24 24",
-      fill: "none",
-      stroke: "currentColor",
-      stroke_width: "2",
-      stroke_linecap: "round",
-      stroke_linejoin: "round",
-      class: "h-4 w-4 text-gray-400"
-    ) do |s|
-      s.path(stroke: "none", d: "M0 0h24v24H0z", fill: "none")
-      s.path(
-        d:
-          "M4 4m0 2a2 2 0 0 1 2 -2h2a2 2 0 0 1 2 2v1a2 2 0 0 1 -2 2h-2a2 2 0 0 1 -2 -2z"
-      )
-      s.path(
-        d:
-          "M4 13m0 2a2 2 0 0 1 2 -2h2a2 2 0 0 1 2 2v3a2 2 0 0 1 -2 2h-2a2 2 0 0 1 -2 -2z"
-      )
-      s.path(
-        d:
-          "M14 4m0 2a2 2 0 0 1 2 -2h2a2 2 0 0 1 2 2v12a2 2 0 0 1 -2 2h-2a2 2 0 0 1 -2 -2z"
-      )
-    end
-  end
-end

data/app/components/oversee/field_component.rb

@@ -1,39 +0,0 @@
-module Oversee
-  class FieldComponent < Phlex::HTML
-    # A map for components to use when rendering a value
-    VALUE_MAP = {
-      string: Oversee::Fields::Value::StringComponent,
-      boolean: Oversee::Fields::Value::BooleanComponent,
-      integer: Oversee::Fields::Value::IntegerComponent,
-      datetime: Oversee::Fields::Value::DatetimeComponent,
-      text: Oversee::Fields::Value::TextComponent,
-      enum: Oversee::Fields::Value::EnumComponent
-    }
-
-    # A map for components to use when rendering a form input field
-    INPUT_MAP ={
-      string: Oversee::Fields::Input::StringComponent,
-      boolean: Oversee::Fields::Input::StringComponent,
-      integer: Oversee::Fields::Input::IntegerComponent,
-      datetime: Oversee::Fields::Input::DatetimeComponent,
-      text: Oversee::Fields::Input::StringComponent,
-      enum: Oversee::Fields::Input::StringComponent,
-    }
-
-    MAP = {
-      value: VALUE_MAP,
-      input: INPUT_MAP,
-    }
-
-    def initialize(resource: nil, datatype: :string, kind: :value, key: nil, value: nil)
-      @kind = kind
-      @datatype = VALUE_MAP.key?(datatype) ? datatype : :text
-      @key = key
-      @value = value || nil
-    end
-
-    def view_template
-      render MAP[@kind][@datatype.to_sym].new(key: @key, value: @value)
-    end
-  end
-end