git_ls 0.5.0 → 0.5.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7736e59f5f16469e453f3f085e1473cef343eb79e51e75cb94c013de62a311ca
-  data.tar.gz: c9715b5c0080aea1d487b349d825f113d1ecf7d75a85fe76fb2cd9648f3c16c0
+  metadata.gz: 723546fbde74cd69c51631aafbb7fee4b4dbe12915f969855dcc6d1b577834bf
+  data.tar.gz: 3b9d5b1c58209e1a799864a71a875b059eef1e315c53e56351c44026f4c07931
 SHA512:
-  metadata.gz: ca243045d1d33fbc49532f35c63d8ea2bc924d119934a39407a9bc427e0e9de493997b6e93be6b3d5245c4d3df129b8bb1b696f0df6849bebdd4fc76febb718a
-  data.tar.gz: 8ebacdfaa8a7723fd87cf650ea72cf70140633b7140403bd0cbc0f320bc1bdfb28bfe8eeeb9fe950d697f2357b4352e5029ac9c749684bca097a2f05b02b4a1a
+  metadata.gz: a4d9fb5d7c4f84057007dbc9052c011f165e191c0c7e4bfc533cf9319ce61f8103d65b936abc884e44fd1ecae666d665c160f9ab39a2f35ec1f115a871a8fd9c
+  data.tar.gz: 71a87a2b4946e2a499dba2c673507951a95eb4fb8a499f3737d037ed428121314d2c5e7fef0356bc8ea7070f4877e69f6b0ed13bd4cffaecacd8a0b757b26d56

data/.github/workflows/ci.yml

@@ -0,0 +1,82 @@
+name: CI
+
+on:
+  push:
+    branches:
+    - main
+  pull_request:
+    branches:
+    - main
+
+jobs:
+  rspec:
+    strategy:
+      fail-fast: false
+      matrix:
+        ruby: [2.4, 2.5, 2.6, 2.7, '3.0', 3.1, 3.2, 3.3, 3.4, ruby-head, jruby, jruby-head]
+    continue-on-error: ${{ endsWith(matrix.ruby, 'head') }}
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v4
+    - uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: ${{ matrix.ruby }}
+        bundler-cache: true
+    - run: bundle exec rspec
+
+  coverage:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: 3.4
+          bundler-cache: true
+      - run: COVERAGE=1 bundle exec rspec
+
+      - uses: actions/upload-artifact@v4
+        with:
+          name: coverage-report
+          path: 'coverage/*'
+          retention-days: 1
+        if: ${{ failure() }}
+
+  rubocop:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v4
+    - uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: 3.4
+        bundler-cache: true
+    - run: bundle exec rubocop
+
+  spellr:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v4
+    - uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: 3.4
+        bundler-cache: true
+    - run: bundle exec spellr
+
+  leftovers:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v4
+    - uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: 3.4
+        bundler-cache: true
+    - run: bundle exec leftovers
+
+  build:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v4
+    - uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: 3.4
+        bundler-cache: true
+    - run: bundle exec rake build

data/.gitignore

@@ -11,3 +11,4 @@
 /.rspec_status
 /.ruby-version
 Gemfile.lock
+/sorbet/rbi/hidden-definitions/errors.txt

data/.leftovers.yml

@@ -1,2 +1,3 @@
 exclude_paths:
   - vendor
+  - sorbet

data/.rubocop.yml

@@ -1,4 +1,6 @@
-require: rubocop-rspec
+require:
+  - rubocop-rspec
+  - rubocop-rake
 
 # Reference:
 # https://rubocop.readthedocs.io/en/latest/
@@ -113,7 +115,7 @@ Metrics:
   CountComments: false
 
 Metrics/BlockLength:
-  ExcludedMethods:
+  AllowedMethods:
     - configure
     - describe
     - context
@@ -126,6 +128,9 @@ Metrics/CyclomaticComplexity:
 Metrics/PerceivedComplexity:
   Enabled: false
 
+Metrics/ClassLength:
+  Enabled: false
+
 RSpec:
   Enabled: true
   Include:
@@ -141,7 +146,7 @@ RSpec/ExampleLength:
 RSpec/ExpectActual:
   Enabled: false
 
-RSpec/FilePath:
+RSpec/SpecFilePathFormat:
   Enabled: false
 
 # Multiple expectations are useful

data/.simplecov

@@ -8,4 +8,8 @@ SimpleCov.start do
   else
     minimum_coverage 100
   end
+  self.formatter = SimpleCov::Formatter::MultiFormatter.new([
+    SimpleCov::Formatter::HTMLFormatter,
+    SimpleCov::Formatter::Console
+  ])
 end

data/.spellr.yml

@@ -1,2 +1,3 @@
 excludes:
   - vendor
+  - sorbet

data/.spellr_wordlists/english.txt

@@ -1,4 +1,5 @@
 baz
+bitshift
 changelog
 codebase
 cov
@@ -28,8 +29,10 @@ rvm
 sharedindex
 sherson
 simplecov
+srb
 sudo
 tmp
+txt
 usr
 utf
 warmup

data/CHANGELOG.md

@@ -1,3 +1,6 @@
+# 0.5.1
+- Test with new ruby versions, meaningless performance tweak using bitshift instead of exponent in one place.
+
 # 0.5.0
 - Major Performance Improvements
 

data/Gemfile

@@ -4,3 +4,21 @@ source 'https://rubygems.org'
 
 # Specify your gem's dependencies in git_index.gemspec
 gemspec
+
+group(:development) do
+  gem 'benchmark', require: false
+  gem 'benchmark-ips', require: false
+  gem 'bundler', '>= 2', require: false
+  gem 'fast_ignore', '>= 0.15.1', require: false
+  gem 'leftovers', '>= 0.4.0', require: false
+  gem 'pry', require: false
+  gem 'rake', '>= 12.3.3', require: false
+  gem 'rspec', require: false
+  gem 'rubocop', '>= 0.93.1', require: false
+  gem 'rubocop-performance', '>= 1.8.1', require: false
+  gem 'rubocop-rake', require: false
+  gem 'rubocop-rspec', '>= 1.44.1', require: false
+  gem 'simplecov', '>= 0.18.5', require: false
+  gem 'simplecov-console', require: false
+  gem 'spellr', require: false, platforms: :ruby
+end

data/README.md

@@ -4,7 +4,7 @@ Parses the .git/index file like `git ls-files` does.
 
 - faster than doing the system call to git
 - doesn't require git to be installed
-- tested against ruby 2.4 - 2.7 and jruby
+- tested against ruby 2.4 - 3.4.1 and jruby
 
 ## Installation
 

data/Rakefile

@@ -1,18 +1,27 @@
 # frozen_string_literal: true
 
+require 'bundler/setup'
 require 'bundler/gem_tasks'
-require 'rspec/core/rake_task'
-require 'rubocop/rake_task'
-require 'spellr/rake_task'
-require 'leftovers/rake_task'
 
-RuboCop::RakeTask.new
+require 'rspec/core/rake_task'
 RSpec::Core::RakeTask.new(:spec)
-Spellr::RakeTask.generate_task
-Leftovers::RakeTask.generate_task
+linters = %i{spec}
+
+if RUBY_PLATFORM != 'java'
+  require 'rubocop/rake_task'
+  RuboCop::RakeTask.new
+  linters << :rubocop
 
-if RUBY_PLATFORM == 'java'
-  task default: %i{spec build}
-else
-  task default: %i{spec rubocop spellr leftovers build}
+  require 'spellr/rake_task'
+  Spellr::RakeTask.generate_task
+  linters << :spellr
+
+  require 'leftovers/rake_task'
+  Leftovers::RakeTask.generate_task
+  linters << :leftovers
 end
+
+linters << :build
+
+desc 'Run all linters'
+task default: linters

data/git_index.gemspec

@@ -26,16 +26,5 @@ Gem::Specification.new do |spec|
   end
 
   spec.require_paths = ['lib']
-
-  spec.add_development_dependency 'benchmark-ips'
-  spec.add_development_dependency 'bundler', '>= 2'
-  spec.add_development_dependency 'leftovers'
-  spec.add_development_dependency 'pry', '> 0'
-  spec.add_development_dependency 'rake', '>= 12.3.3'
-  spec.add_development_dependency 'rspec'
-  spec.add_development_dependency 'rubocop'
-  spec.add_development_dependency 'rubocop-performance'
-  spec.add_development_dependency 'rubocop-rspec'
-  spec.add_development_dependency 'simplecov', '~> 0.18.5'
-  spec.add_development_dependency 'spellr'
+  spec.metadata['rubygems_mfa_required'] = 'true'
 end

data/lib/git_ls/version.rb

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

data/lib/git_ls.rb

@@ -4,6 +4,7 @@
 #   GitLS.files -> Array of strings as files.
 #   This will be identical output to git ls-files
 require 'stringio'
+require_relative 'git_ls/version'
 
 module GitLS # rubocop:disable Metrics/ModuleLength
   class Error < StandardError; end
@@ -32,11 +33,15 @@ module GitLS # rubocop:disable Metrics/ModuleLength
       # 4-byte version number:
       # The current supported versions are 2, 3 and 4.
       # 32-bit number of index entries.
-      sig = file.read(4, buf)
+      file.read(4, buf)
+      sig = buf
       raise ::GitLS::Error, ".git/index file not found at '#{path}'" unless sig == 'DIRC'
 
-      git_index_version = file.read(4, buf).unpack1('N')
-      entries = file.read(4, buf).unpack1('N')
+      file.read(4, buf)
+      git_index_version = buf.unpack1('N')
+
+      file.read(4, buf)
+      entries = buf.unpack1('N')
 
       files = ::Array.new(entries)
       files = case git_index_version
@@ -121,7 +126,8 @@ module GitLS # rubocop:disable Metrics/ModuleLength
 
         next unless literal_length > 0
 
-        words = file.read(8 * literal_length, buf).unpack('B64' * literal_length)
+        file.read(8 * literal_length, buf)
+        words = buf.unpack('B64' * literal_length)
         words.each do |word|
           word.each_char.reverse_each do |char|
             yield(uncompressed_pos) if char == '1'
@@ -138,7 +144,7 @@ module GitLS # rubocop:disable Metrics/ModuleLength
       files.map! do
         file.seek(60, 1) # skip 60 bytes (40 bytes of stat, 20 bytes of sha)
 
-        length = (file.getbyte & 0xF) * 256 + file.getbyte # find the 12 byte length
+        length = ((file.getbyte & 0xF) * 256) + file.getbyte # find the 12 byte length
         if length < 0xFFF
           path = file.read(length)
           # :nocov:
@@ -161,7 +167,7 @@ module GitLS # rubocop:disable Metrics/ModuleLength
         file.seek(60, 1) # skip 60 bytes (40 bytes of stat, 20 bytes of sha)
         flags = file.getbyte
         extended_flag = (flags & 0b0100_0000) > 0
-        length = (flags & 0xF) * 256 + file.getbyte # find the 12 byte length
+        length = ((flags & 0xF) * 256) + file.getbyte # find the 12 byte length
         file.seek(2, 1) if extended_flag
 
         if length < 0xFFF
@@ -183,11 +189,11 @@ module GitLS # rubocop:disable Metrics/ModuleLength
 
     def files_4(files, file) # rubocop:disable Metrics/MethodLength, Metrics/AbcSize
       prev_entry_path = ''
-      files.map! do
+      files.map! do # rubocop:disable Metrics/BlockLength
         file.seek(60, 1) # skip 60 bytes (40 bytes of stat, 20 bytes of sha)
         flags = file.getbyte
         extended_flag = (flags & 0b0100_0000) > 0
-        length = (flags & 0xF) * 256 + file.getbyte # find the 12 byte length
+        length = ((flags & 0xF) * 256) + file.getbyte # find the 12 byte length
         file.seek(2, 1) if extended_flag
 
         # documentation for this number from
@@ -203,7 +209,7 @@ module GitLS # rubocop:disable Metrics/ModuleLength
         n = 1
         while (prev_read_offset & 0b1000_0000) > 0
           read_offset += (prev_read_offset & 0b0111_1111)
-          read_offset += 2**(7 * n)
+          read_offset += 1 << (7 * n)
           n += 1
           prev_read_offset = file.getbyte
         end
@@ -212,7 +218,8 @@ module GitLS # rubocop:disable Metrics/ModuleLength
         initial_part_length = prev_entry_path.bytesize - read_offset
 
         if length < 0xFFF
-          rest = file.read(length - initial_part_length)
+          rest = +''
+          file.read(length - initial_part_length, rest)
           file.seek(1, 1) # the NUL
           # :nocov:
         else
@@ -224,8 +231,8 @@ module GitLS # rubocop:disable Metrics/ModuleLength
           # :nocov:
         end
 
-        prev_entry_path = prev_entry_path.byteslice(0, initial_part_length) + rest
-        prev_entry_path.force_encoding(Encoding::UTF_8)
+        prev_entry_path = +"#{prev_entry_path.byteslice(0, initial_part_length)}#{rest}"
+        prev_entry_path.force_encoding(::Encoding::UTF_8)
       end
     end
   end

metadata

@@ -1,176 +1,21 @@
 --- !ruby/object:Gem::Specification
 name: git_ls
 version: !ruby/object:Gem::Version
-  version: 0.5.0
+  version: 0.5.1
 platform: ruby
 authors:
 - Dana Sherson
-autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-09-12 00:00:00.000000000 Z
-dependencies:
-- !ruby/object:Gem::Dependency
-  name: benchmark-ips
-  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: 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: leftovers
-  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: 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'
-- !ruby/object:Gem::Dependency
-  name: rake
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 12.3.3
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 12.3.3
-- !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: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: rubocop-performance
-  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-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: simplecov
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 0.18.5
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 0.18.5
-- !ruby/object:Gem::Dependency
-  name: spellr
-  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: 
+date: 2025-01-28 00:00:00.000000000 Z
+dependencies: []
 email:
 - robot@dana.sh
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/workflows/ci.yml"
 - ".gitignore"
 - ".leftovers.yml"
 - ".rspec"
@@ -180,7 +25,6 @@ files:
 - ".spellr_wordlists/english.txt"
 - ".spellr_wordlists/ruby.txt"
 - ".spellr_wordlists/shell.txt"
-- ".travis.yml"
 - CHANGELOG.md
 - Gemfile
 - LICENSE.txt
@@ -196,7 +40,7 @@ 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: 
+  rubygems_mfa_required: 'true'
 rdoc_options: []
 require_paths:
 - lib
@@ -211,8 +55,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.2
-signing_key: 
+rubygems_version: 3.6.2
 specification_version: 4
 summary: Read a .git/index file and list the files
 test_files: []

data/.travis.yml

@@ -1,10 +0,0 @@
----
-language: ruby
-cache: bundler
-rvm:
-  - 2.7
-  - 2.6
-  - 2.5
-  - 2.4
-  - jruby
-before_install: sudo apt-get install git && gem install bundler -v 2.1.4