quality 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 619cb08a5ce09129ca03e5cb3b6a04c927e35c03
+  data.tar.gz: 3ec8da62bbba3f08de40e56649ab94af6d8e00da
+SHA512:
+  metadata.gz: 04a2137f381c27549507c9772842b5025715ed5f7ee298d4743392e23396bf2d306ad183ba52049c4567ecd3fc7898210c8e02d69fab1039437ecbfe9e39e8ae
+  data.tar.gz: 904af73ba671ee5f9752e922490c569ab061959908a3705cfbbe14ae4cfd087ee8421364decc7f74e61de2f87c0c2fa35c122d16b8cc0011b857c691d1925e65

data/License.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2013 Vincent Broz
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/Rakefile

@@ -0,0 +1,19 @@
+require 'rake/clean'
+require "bundler/gem_tasks"
+
+$:.unshift File.dirname(__FILE__) + '/lib'
+
+PROJECT_NAME = 'quality'
+
+BUILD_DIR = 'build'; directory BUILD_DIR
+PKG_DIR = "#{BUILD_DIR}/pkg"; directory PKG_DIR
+
+GEM_MANIFEST = "Manifest.txt"
+VERSION_FILE = 'lib/quality.rb'
+
+CLOBBER.include("#{BUILD_DIR}/*")
+
+Dir['tasks/**/*.rake'].each { |t| load t }
+
+task :default => [:test]
+

data/lib/quality/rake/task.rb

@@ -0,0 +1,195 @@
+#!/usr/bin/env ruby
+
+require 'rake'
+require 'rake/tasklib'
+
+module Quality
+
+  #
+  # Defines a task library for running quality's various tools
+  # (Classes here will be configured via the Rakefile, and therefore will
+  # possess a :reek:attribute or two.)
+  #
+  module Rake
+
+    # A Rake task that run quality tools on a set of source files, and
+    # enforce a ratcheting quality level.
+    #
+    # Example:
+    #
+    #   require 'quality/rake/task'
+    #
+    #   Quality::Rake::Task.new do |t|
+    #   end
+    #
+    # This will create a task that can be run with:
+    #
+    #   rake quality
+    #
+    class Task < ::Rake::TaskLib
+
+      # Name of reek task.
+      # Defaults to :reek.
+      attr_accessor :name
+
+      # Array of directories to be added to $LOAD_PATH before running reek.
+      # Defaults to ['<the absolute path to reek's lib directory>']
+      attr_accessor :libs
+
+      # Use verbose output. If this is set to true, the task will print
+      # the reek command to stdout. Defaults to false.
+      attr_accessor :verbose
+
+      # Defines a new task, using the name +name+.
+      def initialize(name = :quality)
+        @name = name
+        @libs = [File.expand_path(File.dirname(__FILE__) + '/../../../lib')]
+        @config_files = nil
+        @source_files = nil
+        @ruby_opts = []
+        @reek_opts = ''
+        @fail_on_error = true
+        @sort = nil
+
+        yield self if block_given?
+        @config_files ||= 'config/**/*.reek'
+        @source_files ||= 'lib/**/*.rb'
+        define
+      end
+
+  private
+
+      def define # :nodoc:
+        desc 'Verify quality has increased or stayed' +
+          'the same' unless ::Rake.application.last_comment
+        task(name) { run_task }
+        self
+      end
+
+      def run_task
+        quality_cane
+        quality_reek
+        quality_flog
+        quality_flay
+      end
+      
+      def quality_quality_cmd(cmd,
+                              args: nil,
+                              emacs_format: false,
+                              &process_output_line)
+        violations = 0
+        out = ""
+        found_output = false
+        full_cmd = cmd
+        if !args.nil?
+          full_cmd = "#{cmd} #{args}"
+        end
+        IO.popen(full_cmd) do |f|
+          while line = f.gets
+            if emacs_format
+              if line =~ /^ *(\S*.rb:[0-9]*) *(.*)/
+                out << $1 << ": " << $2 << "\n"
+              elsif line =~ /^ *(.*) +(\S*.rb:[0-9]*) *(.*)/
+                out << $2 << ": " << $1 << "\n"
+              else
+                out << line
+              end
+            else
+              out << line
+            end
+            found_output = true
+            violations += yield line
+          end
+        end
+        exit_status = $?.exitstatus
+        if !found_output
+          fail "#{full_cmd} execution failed!  Exit status is #{exit_status}"
+        end
+        filename = "#{cmd}_high_water_mark"
+        if File.exist?(filename)
+          existing_violations = IO.read(filename).to_i
+        else
+          existing_violations = 9999999999
+        end
+        puts "Existing violations: #{existing_violations}"
+        puts "Found #{violations} #{cmd} violations"
+        if violations > existing_violations
+          fail "Output from #{cmd}\n\n#{out}\n\n" +
+            "Reduce total number of #{cmd} violations to #{existing_violations} or below!"
+        elsif violations < existing_violations
+          puts "Ratcheting quality up..."
+          File.open(filename, 'w') {|f| f.write(violations.to_s) }
+        end
+      end
+
+      def quality_cane
+        quality_quality_cmd("cane",
+                            emacs_format: true) { |line|
+          if line =~ /\(([0-9]*)\):$/
+            $1.to_i
+          else
+            0
+          end
+        }
+      end
+
+      def quality_reek
+        quality_quality_cmd("reek",
+                            args: "--line-number *.rb lib/*.rb 2>/dev/null",
+                            emacs_format: true) { |line|
+          if line =~ /^  .* (.*)$/
+            1
+          else
+            0
+          end
+        }
+      end
+
+      def quality_flog
+        threshold = 50
+        quality_quality_cmd("flog",
+                            args: "--all --continue --methods-only . 2>/dev/null",
+                            emacs_format: true) { |line|
+          if line =~ /^ *([0-9.]*): flog total$/
+            0
+            #$1.to_i
+          elsif line =~ /^ *([0-9.]*): (.*) .\/.*.rb:[0-9]*$/
+            score = $1.to_i
+            if score > threshold
+              1
+            else
+              0
+            end
+          else
+            0
+          end
+        }
+      end
+
+      def quality_flay
+        quality_quality_cmd("flay",
+                            args: "-t 99999 . 2>/dev/null",
+                            emacs_format: true) { |line|
+          if line =~ /^[0-9]*\).* \(mass = ([0-9]*)\)$/
+            $1.to_i
+          else
+            0
+          end
+        }  
+      end
+
+      def quality
+        Dir.glob("*_high_water_mark").each { |filename|
+          puts "Processing #{filename}"
+          existing_violations = IO.read(filename).to_i
+          if existing_violations <= 0
+            raise "Problem with file #{filename}"
+          end
+          new_violations = existing_violations - 1
+          File.open(filename, 'w') {|f| f.write(new_violations.to_s) }
+          system("git commit -m 'tighten quality standard' #{filename}")
+        }
+      end
+    end
+  end
+end

data/lib/quality/version.rb

@@ -0,0 +1,3 @@
+module Quality
+  VERSION = '0.0.1'
+end

data/quality.gemspec

@@ -0,0 +1,36 @@
+# -*- encoding: utf-8 -*-
+$:.push File.join(File.dirname(__FILE__), "lib")
+require 'quality/version'
+
+Gem::Specification.new do |s|
+  s.name = %q{quality}
+  s.version = Quality::VERSION
+
+  s.authors = ['Vince Broz']
+  #s.default_executable = %q{quality}
+  s.description = %q{Quality is a tool that runs quality checks on Ruby
+code using cane, reek, flog and flay, and makes sure 
+your numbers don't get any worse over time.
+}
+  s.email = ["vince@broz.cc"]
+  #s.executables = ["quality"]
+  #s.extra_rdoc_files = ["CHANGELOG", "License.txt"]
+  s.files = Dir["License.txt", "README.md",
+                "Rakefile",
+                #"bin/quality",
+                "{lib}/**/*",
+                "quality.gemspec" ] & `git ls-files -z`.split("\0")
+  #s.rdoc_options = ["--main", "README.md"]
+  s.require_paths = ["lib"]
+  #s.rubyforge_project = %q{quality}
+  s.rubygems_version = %q{1.3.6}
+  s.summary = %q{Code quality tools for Ruby}
+
+  s.add_runtime_dependency(%q<cane>, [">= 2.6"])
+  s.add_runtime_dependency(%q<reek>, [">= 1.3.1"])
+  s.add_runtime_dependency(%q<flog>, [">= 4.1.1"])
+  s.add_runtime_dependency(%q<flay>, [">= 2.4"])
+
+  s.add_development_dependency(%q<bundler>, [">= 1.1"])
+  s.add_development_dependency(%q<rake>)
+end

metadata

@@ -0,0 +1,133 @@
+--- !ruby/object:Gem::Specification
+name: quality
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Vince Broz
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-08-11 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: cane
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '2.6'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '2.6'
+- !ruby/object:Gem::Dependency
+  name: reek
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 1.3.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 1.3.1
+- !ruby/object:Gem::Dependency
+  name: flog
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 4.1.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 4.1.1
+- !ruby/object:Gem::Dependency
+  name: flay
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '2.4'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '2.4'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '1.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '1.1'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: "Quality is a tool that runs quality checks on Ruby\ncode using cane,
+  reek, flog and flay, and makes sure \nyour numbers don't get any worse over time.\n"
+email:
+- vince@broz.cc
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- License.txt
+- Rakefile
+- lib/quality/rake/task.rb
+- lib/quality/version.rb
+- quality.gemspec
+homepage: 
+licenses: []
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.0.6
+signing_key: 
+specification_version: 4
+summary: Code quality tools for Ruby
+test_files: []