rspec-activerecord-formatter 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 215510c55bb74fa62a54c9237eed2f99f795916c
+  data.tar.gz: 57949cc504f9e0f5dfefa1e6bb94482c95279b7f
+SHA512:
+  metadata.gz: 5eae4c34002844511d9f683e2c22dc7135825ce36ed46c24f83239fe476551161940ce10dce02881e0f951d6952a189fb19d0ac8c586d5c443bc83452b2e7ffc
+  data.tar.gz: adac5f5c0819573703708c2ee6d34362ff0f127f9c0b67f2c16126901cee2dd84a4ccde4f208120963b1d0b0691722fc9dbc2643cb2b4dd3353a9bec8f6c9bd7

data/.gitignore

@@ -0,0 +1 @@
+.DS_Store

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 jmmastey@gmail.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,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2016 Joseph Mastey
+
+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,59 @@
+RSpec Active Record Formatter
+=============
+
+Adds a new formatting option to rspec that counts your ActiveRecord queries
+and object creations.
+
+Why? Because database interaction is really slow, and careless creation of large
+graphs of objects is a primary cause of insanely slow test suites. This project
+can help you diagnose where you're doing the most damage so that you can
+start to fix it.
+
+This library plays nicely with DatabaseCleaner.
+
+Installation
+------------
+
+Normal bundle stuff.
+
+    gem rspec-activerecord-formatter
+
+
+Usage
+------------
+
+The current answer appears to be changing your `.rspec` initializer to include the following:
+
+      --require rails_helper
+      --format ActiveRecordFormatter
+
+We have to include the rails_helper so that ActiveRecord is loaded prior to trying to load the
+formatter. That way, we can hook into AR creations.
+
+Once you set the formatter, you should now see the number of objects created and total queries
+for each of your tests:
+
+![Tests with AR annotations.](https://github.com/jmmastey/rspec-activerecord-formatter/raw/master/doc/images/demo_2.png "Tests with AR annotations.")
+
+You'll also get a summary at the end of your test run:
+
+![Test summary.](https://github.com/jmmastey/rspec-activerecord-formatter/raw/master/doc/images/demo_1.png "Test summary.")
+
+Next Steps
+------------
+* The method I was using to count AR objects doesn't work well with DatabaseCleaner when not explicitly wiring the library into `before` blocks.
+  I'd like to be able to go back to a method other than scanning for `INSERT INTO` strings.
+* Configuration, especially of the aligning of the metric output (to outdent it optionally).
+* Add a `--profile`-like behavior to output the most offending tests.
+
+Contributing
+------------
+
+Contributions are very welcome. Fork, fix, submit pulls.
+
+Contribution is expected to conform to the [Contributor Covenant](https://github.com/jmmastey/rspec-activerecord-formatter/blob/master/CODE_OF_CONDUCT.md).
+
+License
+------------
+
+This software is released under the [MIT License](https://github.com/jmmastey/rspec-activerecord-formatter/blob/master/MIT-LICENSE).

data/lib/rspec/activerecord/formatter.rb

@@ -0,0 +1,5 @@
+require_relative "formatter/collector"
+require_relative "formatter/formatter"
+
+module ActiveRecordFormatter
+end

data/lib/rspec/activerecord/formatter/collector.rb

@@ -0,0 +1,54 @@
+require 'active_support/notifications'
+
+module ActiveRecordFormatter
+  class Collector
+    attr_reader :query_count, :objects_count, :total_queries, :total_objects
+    SKIP_QUERIES = ["SELECT tablename FROM pg_tables", "select sum(ct) from (select count(*) ct from"]
+
+    def initialize
+      @query_count    = 0
+      @objects_count  = 0
+      @total_queries  = 0
+      @total_objects  = 0
+
+      ActiveSupport::Notifications.subscribe("sql.active_record", method(:record_query))
+    end
+
+    def record_query(*_unused, data)
+      return if SKIP_QUERIES.any? { |q| data[:sql].index(q) == 0 }
+
+      @query_count    += 1
+      @total_queries  += 1
+
+      if query_is_an_insert?(data[:sql])
+        @objects_count  += 1
+        @total_objects  += 1
+      end
+    end
+
+    def reset_example
+      @query_count   = 0
+      @objects_count = 0
+    end
+
+    protected
+
+    # TODO: what happens if we try to create many records at once?
+    # TODO: are there any false positives we need to worry about? false negatives?
+    def query_is_an_insert?(query)
+      query =~ /INSERT INTO/
+    end
+  end
+end
+
+# This is actually a really nice way to count records, but sadly
+# we have no way to hook a before action that preceeds DatabaseCleaner.
+# That makes it awfully tough to count anything at all.
+# def self.active_record_count
+#   tables =  (ActiveRecord::Base.connection.tables - ["ar_internal_metadata", "schema_migrations"])
+#   rows   = tables.map { |t| "select count(*) ct from #{t}" }.join(" union ")
+#   value  = "select sum(ct) from (#{rows}) t"
+#
+#   response = ActiveRecord::Base.connection.execute(value)
+#   response.to_a.first["sum"].to_i
+# end

data/lib/rspec/activerecord/formatter/formatter.rb

@@ -0,0 +1,71 @@
+module ActiveRecordFormatter
+  class Formatter < ::RSpec::Core::Formatters::DocumentationFormatter
+    attr_reader :collector, :colorizer, :configuration
+
+    ::RSpec::Core::Formatters.register self, :start, :dump_summary,
+                                             :example_started, :example_passed, :example_failed
+
+    def initialize(output)
+      super
+
+      @colorizer      = ::RSpec::Core::Formatters::ConsoleCodes
+      @collector      = ActiveRecordFormatter::Collector.new
+    end
+
+    def start(start_notification)
+      output.puts "Recording and reporting ActiveRecord select and creation counts."
+    end
+
+    def example_started(example)
+      collector.reset_example
+    end
+
+    def dump_summary(summary)
+      formatted = "\nFinished in #{summary.formatted_duration} " \
+        "(files took #{summary.formatted_load_time} to load)\n" \
+        "#{colorized_expanded_totals(summary)}\n"
+
+      unless summary.failed_examples.empty?
+        formatted << summary.colorized_rerun_commands(colorizer) << "\n"
+      end
+
+      output.puts formatted
+    end
+
+    protected
+
+    def passed_output(example)
+      "#{current_indentation}#{example_counts}" +
+        colorizer.wrap(example.description.strip, :success)
+    end
+
+    def failure_output(example)
+      "#{current_indentation}#{example_counts}" +
+        colorizer.wrap("#{example.description.strip} (FAILED - #{next_failure_index})", :failure)
+    end
+
+    def example_counts(suffix: " ")
+      "(%02d, %02d)#{suffix}" % [collector.objects_count, collector.query_count]
+    end
+
+    def colorized_expanded_totals(summary)
+      if summary.failure_count > 0
+        colorizer.wrap(expanded_totals_line(summary), RSpec.configuration.failure_color)
+      elsif summary.pending_count > 0
+        colorizer.wrap(expanded_totals_line(summary), RSpec.configuration.pending_color)
+      else
+        colorizer.wrap(expanded_totals_line(summary), RSpec.configuration.success_color)
+      end
+    end
+
+    def expanded_totals_line(summary)
+      summary_text = ::RSpec::Core::Formatters::Helpers.pluralize(summary.example_count, "example")
+      summary_text << ", " << ::RSpec::Core::Formatters::Helpers.pluralize(summary.failure_count, "failure")
+      summary_text << ", #{summary.pending_count} pending" if summary.pending_count > 0
+      summary_text << ", #{collector.total_objects} AR objects"
+      summary_text << ", #{collector.total_queries} AR queries"
+
+      summary_text
+    end
+  end
+end

data/lib/rspec/activerecord/formatter/version.rb

@@ -0,0 +1,3 @@
+module ActiveRecordFormatter
+  VERSION = '0.1.0'
+end

data/rspec-activerecord-formatter.gemspec

@@ -0,0 +1,34 @@
+# encoding: utf-8
+
+lib_dir = File.join(File.dirname(__FILE__),'lib')
+$LOAD_PATH << lib_dir unless $LOAD_PATH.include?(lib_dir)
+
+require 'rspec/activerecord/formatter/version'
+
+Gem::Specification.new do |gem|
+
+  gem.name    = "rspec-activerecord-formatter"
+  gem.version = ActiveRecordFormatter::VERSION
+
+  gem.summary     = "Adds object creations and queries to Rspec output."
+  gem.description = "Creates a new formatter for ActiveRecord that can help you diagnose performance issues in RSpec"
+  gem.licenses    = "MIT"
+  gem.authors     = "Joseph Mastey"
+  gem.email       = "jmmastey@gmail.com"
+  gem.homepage    = "http://github.com/jmmastey/rspec-activerecord-formatter"
+
+  glob = lambda { |patterns| gem.files & Dir[*patterns] }
+
+  gem.files       = `git ls-files`.split($/)
+
+  gem.extensions       = glob['ext/**/extconf.rb']
+  gem.test_files       = glob['{spec/{**/}*_spec.rb']
+  gem.extra_rdoc_files = glob['*.{txt,md}']
+
+  gem.require_paths = %w[ext lib].select { |dir| File.directory?(dir) }
+
+  # TODO: these are almost certainly too restrictive.
+  gem.add_dependency "bundler", "~> 1.9"
+  gem.add_dependency "activesupport", ">= 4.0"
+  gem.add_dependency "rspec", "~> 3.4"
+end

metadata

@@ -0,0 +1,100 @@
+--- !ruby/object:Gem::Specification
+name: rspec-activerecord-formatter
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Joseph Mastey
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-12-16 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.9'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.9'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '4.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '4.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.4'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.4'
+description: Creates a new formatter for ActiveRecord that can help you diagnose performance
+  issues in RSpec
+email: jmmastey@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files:
+- CODE_OF_CONDUCT.md
+- README.md
+files:
+- .gitignore
+- CODE_OF_CONDUCT.md
+- Gemfile
+- MIT-LICENSE
+- README.md
+- doc/images/demo_1.png
+- doc/images/demo_2.png
+- lib/rspec/activerecord/formatter.rb
+- lib/rspec/activerecord/formatter/collector.rb
+- lib/rspec/activerecord/formatter/formatter.rb
+- lib/rspec/activerecord/formatter/version.rb
+- rspec-activerecord-formatter.gemspec
+homepage: http://github.com/jmmastey/rspec-activerecord-formatter
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.0.14
+signing_key: 
+specification_version: 4
+summary: Adds object creations and queries to Rspec output.
+test_files: []