phare 0.4 → 0.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 5e4055ee6e95ae9be4856e7031220de6735136a4
-  data.tar.gz: 03a9678f15427a0affb3e76faaeb6694fb2d9775
+  metadata.gz: b1d1e596a5d40fef1d29fa89cd662336f7fd45e7
+  data.tar.gz: 81dddc44763f470efd54222f21b72f48251be8fa
 SHA512:
-  metadata.gz: 83ee6107f5879b34f1da3a9554d96f2bdaccc982bb12f9d768f359d8b6809dae1f048acd3e76ac56584a4790b50e6b475d76e071d9b6e36ccc3c529bd0ffbafb
-  data.tar.gz: 838988f8a43ba902060c4c4b8036228d946fd80d4337bacbe6879bb6369519c354f47140c7feb0031829cfd3d5797da72e5de932f7fb26b265459231e75a35e8
+  metadata.gz: ce38e47371b89624a02538c0cca7a08ab1b15874f6fc566f2450f8e992a2e5ca3943b883a4771f60f4d8dbf6a36479fa1cc86e4790b59afe2ff2298912958b18
+  data.tar.gz: 073eeb502d9612627efedf47a559ded08803378b3c72235819d0fce5e2e245afa6ff89cedf8768db12219a9413b76ccdcc21d95938b50286790e57dac88e5ad1

data/README.md

@@ -3,9 +3,10 @@
     <img src="http://i.imgur.com/9Pa2RgE.png" alt="Phare" />
   </a>
   <br />
-  Phare looks into your files and check for coding style errors. 
+  Phare looks into your files and check for coding style errors.
   <br /><br />
   <a href="https://rubygems.org/gems/phare"><img src="https://badge.fury.io/rb/phare.png" /></a>
+  <a href="https://travis-ci.org/mirego/phare"><img src="https://travis-ci.org/mirego/phare.png?branch=master" /></a>
 </p>
 
 ## Installation
@@ -36,13 +37,18 @@ Phare provides an executable named `phare`. You can just use it as is:
 $ phare
 ```
 
-One of the best way to use Phare is by hooking it before your version control commits. For example, with `git`:
+One of the best ways to use Phare is by hooking it to your version control commit process. For example, with `git`:
 
 ```bash
 $ bundle binstubs phare
 $ ln -s "`pwd`/bin/phare" .git/hooks/pre-commit
 ```
 
+## Contributors
+
+* [@remiprev](https://github.com/remiprev)
+* [@garno](https://github.com/garno)
+
 ## License
 
 `Phare` is © 2014 [Mirego](http://www.mirego.com) and may be freely distributed under the [New BSD license](http://opensource.org/licenses/BSD-3-Clause).  See the [`LICENSE.md`](https://github.com/mirego/phare/blob/master/LICENSE.md) file.

data/lib/phare/check.rb

@@ -20,6 +20,33 @@ module Phare
       end
     end
 
+    def tree_changed?
+      @options[:diff] && tree_changes && tree_changes.any?
+    end
+
+    def tree_changes
+      @modified_files ||= Phare.system_output('git status -s').split("\n").reduce([]) do |memo, diff|
+        filename = diff.split(' ').last
+
+        memo << filename if @extensions.include?(File.extname(filename))
+        memo
+      end
+    end
+
+    def should_run?
+      should_run = binary_exists?
+
+      [:configuration_exists?, :arguments_exists?].each do |condition|
+        should_run = should_run && send(condition) if respond_to?(condition, true)
+      end
+
+      if @options[:diff]
+        should_run = should_run && tree_changed?
+      end
+
+      should_run
+    end
+
   protected
 
     def print_success_message

data/lib/phare/check/jscs.rb

@@ -4,19 +4,33 @@ module Phare
     class JSCS < Check
       attr_reader :config, :path
 
-      def initialize(directory)
+      def initialize(directory, options = {})
         @config = File.expand_path("#{directory}.jscs.json", __FILE__)
         @path = File.expand_path("#{directory}app/assets", __FILE__)
+        @extensions = %w(.js)
+        @options = options
       end
 
       def command
-        "jscs #{@path}"
+        if tree_changed?
+          "jscs #{tree_changes.join(' ')}"
+        else
+          "jscs #{@path}"
+        end
       end
 
     protected
 
-      def should_run?
-        !Phare.system_output('which jscs').empty? && File.exists?(@config) && Dir.exists?(@path)
+      def binary_exists?
+        !Phare.system_output('which jscs').empty?
+      end
+
+      def configuration_exists?
+        File.exists?(@config)
+      end
+
+      def argument_exists?
+        tree_changed? || Dir.exists?(@path)
       end
 
       def print_banner

data/lib/phare/check/jshint.rb

@@ -4,20 +4,34 @@ module Phare
     class JSHint < Check
       attr_reader :config, :path
 
-      def initialize(directory)
+      def initialize(directory, options = {})
         @config = File.expand_path("#{directory}.jshintrc", __FILE__)
         @path = File.expand_path("#{directory}app/assets/javascripts", __FILE__)
         @glob = File.join(@path, '**/*')
+        @extensions = %w(.js .es6.js)
+        @options = options
       end
 
       def command
-        "jshint --config #{@config} --extra-ext .js,.es6.js #{@glob}"
+        if tree_changed?
+          "jshint --config #{@config} --extra-ext #{@extensions.join(',')} #{tree_changes.join(' ')}"
+        else
+          "jshint --config #{@config} --extra-ext #{@extensions.join(',')} #{@glob}"
+        end
       end
 
     protected
 
-      def should_run?
-        !Phare.system_output('which jshint').empty? && File.exists?(@config) && Dir.exists?(@path)
+      def binary_exists?
+        !Phare.system_output('which jshint').empty?
+      end
+
+      def configuration_exists?
+        File.exists?(@config)
+      end
+
+      def arguments_exists?
+        tree_changed? || Dir.exists?(@path)
       end
 
       def print_banner

data/lib/phare/check/rubocop.rb

@@ -2,17 +2,23 @@
 module Phare
   class Check
     class Rubocop < Check
-      def initialize(directory)
+      def initialize(directory, options = {})
         @path = directory
+        @extensions = %w(.rb)
+        @options = options
       end
 
       def command
-        'rubocop'
+        if tree_changed?
+          "rubocop #{tree_changes.join(' ')}"
+        else
+          'rubocop'
+        end
       end
 
     protected
 
-      def should_run?
+      def binary_exists?
         !Phare.system_output('which rubocop').empty?
       end
 

data/lib/phare/check/scss_lint.rb

@@ -4,18 +4,28 @@ module Phare
     class ScssLint < Check
       attr_reader :path
 
-      def initialize(directory)
+      def initialize(directory, options = {})
         @path = File.expand_path("#{directory}app/assets/stylesheets", __FILE__)
+        @extensions = %w(.css .scss)
+        @options = options
       end
 
       def command
-        "scss-lint #{@path}"
+        if tree_changed?
+          "scss-lint #{tree_changes.join(' ')}"
+        else
+          "scss-lint #{@path}"
+        end
       end
 
     protected
 
-      def should_run?
-        !Phare.system_output('which scss-lint').empty? && Dir.exists?(@path)
+      def binary_exists?
+        !Phare.system_output('which scss-lint').empty?
+      end
+
+      def arguments_exists?
+        tree_changed? || Dir.exists?(@path)
       end
 
       def print_banner

data/lib/phare/check_suite.rb

@@ -34,7 +34,7 @@ module Phare
     def run
       @checks = checks.map do |check|
         check = DEFAULT_CHECKS[check]
-        check.new(@directory).tap(&:run).status
+        check.new(@directory, @options).tap(&:run).status
       end
 
       @status = @checks.find { |status| status > 0 } || 0

data/lib/phare/cli.rb

@@ -53,6 +53,10 @@ module Phare
           @options[:only] = checks.split(',').map(&:to_sym)
         end
 
+        opts.on('--diff', 'Only run checks on modified files') do
+          @options[:diff] = true
+        end
+
       end.parse! @argv
     end
   end

data/lib/phare/version.rb

@@ -1,3 +1,3 @@
 module Phare
-  VERSION = '0.4'
+  VERSION = '0.5'
 end

data/spec/phare/check/jscs_spec.rb

@@ -22,6 +22,7 @@ describe Phare::Check::JSCS do
       let(:path_exists?) { false }
       it { expect(check).to_not be_able_to_run }
     end
+
   end
 
   describe :run do
@@ -29,9 +30,11 @@ describe Phare::Check::JSCS do
     let(:run!) { check.run }
 
     context 'with available JSCS' do
+      let(:command) { check.command }
+
       before do
         expect(check).to receive(:should_run?).and_return(true)
-        expect(Phare).to receive(:system).with(check.command)
+        expect(Phare).to receive(:system).with(command)
         expect(Phare).to receive(:last_exit_status).and_return(jscs_exit_status)
         expect(check).to receive(:print_banner)
       end
@@ -46,6 +49,17 @@ describe Phare::Check::JSCS do
         before { expect(Phare).to receive(:puts).with("Something went wrong. Program exited with #{jscs_exit_status}.") }
         it { expect { run! }.to change { check.status }.to(jscs_exit_status) }
       end
+
+      context 'with --diff option' do
+        let(:check) { described_class.new('.', diff: true) }
+        let(:files) { ['foo.js', 'bar.js'] }
+        let(:command) { "jscs #{files.join(' ')}" }
+        let(:jscs_exit_status) { 1337 }
+
+        before { expect(check).to receive(:tree_changes).and_return(files).at_least(:once) }
+
+        it { expect { run! }.to change { check.status }.to(jscs_exit_status) }
+      end
     end
 
     context 'with unavailable JSCS' do

data/spec/phare/check/jshint_spec.rb

@@ -29,9 +29,11 @@ describe Phare::Check::JSHint do
     let(:run!) { check.run }
 
     context 'with available JSHint' do
+      let(:command) { check.command }
+
       before do
         expect(check).to receive(:should_run?).and_return(true)
-        expect(Phare).to receive(:system).with(check.command)
+        expect(Phare).to receive(:system).with(command)
         expect(Phare).to receive(:last_exit_status).and_return(jshint_exit_status)
         expect(check).to receive(:print_banner)
       end

data/spec/phare/check/rubocop_spec.rb

@@ -21,9 +21,11 @@ describe Phare::Check::Rubocop do
     let(:run!) { check.run }
 
     context 'with available Rubocop' do
+      let(:command) { check.command }
+
       before do
         expect(check).to receive(:should_run?).and_return(true)
-        expect(Phare).to receive(:system).with(check.command)
+        expect(Phare).to receive(:system).with(command)
         expect(Phare).to receive(:last_exit_status).and_return(rubocop_exit_status)
         expect(check).to receive(:print_banner)
       end
@@ -38,6 +40,17 @@ describe Phare::Check::Rubocop do
         before { expect(Phare).to receive(:puts).with("Something went wrong. Program exited with #{rubocop_exit_status}.") }
         it { expect { run! }.to change { check.status }.to(rubocop_exit_status) }
       end
+
+      context 'with --diff option' do
+        let(:check) { described_class.new('.', diff: true) }
+        let(:files) { ['foo.rb', 'bar.rb'] }
+        let(:command) { "rubocop #{files.join(' ')}" }
+        let(:rubocop_exit_status) { 1337 }
+
+        before { expect(check).to receive(:tree_changes).and_return(files).at_least(:once) }
+
+        it { expect { run! }.to change { check.status }.to(rubocop_exit_status) }
+      end
     end
 
     context 'with unavailable Rubocop' do

data/spec/phare/check/scss_lint_spec.rb

@@ -26,9 +26,11 @@ describe Phare::Check::ScssLint do
     let(:run!) { check.run }
 
     context 'with available ScssLint' do
+      let(:command) { check.command }
+
       before do
         expect(check).to receive(:should_run?).and_return(true)
-        expect(Phare).to receive(:system).with(check.command)
+        expect(Phare).to receive(:system).with(command)
         expect(Phare).to receive(:last_exit_status).and_return(scsslint_exit_status)
         expect(check).to receive(:print_banner)
       end
@@ -44,6 +46,17 @@ describe Phare::Check::ScssLint do
         before { expect(Phare).to receive(:puts).with("Something went wrong. Program exited with #{scsslint_exit_status}.") }
         it { expect { run! }.to change { check.status }.to(scsslint_exit_status) }
       end
+
+      context 'with --diff option' do
+        let(:check) { described_class.new('.', diff: true) }
+        let(:files) { ['foo.css', 'bar.css.scss'] }
+        let(:command) { "scss-lint #{files.join(' ')}" }
+        let(:scsslint_exit_status) { 1337 }
+
+        before { expect(check).to receive(:tree_changes).and_return(files).at_least(:once) }
+
+        it { expect { run! }.to change { check.status }.to(scsslint_exit_status) }
+      end
     end
 
     context 'with unavailable ScssLint' do

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: phare
 version: !ruby/object:Gem::Version
-  version: '0.4'
+  version: '0.5'
 platform: ruby
 authors:
 - Rémi Prévost
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-03-22 00:00:00.000000000 Z
+date: 2014-04-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler