roger_jshint 1.0.0 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 837f852c6ef0278395df76946e093ee4c52cea1f
-  data.tar.gz: 9c97f2e5133a029712a8c26fca0c21a96447d632
+  metadata.gz: d14bd88e5858be37ebc958542a004606ead19cfb
+  data.tar.gz: c2cf5c3648a17610a1d3d91c53c3157a29bce5a1
 SHA512:
-  metadata.gz: eb42fd286eb3eeef32bbe615d53483847b2a30afbf7766b3d97833a60fa3753731bda7cf2b122b10fe2e824d3593b880853fb267f2ef915f47bb49bf9eb7cf2b
-  data.tar.gz: 714fabeb549664e72c04c40516acf1c233275e7302236b7a8323fb4bd3949ba9c83d447d1059a7ddc3d6dde257576e55b1649453171a2e991bcc1170d01b2064
+  metadata.gz: 43e9915df854a9d385b3e53c8e4c5c6b56b6a6fbc884339b1c7089fec8a06961398c6b172d26cbc61051c0237122ef4e40e948ad1e70662501491ba93d11e067
+  data.tar.gz: a3df08386e01204e31d6e2ac9b670825d78a811c71d9bbf8ad6bb6c37325d656dc072dbb9548b0c8a285b7e3fdabba924b0e600a88afe638011b6505cee946fd

data/.rubocop.yml

@@ -1,17 +1,15 @@
 LineLength:
+  Description: 'Limit lines to 100 characters.'
   Max: 100
+  Enabled: true
 
-Metrics/AbcSize:
-  Enabled:
-    False
+StringLiterals:
+  EnforcedStyle: double_quotes
+  Enabled: true
 
-Style/HashSyntax:
-  Enabled:
-    False
-
-Style/StringLiterals:
-  Enabled:
-    False
+Style/DotPosition:
+  EnforcedStyle: trailing
+  Enabled: true
 
 Metrics/MethodLength:
   CountComments: false  # count full line comments?

data/CHANGELOG.md

@@ -0,0 +1,8 @@
+# Changelog
+
+## Version 1.1.0
+* Add a `.jshintrc` generator
+* Correctly return success value so reger test will output the correct error code
+
+## Version 1.0.0
+* What was before...

data/Gemfile

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

data/Rakefile

@@ -1,15 +1,15 @@
-require 'rake/testtask'
-require 'rubocop/rake_task'
+require "rake/testtask"
+require "rubocop/rake_task"
 
-task :default => [:test, :rubocop]
+task default: [:test, :rubocop]
 
-desc 'Run 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.libs << "test"
+  t.test_files = FileList["test/**/*_test.rb"]
   t.verbose = true
 end

data/lib/roger_jshint.rb

@@ -2,4 +2,4 @@
 module RogerJsHint
 end
 
-require File.dirname(__FILE__) + '/roger_jshint/lint'
+require File.dirname(__FILE__) + "/roger_jshint/lint"

data/lib/roger_jshint/generator.rb

@@ -0,0 +1,45 @@
+require "open-uri"
+
+require "roger/cli/generate"
+require "roger/cli/command"
+require "roger/generators"
+
+module RogerJsHint
+  # Lint configuration retriever
+  class Generator < Roger::Generators::Base
+    include Thor::Actions
+    CONFIG_PATH = ".jshintrc"
+    DEFAULT_CONFIG_URL = "https://raw.githubusercontent.com/"\
+                         "DigitPaint/javascript/master/linters/jshintrc"
+
+    desc "JsHint generator creates an .jshintrc config file"
+    class_option(
+      :config,
+      type: :string,
+      aliases: ["-c"],
+      desc: "Optional config file to use takes a path or url, by
+             default it uses the company' default"
+    )
+
+    class_option(
+      :force,
+      type: :boolean,
+      aliases: ["-f"],
+      desc: "Always overwrite the config file"
+    )
+
+    # Write config file
+    def write_config_file
+      if options[:config]
+        config = open(options[:config]).read
+      else
+        config = open(DEFAULT_CONFIG_URL).read
+      end
+
+      # Create file check if we don't have a conflict or something
+      create_file "#{@project.path}/#{CONFIG_PATH}", config, force: options[:force]
+    end
+  end
+end
+
+Roger::Generators.register :jshint, RogerJsHint::Generator

data/lib/roger_jshint/lint.rb

@@ -1,6 +1,6 @@
-require 'shellwords'
-require 'json'
-require 'roger/test'
+require "shellwords"
+require "json"
+require "roger/test"
 
 module RogerJsHint
   # JS linter plugin for Roger
@@ -11,20 +11,25 @@ module RogerJsHint
     # @option options [Array] :jshint Jshint command
     def initialize(options = {})
       @options = {
-        :match => ['html/**/*.js'],
-        :skip => [],
-        :jshint => 'jshint'
+        match: ["html/**/*.js"],
+        skip: [],
+        jshint: "jshint"
       }
+      detect_jshint
+
       @options.update(options) if options
     end
 
-    def detect_jshint
-      command = [@options[:jshint], "-v", "2>/dev/null"]
-      detect = system(Shellwords.join(command))
-      fail 'Could not find jshint. Install jshint using npm.' unless detect
-    end
+    def report(test, file_path)
+      command = [
+        @options[:jshint],
+        reporter
+      ]
+
+      # The actual linting
+      output = `#{Shellwords.join(command + [Shellwords.escape(file_path)])}`
+      lints = JSON.parse output
 
-    def report(test, file_path, lints)
       success = true
       if lints.empty?
         test.log(self, "No erors in #{file_path}")
@@ -42,19 +47,25 @@ module RogerJsHint
     # @option options [Array[Regexp]] :skip Array of regular expressions to skip files
     def call(test, options)
       options = {}.update(@options).update(options)
-      command = [
-        @options[:jshint],
-        "--reporter=" + File.expand_path('jsonreporter.js', File.dirname(__FILE__))
-      ]
 
-      detect_jshint
-      test.log(self, 'JS-linting files')
+      test.log(self, "JS-linting files")
 
-      test.get_files(options[:match], options[:skip]).each do |file_path|
-        output = `#{Shellwords.join(command + [Shellwords.escape(file_path)])}`
-        lint = JSON.parse output
-        report(test, file_path, lint)
+      failures = test.get_files(options[:match], options[:skip]).select do |file_path|
+        !report(test, file_path)
       end
+      failures.empty?
+    end
+
+    private
+
+    def detect_jshint
+      command = [@options[:jshint], "-v", "2>/dev/null"]
+      detect = system(Shellwords.join(command))
+      fail "Could not find jshint. Install jshint using npm." unless detect
+    end
+
+    def reporter
+      "--reporter=" + File.expand_path("jsonreporter.js", File.dirname(__FILE__))
     end
   end
 end

data/roger_jshint.gemspec

@@ -1,27 +1,29 @@
 # -*- encoding: utf-8 -*-
 
 Gem::Specification.new do |s|
-  s.authors = ['Hans Krutzer', 'Flurin Egger']
-  s.email = ['info@digitpaint.nl', 'hans@digitpaint.nl', 'flurin@digitpaint.nl']
-  s.name = 'roger_jshint'
-  s.version = '1.0.0'
-  s.homepage = 'https://github.com/digitpaint/roger_jshint'
+  s.authors = ["Hans Krutzer", "Flurin Egger"]
+  s.email = ["info@digitpaint.nl", "hans@digitpaint.nl", "flurin@digitpaint.nl"]
+  s.name = "roger_jshint"
+  s.version = "1.1.0"
+  s.homepage = "https://github.com/digitpaint/roger_jshint"
 
-  s.summary = 'Lint JavaScript files within Roger'
+  s.summary = "Lint JavaScript files within Roger"
   s.description = <<-EOF
     Lint JavaScript files from within Roger, using jshint.
     Will use .jshintrc.
   EOF
-  s.licenses = ['MIT']
+  s.licenses = ["MIT"]
 
-  s.date = Time.now.strftime('%Y-%m-%d')
+  s.date = Time.now.strftime("%Y-%m-%d")
 
   s.files = `git ls-files`.split("\n")
-  s.require_paths = ['lib']
+  s.require_paths = ["lib"]
 
-  s.add_dependency 'roger', '~> 1.1', '>= 0.13.0'
+  s.add_dependency "roger", "~> 1.1", ">= 0.13.0"
 
-  s.add_development_dependency 'rubocop', ['>= 0']
-  s.add_development_dependency 'rake', ['>= 0']
-  s.add_development_dependency 'test-unit', ['>= 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/generator_test.rb

@@ -0,0 +1,31 @@
+require "test/unit"
+require "mocha/test_unit"
+
+require "roger/cli"
+require_relative "../lib/roger_jshint/generator.rb"
+
+# Mock project
+class Project
+  def path
+    "./"
+  end
+end
+
+# Linting plugin unit test
+class GeneratorTest < Test::Unit::TestCase
+  #  Check if tasks is added
+  def test_default_generator
+    assert_includes Roger::Cli::Generate.tasks, "jshint", "Task is loaded"
+  end
+
+  def test_create_file
+    file_name = "./.jshintrc"
+    Roger::Cli::Base.expects(:project).once.returns(Project.new)
+    cli = Roger::Cli::Generate.new
+    cli.invoke "jshint", [], ["-f"]
+    assert File.exist?(file_name), "After invoking the file is written"
+
+    # Unlink file
+    File.unlink file_name
+  end
+end

data/test/lint_test.rb

@@ -1,5 +1,5 @@
-require_relative '../lib/roger_jshint/lint.rb'
-require 'test/unit'
+require_relative "../lib/roger_jshint/lint.rb"
+require "test/unit"
 
 # Fake tester to pass into the linter plugin
 class TesterStub
@@ -14,7 +14,7 @@ class TesterStub
   end
 
   def get_files(_, _)
-    ['test/data/test.js']
+    ["test/data/test.js"]
   end
 end
 
@@ -30,11 +30,13 @@ class LintTest < Test::Unit::TestCase
     faketester = TesterStub.new
 
     linter = RogerJsHint::Lint.new
-    linter.call(faketester, {})
+    success = linter.call(faketester, {})
 
     messages = faketester.messages
     messages.shift
 
+    assert_equal(false, success)
+
     assert_equal(messages,
                  ["test/data/test.js:0 0: Bad option: 'subsub'.",
                   "test/data/test.js:1 1: 'x' is not defined.",

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: roger_jshint
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.0
 platform: ruby
 authors:
 - Hans Krutzer
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-05-26 00:00:00.000000000 Z
+date: 2015-07-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: roger
@@ -73,6 +73,34 @@ dependencies:
     - - '>='
       - !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 jshint.
       Will use .jshintrc.
@@ -88,16 +116,19 @@ files:
 - .rubocop.yml
 - .ruby-version
 - .travis.yml
+- CHANGELOG.md
 - Gemfile
 - LICENSE
 - README.md
 - Rakefile
 - lib/roger_jshint.rb
+- lib/roger_jshint/generator.rb
 - lib/roger_jshint/jsonreporter.js
 - lib/roger_jshint/lint.rb
 - roger_jshint.gemspec
 - test/data/jshintrc
 - test/data/test.js
+- test/generator_test.rb
 - test/lint_test.rb
 homepage: https://github.com/digitpaint/roger_jshint
 licenses:
@@ -119,7 +150,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.5
+rubygems_version: 2.2.2
 signing_key: 
 specification_version: 4
 summary: Lint JavaScript files within Roger