janela 0.1.0 → 0.2.0

data/lib/janela/measure.rb

@@ -22,5 +22,11 @@ module Janela
     def apply(relation)
       column ? relation.public_send(aggregate, column) : relation.public_send(aggregate)
     end
+
+    # The column alias ActiveRecord gives a grouped calculation, so a
+    # relation can be ordered by the measure before it is calculated.
+    def sql_alias
+      "#{aggregate}_#{column || 'all'}"
+    end
   end
 end

data/lib/janela/version.rb

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

data/lib/janela.rb

@@ -1,4 +1,5 @@
 require "ransack"
+require "groupdate"
 require "turbo-rails"
 require "stimulus-rails"
 
@@ -16,24 +17,23 @@ module Janela
   # 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.
+  # Only models that declare a janela block are addressable over HTTP, keyed by
+  # the route key that appears in pane URLs (orders, sales_orders). Names are
+  # stored rather than classes so a reloaded model leaves nothing stale behind.
   def self.registry
-    @registry ||= Set.new
+    @registry ||= {}
   end
 
   def self.register(model)
-    registry << model.name
+    registry[model.model_name.route_key] = model.name
   end
 
-  def self.definition!(name)
+  def self.definition!(route_key)
     # 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)
+    Rails.application.eager_load! unless registry.key?(route_key)
+    class_name = registry.fetch(route_key) { raise Error, "#{route_key.inspect} is not a janela model" }
 
-    name.constantize.janela
+    class_name.constantize.janela
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: janela
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Jay Killeen
@@ -38,6 +38,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '4.0'
+- !ruby/object:Gem::Dependency
+  name: groupdate
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '6.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '6.0'
 - !ruby/object:Gem::Dependency
   name: turbo-rails
   requirement: !ruby/object:Gem::Requirement
@@ -81,21 +95,29 @@ 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/controllers/janela/panes_controller.rb
+- app/controllers/janela/snapshot_panes_controller.rb
 - app/helpers/janela/dashboard_helper.rb
-- app/models/janela/visual.rb
-- app/views/janela/visuals/show.html.erb
+- app/jobs/janela/snapshot_job.rb
+- app/models/janela/pane.rb
+- app/models/janela/snapshot.rb
+- app/views/janela/panes/show.html.erb
 - config/importmap.rb
 - config/routes.rb
+- db/migrate/20260915000001_create_janela_snapshots.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/005-pane-urls-and-mount-path.md
+- docs/decisions/006-time-dimensions-with-groupdate.md
+- docs/decisions/007-ordering-and-limits.md
+- docs/decisions/008-dashboard-filters-in-the-page-url.md
+- docs/decisions/009-snapshots.md
 - docs/decisions/INDEX.md
 - lib/janela.rb
 - lib/janela/definition.rb
@@ -112,6 +134,7 @@ metadata:
   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
+  rubygems_mfa_required: 'true'
 rdoc_options: []
 require_paths:
 - lib

data/Rakefile

@@ -1,23 +0,0 @@
-require "bundler/setup"
-
-APP_RAKEFILE = File.expand_path("test/dummy/Rakefile", __dir__)
-load "rails/tasks/engine.rake"
-
-require "bundler/gem_tasks"
-
-require "minitest/test_task"
-
-Minitest::TestTask.create do |t|
-  t.test_globs = Dir["test/**/*_test.rb"] - Dir["test/system/**/*_test.rb"]
-  t.warning = false
-end
-
-Minitest::TestTask.create(:system) do |t|
-  t.test_globs = [ "test/system/**/*_test.rb" ]
-  t.warning = false
-end
-
-require "rubocop/rake_task"
-RuboCop::RakeTask.new
-
-task default: %i[test rubocop]

data/app/models/janela/visual.rb

@@ -1,65 +0,0 @@
-module Janela
-  # One measure grouped by one dimension, rendered as a table or a chart. A
-  # visual ignores filters on its own dimension: clicking a value in a visual
-  # should re-scope the others, not collapse itself to the value clicked.
-  class Visual
-    RENDERERS = %w[table bar].freeze
-
-    attr_reader :definition, :measure, :dimension, :renderer, :filters
-
-    # The helper renders the frame and the controller renders its replacement,
-    # so both derive the id the same way from the same parameters.
-    def self.frame_id(model:, measure:, by:, as: :table)
-      "janela_#{model.to_s.underscore}_#{measure}_by_#{by}_#{as}"
-    end
-
-    def initialize(definition:, measure:, dimension:, renderer: "table", filters: {})
-      @definition = definition
-      @measure = measure
-      @dimension = dimension
-      @renderer = renderer.to_s
-      @filters = filters
-
-      raise Error, "unknown visual renderer #{renderer.inspect}" unless RENDERERS.include?(@renderer)
-    end
-
-    def model
-      definition.model
-    end
-
-    def chart?
-      renderer != "table"
-    end
-
-    def frame_id
-      self.class.frame_id(model: model.name, measure: measure, by: dimension, as: renderer)
-    end
-
-    def title
-      "#{measure.to_s.humanize} by #{dimension.to_s.humanize}"
-    end
-
-    def result(on: nil)
-      definition.query(measure, by: dimension, where: applicable_filters, on: on)
-    end
-
-    def filter_key
-      "#{ransack_name}_eq"
-    end
-
-    # The filter on this visual's own dimension is not applied to its query,
-    # but it is what the user clicked here, so the view highlights it.
-    def selected_value
-      filters[filter_key] || filters[filter_key.to_sym]
-    end
-
-    private
-      def ransack_name
-        definition.dimension!(dimension).ransack_name
-      end
-
-      def applicable_filters
-        filters.reject { |key, _| key.to_s.start_with?(ransack_name) }
-      end
-  end
-end

data/app/views/janela/visuals/show.html.erb

@@ -1,36 +0,0 @@
-<%= turbo_frame_tag @visual.frame_id do %>
-  <% if @result.empty? %>
-    <p class="janela-visual janela-empty"><%= @visual.title %>: no data</p>
-  <% elsif @visual.chart? %>
-    <canvas class="janela-visual janela-chart"
-            data-controller="janela--chart"
-            data-action="janela--chart:toggle->janela--dashboard#toggle"
-            data-janela--chart-type-value="<%= @visual.renderer %>"
-            data-janela--chart-title-value="<%= @visual.title %>"
-            data-janela--chart-key-value="<%= @visual.filter_key %>"
-            data-janela--chart-selected-value="<%= @visual.selected_value %>"
-            data-janela--chart-labels-value="<%= @result.keys.to_json %>"
-            data-janela--chart-values-value="<%= @result.values.map(&:to_f).to_json %>"
-            role="img" aria-label="<%= @visual.title %>"></canvas>
-  <% else %>
-    <table class="janela-visual">
-      <caption><%= @visual.title %></caption>
-      <tbody>
-        <% @result.each do |value, measured| %>
-          <tr>
-            <td>
-              <button type="button"
-                      aria-pressed="<%= value.to_s == @visual.selected_value.to_s && @visual.selected_value.present? %>"
-                      data-action="janela--dashboard#toggle"
-                      data-janela--dashboard-key-param="<%= @visual.filter_key %>"
-                      data-janela--dashboard-value-param="<%= value %>">
-                <%= value %>
-              </button>
-            </td>
-            <td><%= number_with_delimiter(measured) %></td>
-          </tr>
-        <% end %>
-      </tbody>
-    </table>
-  <% end %>
-<% end %>