bullet-board 0.1.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -0,0 +1,7 @@
1
+ ---
2
+ SHA256:
3
+ metadata.gz: 6e928568aca9f2f75687776d9b3b5cd2ca51c8afd5f6b276827fb66ba329be46
4
+ data.tar.gz: be96b8c983d02f74789cb2923a523ff6fed139ee4b64bf28a9a9317252800e0b
5
+ SHA512:
6
+ metadata.gz: ce1a731139ebd6d50220543bbee19c3a3abb3ba504852f771c0d141f5b647c1f31b8c3146ba87b1d291096d87a991835a2190af9fc134aa43586aaf2caae4a6a
7
+ data.tar.gz: 18d677e6389f6ee84a71002586683cf5df9dafa40e0ca00c57958cb2809086502d3d8efbe87457fbc4d771cb8629fc30c15522f3aa8694e86aa3c6fd02068597
@@ -0,0 +1,13 @@
1
+ /.bundle/
2
+ /.yardoc
3
+ /_yardoc/
4
+ /coverage/
5
+ /doc/
6
+ /pkg/
7
+ /spec/reports/
8
+ /tmp/
9
+
10
+ # rspec failure tracking
11
+ .rspec_status
12
+
13
+ *.gem
data/.rspec ADDED
@@ -0,0 +1,3 @@
1
+ --format documentation
2
+ --color
3
+ --require spec_helper
@@ -0,0 +1,7 @@
1
+ ---
2
+ sudo: false
3
+ language: ruby
4
+ cache: bundler
5
+ rvm:
6
+ - 2.4.4
7
+ before_install: gem install bundler -v 1.17.2
@@ -0,0 +1,18 @@
1
+ # AGENDA
2
+
3
+ ### Development TODO Checklist
4
+
5
+ - capture only eager-loading queries per request
6
+ - due diligence on integrating with [GoAccess](https://goaccess.io) as a web log analyzer
7
+ - 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
8
+ - send Slack notification to designated public channel with @<user-name> identifier to notify user
9
+ - configure for QA/UAT boxes
10
+ - integrate with DevOps tool to pull down reports of N+1 statistics
11
+ - TODO: I/O ramifications for turning off sync mode [File#sync] and only write when file is closed
12
+ - supposedly faster according to some sources
13
+ - Address conflicts when requiring both Bullet and BulletBoard
14
+ - only load extensions if `BulletBoard.enable = true`
15
+ - Transform gem into a Rails mountable engine for web interface reporting
16
+ - example of mountable engine web interface: [https://github.com/tatey/delayed-web]
17
+ - CC: Ryan Bates [http://railscasts.com/episodes/277-mountable-engines?autoplay=true]
18
+ - outdated example for creating engine
@@ -0,0 +1,74 @@
1
+ # Contributor Covenant Code of Conduct
2
+
3
+ ## Our Pledge
4
+
5
+ In the interest of fostering an open and welcoming environment, we as
6
+ contributors and maintainers pledge to making participation in our project and
7
+ our community a harassment-free experience for everyone, regardless of age, body
8
+ size, disability, ethnicity, gender identity and expression, level of experience,
9
+ nationality, personal appearance, race, religion, or sexual identity and
10
+ orientation.
11
+
12
+ ## Our Standards
13
+
14
+ Examples of behavior that contributes to creating a positive environment
15
+ include:
16
+
17
+ * Using welcoming and inclusive language
18
+ * Being respectful of differing viewpoints and experiences
19
+ * Gracefully accepting constructive criticism
20
+ * Focusing on what is best for the community
21
+ * Showing empathy towards other community members
22
+
23
+ Examples of unacceptable behavior by participants include:
24
+
25
+ * The use of sexualized language or imagery and unwelcome sexual attention or
26
+ advances
27
+ * Trolling, insulting/derogatory comments, and personal or political attacks
28
+ * Public or private harassment
29
+ * Publishing others' private information, such as a physical or electronic
30
+ address, without explicit permission
31
+ * Other conduct which could reasonably be considered inappropriate in a
32
+ professional setting
33
+
34
+ ## Our Responsibilities
35
+
36
+ Project maintainers are responsible for clarifying the standards of acceptable
37
+ behavior and are expected to take appropriate and fair corrective action in
38
+ response to any instances of unacceptable behavior.
39
+
40
+ Project maintainers have the right and responsibility to remove, edit, or
41
+ reject comments, commits, code, wiki edits, issues, and other contributions
42
+ that are not aligned to this Code of Conduct, or to ban temporarily or
43
+ permanently any contributor for other behaviors that they deem inappropriate,
44
+ threatening, offensive, or harmful.
45
+
46
+ ## Scope
47
+
48
+ This Code of Conduct applies both within project spaces and in public spaces
49
+ when an individual is representing the project or its community. Examples of
50
+ representing a project or community include using an official project e-mail
51
+ address, posting via an official social media account, or acting as an appointed
52
+ representative at an online or offline event. Representation of a project may be
53
+ further defined and clarified by project maintainers.
54
+
55
+ ## Enforcement
56
+
57
+ Instances of abusive, harassing, or otherwise unacceptable behavior may be
58
+ reported by contacting the project team at gtowne@rbmtechnologies.com. All
59
+ complaints will be reviewed and investigated and will result in a response that
60
+ is deemed necessary and appropriate to the circumstances. The project team is
61
+ obligated to maintain confidentiality with regard to the reporter of an incident.
62
+ Further details of specific enforcement policies may be posted separately.
63
+
64
+ Project maintainers who do not follow or enforce the Code of Conduct in good
65
+ faith may face temporary or permanent repercussions as determined by other
66
+ members of the project's leadership.
67
+
68
+ ## Attribution
69
+
70
+ This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
71
+ available at [http://contributor-covenant.org/version/1/4][version]
72
+
73
+ [homepage]: http://contributor-covenant.org
74
+ [version]: http://contributor-covenant.org/version/1/4/
data/Gemfile ADDED
@@ -0,0 +1,6 @@
1
+ source "https://rubygems.org"
2
+
3
+ git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
4
+
5
+ # Specify your gem's dependencies in bullet-board.gemspec
6
+ gemspec
@@ -0,0 +1,52 @@
1
+ PATH
2
+ remote: .
3
+ specs:
4
+ bullet-board (0.1.0)
5
+ bullet (~> 5.9)
6
+ bundler (~> 1.17)
7
+ rake (~> 12.3)
8
+ rspec (~> 3.0)
9
+
10
+ GEM
11
+ remote: https://rubygems.org/
12
+ specs:
13
+ activesupport (5.2.3)
14
+ concurrent-ruby (~> 1.0, >= 1.0.2)
15
+ i18n (>= 0.7, < 2)
16
+ minitest (~> 5.1)
17
+ tzinfo (~> 1.1)
18
+ bullet (5.9.0)
19
+ activesupport (>= 3.0.0)
20
+ uniform_notifier (~> 1.11)
21
+ concurrent-ruby (1.1.5)
22
+ diff-lcs (1.3)
23
+ i18n (1.7.0)
24
+ concurrent-ruby (~> 1.0)
25
+ minitest (5.13.0)
26
+ rake (12.3.3)
27
+ rspec (3.9.0)
28
+ rspec-core (~> 3.9.0)
29
+ rspec-expectations (~> 3.9.0)
30
+ rspec-mocks (~> 3.9.0)
31
+ rspec-core (3.9.0)
32
+ rspec-support (~> 3.9.0)
33
+ rspec-expectations (3.9.0)
34
+ diff-lcs (>= 1.2.0, < 2.0)
35
+ rspec-support (~> 3.9.0)
36
+ rspec-mocks (3.9.0)
37
+ diff-lcs (>= 1.2.0, < 2.0)
38
+ rspec-support (~> 3.9.0)
39
+ rspec-support (3.9.0)
40
+ thread_safe (0.3.6)
41
+ tzinfo (1.2.5)
42
+ thread_safe (~> 0.1)
43
+ uniform_notifier (1.13.0)
44
+
45
+ PLATFORMS
46
+ ruby
47
+
48
+ DEPENDENCIES
49
+ bullet-board!
50
+
51
+ BUNDLED WITH
52
+ 1.17.3
@@ -0,0 +1,21 @@
1
+ The MIT License (MIT)
2
+
3
+ Copyright (c) 2019 gtowne
4
+
5
+ Permission is hereby granted, free of charge, to any person obtaining a copy
6
+ of this software and associated documentation files (the "Software"), to deal
7
+ in the Software without restriction, including without limitation the rights
8
+ to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9
+ copies of the Software, and to permit persons to whom the Software is
10
+ furnished to do so, subject to the following conditions:
11
+
12
+ The above copyright notice and this permission notice shall be included in
13
+ all copies or substantial portions of the Software.
14
+
15
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16
+ IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17
+ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18
+ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19
+ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20
+ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
21
+ THE SOFTWARE.
@@ -0,0 +1,55 @@
1
+ # BulletBoard
2
+
3
+ NOTE: THIS GEM IS STILL A WORK-IN-PROGRESS AND CURRENTLY NOT READY FOR CONSUMPTION
4
+
5
+ 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.
6
+
7
+ ## Installation
8
+
9
+ Add this line to your application's Gemfile:
10
+
11
+ ```ruby
12
+ gem 'bullet-board'
13
+ gem 'slack-notifier'
14
+ ```
15
+
16
+ In the terminal, run bundler:
17
+
18
+ $ bundle install
19
+
20
+ Or install it yourself as:
21
+
22
+ $ gem install bullet-board
23
+
24
+ ## Usage
25
+
26
+ Append to `config/environments/development.rb` initializer with the following code:
27
+
28
+ ```ruby
29
+ config.after_initialize do
30
+ # accepts a block
31
+ BulletBoard.enable do
32
+ Bullet.enable = false
33
+ end
34
+ end
35
+ ```
36
+
37
+ Lastly, ensure that your log directory is not being ignored in `/.gitignore`
38
+
39
+ ## Development
40
+
41
+ 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.
42
+
43
+ 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).
44
+
45
+ ## Contributing
46
+
47
+ 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.
48
+
49
+ ## License
50
+
51
+ The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
52
+
53
+ ## Code of Conduct
54
+
55
+ 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).
@@ -0,0 +1,6 @@
1
+ require "bundler/gem_tasks"
2
+ require "rspec/core/rake_task"
3
+
4
+ RSpec::Core::RakeTask.new(:spec)
5
+
6
+ task :default => :spec
@@ -0,0 +1,14 @@
1
+ #!/usr/bin/env ruby
2
+
3
+ require "bundler/setup"
4
+ require "bullet-board"
5
+
6
+ # You can add fixtures and/or initialization code here to make experimenting
7
+ # with your gem easier. You can also use a different console, if you like.
8
+
9
+ # (If you use this, don't forget to add pry to your Gemfile!)
10
+ # require "pry"
11
+ # Pry.start
12
+
13
+ require "irb"
14
+ IRB.start(__FILE__)
@@ -0,0 +1,8 @@
1
+ #!/usr/bin/env bash
2
+ set -euo pipefail
3
+ IFS=$'\n\t'
4
+ set -vx
5
+
6
+ bundle install
7
+
8
+ # Do any other automated setup that you need to do here
@@ -0,0 +1,44 @@
1
+ lib = File.expand_path("../lib", __FILE__)
2
+ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
3
+ require "bullet-board/version"
4
+
5
+ Gem::Specification.new do |spec|
6
+ spec.name = "bullet-board"
7
+ spec.version = BulletBoard::VERSION
8
+ spec.authors = ["Gregory Towne"]
9
+ spec.email = ["townegr@yahoo.com"]
10
+
11
+ spec.summary = %q{Aggregate unique N+1 queries backed by useful data points.}
12
+ spec.description = %q{Build performance status report that outlines the source of N+1 queries.}
13
+ spec.homepage = "https://github.com/townegr/bullet-board"
14
+ spec.license = "MIT"
15
+
16
+ # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
17
+ # to allow pushing to a single host or delete this section to allow pushing to any host.
18
+ # if spec.respond_to?(:metadata)
19
+ # spec.metadata["allowed_push_host"] = "TODO: Set to 'http://mygemserver.com'"
20
+ #
21
+ # spec.metadata["homepage_uri"] = spec.homepage
22
+ # spec.metadata["source_code_uri"] = "TODO: Put your gem's public repo URL here."
23
+ # spec.metadata["changelog_uri"] = "TODO: Put your gem's CHANGELOG.md URL here."
24
+ # else
25
+ # raise "RubyGems 2.0 or newer is required to protect against " \
26
+ # "public gem pushes."
27
+ # end
28
+
29
+ # Specify which files should be added to the gem when it is released.
30
+ # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
31
+ spec.files = Dir.chdir(File.expand_path('..', __FILE__)) do
32
+ `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
33
+ end
34
+ spec.bindir = "exe"
35
+ spec.executables = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
36
+ spec.require_paths = ["lib"]
37
+ spec.required_ruby_version = '>= 2.4'
38
+ spec.required_rubygems_version = '>= 1.3.6'
39
+
40
+ spec.add_dependency "bundler", "~> 1.17"
41
+ spec.add_dependency "rake", "~> 12.3"
42
+ spec.add_dependency "rspec", "~> 3.0"
43
+ spec.add_dependency 'bullet', '~> 5.9'
44
+ end
@@ -0,0 +1,41 @@
1
+ require 'bullet'
2
+ require 'bullet-board/ext/bullet'
3
+ require 'bullet-board/ext/notification'
4
+ require 'bullet-board/version'
5
+
6
+ module BulletBoard
7
+ # def self.enable_with_dependencies; end
8
+
9
+ def self.enable &block
10
+ configure_with_defaults
11
+ block.call if block_given?
12
+ rescue ConfigurationError => e
13
+ Rails.logger.error "Error: #{e.message}"
14
+ # change to false because we just want the customized logger
15
+ # currently looping twice through UniformNotifier.active_notifiers in
16
+ # Bullet#for_each_active_notifier_with_notification
17
+ ensure
18
+ Bullet.bullet_logger = false
19
+ print_success_notification_to_stderr if Bullet.web_logger_enabled?
20
+ end
21
+
22
+ class ConfigurationError < StandardError
23
+ def message
24
+ "unable to initialize due to configuration conflict"
25
+ end
26
+ end
27
+
28
+ private
29
+
30
+ def self.configure_with_defaults
31
+ Bullet.enable = true
32
+ Bullet.web_logger = true
33
+ end
34
+
35
+ def self.print_success_notification_to_stderr
36
+ STDERR.puts '┌─────────────────────────────────────────────────────────────────────────┐'
37
+ STDERR.puts '│ Configured with the Bullet [https://github.com/flyerhzm/bullet] │'
38
+ STDERR.puts '│ and BulletBoard for reporting [https://github.com/townegr/bullet-board] │'
39
+ STDERR.puts '└─────────────────────────────────────────────────────────────────────────┘'
40
+ end
41
+ end
@@ -0,0 +1,55 @@
1
+ module Bullet
2
+ module BulletExtensions
3
+ def notification?
4
+ UniformNotifier.customized_logger = make_board_log if notify_with_new_request?
5
+ requests << current_connection_id
6
+
7
+ super
8
+ end
9
+ end
10
+
11
+ class << self
12
+ prepend BulletExtensions
13
+
14
+ @@requests = Set.new
15
+
16
+ def bullet_logger= active
17
+ raise BulletBoard::ConfigurationError if active
18
+ end
19
+
20
+ def web_logger_enabled?
21
+ enable? && !!@web_logger_enabled
22
+ end
23
+
24
+ def web_logger= active
25
+ active = (!!active == active) ? active : false
26
+ @web_logger_enabled = active
27
+ end
28
+
29
+ def new_request? id
30
+ !requests.include? id
31
+ end
32
+
33
+ def requests
34
+ @@requests
35
+ end
36
+
37
+ def current_connection_id
38
+ @_current_connection_id ||= Thread.current["ActiveRecord::RuntimeRegistry"].connection_id
39
+ end
40
+
41
+ def notify_with_new_request?
42
+ web_logger_enabled? &&
43
+ new_request?(current_connection_id) &&
44
+ notification_collector.notifications_present?
45
+ end
46
+
47
+ def make_board_log
48
+ app_root = (defined?(::Rails.root) ? Rails.root.to_s : Dir.pwd).to_s
49
+ FileUtils.mkdir_p(app_root + '/log')
50
+ filename = "#{app_root}/log/#{Time.new.utc.strftime("%Y%m%d%H%M%S")}_bullet_board.log"
51
+ web_log_file = File.open(filename, 'a+')
52
+ web_log_file.tap { |f| f.sync = true }
53
+ end
54
+ end
55
+ end
@@ -0,0 +1,46 @@
1
+ require 'bullet'
2
+ require 'pry'
3
+
4
+ module Bullet
5
+ module Notification
6
+ class UnusedEagerLoading
7
+ attr_accessor :counter
8
+
9
+ def initialize callers, base_class, associations, path = nil
10
+ super base_class, associations, path
11
+
12
+ @callers = callers
13
+ @counter = 0
14
+ end
15
+
16
+ def notification_data
17
+ if self.notifier == UniformNotifier::CustomizedLogger
18
+ self.counter += 1
19
+ puts "Call UnusedEagerLoading count: #{self.counter}"
20
+ end
21
+
22
+ super
23
+ end
24
+ end
25
+
26
+ class NPlusOneQuery
27
+ attr_accessor :counter
28
+
29
+ def initialize callers, base_class, associations, path = nil
30
+ super base_class, associations, path
31
+
32
+ @callers = callers
33
+ @counter = 0
34
+ end
35
+
36
+ def notification_data
37
+ if self.notifier == UniformNotifier::CustomizedLogger
38
+ self.counter += 1
39
+ puts "Call NPlusOneQuery count: #{self.counter}"
40
+ end
41
+
42
+ super
43
+ end
44
+ end
45
+ end
46
+ end
@@ -0,0 +1,3 @@
1
+ module BulletBoard
2
+ VERSION = "0.1.0"
3
+ end
metadata ADDED
@@ -0,0 +1,116 @@
1
+ --- !ruby/object:Gem::Specification
2
+ name: bullet-board
3
+ version: !ruby/object:Gem::Version
4
+ version: 0.1.0
5
+ platform: ruby
6
+ authors:
7
+ - Gregory Towne
8
+ autorequire:
9
+ bindir: exe
10
+ cert_chain: []
11
+ date: 2019-11-03 00:00:00.000000000 Z
12
+ dependencies:
13
+ - !ruby/object:Gem::Dependency
14
+ name: bundler
15
+ requirement: !ruby/object:Gem::Requirement
16
+ requirements:
17
+ - - "~>"
18
+ - !ruby/object:Gem::Version
19
+ version: '1.17'
20
+ type: :runtime
21
+ prerelease: false
22
+ version_requirements: !ruby/object:Gem::Requirement
23
+ requirements:
24
+ - - "~>"
25
+ - !ruby/object:Gem::Version
26
+ version: '1.17'
27
+ - !ruby/object:Gem::Dependency
28
+ name: rake
29
+ requirement: !ruby/object:Gem::Requirement
30
+ requirements:
31
+ - - "~>"
32
+ - !ruby/object:Gem::Version
33
+ version: '12.3'
34
+ type: :runtime
35
+ prerelease: false
36
+ version_requirements: !ruby/object:Gem::Requirement
37
+ requirements:
38
+ - - "~>"
39
+ - !ruby/object:Gem::Version
40
+ version: '12.3'
41
+ - !ruby/object:Gem::Dependency
42
+ name: rspec
43
+ requirement: !ruby/object:Gem::Requirement
44
+ requirements:
45
+ - - "~>"
46
+ - !ruby/object:Gem::Version
47
+ version: '3.0'
48
+ type: :runtime
49
+ prerelease: false
50
+ version_requirements: !ruby/object:Gem::Requirement
51
+ requirements:
52
+ - - "~>"
53
+ - !ruby/object:Gem::Version
54
+ version: '3.0'
55
+ - !ruby/object:Gem::Dependency
56
+ name: bullet
57
+ requirement: !ruby/object:Gem::Requirement
58
+ requirements:
59
+ - - "~>"
60
+ - !ruby/object:Gem::Version
61
+ version: '5.9'
62
+ type: :runtime
63
+ prerelease: false
64
+ version_requirements: !ruby/object:Gem::Requirement
65
+ requirements:
66
+ - - "~>"
67
+ - !ruby/object:Gem::Version
68
+ version: '5.9'
69
+ description: Build performance status report that outlines the source of N+1 queries.
70
+ email:
71
+ - townegr@yahoo.com
72
+ executables: []
73
+ extensions: []
74
+ extra_rdoc_files: []
75
+ files:
76
+ - ".gitignore"
77
+ - ".rspec"
78
+ - ".travis.yml"
79
+ - AGENDA.md
80
+ - CODE_OF_CONDUCT.md
81
+ - Gemfile
82
+ - Gemfile.lock
83
+ - LICENSE.txt
84
+ - README.md
85
+ - Rakefile
86
+ - bin/console
87
+ - bin/setup
88
+ - bullet-board.gemspec
89
+ - lib/bullet-board.rb
90
+ - lib/bullet-board/ext/bullet.rb
91
+ - lib/bullet-board/ext/notification.rb
92
+ - lib/bullet-board/version.rb
93
+ homepage: https://github.com/townegr/bullet-board
94
+ licenses:
95
+ - MIT
96
+ metadata: {}
97
+ post_install_message:
98
+ rdoc_options: []
99
+ require_paths:
100
+ - lib
101
+ required_ruby_version: !ruby/object:Gem::Requirement
102
+ requirements:
103
+ - - ">="
104
+ - !ruby/object:Gem::Version
105
+ version: '2.4'
106
+ required_rubygems_version: !ruby/object:Gem::Requirement
107
+ requirements:
108
+ - - ">="
109
+ - !ruby/object:Gem::Version
110
+ version: 1.3.6
111
+ requirements: []
112
+ rubygems_version: 3.0.6
113
+ signing_key:
114
+ specification_version: 4
115
+ summary: Aggregate unique N+1 queries backed by useful data points.
116
+ test_files: []