rubycritic 3.1.3 → 3.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 3251286e7b987d5055afe5a7c2f47ee7aff9b9a6
-  data.tar.gz: b49bad4f415c7a6aaacdfe7039a06e9f90fcd99d
+  metadata.gz: 203294c974eb1596d663eb40e75d346c56b4fc77
+  data.tar.gz: 16cdb0ac81e39e8255bee278522b2f489760b2f3
 SHA512:
-  metadata.gz: af5eb2ab7965ed2bccb20a73db500688809e7ad305147b92680eaa650fbb22c5bb6fc4dd78dd19b9cd49bbfedf26f1a86eb3b2b01b88d097c6f9842d3690c335
-  data.tar.gz: b2ebed2b4d96b5187e9a6fbd4079183a6885cdb2f6a64083a49af9417b17d0f1ef826abdb175ff85b4fe4daa0ec65929566cbd172ffbd7cd7567e4af4ef72004
+  metadata.gz: 67b05900a1bf52a173bdcbd425f055c2fa341ccf06528720e26f49628b686172d68e426fac892f266bda23eafb524d1c15994b87e55bc358b7c0ee0ed54738c7
+  data.tar.gz: 75d2903c9d6c34ec56992596b2a034275420953b6a5bd0f2831c006aa6b887a866dd0ffba7854d37c0f5174f191a7707e93bc500022ca6007d61f8cc35b3260e

data/.rubocop.yml

@@ -18,4 +18,19 @@ Metrics/LineLength:
 Style/Documentation:
   Enabled: false
 
+Security/MarshalLoad:
+  Enabled: false
+  Include:
+    - 'lib/rubycritic/serializer.rb'
+
+Style/RedundantFreeze:
+  Enabled: false
+  Include:
+    - 'lib/rubycritic/core/smell.rb'
+    - 'lib/rubycritic/generators/json/simple.rb'
+    - 'lib/rubycritic/revision_comparator.rb'
+    - 'lib/rubycritic/source_control_systems/perforce.rb'
+    - 'lib/rubycritic/source_locator.rb'
+    - 'lib/rubycritic/version.rb'
+
 inherit_from: .rubocop_todo.yml

data/.travis.yml

@@ -8,13 +8,14 @@ matrix:
     - rvm: 2.1
     - rvm: 2.2
     - rvm: 2.3.3
+    - rvm: 2.4.0
     - rvm: ruby-head
-    - rvm: jruby-9.1.5.0
+    - rvm: jruby-9.1.8.0
       env: JRUBY_OPTS='--debug' # get more accurate coverage data
     - rvm: rbx-3
   allow_failures:
     - rvm: ruby-head
-    - rvm: jruby-9.1.5.0
+    - rvm: jruby-9.1.8.0
     - rvm: rbx-3
   fast_finish: true
 script: bundle exec rake

data/.yardopts

@@ -0,0 +1,5 @@
+--no-private
+--use-cache
+--asset images
+lib/**/*.rb -
+README.md LICENSE.txt CHANGELOG.md

data/CHANGELOG.md

@@ -1,5 +1,11 @@
 # master (unreleased)
 
+# 3.2.0 / 2017-03-24
+
+* [CHANGE] Update `rubocop` to 0.47.1 from 0.42.0 (by [@jdickey][])
+* [CHANGE] Update for Ruby 2.4.0 compatibility; update `parser` gem to 2.4.0 (by [@jdickey][])
+* [CHANGE] Improve YARD documentation (by [@olleolleolle][] and [@tejasbubane][])
+
 # 3.1.3 / 2016-12-19
 
 * [BUGFIX] Fix crash with the usage of an unavailable color in "rainbow" gem  (by [@thedrow][])
@@ -190,3 +196,4 @@
 [@josephpage]: https://github.com/josephpage
 [@hoshinotsuyoshi]: https://github.com/hoshinotsuyoshi
 [@thedrow]: https://github.com/thedrow
+[@jdickey]: https://github.com/jdickey

data/README.md

@@ -5,7 +5,7 @@ RubyCritic
 [![Build Status](https://travis-ci.org/whitesmith/rubycritic.svg?branch=master)](https://travis-ci.org/whitesmith/rubycritic)
 [![Code Climate](https://codeclimate.com/github/whitesmith/rubycritic/badges/gpa.svg)](https://codeclimate.com/github/whitesmith/rubycritic)
 
-<img src="/images/logo.png" alt="RubyCritic Icon" align="right" />
+<img src="https://github.com/whitesmith/rubycritic/raw/master/images/logo.png" alt="RubyCritic Icon" align="right" />
 RubyCritic is a gem that wraps around static analysis gems such as [Reek][1], [Flay][2] and [Flog][3] to provide a quality report of your Ruby code.
 
 **Table of Contents**
@@ -28,15 +28,15 @@ This gem provides features such as:
 
 1. An overview of your project:
 
-  ![RubyCritic overview screenshot](/images/overview.png)
+  ![RubyCritic overview screenshot](https://github.com/whitesmith/rubycritic/raw/master/images/overview.png)
 
 2. An index of the project files with their respective number of smells:
 
-  ![RubyCritic code index screenshot](/images/code.png)
+  ![RubyCritic code index screenshot](https://github.com/whitesmith/rubycritic/raw/master/images/code.png)
 
 3. An index of the smells detected:
 
-  ![RubyCritic smells index screenshot](/images/smells.png)
+  ![RubyCritic smells index screenshot](https://github.com/whitesmith/rubycritic/raw/master/images/smells.png)
 
 4. When analysing code like the following:
 
@@ -52,11 +52,11 @@ This gem provides features such as:
 
   It basically turns something like this:
 
-  ![Reek output screenshot](/images/reek.png)
+  ![Reek output screenshot](https://github.com/whitesmith/rubycritic/raw/master/images/reek.png)
 
   Into something like this:
 
-  ![RubyCritic file code screenshot](/images/smell-details.png)
+  ![RubyCritic file code screenshot](https://github.com/whitesmith/rubycritic/raw/master/images/smell-details.png)
 
 5. It uses your source control system (only Git, Mercurial and Perforce
   are currently supported) to compare your currently uncommitted
@@ -65,7 +65,7 @@ This gem provides features such as:
   **Warning**: If your code is not as you expect it to be after running
   RubyCritic, please check your source control system stash.
 
-Checkout the `/docs` if you want to read more about our [core metrics](./docs/core-metrics.md).
+Checkout the `/docs` if you want to read more about our [core metrics](https://github.com/whitesmith/rubycritic/blob/master/docs/core-metrics.md).
 
 
 ## Getting Started
@@ -188,6 +188,7 @@ RubyCritic is supporting:
 * 2.1
 * 2.2
 * 2.3
+* 2.4
 
 
 ## Improving RubyCritic
@@ -198,7 +199,7 @@ Arguably, the [better_errors gem][7] only got popular after receiving a [(pretty
 
 Similarly, Pull Requests that improve the look and feel of the gem, that tweak the calculation of ratings or that fix existing issues will be most welcome. Just commenting on an issue and giving some insight into how something should work will be appreciated. No contribution is too small.
 
-See RubyCritic's [contributing guidelines](CONTRIBUTING.md) about how to proceed.
+See RubyCritic's [contributing guidelines](https://github.com/whitesmith/rubycritic/blob/master/CONTRIBUTING.md) about how to proceed.
 
 
 ## Contributors
@@ -215,7 +216,7 @@ The current core team consists of:
 
 ## Credits
 
-![Whitesmith](/images/whitesmith.png)
+![Whitesmith](https://github.com/whitesmith/rubycritic/raw/master/images/whitesmith.png)
 
 RubyCritic is maintained and funded by [Whitesmith][9]. Tweet your questions or suggestions to [@Whitesmithco][10].
 
@@ -224,7 +225,7 @@ RubyCritic is maintained and funded by [Whitesmith][9]. Tweet your questions or
 [3]: https://github.com/seattlerb/flog
 [4]: https://github.com/whitesmith/guard-rubycritic
 [5]: http://jenkins-ci.org/
-[6]: ./docs/building-own-code-climate.md
+[6]: https://github.com/whitesmith/rubycritic/blob/master/docs/building-own-code-climate.md
 [7]: https://github.com/charliesome/better_errors
 [8]: https://github.com/charliesome/better_errors/pull/22
 [9]: http://www.whitesmith.co/

data/lib/rubycritic/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module RubyCritic
-  VERSION = '3.1.3'.freeze
+  VERSION = '3.2.0'.freeze
 end

data/rubycritic.gemspec

@@ -21,21 +21,21 @@ Gem::Specification.new do |spec|
   spec.test_files    = `git ls-files -- test/*`.split("\n")
   spec.require_path  = 'lib'
 
-  spec.add_runtime_dependency 'virtus', '~> 1.0'
   spec.add_runtime_dependency 'flay', '~> 2.8'
   spec.add_runtime_dependency 'flog', '~> 4.4'
+  spec.add_runtime_dependency 'launchy', '2.4.3'
+  spec.add_runtime_dependency 'parser', '2.4.0'
+  spec.add_runtime_dependency 'rainbow', '~> 2.1'
   spec.add_runtime_dependency 'reek', '~> 4.4'
-  spec.add_runtime_dependency 'parser', '2.3.3.1'
   spec.add_runtime_dependency 'ruby_parser', '~> 3.8'
-  spec.add_runtime_dependency 'rainbow', '~> 2.1'
-  spec.add_runtime_dependency 'launchy', '2.4.3'
+  spec.add_runtime_dependency 'virtus', '~> 1.0'
 
-  spec.add_development_dependency 'aruba'
-  spec.add_development_dependency 'bundler', '~> 1.3'
-  spec.add_development_dependency 'cucumber'
-  spec.add_development_dependency 'fakefs'
-  spec.add_development_dependency 'rake'
-  spec.add_development_dependency 'minitest', '~> 5.3'
-  spec.add_development_dependency 'mocha', '~> 1.1'
-  spec.add_development_dependency 'rubocop', '>= 0.42.0'
+  spec.add_development_dependency 'aruba', '~> 0.12', '>= 0.12.0'
+  spec.add_development_dependency 'bundler', '~> 1.3', '>= 1.3.0'
+  spec.add_development_dependency 'cucumber', '~> 2.2', '>= 2.2.0'
+  spec.add_development_dependency 'fakefs', '~> 0.10', '>= 0.10.0'
+  spec.add_development_dependency 'minitest', '~> 5.3', '>= 5.3.0'
+  spec.add_development_dependency 'mocha', '~> 1.1', '>= 1.1.0'
+  spec.add_development_dependency 'rake', '~> 11.0', '>= 11.0.0'
+  spec.add_development_dependency 'rubocop', '~> 0.47', '>= 0.47.1'
 end

data/test/samples/location/file0_symlink.rb

@@ -0,0 +1 @@
+test/samples/location/file0.rb

metadata

@@ -1,29 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: rubycritic
 version: !ruby/object:Gem::Version
-  version: 3.1.3
+  version: 3.2.0
 platform: ruby
 authors:
 - Guilherme Simoes
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-12-19 00:00:00.000000000 Z
+date: 2017-03-24 00:00:00.000000000 Z
 dependencies:
-- !ruby/object:Gem::Dependency
-  name: virtus
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.0'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.0'
 - !ruby/object:Gem::Dependency
   name: flay
   requirement: !ruby/object:Gem::Requirement
@@ -53,89 +39,109 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '4.4'
 - !ruby/object:Gem::Dependency
-  name: reek
+  name: launchy
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - '='
       - !ruby/object:Gem::Version
-        version: '4.4'
+        version: 2.4.3
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - '='
       - !ruby/object:Gem::Version
-        version: '4.4'
+        version: 2.4.3
 - !ruby/object:Gem::Dependency
   name: parser
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 2.3.3.1
+        version: 2.4.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 2.3.3.1
+        version: 2.4.0
 - !ruby/object:Gem::Dependency
-  name: ruby_parser
+  name: rainbow
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.8'
+        version: '2.1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.8'
+        version: '2.1'
 - !ruby/object:Gem::Dependency
-  name: rainbow
+  name: reek
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.1'
+        version: '4.4'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.1'
+        version: '4.4'
 - !ruby/object:Gem::Dependency
-  name: launchy
+  name: ruby_parser
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.4.3
+        version: '3.8'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.4.3
+        version: '3.8'
+- !ruby/object:Gem::Dependency
+  name: virtus
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
 - !ruby/object:Gem::Dependency
   name: aruba
   requirement: !ruby/object:Gem::Requirement
     requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.12'
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.12.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.12'
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.12.0
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -143,6 +149,9 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.3'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.3.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -150,90 +159,129 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.3'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.3.0
 - !ruby/object:Gem::Dependency
   name: cucumber
   requirement: !ruby/object:Gem::Requirement
     requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.2'
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 2.2.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.2'
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 2.2.0
 - !ruby/object:Gem::Dependency
   name: fakefs
   requirement: !ruby/object:Gem::Requirement
     requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.10'
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.10.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.10'
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.10.0
 - !ruby/object:Gem::Dependency
-  name: rake
+  name: minitest
   requirement: !ruby/object:Gem::Requirement
     requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.3'
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 5.3.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.3'
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 5.3.0
 - !ruby/object:Gem::Dependency
-  name: minitest
+  name: mocha
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '5.3'
+        version: '1.1'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.1.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '5.3'
+        version: '1.1'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.1.0
 - !ruby/object:Gem::Dependency
-  name: mocha
+  name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.1'
+        version: '11.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 11.0.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.1'
+        version: '11.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 11.0.0
 - !ruby/object:Gem::Dependency
   name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.47'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.42.0
+        version: 0.47.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.47'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.42.0
+        version: 0.47.1
 description: RubyCritic is a tool that wraps around various static analysis gems to
   provide a quality report of your Ruby code.
 email:
@@ -248,6 +296,7 @@ files:
 - ".rubocop_todo.yml"
 - ".todo.reek"
 - ".travis.yml"
+- ".yardopts"
 - CHANGELOG.md
 - CONTRIBUTING.md
 - Gemfile
@@ -439,7 +488,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.8
+rubygems_version: 2.6.10
 signing_key: 
 specification_version: 4
 summary: RubyCritic is a Ruby code quality reporter