git_ls 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3b3b64d9243806400218962b09edcb66818cb89e937d26891cb166abcab21758
-  data.tar.gz: 35635cc661eeed4da50a7552a9843a5c65f9502d54e7970d1a4d704e9409ee6e
+  metadata.gz: e317eb1dd5319b6b4fc46d2c928d2870b953ab830a1eab915b74676770e69f35
+  data.tar.gz: 9782182d8e15fba682c15018c9c0ffd15ac3f748dbb92e6bd6510b256b4f4404
 SHA512:
-  metadata.gz: ee0a4c6e09c94eb10a50f98035cca54ebaf7c5c5d581e2777e8f3db48e713864277f2478b297e0b6aac105af5f1dbb465f4f576fbcbbb3be5fb7d8d7158898ce
-  data.tar.gz: de60f8686d502bd616997b123089707e39e9c234faaf523b8df8037476013fa83f4114ee7ecb6a9a02c485d69b8e93c593dc8e9ae925aaeebe718e09a7316a9e
+  metadata.gz: d5aedff95a701fe5554afd2ff627e2d2f3a6a02fb0bac8603b314fef038e9fdacf61a917ac942fe678c1161123e8a4860fce8d272292f7497df304de0838404f
+  data.tar.gz: 2c6a4b71a6c5d8485230bdb3f6800546118fb1cb07326813ef6de6b269c1be896124be6898ae580292a49a860145c4375e3da5ae537c07f57da26b37ad049905

data/CHANGELOG.md

@@ -1,3 +1,6 @@
+# 0.3.0
+- Improve performance by reading the size in flags
+
 # 0.2.0
 
 - Handles git index version 4

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    git_ls (0.2.0)
+    git_ls (0.3.0)
 
 GEM
   remote: https://rubygems.org/

data/lib/git_ls.rb

@@ -1,8 +1,5 @@
 # frozen_string_literal: true
 
-require_relative 'git_ls/parser'
-
-# Entry point for gem.
 # Usage:
 #   GitLS.files -> Array of strings as files.
 #   This will be identical output to git ls-files
@@ -11,10 +8,132 @@ module GitLS
 
   class << self
     def files(path = ::Dir.pwd)
+      read(path, false)
+    end
+
+    def headers(path = ::Dir.pwd)
+      read(path, true)
+    end
+
+  private
+
+    def read(path, return_headers_only)
       path = ::File.join(path, '.git/index') if ::File.directory?(path)
-      ::GitLS::Parser.new(::File.new(path)).files
+      file = ::File.new(path)
+      # 4-byte signature:
+      # The signature is { 'D', 'I', 'R', 'C' } (stands for "dircache")
+      # 4-byte version number:
+      # The current supported versions are 2, 3 and 4.
+      # 32-bit number of index entries.
+      sig, git_index_version, length = file.read(12).unpack('A4NN')
+      raise ::GitLS::Error, 'not a git dir or .git/index file' unless sig == 'DIRC'
+
+      return { git_index_version: git_index_version, length: length } if return_headers_only
+
+      files = Array.new(length)
+      case git_index_version
+      when 2 then files_2(files, file)
+      when 3 then files_3(files, file)
+      when 4 then files_4(files, file)
+      else raise ::GitLS::Error, 'Unrecognized git index version'
+      end
+      files
     rescue Errno::ENOENT => e
       raise GitLS::Error, "Not a git directory: #{e.message}"
+    ensure
+      # :nocov:
+      # coverage tracking for branches in ensure blocks is weird
+      file&.close
+      # :nocov:
+      files
+    end
+
+    private
+
+    def files_2(files, file)
+      files.map! do
+        file.pos += 60 # skip 60 bytes (40 bytes of stat, 20 bytes of sha)
+        length = (file.getbyte & 0b0000_1111) * 256 + file.getbyte # find the 12 byte length
+        if length < 0xFFF
+          path = file.read(length)
+          # :nocov:
+        else
+          # i can't test this i just get ENAMETOOLONG a lot
+          path = file.readline("\0").chop
+          file.pos -= 1
+          # :nocov:
+        end
+        file.pos += 8 - ((length - 2) % 8) # 1-8 bytes padding of nuls
+        path
+      end
+    end
+
+    def files_3(files, file)
+      files.map! do
+        file.pos += 60 # skip 60 bytes (40 bytes of stat, 20 bytes of sha)
+
+        flags = file.getbyte * 256 + file.getbyte
+        extended_flag = (flags & 0b0100_0000_0000_0000).positive?
+        file.pos += 2 if extended_flag
+
+        length = flags & 0b0000_1111_1111_1111
+        if length < 0xFFF
+          path = file.read(length)
+          # :nocov:
+        else
+          # i can't test this i just get ENAMETOOLONG a lot
+          path = file.readline("\0").chop
+          file.pos -= 1
+          # :nocov:
+        end
+
+        file.pos += 8 - ((path.bytesize - (extended_flag ? 0 : 2)) % 8) # 1-8 bytes padding of nuls
+        path
+      end
+    end
+
+    def files_4(files, file)
+      prev_entry_path = ""
+      files.map! do
+        file.pos += 60 # skip 60 bytes (40 bytes of stat, 20 bytes of sha)
+        flags = file.getbyte * 256 + file.getbyte
+        file.pos += 2 if (flags & 0b0100_0000_0000_0000).positive?
+
+        length = flags & 0b0000_1111_1111_1111
+
+        # documentation for this number from
+        # https://git-scm.com/docs/pack-format#_original_version_1_pack_idx_files_have_the_following_format
+        # offset encoding:
+        #   n bytes with MSB set in all but the last one.
+        #   The offset is then the number constructed by
+        #   concatenating the lower 7 bit of each byte, and
+        #   for n >= 2 adding 2^7 + 2^14 + ... + 2^(7*(n-1))
+        #   to the result.
+        read_offset = 0
+        prev_read_offset = file.getbyte
+        n = 1
+        while (prev_read_offset & 0b1000_0000).positive?
+          read_offset += (prev_read_offset - 0b1000_0000)
+          read_offset += 2**(7 * n)
+          n += 1
+          prev_read_offset = file.getbyte
+        end
+        read_offset += prev_read_offset
+
+        initial_part_length = prev_entry_path.bytesize - read_offset
+
+        if length < 0xFFF
+          rest = file.read(length - initial_part_length)
+          file.pos += 1 # the NUL
+          # :nocov:
+        else
+          # i can't test this i just get ENAMETOOLONG a lot
+          rest = file.readline("\0").chop
+          # :nocov:
+        end
+
+        prev_entry_path = prev_entry_path.byteslice(0, initial_part_length) + rest
+      end
     end
   end
 end

data/lib/git_ls/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module GitLS
-  VERSION = '0.2.0'
+  VERSION = '0.3.0'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: git_ls
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Dana Sherson
@@ -71,7 +71,6 @@ files:
 - Rakefile
 - git_index.gemspec
 - lib/git_ls.rb
-- lib/git_ls/parser.rb
 - lib/git_ls/version.rb
 homepage: https://github.com/robotdana/git_ls
 licenses:

data/lib/git_ls/parser.rb

@@ -1,113 +0,0 @@
-# frozen_string_literal: true
-
-module GitLS
-  # Parse a .git/index file
-  # Format documented here: https://git-scm.com/docs/index-format
-  class Parser
-    HEADER = 'A4' + # 4-byte signature:
-             # The signature is { 'D', 'I', 'R', 'C' } (stands for "dircache")
-             'N' + # 4-byte version number:
-             # The current supported versions are 2, 3 and 4.
-             'N' # 32-bit number of index entries.
-
-    def initialize(file)
-      @file = file
-      raise ::GitLS::Error, 'not a git dir or .git/index file' unless valid?
-    end
-
-    def files
-      headers
-
-      @files = Array.new(length)
-      case git_index_version
-      when 2 then files_2
-      when 3 then files_3
-      when 4 then files_4
-      else raise ::GitLS::Error, 'Unrecognized git version'
-      end
-      @files
-    end
-
-    private
-
-    def files_2
-      @files.map! do
-        @file.pos += 62 # skip 62 bytes (40 bytes of stat, 20 bytes of sha, 2 bytes flags)
-        ret = @file.readline("\0").chop
-        @file.pos += 7 - ((ret.bytesize - 2) % 8) # 1-8 bytes padding of nuls
-        ret
-      end
-    end
-
-    def files_3
-      @files.map! do
-        @file.pos += 60 # skip 60 bytes (40 bytes of stat, 20 bytes of sha)
-        flag = @file.getbyte
-        extended_flag_offset = if (flag & 0b0100_0000).positive?
-          3 # skip next half of flag + extended flags
-        else
-          1 # skip next half of flag
-        end
-        @file.pos += extended_flag_offset
-
-        ret = @file.readline("\0").chop
-        @file.pos += 7 - ((ret.bytesize + extended_flag_offset - 3) % 8) # 1-8 bytes padding of nuls
-        ret
-      end
-    end
-
-    def files_4
-      prev_entry_path = ""
-      @files.map! do
-        @file.pos += 60 # skip 60 bytes (40 bytes of stat, 20 bytes of sha)
-        flag = @file.getbyte
-        @file.pos += if (flag & 0b0100_0000).positive?
-          3 # skip next half of flag + extended flags
-        else
-          1 # skip next half of flag
-        end
-
-        # flags = @file.read(2) # 2 bytes flags
-        # # skip extend flags if extended flags bit set
-        # @file.pos += 2 if flags && (flags.unpack1('n') & 0b0100_0000_0000_0000).positive?
-
-        # documentation for this number from
-        # https://git-scm.com/docs/pack-format#_original_version_1_pack_idx_files_have_the_following_format
-        # offset encoding:
-        #   n bytes with MSB set in all but the last one.
-        #   The offset is then the number constructed by
-        #   concatenating the lower 7 bit of each byte, and
-        #   for n >= 2 adding 2^7 + 2^14 + ... + 2^(7*(n-1))
-        #   to the result.
-        read_offset = 0
-        prev_read_offset = @file.getbyte
-        n = 1
-        while (prev_read_offset & 0b1000_0000).positive?
-          read_offset += (prev_read_offset - 0b1000_0000)
-          read_offset += 2**(7 * n)
-          n += 1
-          prev_read_offset = @file.getbyte
-        end
-        read_offset += prev_read_offset
-
-        prev_entry_path = prev_entry_path.byteslice(0, prev_entry_path.bytesize - read_offset) + @file.readline("\0").chop
-      end
-    end
-
-    def headers
-      @headers ||= @file.read(12).unpack(::GitLS::Parser::HEADER)
-    end
-
-    def valid?
-      headers[0] == 'DIRC'
-    end
-
-    def git_index_version
-      @git_version = headers[1]
-    end
-
-    def length
-      headers[2]
-    end
-  end
-end