rufo 0.5.1 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 35513ffcbf662415975c643eb3dff524ef01b969b64505f221ee2bee96390492
-  data.tar.gz: f23d854af35a0ffbe302537d9d2483ef6f0500dfa9428babe66bca83a4bb81c0
+  metadata.gz: aa747d46eb2f8eaa95accca56c9bf814ef98d4c25552d5085e762ba33b5cdb8d
+  data.tar.gz: bc673bd377a04373a6e9bc9d6aee18abacea6bf9f5c478e0b5100cf91f7dcb24
 SHA512:
-  metadata.gz: 51922a71d81402c5d56ff33cd6c1290fa917607b2a1dd934630098061942cef54f394552fa8975949137f02e824663563a2bdebdcfcf4e89a5239c02c0810e43
-  data.tar.gz: b93dd700b63aa8fa8a9d3444b9cec9b996e9d031f474cab5c45a26d8768f991b89baf819be42483362c61bcfd7dedac955fd8ec1f82270f76a0db55faae31413
+  metadata.gz: d767e3d5061c3076b7cb976335a838816fba1eb0c7815145fc286479acbd978dadf203b0c59b62957dab27d41a0ab171f8dbb5d9f5aa20a60bdcf95c40beece1
+  data.tar.gz: df23b0d9cf4ac9d72fa17d5daeaaabf5fec0ac581dc53eabb5991f18a330e93b4f79b66e7f4ef59e8e34f8503bdfe81bf23dedd328cf517ff307d49556921d3f

data/.circleci/config.yml

@@ -41,7 +41,7 @@
     - run:
         name: Run Rufo
         command: |
-          bundle exec rake rufo:run['lib spec exe/rufo rakelib Rakefile rufo.gemspec']
+          bundle exec rake rufo:run
 
     # Save test results for timing analysis
     - store_test_results:
@@ -58,26 +58,18 @@ jobs:
           BUNDLE_JOBS: "3"
           BUNDLE_RETRY: "3"
           BUNDLE_PATH: vendor/bundle
-  build-2-5-1:
+  build-2-5-3:
     <<: *dockerbuild
     docker:
-      - image: circleci/ruby:2.5.1
+      - image: circleci/ruby:2.5.3
         environment:
           BUNDLE_JOBS: "3"
           BUNDLE_RETRY: "3"
           BUNDLE_PATH: vendor/bundle
-  build-2-4-4:
+  build-2-4-5:
     <<: *dockerbuild
     docker:
-      - image: circleci/ruby:2.4.4
-        environment:
-          BUNDLE_JOBS: "3"
-          BUNDLE_RETRY: "3"
-          BUNDLE_PATH: vendor/bundle
-  build-2-3-7:
-    <<: *dockerbuild
-    docker:
-      - image: circleci/ruby:2.3.7
+      - image: circleci/ruby:2.4.5
         environment:
           BUNDLE_JOBS: "3"
           BUNDLE_RETRY: "3"
@@ -87,6 +79,5 @@ workflows:
   test:
     jobs:
       - build-2-6-1
-      - build-2-5-1
-      - build-2-4-4
-      - build-2-3-7
+      - build-2-5-3
+      - build-2-4-5

data/.rubocop.yml

@@ -2,7 +2,7 @@ AllCops:
   Exclude:
     - "spec/**/*"
     - "vendor/**/*"
-  TargetRubyVersion: 2.3
+  TargetRubyVersion: 2.4
 
 Layout:
   Enabled: false

data/CHANGELOG.md

@@ -10,6 +10,21 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.
 
 ### Added
 
+### Changed
+
+## [0.6.0] - 2019-03-04
+
+### Fixed
+- Fix odd indentation of nested one liner "if" statements (issue [128](https://github.com/ruby-formatter/rufo/issues/128))
+
+### Added
+- Ignore `vendor` directories from files to be checked. This allows rufo to be run without any arguments against a directory both locally and on common CI tools without needing any configuration.
+- Allow logging level to be configured with `--loglevel[=LEVEL]`.
+
+### Changed
+- Dropped support for ruby 2.3 as it is end of life.
+- Remove space before paren for short lambda syntax `-> () {}` becomes `->() {}`.
+
 ## [0.5.1] - 2019-02-13
 
 ### Fixed

data/lib/rufo.rb

@@ -11,6 +11,7 @@ module Rufo
 end
 
 require_relative "rufo/command"
+require_relative "rufo/logger"
 require_relative "rufo/dot_file"
 require_relative "rufo/settings"
 require_relative "rufo/formatter"

data/lib/rufo/command.rb

@@ -8,16 +8,17 @@ class Rufo::Command
   CODE_CHANGE = 3
 
   def self.run(argv)
-    want_check, exit_code, filename_for_dot_rufo = parse_options(argv)
-    new(want_check, exit_code, filename_for_dot_rufo).run(argv)
+    want_check, exit_code, filename_for_dot_rufo, loglevel = parse_options(argv)
+    new(want_check, exit_code, filename_for_dot_rufo, loglevel).run(argv)
   end
 
-  def initialize(want_check, exit_code, filename_for_dot_rufo)
+  def initialize(want_check, exit_code, filename_for_dot_rufo, loglevel)
     @want_check = want_check
     @exit_code = exit_code
     @filename_for_dot_rufo = filename_for_dot_rufo
     @dot_file = Rufo::DotFile.new
     @squiggly_warning_files = []
+    @logger = Rufo::Logger.new(loglevel)
   end
 
   def exit_code(status_code)
@@ -51,12 +52,11 @@ class Rufo::Command
 
     code == result ? CODE_OK : CODE_CHANGE
   rescue Rufo::SyntaxError
-    STDERR.puts "Error: the given text is not a valid ruby program (it has syntax errors)"
+    logger.error("Error: the given text is not a valid ruby program (it has syntax errors)")
     CODE_ERROR
   rescue => ex
-    STDERR.puts "You've found a bug!"
-    STDERR.puts "Please report it to https://github.com/ruby-formatter/rufo/issues with code that triggers it"
-    STDERR.puts
+    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")
     raise ex
   end
 
@@ -72,7 +72,7 @@ class Rufo::Command
       if exists
         files_exist = true
       else
-        STDERR.puts "Error: file or directory not found: #{file}"
+        logger.warn("Error: file or directory not found: #{file}")
         next
       end
       result = format_file(file)
@@ -83,8 +83,6 @@ class Rufo::Command
 
     return CODE_ERROR unless files_exist
 
-    STDERR.puts squiggly_heredoc_warning unless @squiggly_warning_files.empty?
-
     case
     when syntax_error then CODE_ERROR
     when changed      then CODE_CHANGE
@@ -92,30 +90,8 @@ class Rufo::Command
     end
   end
 
-  def squiggly_heredoc_warning
-    <<-WARNING
-Rufo Warning!
-  File#{squiggly_pluralize} #{squiggly_warning_files} #{squiggly_pluralize(:has)} not been formatted due to a problem with Ruby version #{RUBY_VERSION}
-  Please update to Ruby #{backported_version} to fix your formatting!
-  See https://github.com/ruby-formatter/rufo/wiki/Squiggly-Heredocs for information.
-    WARNING
-  end
-
-  def squiggly_pluralize(word = :s)
-    idx = word == :s ? 0 : 1
-    (@squiggly_warning_files.length > 1 ? ["s", "have"] : ["", "has"])[idx]
-  end
-
-  def squiggly_warning_files
-    @squiggly_warning_files.join(", ")
-  end
-
-  def backported_version
-    return "2.3.7" if RUBY_VERSION[0..2] == "2.3"
-    "2.4.4"
-  end
-
   def format_file(filename)
+    logger.debug("Formatting: #{filename}")
     code = File.read(filename)
 
     begin
@@ -123,32 +99,27 @@ Rufo Warning!
     rescue Rufo::SyntaxError
       # We ignore syntax errors as these might be template files
       # with .rb extension
-      STDERR.puts "Error: #{filename} has syntax errors"
+      logger.warn("Error: #{filename} has syntax errors")
       return CODE_ERROR
     end
 
     if code.force_encoding(result.encoding) != result
       if @want_check
-        STDERR.puts "Formatting #{filename} produced changes"
+        logger.warn("Formatting #{filename} produced changes")
       else
-        unless @squiggly_warning
-          File.write(filename, result)
-          puts "Format: #{filename}"
-        else
-          @squiggly_warning_files << filename
-        end
+        File.write(filename, result)
+        logger.log("Format: #{filename}")
       end
 
       return CODE_CHANGE
     end
   rescue Rufo::SyntaxError
-    STDERR.puts "Error: the given text in #{filename} is not a valid ruby program (it has syntax errors)"
+    logger.error("Error: the given text in #{filename} is not a valid ruby program (it has syntax errors)")
     CODE_ERROR
   rescue => ex
-    STDERR.puts "You've found a bug!"
-    STDERR.puts "It happened while trying to format the file #{filename}"
-    STDERR.puts "Please report it to https://github.com/ruby-formatter/rufo/issues with code that triggers it"
-    STDERR.puts
+    logger.error("You've found a bug!")
+    logger.error("It happened while trying to format the file #{filename}")
+    logger.error("Please report it to https://github.com/ruby-formatter/rufo/issues with code that triggers it\n")
     raise ex
   end
 
@@ -162,13 +133,13 @@ Rufo Warning!
     end
     formatter.format
     result = formatter.result
-    @squiggly_warning = true if formatter.squiggly_flag
     result
   end
 
   def self.parse_options(argv)
     exit_code, want_check = true, false
     filename_for_dot_rufo = nil
+    loglevel = :log
 
     OptionParser.new do |opts|
       opts.version = Rufo::VERSION
@@ -186,12 +157,20 @@ Rufo Warning!
         exit_code = false
       end
 
+      opts.on(Rufo::Logger::LEVELS, "--loglevel[=LEVEL]", "Change the level of logging for the CLI. Options are: error, warn, log (default), debug, silent") do |value|
+        loglevel = value.to_sym
+      end
+
       opts.on("-h", "--help", "Show this help") do
         puts opts
         exit
       end
     end.parse!(argv)
 
-    [want_check, exit_code, filename_for_dot_rufo]
+    [want_check, exit_code, filename_for_dot_rufo, loglevel]
   end
+
+  private
+
+  attr_reader :logger
 end

data/lib/rufo/file_finder.rb

@@ -1,3 +1,5 @@
+require "find"
+
 class Rufo::FileFinder
   include Enumerable
 
@@ -7,7 +9,22 @@ class Rufo::FileFinder
     "Rakefile",
     "rakefile.rb",
     "Rakefile.rb",
-  ].join(",")
+  ]
+
+  FILENAMES = [
+    "Gemfile",
+    *RAKEFILES,
+  ]
+
+  EXTENSIONS = [
+    ".rb",
+    ".gemspec",
+    ".rake",
+  ]
+
+  EXCLUDED_DIRS = [
+    "vendor",
+  ]
 
   def initialize(files_or_dirs)
     @files_or_dirs = files_or_dirs
@@ -28,9 +45,17 @@ class Rufo::FileFinder
   attr_reader :files_or_dirs
 
   def all_rb_files(file_or_dir)
-    Dir.glob(
-      File.join(file_or_dir, "**", "{*.rb,Gemfile,*.gemspec,#{RAKEFILES},*.rake}"),
-      File::FNM_EXTGLOB
-    ).select(&File.method(:file?))
+    files = []
+    Find.find(file_or_dir) do |path|
+      basename = File.basename(path)
+      if File.directory?(path)
+        Find.prune if EXCLUDED_DIRS.include?(basename)
+      else
+        if EXTENSIONS.include?(File.extname(basename)) || FILENAMES.include?(basename)
+          files << path
+        end
+      end
+    end
+    files
   end
 end

data/lib/rufo/formatter.rb

@@ -7,8 +7,6 @@ class Rufo::Formatter
 
   INDENT_SIZE = 2
 
-  attr_reader :squiggly_flag
-
   def self.format(code, **options)
     formatter = new(code, **options)
     formatter.format
@@ -16,7 +14,6 @@ class Rufo::Formatter
   end
 
   def initialize(code, **options)
-    @squiggly_flag = false
     @code = code
     @tokens = Ripper.lex(code).reverse!
     @sexp = Ripper.sexp(code)
@@ -242,9 +239,6 @@ class Rufo::Formatter
     when :@tstring_content
       # [:@tstring_content, "hello ", [1, 1]]
       heredoc, tilde = @current_heredoc
-      if heredoc && tilde && broken_ripper_version?
-        @squiggly_flag = true
-      end
       looking_at_newline = current_token_kind == :on_tstring_content && current_token_value == "\n"
       if heredoc && tilde && !@last_was_newline && looking_at_newline
         check :on_tstring_content
@@ -2549,8 +2543,7 @@ class Rufo::Formatter
     write "->"
     next_token
 
-    first_space = skip_space
-    write_space_using_setting(first_space, :one)
+    skip_space
 
     if empty_params?(params)
       if current_token_kind == :on_lparen
@@ -2562,16 +2555,18 @@ class Rufo::Formatter
       end
     else
       visit params
-      consume_space
     end
 
     if void_exps?(body)
+      consume_space
       consume_token :on_tlambeg
       consume_space
       consume_token :on_rbrace
       return
     end
 
+    consume_space
+
     brace = current_token_value == "{"
 
     if brace
@@ -2825,7 +2820,7 @@ class Rufo::Formatter
     if (else_body = node[3])
       # [:else, else_contents]
       # [:elsif, cond, then, else]
-      write_indent
+      write_indent if @line != line
 
       case else_body[0]
       when :else
@@ -3808,12 +3803,6 @@ class Rufo::Formatter
     end
   end
 
-  def broken_ripper_version?
-    version, teeny = RUBY_VERSION[0..2], RUBY_VERSION[4..4].to_i
-    (version == "2.3" && teeny < 5) ||
-      (version == "2.4" && teeny < 2)
-  end
-
   def remove_lines_before_inline_declarations
     return if @inline_declarations.empty?
 

data/lib/rufo/logger.rb

@@ -0,0 +1,39 @@
+module Rufo
+  class Logger
+    LEVELS = {
+      silent: 0,
+      error: 1,
+      warn: 2,
+      log: 3,
+      debug: 4,
+    }
+
+    def initialize(level)
+      @level = LEVELS.fetch(level)
+    end
+
+    def debug(*args)
+      $stdout.puts(*args) if should_output?(:debug)
+    end
+
+    def log(*args)
+      $stdout.puts(*args) if should_output?(:log)
+    end
+
+    def warn(*args)
+      $stderr.puts(*args) if should_output?(:warn)
+    end
+
+    def error(*args)
+      $stderr.puts(*args) if should_output?(:error)
+    end
+
+    private
+
+    attr_reader :level
+
+    def should_output?(level_to_check)
+      LEVELS.fetch(level_to_check) <= level
+    end
+  end
+end

data/lib/rufo/version.rb

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

data/rufo.gemspec

@@ -20,7 +20,7 @@ Gem::Specification.new do |spec|
   spec.bindir = "exe"
   spec.executables = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
-  spec.required_ruby_version = ">= 2.3.5"
+  spec.required_ruby_version = ">= 2.4.5"
 
   spec.add_development_dependency "bundler", ">= 1.15"
   spec.add_development_dependency "byebug", "~> 10.0.2"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rufo
 version: !ruby/object:Gem::Version
-  version: 0.5.1
+  version: 0.6.0
 platform: ruby
 authors:
 - Ary Borenszweig
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-02-13 00:00:00.000000000 Z
+date: 2019-03-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -139,6 +139,7 @@ files:
 - lib/rufo/dot_file.rb
 - lib/rufo/file_finder.rb
 - lib/rufo/formatter.rb
+- lib/rufo/logger.rb
 - lib/rufo/settings.rb
 - lib/rufo/version.rb
 - rakelib/rufo.rake
@@ -155,7 +156,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.3.5
+      version: 2.4.5
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="