skadi 0.4.0.beta.3 → 0.4.0.beta.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5084282e0264c2ccd84363bfcc45fc7e20a2906ef4e71c84716c7f60f0c3289e
-  data.tar.gz: 75a22a18931697176f54febbde94b7a4f96cabdf659daf04b88728c86f9a1bc6
+  metadata.gz: 69c9f96eeeec38ea33c8eb352d9c12d9466ec10294c6f293bad4a8d0011bcd03
+  data.tar.gz: 07f70d68d1da2bf863770b29b284d2a6083c157854def0052075ec3a1dcbb13b
 SHA512:
-  metadata.gz: a979b37d7229bab10836126a58a61c0324ca5a704cdaaa4ff0be4c5e1e143501c905861c000245bb7d4b1584be88a9494936bf8e61f0febdce82ba20182a7057
-  data.tar.gz: c6b3ceafebaa70749c94a1d6467aa1c5bab40620f69cb69340d4034b69b01321594a10eb0241650457084451c544b4f8e633e543e092640b0807569cc06829c0
+  metadata.gz: 6a33409c7b1adc14884970673422fda594d2af59ba5a7a72d5705430e43c9d66ced9b9db915d31a1132fd4471c46ca4b22dfda79243ae4f1347ce3d0f42e3180
+  data.tar.gz: a5ca6dc6342300c4fd459f16e0595877e788f684ca197810c3b8168a91e00420f5a91f4e0ea9a0f5f5c8b6ec68a78c020acaf1550bc53c4baa1d8e51a93c0073

data/CHANGELOG.md

@@ -1,3 +1,8 @@
+## 0.4.0.beta.4 [2026-09-03]
+- Add initializer to install script
+- Change migration generator to detect the Rails database engine from config
+- Use :jsonb data type for SQLite 3.45.0+
+
 ## 0.4.0.beta.3 [2026-09-01]
 - Add "Traffic type" demographic to count bot vs human traffic
 - Change demographic names to be more consistent

data/README.md

@@ -2,7 +2,7 @@
 
 First-party, privacy-by-default analytics for Rails.
 
-Skadi adds flexible and lightweight first-party analytics to your Rails app. Track page views and events, perform A/B testing and more, giving you all the information you need to improve your website.
+Skadi adds flexible and lightweight first-party analytics and a data dashboard to your Rails application. Track page views and events, perform A/B testing and more, giving you everything you need to improve your website.
 
 Skadi is privacy-by-default, which means it respects users' privacy without any additional configuration. It gives you the power to be compliant with privacy laws*, while still collecting useful usage data about your site.
 

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

@@ -14,8 +14,7 @@ module Skadi
       VALID_DB_ENGINES = [ :postgres, :mysql, :sqlite ]
       class_option :db_engine,
         type: :string,
-        default: "postgres",
-        desc: "Database engine (postgres, mysql, sqlite)"
+        desc: "Database engine (postgres, mysql, sqlite). Auto-detected from the app's database config when omitted."
 
       VALID_USER_ID_TYPES = [ :bigint, :integer, :uuid, :string ]
       class_option :user_id_type,
@@ -33,14 +32,49 @@ module Skadi
           "db/migrate/install_skadi.rb"
       end
 
+      def create_initializer
+        template "skadi_initializer.rb", "config/initializers/skadi.rb"
+      end
+
       # Thor requires us to use a private block rather than private on individual definitions
       private
 
       def user_id_type = options[:user_id_type].to_sym
-      def db_engine = options[:db_engine].to_sym
+      def db_engine = (options[:db_engine] || detect_db_engine || :sqlite).to_sym
       def uuid_column_type = (db_engine == :postgres) ? :uuid : :string
       def uuid_column_options = (db_engine == :postgres) ? "" : ", limit: 36"
-      def json_column_type = (db_engine == :postgres) ? :jsonb : :json
+      def json_column_type
+        @_json_column_type ||= case db_engine
+          when :mysql
+            :json
+          when :postgres
+            :jsonb
+          when :sqlite
+            if defined?(ActiveRecord::Base) && ActiveRecord::Base.connection.database_version >= "3.45.0"
+              :jsonb
+            else
+              :json
+            end
+        end
+      rescue StandardError
+        # ActiveRecord::Base.connection can throw if the database cannot be reached, in which case we fallback to :json
+        return @_json_column_type ||= :json
+      end
+
+      def detect_db_engine
+        return unless defined? ActiveRecord::Base
+
+        case ActiveRecord::Base.connection_db_config.adapter
+          when "postgresql"
+            :postgres
+          when "mysql2", "trilogy"
+            :mysql
+          when "sqlite3"
+            :sqlite
+        end
+      rescue StandardError
+        nil
+      end
     end
   end
 end

data/lib/generators/skadi/install/templates/skadi_initializer.rb

@@ -0,0 +1,84 @@
+# This auto-generated file contains the configuration options that you are most
+# likely to change. Refer to the Skadi configuration class to see the full list
+# of configuration options and their descriptions.
+# @see {Skadi::Configuration}
+
+Skadi.configure do |config|
+  # Enables anonymity sets without requiring consent. A hash of the user's IP
+  # and User Agent is used to track them across the same day. This data is
+  # aggregated at the end of the day, anonymising it. Defaults to false.
+  #
+  # config.use_anonymity_sets = true
+
+  # Enables tracking users without requiring consent. The current user will be
+  # attached to site visits and used to de-duplicate visitors.
+  #
+  # config.track_users = true
+
+
+  # A string containing the user model class for the application.
+  #
+  # config.user_model = "User"
+
+  # The method to call within your ApplicationController to get the current user.
+  #
+  # config.user_controller_method = :current_user
+
+
+  # Methods to call within your ApplicationController to authenticate users for
+  # using the Skadi dashboard. These methods should return a boolean.
+  #
+  # config.dashboard_view_controller_method = :skadi_dashboard_can_view
+  # config.dashboard_edit_controller_method = :skadi_dashboard_can_edit
+  # config.dashboard_dangerously_use_sql_controller_method = :skadi_dashboard_can_dangerously_use_sql
+
+
+  # Add custom fields to the events table in the Skadi dashboard.
+  # @see [Skadi::Schema]
+  #
+  # config.dashboard_custom_event_fields = {
+  #   http_verb: {
+  #     # How the field is displayed in the dashboard. A label is auto-generated
+  #     # if omitted ("http_verb" => "Http Verb").
+  #     label: "HTTP Verb",
+  #     # Additional information displayed with this field in the dashboard.
+  #     description: "Typically, GET requests are page views, and POST, PUT, PATCH and DELETE are form submissions.",
+  #     # The datatype, one of: :one_of, :date, :string, :number, :boolean.
+  #     # Defaults to :string if omitted.
+  #     type: :one_of,
+  #     # Options for filtering in the dashboard when the :one_of type is used
+  #     options: %w[GET POST PUT PATCH DELETE],
+  #     # Whether this field can be selected for tables
+  #     select: true,
+  #     # Whether users can filter by this field
+  #     filter: true,
+  #     # Whether this field can be used to split a chart view
+  #     split: true,
+  #     # The SQL expression used to get this field
+  #     sql: "properties->>'http_verb'",
+  #   },
+  # }
+
+  # Add your own database tables to the Skadi dashboard.
+  # @see [Skadi::Schema] for format and examples.
+  #
+  # config.dashboard_custom_schema = {
+  #   user: {
+  #     model: "User",
+  #     fields: {
+  #       username: {
+  #         select: true,
+  #         filter: true,
+  #         split: true,
+  #       },
+  #       name: {
+  #         label: "Full name",
+  #         sql: "CONCAT(users.first_name, ' ', users.last_name)",
+  #         select: true,
+  #         filter: true,
+  #         split: true,
+  #       },
+  #     },
+  #   },
+  # }
+end

data/lib/skadi/version.rb

@@ -1,3 +1,3 @@
 module Skadi
-  VERSION = "0.4.0.beta.3"
+  VERSION = "0.4.0.beta.4"
 end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: skadi
 version: !ruby/object:Gem::Version
-  version: 0.4.0.beta.3
+  version: 0.4.0.beta.4
 platform: ruby
 authors:
 - Simon J
 bindir: bin
 cert_chain: []
-date: 2026-09-01 00:00:00.000000000 Z
+date: 2026-09-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -155,6 +155,7 @@ files:
 - config/routes.rb
 - lib/generators/skadi/install/USAGE
 - lib/generators/skadi/install/install_generator.rb
+- lib/generators/skadi/install/templates/skadi_initializer.rb
 - lib/generators/skadi/install/templates/skadi_migration.rb.erb
 - lib/skadi.rb
 - lib/skadi/analytics.rb