airview 0.1.0

data/lib/airview.rb

@@ -0,0 +1,93 @@
+# frozen_string_literal: true
+
+require_relative "airview/version"
+require "active_support/core_ext/object/blank"
+require "active_support/core_ext/object/inclusion"
+require "active_support/core_ext/hash/keys"
+require "active_support/core_ext/string/inflections"
+require "bigdecimal"
+require "json"
+require_relative "airview/configuration"
+require_relative "airview/field"
+require_relative "airview/resource"
+require_relative "airview/query"
+require_relative "airview/model_discovery"
+require_relative "airview/resource_builder"
+require_relative "airview/schema_inference"
+require_relative "airview/engine" if defined?(Rails)
+
+module Airview
+  class Error < StandardError; end
+
+  class ConfigurationError < Error; end
+  class UnknownResourceError < Error; end
+  RECORD_LABEL_METHODS = %i[
+    name
+    title
+    email
+    username
+    display_name
+    company_name
+    label
+  ].freeze
+
+  class << self
+    def configuration
+      @configuration ||= Configuration.new
+    end
+
+    def configure
+      yield(configuration)
+    end
+
+    def resources
+      if defined?(Airview::ResourceDefinition) && database_resources_available?
+        ResourceBuilder.enabled_resources
+      else
+        {}
+      end
+    end
+
+    def resource!(key)
+      resources.fetch(key.to_sym) do
+        raise UnknownResourceError, "Airview resource #{key.inspect} is not registered"
+      end
+    end
+
+    def record_label(record, preferred_method = nil)
+      return "" unless record
+
+      label = label_from_method(record, preferred_method)
+      label ||= label_from_method(record, :full_name)
+      label ||= label_from_full_name_parts(record)
+      label ||= RECORD_LABEL_METHODS.lazy.filter_map { |method_name| label_from_method(record, method_name) }.first
+      label.presence || "#{record.class.model_name.human} ##{record.id}"
+    end
+
+    private
+
+    def label_from_method(record, method_name)
+      return nil if method_name.blank? || method_name.to_sym == :to_s
+      return nil unless record.respond_to?(method_name)
+
+      value = record.public_send(method_name).to_s.strip
+      return nil if value.blank? || value.start_with?("#<")
+
+      value
+    end
+
+    def label_from_full_name_parts(record)
+      return nil unless record.respond_to?(:first_name) && record.respond_to?(:last_name)
+
+      [record.public_send(:first_name), record.public_send(:last_name)].compact.join(" ").strip.presence
+    end
+
+    def database_resources_available?
+      return false unless ActiveRecord::Base.connected?
+
+      ActiveRecord::Base.connection.data_source_exists?("airview_resources")
+    rescue ActiveRecord::NoDatabaseError, ActiveRecord::StatementInvalid
+      false
+    end
+  end
+end

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

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+require "rails/generators"
+require "rails/generators/active_record/migration"
+
+module Airview
+  module Generators
+    class InstallGenerator < Rails::Generators::Base
+      include Rails::Generators::Migration
+
+      source_root File.expand_path("templates", __dir__)
+
+      def copy_initializer
+        template "airview.rb", "config/initializers/airview.rb"
+      end
+
+      def copy_migration
+        if migration_exists?("create_airview_views")
+          unless migration_exists?("add_folders_to_airview_views")
+            migration_template "add_folders_to_airview_views.rb", "db/migrate/add_folders_to_airview_views.rb"
+          end
+        else
+          migration_template "create_airview_views.rb", "db/migrate/create_airview_views.rb"
+        end
+      end
+
+      def self.next_migration_number(_dirname)
+        Time.now.utc.strftime("%Y%m%d%H%M%S")
+      end
+
+      private
+
+      def migration_exists?(name)
+        Dir.glob(File.join(destination_root, "db/migrate/*_#{name}.rb")).any?
+      end
+    end
+  end
+end

data/lib/generators/airview/install/templates/add_folders_to_airview_views.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+class AddFoldersToAirviewViews < ActiveRecord::Migration[7.1]
+  def change
+    add_column :airview_views, :folder, :string unless column_exists?(:airview_views, :folder)
+    add_index :airview_views, %i[resource_key folder] unless index_exists?(:airview_views, %i[resource_key folder])
+  end
+end

data/lib/generators/airview/install/templates/airview.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+# Airview is intended for trusted internal admin surfaces.
+# Protect the mount point in config/routes.rb with your app's authentication.
+#
+# authenticate :user, ->(user) { user.admin? } do
+#   mount Airview::Engine => "/airview"
+# end
+
+Airview.configure do |config|
+  # Resource configuration is managed through the Airview UI at /airview/setup.
+end

data/lib/generators/airview/install/templates/create_airview_views.rb

@@ -0,0 +1,57 @@
+# frozen_string_literal: true
+
+class CreateAirviewViews < ActiveRecord::Migration[7.1]
+  def change
+    create_table :airview_resources do |t|
+      t.string :key, null: false
+      t.string :record_class_name, null: false
+      t.string :label, null: false
+      t.string :label_method
+      t.boolean :enabled, null: false, default: false
+      t.integer :position, null: false, default: 0
+      t.json :metadata, null: false, default: {}
+
+      t.timestamps
+    end
+
+    add_index :airview_resources, :key, unique: true
+    add_index :airview_resources, :record_class_name, unique: true
+    add_index :airview_resources, :enabled
+
+    create_table :airview_fields do |t|
+      t.references :airview_resource, null: false, foreign_key: { to_table: :airview_resources }
+      t.string :name, null: false
+      t.string :label, null: false
+      t.string :field_type, null: false
+      t.boolean :visible, null: false, default: true
+      t.boolean :read_only, null: false, default: false
+      t.integer :position, null: false, default: 0
+      t.string :association_name
+      t.string :target_model_name
+      t.string :target_label_method
+      t.json :metadata, null: false, default: {}
+
+      t.timestamps
+    end
+
+    add_index :airview_fields, %i[airview_resource_id name], unique: true
+    add_index :airview_fields, :visible
+
+    create_table :airview_views do |t|
+      t.string :name, null: false
+      t.string :resource_key, null: false
+      t.string :owner_key
+      t.string :folder
+      t.json :columns, null: false, default: []
+      t.json :filters, null: false, default: {}
+      t.json :sorts, null: false, default: {}
+      t.json :preferences, null: false, default: {}
+
+      t.timestamps
+    end
+
+    add_index :airview_views, :resource_key
+    add_index :airview_views, %i[resource_key folder]
+    add_index :airview_views, %i[resource_key name]
+  end
+end

data/sig/airview.rbs

@@ -0,0 +1,54 @@
+module Airview
+  VERSION: String
+
+  def self.configuration: () -> Configuration
+  def self.configure: () { (Configuration) -> void } -> void
+  def self.resources: () -> Hash[Symbol, Resource]
+  def self.resource!: (Symbol | String key) -> Resource
+
+  class Error < StandardError
+  end
+
+  class ConfigurationError < Error
+  end
+
+  class UnknownResourceError < Error
+  end
+
+  class Configuration
+  end
+
+  class Field
+    attr_reader name: Symbol
+    attr_reader label: String
+    attr_reader type: Symbol
+    attr_reader options: untyped
+    attr_reader model: untyped
+    attr_reader label_method: Symbol
+
+    def initialize: (Symbol | String name, type: Symbol | String, ?label: String?, ?readonly: bool, ?options: untyped, ?model: untyped, ?label_method: Symbol?) -> void
+    def readonly?: () -> bool
+    def editable?: () -> bool
+    def association?: () -> bool
+    def attribute_name: () -> Symbol
+    def validate!: () -> void
+    def model_class: () -> untyped
+    def option_values: () -> Array[untyped]
+  end
+
+  class Resource
+    attr_accessor label: String
+    attr_accessor label_method: Symbol
+    attr_reader key: Symbol
+    attr_reader model: String
+    attr_reader fields: Hash[Symbol, Field]
+
+    def initialize: (Symbol | String key, model: String) -> void
+    def field: (Symbol | String name, type: Symbol | String, ?label: String?, **untyped options) -> Field
+    def model_class: () -> untyped
+    def field!: (Symbol | String name) -> Field
+    def editable_fields: () -> Array[Field]
+    def validate!: () -> void
+    def record_label: (untyped record) -> String
+  end
+end

metadata

@@ -0,0 +1,110 @@
+--- !ruby/object:Gem::Specification
+name: airview
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- jacksonriso
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2026-08-06 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '7.1'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '9.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '7.1'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '9.0'
+description: Airview mounts an internal admin UI for browsing and editing explicitly
+  registered ActiveRecord models.
+email:
+- risojackson@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- CODE_OF_CONDUCT.md
+- LICENSE.txt
+- README.md
+- app/assets/javascripts/airview/application.js
+- app/assets/stylesheets/airview/application.css
+- app/controllers/airview/application_controller.rb
+- app/controllers/airview/resources_controller.rb
+- app/controllers/airview/setup_controller.rb
+- app/controllers/airview/views_controller.rb
+- app/helpers/airview/application_helper.rb
+- app/javascript/airview/controllers/grid_controller.js
+- app/models/airview/application_record.rb
+- app/models/airview/field_definition.rb
+- app/models/airview/resource_definition.rb
+- app/models/airview/view.rb
+- app/views/airview/resources/_delete_modal.html.erb
+- app/views/airview/resources/_record_modal.html.erb
+- app/views/airview/resources/empty.html.erb
+- app/views/airview/resources/show.html.erb
+- app/views/airview/setup/_form.html.erb
+- app/views/airview/setup/edit.html.erb
+- app/views/airview/setup/index.html.erb
+- app/views/airview/setup/new.html.erb
+- app/views/airview/shared/_sidebar.html.erb
+- app/views/layouts/airview/application.html.erb
+- config/routes.rb
+- db/migrate/20260806000000_create_airview_views.rb
+- lib/airview.rb
+- lib/airview/configuration.rb
+- lib/airview/engine.rb
+- lib/airview/field.rb
+- lib/airview/model_discovery.rb
+- lib/airview/query.rb
+- lib/airview/resource.rb
+- lib/airview/resource_builder.rb
+- lib/airview/schema_inference.rb
+- lib/airview/version.rb
+- lib/generators/airview/install/install_generator.rb
+- lib/generators/airview/install/templates/add_folders_to_airview_views.rb
+- lib/generators/airview/install/templates/airview.rb
+- lib/generators/airview/install/templates/create_airview_views.rb
+- sig/airview.rbs
+homepage: https://github.com/jacksonriso/airview
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/jacksonriso/airview
+  source_code_uri: https://github.com/jacksonriso/airview
+  changelog_uri: https://github.com/jacksonriso/airview/blob/main/CHANGELOG.md
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.2.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.5.22
+signing_key:
+specification_version: 4
+summary: A Rails engine for Airtable-like database views inside Rails apps.
+test_files: []