roodi 3.1.1 → 3.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 791b4df2f1296693e2b3bb3eff9ca6f20e5f42f3
-  data.tar.gz: 3c6cc32ae0aae19f77615c293f59f331d209a076
+  metadata.gz: cc65ef0c9ffac9f896579cda0a56572065ea813f
+  data.tar.gz: 8c0c7e0b9ca16a6f2e2597fc38677c6ac12ea663
 SHA512:
-  metadata.gz: cc7d87be26ee71b755ca594122c0fcb95321dd223d16c7c3ea3b0d88756b7d667a6d99b82338f6a36e21df30cc1ecf61c2b9d01496774abcd18c05a15f041090
-  data.tar.gz: e400fb3c7e4a3b66d8992ef43e18b881ddff25d4a51e49da8c000a491ebe15fc365432db646761d7ddcdcf7b9713189fdd374877385903a1262eed8ee95e61a3
+  metadata.gz: e5ff37f5f09ebfab6113e5fcf9e0705998ff1067174df0be337f4ee3b42fcfadc1273639e7447e56b26bb89089879f16e2fbd5d8a68598473211f345b2e38eb9
+  data.tar.gz: 6f07ed9c3bb7f711daf43f5ce2108b98654f06a315aed57c83e3d0d236d790a517d8811868d98e3ac18db5fa588504718e2541839107b3a7fe85e9e39a95edd4

data/.travis.yml

@@ -1,11 +1,7 @@
 language: ruby
 rvm:
-  - 1.8.7
   - 1.9.2
   - 1.9.3
   - 2.0.0
-  - jruby-18mode # JRuby in 1.8 mode
   - jruby-19mode # JRuby in 1.9 mode
-  - rbx-18mode
   - rbx-19mode
-  - ree

data/History.txt

@@ -1,3 +1,11 @@
+= 3.2.0
+* Checks all files under current directory by default
+* Made it easier to run for the whole project as a rake task
+* Added instructions for how to add Roodi to your Rakefile
+* Removed support for Ruby Enterprise Edition
+* Removed support for Ruby 1.8
+* Improved installation instructions and corrected spelling error
+
 = 3.1.1
 * Merge pull request #23 from metricfu/remove_rubygems_require
   * Fix ruby warnings

data/README.md

@@ -1,16 +1,21 @@
 # roodi
 
 [![Build Status](https://travis-ci.org/roodi/roodi.png?branch=master)](https://travis-ci.org/roodi/roodi)
-[![Code Climate](https://codeclimate.com/repos/5204c3fc7e00a47bf7015e4e/badges/44ede0c56a53ff100012/gpa.png)](https://codeclimate.com/repos/5204c3fc7e00a47bf7015e4e/feed)
 [![Coverage Status](https://coveralls.io/repos/roodi/roodi/badge.png?branch=master)](https://coveralls.io/r/roodi/roodi?branch=master)
 
 ## Description
 
-Roodi stands for Ruby Object Oriented Design Inferometer. It parses your Ruby code and warns you about design issues you have based on the checks that is has configured.
+Roodi stands for Ruby Object Oriented Design Inferometer. It parses your Ruby code and warns you about design issues you have based on the checks that it has configured.
 
 ## Install
 
-`$ sudo gem install roodi`
+Open your terminal and type this:
+
+`$ gem install roodi`
+
+Alternatively, you can put it in your Gemfile:
+
+`gem "roodi"`
 
 ## Synopsis
 
@@ -20,6 +25,10 @@ To check one or more files using the default configuration that comes with Roodi
 
 ## Example Usage
 
+Check all ruby files recursively under the current directory:
+
+`$ roodi` or `$ roodi .`
+
 Check all ruby files in a rails app:
 
 `$ roodi "rails_app/**/*.rb"`
@@ -40,6 +49,14 @@ If you're writing a check, it is useful to see the structure of a file the way t
 
 `$ roodi-describe [filename]`
 
+## Running it as part of your build
+
+Add the following to your Rakefile:
+
+    require 'roodi_task'
+    RoodiTask.new
+    task :default => [:roodi]
+
 ## Custom Configuration
 
 To change the set of checks included, or to change the default values of the checks, you can provide your own config file.  The config file is a YAML file that lists the checks to be included.  Each check can optionally include a hash of options that are passed to the check to configure it.  For example, the default config file looks like this:

data/Rakefile

@@ -3,21 +3,12 @@ require 'rspec/core/rake_task'
 require 'bundler'
 require 'roodi'
 require 'bundler/gem_tasks'
-
-def roodi(ruby_files)
-  roodi = Roodi::Core::Runner.new
-  ruby_files.each { |file| roodi.check_file(file) }
-  roodi.errors.each {|error| puts error}
-  puts "\nFound #{roodi.errors.size} errors."
-end
+require 'roodi_task'
 
 desc "Run all specs"
 RSpec::Core::RakeTask.new(:spec)
 
 desc "Run Roodi against all source files"
-task :roodi do
-  pattern = File.join(File.dirname(__FILE__), "**", "*.rb")
-  roodi(Dir.glob(pattern))
-end
+RoodiTask.new
 
 task :default => [:spec, :roodi]

data/bin/roodi

@@ -10,12 +10,12 @@ config_param = ARGV.detect {|arg| arg =~ /-config=.*/}
 runner.config = config_param.split("=")[1] if config_param
 ARGV.delete config_param
 
-ARGV.each do |arg|
-  Dir.glob(arg).each { |file| runner.check_file(file) }
-end
+puts "\nRunning Roodi checks"
 
+runner.start(ARGV)
 runner.errors.each {|error| puts error}
 
-puts "\nFound #{runner.errors.size} errors."
+puts "\nChecked #{runner.files_checked} files"
+puts "Found #{runner.errors.size} errors"
 
-exit runner.errors.size
+exit runner.errors.size

data/lib/roodi/core/runner.rb

@@ -11,12 +11,36 @@ module Roodi
       DEFAULT_CONFIG = File.join(File.dirname(__FILE__), "..", "..", "..", "roodi.yml")
 
       attr_writer :config
+      attr_reader :files_checked
 
       def initialize(*checks)
         @config = DEFAULT_CONFIG
         @checks = checks unless checks.empty?
       end
 
+      def start(paths)
+        paths = ['.'] if paths == []
+        all_files = collect_files(paths)
+        @files_checked = all_files.count
+        all_files.each do |path|
+          check_file(path)
+        end
+      end
+
+      def collect_files(paths)
+        files = []
+        paths.each do |path|
+          if File.file?(path)
+            files << path
+          elsif File.directory?(path)
+            files += Dir.glob(File.join(path, '**/*.{rb,erb}'))
+          else
+            files += Dir.glob(path)
+          end
+        end
+        files
+      end
+
       def check(filename, content)
         @checks ||= load_checks
         @checker ||= CheckingVisitor.new(@checks)

data/lib/roodi/version.rb

@@ -1,3 +1,3 @@
 module Roodi
-  VERSION = '3.1.1'
+  VERSION = '3.2.0'
 end

data/lib/roodi_task.rb

@@ -1,3 +1,6 @@
+require 'rake/tasklib'
+require 'roodi'
+
 class RoodiTask < Rake::TaskLib
   attr_accessor :name
   attr_accessor :patterns
@@ -6,7 +9,7 @@ class RoodiTask < Rake::TaskLib
 
   def initialize name = :roodi, patterns = nil, config = nil
     @name      = name
-    @patterns  = patterns || %w(app/**/*.rb lib/**/*.rb spec/**/*.rb test/**/*.rb)
+    @patterns  = patterns || []
     @config    = config
     @verbose   = Rake.application.options.trace
 
@@ -16,18 +19,20 @@ class RoodiTask < Rake::TaskLib
   end
 
   def define
-    desc "Check for design issues in: #{patterns.join(', ')}"
+    desc "Run Roodi against all source files"
     task name do
+      puts "\nRunning Roodi checks"
+
       runner = Roodi::Core::Runner.new
 
       runner.config = config if config
 
-      patterns.each do |pattern|
-        Dir.glob(pattern).each { |file| runner.check_file(file) }
-      end
+      runner.start(@patterns)
 
       runner.errors.each {|error| puts error}
 
+      puts "\nChecked #{runner.files_checked} files"
+
       raise "Found #{runner.errors.size} errors." unless runner.errors.empty?
     end
     self

data/spec/roodi/core/runner_spec.rb

@@ -32,6 +32,25 @@ describe Roodi::Core::Runner do
       expect(subject.errors).to_not be_empty
       expect(subject.errors[0]).to eq "dummy-file.rb looks like it's not a valid Ruby file."
     end
+
+    it "checks that one file" do
+      subject.start(['lib/roodi.rb'])
+      expect(subject.files_checked).to eq 1
+    end
+  end
+
+  describe "running against a directory" do
+    it "checks all files in that directory recursively" do
+      subject.start(['.'])
+      expect(subject.files_checked).to be > 1
+    end
+  end
+
+  describe "running without specifying files or directory" do
+    it "checks all files in that directory recursively" do
+      subject.start([])
+      expect(subject.files_checked).to be > 1
+    end
   end
 
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: roodi
 version: !ruby/object:Gem::Version
-  version: 3.1.1
+  version: 3.2.0
 platform: ruby
 authors:
 - Marty Andrews
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-08-25 00:00:00.000000000 Z
+date: 2013-11-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: ruby_parser