rubycritic 2.9.1 → 2.9.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: bbbcd64b6e1f0d249b3f97919ef56592a4128bf3
-  data.tar.gz: 1bdf4b409bbcf75613d7bb33feffb8b434d89112
+  metadata.gz: 22e5c323d28fee5bc92ef613ca7435aae70d50a0
+  data.tar.gz: 3836b3346a5b98e90c99d6ac1da9f2faaaeabbff
 SHA512:
-  metadata.gz: 4dec6334a9163a9484fe5d2a1d8f82b7c895f1d5dd1331531547f7000e11931e09c64ffc2fb04b056040077b220b26062b189dba91977f8e09e8081197a5d22e
-  data.tar.gz: 82a5e47a652aecef5f11f46c8053dcb7cc6da82462d9f2b071019e150d3c9b5c05383e011f4fe1b49c3e19277011c59694455a97ffa60f5a4f82c84787524bbf
+  metadata.gz: 8e349b4ba246bc9c2d40544eeba7908d1cdc71b8af6f7c0a5b54f929f4a085acfcde10d15047e53a956310b44e4739a95b3dd7d52d566c843e3d60b80a389b2b
+  data.tar.gz: b1e9c59fd761ac53096663b9a0deea0433f0d2158618595e1d88c8fa038116f68b0f31e11625ef8157a596883c156d9abe1f270202c0faad0deb12b0000972b3

data/CHANGELOG.md

@@ -1,3 +1,10 @@
+# 2.9.2 / 2016-07-01
+
+* [CHANGE] Upgrade rubocop to 0.41.1 (by nijikon)
+* [CHANGE] Upgrade flog to 4.4.0 (by nijikon)
+* [CHANGE] Upgrade flay to 2.8.0 (by nijikon)
+* [CHANGE] Upgrade Reek to 4.1.0 and Parser to 2.3.1.2 (by y-yagi)
+
 # 2.9.1 / 2016-05-16
 
 * [CHANGE] Upgrade 'parser' to 2.3.1.0 (by y-yagi)

data/README.md

@@ -8,6 +8,22 @@ RubyCritic
 <img src="http://i.imgur.com/66HACCD.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**
+
+- [Overview](#overview)
+- [Getting Started](#getting-started)
+- [Usage](#usage)
+  + [Analyzer Configuration](#analyzer-configuration)
+  + [Alternative Usage Methods](#alternative-usage-methods)
+  + [Rake Task](#rake-task)
+- [Compatibility](#compatibility)
+- [Improving RubyCritic](#improving-rubyCritic)
+- [Contributors](#contributors)
+- [Credits](#credits)
+
+
+## Overview
+
 This gem provides features such as:
 
 1. An overview of your project:
@@ -48,8 +64,10 @@ 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.
 
-Getting Started
----------------
+Checkout the `/docs` if you want to read more about our [core metrics](./docs/core-metrics.md).
+
+
+## Getting Started
 
 RubyCritic can be installed with the following command:
 
@@ -70,8 +88,8 @@ And then execute:
 $ bundle
 ```
 
-Usage
------
+
+## Usage
 
 Running `rubycritic` with no arguments will analyse all the Ruby files in the
 current directory:
@@ -101,8 +119,8 @@ $ rubycritic --help
 | `--deduplicate-symlinks` | De-duplicate symlinks based on their final target     |
 | `--suppress-ratings`     | Suppress letter ratings                               |
 
-Analyzer Configuration
--------------------------
+
+### Analyzer Configuration
 
 * [`Reek`](https://github.com/troessner/reek): `RubyCritic` utilizes `Reek`'s default [configuration loading mechanism](https://github.com/troessner/reek#configuration-file).
   This means that if you have an existing `Reek` configuration file, you can just put this into your
@@ -113,15 +131,15 @@ Analyzer Configuration
     * `continue`: Makes it so that `flog` does not abort when a ruby file cannot be parsed.
     * `methods`: Configures `flog` to skip code outside of methods. It prevents `flog` from reporting on the "methods" `private` and `protected`. It also prevents `flog` from reporting on Rails methods like `before_action` and `has_many`.
 
-Alternative Usage Methods
--------------------------
+
+### Alternative Usage Methods
 
 If you're fond of Guard you might like [guard-rubycritic][4]. It automatically analyses your Ruby files as they are modified.
 
 For continuous integration, you can give [Jenkins CI][5] a spin. With it, you can [easily build your own (poor-man's) Code Climate][6]!
 
-Rake Task
----------
+
+### Rake Task
 
 You can use RubyCritic as Rake command in its most simple form like this:
 
@@ -159,8 +177,8 @@ RubyCritic::RakeTask.new do |task|
 end
 ```
 
-Compatibility
----------------
+
+## Compatibility
 
 RubyCritic is supporting:
 
@@ -168,8 +186,8 @@ RubyCritic is supporting:
 * 2.2
 * 2.3
 
-Improving RubyCritic
---------------------
+
+## Improving RubyCritic
 
 RubyCritic doesn't have to remain a second choice to other code quality analysis services. Together, we can improve it and continue to build on the great code metric tools that are available in the Ruby ecosystem.
 
@@ -179,8 +197,9 @@ 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
----------------
+
+## Contributors
+
 
 `RubyCritics` initial author was [Guilherme Simões](https://github.com/guilhermesimoes).
 
@@ -190,8 +209,8 @@ The current core team consists of:
 * [Lucas Mazza](https://github.com/lucasmazza)
 * [Timo Rößner](https://github.com/troessner)
 
-Credits
--------
+
+## Credits
 
 ![Whitesmith](http://i.imgur.com/Si2l3kd.png)
 
@@ -202,7 +221,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]: https://github.com/whitesmith/rubycritic/wiki/Building-your-own-Code-Climate
+[6]: ./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/docs/building-own-code-climate.md

@@ -0,0 +1,152 @@
+# Building your own Code Climate
+
+## Installing Jenkins
+
+There are [official guides for installing Jenkins][1] on pretty much any platform. After following the most suitable one, Jenkins should be running on the Build Server (your machine or AWS, for example).
+
+From this point forward, everything should be installed under the Jenkins user account on the Build Server. Switching user accounts can be achieved by running the Switch User command:
+
+```bash
+$ sudo su - jenkins
+```
+
+In the likely event that you don't know your Jenkins user's password, run the following command to change it:
+
+```bash
+$ sudo passwd jenkins
+```
+
+## Installing Ruby
+
+There are many different [ways to install Ruby][2], RVM and rbenv being the two most popular ones. RVM has a nice [guide on using RVM with Jenkins][3]. Regardless of what you choose, you should now have Ruby running on the Build Server and be able to install any gems.
+
+Ensure that everything is working correctly by running the following command:
+
+```bash
+$ ruby --version
+```
+
+## Installing gems
+
+You should install two gems after installing Ruby: Bundler and RubyCritic. You can do so with the following command:
+
+```bash
+$ gem install bundler rubycritic
+```
+
+## Installing Git
+
+Next up, Git should be installed since Jenkins needs it to be able to clone your repositories in order to analyse them. [This is the installation guide recommended][4] to install Git.
+
+Ensure that everything is working correctly by running the following command:
+
+```bash
+$ git --version
+```
+
+## Generating SSH Keys
+
+SSH keys are a way to identify trusted computers without involving passwords. GitHub has an excellent guide on [generating SSH keys][5] which you should definitely follow.
+
+However, you may want to create a GitHub account just for your Jenkins user. The alternative requires you to add the new SSH Key to your account which, from a security standpoint, is probably a bad idea.
+
+Ensure that everything is working correctly by running the following command:
+
+```bash
+$ ssh -T git@github.com
+```
+
+## Configuring Jenkins
+
+Jenkins should be running automatically after being installed. The Jenkins UI should be accessible at `http://localhost:8080/` in your browser. The next few steps all take place in that UI.
+
+### Enabling Security
+
+By default Jenkins is not secure which means anyone is able to run commands on the Build Server and access your private projects. There are many [ways to secure Jenkins][6], but the simplest one is standard authentication with a username and password.
+
+From the main page, head to `Manage Jenkins` and then to `Configure Global Security` where the option `Enable security` should be checked. Still on the same page, select `Jenkins' own user database` under `Security Realm` and leave `Allow users to sign up` enabled for now.
+
+After configuring these options, a new `sign up` link should appear in the top right corner of every page. After signing up and returning to the `Configure Global Security` page where you were before, it's time to set up some restrictions. The easiest way to do so is to select the option `Logged-in users can do anything` instead of the usual `Anyone can do anything` under `Authorization` and then deselect the option `Allow users to sign up`.
+
+Ensure that everything is working correctly by logging out and logging in again. If you have any problems after these steps and can no longer access Jenkins, you can [reset its security settings][7] and try again.
+
+### Installing Plugins
+
+Installing a Jenkins Plugin is extremely easy. All you have to do is proceed to `Manage Jenkins`, go to `Manage Plugins`, select the `Available` tab and then check the desired plugin.
+
+To build your own Code Climate, three plugins are needed:
+
+  * [GitHub][8], which triggers jobs when you push to a GitHub repository.
+
+  * [Git][9], which allows cloning Git repositories.
+
+  * [HTML Publisher][10], which persists RubyCritic's reports and creates a web interface to access them.
+
+However, you can install many other plugins that will improve your Build server, like:
+
+  * [Jenkins ci skip][11], which skips a build when `[ci skip]` is added to a commit's message.
+
+## Creating Your First Job
+
+Finally, it's time to set up the job that will run in the Build Server after every push. Head to the main page and then to `New Item`. Give the job a name (like the name of your project) and select the option `Build a free-style software project`. Clicking the `OK` button will create the job and take you to the configuration page for that job.
+
+Under `Source Code Management` select `Git` and enter your project's repository URL. If your project is private, then you need to set up Jenkins' credentials so that GitHub can authorize it. This was the reason for setting up Jenkins' SSH key beforehand. Now all that has to be done is to click the `Add` button on the far right, pick the `kind` of credentials `SSH Username with private key` and select the `Private key` option `from the Jenkins master ~/.ssh`. Confirm these new credentials by clicking another `Add` button.
+
+Under `Branches to build` you can enter one or more branches that you want Jenkins to build against. The default is `*/master` but you can leave the `branch` field blank so that Jenkins builds against any changed branch.
+
+Under `Build Triggers` select `Build when a change is pushed to GitHub`, and start configuring the `Build` script. Click the dropdown `Add build step`, select the `Execute shell` option and in the new textarea enter the script to be run after every push. The possibilities here are endless. You could:
+
+  * Build a Continuous Integration server like Travis. To do so, the script could consist in just the following commands:
+
+  ```bash
+  bundle
+  rake
+  ```
+
+  These commands would install all the gems defined in your project's Gemfile and run the project's tests.
+
+  If you had installed Ruby through RVM, your project was a gem and you wished to test it using different, stable Ruby versions, you might change the script to something like this:
+
+  ```bash
+  #!/bin/bash
+  rvm use 1.9.3
+  bundle
+  rake
+  rvm use 2.1
+  bundle
+  rake
+  ```
+
+  Please note that the first line specifies bash as the shell that runs the script and is **necessary** for the script to successfully run.
+
+  * Build a service like Code Climate using the RubyCritic gem. In that case, the script could consist in just the following command:
+
+  ```bash
+  rubycritic app lib
+  ```
+
+  However, Jenkins isolates and cleans the workspace after every build thus making it necessary to use the HTML Publisher plugin (previously installed) to persist the reports generated by RubyCritic.
+
+  Under `Post-build Actions` select `Publish HTML reports`, enter `tmp/rubycritic/` as the `HTML directory to archive`, `overview.html` as the `Index page` and give a title to the report. If you select the option `Keep past HTML reports`, you'll be able to access previous RubyCritic reports, giving you more insight into where your project has been and where it is heading.
+
+Finally, click the `Save` button to save your job configuration. You can try out your build right away by clicking the `Build Now` button.
+
+## Setting Up A GitHub Service
+
+The last step is to set up GitHub integration so that a push triggers a new job in the Build Server. You’ll need admin access to your project's repository to be able to change its settings. On the repository page navigate to `Settings`, `Webhooks & Services` and click the `Add service` button. Select the `Jenkins (GitHub plugin)` options and set the `Jenkins hook url`.
+
+This URL is the same as the one you use to access the Jenkins UI followed by `/github-webhook/`. On AWS, for example, your URL could look something like `http://ec2-12-34-567-890.amazonaws.com:8080/github-webhook/`.
+
+And you're finally done! After every push to GitHub your Build Server should run RubyCritic and present its results, very much like Code Climate!
+
+[1]: https://wiki.jenkins-ci.org/display/JENKINS/Installing+Jenkins
+[2]: https://www.ruby-lang.org/en/installation/
+[3]: https://rvm.io/integration/jenkins
+[4]: http://git-scm.com/book/en/Getting-Started-Installing-Git
+[5]: https://help.github.com/articles/generating-ssh-keys
+[6]: https://wiki.jenkins-ci.org/display/JENKINS/Securing+Jenkins
+[7]: https://wiki.jenkins-ci.org/display/JENKINS/Disable+security
+[8]: https://wiki.jenkins-ci.org/display/JENKINS/GitHub+Plugin
+[9]: https://wiki.jenkins-ci.org/display/JENKINS/Git+Plugin
+[10]: https://wiki.jenkins-ci.org/display/JENKINS/HTML+Publisher+Plugin
+[11]: https://github.com/banyan/jenkins-ci-skip-plugin

data/docs/core-metrics.md

@@ -0,0 +1,72 @@
+# Core Metrics, Score and Rating
+
+RubyCritic wraps around static analysis gems such as [Reek][2], [Flay][3] and [Flog][4] to provide a quality report of your Ruby code.
+
+Each of these gems are internally wrapped as an **Analyser**, with a collection of **AnalysedModule**s, which give us calculations of key metrics.
+The most important ones are **churn**, **complexity**, **cost** and **rating**. 
+
+The output of RubyCritic will give you four values to help you judge your code's _odorousness_:
+
+- [**Score**](#score): A generic number representing overall quality of the analysed code
+- [**Churn**](#churn-and-complexity): Number of times a file was changed
+- [**Complexity**](#churn-and-complexity): Amount of _pain_ in your code
+- [**Rating**](#rating): The grade assigned to a file
+
+RubyCritic's **rating** system was inspired by Code Climate's, you can [read more about how that works here][1].
+Note that the global **score** is fairly different from Code Climate's GPA, although it serves the same purpose.
+
+## Score
+
+Is a value that ranges from 0 to 100, where higher values are better (less code smells detected) and is intended to provide a quick insight about the overall code quality.
+
+This is basically an average of the calculated [cost](#cost) of each file.
+There is a [threshold][6] to avoid very bad modules from having excessive impact.
+
+## Churn and complexity
+
+Churn is very simple to calculate - it is the number of times the file was committed.
+
+Complexity is the output of [Flog][4]. You can [read more about how it works][7], but here's a quick summary:
+
+> It works based on counting your code's ABCs:
+>
+> A - Assignments. When more objects are assigned, the complexity goes up - foo = 1 + 1.
+>
+> B - Branches. When code branches, there are multiple paths that it might follow. This also increases it's complexity.
+>
+> C - Calls. When code calls other code, the complexity increases because they caller and callee are now connected. A call is both a method call or other action like eval or puts.
+>
+> All code has assignments, branches, and calls. Flog's job is to check that they aren't used excessively or abused.
+
+Both **churn** and **complexity** are presented as a chart:
+
+![RubyCritic overview screenshot](http://i.imgur.com/oiE5O3X.png)
+
+Each file is represented by a dot. **The closer they are to the bottom-left corner, the better.**
+But keep in mind that you cannot reduce churn (well... not unless you re-write your repo's history :neckbeard:), so try to keep the dots as close to the bottom as possible.
+Chad made a nice [summary if you want to know more][8] about the meaning behind each quadrant.
+
+
+## Rating
+
+This is a letter from `A` to `F`, `A` being the best. This serves as a baseline to tell you how *smelly* a file is.
+Generally `A`'s & `B`'s are good enough, `C`'s serve as a warning and `D`'s & `F`'s are the ones you should be fixing.
+
+**Rating** is simply [a conversion][5] from the calculated **cost** to a letter.
+
+![RubyCritic code index screenshot](http://i.imgur.com/a0GCn48.png)
+
+### Cost
+
+The definition of this **cost** varies from tool to tool, but it's always a non-negative number, with high values indicating worse smells.
+The **complexity** of a file also (slightly) affects its final cost.
+
+
+[1]: https://gist.github.com/brynary/21369b5892525e1bd102
+[2]: https://github.com/troessner/reek
+[3]: https://github.com/seattlerb/flay
+[4]: https://github.com/seattlerb/flog
+[5]: https://github.com/whitesmith/rubycritic/blob/master/lib/rubycritic/core/rating.rb
+[6]: https://github.com/whitesmith/rubycritic/blob/master/lib/rubycritic/core/analysed_modules_collection.rb
+[7]: http://www.railsinside.com/tutorials/487-how-to-score-your-rails-apps-complexity-before-refactoring.html
+[8]: https://github.com/chad/turbulence#hopefully-meaningful-metrics

data/lib/rubycritic/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Rubycritic
-  VERSION = '2.9.1'.freeze
+  VERSION = '2.9.2'.freeze
 end

data/rubycritic.gemspec

@@ -21,10 +21,10 @@ Gem::Specification.new do |spec|
   spec.require_path  = 'lib'
 
   spec.add_runtime_dependency 'virtus', '~> 1.0'
-  spec.add_runtime_dependency 'flay', '2.7.0'
-  spec.add_runtime_dependency 'flog', '4.3.2'
-  spec.add_runtime_dependency 'reek', '4.0.2'
-  spec.add_runtime_dependency 'parser', '2.3.1.0'
+  spec.add_runtime_dependency 'flay', '2.8.0'
+  spec.add_runtime_dependency 'flog', '4.4.0'
+  spec.add_runtime_dependency 'reek', '4.1.0'
+  spec.add_runtime_dependency 'parser', '2.3.1.2'
   spec.add_runtime_dependency 'ruby_parser', '~> 3.8'
   spec.add_runtime_dependency 'colorize'
   spec.add_runtime_dependency 'launchy', '2.4.3'
@@ -35,6 +35,6 @@ Gem::Specification.new do |spec|
   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.40.0'
+  spec.add_development_dependency 'rubocop', '>= 0.41.1'
   spec.add_development_dependency 'pry-byebug'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rubycritic
 version: !ruby/object:Gem::Version
-  version: 2.9.1
+  version: 2.9.2
 platform: ruby
 authors:
 - Guilherme Simoes
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-05-16 00:00:00.000000000 Z
+date: 2016-07-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: virtus
@@ -30,56 +30,56 @@ dependencies:
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 2.7.0
+        version: 2.8.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 2.7.0
+        version: 2.8.0
 - !ruby/object:Gem::Dependency
   name: flog
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 4.3.2
+        version: 4.4.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 4.3.2
+        version: 4.4.0
 - !ruby/object:Gem::Dependency
   name: reek
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 4.0.2
+        version: 4.1.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 4.0.2
+        version: 4.1.0
 - !ruby/object:Gem::Dependency
   name: parser
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 2.3.1.0
+        version: 2.3.1.2
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 2.3.1.0
+        version: 2.3.1.2
 - !ruby/object:Gem::Dependency
   name: ruby_parser
   requirement: !ruby/object:Gem::Requirement
@@ -210,16 +210,16 @@ dependencies:
   name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 0.40.0
+        version: 0.41.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 0.40.0
+        version: 0.41.1
 - !ruby/object:Gem::Dependency
   name: pry-byebug
   requirement: !ruby/object:Gem::Requirement
@@ -255,6 +255,8 @@ files:
 - README.md
 - Rakefile
 - bin/rubycritic
+- docs/building-own-code-climate.md
+- docs/core-metrics.md
 - features/command_line_interface/minimum_score.feature
 - features/command_line_interface/options.feature
 - features/rake_task.feature
@@ -454,4 +456,3 @@ test_files:
 - test/samples/reek/smelly.rb
 - test/samples/unparsable.rb
 - test/test_helper.rb
-has_rdoc: