better_rails_debugger 0.0.1

data/config/initializers/setup.rb

@@ -0,0 +1,10 @@
+Rails.application.config.assets.precompile += %w(
+better_rails_debugger/jquery.min.js
+better_rails_debugger/bootstrap.min.js
+better_rails_debugger/moment.min.js
+better_rails_debugger/place.min.js
+better_rails_debugger/popper.min.js
+better_rails_debugger/Chart.min.js
+better_rails_debugger/prism.css
+better_rails_debugger/prism.js
+)

data/config/mongoid.yml

@@ -0,0 +1,160 @@
+development:
+  # Configure available database clients. (required)
+  clients:
+    # Defines the default client. (required)
+    default:
+      # Defines the name of the default database that Mongoid can connect to.
+      # (required).
+      database: dummy_development
+      # Provides the hosts the default client can connect to. Must be an array
+      # of host:port pairs. (required)
+      hosts:
+        - localhost:27017
+      options:
+        # Change the default write concern. (default = { w: 1 })
+        # write:
+        #   w: 1
+
+        # Change the default read preference. Valid options for mode are: :secondary,
+        # :secondary_preferred, :primary, :primary_preferred, :nearest
+        # (default: primary)
+        # read:
+        #   mode: :secondary_preferred
+        #   tag_sets:
+        #     - use: web
+
+        # The name of the user for authentication.
+        # user: 'user'
+
+        # The password of the user for authentication.
+        # password: 'password'
+
+        # The user's database roles.
+        # roles:
+        #   - 'dbOwner'
+
+        # Change the default authentication mechanism. Valid options are: :scram,
+        # :mongodb_cr, :mongodb_x509, and :plain. Note that all authentication
+        # mechanisms require username and password, with the exception of :mongodb_x509.
+        # Default on mongoDB 3.0 is :scram, default on 2.4 and 2.6 is :plain.
+        # auth_mech: :scram
+
+        # The database or source to authenticate the user against.
+        # (default: the database specified above or admin)
+        # auth_source: admin
+
+        # Force a the driver cluster to behave in a certain manner instead of auto-
+        # discovering. Can be one of: :direct, :replica_set, :sharded. Set to :direct
+        # when connecting to hidden members of a replica set.
+        # connect: :direct
+
+        # Changes the default time in seconds the server monitors refresh their status
+        # via ismaster commands. (default: 10)
+        # heartbeat_frequency: 10
+
+        # The time in seconds for selecting servers for a near read preference. (default: 0.015)
+        # local_threshold: 0.015
+
+        # The timeout in seconds for selecting a server for an operation. (default: 30)
+        # server_selection_timeout: 30
+
+        # The maximum number of connections in the connection pool. (default: 5)
+        # max_pool_size: 5
+
+        # The minimum number of connections in the connection pool. (default: 1)
+        # min_pool_size: 1
+
+        # The time to wait, in seconds, in the connection pool for a connection
+        # to be checked in before timing out. (default: 5)
+        # wait_queue_timeout: 5
+
+        # The time to wait to establish a connection before timing out, in seconds.
+        # (default: 5)
+        # connect_timeout: 5
+
+        # The timeout to wait to execute operations on a socket before raising an error.
+        # (default: 5)
+        # socket_timeout: 5
+
+        # The name of the replica set to connect to. Servers provided as seeds that do
+        # not belong to this replica set will be ignored.
+        # replica_set: name
+
+        # Whether to connect to the servers via ssl. (default: false)
+        # ssl: true
+
+        # The certificate file used to identify the connection against MongoDB.
+        # ssl_cert: /path/to/my.cert
+
+        # The private keyfile used to identify the connection against MongoDB.
+        # Note that even if the key is stored in the same file as the certificate,
+        # both need to be explicitly specified.
+        # ssl_key: /path/to/my.key
+
+        # A passphrase for the private key.
+        # ssl_key_pass_phrase: password
+
+        # Whether or not to do peer certification validation. (default: true)
+        # ssl_verify: true
+
+        # The file containing a set of concatenated certification authority certifications
+        # used to validate certs passed from the other end of the connection.
+        # ssl_ca_cert: /path/to/ca.cert
+
+
+  # Configure Mongoid specific options. (optional)
+  options:
+    # Includes the root model name in json serialization. (default: false)
+    # include_root_in_json: false
+
+    # Include the _type field in serialization. (default: false)
+    # include_type_for_serialization: false
+
+    # Preload all models in development, needed when models use
+    # inheritance. (default: false)
+    # preload_models: false
+
+    # Raise an error when performing a #find and the document is not found.
+    # (default: true)
+    # raise_not_found_error: true
+
+    # Raise an error when defining a scope with the same name as an
+    # existing method. (default: false)
+    # scope_overwrite_exception: false
+
+    # Raise an error when defining a field with the same name as an
+    # existing method. (default: false)
+    # duplicate_fields_exception: false
+
+    # Use Active Support's time zone in conversions. (default: true)
+    # use_activesupport_time_zone: true
+
+    # Ensure all times are UTC in the app side. (default: false)
+    # use_utc: false
+
+    # Set the Mongoid and Ruby driver log levels when not in a Rails
+    # environment. The Mongoid logger will be set to the Rails logger
+    # otherwise.(default: :info)
+    # log_level: :info
+
+    # Control whether `belongs_to` association is required. By default
+    # `belongs_to` will trigger a validation error if the association
+    # is not present. (default: true)
+    # belongs_to_required_by_default: true
+
+    # Application name that is printed to the mongodb logs upon establishing a
+    # connection in server versions >= 3.4. Note that the name cannot exceed 128 bytes.
+    # app_name: MyApplicationName
+
+    # Use background indexes by default if `background` option not specified. (default: false)
+    # background_indexing: false
+test:
+  clients:
+    default:
+      database: dummy_test
+      hosts:
+        - localhost:27017
+      options:
+        read:
+          mode: :primary
+        max_pool_size: 1

data/config/routes.rb

@@ -0,0 +1,21 @@
+BetterRailsDebugger::Engine.routes.draw do
+  # NEW
+  resources :analysis_groups
+
+  resources :group_instances do
+    member do
+      get 'objects'
+      get 'code'
+    end
+  end
+
+  # OLD
+  root 'analysis_groups#index'
+
+  resources :memory, only: [:index, :show] do
+    member do
+      get 'analyze'
+    end
+  end
+
+end

data/lib/better_rails_debugger/config.rb

@@ -0,0 +1,45 @@
+module BetterRailsDebugger
+  class Configuration
+    include Singleton
+
+    attr_reader :mongoid_config_file
+
+    def initialize
+      Mongoid.logger.level = Logger::FATAL
+    end
+
+    # Set MongoID configuration file
+    def mongoid_config_file=(file_path)
+      raise LoadError.new "File #{file_path} not found" if !File.exist? file_path
+      @mongoid_config_file = file_path
+    end
+
+    # Skip globally, the analysis of all classes added here
+    def skip_classes=(list)
+      return @skip_classes if @skip_classes
+      raise ArgumentError.new "Expected Array, got #{list.class}" if !list.kind_of? Array
+      raise ArgumentError.new "Array must contain classes and mondules names only" if list.any? {|a| !a.class.kind_of?(Class)}
+      @skip_classes ||= list
+    end
+
+    def skip_classes
+      @skip_classes || []
+    end
+
+    private
+
+    def classes_to_skip
+      @classes_to_skip ||= ruby_classes + skip_classes
+    end
+
+    def ruby_classes
+      @ruby_classes ||= %w{
+
+      }.map(&:constantize)
+    end
+  end
+
+  def self.configure(&block)
+    block.call Configuration.instance
+  end
+end

data/lib/better_rails_debugger/engine.rb

@@ -0,0 +1,5 @@
+module BetterRailsDebugger
+  class Engine < ::Rails::Engine
+    isolate_namespace BetterRailsDebugger
+  end
+end

data/lib/better_rails_debugger/memory_analyzer.rb

@@ -0,0 +1,109 @@
+require 'objspace'
+
+module BetterRailsDebugger
+  class MemoryAnalyzer
+    include Singleton
+
+
+    def analyze(identifier, group_id)
+      begin
+        group = ::BetterRailsDebugger::AnalysisGroup.find group_id
+      rescue Mongoid::Errors::DocumentNotFound
+        # If the group does not exist, just run the code and return
+        yield
+        return
+      end
+      # If we reached the max time to execute the code, just execute the code and do not collect information
+      if times_to_run_exceeded?(group) or skip_instance?(group, identifier)
+        yield
+      else
+        ::ObjectSpace.trace_object_allocations do
+          yield
+          collect_information(identifier, group_id)
+        end
+      end
+    end
+
+    # Clean ObjectSpace abject allocation tracer history
+    def clear_tracking
+      ::ObjectSpace.trace_object_allocations_clear
+    end
+
+    def times_to_run_exceeded?(group)
+      group.times_to_run.to_i > 0 and group.group_instances.count >= group.times_to_run
+    end
+
+    def skip_instance?(group, identifier)
+      !group.analyze_repeated_instances and GroupInstance.where(identifier: identifier, analysis_group: group.id).count > 0
+    end
+
+    # Record into db, information about object creation
+    def collect_information(identifier, group_id)
+      group = ::BetterRailsDebugger::AnalysisGroup.find group_id
+      if not group.present?
+        Rails.logger.error "[BetterRailsDebugger] Group '#{recorded[:group_id]}' not found. Skiping..."
+        return
+      end
+
+      # Load Mongo db if required
+      if not Mongoid::Config.configured?
+        Mongoid.load!(BetterRailsDebugger::Configuration.instance.mongoid_config_file, Rails.env.to_sym)
+        Mongoid.logger.level = Logger::FATAL
+      end
+
+      instance = ::BetterRailsDebugger::GroupInstance.create identifier: identifier, analysis_group_id: group_id, caller_file: caller[3][/[^:]+/]
+
+      collect_memory_information(instance)
+
+      # Now, it's time to analyze all collected data and generate a report
+      ::BetterRailsDebugger::AnalysisRecorderJob.perform_later({ instance_id: instance.id.to_s })
+    end
+
+    private
+
+    def collect_memory_information(instance)
+      objects = []
+      return if !instance.analysis_group.collect_memory_information
+      ObjectSpace.each_object(Object) do |obj|
+
+        next if !all_valid_classes[obj.class]
+
+        source_line = ObjectSpace.allocation_sourcefile(obj)
+
+        # Do not track objects that we don't know where comes from
+        next if !source_line
+
+        next if !instance.track_allocation_of? source_line
+
+        meta = {
+          ruby_object_id: obj.object_id,
+          source_file: source_line,
+          source_line: ObjectSpace.allocation_sourceline(obj),
+          memsize: ObjectSpace.memsize_of(obj),
+          class_name: obj.class.name,
+          group_instance_id: instance.id
+        }
+
+        # Add extra conditional metadata here....
+
+        objects << meta
+      end
+      ::BetterRailsDebugger::ObjectInformation.collection.insert_many(objects)
+    end
+
+    def all_valid_classes
+      return @all_valid_classes if @all_valid_classes
+      if !@all_classes
+        @all_classes = []
+        ObjectSpace.each_object(Class) do |klass|
+          @all_classes << klass
+        end
+      end
+      @all_valid_classes = Hash.new false
+      (@all_classes - ::BetterRailsDebugger::Configuration.instance.send(:classes_to_skip)).each do |klass|
+        @all_valid_classes[klass] = true
+      end
+      @all_valid_classes
+    end
+  end
+end

data/lib/better_rails_debugger/version.rb

@@ -0,0 +1,3 @@
+module BetterRailsDebugger
+  VERSION = '0.0.1'
+end

data/lib/better_rails_debugger.rb

@@ -0,0 +1,16 @@
+require "better_rails_debugger/engine"
+require "mongoid"
+require "haml"
+require "will_paginate_mongoid"
+require "will_paginate-bootstrap4"
+require "rouge"
+require "font-awesome-rails"
+
+require "better_rails_debugger/config"
+require "better_rails_debugger/memory_analyzer"
+
+Haml.init_rails(binding)
+
+module BetterRailsDebugger
+  # Your code goes here...
+end

data/lib/tasks/better_rails_debugger_tasks.rake

@@ -0,0 +1,4 @@
+# desc "Explaining what the task does"
+# task :better_rails_debugger do
+#   # Task goes here
+# end

metadata

@@ -0,0 +1,247 @@
+--- !ruby/object:Gem::Specification
+name: better_rails_debugger
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Andres Jose Borek
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2018-03-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 5.1.5
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '6.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 5.1.5
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '6.0'
+- !ruby/object:Gem::Dependency
+  name: haml-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: mongoid
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 7.0.0.beta
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '8.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 7.0.0.beta
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '8.0'
+- !ruby/object:Gem::Dependency
+  name: will_paginate_mongoid
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: will_paginate-bootstrap4
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rouge
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.1'
+- !ruby/object:Gem::Dependency
+  name: font-awesome-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  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: Better rails debugger can analyze memory issues only by the moment, but
+  performance is planned.
+email:
+- andres.b.dev@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- MIT-LICENSE
+- README.md
+- Rakefile
+- app/assets/config/better_rails_debugger_manifest.js
+- app/assets/images/avatars/1.jpg
+- app/assets/images/avatars/2.jpg
+- app/assets/images/avatars/3.jpg
+- app/assets/images/avatars/4.jpg
+- app/assets/images/avatars/5.jpg
+- app/assets/images/avatars/6.jpg
+- app/assets/images/avatars/7.jpg
+- app/assets/images/avatars/8.jpg
+- app/assets/images/favicon.png
+- app/assets/images/logo-symbol.png
+- app/assets/images/logo.png
+- app/assets/javascripts/better_rails_debugger/Chart.min.js
+- app/assets/javascripts/better_rails_debugger/app.js
+- app/assets/javascripts/better_rails_debugger/application.js
+- app/assets/javascripts/better_rails_debugger/bootstrap.min.js
+- app/assets/javascripts/better_rails_debugger/jquery-3.0.0.min.js
+- app/assets/javascripts/better_rails_debugger/jquery.min.js
+- app/assets/javascripts/better_rails_debugger/moment.min.js
+- app/assets/javascripts/better_rails_debugger/pace.min.js
+- app/assets/javascripts/better_rails_debugger/popper.min.js
+- app/assets/javascripts/better_rails_debugger/popper.min.js.map
+- app/assets/javascripts/better_rails_debugger/prism.js
+- app/assets/javascripts/better_rails_debugger/views/charts.js
+- app/assets/javascripts/better_rails_debugger/views/main.js
+- app/assets/javascripts/better_rails_debugger/views/popovers.js
+- app/assets/javascripts/better_rails_debugger/views/tooltips.js
+- app/assets/javascripts/better_rails_debugger/views/widgets.js
+- app/assets/stylesheets/better_rails_debugger/analysis_group_controller.css
+- app/assets/stylesheets/better_rails_debugger/application.scss
+- app/assets/stylesheets/better_rails_debugger/group_instances_controller.css
+- app/assets/stylesheets/better_rails_debugger/memory.css
+- app/assets/stylesheets/better_rails_debugger/prism.css
+- app/assets/stylesheets/better_rails_debugger/style.min.css
+- app/controllers/better_rails_debugger/analysis_groups_controller.rb
+- app/controllers/better_rails_debugger/application_controller.rb
+- app/controllers/better_rails_debugger/group_instances_controller.rb
+- app/controllers/better_rails_debugger/memory_controller.rb
+- app/helpers/better_rails_debugger/analysis_groups_helper.rb
+- app/helpers/better_rails_debugger/application_helper.rb
+- app/helpers/better_rails_debugger/group_instances_helper.rb
+- app/helpers/better_rails_debugger/memory_helper.rb
+- app/jobs/better_rails_debugger/analysis_recorder_job.rb
+- app/jobs/better_rails_debugger/application_job.rb
+- app/mailers/better_rails_debugger/application_mailer.rb
+- app/models/better_rails_debugger/analysis_group.rb
+- app/models/better_rails_debugger/application_record.rb
+- app/models/better_rails_debugger/group_instance.rb
+- app/models/better_rails_debugger/object_information.rb
+- app/views/better_rails_debugger/analysis_groups/_form.html.haml
+- app/views/better_rails_debugger/analysis_groups/edit.html.haml
+- app/views/better_rails_debugger/analysis_groups/index.html.haml
+- app/views/better_rails_debugger/analysis_groups/new.html.haml
+- app/views/better_rails_debugger/analysis_groups/show.html.haml
+- app/views/better_rails_debugger/group_instances/objects.html.haml
+- app/views/better_rails_debugger/memory/index.html.haml
+- app/views/better_rails_debugger/memory/show.html.haml
+- app/views/better_rails_debugger/shared/_header.html.haml
+- app/views/better_rails_debugger/shared/_sidebar.html.haml
+- app/views/layouts/better_rails_debugger/application.html.erb
+- config/initializers/setup.rb
+- config/mongoid.yml
+- config/routes.rb
+- lib/better_rails_debugger.rb
+- lib/better_rails_debugger/config.rb
+- lib/better_rails_debugger/engine.rb
+- lib/better_rails_debugger/memory_analyzer.rb
+- lib/better_rails_debugger/version.rb
+- lib/tasks/better_rails_debugger_tasks.rake
+homepage: ''
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '2.4'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.12
+signing_key: 
+specification_version: 4
+summary: Tool that helps you to debug memory issues and others.
+test_files: []