csslint_ruby 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: b17ba1e8fee39d351de42a8e96b950d0b70bb8c0
+  data.tar.gz: cc7f1d01caf0958e2751771386446ef25a1b42ee
+SHA512:
+  metadata.gz: 3f038b60d20349828b9aa2a1a990d38a917f3a5af507a6e65feca5bb5f860a8ba70ffba5676e4010c42214194c4cdc445e92a9d41638d840d96bd3a8d89406ec
+  data.tar.gz: cc93d22832e05fac2844ced0e487a6d9dadfa5505aade68ec65a684b589d277839e1de6719048dc64797b1ad0a4140f3041e3abde8ba4df5e9045d912223ec94

data/.gitignore

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

data/.travis.yml

@@ -0,0 +1,10 @@
+language: ruby
+rvm:
+  - 2.0.0
+  - 1.9.3
+  - jruby-19mode
+  - ruby-head
+  - jruby-head
+before_install:
+  - gem update --system
+  - gem --version

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in csslint_ruby.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Yann
+
+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,47 @@
+# CsslintRuby
+
+API to lint your css source code from ruby.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'csslint_ruby'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install csslint_ruby
+
+## Usage
+
+```ruby
+    source = "body { background: red;}"
+    CsslintRuby.run(source) # => <CsslintRuby::Result:0x007ff7629b4018 @errors=[], @warnings=[]>
+```
+
+You can also provide pass an option hash to provide CSSLint with a custom set of rules. You can check the full list [here](https://github.com/stubbornella/csslint/wiki/Rules)
+
+```ruby
+   options = {errors: ['known-properties', 'display-property-grouping'], warnings: ['box-model'], ignore: ['import']}
+   result = CsslintRuby.run(source, options) # => <CsslintRuby::Result:0x007ff76287b160 @errors=[{"type"=>"error", "line"=>2, "col"=>8, "message"=>"Expected (inline | block | list-item | inline-block | table | inline-table | table-row-group | table-header-group | table-footer-group | table-row | table-column-group | table-column | table-cell | table-caption | box | inline-box | grid | inline-grid | none | inherit | -moz-box | -moz-inline-block | -moz-inline-box | -moz-inline-grid | -moz-inline-stack | -moz-inline-table | -moz-grid | -moz-grid-group | -moz-grid-line | -moz-groupbox | -moz-deck | -moz-popup | -moz-stack | -moz-marker | -webkit-box | -webkit-inline-box) but found 'asdas'.", "evidence"=>"body { display: asdas;}", "rule"=>{"id"=>"known-properties", "name"=>"Require use of known properties", "desc"=>"Properties should be known (listed in CSS3 specification) or be a vendor-prefixed property.", "browsers"=>"All"}}], @warnings=[]>
+   result.errors # => [{"type"=>"error", "line"=>2, "col"=>8, "message"=>"Expected (inline | block | list-item | inline-block | table | inline-table | table-row-group | table-header-group | table-footer-group | table-row | table-column-group | table-column | table-cell | table-caption | box | inline-box | grid | inline-grid | none | inherit | -moz-box | -moz-inline-block | -moz-inline-box | -moz-inline-grid | -moz-inline-stack | -moz-inline-table | -moz-grid | -moz-grid-group | -moz-grid-line | -moz-groupbox | -moz-deck | -moz-popup | -moz-stack | -moz-marker | -webkit-box | -webkit-inline-box) but found 'asdas'.", "evidence"=>"body { display: asdas;}", "rule"=>{"id"=>"known-properties", "name"=>"Require use of known properties", "desc"=>"Properties should be known (listed in CSS3 specification) or be a vendor-prefixed property.", "browsers"=>"All"}}]
+   result.warnings # => []
+```
+
+Alternatively ``` CsslintRuby.run``` can accept anything the acts like in ```IO``` object.
+```ruby
+    source = File.open('/path/to/my/css/file.css')
+    CsslintRuby.run(source) # => <CsslintRuby::Result:0x007ff7629b4018 @errors=[], @warnings=[]>
+```
+
+## Contributing
+
+1. Fork it ( http://github.com/<my-github-username>/csslint_ruby/fork )
+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

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/csslint_ruby.gemspec

@@ -0,0 +1,26 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'csslint_ruby/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'csslint_ruby'
+  spec.version       = CsslintRuby::VERSION
+  spec.authors       = ['StupidCodefactory']
+  spec.email         = ['ymarquet@gmail.com']
+  spec.summary       = %q{Provide an interface to lint css with CSSLint from ruby}
+  spec.description   = %q{Provide an interface to lint css with CSSLint from ruby}
+  spec.homepage      = ''
+  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{^(test|spec|features)/})
+  spec.require_paths = ['lib']
+
+  spec.add_dependency 'execjs'
+  spec.add_development_dependency 'byebug'
+  spec.add_development_dependency 'rspec'
+  spec.add_development_dependency 'bundler', '~> 1.5'
+  spec.add_development_dependency 'rake'
+end

data/lib/csslint_ruby/source.rb

@@ -0,0 +1,14 @@
+module CsslintRuby
+  class Source
+
+    def self.path
+      ENV['CSSLINT_PATH'] ||
+        File.expand_path("../../../vendor/csslint/csslint.js", __FILE__)
+    end
+
+    def self.contents
+      @contents ||= File.read(path)
+    end
+
+  end
+end

data/lib/csslint_ruby/version.rb

@@ -0,0 +1,3 @@
+module CsslintRuby
+  VERSION = "0.0.1"
+end

data/lib/csslint_ruby.rb

@@ -0,0 +1,68 @@
+require 'csslint_ruby/version'
+require 'csslint_ruby/source'
+require 'execjs'
+
+module CsslintRuby
+
+  def self.context
+    ExecJS.compile(
+      Source.contents + <<-EOJS
+function gatherRules(options){
+    var ruleset,
+        ignores  = options.ignores,
+        warnings = options.rules || options.warnings,
+        errors   = options.errors;
+
+    if (ignores) {
+        ruleset = ruleset || {};
+        for( var _i = 0, _len = ignores.length; _i < _len; _i++ ) {
+            ruleset[ignores[_i]] = 0;
+        };
+    }
+
+    if (warnings) {
+        ruleset = ruleset || {};
+        for( var _i = 0, _len = warnings.length; _i < _len; _i++ ) {
+            ruleset[warnings[_i]] = 1;
+        };
+    }
+
+    if (errors) {
+        ruleset = ruleset || {};
+        for( var _i = 0, _len = errors.length; _i < _len; _i++ ) {
+            ruleset[errors[_i]] = 2;
+        };
+    }
+
+    return ruleset;
+};
+
+function CSSLINTER(source, options) {
+    var result    = CSSLint.verify( source, gatherRules( options ) );
+    var messages  = result.messages || [];
+    return [ messages ];
+};
+EOJS
+    )
+  end
+
+  def self.run(source, options = {})
+    source = source.respond_to?(:read) ? source.read : source
+    Result.new(*context.call('CSSLINTER', source, options))
+  end
+
+  class Result
+
+    TYPE_ERROR = "error".freeze
+
+    attr_reader :errors, :warnings
+
+    def initialize(errors)
+      @errors, @warnings = errors.partition {|error| error['type'] == TYPE_ERROR }
+    end
+
+    def valid?
+      errors.empty?
+    end
+  end
+end

data/spec/fixtures/errors.css

@@ -0,0 +1,3 @@
+background {
+    display: ;
+}

data/spec/fixtures/errors_with_options.css

@@ -0,0 +1,3 @@
+body {
+    display: unkown-property;
+}

data/spec/fixtures/source.css

@@ -0,0 +1,3 @@
+body {
+    color: red;
+}

data/spec/lib/csslint_ruby_spec.rb

@@ -0,0 +1,53 @@
+require 'spec_helper'
+
+describe CsslintRuby do
+
+
+  describe "When no linting errors are returned" do
+
+    let(:source) { File.open('spec/fixtures/source.css') }
+
+    it 'is valid' do
+      expect(CsslintRuby.run(source)).to be_valid
+    end
+
+  end
+
+  describe "When linting errors are returned" do
+
+    let(:source) { File.open('spec/fixtures/errors.css') }
+    let(:result) { CsslintRuby.run(source, {}) }
+
+    it 'is not valid' do
+      expect(result).not_to be_valid
+    end
+
+    describe '#errors' do
+      it 'have an expected structure' do
+        expect(result.errors.first).to include('type', 'line', 'col', 'message', 'evidence', 'rule')
+      end
+
+      it 'have rule description on' do
+        expect(result.errors.first['rule']).to include('id', 'name', 'desc', 'browsers')
+      end
+    end
+  end
+
+  describe "When passing options" do
+    let(:options) { {errors: ['known-properties']} }
+    let(:source)  { File.open('spec/fixtures/errors_with_options.css') }
+
+    it 'passes the options to CSSLint correctly' do
+      result = CsslintRuby.run(source, options)
+      expect(result).not_to be_valid
+      expect(result.errors.first).to include(
+        'type' => 'error',
+        'rule' => {
+          'id'      => 'known-properties',
+          'name'    => 'Require use of known properties',
+          'desc'    => 'Properties should be known (listed in CSS3 specification) or be a vendor-prefixed property.',
+          'browsers'=>'All'
+        })
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,4 @@
+require 'bundler/setup'
+require 'rspec'
+require 'csslint_ruby'
+require 'byebug'