preek 0.1.0

checksums.yaml

@@ -0,0 +1,15 @@
+---
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    ZjczMTRhYmZjYTA0ODE2M2Y3NjFhNWFlMzRhNDQ1N2E1OTRkZWI1Mw==
+  data.tar.gz: !binary |-
+    YjFmYmZhMGU3NDA5N2M1ZjdlNWVmYmI1ZDU1YzI4YmE0YTQxYWM2Yg==
+!binary "U0hBNTEy":
+  metadata.gz: !binary |-
+    NzZmN2JiOTg0ODI2N2Q0MzM0MzM4MTg2Y2Q2Y2IwNjViZWY1NzJhMDM2MjVj
+    ODA4MzYzYzJiMDE1MjI0MzU2YzVlMjdiZDBhNGZmNTRjYzUyNzI5YTE4NWI0
+    ODY4OTczMTNiZTJmOTUzYjc5NGRiZWQ3Njg0OThiNTkzYTgzMWM=
+  data.tar.gz: !binary |-
+    NTVjODc4NDAwYjM2Yjc5M2IyM2QwNTliOTAyMzJjNzZmMmFmMDMwZGIxODhi
+    OGE5MGU4MTliZGI2ZDVjMmU3YzUxOWY3NmVmYTRmNGViYTczYmNkOThmMWI3
+    ZWMyN2Q1YWE1MTI0Y2ExMDMxNTAwMDhjNTY3YTk4NzQ0ZTBlOWU=

data/.gitignore

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

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--format documentation

data/.travis.yml

@@ -0,0 +1,8 @@
+language: ruby
+rvm:
+  - 1.9.3
+  - jruby-19mode
+  - 2.0.0
+branches:
+  only:
+    - master

data/Gemfile

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

data/Guardfile

@@ -0,0 +1,9 @@
+# A sample Guardfile
+# More info at https://github.com/guard/guard#readme
+
+guard 'rspec' do
+  watch(%r{^spec/.+_spec\.rb$})
+  watch(%r{^lib/(.+)\.rb$})     { |m| "spec/lib/#{m[1]}_spec.rb" }
+  watch('spec/spec_helper.rb')  { "spec" }
+end
+

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2013 jonnev
+
+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,27 @@
+[![Code Climate](https://codeclimate.com/github/joenas/preek.png)](https://codeclimate.com/github/joenas/preek)
+
+# Preek
+
+For a pretty colorful output of [Reek](https://github.com/troessner/reek), which is an awesome gem!
+
+## Installation
+
+Install it yourself as:
+
+    $ git clone git@github.com:joenas/preek.git
+    
+    $ cd preek
+
+    $ rake install
+
+## Usage
+
+    $ preek . or file
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Added some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,9 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"
+
+task :default => [:spec]
+
+desc 'run Rspec specs'
+task :spec do
+  sh 'rspec spec'
+end

data/bin/preek

@@ -0,0 +1,13 @@
+#!/usr/bin/env ruby
+require "preek"
+
+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

data/lib/preek.rb

@@ -0,0 +1,36 @@
+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 'FILE', 'Pretty format Reek output'
+    def parse(args)
+      files, @not_files = args.partition { |file| File.exists? file }
+      report_smells_for files unless files.empty?
+      report_not_files
+    end
+
+  private
+    def report_smells_for files
+      sources = Reek::Source::SourceLocator.new(files).all_sources
+      smelly_files = SmellCollector.new(sources).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
+  end
+end

data/lib/preek/cli.rb

@@ -0,0 +1,24 @@
+require 'preek'
+module Preek
+  class Cli
+    def initialize(args)
+      @args = args
+    end
+
+    def execute
+      Preek.start []
+    end
+  end
+end
+
+      
+# 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

data/lib/preek/klass_collector.rb

@@ -0,0 +1,17 @@
+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

data/lib/preek/smell_collector.rb

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

data/lib/preek/smell_file.rb

@@ -0,0 +1,26 @@
+module Preek
+  require 'preek/klass_collector'
+  # A smelly file
+  class SmellFile
+    def initialize(smells)
+      @smells = smells
+      @klass_collector = KlassCollector.new
+    end
+
+    def klasses
+      add_smells_to_klass
+      @klass_collector.get_klasses
+    end
+
+    def file
+      @smells.first.source
+    end
+
+  private
+    def add_smells_to_klass
+      @smells.each do |smell|
+        @klass_collector.find(smell.klass).add_smell smell
+      end
+    end
+  end
+end

data/lib/preek/smell_klass.rb

@@ -0,0 +1,23 @@
+module Preek
+  # A container for a smelly klass in a file!
+  class SmellKlass
+    def initialize
+      @smells = []
+    end
+
+    def add_smell smell
+      @smells << smell
+    end
+
+    def name
+      @smells.first.klass
+    end
+
+    def smells
+      @smells.map do |smell|
+        smell.smell_string
+        #FormatedSmell.new(smell).print_data
+      end
+    end
+  end
+end

data/lib/preek/smell_reporter.rb

@@ -0,0 +1,44 @@
+module Preek
+  # Here we report the smells in a nice fashion
+  class SmellReporter < Thor::Shell::Color
+    def initialize smelly_files
+      @smelly_files = smelly_files
+      @padding = 0
+    end
+
+    def print_smells
+      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
+      end
+    end
+  private
+    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)#.gsub(Dir.pwd, ".")
+    end
+  end
+end

data/lib/preek/smell_warning.rb

@@ -0,0 +1,16 @@
+module Reek
+  # Is was easier this way
+  class SmellWarning
+    def klass
+      @location[CONTEXT_KEY][/^([\w:]*)(#\w*)?/, 1]
+    end
+
+    def smell_method
+      @location[CONTEXT_KEY][/^([\w:]*)(#\w*)?/, 2]
+    end
+
+    def smell_string
+      "#{smell_method} #{@smell['message']} (#{@smell['subclass']}) at lines #{@location['lines']*','}"
+    end
+  end
+end

data/lib/preek/version.rb

@@ -0,0 +1,3 @@
+module Preek
+  VERSION = "0.1.0"
+end

data/preek.gemspec

@@ -0,0 +1,26 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/preek/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.authors       = ["Jon Neverland"]
+  gem.email         = ["jonwestin@gmail.com"]
+  gem.description   = %q{Gives the nice output to the reek}
+  gem.summary       = %q{It might reek but its pretty}
+  gem.homepage      = "https://github.com/joenas/preek"
+
+  gem.files         = `git ls-files`.split($\)
+  #gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.executable    = 'preek'
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.name          = "preek"
+  gem.require_paths = ["lib"]
+  gem.version       = Preek::VERSION
+  gem.add_runtime_dependency "thor"
+  gem.add_runtime_dependency "reek"
+  gem.add_runtime_dependency "rake"
+  gem.add_development_dependency "rake"
+  gem.add_development_dependency "rspec"
+  gem.add_development_dependency "guard"
+  gem.add_development_dependency "guard-rspec"
+  gem.add_development_dependency "simplecov"
+end

data/spec/preek_spec.rb

@@ -0,0 +1,78 @@
+require 'spec_helper'
+
+describe Preek::Preek do
+
+  def test_file(file_name)
+    File.expand_path(File.join(File.dirname(__FILE__),'test_files/',"#{file_name}.rb"))
+  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
+  end
+
+  describe "#parse" do
+    let(:output) { capture(:stdout) { subject.parse(args) } }
+
+    context "with non-existing file in ARGS" do
+      let(:args) { ['i/am/not/a_file'] }
+      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
+    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 "when given file has Irresponsible smell" do
+      let(:args){ [test_file('irresponsible')] }
+      it "output contains 'Irresponsible'" do
+        output.should include("Irresponsible")
+      end
+      it "outputs the name of the file" do
+        output.should 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 both classnames" do
+        output.should include('FirstSmelly', 'SecondSmelly')
+      end
+      it "output contains both smells" do
+        output.should include('IrresponsibleModule', 'UncommunicativeMethodName')
+      end
+    end
+
+    context "when given a file with two different smells" do
+      let(:args){ [test_file('irresponsible_and_lazy')] }
+      it "output contains both smells" do
+        output.should include('IrresponsibleModule', 'UncommunicativeMethodName')
+      end
+    end
+
+    context "when given two smelly files" do
+      let(:args){ [test_file('too_many_statements'), test_file('two_smelly_classes')] }
+      it "output contains all smells" do
+        output.should include('IrresponsibleModule', 'UncommunicativeMethodName', 'TooManyStatements')
+      end
+
+      it "output contains both filenames" do
+        output.should include(args[0], args[1])
+      end
+
+      it "output contains the names of the smelly methods" do
+        output.should include("#loong_method", "#x")
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,26 @@
+require 'simplecov'
+SimpleCov.start
+
+$:.unshift(File.join(File.dirname(__FILE__), "..", "lib"))
+require 'stringio'
+require File.expand_path('../../lib/preek', __FILE__)
+
+RSpec.configure do |config|
+  config.treat_symbols_as_metadata_keys_with_true_values = true
+  config.run_all_when_everything_filtered = true
+  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

data/spec/test_files/irresponsible.rb

@@ -0,0 +1,2 @@
+class Irresponsible
+end

data/spec/test_files/irresponsible_and_lazy.rb

@@ -0,0 +1,3 @@
+class IrresponsibleAndLazy
+  def x; end
+end

data/spec/test_files/non_smelly.rb

@@ -0,0 +1,3 @@
+# This class has no smells!
+class NonSmelly
+end

data/spec/test_files/too_many_statements.rb

@@ -0,0 +1,8 @@
+# this class has... TooManyStatments!
+
+class TooManyStatments
+  def loong_method
+    puts "a";puts "b";puts "c";puts "d";puts "e";puts "f"
+    puts "g"
+  end
+end

data/spec/test_files/two_smelly_classes.rb

@@ -0,0 +1,6 @@
+class FirstSmelly; end
+
+# this has a comment but bad method
+class SecondSmelly
+  def x(); end
+end

metadata

@@ -0,0 +1,189 @@
+--- !ruby/object:Gem::Specification
+name: preek
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Jon Neverland
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-02-28 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: thor
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: reek
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !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: rspec
+  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: guard
+  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: guard-rspec
+  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: simplecov
+  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'
+description: Gives the nice output to the reek
+email:
+- jonwestin@gmail.com
+executables:
+- preek
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- .travis.yml
+- Gemfile
+- Guardfile
+- LICENSE
+- README.md
+- Rakefile
+- bin/preek
+- lib/preek.rb
+- lib/preek/cli.rb
+- lib/preek/klass_collector.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/spec_helper.rb
+- spec/test_files/irresponsible.rb
+- spec/test_files/irresponsible_and_lazy.rb
+- spec/test_files/non_smelly.rb
+- spec/test_files/too_many_statements.rb
+- spec/test_files/two_smelly_classes.rb
+homepage: https://github.com/joenas/preek
+licenses: []
+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.0.0
+signing_key: 
+specification_version: 4
+summary: It might reek but its pretty
+test_files:
+- spec/preek_spec.rb
+- spec/spec_helper.rb
+- spec/test_files/irresponsible.rb
+- spec/test_files/irresponsible_and_lazy.rb
+- spec/test_files/non_smelly.rb
+- spec/test_files/too_many_statements.rb
+- spec/test_files/two_smelly_classes.rb