undercover 0.1.2 → 0.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 4912afdc776b0f9799d09f6fa347a3991683b3bd
-  data.tar.gz: 9cb73276512755b47bcb49cf6e39264643f0dd2b
+SHA256:
+  metadata.gz: f5a66a64143952a6005a4198ca9887868fb4d945fb2f8eae7285b015fecccd37
+  data.tar.gz: 7dfb19c17f81762209c03a763a9fc2e49f007693195a367698bdc96afce77b4f
 SHA512:
-  metadata.gz: f32ef0b88a932b5c15930440a2e7f9ad474facfc9ba9ddbac1b4188244695ab60682d45f373348fd4ed8f4b2dfc91e51ee5823f4a69d3bfecf2c8ce44041cfb6
-  data.tar.gz: 25ccb7bdf904cb8205434025f73ce4b3b69ccaeead0eaa5ea6013edfdf0e61c4f7bcd95ad83aea293b5d0523cffa5adacc19e0165c2e3dfddd4c5382823ee8d4
+  metadata.gz: 81f95df75a46c1a5b1814d8ab6438793dc37ac4168af4336938e0cfd3239aa4891659fcc66d2c3331480263fb69e486ac895c371c9347cc53dd77a741f9613ae
+  data.tar.gz: d1edd837513823ffc935eb1aaebe01fb3a4b6c1a3d085a00ca328bfe6678a3eaf80e539151236974cbe42f91092558aad89e18d6a1db9b615eef42e7f32902b5

data/.codebeatsettings

@@ -0,0 +1,7 @@
+{
+  "RUBY": {
+    "ABC": [15, 20, 25, 30],
+    "CYCLO": [15, 20, 25, 30],
+    "LOC": [8, 10, 12, 20]
+  }
+}

data/.gitignore

@@ -1,3 +1,4 @@
+Gemfile.lock
 /.bundle/
 /.yardoc
 /_yardoc/

data/.rubocop.yml

@@ -8,7 +8,7 @@ Style/RegexpLiteral:
 Style/Documentation:
   Enabled: false
 
-Style/SpaceInsideHashLiteralBraces:
+Layout/SpaceInsideHashLiteralBraces:
   Enabled: true
   EnforcedStyle: no_space
 

data/README.md

@@ -2,7 +2,9 @@
 
 **RuboCop for code coverage**
 
-Meaningful warnings for methods and classes which lack testing, using data from coverage reports, git metadata and a parsed structure of your Ruby codebase. `undercover` automates the coverage feedback loop and makes sure no code review passes without tests.
+**Inspects files in a git diff and warns on methods, classes and blocks which need test coverage.** Use it locally or as part of an automated build to shorten your code coverage feedback loop!
+
+Technically, `undercover` combines data from git, coverage reports and code structure graphs.
 
 A sample output of `undercover` ran before a commit may look like this:
 
@@ -36,8 +38,6 @@ Or install it yourself as:
 
 ## Setting up required LCOV reporting
 
-Undercover depends on a git diff, code structure generated by [`imagen`](https://github.com/grodowski/imagen_rb) and a coverage report in LCOV format.
-
 To make your specs compatible with `undercover` by providing an LCOV report, please add `simplecov` and `simplecov-lcov` to your test setup. Example for rspec:
 
 ```ruby
@@ -96,7 +96,7 @@ The defaults assume that the program is run from the top level of the project di
 
 ## 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.
+After checking out the repo, run `bundle` to install dependencies. Then, run `rake` to run the tests and RuboCop. You can also run `pry -r 'undercover'` for an interactive prompt that will allow you to experiment.
 
 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).
 

data/bin/undercover

@@ -11,5 +11,5 @@ time = Benchmark.realtime do
   result = Undercover::CLI.run(ARGV)
 end
 
-puts "Undercover finished in #{time}ms"
+puts "Undercover finished in #{time.round(4)}s"
 exit result

data/lib/undercover.rb

@@ -21,19 +21,25 @@ module Undercover
 
     attr_reader :changeset,
                 :lcov,
-                :results
+                :results,
+                :code_dir
 
-    # TODO: pass merge base as cli argument
-    # add dependecy on "options" for all opts (dirs, git_dir, etc)
-    def initialize(lcov_report_path, code_dir, git_dir: '.git', compare: nil)
-      @lcov = LcovParser.parse(File.open(lcov_report_path))
-      @changeset = Changeset.new(File.join(code_dir, git_dir), compare).update
+    # Initializes a new Undercover::Report
+    #
+    # @param options [Undercover::Options]
+    def initialize(opts)
+      @lcov = LcovParser.parse(File.open(opts.lcov))
+      @code_dir = opts.path
+      git_dir = File.join(opts.path, opts.git_dir)
+      @changeset = Changeset.new(git_dir, opts.compare).update
       @results = Hash.new { |hsh, key| hsh[key] = [] }
     end
 
     def build
       each_result_arg do |filename, coverage, imagen_node|
-        results[filename] << Result.new(imagen_node, coverage, filename)
+        results[filename.gsub(/^\.\//, '')] << Result.new(
+          imagen_node, coverage, filename
+        )
       end
       self
     end
@@ -69,17 +75,16 @@ module Undercover
 
     private
 
-    # TODO: some of this could be moved to the imagen gem
     # TODO: should that start from changeset.file_paths?
     # this way we could report things that weren't even loaded in any spec,
     # so is this still good idea? (Rakefile, .gemspec etc)
     def each_result_arg
       match_all = ->(_) { true }
       lcov.source_files.each do |filename, coverage|
-        ast = Imagen::Node::Root.new
-        Imagen::Visitor.traverse(Parser::CurrentRuby.parse_file(filename), ast)
-        ast.children[0].find_all(match_all).each do |node|
-          yield(filename, coverage, node)
+        path = File.join(code_dir, filename)
+        root_ast = Imagen::Node::Root.new.build_from_file(path)
+        root_ast.children[0].find_all(match_all).each do |node|
+          yield(path, coverage, node)
         end
       end
     end

data/lib/undercover/cli.rb

@@ -16,16 +16,9 @@ module Undercover
 
     WARNINGS_TO_EXITCODE = {stale_coverage: 1, no_changes: 0}.freeze
 
-    # TODO: add executable in ./bin later
-    # rubocop:disable Metrics/AbcSize, Metrics/MethodLength
     def self.run(args)
       opts = Undercover::Options.new.parse(args)
-      report = Undercover::Report.new(
-        opts.lcov,
-        opts.path,
-        git_dir: opts.git_dir,
-        compare: opts.compare
-      ).build
+      report = Undercover::Report.new(opts).build
 
       error = report.validate(opts.lcov)
       if error
@@ -37,6 +30,5 @@ module Undercover
       puts Undercover::Formatter.new(warnings)
       warnings.any? ? 1 : 0
     end
-    # rubocop:enable Metrics/AbcSize, Metrics/MethodLength
   end
 end

data/lib/undercover/options.rb

@@ -25,7 +25,6 @@ module Undercover
       @run_mode = RUN_MODE_DIFF_STRICT
       @enabled_formatters = [OUTPUT_STDOUT]
       # set defaults
-      self.lcov = guess_lcov_path
       self.path = '.'
       self.git_dir = '.git'
     end
@@ -54,6 +53,7 @@ module Undercover
         # --exit-status (do not print report, just exit)
         # --ruby-version (string, like '2.4.4', how to support in parser?)
       end.parse(args)
+      guess_lcov_path unless lcov
       self
     end
     # rubocop:enable Metrics/MethodLength
@@ -87,8 +87,8 @@ module Undercover
     end
 
     def guess_lcov_path
-      pwd = Pathname.pwd
-      File.join(pwd, 'coverage', 'lcov', "#{pwd.split.last}.lcov")
+      cwd = Pathname.new(File.expand_path(path))
+      self.lcov = File.join(cwd, 'coverage', 'lcov', "#{cwd.split.last}.lcov")
     end
   end
 end

data/lib/undercover/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Undercover
-  VERSION = '0.1.2'
+  VERSION = '0.1.3'
 end

data/undercover.gemspec

@@ -22,7 +22,7 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(/^bin\//) { |f| File.basename(f) }
   spec.require_paths = ['lib']
 
-  spec.add_dependency 'imagen', '~> 0.1.1'
+  spec.add_dependency 'imagen', '~> 0.1.2'
   spec.add_dependency 'rainbow', '~> 3.0.0'
   spec.add_dependency 'rugged', '~> 0.27.0'
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: undercover
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.1.3
 platform: ruby
 authors:
 - Jan Grodowski
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-05-18 00:00:00.000000000 Z
+date: 2018-05-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: imagen
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.1.1
+        version: 0.1.2
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.1.1
+        version: 0.1.2
 - !ruby/object:Gem::Dependency
   name: rainbow
   requirement: !ruby/object:Gem::Requirement
@@ -172,12 +172,12 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
+- ".codebeatsettings"
 - ".gitignore"
 - ".rspec"
 - ".rubocop.yml"
 - ".travis.yml"
 - Gemfile
-- Gemfile.lock
 - LICENSE.txt
 - README.md
 - Rakefile
@@ -213,7 +213,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.14.1
+rubygems_version: 2.7.6
 signing_key: 
 specification_version: 4
 summary: Actionable code coverage - detects untested code blocks in recent changes

data/Gemfile.lock

@@ -1,76 +0,0 @@
-PATH
-  remote: .
-  specs:
-    undercover (0.1.2)
-      imagen (~> 0.1.1)
-      rainbow (~> 3.0.0)
-      rugged (~> 0.27.0)
-
-GEM
-  remote: https://rubygems.org/
-  specs:
-    ast (2.4.0)
-    coderay (1.1.2)
-    diff-lcs (1.3)
-    docile (1.3.0)
-    imagen (0.1.1)
-      parser
-    json (2.1.0)
-    method_source (0.9.0)
-    parallel (1.12.1)
-    parser (2.5.1.0)
-      ast (~> 2.4.0)
-    powerpack (0.1.1)
-    pry (0.11.3)
-      coderay (~> 1.1.0)
-      method_source (~> 0.9.0)
-    rainbow (3.0.0)
-    rake (10.5.0)
-    rspec (3.7.0)
-      rspec-core (~> 3.7.0)
-      rspec-expectations (~> 3.7.0)
-      rspec-mocks (~> 3.7.0)
-    rspec-core (3.7.1)
-      rspec-support (~> 3.7.0)
-    rspec-expectations (3.7.0)
-      diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.7.0)
-    rspec-mocks (3.7.0)
-      diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.7.0)
-    rspec-support (3.7.1)
-    rubocop (0.55.0)
-      parallel (~> 1.10)
-      parser (>= 2.5)
-      powerpack (~> 0.1)
-      rainbow (>= 2.2.2, < 4.0)
-      ruby-progressbar (~> 1.7)
-      unicode-display_width (~> 1.0, >= 1.0.1)
-    ruby-progressbar (1.9.0)
-    rugged (0.27.0)
-    simplecov (0.16.1)
-      docile (~> 1.1)
-      json (>= 1.8, < 3)
-      simplecov-html (~> 0.10.0)
-    simplecov-html (0.10.2)
-    simplecov-lcov (0.7.0)
-    timecop (0.9.1)
-    unicode-display_width (1.3.2)
-
-PLATFORMS
-  ruby
-  x86_64-darwin-17
-
-DEPENDENCIES
-  bundler (~> 1.16)
-  pry
-  rake (~> 10.0)
-  rspec (~> 3.0)
-  rubocop (~> 0.55.0)
-  simplecov
-  simplecov-lcov
-  timecop
-  undercover!
-
-BUNDLED WITH
-   1.16.2