coffeelint 1.8.1 → 1.9.1

data/lib/coffeelint.rb

@@ -1,8 +1,8 @@
 require "coffeelint/version"
+require 'coffeelint/config'
 require 'coffeelint/cmd'
 require 'execjs'
 require 'coffee-script'
-require 'json'
 
 module Coffeelint
   require 'coffeelint/railtie' if defined?(Rails::Railtie)
@@ -44,10 +44,8 @@ module Coffeelint
   end
 
   def self.lint(script, config = {})
-    if !config[:config_file].nil?
-      fname = config.delete(:config_file)
-      config.merge!(JSON.parse(File.read(fname)))
-    end
+    fname = config.fetch(:config_file, CoffeeLint::Config.locate)
+    config.merge!(CoffeeLint::Config.parse(fname)) unless fname.nil?
     Coffeelint.context.call('window.coffeelint.lint', script, config)
   end
 

data/lib/coffeelint/config.rb

@@ -0,0 +1,42 @@
+require 'json'
+
+module CoffeeLint
+  class Config
+    # Looks for existing config files and returns the first match.
+    def self.locate
+      locations = default_locations
+
+      # handle environment variables
+      locations.push(ENV['COFFEELINT_CONFIG']) if ENV['COFFEELINT_CONFIG']
+      locations.concat(config_files_in_path(ENV['HOME'])) if ENV['HOME']
+
+      locations.compact.detect { |file| File.exists?(file) }
+    end
+
+    # Parses a given JSON file to a Hash.
+    def self.parse(file_name)
+      JSON.parse(File.read(file_name))
+    end
+
+    # Config files CoffeeLint will look for.
+    def self.default_locations
+      config_files + config_files_in_path('config')
+    end
+    private_class_method :default_locations
+
+    # Maps config file names in given path/directory.
+    def self.config_files_in_path(path)
+      config_files.map { |file| File.join([*path, file].compact.reject(&:empty?)) }
+    end
+    private_class_method :config_files_in_path
+
+    # Config file names CoffeeLint will look for.
+    def self.config_files
+      %w(
+        coffeelint.json
+        .coffeelint.json
+      )
+    end
+    private_class_method :config_files
+  end
+end

data/lib/coffeelint/version.rb

@@ -1,3 +1,3 @@
 module Coffeelint
-  VERSION = "1.8.1"
+  VERSION = "1.9.1"
 end

data/lib/tasks/coffeelint.rake

@@ -1,17 +1,5 @@
 desc "lint application javascript"
 task :coffeelint do
-  conf = {}
-
-  config_file = [].tap {|files|
-    files << ENV['COFFEELNT_CONFIG'] if ENV['COFFEELENT_CONFIG']
-    files << 'config/coffeelint.json'
-    if ENV['HOME']
-      files << "#{ENV['HOME']}/coffeelint.json"
-      files << "#{ENV['HOME']}/.coffeelint.json"
-    end
-  }.compact.detect {|file| File.exists?(file) }
-
-  conf[:config_file] = config_file if config_file
-  success = Coffeelint.run_test_suite('app', conf) and Coffeelint.run_test_suite('spec', conf)
+  success = Coffeelint.run_test_suite('app') and Coffeelint.run_test_suite('spec')
   fail "Lint!" unless success
 end

data/spec/assets/.coffeelint.json

@@ -0,0 +1,5 @@
+{
+  "max_line_length": {
+    "value": 120
+  }
+}

data/spec/config_spec.rb

@@ -0,0 +1,64 @@
+require 'spec_helper'
+
+module CoffeeLint
+  describe Config do
+    describe '.locate' do
+      before(:each) { allow(File).to receive(:exists?) { false } }
+
+      it 'returns nil if no config file could be located' do
+        expect(Config.locate).to eq(nil)
+      end
+
+      context 'default locations' do
+        %w(coffeelint.json .coffeelint.json config/coffeelint.json config/.coffeelint.json).each do |config_file|
+          it "tries to locate #{config_file}" do
+            allow(File).to receive(:exists?).with(config_file).and_return(true)
+            expect(Config.locate).to eq(config_file)
+          end
+        end
+      end
+
+      context 'environment variables' do
+        it 'tries to locate ENV[\'COFFEELINT_CONFIG\']' do
+          ENV['COFFEELINT_CONFIG'] = 'coffeelint.json'
+
+          allow(File).to receive(:exists?).with('coffeelint.json').and_return(true)
+          expect(Config.locate).to eq('coffeelint.json')
+        end
+
+        it 'tries to locate config files in ENV[\'HOME\']' do
+          ENV['HOME'] = '~/coffeescript'
+
+          allow(File).to receive(:exists?).with('~/coffeescript/.coffeelint.json').and_return(true)
+          expect(Config.locate).to eq('~/coffeescript/.coffeelint.json')
+        end
+      end
+    end
+
+    describe '.parse' do
+      it 'should parse a given JSON file' do
+        expect(Config.parse(File.join(File.dirname(__FILE__), 'assets/.coffeelint.json'))).
+          to eq({"max_line_length" => {"value" => 120}})
+      end
+    end
+
+    context 'private class methods' do
+      describe '.config_files_in_path' do
+        it 'ignores empty path segments' do
+          result = %w(coffeelint.json .coffeelint.json)
+          expect(Config.send(:config_files_in_path, '')).to eq(result)
+          expect(Config.send(:config_files_in_path, [])).to eq(result)
+          expect(Config.send(:config_files_in_path, [''])).to eq(result)
+        end
+
+        it 'builds usefull path segements' do
+          result = %w(config/coffeelint.json config/.coffeelint.json)
+          expect(Config.send(:config_files_in_path, 'config')).to eq(result)
+          expect(Config.send(:config_files_in_path, ['config'])).to eq(result)
+          expect(Config.send(:config_files_in_path, ['coffeescript', 'config'])).
+            to eq(%w(coffeescript/config/coffeelint.json coffeescript/config/.coffeelint.json))
+        end
+      end
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: coffeelint
 version: !ruby/object:Gem::Version
-  version: 1.8.1
+  version: 1.9.1
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-01-29 00:00:00.000000000 Z
+date: 2015-02-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: coffee-script
@@ -111,10 +111,13 @@ files:
 - coffeelint.gemspec
 - lib/coffeelint.rb
 - lib/coffeelint/cmd.rb
+- lib/coffeelint/config.rb
 - lib/coffeelint/railtie.rb
 - lib/coffeelint/version.rb
 - lib/tasks/coffeelint.rake
+- spec/assets/.coffeelint.json
 - spec/coffeelint_spec.rb
+- spec/config_spec.rb
 - spec/spec_helper.rb
 - coffeelint/lib/coffeelint.js
 homepage: https://github.com/zipcodeman/coffeelint-ruby
@@ -143,5 +146,7 @@ signing_key:
 specification_version: 3
 summary: Ruby bindings for coffeelint along with railtie to add rake task to rails
 test_files:
+- spec/assets/.coffeelint.json
 - spec/coffeelint_spec.rb
+- spec/config_spec.rb
 - spec/spec_helper.rb