rubycritic 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: e3254c84987373469b8c33271f81794a5495b7a1
+  data.tar.gz: 7face22a8c659ef7fb50c701e2ceaab5925c618a
+SHA512:
+  metadata.gz: 3f00535b10889d81455894436c7b79d117a085745fcc6e886dfb9aabf7c53bcb47827d4d1d9ca1a6b596a46e2a4f9b4ca0494b555e7552321f8ac76d887e1671
+  data.tar.gz: 5fd94e011dd5c5ae34fab83e23d528ec618307ce801fecb87cdf1971be8b32df281ee1c4ea05e12d338ac483a74f84b7566f9fd0ff7943f46661af8bad859496

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/CONTRIBUTING.md

@@ -0,0 +1,19 @@
+Contributing
+============
+
+1. Fork the project.
+2. Create your feature branch (`git checkout -b my-new-feature`).
+3. Stage partial-file changesets (`git -p`).
+4. Commit your changes (`git commit`).
+   Make exactly as many commits as you need.
+   Too many is confusing. Too few will result in epic diffs. Strive for just the right number.
+   Each commit should do one thing and one thing only.
+   Follow [these guidelines][1] when writing your commit messages.
+5. [Hide the sausage making][2]. Squash, split and reorder commits if necessary (`git rebase -i`).
+   For a more in-depth look at interactive rebasing, be sure to check [how to rewrite history][3].
+6. Push to the branch (`git push origin my-new-feature`).
+7. Create new Pull Request.
+
+[1]: http://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html
+[2]: http://sethrobertson.github.io/GitBestPractices/#sausage
+[3]: http://git-scm.com/book/en/Git-Tools-Rewriting-History#Changing-Multiple-Commit-Messages

data/Gemfile

@@ -0,0 +1,4 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in rubycritic.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Guilherme Simoes
+
+MIT License
+
+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/README.md

@@ -0,0 +1,41 @@
+Ruby Critic
+===========
+
+Ruby Critic is a tool that detects and reports smells in Ruby code.
+
+Installation
+------------
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem "rubycritic"
+```
+
+And then execute:
+
+```bash
+$ bundle
+```
+
+Or just install it yourself:
+
+```bash
+$ gem install rubycritic
+```
+
+Usage
+-----
+
+Running `rubycritic` with no arguments will check all Ruby source files in the
+current directory:
+
+```bash
+$ rubycritic
+```
+
+Alternatively you can pass `rubycritic` a list of files and directories to check:
+
+```bash
+$ rubycritic app lib/foo.rb
+```

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+task :default => :test
+
+Rake::TestTask.new do |t|
+  t.libs.push "lib"
+  t.libs.push "test"
+  t.pattern = "test/**/*_test.rb"
+end

data/SPEC.md

@@ -0,0 +1,58 @@
+Ruby Critic
+===========
+
+Ruby Critic is a tool that detects and reports smells in Ruby code.
+
+Inspired by [RuboCop][1], [Rails Best Practices][2] and [Code Climate][3], Ruby Critic aims to better help you refactor your code. By making use of Ruby's rich ecosystem of code metrics tools, Ruby Critic generates high-quality visualizations and insightful code quality reports.
+
+[1]: https://github.com/bbatsov/rubocop/
+[2]: https://github.com/railsbp/rails_best_practices
+[3]: https://codeclimate.com/
+
+Installation
+------------
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem "rubycritic"
+```
+
+And then execute:
+
+```bash
+$ bundle
+```
+
+Or just install it yourself:
+
+```bash
+$ gem install rubycritic
+```
+
+Usage
+-----
+
+Running `rubycritic` with no arguments will check all Ruby source files in the
+current directory:
+
+```bash
+$ rubycritic
+```
+
+Alternatively you can pass `rubycritic` a list of files and directories to check:
+
+```bash
+$ rubycritic app lib/foo.rb
+```
+
+Options
+-------
+
+To specify an output file for the results:
+
+```bash
+$ rubycritic -o output_file
+```
+
+The output format is determined by the file extension or by using the `-f` option. Current options are: `text`, `html`, `yaml` and `json`.

data/bin/rubycritic

@@ -0,0 +1,3 @@
+#!/usr/bin/env ruby
+
+require "rubycritic/cli"

data/lib/rubycritic.rb

@@ -0,0 +1,23 @@
+require "rubycritic/source_locator"
+require "rubycritic/analysers/reek"
+require "rubycritic/smell_adapters/reek"
+require "rubycritic/smells_aggregator"
+require "rubycritic/report_generators/report_generator"
+
+module Rubycritic
+
+  class Rubycritic
+    def initialize(paths)
+      @source = SourceLocator.new(paths)
+
+      analyser = Analyser::Reek.new(@source.paths)
+      smell_adapters = [ SmellAdapter::Reek.new(analyser) ]
+      @aggregator = SmellsAggregator.new(smell_adapters)
+    end
+
+    def critique
+      ReportGenerator.new(@source.pathnames, @aggregator.smelly_pathnames).generate_report
+    end
+  end
+
+end

data/lib/rubycritic/analysers/config.reek

@@ -0,0 +1,18 @@
+---
+Attribute:
+  enabled: false
+IrresponsibleModule:
+  enabled: false
+UncommunicativeMethodName:
+  reject:
+  - !ruby/regexp /^[a-z]$/
+  - !ruby/regexp /[0-9]$/
+UncommunicativeParameterName:
+  reject:
+  - !ruby/regexp /^.$/
+  - !ruby/regexp /[0-9]$/
+  - !ruby/regexp /^_/
+UncommunicativeVariableName:
+  reject:
+  - !ruby/regexp /^.$/
+  - !ruby/regexp /[0-9]$/

data/lib/rubycritic/analysers/flog.rb

@@ -0,0 +1,20 @@
+require "flog"
+
+module Rubycritic
+  module Analyser
+
+    class Flog < ::Flog
+      DEFAULT_OPTIONS = {
+        :all => true,
+        :continue => true,
+        :methods => true
+      }
+
+      def initialize(paths)
+        super(DEFAULT_OPTIONS)
+        flog(*paths)
+      end
+    end
+
+  end
+end

data/lib/rubycritic/analysers/reek.rb

@@ -0,0 +1,15 @@
+require "reek"
+
+module Rubycritic
+  module Analyser
+
+    class Reek < ::Reek::Examiner
+      DEFAULT_CONFIG_FILES = [File.expand_path("../config.reek", __FILE__)]
+
+      def initialize(paths)
+        super(Array(paths), DEFAULT_CONFIG_FILES)
+      end
+    end
+
+  end
+end

data/lib/rubycritic/cli.rb

@@ -0,0 +1,25 @@
+require "optparse"
+require "rubycritic"
+
+module Rubycritic
+
+  OptionParser.new do |opts|
+    opts.banner = "Usage: rubycritic [options] [paths]"
+
+    opts.on_tail("-v", "--version", "Show this version") do
+      require "rubycritic/version"
+      puts VERSION
+      exit 0
+    end
+
+    opts.on_tail("-h", "--help", "Show this message") do
+      puts opts
+      exit 0
+    end
+  end.parse!
+
+  ARGV << "." if ARGV.empty?
+  Rubycritic.new(ARGV).critique
+  exit 0
+
+end

data/lib/rubycritic/location.rb

@@ -0,0 +1,40 @@
+require "pathname"
+
+module Rubycritic
+
+  class Location
+    attr_reader :pathname, :line
+
+    def initialize(path, line)
+      @pathname = Pathname.new(path)
+      @line = line
+    end
+
+    def path
+      @pathname.to_s
+    end
+
+    def file
+      @pathname.basename.to_s
+    end
+
+    def to_s
+      "#{path}:#{line}"
+    end
+
+    def ==(other)
+      self.class == other.class && state == other.state
+    end
+
+    def <=>(other)
+      state <=> other.state
+    end
+
+    protected
+
+    def state
+      [@pathname, @line]
+    end
+  end
+
+end

data/lib/rubycritic/report_generators/assets/stylesheets/application.css

@@ -0,0 +1,4 @@
+.smelly {
+  display: inline;
+  background-color: #FFC8C8;
+}

data/lib/rubycritic/report_generators/file_generator.rb

@@ -0,0 +1,58 @@
+require "erb"
+require "rubycritic/report_generators/line_generator"
+
+module Rubycritic
+
+  class FileGenerator
+    LINE_NUMBER_OFFSET = 1
+    REPORT_DIR = File.expand_path("tmp/rubycritic", Dir.getwd)
+    TEMPLATES_DIR = File.expand_path("../templates", __FILE__)
+    FILE_TEMPLATE = ERB.new(File.read(File.join(TEMPLATES_DIR, "file.html.erb")))
+    LAYOUT_TEMPLATE = ERB.new(File.read(File.join(TEMPLATES_DIR, "layouts", "application.html.erb")))
+
+    def initialize(pathname, smells)
+      @pathname = pathname
+      @smells = smells
+    end
+
+    def file_pathname
+      File.join(file_directory, file_name)
+    end
+
+    def file_directory
+      File.join(REPORT_DIR, File.dirname(@pathname))
+    end
+
+    def file_name
+      "#{@pathname.basename.sub_ext('')}.html"
+    end
+
+    def output
+      output ||= file_content
+    end
+
+    def stylesheet_path
+      File.join(REPORT_DIR, "assets/stylesheets/application.css")
+    end
+
+    def get_binding
+      binding
+    end
+
+    private
+
+    def file_content
+      file_code = ""
+      File.readlines(@pathname).each.with_index(LINE_NUMBER_OFFSET) do |line_text, line_number|
+        location = Location.new(@pathname, line_number)
+        line_smells = @smells.select { |smell| smell.located_in?(location) }
+        file_code << LineGenerator.new(line_text, line_number, line_smells).output
+      end
+
+      file_body = FILE_TEMPLATE.result(self.get_binding { file_code })
+
+      LAYOUT_TEMPLATE.result(self.get_binding { file_body })
+    end
+  end
+
+end

data/lib/rubycritic/report_generators/line_generator.rb

@@ -0,0 +1,29 @@
+require "cgi"
+require "erb"
+
+module Rubycritic
+
+  class LineGenerator
+    LINE_NUMBER_PADDING = 3
+    TEMPLATES_DIR = File.expand_path("../templates", __FILE__)
+    NORMAL_TEMPLATE = ERB.new(File.read(File.join(TEMPLATES_DIR, "line.html.erb")))
+    SMELLY_TEMPLATE = ERB.new(File.read(File.join(TEMPLATES_DIR, "smelly_line.html.erb")))
+
+    def initialize(text, number, smells)
+      @text = CGI::escapeHTML(text.chomp)
+      @number = number.to_s.rjust(LINE_NUMBER_PADDING)
+      @smells = smells
+      @template =
+        if @smells.empty?
+          NORMAL_TEMPLATE
+        else
+          SMELLY_TEMPLATE
+        end
+    end
+
+    def output
+      @output ||= @template.result(binding).delete("\n") + "\n"
+    end
+  end
+
+end

data/lib/rubycritic/report_generators/report_generator.rb

@@ -0,0 +1,31 @@
+require "fileutils"
+require "rubycritic/report_generators/file_generator"
+
+module Rubycritic
+
+  class ReportGenerator
+    ASSETS_DIR = File.expand_path("../assets", __FILE__)
+    REPORT_DIR = File.expand_path("tmp/rubycritic", Dir.getwd)
+
+    def initialize(source_pathnames, smelly_pathnames)
+      @source_pathnames = source_pathnames
+      @smelly_pathnames = smelly_pathnames
+    end
+
+    def generate_report
+      FileUtils.mkdir_p(REPORT_DIR)
+      FileUtils.cp_r(ASSETS_DIR, REPORT_DIR)
+
+      @source_pathnames.each do |pathname|
+        file_smells = @smelly_pathnames[pathname]
+        file_generator = FileGenerator.new(pathname, file_smells)
+
+        FileUtils.mkdir_p(file_generator.file_directory)
+        File.open(file_generator.file_pathname, "w+") do |report_file|
+          report_file.write(file_generator.output)
+        end
+      end
+    end
+  end
+
+end

data/lib/rubycritic/report_generators/templates/file.html.erb

@@ -0,0 +1 @@
+<pre><code><%= yield %></code></pre>

data/lib/rubycritic/report_generators/templates/layouts/application.html.erb

@@ -0,0 +1,16 @@
+<!DOCTYPE html>
+<html>
+    <head>
+        <meta charset="utf-8">
+        <meta http-equiv="X-UA-Compatible" content="IE=edge">
+        <title>RubyCritic</title>
+        <link href="<%= stylesheet_path %>" media="screen, projection, print" rel="stylesheet" type="text/css">
+        <meta name="description" content="">
+        <meta name="viewport" content="width=device-width, initial-scale=1">
+    </head>
+    <body>
+        <h1>RubyCritic</h1>
+
+        <%= yield %>
+    </body>
+</html>

data/lib/rubycritic/report_generators/templates/line.html.erb

@@ -0,0 +1 @@
+<%= @number %>. <%= @text %>

data/lib/rubycritic/report_generators/templates/smelly_line.html.erb

@@ -0,0 +1 @@
+<div class='smelly'><%= @number %>. <%= @text %> # <% @smells.each { |smell| %><%= smell %><% } %></div>

data/lib/rubycritic/smell.rb

@@ -0,0 +1,32 @@
+require "virtus"
+require "rubycritic/location"
+
+module Rubycritic
+
+  class Smell
+    include Virtus.model
+
+    attribute :context
+    attribute :locations
+    attribute :message
+    attribute :score
+    attribute :type
+
+    def pathnames
+      @pathnames ||= locations.map(&:pathname).uniq
+    end
+
+    def located_in?(other_location)
+      locations.any? { |location| location == other_location }
+    end
+
+    def <=>(other)
+      locations <=> other.locations
+    end
+
+    def to_s
+      "(#{type}) #{context} #{message}"
+    end
+  end
+
+end

data/lib/rubycritic/smell_adapters/flog.rb

@@ -0,0 +1,41 @@
+require "rubycritic/smell"
+
+module Rubycritic
+  module SmellAdapter
+
+    class Flog
+      def initialize(flog)
+        @flog = flog
+      end
+
+      def smells
+        smells = []
+        @flog.each_by_score do |class_method, score|
+          smells << create_smell(class_method, score)
+        end
+        smells
+      end
+
+      private
+
+      def create_smell(context, score)
+        location = method_location(context)
+        message  = "has a complexity of #{score.round}"
+        Smell.new(
+          :locations => [location],
+          :context => context,
+          :message => message,
+          :score => score,
+          :type => "Complexity"
+        )
+      end
+
+      def method_location(context)
+        line = @flog.method_locations[context]
+        file_path, file_line = line.split(':')
+        Location.new(file_path, file_line)
+      end
+    end
+
+  end
+end

data/lib/rubycritic/smell_adapters/reek.rb

@@ -0,0 +1,35 @@
+require "rubycritic/smell"
+
+module Rubycritic
+  module SmellAdapter
+
+    class Reek
+      def initialize(reek)
+        @reek = reek
+      end
+
+      def smells
+        @reek.smells.map do |smell|
+          create_smell(smell)
+        end
+      end
+
+      private
+
+      def create_smell(smell)
+        locations = smell_locations(smell.source, smell.lines)
+        message   = smell.message
+        context   = smell.context
+        type      = smell.subclass
+        Smell.new(:locations => locations, :context => context, :message => message, :type => type)
+      end
+
+      def smell_locations(file_path, file_lines)
+        file_lines.uniq.map do |file_line|
+          Location.new(file_path, file_line)
+        end
+      end
+    end
+
+  end
+end

data/lib/rubycritic/smells_aggregator.rb

@@ -0,0 +1,29 @@
+module Rubycritic
+
+  class SmellsAggregator
+    def initialize(smell_adapters)
+      @smell_adapters = smell_adapters
+    end
+
+    def smells
+      @smells ||= @smell_adapters.map(&:smells).flatten.sort
+    end
+
+    def smelly_pathnames
+      @smelly_pathnames ||= pathnames_to_files_with_smells
+    end
+
+    private
+
+    def pathnames_to_files_with_smells
+      pathnames = Hash.new { |hash, key| hash[key] = [] }
+      smells.each do |smell|
+        smell.pathnames.each do |path|
+          pathnames[path] << smell
+        end
+      end
+      pathnames
+    end
+  end
+
+end

data/lib/rubycritic/source_locator.rb

@@ -0,0 +1,31 @@
+module Rubycritic
+
+  class SourceLocator
+    RUBY_FILES = File.join("**", "*.rb")
+
+    def initialize(dirs)
+      @dirs = dirs
+    end
+
+    def pathnames
+      @pathnames ||= expand_paths
+    end
+
+    def paths
+      @paths ||= pathnames.map(&:to_s)
+    end
+
+    private
+
+    def expand_paths
+      @dirs.map do |path|
+        if File.directory?(path)
+          Pathname.glob(RUBY_FILES)
+        elsif File.exists?(path)
+          Pathname.new(path)
+        end
+      end.flatten.compact.sort
+    end
+  end
+
+end

data/lib/rubycritic/version.rb

@@ -0,0 +1,3 @@
+module Rubycritic
+  VERSION = "0.0.1"
+end

data/rubycritic.gemspec

@@ -0,0 +1,31 @@
+# coding: utf-8
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "rubycritic/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "rubycritic"
+  spec.version       = Rubycritic::VERSION
+  spec.authors       = ["Guilherme Simoes"]
+  spec.email         = ["guilherme.rdems@gmail.com"]
+  spec.description   = <<-EOF
+    Ruby Critic is a tool that detects and reports smells in Ruby classes, modules and methods.
+  EOF
+  spec.summary       = "Ruby code smell detector"
+  spec.homepage      = "https://github.com/GuilhermeSimoes/rubycritic"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split("\n")
+  spec.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  spec.test_files    = `git ls-files -- test/*`.split("\n")
+  spec.require_path  = "lib"
+
+  spec.add_runtime_dependency "virtus", "~> 1.0"
+  spec.add_runtime_dependency "flog", "4.2.0"
+  spec.add_runtime_dependency "reek", "1.3.6"
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "minitest", "~> 5.3"
+  spec.add_development_dependency "mocha", "~> 1.0"
+end

data/test/lib/rubycritic/location_test.rb

@@ -0,0 +1,37 @@
+require "test_helper"
+require "rubycritic/location"
+
+describe Rubycritic::Location do
+  describe "attribute readers" do
+    before do
+      @path = "./foo"
+      @line = 42
+      @location = Rubycritic::Location.new(@path, @line)
+    end
+
+    it "has a file path" do
+      @location.path.must_equal @path
+    end
+
+    it "has a file name" do
+      @location.file.must_equal "foo"
+    end
+
+    it "has a line number" do
+      @location.line.must_equal @line
+    end
+  end
+
+  it "is comparable" do
+    location1 = Rubycritic::Location.new("./foo", 42)
+    location2 = Rubycritic::Location.new("./foo", 42)
+    location1.must_equal location2
+  end
+
+  it "is sortable" do
+    location1 = Rubycritic::Location.new("./foo", 42)
+    location2 = Rubycritic::Location.new("./bar", 23)
+    location3 = Rubycritic::Location.new("./bar", 16)
+    [location1, location2, location3].sort.must_equal [location3, location2, location1]
+  end
+end

data/test/lib/rubycritic/metric_adapters/flog_adapter_test.rb

@@ -0,0 +1,25 @@
+require "test_helper"
+require "rubycritic/analysers/flog"
+require "rubycritic/smell_adapters/flog"
+
+describe Rubycritic::SmellAdapter::Flog do
+  before do
+    @sample_path = "test/samples/flog/smelly.rb"
+    flog = Rubycritic::Analyser::Flog.new([@sample_path])
+    @adapter = Rubycritic::SmellAdapter::Flog.new(flog)
+  end
+
+  it "detects smells" do
+    @adapter.smells.wont_be_empty
+  end
+
+  it "has smells with messages" do
+    smell = @adapter.smells.first
+    smell.message.must_equal "has a complexity of 8"
+  end
+
+  it "has smells with scores" do
+    smell = @adapter.smells.first
+    smell.score.must_be_kind_of Numeric
+  end
+end

data/test/lib/rubycritic/metric_adapters/reek_adapter_test.rb

@@ -0,0 +1,34 @@
+require "test_helper"
+require "rubycritic/analysers/reek"
+require "rubycritic/smell_adapters/reek"
+
+describe Rubycritic::SmellAdapter::Reek do
+  context "when analysing a smelly file" do
+    before do
+      @sample_path = "test/samples/reek/smelly.rb"
+      reek = Rubycritic::Analyser::Reek.new([@sample_path])
+      @adapter = Rubycritic::SmellAdapter::Reek.new(reek)
+    end
+
+    it "detects smells" do
+      @adapter.smells.wont_be_empty
+    end
+
+    it "has smells with messages" do
+      smell = @adapter.smells.first
+      smell.message.must_equal "has boolean parameter 'reek'"
+    end
+  end
+
+  context "when analysing a file with smells ignored in config.reek" do
+    before do
+      sample_path = "test/samples/reek/not_smelly.rb"
+      reek = Rubycritic::Analyser::Reek.new(sample_path)
+      @adapter = Rubycritic::SmellAdapter::Reek.new(reek)
+    end
+
+    it "does not detect smells" do
+      @adapter.smells.must_be_empty
+    end
+  end
+end

data/test/lib/rubycritic/smell_test.rb

@@ -0,0 +1,57 @@
+require "test_helper"
+require "rubycritic/smell"
+
+describe Rubycritic::Smell do
+  it "has a context reader" do
+    context = "#bar"
+    smell = Rubycritic::Smell.new(:context => context)
+    smell.context.must_equal context
+  end
+
+  it "has a locations reader" do
+    location = Rubycritic::Location.new("./foo", "42")
+    smell = Rubycritic::Smell.new(:locations => [location])
+    smell.locations.must_equal [location]
+  end
+
+  it "has a pathnames reader" do
+    path = Pathname.new("./foo")
+    location1 = Rubycritic::Location.new("./foo", "42")
+    location2 = Rubycritic::Location.new("./foo", "23")
+    smell = Rubycritic::Smell.new(:locations => [location1, location2])
+    smell.pathnames.must_equal [path]
+  end
+
+  it "has a message reader" do
+    message = "This smells"
+    smell = Rubycritic::Smell.new(:message => message)
+    smell.message.must_equal message
+  end
+
+  it "has a score reader" do
+    score = 0
+    smell = Rubycritic::Smell.new(:score => score)
+    smell.score.must_equal score
+  end
+
+  it "has a type reader" do
+    type = :complexity
+    smell = Rubycritic::Smell.new(:type => type)
+    smell.type.must_equal type
+  end
+
+  it "is sortable" do
+    location1 = Rubycritic::Location.new("./foo", 42)
+    location2 = Rubycritic::Location.new("./bar", 23)
+    location3 = Rubycritic::Location.new("./bar", 16)
+    [location1, location2, location3].sort.must_equal [location3, location2, location1]
+  end
+
+  describe "#located_in?" do
+    it "returns true if the smell has a location that matches the location passed as argument" do
+      location = Rubycritic::Location.new("./foo", "42")
+      smell = Rubycritic::Smell.new(:locations => [location])
+      smell.located_in?(location).must_equal true
+    end
+  end
+end

data/test/lib/rubycritic/smells_aggregator_test.rb

@@ -0,0 +1,47 @@
+require "test_helper"
+require "rubycritic/smells_aggregator"
+
+describe Rubycritic::SmellsAggregator do
+  context "when when analysing smelly files" do
+    before do
+      @location1 = Rubycritic::Location.new("./foo", "42")
+      @location2 = Rubycritic::Location.new("./bar", "23")
+      @location3 = Rubycritic::Location.new("./bar", "16")
+      @smell1 = Rubycritic::Smell.new(:locations => [@location1])
+      @smell2 = Rubycritic::Smell.new(:locations => [@location2, @location3])
+      @smell_adapters = [stub(:smells => [@smell1]), stub(:smells => [@smell2])]
+    end
+
+    describe "#smells" do
+      it "returns the smells found in those files" do
+        smells = [@smell2, @smell1]
+        Rubycritic::SmellsAggregator.new(@smell_adapters).smells.must_equal smells
+      end
+    end
+
+    describe "#smelly_pathnames" do
+      it "returns the files where smells were found" do
+        smelly_pathnames = {@location1.pathname => [@smell1], @location2.pathname => [@smell2]}
+        Rubycritic::SmellsAggregator.new(@smell_adapters).smelly_pathnames.must_equal smelly_pathnames
+      end
+    end
+  end
+
+  context "when analysing files with no smells" do
+    before do
+      @smell_adapters = [stub(:smells => [])]
+    end
+
+    describe "#smells" do
+      it "returns an empty array" do
+        Rubycritic::SmellsAggregator.new(@smell_adapters).smells.must_equal []
+      end
+    end
+
+    describe "#smelly_pathnames" do
+      it "returns an empty hash" do
+        Rubycritic::SmellsAggregator.new(@smell_adapters).smelly_pathnames.must_equal({})
+      end
+    end
+  end
+end

data/test/lib/rubycritic/source_locator_test.rb

@@ -0,0 +1,44 @@
+require "test_helper"
+require "rubycritic/source_locator"
+
+describe Rubycritic::SourceLocator do
+  before do
+    @original_dir = Dir.pwd
+    Dir.chdir("test/samples/location")
+  end
+
+  describe "#paths" do
+    it "finds a single path" do
+      paths = ["file0.rb"]
+      Rubycritic::SourceLocator.new(paths).paths.must_equal paths
+    end
+
+    it "finds multiple paths" do
+      paths = ["dir1/file1.rb", "file0.rb"]
+      Rubycritic::SourceLocator.new(paths).paths.must_equal paths
+    end
+
+    it "finds all the paths" do
+      paths = ["dir1/file1.rb", "file0.rb"]
+      Rubycritic::SourceLocator.new(["."]).paths.must_equal paths
+    end
+
+    it "deals with non-existent paths" do
+      paths = ["non_existent_dir1/non_existent_file1.rb", "non_existent_file0.rb"]
+      Rubycritic::SourceLocator.new(paths).paths.must_equal []
+    end
+  end
+
+  describe "#pathnames" do
+    it "finds a single path" do
+      path = "file0.rb"
+      paths = [path]
+      result = [Pathname.new(path)]
+      Rubycritic::SourceLocator.new(paths).pathnames.must_equal result
+    end
+  end
+
+  after do
+    Dir.chdir(@original_dir)
+  end
+end

data/test/lib/rubycritic/version_test.rb

@@ -0,0 +1,7 @@
+require "test_helper"
+
+describe "Rubycritic version" do
+  it "is defined" do
+    Rubycritic::VERSION.wont_be_nil
+  end
+end

data/test/samples/flog/smelly.rb

@@ -0,0 +1,6 @@
+class AllTheMethods
+  def method_missing(method, *args, &block)
+    define_method(method) { "I did not exist, but now I do." }
+    send(method)
+  end
+end

data/test/samples/reek/not_smelly.rb

@@ -0,0 +1,7 @@
+class Perfumed
+  attr_reader :perfume
+
+  def ignoresRubyStyle(oneParameter)
+    oneVariable = oneParameter
+  end
+end

data/test/samples/reek/smelly.rb

@@ -0,0 +1,5 @@
+class Theon
+  def reeks?(reek = true)
+    reek
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,7 @@
+require "minitest/autorun"
+require "minitest/pride"
+require "mocha/setup"
+
+def context(*args, &block)
+  describe(*args, &block)
+end

metadata

@@ -0,0 +1,199 @@
+--- !ruby/object:Gem::Specification
+name: rubycritic
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Guilherme Simoes
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-03-18 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: virtus
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: flog
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 4.2.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 4.2.0
+- !ruby/object:Gem::Dependency
+  name: reek
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.3.6
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.3.6
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !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'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.3'
+- !ruby/object:Gem::Dependency
+  name: mocha
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+description: |2
+      Ruby Critic is a tool that detects and reports smells in Ruby classes, modules and methods.
+email:
+- guilherme.rdems@gmail.com
+executables:
+- rubycritic
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- CONTRIBUTING.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- SPEC.md
+- bin/rubycritic
+- lib/rubycritic.rb
+- lib/rubycritic/analysers/config.reek
+- lib/rubycritic/analysers/flog.rb
+- lib/rubycritic/analysers/reek.rb
+- lib/rubycritic/cli.rb
+- lib/rubycritic/location.rb
+- lib/rubycritic/report_generators/assets/stylesheets/application.css
+- lib/rubycritic/report_generators/file_generator.rb
+- lib/rubycritic/report_generators/line_generator.rb
+- lib/rubycritic/report_generators/report_generator.rb
+- lib/rubycritic/report_generators/templates/file.html.erb
+- lib/rubycritic/report_generators/templates/layouts/application.html.erb
+- lib/rubycritic/report_generators/templates/line.html.erb
+- lib/rubycritic/report_generators/templates/smelly_line.html.erb
+- lib/rubycritic/smell.rb
+- lib/rubycritic/smell_adapters/flog.rb
+- lib/rubycritic/smell_adapters/reek.rb
+- lib/rubycritic/smells_aggregator.rb
+- lib/rubycritic/source_locator.rb
+- lib/rubycritic/version.rb
+- rubycritic.gemspec
+- test/lib/rubycritic/location_test.rb
+- test/lib/rubycritic/metric_adapters/flog_adapter_test.rb
+- test/lib/rubycritic/metric_adapters/reek_adapter_test.rb
+- test/lib/rubycritic/smell_test.rb
+- test/lib/rubycritic/smells_aggregator_test.rb
+- test/lib/rubycritic/source_locator_test.rb
+- test/lib/rubycritic/version_test.rb
+- test/samples/flog/smelly.rb
+- test/samples/location/dir1/file1.rb
+- test/samples/location/file0.rb
+- test/samples/reek/not_smelly.rb
+- test/samples/reek/smelly.rb
+- test/test_helper.rb
+homepage: https://github.com/GuilhermeSimoes/rubycritic
+licenses:
+- MIT
+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.1.11
+signing_key: 
+specification_version: 4
+summary: Ruby code smell detector
+test_files:
+- test/lib/rubycritic/location_test.rb
+- test/lib/rubycritic/metric_adapters/flog_adapter_test.rb
+- test/lib/rubycritic/metric_adapters/reek_adapter_test.rb
+- test/lib/rubycritic/smell_test.rb
+- test/lib/rubycritic/smells_aggregator_test.rb
+- test/lib/rubycritic/source_locator_test.rb
+- test/lib/rubycritic/version_test.rb
+- test/samples/flog/smelly.rb
+- test/samples/location/dir1/file1.rb
+- test/samples/location/file0.rb
+- test/samples/reek/not_smelly.rb
+- test/samples/reek/smelly.rb
+- test/test_helper.rb