format-staged 0.0.2 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 80bea79a03480ca702efd9bec176a0a2e180e82e854c7300773b064bf4c46b1e
-  data.tar.gz: 06356777c82f354560e700aef495929f1dc7e4d0d72c08456271a3b08fd3d8cc
+  metadata.gz: de70125ce0e96109a9985370a252e9746dc9a87cb16bd49e6ac669251b6f0fa9
+  data.tar.gz: d06a10b6260cd39474a0b3854f1d6458f102c975cdc62251a97606864693dd32
 SHA512:
-  metadata.gz: bd2a7a026faf4ff75b34b69a26aba8df9ff9d18d15be75341c365a8c5bae010044010d2fe3976cd5b60ccc9e7f0d68c7a62955bc620c56b7ad3955779713ec95
-  data.tar.gz: 126334604bfac8205438d64d597638490d560db058476f4a53b673f89f2b80cbc055a3f76863d5f6489b89f132140947794cb4a0cece89ea89ea287fe6c0c5f8
+  metadata.gz: 6fe36e8bb0256f4043c2314d19a21855321204aa40f41fe07a9cd00a64f50d2090c8a90def65f4e52a332dc049b625e96e921f948908f5fe04352c50f2a71d70
+  data.tar.gz: e576b4a239f62ac50a4d231b74924ee7186f7abbd86c9faadbad0aa3c090ccbc876b1e57197f7f2681edd945b8d038ba4f1d9a9b16eedd1cab90e5c24ae36e9a

data/bin/git-format-staged

@@ -57,6 +57,10 @@ parser = OptionParser.new do |opt|
     puts FormatStaged::VERSION
     exit
   end
+
+  opt.on('--[no-]color', 'Colorizes output') do |value|
+    parameters[:color_output] = value
+  end
 end
 
 parser.parse!
@@ -69,5 +73,10 @@ if !parameters[:formatter] || parameters[:patterns].empty?
   exit
 end
 
-formatter = FormatStaged.new(**parameters)
-formatter.run
+begin
+  success = FormatStaged.run(**parameters)
+  exit success ? 0 : 1
+rescue RuntimeError => e
+  puts "💣 Error: #{e.message}".red
+  exit 1
+end

data/lib/format-staged/entry.rb

@@ -1,6 +1,10 @@
 # frozen_string_literal: true
 
-class FormatStaged
+module FormatStaged
+  ##
+  # Entry in the git index.
+  #
+  # Data as produced by `git diff-index`
   class Entry
     PATTERN = /^
       :(?<src_mode>\d+)\s

data/lib/format-staged/io.rb

@@ -1,43 +1,77 @@
 # frozen_string_literal: true
 
 require 'English'
-class FormatStaged
-  def get_output(*args, lines: true)
-    puts "> #{args.join(' ')}" if @verbose
-
-    output = IO.popen(args, err: :err) do |io|
-      if lines
-        io.readlines.map(&:chomp)
-      else
-        io.read
-      end
+
+module FormatStaged
+  ##
+  # Mixin that provides IO methods
+  module IOMixin
+    def get_output(*args, lines: true, silent: false)
+      puts "> #{args.join(' ')}" if @verbose
+
+      r = IO.popen(args, err: :err)
+      output = read_output(r, lines: lines, silent: silent)
+
+      raise 'Failed to run command' unless $CHILD_STATUS.success?
+
+      output
     end
 
-    if @verbose && lines
-      output.each do |line|
-        puts "< #{line}"
-      end
+    def get_status(*args)
+      puts "> #{args.join(' ')}" if @verbose
+      result = system(*args)
+
+      raise 'Failed to run command' if result.nil?
+
+      puts "? #{$CHILD_STATUS.exitstatus}" if @verbose
+
+      $CHILD_STATUS.exitstatus
     end
 
-    raise 'Failed to run command' unless $CHILD_STATUS.success?
+    def pipe_command(*args, source: nil)
+      puts (source.nil? ? '> ' : '| ') + args.join(' ') if @verbose
+      r, w = IO.pipe
 
-    output
-  end
+      opts = {}
+      opts[:in] = source unless source.nil?
+      opts[:out] = w
+      opts[:err] = :err
 
-  def pipe_command(*args, source: nil)
-    puts (source.nil? ? '> ' : '| ') + args.join(' ') if @verbose
-    r, w = IO.pipe
+      pid = spawn(*args, **opts)
 
-    opts = {}
-    opts[:in] = source unless source.nil?
-    opts[:out] = w
-    opts[:err] = :err
+      w.close
+      source&.close
 
-    pid = spawn(*args, **opts)
+      [pid, r]
+    end
 
-    w.close
-    source&.close
+    def read_output(output, lines: true, silent: false)
+      result = output.read
+      splits = result.split("\n")
+      if @verbose && !silent
+        splits.each do |line|
+          puts "< #{line}"
+        end
+      end
+      output.close
+
+      lines ? splits : result
+    end
+
+    def fail!(message)
+      abort "💣  #{message.red}"
+    end
 
-    [pid, r]
+    def warning(message)
+      warn "⚠️  #{message.yellow}"
+    end
+
+    def info(message)
+      puts message.blue
+    end
+
+    def verbose_info(message)
+      puts "ℹ️  #{message}" if verbose
+    end
   end
 end

data/lib/format-staged/job.rb

@@ -0,0 +1,157 @@
+# frozen_string_literal: true
+
+require_relative 'entry'
+require_relative 'io'
+
+require 'shellwords'
+require 'colorize'
+require 'English'
+
+module FormatStaged
+  ##
+  # Runs staged changes through a formatting tool
+  class Job
+    include IOMixin
+
+    attr_reader :formatter, :patterns, :update, :write, :verbose
+
+    def initialize(formatter:, patterns:, **options)
+      validate_patterns patterns
+
+      @formatter = formatter
+      @patterns = patterns
+      @update = options.fetch(:update, true)
+      @write = options.fetch(:write, true)
+      @verbose = options.fetch(:verbose, true)
+
+      String.disable_colorization = !options.fetch(:color_output, $stdout.isatty)
+    end
+
+    def run
+      files = matching_files(repo_root)
+      if files.empty?
+        info 'No staged file matching pattern. Done'
+        return true
+      end
+
+      formatted = files.filter { |file| format_file file }
+
+      return false unless formatted.size == files.size
+
+      quiet = @verbose ? [] : ['--quiet']
+      return !write || get_status('git', 'diff-index', '--cached', '--exit-code', *quiet, 'HEAD') != 0
+    end
+
+    def repo_root
+      verbose_info 'Finding repository root'
+      root = get_output('git', 'rev-parse', '--show-toplevel', lines: false).chomp
+      verbose_info "Repo at #{root}"
+
+      root
+    end
+
+    def matching_files(root)
+      verbose_info 'Listing staged files'
+
+      get_output('git', 'diff-index', '--cached', '--diff-filter=AM', '--no-renames', 'HEAD')
+        .map { |line| Entry.new(line, root: root) }
+        .reject(&:symlink?)
+        .filter { |entry| entry.matches?(@patterns) }
+    end
+
+    def format_file(file)
+      new_hash = format_object file
+
+      return true unless write
+
+      if new_hash == file.dst_hash
+        info "Unchanged #{file.src_path}"
+        return true
+      end
+
+      if object_is_empty new_hash
+        info "Skipping #{file.src_path}, formatted file is empty"
+        return false
+      end
+
+      replace_file_in_index file, new_hash
+      update_working_copy file, new_hash
+
+      if new_hash == file.src_hash
+        info "File #{file.src_path} equal to comitted"
+        return true
+      end
+
+      true
+    end
+
+    def update_working_copy(file, new_hash)
+      return unless update
+
+      begin
+        patch_working_file file, new_hash
+      rescue StandardError => e
+        warning "failed updating #{file.src_path} in working copy: #{e}"
+      end
+    end
+
+    def format_object(file)
+      info "Formatting #{file.src_path}"
+
+      format_command = formatter.sub('{}', file.src_path.shellescape)
+
+      pid1, r = pipe_command 'git', 'cat-file', '-p', file.dst_hash
+      pid2, r = pipe_command format_command, source: r
+
+      write_args = write ? ['-w'] : []
+      pid3, r = pipe_command 'git', 'hash-object', *write_args, '--stdin', source: r
+
+      result = read_output(r, lines: false).chomp
+
+      Process.wait pid1
+      raise "Cannot read #{file.dst_hash} from object database" unless $CHILD_STATUS.success?
+
+      Process.wait pid2
+      raise "Error formatting #{file.src_path}" unless $CHILD_STATUS.success?
+
+      Process.wait pid3
+      raise 'Error writing formatted file back to object database' unless $CHILD_STATUS.success? && !result.empty?
+
+      result
+    end
+
+    def object_is_empty(hash)
+      size = get_output('git', 'cat-file', '-s', hash).first.to_i
+      size.zero?
+    end
+
+    def patch_working_file(file, new_hash)
+      info 'Updating working copy'
+
+      patch = get_output 'git', 'diff', file.dst_hash, new_hash, lines: false, silent: true
+      patch.gsub! "a/#{file.dst_hash}", "a/#{file.src_path}"
+      patch.gsub! "b/#{new_hash}", "b/#{file.src_path}"
+
+      input, patch_out = IO.pipe
+      pid, r = pipe_command 'git', 'apply', '-', source: input
+
+      patch_out.write patch
+      patch_out.close
+
+      read_output r
+
+      Process.wait pid
+      raise 'Error applying patch' unless $CHILD_STATUS.success?
+    end
+
+    def replace_file_in_index(file, new_hash)
+      get_output 'git', 'update-index', '--cacheinfo', "#{file.dst_mode},#{new_hash},#{file.src_path}"
+    end
+
+    def validate_patterns(patterns)
+      patterns.each do |pattern|
+        fail! "Negative pattern '#{pattern}' is not yet supported" if pattern.start_with? '!'
+      end
+    end
+  end
+end

data/lib/format-staged/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
-class FormatStaged
-  VERSION = '0.0.2'
+module FormatStaged
+  VERSION = '0.1.1'
 end

data/lib/format_staged.rb

@@ -1,112 +1,11 @@
 # frozen_string_literal: true
 
-require 'English'
-require 'format-staged/version'
-require 'format-staged/entry'
-require 'format-staged/io'
-require 'shellwords'
+require_relative 'format-staged/job'
 
-class FormatStaged
-  attr_reader :formatter, :patterns, :update, :write, :verbose
-
-  def initialize(formatter:, patterns:, update: true, write: true, verbose: true)
-    @formatter = formatter
-    @patterns = patterns
-    @update = update
-    @write = write
-    @verbose = verbose
-  end
-
-  def run
-    root = get_output('git', 'rev-parse', '--show-toplevel').first
-
-    files = get_output('git', 'diff-index', '--cached', '--diff-filter=AM', '--no-renames', 'HEAD')
-            .map { |line| Entry.new(line, root: root) }
-            .reject(&:symlink?)
-            .filter { |entry| entry.matches?(@patterns) }
-
-    files.each do |file|
-      format_file(file)
-    end
-  end
-
-  def format_file(file)
-    new_hash = format_object file
-
-    return true unless write
-
-    if new_hash == file.dst_hash
-      puts "Unchanged #{file.src_path}"
-      return false
-    end
-
-    if object_is_empty new_hash
-      puts "Skipping #{file.src_path}, formatted file is empty"
-      return false
-    end
-
-    replace_file_in_index file, new_hash
-
-    if update
-      begin
-        patch_working_file file, new_hash
-      rescue StandardError => e
-        puts "Warning: failed updating #{file.src_path} in working copy: #{e}"
-      end
-    end
-
-    true
-  end
-
-  def format_object(file)
-    puts "Formatting #{file.src_path}"
-
-    format_command = formatter.sub('{}', file.src_path.shellescape)
-
-    pid1, r = pipe_command 'git', 'cat-file', '-p', file.dst_hash
-    pid2, r = pipe_command format_command, source: r
-    pid3, r = pipe_command 'git', 'hash-object', '-w', '--stdin', source: r
-
-    result = r.readlines.map(&:chomp)
-    if @verbose
-      result.each do |line|
-        puts "< #{line}"
-      end
-    end
-
-    Process.wait pid1
-    raise "Cannot read #{file.dst_hash} from object database" unless $CHILD_STATUS.success?
-
-    Process.wait pid2
-    raise "Error formatting #{file.src_path}" unless $CHILD_STATUS.success?
-
-    Process.wait pid3
-    raise 'Error writing formatted file back to object database' unless $CHILD_STATUS.success? && !result.empty?
-
-    result.first
-  end
-
-  def object_is_empty(hash)
-    size = get_output('git', 'cat-file', '-s', hash).first.to_i
-    size.zero?
-  end
-
-  def patch_working_file(file, new_hash)
-    patch = get_output 'git', 'diff', file.dst_hash, new_hash, lines: false
-    patch.gsub! "a/#{file.dst_hash}", "a/#{file.src_path}"
-    patch.gsub! "b/#{new_hash}", "b/#{file.src_path}"
-
-    input, patch_out = IO.pipe
-    pid, r = pipe_command 'git', 'apply', '-', source: input
-
-    patch_out.write patch
-    patch_out.close
-
-    Process.wait pid
-    raise 'Error applying patch' unless $CHILD_STATUS.success?
-  end
-
-  def replace_file_in_index(file, new_hash)
-    get_output 'git', 'update-index', '--cacheinfo', "#{file.dst_mode},#{new_hash},#{file.src_path}"
+##
+# FormatStaged module
+module FormatStaged
+  def self.run(**options)
+    Job.new(**options).run
   end
 end

metadata

@@ -1,15 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: format-staged
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.1.1
 platform: ruby
 authors:
 - Sven Weidauer
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-05-25 00:00:00.000000000 Z
+date: 2022-06-07 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: colorize
+  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: rake
   requirement: !ruby/object:Gem::Requirement
@@ -24,6 +38,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '13.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  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: rubocop
   requirement: !ruby/object:Gem::Requirement
@@ -52,6 +80,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.6'
+- !ruby/object:Gem::Dependency
+  name: rubocop-rspec
+  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'
 description: git format staged
 email: sven@5sw.de
 executables:
@@ -62,6 +104,7 @@ files:
 - bin/git-format-staged
 - lib/format-staged/entry.rb
 - lib/format-staged/io.rb
+- lib/format-staged/job.rb
 - lib/format-staged/version.rb
 - lib/format_staged.rb
 homepage: https://github.com/5sw/format-staged
@@ -75,7 +118,7 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - "~>"
+  - - ">="
     - !ruby/object:Gem::Version
       version: '2.7'
 required_rubygems_version: !ruby/object:Gem::Requirement