slim_lint 0.5.0 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e6369991d47446420b433e59002ca420cb12ffec
-  data.tar.gz: a6c4a34cffad4c9e8c3296e28c08b47ae558acdf
+  metadata.gz: 8c2a57fa0d9dc24917ca85379e01546e917ec092
+  data.tar.gz: 13144b73104ca05aa05e0d23bef2ed71b9130529
 SHA512:
-  metadata.gz: 87d930b8e8514e0233e94ba2ace9c2d8fb338429f6d3846f566b95a54daceadb0a6840d5af893dd6e885d0af254bf17ace8033704e9adb609612d862effeb12e
-  data.tar.gz: c29bebcc2db97f8908130338ad4922af655646a7eed40c36b9019b56e427a7b6a324daf468ff6a2acb3b9777294e157700e48b620538898a88303ee11eb9f5fc
+  metadata.gz: fe1ff6f1c59b1b97cff345874117a89851ccda90bd71fbace6d4f6663d4a71b316780d34a59e3ef5fb564e59d249edb4ebaad26c14808c9a15ffcfb31a9ac55f
+  data.tar.gz: 1827561fb1b2107d2006ec8105f969d740e5486a7cfdc1366182fb02595d98329d5fb54046636e0cb5eb25d16308a155f7d24593166e1cab37c9c446fc9eb273

data/lib/slim_lint/cli.rb

@@ -5,7 +5,7 @@ require 'sysexits'
 
 module SlimLint
   # Command line application interface.
-  class CLI
+  class CLI # rubocop:disable Metrics/ClassLength
     # Create a CLI that outputs to the specified logger.
     #
     # @param logger [SlimLint::Logger]
@@ -38,8 +38,8 @@ module SlimLint
       if options[:help]
         print_help(options)
         Sysexits::EX_OK
-      elsif options[:version]
-        print_version
+      elsif options[:version] || options[:verbose_version]
+        print_version(options)
         Sysexits::EX_OK
       elsif options[:show_linters]
         print_available_linters
@@ -123,17 +123,32 @@ module SlimLint
     end
 
     # Outputs the application name and version.
-    def print_version
+    def print_version(options)
       log.log "#{SlimLint::APP_NAME} #{SlimLint::VERSION}"
+
+      if options[:verbose_version]
+        log.log "slim #{Gem.loaded_specs['slim'].version}"
+        log.log "rubocop #{Gem.loaded_specs['rubocop'].version}"
+        log.log RUBY_DESCRIPTION
+      end
     end
 
     # Outputs the backtrace of an exception with instructions on how to report
     # the issue.
-    def print_unexpected_exception(ex)
+    def print_unexpected_exception(ex) # rubocop:disable Metrics/AbcSize
       log.bold_error ex.message
       log.error ex.backtrace.join("\n")
       log.warning 'Report this bug at ', false
       log.info SlimLint::BUG_REPORT_URL
+      log.newline
+      log.success 'To help fix this issue, please include:'
+      log.log '- The above stack trace'
+      log.log '- Slim-Lint version: ', false
+      log.info SlimLint::VERSION
+      log.log '- RuboCop version: ', false
+      log.info Gem.loaded_specs['rubocop'].version
+      log.log '- Ruby version: ', false
+      log.info RUBY_VERSION
     end
   end
 end

data/lib/slim_lint/document.rb

@@ -35,8 +35,9 @@ module SlimLint
     private
 
     # @param source [String] Slim code to parse
-    # @raise [Slim::Parser::Error] if there was a problem parsing the document
+    # @raise [SlimLint::Exceptions::ParseError] if there was a problem parsing the document
     def process_source(source)
+      @source = process_encoding(source)
       @source = strip_frontmatter(source)
       @source_lines = @source.split("\n")
 
@@ -44,6 +45,14 @@ module SlimLint
       @sexp = engine.parse(source)
     end
 
+    # Ensure the string's encoding is valid.
+    #
+    # @param source [String]
+    # @return [String] source encoded in a valid encoding
+    def process_encoding(source)
+      ::Temple::Filters::Encoding.new.call(source)
+    end
+
     # Removes YAML frontmatter
     def strip_frontmatter(source)
       if config['skip_frontmatter'] &&

data/lib/slim_lint/engine.rb

@@ -28,6 +28,16 @@ module SlimLint
     #
     # @param source [String] source code to parse
     # @return [SlimLint::Sexp] parsed Sexp
-    alias_method :parse, :call
+    def parse(source)
+      call(source)
+    rescue ::Slim::Parser::SyntaxError => ex
+      # Convert to our own exception type to isolate from upstream changes
+      error = SlimLint::Exceptions::ParseError.new(ex.error,
+                                                   ex.file,
+                                                   ex.line,
+                                                   ex.lineno,
+                                                   ex.column)
+      raise error
+    end
   end
 end

data/lib/slim_lint/exceptions.rb

@@ -9,6 +9,9 @@ module SlimLint::Exceptions
   # Raised when an invalid file path is specified
   class InvalidFilePath < StandardError; end
 
+  # Raised when the Slim parser is unable to parse a template.
+  class ParseError < ::Slim::Parser::SyntaxError; end
+
   # Raised when attempting to execute `Runner` with options that would result in
   # no linters being enabled.
   class NoLintersError < StandardError; end

data/lib/slim_lint/logger.rb

@@ -22,7 +22,6 @@ module SlimLint
     #
     # @param output [String] the output to send
     # @param newline [true,false] whether to append a newline
-    # @return [nil]
     def log(output, newline = true)
       @out.print(output)
       @out.print("\n") if newline
@@ -32,7 +31,6 @@ module SlimLint
     # If output destination is not a TTY, behaves the same as {#log}.
     #
     # @param args [Array<String>]
-    # @return [nil]
     def bold(*args)
       color('1', *args)
     end
@@ -41,7 +39,6 @@ module SlimLint
     # If output destination is not a TTY, behaves the same as {#log}.
     #
     # @param args [Array<String>]
-    # @return [nil]
     def error(*args)
       color(31, *args)
     end
@@ -50,7 +47,6 @@ module SlimLint
     # If output destination is not a TTY, behaves the same as {#log}.
     #
     # @param args [Array<String>]
-    # @return [nil]
     def bold_error(*args)
       color('1;31', *args)
     end
@@ -59,7 +55,6 @@ module SlimLint
     # If output destination is not a TTY, behaves the same as {#log}.
     #
     # @param args [Array<String>]
-    # @return [nil]
     def success(*args)
       color(32, *args)
     end
@@ -68,7 +63,6 @@ module SlimLint
     # If output destination is not a TTY, behaves the same as {#log}.
     #
     # @param args [Array<String>]
-    # @return [nil]
     def warning(*args)
       color(33, *args)
     end
@@ -77,11 +71,15 @@ module SlimLint
     # If output destination is not a TTY, behaves the same as {#log}.
     #
     # @param args [Array<String>]
-    # @return [nil]
     def info(*args)
       color(36, *args)
     end
 
+    # Print a blank line.
+    def newline
+      log('')
+    end
+
     # Whether this logger is outputting to a TTY.
     #
     # @return [true,false]

data/lib/slim_lint/options.rb

@@ -94,6 +94,10 @@ module SlimLint
       parser.on_tail('-v', '--version', 'Display version') do
         @options[:version] = true
       end
+
+      parser.on_tail('-V', '--verbose-version', 'Display verbose version information') do
+        @options[:verbose_version] = true
+      end
     end
   end
 end

data/lib/slim_lint/rake_task.rb

@@ -1,5 +1,6 @@
 require 'rake'
 require 'rake/tasklib'
+require 'slim_lint/constants'
 
 module SlimLint
   # Rake task interface for slim-lint command line interface.

data/lib/slim_lint/ruby_extractor.rb

@@ -41,6 +41,7 @@ module SlimLint
     # Extracts Ruby code from Sexp representing a Slim document.
     #
     # @param sexp [SlimLint::Sexp]
+    # @return [SlimLint::RubyExtractor::RubySource]
     def extract(sexp)
       trigger_pattern_callbacks(sexp)
       RubySource.new(@source_lines.join("\n"), @source_map)

data/lib/slim_lint/runner.rb

@@ -50,8 +50,8 @@ module SlimLint
     def collect_lints(file, linter_selector, config)
       begin
         document = SlimLint::Document.new(File.read(file), file: file, config: config)
-      rescue Slim::Parser::SyntaxError => ex
-        return [SlimLint::Lint.new(nil, file, ex.line, ex.error, :error)]
+      rescue SlimLint::Exceptions::ParseError => ex
+        return [SlimLint::Lint.new(nil, file, ex.lineno, ex.error, :error)]
       end
 
       linter_selector.linters_for_file(file).map do |linter|

data/lib/slim_lint/utils.rb

@@ -65,6 +65,8 @@ module SlimLint
 
     # Calls a block of code with a modified set of environment variables,
     # restoring them once the code has executed.
+    #
+    # @param env [Hash] environment variables to set
     def with_environment(env)
       old_env = {}
       env.each do |var, value|

data/lib/slim_lint/version.rb

@@ -1,4 +1,4 @@
 # Defines the gem version.
 module SlimLint
-  VERSION = '0.5.0'
+  VERSION = '0.6.0'
 end

data/lib/slim_lint.rb

@@ -1,6 +1,9 @@
 # Load all slim-lint modules necessary to parse and lint a file.
 # Ordering here can be important depending on class references in each module.
 
+# Need to load slim before we can reference some classes or define filters
+require 'slim'
+
 require 'slim_lint/constants'
 require 'slim_lint/exceptions'
 require 'slim_lint/configuration'
@@ -13,9 +16,6 @@ require 'slim_lint/linter_registry'
 require 'slim_lint/logger'
 require 'slim_lint/version'
 
-# Need to load slim before we can define filters
-require 'slim'
-
 # Load all filters (required by SlimLint::Engine)
 Dir[File.expand_path('slim_lint/filters/*.rb', File.dirname(__FILE__))].each do |file|
   require file

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: slim_lint
 version: !ruby/object:Gem::Version
-  version: 0.5.0
+  version: 0.6.0
 platform: ruby
 authors:
 - Shane da Silva
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-05-31 00:00:00.000000000 Z
+date: 2015-06-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: slim
@@ -149,7 +149,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 1.9.3
+      version: 2.0.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
@@ -157,7 +157,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.5
+rubygems_version: 2.4.8
 signing_key: 
 specification_version: 4
 summary: Slim template linting tool