format-staged 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f8fd81e745a1b6710724e4834252786c1775928cb3ca8281b4acb94f87bf0946
-  data.tar.gz: 05f8dfa70f6405d390bf19e6c9c515ebed6647b714ecc83122e28b420f5934bf
+  metadata.gz: 80bea79a03480ca702efd9bec176a0a2e180e82e854c7300773b064bf4c46b1e
+  data.tar.gz: 06356777c82f354560e700aef495929f1dc7e4d0d72c08456271a3b08fd3d8cc
 SHA512:
-  metadata.gz: 6d04e7ef3312f160d22796fa6c0b9f923405b7c65540cd107641c2c668d312f66859d9c661b00a3e43fbddec56fc4b888d8823057bd64d652147d8aa90ff57bf
-  data.tar.gz: 61873bda257b0fd6d89abb4bb191f32694ea4dfb6e7f36b138d84f45b77091ba64b458195debdf498f3503b55800e3f685f170a8e0b3054b5895c324ebf8f4ec
+  metadata.gz: bd2a7a026faf4ff75b34b69a26aba8df9ff9d18d15be75341c365a8c5bae010044010d2fe3976cd5b60ccc9e7f0d68c7a62955bc620c56b7ad3955779713ec95
+  data.tar.gz: 126334604bfac8205438d64d597638490d560db058476f4a53b673f89f2b80cbc055a3f76863d5f6489b89f132140947794cb4a0cece89ea89ea287fe6c0c5f8

data/bin/git-format-staged

@@ -1,40 +1,59 @@
 #!/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
@@ -43,9 +62,9 @@ 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

data/lib/format-staged/entry.rb

@@ -1,9 +1,19 @@
-class FormatStaged 
+# frozen_string_literal: true
+
+class FormatStaged
   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 +27,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,43 @@
-class FormatStaged 
+# frozen_string_literal: true
+
+require 'English'
+class FormatStaged
   def get_output(*args, lines: true)
-    puts '> ' + args.join(' ') if @verbose
-    
+    puts "> #{args.join(' ')}" if @verbose
+
     output = IO.popen(args, err: :err) do |io|
       if lines
-        io.readlines.map { |l| l.chomp }
+        io.readlines.map(&:chomp)
       else
         io.read
       end
     end
-    
-    if @verbose and lines
+
+    if @verbose && lines
       output.each do |line|
         puts "< #{line}"
       end
     end
-    
-    raise "Failed to run command" unless $?.success?
-    
+
+    raise 'Failed to run command' unless $CHILD_STATUS.success?
+
     output
   end
-  
+
   def pipe_command(*args, source: nil)
-    puts (source.nil? ? '> ' : '| ') + args.join(' ')  if @verbose
+    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  
+    source&.close
+
+    [pid, r]
+  end
 end

data/lib/format-staged/version.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 class FormatStaged
-  VERSION = "0.0.1"
-end
+  VERSION = '0.0.2'
+end

data/lib/format_staged.rb

@@ -0,0 +1,112 @@
+# frozen_string_literal: true
+
+require 'English'
+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(&: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}"
+  end
+end

metadata

@@ -1,15 +1,57 @@
 --- !ruby/object:Gem::Specification
 name: format-staged
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Sven Weidauer
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-05-22 00:00:00.000000000 Z
-dependencies: []
+date: 2022-05-25 00:00:00.000000000 Z
+dependencies:
+- !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: 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'
 description: git format staged
 email: sven@5sw.de
 executables:
@@ -18,23 +60,24 @@ 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/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