guard-preek 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: d5f27ec528c54151012dfa1ff5147ed498a55399
+  data.tar.gz: 3c7c80aa50afee1c961f03b15d6fbff40011c187
+SHA512:
+  metadata.gz: 3e2579b43bb94cdafcc5cc8716d1f63798d1ee969d8552d340fac9cb97ff1eee0d3fbe9fc4a81f788d9fb9f9038c7d0fb4796b1d0e4d545c82ca735c40ad156e
+  data.tar.gz: 2505e492d0622f11b51f29060f0d4f44beb84e9f8c50856fd7d8ba39eb0fbe6b3f607a43e144da8896c3269f843215ae994bf26c0ee4603f11e4f9770e7d9105

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/.rspec

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

data/Gemfile

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

data/Guardfile

@@ -0,0 +1,24 @@
+# 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" }
+
+  # Rails example
+  watch(%r{^app/(.+)\.rb$})                           { |m| "spec/#{m[1]}_spec.rb" }
+  watch(%r{^app/(.*)(\.erb|\.haml)$})                 { |m| "spec/#{m[1]}#{m[2]}_spec.rb" }
+  watch(%r{^app/controllers/(.+)_(controller)\.rb$})  { |m| ["spec/routing/#{m[1]}_routing_spec.rb", "spec/#{m[2]}s/#{m[1]}_#{m[2]}_spec.rb", "spec/acceptance/#{m[1]}_spec.rb"] }
+  watch(%r{^spec/support/(.+)\.rb$})                  { "spec" }
+  watch('config/routes.rb')                           { "spec/routing" }
+  watch('app/controllers/application_controller.rb')  { "spec/controllers" }
+
+  # Capybara features specs
+  watch(%r{^app/views/(.+)/.*\.(erb|haml)$})          { |m| "spec/features/#{m[1]}_spec.rb" }
+
+  # Turnip features and steps
+  watch(%r{^spec/acceptance/(.+)\.feature$})
+  watch(%r{^spec/acceptance/steps/(.+)_steps\.rb$})   { |m| Dir[File.join("**/#{m[1]}.feature")][0] || 'spec/acceptance' }
+end
+

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Jon Neverland
+
+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,46 @@
+# Guard::Preek
+
+Do your refactoring with Guard and Preek printing the smells for you. In color!
+
+## Installation
+
+    $ gem install guard-preek
+    
+or
+
+    # Add to Gemfile
+    gem 'guard/preek'
+
+or install it yourself
+
+    $ git clone git@github.com:joenas/guard-preek.git
+    $ cd guard-preek
+    $ rake install
+    
+
+## Usage
+
+To generate template: 
+ 
+    $ guard init preek
+
+### Examples
+```ruby
+guard :preek, run_all_dir: 'lib' do
+	watch(/lib\/(.*).rb/)
+end
+```
+
+### Available options
+
+``` ruby
+run_all_dir: 'lib'           # Enter in guard will run Preek on 'lib'
+```
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/guard-preek.gemspec

@@ -0,0 +1,31 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'guard/preek/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "guard-preek"
+  spec.version       = Guard::PreekVersion::VERSION
+  spec.authors       = ["Jon Neverland"]
+  spec.email         = ["jonwestin@gmail.com"]
+  spec.description   = %q{Simple refactoring Guard, pretty prints Reek smells}
+  spec.summary       = %q{Simple refactoring Guard, pretty prints Reek smells}
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "guard", '>= 1.6'
+  spec.add_dependency "preek"
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "guard"
+  spec.add_development_dependency "guard-rspec"
+  spec.add_development_dependency "rspec"
+  spec.add_development_dependency "rspec-given"
+  spec.add_development_dependency 'coveralls'
+end

data/lib/guard/preek.rb

@@ -0,0 +1,26 @@
+require "guard/preek/version"
+require 'guard'
+require 'guard/guard'
+
+module Guard
+  class Preek < Guard
+    autoload :Runner, 'guard/preek/runner'
+
+    def run_on_changes(paths)
+      Runner.new(paths).perform
+    end
+
+    def run_all
+      dir = options[:run_all_dir]
+      raise_dir_missing unless dir
+      Runner.new(dir).perform
+    end
+
+  private
+    def raise_dir_missing
+      UI.error "Please specify a dir for run all in your Guardfile!\nExample:\n\tguard :preek, run_all_dir: 'lib' do \n\t  watch(/lib\/(.*).rb/) \n\tend"
+      throw :task_has_failed
+    end
+  end
+end
+

data/lib/guard/preek/runner.rb

@@ -0,0 +1,28 @@
+require 'reek'
+require 'thor/shell/color'
+require 'preek/smell_collector'
+require 'preek/smell_reporter'
+require 'preek/smell_warning'
+require 'preek/smell_file'
+require 'preek/klass_collector'
+
+module Guard
+  class Preek
+    class Runner
+      def initialize(files)
+        @files = Array(files)
+      end
+
+      def perform
+        sources = Reek::Source::SourceLocator.new(@files).all_sources
+        smelly_files = ::Preek::SmellCollector.new(sources, excludes).smelly_files
+        ::Preek::SmellReporter.new(smelly_files).print_smells
+      end
+
+    private
+      def excludes
+        %w(IrresponsibleModule)
+      end
+    end
+  end
+end

data/lib/guard/preek/templates/Guardfile

@@ -0,0 +1,7 @@
+# A sample Guardfile
+# More info at https://github.com/guard/guard#readme
+
+guard :preek, run_all_dir: 'lib' do
+	watch(/lib\/(.*).rb/)
+end
+

data/lib/guard/preek/version.rb

@@ -0,0 +1,5 @@
+module Guard
+  class PreekVersion
+    VERSION = "0.0.1"
+  end
+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/guard/integration_spec.rb

@@ -0,0 +1,38 @@
+require 'spec_helper'
+
+describe Guard::Preek do
+  include CaptureHelper
+
+  Given(:guard){ Guard::Preek.new([], options) }
+  Given(:options){ Hash.new }
+
+  context '#run_on_changes' do
+    Given(:paths){ ["spec/test_files/#{file}.rb"] }
+    When(:output) { capture(:stdout) { guard.run_on_changes(paths) } }
+
+    context 'with a smell' do
+      Given(:file) {'nil_check'}
+      Then { output.should match(/NilCheck/) }
+    end
+
+    context 'with Irresponsible' do
+      Given(:file) {'irresponsible'}
+      Then { output.should match(/No smells detected/) }
+    end
+
+    context 'without smell' do
+      Given(:file) {'non_smelly'}
+      Then { output.should match(/No smells detected/) }
+    end
+  end
+
+  context '#run_all' do
+    context 'with "run_all_dir" option' do
+      Given(:options){ {run_all_dir: 'spec/test_files'} }
+      When(:output) { capture(:stdout) { guard.run_all } }
+      Then{ output.should match /NilCheck/ }
+      Then{ output.should match /TooManyStatements/ }
+      Then{ output.should_not match /Irresponsible/ }
+    end
+  end
+end

data/spec/guard/preek_spec.rb

@@ -0,0 +1,35 @@
+require 'spec_helper'
+
+describe Guard::Preek do
+
+  Given(:guard){ Guard::Preek.new([], options) }
+  Given(:options){ Hash.new }
+
+  context '#run_on_changes' do
+    Given(:paths){ ['some_file.rb'] }
+    Given(:runner){ double('runner', perform: true) }
+    Given{ Guard::Preek::Runner.should_receive(:new).with(paths).and_return(runner) }
+    Given{ runner.should_receive(:perform) }
+    When{ guard.run_on_changes(paths) }
+    Then{ 'its great' }
+  end
+
+  context '#run_all' do
+    context 'with "run_all_dir" option' do
+      Given(:options){ {run_all_dir: 'lib'} }
+      Given(:runner){ double('runner', perform: true) }
+      Given{ Guard::Preek::Runner.should_receive(:new).with(options[:run_all_dir]).and_return(runner) }
+      Given{ runner.should_receive(:perform) }
+      When{ guard.run_all }
+      Then{ 'also great' }
+    end
+
+
+    context 'with no options' do
+      Then{
+        Guard::UI.should_receive(:error).with(/Guardfile/)
+        expect { guard.run_all }.to throw_symbol :task_has_failed
+      }
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,21 @@
+# This file was generated by the `rspec --init` command. Conventionally, all
+# specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.
+# Require this file using `require "spec_helper"` to ensure that it is only
+# loaded once.
+#
+# See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
+require 'guard/preek'
+require 'rspec-given'
+require 'capture_helper'
+
+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
+
+  # Run specs in random order to surface order dependencies. If you find an
+  # order dependency and want to debug it, you can fix the order by providing
+  # the seed, which is printed after each run.
+  #     --seed 1234
+  config.order = 'random'
+end

data/spec/test_files/irresponsible.rb

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

data/spec/test_files/nil_check.rb

@@ -0,0 +1,12 @@
+#This class a nil check
+class NilCheck
+  def initialize(number)
+    @number = number
+  end
+
+  def nil_check
+    @number.times do |number|
+      next if number.nil?
+    end
+  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

metadata

@@ -0,0 +1,200 @@
+--- !ruby/object:Gem::Specification
+name: guard-preek
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Jon Neverland
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-08-24 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: guard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !ruby/object:Gem::Dependency
+  name: preek
+  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: 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: 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: 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: rspec-given
+  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: coveralls
+  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: Simple refactoring Guard, pretty prints Reek smells
+email:
+- jonwestin@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- Gemfile
+- Guardfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- guard-preek.gemspec
+- lib/guard/preek.rb
+- lib/guard/preek/runner.rb
+- lib/guard/preek/templates/Guardfile
+- lib/guard/preek/version.rb
+- spec/capture_helper.rb
+- spec/guard/integration_spec.rb
+- spec/guard/preek_spec.rb
+- spec/spec_helper.rb
+- spec/test_files/.DS_Store
+- spec/test_files/irresponsible.rb
+- spec/test_files/nil_check.rb
+- spec/test_files/non_smelly.rb
+- spec/test_files/too_many_statements.rb
+homepage: ''
+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.0.2
+signing_key: 
+specification_version: 4
+summary: Simple refactoring Guard, pretty prints Reek smells
+test_files:
+- spec/capture_helper.rb
+- spec/guard/integration_spec.rb
+- spec/guard/preek_spec.rb
+- spec/spec_helper.rb
+- spec/test_files/.DS_Store
+- spec/test_files/irresponsible.rb
+- spec/test_files/nil_check.rb
+- spec/test_files/non_smelly.rb
+- spec/test_files/too_many_statements.rb