rails_spotlight 0.2.0 → 0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: df87e15beee1f5b3706be05e0e6642d56165eeb7ae667cab7dad6514abcfe728
-  data.tar.gz: 50d7dc4b7cefae1cf565f021aea4d398757ff6a09bd5bdce3dd8e2b56ed24cee
+  metadata.gz: 41eb3756c5f0405d7811d039c0953ac3a62b993486a4fc2e2085686c8c9cd54b
+  data.tar.gz: fd0d5d64ff53a660ade6867f05c152e36cd228ccb02b1d9006c3e4be8ed8e6cd
 SHA512:
-  metadata.gz: e5050e1f700b52d97e62cf26d1fc1cd37f2f5eb1fe5ffc815f030aea8a67e137b0eb4030aff8ca52c06586e754f327477a6ae93fe3502d2e876e2c6e61de9333
-  data.tar.gz: 0ae4a9d1b8d806f0c8bc33297c3d941e683c4d7731a672a4804889a3700b65229fd2334a35ca94874ec0ba76a1a820a549ffddff05c8f651753ed6e6b6e32f27
+  metadata.gz: d3159584ad8395c2ea3a17fb969cd9a50c94a120c0db950ff11db8d52ce3357f443c7944a23dc8dc3521844f98e6cdc30da288f53a08e6308f8722c53a85907b
+  data.tar.gz: 2057d0386f21959a19b229ca2f3b4e46db2a0270d1c8f1262f551363eeda54c7127bc3b78c1c209b6e949a62dc2ce1c82989b17650eaa7c6dc02bb99874f3389

data/README.md

@@ -45,6 +45,18 @@ file will be created in `config/rails_spotlight.yml`
   ACTION_CABLE_MOUNT_PATH: /cable
 ```
 
+## Troubleshooting
+
+Known issue:
+
+Authentication error when using: 
+  - Specific authentication method and action cable
+  - AUTO_MOUNT_ACTION_CABLE: true
+
+Solution:
+  - Set AUTO_MOUNT_ACTION_CABLE: false
+  - Add manually `mount ActionCable.server => '/cable'` to `config/routes.rb` with proper authentication method
+
 ## Testing
 
 To run tests for all versions of Rails and Ruby, run:
@@ -55,19 +67,9 @@ docker-compose up
 
 ## Usage
 
-## Development
-
-## Contributing
-
-Bug reports and pull requests are welcome on GitHub at https://github.com/pniemczyk/rails_spotlight. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/[USERNAME]/rails_spotlight/blob/master/CODE_OF_CONDUCT.md).
+Gem is created for the Chrome extension [Rails Spotlight](https://chrome.google.com/webstore/detail/rails-spotlight/kfacifkandemkdemkliponofajohhnbp?hl=en-US), but it can be used for any purpose.
 
 ## License
 
 The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
 
-## Code of Conduct
-
-Everyone interacting in the RailsSpotlight project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/pniemczyk/rails_spotlight/blob/master/CODE_OF_CONDUCT.md).
-
-
-check https://github.com/alexrudall/ruby-openai

data/lib/rails_spotlight/configuration.rb

@@ -19,11 +19,11 @@ module RailsSpotlight
       @logger = opts[:logger] || Logger.new(File.join(self.class.rails_root, 'log', 'rails_spotlight.log'))
       @storage_path = opts[:storage_path] || File.join(self.class.rails_root, 'tmp', 'data', 'rails_spotlight')
       @storage_pool_size = opts[:storage_pool_size] || 20
-      @live_console_enabled = opts[:live_console_enabled] || true
-      @request_completed_broadcast_enabled = opts[:request_completed_broadcast_enabled] || false
+      @live_console_enabled = opts[:live_console_enabled].nil? ? true : is_true?(opts[:live_console_enabled])
+      @request_completed_broadcast_enabled = is_true?(opts[:request_completed_broadcast_enabled])
       @middleware_skipped_paths = opts[:middleware_skipped_paths] || []
       @not_encodable_event_values = DEFAULT_NOT_ENCODABLE_EVENT_VALUES.merge(opts[:not_encodable_event_values] || {})
-      @auto_mount_action_cable = opts[:auto_mount_action_cable] || true
+      @auto_mount_action_cable = opts[:auto_mount_action_cable].nil? ? true : is_true?(opts[:auto_mount_action_cable])
       @action_cable_mount_path = opts[:action_cable_mount_path] || '/cable'
     end
 
@@ -54,9 +54,10 @@ module RailsSpotlight
       return new unless File.exist?(config_file)
 
       erb_result = ERB.new(File.read(config_file)).result
-      config = YAML.safe_load(erb_result) || {}
+      data = YAML.safe_load(erb_result) || {}
+
       # Support older versions of Ruby and Rails
-      opts = config.each_with_object({}) do |(key, value), memo|
+      opts = data.each_with_object({}) do |(key, value), memo|
         new_key = key.is_a?(String) ? key.downcase.to_sym : key
         memo[new_key] = value
       end
@@ -74,6 +75,10 @@ module RailsSpotlight
 
     private
 
+    def is_true?(value)
+      value == true || value == 'true' || value == 1 || value == '1'
+    end
+
     def detect_project_name
       return ENV['RAILS_SPOTLIGHT_PROJECT'] if ENV['RAILS_SPOTLIGHT_PROJECT'].present?
 

data/lib/rails_spotlight/event.rb

@@ -63,30 +63,14 @@ module RailsSpotlight
     end
 
     def transform_hash(original, options = {}, &block)
-      # options[:safe_descent] ||= {}
-      # new_hash = {}
-      # options[:safe_descent][original.object_id] = new_hash
-      # original.each_with_object(new_hash) do |(key, value), result|
-      #   if options[:deep] && Hash === value
-      #     value = options[:safe_descent].fetch(value.object_id) do
-      #       transform_hash(value, options, &block)
-      #     end
-      #   end
-      #   block.call(result, key, value)
-      # end
-
-      # Initialize safe_descent hash to keep track of hashes already transformed.
-      # options[:safe_descent] ||= {}
       options[:safe_descent] ||= {}.compare_by_identity
 
       # Check if the hash has already been transformed to prevent infinite recursion.
-      # return options[:safe_descent][original.object_id] if options[:safe_descent].key?(original.object_id)
       return options[:safe_descent][original] if options[:safe_descent].key?(original)
 
       # Create a new hash to store the transformed values.
       new_hash = {}
       # Store the new hash in safe_descent using the original's object_id to mark it as processed.
-      # options[:safe_descent][original.object_id] = new_hash
       options[:safe_descent][original] = new_hash
 
       # Iterate over each key-value pair in the original hash.
@@ -94,7 +78,6 @@ module RailsSpotlight
         # If deep transformation is required and the value is a hash,
         # recursively transform it, unless it's already been transformed.
         if options[:deep] && Hash === value # rubocop:disable Style/CaseEquality
-          # value = options[:safe_descent].fetch(value.object_id) do
           value = options[:safe_descent].fetch(value) do
             transform_hash(value, options, &block)
           end

data/lib/rails_spotlight/railtie.rb

@@ -5,7 +5,7 @@ require 'rails/railtie'
 module RailsSpotlight
   class Railtie < ::Rails::Railtie
     initializer 'rails_spotlight.inject_middlewares' do
-      insert_middleware unless Rails.env.production?
+      insert_base_middlewares unless Rails.env.production?
     end
 
     initializer 'rails_spotlight.log_interceptor' do
@@ -17,19 +17,28 @@ module RailsSpotlight
     end
 
     initializer 'rails_spotlight.action_cable_setup' do
-      unless Rails.env.production?
-        app.config.after_initialize do
-          existing_origins = Array(app.config.action_cable.allowed_request_origins)
-          app.config.action_cable.allowed_request_origins = existing_origins | [%r{\Achrome-extension://.*\z}]
-
-          require 'rails_spotlight/channels/request_completed_channel' if ::RailsSpotlight.config.request_completed_broadcast_enabled?
-          require 'rails_spotlight/channels/live_console_channel' if ::RailsSpotlight.config.live_console_enabled?
-          Rails.application.routes.draw { mount ActionCable.server => '/cable' } if ::RailsSpotlight.config.auto_mount_action_cable?
-        end
+      insert_action_cable_helpers unless Rails.env.production?
+    end
+
+    def insert_action_cable_helpers
+      return unless ::RailsSpotlight.config.action_cable_present?
+
+      app.config.after_initialize do
+        update_actioncable_allowed_request_origins!
+
+        require 'rails_spotlight/channels/request_completed_channel' if ::RailsSpotlight.config.request_completed_broadcast_enabled?
+        require 'rails_spotlight/channels/live_console_channel' if ::RailsSpotlight.config.live_console_enabled?
+
+        app.routes.draw { mount ActionCable.server => '/cable' } if ::RailsSpotlight.config.auto_mount_action_cable?
       end
     end
 
-    def insert_middleware
+    def update_actioncable_allowed_request_origins!
+      existing_origins = Array(app.config.action_cable.allowed_request_origins)
+      app.config.action_cable.allowed_request_origins = existing_origins | [%r{\Achrome-extension://.*\z}]
+    end
+
+    def insert_base_middlewares
       app.middleware.use ::RailsSpotlight::Middlewares::RequestHandler
 
       if defined? ActionDispatch::DebugExceptions

data/lib/rails_spotlight/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module RailsSpotlight
-  VERSION = '0.2.0'
+  VERSION = '0.2.1'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rails_spotlight
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.2.1
 platform: ruby
 authors:
 - Pawel Niemczyk
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-01-28 00:00:00.000000000 Z
+date: 2024-02-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rack-contrib