rubycritic 2.1.0 → 2.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 5cf713113af44f9c325495284ffc4e6845688c8e
-  data.tar.gz: 508db135f5cf808c7b012ee19dc5d82db0872e82
+  metadata.gz: 1bbd53ca30b1e2cae94b44246ca2df4f1ef200bb
+  data.tar.gz: 584e3a45c1c3ae04c261366b706699c5087effea
 SHA512:
-  metadata.gz: 6ef195a2c4913ab047af9227575e96295d6ba988931d8586faf4ada2fb026b4d9898b824c9bd87f4f9c1469199bedb37f645d7710efd4cb5efdab8732df947c7
-  data.tar.gz: 2d13ac2809f5e5f7d01c38dd18a69c593bc3afcc994a386a50b1a479eeda185b9ecd5c63cbc7e2752c62ffd2bb36560daf8be879a04a7eb90ffb0fe5164328d2
+  metadata.gz: 9a452882ed7dc3cb9bd8ab6817650a4f475ea06cc465ff7c9d9290495578be1ad76c04eb31cd66155813a88d14ad28c44c43280f2bcef7d0a5a521d8e8abd97c
+  data.tar.gz: 2b2f54e2f3f40363bdd9f628e0f0fa0ff742dde3ad217aa69f0d25e2bb0424bc3a8119a37937e42c49fbf197604c5e4ae54e1c8d0fb3459f90662461165f9609

data/.gitignore

@@ -15,3 +15,4 @@ spec/reports
 test/tmp
 test/version_tmp
 tmp
+.idea/

data/.travis.yml

@@ -1,3 +1,4 @@
+sudo: false
 language: ruby
 
 rvm:

data/CHANGELOG.md

@@ -1,3 +1,7 @@
+# 2.2.0 / 2015-11-20
+
+* [CHANGE] Use `Reeks` default configuration loading.
+
 # 2.1.0 / 2015-11-11
 
 * [CHANGE] Bump flay dependency to 2.6.1.

data/CONTRIBUTING.md

@@ -32,8 +32,8 @@ Each commit should do one thing and one thing only. For example, all whitespace
 
 9. [Create a Pull Request] and send it to be merged with the master branch.
 
-10. After your code is reviewed, [hide the sausage making]. Squash, split and reorder commits if necessary (`git rebase -i`).
-For a more in-depth look at interactive rebasing, be sure to check [how to rewrite history].
+10. After your code is reviewed, [hide the sausage making]. We follow the "one commit per pull request" [principle](http://ndlib.github.io/practices/one-commit-per-pull-request/) since this allows for a clean git history, easy handling of features and convenient rollbacks when things go wrong. Or in one sentence: You can have as many commits as you want in your pull request, but after the final review and before the merge you need to squash all of those in one single commit.
+For a more in-depth look at interactive rebasing, be sure to check [how to rewrite history] as well.
 
 Improving the Documentation
 ---------------------------

data/README.md

@@ -100,6 +100,14 @@ $ rubycritic --help
 | `--deduplicate-symlinks` | De-duplicate symlinks based on their final target     |
 | `--suppress-ratings`     | Suppress letter ratings                               |
 
+Analyzer Configuration
+-------------------------
+
+* `Reek`: `RubyCritic` just uses `Reek`'s default [configuration loading mechanism](https://github.com/troessner/reek#configuration-file).
+
+This section is work in progress at the moment and is missing the other analyzers that RubyCritic supports.
+You can expect this to be updated soon.
+
 Alternative Usage Methods
 -------------------------
 
@@ -131,6 +139,17 @@ Similarly, Pull Requests that improve the look and feel of the gem, that tweak t
 
 See RubyCritic's [contributing guidelines](CONTRIBUTING.md) about how to proceed.
 
+Contributors / Core Team
+---------------
+
+`RubyCritics` initial author was [Guilherme Simões](https://github.com/guilhermesimoes).
+
+The current core team consists of:
+
+* [Nuno Silva](https://github.com/Onumis)
+* [Lucas Mazza](https://github.com/lucasmazza)
+* [Timo Rößner](https://github.com/troessner)
+
 Credits
 -------
 

data/lib/rubycritic/analysers/helpers/reek.rb

@@ -1,15 +1,6 @@
 require "reek"
-require "reek/configuration/app_configuration"
-require "ostruct"
 
 module Rubycritic
-
   class Reek < ::Reek::Examiner
-    DEFAULT_CONFIG_FILE = File.expand_path("../config.reek", __FILE__)
-
-    def initialize(pathname)
-      config = ::Reek::Configuration::AppConfiguration.from_path(DEFAULT_CONFIG_FILE)
-      super(pathname, [], :configuration => config)
-    end
   end
 end

data/lib/rubycritic/version.rb

@@ -1,3 +1,3 @@
 module Rubycritic
-  VERSION = "2.1.0"
+  VERSION = "2.2.0"
 end

data/test/lib/rubycritic/analysers/smells/reek_test.rb

@@ -11,25 +11,15 @@ describe Rubycritic::Analyser::ReekSmells do
     end
 
     it "detects its smells" do
-      @analysed_module.smells.length.must_equal 1
+      @analysed_module.smells.length.must_equal 2
     end
 
     it "creates smells with messages" do
-      smell = @analysed_module.smells.first
-      smell.message.must_equal "has boolean parameter 'reek'"
-    end
-  end
-
-  context "when analysing a file with smells ignored in config.reek" do
-    before do
-      pathname = Pathname.new("test/samples/reek/not_smelly.rb")
-      @analysed_module = AnalysedModuleDouble.new(:pathname => pathname, :smells => [])
-      analysed_modules = [@analysed_module]
-      Rubycritic::Analyser::ReekSmells.new(analysed_modules).run
-    end
+      first_smell = @analysed_module.smells.first
+      first_smell.message.must_equal "has no descriptive comment"
 
-    it "does not detect those smells" do
-      @analysed_module.smells.must_be_empty
+      last_smell = @analysed_module.smells.last
+      last_smell.message.must_equal "has boolean parameter 'reek'"
     end
   end
 end

data/test/samples/reek/smelly.rb

@@ -3,3 +3,10 @@ class Theon
     reek
   end
 end
+
+# Reek should report
+# [1]:Theon has no descriptive comment (IrresponsibleModule)
+# [2]:Theon#reeks? has boolean parameter 'reek' (BooleanParameter)
+# This comment is below the module because otherwise Reek will interpret this
+# as a comment describing the module which would thus prevent
+# IrresponsibleModule from being reported.

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rubycritic
 version: !ruby/object:Gem::Version
-  version: 2.1.0
+  version: 2.2.0
 platform: ruby
 authors:
 - Guilherme Simoes
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-11-11 00:00:00.000000000 Z
+date: 2015-11-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: virtus
@@ -180,7 +180,6 @@ files:
 - lib/rubycritic/analysers/churn.rb
 - lib/rubycritic/analysers/complexity.rb
 - lib/rubycritic/analysers/helpers/ast_node.rb
-- lib/rubycritic/analysers/helpers/config.reek
 - lib/rubycritic/analysers/helpers/flay.rb
 - lib/rubycritic/analysers/helpers/flog.rb
 - lib/rubycritic/analysers/helpers/methods_counter.rb
@@ -301,7 +300,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.5
+rubygems_version: 2.4.6
 signing_key: 
 specification_version: 4
 summary: RubyCritic is a Ruby code quality reporter

data/lib/rubycritic/analysers/helpers/config.reek

@@ -1,26 +0,0 @@
----
-Attribute:
-  enabled: false
-DuplicateMethodCall:
-  max_calls: 2
-IrresponsibleModule:
-  enabled: false
-NestedIterators:
-  max_allowed_nesting: 2
-TooManyStatements:
-  enabled: false
-UncommunicativeMethodName:
-  reject:
-  - !ruby/regexp /^[a-z]$/
-  - !ruby/regexp /[0-9]$/
-UncommunicativeParameterName:
-  reject:
-  - !ruby/regexp /^.$/
-  - !ruby/regexp /[0-9]$/
-  - !ruby/regexp /^_/
-UncommunicativeVariableName:
-  reject:
-  - !ruby/regexp /^.$/
-  - !ruby/regexp /[0-9]$/
-UtilityFunction:
-  enabled: false