rspec-activerecord-formatter 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 215510c55bb74fa62a54c9237eed2f99f795916c
-  data.tar.gz: 57949cc504f9e0f5dfefa1e6bb94482c95279b7f
+SHA256:
+  metadata.gz: 3c8cb5d2c352d6067bb7b6a1005ce9d80f257ef818e94da07b03530e705d5934
+  data.tar.gz: a21d87f0badc6b92de0906f3bc7782b6c13dbe89ee40b59ec1b07bf2a40ca1f1
 SHA512:
-  metadata.gz: 5eae4c34002844511d9f683e2c22dc7135825ce36ed46c24f83239fe476551161940ce10dce02881e0f951d6952a189fb19d0ac8c586d5c443bc83452b2e7ffc
-  data.tar.gz: adac5f5c0819573703708c2ee6d34362ff0f127f9c0b67f2c16126901cee2dd84a4ccde4f208120963b1d0b0691722fc9dbc2643cb2b4dd3353a9bec8f6c9bd7
+  metadata.gz: d31c6f727a9c54acde509ce7f8b66185eedeb7825ff18af6b7da27f583ed460e38fafcb17a65bd66b0ceadef2b5a2a2db9cdd7a6821d199568e4b2170a81f23f
+  data.tar.gz: 1265045f094776141c99699dc6f35514de052cb60c7c40893808bb6ebe4ace017c2244c55d3681adb16c3cc7472dcd197bd3e41566ee6cd17ad9a4e102cf556e

data/.gitignore

@@ -1 +1,3 @@
 .DS_Store
+Gemfile.lock
+coverage

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--require spec_helper

data/.simplecov

@@ -0,0 +1,10 @@
+require 'coveralls'
+
+SimpleCov.formatters = [
+  SimpleCov::Formatter::HTMLFormatter,
+  Coveralls::SimpleCov::Formatter
+]
+
+SimpleCov.start do
+  add_filter './spec'
+end

data/.travis.yml

@@ -0,0 +1,8 @@
+language: ruby
+cache: bundler
+
+rvm:
+  - 2.3.3
+
+before_install: gem install bundler
+script: bundle exec rspec

data/README.md

@@ -22,14 +22,18 @@ Normal bundle stuff.
 Usage
 ------------
 
-The current answer appears to be changing your `.rspec` initializer to include the following:
+The current answer is to change your `.rspec` initializer to include the following:
 
-      --require rails_helper
-      --format ActiveRecordFormatter
+    --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.
 
+You can also run the formatter as a one-off option to rspec:
+
+    rspec path/to/example_spec.rb --require rails_helper --format ActiveRecordFormatter
+
 Once you set the formatter, you should now see the number of objects created and total queries
 for each of your tests:
 
@@ -43,8 +47,10 @@ 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).
+* Configuration, especially formatting the output to optionally outdent the counts.
 * Add a `--profile`-like behavior to output the most offending tests.
+* The current dependency versions are a vague guess. They can and should clearly be more lenient.
+* I dunno, tests.
 
 Contributing
 ------------

data/lib/rspec-activerecord-formatter.rb

@@ -0,0 +1 @@
+require 'rspec/activerecord/formatter'

data/lib/rspec/activerecord/formatter.rb

@@ -1,5 +1,71 @@
-require_relative "formatter/collector"
-require_relative "formatter/formatter"
+require_relative "helpers/collector"
 
-module ActiveRecordFormatter
+class ActiveRecordFormatter < ::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      = ActiveRecordFormatterHelpers::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

data/lib/rspec/activerecord/{formatter → helpers}/collector.rb

@@ -1,6 +1,6 @@
 require 'active_support/notifications'
 
-module ActiveRecordFormatter
+module ActiveRecordFormatterHelpers
   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"]

data/rspec-activerecord-formatter.gemspec

@@ -3,12 +3,10 @@
 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.version = "0.2.0"
 
   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"
@@ -31,4 +29,6 @@ Gem::Specification.new do |gem|
   gem.add_dependency "bundler", "~> 1.9"
   gem.add_dependency "activesupport", ">= 4.0"
   gem.add_dependency "rspec", "~> 3.4"
+
+  gem.add_development_dependency "coveralls"
 end

data/spec/collector_spec.rb

@@ -0,0 +1,2 @@
+RSpec.describe ActiveRecordFormatter::Collector do
+end

data/spec/formatter_spec.rb

@@ -0,0 +1,2 @@
+RSpec.describe ActiveRecordFormatter::Formatter do
+end

data/spec/spec_helper.rb

@@ -0,0 +1,54 @@
+require 'simplecov'
+
+require 'rspec/activerecord/formatter'
+
+# This file was generated by the `rspec --init` command. Conventionally, all
+# specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.
+# The generated `.rspec` file contains `--require spec_helper` which will cause
+# this file to always be loaded, without a need to explicitly require it in any
+# files.
+#
+# Given that it is always loaded, you are encouraged to keep this file as
+# light-weight as possible. Requiring heavyweight dependencies from this file
+# will add to the boot time of your test suite on EVERY test run, even for an
+# individual file that may not need all of that loaded. Instead, consider making
+# a separate helper file that requires the additional dependencies and performs
+# the additional setup, and require it from the spec files that actually need
+# it.
+#
+# The `.rspec` file also contains a few flags that are not defaults but that
+# users commonly want.
+#
+# See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
+
+RSpec.configure do |config|
+  # This allows you to limit a spec run to individual examples or groups
+  # you care about by tagging them with `:focus` metadata. When nothing
+  # is tagged with `:focus`, all examples get run. RSpec also provides
+  # aliases for `it`, `describe`, and `context` that include `:focus`
+  # metadata: `fit`, `fdescribe` and `fcontext`, respectively.
+  config.filter_run_when_matching :focus
+
+  # Limits the available syntax to the non-monkey patched syntax that is
+  # recommended. For more details, see:
+  #   - http://rspec.info/blog/2012/06/rspecs-new-expectation-syntax/
+  #   - http://www.teaisaweso.me/blog/2013/05/27/rspecs-new-message-expectation-syntax/
+  #   - http://rspec.info/blog/2014/05/notable-changes-in-rspec-3/#zero-monkey-patching-mode
+  config.disable_monkey_patching!
+
+  # This setting enables warnings. It's recommended, but in some cases may
+  # be too noisy due to issues in dependencies.
+  config.warnings = true
+
+  # Run specs in random order to surface order dependencies. If you find an
+  # order dependency and want to debug it, you can fix the order by providing
+  # the seed, which is printed after each run.
+  #     --seed 1234
+  config.order = :random
+
+  # Seed global randomization in this process using the `--seed` CLI option.
+  # Setting this allows you to use `--seed` to deterministically reproduce
+  # test failures related to randomization by passing the same `--seed` value
+  # as the one that triggered the failure.
+  Kernel.srand config.seed
+end

metadata

@@ -1,57 +1,71 @@
 --- !ruby/object:Gem::Specification
 name: rspec-activerecord-formatter
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Joseph Mastey
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-12-16 00:00:00.000000000 Z
+date: 2019-02-21 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'
+- !ruby/object:Gem::Dependency
+  name: coveralls
+  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: Creates a new formatter for ActiveRecord that can help you diagnose performance
   issues in RSpec
 email: jmmastey@gmail.com
@@ -61,18 +75,23 @@ extra_rdoc_files:
 - CODE_OF_CONDUCT.md
 - README.md
 files:
-- .gitignore
+- ".gitignore"
+- ".rspec"
+- ".simplecov"
+- ".travis.yml"
 - 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.rb
-- lib/rspec/activerecord/formatter/collector.rb
-- lib/rspec/activerecord/formatter/formatter.rb
-- lib/rspec/activerecord/formatter/version.rb
+- lib/rspec/activerecord/helpers/collector.rb
 - rspec-activerecord-formatter.gemspec
+- spec/collector_spec.rb
+- spec/formatter_spec.rb
+- spec/spec_helper.rb
 homepage: http://github.com/jmmastey/rspec-activerecord-formatter
 licenses:
 - MIT
@@ -83,17 +102,17 @@ 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
+rubygems_version: 2.7.6
 signing_key: 
 specification_version: 4
 summary: Adds object creations and queries to Rspec output.

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

@@ -1,71 +0,0 @@
-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

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