phare 0.6 → 0.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 15b3ee8b4694a9fa9c68c084483509a79b514186
-  data.tar.gz: 96bc1409085eb987dc81f520cbc47e44381dfc2b
+  metadata.gz: 07cb8717d161d567751d2fc326c271fa8d865fe6
+  data.tar.gz: 934dfb629245a3d31d292959f402c65be527cb46
 SHA512:
-  metadata.gz: 16c1bf55cf413dfaabce005af9eec64770dfe3eb7640f2f02f7650b60d9dbbfacb3954384f75eec7e77b534bc64207235ad2fefd9fa86cbb3eefdac27bc16e46
-  data.tar.gz: fb2e07dff0f5bd49d282039497ac74cf8c9eafb2f41947bea26af8c75585a01eb0998c523caf176f7f31ba58f7a54438c4f58bdb1687ec6fd015e384c575edff
+  metadata.gz: 458a51f11e60f39e557cd10e84a2e9d5bf54546cd5584da14d576cb455b3a7d9bd06bd94ea45ef80dc5a3ab1451e79c981ed9f41d50b80dafa22c914f22e83d1
+  data.tar.gz: 327fadabf0c2e504c8130ca8f253635582f888bc4523528d222e6165dc6566bc1ef2f029bb9bdc55da3b5f0b8c3c9ba9fc7f681363a7fd80e6ade86e53e0b10c

data/README.md

@@ -12,7 +12,7 @@
 
 ## Installation
 
-Add these lines to your application’s Gemfile as development dependancies:
+Add these lines to your application’s `Gemfile` as development dependencies:
 
 ```ruby
 group :development do
@@ -23,11 +23,47 @@ group :development do
 end
 ```
 
+```shell
+$ bundle install
+```
 
-If you wish to check for JavaScript code style using JSHint and JSCS, you must install them too:
+If you wish to check for JavaScript code style using JSHint and JSCS, you must
+specify them in your `package.json` file:
+
+```json
+{
+  "name": "foo",
+  "version": "0.0.1",
+  "devDependencies": {
+    "jshint": "latest",
+    "jscs": "latest"
+  }
+}
+```
 
-```bash
-$ npm install -g jshint jscs
+```shell
+$ npm install
+```
+
+### Shims
+
+Phare uses top-level commands in its checks (eg. `$ rubocop` and not `$ bundle exec rubocop`).
+You’ll need to run these commands in order to use the shims provided by either
+Bundler or NPM.
+
+#### Bundler
+
+```shell
+$ bundle install
+$ bundle binstub rubocop scss-lint
+$ export PATH="./bin:$PATH"
+```
+
+#### npm
+
+```shell
+$ npm install
+$ export PATH="./node_modules/.bin:$PATH"
 ```
 
 ## Usage
@@ -40,13 +76,23 @@ $ phare
 
 ### Version control hook
 
-One of the best ways to use Phare is by hooking it to your version control commit process. 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
 ```
 
+That way, every time `git commit` is ran, `phare` will be executed and the
+commit will be aborted if there are some errors. However, you can skip this
+check altogether by specifying `SKIP_PHARE=1` before your command.
+
+```bash
+$ git commit -m 'Add stuff'
+$ SKIP_PHARE=1 git commit -m 'Add stuff and I don’t care about Phare'
+```
+
 ### Options
 
 #### Command-line

data/lib/phare/check.rb

@@ -32,7 +32,10 @@ module Phare
       end
 
       if @options[:diff]
-        should_run &&= @tree.changed?
+        # NOTE: If the tree hasn't changed or if there is no files
+        #       to check (e.g. they are all in the exclude list),
+        #       we skip the check.
+        should_run &&= @tree.changed? && files_to_check.any?
       end
 
       should_run
@@ -40,6 +43,14 @@ module Phare
 
   protected
 
+    def excluded_files
+      @excluded_files ||= [Dir.glob(excluded_list || [])].flatten
+    end
+
+    def files_to_check
+      @files_to_check ||= @tree.changes - excluded_files
+    end
+
     def print_success_message
       Phare.puts('Everything looks good from here!')
     end

data/lib/phare/check/jscs.rb

@@ -1,4 +1,7 @@
 # encoding: utf-8
+
+require 'json'
+
 module Phare
   class Check
     class JSCS < Check
@@ -15,7 +18,7 @@ module Phare
 
       def command
         if @tree.changed?
-          "jscs #{@tree.changes.join(' ')}"
+          "jscs #{files_to_check.join(' ')}"
         else
           "jscs #{@path}"
         end
@@ -23,6 +26,14 @@ module Phare
 
     protected
 
+      def excluded_list
+        configuration_file['excludeFiles']
+      end
+
+      def configuration_file
+        @configuration_file ||= File.exist?('.jscs.json') ? JSON.parse(File.read('.jscs.json')) : {}
+      end
+
       def binary_exists?
         !Phare.system_output('which jscs').empty?
       end

data/lib/phare/check/jshint.rb

@@ -16,7 +16,7 @@ module Phare
 
       def command
         if @tree.changed?
-          "jshint --config #{@config} --extra-ext #{@extensions.join(',')} #{@tree.changes.join(' ')}"
+          "jshint --config #{@config} --extra-ext #{@extensions.join(',')} #{files_to_check.join(' ')}"
         else
           "jshint --config #{@config} --extra-ext #{@extensions.join(',')} #{@glob}"
         end
@@ -24,6 +24,14 @@ module Phare
 
     protected
 
+      def excluded_list
+        configuration_file.split("\n") if configuration_file
+      end
+
+      def configuration_file
+        @configuration_file ||= File.exist?('.jshintignore') ? File.open('.jshintignore') : false
+      end
+
       def binary_exists?
         !Phare.system_output('which jshint').empty?
       end

data/lib/phare/check/rubocop.rb

@@ -12,7 +12,7 @@ module Phare
 
       def command
         if @tree.changed?
-          "rubocop #{@tree.changes.join(' ')}"
+          "rubocop #{files_to_check.join(' ')}"
         else
           'rubocop'
         end
@@ -20,6 +20,14 @@ module Phare
 
     protected
 
+      def excluded_list
+        configuration_file['AllCops']['Exclude'] if configuration_file['AllCops'] && configuration_file['AllCops']['Exclude']
+      end
+
+      def configuration_file
+        @configuration_file ||= File.exist?('.rubocop.yml') ? YAML::load(File.open('.rubocop.yml')) : {}
+      end
+
       def binary_exists?
         !Phare.system_output('which rubocop').empty?
       end

data/lib/phare/check/scss_lint.rb

@@ -14,7 +14,7 @@ module Phare
 
       def command
         if @tree.changed?
-          "scss-lint #{@tree.changes.join(' ')}"
+          "scss-lint #{files_to_check.join(' ')}"
         else
           "scss-lint #{@path}"
         end
@@ -22,6 +22,14 @@ module Phare
 
     protected
 
+      def excluded_list
+        configuration_file['exclude']
+      end
+
+      def configuration_file
+        @configuration_file ||= File.exist?('.scss-lint.yml') ? YAML::load(File.open('.scss-lint.yml')) : {}
+      end
+
       def binary_exists?
         !Phare.system_output('which scss-lint').empty?
       end

data/lib/phare/check_suite.rb

@@ -25,7 +25,7 @@ module Phare
       if @options[:only].any?
         checks &= @options[:only]
       elsif @options[:skip]
-        checks -= @options[:skip]
+        checks - @options[:skip]
       else
         checks
       end

data/lib/phare/cli.rb

@@ -11,17 +11,14 @@ module Phare
     end
 
     def run
-      if @env['SKIP_CODE_CHECK']
+      if @options[:version]
+        Phare.puts Phare::VERSION
+        exit 0
+      elsif @env['SKIP_CODE_CHECK'] || @env['SKIP_PHARE']
         Phare.banner 'Skipping code style checking… Really? Well alright then…'
         exit 0
       else
-        if @suite.tap(&:run).status == 0
-          Phare.banner 'Everything looks good, keep on committing!'
-          exit 0
-        else
-          Phare.banner 'Something’s wrong with your code style. Please fix it before committing.'
-          exit 1
-        end
+        exit run_suite
       end
     end
 
@@ -43,12 +40,17 @@ module Phare
       options
     end
 
+    # rubocop:disable Metrics/AbcSize
     def parsed_options_from_arguments(argv)
       options_to_merge = {}
 
       OptionParser.new do |opts|
         opts.banner = 'Usage: phare [options]'
 
+        opts.on('--version', 'Display Phare’s version') do
+          options_to_merge[:version] = true
+        end
+
         opts.on('--directory', 'The directory in which to run the checks (default is the current directory') do |directory|
           options_to_merge[:directory] = directory
         end
@@ -64,11 +66,11 @@ module Phare
         opts.on('--diff', 'Only run checks on modified files') do
           options_to_merge[:diff] = true
         end
-
       end.parse! argv
 
       options_to_merge
     end
+    # rubocop:enable Metrics/AbcSize
 
     def parsed_options_from_yaml(file)
       options_to_merge = {}
@@ -85,5 +87,15 @@ module Phare
 
       options_to_merge
     end
+
+    def run_suite
+      if @suite.tap(&:run).status == 0
+        Phare.banner 'Everything looks good, keep on committing!'
+        0
+      else
+        Phare.banner 'Something’s wrong with your code style. Please fix it before committing.'
+        1
+      end
+    end
   end
 end

data/lib/phare/git.rb

@@ -13,7 +13,7 @@ module Phare
       @changes ||= Phare.system_output('git status -s').split("\n").each_with_object([]) do |diff, memo|
         filename = diff.split(' ').last
 
-        if diff =~ /^[^D]{2}/ && @extensions.include?(File.extname(filename))
+        if diff =~ /^[A|M].*/ && @extensions.include?(File.extname(filename))
           memo << filename
         else
           next

data/lib/phare/version.rb

@@ -1,3 +1,3 @@
 module Phare
-  VERSION = '0.6'
+  VERSION = '0.7'
 end

data/phare.gemspec

@@ -21,5 +21,5 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'bundler', '~> 1.3'
   spec.add_development_dependency 'rake'
   spec.add_development_dependency 'rspec', '~> 3.0.0.rc1'
-  spec.add_development_dependency 'rubocop', '0.22'
+  spec.add_development_dependency 'rubocop', '0.27'
 end

data/spec/phare/check/jscs_spec.rb

@@ -5,6 +5,7 @@ describe Phare::Check::JSCS do
 
   describe :should_run? do
     let(:check) { described_class.new('.') }
+
     before do
       expect(Phare).to receive(:system_output).with('which jscs').and_return(which_output)
       allow(File).to receive(:exist?).with(check.config).and_return(config_exists?)
@@ -15,7 +16,20 @@ describe Phare::Check::JSCS do
       let(:which_output) { 'jscs' }
       let(:config_exists?) { true }
       let(:path_exists?) { true }
+
       it { expect(check).to be_able_to_run }
+
+      context 'with only excluded files and the --diff option' do
+        let(:check) { described_class.new('.', diff: true) }
+        let(:files) { ['foo.js'] }
+
+        before do
+          expect(check).to receive(:excluded_files).and_return(files).once
+          expect(check.tree).to receive(:changes).and_return(files).at_least(:once)
+        end
+
+        it { expect(check.should_run?).to be_falsey }
+      end
     end
 
     context 'with unfound jscs command' do
@@ -24,7 +38,6 @@ describe Phare::Check::JSCS do
       let(:path_exists?) { false }
       it { expect(check).to_not be_able_to_run }
     end
-
   end
 
   describe :run do
@@ -54,13 +67,30 @@ describe Phare::Check::JSCS do
 
       context 'with --diff option' do
         let(:check) { described_class.new('.', diff: true) }
-        let(:files) { ['foo.js', 'bar.js'] }
-        let(:command) { "jscs #{files.join(' ')}" }
+        let(:files) { ['app/foo.js', 'bar.js'] }
         let(:jscs_exit_status) { 1337 }
 
-        before { expect(check.tree).to receive(:changes).and_return(files).at_least(:once) }
+        context 'without exclusions' do
+          let(:command) { "jscs #{files.join(' ')}" }
 
-        it { expect { run! }.to change { check.status }.to(jscs_exit_status) }
+          before do
+            expect(check.tree).to receive(:changes).and_return(files).at_least(:once)
+            expect(check).to receive(:excluded_files).and_return([]).once
+          end
+
+          it { expect { run! }.to change { check.status }.to(jscs_exit_status) }
+        end
+
+        context 'with exclusions' do
+          let(:command) { 'jscs bar.js' }
+
+          before do
+            expect(check).to receive(:excluded_files).and_return(['app/foo.js']).once
+            expect(check.tree).to receive(:changes).and_return(files).at_least(:once)
+          end
+
+          it { expect { run! }.to change { check.status }.to(jscs_exit_status) }
+        end
       end
     end
 

data/spec/phare/check/jshint_spec.rb

@@ -16,6 +16,18 @@ describe Phare::Check::JSHint do
       let(:config_exists?) { true }
       let(:path_exists?) { true }
       it { expect(check).to be_able_to_run }
+
+      context 'with only excluded files and the --diff option' do
+        let(:check) { described_class.new('.', diff: true) }
+        let(:files) { ['foo.js'] }
+
+        before do
+          expect(check).to receive(:excluded_files).and_return(files).once
+          expect(check.tree).to receive(:changes).and_return(files).at_least(:once)
+        end
+
+        it { expect(check.should_run?).to be_falsey }
+      end
     end
 
     context 'with unfound jshint command' do
@@ -32,8 +44,12 @@ describe Phare::Check::JSHint do
 
     context 'with available JSHint' do
       let(:command) { check.command }
+      let(:directory) { '.' }
+      let(:expanded_path) { '.jshintrc' }
 
       before do
+        expect(File).to receive(:expand_path).with("#{directory}app/assets/javascripts", anything).once.and_call_original
+        expect(File).to receive(:expand_path).with("#{directory}.jshintrc", anything).once.and_return(expanded_path)
         expect(check).to receive(:should_run?).and_return(true)
         expect(Phare).to receive(:system).with(command)
         expect(Phare).to receive(:last_exit_status).and_return(jshint_exit_status)
@@ -51,6 +67,34 @@ describe Phare::Check::JSHint do
         before { expect(Phare).to receive(:puts).with("Something went wrong. Program exited with #{jshint_exit_status}.") }
         it { expect { run! }.to change { check.status }.to(jshint_exit_status) }
       end
+
+      context 'with --diff option' do
+        let(:check) { described_class.new(directory, diff: true) }
+        let(:files) { ['app/foo.js', 'bar.js'] }
+        let(:jshint_exit_status) { 1337 }
+
+        context 'without exclusions' do
+          let(:command) { "jshint --config #{expanded_path} --extra-ext .js,.es6 #{files.join(' ')}" }
+
+          before do
+            expect(check.tree).to receive(:changes).and_return(files).at_least(:once)
+            expect(check).to receive(:excluded_files).and_return([]).once
+          end
+
+          it { expect { run! }.to change { check.status }.to(jshint_exit_status) }
+        end
+
+        context 'with exclusions' do
+          let(:command) { "jshint --config #{expanded_path} --extra-ext .js,.es6 bar.js" }
+
+          before do
+            expect(check).to receive(:excluded_files).and_return(['app/foo.js']).once
+            expect(check.tree).to receive(:changes).and_return(files).at_least(:once)
+          end
+
+          it { expect { run! }.to change { check.status }.to(jshint_exit_status) }
+        end
+      end
     end
 
     context 'with unavailable JSHint' do

data/spec/phare/check/rubocop_spec.rb

@@ -10,6 +10,18 @@ describe Phare::Check::Rubocop do
     context 'with found rubocop command' do
       let(:which_output) { 'rubocop' }
       it { expect(check).to be_able_to_run }
+
+      context 'with only excluded files and the --diff option' do
+        let(:check) { described_class.new('.', diff: true) }
+        let(:files) { ['foo.rb'] }
+
+        before do
+          expect(check).to receive(:excluded_files).and_return(files).once
+          expect(check.tree).to receive(:changes).and_return(files).at_least(:once)
+        end
+
+        it { expect(check.should_run?).to be_falsey }
+      end
     end
 
     context 'with unfound rubocop command' do
@@ -46,12 +58,29 @@ describe Phare::Check::Rubocop do
       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.tree).to receive(:changes).and_return(files).at_least(:once) }
+        context 'without exclusions' do
+          let(:command) { "rubocop #{files.join(' ')}" }
 
-        it { expect { run! }.to change { check.status }.to(rubocop_exit_status) }
+          before do
+            expect(check.tree).to receive(:changes).and_return(files).at_least(:once)
+            expect(check).to receive(:excluded_files).and_return([]).once
+          end
+
+          it { expect { run! }.to change { check.status }.to(rubocop_exit_status) }
+        end
+
+        context 'with exclusions' do
+          let(:command) { 'rubocop bar.rb' }
+
+          before do
+            expect(check).to receive(:excluded_files).and_return(['foo.rb']).once
+            expect(check.tree).to receive(:changes).and_return(files).at_least(:once)
+          end
+
+          it { expect { run! }.to change { check.status }.to(rubocop_exit_status) }
+        end
       end
     end
 

data/spec/phare/check/scss_lint_spec.rb

@@ -14,6 +14,18 @@ describe Phare::Check::ScssLint do
       let(:which_output) { 'scss-lint' }
       let(:path_exists?) { true }
       it { expect(check).to be_able_to_run }
+
+      context 'with only excluded files and the --diff option' do
+        let(:check) { described_class.new('.', diff: true) }
+        let(:files) { ['foo.scss'] }
+
+        before do
+          expect(check).to receive(:excluded_files).and_return(files).once
+          expect(check.tree).to receive(:changes).and_return(files).at_least(:once)
+        end
+
+        it { expect(check.should_run?).to be_falsey }
+      end
     end
 
     context 'with unfound scss-lint command' do
@@ -51,13 +63,30 @@ describe Phare::Check::ScssLint do
 
       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(:files) { ['foo.rb', 'bar.rb'] }
         let(:scsslint_exit_status) { 1337 }
 
-        before { expect(check.tree).to receive(:changes).and_return(files).at_least(:once) }
+        context 'without exclusions' do
+          let(:command) { "scss-lint #{files.join(' ')}" }
 
-        it { expect { run! }.to change { check.status }.to(scsslint_exit_status) }
+          before do
+            expect(check.tree).to receive(:changes).and_return(files).at_least(:once)
+            expect(check).to receive(:excluded_files).and_return([]).once
+          end
+
+          it { expect { run! }.to change { check.status }.to(scsslint_exit_status) }
+        end
+
+        context 'with exclusions' do
+          let(:command) { 'scss-lint bar.rb' }
+
+          before do
+            expect(check).to receive(:excluded_files).and_return(['foo.rb']).once
+            expect(check.tree).to receive(:changes).and_return(files).at_least(:once)
+          end
+
+          it { expect { run! }.to change { check.status }.to(scsslint_exit_status) }
+        end
       end
     end
 

data/spec/phare/cli_spec.rb

@@ -9,11 +9,26 @@ describe Phare::CLI do
   let(:env) { {} }
 
   describe :run do
-    context 'with code check skipping' do
+    context 'with version flag' do
+      let(:cli) { described_class.new(env, ['--version']) }
+
+      before do
+        expect(Phare).to receive(:puts).with Phare::VERSION
+      end
+
+      it { expect { run! }.to exit_with_code(0) }
+    end
+
+    context 'with legacy code check skipping' do
       let(:env) { { 'SKIP_CODE_CHECK' => '1' } }
       it { expect { run! }.to exit_with_code(0) }
     end
 
+    context 'with code check skipping' do
+      let(:env) { { 'SKIP_PHARE' => '1' } }
+      it { expect { run! }.to exit_with_code(0) }
+    end
+
     context 'without code check skipping' do
       let(:env) { {} }
 

data/spec/phare/git_spec.rb

@@ -12,7 +12,7 @@ describe Phare::Git do
       before { expect(git).to receive(:changes).and_return(changes) }
 
       context 'with changes' do
-        let(:changes) { ['foo.rb'] }
+        let(:changes) { %w(foo.rb) }
 
         it { expect(git.changed?).to eq(true) }
       end
@@ -37,31 +37,31 @@ describe Phare::Git do
     context 'with empty tree' do
       let(:tree) { '' }
 
-      it { expect(git.changes).to eq([]) }
+      it { expect(git.changes).to be_empty }
     end
 
     context 'with untracked file' do
       let(:tree) { '?? foo.rb' }
 
-      it { expect(git.changes).to eq(['foo.rb']) }
+      it { expect(git.changes).to be_empty }
     end
 
     context 'with added file' do
       let(:tree) { "A  foo.rb\nAM bar.rb" }
 
-      it { expect(git.changes).to eq(['foo.rb', 'bar.rb']) }
+      it { expect(git.changes).to match_array(%w(foo.rb bar.rb)) }
     end
 
     context 'with modified file' do
-      let(:tree) { "M  foo.rb\nDM bar.rb" }
+      let(:tree) { "M  foo.rb\nDM bar.rb\n M foobar.rb" }
 
-      it { expect(git.changes).to eq(['foo.rb']) }
+      it { expect(git.changes).to match_array(%w(foo.rb)) }
     end
 
     context 'with deleted file' do
-      let(:tree) { " D foo.rb\nMD bar.rb" }
+      let(:tree) { " D foo.rb\nMD bar.rb\n D foobar.rb" }
 
-      it { expect(git.changes).to eq([]) }
+      it { expect(git.changes).to match_array(%w(bar.rb)) }
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: phare
 version: !ruby/object:Gem::Version
-  version: '0.6'
+  version: '0.7'
 platform: ruby
 authors:
 - Rémi Prévost
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-06-03 00:00:00.000000000 Z
+date: 2015-04-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -58,14 +58,14 @@ dependencies:
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: '0.22'
+        version: '0.27'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: '0.22'
+        version: '0.27'
 description: Phare looks into your files and check for (Ruby, JavaScript and SCSS)
   coding style errors.
 email:
@@ -123,7 +123,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.2
+rubygems_version: 2.4.5
 signing_key: 
 specification_version: 4
 summary: Phare looks into your files and check for (Ruby, JavaScript and SCSS) coding