devformance 0.1.0

data/spec/requests/devmetrics_pages_spec.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require "rails_helper"
+
+RSpec.describe "Devformance Dashboard", type: :request do
+  describe "GET /devformance" do
+    it "returns 200 and renders the dashboard" do
+      get "/devformance"
+      expect(response).to have_http_status(200)
+    end
+  end
+end

data/spec/requests/performance_spec.rb

@@ -0,0 +1,17 @@
+require 'devformance'
+
+RSpec.describe "Performance Suite", type: :request, devformance: true do
+  it "performs a slow query" do
+    # Trigger a dummy slow query if possible or just use sleep + notification
+    ActiveSupport::Notifications.instrument('sql.active_record', sql: 'SELECT * FROM users OFFSET 5000', start: Time.now - 0.2, finish: Time.now) do
+      # nothing
+    end
+    expect(true).to be true
+  end
+
+  it "performs another query" do
+    ActiveSupport::Notifications.instrument('sql.active_record', sql: 'SELECT count(*) FROM query_logs', start: Time.now - 0.05, finish: Time.now) do
+    end
+    expect(true).to be true
+  end
+end

data/spec/requests/slow_perf_spec.rb

@@ -0,0 +1,9 @@
+require 'devformance'
+
+RSpec.describe "Slow Performance Suite", type: :request, devformance: true do
+  it "performs a very slow query" do
+    ActiveSupport::Notifications.instrument('sql.active_record', sql: 'SELECT pg_sleep(0.5)', start: Time.now - 0.5, finish: Time.now) do
+    end
+    expect(true).to be true
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,114 @@
+# This file was generated by the `rspec --init` command. Conventionally, all
+# specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.
+# The generated `.rspec` file contains `--require spec_helper` which will cause
+# this file to always be loaded, without a need to explicitly require it in any
+# files.
+#
+# Given that it is always loaded, you are encouraged to keep this file as
+# light-weight as possible. Requiring heavyweight dependencies from this file
+# will add to the boot time of your test suite on EVERY test run, even for an
+# individual file that may not need all of that loaded. Instead, consider making
+# a separate helper file that requires the additional dependencies and performs
+# the additional setup, and require it from the spec files that actually need
+# it.
+#
+# See https://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
+
+require "simplecov"
+SimpleCov.start "rails" do
+  add_filter "/test/"
+  add_filter "/config/"
+  add_filter "/vendor/"
+
+  add_group "Controllers",  "app/controllers"
+  add_group "Models",       "app/models"
+  add_group "Services",     "app/services"
+  add_group "Jobs",         "app/jobs"
+  add_group "Serializers",  "app/serializers"
+
+  minimum_coverage 90 # fails the build if you drop below this
+end
+
+RSpec.configure do |config|
+  # rspec-expectations config goes here. You can use an alternate
+  # assertion/expectation library such as wrong or the stdlib/minitest
+  # assertions if you prefer.
+  config.expect_with :rspec do |expectations|
+    # This option will default to `true` in RSpec 4. It makes the `description`
+    # and `failure_message` of custom matchers include text for helper methods
+    # defined using `chain`, e.g.:
+    #     be_bigger_than(2).and_smaller_than(4).description
+    #     # => "be bigger than 2 and smaller than 4"
+    # ...rather than:
+    #     # => "be bigger than 2"
+    expectations.include_chain_clauses_in_custom_matcher_descriptions = true
+  end
+
+  # rspec-mocks config goes here. You can use an alternate test double
+  # library (such as bogus or mocha) by changing the `mock_with` option here.
+  config.mock_with :rspec do |mocks|
+    # Prevents you from mocking or stubbing a method that does not exist on
+    # a real object. This is generally recommended, and will default to
+    # `true` in RSpec 4.
+    mocks.verify_partial_doubles = true
+  end
+
+  # This option will default to `:apply_to_host_groups` in RSpec 4 (and will
+  # have no way to turn it off -- the option exists only for backwards
+  # compatibility in RSpec 3). It causes shared context metadata to be
+  # inherited by the metadata hash of host groups and examples, rather than
+  # triggering implicit auto-inclusion in groups with matching metadata.
+  config.shared_context_metadata_behavior = :apply_to_host_groups
+
+# The settings below are suggested to provide a good initial experience
+# with RSpec, but feel free to customize to your heart's content.
+=begin
+  # This allows you to limit a spec run to individual examples or groups
+  # you care about by tagging them with `:focus` metadata. When nothing
+  # is tagged with `:focus`, all examples get run. RSpec also provides
+  # aliases for `it`, `describe`, and `context` that include `:focus`
+  # metadata: `fit`, `fdescribe` and `fcontext`, respectively.
+  config.filter_run_when_matching :focus
+
+  # Allows RSpec to persist some state between runs in order to support
+  # the `--only-failures` and `--next-failure` CLI options. We recommend
+  # you configure your source control system to ignore this file.
+  config.example_status_persistence_file_path = "spec/examples.txt"
+
+  # Limits the available syntax to the non-monkey patched syntax that is
+  # recommended. For more details, see:
+  # https://rspec.info/features/3-12/rspec-core/configuration/zero-monkey-patching-mode/
+  config.disable_monkey_patching!
+
+  # This setting enables warnings. It's recommended, but in some cases may
+  # be too noisy due to issues in dependencies.
+  config.warnings = true
+
+  # Many RSpec users commonly either run the entire suite or an individual
+  # file, and it's useful to allow more verbose output when running an
+  # individual spec file.
+  if config.files_to_run.one?
+    # Use the documentation formatter for detailed output,
+    # unless a formatter has already been configured
+    # (e.g. via a command-line flag).
+    config.default_formatter = "doc"
+  end
+
+  # Print the 10 slowest examples and example groups at the
+  # end of the spec run, to help surface which specs are running
+  # particularly slow.
+  config.profile_examples = 10
+
+  # Run specs in random order to surface order dependencies. If you find an
+  # order dependency and want to debug it, you can fix the order by providing
+  # the seed, which is printed after each run.
+  #     --seed 1234
+  config.order = :random
+
+  # Seed global randomization in this process using the `--seed` CLI option.
+  # Setting this allows you to use `--seed` to deterministically reproduce
+  # test failures related to randomization by passing the same `--seed` value
+  # as the one that triggered the failure.
+  Kernel.srand config.seed
+=end
+end

data/spec/support/devmetrics_formatter.rb

@@ -0,0 +1,106 @@
+require 'csv'
+require 'securerandom'
+
+class DevformanceFormatter
+  def initialize(output)
+    @output = output
+    @log_file = Rails.root.join('log', "devformance_#{Time.current.strftime('%Y%m%d_%H%M%S')}.log")
+    @results = []
+    @start_time = Time.current
+    @slow_queries = []
+    @nplusone_issues = []
+  end
+
+  def example_started(example)
+    @current_example = {
+      id: SecureRandom.hex(4),
+      start_time: Time.current,
+      description: example.description,
+      controller: example.metadata[:controller] || 'unknown',
+      action: example.metadata[:action] || 'unknown',
+      file: example.location.file,
+      line: example.location.line
+    }
+  end
+
+  def example_passed(example)
+    log_result(example, 'PASS')
+  end
+
+  def example_failed(example)
+    log_result(example, 'FAIL')
+  end
+
+  def example_pending(example)
+    log_result(example, 'PENDING')
+  end
+
+  def dump_summary(duration, example_count, failure_count, pending_count)
+    write_summary(duration, example_count, failure_count, pending_count)
+  end
+
+  private
+
+  def log_result(example, status)
+    result = @current_example.merge(
+      status: status,
+      duration: Time.current - @current_example[:start_time],
+      end_time: Time.current,
+      slow_queries: @slow_queries.length,
+      nplusone: @nplusone_issues.length
+    )
+
+    @results << result
+    write_row(result)
+    clear_metrics
+  end
+
+  def write_row(row)
+    File.open(@log_file, 'a') do |f|
+      f.puts "\n" + '='*120
+      f.puts "| #{row[:end_time].strftime('%Y-%m-%d %H:%M:%S')} | #{row[:controller]}##{row[:action]} | #{row[:description][0..60]}... | #{row[:status].center(6)} | #{row[:duration].round(2)}ms | SQ:#{row[:slow_queries]} | N+1:#{row[:nplusone]} |"
+      f.puts '='*120
+    end
+  end
+
+  def write_summary(duration, total, failed, pending)
+    File.open(@log_file, 'a') do |f|
+      f.puts "\n" + '█'*120
+      f.puts "📊 DEV METRICS REPORT - #{Time.current.strftime('%Y-%m-%d %H:%M:%S')}"
+      f.puts '█'*120
+      f.puts "⏱️  Total Duration: #{duration.round(2)}s"
+      f.puts "✅ Tests Passed: #{total - failed - pending}"
+      f.puts "❌ Tests Failed: #{failed}"
+      f.puts "⏳ Tests Pending: #{pending}"
+      f.puts "📈 Total Tests: #{total}"
+
+      coverage = get_coverage_percentage
+      f.puts "📊 Test Coverage: #{coverage}%"
+
+      slow_query_total = @results.sum { |r| r[:slow_queries] }
+      nplusone_total = @results.sum { |r| r[:nplusone] }
+
+      f.puts "🐌 Total Slow Queries: #{slow_query_total}"
+      f.puts "🔄 Total N+1 Issues: #{nplusone_total}"
+      f.puts "🚀 Avg Test Duration: #{(@results.sum { |r| r[:duration] } / @results.length).round(2)}ms"
+      f.puts '█'*120
+      f.puts "📄 Log saved to: #{@log_file}"
+    end
+  end
+
+  def get_coverage_percentage
+    if File.exist?('coverage/index.html')
+      # Parse simplecov coverage
+      cov_file = File.read('coverage/.resultset.json')
+      return 95.0 # Placeholder - parse real coverage
+    end
+    0.0
+  rescue
+    0.0
+  end
+
+  def clear_metrics
+    @slow_queries.clear
+    @nplusone_issues.clear
+  end
+end

data/spec/support/devmetrics_metrics.rb

@@ -0,0 +1,37 @@
+require 'bullet'
+
+RSpec.configure do |config|
+  config.around(:each, type: :request) do |example|
+    queries = []
+    subscriber = ActiveSupport::Notifications.subscribe('sql.active_record') do |_name, _start, _finish, _id, payload|
+      next if payload[:name]&.match?(/\A(SCHEMA|TRANSACTION)\z/)
+      next if payload[:sql]&.match?(/\A(BEGIN|COMMIT|ROLLBACK|SAVEPOINT|RELEASE)/i)
+      queries << payload[:sql]
+    end
+
+    if defined?(Bullet) && Bullet.enabled?
+      Bullet.start_request
+    end
+
+    example.run
+
+    if defined?(Bullet) && Bullet.enabled?
+      Bullet.end_request
+      if Bullet.notification_collector&.notifications_present?
+        puts "\n[Bullet] N+1 warnings in: #{example.full_description}"
+        Bullet.notification_collector.notifications.each do |notification|
+          puts "  #{notification.body}"
+        end
+      end
+    end
+
+    ActiveSupport::Notifications.unsubscribe(subscriber)
+
+    if queries.any?
+      puts "\n[SQL] #{queries.size} quer#{queries.size == 1 ? 'y' : 'ies'} in: #{example.full_description}"
+      queries.each_with_index do |sql, i|
+        puts "  #{i + 1}. #{sql}"
+      end
+    end
+  end
+end

data/spec/support/factory_bot.rb

@@ -0,0 +1,3 @@
+RSpec.configure do |config|
+  config.include FactoryBot::Syntax::Methods
+end

metadata

@@ -0,0 +1,200 @@
+--- !ruby/object:Gem::Specification
+name: devformance
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Devformance Contributors
+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: '6.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '6.1'
+- !ruby/object:Gem::Dependency
+  name: factory_bot_rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: |
+  Devformance is a mountable Rails Engine that adds a live performance
+  monitoring dashboard to any Rails 6.1+ application. It tracks slow SQL
+  queries, detects N+1 issues via Bullet, streams test run output in real
+  time, and surfaces memory and DB connection metrics — all accessible at /devformance.
+email: []
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- README.md
+- app/assets/builds/tailwind.css
+- app/assets/images/icon.png
+- app/assets/images/icon.svg
+- app/assets/stylesheets/devmetrics/dashboard.css
+- app/assets/stylesheets/devmetrics_live/application.css
+- app/assets/tailwind/application.css
+- app/channels/application_cable/channel.rb
+- app/channels/application_cable/connection.rb
+- app/channels/devformance/metrics_channel.rb
+- app/controllers/application_controller.rb
+- app/controllers/devformance/application_controller.rb
+- app/controllers/devformance/icons_controller.rb
+- app/controllers/devformance/metrics_controller.rb
+- app/controllers/devformance/playground_controller.rb
+- app/helpers/application_helper.rb
+- app/helpers/metrics_helper.rb
+- app/helpers/playground_helper.rb
+- app/javascript/devformance/channels/consumer.js
+- app/javascript/devformance/channels/index.js
+- app/javascript/devformance/controllers/application.js
+- app/javascript/devformance/controllers/hello_controller.js
+- app/javascript/devformance/controllers/index.js
+- app/javascript/devformance/controllers/metrics_controller.js
+- app/javascript/devformance/controllers/playground_controller.js
+- app/javascript/devmetrics.js
+- app/jobs/application_job.rb
+- app/jobs/devformance/file_runner_job.rb
+- app/mailers/application_mailer.rb
+- app/models/application_record.rb
+- app/models/devformance/file_result.rb
+- app/models/devformance/run.rb
+- app/models/devformance/slow_query.rb
+- app/views/devformance/metrics/index.html.erb
+- app/views/devformance/playground/run.html.erb
+- app/views/layouts/devformance/application.html.erb
+- app/views/layouts/mailer.html.erb
+- app/views/layouts/mailer.text.erb
+- app/views/metrics/index.html.erb
+- app/views/pwa/manifest.json.erb
+- app/views/pwa/service-worker.js
+- config/BUSINESS_LOGIC_PLAN.md
+- config/application.rb
+- config/boot.rb
+- config/cable.yml
+- config/cache.yml
+- config/credentials.yml.enc
+- config/database.yml
+- config/deploy.yml
+- config/engine_routes.rb
+- config/environment.rb
+- config/environments/development.rb
+- config/environments/production.rb
+- config/environments/test.rb
+- config/importmap.rb
+- config/initializers/assets.rb
+- config/initializers/content_security_policy.rb
+- config/initializers/filter_parameter_logging.rb
+- config/initializers/inflections.rb
+- config/locales/en.yml
+- config/master.key
+- config/puma.rb
+- config/queue.yml
+- config/recurring.yml
+- config/routes.rb
+- config/storage.yml
+- db/migrate/20260317144616_create_slow_queries.rb
+- db/migrate/20260317175630_create_performance_runs.rb
+- db/migrate/20260317195043_add_run_id_to_slow_queries.rb
+- db/migrate/20260319000001_create_devformance_runs.rb
+- db/migrate/20260319000002_create_devformance_file_results.rb
+- db/migrate/20260319000003_add_columns_to_slow_queries.rb
+- lib/devformance.rb
+- lib/devformance/bullet_log_parser.rb
+- lib/devformance/compatibility.rb
+- lib/devformance/coverage_setup.rb
+- lib/devformance/engine.rb
+- lib/devformance/log_writer.rb
+- lib/devformance/run_orchestrator.rb
+- lib/devformance/sql_instrumentor.rb
+- lib/devformance/test_framework/base.rb
+- lib/devformance/test_framework/coverage_helper.rb
+- lib/devformance/test_framework/detector.rb
+- lib/devformance/test_framework/minitest.rb
+- lib/devformance/test_framework/registry.rb
+- lib/devformance/test_framework/rspec.rb
+- lib/devformance/test_helper.rb
+- lib/devformance/version.rb
+- lib/generators/devformance/install/install_generator.rb
+- lib/generators/devformance/install/templates/add_columns_to_slow_queries.rb.erb
+- lib/generators/devformance/install/templates/add_run_id_to_slow_queries.rb.erb
+- lib/generators/devformance/install/templates/create_devformance_file_results.rb.erb
+- lib/generators/devformance/install/templates/create_devformance_runs.rb.erb
+- lib/generators/devformance/install/templates/create_performance_runs.rb.erb
+- lib/generators/devformance/install/templates/create_slow_queries.rb.erb
+- lib/generators/devformance/install/templates/initializer.rb
+- lib/tasks/devformance.rake
+- spec/fixtures/devformance/devformance_run.rb
+- spec/fixtures/devformance/file_result.rb
+- spec/fixtures/devformance/slow_query.rb
+- spec/lib/devmetrics/log_writer_spec.rb
+- spec/lib/devmetrics/run_orchestrator_spec.rb
+- spec/lib/devmetrics/sql_instrumentor_spec.rb
+- spec/models/devmetrics/file_result_spec.rb
+- spec/models/devmetrics/run_spec.rb
+- spec/models/query_log_spec.rb
+- spec/rails_helper.rb
+- spec/requests/devmetrics/metrics_controller_spec.rb
+- spec/requests/devmetrics_pages_spec.rb
+- spec/requests/performance_spec.rb
+- spec/requests/slow_perf_spec.rb
+- spec/spec_helper.rb
+- spec/support/devmetrics_formatter.rb
+- spec/support/devmetrics_metrics.rb
+- spec/support/factory_bot.rb
+homepage: https://github.com/yourusername/devformance
+licenses:
+- MIT
+metadata: {}
+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.6.7
+specification_version: 4
+summary: Real-time Rails performance dashboard
+test_files: []