quarterdeck 0.1.0

data/app/views/quarterdeck/visits/show.html.erb

@@ -0,0 +1,72 @@
+<div class="space-y-6">
+  <div class="flex items-center gap-3">
+    <%= link_to quarterdeck.visits_path, class: "text-indigo-600 hover:text-indigo-800 text-sm" do %>
+      &larr; Back to Visits
+    <% end %>
+  </div>
+
+  <!-- Visit Details -->
+  <div class="bg-white rounded-xl shadow-sm border border-gray-200 p-6">
+    <h3 class="text-lg font-semibold text-gray-900 mb-4">Visit Details</h3>
+    <dl class="grid grid-cols-1 sm:grid-cols-2 lg:grid-cols-3 gap-4">
+      <% details = {
+        "Started" => @visit.started_at&.strftime("%b %d, %Y %H:%M:%S"),
+        "Landing Page" => @visit.landing_page,
+        "Referring Domain" => @visit.referring_domain,
+        "Browser" => @visit.browser,
+        "OS" => @visit.os,
+        "Device" => @visit.device_type,
+        "Country" => @visit.country,
+        "Region" => @visit.region,
+        "City" => @visit.city,
+        "UTM Source" => @visit.utm_source,
+        "UTM Medium" => @visit.utm_medium,
+        "UTM Campaign" => @visit.utm_campaign,
+        "UTM Term" => @visit.utm_term,
+        "UTM Content" => @visit.utm_content,
+        "IP" => @visit.ip
+      } %>
+      <% details.each do |label, val| %>
+        <div>
+          <dt class="text-xs font-medium text-gray-500 uppercase"><%= label %></dt>
+          <dd class="mt-1 text-sm text-gray-900"><%= val.presence || "-" %></dd>
+        </div>
+      <% end %>
+    </dl>
+  </div>
+
+  <!-- Events -->
+  <div class="bg-white rounded-xl shadow-sm border border-gray-200 overflow-hidden">
+    <div class="px-6 py-4 border-b border-gray-200">
+      <h3 class="text-sm font-semibold text-gray-900">Events (<%= @events.count %>)</h3>
+    </div>
+    <div class="overflow-x-auto">
+      <table class="min-w-full divide-y divide-gray-200">
+        <thead class="bg-gray-50">
+          <tr>
+            <th class="px-6 py-3 text-left text-xs font-medium text-gray-500 uppercase tracking-wider">Time</th>
+            <th class="px-6 py-3 text-left text-xs font-medium text-gray-500 uppercase tracking-wider">Name</th>
+            <th class="px-6 py-3 text-left text-xs font-medium text-gray-500 uppercase tracking-wider">Properties</th>
+          </tr>
+        </thead>
+        <tbody class="bg-white divide-y divide-gray-200">
+          <% @events.each do |event| %>
+            <tr class="hover:bg-gray-50">
+              <td class="px-6 py-3 text-sm text-gray-900 whitespace-nowrap"><%= event.time.strftime("%H:%M:%S") %></td>
+              <td class="px-6 py-3 text-sm text-gray-900">
+                <span class="inline-flex items-center px-2 py-0.5 rounded-md text-xs font-medium bg-indigo-50 text-indigo-700">
+                  <%= event.name %>
+                </span>
+              </td>
+              <td class="px-6 py-3 text-sm text-gray-600 max-w-md truncate">
+                <% if event.properties.present? %>
+                  <code class="text-xs bg-gray-100 rounded px-1 py-0.5"><%= event.properties.to_json %></code>
+                <% end %>
+              </td>
+            </tr>
+          <% end %>
+        </tbody>
+      </table>
+    </div>
+  </div>
+</div>

data/config/importmap.rb

@@ -0,0 +1,5 @@
+pin "chart.js/auto", to: "https://cdn.jsdelivr.net/npm/chart.js@4.4.7/dist/chart.umd.min.js"
+pin "quarterdeck/application", to: "quarterdeck/application.js"
+pin "quarterdeck/controllers/chart_controller", to: "quarterdeck/controllers/chart_controller.js"
+pin "quarterdeck/controllers/date_range_controller", to: "quarterdeck/controllers/date_range_controller.js"
+pin "quarterdeck/controllers/live_controller", to: "quarterdeck/controllers/live_controller.js"

data/config/routes.rb

@@ -0,0 +1,8 @@
+Quarterdeck::Engine.routes.draw do
+  root to: "overview#show"
+  resources :visits, only: [ :index, :show ]
+  resources :events, only: [ :index ]
+  resource :campaigns, only: [ :show ]
+  resource :geographic, only: [ :show ]
+  resource :live, only: [ :show ], controller: "live"
+end

data/lib/generators/quarterdeck/install_generator.rb

@@ -0,0 +1,39 @@
+module Quarterdeck
+  module Generators
+    class InstallGenerator < Rails::Generators::Base
+      source_root File.expand_path("templates", __dir__)
+
+      desc "Install Quarterdeck analytics dashboard"
+
+      def create_initializer
+        create_file "config/initializers/quarterdeck.rb", <<~RUBY
+          # Quarterdeck configuration
+          # See https://github.com/leopolicastro/quarterdeck for documentation
+
+          # Set the parent controller for Quarterdeck controllers
+          # Quarterdeck.parent_controller = "ApplicationController"
+
+          # Set up authentication (optional)
+          # Quarterdeck.authenticate_with do
+          #   redirect_to main_app.root_path unless current_user&.admin?
+          # end
+        RUBY
+      end
+
+      def mount_engine
+        route 'mount Quarterdeck::Engine => "/analytics"'
+      end
+
+      def show_post_install
+        say ""
+        say "Quarterdeck has been installed!", :green
+        say ""
+        say "  Dashboard: /analytics"
+        say "  Config:    config/initializers/quarterdeck.rb"
+        say ""
+        say "Make sure you have ahoy_matey configured in your app."
+        say ""
+      end
+    end
+  end
+end

data/lib/quarterdeck/engine.rb

@@ -0,0 +1,19 @@
+module Quarterdeck
+  class Engine < ::Rails::Engine
+    isolate_namespace Quarterdeck
+
+    initializer "quarterdeck.importmap", before: "importmap" do |app|
+      if app.config.respond_to?(:importmap)
+        app.config.importmap.paths << Engine.root.join("config/importmap.rb")
+        app.config.importmap.cache_sweepers << Engine.root.join("app/javascript")
+      end
+    end
+
+    initializer "quarterdeck.assets" do |app|
+      if app.config.respond_to?(:assets)
+        app.config.assets.paths << Engine.root.join("app/javascript")
+        app.config.assets.precompile += %w[ quarterdeck/application.css ]
+      end
+    end
+  end
+end

data/lib/quarterdeck/version.rb

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

data/lib/quarterdeck.rb

@@ -0,0 +1,19 @@
+require "quarterdeck/version"
+require "ahoy_matey"
+require "pagy"
+require "groupdate"
+require "quarterdeck/engine"
+
+module Quarterdeck
+  mattr_accessor :parent_controller, default: "ApplicationController"
+
+  class << self
+    def authenticate_with(&block)
+      @authentication_block = block
+    end
+
+    def authentication_block
+      @authentication_block
+    end
+  end
+end

data/lib/tasks/quarterdeck_tasks.rake

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

metadata

@@ -0,0 +1,139 @@
+--- !ruby/object:Gem::Specification
+name: quarterdeck
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- leopolicastro
+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.1.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 8.1.2
+- !ruby/object:Gem::Dependency
+  name: pagy
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '6'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '6'
+- !ruby/object:Gem::Dependency
+  name: groupdate
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '6'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '6'
+- !ruby/object:Gem::Dependency
+  name: csv
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: A beautiful analytics dashboard UI for Rails apps already using ahoy_matey
+  for tracking. Quarterdeck reads your existing Ahoy data and presents it in a modern
+  dashboard with charts, tables, and filters.
+email:
+- 43428385+leopolicastro@users.noreply.github.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- MIT-LICENSE
+- README.md
+- Rakefile
+- app/assets/stylesheets/quarterdeck/application.css
+- app/controllers/quarterdeck/application_controller.rb
+- app/controllers/quarterdeck/campaigns_controller.rb
+- app/controllers/quarterdeck/events_controller.rb
+- app/controllers/quarterdeck/geographics_controller.rb
+- app/controllers/quarterdeck/live_controller.rb
+- app/controllers/quarterdeck/overview_controller.rb
+- app/controllers/quarterdeck/visits_controller.rb
+- app/helpers/quarterdeck/application_helper.rb
+- app/javascript/quarterdeck/application.js
+- app/javascript/quarterdeck/controllers/chart_controller.js
+- app/javascript/quarterdeck/controllers/date_range_controller.js
+- app/javascript/quarterdeck/controllers/live_controller.js
+- app/jobs/quarterdeck/application_job.rb
+- app/mailers/quarterdeck/application_mailer.rb
+- app/models/quarterdeck/application_record.rb
+- app/views/layouts/quarterdeck/application.html.erb
+- app/views/quarterdeck/campaigns/show.html.erb
+- app/views/quarterdeck/events/index.html.erb
+- app/views/quarterdeck/geographics/show.html.erb
+- app/views/quarterdeck/live/show.html.erb
+- app/views/quarterdeck/overview/show.html.erb
+- app/views/quarterdeck/shared/_data_table.html.erb
+- app/views/quarterdeck/shared/_nav.html.erb
+- app/views/quarterdeck/shared/_period_tabs.html.erb
+- app/views/quarterdeck/shared/_stat_card.html.erb
+- app/views/quarterdeck/visits/index.html.erb
+- app/views/quarterdeck/visits/show.html.erb
+- config/importmap.rb
+- config/routes.rb
+- lib/generators/quarterdeck/install_generator.rb
+- lib/quarterdeck.rb
+- lib/quarterdeck/engine.rb
+- lib/quarterdeck/version.rb
+- lib/tasks/quarterdeck_tasks.rake
+homepage: https://github.com/leopolicastro/quarterdeck
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/leopolicastro/quarterdeck
+  source_code_uri: https://github.com/leopolicastro/quarterdeck
+  changelog_uri: https://github.com/leopolicastro/quarterdeck/blob/main/CHANGELOG.md
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 4.0.6
+specification_version: 4
+summary: Analytics dashboard engine for Rails apps using Ahoy
+test_files: []