preek 1.0.0 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 2300b0792702884ce539a9e7204c06f31fc1dcae
-  data.tar.gz: 5150fd3103a539732308a852c8efeb07abde9a9c
+  metadata.gz: 37e624d4a67976a8062a37c690c17957dd605706
+  data.tar.gz: 744b77bcea99590f34da0ee56b8bc72d15525b3a
 SHA512:
-  metadata.gz: d112cda98c69d5b28fd531d64a104e2576f1e656dc1c34adbff5b8f0d6491a342fbe54157201b1a8f99b9f9559db5a4fac7e09f87e084514b5786bffd9caa4dd
-  data.tar.gz: 3f8db5a1be25a4125ee1a23b292fd896b024002ac972a68fcf0c1e7d6805abf501169a582db549276edbf6780e14710492bf8736bac81eff3a69aee5226652ae
+  metadata.gz: 9d7fb7c110fd621346a35d1c6c1eaf46b4888a6d5e25a99c2632e5ecc7dfa69b16bf8caf5b16bc7c80e99021a1fbf1cfdede29a2722c2fffa11b8928d7e196bb
+  data.tar.gz: fa3d7538f75edf82b4976ffd2ab4047e7e46096617ae4c81a070b461ee6d725ed622a1ad0c6fd27751a7ddbac3fa4dd849e8c5beec1b3f76c309db0f528d5d8d

data/README.md

@@ -9,24 +9,23 @@
 
 For a pretty colorful output of [Reek](https://github.com/troessner/reek), which is an awesome gem!
 This is just something I came up with while learning [Thor](https://github.com/wycats/thor).
-As an exercise I also worked on getting Reek and Pelusa to stop whining when running them on the code.
 
 ## Installation
 
-Install it yourself as:
+    $ gem install preek
 
-    $ git clone git@github.com:joenas/preek.git
+From source
 
+    $ git clone git@github.com:joenas/preek.git
     $ cd preek
-
     $ rake install
 
-or
 
-    $ gem install preek
 
 
 ## Usage
+
+### CLI
 ```bash
 Usage:
   preek smell FILE(S)|DIR
@@ -45,6 +44,21 @@ At the moment it only supports files, not stuff like this:
 
     $ echo "def x() true end" | reek
 
+### Ruby
+
+```ruby
+# Convenience method, prints all smells in files
+
+filenames = Dir['**/*.rb']
+Preek::Smell(filenames)
+
+# To exclude certain smell classes
+
+excludes = %w(IrresponsibleModule)
+Preek::Smell(filenames, excludes)
+
+
+```
 
 ## Contributing
 

data/lib/preek/cli.rb

@@ -21,33 +21,22 @@ module Preek
                   aliases: '-i',
                   desc: 'include IrresponsibleModule smell in output.'
     def smell(*args)
-      args ||= @args
-      @includes = options.keys.map {|key| _aliases[key.to_sym] }
-      @files, @not_files = args.partition { |file| File.exists? file }
-      report_smells
-      report_not_files
+      Preek::Smell(args, excludes)
     end
 
   private
-    def report_smells
-      return if @files.empty?
-      smelly_files = SmellCollector.new(@files, excludes).smelly_files
-      SmellReporter.new(smelly_files).print_smells
-    end
-
-    def report_not_files
-      return if @not_files.empty?
-      say_status :error, "No such file(s) - #{@not_files.join(', ')}.", :red
-    end
-
     def _aliases
       {
         irresponsible: 'IrresponsibleModule'
       }
     end
 
+    def includes
+      options.keys.map {|key| _aliases[key.to_sym] }
+    end
+
     def excludes
-      (exclude_list - @includes)
+      (exclude_list - includes)
     end
 
     def exclude_list

data/lib/preek/smell_collector.rb

@@ -8,23 +8,36 @@ require 'preek/smell_klass'
 module Preek
   # This is a 'Collector'
   class SmellCollector
-    def initialize(files, excludes)
-      @files = files
+    def initialize(files, excludes = [])
+      @files = files.delete_if { |file| !File.exists? file }
       @excludes = excludes
     end
 
     def smelly_files
-      @smelly_files ||= examine_sources
+      @smelly_files ||= files_from_sources
     end
 
   private
-    def examine_sources
-      sources.map do |source|
-        smells = Reek::Examiner.new(source).smells
-        SmellFile.new(smells, @excludes) unless smells.empty?
+    def files_from_sources
+      filtered_sources.map do |examiner|
+        SmellFile.new(examiner) if examiner.smelly?
       end.compact
     end
 
+    def filtered_sources
+      sources.map do |source|
+        examiner = Reek::Examiner.new(source)
+        filter_excludes_from(examiner)
+        examiner
+      end
+    end
+
+    def filter_excludes_from(examiner)
+      examiner.smells.delete_if do |smell|
+        @excludes.include? smell.smell_class
+      end
+    end
+
     def sources
       Reek::Source::SourceLocator.new(@files).all_sources
     end

data/lib/preek/smell_file.rb

@@ -3,29 +3,27 @@ module Preek
   class SmellFile
     attr_reader :klasses
 
-    def initialize(smells, excludes)
-      @smells = smells
-      @excludes = excludes
+    def initialize(examiner)
+      @examiner = examiner
       @klasses = {}
       add_smells_to_klasses
     end
 
     def file
-      @smells.first.source
+      @examiner.description
     end
 
     alias :filename :file
 
   private
     def add_smells_to_klasses
-      @smells.each do |smell|
-        next if @excludes.include? smell.smell_class
-        find(smell.klass).add smell
+      @examiner.smells.each do |smell|
+        find(smell.klass) << smell
       end
     end
 
     def find(klassname)
-      @klasses[klassname.to_sym] ||= SmellKlass.new
+      @klasses[klassname.to_sym] ||= SmellKlass.new(klassname)
     end
   end
 end

data/lib/preek/smell_klass.rb

@@ -1,7 +1,10 @@
 module Preek
   # A container for a smelly klass in a file!
   class SmellKlass
-    def initialize
+    attr_reader :name
+
+    def initialize(name)
+      @name = name
       @smells = []
     end
 
@@ -9,9 +12,7 @@ module Preek
       @smells << smell
     end
 
-    def name
-      @smells.first.klass
-    end
+    alias :<< :add
 
     def smells
       @smells.map(&:smell_string)

data/lib/preek/smell_reporter.rb

@@ -2,20 +2,39 @@ require 'thor/shell/color'
 module Preek
   # Here we report the smells in a nice fashion
   class SmellReporter < Thor::Shell::Color
-    def initialize smelly_files
-      @smelly_files = smelly_files.delete_if {|smell_file| smell_file.klasses.empty? }
+    def initialize(smelly_files, not_files)
+      @smelly_files = smelly_files
+      @not_files = not_files
       @padding = 0
     end
 
     def print_smells
-      return say_status 'success!', 'No smells detected.' if @smelly_files.empty?
+      if success?
+        say_status 'success!', 'No smells detected.'
+      else
+        print_each_smell
+      end
+      print_not_files
+    end
+    alias :print_result :print_smells
+
+  private
+    def success?
+      @smelly_files.empty?
+    end
+
+    def print_not_files
+      return if @not_files.empty?
+      say_status :error, "No such file(s) - #{@not_files.join(', ')}.", :red
+    end
+
+    def print_each_smell
       print_line
       @smelly_files.each do |smelly|
         say_status 'file', format_path(smelly.filename), :blue
         print_klasses smelly.klasses
       end
     end
-  private
 
     def print_klasses klasses
       klasses.each do |index, klass|

data/lib/preek/version.rb

@@ -1,3 +1,3 @@
 module Preek
-  VERSION = "1.0.0"
+  VERSION = "1.1.0"
 end

data/lib/preek.rb

@@ -1,8 +1,11 @@
 module Preek
-  require 'thor'
-
   require 'preek/version'
   require 'preek/smell_collector'
   require 'preek/smell_reporter'
 
-end
+  def self.Smell(filenames, excludes = [])
+    files, not_files = filenames.partition { |file| File.exists? file }
+    smelly_files = SmellCollector.new(files, excludes).smelly_files
+    SmellReporter.new(smelly_files, not_files).print_result
+  end
+end

data/spec/cli_spec.rb

@@ -22,6 +22,9 @@ describe Preek::CLI do
 
     context "with non-existing file in ARGS" do
       let(:args) { ['i/am/not/a_file'] }
+      # it "does not output 'success'" do
+      #   output.should_not include("success")
+      # end
       it "outputs 'No such file'" do
         output.should include("No such file")
       end
@@ -108,6 +111,25 @@ describe Preek::CLI do
       end
     end
 
+    context "when given one file without smells and another with smells" do
+      let(:args){ [test_file('non_smelly'), test_file('two_smelly_classes')] }
+      before :each do
+        subject.options =  {irresponsible: true}
+      end
+
+      it "output contains all smells" do
+        output.should include('IrresponsibleModule', 'UncommunicativeMethodName')
+      end
+
+      it "output contains only smelly filename" do
+        output.should include(args[1])
+      end
+
+      it "output contains the names of the smelly method" do
+        output.should include("#x")
+      end
+    end
+
     context "when given file has NilCheck smell" do
       let(:args){ [test_file('nil_check')] }
       it "output contains 'NilCheck'" do

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: preek
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.0
 platform: ruby
 authors:
 - Jon Neverland
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-08-24 00:00:00.000000000 Z
+date: 2013-08-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: thor