phare 0.5.2 → 0.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: bfcaf74d67d7cc658fd83f8857ea9f261664ec57
-  data.tar.gz: 916cc9cca2dcbf70d1679ee87b1483c170ad9e90
+  metadata.gz: 15b3ee8b4694a9fa9c68c084483509a79b514186
+  data.tar.gz: 96bc1409085eb987dc81f520cbc47e44381dfc2b
 SHA512:
-  metadata.gz: 8e024596d554770e2eb47bb0578c877cf211643d56ca81aa070826833d06406ef15e2db02799a171d8a52415efae15980549891aa5a5fbf83df1c3cb47d81b34
-  data.tar.gz: dce0b277a9221a0e4e83b5494eac777322e8e469a7bae8dede1609988e6c609f3f7c871e545c5a71e847f1e0b29c1e13c24ff0b292b3ca5fc7b8bbf91493c837
+  metadata.gz: 16c1bf55cf413dfaabce005af9eec64770dfe3eb7640f2f02f7650b60d9dbbfacb3954384f75eec7e77b534bc64207235ad2fefd9fa86cbb3eefdac27bc16e46
+  data.tar.gz: fb2e07dff0f5bd49d282039497ac74cf8c9eafb2f41947bea26af8c75585a01eb0998c523caf176f7f31ba58f7a54438c4f58bdb1687ec6fd015e384c575edff

data/.rubocop.yml

@@ -1,8 +1,6 @@
 AllCops:
-  Includes:
-    - Rakefile
-    - config.ru
-    - Gemfile
+  Include:
+    - phare.gemspec
 
 Documentation:
   Enabled: false
@@ -13,6 +11,9 @@ Encoding:
 LineLength:
   Max: 200
 
+ClassLength:
+  Max: 200
+
 AccessModifierIndentation:
   EnforcedStyle: outdent
 
@@ -42,8 +43,11 @@ Lambda:
 RegexpLiteral:
   Enabled: false
 
-RedundantBegin:
+AssignmentInCondition:
+  Enabled: false
+
+ClassAndModuleChildren:
   Enabled: false
 
-AssignmentInCondition:
+GuardClause:
   Enabled: false

data/.travis.yml

@@ -1,6 +1,7 @@
 language: ruby
 
 rvm:
+  - 2.1.1
   - 2.0.0
   - 1.9.3
 

data/README.md

@@ -5,8 +5,9 @@
   <br />
   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>
+  <a href="https://rubygems.org/gems/phare"><img src="http://img.shields.io/gem/v/phare.svg" /></a>
+  <a href="https://travis-ci.org/mirego/phare"><img src="http://img.shields.io/travis/mirego/phare.svg" /></a>
+  <a href="https://codeclimate.com/github/mirego/phare"><img src="http://img.shields.io/codeclimate/github/mirego/phare.svg" /></a>
 </p>
 
 ## Installation
@@ -37,6 +38,8 @@ Phare provides an executable named `phare`. You can just use it as is:
 $ 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`:
 
 ```bash
@@ -44,6 +47,28 @@ $ bundle binstubs phare
 $ ln -s "`pwd`/bin/phare" .git/hooks/pre-commit
 ```
 
+### Options
+
+#### Command-line
+
+| Option      | Description
+|-------------|-------------------------------------------------------------------------------------------------------------------------
+| `directory` | The directory in which to run the checks (default is the current directory
+| `only`      | The specific checks to run (e.g. `--only=rubocup,jscs`)
+| `skip`      | The checks to skip (e.g. `--skip=scsslint`)
+
+#### `.phare.yml`
+
+Instead of using command-line arguments when running the `phare` command, you
+can create a `.phare.yml` file at the root of your project and hard-code options
+in that file.
+
+```yaml
+skip:
+  - scsslint
+  - jshint
+```
+
 ## Contributors
 
 * [@remiprev](https://github.com/remiprev)

data/bin/phare

@@ -1,6 +1,6 @@
 #!/usr/bin/env ruby
 
-$LOAD_PATH.unshift File.join(File.dirname(__FILE__), *%w[.. lib])
+$LOAD_PATH.unshift File.join(File.dirname(__FILE__), *%w(.. lib))
 
 require 'phare'
 

data/lib/phare.rb

@@ -1,5 +1,6 @@
 require 'English'
 require 'optparse'
+require 'yaml'
 require 'phare/version'
 
 require 'phare/cli'
@@ -29,4 +30,10 @@ module Phare
   def self.puts(*args)
     STDOUT.puts(*args)
   end
+
+  def self.banner(string)
+    Phare.puts '-' * string.length
+    Phare.puts string
+    Phare.puts '-' * string.length
+  end
 end

data/lib/phare/check.rb

@@ -2,7 +2,7 @@ module Phare
   class Check
     attr_reader :status, :command, :tree
 
-    def initialize(directory, options = {})
+    def initialize(_directory, options = {})
       @tree = Git.new(@extensions, options)
     end
 
@@ -28,11 +28,11 @@ module Phare
       should_run = binary_exists?
 
       [:configuration_exists?, :arguments_exists?].each do |condition|
-        should_run = should_run && send(condition) if respond_to?(condition, true)
+        should_run &&= send(condition) if respond_to?(condition, true)
       end
 
       if @options[:diff]
-        should_run = should_run && @tree.changed?
+        should_run &&= @tree.changed?
       end
 
       should_run

data/lib/phare/check/jscs.rb

@@ -28,17 +28,15 @@ module Phare
       end
 
       def configuration_exists?
-        File.exists?(@config)
+        File.exist?(@config)
       end
 
       def argument_exists?
-        @tree.changed? || Dir.exists?(@path)
+        @tree.changed? || Dir.exist?(@path)
       end
 
       def print_banner
-        Phare.puts '---------------------------------------------'
-        Phare.puts 'Running JSCS to check for JavaScript style…'
-        Phare.puts '---------------------------------------------'
+        Phare.banner 'Running JSCS to check for JavaScript style…'
       end
     end
   end

data/lib/phare/check/jshint.rb

@@ -29,17 +29,15 @@ module Phare
       end
 
       def configuration_exists?
-        File.exists?(@config)
+        File.exist?(@config)
       end
 
       def arguments_exists?
-        @tree.changed? || Dir.exists?(@path)
+        @tree.changed? || Dir.exist?(@path)
       end
 
       def print_banner
-        Phare.puts '---------------------------------------------'
-        Phare.puts 'Running JSHint to check for JavaScript style…'
-        Phare.puts '---------------------------------------------'
+        Phare.banner 'Running JSHint to check for JavaScript style…'
       end
     end
   end

data/lib/phare/check/rubocop.rb

@@ -25,9 +25,7 @@ module Phare
       end
 
       def print_banner
-        Phare.puts '----------------------------------------'
-        Phare.puts 'Running Rubocop to check for Ruby style…'
-        Phare.puts '----------------------------------------'
+        Phare.banner 'Running Rubocop to check for Ruby style…'
       end
     end
   end

data/lib/phare/check/scss_lint.rb

@@ -6,7 +6,7 @@ module Phare
 
       def initialize(directory, options = {})
         @path = File.expand_path("#{directory}app/assets/stylesheets", __FILE__)
-        @extensions = %w(.css .scss)
+        @extensions = %w(.scss)
         @options = options
 
         super
@@ -27,13 +27,11 @@ module Phare
       end
 
       def arguments_exists?
-        @tree.changed? || Dir.exists?(@path)
+        @tree.changed? || Dir.exist?(@path)
       end
 
       def print_banner
-        Phare.puts '------------------------------------------'
-        Phare.puts 'Running SCSS-Lint to check for SCSS style…'
-        Phare.puts '------------------------------------------'
+        Phare.banner 'Running SCSS-Lint to check for SCSS style…'
       end
     end
   end

data/lib/phare/check_suite.rb

@@ -23,9 +23,9 @@ module Phare
       checks = DEFAULT_CHECKS.keys
 
       if @options[:only].any?
-        checks = checks & @options[:only]
+        checks &= @options[:only]
       elsif @options[:skip]
-        checks = checks - @options[:skip]
+        checks -= @options[:skip]
       else
         checks
       end

data/lib/phare/cli.rb

@@ -5,59 +5,85 @@ module Phare
 
     def initialize(env, argv)
       @env = env
-      @argv = argv
-      parse_options
+      @options = parsed_options(argv)
 
       @suite = Phare::CheckSuite.new(@options)
     end
 
     def run
       if @env['SKIP_CODE_CHECK']
-        Phare.puts '--------------------------------------------------------'
-        Phare.puts 'Skipping code style checking… Really? Well alright then…'
-        Phare.puts '--------------------------------------------------------'
-
+        Phare.banner 'Skipping code style checking… Really? Well alright then…'
         exit 0
       else
         if @suite.tap(&:run).status == 0
-          Phare.puts '------------------------------------------'
-          Phare.puts 'Everything looks good, keep on committing!'
-          Phare.puts '------------------------------------------'
-
+          Phare.banner 'Everything looks good, keep on committing!'
           exit 0
         else
-          Phare.puts '------------------------------------------------------------------------'
-          Phare.puts 'Something’s wrong with your code style. Please fix it before committing.'
-          Phare.puts '------------------------------------------------------------------------'
-
+          Phare.banner 'Something’s wrong with your code style. Please fix it before committing.'
           exit 1
         end
       end
     end
 
-    def parse_options
-      @options = { directory: Dir.getwd }
+  protected
+
+    def parsed_options(argv)
+      options = { directory: Dir.getwd }
+      options.merge! parsed_options_from_yaml(File.join(options[:directory], '.phare.yml'))
+      options.merge! parsed_options_from_arguments(argv)
+      symbolize_options!(options)
+
+      options
+    end
+
+    def symbolize_options!(options)
+      options[:skip].map!(&:to_sym) if options[:skip]
+      options[:only].map!(&:to_sym) if options[:only]
+
+      options
+    end
+
+    def parsed_options_from_arguments(argv)
+      options_to_merge = {}
 
       OptionParser.new do |opts|
         opts.banner = 'Usage: phare [options]'
 
         opts.on('--directory', 'The directory in which to run the checks (default is the current directory') do |directory|
-          @options[:directory] = directory
+          options_to_merge[:directory] = directory
         end
 
         opts.on('--skip x,y,z', 'Skip checks') do |checks|
-          @options[:skip] = checks.split(',').map(&:to_sym)
+          options_to_merge[:skip] = checks.split(',')
         end
 
         opts.on('--only x,y,z', 'Only run the specified checks') do |checks|
-          @options[:only] = checks.split(',').map(&:to_sym)
+          options_to_merge[:only] = checks.split(',')
         end
 
         opts.on('--diff', 'Only run checks on modified files') do
-          @options[:diff] = true
+          options_to_merge[:diff] = true
         end
 
-      end.parse! @argv
+      end.parse! argv
+
+      options_to_merge
+    end
+
+    def parsed_options_from_yaml(file)
+      options_to_merge = {}
+
+      if File.exist?(file)
+        # Load YAML content
+        content = YAML.load(File.read(file))
+
+        # Symbolize keys
+        options_to_merge = content.reduce({}) do |memo, (key, value)|
+          memo.merge! key.to_sym => value
+        end
+      end
+
+      options_to_merge
     end
   end
 end

data/lib/phare/git.rb

@@ -10,14 +10,14 @@ module Phare
     end
 
     def changes
-      @changes ||= Phare.system_output('git status -s').split("\n").reduce([]) do |memo, diff|
+      @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))
           memo << filename
+        else
+          next
         end
-
-        memo
       end
     end
   end

data/lib/phare/version.rb

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

data/phare.gemspec

@@ -7,18 +7,19 @@ Gem::Specification.new do |spec|
   spec.name          = 'phare'
   spec.version       = Phare::VERSION
   spec.authors       = ['Rémi Prévost']
-  spec.email         = ['remi@exomel.com']
+  spec.email         = ['rprevost@mirego.com']
   spec.description   = 'Phare looks into your files and check for (Ruby, JavaScript and SCSS) coding style errors.'
   spec.summary       = spec.description
   spec.homepage      = 'https://github.com/mirego/phare'
   spec.license       = 'BSD 3-Clause'
 
-  spec.files         = `git ls-files`.split($/)
+  spec.files         = `git ls-files`.split($INPUT_RECORD_SEPARATOR)
   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.require_paths = ['lib']
 
   spec.add_development_dependency 'bundler', '~> 1.3'
   spec.add_development_dependency 'rake'
-  spec.add_development_dependency 'rspec', '~> 3.0.0.beta2'
+  spec.add_development_dependency 'rspec', '~> 3.0.0.rc1'
+  spec.add_development_dependency 'rubocop', '0.22'
 end

data/spec/phare/check/jscs_spec.rb

@@ -1,12 +1,14 @@
 require 'spec_helper'
 
 describe Phare::Check::JSCS do
+  let(:described_class) { Phare::Check::JSCS }
+
   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(:exists?).with(check.config).and_return(config_exists?)
-      allow(Dir).to receive(:exists?).with(check.path).and_return(path_exists?)
+      allow(File).to receive(:exist?).with(check.config).and_return(config_exists?)
+      allow(Dir).to receive(:exist?).with(check.path).and_return(path_exists?)
     end
 
     context 'with found jscs command' do

data/spec/phare/check/jshint_spec.rb

@@ -1,12 +1,14 @@
 require 'spec_helper'
 
 describe Phare::Check::JSHint do
+  let(:described_class) { Phare::Check::JSHint }
+
   describe :should_run? do
     let(:check) { described_class.new('.') }
     before do
       expect(Phare).to receive(:system_output).with('which jshint').and_return(which_output)
-      allow(File).to receive(:exists?).with(check.config).and_return(config_exists?)
-      allow(Dir).to receive(:exists?).with(check.path).and_return(path_exists?)
+      allow(File).to receive(:exist?).with(check.config).and_return(config_exists?)
+      allow(Dir).to receive(:exist?).with(check.path).and_return(path_exists?)
     end
 
     context 'with found jshint command' do

data/spec/phare/check/rubocop_spec.rb

@@ -1,6 +1,8 @@
 require 'spec_helper'
 
 describe Phare::Check::Rubocop do
+  let(:described_class) { Phare::Check::Rubocop }
+
   describe :should_run? do
     let(:check) { described_class.new('.') }
     before { expect(Phare).to receive(:system_output).with('which rubocop').and_return(which_output) }

data/spec/phare/check/scss_lint_spec.rb

@@ -1,11 +1,13 @@
 require 'spec_helper'
 
 describe Phare::Check::ScssLint do
+  let(:described_class) { Phare::Check::ScssLint }
+
   describe :should_run? do
     let(:check) { described_class.new('.') }
     before do
       expect(Phare).to receive(:system_output).with('which scss-lint').and_return(which_output)
-      allow(Dir).to receive(:exists?).with(check.path).and_return(path_exists?)
+      allow(Dir).to receive(:exist?).with(check.path).and_return(path_exists?)
     end
 
     context 'with found scss-lint command' do

data/spec/phare/check_suite_spec.rb

@@ -1,6 +1,8 @@
 require 'spec_helper'
 
 describe Phare::CheckSuite do
+  let(:described_class) { Phare::CheckSuite }
+
   describe :run do
     let(:options) { { directory: '.' } }
     let(:suite) { described_class.new(options) }
@@ -30,7 +32,7 @@ describe Phare::CheckSuite do
     end
 
     context 'with no failing check' do
-      let(:exit_status_proc) { proc { |index| 0 } }
+      let(:exit_status_proc) { proc { 0 } }
 
       it { expect { suite.run }.to change { suite.status }.to(0) }
     end

data/spec/phare/cli_spec.rb

@@ -1,11 +1,14 @@
 require 'spec_helper'
 
 describe Phare::CLI do
+  let(:described_class) { Phare::CLI }
+
   let(:cli) { described_class.new(env, argv) }
   let(:argv) { [] }
   let(:run!) { cli.run }
+  let(:env) { {} }
 
-  describe :initialize do
+  describe :run do
     context 'with code check skipping' do
       let(:env) { { 'SKIP_CODE_CHECK' => '1' } }
       it { expect { run! }.to exit_with_code(0) }
@@ -33,4 +36,16 @@ describe Phare::CLI do
       end
     end
   end
+
+  describe :parsed_options do
+    let(:parsed_options) { cli.send(:parsed_options, argv) }
+
+    before do
+      expect(cli).to receive(:parsed_options_from_yaml).and_return(skip: ['scsslint'])
+      expect(cli).to receive(:parsed_options_from_arguments).and_return(skip: ['rubocop'])
+    end
+
+    it { expect(parsed_options[:directory]).to eql Dir.pwd }
+    it { expect(parsed_options[:skip]).to eql [:rubocop] }
+  end
 end

data/spec/phare/git_spec.rb

@@ -1,6 +1,8 @@
 require 'spec_helper'
 
 describe Phare::Git do
+  let(:described_class) { Phare::Git }
+
   let(:extensions) { ['.rb'] }
   let(:options) { { diff: true } }
   let(:git) { described_class.new(extensions, options) }
@@ -39,7 +41,7 @@ describe Phare::Git do
     end
 
     context 'with untracked file' do
-      let(:tree) { "?? foo.rb" }
+      let(:tree) { '?? foo.rb' }
 
       it { expect(git.changes).to eq(['foo.rb']) }
     end

data/spec/spec_helper.rb

@@ -29,12 +29,16 @@ RSpec::Matchers.define :exit_with_code do |expected_code|
     actual && actual == expected_code
   end
 
-  failure_message do |block|
+  supports_block_expectations do
+    true
+  end
+
+  failure_message do
     "expected block to call exit(#{expected_code}) but exit" +
       (actual.nil? ? ' not called' : "(#{actual}) was called")
   end
 
-  failure_message_when_negated do |block|
+  failure_message_when_negated do
     "expected block not to call exit(#{expected_code})"
   end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: phare
 version: !ruby/object:Gem::Version
-  version: 0.5.2
+  version: '0.6'
 platform: ruby
 authors:
 - Rémi Prévost
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-05-12 00:00:00.000000000 Z
+date: 2014-06-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -44,18 +44,32 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.0.0.beta2
+        version: 3.0.0.rc1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.0.0.beta2
+        version: 3.0.0.rc1
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: '0.22'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: '0.22'
 description: Phare looks into your files and check for (Ruby, JavaScript and SCSS)
   coding style errors.
 email:
-- remi@exomel.com
+- rprevost@mirego.com
 executables:
 - phare
 extensions: []