format-staged 0.0.1 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f8fd81e745a1b6710724e4834252786c1775928cb3ca8281b4acb94f87bf0946
-  data.tar.gz: 05f8dfa70f6405d390bf19e6c9c515ebed6647b714ecc83122e28b420f5934bf
+  metadata.gz: f07500eeef0c1c28b74bbd28b5fd935b733d8c5b444e714db45b18ca450fdfce
+  data.tar.gz: 1cac2a6e5e80f10a0fd0df2c0349e49b7411f632709193902ba1eb9c3b646d8a
 SHA512:
-  metadata.gz: 6d04e7ef3312f160d22796fa6c0b9f923405b7c65540cd107641c2c668d312f66859d9c661b00a3e43fbddec56fc4b888d8823057bd64d652147d8aa90ff57bf
-  data.tar.gz: 61873bda257b0fd6d89abb4bb191f32694ea4dfb6e7f36b138d84f45b77091ba64b458195debdf498f3503b55800e3f685f170a8e0b3054b5895c324ebf8f4ec
+  metadata.gz: ba546faa5200d31c2f7c4faa413196d31c6b45314fecd583a2905b1f0c52b7135a4e0f847384a6c5fb27b41e8a66e6813a2329b1cb65af1659a6c9250fa40daf
+  data.tar.gz: 82dd60bd9f48843a67a72c65bb4d455ea818502b6e6f34bc6c66b94a2aa6497bbc9981909ed1d266519d544cf48a95dd1ada6c8d73531eab07f49522c7083f3a

data/bin/git-format-staged

@@ -1,54 +1,82 @@
 #!/usr/bin/env ruby
-require 'format-staged'
+# frozen_string_literal: true
+
+require 'format_staged'
 require 'optparse'
 
 parameters = {
-  :update => true,
-  :write => true,
-  :verbose => false,
+  update: true,
+  write: true,
+  verbose: false
 }
 
 parser = OptionParser.new do |opt|
   opt.banner = "Usage: #{opt.program_name} [options] [patterns]"
-  opt.separator ""
-  opt.on('-f', '--formatter COMMAND', 'Shell command to format files, will run once per file. Occurrences of the placeholder `{}` will be replaced with a path to the file being formatted. (Example: "prettier --stdin-filepath \'{}\'")') do |o|
+  opt.separator ''
+  opt.on('-f', '--formatter COMMAND',
+         <<~DOC
+           Shell command to format files, will run once per file. Occurrences of the placeholder `{}` will \
+           be replaced with a path to the file being formatted. \
+           (Example: "prettier --stdin-filepath \'{}\'")
+         DOC
+  ) do |o|
     parameters[:formatter] = o
   end
-  
-  opt.on('--[no-]update-working-tree', 'By default formatting changes made to staged file content will also be applied to working tree files via a patch. This option disables that behavior, leaving working tree files untouched.') do |value|
+
+  opt.on('--[no-]update-working-tree',
+         <<~DOC
+           By default formatting changes made to staged file content will also be applied to working tree \
+           files via a patch. This option disables that behavior, leaving working tree files untouched.#{' '}
+         DOC
+        ) do |value|
     parameters[:update] = value
   end
-  
-  opt.on('--[no-]write', "Prevents #{opt.program_name} from modifying staged or working tree files. You can use this option to check staged changes with a linter instead of formatting. With this option stdout from the formatter command is ignored.") do |value|
+
+  opt.on('--[no-]write',
+         <<~DOC
+           "Prevents #{opt.program_name} from modifying staged or working tree files. You can use this option \
+           to check staged changes with a linter instead of formatting. With this option stdout from the \
+           formatter command is ignored."
+         DOC
+        ) do |value|
     parameters[:write] = value
   end
-  
-  opt.on("-v", "--[no-]verbose", 'Shows commands being run') do |value| 
+
+  opt.on('-v', '--[no-]verbose', 'Shows commands being run') do |value|
     parameters[:verbose] = value
   end
 
-  opt.separator ""
-  
+  opt.separator ''
+
   opt.on_tail('-h', '--help', 'Prints this help') do
     puts opt
     exit
   end
-  
-  opt.on_tail('--version', "Prints the version number and exits") do
+
+  opt.on_tail('--version', 'Prints the version number and exits') do
     puts FormatStaged::VERSION
     exit
   end
+
+  opt.on('--[no-]color', 'Colorizes output') do |value|
+    parameters[:color_output] = value
+  end
 end
 
 parser.parse!
 parameters[:patterns] = ARGV
 
-if !parameters[:formatter] or parameters[:patterns].empty?
-  puts "Missing formatter or file patterns!"
-  
+if !parameters[:formatter] || parameters[:patterns].empty?
+  puts 'Missing formatter or file patterns!'
+
   puts parser
   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,9 +1,23 @@
-class FormatStaged 
+# frozen_string_literal: true
+
+module FormatStaged
+  ##
+  # Entry in the git index.
+  #
+  # Data as produced by `git diff-index`
   class Entry
-    PATTERN = /^:(?<src_mode>\d+) (?<dst_mode>\d+) (?<src_hash>[a-f0-9]+) (?<dst_hash>[a-f0-9]+) (?<status>[A-Z])(?<score>\d+)?\t(?<src_path>[^\t]+)(?:\t(?<dst_path>[^\t]+))?$/
+    PATTERN = /^
+      :(?<src_mode>\d+)\s
+      (?<dst_mode>\d+)\s
+      (?<src_hash>[a-f0-9]+)\s
+      (?<dst_hash>[a-f0-9]+)\s
+      (?<status>[A-Z])(?<score>\d+)?\t
+      (?<src_path>[^\t]+)
+      (?:\t(?<dst_path>[^\t]+))?
+      $/x.freeze
 
     attr_reader :src_mode, :dst_mode, :src_hash, :dst_hash, :status, :score, :src_path, :dst_path, :path, :root
-    
+
     def initialize(line, root:)
       matches = line.match(PATTERN) or raise "Cannot parse output #{line}"
       @src_mode = matches[:src_mode]
@@ -17,17 +31,15 @@ class FormatStaged
       @path = File.expand_path(@src_path, root)
       @root = root
     end
-    
+
     def symlink?
       @dst_mode == '120000'
     end
-    
+
     def matches?(patterns)
       result = false
       patterns.each do |pattern|
-        if File.fnmatch? pattern, path, File::FNM_EXTGLOB
-          result = true
-        end
+        result = true if File.fnmatch? pattern, path, File::FNM_EXTGLOB
       end
       result
     end

data/lib/format-staged/io.rb

@@ -1,40 +1,77 @@
-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 { |l| l.chomp }
-      else
-        io.read
-      end
+# frozen_string_literal: true
+
+require 'English'
+
+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
+
+    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
-    
-    if @verbose and lines
-      output.each do |line|
-        puts "< #{line}"
+
+    def pipe_command(*args, source: nil)
+      puts (source.nil? ? '> ' : '| ') + args.join(' ') if @verbose
+      r, w = IO.pipe
+
+      opts = {}
+      opts[:in] = source unless source.nil?
+      opts[:out] = w
+      opts[:err] = :err
+
+      pid = spawn(*args, **opts)
+
+      w.close
+      source&.close
+
+      [pid, r]
+    end
+
+    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
+
+    def warning(message)
+      warn "⚠️  #{message.yellow}"
+    end
+
+    def info(message)
+      puts message.blue
+    end
+
+    def verbose_info(message)
+      puts "ℹ️  #{message}" if verbose
     end
-    
-    raise "Failed to run command" unless $?.success?
-    
-    output
   end
-  
-  def pipe_command(*args, source: nil)
-    puts (source.nil? ? '> ' : '| ') + args.join(' ')  if @verbose
-    r, w = IO.pipe
-    
-    opts = {}
-    opts[:in] = source unless source.nil?
-    opts[:out] = w
-    opts[:err] = :err
-    
-    pid = spawn(*args, **opts)
-    
-    w.close
-    source &.close
-    
-    return [pid, r]
-  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,3 +1,5 @@
-class FormatStaged
-  VERSION = "0.0.1"
-end
+# frozen_string_literal: true
+
+module FormatStaged
+  VERSION = '0.1.0'
+end

data/lib/format_staged.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+require_relative 'format-staged/job'
+
+##
+# FormatStaged module
+module FormatStaged
+  def self.run(**options)
+    Job.new(**options).run
+  end
+end

metadata

@@ -1,15 +1,99 @@
 --- !ruby/object:Gem::Specification
 name: format-staged
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.1.0
 platform: ruby
 authors:
 - Sven Weidauer
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-05-22 00:00:00.000000000 Z
-dependencies: []
+date: 2022-06-06 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
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !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
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.29'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.29'
+- !ruby/object:Gem::Dependency
+  name: rubocop-rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !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:
@@ -18,23 +102,25 @@ extensions: []
 extra_rdoc_files: []
 files:
 - bin/git-format-staged
-- lib/format-staged.rb
 - 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
 licenses:
 - MIT
-metadata: {}
+metadata:
+  rubygems_mfa_required: 'true'
 post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - "~>"
     - !ruby/object:Gem::Version
-      version: '0'
+      version: '2.7'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="

data/lib/format-staged.rb

@@ -1,109 +0,0 @@
-require 'format-staged/version'
-require 'format-staged/entry'
-require 'format-staged/io'
-require 'shellwords'
-
-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 { |entry| entry.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 if not 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 => error
-          puts "Warning: failed updating #{file.src_path} in working copy: #{error}"
-        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 { |it| it.chomp }
-      if @verbose
-        result.each do |line|
-          puts "< #{line}"
-        end
-      end
-    
-      Process.wait pid1
-      raise "Cannot read #{file.dst_hash} from object database" unless $?.success?
-      
-      Process.wait pid2
-      raise "Error formatting #{file.src_path}" unless $?.success?
-      
-      Process.wait pid3
-      raise "Error writing formatted file back to object database" unless $?.success? && !result.empty?
-      
-      result.first
-    end
-    
-    def object_is_empty(hash)
-      size = get_output("git", "cat-file", "-s", hash).first.to_i
-      size == 0
-    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 $?.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
-end