janela 0.1.0

data/lib/janela/dimension.rb

@@ -0,0 +1,30 @@
+module Janela
+  class Dimension
+    attr_reader :name, :model, :through
+
+    def initialize(name, model:, through: nil)
+      @name = name
+      @model = model
+      @through = through
+
+      raise Error, "#{model} has no association #{through.inspect}" if through && reflection.nil?
+    end
+
+    def attribute
+      klass.arel_table[name]
+    end
+
+    def ransack_name
+      through ? "#{through}_#{name}" : name.to_s
+    end
+
+    private
+      def klass
+        through ? reflection.klass : model
+      end
+
+      def reflection
+        model.reflect_on_association(through)
+      end
+  end
+end

data/lib/janela/engine.rb

@@ -0,0 +1,21 @@
+require "rails/engine"
+
+module Janela
+  class Engine < ::Rails::Engine
+    isolate_namespace Janela
+
+    initializer "janela.model" do
+      ActiveSupport.on_load(:active_record) { extend Janela::Model }
+    end
+
+    # isolate_namespace keeps engine helpers out of the host, but the dashboard
+    # helpers are the engine's public API and belong in the host's views.
+    initializer "janela.helpers" do
+      ActiveSupport.on_load(:action_view) { include Janela::DashboardHelper }
+    end
+
+    initializer "janela.importmap", before: "importmap" do |app|
+      app.config.importmap.paths << root.join("config/importmap.rb") if app.config.respond_to?(:importmap)
+    end
+  end
+end

data/lib/janela/measure.rb

@@ -0,0 +1,26 @@
+module Janela
+  class Measure
+    AGGREGATES = %i[sum count average minimum maximum].freeze
+
+    attr_reader :name, :aggregate, :column
+
+    def self.build(name, **options)
+      aggregate, column = options.first
+      unless options.size == 1 && AGGREGATES.include?(aggregate)
+        raise Error, "measure #{name.inspect} needs exactly one of #{AGGREGATES.join(', ')}"
+      end
+
+      new(name, aggregate, column == true ? nil : column)
+    end
+
+    def initialize(name, aggregate, column)
+      @name = name
+      @aggregate = aggregate
+      @column = column
+    end
+
+    def apply(relation)
+      column ? relation.public_send(aggregate, column) : relation.public_send(aggregate)
+    end
+  end
+end

data/lib/janela/model.rb

@@ -0,0 +1,25 @@
+module Janela
+  module Model
+    def janela(&block)
+      return @janela_definition unless block
+
+      @janela_definition = Definition.new(self)
+      @janela_definition.instance_eval(&block)
+      define_janela_ransack_allowlist
+      Janela.register(self)
+      @janela_definition
+    end
+
+    private
+      # Dimensions are the only things Janela filters on, so they are the
+      # Ransack allowlist. A model that already declares its own allowlist
+      # keeps it.
+      def define_janela_ransack_allowlist
+        return if singleton_class.method_defined?(:ransackable_attributes, false)
+
+        definition = @janela_definition
+        define_singleton_method(:ransackable_attributes) { |_auth_object = nil| definition.ransackable_attributes }
+        define_singleton_method(:ransackable_associations) { |_auth_object = nil| definition.ransackable_associations }
+      end
+  end
+end

data/lib/janela/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module Janela
+  VERSION = "0.1.0"
+end

data/lib/janela.rb

@@ -0,0 +1,39 @@
+require "ransack"
+require "turbo-rails"
+require "stimulus-rails"
+
+require "janela/version"
+require "janela/engine"
+require "janela/model"
+require "janela/definition"
+require "janela/measure"
+require "janela/dimension"
+
+module Janela
+  class Error < StandardError; end
+
+  # Janela's controllers inherit from the host's, so the host's authentication
+  # and authorisation apply to dashboards with no configuration.
+  mattr_accessor :parent_controller, default: "ApplicationController"
+
+  # Only models that declare a janela block are addressable over HTTP, so a
+  # request parameter can never name an arbitrary class. Names are stored
+  # rather than definitions so a reloaded model does not leave a stale class
+  # behind in development.
+  def self.registry
+    @registry ||= Set.new
+  end
+
+  def self.register(model)
+    registry << model.name
+  end
+
+  def self.definition!(name)
+    # In development a model is only registered once autoloaded, so a cold
+    # lookup loads the app rather than constantizing an unvetted parameter.
+    Rails.application.eager_load! unless registry.include?(name)
+    raise Error, "#{name.inspect} is not a janela model" unless registry.include?(name)
+
+    name.constantize.janela
+  end
+end

metadata

@@ -0,0 +1,133 @@
+--- !ruby/object:Gem::Specification
+name: janela
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Jay Killeen
+- Vanessa Soares
+bindir: bin
+cert_chain: []
+date: 1980-01-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '8.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '8.0'
+- !ruby/object:Gem::Dependency
+  name: ransack
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.0'
+- !ruby/object:Gem::Dependency
+  name: turbo-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: stimulus-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.3'
+description: Janela lets you define dashboards directly on your ActiveRecord models
+  and associations. Slicers, cross-filtering charts, and dimension drill-down as first-class
+  Rails citizens, not a bolted-on admin panel. Built on Ruby and Stimulus so it drops
+  onto any Rails application with no separate frontend build step. Dashboards can
+  run live and interactive for internal analysts, or be published as locked, static
+  views for external audiences, from the same underlying definition.
+email:
+- jay@retailtasker.com.au
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- LICENSE.txt
+- README.md
+- Rakefile
+- app/assets/javascripts/janela/chart_controller.js
+- app/assets/javascripts/janela/dashboard_controller.js
+- app/assets/javascripts/janela/vendor/chart.js
+- app/controllers/janela/application_controller.rb
+- app/controllers/janela/visuals_controller.rb
+- app/helpers/janela/dashboard_helper.rb
+- app/models/janela/visual.rb
+- app/views/janela/visuals/show.html.erb
+- config/importmap.rb
+- config/routes.rb
+- docs/decisions/001-built-to-be-forked.md
+- docs/decisions/002-measures-and-dimensions-over-ransack.md
+- docs/decisions/003-cross-filtering-with-turbo-frames.md
+- docs/decisions/004-charts-and-javascript-delivery.md
+- docs/decisions/INDEX.md
+- lib/janela.rb
+- lib/janela/definition.rb
+- lib/janela/dimension.rb
+- lib/janela/engine.rb
+- lib/janela/measure.rb
+- lib/janela/model.rb
+- lib/janela/version.rb
+homepage: https://github.com/retail-tasker/janela
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+  source_code_uri: https://github.com/retail-tasker/janela
+  changelog_uri: https://github.com/retail-tasker/janela/blob/main/CHANGELOG.md
+  bug_tracker_uri: https://github.com/retail-tasker/janela/issues
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.3.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.6.9
+specification_version: 4
+summary: PowerBI-style dashboards and cross-filtering slicers, native to Rails and
+  ActiveRecord.
+test_files: []