polishgeeks-dev-tools 1.2.0 → 1.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b2cbe8369c08f481d0060a493bca52c0b1223c6f
-  data.tar.gz: 19384f5f7b3c94e6e588d610b1b6aeb2b1d90791
+  metadata.gz: 720e29e14953ef13e7c94a269d5c089ff3783d38
+  data.tar.gz: 56b9bf6b831f5cff118daf838c74a0f311a99977
 SHA512:
-  metadata.gz: 9bf268c0e62ed3029f2bebb6872705304c3ec7abd97c26bfc14278a4b565ccff02f035610c94f36173748480fcabb471abc18b2ddfc82d741e1d5b9c9b93177f
-  data.tar.gz: 9ec402bf09e3ec5f4258b2a15c014f71707c3dee74d4559d78c92aca56c7341a0b6b7a59d87c3d326bce8ed9d6a191892b3c997aa236e3e5653d3196e999b592
+  metadata.gz: 73fab8df5c40ec3f30c51a7b29b48c153d9131b559544adbe8cf8d651633bc25d86e9cbf1db09b03ea6a02bbc279e81620d25a827798c5bde288c24ce833bb80
+  data.tar.gz: 50a39d960da6ca93fabf46fe6e443569552fbd04e151d8633e1524db1193b77faa332bb1482382059c990619b3cbb039cff217c6aa135dfd59fab3094ef21501

data/.gitignore

@@ -20,3 +20,4 @@ tmp
 *.o
 *.a
 mkmf.log
+.DS_Store

data/CHANGELOG.md

@@ -1,5 +1,8 @@
 # PolishGeeks Dev Tools Changelog
 
+## 1.2.1
+- Extracted all errors to PolishGeeks::DevTools::Errors namespace
+
 ## 1.2.0
 - Added EmptyMethod command which checks if some files have empty methods
 

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    polishgeeks-dev-tools (1.2.0)
+    polishgeeks-dev-tools (1.2.1)
       brakeman
       faker
       haml-lint
@@ -9,7 +9,7 @@ PATH
       pry
       rspec
       rubocop
-      rubycritic (= 1.2.1)
+      rubycritic
       shoulda
       simplecov
       timecop
@@ -38,7 +38,7 @@ GEM
       descendants_tracker (~> 0.0.4)
       ice_nine (~> 0.11.0)
       thread_safe (~> 0.3, >= 0.3.1)
-    brakeman (3.1.0)
+    brakeman (3.1.2)
       erubis (~> 2.6)
       fastercsv (~> 1.5)
       haml (>= 3.0, < 5.0)
@@ -46,10 +46,11 @@ GEM
       multi_json (~> 1.2)
       ruby2ruby (>= 2.1.1, < 2.3.0)
       ruby_parser (~> 3.7.0)
+      safe_yaml
       sass (~> 3.0)
       slim (>= 1.3.6, < 4.0)
-      terminal-table (~> 1.4.5)
-    bson (3.2.4)
+      terminal-table (~> 1.4)
+    bson (3.2.6)
     builder (3.2.2)
     coderay (1.1.0)
     coercible (1.0.0)
@@ -57,7 +58,6 @@ GEM
     concord (0.1.5)
       adamantium (~> 0.2.0)
       equalizer (~> 0.0.9)
-    connection_pool (2.2.0)
     descendants_tracker (0.0.4)
       thread_safe (~> 0.3, >= 0.3.1)
     diff-lcs (1.2.5)
@@ -79,41 +79,38 @@ GEM
       haml (~> 4.0)
       rubocop (>= 0.25.0)
       sysexits (~> 1.1)
-    highline (1.7.3)
+    highline (1.7.8)
     i18n (0.7.0)
     ice_nine (0.11.1)
     json (1.8.3)
     memoizable (0.4.2)
       thread_safe (~> 0.3, >= 0.3.1)
     method_source (0.8.2)
-    minitest (5.8.0)
-    mongoid (4.0.2)
+    minitest (5.8.2)
+    mongo (2.1.2)
+      bson (~> 3.0)
+    mongoid (5.0.1)
       activemodel (~> 4.0)
-      moped (~> 2.0.0)
+      mongo (~> 2.1)
       origin (~> 2.1)
       tzinfo (>= 0.3.37)
-    mongoid-rspec (2.2.0)
-      mongoid (~> 4.0.0)
+    mongoid-rspec (3.0.0)
+      mongoid (~> 5.0)
       rake
-      rspec (~> 3.1)
-    moped (2.0.7)
-      bson (~> 3.0)
-      connection_pool (~> 2.0)
-      optionable (~> 0.2.0)
+      rspec (~> 3.3)
     multi_json (1.11.2)
-    optionable (0.2.0)
     origin (2.1.1)
-    parser (2.2.2.6)
+    parser (2.2.3.0)
       ast (>= 1.1, < 3.0)
     powerpack (0.1.1)
     procto (0.0.2)
-    pry (0.10.1)
+    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.3)
+    reek (1.6.5)
       parser (~> 2.2.0.pre.7)
       rainbow (>= 1.99, < 3.0)
       unparser (~> 0.2.2)
@@ -130,26 +127,26 @@ GEM
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.3.0)
     rspec-support (3.3.0)
-    rubocop (0.34.0)
+    rubocop (0.35.0)
       astrolabe (~> 1.3)
-      parser (>= 2.2.2.5, < 3.0)
+      parser (>= 2.2.3.0, < 3.0)
       powerpack (~> 0.1)
       rainbow (>= 1.99.1, < 3.0)
-      ruby-progressbar (~> 1.4)
+      ruby-progressbar (~> 1.7)
     ruby-progressbar (1.7.5)
     ruby2ruby (2.2.0)
       ruby_parser (~> 3.1)
       sexp_processor (~> 4.0)
-    ruby_parser (3.7.1)
+    ruby_parser (3.7.2)
       sexp_processor (~> 4.1)
-    rubycritic (1.2.1)
+    rubycritic (1.4.0)
       flay (= 2.4.0)
       flog (= 4.2.1)
       parser (>= 2.2.0, < 3.0)
-      reek (= 1.6.3)
-      ruby2ruby (>= 2.1.1, < 3.0)
+      reek (= 1.6.5)
       virtus (~> 1.0)
-    sass (3.4.18)
+    safe_yaml (1.0.4)
+    sass (3.4.19)
     sexp_processor (4.6.0)
     shoulda (3.5.0)
       shoulda-context (~> 1.0, >= 1.0.1)
@@ -168,7 +165,7 @@ GEM
     slop (3.6.0)
     sysexits (1.2.0)
     temple (0.7.6)
-    terminal-table (1.4.5)
+    terminal-table (1.5.2)
     thread_safe (0.3.5)
     tilt (2.0.1)
     timecop (0.8.0)

data/Rakefile

@@ -8,7 +8,7 @@ task :check do
     config.brakeman = false
     config.haml_lint = false
     config.expires_in_files_ignored = %w(
-      lib/polishgeeks/dev-tools/command/expires_in.rb
+      lib/polishgeeks/dev-tools/commands/expires_in.rb
     )
     config.empty_method_ignored = %w(
       empty_method_spec.rb

data/lib/polishgeeks-dev-tools.rb

@@ -1,13 +1,29 @@
-require 'yaml'
-require 'yard'
-require 'pry'
-require 'fileutils'
-require 'timecop'
-require 'faker'
-require 'ostruct'
-
-base_path = File.dirname(__FILE__) + '/polishgeeks/dev-tools/*.rb'
-Dir[base_path].each { |file| require file }
+%w(
+  yaml
+  yard
+  pry
+  fileutils
+  timecop
+  faker
+  ostruct
+).each { |lib| require lib }
+
+%w(
+  validators/base
+  commands/base
+  commands/empty_method
+  commands/empty_method/string_refinements
+).each { |lib| require "polishgeeks/dev-tools/#{lib}" }
+
+%w(
+  *.rb
+  validators/*.rb
+  commands/*.rb
+  commands/**/*.rb
+).each do |path|
+  base_path = File.dirname(__FILE__) + "/polishgeeks/dev-tools/#{path}"
+  Dir[base_path].each { |file| require file }
+end
 
 module PolishGeeks
   module DevTools
@@ -35,14 +51,4 @@ module PolishGeeks
   end
 end
 
-require 'polishgeeks/dev-tools/command/base'
-require 'polishgeeks/dev-tools/command/empty_method'
-require 'polishgeeks/dev-tools/command/empty_method/string_refinements'
-
-commands_path = File.dirname(__FILE__) + '/polishgeeks/dev-tools/command/*.rb'
-Dir[commands_path].each { |file| require file }
-
-commands_path = File.dirname(__FILE__) + '/polishgeeks/dev-tools/command/**/*.rb'
-Dir[commands_path].each { |file| require file }
-
 load 'polishgeeks/dev-tools/tasks/dev-tools.rake'

data/lib/polishgeeks/dev-tools/{command → commands}/allowed_extensions.rb

@@ -1,6 +1,6 @@
 module PolishGeeks
   module DevTools
-    module Command
+    module Commands
       # Checking config directory that all files are allowed
       class AllowedExtensions < Base
         self.type = :validator

data/lib/polishgeeks/dev-tools/{command → commands}/base.rb

@@ -1,14 +1,11 @@
 module PolishGeeks
   module DevTools
     # Module encapsulating all the commands that we use to check/verify code
-    module Command
+    module Commands
       # Base class for all the commands
       # @abstract Subclass and use
       class Base
-        # Raised when we specify a framework in which a given command can be executed
-        # and it is not present (not detected)
-        class MissingFramework < StandardError; end
-
+        # Output string that we get after executing this command
         attr_reader :output
         # stored_output [PolishGeeks::DevTools::OutputStorer] storer with results of previous
         #   commands (they might use output from previous/other commands)
@@ -21,7 +18,7 @@ module PolishGeeks
 
         class << self
           attr_accessor :type
-          attr_accessor :framework
+          attr_accessor :validators
 
           TYPES.each do |type|
             # @return [Boolean] if it is a given type command
@@ -31,23 +28,16 @@ module PolishGeeks
           end
         end
 
-        # When we will try to use a given command, we need to check if it requires
-        # a given framework (Rails, Sinatra), if so, then we need to check if it is
-        # present, because without it a given command cannot run
-        def initialize
-          ensure_framework_if_required
-        end
-
         # @raise [NotImplementedError] this should be implemented in a subclass
         def execute
-          fail NotImplementedError
+          fail Errors::NotImplementedError
         end
 
         # @raise [NotImplementedError] this should be implemented in a subclass
         #   if it is a validator type (or no implementation required when
         #   it is a validator)
         def valid?
-          fail NotImplementedError
+          fail Errors::NotImplementedError
         end
 
         # @return [String] what message should be printed when error occures
@@ -56,16 +46,16 @@ module PolishGeeks
           output
         end
 
-        private
-
-        # Checks if a framework is required for a given command, and if so, it wont
-        # allow to execute this command if it is not present
-        # @raise [PolishGeeks::DevTools::Command::Base::MissingFramework] if req framework missing
-        def ensure_framework_if_required
-          return unless self.class.framework
-          return if PolishGeeks::DevTools.config.public_send(:"#{self.class.framework}?")
-
-          fail MissingFramework, self.class.framework
+        # Runs validators if any to check if all requirements of this command
+        # are met in order to execute it properly
+        # @raise [PolishGeeks::DevTools::Errors::InvalidValidatorClassError] when invalid
+        #   validator class name is defined
+        # @raise [PolishGeeks::DevTools::Errors::PreCommandValidationError] when validator
+        #   conditions are not met
+        def ensure_executable!
+          (self.class.validators || []).each do |validator_class|
+            validator_class.new(stored_output).validate!
+          end
         end
       end
     end

data/lib/polishgeeks/dev-tools/{command → commands}/brakeman.rb

@@ -1,11 +1,13 @@
 module PolishGeeks
   module DevTools
-    module Command
+    module Commands
       # A static analysis security vulnerability scanner for Ruby on Rails applications
       # @see https://github.com/presidentbeef/brakeman
       class Brakeman < Base
         self.type = :validator
-        self.framework = :rails
+        self.validators = [
+          Validators::Rails
+        ]
 
         # Regexps to get some stat info from brakeman output
         REGEXPS = {

data/lib/polishgeeks/dev-tools/{command → commands}/empty_method.rb

@@ -1,6 +1,6 @@
 module PolishGeeks
   module DevTools
-    module Command
+    module Commands
       # Validator used to check if all '.rb' files don't have empty methods
       class EmptyMethod < Base
         self.type = :validator

data/lib/polishgeeks/dev-tools/{command → commands}/empty_method/file_parser.rb

@@ -1,6 +1,6 @@
 module PolishGeeks
   module DevTools
-    module Command
+    module Commands
       class EmptyMethod
         # Parse file and search whether it contain empty methods
         class FileParser

data/lib/polishgeeks/dev-tools/{command → commands}/empty_method/string_refinements.rb

@@ -1,6 +1,6 @@
 module PolishGeeks
   module DevTools
-    module Command
+    module Commands
       class EmptyMethod
         # Adds ability to check strings on specific regex matching
         module StringRefinements

data/lib/polishgeeks/dev-tools/{command → commands}/examples_comparator.rb

@@ -1,6 +1,6 @@
 module PolishGeeks
   module DevTools
-    module Command
+    module Commands
       # Command wrapper for ExamplesComparator rake task
       # It informs us if our .example files structure is the same as non-example once
       class ExamplesComparator < Base

data/lib/polishgeeks/dev-tools/{command → commands}/expires_in.rb

@@ -1,6 +1,6 @@
 module PolishGeeks
   module DevTools
-    module Command
+    module Commands
       # Checking Rails cache options especially expires_in
       class ExpiresIn < Base
         self.type = :validator

data/lib/polishgeeks/dev-tools/{command → commands}/final_blank_line.rb

@@ -1,6 +1,6 @@
 module PolishGeeks
   module DevTools
-    module Command
+    module Commands
       # Validator used to check if all files have final blank line
       class FinalBlankLine < Base
         self.type = :validator

data/lib/polishgeeks/dev-tools/{command → commands}/haml_lint.rb

@@ -1,6 +1,6 @@
 module PolishGeeks
   module DevTools
-    module Command
+    module Commands
       # Command wrapper for Haml lint validation
       # It informs us if haml is formatted in a proper way
       # @see https://github.com/causes/haml-lint

data/lib/polishgeeks/dev-tools/{command → commands}/readme.rb

@@ -1,6 +1,6 @@
 module PolishGeeks
   module DevTools
-    module Command
+    module Commands
       # Checks README.rb exists
       class Readme < Base
         self.type = :validator

data/lib/polishgeeks/dev-tools/{command → commands}/rspec.rb

@@ -1,6 +1,6 @@
 module PolishGeeks
   module DevTools
-    module Command
+    module Commands
       # Command wrapper for Rspec validation
       # It informs us if our specs are working in a proper way
       class Rspec < Base

data/lib/polishgeeks/dev-tools/{command → commands}/rspec_files_names.rb

@@ -1,6 +1,6 @@
 module PolishGeeks
   module DevTools
-    module Command
+    module Commands
       # Validator used to check if all the rspec spec files have a proper
       # sufix (_spec.rb)
       class RspecFilesNames < Base

data/lib/polishgeeks/dev-tools/{command → commands}/rspec_files_structure.rb

@@ -1,6 +1,6 @@
 module PolishGeeks
   module DevTools
-    module Command
+    module Commands
       # Checks if there are are rb files that don't have corresponding rspec
       # spec files defined
       # This will validate that the names are the same (no typos, etc) and no

data/lib/polishgeeks/dev-tools/{command → commands}/rubocop.rb

@@ -1,6 +1,6 @@
 module PolishGeeks
   module DevTools
-    module Command
+    module Commands
       # Command wrapper for Rubocop validation
       # It informs us if code is formatted in a proper way
       class Rubocop < Base

data/lib/polishgeeks/dev-tools/{command → commands}/rubycritic.rb

@@ -1,6 +1,6 @@
 module PolishGeeks
   module DevTools
-    module Command
+    module Commands
       # Command wrapper for RubyCritic statistics
       # It informs us if RubyCritic stats were generated
       class Rubycritic < Base