bullet-board 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 6e928568aca9f2f75687776d9b3b5cd2ca51c8afd5f6b276827fb66ba329be46
+  data.tar.gz: be96b8c983d02f74789cb2923a523ff6fed139ee4b64bf28a9a9317252800e0b
+SHA512:
+  metadata.gz: ce1a731139ebd6d50220543bbee19c3a3abb3ba504852f771c0d141f5b647c1f31b8c3146ba87b1d291096d87a991835a2190af9fc134aa43586aaf2caae4a6a
+  data.tar.gz: 18d677e6389f6ee84a71002586683cf5df9dafa40e0ca00c57958cb2809086502d3d8efbe87457fbc4d771cb8629fc30c15522f3aa8694e86aa3c6fd02068597

data/.gitignore

@@ -0,0 +1,13 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status
+
+*.gem

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.travis.yml

@@ -0,0 +1,7 @@
+---
+sudo: false
+language: ruby
+cache: bundler
+rvm:
+  - 2.4.4
+before_install: gem install bundler -v 1.17.2

data/AGENDA.md

@@ -0,0 +1,18 @@
+# AGENDA
+
+### Development TODO Checklist
+
+- capture only eager-loading queries per request
+- due diligence on integrating with [GoAccess](https://goaccess.io) as a web log analyzer
+- use [UniformNotifier](https://github.com/flyerhzm/uniform_notifier) for Slack integration to notify developers when their pull requests contribute to new instances of N+1 queries
+  - send Slack notification to designated public channel with @<user-name> identifier to notify user
+- configure for QA/UAT boxes
+  - integrate with DevOps tool to pull down reports of N+1 statistics
+- TODO: I/O ramifications for turning off sync mode [File#sync] and only write when file is closed
+  - supposedly faster according to some sources
+- Address conflicts when requiring both Bullet and BulletBoard
+  - only load extensions if `BulletBoard.enable = true`
+- Transform gem into a Rails mountable engine for web interface reporting
+  - example of mountable engine web interface: [https://github.com/tatey/delayed-web]
+  - CC: Ryan Bates [http://railscasts.com/episodes/277-mountable-engines?autoplay=true]
+    - outdated example for creating engine

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at gtowne@rbmtechnologies.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in bullet-board.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,52 @@
+PATH
+  remote: .
+  specs:
+    bullet-board (0.1.0)
+      bullet (~> 5.9)
+      bundler (~> 1.17)
+      rake (~> 12.3)
+      rspec (~> 3.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activesupport (5.2.3)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 0.7, < 2)
+      minitest (~> 5.1)
+      tzinfo (~> 1.1)
+    bullet (5.9.0)
+      activesupport (>= 3.0.0)
+      uniform_notifier (~> 1.11)
+    concurrent-ruby (1.1.5)
+    diff-lcs (1.3)
+    i18n (1.7.0)
+      concurrent-ruby (~> 1.0)
+    minitest (5.13.0)
+    rake (12.3.3)
+    rspec (3.9.0)
+      rspec-core (~> 3.9.0)
+      rspec-expectations (~> 3.9.0)
+      rspec-mocks (~> 3.9.0)
+    rspec-core (3.9.0)
+      rspec-support (~> 3.9.0)
+    rspec-expectations (3.9.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-mocks (3.9.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-support (3.9.0)
+    thread_safe (0.3.6)
+    tzinfo (1.2.5)
+      thread_safe (~> 0.1)
+    uniform_notifier (1.13.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bullet-board!
+
+BUNDLED WITH
+   1.17.3

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2019 gtowne
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,55 @@
+# BulletBoard
+
+NOTE: THIS GEM IS STILL A WORK-IN-PROGRESS AND CURRENTLY NOT READY FOR CONSUMPTION
+
+Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/bullet-board`. To experiment with that code, run `bin/console` for an interactive prompt.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'bullet-board'
+gem 'slack-notifier'
+```
+
+In the terminal, run bundler:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install bullet-board
+
+## Usage
+
+Append to `config/environments/development.rb` initializer with the following code:
+
+```ruby
+config.after_initialize do
+  # accepts a block
+  BulletBoard.enable do
+    Bullet.enable = false
+  end
+end
+```
+
+Lastly, ensure that your log directory is not being ignored in `/.gitignore`
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/bullet-board. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+## 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 BulletBoard project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/bullet-board/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "bullet-board"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/bullet-board.gemspec

@@ -0,0 +1,44 @@
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "bullet-board/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "bullet-board"
+  spec.version       = BulletBoard::VERSION
+  spec.authors       = ["Gregory Towne"]
+  spec.email         = ["townegr@yahoo.com"]
+
+  spec.summary       = %q{Aggregate unique N+1 queries backed by useful data points.}
+  spec.description   = %q{Build performance status report that outlines the source of N+1 queries.}
+  spec.homepage      = "https://github.com/townegr/bullet-board"
+  spec.license       = "MIT"
+
+  # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
+  # to allow pushing to a single host or delete this section to allow pushing to any host.
+  # if spec.respond_to?(:metadata)
+  #   spec.metadata["allowed_push_host"] = "TODO: Set to 'http://mygemserver.com'"
+  #
+  #   spec.metadata["homepage_uri"] = spec.homepage
+  #   spec.metadata["source_code_uri"] = "TODO: Put your gem's public repo URL here."
+  #   spec.metadata["changelog_uri"] = "TODO: Put your gem's CHANGELOG.md URL here."
+  # else
+  #   raise "RubyGems 2.0 or newer is required to protect against " \
+  #     "public gem pushes."
+  # end
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+  spec.required_ruby_version = '>= 2.4'
+  spec.required_rubygems_version = '>= 1.3.6'
+
+  spec.add_dependency "bundler", "~> 1.17"
+  spec.add_dependency "rake", "~> 12.3"
+  spec.add_dependency "rspec", "~> 3.0"
+  spec.add_dependency 'bullet', '~> 5.9'
+end

data/lib/bullet-board.rb

@@ -0,0 +1,41 @@
+require 'bullet'
+require 'bullet-board/ext/bullet'
+require 'bullet-board/ext/notification'
+require 'bullet-board/version'
+
+module BulletBoard
+  # def self.enable_with_dependencies; end
+
+  def self.enable &block
+    configure_with_defaults
+    block.call if block_given?
+  rescue ConfigurationError => e
+    Rails.logger.error "Error: #{e.message}"
+    # change to false because we just want the customized logger
+    # currently looping twice through UniformNotifier.active_notifiers in
+    # Bullet#for_each_active_notifier_with_notification
+  ensure
+    Bullet.bullet_logger = false
+    print_success_notification_to_stderr if Bullet.web_logger_enabled?
+  end
+
+  class ConfigurationError < StandardError
+    def message
+      "unable to initialize due to configuration conflict"
+    end
+  end
+
+  private
+
+  def self.configure_with_defaults
+    Bullet.enable = true
+    Bullet.web_logger = true
+  end
+
+  def self.print_success_notification_to_stderr
+    STDERR.puts '┌─────────────────────────────────────────────────────────────────────────┐'
+    STDERR.puts '│ Configured with the Bullet [https://github.com/flyerhzm/bullet]         │'
+    STDERR.puts '│ and BulletBoard for reporting [https://github.com/townegr/bullet-board] │'
+    STDERR.puts '└─────────────────────────────────────────────────────────────────────────┘'
+  end
+end

data/lib/bullet-board/ext/bullet.rb

@@ -0,0 +1,55 @@
+module Bullet
+  module BulletExtensions
+    def notification?
+      UniformNotifier.customized_logger = make_board_log if notify_with_new_request?
+      requests << current_connection_id
+
+      super
+    end
+  end
+
+  class << self
+    prepend BulletExtensions
+
+    @@requests = Set.new
+
+    def bullet_logger= active
+      raise BulletBoard::ConfigurationError if active
+    end
+
+    def web_logger_enabled?
+      enable? && !!@web_logger_enabled
+    end
+
+    def web_logger= active
+      active = (!!active == active) ? active : false
+      @web_logger_enabled = active
+    end
+
+    def new_request? id
+      !requests.include? id
+    end
+
+    def requests
+      @@requests
+    end
+
+    def current_connection_id
+      @_current_connection_id ||= Thread.current["ActiveRecord::RuntimeRegistry"].connection_id
+    end
+
+    def notify_with_new_request?
+      web_logger_enabled? &&
+      new_request?(current_connection_id) &&
+      notification_collector.notifications_present?
+    end
+
+    def make_board_log
+      app_root = (defined?(::Rails.root) ? Rails.root.to_s : Dir.pwd).to_s
+      FileUtils.mkdir_p(app_root + '/log')
+      filename = "#{app_root}/log/#{Time.new.utc.strftime("%Y%m%d%H%M%S")}_bullet_board.log"
+      web_log_file = File.open(filename, 'a+')
+      web_log_file.tap { |f| f.sync = true }
+    end
+  end
+end

data/lib/bullet-board/ext/notification.rb

@@ -0,0 +1,46 @@
+require 'bullet'
+require 'pry'
+
+module Bullet
+  module Notification
+      class UnusedEagerLoading
+        attr_accessor :counter
+
+        def initialize callers, base_class, associations, path = nil
+          super base_class, associations, path
+
+          @callers = callers
+          @counter = 0
+        end
+
+        def notification_data
+          if self.notifier == UniformNotifier::CustomizedLogger
+            self.counter += 1
+            puts "Call UnusedEagerLoading count: #{self.counter}"
+          end
+
+          super
+        end
+      end
+
+      class NPlusOneQuery
+        attr_accessor :counter
+
+        def initialize callers, base_class, associations, path = nil
+          super base_class, associations, path
+
+          @callers = callers
+          @counter = 0
+        end
+
+        def notification_data
+          if self.notifier == UniformNotifier::CustomizedLogger
+            self.counter += 1
+            puts "Call NPlusOneQuery count: #{self.counter}"
+          end
+
+          super
+        end
+      end
+  end
+end

data/lib/bullet-board/version.rb

@@ -0,0 +1,3 @@
+module BulletBoard
+  VERSION = "0.1.0"
+end

metadata

@@ -0,0 +1,116 @@
+--- !ruby/object:Gem::Specification
+name: bullet-board
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Gregory Towne
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2019-11-03 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.17'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.17'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.3'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: bullet
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.9'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.9'
+description: Build performance status report that outlines the source of N+1 queries.
+email:
+- townegr@yahoo.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- AGENDA.md
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- bullet-board.gemspec
+- lib/bullet-board.rb
+- lib/bullet-board/ext/bullet.rb
+- lib/bullet-board/ext/notification.rb
+- lib/bullet-board/version.rb
+homepage: https://github.com/townegr/bullet-board
+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: 1.3.6
+requirements: []
+rubygems_version: 3.0.6
+signing_key: 
+specification_version: 4
+summary: Aggregate unique N+1 queries backed by useful data points.
+test_files: []