lint_trap 0.0.8 → 0.0.9

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 05684bf565de4f670e2d5d385585eccc4f973825
-  data.tar.gz: b77841570b01e04382e724e1c67663972fb533b0
+  metadata.gz: 7f171a483bce815192fe84c70780c8ad31dd7162
+  data.tar.gz: cbb5e42420f0cd7ca00cc588d2abf268b35a00f3
 SHA512:
-  metadata.gz: 34d87142a75679ff066cada80c3ce7100c3e90a72d5dcb9fcde929b6e4acb16e63b68684ac2459b38bd2c18f37824c5e2b93017a23098c1002c932bc79874b72
-  data.tar.gz: 6dc8ad9c4aa3031f507cb0b2967b31af1e7fe6f8b86cf244e9a04e335866768beb1a2c86d6b19948a0dc45aecdbd6c60d568875065390cd7c845017207076c3d
+  metadata.gz: 2e33c63d67abec9904c004a1652e4ec2f34040bd5c3ecaed38a419c67ae9c4e71c6bf64eec6d13131309530d4cb99a628dbc6452e97b1be18aae707908d502e4
+  data.tar.gz: 03050267d12f19b005d4551209e4a343059e4e7d7b00e806359c69d81fd5001e0a63fe7dc8749378daf5271b5e1543d9025289759d1bc20c4d38b9676ead9f12

data/Rakefile

@@ -19,34 +19,83 @@ task :credentials do
 end
 
 namespace :docker do
-  DockerError = Class.new(StandardError)
+  module Docker
+    DOCKER_CACHE_PATH = File.expand_path('~/.docker')
+    DOCKER_IMAGE_PATH = File.join(DOCKER_CACHE_PATH, 'image.tar')
+    IMAGE_NAME = 'lintci/spin_cycle'
 
-  def fail_on_error
-    return if $? == 0
+    BuildError = Class.new(StandardError)
 
-    raise DockerError, 'There was a problem executing the command.'
-  end
 
-  def sha
-    ENV['CIRCLE_SHA1'] ? ENV['CIRCLE_SHA1'] : ENV['SHA']
-  end
+    def tag
+      run("docker tag -f #{image_sha} #{image_latest}")
+      run("docker tag -f #{image_sha} #{image_version}")
+    end
 
-  task :tag do
-    require_relative 'lib/lint_trap/version'
+    def pull
+      run("docker pull #{image_latest}")
+    end
 
-    system("docker tag -f lintci/spin_cycle:#{sha} lintci/spin_cycle:latest") or fail_on_error
-    system("docker tag -f lintci/spin_cycle:#{sha} lintci/spin_cycle:#{LintTrap::VERSION}") or fail_on_error
-  end
+    def load
+      if File.exist?(DOCKER_IMAGE_PATH)
+        run("docker load -i #{DOCKER_IMAGE_PATH}")
+      else
+        pull
+      end
+    end
 
-  task :build do
-    system("docker pull lintci/spin_cycle:latest") or fail_on_error
-    system("docker build -t lintci/spin_cycle:#{sha} .") or fail_on_error
-  end
+    def dump
+      require 'fileutils'
+
+      FileUtils.mkdir_p(DOCKER_CACHE_PATH)
+      run("docker save #{image_latest} > #{DOCKER_IMAGE_PATH}")
+    end
+
+    def build
+      run("docker build -t #{image_sha} .")
+    end
+
+    def push
+      run("docker login -e #{ENV['DOCKER_EMAIL']} -u #{ENV['DOCKER_USER']} -p #{ENV['DOCKER_PASSWORD']}")
+      run("docker push #{image_sha}")
+      run("docker push #{image_version}")
+      run("docker push #{image_latest}")
+    end
+
+  private
 
-  task :push do
-    system("docker login -e #{ENV['DOCKER_EMAIL']} -u #{ENV['DOCKER_USER']} -p #{ENV['DOCKER_PASSWORD']}") or fail_on_error
-    system("docker push lintci/spin_cycle:#{sha}") or fail_on_error
-    system("docker push lintci/spin_cycle:#{LintTrap::VERSION}") or fail_on_error
-    system("docker push lintci/spin_cycle:latest") or fail_on_error
+    def run(command)
+      puts command
+      system(command)
+
+      raise BuildError, 'There was a problem executing the command.' unless $? == 0
+    end
+
+    def image_sha
+      "#{IMAGE_NAME}:#{sha}"
+    end
+
+    def image_version
+      require_relative 'lib/lint_trap/version'
+
+      "#{IMAGE_NAME}:#{LintTrap::VERSION}"
+    end
+
+    def image_latest
+      "#{IMAGE_NAME}:latest"
+    end
+
+    def sha
+      sha = ENV['CIRCLE_SHA1'] ? ENV['CIRCLE_SHA1'] : `git rev-parse HEAD`.strip
+    end
   end
+
+  include Docker
+
+  task(:tag){tag}
+  task(:pull){pull}
+  task(:load){load}
+  task(:dump){dump}
+  task(:build){build}
+  task(:push){push}
 end

data/circle.yml

@@ -8,12 +8,18 @@ checkout:
     - git config --global user.email "circleci@lintci.com"
     - git config --global user.name "LintCI's CircleCI Bot"
 dependencies:
+  cache_directories:
+    - "~/.docker"
   post:
-    - bundle exec rake docker:build docker:tag
+    - bundle exec rake docker:pull
+    - bundle exec rake docker:build
+    - bundle exec rake docker:tag
 deployment:
   master:
     branch: master
     commands:
-      - bundle exec rake credentials release docker:push
+      - bundle exec rake credentials
+      - bundle exec rake release
+      - bundle exec rake docker:push
 
 

data/lib/lint_trap/language/base.rb

@@ -6,13 +6,17 @@ module LintTrap
         self.class.name.split('::').last
       end
 
-      def linters
-        raise NotImplementedError, 'Must define what linters this language supports.'
+      def linters(*classes)
+        classes.map(&:new)
       end
 
       def ==(other)
         name == other.name
       end
+
+      def inspect
+        "<#{name}>"
+      end
     end
   end
 end

data/lib/lint_trap/language/coffeescript.rb

@@ -6,7 +6,7 @@ module LintTrap
     # CoffeeScript
     class CoffeeScript < Base
       def linters
-        [Linter::CoffeeLint].map(&:new)
+        super(Linter::CoffeeLint)
       end
     end
   end

data/lib/lint_trap/language/cpp.rb

@@ -10,7 +10,7 @@ module LintTrap
       end
 
       def linters
-        [Linter::CPPCheck].map(&:new)
+        super(Linter::CPPCheck)
       end
     end
   end

data/lib/lint_trap/language/css.rb

@@ -6,7 +6,7 @@ module LintTrap
     # CSS
     class CSS < Base
       def linters
-        [Linter::CSSLint].map(&:new)
+        super(Linter::CSSLint)
       end
     end
   end

data/lib/lint_trap/language/go.rb

@@ -6,7 +6,7 @@ module LintTrap
     # Go
     class Go < Base
       def linters
-        [Linter::GoLint].map(&:new)
+        super(Linter::GoLint)
       end
     end
   end

data/lib/lint_trap/language/java.rb

@@ -6,7 +6,7 @@ module LintTrap
     # Java
     class Java < Base
       def linters
-        [Linter::CheckStyle].map(&:new)
+        super(Linter::CheckStyle)
       end
     end
   end

data/lib/lint_trap/language/javascript.rb

@@ -6,7 +6,7 @@ module LintTrap
     # JavaScript
     class JavaScript < Base
       def linters
-        [Linter::JSHint].map(&:new)
+        super(Linter::JSHint)
       end
     end
   end

data/lib/lint_trap/language/json.rb

@@ -6,7 +6,7 @@ module LintTrap
     # JSON
     class JSON < Base
       def linters
-        [Linter::JSONLint].map(&:new)
+        super(Linter::JSONLint)
       end
     end
   end

data/lib/lint_trap/language/python.rb

@@ -6,7 +6,7 @@ module LintTrap
     # Python
     class Python < Base
       def linters
-        [Linter::PyLint].map(&:new)
+        super(Linter::PyLint)
       end
     end
   end

data/lib/lint_trap/language/ruby.rb

@@ -6,7 +6,7 @@ module LintTrap
     # Ruby
     class Ruby < Base
       def linters
-        [Linter::RuboCop].map(&:new)
+        super(Linter::RuboCop)
       end
     end
   end

data/lib/lint_trap/language/scss.rb

@@ -6,7 +6,7 @@ module LintTrap
     # SCSS
     class SCSS < Base
       def linters
-        [Linter::SCSSLint].map(&:new)
+        super(Linter::SCSSLint)
       end
     end
   end

data/lib/lint_trap/linter/base.rb

@@ -21,10 +21,18 @@ module LintTrap
         self.class.name.split('::').last
       end
 
+      def languages(*classes)
+        classes.map(&:new)
+      end
+
       def ==(other)
         name == other.name
       end
 
+      def inspect
+        "<#{name}>"
+      end
+
     protected
 
       attr_reader :container, :options

data/lib/lint_trap/linter/checkstyle.rb

@@ -7,6 +7,10 @@ module LintTrap
       JAR = 'checkstyle/checkstyle_logger-all.jar'
       CHECKS_XML = 'checkstyle/sun_checks.xml'
 
+      def languages
+        super(Language::Java)
+      end
+
     private
 
       def command_name

data/lib/lint_trap/linter/coffeelint.rb

@@ -6,6 +6,10 @@ module LintTrap
     class CoffeeLint < Base
       REPORTER = 'coffeelint/lint_trap.coffee'
 
+      def languages
+        super(Language::CoffeeScript)
+      end
+
     private
 
       def flags

data/lib/lint_trap/linter/cppcheck.rb

@@ -4,6 +4,10 @@ module LintTrap
   module Linter
     # Encapsulates logic specific to cppcheck command line tool.
     class CPPCheck < Base
+      def languages
+        super(Language::CPP)
+      end
+
     private
 
       def flags

data/lib/lint_trap/linter/csslint.rb

@@ -5,6 +5,10 @@ module LintTrap
   module Linter
     # Encapsulates logic specific to csslint command line tool.
     class CSSLint < Base
+      def languages
+        super(Language::CSS)
+      end
+
     private
 
       def flags

data/lib/lint_trap/linter/golint.rb

@@ -5,6 +5,10 @@ module LintTrap
   module Linter
     # Encapsulates logic specific to golint command line tool.
     class GoLint < Base
+      def languages
+        super(Language::Go)
+      end
+
     private
 
       def flags

data/lib/lint_trap/linter/jshint.rb

@@ -6,6 +6,10 @@ module LintTrap
     class JSHint < Base
       FORMATTER = 'jshint/formatter.js'
 
+      def languages
+        super(Language::JavaScript)
+      end
+
     private
 
       def flags

data/lib/lint_trap/linter/jsonlint.rb

@@ -4,6 +4,10 @@ module LintTrap
   module Linter
     # Encapsulates logic specific to durable-json-lint command line tool.
     class JSONLint < Base
+      def languages
+        super(Language::JSON)
+      end
+
     private
 
       def command_name

data/lib/lint_trap/linter/pylint.rb

@@ -4,6 +4,10 @@ module LintTrap
   module Linter
     # Encapsulates logic specific to pylint command line tool.
     class PyLint < Base
+      def languages
+        super(Language::Python)
+      end
+
     private
 
       def flags

data/lib/lint_trap/linter/rubocop.rb

@@ -6,6 +6,10 @@ module LintTrap
     class RuboCop < Base
       FORMATTER = 'rubocop/formatter.rb'
 
+      def languages
+        super(Language::Ruby)
+      end
+
     private
 
       def flags

data/lib/lint_trap/linter/scsslint.rb

@@ -6,6 +6,10 @@ module LintTrap
     class SCSSLint < Base
       COMMAND = 'scsslint/scsslint'
 
+      def languages
+        super(Language::SCSS)
+      end
+
       def command_name
         config_path(COMMAND)
       end

data/lib/lint_trap/version.rb

@@ -1,3 +1,3 @@
 module LintTrap
-  VERSION = '0.0.8'
+  VERSION = '0.0.9'
 end

data/spec/language/coffeescript_spec.rb

@@ -3,6 +3,8 @@ require 'spec_helper'
 describe LintTrap::Language::CoffeeScript do
   subject(:language){described_class.new}
 
+  it_behaves_like 'language'
+
   its(:name){is_expected.to eq('CoffeeScript')}
   its(:linters){is_expected.to eq([LintTrap::Linter::CoffeeLint.new])}
 end

data/spec/language/cpp_spec.rb

@@ -3,6 +3,8 @@ require 'spec_helper'
 describe LintTrap::Language::CPP do
   subject(:language){described_class.new}
 
+  it_behaves_like 'language'
+
   its(:name){is_expected.to eq('C++')}
   its(:linters){is_expected.to eq([LintTrap::Linter::CPPCheck.new])}
 end

data/spec/language/css_spec.rb

@@ -3,6 +3,8 @@ require 'spec_helper'
 describe LintTrap::Language::CSS do
   subject(:language){described_class.new}
 
+  it_behaves_like 'language'
+
   its(:name){is_expected.to eq('CSS')}
   its(:linters){is_expected.to eq([LintTrap::Linter::CSSLint.new])}
 end

data/spec/language/go_spec.rb

@@ -3,6 +3,8 @@ require 'spec_helper'
 describe LintTrap::Language::Go do
   subject(:language){described_class.new}
 
+  it_behaves_like 'language'
+
   its(:name){is_expected.to eq('Go')}
   its(:linters){is_expected.to eq([LintTrap::Linter::GoLint.new])}
 end

data/spec/language/java_spec.rb

@@ -3,6 +3,8 @@ require 'spec_helper'
 describe LintTrap::Language::Java do
   subject(:language){described_class.new}
 
+  it_behaves_like 'language'
+
   its(:name){is_expected.to eq('Java')}
   its(:linters){is_expected.to eq([LintTrap::Linter::CheckStyle.new])}
 end

data/spec/language/javascript_spec.rb

@@ -3,6 +3,8 @@ require 'spec_helper'
 describe LintTrap::Language::JavaScript do
   subject(:language){described_class.new}
 
+  it_behaves_like 'language'
+
   its(:name){is_expected.to eq('JavaScript')}
   its(:linters){is_expected.to eq([LintTrap::Linter::JSHint.new])}
 end

data/spec/language/json_spec.rb

@@ -3,6 +3,8 @@ require 'spec_helper'
 describe LintTrap::Language::JSON do
   subject(:language){described_class.new}
 
+  it_behaves_like 'language'
+
   its(:name){is_expected.to eq('JSON')}
   its(:linters){is_expected.to eq([LintTrap::Linter::JSONLint.new])}
 end

data/spec/language/python_spec.rb

@@ -3,6 +3,8 @@ require 'spec_helper'
 describe LintTrap::Language::Python do
   subject(:language){described_class.new}
 
+  it_behaves_like 'language'
+
   its(:name){is_expected.to eq('Python')}
   its(:linters){is_expected.to eq([LintTrap::Linter::PyLint.new])}
 end

data/spec/language/ruby_spec.rb

@@ -3,6 +3,8 @@ require 'spec_helper'
 describe LintTrap::Language::Ruby do
   subject(:language){described_class.new}
 
+  it_behaves_like 'language'
+
   its(:name){is_expected.to eq('Ruby')}
   its(:linters){is_expected.to eq([LintTrap::Linter::RuboCop.new])}
 end

data/spec/language/scss_spec.rb

@@ -3,6 +3,8 @@ require 'spec_helper'
 describe LintTrap::Language::SCSS do
   subject(:language){described_class.new}
 
+  it_behaves_like 'language'
+
   its(:name){is_expected.to eq('SCSS')}
   its(:linters){is_expected.to eq([LintTrap::Linter::SCSSLint.new])}
 end

data/spec/linter/checkstyle_spec.rb

@@ -4,8 +4,12 @@ describe LintTrap::Linter::CheckStyle do
   let(:container){LintTrap::Container::Fake.new}
   let(:options){{}}
   let(:files){%w(Good.java bad.java)}
-  subject(:linter){described_class.new}
   let(:command){instance_double(LintTrap::Command)}
+  subject(:linter){described_class.new}
+
+  it_behaves_like 'linter'
+
+  its(:languages){is_expected.to eq([LintTrap::Language::Java.new])}
 
   describe '#lint' do
     context 'when config is provided' do

data/spec/linter/coffeelint_spec.rb

@@ -7,6 +7,10 @@ describe LintTrap::Linter::CoffeeLint do
   subject(:linter){described_class.new}
   let(:command){instance_double(LintTrap::Command)}
 
+  it_behaves_like 'linter'
+
+  its(:languages){is_expected.to eq([LintTrap::Language::CoffeeScript.new])}
+
   describe '#lint' do
     context 'when config is provided' do
       let(:options){{config: 'coffeelint.json'}}

data/spec/linter/cppcheck_spec.rb

@@ -7,6 +7,10 @@ describe LintTrap::Linter::CPPCheck do
   subject(:linter){described_class.new}
   let(:command){instance_double(LintTrap::Command)}
 
+  it_behaves_like 'linter'
+
+  its(:languages){is_expected.to eq([LintTrap::Language::CPP.new])}
+
   describe '#lint' do
     it 'runs the lint command with the correct arguments' do
       expect(LintTrap::Command).to receive(:new).with(

data/spec/linter/csslint_spec.rb

@@ -7,6 +7,10 @@ describe LintTrap::Linter::CSSLint do
   subject(:linter){described_class.new}
   let(:command){instance_double(LintTrap::Command)}
 
+  it_behaves_like 'linter'
+
+  its(:languages){is_expected.to eq([LintTrap::Language::CSS.new])}
+
   describe '#lint' do
     context 'when config is provided' do
       let(:options){{config: '.csslintrc'}}

data/spec/linter/golint_spec.rb

@@ -7,6 +7,10 @@ describe LintTrap::Linter::GoLint do
   subject(:linter){described_class.new}
   let(:command){instance_double(LintTrap::Command)}
 
+  it_behaves_like 'linter'
+
+  its(:languages){is_expected.to eq([LintTrap::Language::Go.new])}
+
   describe '#lint' do
     it 'runs the lint command with the correct arguments' do
       expect(LintTrap::Command).to receive(:new).with(

data/spec/linter/jshint_spec.rb

@@ -7,6 +7,10 @@ describe LintTrap::Linter::JSHint do
   subject(:linter){described_class.new}
   let(:command){instance_double(LintTrap::Command)}
 
+  it_behaves_like 'linter'
+
+  its(:languages){is_expected.to eq([LintTrap::Language::JavaScript.new])}
+
   describe '#lint' do
     context 'when config is provided' do
       let(:options){{config: '.jshintrc'}}

data/spec/linter/jsonlint_spec.rb

@@ -7,6 +7,10 @@ describe LintTrap::Linter::JSONLint do
   subject(:linter){described_class.new}
   let(:command){instance_double(LintTrap::Command)}
 
+  it_behaves_like 'linter'
+
+  its(:languages){is_expected.to eq([LintTrap::Language::JSON.new])}
+
   describe '#lint' do
     it 'runs the lint command with the correct arguments' do
       expect(LintTrap::Command).to receive(:new).with(

data/spec/linter/pylint_spec.rb

@@ -7,6 +7,10 @@ describe LintTrap::Linter::PyLint do
   subject(:linter){described_class.new}
   let(:command){instance_double(LintTrap::Command)}
 
+  it_behaves_like 'linter'
+
+  its(:languages){is_expected.to eq([LintTrap::Language::Python.new])}
+
   describe '#lint' do
     context 'when config is provided' do
       let(:options){{config: '.pylintrc'}}

data/spec/linter/rubocop_spec.rb

@@ -7,6 +7,10 @@ describe LintTrap::Linter::RuboCop do
   subject(:linter){described_class.new}
   let(:command){instance_double(LintTrap::Command)}
 
+  it_behaves_like 'linter'
+
+  its(:languages){is_expected.to eq([LintTrap::Language::Ruby.new])}
+
   describe '#lint' do
     context 'when config is provided' do
       let(:options){{config: '.rubocop.yml'}}

data/spec/linter/scsslint_spec.rb

@@ -7,6 +7,10 @@ describe LintTrap::Linter::SCSSLint do
   subject(:linter){described_class.new}
   let(:command){instance_double(LintTrap::Command)}
 
+  it_behaves_like 'linter'
+
+  its(:languages){is_expected.to eq([LintTrap::Language::SCSS.new])}
+
   describe '#lint' do
     context 'when config is provided' do
       let(:options){{config: '.scss-lint.yml'}}

data/spec/spec_helper.rb

@@ -3,6 +3,8 @@ require 'rspec/its'
 require 'lint_trap'
 require 'pry'
 require_relative 'support/fixture_file_helper'
+require_relative 'support/examples/language'
+require_relative 'support/examples/linter'
 
 ENV['DEBUG_LINTING'] = ENV['CI']
 

data/spec/support/examples/language.rb

@@ -0,0 +1,12 @@
+shared_examples_for 'language' do
+  its(:linters){is_expected.to_not be_empty}
+
+  describe '#linters' do
+    it 'returns a list of linters which reference this language' do
+      language.linters.each do |linter|
+        expect(linter.languages).to include(language),
+          "expected #{linter.name} to reference #{language.name} as one of it's languages"
+      end
+    end
+  end
+end

data/spec/support/examples/linter.rb

@@ -0,0 +1,11 @@
+shared_examples_for 'linter' do
+  its(:languages){is_expected.to_not be_empty}
+
+  describe '#languages' do
+    it 'returns a list of languages which reference this linter' do
+      linter.languages.each do |language|
+        expect(language.linters).to include(linter), "expected #{language.name} to reference #{linter.name} as one of it's linters"
+      end
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: lint_trap
 version: !ruby/object:Gem::Version
-  version: 0.0.8
+  version: 0.0.9
 platform: ruby
 authors:
 - Allen Madsen
@@ -213,6 +213,8 @@ files:
 - spec/parser/standard_spec.rb
 - spec/parser/vim_quickfix_spec.rb
 - spec/spec_helper.rb
+- spec/support/examples/language.rb
+- spec/support/examples/linter.rb
 - spec/support/fixture_file_helper.rb
 homepage: https://github.com/lintci/lint_trap
 licenses:
@@ -300,4 +302,6 @@ test_files:
 - spec/parser/standard_spec.rb
 - spec/parser/vim_quickfix_spec.rb
 - spec/spec_helper.rb
+- spec/support/examples/language.rb
+- spec/support/examples/linter.rb
 - spec/support/fixture_file_helper.rb