guard-scss_lint 0.1.0

data/.travis.yml

@@ -0,0 +1,10 @@
+rvm:
+- 1.9.3
+- 2.0.0
+- 2.1.0
+- 2.1.1
+- 2.1.2
+- 2.2.3
+script:
+- bundle exec rspec
+- bundle exec rubocop

data/Gemfile

@@ -0,0 +1,10 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in guard-scss-lint.gemspec
+gemspec
+
+group :test do
+  gem 'coveralls'
+  gem 'simplecov-rcov'
+  gem 'ci_reporter'
+end

data/Guardfile

@@ -0,0 +1,10 @@
+guard :rspec, cmd: "bundle exec rspec" do
+  watch(%r{^spec/.+_spec\.rb$})
+  watch(%r{^lib/(.+)\.rb$})     { |m| "spec/lib/#{m[1]}_spec.rb" }
+  watch('spec/spec_helper.rb')  { "spec" }
+end
+
+guard :rubocop do
+  watch(%r{.+\.rb$})
+  watch(%r{(?:.+/)?\.rubocop\.yml$}) { |m| File.dirname(m[0]) }
+end

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Chris Rohr
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/README.md

@@ -0,0 +1,77 @@
+[![Gem Version](http://img.shields.io/gem/v/guard-scss_lint.svg)](http://badge.fury.io/rb/guard-scss_lint)
+[![Dependency Status](http://img.shields.io/gemnasium/chrisrohr/guard-scss_lint.svg)](https://gemnasium.com/chrisrohr/guard-scss_lint)
+[![Build Status](https://travis-ci.org/chrisrohr/guard-scss_lint.svg?branch=master)](https://travis-ci.org/chrisrohr/guard-scss_lint)
+[![Coverage Status](http://img.shields.io/coveralls/chrisrohr/guard-scss_lint/master.svg)](https://coveralls.io/r/chrisrohr/guard-scss_lint)
+[![Code Climate](http://img.shields.io/codeclimate/github/chrisrohr/guard-scss_lint.svg)](https://codeclimate.com/github/chrisrohr/guard-scss_lint)
+
+# guard-scss_lint
+
+A guard to lint your SCSS.
+
+This guard plugin is a fork of the originally created [guard-scss-lint](https://github.com/chrislopresto/guard-scss-lint) plugin by Chris LoPresto.  This version has been modified to conform to the ruby gems naming standard as well as supports the latest versions of Scss Lint.
+
+## Installation
+
+Please make sure you have [Guard](https://github.com/guard/guard) installed before continue.
+
+Add `guard-scss_lint` to your `Gemfile`:
+
+```ruby
+group :development do
+  gem 'guard-scss_lint'
+end
+```
+
+and then execute:
+
+```sh
+$ bundle install
+```
+
+or install it yourself as:
+
+```sh
+$ gem install guard-scss_lint
+```
+
+Add the default Guard::ScssLint definition to your `Guardfile` by running:
+
+```sh
+$ guard init scss_lint
+```
+
+## Usage
+
+Please read the [Guard usage documentation](https://github.com/guard/guard#readme).
+
+## Options
+
+You can pass some options in `Guardfile` like the following example:
+
+```ruby
+guard :scss_lint, all_on_start: false, config: '.custom-scss-lint.yml' do
+  # ...
+end
+```
+
+### Available Options
+
+```ruby
+all_on_start: true    # Check all files at Guard startup.
+                      #  default: true
+config: 'filename'    # Location of custom scss lint configuration file.
+                      #  default: nil (Uses .scss-lint.yml file or SCSSLint defaults)
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request
+
+## License
+
+Copyright (c) 2015 Chris Rohr
+
+See the [LICENSE](LICENSE) for details.

data/Rakefile

@@ -0,0 +1 @@
+require 'bundler/gem_tasks'

data/guard-scss_lint.gemspec

@@ -0,0 +1,34 @@
+# encoding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'guard/scss_lint/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'guard-scss_lint'
+  spec.version       = Guard::ScssLintVersion::VERSION
+  spec.authors       = ['Chris Rohr']
+  spec.email         = ['rohr.chris@gmail.com']
+  spec.summary       = %q{Guard plugin for scss_lint}
+  spec.description   = %q{A Guard plugin to lint your .scss files using scss_lint. SCSS Lint changed from scss-lint to scss_lint and this is the guard update for that.}
+  spec.homepage      = 'https://github.com/chrisrohr/guard-scss_lint'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^spec/})
+  spec.require_path  = 'lib'
+
+  # spec.add_dependency 'guard', '~> 2.2'
+  spec.add_dependency 'guard-compat', '~> 1.1'
+  spec.add_dependency 'scss_lint', '~> 0.42.0'
+
+  spec.add_development_dependency 'bundler'
+  spec.add_development_dependency 'rake'
+  spec.add_development_dependency 'rspec'
+  spec.add_development_dependency 'simplecov'
+  spec.add_development_dependency 'rubocop'
+  spec.add_development_dependency 'pry'
+  spec.add_development_dependency 'pry-nav'
+  spec.add_development_dependency 'guard-rspec'
+  spec.add_development_dependency 'guard-rubocop'
+end

data/lib/guard/scss_lint/templates/Guardfile

@@ -0,0 +1,3 @@
+guard 'scss-lint' do
+  watch(%r{^app/assets/stylesheets/.+.scss})
+end

data/lib/guard/scss_lint/version.rb

@@ -0,0 +1,5 @@
+module Guard
+  class ScssLintVersion
+    VERSION = '0.1.0'
+  end
+end

data/lib/guard/scss_lint.rb

@@ -0,0 +1,83 @@
+require 'guard/compat/plugin'
+require 'scss_lint'
+
+require 'rainbow'
+require 'rainbow/ext/string'
+
+module Guard
+  class ScssLint < Plugin
+
+    attr_reader :options, :config
+
+    def initialize(options = {})
+      super
+
+      @options = {
+        all_on_start: true
+      }.merge(options)
+
+      config_file = @options[:config] || '.scss-lint.yml'
+      if File.exist?(config_file)
+        @config = SCSSLint::Config.load config_file
+      else
+        @config = SCSSLint::Config.default
+      end
+
+      @scss_lint_runner = SCSSLint::Runner.new @config
+      @failed_paths     = []
+    end
+
+    def start
+      Guard::Compat::UI.info "Guard::ScssLint (SCSSLint version #{SCSSLint::VERSION}) is running"
+      run_all if @options[:all_on_start]
+    end
+
+    def reload
+    end
+
+    def run_all
+      Guard::Compat::UI.info 'Running ScssLint for all .scss files'
+      pattern = File.join '**', '*.scss'
+      paths   = Guard::Compat.matching_files(self, Dir.glob(pattern))
+      run_on_changes paths
+    end
+
+    def run_on_changes(paths)
+      run paths.uniq
+    end
+
+    private
+
+    def run(paths = [])
+      @scss_lint_runner = SCSSLint::Runner.new @config
+      paths = paths.reject { |p| @config.excluded_file?(p) }
+      @scss_lint_runner.run paths
+      @scss_lint_runner.lints.each do |lint|
+        Guard::Compat::UI.send lint.severity, lint_message(lint)
+      end
+      Guard::Compat::UI.info "Guard::ScssLint inspected #{paths.size} files, found #{@scss_lint_runner.lints.count} errors."
+      Guard::Compat::UI.notify("#{@scss_lint_runner.lints.count} errors found", title: "Guard ScssLint issues found") if @scss_lint_runner.lints.count > 0
+    end
+
+    def lint_message(lint)
+      [lint.filename.color(:cyan),
+       ':',
+       lint.location.line.to_s.color(:magenta),
+       ':',
+       lint.location.column.to_s.color(:blue),
+       ' ',
+       lint_severity_abbrevation(lint),
+       ' ',
+       lint.linter.name.color(:green),
+       ':'.color(:green),
+       ' ',
+       lint.description
+      ].join
+    end
+
+    def lint_severity_abbrevation(lint)
+      color = lint.severity == :error ? :red : :yellow
+      ['[', lint.severity.to_s[0].upcase, ']'].join.color(color)
+    end
+  end
+end

data/spec/configs/test-config-1.yml

@@ -0,0 +1,3 @@
+linters:
+  PlaceholderInExtend:
+    enabled: false

data/spec/configs/test-config-2.yml

@@ -0,0 +1,7 @@
+scss_files: '../resources/**/*.scss'
+
+exclude: '../resources/invalid/**'
+
+linters:
+  PlaceholderInExtend:
+    enabled: false

data/spec/guard/scss_lint_spec.rb

@@ -0,0 +1,117 @@
+require 'spec_helper'
+require 'guard/scss_lint'
+require 'scss_lint'
+
+describe Guard::ScssLint, exclude_stubs: [Guard::Plugin] do
+  let(:options) { {} }
+  subject(:guard) { Guard::ScssLint.new(options) }
+
+  before do
+    meths = %w(info warning error deprecation debug notify color color_enabled?)
+    meths.each do |type|
+      allow(Guard::Compat::UI).to receive(type.to_sym)
+    end
+  end
+
+  describe '#options' do
+    subject { super().options }
+
+    context 'by default' do
+      let(:options) { {} }
+
+      describe '[:all_on_start]' do
+        subject { super()[:all_on_start] }
+        it { should be_truthy }
+      end
+
+      describe '[:keep_failed]' do
+        subject { super()[:keep_failed] }
+        it { should be_falsy }
+      end
+
+      describe '[:config]' do
+        subject { super()[:config] }
+        it 'uses default config from SCSS Lint' do
+          expect(guard.config).to eq(SCSSLint::Config.default)
+        end
+      end
+    end
+
+    context 'passed in config file' do
+      let(:options) { { config: File.join(Dir.pwd, 'spec', 'configs', 'test-config-2.yml') } }
+
+      describe '[:config]' do
+        subject { super()[:config] }
+        it 'uses customized config' do
+          expect(guard.config).not_to eq(SCSSLint::Config.default)
+        end
+      end
+    end
+  end
+
+  describe '#start' do
+    context 'when :all_on_start option is enabled' do
+      let(:options) { { all_on_start: true } }
+
+      it 'runs all' do
+        expect(guard).to receive(:run_all)
+        guard.start
+        expect(Guard::Compat::UI).to have_received(:info).with("Guard::ScssLint (SCSSLint version #{SCSSLint::VERSION}) is running")
+      end
+    end
+
+    context 'when :all_on_start option is disabled' do
+      let(:options) { { all_on_start: false } }
+
+      it 'does nothing' do
+        expect(guard).not_to receive(:run_all)
+        guard.start
+        expect(Guard::Compat::UI).to have_received(:info).with("Guard::ScssLint (SCSSLint version #{SCSSLint::VERSION}) is running")
+      end
+    end
+  end
+
+  shared_examples 'processes after running', :processes_after_running do
+    context 'when passes' do
+      it 'prints status message with zero errors' do
+        allow_any_instance_of(SCSSLint::Runner).to receive(:run).and_return(true)
+        subject
+        expect(Guard::Compat::UI).to have_received(:info).with("Guard::ScssLint inspected 1 files, found 0 errors.")
+      end
+
+      it 'does not notify of errors' do
+        allow_any_instance_of(SCSSLint::Runner).to receive(:run).and_return(true)
+        allow_any_instance_of(SCSSLint::Runner).to receive(:failed_paths).and_return([])
+        subject
+        expect(Guard::Compat::UI).not_to have_received(:notify)
+      end
+    end
+
+    context 'when failed' do
+      it 'prints and notifies status message with non-zero errors' do
+        allow_any_instance_of(SCSSLint::Runner).to receive(:run).and_return(false)
+        allow_any_instance_of(SCSSLint::Runner).to receive(:lints).and_return([
+          SCSSLint::Lint.new(SCSSLint::Linter::PropertySortOrder.new, 'a.scss', SCSSLint::Location.new, 'wrong order')
+        ])
+        subject
+        expect(Guard::Compat::UI).to have_received(:info).with("Guard::ScssLint inspected 1 files, found 1 errors.")
+        expect(Guard::Compat::UI).to have_received(:notify).with("1 errors found", title: "Guard ScssLint issues found")
+      end
+    end
+  end
+
+  describe '#run_all', :processes_after_running do
+    subject { super().run_all }
+
+    before do
+      allow(Guard::Compat).to receive(:matching_files).and_return(['a.scss'])
+      allow_any_instance_of(SCSSLint::Runner).to receive(:run).and_return(true)
+      allow_any_instance_of(SCSSLint::Runner).to receive(:failed_paths).and_return([])
+    end
+
+    it 'inspects all scss files with scss lint' do
+      expect_any_instance_of(SCSSLint::Runner).to receive(:run).with(['a.scss'])
+      guard.run_all
+    end
+  end
+end

data/spec/resources/invalid/invalid.scss

@@ -0,0 +1,5 @@
+main {
+  padding-bottom: 80px;
+  width: 100%;
+  margin-top: 51px;
+}

data/spec/resources/valid/valid.scss

@@ -0,0 +1,5 @@
+main {
+  margin-top: 51px;
+  padding-bottom: 80px;
+  width: 100%;
+}

data/spec/spec_helper.rb

@@ -0,0 +1,28 @@
+require 'pry'
+require 'guard/compat/test/helper'
+
+RSpec.configure do |config|
+  config.expect_with :rspec do |c|
+    c.syntax = :expect
+  end
+
+  config.mock_with :rspec do |c|
+    c.syntax = :expect
+  end
+end
+
+require 'simplecov'
+SimpleCov.coverage_dir(File.join('spec', 'coverage'))
+
+if ENV['TRAVIS']
+  require 'coveralls'
+  SimpleCov.formatter = Coveralls::SimpleCov::Formatter
+elsif ENV['CI']
+  require 'simplecov-rcov'
+  SimpleCov.formatter = SimpleCov::Formatter::RcovFormatter
+end
+
+SimpleCov.start do
+  add_filter '/spec/'
+  add_filter '/vendor/bundle/'
+end

metadata

@@ -0,0 +1,225 @@
+--- !ruby/object:Gem::Specification
+name: guard-scss_lint
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Chris Rohr
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-10-11 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: guard-compat
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+- !ruby/object:Gem::Dependency
+  name: scss_lint
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.42.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.42.0
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry-nav
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: guard-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: guard-rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: A Guard plugin to lint your .scss files using scss_lint. SCSS Lint changed
+  from scss-lint to scss_lint and this is the guard update for that.
+email:
+- rohr.chris@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".coveralls.yml"
+- ".editorconfig"
+- ".gitignore"
+- ".rubocop.yml"
+- ".travis.yml"
+- Gemfile
+- Guardfile
+- LICENSE
+- README.md
+- Rakefile
+- guard-scss_lint.gemspec
+- lib/guard/scss_lint.rb
+- lib/guard/scss_lint/templates/Guardfile
+- lib/guard/scss_lint/version.rb
+- spec/configs/test-config-1.yml
+- spec/configs/test-config-2.yml
+- spec/guard/scss_lint_spec.rb
+- spec/resources/invalid/invalid.scss
+- spec/resources/valid/valid.scss
+- spec/spec_helper.rb
+homepage: https://github.com/chrisrohr/guard-scss_lint
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.5
+signing_key: 
+specification_version: 4
+summary: Guard plugin for scss_lint
+test_files:
+- spec/configs/test-config-1.yml
+- spec/configs/test-config-2.yml
+- spec/guard/scss_lint_spec.rb
+- spec/resources/invalid/invalid.scss
+- spec/resources/valid/valid.scss
+- spec/spec_helper.rb