git_ls 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 36a574370f3eb35ebc2809b74763a95b5e8ccfbcdeaa6a51c3e676b5c99169e1
+  data.tar.gz: 23edfa443ecf1ba37421b9722447d4222e9f243caa020649b08c89186b3b1b78
+SHA512:
+  metadata.gz: 1ec5afd8473e7549d01de8aa9396ce1fd498d761dc494f9a25145cf0234b59448c44d736bf5463b5d4dffbebb40eca661dfad5c10ab9644e4a0d132fad8df8a9
+  data.tar.gz: 1cd05421d153e6a12357db5689daf22a5932bdd2a40a044d058acbb9f8f5425c7728b4c32b6422c6b3d3de6b732852f45034891c5d892aba068f12a29fd6acc9

data/.gitignore

@@ -0,0 +1,12 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+/.rspec_status
+/.ruby-version

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.travis.yml

@@ -0,0 +1,6 @@
+---
+language: ruby
+cache: bundler
+rvm:
+  - 2.7.0
+before_install: gem install bundler -v 2.1.4

data/CHANGELOG.md

@@ -0,0 +1,3 @@
+# 0.1.0
+
+Initial release

data/Gemfile

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in git_index.gemspec
+gemspec
+
+gem 'rake', '~> 12.0'
+gem 'rspec', '~> 3.0'

data/Gemfile.lock

@@ -0,0 +1,41 @@
+PATH
+  remote: .
+  specs:
+    git_index (0.1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    coderay (1.1.3)
+    diff-lcs (1.4.4)
+    method_source (1.0.0)
+    pry (0.13.1)
+      coderay (~> 1.1)
+      method_source (~> 1.0)
+    rake (12.3.3)
+    rspec (3.9.0)
+      rspec-core (~> 3.9.0)
+      rspec-expectations (~> 3.9.0)
+      rspec-mocks (~> 3.9.0)
+    rspec-core (3.9.2)
+      rspec-support (~> 3.9.3)
+    rspec-expectations (3.9.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-mocks (3.9.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-support (3.9.3)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (>= 2)
+  git_index!
+  pry (> 0)
+  rake (~> 12.0)
+  rspec (~> 3.0)
+
+BUNDLED WITH
+   2.1.4

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2020 Dana Sherson
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,51 @@
+# GitLS.files
+
+Parses the .git/index file like `git ls-files` does.
+
+- for small repos (as in, anything smaller than rails),
+  it can be significantly faster than doing the system call to git
+- still takes less than half a second for large repos e.g. the linux repo
+- doesn't require git to be installed
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'git_ls'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install git_ls
+
+## Usage
+
+`GitLS.files` returns an array of filenames, equivalent to `` `git ls-files -z`.split("\0") ``
+`GitLS.files("path/to/repo")` if the repo is not $PWD.
+
+## Issues
+
+- Doesn't work for git version 4 files at all
+- Doesn't understand split index files at all
+- Has only 1 test
+
+## Development
+
+Have a look in the bin dir for some useful tools.
+To install this gem onto your local machine, run `bundle exec rake install`.
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/robotdana/git_ls.
+If you're comfortable, please attach `.git/index` and the output of `git ls-files` where it doesn't match.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+# git_ls

data/Rakefile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/git_index.gemspec

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+require_relative 'lib/git_ls/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'git_ls'
+  spec.version       = GitLS::VERSION
+  spec.authors       = ['Dana Sherson']
+  spec.email         = ['robot@dana.sh']
+
+  spec.summary       = 'Read a .git/index file and list the files'
+  spec.homepage      = 'https://github.com/robotdana/git_ls'
+  spec.license       = 'MIT'
+  spec.required_ruby_version = Gem::Requirement.new('>= 2.4.0')
+
+  if spec.respond_to?(:metadata)
+    spec.metadata['homepage_uri'] = spec.homepage
+    spec.metadata['source_code_uri'] = spec.homepage
+    spec.metadata['changelog_uri'] = spec.homepage + '/blob/main/CHANGELOG.md'
+  end
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files = Dir.chdir(File.expand_path(__dir__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(bin|test|spec|features)/}) }
+  end
+
+  spec.require_paths = ['lib']
+
+  spec.add_development_dependency 'bundler', '>= 2'
+  spec.add_development_dependency 'pry', '> 0'
+end

data/lib/git_ls.rb

@@ -0,0 +1,18 @@
+# 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
+module GitLS
+  class Error < StandardError; end
+
+  class << self
+    def files(path = ::Dir.pwd)
+      path = ::File.join(path, '.git/index') if ::File.directory?(path)
+      ::GitLS::Parser.new(::File.new(path)).files
+    end
+  end
+end

data/lib/git_ls/parser.rb

@@ -0,0 +1,71 @@
+# 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_version
+      when 2 then files_2
+      when 3 then files_3
+      when 4 then raise ::GitLS::Error, "4 is complicated git version, it's not done yet"
+      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)
+        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?
+
+        ret = @file.readline("\0").chop
+        @file.pos += 7 - ((ret.bytesize - 2) % 8) # 1-8 bytes padding of nuls
+        ret
+      end
+    end
+
+    def headers
+      @headers ||= @file.read(12).unpack(::GitLS::Parser::HEADER)
+    end
+
+    def valid?
+      headers[0] == 'DIRC'
+    end
+
+    def git_version
+      @git_version = headers[1]
+    end
+
+    def length
+      headers[2]
+    end
+  end
+end

data/lib/git_ls/version.rb

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

metadata

@@ -0,0 +1,87 @@
+--- !ruby/object:Gem::Specification
+name: git_ls
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Dana Sherson
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2020-07-17 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '2'
+- !ruby/object:Gem::Dependency
+  name: pry
+  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: 
+email:
+- robot@dana.sh
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CHANGELOG.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- 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:
+- MIT
+metadata:
+  homepage_uri: https://github.com/robotdana/git_ls
+  source_code_uri: https://github.com/robotdana/git_ls
+  changelog_uri: https://github.com/robotdana/git_ls/blob/main/CHANGELOG.md
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.4.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.2
+signing_key: 
+specification_version: 4
+summary: Read a .git/index file and list the files
+test_files: []