warder 0.2.1 → 0.2.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 8293a08b303f9d5b9eb1fa1159b437f251e6dfe9
-  data.tar.gz: fd4341bbdf903230a80b2e2b600fd51e57ea0a7c
+  metadata.gz: 5ce6a5ae6fa2e132a1aa894be28bd683e83a5ea6
+  data.tar.gz: 8f56efcb997bd2ee849d7e978149cd0e1b133d3f
 SHA512:
-  metadata.gz: 30aa9ddb458431940bc85e130ab887226cb2306838e0b86db9750c8212d399964de6b039e08f8577dfd3f3fb501a707883852f2961108913ea6ad7808685bbef
-  data.tar.gz: 4d1a665377df8e920a214de587078489431428db44f68bec9e72056efd8258284288c50a05c760b70a77a9108611293d0a045f44864e58eb80cafe21338ddb68
+  metadata.gz: 78569d1fd5f6a23734c84775ef4508000cfec3db3ba65051281a46a7fa1a7cec3a64f83593fa18c729c06927b83eb82e4f1e572d055918440f9e0e885237efe7
+  data.tar.gz: 939efeec5ea2014a340eee05a10c9525744d98da150595ead00111fcc653ccc3e6431a3eb7a5ad8d470865388d426469246f82c97b2f1242c391a1e6513eb63f

data/README.md

@@ -4,7 +4,56 @@
 [![Code Climate](https://codeclimate.com/github/yltsrc/warder.png)](https://codeclimate.com/github/yltsrc/warder)
 [![Dependency Status](https://gemnasium.com/yltsrc/warder.png)](https://gemnasium.com/yltsrc/warder)
 
-TODO: Write a gem description
+## Getting started
+
+Main goal of this project was to provide you tool, which will help make code
+better. I used these tools for a while and can provide some tips.
+
+Just to start with warder, it would be great to do something simple.
+And I will recommend to start with checking your bundle for security issues
+
+    $ warder --bundle-audit
+
+Sooner or later you will start with code cleanup. There are two main ways to
+deal with it, depending what you plan to achieve. If you are interested in clean
+code, according to style guides, you may want to use
+
+    $ warder --style-guide
+
+But if you want to see you code OOP-friendly, then you need different approach
+
+    $ warder --code-smells
+
+Next steps for stylish code are:
+
+    $ warder --code-duplication
+    $ warder --magick-numbers
+
+And for OOP-style code next steps will be:
+
+    $ warder --code-complexity
+
+Then you can apply everything is left. But I strongly recommend to add
+validations one by one, right after all issues are fixed from previous one.
+Now it is not possible to compare results on feature branches without scripting,
+so you must be careful, if you want to use all suitable validators and results
+are not as good as it can be.
+
+There are few rails specific validators, but the rules are the same. Security is
+the first priority:
+
+    $ warder --rails-security
+
+You may also want to see some advice, regarding rails best practices:
+
+    $ warder --rails-advice
+
+but be careful with it, some reported advices may conflict with another
+validators.
+
+You may also see, how your rails app meets Sandi Metz rules:
+
+    $ warder --sandi-rules
 
 ## Installation
 
@@ -22,7 +71,51 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+First of all, RTFM!
+
+    $ warder --help
+
+to see all supported scanners.
+If you are too lazy, you will be confused with results.
+
+    $ warder
+    
+to see that everything is good (actually no one validator used) and you don't
+need to fix any issues :)
+
+You also can use shortcuts:
+
+    $ warder --all
+    
+to run all validations, even ones you don't really need.
+
+To run only rails related validations:
+
+    $ warder --rails
+
+or to validate your ruby project:
+
+    $ warder --all --no-rails
+
+if you so tired looking at your code issues, you can use silent mode
+
+    $ warder --quiet
+    
+and you just will get result by exit code.
+
+But if you, or your CI is really interested in statistics, there is statistics
+mode for you:
+
+    $ warder --quiet --stats
+
+if you working on multiple projects, you can pass path to another project
+as an argument:
+
+    $ warder --quiet /path/to/another/project
+    
+The best thing I can do with warder is validate project itself, so anyone can
+see, that it is not so hard to write good ruby code. Just check build status on
+[Travis CI](https://travis-ci.org/yltsrc/warder).
 
 ## Contributing
 

data/lib/warder/cli/arguments.rb

@@ -1,6 +1,7 @@
 require 'optparse'
 
 module Warder
+  # responsible for hiding arguments from global scope
   class CLI
     # responsible for parsing cli arguments
     class Arguments

data/lib/warder/cli.rb

@@ -1,5 +1,5 @@
 module Warder
-  # responsible for executing warder tools
+  # responsible for cli integration
   class CLI
     def initialize(argv, stdin = STDIN, stdout = STDOUT,
                    stderr = STDERR, kernel = Kernel)

data/lib/warder/code_complexity_runner.rb

@@ -29,7 +29,7 @@ module Warder
     end
 
     def total?(line)
-      TOTAL_REGEXP.match(line)
+      self.class::TOTAL_REGEXP.match(line)
     end
   end
 end

data/lib/warder/rails_security_runner.rb

@@ -17,11 +17,11 @@ module Warder
     end
 
     def printable?(line)
-      super && PRINTABLE_REGEXP.match(line)
+      super && self.class::PRINTABLE_REGEXP.match(line)
     end
 
     def number_of_issues(line)
-      FAILURE_REGEXP.match(line) ? 1 : 0
+      self.class::FAILURE_REGEXP.match(line) ? 1 : 0
     end
   end
 end

data/lib/warder/version.rb

@@ -1,4 +1,4 @@
 # define warder version
 module Warder
-  VERSION = '0.2.1'
+  VERSION = '0.2.2'
 end

data/spec/fixtures/valid_rails_app/Gemfile

@@ -1,5 +1,5 @@
 source 'https://rubygems.org'
 
-gem 'rails', '~> 4.2.0'
+gem 'rails', '~> 4.2.2'
 
 gem 'sqlite3'

data/spec/fixtures/valid_rails_app/Gemfile_lock

@@ -1,36 +1,36 @@
 GEM
   remote: https://rubygems.org/
   specs:
-    actionmailer (4.2.0)
-      actionpack (= 4.2.0)
-      actionview (= 4.2.0)
-      activejob (= 4.2.0)
+    actionmailer (4.2.2)
+      actionpack (= 4.2.2)
+      actionview (= 4.2.2)
+      activejob (= 4.2.2)
       mail (~> 2.5, >= 2.5.4)
       rails-dom-testing (~> 1.0, >= 1.0.5)
-    actionpack (4.2.0)
-      actionview (= 4.2.0)
-      activesupport (= 4.2.0)
-      rack (~> 1.6.0)
+    actionpack (4.2.2)
+      actionview (= 4.2.2)
+      activesupport (= 4.2.2)
+      rack (~> 1.6)
       rack-test (~> 0.6.2)
       rails-dom-testing (~> 1.0, >= 1.0.5)
       rails-html-sanitizer (~> 1.0, >= 1.0.1)
-    actionview (4.2.0)
-      activesupport (= 4.2.0)
+    actionview (4.2.2)
+      activesupport (= 4.2.2)
       builder (~> 3.1)
       erubis (~> 2.7.0)
       rails-dom-testing (~> 1.0, >= 1.0.5)
       rails-html-sanitizer (~> 1.0, >= 1.0.1)
-    activejob (4.2.0)
-      activesupport (= 4.2.0)
+    activejob (4.2.2)
+      activesupport (= 4.2.2)
       globalid (>= 0.3.0)
-    activemodel (4.2.0)
-      activesupport (= 4.2.0)
+    activemodel (4.2.2)
+      activesupport (= 4.2.2)
       builder (~> 3.1)
-    activerecord (4.2.0)
-      activemodel (= 4.2.0)
-      activesupport (= 4.2.0)
+    activerecord (4.2.2)
+      activemodel (= 4.2.2)
+      activesupport (= 4.2.2)
       arel (~> 6.0)
-    activesupport (4.2.0)
+    activesupport (4.2.2)
       i18n (~> 0.7)
       json (~> 1.7, >= 1.7.7)
       minitest (~> 5.1)
@@ -39,62 +39,56 @@ GEM
     arel (6.0.0)
     builder (3.2.2)
     erubis (2.7.0)
-    globalid (0.3.0)
+    globalid (0.3.5)
       activesupport (>= 4.1.0)
-    hike (1.2.3)
     i18n (0.7.0)
-    json (1.8.2)
-    loofah (2.0.1)
+    json (1.8.3)
+    loofah (2.0.2)
       nokogiri (>= 1.5.9)
     mail (2.6.3)
       mime-types (>= 1.16, < 3)
-    mime-types (2.4.3)
+    mime-types (2.6.1)
     mini_portile (0.6.2)
-    minitest (5.5.1)
-    multi_json (1.10.1)
+    minitest (5.7.0)
     nokogiri (1.6.6.2)
       mini_portile (~> 0.6.0)
-    rack (1.6.0)
+    rack (1.6.4)
     rack-test (0.6.3)
       rack (>= 1.0)
-    rails (4.2.0)
-      actionmailer (= 4.2.0)
-      actionpack (= 4.2.0)
-      actionview (= 4.2.0)
-      activejob (= 4.2.0)
-      activemodel (= 4.2.0)
-      activerecord (= 4.2.0)
-      activesupport (= 4.2.0)
+    rails (4.2.2)
+      actionmailer (= 4.2.2)
+      actionpack (= 4.2.2)
+      actionview (= 4.2.2)
+      activejob (= 4.2.2)
+      activemodel (= 4.2.2)
+      activerecord (= 4.2.2)
+      activesupport (= 4.2.2)
       bundler (>= 1.3.0, < 2.0)
-      railties (= 4.2.0)
+      railties (= 4.2.2)
       sprockets-rails
     rails-deprecated_sanitizer (1.0.3)
       activesupport (>= 4.2.0.alpha)
-    rails-dom-testing (1.0.5)
+    rails-dom-testing (1.0.6)
       activesupport (>= 4.2.0.beta, < 5.0)
       nokogiri (~> 1.6.0)
       rails-deprecated_sanitizer (>= 1.0.1)
-    rails-html-sanitizer (1.0.1)
+    rails-html-sanitizer (1.0.2)
       loofah (~> 2.0)
-    railties (4.2.0)
-      actionpack (= 4.2.0)
-      activesupport (= 4.2.0)
+    railties (4.2.2)
+      actionpack (= 4.2.2)
+      activesupport (= 4.2.2)
       rake (>= 0.8.7)
       thor (>= 0.18.1, < 2.0)
     rake (10.4.2)
-    sprockets (2.12.3)
-      hike (~> 1.2)
-      multi_json (~> 1.0)
+    sprockets (3.2.0)
       rack (~> 1.0)
-      tilt (~> 1.1, != 1.3.0)
-    sprockets-rails (2.2.4)
+    sprockets-rails (2.3.1)
       actionpack (>= 3.0)
       activesupport (>= 3.0)
       sprockets (>= 2.8, < 4.0)
     sqlite3 (1.3.10)
     thor (0.19.1)
-    thread_safe (0.3.4)
-    tilt (1.4.1)
+    thread_safe (0.3.5)
     tzinfo (1.2.2)
       thread_safe (~> 0.1)
 
@@ -102,5 +96,5 @@ PLATFORMS
   ruby
 
 DEPENDENCIES
-  rails (~> 4.2.0)
+  rails (~> 4.2.1)
   sqlite3

data/warder.gemspec

@@ -19,7 +19,7 @@ Gem::Specification.new do |spec|
   spec.require_paths = ['lib']
 
   spec.add_dependency 'rubocop', '~> 0.31'
-  spec.add_dependency 'reek', '~> 1.6'
+  spec.add_dependency 'reek', '~> 2.2'
   spec.add_dependency 'flay', '~> 2.6.1'
   spec.add_dependency 'flog', '~> 4.3'
   spec.add_dependency 'mago', '~> 0.1'
@@ -30,7 +30,7 @@ Gem::Specification.new do |spec|
 
   spec.add_development_dependency 'bundler', '~> 1.3'
   spec.add_development_dependency 'rake', '~> 10.0'
-  spec.add_development_dependency 'rspec', '~> 3.2'
+  spec.add_development_dependency 'rspec', '~> 3.3'
   spec.add_development_dependency 'cucumber', '~> 2.0'
   spec.add_development_dependency 'aruba', '~> 0.6'
   spec.add_development_dependency 'simplecov', '~> 0.10'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: warder
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.2.2
 platform: ruby
 authors:
 - Yura Tolstik
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-05-06 00:00:00.000000000 Z
+date: 2015-06-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rubocop
@@ -30,14 +30,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.6'
+        version: '2.2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.6'
+        version: '2.2'
 - !ruby/object:Gem::Dependency
   name: flay
   requirement: !ruby/object:Gem::Requirement
@@ -170,14 +170,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.2'
+        version: '3.3'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.2'
+        version: '3.3'
 - !ruby/object:Gem::Dependency
   name: cucumber
   requirement: !ruby/object:Gem::Requirement