polishgeeks-dev-tools 1.2.1 → 1.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 720e29e14953ef13e7c94a269d5c089ff3783d38
-  data.tar.gz: 56b9bf6b831f5cff118daf838c74a0f311a99977
+  metadata.gz: d179da954eaf4443ccc003a8eb4660beb6b2f31b
+  data.tar.gz: 8d8325cf8b7fdb7dcd7aced470f68929ac8a3f64
 SHA512:
-  metadata.gz: 73fab8df5c40ec3f30c51a7b29b48c153d9131b559544adbe8cf8d651633bc25d86e9cbf1db09b03ea6a02bbc279e81620d25a827798c5bde288c24ce833bb80
-  data.tar.gz: 50a39d960da6ca93fabf46fe6e443569552fbd04e151d8633e1524db1193b77faa332bb1482382059c990619b3cbb039cff217c6aa135dfd59fab3094ef21501
+  metadata.gz: 2af6ccd3d2d0dfeb6104715af00db161c33340c5c2d3c15d11c976fcd821dad6a6e10438ea76ef2d2590450c993180d67998e0da07c9c83a207f2743ebd0d582
+  data.tar.gz: 0f130a534b39e4850da865a87e1a72469b5a04372d2b35603ad62d06bf7493cedff523a055d064dd70d080cdd9eb9aa465e378b636fa0000f0046097161452e3

data/.ruby-version

@@ -1 +1 @@
-ruby-2.2.3
+ruby-2.3.0

data/.travis.yml

@@ -1,6 +1,7 @@
 language: ruby
 rvm:
-  - 2.1.7
-  - 2.2.3
+  - 2.1.8
+  - 2.2.4
+  - 2.3.0
 script:
   - bundle exec rake

data/CHANGELOG.md

@@ -1,9 +1,78 @@
 # PolishGeeks Dev Tools Changelog
 
+## master (unreleased)
+
+## 1.3.0 (03/04/2016)
+
+- Move to ruby 2.3.0 by default
+- Bump bundler-audit dependency to 0.5.0
+- Bump brakeman dependency to 3.2.1
+- Bump simplecov dependency to 0.11.2
+- Bump rspec dependency to 3.4.4
+- Reorganize how we run rubocop-rspec
+- #44: Bump rubocop dependency to 0.39.0
+- #17: Bump rubycritic dependency to 2.8.0
+- #30: Allow to pass config file to brakeman
+- #18: Add bundler-audit which checks for vulnerable versions of gems
+- #21: Replace readme validator with required files validators, which allows us to
+  define what files you want to require in your project
+- #35: Added gemfile validator which checks if Gemfile contains gems from local path
+
+If you had readme validator turned off like this
+```ruby
+  PolishGeeks::DevTools.setup do |config|
+    config.readme = false
+  end
+```
+Now you need to change that to
+```ruby
+  PolishGeeks::DevTools.setup do |config|
+    config.required_files = false
+  end
+```
+You can now add extra files for validation
+```ruby
+  PolishGeeks::DevTools.setup do |config|
+    config.required_files_include = %w(REVIEW.md)
+  end
+```
+
+- #26: Rename empty_method to empty_methods validator
+
+If you had empty_method validator turned off like this and had files ignored
+```ruby
+  PolishGeeks::DevTools.setup do |config|
+    config.empty_method = false
+    config.empty_method_ignored = %w(REVIEW.md)
+  end
+```
+Now you need to change that to
+```ruby
+  PolishGeeks::DevTools.setup do |config|
+    config.empty_methods = false
+    config.empty_methods_ignored = %w(REVIEW.md)
+  end
+```
+
+- #12: Add rubocop-rspec which checks add code style checking for your RSpec files
+
+- #33: Add an option to disallow pending specs
+
+If you want to allow pending specs then
+```ruby
+  PolishGeeks::DevTools.setup do |config|
+    config.rspec_disallow_pending = false
+  end
+```
+
 ## 1.2.1
+
 - Extracted all errors to PolishGeeks::DevTools::Errors namespace
+- Add support for validators
+- Rename Command to Commands namespace
 
 ## 1.2.0
+
 - Added EmptyMethod command which checks if some files have empty methods
 
 ## 1.1.2

data/Gemfile.lock

@@ -1,14 +1,16 @@
 PATH
   remote: .
   specs:
-    polishgeeks-dev-tools (1.2.1)
+    polishgeeks-dev-tools (1.3.0)
       brakeman
+      bundler-audit
       faker
       haml-lint
       mongoid-rspec
       pry
       rspec
       rubocop
+      rubocop-rspec
       rubycritic
       shoulda
       simplecov
@@ -18,59 +20,55 @@ PATH
 GEM
   remote: https://rubygems.org/
   specs:
-    abstract_type (0.0.7)
-    activemodel (4.2.4)
-      activesupport (= 4.2.4)
+    activemodel (4.2.6)
+      activesupport (= 4.2.6)
       builder (~> 3.1)
-    activesupport (4.2.4)
+    activesupport (4.2.6)
       i18n (~> 0.7)
       json (~> 1.7, >= 1.7.7)
       minitest (~> 5.1)
       thread_safe (~> 0.3, >= 0.3.4)
       tzinfo (~> 1.1)
-    adamantium (0.2.0)
-      ice_nine (~> 0.11.0)
-      memoizable (~> 0.4.0)
-    ast (2.1.0)
-    astrolabe (1.3.1)
-      parser (~> 2.2)
+    addressable (2.4.0)
+    ast (2.2.0)
     axiom-types (0.1.1)
       descendants_tracker (~> 0.0.4)
       ice_nine (~> 0.11.0)
       thread_safe (~> 0.3, >= 0.3.1)
-    brakeman (3.1.2)
+    brakeman (3.2.1)
       erubis (~> 2.6)
-      fastercsv (~> 1.5)
       haml (>= 3.0, < 5.0)
-      highline (~> 1.6)
-      multi_json (~> 1.2)
-      ruby2ruby (>= 2.1.1, < 2.3.0)
-      ruby_parser (~> 3.7.0)
-      safe_yaml
+      highline (>= 1.6.20, < 2.0)
+      ruby2ruby (~> 2.3.0)
+      ruby_parser (~> 3.8.1)
+      safe_yaml (>= 1.0)
       sass (~> 3.0)
       slim (>= 1.3.6, < 4.0)
       terminal-table (~> 1.4)
-    bson (3.2.6)
+    bson (4.0.4)
     builder (3.2.2)
-    coderay (1.1.0)
+    bundler-audit (0.5.0)
+      bundler (~> 1.2)
+      thor (~> 0.18)
+    codeclimate-engine-rb (0.3.1)
+      virtus (~> 1.0)
+    coderay (1.1.1)
     coercible (1.0.0)
       descendants_tracker (~> 0.0.1)
-    concord (0.1.5)
-      adamantium (~> 0.2.0)
-      equalizer (~> 0.0.9)
+    colorize (0.7.7)
     descendants_tracker (0.0.4)
       thread_safe (~> 0.3, >= 0.3.1)
     diff-lcs (1.2.5)
     docile (1.1.5)
     equalizer (0.0.11)
     erubis (2.7.0)
-    faker (1.5.0)
+    faker (1.6.3)
       i18n (~> 0.5)
-    fastercsv (1.5.5)
-    flay (2.4.0)
+    flay (2.7.0)
+      erubis (~> 2.7.0)
       ruby_parser (~> 3.0)
       sexp_processor (~> 4.0)
-    flog (4.2.1)
+    flog (4.3.2)
       ruby_parser (~> 3.1, > 3.1.0)
       sexp_processor (~> 4.4)
     haml (4.0.7)
@@ -81,80 +79,83 @@ GEM
       sysexits (~> 1.1)
     highline (1.7.8)
     i18n (0.7.0)
-    ice_nine (0.11.1)
+    ice_nine (0.11.2)
     json (1.8.3)
-    memoizable (0.4.2)
-      thread_safe (~> 0.3, >= 0.3.1)
+    launchy (2.4.3)
+      addressable (~> 2.3)
     method_source (0.8.2)
-    minitest (5.8.2)
-    mongo (2.1.2)
-      bson (~> 3.0)
-    mongoid (5.0.1)
+    minitest (5.8.4)
+    mongo (2.2.4)
+      bson (~> 4.0)
+    mongoid (5.1.2)
       activemodel (~> 4.0)
       mongo (~> 2.1)
-      origin (~> 2.1)
+      origin (~> 2.2)
       tzinfo (>= 0.3.37)
     mongoid-rspec (3.0.0)
       mongoid (~> 5.0)
       rake
       rspec (~> 3.3)
-    multi_json (1.11.2)
-    origin (2.1.1)
-    parser (2.2.3.0)
-      ast (>= 1.1, < 3.0)
+    origin (2.2.0)
+    parser (2.3.0.7)
+      ast (~> 2.2)
     powerpack (0.1.1)
-    procto (0.0.2)
     pry (0.10.3)
       coderay (~> 1.1.0)
       method_source (~> 0.8.1)
       slop (~> 3.4)
-    rainbow (2.0.0)
-    rake (10.4.2)
-    reek (1.6.5)
-      parser (~> 2.2.0.pre.7)
-      rainbow (>= 1.99, < 3.0)
-      unparser (~> 0.2.2)
-    rspec (3.3.0)
-      rspec-core (~> 3.3.0)
-      rspec-expectations (~> 3.3.0)
-      rspec-mocks (~> 3.3.0)
-    rspec-core (3.3.2)
-      rspec-support (~> 3.3.0)
-    rspec-expectations (3.3.1)
+    rainbow (2.1.0)
+    rake (11.1.2)
+    reek (3.11)
+      codeclimate-engine-rb (~> 0.3.1)
+      parser (~> 2.3, >= 2.3.0.6)
+      rainbow (~> 2.0)
+    rspec (3.4.0)
+      rspec-core (~> 3.4.0)
+      rspec-expectations (~> 3.4.0)
+      rspec-mocks (~> 3.4.0)
+    rspec-core (3.4.4)
+      rspec-support (~> 3.4.0)
+    rspec-expectations (3.4.0)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.3.0)
-    rspec-mocks (3.3.2)
+      rspec-support (~> 3.4.0)
+    rspec-mocks (3.4.1)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.3.0)
-    rspec-support (3.3.0)
-    rubocop (0.35.0)
-      astrolabe (~> 1.3)
-      parser (>= 2.2.3.0, < 3.0)
+      rspec-support (~> 3.4.0)
+    rspec-support (3.4.1)
+    rubocop (0.39.0)
+      parser (>= 2.3.0.7, < 3.0)
       powerpack (~> 0.1)
       rainbow (>= 1.99.1, < 3.0)
       ruby-progressbar (~> 1.7)
+      unicode-display_width (~> 1.0, >= 1.0.1)
+    rubocop-rspec (1.4.1)
+      rubocop (= 0.39.0)
     ruby-progressbar (1.7.5)
-    ruby2ruby (2.2.0)
+    ruby2ruby (2.3.0)
       ruby_parser (~> 3.1)
       sexp_processor (~> 4.0)
-    ruby_parser (3.7.2)
+    ruby_parser (3.8.1)
       sexp_processor (~> 4.1)
-    rubycritic (1.4.0)
-      flay (= 2.4.0)
-      flog (= 4.2.1)
-      parser (>= 2.2.0, < 3.0)
-      reek (= 1.6.5)
+    rubycritic (2.8.0)
+      colorize
+      flay (= 2.7.0)
+      flog (= 4.3.2)
+      launchy (= 2.4.3)
+      parser (~> 2.3)
+      reek (= 3.11)
+      ruby_parser (~> 3.8)
       virtus (~> 1.0)
     safe_yaml (1.0.4)
-    sass (3.4.19)
-    sexp_processor (4.6.0)
+    sass (3.4.22)
+    sexp_processor (4.7.0)
     shoulda (3.5.0)
       shoulda-context (~> 1.0, >= 1.0.1)
       shoulda-matchers (>= 1.4.1, < 3.0)
     shoulda-context (1.2.1)
     shoulda-matchers (2.8.0)
       activesupport (>= 3.0.0)
-    simplecov (0.10.0)
+    simplecov (0.11.2)
       docile (~> 1.1.0)
       json (~> 1.8)
       simplecov-html (~> 0.10.0)
@@ -166,19 +167,13 @@ GEM
     sysexits (1.2.0)
     temple (0.7.6)
     terminal-table (1.5.2)
+    thor (0.19.1)
     thread_safe (0.3.5)
-    tilt (2.0.1)
-    timecop (0.8.0)
+    tilt (2.0.2)
+    timecop (0.8.1)
     tzinfo (1.2.2)
       thread_safe (~> 0.1)
-    unparser (0.2.4)
-      abstract_type (~> 0.0.7)
-      adamantium (~> 0.2.0)
-      concord (~> 0.1.5)
-      diff-lcs (~> 1.2.5)
-      equalizer (~> 0.0.9)
-      parser (~> 2.2.2)
-      procto (~> 0.0.2)
+    unicode-display_width (1.0.3)
     virtus (1.0.5)
       axiom-types (~> 0.1)
       coercible (~> 1.0)
@@ -195,4 +190,4 @@ DEPENDENCIES
   rake
 
 BUNDLED WITH
-   1.10.6
+   1.11.2

data/README.md

@@ -1,6 +1,7 @@
 # PolishGeeks Dev Tools
 
-[![Build Status](https://travis-ci.org/polishgeeks/polishgeeks-dev-tools.png)](https://travis-ci.org/polishgeeks/polishgeeks-dev-tools)
+[![Gem Version](https://badge.fury.io/rb/polishgeeks-dev-tools.svg)](https://rubygems.org/gems/polishgeeks-dev-tools)
+[![Build Status](https://api.travis-ci.org/polishgeeks/polishgeeks-dev-tools.svg)](https://travis-ci.org/polishgeeks/polishgeeks-dev-tools)
 [![Code Climate](https://codeclimate.com/github/polishgeeks/polishgeeks-dev-tools/badges/gpa.svg)](https://codeclimate.com/github/polishgeeks/polishgeeks-dev-tools)
 
 Gem with a set of useful tools used when developing Ruby based applications.
@@ -46,26 +47,30 @@ end
 Some options might be available only for given framework (Ruby on Rails, Sinatra, etc). Please refer to this table to
 determine, which you can use in your project:
 
-| Option                | Framework | Description                                                                           |
-|-----------------------|-----------|---------------------------------------------------------------------------------------|
-| brakeman              | Rails     | A static analysis security vulnerability scanner for Ruby on Rails                    |
-| rubocop               | -         | Used to check Ruby syntax according to our styling                                    |
-| final_blank_line      | -         | Check if all files have final blank line                                              |
-| empty_method          | -         | Check if some files have empty methods                                                 |
-| expires_in            | -         | Checks if there are typos like expire_in, etc that might brake app caching            |
-| haml_lint             | -         | User to check HAML syntax in the app views                                            |
-| yard                  | -         | YARD documentation standards checking                                                 |
-| rspec_files_names     | -         | Checks if all the rspec files have proper sufix (_spec.rb)                            |
-| rspec_files_structure | -         | Checks if we have corresponding _spec.rb files for each app/ lib ruby file            |
-| tasks_files_names     | -         | Checks if all the tasks for Capistrano and Rake files have proper extensions          |
-| rspec                 | -         | Specs framework                                                                       |
-| coverage              | -         | Specs code coverage generator                                                         |
-| simplecov             | -         | Simplecov code coverage threshold checking                                            |
-| simplecov_threshold   | -         | Threshold level for code coverage                                                     |
-| examples_comparator   | -         | Compares yml *.example files with non-examples and checks if they have same structure |
-| rubycritic            | -         | Generates a RubyCritic for given project                                              |
-| allowed_extensions    | -         | Checks that all the files in ./config directory have an allowed extension             |
-| yml_parser            | -         | Checks that parameters of all yaml files in ./config directory have some value        |
+| Option                 | Framework | Description                                                                           |
+|------------------------|-----------|---------------------------------------------------------------------------------------|
+| brakeman               | Rails     | A static analysis security vulnerability scanner for Ruby on Rails                    |
+| required_files         | -         | Check if required files are present and not empty                                     |
+| rubocop                | -         | Used to check Ruby syntax according to our styling                                    |
+| rubocop_rspec          | -         | Used to check RSpec syntax according to our styling                                   |
+| final_blank_line       | -         | Check if all files have final blank line                                              |
+| empty_methods          | -         | Check if some files have empty methods                                                |
+| expires_in             | -         | Checks if there are typos like expire_in, etc that might brake app caching            |
+| haml_lint              | -         | User to check HAML syntax in the app views                                            |
+| yard                   | -         | YARD documentation standards checking                                                 |
+| rspec_files_names      | -         | Checks if all the rspec files have proper sufix (_spec.rb)                            |
+| rspec_files_structure  | -         | Checks if we have corresponding _spec.rb files for each app/ lib ruby file            |
+| tasks_files_names      | -         | Checks if all the tasks for Capistrano and Rake files have proper extensions          |
+| rspec                  | -         | Specs framework                                                                       |
+| rspec_disallow_pending | -         | Disallow pending tests in specs                                                       |
+| simplecov              | -         | Simplecov code coverage threshold checking                                            |
+| simplecov_threshold    | -         | Threshold level for code coverage                                                     |
+| examples_comparator    | -         | Compares yml *.example files with non-examples and checks if they have same structure |
+| rubycritic             | -         | Generates a RubyCritic for given project                                              |
+| allowed_extensions     | -         | Checks that all the files in ./config directory have an allowed extension             |
+| yml_parser             | -         | Checks that parameters of all yaml files in ./config directory have some value        |
+| bundler_audit          | -         | Checks for vulnerable versions of gems in Gemfile.lock                                |
+| gemfile                | -         | Checks if Gemfile contains gems from local path                                       |
 
 ## Config options
 
@@ -73,9 +78,10 @@ Some validators might accept additional config settings - please refer to this t
 
 | Option                        | Validator             | Description                                                                                                 |
 |-------------------------------|-----------------------|-------------------------------------------------------------------------------------------------------------|
+| required_files_include        | required_files        | You can provide an array of files that should be included in the check                                      |
 | rspec_files_structure_ignored | rspec_files_structure | You can provide an array of files that should be ignored                                                    |
 | final_blank_line_ignored      | final_blank_line      | You can provide an array of files (ex. lib/file.rb) or directories (ex. lib/command) that should be ignored |
-| empty_method_ignored          | empty_method          | You can provide an array of files (ex. lib/file.rb) or directories (ex. lib/command) that should be ignored |
+| empty_methods_ignored         | empty_methods         | You can provide an array of files (ex. lib/file.rb) or directories (ex. lib/command) that should be ignored |
 
 ## Usage in any Rails/Ruby application
 

data/Rakefile

@@ -8,12 +8,13 @@ task :check do
     config.brakeman = false
     config.haml_lint = false
     config.expires_in_files_ignored = %w(
-      lib/polishgeeks/dev-tools/commands/expires_in.rb
+      lib/polish_geeks/dev_tools/commands/expires_in.rb
     )
-    config.empty_method_ignored = %w(
-      empty_method_spec.rb
+    config.empty_methods_ignored = %w(
+      empty_methods_spec.rb
       file_parser_spec.rb
     )
+    config.rspec_files_structure_ignored = %w(lib/polishgeeks-dev-tools.rb)
   end
 
   PolishGeeks::DevTools::Runner.new.execute(