roger_eslint 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: a3ed5a00c847aa7df8754176d1dbeef857ff1969
+  data.tar.gz: 20509207b4e93285315bfdd7a4064f866b7226a6
+SHA512:
+  metadata.gz: b5c82390bd2e59841405044d4435cbbf160c3125d45e229424697981b550e990508a5317cdc62fb7477dac78ee885a64fd281565e5bbc22794ed62de0d8c40ca
+  data.tar.gz: 4d542778c45ca52cdfa929e1f250d982cf1c767d3d8281ec7fec22d12548a366aaacfe857190fbcf3a9adb22ba231668dcb8587d9e1bdedee77cc6c362e521f2

data/.rubocop.yml

@@ -0,0 +1,47 @@
+LineLength:
+  Description: 'Limit lines to 100 characters.'
+  Max: 100
+  Enabled: true
+
+StringLiterals:
+  EnforcedStyle: double_quotes
+  Enabled: true
+
+Style/DotPosition:
+  EnforcedStyle: trailing
+  Enabled: true
+
+Metrics/MethodLength:
+  CountComments: false  # count full line comments?
+  Max: 20
+
+Metrics/AbcSize:
+  Max: 20
+
+Style/ClassAndModuleChildren:
+  EnforcedStyle: compact
+  Enabled: false
+
+# By default, the rails cops are not run. Override in project or home
+# directory .rubocop.yml files, or by giving the -R/--rails option.
+Rails:
+  Enabled: false
+
+# Disabled cops
+Metrics/ClassLength:
+  Enabled: false
+
+Metrics/ModuleLength:
+  Enabled: false
+
+Style/EachWithObject:
+  Enabled: false
+
+Style/AccessorMethodName:
+  Enabled: false
+
+Lint/AssignmentInCondition:
+  Enabled: false
+
+Style/SingleLineBlockParams:
+  Enabled: false

data/CHANGELOG.md

@@ -0,0 +1,4 @@
+# Changelog
+
+## Version 1.0.0
+* First workable version

data/Gemfile

@@ -0,0 +1,3 @@
+source "https://rubygems.org"
+
+gemspec

data/Gemfile.lock

@@ -0,0 +1,56 @@
+PATH
+  remote: .
+  specs:
+    roger_eslint (1.0.0)
+      roger (~> 1.5, >= 1.0.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    ast (2.2.0)
+    hpricot (0.8.4)
+    metaclass (0.0.4)
+    mime-types (2.99)
+    mocha (1.1.0)
+      metaclass (~> 0.0.1)
+    parser (2.3.0.1)
+      ast (~> 2.2)
+    power_assert (0.2.7)
+    powerpack (0.1.1)
+    rack (1.6.4)
+    rainbow (2.0.0)
+    rake (10.5.0)
+    redcarpet (3.3.4)
+    roger (1.5.0)
+      hpricot (= 0.8.4)
+      mime-types (~> 2.2)
+      rack (>= 1.0.0)
+      redcarpet (>= 3.1.1)
+      test_construct (~> 2.0)
+      thor (~> 0.19.0)
+      tilt (~> 2.0.1)
+    rubocop (0.36.0)
+      parser (>= 2.3.0.0, < 3.0)
+      powerpack (~> 0.1)
+      rainbow (>= 1.99.1, < 3.0)
+      ruby-progressbar (~> 1.7)
+    ruby-progressbar (1.7.5)
+    test-unit (3.1.5)
+      power_assert
+    test_construct (2.0.1)
+    thor (0.19.1)
+    tilt (2.0.2)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  mocha (~> 1.1.0)
+  rake
+  roger_eslint!
+  rubocop
+  test-unit
+  thor (~> 0)
+
+BUNDLED WITH
+   1.10.6

data/LICENSE

@@ -0,0 +1,22 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Digitpant, Flurin Egger
+
+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,28 @@
+Roger ESLint
+============
+
+[![Build Status](https://travis-ci.org/DigitPaint/roger_eslint.svg)](https://travis-ci.org/DigitPaint/roger_eslint)
+
+
+Lint JavaScript files from within Roger. This plugin uses [eslint](http://eslint.org/). If present, .eslintrc in your project will be used. If not, jshint will walk the directory tree upwards until a .eslintrc file is found. 
+
+## Installation
+* Install jshint using npm: ```npm install eslint -g```
+
+* Add ```gem 'roger_esliint'``` to your Gemfile
+
+* Add this to your Mockupfile:
+```
+mockup.test do |t|
+  t.use :eslint
+end
+```
+
+* (Optional) put a .eslintrc in your project's root directory.
+
+## Running
+Execute ```roger test eslint```.
+
+## License
+
+This project is released under the [MIT license](LICENSE).

data/Rakefile

@@ -0,0 +1,15 @@
+require "rake/testtask"
+require "rubocop/rake_task"
+
+task default: [:test, :rubocop]
+
+desc "Run rubocop"
+task :rubocop do
+  RuboCop::RakeTask.new
+end
+
+Rake::TestTask.new do |t|
+  t.libs << "test"
+  t.test_files = FileList["test/**/*_test.rb"]
+  t.verbose = true
+end

data/lib/roger_eslint/lint.rb

@@ -0,0 +1,126 @@
+require "shellwords"
+require "json"
+require "roger/test"
+
+module RogerEslint
+  # JS linter plugin for Roger
+  class Lint
+    # ESLint severities translated into a human readable format
+    ESLINT_SEVERITIES = {
+      1 => "Warning",
+      2 => "Error"
+    }.freeze
+
+    # @param [Hash] options The options
+    # @option options [Array] :match Files to match
+    # @option options [Array[Regexp]] :skip Array of regular expressions to skip files
+    # @option options [Boolean] (false) :fail_on_warning Wether or not to fail test on warnings
+    # @option options [String] :eslint eslint command
+    # @option options [Array] :eslint_options An array of eslint options; make sure
+    #   you have the commandline flag and the value in separate elments, so: `["--global", "$"]`
+    def initialize(options = {})
+      @options = {
+        match: ["html/**/*.js"],
+        skip: [],
+        fail_on_warning: false,
+        eslint: "eslint",
+        eslint_options: []
+      }
+
+      @options.update(options) if options
+
+      detect_eslint
+    end
+
+    def lint(test, file_path)
+      output = `#{eslint_command(file_path)}`
+      file_lints = JSON.parse(output).first
+
+      unless file_lints
+        test.warn(self, "No files linted")
+        return true
+      end
+
+      success = file_lints["errorCount"] <= 0
+      success &&= file_lints["warningCount"] <= 0 if @options[:fail_on_warning]
+
+      fixables = []
+
+      if success
+        test.log(self, "#{file_path}: OK")
+      else
+        file_lints["messages"].each do |message|
+          fixables << message if message["fix"]
+          report_message(test, file_path, message)
+        end
+      end
+
+      report_fixables(test, file_path, fixables)
+
+      success
+    end
+
+    # @param [Hash] options The options
+    # @option options [Array] :match Files to match
+    # @option options [Array[Regexp]] :skip Array of regular expressions to skip files
+    def call(test, options)
+      options = {}.update(@options).update(options)
+
+      test.log(self, "ESLinting files")
+
+      failures = test.get_files(options[:match], options[:skip]).select do |file_path|
+        !lint(test, file_path)
+      end
+      failures.empty?
+    end
+
+    private
+
+    def eslint_command(file_path, extras = [])
+      command = [
+        @options[:eslint],
+        "-f", "json"
+      ]
+
+      command += @options[:eslint_options] if @options[:eslint_options]
+
+      command += extras
+      command << file_path
+
+      Shellwords.join(command)
+    end
+
+    def report_message(test, file_path, message)
+      output = "#{file_path}: "
+      output << message["line"].to_s
+      output << ":"
+      output << message["column"].to_s
+      output << " ["
+      output << ESLINT_SEVERITIES[message["severity"]]
+      output << " (Fixable)" if message["fix"]
+      output << "] "
+      output << message["message"]
+
+      test.log(self, output)
+      test.log(self, "  #{message['source']}")
+    end
+
+    def report_fixables(test, file_path, fixables)
+      if fixables.any?
+        test.log(self, "#{fixables.size} problems can be fixed automatically. Run:")
+        test.log(self, "  #{eslint_command(file_path, ['--fix'])}")
+      end
+    end
+
+    def detect_eslint
+      command = [@options[:eslint], "-v", "2>/dev/null"]
+      detect = system(Shellwords.join(command))
+      unless detect
+        err = "Could not find eslint. Install eslint using: 'npm install -g eslint'."
+        fail ArgumentError, err
+      end
+    end
+  end
+end
+
+Roger::Test.register :eslint, RogerEslint::Lint

data/lib/roger_eslint/version.rb

@@ -0,0 +1,4 @@
+# Roger main namespace
+module RogerEslint
+  VERSION = "1.0.0"
+end

data/lib/roger_eslint.rb

@@ -0,0 +1,6 @@
+# Eslint plugin
+module RogerEslint
+end
+
+require File.dirname(__FILE__) + "/roger_eslint/lint"
+require File.dirname(__FILE__) + "/roger_eslint/version"

data/roger_eslint.gemspec

@@ -0,0 +1,31 @@
+# -*- encoding: utf-8 -*-
+
+require File.dirname(__FILE__) + "/lib/roger_eslint/version"
+
+Gem::Specification.new do |s|
+  s.authors = ["Flurin Egger"]
+  s.email = ["info@digitpaint.nl", "flurin@digitpaint.nl"]
+  s.name = "roger_eslint"
+  s.version = RogerEslint::VERSION
+  s.homepage = "https://github.com/digitpaint/roger_eslint"
+
+  s.summary = "Lint JavaScript files with ESLint within Roger"
+  s.description = <<-EOF
+    Lint JavaScript files from within Roger, using eslint.
+    Will use .eslintrc.
+  EOF
+  s.licenses = ["MIT"]
+
+  s.date = Time.now.strftime("%Y-%m-%d")
+
+  s.files = `git ls-files`.split("\n")
+  s.require_paths = ["lib"]
+
+  s.add_dependency "roger", "~> 1.5", ">= 1.0.0"
+
+  s.add_development_dependency "rubocop", [">= 0"]
+  s.add_development_dependency "rake", [">= 0"]
+  s.add_development_dependency "test-unit", [">= 0"]
+  s.add_development_dependency "thor", ["~> 0"]
+  s.add_development_dependency "mocha", ["~> 1.1.0"]
+end

data/test/data/.eslintrc-no-undef.js

@@ -0,0 +1,6 @@
+module.exports = {
+  "root" : true,
+  "rules" : {
+    "no-undef" : 2
+  }
+}

data/test/data/error.js

@@ -0,0 +1,2 @@
+x = 5;
+alert(x);

data/test/data/fixable.js

@@ -0,0 +1 @@
+var a = "henk"

data/test/data/globals.js

@@ -0,0 +1 @@
+var a = my_global;

data/test/lint_test.rb

@@ -0,0 +1,97 @@
+require File.dirname(__FILE__) + "/../lib/roger_eslint/lint.rb"
+require "test/unit"
+
+# Fake tester to pass into the linter plugin
+class TesterStub
+  attr_reader :messages
+  attr_writer :files
+
+  def initialize
+    @messages = []
+    @files = []
+  end
+
+  def log(_, message)
+    @messages.push(message)
+  end
+
+  def warn(_, message)
+    @messages.push(message)
+  end
+
+  def get_files(_, _)
+    @files
+  end
+end
+
+# Linting plugin unit test
+class LintTest < Test::Unit::TestCase
+  def setup
+  end
+
+  def test_detect_eslint
+    assert_nothing_raised do
+      RogerEslint::Lint.new
+    end
+
+    assert_raise(ArgumentError) do
+      RogerEslint::Lint.new eslint: "eslint-blabla"
+    end
+  end
+
+  def test_lint_nonexisting_file
+    success, messages = lint_file("test/data/does_not_exist.js")
+
+    assert success
+    assert_equal "No files linted", messages[0]
+  end
+
+  def test_lint_with_default_eslintrc
+    eslintrc_file = ".eslintrc.js"
+    assert !File.exist?(eslintrc_file), ".eslintrc.js file already exists."
+    FileUtils.cp("./test/data/.eslintrc-no-undef.js", eslintrc_file)
+
+    file = "test/data/error.js"
+    success, messages = lint_file(file)
+
+    assert !success
+
+    assert_equal("#{file}: 1:1 [Error] \"x\" is not defined.", messages[0])
+    assert_equal("#{file}: 2:1 [Error] \"alert\" is not defined.", messages[2])
+    assert_equal("#{file}: 2:7 [Error] \"x\" is not defined.", messages[4])
+  ensure
+    File.unlink eslintrc_file
+  end
+
+  def test_lint_pass_eslint_options
+    file = "test/data/globals.js"
+    success, messages = lint_file(file, eslint_options: ["--no-eslintrc", "--global", "my_global"])
+    assert success
+    assert_equal "#{file}: OK", messages[0]
+  end
+
+  def test_lint_fixable_errors
+    file = "test/data/fixable.js"
+    success, messages = lint_file(file, eslint_options: ["--no-eslintrc", "--rule", "semi: 2"])
+    assert !success
+    assert_equal "#{file}: 1:15 [Error (Fixable)] Missing semicolon.", messages[0]
+    assert_equal "1 problems can be fixed automatically. Run:", messages[2]
+  end
+
+  protected
+
+  def lint_file(file, options = {})
+    faketester = TesterStub.new
+    faketester.files = [file]
+
+    linter = RogerEslint::Lint.new options
+    success = linter.call(faketester, {})
+
+    messages = faketester.messages
+
+    # Chop off the first message is it just says "ESLinting files"
+    messages.shift
+
+    [success, messages]
+  end
+end

metadata

@@ -0,0 +1,153 @@
+--- !ruby/object:Gem::Specification
+name: roger_eslint
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Flurin Egger
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-01-17 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: roger
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.5'
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.5'
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 1.0.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: 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: test-unit
+  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: thor
+  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: mocha
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.1.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.1.0
+description: |2
+      Lint JavaScript files from within Roger, using eslint.
+      Will use .eslintrc.
+email:
+- info@digitpaint.nl
+- flurin@digitpaint.nl
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .rubocop.yml
+- CHANGELOG.md
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- README.md
+- Rakefile
+- lib/roger_eslint.rb
+- lib/roger_eslint/lint.rb
+- lib/roger_eslint/version.rb
+- roger_eslint.gemspec
+- test/data/.eslintrc-no-undef.js
+- test/data/error.js
+- test/data/fixable.js
+- test/data/globals.js
+- test/lint_test.rb
+homepage: https://github.com/digitpaint/roger_eslint
+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.2.2
+signing_key: 
+specification_version: 4
+summary: Lint JavaScript files with ESLint within Roger
+test_files: []