simplecov-tdd 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: eecc7193441832d9a0fa36b2cbad35da148fba17
-  data.tar.gz: 2b6bc9c591fe4ffc4fa11b9951d015ed624e7e56
+SHA256:
+  metadata.gz: 678d4521b0050e2b500bf036c4e32031352bc1fa00ab8f2a9aecb7cd2125febd
+  data.tar.gz: 33b54df0fd182be3c66bd5bbc9131c4414ba6c158d4381c9959bcd4edd593203
 SHA512:
-  metadata.gz: b146adda2629ee2f253bf2dcc191882b66078d43096bb6ac62f25a79fc394b2d33bf80cf299e0523145a8ca8b2bf31b1874283472a3adf9d9763bf53fe70b29c
-  data.tar.gz: 1fa2334a1d6733c1c4a30a1f74843087ac26fab6b90a83d770ee8814db4b9d5ee8da0a03b04dec49db5f82fd9e72aa7aeb20147ab53f2c2669cb0bef288ce5c6
+  metadata.gz: b08b96e78e4b3ae6aeceb124513e52fb2527394d50cde2858db863b8fb75c9eddb8142942784c12c81931359b256f7d1c815f6b3feab8f80209c95603ad5eeef
+  data.tar.gz: 48a4a28e253328074c0a2e05fe616d064e2257af0090830cbd760d44a27dc831e303739a722dad5308536987752057c9be4031fd93d2bfbcaf3947ed19b7480c

data/CHANGELOG.md

@@ -1,3 +1,21 @@
+0.2.0 (2019-03-06)
+==================
+## Features
+* Added style_output configuration option. There are two options: [:simple, :verbose].
+:simple is the default, while :verbose outputs line numbers along with source code that
+is missing coverage.
+* Added debug_mode configuration option for investigating mismatched filenames. Default is disabled
+
+## Improvements
+* Improved output of the current tested file to start with the app/ directory instead
+of full path
+* Slight optimizations done to the way the current filename is detected
+* Better documentation added
+
+## Bug fixes
+* Files previously containing the phrase 'spec' as part of their name would be
+improperly formatted. This caused these files to come up as mismatches.
+
 0.1.0 (2019-02-20)
 ==================
 ## Features

data/README.md

@@ -1,6 +1,8 @@
 # Simplecov::Tdd
 
-A SimpleCov formatter for test driven development
+A SimpleCov formatter for test driven development. Displays code coverage results in the console for single files
+
+![Example TDD](https://github.com/joshmfrankel/simplecov-tdd/blob/master/example.gif)
 
 ## Installation
 
@@ -21,15 +23,72 @@ Or install it yourself as:
 ## Usage
 
 1. Ensure that you've configured your project to SimpleCov's _Getting Started_ section: https://github.com/colszowka/simplecov#getting-started
-2. Set your `SimpleCov.formatter` to the following:
+2. Set your SimpleCov configuration to the following:
 
 ```ruby
+require "simplecov/tdd"
 SimpleCov.formatter = Simplecov::Formatter::Tdd
+# OR use multi-formatter
+SimpleCov.formatters = SimpleCov::Formatter::MultiFormatter.new([
+  SimpleCov::Formatter::HTMLFormatter,
+  Simplecov::Formatter::Tdd
+])
+```
+
+Simple Setup:
+
+```ruby
+# /spec/spec_helper.rb
+require "simplecov"
+require "simplecov/tdd"
+SimpleCov.formatter = SimpleCov::Formatter::Tdd
+SimpleCov.start 'rails'
 ```
-3. Run your tests using rspec path/to/file_spec.rb or guard
+
+3. Run your tests using `rspec path/to/file_spec.rb` or `guard`
 4. Fix the missing coverage
 5. 💰 Profit! 💰
 
+## Configuration options
+
+There are a few configuration options that may be set before formatting is called.
+Generally you may place these after `SimpleCov.formatter` or `SimpleCov.formatters = SimpleCov::Formatter::MultiFormatter.new` in your setup.
+
+### output_style (default: :simple)
+When there are lines missing coverage, this option determines how to display output.
+The accepted values are `:simple` (default) or `:verbose`.
+
+```ruby
+SimpleCov::Formatter::Tdd.output_style = :verbose
+```
+
+Here's an example of what :verbose output looks like:
+
+```ruby
+app/models/matched_90.rb
+90.0% coverage, 167 total lines
+
+The following 2 lines have missing coverage:
+[5, 25]
+
+line | source code
+-------------------
+5 => obj.is_a?(SomeClass)
+25 => SomeClass.explode!
+```
+
+### debug_mode (default: false)
+This is useful for determining if the current file being tested doesn't have
+a match from SimpleCov's file list.
+
+```ruby
+SimpleCov::Formatter::Tdd.debug_mode = true
+```
+
+## Future Features
+
+* Support for minitest
+
 ## 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.

data/lib/simplecov/tdd.rb

@@ -3,51 +3,91 @@ require "simplecov/tdd/version"
 
 module SimpleCov
   module Formatter
+
+    # A SimpleCov formatter for generating single file results while using
+    # test driven development principles
     class Tdd
       attr_reader :result
 
-      def format(coverage_results, debug: false)
+      # Hook into SimpleCov format by defining specific implementation
+      # of #format for the TDD formatter
+      def format(coverage_results)
         @result = single_result(coverage_results)
 
+        # Is there a matching result?
         if result.nil?
-          raise StandardError, "Could not find #{current_filename} as part of the SimpleCov::FileList results" if debug
-          return
+          raise StandardError, "Could not find #{current_filename} as part of the SimpleCov::FileList results" if debug_mode
+          return # Early return silently dies outside of debug mode
         end
 
-        puts current_filename
-        coverage_overview_text
-        missed_line_numbers_message
+        puts format_filename_for_output
+        puts coverage_overview_text
+        puts missed_line_numbers_message
+      end
+
+      # Class level attr_writer
+      # @param style [Symbol] the symbol representation of the output_style
+      #   accepted values are: [:simple, :verbose]
+      def self.output_style=(style)
+        @output_style = style
+      end
+
+      # Class level attr_reader
+      def self.output_style
+        @output_style
+      end
+
+      # Instance level method that defers to class_level variable when
+      # set via configuration. The default output_style is :simple
+      def output_style
+        self.class.output_style || :simple
+      end
+
+      # Class level attr_writer
+      # @param flag [Boolean] the current status (true/false) of debug mode
+      def self.debug_mode=(flag)
+        @debug_mode = flag
+      end
+
+      # Class level attr_reader
+      def self.debug_mode
+        @debug_mode
+      end
+
+      # Instance level method that defers to class_level variable when
+      # set via configuration. The default debug_mode is false
+      def debug_mode
+        self.class.debug_mode || false
       end
 
       private
 
-      # From SimpleCov::FileList match the current_filename to a corresponding
-      # coverage result
+      # Match the current file against the SimpleCov::FileList results to determine
+      # a matching test
+      # @param coverage_results [SimpleCov::Result] the incoming results from running
+      #   SimpleCov after tests
       def single_result(coverage_results)
-        coverage_results.files.select { |file| file.filename == current_filename }[0]
+        coverage_results.files.detect { |file| file.filename == current_filename }
       end
 
       # Infer the current_filename based on incoming ARGV command line
       # arguments and a matching spec type file
       def current_filename
         @_current_filename ||= begin
-          # @todo Can we hook into Guard watched file? That would be more accurate
           # @TODO support for minitest
-
-          argument_index = nil
-          ARGV.each.with_index do |arg, index|
-            if arg.match(/_spec.rb/)
-              argument_index = index
-              break
-            end
-          end
+          argument_index = ARGV.find_index { |arg| arg.match(/_spec.rb/) }
 
           if argument_index
-            Dir.pwd + "/" + ARGV[argument_index].sub("spec", "app").sub("_spec", "")
+            Dir.pwd + "/" + ARGV[argument_index].sub("spec/", "app/").sub("_spec.rb", ".rb")
           end
         end
       end
 
+      # Format the currently matched filename to be more human readable
+      def format_filename_for_output
+        "app/" + current_filename.split("/app/")[1]
+      end
+
       # @todo tty support for colors
       def coverage_overview_text
         covered_percent = result.covered_percent.round(2)
@@ -67,13 +107,28 @@ module SimpleCov
           end
         end
 
-        puts colorized_overview_text
+        colorized_overview_text
       end
 
+      # Display the missing line numbers in a summary message
       def missed_line_numbers_message
         return if result.covered_percent == 100
 
-        puts "\nThe following #{missed_line_numbers.size} lines have missing coverage: \n\e[31m#{missed_line_numbers}\e[0m"
+        "\nThe following #{missed_line_numbers.size} lines have missing coverage: \n\e[31m#{missed_line_numbers}\e[0m".tap do |output|
+          output << missed_line_numbers_verbose_message
+        end
+      end
+
+      # When output_style == :verbose, display a table that includes the
+      # line number missing converage as well as the related code
+      def missed_line_numbers_verbose_message
+        return "" if output_style != :verbose
+
+        "\nline | source code\n-------------------\n".tap do |output|
+          result.missed_lines.each do |missed_line|
+            output << missed_line.line_number.to_s + " => " + missed_line.src.strip + "\n"
+          end
+        end
       end
 
       def missed_line_numbers

data/lib/simplecov/tdd/version.rb

@@ -1,5 +1,5 @@
 module SimpleCov
   module Tdd
-    VERSION = "0.1.0"
+    VERSION = "0.2.0"
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: simplecov-tdd
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Josh Frankel
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-02-21 00:00:00.000000000 Z
+date: 2019-03-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: simplecov
@@ -99,6 +99,7 @@ files:
 - Rakefile
 - bin/console
 - bin/setup
+- example.gif
 - lib/simplecov/tdd.rb
 - lib/simplecov/tdd/version.rb
 - simplecov-tdd.gemspec
@@ -120,8 +121,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.6.13
+rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
 summary: SimpleCov formatter for test driven development