activeadmin_calendar 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 12858a761cb81a1bed452aedd1786fce50144c17426bf7255f109eafd0e19939
+  data.tar.gz: ed69d6fff3f544f19d53f25948fc620a3c3a0ee68988e69f0d7148d301596892
+SHA512:
+  metadata.gz: 87b4773b56d4d7e1bb2a90181ca845353749d7c94e4530a765c9186db7d45524af1930b8bba71e7da3a2435564f0686d4a77f4809588c94adeaf206ea4f482a8
+  data.tar.gz: 9654babc7504f7b4db6355e255f3eb5fb718cdb6e1580e7695da656595de32fb937cfc2d86e948ab6f911b2d56ede42aa0bd9a513b49b1e04429c83d55e6e079

data/LICENSE.txt

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Igor Fedoronchuk
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/README.md

@@ -0,0 +1,117 @@
+# activeadmin_calendar
+
+![CI](https://github.com/activeadmin-plugins/activeadmin_calendar/workflows/CI/badge.svg)
+![Coverage](https://img.shields.io/endpoint?url=https://activeadmin-plugins.github.io/activeadmin_calendar/badge.json)
+![Ruby](https://img.shields.io/badge/ruby-3.3%2B-blue)
+
+Adds `index as: :calendar` to ActiveAdmin — renders the resource list as a
+month grid with one cell per day. The index block is yielded
+`(date, records_for_that_day)`.
+
+Works with **ActiveAdmin 3.5+ and 4.x**.
+
+### ActiveAdmin 4
+
+![Payments calendar on AA 4](https://github.com/activeadmin-plugins/activeadmin_calendar/releases/download/assets-v1/payments_calendar_4_0.png)
+
+### ActiveAdmin 3
+
+![Payments calendar on AA 3.5](https://github.com/activeadmin-plugins/activeadmin_calendar/releases/download/assets-v1/payments_calendar_3_5.png)
+
+## Install
+
+```ruby
+# Gemfile
+gem "activeadmin_calendar"
+```
+
+For Sprockets (AA 3):
+
+```scss
+/* app/assets/stylesheets/active_admin.scss */
+@import "activeadmin_calendar";
+```
+
+Propshaft / Tailwind (AA 4) picks the bundled CSS up automatically.
+
+## Usage
+
+### Single-date events — `group_by:`
+
+One SQL query per visible month, rows bucketed in Ruby.
+
+```ruby
+ActiveAdmin.register Payment do
+  config.paginate = false
+  filter :card_type, as: :select, collection: Payment::CARD_TYPES
+
+  index as: :calendar, group_by: :paid_at do |date, payments|
+    by_card = payments.group_by(&:card_type)
+                      .transform_values { |ps| ps.sum(&:amount) }
+    ul do
+      by_card.each { |c, sum| li "#{c.upcase}: #{number_to_currency(sum)}" }
+      total = by_card.values.sum
+      li { strong "Total: #{number_to_currency(total)}" } unless total.zero?
+    end
+  end
+end
+```
+
+### Range / fan-out events — `group_by_scope:`
+
+One row appears in **every** day in its active range. Use a custom scope:
+
+#### ActiveAdmin 4
+
+![Bookings calendar — fan-out on AA 4](https://github.com/activeadmin-plugins/activeadmin_calendar/releases/download/assets-v1/bookings_calendar_4_0.png)
+
+#### ActiveAdmin 3
+
+![Bookings calendar — fan-out on AA 3.5](https://github.com/activeadmin-plugins/activeadmin_calendar/releases/download/assets-v1/bookings_calendar_3_5.png)
+
+```ruby
+class Booking < ApplicationRecord
+  scope :active_on, ->(date) { where("check_in <= ? AND check_out > ?", date, date) }
+end
+
+ActiveAdmin.register Booking do
+  filter :room_number
+  filter :guest_name_cont, label: "Guest name contains"
+
+  index as: :calendar, group_by_scope: :active_on do |date, bookings|
+    ul do
+      bookings.sort_by(&:room_number).each do |b|
+        first, last = b.check_in == date, b.check_out - 1.day == date
+        marker = first && last ? "•" : first ? "→" : last ? "←" : "·"
+        li { text_node "#{marker} ##{b.room_number} #{b.guest_name}" }
+      end
+    end
+  end
+end
+```
+
+May 18 → 21 booking shows on 18 (`→`), 19 (`·`), 20 (`←`).
+
+## Options
+
+| Option | Effect |
+|---|---|
+| `group_by:` (Symbol) | Bucket by a date/datetime column. **1 SQL** per month (prefetched). |
+| `group_by_scope:` (Symbol) | Call `Model.scope(date)` per cell — for ranges, joins, or any bucket logic that simple `where(col = date)` can't express. **N SQL** per month (one per visible day). |
+
+URL params `?year=2026&month=5` drive the visible month. Today / Previous /
+Next links are rendered automatically and preserve current filter params.
+
+Ransack filters apply transparently — the gem buckets the already-scoped
+collection. `?q[card_type_eq]=visa` narrows what's shown in each cell.
+
+## Compatibility
+
+| AA | Status |
+|---|---|
+| 4.0.0.beta22 | ✅ |
+| 3.5 | ✅ |
+
+## License
+
+MIT

data/app/assets/stylesheets/activeadmin_calendar.css

@@ -0,0 +1,104 @@
+/*
+ * AA 4 wraps every index_as_* component in `.paginated-collection` /
+ * `.paginated-collection-contents`, which Tailwind plugin styles as a panel
+ * with border + background. The calendar has its own visual structure and
+ * doesn't need that wrapper — reset it.
+ */
+.paginated-collection:has(#index_calendar),
+.paginated-collection:has(#index_calendar) .paginated-collection-contents {
+  background: transparent;
+  border: 0;
+  box-shadow: none;
+  padding: 0;
+}
+
+div#index_calendar_header {
+  display: flex;
+  align-items: baseline;
+  gap: 1.5em;
+  margin-bottom: 0.5em;
+}
+
+div#index_calendar_header h2 {
+  margin: 0;
+}
+
+ul#index_calendar_nav {
+  list-style-type: none;
+  padding: 0;
+  margin: 0;
+  display: flex;
+  gap: 0.75em;
+}
+
+ul#index_calendar_nav li {
+  margin: 0;
+}
+
+ul#index_calendar_nav li a {
+  display: block;
+  padding: 2px 8px;
+  border: 1px solid #ddd;
+  text-decoration: none;
+  color: #222;
+  background-color: #eee;
+}
+
+ul#index_calendar_nav li a:hover {
+  border-color: #333;
+}
+
+table#index_calendar {
+  border-collapse: collapse;
+}
+
+table#index_calendar th,
+table#index_calendar td {
+  line-height: 1.5em;
+  width: 14.286%;
+}
+
+table#index_calendar thead th {
+  color: #555;
+  background-color: transparent;
+  font-weight: normal;
+  text-align: left;
+}
+
+table#index_calendar tbody td {
+  height: 120px;
+  vertical-align: top;
+  border: 1px solid #ddd;
+  font-size: 90%;
+  padding: 6px 8px;
+}
+
+table#index_calendar thead th {
+  padding: 4px 8px;
+}
+
+table#index_calendar tbody td.current_month {
+  color: #333;
+  background-color: transparent;
+}
+
+table#index_calendar tbody td.not_current_month {
+  color: #aaa;
+  background-color: transparent;
+}
+
+table#index_calendar tbody td.today {
+  color: #222;
+  background-color: #eee;
+}
+
+table#index_calendar tbody td.today .day {
+  font-weight: bold;
+}
+
+table#index_calendar ul,
+table#index_calendar ol {
+  list-style-type: none;
+  padding: 0;
+  margin: 0;
+}

data/lib/activeadmin_calendar/engine.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+require "rails/engine"
+
+module ActiveadminCalendar
+  class Engine < ::Rails::Engine
+    config.to_prepare do
+      require "activeadmin_calendar/index_as_calendar"
+    end
+  end
+end

data/lib/activeadmin_calendar/index_as_calendar.rb

@@ -0,0 +1,150 @@
+# frozen_string_literal: true
+
+module ActiveAdmin
+  module Views
+    # = Index as a Calendar
+    #
+    # Render the index page as a month calendar grid. Resources are bucketed
+    # into day cells by a configurable attribute (default: `updated_at`) or via
+    # a custom scope.
+    #
+    #     index as: :calendar, group_by: :paid_at do |date, payments|
+    #       ul { payments.each { |p| li p.amount } }
+    #     end
+    #
+    # For pre-bucketed scopes (when the group-by column is not on the table or
+    # needs custom SQL) pass `:group_by_scope`:
+    #
+    #     scope :on_date, ->(date) { where(paid_at: date.all_day) }
+    #     index as: :calendar, group_by_scope: :on_date do |date, items|
+    #       # ...
+    #     end
+    class IndexAsCalendar < ActiveAdmin::Component
+      def self.index_name
+        "calendar"
+      end
+
+      def build(page_presenter, collection)
+        @page_presenter = page_presenter
+        @collection = collection
+        prefetch_month_records!
+        build_calendar
+      end
+
+      def group_by
+        @page_presenter[:group_by] || :updated_at
+      end
+
+      def group_by_scope
+        @page_presenter[:group_by_scope]
+      end
+
+      private
+
+      def build_calendar
+        build_navigation
+        build_table
+      end
+
+      def build_navigation
+        prev_month = current_month.at_beginning_of_month - 1
+        next_month = current_month.at_end_of_month + 1
+
+        div id: "index_calendar_header" do
+          h2 current_month.strftime("%B %Y")
+
+          ul id: "index_calendar_nav" do
+            li link_to("Today", params.to_unsafe_h.except(:year, :month)), class: "today"
+            li link_to("Previous", params.to_unsafe_h.merge(year: prev_month.year, month: prev_month.month)), class: "prev"
+            li link_to("Next", params.to_unsafe_h.merge(year: next_month.year, month: next_month.month)), class: "next"
+          end
+        end
+      end
+
+      def build_table
+        table id: "index_calendar" do
+          build_table_headers
+          build_table_body
+        end
+      end
+
+      def build_table_headers
+        thead do
+          tr do
+            7.times do |i|
+              th I18n.t("date.abbr_day_names").rotate[i].to_s.capitalize
+            end
+          end
+        end
+      end
+
+      def build_table_body
+        tbody do
+          (grid_start_date..grid_end_date).to_a.in_groups_of(7).each { |week| build_week(week) }
+        end
+      end
+
+      def build_week(dates)
+        tr { dates.each { |d| build_day(d) } }
+      end
+
+      def build_day(date)
+        active = date.month == current_month.month && date.year == current_month.year
+        classes = [active ? "current_month" : "not_current_month"]
+        classes << "today" if date == Time.zone.now.to_date
+
+        td class: classes.join(" ") do
+          div class: "day" do
+            date.day == 1 ? date.strftime("%b #{date.day}") : date.day.to_s
+          end
+          scope = day_scope(date)
+          instance_exec(date, scope, &@page_presenter.block) if @page_presenter.block
+        end
+      end
+
+      # Pre-loads the entire visible month range in one SQL query and groups
+      # the rows in Ruby by date. Called once in #build. Skipped when the user
+      # opts into `group_by_scope:` — that mode keeps per-cell semantics since
+      # we can't infer how a custom scope buckets rows.
+      def prefetch_month_records!
+        return if group_by_scope
+        return unless @collection.respond_to?(:where)
+
+        col = group_by.to_s
+        records = @collection.where("#{col} >= ? AND #{col} < ?", grid_start_date, grid_end_date.tomorrow).to_a
+        @prefetched_by_date = records.group_by do |r|
+          val = r.public_send(group_by)
+          val.respond_to?(:to_date) ? val.to_date : val
+        end
+        @prefetched_by_date.default = [].freeze
+      end
+
+      def day_scope(date)
+        if group_by_scope
+          @collection.public_send(group_by_scope, date)
+        else
+          @prefetched_by_date[date]
+        end
+      end
+
+      def grid_start_date
+        current_month.at_beginning_of_month.beginning_of_week
+      end
+
+      def grid_end_date
+        current_month.at_end_of_month.end_of_week
+      end
+
+      def current_month
+        @current_month ||= begin
+          now = Time.zone.now
+          year  = params[:year].presence&.to_i  || now.year
+          month = params[:month].presence&.to_i || now.month
+          Date.new(year, month, 1)
+        rescue Date::Error, ArgumentError, TypeError
+          now.to_date.beginning_of_month
+        end
+      end
+    end
+  end
+end

data/lib/activeadmin_calendar/version.rb

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

data/lib/activeadmin_calendar.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require "activeadmin_calendar/version"
+
+module ActiveadminCalendar
+end
+
+require "activeadmin_calendar/engine" if defined?(Rails)

metadata

@@ -0,0 +1,105 @@
+--- !ruby/object:Gem::Specification
+name: activeadmin_calendar
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Igor Fedoronchuk
+bindir: bin
+cert_chain: []
+date: 1980-01-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activeadmin
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.5'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.5'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: arbre
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.4'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.4'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: railties
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '7.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '7.0'
+description: 'Adds `index as: :calendar` — a month-grid index style that buckets resources
+  by a date attribute or custom scope and yields each day cell.'
+email:
+- fedoronchuk@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE.txt
+- README.md
+- app/assets/stylesheets/activeadmin_calendar.css
+- lib/activeadmin_calendar.rb
+- lib/activeadmin_calendar/engine.rb
+- lib/activeadmin_calendar/index_as_calendar.rb
+- lib/activeadmin_calendar/version.rb
+homepage: https://github.com/activeadmin-plugins/activeadmin_calendar
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/activeadmin-plugins/activeadmin_calendar
+  source_code_uri: https://github.com/activeadmin-plugins/activeadmin_calendar
+  changelog_uri: https://github.com/activeadmin-plugins/activeadmin_calendar/releases
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '3.1'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.7.1
+specification_version: 4
+summary: Calendar index style for ActiveAdmin
+test_files: []