guard-scss-lint 0.0.1alpha

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 600702aa7cc75cac7231d2e55a29036f93800a7b
+  data.tar.gz: 3c01059f27f088d790ca57e65293f5a1801ecd40
+SHA512:
+  metadata.gz: 242584fd1aae0967d7ff87878b474414712909b6b158357c1d46ff205b24a0d893e30c24243e1ce327ac4427aa0b215d3a82c6062a697a02e7436fc1a94394cc
+  data.tar.gz: 310ab0dc06d49efc0759f5674914be1100cef36d7cda12188a656bbfc5c5f5a3eb9932a85413720b91856e51a7e0cf84e424cf342b0df1fd4736fb3c100a22d4

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+pkg/
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+rdoc
+spec/reports
+test
+tmp
+vendor/bundle

data/.rubocop.yml

@@ -0,0 +1,57 @@
+Style/Documentation:
+  Enabled: false
+
+Style/CollectionMethods:
+  Enabled: false
+
+Style/EachWithObject:
+  Enabled: false
+
+Style/StringLiterals:
+  Enabled: false
+
+Style/SignalException:
+  Enabled: false
+
+Style/TrailingComma:
+  EnforcedStyleForMultiline: no_comma
+
+Style/AlignHash:
+  EnforcedLastArgumentHashStyle: ignore_implicit
+
+Style/AlignParameters:
+  EnforcedStyle: with_fixed_indentation
+
+Style/CaseIndentation:
+  IndentOneStep: true
+
+Style/SingleLineBlockParams:
+  Enabled: false
+
+Metrics/BlockNesting:
+  Max: 2
+
+Metrics/MethodLength:
+  Max: 7
+
+Metrics/ParameterLists:
+  Max: 4
+
+Metrics/LineLength:
+  Exclude:
+    - '**/Guardfile'
+    - guard-scss-lint.gemspec
+
+Style/GlobalVars:
+  Exclude:
+    - '**/Guardfile'
+    - test/support/guard/*.rb
+
+Style/FileName:
+  Exclude:
+    - '**/scss-lint.rb'
+
+Style/RegexpLiteral:
+  Exclude:
+    - '**/Guardfile'
+    - guard-scss-lint.gemspec

data/.yardopts

@@ -0,0 +1 @@
+--markup markdown

data/Gemfile

@@ -0,0 +1,16 @@
+source 'https://rubygems.org'
+
+gemspec
+
+group :test do
+  gem 'coveralls',      '~> 0.6'
+  gem 'simplecov-rcov', '~> 0.2'
+  gem 'ci_reporter',    '~> 1.8'
+end
+
+platforms :rbx do
+  gem 'rubysl'
+  gem 'rubinius-developer_tools'
+  gem 'json'
+  gem 'racc' # Needed for RuboCop
+end

data/LICENSE.txt

@@ -0,0 +1,23 @@
+COPYRIGHT (C) 2014 ADAM EBERLIN
+COPYRIGHT (C) 2013 YUJI NAKAYAMA
+
+MIT LICENSE
+
+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,113 @@
+<!--
+[![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/arkbot/guard-scss-lint.svg)](https://gemnasium.com/arkbot/guard-scss-lint)
+[![Build Status](https://travis-ci.org/arkbot/guard-scss-lint.svg?branch=master)](https://travis-ci.org/arkbot/guard-scss-lint)
+[![Coverage Status](https://img.shields.io/coveralls/arkbot/guard-scss-lint/master.svg)](https://coveralls.io/r/arkbot/guard-scss-lint)
+[![Code Climate](http://img.shields.io/codeclimate/github/arkbot/guard-scss-lint.svg)](https://codeclimate.com/github/arkbot/guard-scss-lint)
+
+# guard-scss-lint
+
+**guard-scss-lint** automatically checks your SCSS code style with [scss-lint](https://github.com/causes/scss-lint/) when files are modified.
+
+Tested on MRI 1.9, 2.0, 2.1, JRuby in 1.9 mode and Rubinius.
+
+## Installation
+
+Please make sure to 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 scsslint
+```
+
+## 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 :scsslint, all_on_start: false do
+  # ...
+end
+```
+
+### Available Options
+
+```ruby
+all_on_start: true     # Check all files at Guard startup.
+                       #   default: true
+cli: '--some-opts'     # Pass arbitrary scss-lint CLI arguments.
+                       # An array or string is acceptable.
+                       #   default: nil
+hide_stdout: false     # Do not display console output (in case outputting to file).
+                       #   default: false
+keep_failed: true      # Keep failed files until they pass.
+                       #   default: true
+notification: :failed  # Display Growl notification after each run.
+                       #   true    - Always notify
+                       #   false   - Never notify
+                       #   :failed - Notify only when failed
+                       #   default: :failed
+```
+
+## Advanced Tips
+
+If you're using a testing Guard plugin such as [`guard-rspec`](https://github.com/guard/guard-rspec) together with `guard-scss-lint` in the TDD way (the red-green-refactor cycle),
+you might be uncomfortable with the offense reports from scss-lint in the red-green phase:
+
+In this case, you may find the following `Guardfile` structure useful:
+
+```ruby
+# This group allows to skip running scss-lint when RSpec failed.
+group :red_green_refactor, halt_on_fail: true do
+  guard :rspec do
+    # ...
+  end
+
+  guard :scsslint do
+    # ...
+  end
+end
+```
+
+## 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
+
+## MIT License
+
+See the [LICENSE.txt](LICENSE.txt) for details.
+
+## Credits
+
+Yuji Nakayama's gem [`guard-rubocop`](https://github.com/bbatsov/rubocop/) made this project possible amidst my numerous time constraints.

data/Rakefile

@@ -0,0 +1,13 @@
+# coding: utf-8
+
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+require 'rubocop/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+RuboCop::RakeTask.new(:style)
+
+desc 'Run RSpec and RuboCop'
+task all: [:spec, :style]
+
+task default: :all

data/guard-scss-lint.gemspec

@@ -0,0 +1,33 @@
+# coding: 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.to_s
+  spec.authors       = ['Adam Eberlin']
+  spec.email         = ['ae@adameberlin.com']
+  spec.summary       = 'Guard plugin for scss-lint'
+  spec.description   = 'Automatically checks SCSS style with scss-lint when files are modified.'
+  spec.homepage      = 'https://github.com/arkbot/guard-scss-lint'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  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.add_development_dependency 'bundler', '~> 1.3'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+  spec.add_development_dependency 'simplecov', '~> 0.7'
+  spec.add_development_dependency 'guard-rspec', '>= 4.2.3', '< 5.0'
+  spec.add_development_dependency 'rubocop', '~> 0.20'
+  spec.add_development_dependency 'ruby_gntp', '~> 0.3'
+
+  spec.add_runtime_dependency 'guard', '~> 2.0'
+  spec.add_runtime_dependency 'scss-lint', '~> 0.30.0'
+end

data/lib/guard/scss-lint.rb

@@ -0,0 +1,110 @@
+# coding: utf-8
+
+require 'guard'
+require 'guard/plugin'
+
+module Guard
+  # This class gets API calls from `guard` and runs `scss-lint` command via
+  # {Guard::ScssLint::Runner}. An instance of this class stays alive in a
+  # `guard` command session.
+  class ScssLint < Plugin
+    autoload :Runner, 'guard/scss-lint/runner'
+
+    attr_reader :options, :failed_paths
+
+    def initialize(options = nil)
+      super
+
+      merge_with_default_opts(options)
+
+      @failed_paths = []
+    end
+
+    def merge_with_default_opts(options = {})
+      @options = {
+        all_on_start: true,
+        keep_failed:  true,
+        notification: :failed,
+        cli: nil,
+        hide_stdout: false
+      }.merge(options)
+    end
+
+    def start
+      run_all if @options[:all_on_start]
+    end
+
+    def run_all
+      UI.info 'Inspecting SCSS code style of all files'
+      inspect_with_scsslint
+    end
+
+    def run_on_additions(paths)
+      run_partially(paths)
+    end
+
+    def run_on_modifications(paths)
+      # run_partially(paths)
+      inspect_with_scsslint(paths)
+    end
+
+    def reload
+      @failed_paths = []
+    end
+
+    private
+
+    def run_partially(paths)
+      paths += @failed_paths if @options[:keep_failed]
+      paths = clean_paths(paths)
+
+      return if paths.empty?
+
+      displayed_paths = paths.map { |path| smart_path(path) }
+      UI.info "Inspecting SCSS code style: #{displayed_paths.join(' ')}"
+
+      inspect_with_scsslint(paths)
+    end
+
+    def inspect_with_scsslint(paths = [])
+      runner = Runner.new(@options)
+      passed = runner.run(paths)
+      @failed_paths = runner.failed_paths
+      throw :task_has_failed unless passed
+    rescue => error
+      throw_inspect_error(error)
+    end
+
+    def throw_inspect_error(error)
+      error_klazz = error.class.name
+      UI.error 'The following exception occurred while running scss-lint: ' \
+               "#{error.backtrace.first} #{error.message} (#{error_klazz})"
+    end
+
+    def clean_paths(paths)
+      paths = paths.dup
+      paths.map! { |path| File.expand_path(path) }.uniq!
+      paths.reject! do |path|
+        next true unless File.exist?(path)
+        included_in_other_path?(path, paths)
+      end
+      paths
+    end
+
+    def included_in_other_path?(target_path, other_paths)
+      dir_paths = other_paths.select { |path| File.directory?(path) }
+      dir_paths.delete(target_path)
+      dir_paths.any? do |dir_path|
+        target_path.start_with?(dir_path)
+      end
+    end
+
+    def smart_path(path)
+      if path.start_with?(Dir.pwd)
+        Pathname.new(path).relative_path_from(Pathname.getwd).to_s
+      else
+        path
+      end
+    end
+  end
+end

data/lib/guard/scss-lint/runner.rb

@@ -0,0 +1,131 @@
+# coding: utf-8
+
+require 'json'
+
+module Guard
+  class ScssLint
+    # This class runs `scss-lint` command, retrieves result and notifies. An
+    # instance of this class is intended to invoke `scss-lint` only once in
+    # its lifetime.
+    class Runner
+
+      def initialize(options)
+        @options = options
+      end
+
+      def run(paths = [])
+        command = build_command(paths)
+        passed = system(*command)
+        handle_notifications(passed)
+        passed
+      end
+
+      def handle_notifications(passed)
+        case @options[:notification]
+          when :failed then notify(passed) unless passed
+          when true then notify(passed)
+        end
+      end
+
+      def build_command(paths)
+        command = build_formatters_for_command(['scss-lint'])
+        command.concat(args_specified_by_user)
+        command.concat(paths)
+      end
+
+      def build_formatters_for_command(command)
+        command.concat(['--format', 'JSON', '--out', json_file_path])
+
+        # Keep default formatter for console.
+        unless include_formatter_for_console?(args_specified_by_user)
+          command.concat(%w(--format Default))
+        end
+      end
+
+      def args_specified_by_user(args = @options[:cli])
+        @args_specified_by_user ||= begin
+          case args
+            when Array, String then handle_args_array_or_string(args)
+            when NilClass then []
+            else fail ':cli option must be either an array or string'
+          end
+        end
+      end
+
+      def handle_args_array_or_string(args)
+        args.is_a?(Array) ? args : args.shellsplit
+      end
+
+      def include_formatter_for_console?(cli_args)
+        return true if @options[:hide_stdout]
+
+        formatter_args(cli_args).each_value.any? do |args|
+          args.none? { |a| a == '--out' || a.start_with?('-o') }
+        end
+      end
+
+      def formatter_args(cli_args)
+        index = -1
+        args = cli_args.group_by do |arg|
+          index += 1 if arg == '--format' || arg.start_with?('-f')
+          index
+        end
+        args.delete(-1)
+        args
+      end
+
+      def json_file_path
+        @json_file_path ||= begin
+          # Just generate random tempfile path.
+          basename = self.class.name.downcase.gsub('::', '_')
+          tempfile = Tempfile.new(basename)
+          tempfile.close
+          tempfile.path
+        end
+      end
+
+      def result
+        @result ||= begin
+          File.open(json_file_path) do |file|
+            # Rubinius 2.0.0.rc1 does not support `JSON.load` with 3 args.
+            JSON.parse(file.read)
+          end
+        end
+      end
+
+      def notify(passed)
+        image = passed ? :success : :failed
+        Notifier.notify(summary_text, title: 'scss-lint results', image: image)
+      end
+
+      def summary_text
+        offense_count, file_count = 0, 0
+        result.each do |file, offenses|
+          file_count += 1
+          offense_count += offenses.size
+        end
+        text = pluralize(file_count, 'file')
+        text << ' inspected, '
+
+        text << pluralize(offense_count, 'offense', no_for_zero: true)
+        text << ' detected'
+      end
+
+      def failed_paths
+        failed_files = result.reject do |file, offenses|
+          offenses.empty?
+        end
+        failed_files.to_a.collect(&:first)
+      end
+
+      def pluralize(number, thing, options = {})
+        if number == 0 && options[:no_for_zero]
+          text = 'no'
+        else
+          text = number.to_s
+        end
+        text << (number == 1 ? " #{thing}" : " #{thing}s")
+      end
+    end
+  end
+end

data/lib/guard/scss-lint/templates/Guardfile

@@ -0,0 +1,3 @@
+guard :scsslint do
+  watch(%r{.+\.scss$})
+end

data/lib/guard/scss-lint/version.rb

@@ -0,0 +1,16 @@
+# coding: utf-8
+
+module Guard
+  # A workaround for declaring `class ScssLint`
+  # before `class ScssLint < Guard` in scss-lint.rb
+  module ScssLintVersion
+    # http://semver.org/
+    MAJOR = 0
+    MINOR = 0
+    PATCH = '1alpha'
+
+    def self.to_s
+      [MAJOR, MINOR, PATCH].join('.')
+    end
+  end
+end

data/lib/guard/scsslint.rb

@@ -0,0 +1,2 @@
+# Convenience helper, since ruby doesn't like symbols with dashes in them.
+require_relative 'scss-lint.rb'

data/spec/.rubocop.yml

@@ -0,0 +1,12 @@
+inherit_from: ../.rubocop.yml
+
+BracesAroundHashParameters:
+  Enabled: false
+
+Metrics/LineLength:
+  Exclude:
+    - '**/**.rb'
+
+Style/FileName:
+  Exclude:
+    - '**/scss-lint_spec.rb'

metadata

@@ -0,0 +1,191 @@
+--- !ruby/object:Gem::Specification
+name: guard-scss-lint
+version: !ruby/object:Gem::Version
+  version: 0.0.1alpha
+platform: ruby
+authors:
+- Adam Eberlin
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-11-28 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.7'
+- !ruby/object:Gem::Dependency
+  name: guard-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.2.3
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.2.3
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.20'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.20'
+- !ruby/object:Gem::Dependency
+  name: ruby_gntp
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.3'
+- !ruby/object:Gem::Dependency
+  name: guard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: scss-lint
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.30.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.30.0
+description: Automatically checks SCSS style with scss-lint when files are modified.
+email:
+- ae@adameberlin.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rubocop.yml"
+- ".yardopts"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- guard-scss-lint.gemspec
+- lib/guard/scss-lint.rb
+- lib/guard/scss-lint/runner.rb
+- lib/guard/scss-lint/templates/Guardfile
+- lib/guard/scss-lint/version.rb
+- lib/guard/scsslint.rb
+- spec/.rubocop.yml
+homepage: https://github.com/arkbot/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: 1.3.1
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.2
+signing_key: 
+specification_version: 4
+summary: Guard plugin for scss-lint
+test_files:
+- spec/.rubocop.yml