phare 0.1 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 9cdce49504a22679ea43dfe644e259f624322c6f
-  data.tar.gz: 3525cfc8920a49d5348c80eb1d4cec5a4c4a57de
+  metadata.gz: 72b28ae2c619de4e9b95d9dd0d52abc85b10ed9c
+  data.tar.gz: 8625df33c0f902de3574ff3b66827e081fa2dfba
 SHA512:
-  metadata.gz: 0c495fd0e49ee1a81215cd23c668696f6cdc334882f2e9c77bde160230ca1c997553fda95267e1ed569498d986ea4933f2a8cb5770e56d6cc3cfccabe614f1f0
-  data.tar.gz: 1c573198e4ff077aea4822748b11434dbc58b196764ea1e1a879a77aa4647e11f231dfe16dcc85637431d6bc1021b7dfa000029c78e0ccc2473aa2619a03994b
+  metadata.gz: fcc6e5cc92116b198cc50b9eda3cdc4db2c0469a0cea936bc8852a0541eb4f6bcee077418520d4502a6f4ba50bb19a3540d325b7b27e74ec54c4165079ce5296
+  data.tar.gz: 1f9b87c9982baea160b59e8c61365c4557ec2cc2d6c57f053c65811802c4ca13da21468b26c90c8d99bd709012245fa5114d2a7da090b802103f3fd663d2deae

data/.rubocop.yml

@@ -0,0 +1,49 @@
+AllCops:
+  Includes:
+    - Rakefile
+    - config.ru
+    - Gemfile
+
+Documentation:
+  Enabled: false
+
+Encoding:
+  Enabled: false
+
+LineLength:
+  Max: 200
+
+AccessModifierIndentation:
+  EnforcedStyle: outdent
+
+IfUnlessModifier:
+  Enabled: false
+
+CaseIndentation:
+  IndentWhenRelativeTo: case
+  IndentOneStep: true
+
+MethodLength:
+  CountComments: false
+  Max: 20
+
+SignalException:
+  Enabled: false
+
+ColonMethodCall:
+  Enabled: false
+
+AsciiComments:
+  Enabled: false
+
+Lambda:
+  Enabled: false
+
+RegexpLiteral:
+  Enabled: false
+
+RedundantBegin:
+  Enabled: false
+
+AssignmentInCondition:
+  Enabled: false

data/README.md

@@ -2,10 +2,12 @@
 
 ## Installation
 
-Add this line to your application’s Gemfile:
+Add this line to your application’s Gemfile as a development dependancy:
 
 ```ruby
-gem 'phare'
+group :development do
+  gem 'phare'
+end
 ```
 
 If you wish to check for JavaScript code style using JSHint and JSCS, you must install them too:

data/bin/phare

@@ -1,25 +1,7 @@
 #!/usr/bin/env ruby
 
-$:.unshift File.join(File.dirname(__FILE__), *%w[.. lib])
+$LOAD_PATH.unshift File.join(File.dirname(__FILE__), *%w[.. lib])
 
 require 'phare'
 
-if ENV['SKIP_CODE_CHECK']
-    puts '--------------------------------------------------------'
-    puts 'Skipping code style checking… Really? Well alright then…'
-    puts '--------------------------------------------------------'
-else
-  if Phare::CLI.new(Dir.getwd).tap { |c| c.run }.status == 0
-    puts ''
-    puts '------------------------------------------'
-    puts 'Everything looks good, keep on committing!'
-    puts '------------------------------------------'
-    exit 0
-  else
-    puts ''
-    puts '------------------------------------------------------------------------'
-    puts 'Something’s wrong with your code style. Please fix it before committing.'
-    puts '------------------------------------------------------------------------'
-    exit 1
-  end
-end
+Phare::CLI.new(ENV)

data/lib/phare/check.rb

@@ -0,0 +1,23 @@
+module Phare
+  class Check
+    attr_reader :status
+
+    def initialize(directory)
+      @directory = directory
+      @directory << '/' unless @directory.end_with?('/')
+    end
+
+    def run
+      ruby = Checks::RubyRubocop.new
+      ruby.run
+
+      jshint = Checks::JavaScriptJSHint.new(@directory)
+      jshint.run
+
+      jscs = Checks::JavaScriptJSCS.new(@directory)
+      jscs.run
+
+      @status = [ruby.status, jshint.status, jscs.status].find { |status| status > 0 } || 0
+    end
+  end
+end

data/lib/phare/checks/javascript_jscs.rb

@@ -7,25 +7,35 @@ module Phare
         @config = File.expand_path("#{directory}.jscs.json", __FILE__)
         @path = File.expand_path("#{directory}app/assets", __FILE__)
         @command = "jscs #{@path}"
-
-        puts '---------------------------------------------'
-        puts 'Running JSCS to check for JavaScript style…'
-        puts '---------------------------------------------'
       end
 
       def run
-        if File.exists?(@config)
+        if should_run?
+          print_banner
           system(@command)
           @status = $CHILD_STATUS.exitstatus
 
           unless @status == 0
             puts "Something went wrong. Program exited with #{@status}"
           end
+
+          puts ''
         else
-          puts 'No `.jscs.json` configuration file found. Skipping it.'
           @status = 0
         end
       end
+
+    protected
+
+      def should_run?
+        !`which jscs`.empty? && File.exists?(@config)
+      end
+
+      def print_banner
+        puts '---------------------------------------------'
+        puts 'Running JSCS to check for JavaScript style…'
+        puts '---------------------------------------------'
+      end
     end
   end
 end

data/lib/phare/checks/javascript_jshint.rb

@@ -7,14 +7,10 @@ module Phare
         @config = File.expand_path("#{directory}.jshintrc", __FILE__)
         @path = File.expand_path("#{directory}app/assets/javascripts/**/*", __FILE__)
         @command = "jshint --config #{@config} --extra-ext .js,.es6.js #{@path}"
-
-        puts '---------------------------------------------'
-        puts 'Running JSHint to check for JavaScript style…'
-        puts '---------------------------------------------'
       end
 
       def run
-        if File.exists?(@config)
+        if should_run?
           system(@command)
           @status = $CHILD_STATUS.exitstatus
 
@@ -23,11 +19,24 @@ module Phare
           else
             puts "Something went wrong. Program exited with #{@status}"
           end
+
+          puts ''
         else
-          puts 'No `.jshintrc` configuration file found. Skipping it.'
           @status = 0
         end
       end
+
+    protected
+
+      def should_run?
+        !`which jshint`.empty? && File.exists?(@config)
+      end
+
+      def print_banner
+        puts '---------------------------------------------'
+        puts 'Running JSHint to check for JavaScript style…'
+        puts '---------------------------------------------'
+      end
     end
   end
 end

data/lib/phare/checks/ruby_rubocop.rb

@@ -5,20 +5,35 @@ module Phare
 
       def initialize
         @command = 'bundle exec rubocop'
-
-        puts '----------------------------------------'
-        puts 'Running Rubocop to check for Ruby style…'
-        puts '----------------------------------------'
       end
 
       def run
-        system(@command)
-        @status = $CHILD_STATUS.exitstatus
+        if should_run?
+          print_banner
+          system(@command)
+          @status = $CHILD_STATUS.exitstatus
 
-        unless @status == 0
-          puts "Something went wrong. Program exited with #{@status}"
+          unless @status == 0
+            puts "Something went wrong. Program exited with #{@status}"
+          end
+
+          puts ''
+        else
+          @status = 0
         end
       end
+
+    protected
+
+      def should_run?
+        !`which rubocop`.empty?
+      end
+
+      def print_banner
+        puts '----------------------------------------'
+        puts 'Running Rubocop to check for Ruby style…'
+        puts '----------------------------------------'
+      end
     end
   end
 end

data/lib/phare/cli.rb

@@ -1,29 +1,27 @@
-require 'English'
-
 module Phare
   class CLI
-    attr_reader :status
-
-    def initialize(directory)
-      @directory = directory
-      @directory << '/' unless @directory.end_with?('/')
-    end
-
-    def run
-      ruby = Checks::RubyRubocop.new
-      ruby.run
-
-      puts ''
-
-      jshint = Checks::JavaScriptJSHint.new(@directory)
-      jshint.run
-
-      puts ''
-
-      jscs = Checks::JavaScriptJSCS.new(@directory)
-      jscs.run
-
-      @status = [ruby.status, jshint.status, jscs.status].find { |status| status > 0 } || 0
+    def initialize(env)
+      if env['SKIP_CODE_CHECK']
+        puts '--------------------------------------------------------'
+        puts 'Skipping code style checking… Really? Well alright then…'
+        puts '--------------------------------------------------------'
+
+        exit 0
+      else
+        if Phare::Check.new(Dir.getwd).tap { |c| c.run }.status == 0
+          puts '------------------------------------------'
+          puts 'Everything looks good, keep on committing!'
+          puts '------------------------------------------'
+
+          exit 0
+        else
+          puts '------------------------------------------------------------------------'
+          puts 'Something’s wrong with your code style. Please fix it before committing.'
+          puts '------------------------------------------------------------------------'
+
+          exit 1
+        end
+      end
     end
   end
 end

data/lib/phare/version.rb

@@ -1,3 +1,3 @@
 module Phare
-  VERSION = '0.1'
+  VERSION = '0.1.1'
 end

data/lib/phare.rb

@@ -1,10 +1,9 @@
+require 'English'
 require 'phare/version'
 
 require 'phare/cli'
+require 'phare/check'
 
 require 'phare/checks/ruby_rubocop'
 require 'phare/checks/javascript_jshint'
 require 'phare/checks/javascript_jscs'
-
-module Phare
-end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: phare
 version: !ruby/object:Gem::Version
-  version: '0.1'
+  version: 0.1.1
 platform: ruby
 authors:
 - Rémi Prévost
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-02-25 00:00:00.000000000 Z
+date: 2014-02-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -61,11 +61,13 @@ extensions: []
 extra_rdoc_files: []
 files:
 - .gitignore
+- .rubocop.yml
 - Gemfile
 - README.md
 - Rakefile
 - bin/phare
 - lib/phare.rb
+- lib/phare/check.rb
 - lib/phare/checks/javascript_jscs.rb
 - lib/phare/checks/javascript_jshint.rb
 - lib/phare/checks/ruby_rubocop.rb
@@ -97,4 +99,3 @@ signing_key:
 specification_version: 4
 summary: ''
 test_files: []
-has_rdoc: