preek 1.1.0 → 1.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 37e624d4a67976a8062a37c690c17957dd605706
-  data.tar.gz: 744b77bcea99590f34da0ee56b8bc72d15525b3a
+  metadata.gz: 6a2898d250cb8cea642a90c538ce337b21b582fb
+  data.tar.gz: 963cbb7dcebd619e3da7a47fd2fdce46d767a406
 SHA512:
-  metadata.gz: 9d7fb7c110fd621346a35d1c6c1eaf46b4888a6d5e25a99c2632e5ecc7dfa69b16bf8caf5b16bc7c80e99021a1fbf1cfdede29a2722c2fffa11b8928d7e196bb
-  data.tar.gz: fa3d7538f75edf82b4976ffd2ab4047e7e46096617ae4c81a070b461ee6d725ed622a1ad0c6fd27751a7ddbac3fa4dd849e8c5beec1b3f76c309db0f528d5d8d
+  metadata.gz: 0f33bf0471e6fde2f572c62bd546da8611ef8be0f54ce4e81bcfaac2da2335c9e55ae2f4b4cfea0300a503c89272ec1444ea8c95bb7cad4cedfb610e465bd8c6
+  data.tar.gz: 3a51ab71c58530be58fd33affcf172ac7b4f8abc781050d73f02da3fb103d04a71a8bf49c9bbae1d20af7faacfd4575d8769ee2e8b42c6f3753fb205c82f0ed4

data/README.md

@@ -31,8 +31,9 @@ Usage:
   preek smell FILE(S)|DIR
 
 Options:
-  -i, [--irresponsible]  # include IrresponsibleModule smell in output.
-
+  -i, [--irresponsible]  # Include IrresponsibleModule smell in output.
+  -c, [--compact]        # Compact output.
+  -v, [--verbose]        # Report files with no smells
 
 Commands:
   preek help [COMMAND]     # Describe available commands or one specific command

data/lib/preek.rb

@@ -1,11 +1,10 @@
 module Preek
   require 'preek/version'
-  require 'preek/smell_collector'
-  require 'preek/smell_reporter'
+  require 'preek/examiner'
+  require 'preek/report'
+  require 'preek/output'
 
   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
+    Examiner.new(filenames, excludes).perform
   end
 end

data/lib/preek/cli.rb

@@ -1,8 +1,5 @@
 require 'thor'
-
 require 'preek/version'
-require 'preek/smell_collector'
-require 'preek/smell_reporter'
 
 module Preek
 
@@ -16,15 +13,37 @@ module Preek
     end
 
     desc 'smell FILE(S)|DIR', 'Pretty format Reek output'
+
     method_option :irresponsible,
                   type: :boolean,
                   aliases: '-i',
-                  desc: 'include IrresponsibleModule smell in output.'
+                  desc: 'Include IrresponsibleModule smell in output.'
+
+    method_option :compact,
+                  type: :boolean,
+                  aliases: '-c',
+                  desc: 'Compact output.'
+
+    method_option :verbose,
+                  type: :boolean,
+                  aliases: '-v',
+                  desc: 'Report files with no smells.'
+
+
     def smell(*args)
-      Preek::Smell(args, excludes)
+      Examiner.new(args, excludes, reporter: reporter, output: output).perform
     end
 
   private
+
+    def reporter
+      options[:verbose] ? VerboseReport : QuietReport
+    end
+
+    def output
+      options[:compact] ? CompactOutput : Output
+    end
+
     def _aliases
       {
         irresponsible: 'IrresponsibleModule'

data/lib/preek/examiner.rb

@@ -0,0 +1,68 @@
+require 'reek/examiner'
+
+module Preek
+  class Examiner
+    def initialize(files, excludes = [], options = {})
+      @files = files
+      @excludes = excludes
+      @reporter = options[:reporter] || VerboseReport
+      output_class = options[:output] || Output
+      @output = output_class.new
+      @total_smells = 0
+    end
+
+    def perform
+      examine_and_report
+      report_totals if totals_to_report?
+      @output.print_line
+      report_non_existing if non_existing_files?
+    end
+
+  private
+    def examine_and_report
+      sources.each do |source|
+        examiner = Reek::Examiner.new(source)
+        filter_excludes_from(examiner)
+        @reporter.new(examiner, @output).report
+        @total_smells += examiner.smells_count
+      end
+    end
+
+    def filter_excludes_from(examiner)
+      examiner.smells.delete_if do |smell|
+        @excludes.include? smell.smell_class
+      end
+    end
+
+    def totals_to_report?
+      return false if @reporter.verbose? || @sources.count == 0
+      @total_smells == 0
+    end
+
+    def report_totals
+      @output.print_line
+      @output.green :success, %(No smells detected)
+    end
+
+    def report_non_existing
+      @output.red :error, %{No such file(s) - #{non_existing_files.join(', ')}.\n}
+      @output.print_line
+    end
+
+    def existing_files
+      @existing_files ||= @files.select {|file| File.exists? file}
+    end
+
+    def non_existing_files?
+      !non_existing_files.empty?
+    end
+
+    def non_existing_files
+      @files - existing_files
+    end
+
+    def sources
+      @sources ||= Reek::Source::SourceLocator.new(existing_files).all_sources
+    end
+  end
+end

data/lib/preek/output.rb

@@ -0,0 +1,36 @@
+require 'thor/shell/color'
+module Preek
+  class Output < Thor::Shell::Color
+    def status(*args)
+      say_status *args
+    end
+
+    def print_line
+      say "\n\t#{'-'*60}\n\n"
+    end
+
+    def blue(*args)
+      status *args, :blue
+    end
+
+    def green(*args)
+      status *args, :green
+    end
+
+    def red(*args)
+      status *args, :red
+    end
+  end
+
+  class CompactOutput < Output
+    def status(title, text, color = nil)
+      title = title.to_s + ": " if title.is_a?(Symbol)
+      say title, color, false
+      say text
+    end
+
+    def print_line
+      say "\n-\n\n"
+    end
+  end
+end

data/lib/preek/report.rb

@@ -0,0 +1,64 @@
+require 'preek/ext/smell_warning'
+require 'preek/smell_file'
+require 'preek/smell_klass'
+module Preek
+  class VerboseReport
+    def self.verbose?
+      true
+    end
+
+    def initialize(examiner, output)
+      @examiner, @output = examiner, output
+    end
+
+    def report
+      print_header
+      if @examiner.smelly?
+        report_smells
+      else
+        report_success
+      end
+    end
+
+    private
+
+    def print_header
+      @output.print_line
+      @output.blue :file, "#{@examiner.description}\n"
+    end
+
+    def smell_file
+      SmellFile.new(@examiner)
+    end
+
+    def report_smells
+      smell_file.klasses do |klass|
+        @output.green :class, klass.name
+        @output.red :smells, ''
+        klass.smells.each &print_smell
+      end
+    end
+
+    def print_smell
+      lambda {|smell| @output.status nil, smell }
+    end
+
+    def print_klass_smells(smells)
+      smells.each {|smell| @output.status nil, smell }
+    end
+
+    def report_success
+      @output.green :success, "No smells detected.\n"
+    end
+  end
+
+  class QuietReport < VerboseReport
+    def self.verbose?
+      false
+    end
+
+    def report
+      print_header && report_smells if @examiner.smelly?
+    end
+  end
+end

data/lib/preek/smell_file.rb

@@ -1,7 +1,6 @@
 module Preek
   # A smelly file
   class SmellFile
-    attr_reader :klasses
 
     def initialize(examiner)
       @examiner = examiner
@@ -15,6 +14,13 @@ module Preek
 
     alias :filename :file
 
+    def klasses
+      return @klasses unless block_given?
+      @klasses.each do |name, klass|
+        yield klass
+      end
+    end
+
   private
     def add_smells_to_klasses
       @examiner.smells.each do |smell|

data/lib/preek/smell_klass.rb

@@ -1,5 +1,5 @@
 module Preek
-  # A container for a smelly klass in a file!
+  # A container for smells in a class
   class SmellKlass
     attr_reader :name
 

data/lib/preek/version.rb

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

data/preek.gemspec

@@ -19,8 +19,8 @@ Gem::Specification.new do |gem|
   gem.add_runtime_dependency "thor", ">=0.16"
   gem.add_runtime_dependency "reek", ">=1.3"
   gem.add_development_dependency "rspec", ">=2.13"
+  gem.add_development_dependency "rspec-given"
   gem.add_development_dependency "guard", ">=1.6"
-  gem.add_development_dependency "guard-pushover"
   gem.add_development_dependency "guard-rspec", ">=2.4"
   gem.add_development_dependency 'coveralls'
 end

data/spec/cli_spec.rb

@@ -10,133 +10,116 @@ describe Preek::CLI do
   end
 
   describe "#version" do
-    let(:output) { capture(:stdout) { subject.version} }
-    it "outputs the gem version in the right format" do
-      output.should =~ /(\d\.?){3}/
-    end
+    When(:output) { capture(:stdout) { subject.version} }
+    Then {output.should =~ /(\d\.?){3}/}
   end
 
-  describe "#parse" do
-    let(:output) { capture(:stdout) { subject.smell(*args) } }
-    let(:args) { ['i/am/not/a_file'] }
+  describe "#smell" do
+
+    When(:output) { capture(:stdout) { subject.smell(*args) } }
 
     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
-      it "outputs the name of the file" do
-        output.should include(args[0])
-      end
+      Given(:args) { ['i/am/not/a_file'] }
+      Then{output.should_not include("success")}
+      Then{output.should include("No such file")}
+      Then{output.should include(args[0])}
     end
 
-    context "when given file has no smells" do
-      let(:args){ [test_file('non_smelly')] }
-      it "output contains 'success! No smells'" do
-        output.should include("No smells")
-      end
-    end
+    context 'default quiet report' do
 
-    context "when given file has Irresponsible smell" do
-      let(:args){ [test_file('irresponsible')] }
-      it "output contains 'success! No smells'" do
-        output.should include("No smells")
+      context "when given file has no smells" do
+        Given(:args){ [test_file('non_smelly')] }
+        Then{output.should include("No smells")}
+        Then{output.should_not include(args[0])}
       end
-    end
-
-    context "when given file has Irresponsible smell with --irresponsible options" do
-      let(:args){ [test_file('irresponsible')] }
 
-      before :each do
-        subject.options =  {irresponsible: true}
+      context "when given file has no smells" do
+        Given(:args){ [test_file('non_smelly'), 'i/am/not/a_file'] }
+        Then{output.should include("No smells")}
+        Then{output.should_not include(args[0])}
+        Then{output.should include("No such file")}
+        Then{output.should include(args[1])}
       end
 
-      it "output contains 'Irresponsible'" do
-        output.should include("Irresponsible")
+      context "when given file has Irresponsible smell" do
+        Given(:args){ [test_file('irresponsible')] }
+        Then{output.should include("No smells")}
+        Then{output.should_not include(args[0])}
       end
 
-    end
-
-    context "when given a file with two smelly classes" do
-      let(:args){ [test_file('two_smelly_classes')] }
-      it "output contains one classnames" do
-        output.should include('SecondSmelly')
-      end
-      it "output contains one smell" do
-        output.should include('UncommunicativeMethodName')
+      context "when given a file with two smelly classes" do
+        Given(:args){ [test_file('two_smelly_classes')] }
+        Then{output.should include('SecondSmelly')}
+        Then{output.should include('UncommunicativeMethodName')}
       end
-    end
 
-    context "when given a file with two smelly classes with --irresponsible options" do
-      let(:args){ [test_file('two_smelly_classes')] }
-      before :each do
-        subject.options =  {irresponsible: true}
+      context "when given two smelly files" do
+        Given(:args){ [test_file('too_many_statements'), test_file('two_smelly_classes')] }
+        Then{output.should include('UncommunicativeMethodName', 'TooManyStatements')}
+        Then{output.should include(args[0], args[1])}
+        Then{output.should include("#loong_method", "#x")}
       end
 
-      it "output contains both classnames" do
-        output.should include('FirstSmelly', 'SecondSmelly')
-      end
-      it "output contains both smells" do
-        output.should include('IrresponsibleModule', 'UncommunicativeMethodName')
+      context "when given one file without smells and another with smells" do
+        Given(:args){ [test_file('non_smelly'), test_file('too_many_statements')] }
+
+        Then{output.should include('TooManyStatements')}
+        Then{output.should include(args[1])}
+        Then{output.should include("#loong_method")}
+        Then{output.should_not include(args[0])}
       end
-    end
 
-    context "when given a file with two different smells with --irresponsible options" do
-      let(:args){ [test_file('irresponsible_and_lazy')] }
-      it "output contains both smells" do
-        subject.options =  {irresponsible: true}
-        output.should include('IrresponsibleModule', 'UncommunicativeMethodName')
+      context "when given file has NilCheck smell" do
+        Given(:args){ [test_file('nil_check')] }
+        Then{output.should include("NilCheck")}
+        Then{output.should include(args[0])}
       end
     end
 
-    context "when given two smelly files" do
-      let(:args){ [test_file('too_many_statements'), test_file('two_smelly_classes')] }
-      before :each do
-        subject.options =  {irresponsible: true}
-      end
+    context 'with --irresponsible option' do
+      Given{subject.options =  {irresponsible: true} }
 
-      it "output contains all smells" do
-        output.should include('IrresponsibleModule', 'UncommunicativeMethodName', 'TooManyStatements')
+      context "when given file has Irresponsible smell" do
+        Given(:args){ [test_file('irresponsible')] }
+        Then{output.should include("Irresponsible")}
       end
 
-      it "output contains both filenames" do
-        output.should include(args[0], args[1])
+      context "when given a file with two smelly classes" do
+        Given(:args){ [test_file('two_smelly_classes')] }
+        Then{output.should include('FirstSmelly', 'SecondSmelly')}
+        Then{output.should include('IrresponsibleModule', 'UncommunicativeMethodName')}
       end
 
-      it "output contains the names of the smelly methods" do
-        output.should include("#loong_method", "#x")
+      context "when given two smelly files" do
+        Given(:args){ [test_file('too_many_statements'), test_file('two_smelly_classes')] }
+        Then{output.should include('IrresponsibleModule', 'UncommunicativeMethodName', 'TooManyStatements')}
+        Then{output.should include(args[0], args[1])}
+        Then{output.should include("#loong_method", "#x")}
       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}
+      context "when given a file with two different smells" do
+        Given(:args){ [test_file('irresponsible_and_lazy')] }
+        Then{output.should include('IrresponsibleModule', 'UncommunicativeMethodName')}
       end
+    end
 
-      it "output contains all smells" do
-        output.should include('IrresponsibleModule', 'UncommunicativeMethodName')
-      end
+    context 'with --verbose option' do
+      Given{subject.options =  {verbose: true}}
 
-      it "output contains only smelly filename" do
-        output.should include(args[1])
+      context "when given file has no smells" do
+        Given(:args){ [test_file('non_smelly')] }
+        Then{output.should include("No smells")}
+        Then{output.should include(args[0])}
       end
 
-      it "output contains the names of the smelly method" do
-        output.should include("#x")
+      context "when given two smelly files" do
+        Given(:args){ [test_file('too_many_statements'), test_file('two_smelly_classes')] }
+        Then{output.should include(args[0], args[1])}
       end
-    end
 
-    context "when given file has NilCheck smell" do
-      let(:args){ [test_file('nil_check')] }
-      it "output contains 'NilCheck'" do
-        output.should include("NilCheck")
-      end
-      it "outputs the name of the file" do
-        output.should include(args[0])
+      context "when given one file without smells and another with smells" do
+        Given(:args){ [test_file('non_smelly'), test_file('too_many_statements')] }
+        Then{output.should include(args[1], args[0])}
       end
     end
   end

data/spec/spec_helper.rb

@@ -4,6 +4,7 @@ Coveralls.wear!
 $:.unshift(File.join(File.dirname(__FILE__), "..", "lib"))
 require 'stringio'
 require File.expand_path('../../lib/preek', __FILE__)
+require 'rspec/given'
 
 RSpec.configure do |config|
   config.treat_symbols_as_metadata_keys_with_true_values = true

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: preek
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 1.2.1
 platform: ruby
 authors:
 - Jon Neverland
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-08-25 00:00:00.000000000 Z
+date: 2013-09-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: thor
@@ -53,33 +53,33 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '2.13'
 - !ruby/object:Gem::Dependency
-  name: guard
+  name: rspec-given
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - '>='
       - !ruby/object:Gem::Version
-        version: '1.6'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '>='
       - !ruby/object:Gem::Version
-        version: '1.6'
+        version: '0'
 - !ruby/object:Gem::Dependency
-  name: guard-pushover
+  name: guard
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - '>='
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.6'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '>='
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.6'
 - !ruby/object:Gem::Dependency
   name: guard-rspec
   requirement: !ruby/object:Gem::Requirement
@@ -127,11 +127,12 @@ files:
 - bin/preek
 - lib/preek.rb
 - lib/preek/cli.rb
+- lib/preek/examiner.rb
 - lib/preek/ext/smell_warning.rb
-- lib/preek/smell_collector.rb
+- lib/preek/output.rb
+- lib/preek/report.rb
 - lib/preek/smell_file.rb
 - lib/preek/smell_klass.rb
-- lib/preek/smell_reporter.rb
 - lib/preek/version.rb
 - preek.gemspec
 - spec/capture_helper.rb
@@ -163,7 +164,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.0.2
+rubygems_version: 2.0.3
 signing_key: 
 specification_version: 4
 summary: It might reek but its pretty

data/lib/preek/smell_collector.rb

@@ -1,45 +0,0 @@
-require 'reek'
-
-require 'preek/ext/smell_warning'
-
-require 'preek/smell_file'
-require 'preek/smell_klass'
-
-module Preek
-  # This is a 'Collector'
-  class SmellCollector
-    def initialize(files, excludes = [])
-      @files = files.delete_if { |file| !File.exists? file }
-      @excludes = excludes
-    end
-
-    def smelly_files
-      @smelly_files ||= files_from_sources
-    end
-
-  private
-    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
-  end
-end

data/lib/preek/smell_reporter.rb

@@ -1,64 +0,0 @@
-require 'thor/shell/color'
-module Preek
-  # Here we report the smells in a nice fashion
-  class SmellReporter < Thor::Shell::Color
-    def initialize(smelly_files, not_files)
-      @smelly_files = smelly_files
-      @not_files = not_files
-      @padding = 0
-    end
-
-    def print_smells
-      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
-
-    def print_klasses klasses
-      klasses.each do |index, klass|
-        say_status "\n\tclass", klass.name
-        say_status 'smells', '', :red
-        print_klass_smells klass.smells
-      end
-      print_line
-    end
-
-    def print_klass_smells smells
-      smells.each {|smell|
-       say_status nil, smell
-      }
-    end
-
-    def print_line
-      say "\n\t#{'-'*60}\n\n"
-    end
-
-    def padding; 0; end
-
-    def format_path file
-      File.expand_path(file)
-    end
-  end
-end