polishgeeks-dev-tools 1.0.0

data/lib/polishgeeks/dev-tools/command/haml_lint.rb

@@ -0,0 +1,28 @@
+module PolishGeeks
+  module DevTools
+    module Command
+      # Command wrapper for Haml lint validation
+      # It informs us if haml is formatted in a proper way
+      # @see https://github.com/causes/haml-lint
+      class HamlLint < Base
+        self.type = :validator
+
+        # Executes this command
+        # @return [String] command output
+        def execute
+          loc_config = File.join(DevTools.gem_root, 'config', 'haml-lint.yml')
+          app_config = File.join(DevTools.app_root, '.haml-lint.yml')
+
+          config = File.exist?(app_config) ? app_config : loc_config
+
+          @output = Shell.new.execute("bundle exec haml-lint -c #{config} app/views")
+        end
+
+        # @return [Boolean] true if there were no Rubocop offenses detected
+        def valid?
+          @output.to_s.empty?
+        end
+      end
+    end
+  end
+end

data/lib/polishgeeks/dev-tools/command/readme.rb

@@ -0,0 +1,32 @@
+module PolishGeeks
+  module DevTools
+    module Command
+      # Checks README.rb exists
+      class Readme < Base
+        self.type = :validator
+
+        # Executes this command
+        # @return [String] command output
+        def execute
+          readme = File.join(::PolishGeeks::DevTools.app_root, 'README.md')
+          @output = File.exist?(readme)
+        end
+
+        # @return [String] label with this validator description
+        def label
+          'README.rb required'
+        end
+
+        # @return [String] error message
+        def error_message
+          "README.rb doesn't exist!"
+        end
+
+        # @return [Boolean] true if README.rb exist
+        def valid?
+          @output
+        end
+      end
+    end
+  end
+end

data/lib/polishgeeks/dev-tools/command/rspec.rb

@@ -0,0 +1,38 @@
+module PolishGeeks
+  module DevTools
+    module Command
+      # Command wrapper for Rspec validation
+      # It informs us if our specs are working in a proper way
+      class Rspec < Base
+        self.type = :validator
+
+        # Regexp used to match Rspec examples count
+        EXAMPLES_REGEXP = /(\d+) examples/
+        # Regexp used to match Rspec failures
+        FAILURES_REGEXP = /(\d+) failures/
+        # Regexp used to match Rspec pendings
+        PENDING_REGEXP = /(\d+) pending/
+
+        # Executes this command
+        # @return [String] command output
+        def execute
+          @output = Shell.new.execute('bundle exec rspec spec')
+        end
+
+        # @return [Boolean] true if there were no Rspec failures, false otherwise
+        def valid?
+          output.include?('0 failures')
+        end
+
+        # @return [String] default label for this command
+        def label
+          examples = output.scan(EXAMPLES_REGEXP).flatten.first.to_i
+          failures = output.scan(FAILURES_REGEXP).flatten.first.to_i
+          pending = output.scan(PENDING_REGEXP).flatten.first.to_i
+
+          "Rspec (#{examples} ex, #{failures} fa, #{pending} pe)"
+        end
+      end
+    end
+  end
+end

data/lib/polishgeeks/dev-tools/command/rspec_files_names.rb

@@ -0,0 +1,58 @@
+module PolishGeeks
+  module DevTools
+    module Command
+      # Validator used to check if all the rspec spec files have a proper
+      # sufix (_spec.rb)
+      class RspecFilesNames < Base
+        self.type = :validator
+
+        attr_reader :counter
+
+        # List of dirs in spec/ dir that we will check for
+        # _spec.rb naming
+        CHECKED_DIRS = %w(
+          aggregators controllers helpers lib libs models decorators
+          presenters services workers mailers requests polishgeeks*
+        )
+
+        # Regexp used to check names in spec files
+        CHECK_REGEXP = /(\_spec\.rb)$/
+
+        # Executes this command
+        # @return [Array] command output array with list of spec files
+        #   that dont have a proper name
+        def execute
+          @output = []
+          @counter = 0
+
+          CHECKED_DIRS.each do |name|
+            path = File.join(::PolishGeeks::DevTools.app_root, 'spec', name)
+            files = Dir.glob("#{path}/**/*").select { |f| File.file? f }
+
+            @counter += files.count
+
+            files.each do |file|
+              @output << file unless file =~ CHECK_REGEXP
+            end
+          end
+        end
+
+        # @return [Boolean] true if all specs have a proper sufix (_spec.rb)
+        def valid?
+          output.empty?
+        end
+
+        # @return [String] default label for this command
+        def label
+          "Rspec files names: #{counter} files checked"
+        end
+
+        # @return [String] message that should be printed when some files have
+        #   invalid name
+        def error_message
+          "Following files have invalid name: \n #{output.join("\n")}\n"
+        end
+      end
+    end
+  end
+end

data/lib/polishgeeks/dev-tools/command/rspec_files_structure.rb

@@ -0,0 +1,134 @@
+module PolishGeeks
+  module DevTools
+    module Command
+      # 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
+      # file are without spec files (even just with pending)
+      class RspecFilesStructure < Base
+        self.type = :validator
+
+        # Files in directories that we want to check against their rspec
+        # corresponding files
+        FILES_CHECKED = %w(
+          app/**/*.rb
+          lib/**/*.rb
+        )
+
+        # From where should we take spec files
+        RSPEC_FILES = %w(
+          spec/**/*_spec.rb
+        )
+
+        # Executes this command
+        # @return [Array<String>] empty array if all the files have corresponding
+        #   rspec files, otherwise array will contain files that doesn't
+        def execute
+          @output = {
+            app: analyzed_files - rspec_files,
+            rspec: rspec_files - analyzed_files
+          }
+        end
+
+        # @return [Boolean] true if everything is ok and all the files have
+        #   rspec corresponding files
+        def valid?
+          @output[:app].empty? && @output[:rspec].empty?
+        end
+
+        # @return [String] label with this validator description
+        def label
+          "Rspec files structure (#{analyzed_files.count} checked)"
+        end
+
+        # @return [String] error message that will be displayed if something
+        #   goes wrong
+        def error_message
+          err = files_error_message + rspec_error_message
+          err
+        end
+
+        private
+
+        # @return [Array<String>] array with list of files that we want to compare with
+        #   those from Rspec that should exist
+        def analyzed_files
+          files = FILES_CHECKED.map do |dir|
+            Dir[File.join(DevTools.app_root, dir)]
+          end
+
+          files.flatten!
+          files.uniq!
+
+          files.delete_if do |file|
+            excludes.any? { |exclude| file.include?(exclude) }
+          end
+
+          files.map! { |file| sanitize(file) }
+
+          files
+        end
+
+        # @return [Array<String>] rspec files that should correspond with analyzed_files
+        def rspec_files
+          files = RSPEC_FILES.map { |dir| Dir[File.join(DevTools.app_root, dir)] }
+
+          files.flatten!
+
+          files.delete_if do |file|
+            excludes.any? { |exclude| file =~ /#{exclude}/ }
+          end
+
+          files.map! { |file| sanitize(file) }
+          files.uniq!
+
+          files
+        end
+
+        # @param [String] file name that we want to sanitize
+        # @return [String] sanitized file name
+        # @example
+        #   file = /home/something/app/models/user.rb
+        #   sanitize(file) #=> models/user.rb
+        def sanitize(file)
+          file.gsub!(DevTools.app_root + '/', '')
+          file.gsub!('_spec.rb', '.rb')
+          file.gsub!('spec/', '')
+          file.gsub!('app/', '')
+          file
+        end
+
+        # @return [String] return message with files which don't
+        # have corresponding Rspec files
+        def files_error_message
+          return '' if @output[:app].empty?
+          err = 'Following files don\'t have corresponding Rspec files:'
+          err << "\n\n"
+          err << @output[:app].join("\n")
+          err << "\n"
+          err
+        end
+
+        # @return [String] return message with Rspec files which don't
+        # have corresponding files
+        def rspec_error_message
+          return '' if @output[:rspec].empty?
+          err = "\n\n"
+          err << 'Following Rspec don\'t have corresponding files:'
+          err << "\n\n"
+          err << @output[:rspec].map! { |file| file.gsub!('.rb', '_spec.rb') }.join("\n")
+          err << "\n"
+          err
+        end
+
+        # @return [Array<String>] list of files/directories that
+        #   should be excluded from checking
+        # @note This should be set in the initializer for this gem
+        #   in the place where it is going to be used
+        def excludes
+          DevTools.config.rspec_files_structure_ignored || []
+        end
+      end
+    end
+  end
+end

data/lib/polishgeeks/dev-tools/command/rubocop.rb

@@ -0,0 +1,50 @@
+module PolishGeeks
+  module DevTools
+    module Command
+      # Command wrapper for Rubocop validation
+      # It informs us if code is formatted in a proper way
+      class Rubocop < Base
+        self.type = :validator
+
+        # Regexp used to get number of inspected files
+        FILES_REGEXP = /(\d+) files inspected/
+        # Regexp used to get number of offenses detected
+        OFFENSES_REGEXP = /(\d+) offense.* detected/
+
+        # Executes this command
+        # @return [String] command output
+        def execute
+          loc_config = File.join(DevTools.gem_root, 'config', 'rubocop.yml')
+          app_config = File.join(DevTools.app_root, '.rubocop.yml')
+
+          config = File.exist?(app_config) ? app_config : loc_config
+          cmd = "bundle exec rubocop -c #{config} #{PolishGeeks::DevTools.app_root}"
+
+          @output = Shell.new.execute(cmd)
+        end
+
+        # @return [Boolean] true if there were no Rubocop offenses detected
+        def valid?
+          offenses_count == 0
+        end
+
+        # @return [String] default label for this command
+        def label
+          "Rubocop (#{files_count} files, #{offenses_count} offenses)"
+        end
+
+        private
+
+        # @return [Integer] number of files inspected
+        def files_count
+          output.scan(FILES_REGEXP).flatten.first.to_i
+        end
+
+        # @return [Integer] number of offences found
+        def offenses_count
+          output.scan(OFFENSES_REGEXP).flatten.first.to_i
+        end
+      end
+    end
+  end
+end

data/lib/polishgeeks/dev-tools/command/rubycritic.rb

@@ -0,0 +1,17 @@
+module PolishGeeks
+  module DevTools
+    module Command
+      # Command wrapper for RubyCritic statistics
+      # It informs us if RubyCritic stats were generated
+      class Rubycritic < Base
+        self.type = :generator
+
+        # Executes this command
+        # @return [String] command output
+        def execute
+          @output = Shell.new.execute('bundle exec rubycritic ./app ./lib/')
+        end
+      end
+    end
+  end
+end

data/lib/polishgeeks/dev-tools/command/simplecov.rb

@@ -0,0 +1,32 @@
+module PolishGeeks
+  module DevTools
+    module Command
+      # Command wrapper for Simplecov statistics
+      # It informs us if Simplecov coverage stats were generated
+      class Simplecov < Base
+        self.type = :validator
+
+        # Regexp used to match code coverage from Simplecov generated output
+        MATCH_REGEXP = /\(\d+.\d+\%\) covered/
+
+        # Executes this command
+        # @return [String] command output
+        # @note Since this command wrapper is using external output
+        #   information (from Rspec), it doesn't execute any shell tasks
+        def execute
+          @output = stored_output.rspec
+        end
+
+        # @return [Boolean] true if Simplecov coverage was generated
+        def valid?
+          output[MATCH_REGEXP].length > 0
+        end
+
+        # @return [String] default label for this command
+        def label
+          "Simplecov #{output[MATCH_REGEXP]}"
+        end
+      end
+    end
+  end
+end

data/lib/polishgeeks/dev-tools/command/tasks_files_names.rb

@@ -0,0 +1,76 @@
+module PolishGeeks
+  module DevTools
+    module Command
+      # Checks if tasks files (rake and capistrano) have proper extensions
+      class TasksFilesNames < Base
+        self.type = :validator
+
+        attr_reader :counter
+
+        # Capistrano tasks check rules
+        CAP = OpenStruct.new(
+          dirs: %w(
+            lib/capistrano
+          ),
+          regexp: /.*\.cap$/
+        )
+
+        # Rake tasks check rules
+        RAKE = OpenStruct.new(
+          dirs: %w(
+            lib/tasks
+          ),
+          regexp: /.*\.rake$/
+        )
+
+        # Executes this command
+        # @return [Array<String>] command output array with list of spec files
+        #   that dont have a proper name, or an empty array if everything is ok
+        def execute
+          @output = []
+          @counter = 0
+
+          cap_files = files(CAP)
+          @counter += cap_files.count
+
+          cap_files.delete_if { |file| file =~ CAP.regexp }
+          @output += cap_files
+
+          rake_files = files(RAKE)
+          @counter += rake_files.count
+
+          rake_files.delete_if { |file| file =~ RAKE.regexp }
+          @output += rake_files
+        end
+
+        # @return [Boolean] true if all files have proper names and extensions
+        def valid?
+          output.empty?
+        end
+
+        # @return [String] default label for this command
+        def label
+          "Tasks files names: #{counter} files checked"
+        end
+
+        # @return [String] message that should be printed when some files have
+        #   invalid extensions/names
+        def error_message
+          "Following files have invalid extensions: \n #{output.join("\n")}\n"
+        end
+
+        private
+
+        # @param type [OpenStruct] openstruct with a dirs and regexp methods
+        # @return [Array<String>] Array with all the files of appropriate type
+        def files(type)
+          files = type.dirs.map { |dir| Dir["#{DevTools.app_root}/#{dir}/**/*"] }
+          files.flatten!
+          files.delete_if { |file| File.directory?(file) }
+
+          files
+        end
+      end
+    end
+  end
+end