dbwatcher 0.1.5

data/lib/dbwatcher/tracker.rb

@@ -0,0 +1,112 @@
+# frozen_string_literal: true
+
+module Dbwatcher
+  class Tracker
+    class << self
+      def track(name: nil, metadata: {}, &block)
+        return yield unless Dbwatcher.configuration.enabled
+
+        session = create_session(name, metadata)
+        Thread.current[:dbwatcher_session] = session
+
+        execute_with_session(session, &block)
+      ensure
+        Thread.current[:dbwatcher_session] = nil
+      end
+
+      def current_session
+        Thread.current[:dbwatcher_session]
+      end
+
+      def record_change(change)
+        session = current_session
+        return unless session && change.is_a?(Hash)
+
+        session.changes << change
+      rescue StandardError => e
+        warn "Failed to record change: #{e.message}"
+      end
+
+      private
+
+      def create_session(name, metadata)
+        Session.new(
+          id: SecureRandom.uuid,
+          name: name || "Session #{Time.now.strftime("%Y-%m-%d %H:%M:%S")}",
+          metadata: metadata || {},
+          started_at: Time.now.strftime("%Y-%m-%dT%H:%M:%S%z"),
+          changes: []
+        )
+      end
+
+      def execute_with_session(session, &block)
+        result = block.call
+        finalize_session(session)
+        result
+      rescue StandardError => e
+        finalize_session(session)
+        raise e
+      end
+
+      def finalize_session(session)
+        session.ended_at = Time.now.strftime("%Y-%m-%dT%H:%M:%S%z")
+        Storage.save_session(session)
+      rescue StandardError
+        nil
+      end
+    end
+
+    class Session
+      attr_accessor :id, :name, :metadata, :started_at, :ended_at, :changes
+
+      def initialize(attrs = {})
+        # Set default values
+        @changes = []
+        @metadata = {}
+
+        # Set provided attributes
+        attrs.each do |key, value|
+          setter_method = "#{key}="
+          send(setter_method, value) if respond_to?(setter_method)
+        end
+      end
+
+      def to_h
+        {
+          id: id,
+          name: name,
+          metadata: metadata,
+          started_at: started_at,
+          ended_at: ended_at,
+          changes: changes
+        }
+      end
+
+      def summary
+        return {} unless changes.is_a?(Array)
+
+        valid_changes = filter_valid_changes
+        group_changes_by_operation(valid_changes)
+      rescue StandardError => e
+        warn "Failed to calculate session summary: #{e.message}"
+        {}
+      end
+
+      private
+
+      def filter_valid_changes
+        changes.select { |change| valid_change?(change) }
+      end
+
+      def valid_change?(change)
+        change.is_a?(Hash) && change[:table_name] && change[:operation]
+      end
+
+      def group_changes_by_operation(valid_changes)
+        valid_changes
+          .group_by { |change| "#{change[:table_name]},#{change[:operation]}" }
+          .transform_values(&:count)
+      end
+    end
+  end
+end

data/lib/dbwatcher/version.rb

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

data/lib/dbwatcher.rb

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+require "json"
+require "fileutils"
+require "securerandom"
+require_relative "dbwatcher/version"
+require_relative "dbwatcher/configuration"
+require_relative "dbwatcher/tracker"
+require_relative "dbwatcher/storage"
+require_relative "dbwatcher/model_extension"
+require_relative "dbwatcher/middleware"
+require_relative "dbwatcher/engine" if defined?(Rails)
+
+module Dbwatcher
+  class Error < StandardError; end
+
+  class << self
+    attr_writer :configuration
+
+    def configuration
+      @configuration ||= Configuration.new
+    end
+
+    def configure
+      yield(configuration)
+    end
+
+    def track(name: nil, metadata: {}, &block)
+      Tracker.track(name: name, metadata: metadata, &block)
+    end
+
+    def current_session
+      Tracker.current_session
+    end
+
+    def reset!
+      Storage.reset!
+    end
+  end
+end

metadata

@@ -0,0 +1,198 @@
+--- !ruby/object:Gem::Specification
+name: dbwatcher
+version: !ruby/object:Gem::Version
+  version: 0.1.5
+platform: ruby
+authors:
+- Huy Nguyen
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2025-06-15 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '6.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '6.0'
+- !ruby/object:Gem::Dependency
+  name: capybara
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: cucumber-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.1'
+- !ruby/object:Gem::Dependency
+  name: database_cleaner-active_record
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: rspec-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '6.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '6.0'
+- !ruby/object:Gem::Dependency
+  name: selenium-webdriver
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+- !ruby/object:Gem::Dependency
+  name: sprockets-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.4'
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.4'
+- !ruby/object:Gem::Dependency
+  name: webrick
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+description: DB Watcher helps developers debug Rails applications by tracking all
+  database changes
+email:
+- patrick204nqh@gmail.com
+executables:
+- console
+- release
+- setup
+extensions: []
+extra_rdoc_files: []
+files:
+- README.md
+- Rakefile
+- app/controllers/dbwatcher/sessions_controller.rb
+- app/views/dbwatcher/sessions/index.html.erb
+- app/views/dbwatcher/sessions/show.html.erb
+- app/views/layouts/dbwatcher/application.html.erb
+- bin/console
+- bin/release
+- bin/setup
+- config/routes.rb
+- lib/dbwatcher.rb
+- lib/dbwatcher/configuration.rb
+- lib/dbwatcher/engine.rb
+- lib/dbwatcher/middleware.rb
+- lib/dbwatcher/model_extension.rb
+- lib/dbwatcher/storage.rb
+- lib/dbwatcher/tracker.rb
+- lib/dbwatcher/version.rb
+homepage: https://github.com/patrick204nqh/dbwatcher
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+  homepage_uri: https://github.com/patrick204nqh/dbwatcher
+  source_code_uri: https://github.com/patrick204nqh/dbwatcher
+  changelog_uri: https://github.com/patrick204nqh/dbwatcher/blob/main/CHANGELOG.md
+  documentation_uri: https://github.com/patrick204nqh/dbwatcher/blob/main/README.md
+  bug_tracker_uri: https://github.com/patrick204nqh/dbwatcher/issues
+  rubygems_mfa_required: 'true'
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.1.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.5.22
+signing_key:
+specification_version: 4
+summary: Track and visualize database changes in Rails applications
+test_files: []