rufo 0.11.0 → 0.12.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8880f0f88e4def3cc19a1fa8a54b7fe7f5393e6cdb93f47a19c1565a7564ed2f
-  data.tar.gz: 74f522f20caa7d57bc9607d3dc6100b1a48758cc72a18dcaf85c0ab5e1c66e9b
+  metadata.gz: 87b9e11a2d83bf366134074b750fca515da61d65c626ad4a85cb029b3246f314
+  data.tar.gz: 5f2caf3f22b5b7e8411e7a35f9e73c27bfd7a92f7f8246f3099ed98ecacef359
 SHA512:
-  metadata.gz: c6de4f9c31d85b4bbcc39c8873c7fc677da69b07c1600620811253d44fa8e67e51a1ecdbd7156c81523f6b2285bccb038e5dbf99a3b09104a48ab253edf43da5
-  data.tar.gz: a7d27577fcedab3672924b89aeb15ddd117ed31802fda6e8b987c0bcaa8449adce45f573ce2c74c381ef39fba7c97d0d9efefc8de5f321d87d9cbeccdd245672
+  metadata.gz: 00742ceee28433e130ccceffd31ee41a8a827135d3f986f552d42821e62acc6b5a7c795771c5bdea5ec46069374a1ca014f964ca21fcd425240ffeedc101b72f
+  data.tar.gz: ade0daa5611c2cbe51f9bf59de4df7750aaac6ecec829eaad97b9f478cba2d5f5a4671ac054c9d2850f5b1758b07881b51474e94a1cbe754f02a6348ccaa1607

data/.circleci/config.yml

@@ -28,6 +28,9 @@
                             --format RspecJunitFormatter \
                             --out test_results/rspec.xml \
                             --format progress
+    - run:
+          name: Upload code coverage
+          command: bash <(curl -s https://codecov.io/bash) -f 'coverage/coverage.xml'
     - run:
         name: Run RuboCop
         command: |
@@ -53,7 +56,6 @@
     - store_test_results:
         path: test_results
 
-
 version: 2
 jobs:
   build-2-7-0:
@@ -96,6 +98,7 @@ jobs:
           BUNDLE_JOBS: "3"
           BUNDLE_RETRY: "3"
           BUNDLE_PATH: vendor/bundle
+
 workflows:
   version: 2
   test:

data/CHANGELOG.md

@@ -12,6 +12,20 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.
 
 ### Added
 
+## [0.12.0] - 2020-03-08
+
+### Fixed
+- File.read default encode UTF-8
+- Handle case where the code is invalid but ripper does not raise an error.
+- Removed implicit dependency on `rake`.
+- Error when semicolon and then used in a case statement #230.
+
+### Changed
+
+### Added
+- Code coverage tracking with codecov.io
+- `node_modules` folders are now ignored.
+
 ## [0.11.0] - 2020-02-09
 
 ### Fixed

data/lib/rufo.rb

@@ -2,6 +2,7 @@
 
 module Rufo
   class Bug < StandardError; end
+  class UnknownSyntaxError < StandardError; end
 
   class SyntaxError < StandardError
     attr_reader :lineno
@@ -25,4 +26,5 @@ require_relative "rufo/parser"
 require_relative "rufo/formatter"
 require_relative "rufo/erb_formatter"
 require_relative "rufo/version"
+require_relative "rufo/file_list"
 require_relative "rufo/file_finder"

data/lib/rufo/command.rb

@@ -54,6 +54,9 @@ class Rufo::Command
   rescue Rufo::SyntaxError => e
     logger.error("STDIN is invalid code. Error on line:#{e.lineno} #{e.message}")
     CODE_ERROR
+  rescue Rufo::UnknownSyntaxError
+    logger.error("STDIN is invalid code. Try running the code for a better error.")
+    CODE_ERROR
   rescue => e
     logger.error("You've found a bug!")
     logger.error("Please report it to https://github.com/ruby-formatter/rufo/issues with code that triggers it\n")
@@ -96,7 +99,7 @@ class Rufo::Command
 
   def format_file(filename)
     logger.debug("Formatting: #{filename}")
-    code = File.read(filename)
+    code = File.read(filename, encoding: "UTF-8")
 
     begin
       location = @filename_for_dot_rufo || File.dirname(filename)
@@ -122,6 +125,9 @@ class Rufo::Command
   rescue Rufo::SyntaxError => e
     logger.error("#{filename}:#{e.lineno} #{e.message}")
     CODE_ERROR
+  rescue Rufo::UnknownSyntaxError
+    logger.error("#{filename} is invalid code. Try running the code for a better error.")
+    CODE_ERROR
   rescue => e
     logger.error("You've found a bug!")
     logger.error("It happened while trying to format the file #{filename}")

data/lib/rufo/file_finder.rb

@@ -1,6 +1,3 @@
-require "find"
-require "rake/file_list"
-
 class Rufo::FileFinder
   include Enumerable
 
@@ -31,12 +28,9 @@ class Rufo::FileFinder
     *EXTENSIONS,
   ]
 
-  EXCLUDED_DIRS = [
-    "vendor",
-  ]
-
   EXCLUDE_PATTERNS = [
     "vendor/**/*",
+    "node_modules/**/*",
   ]
 
   def initialize(files_or_dirs, includes: [], excludes: [])
@@ -69,7 +63,7 @@ class Rufo::FileFinder
   end
 
   def build_file_list
-    fl = Rake::FileList.new(*DEFAULT_PATTERNS)
+    fl = Rufo::FileList.new(*DEFAULT_PATTERNS)
     fl.exclude(*EXCLUDE_PATTERNS)
     fl.exclude(*excludes)
     fl.include(*includes)

data/lib/rufo/file_list.rb

@@ -0,0 +1,244 @@
+# frozen_string_literal: true
+
+# This file is based on https://github.com/ruby/rake/blob/master/lib/rake/file_list.rb
+# Git commit: 5b8f8fc41a5d7d7d6a5d767e48464c60884d3aee
+
+module Rufo
+
+  ##
+  # A FileList is essentially an array with a few helper methods defined to
+  # make file manipulation a bit easier.
+  #
+  # FileLists are lazy.  When given a list of glob patterns for possible files
+  # to be included in the file list, instead of searching the file structures
+  # to find the files, a FileList holds the pattern for latter use.
+  #
+  # This allows us to define a number of FileList to match any number of
+  # files, but only search out the actual files when then FileList itself is
+  # actually used.  The key is that the first time an element of the
+  # FileList/Array is requested, the pending patterns are resolved into a real
+  # list of file names.
+  #
+  class FileList
+
+    # == Method Delegation
+    #
+    # The lazy evaluation magic of FileLists happens by implementing all the
+    # array specific methods to call +resolve+ before delegating the heavy
+    # lifting to an embedded array object (@items).
+    #
+    # In addition, there are two kinds of delegation calls.  The regular kind
+    # delegates to the @items array and returns the result directly.  Well,
+    # almost directly.  It checks if the returned value is the @items object
+    # itself, and if so will return the FileList object instead.
+    #
+    # The second kind of delegation call is used in methods that normally
+    # return a new Array object.  We want to capture the return value of these
+    # methods and wrap them in a new FileList object.  We enumerate these
+    # methods in the +SPECIAL_RETURN+ list below.
+
+    # List of array methods (that are not in +Object+) that need to be
+    # delegated.
+    ARRAY_METHODS = (Array.instance_methods - Object.instance_methods).map(&:to_s)
+
+    # List of additional methods that must be delegated.
+    MUST_DEFINE = %w[inspect <=>]
+
+    # List of methods that should not be delegated here (we define special
+    # versions of them explicitly below).
+    MUST_NOT_DEFINE = %w[to_a to_ary partition * <<]
+
+    # List of delegated methods that return new array values which need
+    # wrapping.
+    SPECIAL_RETURN = %w[
+      map collect sort sort_by select find_all reject grep
+      compact flatten uniq values_at
+      + - & |
+    ]
+
+    DELEGATING_METHODS = (ARRAY_METHODS + MUST_DEFINE - MUST_NOT_DEFINE).map(&:to_s).sort.uniq
+
+    # Now do the delegation.
+    DELEGATING_METHODS.each do |sym|
+      if SPECIAL_RETURN.include?(sym)
+        ln = __LINE__ + 1
+        class_eval %{
+          def #{sym}(*args, &block)
+            resolve
+            result = @items.send(:#{sym}, *args, &block)
+            self.class.new.import(result)
+          end
+        }, __FILE__, ln
+      else
+        ln = __LINE__ + 1
+        class_eval %{
+          def #{sym}(*args, &block)
+            resolve
+            result = @items.send(:#{sym}, *args, &block)
+            result.object_id == @items.object_id ? self : result
+          end
+        }, __FILE__, ln
+      end
+    end
+
+    GLOB_PATTERN = %r{[*?\[\{]}
+
+    # Create a file list from the globbable patterns given.  If you wish to
+    # perform multiple includes or excludes at object build time, use the
+    # "yield self" pattern.
+    #
+    # Example:
+    #   file_list = FileList.new('lib/**/*.rb', 'test/test*.rb')
+    #
+    #   pkg_files = FileList.new('lib/**/*') do |fl|
+    #     fl.exclude(/\bCVS\b/)
+    #   end
+    #
+    def initialize(*patterns)
+      @pending_add = []
+      @pending = false
+      @exclude_patterns = DEFAULT_IGNORE_PATTERNS.dup
+      @exclude_procs = DEFAULT_IGNORE_PROCS.dup
+      @items = []
+      patterns.each { |pattern| include(pattern) }
+      yield self if block_given?
+    end
+
+    # Add file names defined by glob patterns to the file list.  If an array
+    # is given, add each element of the array.
+    #
+    # Example:
+    #   file_list.include("*.java", "*.cfg")
+    #   file_list.include %w( math.c lib.h *.o )
+    #
+    def include(*filenames)
+      filenames.each do |fn|
+        @pending_add << fn
+      end
+      @pending = true
+      self
+    end
+
+    alias :add :include
+
+    # Register a list of file name patterns that should be excluded from the
+    # list.  Patterns may be regular expressions, glob patterns or regular
+    # strings.  In addition, a block given to exclude will remove entries that
+    # return true when given to the block.
+    #
+    # Note that glob patterns are expanded against the file system. If a file
+    # is explicitly added to a file list, but does not exist in the file
+    # system, then an glob pattern in the exclude list will not exclude the
+    # file.
+    #
+    # Examples:
+    #   FileList['a.c', 'b.c'].exclude("a.c") => ['b.c']
+    #   FileList['a.c', 'b.c'].exclude(/^a/)  => ['b.c']
+    #
+    # If "a.c" is a file, then ...
+    #   FileList['a.c', 'b.c'].exclude("a.*") => ['b.c']
+    #
+    # If "a.c" is not a file, then ...
+    #   FileList['a.c', 'b.c'].exclude("a.*") => ['a.c', 'b.c']
+    #
+    def exclude(*patterns, &block)
+      patterns.each do |pat|
+        @exclude_patterns << pat
+      end
+      @exclude_procs << block if block_given?
+      resolve_exclude unless @pending
+      self
+    end
+
+    # Return the internal array object.
+    def to_a
+      resolve
+      @items
+    end
+
+    def <<(obj)
+      resolve
+      @items << obj
+      self
+    end
+
+    # Resolve all the pending adds now.
+    def resolve
+      if @pending
+        @pending = false
+        @pending_add.each do |fn| resolve_add(fn) end
+        @pending_add = []
+        resolve_exclude
+      end
+      self
+    end
+
+    def resolve_add(filename) # :nodoc:
+      case filename
+      when GLOB_PATTERN
+        add_matching(filename)
+      else
+        self << filename
+      end
+    end
+
+    private :resolve_add
+
+    def resolve_exclude # :nodoc:
+      reject! { |fn| excluded_from_list?(fn) }
+      self
+    end
+
+    private :resolve_exclude
+    # Convert a FileList to a string by joining all elements with a space.
+    def to_s
+      resolve
+      self.join(" ")
+    end
+
+    # Add matching glob patterns.
+    def add_matching(pattern)
+      self.class.glob(pattern).each do |fn|
+        self << fn unless excluded_from_list?(fn)
+      end
+    end
+
+    private :add_matching
+
+    # Should the given file name be excluded from the list?
+    def excluded_from_list?(filename)
+      return true if @exclude_patterns.any? do |pat|
+        case pat
+        when Regexp
+          filename =~ pat
+        when GLOB_PATTERN
+          flags = File::FNM_PATHNAME
+          flags |= File::FNM_EXTGLOB
+          File.fnmatch?(pat, filename, flags)
+        else
+          filename == pat
+        end
+      end
+      @exclude_procs.any? { |p| p.call(filename) }
+    end
+
+    DEFAULT_IGNORE_PATTERNS = [
+      /(^|[\/\\])CVS([\/\\]|$)/,
+      /(^|[\/\\])\.svn([\/\\]|$)/,
+      /\.bak$/,
+      /~$/,
+    ]
+    DEFAULT_IGNORE_PROCS = [
+      proc { |fn| fn =~ /(^|[\/\\])core$/ && !File.directory?(fn) },
+    ]
+
+    class << self
+      # Get a sorted list of files matching the pattern. This method
+      # should be preferred to Dir[pattern] and Dir.glob(pattern) because
+      # the files returned are guaranteed to be sorted.
+      def glob(pattern, *args)
+        Dir.glob(pattern, *args).sort
+      end
+    end
+  end
+end

data/lib/rufo/formatter.rb

@@ -21,7 +21,10 @@ class Rufo::Formatter
 
     # sexp being nil means that the code is not valid.
     # Parse the code so we get better error messages.
-    Rufo::Parser.parse(code) if @sexp.nil?
+    if @sexp.nil?
+      Rufo::Parser.parse(code)
+      raise Rufo::UnknownSyntaxError # Sometimes parsing does not raise an error
+    end
 
     @indent = 0
     @line = 0
@@ -2924,10 +2927,23 @@ class Rufo::Formatter
       visit_comma_separated_list conds
       skip_space
     end
+    written_space = false
+    if semicolon?
+      inline = true
+      skip_semicolons
+
+      if newline? || comment?
+        inline = false
+      else
+        write ";"
+        track_case_when
+        write " "
+        written_space = true
+      end
+    end
 
-    then_keyword = keyword?("then")
-    inline = then_keyword || semicolon?
-    if then_keyword
+    if keyword?("then")
+      inline = true
       next_token
 
       skip_space
@@ -2941,7 +2957,7 @@ class Rufo::Formatter
         # Cancel tracking of `case when ... then` on a nelwine.
         @case_when_positions.pop
       else
-        write_space
+        write_space unless written_space
 
         write "then"
 
@@ -2964,16 +2980,6 @@ class Rufo::Formatter
 
         write_space
       end
-    elsif semicolon?
-      skip_semicolons
-
-      if newline? || comment?
-        inline = false
-      else
-        write ";"
-        track_case_when
-        write " "
-      end
     end
 
     if inline

data/lib/rufo/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Rufo
-  VERSION = "0.11.0"
+  VERSION = "0.12.0"
 end

data/rufo.gemspec

@@ -29,4 +29,6 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "rspec", "~> 3.0"
   spec.add_development_dependency "rspec_junit_formatter", "~> 0.4.1"
   spec.add_development_dependency "rubocop", "~> 0.79.0"
+  spec.add_development_dependency "simplecov", "~> 0.18.5"
+  spec.add_development_dependency "simplecov-cobertura", "~> 1.3.1"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rufo
 version: !ruby/object:Gem::Version
-  version: 0.11.0
+  version: 0.12.0
 platform: ruby
 authors:
 - Ary Borenszweig
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-02-09 00:00:00.000000000 Z
+date: 2020-03-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -108,6 +108,34 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 0.79.0
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.18.5
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.18.5
+- !ruby/object:Gem::Dependency
+  name: simplecov-cobertura
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.3.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.3.1
 description: Fast and unobtrusive Ruby code formatter
 email:
 - asterite@gmail.com
@@ -140,6 +168,7 @@ files:
 - lib/rufo/dot_file.rb
 - lib/rufo/erb_formatter.rb
 - lib/rufo/file_finder.rb
+- lib/rufo/file_list.rb
 - lib/rufo/formatter.rb
 - lib/rufo/logger.rb
 - lib/rufo/parser.rb
@@ -166,7 +195,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
+rubygems_version: 3.1.2
 signing_key: 
 specification_version: 4
 summary: Ruby code formatter