oversee 0.0.1 → 0.1.0

data/app/components/oversee/fields/value/string_component.rb

@@ -0,0 +1,23 @@
+module Oversee
+  module Fields
+    module Value
+      class StringComponent < Phlex::HTML
+        def initialize(key: nil, value: nil, kind: :value)
+          @key = key
+          @value = value
+          @kind = kind
+        end
+
+        def view_template
+          return p(class: "text-gray-500 text-xs"){ "—" } if @value.blank?
+
+          if @key&.downcase&.include?("password") ||  @key&.downcase&.include?("token")
+            p { "[REDACTED]" }
+          else
+            p(class: "truncate") { @value }
+          end
+        end
+      end
+    end
+  end
+end

data/app/components/oversee/fields/value/text_component.rb

@@ -0,0 +1,16 @@
+module Oversee
+  module Fields
+    module Value
+      class TextComponent < Phlex::HTML
+        def initialize(datatype: :string, key: nil, value: nil, kind: :value)
+          @value = value
+        end
+
+        def view_template
+          return p(class: "text-gray-500 text-xs"){ "—" } if @value.blank?
+          p(class: "truncate") { @value }
+        end
+      end
+    end
+  end
+end

data/app/controllers/oversee/application_controller.rb

@@ -0,0 +1,4 @@
+module Oversee
+  class ApplicationController < ActionController::Base
+  end
+end

data/app/controllers/oversee/base_controller.rb

@@ -0,0 +1,6 @@
+module Oversee
+  class BaseController < ActionController::Base
+    include Pagy::Backend
+    layout "oversee/application"
+  end
+end

data/app/controllers/oversee/dashboard_controller.rb

@@ -0,0 +1,21 @@
+module Oversee
+  class DashboardController < BaseController
+    def show
+      fetch_metrics
+
+      root = Rails.root.join("app/oversee/cards/")
+      files = Dir.glob(root.join("**/*.rb"))
+      @class_strings = files.sort!.map! { |f| f.split(root.to_s).last.delete_suffix(".rb").classify }
+    end
+
+    private
+
+    def fetch_metrics
+      # @metrics = [{
+      #   label: "Total Users",
+      #   value: User.count,
+      # }]
+      @metrics = []
+    end
+  end
+end

data/app/controllers/oversee/resources/fields_controller.rb

@@ -0,0 +1,45 @@
+module Oversee
+  module Resources
+    class FieldsController < BaseController
+      before_action :set_resource_class
+
+      def update
+        @resource_class = params[:resource_class].constantize
+        @resource = @resource_class.find(params[:id])
+        # @datatype = @resource_class.columns_hash[@key.to_s].type
+
+        respond_to do |format|
+          if @resource.update(resource_params)
+            format.html { redirect_to resource_path(@resource, resource: @resource_class) }
+            format.turbo_stream
+          else
+          end
+        end
+      end
+      
+      # Non-standard actions
+      def edit
+        @resource = @resource_class.find(params[:id])
+        @key = params[:key].to_sym
+        @value = @resource.send(@key)
+        @datatype = @resource.class.columns_hash[@key.to_s].type
+        puts "---"
+        puts "key: #{@key}"
+        puts "value: #{@value}"
+        puts "datatype: #{@datatype}"
+        puts "---"
+
+      end
+
+      private
+
+      def set_resource_class
+        @resource_class = params[:resource_class].constantize
+      end
+
+      def resource_params
+        params.require(:resource).permit!
+      end
+    end
+  end
+end

data/app/controllers/oversee/resources_controller.rb

@@ -0,0 +1,92 @@
+module Oversee
+  class ResourcesController < BaseController
+    include ActionView::RecordIdentifier
+
+    before_action :set_resource_class, except: [:update]
+    before_action :set_resource, only: %i[show edit destroy]
+
+    def index
+      set_sorting_rules
+
+      @resources = @resource_class.order(@sort_attribute.to_sym => sort_direction)
+      @pagy, @resources = pagy(@resources)
+    end
+
+    def show
+      resource_associations
+    end
+
+    def edit
+    end
+
+    def update
+      @resource_class = params[:resource_class].constantize
+      set_resource
+
+      @key = params[:resource][:oversee_key]
+      @datatype = params[:resource][:oversee_datatype]
+
+      respond_to do |format|
+        if @resource.update(resource_params)
+          format.html { redirect_to resource_path(@resource.id, resource: @resource_class) }
+          format.turbo_stream
+        else
+        end
+      end
+    end
+
+    def destroy
+      @resource.destroy
+      redirect_to resources_path(resource: @resource_class)
+    end
+
+    # Non-standard actions
+    def input_field
+      set_resource
+
+      @key = params[:key].to_sym
+      @value = @resource.send(@key)
+      @datatype = @resource.class.columns_hash[@key.to_s].type
+
+      puts "---"
+      puts "key: #{@key}"
+      puts "value: #{@value}"
+      puts "datatype: #{@datatype}"
+      puts "---"
+    end
+
+    private
+
+    def set_resource_class
+      @resource_class = params[:resource].constantize
+    end
+
+    def set_resource
+      @resource = @resource_class.find(params[:id])
+    end
+
+    def resource_associations
+      @resource_associations ||= @resource_class.reflect_on_all_associations
+    end
+
+    def sort_attribute
+      @sort_attribute ||= @resource_class.column_names.include?(params[:sort_attribute]) ? params[:sort_attribute] : "created_at"
+    end
+
+    def sort_direction
+      @sort_direction ||= ["asc", "desc"].include?(params[:sort_direction]) ? params[:sort_direction] : "desc"
+    end
+
+    def set_sorting_rules
+      @sort_attribute = params[:sort_attribute] || "created_at"
+      @sort_direction = params[:sort_direction] || "desc"
+    end
+
+    def resource_params
+      params[:resource].delete(:oversee_key)
+      params[:resource].delete(:oversee_datatype)
+
+      params.require(:resource).permit!
+    end
+  end
+end

data/app/helpers/oversee/application_helper.rb

@@ -0,0 +1,5 @@
+module Oversee
+  module ApplicationHelper
+    include Pagy::Frontend
+  end
+end

data/app/jobs/oversee/application_job.rb

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

data/app/mailers/oversee/application_mailer.rb

@@ -0,0 +1,6 @@
+module Oversee
+  class ApplicationMailer < ActionMailer::Base
+    default from: "from@example.com"
+    layout "mailer"
+  end
+end

data/app/models/oversee/application_record.rb

@@ -0,0 +1,5 @@
+module Oversee
+  class ApplicationRecord < ActiveRecord::Base
+    self.abstract_class = true
+  end
+end

data/app/oversee/cards.rb

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

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

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

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

@@ -0,0 +1,17 @@
+<script src="https://cdn.tailwindcss.com"></script>
+
+<script type="importmap" data-turbo-track="reload">
+  {
+    "imports": {
+      "@hotwired/stimulus": "https://unpkg.com/@hotwired/stimulus/dist/stimulus.js",
+      "@hotwired/turbo": "https://unpkg.com/@hotwired/turbo",
+      "@hotwired/turbo-rails": "https://unpkg.com/@hotwired/turbo-rails"
+    }
+  }
+</script>
+
+<script async src="https://unpkg.com/es-module-shims/dist/es-module-shims.js"></script>
+
+<script type="module">
+  import * as Turbo from "@hotwired/turbo-rails"
+</script>

data/app/views/oversee/dashboard/show.html.erb

@@ -0,0 +1,18 @@
+<div class="p-8">
+  <div class="flex items-center justify-between">
+    <div>
+      <p class="text-xs uppercase font-medium text-gray-400">Dashboard</p>
+      <h1 class="text-xl">Welcome</h1>
+    </div>
+  </div>
+</div>
+
+<% if Oversee.card_class_names.present? %>
+  <div class="p-8">
+    <div class="grid grid-cols-4 gap-4">
+      <% Oversee.card_class_names.each do |card_name| %>
+        <%= render Oversee::CardComponent.new(card_name: card_name) %>
+      <% end %>
+    </div>
+  </div>
+<% end %>

data/app/views/oversee/resources/_form.html.erb

@@ -0,0 +1,10 @@
+<%= form_with model: @resource, scope: :resource, url: resource_path do |form| %>
+  <% @resource_class.columns_hash.each do |key, metadata| %>
+    <div class="mb-4">
+      <%= form.label key, class: "uppercase text-xs" %>
+      <%= form.text_field key, class: "block border" %>
+    </div>
+  <% end %>
+  <%= hidden_field_tag :resource_class, @resource_class %>
+  <%= form.submit %>
+<% end %>

data/app/views/oversee/resources/_input_field.html.erb

@@ -0,0 +1,20 @@
+<div id="<%= dom_id(@resource, key) %>" class="py-4 px-8 hover:bg-gray-50 group flex items-center justify-between">
+  <div class="hidden space-y-2 animate-pulse">
+    <div class="h-4 w-10 bg-gray-100 rounded-md"></div>
+    <div class="h-8 w-32 bg-gray-100 rounded-md"></div>
+  </div>
+  <div>
+    <%= render Oversee::FieldLabelComponent.new(key: key, datatype: datatype) %>
+    <div class="mt-2">
+      <%= form_with url: resource_path(@resource.id, resource_class: @resource_class), scope: :resource, model: @resource do |f| %>
+        <%= f.hidden_field :oversee_key, value: key %>
+        <%= f.hidden_field :oversee_datatype, value: datatype %>
+
+        <% input_datatype = [:string, :integer, :datetime].include?(datatype) ? datatype : :string %>
+        <%= render Oversee::FieldComponent.new(kind: :input, datatype: input_datatype.to_sym, key: key, value: value)%>
+
+        <%= f.submit "Save", class: "bg-blue-500 px-4 py-2 rounded-md text-white text-sm hover:bg-blue-600 hover:cursor-pointer" %>
+      <% end %>
+    </div>
+  </div>
+</div>

data/app/views/oversee/resources/edit.html.erb

@@ -0,0 +1,31 @@
+<div class="p-8">
+  <div class="flex items-center justify-between">
+    <div>
+      <p class="text-xs uppercase font-medium text-gray-400">Resource</p>
+      <h1 class="text-xl"><%= params[:resource] %></h1>
+    </div>
+
+    <%= link_to 'Edit', edit_resource_path(@resource, resource: params[:resource]), class: "inline-flex items-center justify-center py-2 px-6 rounded bg-blue-500 text-white text-sm font-medium" %>
+  </div>
+</div>
+<div class="p-8">
+  <%= render "form" %>
+</div>
+<div class="p-8">
+  <div class="bg-white px-8 border shadow-sm rounded">
+    <div class="divide-y divide-gray-100 -mx-8">
+      <% @resource.attributes.each do |attribute, value| %>
+        <div class="py-4 px-8">
+          <p class="text-xs font-medium text-gray-500 uppercase"><%= attribute.humanize %></p>
+          <p class="mt-1 text-lg"><%= render Oversee::FieldComponent.new(datatype: :string, value: value) %></p>
+        </div>
+      <% end %>
+    </div>
+  </div>
+</div>
+
+<div class="p-8">
+  <pre>
+    <%= debug @resource.attributes %>
+  </pre>
+</div>

data/app/views/oversee/resources/index.html.erb

@@ -0,0 +1,59 @@
+<div class="p-8">
+  <div class="flex items-center justify-between">
+    <div>
+      <p class="text-xs font-medium text-gray-500">Index</p>
+      <h1 class="text-2xl"><%= params[:resource] %></h1>
+    </div>
+    <%= link_to 'Add new', "", class: "inline-flex items-center justify-center py-2 px-6 rounded bg-blue-500 text-white text-sm font-medium" %>
+  </div>
+</div>
+<div class="">
+  <div class="bg-white border-t overflow-x-hidden">
+    <div class="-mx-4 overflow-x-auto sm:-mx-6 lg:-mx-8">
+      <div class="inline-block min-w-full align-middle sm:px-6 lg:px-8">
+        <table class="min-w-full divide-y divide-gray-300">
+          <thead>
+            <tr class="divide-x divide-gray-200">
+              <th class="hidden"><input type="checkbox" name="" id="" class="mx-4"></th>
+              <th scope="col" class="px-4 py-3.5 text-left text-xs font-semibold text-gray-900 uppercase"></th>
+              <% @resource_class.columns_hash.each do |key, metadata| %>
+                <th scope="col" class="px-4 py-3.5 text-left text-xs font-semibold text-gray-900 uppercase whitespace-nowrap hover:bg-gray-50 transition">
+                  <a href="<%= resources_path(resource: params[:resource], sort_attribute: key, sort_direction: params[:sort_direction] == "asc" ? :desc : :asc) %>" class="hover:underline">
+                    <%= render Oversee::FieldLabelComponent.new(key: key, datatype: metadata.sql_type_metadata.type) %>
+                  </a>
+                </th>
+              <% end %>
+            </tr>
+          </thead>
+          <tbody class="divide-y divide-gray-100 bg-white">
+            <% @resources.each do |resource| %>
+              <tr class="divide-x divide-gray-100">
+                <td class="hidden">
+                  <input type="checkbox" name="" id="" class="mx-4">
+                </td>
+                <td>
+                  <div class="flex space-x-2 mx-4">
+                    <a href="<%= resource_path(resource.id, resource: params[:resource]) %>" data-turbo-stream="true">
+                      <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 16 16" fill="currentColor" data-slot="icon" class="w-4 h-4 text-gray-500 hover:text-blue-500">
+                        <path d="M8 9.5a1.5 1.5 0 1 0 0-3 1.5 1.5 0 0 0 0 3Z" />
+                        <path fill-rule="evenodd" d="M1.38 8.28a.87.87 0 0 1 0-.566 7.003 7.003 0 0 1 13.238.006.87.87 0 0 1 0 .566A7.003 7.003 0 0 1 1.379 8.28ZM11 8a3 3 0 1 1-6 0 3 3 0 0 1 6 0Z" clip-rule="evenodd" />
+                      </svg>
+                    </a>
+                  </div>
+                </td>
+                <% @resource_class.columns_hash.each do |key, metadata| %>
+                  <td class="whitespace-nowrap p-4 text-sm text-gray-500">
+                    <div class="max-w-96">
+                    <%= render Oversee::FieldComponent.new(datatype: metadata.sql_type_metadata.type, value: resource.send(key), key: key) %>
+                    </div>
+                  </td>
+                <% end %>
+              </tr>
+            <% end %>
+          </tbody>
+        </table>
+      </div>
+    </div>
+  </div>
+  <%= raw(pagy_nav(@pagy)) if @pagy.pages > 1 %>
+</div>

data/app/views/oversee/resources/input_field.html.erb

@@ -0,0 +1 @@
+<%= render partial: "oversee/resources/input_field" %>

data/app/views/oversee/resources/input_field.turbo_stream.erb

@@ -0,0 +1,3 @@
+<%= turbo_stream.replace dom_id(@resource, @key) do %>
+  <%= render partial: "oversee/resources/input_field", locals: { datatype: @datatype, key: @key, value: @value } %>
+<% end %>

data/app/views/oversee/resources/show.html.erb

@@ -0,0 +1,51 @@
+<div class="p-8">
+  <div class="flex items-center justify-between">
+    <div>
+      <p class="text-xs font-medium text-gray-500">Resource</p>
+      <h1 class="text-xl"><%= params[:resource] %></h1>
+      <div class="mt-2 inline-flex py-1 px-3 rounded-full text-xs bg-white border"># <%= @resource.to_param %></div>
+    </div>
+    <%= button_to resource_path(resource: params[:resource]), method: :delete, data: { turbo_confirm: "Are you sure?" }, class: "py-2 px-6 inline-flex border rounded text-red-500 shadow-sm hover:bg-gray-50 text-sm font-medium" do %>
+      Delete
+    <% end %>
+  </div>
+</div>
+
+<div class="pb-8">
+  <div class="px-8">
+    <h3 class="text-xl mb-8">Associations</h3>
+    <div class="border-y divide-y -mx-8">
+    <% @resource_associations.each do |association| %>
+      <% associated_resources = @resource.send(association.name.to_sym) %>
+      <% next if associated_resources.blank? %>
+      <% associated_resources = [associated_resources] unless associated_resources.respond_to?(:each) %>
+
+      <div class="px-8 py-6">
+        <div class="inline-flex items-center gap-2 mb-4">
+          <div class="inline-flex items-center justify-center h-6 w-6 bg-gray-50">
+            <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"><path stroke="none" d="M0 0h24v24H0z" fill="none"/><path d="M12 5m-2 0a2 2 0 1 0 4 0a2 2 0 1 0 -4 0" /><path d="M5 19m-2 0a2 2 0 1 0 4 0a2 2 0 1 0 -4 0" /><path d="M19 19m-2 0a2 2 0 1 0 4 0a2 2 0 1 0 -4 0" /><path d="M6.5 17.5l5.5 -4.5l5.5 4.5" /><path d="M12 7l0 6" /></svg>
+          </div>
+          <%= association.name.to_s.titleize %>
+        </div>
+
+        <div class="flex gap-2 flex-wrap">
+          <% associated_resources.each do |ar| %>
+            <a href="<%= resource_path(ar.id, resource: ar.class) %>" class="inline-flex text-xs border border-transparent rounded-full bg-gray-100 hover:bg-gray-200 px-3 py-1.5"><%= ar.class %> - <%= ar.to_param %></a>
+          <% end %>
+        </div>
+      </div>
+    <% end %>
+    </div>
+  </div>
+</div>
+
+<div class="pb-8">
+  <div class="px-8">
+    <h3 class="text-xl mb-8">Attributes</h3>
+    <div class="border-y divide-y -mx-8">
+      <% @resource_class.columns_hash.each do |key, metadata| %>
+        <%= render Oversee::Fields::DisplayRowComponent.new(key: key, resource: @resource, datatype: metadata.sql_type_metadata.type, value: @resource.send(key)) %>
+      <% end %>
+    </div>
+  </div>
+</div>

data/app/views/oversee/resources/update.turbo_stream.erb

@@ -0,0 +1,3 @@
+<%= turbo_stream.replace(dom_id(@resource, @key)) do %>
+  <%= render Oversee::Fields::DisplayRowComponent.new(key: @key, resource: @resource, datatype: @datatype, value: @resource.send(@key)) %>
+<% end %>

data/app/views/shared/_sidebar.html.erb

@@ -0,0 +1,32 @@
+<div class="bg-gray-50 h-full relative p-4">
+  <div class="overflow-y-scroll mb-4">
+    <ul class="mb-4">
+      <li class="flex">
+        <a href="<%= root_path %>" class="group flex items-center space-x-1.5 rounded-md hover:bg-gray-100 p-2">
+          <svg xmlns="http://www.w3.org/2000/svg" class="group-hover:text-gray-500 text-gray-400 w-4 h-4 transition-colors duration-75" width="24" height="24" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"/><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" /><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" /><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" /></svg>
+          <p class="text-sm text-gray-800 group-hover:text-gray-900">Dashboard</p>
+        </a>
+      </li>
+      <li class="flex">
+        <a href="<%= main_app.root_path %>" class="group flex items-center space-x-1.5 rounded-md hover:bg-gray-100 p-2">
+          <svg xmlns="http://www.w3.org/2000/svg" class="group-hover:text-gray-500 text-gray-400 w-4 h-4 transition-colors duration-75" width="24" height="24" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"/><path d="M14 8v-2a2 2 0 0 0 -2 -2h-7a2 2 0 0 0 -2 2v12a2 2 0 0 0 2 2h7a2 2 0 0 0 2 -2v-2" /><path d="M9 12h12l-3 -3" /><path d="M18 15l3 -3" /></svg>
+          <p class="text-sm text-gray-800 group-hover:text-gray-900">Return to app</p>
+        </a>
+      </li>
+    </ul>
+    <p class="font-medium mb-2 text-xs text-gray-500">Resources</p>
+    <ul>
+      <% ApplicationRecord.descendants.map(&:to_s).sort.each do |resource_name| %>
+        <li class="flex">
+          <a href="<%= resources_path(resource: resource_name) %>" class="group flex items-center space-x-1.5 rounded-md hover:bg-gray-100 p-2">
+            <svg xmlns="http://www.w3.org/2000/svg" class="group-hover:text-gray-500 text-gray-400 w-4 h-4 transition-colors duration-75" width="24" height="24" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"/><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" /></svg>
+            <p class="text-sm text-gray-800 group-hover:text-gray-900"><%= resource_name %></p>
+          </a>
+        </li>
+      <% end %>
+    </ul>
+  </div>
+  <div class="absolute bottom-0 w-full text-xs flex items-center justify-center py-3 bg-gray-50 -mx-4">
+    <p>Powered by <a href="https://github.com/primevise/oversee" class="text-blue-500 hover:underline" target="_blank">Oversee</a></p>
+  </div>
+</div>

data/config/routes.rb

@@ -0,0 +1,10 @@
+Oversee::Engine.routes.draw do
+
+  # Resources
+  resources :resources do
+    resources :fields, only: [:show, :edit, :update]
+    get :input_field, on: :member
+  end
+  
+  root to: "dashboard#show"
+end

data/lib/oversee/configuration.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+module Oversee
+  class Configuration
+    attr_accessor :excluded_resources
+    attr_accessor :filter_sensitive_columns
+    attr_accessor :sensitive_column_titles
+
+    def initialize
+      @excluded_resources = []
+      @filter_sensitive_columns = true
+      @sensitive_column_titles = %w[password password_digest access_token]
+    end
+  end
+
+  def self.configuration
+    @configuration ||= Configuration.new
+  end
+
+  def self.configuration=(config)
+    @configuration = config
+  end
+
+  def self.configure
+    yield configuration
+  end
+end

data/lib/oversee/engine.rb

@@ -0,0 +1,10 @@
+module Oversee
+  class Engine < ::Rails::Engine
+    isolate_namespace Oversee
+
+    config.to_prepare do
+      # Eager-loading to fetch all resources
+      Rails.application.eager_load!
+    end
+  end
+end

data/lib/oversee/version.rb

@@ -0,0 +1,3 @@
+module Oversee
+  VERSION = "0.1.0"
+end

data/lib/oversee.rb

@@ -1,5 +1,27 @@
-class Oversee
-  def self.lulwut
-    "LULWUT"
+require "zeitwerk"
+
+require "oversee/version"
+require "oversee/engine"
+require "oversee/configuration"
+
+require "phlex-rails"
+require "pagy"
+
+# Zeitwerk
+loader = Zeitwerk::Loader.for_gem
+loader.ignore("#{__dir__}/generators")
+loader.setup
+
+module Oversee
+  class << self
+    def allowed_resource_list
+      ApplicationRecord.descendants
+    end
+
+    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
-end
+end

data/lib/tasks/oversee_tasks.rake

@@ -0,0 +1,4 @@
+# desc "Explaining what the task does"
+# task :oversee do
+#   # Task goes here
+# end