code_sunset 0.1.0

data/lib/code_sunset.rb

@@ -0,0 +1,109 @@
+require "active_support"
+require "active_support/core_ext/hash/deep_merge"
+require "active_support/core_ext/hash/keys"
+require "active_support/core_ext/integer/time"
+require "active_support/core_ext/object/blank"
+require "active_support/core_ext/object/try"
+require "digest"
+require "json"
+require "logger"
+require "net/http"
+require "uri"
+
+require "code_sunset/version"
+require "code_sunset/configuration"
+require "code_sunset/context"
+require "code_sunset/controller_context"
+require "code_sunset/job_context"
+require "code_sunset/event_buffer"
+require "code_sunset/analytics_filters"
+require "code_sunset/event_payload"
+require "code_sunset/instrumentation"
+require "code_sunset/event_ingestor"
+require "code_sunset/identity_hash"
+require "code_sunset/feature_snapshot"
+require "code_sunset/status_engine"
+require "code_sunset/score_calculator"
+require "code_sunset/feature_query"
+require "code_sunset/removal_candidate_query"
+require "code_sunset/feature_usage_series"
+require "code_sunset/removal_prompt_builder"
+require "code_sunset/alert_dispatcher"
+require "code_sunset/subscriber"
+require "code_sunset/engine"
+
+module CodeSunset
+  class << self
+    def configuration
+      @configuration ||= Configuration.new
+    end
+
+    def configure
+      yield(configuration)
+    end
+
+    def reset_configuration!
+      @configuration = Configuration.new
+    end
+
+    def enabled?
+      configuration.enabled
+    end
+
+    def event_buffer
+      @event_buffer ||= CodeSunset::EventBuffer.new
+    end
+
+    def hit(feature_key, **attrs)
+      Instrumentation.hit(feature_key, **attrs)
+    end
+
+    def track(feature_key, **attrs)
+      hit(feature_key, **attrs)
+      return unless block_given?
+
+      yield
+    end
+
+    def with_context(**context)
+      return unless block_given?
+
+      Context.with(context) { yield }
+    end
+
+    def register(feature_key, **attrs)
+      return unless enabled?
+      return unless defined?(CodeSunset::Feature)
+
+      safe_execute("register #{feature_key}") do
+        feature = CodeSunset::Feature.find_or_initialize_by(key: feature_key.to_s)
+        feature.assign_attributes(attrs.compact)
+        feature.save!
+        feature
+      end
+    end
+
+    def removal_candidates(filters = {})
+      return [] unless defined?(CodeSunset::RemovalCandidateQuery)
+
+      CodeSunset::RemovalCandidateQuery.new(filters).call
+    end
+
+    def logger
+      return Rails.logger if defined?(Rails) && Rails.respond_to?(:logger) && Rails.logger
+
+      @logger ||= Logger.new($stdout)
+    end
+
+    def log_error(message, error)
+      logger.error("[code_sunset] #{message}: #{error.class}: #{error.message}")
+    end
+
+    def safe_execute(description = "operation")
+      yield
+    rescue StandardError => error
+      log_error(description, error)
+      nil
+    end
+  end
+end

data/lib/generators/code_sunset/eject_ui/eject_ui_generator.rb

@@ -0,0 +1,33 @@
+require "rails/generators/base"
+
+module CodeSunset
+  module Generators
+    class EjectUiGenerator < Rails::Generators::Base
+      source_root File.expand_path("../../../..", __dir__)
+
+      UI_FILES = {
+        "app/assets/javascripts/code_sunset/application.js" => "app/assets/javascripts/code_sunset/application.js",
+        "app/assets/javascripts/code_sunset/vendor/chart.umd.min.js" => "app/assets/javascripts/code_sunset/vendor/chart.umd.min.js",
+        "app/helpers/code_sunset/application_helper.rb" => "app/helpers/code_sunset/application_helper.rb",
+        "app/views/layouts/code_sunset/application.html.erb" => "app/views/layouts/code_sunset/application.html.erb",
+        "app/views/code_sunset/dashboard/index.html.erb" => "app/views/code_sunset/dashboard/index.html.erb",
+        "app/views/code_sunset/features/index.html.erb" => "app/views/code_sunset/features/index.html.erb",
+        "app/views/code_sunset/features/show.html.erb" => "app/views/code_sunset/features/show.html.erb",
+        "app/views/code_sunset/removal_candidates/index.html.erb" => "app/views/code_sunset/removal_candidates/index.html.erb",
+        "app/assets/stylesheets/code_sunset/application.css" => "app/assets/stylesheets/code_sunset/application.css"
+      }.freeze
+
+      desc "Copies the Code Sunset dashboard UI into the host app for customization."
+
+      def copy_ui_files
+        UI_FILES.each do |source, destination|
+          copy_file source, destination
+        end
+      end
+
+      def show_next_steps
+        say_status :ejected, "Host app copies now override the engine UI. Customize them freely and mount the engine anywhere you like.", :green
+      end
+    end
+  end
+end

data/lib/generators/code_sunset/initializer/initializer_generator.rb

@@ -0,0 +1,13 @@
+require "rails/generators/base"
+
+module CodeSunset
+  module Generators
+    class InitializerGenerator < Rails::Generators::Base
+      source_root File.expand_path("templates", __dir__)
+
+      def copy_initializer
+        template "code_sunset.rb", "config/initializers/code_sunset.rb"
+      end
+    end
+  end
+end

data/lib/generators/code_sunset/initializer/templates/code_sunset.rb

@@ -0,0 +1,34 @@
+CodeSunset.configure do |config|
+  config.enabled = true
+  config.environment = Rails.env
+  config.async = true
+  config.sample_rate = 1.0
+  config.app_version = ENV["CODE_SUNSET_APP_VERSION"] || ENV["APP_VERSION"] || ENV["GIT_SHA"]
+  config.identity_fields = %i[user_id org_id]
+  config.hash_identity = false
+  config.event_retention_days = 90
+  config.enqueue_failure_policy = :drop
+  config.enqueue_buffer_size = 1000
+  config.alert_cooldown = 24.hours
+
+  # Return true to allow dashboard access.
+  config.dashboard_authorizer = ->(controller) { controller.respond_to?(:current_user) && controller.current_user.present? }
+
+  # Optional business-domain hooks.
+  # config.plan_resolver = ->(org_id, metadata, _payload) { metadata[:plan] }
+  # config.internal_org_resolver = ->(org_id, _metadata, _payload) { InternalOrg.exists?(id: org_id) }
+  # config.paid_org_resolver = ->(org_id, _metadata, _payload) { Account.find_by(id: org_id)&.paid? }
+
+  # Optional custom metadata filters for the admin panel.
+  # config.custom_filters = {
+  #   region: { label: "Region", type: :string, metadata_key: "region" },
+  #   beta_opt_in: { label: "Beta Opt-In", type: :boolean, metadata_key: "beta_opt_in" },
+  #   account_tier: { label: "Account Tier", type: :select, metadata_key: "tier", options: [["Free", "free"], ["Pro", "pro"]] }
+  # }
+  # config.alert_webhook_url = ENV["CODE_SUNSET_WEBHOOK_URL"]
+  # config.slack_webhook_url = ENV["CODE_SUNSET_SLACK_WEBHOOK_URL"]
+
+  # Use :memory_buffer only for best-effort temporary queue outages.
+  # Buffered events stay in-process and must be flushed by a scheduled job/task.
+  # config.enqueue_failure_policy = :memory_buffer
+end

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

@@ -0,0 +1,23 @@
+require "rails/generators/base"
+
+module CodeSunset
+  module Generators
+    class InstallGenerator < Rails::Generators::Base
+      class_option :eject_ui, type: :boolean, default: false, desc: "Copy the engine dashboard layout, views, helper, and stylesheet into the host app."
+
+      def install_initializer
+        invoke "code_sunset:initializer"
+      end
+
+      def install_migration
+        invoke "code_sunset:migration"
+      end
+
+      def install_ui
+        return unless options[:eject_ui]
+
+        invoke "code_sunset:eject_ui"
+      end
+    end
+  end
+end

data/lib/generators/code_sunset/migration/migration_generator.rb

@@ -0,0 +1,21 @@
+require "rails/generators"
+require "rails/generators/active_record"
+require "rails/generators/migration"
+
+module CodeSunset
+  module Generators
+    class MigrationGenerator < Rails::Generators::Base
+      include Rails::Generators::Migration
+
+      source_root File.expand_path("templates", __dir__)
+
+      def copy_migration
+        migration_template "create_code_sunset_tables.rb", "db/migrate/create_code_sunset_tables.rb"
+      end
+
+      def self.next_migration_number(dirname)
+        ActiveRecord::Generators::Base.next_migration_number(dirname)
+      end
+    end
+  end
+end

data/lib/generators/code_sunset/migration/templates/create_code_sunset_tables.rb

@@ -0,0 +1,75 @@
+class CreateCodeSunsetTables < ActiveRecord::Migration[7.1]
+  def change
+    create_table :code_sunset_features do |t|
+      t.string :key, null: false
+      t.string :owner
+      t.text :description
+      t.string :status
+      t.integer :sunset_after_days, null: false, default: 90
+      t.integer :remove_after_days_unused, null: false, default: 60
+      t.timestamps
+    end
+
+    add_index :code_sunset_features, :key, unique: true
+    add_index :code_sunset_features, :status
+
+    create_table :code_sunset_events do |t|
+      t.string :feature_key, null: false
+      t.datetime :occurred_at, null: false
+      t.bigint :user_id
+      t.bigint :org_id
+      t.string :hashed_user_id
+      t.string :hashed_org_id
+      t.string :request_id
+      t.string :source
+      t.string :request_path
+      t.string :controller
+      t.string :action
+      t.string :job_class
+      t.string :app_env, null: false
+      t.string :app_version
+      t.string :plan
+      t.boolean :internal_org
+      t.boolean :paid_org
+      t.jsonb :metadata, null: false, default: {}
+      t.timestamps
+    end
+
+    add_index :code_sunset_events, :feature_key
+    add_index :code_sunset_events, :occurred_at
+    add_index :code_sunset_events, [:feature_key, :occurred_at]
+    add_index :code_sunset_events, :user_id
+    add_index :code_sunset_events, :org_id
+    add_index :code_sunset_events, :hashed_user_id
+    add_index :code_sunset_events, :hashed_org_id
+    add_index :code_sunset_events, :app_env
+    add_index :code_sunset_events, :plan
+    add_index :code_sunset_events, :metadata, using: :gin
+
+    create_table :code_sunset_daily_rollups do |t|
+      t.string :feature_key, null: false
+      t.string :app_env
+      t.date :day, null: false
+      t.integer :hits_count, null: false, default: 0
+      t.integer :unique_users_count, null: false, default: 0
+      t.integer :unique_orgs_count, null: false, default: 0
+      t.datetime :last_seen_at
+      t.timestamps
+    end
+
+    add_index :code_sunset_daily_rollups, [:feature_key, :app_env, :day], unique: true, name: "index_code_sunset_rollups_on_feature_env_day"
+    add_index :code_sunset_daily_rollups, :day
+
+    create_table :code_sunset_alert_deliveries do |t|
+      t.string :feature_key, null: false
+      t.string :status, null: false
+      t.string :alert_kind, null: false
+      t.datetime :delivered_at, null: false
+      t.jsonb :payload, null: false, default: {}
+      t.timestamps
+    end
+
+    add_index :code_sunset_alert_deliveries, [:feature_key, :status, :alert_kind, :delivered_at], name: "index_code_sunset_alerts_on_feature_status_kind_time"
+    add_index :code_sunset_alert_deliveries, :delivered_at
+  end
+end

data/lib/tasks/code_sunset_tasks.rake

@@ -0,0 +1,21 @@
+namespace :code_sunset do
+  desc "Aggregate raw events into daily rollups"
+  task aggregate_rollups: :environment do
+    CodeSunset::AggregateDailyRollupsJob.perform_now
+  end
+
+  desc "Clean up raw events older than the configured retention window"
+  task cleanup_events: :environment do
+    CodeSunset::CleanupEventsJob.perform_now
+  end
+
+  desc "Evaluate alerts for deprecated features"
+  task evaluate_alerts: :environment do
+    CodeSunset::EvaluateAlertsJob.perform_now
+  end
+
+  desc "Flush buffered events when enqueue_failure_policy is :memory_buffer"
+  task flush_buffer: :environment do
+    CodeSunset::FlushBufferedEventsJob.perform_now
+  end
+end

metadata

@@ -0,0 +1,185 @@
+--- !ruby/object:Gem::Specification
+name: code_sunset
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- sdglhm
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2026-03-30 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '7.1'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '9.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '7.1'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '9.0'
+- !ruby/object:Gem::Dependency
+  name: pg
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !ruby/object:Gem::Dependency
+  name: puma
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '7.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '7.0'
+- !ruby/object:Gem::Dependency
+  name: propshaft
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+description: Track legacy code usage, aggregate removal signals, and review everything
+  in a mounted Rails engine dashboard.
+email:
+- hello@sdglhm.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- MIT-LICENSE
+- README.md
+- Rakefile
+- app/assets/images/code_sunset/.keep
+- app/assets/images/code_sunset/logo-dark.png
+- app/assets/images/code_sunset/logo-light.png
+- app/assets/images/code_sunset/topography.svg
+- app/assets/javascripts/code_sunset/application.js
+- app/assets/javascripts/code_sunset/vendor/chart.umd.min.js
+- app/assets/stylesheets/code_sunset/application.css
+- app/controllers/code_sunset/application_controller.rb
+- app/controllers/code_sunset/dashboard_controller.rb
+- app/controllers/code_sunset/features_controller.rb
+- app/controllers/code_sunset/removal_candidates_controller.rb
+- app/controllers/concerns/.keep
+- app/helpers/code_sunset/application_helper.rb
+- app/jobs/code_sunset/aggregate_daily_rollups_job.rb
+- app/jobs/code_sunset/application_job.rb
+- app/jobs/code_sunset/cleanup_events_job.rb
+- app/jobs/code_sunset/evaluate_alerts_job.rb
+- app/jobs/code_sunset/flush_buffered_events_job.rb
+- app/jobs/code_sunset/persist_event_job.rb
+- app/mailers/code_sunset/application_mailer.rb
+- app/models/code_sunset/alert_delivery.rb
+- app/models/code_sunset/application_record.rb
+- app/models/code_sunset/daily_rollup.rb
+- app/models/code_sunset/event.rb
+- app/models/code_sunset/feature.rb
+- app/models/concerns/.keep
+- app/views/code_sunset/dashboard/index.html.erb
+- app/views/code_sunset/features/index.html.erb
+- app/views/code_sunset/features/show.html.erb
+- app/views/code_sunset/removal_candidates/index.html.erb
+- app/views/code_sunset/shared/_filter_bar.html.erb
+- app/views/layouts/code_sunset/application.html.erb
+- bin/rails
+- code_sunset.gemspec
+- config/routes.rb
+- db/migrate/20260330000000_create_code_sunset_tables.rb
+- db/migrate/20260331000000_harden_code_sunset_reliability.rb
+- lib/code_sunset.rb
+- lib/code_sunset/alert_dispatcher.rb
+- lib/code_sunset/analytics_filters.rb
+- lib/code_sunset/configuration.rb
+- lib/code_sunset/context.rb
+- lib/code_sunset/controller_context.rb
+- lib/code_sunset/engine.rb
+- lib/code_sunset/event_buffer.rb
+- lib/code_sunset/event_ingestor.rb
+- lib/code_sunset/event_payload.rb
+- lib/code_sunset/feature_query.rb
+- lib/code_sunset/feature_snapshot.rb
+- lib/code_sunset/feature_usage_series.rb
+- lib/code_sunset/identity_hash.rb
+- lib/code_sunset/instrumentation.rb
+- lib/code_sunset/job_context.rb
+- lib/code_sunset/removal_candidate_query.rb
+- lib/code_sunset/removal_prompt_builder.rb
+- lib/code_sunset/score_calculator.rb
+- lib/code_sunset/status_engine.rb
+- lib/code_sunset/subscriber.rb
+- lib/code_sunset/version.rb
+- lib/generators/code_sunset/eject_ui/eject_ui_generator.rb
+- lib/generators/code_sunset/initializer/initializer_generator.rb
+- lib/generators/code_sunset/initializer/templates/code_sunset.rb
+- lib/generators/code_sunset/install/install_generator.rb
+- lib/generators/code_sunset/migration/migration_generator.rb
+- lib/generators/code_sunset/migration/templates/create_code_sunset_tables.rb
+- lib/tasks/code_sunset_tasks.rake
+homepage: https://sdglhm.com
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://sdglhm.com
+  source_code_uri: https://github.com/sdglhm/code_sunset
+  changelog_uri: https://github.com/sdglhm/code_sunset/blob/main/README.md
+  bug_tracker_uri: https://github.com/sdglhm/code_sunset/issues
+post_install_message:
+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: 3.4.10
+signing_key:
+specification_version: 4
+summary: Runtime-aware deprecation intelligence for Rails.
+test_files: []