coverfield 0.0.4 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c9769d1a0bdcb6d2f686f03b0fe60207779fc2e3
-  data.tar.gz: 41b064b0ea8701426554cd0326228cc4f8a9edc0
+  metadata.gz: c06502048cd2cfbb46d8383572891c9a6a4ebff8
+  data.tar.gz: 1156c6922c0181fd7267ed4bd3fe9a370127aad5
 SHA512:
-  metadata.gz: 9e27ac0765a91a7c474a1022107d951bc6f7362423fb9d80ab460ae78e6d6503ba249ec09f3309620a7f3b1b6d6d56f497004110b3624967efce9582885e7234
-  data.tar.gz: 0c09947fd5dfe20d34bcba1b9ee09500a58153c4ae1e43e6fe1cbda8ae99f14b3231cbaa48bb16f651c894d217aedc476bda6e593b4382f43ac2e172462f4efb
+  metadata.gz: 1be8dfd4b92c3e2b0d6188c3fee72e8f28868994d284e600bad14eaba2a317932e0f186337f44c8290fe8934e3406308a2004d3d489f0a98a897af582dba5fcb
+  data.tar.gz: b33d06bb0e8d0bd9155294110fc245ec8f5ed3c351e438000c2add9d6ac6f4d1c4a84360c5e682cbfa51c38083695032de21206c59ac38508116221079506b30

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    coverfield (0.0.2)
+    coverfield (0.1.0)
       colorize (~> 0.7)
       rubocop (~> 0.40)
 
@@ -31,4 +31,4 @@ DEPENDENCIES
   coverfield!
 
 BUNDLED WITH
-   1.12.4
+   1.12.5

data/README.md

@@ -1,5 +1,9 @@
 # Coverfield
 
+[![Gem Version](http://img.shields.io/gem/v/coverfield.svg)](http://badge.fury.io/rb/coverfield)
+
+**Warning:** Alpha Release, do not rely on or use in production yet!
+
 One day I found a class in my ruby app with > 95% coverage in
 [SimpleCov](https://github.com/colszowka/simplecov) but without any dedicated
 spec. SimpleCov is an awesome tool if you want to get an idea of your test
@@ -30,11 +34,11 @@ test suite.
 
 ## Future
 
-This project has still prototype character and there's plenty to do like
-respecting `:nocov:` tags and so on.
+This project has still prototype character (this is an alpha release) and
+there's plenty to do (specs for example).
 
-And I'm gonna contact [Christoph Olszowka](https://github.com/colszowka) to ask
-him if there is a chance that this code will be included to SimpleCov in some
+And I wrote [Christoph Olszowka](https://github.com/colszowka) to ask
+him if there is a chance that this will be included to SimpleCov in some
 way. I would really appreciate that!
 
 
@@ -66,8 +70,9 @@ Coverfield requires you to have a specific architecture of your RSpec Suite.
 2. Within `spec` all specs are placed in the same path as the file which is
    tested by the spec. For example the spec for the file
    `/lib/some/nice_class.rb` have to be placed in
-   `/spec/lib/some/nice_class_spec.rb`. And the spec for the file
-   `/app/models/post.rb` goes to `/spec/models/post.rb`
+   `/spec/lib/some/nice_class_spec.rb` or `/spec/some/nice_class_spec.rb`.
+   And the spec for the file `/app/models/post.rb` goes to
+   `/spec/app/models/post.rb` or `/spec/models/post.rb`
    [Why?](http://stackoverflow.com/questions/14180003/rspec-naming-conventions-for-files-and-directory-structure)
 3. The first `describe` call have to be built like that:
    `describe Some::NiceClass do` assuming, that `/lib/some/nice_code.rb` defines
@@ -76,3 +81,4 @@ Coverfield requires you to have a specific architecture of your RSpec Suite.
 4. All inner `describe` calls for the methods have to be built like that:
    `describe '#method_name' do`. The `#` is optional and may also be a `.`.
    [Why?](http://betterspecs.org/#describe)
+5. All dependencies of your app have to be installed (`bundle install`).

data/bin/coverfield

@@ -9,9 +9,9 @@ require 'colorize'
 APP_ROOT = Bundler.root.to_s
 
 require 'coverfield'
-require 'coverfield/source_class'
-require 'coverfield/source_file'
-require 'coverfield/test_file'
+require 'coverfield/source/class'
+require 'coverfield/source/file'
+require 'coverfield/source/test_file'
 
 
 # Ensure there are paths to search for
@@ -25,31 +25,41 @@ target_files = target_finder.find(paths)
 
 
 # Map all found files to SourceFiles
-source_files = target_files.map { |file| Coverfield::SourceFile.new(file) }
+source_files = target_files.map { |file| Coverfield::Source::File.new(file) }
 
-overall_covered = 0
-overall_methods = 0
 
-# Iterate over all found files and their classes
+# Initialize counter variables
+total_covered = 0
+total_methods = 0
+total_relevant_methods = 0
+
+# Iterate over all found files and their classes for fancy output
 source_files.each do |file|
   file.classes.each do |cls|
-    class_name = (cls.module_name.to_s + (cls.module_name.empty? ? '' : '::') + cls.name.to_s).light_blue
-    coverage = "#{file.coverage}/#{cls.methods.size}"
-    covered = file.coverage == cls.methods.size
+    class_name = cls.full_qualified_name.to_s.light_blue
+    coverage = "#{file.coverage}/#{cls.relevant_method_count}/#{cls.method_count}"
+    covered = file.coverage == cls.relevant_method_count
     puts "#{covered ? '[X]'.green : '[ ]'.red} Found class: #{class_name} with #{covered ? coverage.green : coverage.red} covered methods in #{file.relative_file_name.light_blue}".bold
 
     file.hints.each do |hint|
       puts "    - #{hint}"
     end
 
-    overall_methods += cls.methods.size
-    overall_covered += file.coverage
+    total_methods += cls.method_count
+    total_relevant_methods += cls.relevant_method_count
+    total_covered += file.coverage
 
     puts
   end
 end
 
+relevant_percent = (total_relevant_methods * 100 / total_methods).round.to_s + '%'
+covered_percent = (total_covered * 100 / total_methods).round.to_s + '%'
+uncovered_percent = ((total_relevant_methods - total_covered) * 100 / total_methods).round.to_s + '%'
 
 puts
-puts "Have found #{overall_methods.to_s.yellow} methods and #{overall_covered.to_s.yellow} are covered by tests. Thus there are #{(overall_methods - overall_covered).to_s.yellow} uncovered methods."
+puts "There are #{total_methods.to_s.yellow} methods in total."
+puts "#{total_relevant_methods.to_s.yellow} (#{relevant_percent.yellow}) of them are relevant for coverage."
+puts "And #{total_covered.to_s.yellow} (#{covered_percent.yellow}) methods are covered by tests."
+puts "Thus there are #{(total_relevant_methods - total_covered).to_s.yellow} (#{uncovered_percent.yellow}) uncovered methods."
 puts

data/lib/coverfield/source/class.rb

@@ -0,0 +1,37 @@
+require 'coverfield/source/method'
+
+class Coverfield::Source::Class
+  attr_reader :name, :module_name, :node, :methods, :source_file
+
+  # Constructor
+  public def initialize(class_name, module_name, node, source_file)
+    @name = class_name
+    @module_name = module_name
+    @node = node
+    @methods = []
+    @source_file = source_file
+    find_methods
+  end
+
+  public def full_qualified_name
+    name = @name
+    name = "#{@module_name}::#{name}" unless @module_name.empty?
+    name
+  end
+
+  public def relevant_method_count
+    relevant_methods = @methods.select { |m| !m.nocov?}
+    relevant_methods.size
+  end
+
+  public def method_count
+    @methods.size
+  end
+
+  # Finds all methods
+  private def find_methods
+    node.each_node(:def) do |node|
+      @methods << Coverfield::Source::Method.new(*node, self)
+    end
+  end
+end

data/lib/coverfield/source/file.rb

@@ -0,0 +1,109 @@
+require 'coverfield/source/file_methods'
+require 'coverfield/source/test_file'
+require 'coverfield/source/class'
+require 'coverfield/source/nocov_range'
+
+class Coverfield::Source::File
+  include Coverfield::Source::FileMethods
+
+  attr_reader :classes, :test_file, :coverage, :hints
+
+  # Constructor
+  public def initialize(file_name)
+    @file_name = file_name
+    @classes = []
+    @coverage = 0
+    @hints = []
+    @nocov_ranges = []
+
+    unless File.zero?(file_name)
+      parse_code
+      find_nocov_ranges
+      find_classes
+      find_test_file
+      calculate_coverage
+    end
+  rescue Exception => e
+    raise RuntimeError, "Error while processing file #{file_name}: #{e.message}", e.backtrace
+  end
+
+
+  # Calculates the number of covered methods of this file and sets @coverage and @hints
+  private def calculate_coverage
+    @coverage = 0
+
+    classes.each do |cls|
+      cls.methods.each do |method|
+        if test_file.cover?(cls.full_qualified_name, method.name)
+          @coverage += 1
+        else
+          method_name = "#{cls.name}.#{method.name}".red
+
+          if method.nocov?
+            @coverage += 1
+          else
+            @hints << "Missing test for #{method_name} in #{test_file.relative_file_name.yellow}"
+          end
+        end
+      end
+    end
+  end
+
+
+  public def nocov?(method_body_node)
+    @nocov_ranges.each do |nocov_range|
+      return true if nocov_range.includes?(method_body_node)
+    end
+
+    false
+  end
+
+
+  # Find class definitions
+  private def find_classes
+    @processed_source.ast.each_node(:class) do |node|
+      name, superclass, body = *node
+      _scope, const_name, value = *name
+      module_name = node.parent_module_name
+
+      if module_name == 'Object'
+        nothing, scope_name, nothing = *_scope
+        module_name = scope_name.to_s
+      end
+
+      @classes << Coverfield::Source::Class.new(const_name, module_name, node, self)
+    end
+  end
+
+
+  # Find the spec file for that class
+  private def find_test_file
+    spec_path = APP_ROOT + '/spec'
+    relative_file_name = @file_name.to_s.gsub(APP_ROOT, '')
+    @test_file = Coverfield::Source::TestFile.new(spec_path + relative_file_name.gsub('.rb', '_spec.rb'))
+
+    # When no file was found also try without '/lib' or '/app'
+    unless @test_file.file_exists?
+      relative_file_name.gsub!(/^\/(lib|app)/, '')
+      @test_file = Coverfield::Source::TestFile.new(spec_path + relative_file_name)
+    end
+  end
+
+
+  private def find_nocov_ranges
+    first = true
+    line = 0
+
+    @processed_source.comments.each do |comment|
+      if comment.type == :inline && comment.text.strip =~ /^#\s*\:nocov\:/
+        if first
+          line = comment.loc.expression.first_line
+        else
+          @nocov_ranges << Coverfield::Source::NocovRange.new(line, comment.loc.expression.first_line)
+        end
+
+        first = !first
+      end
+    end
+  end
+end

data/lib/coverfield/{file_methods.rb → source/file_methods.rb}

@@ -1,4 +1,4 @@
-module Coverfield::FileMethods
+module Coverfield::Source::FileMethods
   attr_reader :file_name
 
   # Parse the source code
@@ -11,4 +11,4 @@ module Coverfield::FileMethods
   public def relative_file_name
     @file_name.gsub(APP_ROOT + '/', '')
   end
-end
+end

data/lib/coverfield/source/method.rb

@@ -0,0 +1,14 @@
+class Coverfield::Source::Method
+  attr_reader :name, :args, :body, :source_class
+
+  public def initialize(method_name, args, body, source_class)
+    @name = method_name
+    @args = args
+    @body = body
+    @source_class = source_class
+  end
+
+  public def nocov?
+    @source_class.source_file.nocov? @body
+  end
+end

data/lib/coverfield/source/nocov_range.rb

@@ -0,0 +1,11 @@
+class Coverfield::Source::NocovRange
+  public def initialize(first_line, last_line)
+    @first_line = first_line
+    @last_line = last_line
+  end
+
+  public def includes?(node)
+    source_range = node.source_range
+    source_range.first_line > @first_line && source_range.last_line < @last_line
+  end
+end

data/lib/coverfield/{test_file.rb → source/test_file.rb}

@@ -1,5 +1,7 @@
-class Coverfield::TestFile
-  include Coverfield::FileMethods
+require 'coverfield/source/file_methods'
+
+class Coverfield::Source::TestFile
+  include Coverfield::Source::FileMethods
 
   # Constructor
   public def initialize(file_name)
@@ -37,6 +39,7 @@ class Coverfield::TestFile
 
   # Small helper method which builts the full qualified class name out of a describe arguments node
   private def get_spec_class_name(describe_args_node)
+    return describe_args_node if describe_args_node.is_a?(String)
     subject_ary = []
 
     describe_args_node.each_node(:const) do |const_part|
@@ -52,6 +55,7 @@ class Coverfield::TestFile
   private def find_describes
     # Contains the current test subject where alls test methods should be associated with
     current_subject = nil
+    first_describe = true
 
     # Iterate over all send nodes (method calls)
     @processed_source.ast.each_node(:send) do |node|
@@ -60,15 +64,25 @@ class Coverfield::TestFile
 
       # We only care if it's a describe() call
       if method_name == :describe
-        if args.const_type?
+        if first_describe || args.const_type?
           # If it's a const, it's the first describe, which describes the class/module to test
           current_subject = get_spec_class_name(args)
           @describes[current_subject] = []
         else
           # Otherwise, get the String argument, it will contain something like '#method_name'
           value, nothing = *args.each_node(:str).first
+
+          if value == nil
+            # That happens if the argument is a symbol
+            value, nothing = *args.each_node(:sym).first
+            value = value.to_s
+          end
+
           @describes[current_subject] << value.strip.gsub(/^(?:\.|#)(.+)$/i, '\1')
+
         end
+
+        first_describe = false
       end
     end
   end

data/lib/coverfield/version.rb

@@ -1,5 +1,5 @@
 module Coverfield
-  version = '0.0.4'
+  version = '0.1.0'
 
   def version.to_a
     split('.').map(&:to_i)
@@ -22,4 +22,4 @@ module Coverfield
   end
 
   VERSION = version
-end
+end

data/lib/coverfield.rb

@@ -1,3 +1,4 @@
 module Coverfield
-
-end
+  module Source
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: coverfield
 version: !ruby/object:Gem::Version
-  version: 0.0.4
+  version: 0.1.0
 platform: ruby
 authors:
 - Benjamin Klein
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-06-20 00:00:00.000000000 Z
+date: 2016-06-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rubocop
@@ -69,10 +69,12 @@ files:
 - bin/coverfield
 - coverfield.gemspec
 - lib/coverfield.rb
-- lib/coverfield/file_methods.rb
-- lib/coverfield/source_class.rb
-- lib/coverfield/source_file.rb
-- lib/coverfield/test_file.rb
+- lib/coverfield/source/class.rb
+- lib/coverfield/source/file.rb
+- lib/coverfield/source/file_methods.rb
+- lib/coverfield/source/method.rb
+- lib/coverfield/source/nocov_range.rb
+- lib/coverfield/source/test_file.rb
 - lib/coverfield/version.rb
 homepage: http://github.com/phortx/coverfield
 licenses:

data/lib/coverfield/source_class.rb

@@ -1,26 +0,0 @@
-class Coverfield::SourceClass
-  attr_reader :name, :module_name, :node, :methods
-
-  # Constructor
-  public def initialize(class_name, module_name, node)
-    @name = class_name
-    @module_name = module_name
-    @node = node
-    @methods = []
-    find_methods
-  end
-
-  public def full_qualified_name
-    name = @name
-    name = "#{@module_name}::#{name}" unless @module_name.empty?
-    name
-  end
-
-  # Finds all methods
-  private def find_methods
-    node.each_node(:def) do |node|
-      method_name, args, body = *node
-      @methods << method_name
-    end
-  end
-end

data/lib/coverfield/source_file.rb

@@ -1,66 +0,0 @@
-require 'coverfield/file_methods'
-
-class Coverfield::SourceFile
-  include Coverfield::FileMethods
-
-  attr_reader :classes, :test_file, :coverage, :hints
-
-  # Constructor
-  public def initialize(file_name)
-    @file_name = file_name
-    @classes = []
-    @coverage = 0
-    @hints = []
-
-    unless File.zero?(file_name)
-      parse_code
-      find_classes
-      find_test_file
-      calculate_coverage
-    end
-  rescue Exception => e
-    raise RuntimeError, "Error while processing file #{file_name}: #{e.message}", e.backtrace
-  end
-
-
-  # Calculates the number of covered methods of this file and sets @coverage and @hints
-  public def calculate_coverage
-    @coverage = 0
-
-    classes.each do |cls|
-      cls.methods.each do |method_name|
-        if test_file.cover?(cls.full_qualified_name, method_name)
-          @coverage += 1
-        else
-          method_name = "#{cls.name}.#{method_name}".red
-          @hints << "Missing test for #{method_name} in #{test_file.relative_file_name.yellow}"
-        end
-      end
-    end
-  end
-
-
-  # Find class definitions
-  private def find_classes
-    @processed_source.ast.each_node(:class) do |node|
-      name, superclass, body = *node
-      _scope, const_name, value = *name
-      module_name = node.parent_module_name
-
-      if module_name == 'Object'
-        nothing, scope_name, nothing = *_scope
-        module_name = scope_name.to_s
-      end
-
-      @classes << Coverfield::SourceClass.new(const_name, module_name, node)
-    end
-  end
-
-
-  # Find the spec file for that class
-  private def find_test_file
-    relative_file_name = @file_name.to_s.gsub(APP_ROOT, '')
-    relative_file_name.gsub!('/app', '')
-    @test_file = Coverfield::TestFile.new(APP_ROOT + '/spec' + relative_file_name.gsub('.rb', '_spec.rb'))
-  end
-end