preek 0.1.3 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 23aaf624b23cc383b727443a4638f9d8974465ff
-  data.tar.gz: ba4e3c93bd89f810a2ff58b8d76373fc39153f19
+  metadata.gz: 2300b0792702884ce539a9e7204c06f31fc1dcae
+  data.tar.gz: 5150fd3103a539732308a852c8efeb07abde9a9c
 SHA512:
-  metadata.gz: f8e069e0498d2879120117dca4c13a4679981bef8757a0fe6293705a0c43d69971b64c3c0d7b30717e628601f8f00962b8b586fd9101c346646056732a9fa2ad
-  data.tar.gz: 331ad8be448eb115fc52bc5ef25f719af4a4f71ac4bc670fcd1d75c7e5b022015e6d7339353fa312ee20c7caac37f075ebd14728ffc1755ed7b5dcf8cb8e0b88
+  metadata.gz: d112cda98c69d5b28fd531d64a104e2576f1e656dc1c34adbff5b8f0d6491a342fbe54157201b1a8f99b9f9559db5a4fac7e09f87e084514b5786bffd9caa4dd
+  data.tar.gz: 3f8db5a1be25a4125ee1a23b292fd896b024002ac972a68fcf0c1e7d6805abf501169a582db549276edbf6780e14710492bf8736bac81eff3a69aee5226652ae

data/README.md

@@ -1,3 +1,4 @@
+[![Gem Version](https://badge.fury.io/rb/preek.png)](http://badge.fury.io/rb/preek)
 [![Code Climate](https://codeclimate.com/github/joenas/preek.png)](https://codeclimate.com/github/joenas/preek)
 [![Build Status](https://travis-ci.org/joenas/preek.png)](https://travis-ci.org/joenas/preek)
 [![Dependency Status](https://gemnasium.com/joenas/preek.png)](https://gemnasium.com/joenas/preek)
@@ -26,8 +27,19 @@ or
 
 
 ## Usage
+```bash
+Usage:
+  preek smell FILE(S)|DIR
 
-    $ preek . or file
+Options:
+  -i, [--irresponsible]  # include IrresponsibleModule smell in output.
+
+
+Commands:
+  preek help [COMMAND]     # Describe available commands or one specific command
+  preek smell FILE(S)|DIR  # Pretty format Reek output
+  preek version            # Shows version
+```
 
 At the moment it only supports files, not stuff like this:
 

data/bin/preek

@@ -1,14 +1,5 @@
 #!/usr/bin/env ruby
 require "preek"
+require "preek/cli"
 
-# unless ARGV.empty?
-#   preek = Preek::Preek.new
-#   if preek.respond_to? ARGV[0]
-#     preek.send ARGV.shift.to_sym, ARGV
-#   else
-#     preek.parse ARGV
-#   end
-# else
-#   Preek::Preek.start
-# end
-Preek::Preek.start
+Preek::CLI.start

data/lib/preek.rb

@@ -1,56 +1,8 @@
 module Preek
-  require 'reek'
   require 'thor'
+
   require 'preek/version'
   require 'preek/smell_collector'
   require 'preek/smell_reporter'
-  require 'preek/smell_warning'
-  # whoop whoop
-  class Preek < Thor
-    include Thor::Actions
-
-    desc 'version', 'Shows version'
-    def version(*)
-      say VERSION
-    end
-
-    desc 'smell FILE(S)|DIR', 'Pretty format Reek output'
-    method_option :irresponsible,
-                  type: :boolean,
-                  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_for(files, excludes) unless files.empty?
-      report_not_files
-    end
-
-  private
-    def report_smells_for(files, includes)
-      sources = Reek::Source::SourceLocator.new(files).all_sources
-      smelly_files = SmellCollector.new(sources, excludes).smelly_files
-      @reporter = SmellReporter.new(smelly_files)
-      @reporter.print_smells
-    end
-
-    def report_not_files
-      say_status :error, "No such file(s) - #{@not_files*", "}.", :red unless @not_files.empty?
-    end
-
-    def _aliases
-      {
-        irresponsible: 'IrresponsibleModule'
-      }
-    end
-
-    def excludes
-      (exclude_list - @includes)#.map(&:to_s).map(&:capitalize)
-    end
 
-    def exclude_list
-      %w(IrresponsibleModule)
-    end
-  end
 end

data/lib/preek/cli.rb

@@ -0,0 +1,57 @@
+require 'thor'
+
+require 'preek/version'
+require 'preek/smell_collector'
+require 'preek/smell_reporter'
+
+module Preek
+
+  # whoop whoop
+  class CLI < Thor
+    include Thor::Actions
+
+    desc 'version', 'Shows version'
+    def version(*)
+      say VERSION
+    end
+
+    desc 'smell FILE(S)|DIR', 'Pretty format Reek output'
+    method_option :irresponsible,
+                  type: :boolean,
+                  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
+    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 excludes
+      (exclude_list - @includes)
+    end
+
+    def exclude_list
+      %w(IrresponsibleModule)
+    end
+  end
+end

data/lib/preek/smell_collector.rb

@@ -1,24 +1,32 @@
+require 'reek'
+
+require 'preek/ext/smell_warning'
+
+require 'preek/smell_file'
+require 'preek/smell_klass'
+
 module Preek
-  require 'reek'
-  require 'preek/smell_file'
   # This is a 'Collector'
   class SmellCollector
-    def initialize(sources, excludes)
-      @sources = sources
+    def initialize(files, excludes)
+      @files = files
       @excludes = excludes
-      @files = examine_sources
     end
 
     def smelly_files
-      @files.compact#reject(&:nil?)
+      @smelly_files ||= examine_sources
     end
 
   private
     def examine_sources
-      @sources.map do |source|
+      sources.map do |source|
         smells = Reek::Examiner.new(source).smells
         SmellFile.new(smells, @excludes) unless smells.empty?
-      end
+      end.compact
+    end
+
+    def sources
+      Reek::Source::SourceLocator.new(@files).all_sources
     end
   end
 end

data/lib/preek/smell_file.rb

@@ -1,28 +1,31 @@
 module Preek
-  require 'preek/klass_collector'
   # A smelly file
   class SmellFile
+    attr_reader :klasses
+
     def initialize(smells, excludes)
       @smells = smells
       @excludes = excludes
-      @klass_collector = KlassCollector.new
-      add_smells_to_klass
-    end
-
-    def klasses
-      @klass_collector.get_klasses
+      @klasses = {}
+      add_smells_to_klasses
     end
 
     def file
       @smells.first.source
     end
 
+    alias :filename :file
+
   private
-    def add_smells_to_klass
+    def add_smells_to_klasses
       @smells.each do |smell|
         next if @excludes.include? smell.smell_class
-        @klass_collector.find(smell.klass).add_smell smell
+        find(smell.klass).add smell
       end
     end
+
+    def find(klassname)
+      @klasses[klassname.to_sym] ||= SmellKlass.new
+    end
   end
 end

data/lib/preek/smell_klass.rb

@@ -5,7 +5,7 @@ module Preek
       @smells = []
     end
 
-    def add_smell smell
+    def add(smell)
       @smells << smell
     end
 
@@ -14,10 +14,7 @@ module Preek
     end
 
     def smells
-      @smells.map do |smell|
-        smell.smell_string
-        #FormatedSmell.new(smell).print_data
-      end
+      @smells.map(&:smell_string)
     end
   end
 end

data/lib/preek/smell_reporter.rb

@@ -1,21 +1,22 @@
+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
+      @smelly_files = smelly_files.delete_if {|smell_file| smell_file.klasses.empty? }
       @padding = 0
     end
 
     def print_smells
-      @smelly_files.delete_if {|smell_file| smell_file.klasses.empty? }
       return say_status 'success!', 'No smells detected.' if @smelly_files.empty?
       print_line
-      @smelly_files.each do |smell|
-        say_status 'file', format_path(smell.file), :blue
-        print_klasses smell.klasses
+      @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|
         say_status "\n\tclass", klass.name
@@ -38,7 +39,7 @@ module Preek
     def padding; 0; end
 
     def format_path file
-      File.expand_path(file)#.gsub(Dir.pwd, ".")
+      File.expand_path(file)
     end
   end
 end

data/lib/preek/version.rb

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

data/spec/capture_helper.rb

@@ -0,0 +1,13 @@
+module CaptureHelper
+  def capture(stream)
+    begin
+      stream = stream.to_s
+      eval "$#{stream} = StringIO.new"
+      yield
+      result = eval("$#{stream}").string
+    ensure
+      eval("$#{stream} = #{stream.upcase}")
+    end
+    result
+  end
+end

data/spec/{preek_spec.rb → cli_spec.rb}

@@ -1,6 +1,9 @@
 require 'spec_helper'
+require 'capture_helper'
+require 'preek/cli'
 
-describe Preek::Preek do
+describe Preek::CLI do
+  include CaptureHelper
 
   def test_file(file_name)
     File.expand_path(File.join(File.dirname(__FILE__),'test_files/',"#{file_name}.rb"))
@@ -14,7 +17,7 @@ describe Preek::Preek do
   end
 
   describe "#parse" do
-    let(:output) { capture(:stdout) { subject.parse(*args) } }
+    let(:output) { capture(:stdout) { subject.smell(*args) } }
     let(:args) { ['i/am/not/a_file'] }
 
     context "with non-existing file in ARGS" do

data/spec/spec_helper.rb

@@ -11,16 +11,4 @@ RSpec.configure do |config|
   config.filter_run :focus
   config.order = 'random'
   config.fail_fast = true
-
-  def capture(stream)
-    begin
-      stream = stream.to_s
-      eval "$#{stream} = StringIO.new"
-      yield
-      result = eval("$#{stream}").string
-    ensure
-      eval("$#{stream} = #{stream.upcase}")
-    end
-    result
-  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: preek
 version: !ruby/object:Gem::Version
-  version: 0.1.3
+  version: 1.0.0
 platform: ruby
 authors:
 - Jon Neverland
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-07-19 00:00:00.000000000 Z
+date: 2013-08-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: thor
@@ -126,15 +126,16 @@ files:
 - Rakefile
 - bin/preek
 - lib/preek.rb
-- lib/preek/klass_collector.rb
+- lib/preek/cli.rb
+- lib/preek/ext/smell_warning.rb
 - lib/preek/smell_collector.rb
 - lib/preek/smell_file.rb
 - lib/preek/smell_klass.rb
 - lib/preek/smell_reporter.rb
-- lib/preek/smell_warning.rb
 - lib/preek/version.rb
 - preek.gemspec
-- spec/preek_spec.rb
+- spec/capture_helper.rb
+- spec/cli_spec.rb
 - spec/spec_helper.rb
 - spec/test_files/irresponsible.rb
 - spec/test_files/irresponsible_and_lazy.rb
@@ -162,12 +163,13 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.0.3
+rubygems_version: 2.0.2
 signing_key: 
 specification_version: 4
 summary: It might reek but its pretty
 test_files:
-- spec/preek_spec.rb
+- spec/capture_helper.rb
+- spec/cli_spec.rb
 - spec/spec_helper.rb
 - spec/test_files/irresponsible.rb
 - spec/test_files/irresponsible_and_lazy.rb

data/lib/preek/klass_collector.rb

@@ -1,17 +0,0 @@
-module Preek
-  require 'preek/smell_klass'
-  # This keeps track of classes in a smelly file
-  class KlassCollector
-    def initialize
-      @klasses = {}
-    end
-
-    def find(klassname)
-      @klasses[klassname.to_sym] ||= SmellKlass.new
-    end
-
-    def get_klasses
-      @klasses
-    end
-  end
-end