rails_spotlight 0.1.0 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 52e5d7e1fba61276ede96f911afffadec04140d81c77096c4e79e695d4d25482
-  data.tar.gz: 6e3fab91311760f4f37788b787e675040df48eabe187dfdb70307a8bd06130e4
+  metadata.gz: 4f1b6f06197af1c1897a968d29834f8d4903ad506f814761960020aa99120944
+  data.tar.gz: 2e71488c1baa2106f146ed9f825508c965f1d370ee2d8cbbdd8564d90a632a7f
 SHA512:
-  metadata.gz: d1fe8120e70db0b364bceb63b1dbd2585fb7725209822bbc458533e1a1ab05abef3ede5fcb14652dc8a38b7b92a08e2a29029197e1d4b7981c78d95531effa03
-  data.tar.gz: ac8ef6112a2f715932ed4c8c4328ff2c570235917b1e915ca978a1d136aded36916c59f49c835ac10e54b600e471c9842ec6acac735d3b9f37c3288950227a6a
+  metadata.gz: 6e914a9fc7318521403dc19c585935b79154398b747a60fb45eb7fc079ff9220a5e188cdb0a744da42214363497fccf97ad24d16c524dcea69a731d4057095ce
+  data.tar.gz: 17244e465089b317de22af0038d6f855eb132256110f67e2691c503d32e3a54c27f7e4faa3ca847655202555a865d3c1881aebd9a094816fd2b89c674a026671

data/.rubocop.yml

@@ -1,7 +1,10 @@
 AllCops:
-  TargetRubyVersion: 3.2
+  TargetRubyVersion: 2.0
   DefaultFormatter: progress
-  SuggestExtensions: true
+  SuggestExtensions:
+    rubocop-rake: true
+    rubocop-rspec: true
+
   NewCops: enable
 
 Style/StringLiterals:
@@ -35,3 +38,6 @@ Layout/HashAlignment:
   EnforcedHashRocketStyle: table
   EnforcedColonStyle: table
   EnforcedLastArgumentHashStyle: always_inspect
+
+Style/Documentation:
+  Enabled: false

data/Gemfile.lock

@@ -1,19 +1,111 @@
 PATH
   remote: .
   specs:
-    rails_spotlight (0.1.0)
+    rails_spotlight (0.1.2)
+      meta_request (~> 0.7)
+      rack-contrib (>= 1.1, < 3)
+      railties (>= 3.0.0, < 7.1)
 
 GEM
   remote: https://rubygems.org/
   specs:
+    actionpack (7.0.4.3)
+      actionview (= 7.0.4.3)
+      activesupport (= 7.0.4.3)
+      rack (~> 2.0, >= 2.2.0)
+      rack-test (>= 0.6.3)
+      rails-dom-testing (~> 2.0)
+      rails-html-sanitizer (~> 1.0, >= 1.2.0)
+    actionview (7.0.4.3)
+      activesupport (= 7.0.4.3)
+      builder (~> 3.1)
+      erubi (~> 1.4)
+      rails-dom-testing (~> 2.0)
+      rails-html-sanitizer (~> 1.1, >= 1.2.0)
+    activesupport (7.0.4.3)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 1.6, < 2)
+      minitest (>= 5.1)
+      tzinfo (~> 2.0)
     ast (2.4.2)
+    awesome_print (1.9.2)
+    builder (3.2.4)
+    coderay (1.1.3)
+    concurrent-ruby (1.2.2)
+    crass (1.0.6)
     diff-lcs (1.5.0)
+    erubi (1.12.0)
+    ffi (1.15.5)
+    formatador (1.1.0)
+    guard (2.18.0)
+      formatador (>= 0.2.4)
+      listen (>= 2.7, < 4.0)
+      lumberjack (>= 1.0.12, < 2.0)
+      nenv (~> 0.1)
+      notiffany (~> 0.0)
+      pry (>= 0.13.0)
+      shellany (~> 0.0)
+      thor (>= 0.18.1)
+    guard-compat (1.2.1)
+    guard-rspec (4.7.3)
+      guard (~> 2.1)
+      guard-compat (~> 1.1)
+      rspec (>= 2.99.0, < 4.0)
+    guard-rubocop (1.5.0)
+      guard (~> 2.0)
+      rubocop (< 2.0)
+    i18n (1.12.0)
+      concurrent-ruby (~> 1.0)
     json (2.6.3)
+    listen (3.8.0)
+      rb-fsevent (~> 0.10, >= 0.10.3)
+      rb-inotify (~> 0.9, >= 0.9.10)
+    loofah (2.19.1)
+      crass (~> 1.0.2)
+      nokogiri (>= 1.5.9)
+    lumberjack (1.2.8)
+    meta_request (0.7.4)
+      rack-contrib (>= 1.1, < 3)
+      railties (>= 3.0.0, < 7.1)
+    method_source (1.0.0)
+    mini_portile2 (2.8.1)
+    minitest (5.18.0)
+    nenv (0.3.0)
+    nokogiri (1.14.2)
+      mini_portile2 (~> 2.8.0)
+      racc (~> 1.4)
+    notiffany (0.1.3)
+      nenv (~> 0.1)
+      shellany (~> 0.0)
     parallel (1.22.1)
     parser (3.2.1.1)
       ast (~> 2.4.1)
+    pry (0.14.2)
+      coderay (~> 1.1)
+      method_source (~> 1.0)
+    racc (1.6.2)
+    rack (2.2.6.4)
+    rack-contrib (2.3.0)
+      rack (~> 2.0)
+    rack-test (2.1.0)
+      rack (>= 1.3)
+    rails-dom-testing (2.0.3)
+      activesupport (>= 4.2.0)
+      nokogiri (>= 1.6)
+    rails-html-sanitizer (1.5.0)
+      loofah (~> 2.19, >= 2.19.1)
+    railties (7.0.4.3)
+      actionpack (= 7.0.4.3)
+      activesupport (= 7.0.4.3)
+      method_source
+      rake (>= 12.2)
+      thor (~> 1.0)
+      zeitwerk (~> 2.5)
     rainbow (3.1.1)
     rake (13.0.6)
+    rb-fsevent (0.11.2)
+    rb-inotify (0.10.1)
+      ffi (~> 1.0)
     regexp_parser (2.6.2)
     rexml (3.2.5)
     rspec (3.12.0)
@@ -42,12 +134,21 @@ GEM
     rubocop-ast (1.24.1)
       parser (>= 3.1.1.0)
     ruby-progressbar (1.11.0)
+    shellany (0.0.1)
+    thor (1.2.1)
+    tzinfo (2.0.6)
+      concurrent-ruby (~> 1.0)
     unicode-display_width (2.4.2)
+    zeitwerk (2.6.7)
 
 PLATFORMS
   ruby
 
 DEPENDENCIES
+  awesome_print (~> 1.6)
+  guard (~> 2.12)
+  guard-rspec (~> 4.5)
+  guard-rubocop (~> 1.2)
   rails_spotlight!
   rake (~> 13.0)
   rspec (~> 3.0)

data/Guardfile

@@ -0,0 +1,11 @@
+guard :rspec, cmd: 'rspec' do
+  watch(%r{^lib/(.+).rb$})      { |m| "spec/lib/#{m[1]}_spec.rb" }
+  watch(%r{^spec/(.+).rb$})     { |m| "spec/#{m[1]}.rb" }
+  watch('spec/spec_helper.rb')  { 'spec' }
+  watch('Gemfile')
+end
+
+guard :rubocop, all_on_start: false, cli: ['--format', 'clang'] do
+  watch(/.+\.rb$/)
+  watch(%r{(?:.+/)?\.rubocop\.yml$}) { |m| File.dirname(m[0]) }
+end

data/README.md

@@ -17,3 +17,6 @@ The gem is available as open source under the terms of the [MIT License](https:/
 ## 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/middlewares/handlers/base_action_handler.rb

@@ -0,0 +1,93 @@
+module RailsSpotlight
+  module Middlewares
+    module Handlers
+      class BaseActionHandler
+        IncorrectResponseContentType = Class.new(StandardError)
+        NotFound = Class.new(StandardError)
+        UnprocessableEntity = Class.new(StandardError)
+
+        def initialize(request_id, request, content_type)
+          @request_id = request_id
+          @request = request
+          @content_type = content_type
+        end
+
+        attr_reader :request_id, :request, :content_type
+
+        def call
+          execute
+          response
+        rescue NotFound => e
+          not_found_response(e.message)
+        rescue UnprocessableEntity => e
+          unprocessed_response(e.message)
+        rescue => e # rubocop:disable Style/RescueStandardError
+          internal_server_error_response(e.message)
+        end
+
+        protected
+
+        attr_writer :status, :headers
+
+        def headers
+          @headers ||= {}
+        end
+
+        def status
+          @status ||= 200
+        end
+
+        def execute
+          raise 'Not implemented yet'
+        end
+
+        def json_response_body
+          raise IncorrectResponseContentType, content_type
+        end
+
+        def text_response_body
+          raise IncorrectResponseContentType, content_type
+        end
+
+        def json_request_body
+          @json_request_body ||= JSON.parse(request.body.read)
+        rescue JSON::ParserError
+          raise 'Invalid JSON'
+        end
+
+        def internal_server_error_response(message)
+          response(500, message_to_body(message))
+        end
+
+        def unprocessed_response(message)
+          response(422, message_to_body(message))
+        end
+
+        def not_found_response(message)
+          response(404, message_to_body(message))
+        end
+
+        def message_to_body(message)
+          content_type == :json ? { message: message } : message
+        end
+
+        def response_headers(headers = {})
+          {
+            'Content-Type' => content_type == :json ? 'application/json; charset=utf-8' : 'text/plain; charset=utf-8',
+            'X-Rails-Spotlight' => '1.0.0',
+            'X-Request-Id' => request_id
+          }.merge(headers)
+        end
+
+        def response(overridden_status = nil, overridden_body = nil)
+          body = if overridden_body.present?
+                   content_type == :json ? overridden_body.to_json : overridden_body
+                 else
+                   content_type == :json ? json_response_body.to_json : text_response_body
+                 end
+          [overridden_status.present? ? overridden_status : status, response_headers(headers), [body]]
+        end
+      end
+    end
+  end
+end

data/lib/rails_spotlight/middlewares/handlers/file_action_handler.rb

@@ -0,0 +1,41 @@
+module RailsSpotlight
+  module Middlewares
+    module Handlers
+      class FileActionHandler < BaseActionHandler
+        def execute
+          raise NotFound, 'File not found' unless path_valid?
+
+          File.write(file_path, json_request_body.fetch('content')) if write_mode?
+        rescue => e # rubocop:disable Style/RescueStandardError
+          raise UnprocessableEntity, e.message
+        end
+
+        private
+
+        def text_response_body
+          File.read(file_path)
+        end
+
+        def json_response_body
+          { source: text_response_body }
+        end
+
+        def write_mode?
+          request_mode == 'write'
+        end
+
+        def request_mode
+          @request_mode ||= json_request_body.fetch('mode') { 'read' }
+        end
+
+        def path_valid?
+          file_path.to_s.include?(Rails.root.to_s) && File.exist?(file_path)
+        end
+
+        def file_path
+          @file_path ||= Rails.root.join(json_request_body.fetch('file'))
+        end
+      end
+    end
+  end
+end

data/lib/rails_spotlight/middlewares/handlers/not_found_action_handler.rb

@@ -0,0 +1,11 @@
+module RailsSpotlight
+  module Middlewares
+    module Handlers
+      class NotFoundActionHandler < BaseActionHandler
+        def execute
+          raise NotFound, 'Not found'
+        end
+      end
+    end
+  end
+end

data/lib/rails_spotlight/middlewares/handlers/sql_action_handler.rb

@@ -0,0 +1,37 @@
+module RailsSpotlight
+  module Middlewares
+    module Handlers
+      class SqlActionHandler < BaseActionHandler
+        def execute
+          ActiveSupport::Notifications.subscribed(method(:logger), 'sql.active_record', monotonic: true) do
+            ActiveSupport::ExecutionContext.set(rails_spotlight: request_id) do
+              self.result = ActiveRecord::Base.connection.exec_query(query)
+            end
+          end
+        end
+
+        private
+
+        attr_accessor :result
+
+        def json_response_body
+          { result: result, logs: logs }
+        end
+
+        def logger(_, started, finished, unique_id, payload)
+          logs << { time: started, end: finished, unique_id: unique_id }.merge(
+            payload.as_json(except: %i[connection method name filename line])
+          )
+        end
+
+        def logs
+          @logs ||= []
+        end
+
+        def query
+          @query ||= json_request_body.fetch('query')
+        end
+      end
+    end
+  end
+end

data/lib/rails_spotlight/middlewares/handlers/verify_action_handler.rb

@@ -0,0 +1,25 @@
+module RailsSpotlight
+  module Middlewares
+    module Handlers
+      class VerifyActionHandler < BaseActionHandler
+        def execute; end
+
+        private
+
+        def text_response_body
+          "Rails Spotlight is working!\nRails version: #{Rails.version}\nRails environment: #{Rails.env}"
+        end
+
+        def json_response_body
+          {
+            params: request.params,
+            body: request.body.read,
+            content_type: request.content_type,
+            request_method: request.request_method,
+            version: request.get_header('HTTP_X_RAILS_SPOTLIGHT')
+          }
+        end
+      end
+    end
+  end
+end

data/lib/rails_spotlight/middlewares/request_handler.rb

@@ -0,0 +1,38 @@
+require_relative 'handlers/base_action_handler'
+require_relative 'handlers/file_action_handler'
+require_relative 'handlers/sql_action_handler'
+require_relative 'handlers/verify_action_handler'
+require_relative 'handlers/not_found_action_handler'
+
+module RailsSpotlight
+  module Middlewares
+    class RequestHandler
+      def initialize(app)
+        @app = app
+      end
+
+      def call(env)
+        path_info = env['PATH_INFO']
+        action, content_type = path_info.match(%r{/__rails_spotlight/(.+)\.(\w+)$}).try(:captures)
+        return handle(Rack::Request.new(env), action, content_type.try(:to_sym)) if action
+
+        app.call(env)
+      end
+
+      private
+
+      attr_reader :app
+
+      def handle(request, action, content_type = :json)
+        args = [SecureRandom.uuid, request, content_type]
+        case action
+        when 'file' then Handlers::FileActionHandler.new(*args).call
+        when 'sql' then Handlers::SqlActionHandler.new(*args).call
+        when 'verify' then Handlers::VerifyActionHandler.new(*args).call
+        else
+          Handlers::NotFoundActionHandler.new(*args).call
+        end
+      end
+    end
+  end
+end

data/lib/rails_spotlight/railtie.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+require 'rails/railtie'
+require 'meta_request'
+
+module RailsSpotlight
+  class Railtie < ::Rails::Railtie
+    initializer 'rails_spotlight.inject_middlewares' do
+      insert_middleware unless Rails.env.production?
+    end
+
+    # initializer 'rails_spotlight.log_interceptor' do
+    #   Rails.logger&.extend(LogInterceptor)
+    # end
+    #
+    # initializer 'rails_spotlight.subscribe_to_notifications' do
+    #   AppNotifications.subscribe
+    # end
+
+    def insert_middleware
+      if defined? ActionDispatch::DebugExceptions
+        app.middleware.insert_before ActionDispatch::DebugExceptions, RailsSpotlight::Middlewares::RequestHandler
+      else
+        app.middleware.use RailsSpotlight::Middlewares::RequestHandler
+      end
+    end
+
+    def app
+      Rails.application
+    end
+  end
+end

data/lib/rails_spotlight/version.rb

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

data/lib/rails_spotlight.rb

@@ -1,8 +1,9 @@
 # frozen_string_literal: true
 
 require_relative 'rails_spotlight/version'
+require_relative 'rails_spotlight/middlewares/request_handler'
 
 module RailsSpotlight
-  class Error < StandardError; end
-  # Your code goes here...
 end
+
+require_relative 'rails_spotlight/railtie'

metadata

@@ -1,15 +1,153 @@
 --- !ruby/object:Gem::Specification
 name: rails_spotlight
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.2
 platform: ruby
 authors:
 - Pawel Niemczyk
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-03-19 00:00:00.000000000 Z
-dependencies: []
+date: 2023-04-07 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rack-contrib
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.1'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.1'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '3'
+- !ruby/object:Gem::Dependency
+  name: railties
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '7.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '7.1'
+- !ruby/object:Gem::Dependency
+  name: meta_request
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.7'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.7'
+- !ruby/object:Gem::Dependency
+  name: awesome_print
+  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: guard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.12'
+- !ruby/object:Gem::Dependency
+  name: guard-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.5'
+- !ruby/object:Gem::Dependency
+  name: guard-rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.8.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.8.0
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.74.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.74.0
 description: Lets have a look at your rails application in details
 email:
 - pniemczyk.info@gmail.com
@@ -24,11 +162,19 @@ files:
 - CODE_OF_CONDUCT.md
 - Gemfile
 - Gemfile.lock
+- Guardfile
 - LICENSE.txt
 - README.md
 - Rakefile
 - exe/rails_spotlight
 - lib/rails_spotlight.rb
+- lib/rails_spotlight/middlewares/handlers/base_action_handler.rb
+- lib/rails_spotlight/middlewares/handlers/file_action_handler.rb
+- lib/rails_spotlight/middlewares/handlers/not_found_action_handler.rb
+- lib/rails_spotlight/middlewares/handlers/sql_action_handler.rb
+- lib/rails_spotlight/middlewares/handlers/verify_action_handler.rb
+- lib/rails_spotlight/middlewares/request_handler.rb
+- lib/rails_spotlight/railtie.rb
 - lib/rails_spotlight/version.rb
 - sig/rails_spotlight.rbs
 homepage: https://github.com/pniemczyk/rails_spotlight
@@ -38,6 +184,7 @@ metadata:
   homepage_uri: https://github.com/pniemczyk/rails_spotlight
   source_code_uri: https://github.com/pniemczyk/rails_spotlight
   changelog_uri: https://github.com/pniemczyk/rails_spotlight/blob/master/CHANGELOG.md
+  rubygems_mfa_required: 'true'
 post_install_message:
 rdoc_options: []
 require_paths:
@@ -46,7 +193,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 3.2.0
+      version: 2.0.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="