rails-erb-lint 1.1.6 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 47ed75bff301016846c33cbb1668bf22c18129e6
-  data.tar.gz: ad5636a84c2e6ec82b6077b5ebb8c6a2883f9c41
+  metadata.gz: 8c755024ecaeaabf99ceb33b9c65c52c0ab3cda9
+  data.tar.gz: 71d266c0611a778fcc2367e699f3e9861cacdada
 SHA512:
-  metadata.gz: 11b4dc46a0492af6d24a8bbfa4cf8346a2407efc2121a8fd09749a8f8b874494a51ec261618d6177891fc9346bdb1b4c6f03f7bc7f8e20aebbcd8632282cf2f3
-  data.tar.gz: fbd2b1cf99d7ebaac67b7966f8aa4a4e9fa0a0f50c05e9427d93d5af771bae6ae09370488e711559fe036da4dc177c335483b354880b23129e2e05d6d0e39c33
+  metadata.gz: 20df5b0a36e0b31c0b6276adccdab2e78394a976c4a78571114ef5ca5103cc0c1d42ec6bec7946c123097dbc9dcf0039df8b165b91de202df8d2debf61f4f6fe
+  data.tar.gz: 93d14018a063366b3d74c7941a91a40c92be52b89dbd4106c246f9c0a8f812f71b5cc93604c17e15a76a5d4f0b3f3d18e358b69e182d3bb2d90480154af16f95

data/lib/rails-erb-lint/helpers/rails_erb_check.rb

@@ -1,13 +1,23 @@
 require 'action_view'
 
 module RailsErbCheck
-  def self.valid_syntax?(erb)
-    begin
-      ActionView::Template::Handlers::Erubis.new(erb).result
-    rescue SyntaxError
-      return false
-    rescue Exception
-      return true
+  class Checker
+    attr_reader :error
+
+    def initialize(erb_path)
+      @erb = File.read(erb_path)
+    end
+
+    def valid_syntax?
+      begin
+        ActionView::Template::Handlers::Erubis.new(@erb).result
+      rescue SyntaxError => e
+        @error = e
+        return false
+      rescue Exception
+        return true
+      end
     end
+
   end
 end

data/lib/rails-erb-lint/linter/check_validity.rb

@@ -1,7 +1,10 @@
-require 'gli'
-require 'action_view'
-require 'find'
-require 'rainbow'
+['action_view',
+ 'find',
+ 'gli',
+ 'json',
+ 'rainbow'].each do |d|
+  require d
+end
 
 require_relative '../helpers/rails_erb_check'
 
@@ -9,31 +12,91 @@ include GLI::App
 
 program_desc 'A simple lint tool for ERB Rails views.'
 
+def get_erb_list(path)
+  erb_files = []
+
+  Find.find(path.to_s) do |f|
+    next if FileTest.directory?(f)
+    if /.*\.erb/.match(File.basename(f))
+      erb_files << f
+    end
+  end
+
+  erb_files
+end
+
+def check_files(erbs, options)
+  files = {}
+
+  erbs.each do |f|
+    checker = RailsErbCheck::Checker.new(f)
+
+    if checker.valid_syntax?
+      puts Rainbow("#{f} => valid").green if options[:valid]
+      files[f] = { invalid: false }
+    else
+      puts Rainbow("#{f} => invalid").red
+      puts checker.error.message if options[:error]
+      files[f] = {
+        invalid: true,
+        error: checker.error.message,
+        backtrace: checker.error.backtrace
+      }
+    end
+  end
+
+  files
+end
+
+def export_json(hash, path)
+  File.open(path, 'w') do |file|
+    JSON.dump(hash, file)
+  end
+end
+
 desc 'Check for syntax errors on views'
 command :check do |c|
-  c.switch :verbose, default_value: false
-  c.action do |global_options, options|
-    valid = []
-    invalid = []
-    erb_files = []
+  c.switch [:v, :valid], {
+    default_value: false,
+    arg_name: 'valid',
+    desc: 'print valid files along with invalid files'
+  }
+
+  c.switch [:e, :error], {
+    default_value: false,
+    arg_name: 'error',
+    desc: 'print errors associated with invalid files'
+  }
 
-    path = Dir.getwd
+  c.flag [:j, :json], {
+    default_value: nil,
+    arg_name: 'json-file',
+    type: String,
+    desc: 'Export a json file with results, also exports valid files when coupled with -v'
+  }
+
+  c.flag [:p, :path], {
+    default_value: Dir.getwd,
+    arg_name: 'path',
+    type: String,
+    desc: 'specify the path that should be used as the root of the check'
+  }
+
+  c.action do |global_options, options|
+    path = options[:path]
     puts Rainbow("Checking for files in current directory: #{path}").green
 
-    Find.find(path.to_s) do |f|
-      next if FileTest.directory?(f)
-      if /.*\.erb/.match(File.basename(f))
-        erb_files << f
-      end
-    end
+    erbs  = get_erb_list(path)
+    files = check_files(erbs, options)
+
+    valid   = files.reject { |file, info| info[:invalid] }
+    invalid = files.select { |file, info| info[:invalid] }
 
-    erb_files.each do |f|
-      if RailsErbCheck.valid_syntax?(File.read(f))
-        puts Rainbow("#{f} => valid").green if options[:verbose]
-        valid << f
+    if options[:json]
+      if options[:valid]
+        export_json(files, options[:json])
       else
-        puts Rainbow("#{f} => invalid").red
-        invalid << f
+        export_json(invalid, options[:json])
       end
     end
 

data/lib/rails-erb-lint/version.rb

@@ -1,3 +1,3 @@
 module RailsErbLint
-  VERSION = '1.1.6'
+  VERSION = '1.2.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rails-erb-lint
 version: !ruby/object:Gem::Version
-  version: 1.1.6
+  version: 1.2.0
 platform: ruby
 authors:
 - Katherine Pe
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-02-02 00:00:00.000000000 Z
+date: 2016-08-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -66,6 +66,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '4.0'
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: builder
   requirement: !ruby/object:Gem::Requirement