rjgit 6.4.0.0 → 6.5.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5cf23697cf088e1ad377026269d1a8af6ffd616a6e4e9fa7039be442ab5c8df9
-  data.tar.gz: 302078c9082f0abfe79378252869be2afc4b54a4196511275d4d800cd3f0e093
+  metadata.gz: 6ffd00cd58355827c9f0e25310905d0634d556f3266189b170ebdf5c725db6d9
+  data.tar.gz: ec13041af58650371daba46753ba499260ba3d48ead0c7159c0c3016fbd9eaa9
 SHA512:
-  metadata.gz: cc7dbe650511932d321571dfbadc6f786a0695db2ce73e9ae70a1e6af7ae6ef167af071ea83672a0090493323e7bd756b0daef58c3663317c36a48044860b954
-  data.tar.gz: cf50e8bb4b4bbc06f722fe201a91373e3b1e18fdee2868476807a17c9e180f94851882d951f2771df4cbe65bc230d79af4fab07f28cb9a0d8c493748f24e62d7
+  metadata.gz: 4dacb2b8c3414b8250c91277815813ada02b7fe6ce010dd2167b1d9d616cecd73f93b84ef51643ee1e5b625bdff58462b720fc6df511018d2637ca93a9dc3a56
+  data.tar.gz: de445b74d2ce33b6368ff794607d8c3e294ebc06231320f0e6b2ecd5d18b563f80f9f0567cbcdef2f5ce7005d2680b66b5e876006c800bb71a37f350d67d5d34

data/README.md

@@ -6,7 +6,7 @@ RJGit
 [![Ruby Build](https://github.com/repotag/rjgit/actions/workflows/test.yaml/badge.svg)](https://github.com/repotag/rjgit/actions/workflows/test.yaml)
 [![Coverage Status](https://coveralls.io/repos/repotag/rjgit/badge.png?branch=master)](https://coveralls.io/r/repotag/rjgit)
 [![Gem Version](https://badge.fury.io/rb/rjgit.png)](http://badge.fury.io/rb/rjgit)
-[![Cutting Edge Dependency Status](https://dometto-cuttingedge.herokuapp.com/github/repotag/rjgit/svg 'Cutting Edge Dependency Status')](https://dometto-cuttingedge.herokuapp.com/github/repotag/rjgit/info)
+[![Cutting Edge Dependency Status](https://cuttingedge.onrender.com/github/repotag/rjgit/svg 'Cutting Edge Dependency Status')](https://cuttingedge.onrender.com/github/repotag/rjgit/info)
 
 Summary
 -------
@@ -15,21 +15,13 @@ RJGit provides a fully featured library for accessing and manipulating git repos
 
 Installation
 ------------
-Install the rjgit gem with the command:
+
+Install the rjgit gem with:
 
 ```sh
 $ gem install rjgit
 ```
 
-#### Dependencies for using RJGit:
-- JRuby >= 1.7.0
-- mime-types >= 1.15
-
-#### Further dependencies for developing RJGIT:
-- rake >= 0.9.2.2
-- rspec >= 2.0
-- simplecov
-
 #### Version scheme
 
 RJGit's version number is the version of jgit used, plus our own patch level counter. For instance, RJGit 4.0.1.0 uses jgit 4.0.1, patch level 0.
@@ -67,7 +59,12 @@ repo.commits('master')
 repo.commits('959329025f67539fb82e76b02782322fad032821')
 repo.head
 commit = repo.commits('master').first # a Commit object; try commit.actor, commit.id, etc.
-# Similarly for getting tags, branches, trees (directories), and blobs (files).
+```
+
+### Getting branches
+
+```ruby
+repo.branches
 ```
 
 ### Finding a single object by SHA
@@ -76,11 +73,43 @@ repo.find('959329025f67539fb82e76b02782322fad032821')
 repo.find('959329025f67539fb82e76b02782322fad032821', :commit) # Find a specific :commit, :blob, :tree, or :tag
 ```
 
-### Logs
+### Blobs and Trees
 
 ```ruby
-repo.git.log # Returns an Array of Commits constituting the log for the default branch
-repo.git.log("follow-rename.txt", "HEAD", follow: true, list_renames: true) # Log for a specific path, tracking the pathname over renames. Returns an Array of TrackingCommits, which store the tracked filename: [#<RJGit::TrackingCommit:0x773014d3 @tracked_pathname="follow-rename.txt" ...>]
+blob = repo.blob("example/file.txt") # Retrieve a file by filepath, from the HEAD commit...
+blob = repo.blob("example/file.txt", "refs/heads/mybranch') # Retrieve the same file from a different branch
+blob = repo.find("959329025f67539fb82e76b02782322fad032822", :blob) # ...or by SHA
+blob.data # Cat the file; also blob.id, blob.mode, etc.
+tree = repo.tree("example") # Retrieve a tree by filepath...
+tree = repo.find("959329025f67539fb82e76b02782322fad032000", :tree) #...or by SHA
+tree.data # List the tree's contents (blobs and trees). Also tree.id, tree.mode, etc.
+tree.each {|entry| puts entry.inspect} # Loop over the Tree's children (Blobs and Trees)
+tree.find_blob {|entry| entry[:name] == 'foo.txt'} # Find a single blob that matches the block
+tree.find_tree {|entry| entry[:name] == 'mytree' } # Find a single tree that matches the block
+tree.find {|entry| ...} # Find a single entry that matches the block
+tree.find_all {|entry entry[:name].include?('.') } # Find all entries matching the block
+tree.trees # An array of the Tree's child Trees
+tree.blobs # An array of the Tree's child Blobs
+Porcelain::ls_tree(repo, repo.tree("example"), :print => true, :recursive => true, :ref => 'mybranch') # Outputs the Tree's contents to $stdout. Faster for recursive listing than Tree#each. Passing nil as the second argument lists the entire repository. ref defaults to HEAD.
+```
+
+### Getting tags
+```ruby
+tag = repo.tags['example_tag']
+tag.id # tag's object id
+tag.author.name # Etcetera
+some_object = Porcelain.object_for_tag(repo, tag) # Returns the tagged object; e.g. a Commit
+```
+
+### Getting notes
+
+```ruby
+repo.notes
+note = repo.head.note
+note.message # the String message of the note
+note.annotates # the SHA ID of the object this note is attached to
+repo.head.note = "Happy note writing"
+repo.head.note_remove
 ```
 
 ### Getting diffs
@@ -91,26 +120,11 @@ options = {:old_rev => sha2, :new_rev => sha1, :file_path => "some/path.txt", :p
 Porcelain.diff(repo, options)
 ```
 
-### Getting tags
-```ruby
-tag = repo.tags['example_tag']
-tag.id # tag's object id
-tag.author.name # Etcetera
-some_object = Porcelain.object_for_tag(repo, tag) # Returns the tagged object; e.g. a Commit
-```
+### Logs
 
-### Blobs and Trees
 ```ruby
-blob = repo.blob("example/file.txt") # Retrieve a file by filepath...
-blob = repo.find("959329025f67539fb82e76b02782322fad032822", :blob) # ...or by SHA
-blob.data # Cat the file; also blob.id, blob.mode, etc.
-tree = repo.tree("example") # Retrieve a tree by filepath...
-tree = repo.find("959329025f67539fb82e76b02782322fad032000", :tree) #...or by SHA
-tree.data # List the tree's contents (blobs and trees). Also tree.id, tree.mode, etc.
-tree.each {|entry| puts entry.inspect} # Loop over the Tree's children (Blobs and Trees)
-tree.trees # An array of the Tree's child Trees
-tree.blobs # An array of the Tree's child Blobs
-Porcelain::ls_tree(repo, repo.tree("example"), :print => true, :recursive => true, :ref => 'mybranch') # Outputs the Tree's contents to $stdout. Faster for recursive listing than Tree#each. Passing nil as the second argument lists the entire repository. ref defaults to HEAD.
+repo.git.log # Returns an Array of Commits constituting the log for the default branch
+repo.git.log("follow-rename.txt", "HEAD", follow: true, list_renames: true) # Log for a specific path, tracking the pathname over renames. Returns an Array of TrackingCommits, which store the tracked filename: [#<RJGit::TrackingCommit:0x773014d3 @tracked_pathname="follow-rename.txt" ...>]
 ```
 
 ### Creating blobs and trees from scratch
@@ -157,40 +171,24 @@ Contributing
 1. Create a new branch
 1. Modify the sources
 1. Add specs with full coverage for your new code
-1. Make sure the whole test suite passes by running rake
+1. Make sure the whole test suite passes by running `bundle exec rake`
 1. Push the branch up to GitHub
 1. Send us a pull request
 
-Running RSpec tests (the recommended way)
----------------
-
-1. Start the nailgun server
-```
-jruby --ng-server &
-```
-1. Run rake against the nailgun instance
-```
-jruby --ng -S rake
-```
-
 Authors
 -------
 
-RJGit is being developed by Team Repotag:
+RJGit is being developed by:
 
-- [Maarten Engelen](https://github.com/maarten)
 - [Bart Kamphorst](https://github.com/bartkamphorst)
 - [Dawa Ometto](https://github.com/dometto)
-- [Arlette van Wissen](https://github.com/arlettevanwissen)
-- [Steven Woudenberg](https://github.com/stevenwoudenberg)
 
-With special thanks to:
-- [Patrick Pepels](https://github.com/bluedread)
+
 
 
 License
 -------
-Copyright (c) 2011 - 2022, Team Repotag
+Copyright (c) 2011 - 2023, Team Repotag
 
 (Modified BSD License)
 

data/lib/commit.rb

@@ -4,6 +4,7 @@ module RJGit
   import 'org.eclipse.jgit.revwalk.RevCommit'
   import 'org.eclipse.jgit.diff.DiffFormatter'
   import 'org.eclipse.jgit.util.io.DisabledOutputStream'
+  import 'org.eclipse.jgit.api.Git'
   
   class Commit
 
@@ -30,6 +31,20 @@ module RJGit
       @tree ||= Tree.new(@jrepo, TREE_TYPE, nil, @jcommit.get_tree)
     end
   
+    def note(ref=Note::DEFAULT_REF)
+      jnote = Git.new(@jrepo).notes_show().set_notes_ref(ref).setObjectId(@jcommit).call()
+      jnote ? Note.new(@jrepo, jnote) : nil
+    end
+    
+    def note=(message, ref=Note::DEFAULT_REF)
+      Note.new(@jrepo, Git.new(@jrepo).notes_add.set_message(message).set_notes_ref(ref).setObjectId(@jcommit).call())
+    end
+    
+    def remove_note(ref=Note::DEFAULT_REF)
+      Git.new(@jrepo).notes_remove.set_notes_ref(ref).setObjectId(@jcommit).call()
+      return nil
+    end
+  
     def parents
       @parents ||= @jcommit.get_parents.map do |parent|
         RJGit::Commit.new(@jrepo, RevWalk.new(@jrepo).parseCommit(parent.get_id))

data/lib/note.rb

@@ -0,0 +1,18 @@
+module RJGit
+  
+  class Note
+    attr_reader :jnote, :message, :annotates
+    DEFAULT_REF = "refs/notes/commits"
+    
+    def initialize(repository, note)
+      @jrepo = RJGit.repository_type(repository)
+      @jnote = RJGit.note_type(note)
+      @message = @jrepo.open(@jnote.getData()).get_bytes.to_a.pack('c*').force_encoding('UTF-8')
+      @annotates = @jnote.to_s[5..44]
+    end
+    
+    def to_s
+      @message
+    end
+  end
+end

data/lib/repo.rb

@@ -216,6 +216,12 @@ module RJGit
     def tree(file_path, revstring=Constants::HEAD)
       Tree.find_tree(@jrepo, file_path, revstring)
     end
+      
+    def notes(ref=Note::DEFAULT_REF)
+      @git.jgit.notes_list().set_notes_ref(ref).call().to_a.map do |jnote|
+        Note.new(@jrepo, jnote)
+      end
+    end
     
     def update_ref(commit, force = false, ref = "refs/heads/#{Constants::MASTER}")
       ref_updater = @jrepo.updateRef(ref)

data/lib/rjgit_helpers.rb

@@ -83,7 +83,7 @@ module RJGit
   end
   
   def self.repository_type(repository)
-    repo = case repository
+    case repository
       when Repo then repository.jrepo
       when org.eclipse.jgit.lib.Repository then repository
       else nil
@@ -91,7 +91,7 @@ module RJGit
   end
   
   def self.actor_type(actor)
-    person_ident = case actor
+    case actor
       when Actor then actor.person_ident
       when org.eclipse.jgit.lib.PersonIdent then actor
       else nil
@@ -99,7 +99,7 @@ module RJGit
   end
   
   def self.tree_type(tree)
-    treeobj = case tree
+    case tree
       when Tree then tree.jtree
       when org.eclipse.jgit.revwalk.RevTree then tree
       when org.eclipse.jgit.lib.ObjectId then tree
@@ -108,15 +108,23 @@ module RJGit
   end
   
   def self.blob_type(blob)
-    blobobj = case blob
+    case blob
       when Blob then blob.jblob
       when org.eclipse.jgit.revwalk.RevBlob then blob
       else nil
     end
   end
   
+  def self.note_type(note)
+    case note
+      when Note then note.jnote
+      when org.eclipse.jgit.notes.Note then note
+      else nil
+    end
+  end
+  
   def self.commit_type(commit)
-    commitobj = case commit
+    case commit
       when Commit then commit.jcommit
       when org.eclipse.jgit.lib.ObjectId then commit
       else nil

data/lib/tree.rb

@@ -25,14 +25,6 @@ module RJGit
       RJGit::Porcelain.ls_tree(@jrepo, @path, Constants::HEAD, options={:print => true, :io => strio})
       @contents = strio.string
     end
-    
-    def contents_array
-      @contents_ary ||= jtree_entries
-    end
-
-    def count
-      contents_array.size
-    end
           
     def recursive_contents_array(limit = nil)
       if @recursive_contents.nil? || @recursive_contents[:limit] != limit
@@ -46,6 +38,26 @@ module RJGit
     def recursive_count(limit = nil)
       recursive_contents_array(limit).size
     end
+
+    def find_blob(&block)
+      return nil unless block_given?
+      _find(:Blob) {|tree_entry| yield tree_entry }
+    end
+
+    def find_tree(&block)
+      return nil unless block_given?
+      _find(:Tree) {|tree_entry| yield tree_entry }
+    end
+
+    def find(&block)
+      return nil unless block_given?
+      _find(nil) {|tree_entry| yield tree_entry}
+    end
+
+    def find_all(&block)
+      return nil unless block_given?
+      _find(nil, true) {|tree_entry| yield tree_entry}
+    end
     
     def each(&block)
       contents_array.each(&block)
@@ -64,8 +76,12 @@ module RJGit
         self
       else
         treewalk = TreeWalk.forPath(@jrepo, file, @jtree)
-        treewalk.nil? ? nil : 
-          wrap_tree_or_blob(treewalk.get_file_mode(0), treewalk.get_path_string, treewalk.get_object_id(0))
+        if treewalk
+          mode = treewalk.get_file_mode(0)
+          wrap_tree_or_blob(obj_type(mode), mode.get_bits, treewalk.get_path_string, treewalk.get_object_id(0))
+        else
+          nil
+        end
       end
     end
     
@@ -104,22 +120,68 @@ module RJGit
 
     private
 
-    def jtree_entries(options={})
+    def contents_array
+      @contents_ary ||= jtree_entries
+    end
+
+    def _find(type = nil, multiple = false, &block)
+      return nil unless block_given?
+      treewalk = init_walk
+      results = [] if multiple
+
+      while treewalk.next
+        entry = tree_entry(treewalk)
+        next if type && type != entry[:type]
+        if yield entry
+          result = wrap_tree_or_blob(entry[:type], entry[:mode], entry[:name], entry[:id])
+          if multiple
+            results << result
+          else
+            return result
+          end
+        end
+      end
+      return results
+    end
+
+    def init_walk(recurse=false)
       treewalk = TreeWalk.new(@jrepo)
       treewalk.add_tree(@jtree)
-      treewalk.set_recursive(true) if options[:recursive]
+      treewalk.set_recursive(true) if recurse
+      treewalk
+    end
+
+    def tree_entry(treewalk)
+      mode = treewalk.get_file_mode(0)
+      {
+        type: obj_type(mode),
+        mode: mode.get_bits,
+        name: treewalk.get_path_string,
+        id: treewalk.get_object_id(0)
+      }
+    end
+
+    def jtree_entries(options = {})
+      treewalk = init_walk(options[:recursive])
       entries = []
       while treewalk.next
-        entries << wrap_tree_or_blob(treewalk.get_file_mode(0), treewalk.get_path_string, treewalk.get_object_id(0))
+        mode = treewalk.get_file_mode(0)
+        type = obj_type(mode)
+
+        entries << wrap_tree_or_blob(type, mode.get_bits, treewalk.get_path_string, treewalk.get_object_id(0))
+
         break if options[:limit] && entries.size >= options[:limit].to_i
       end
       entries
     end
 
-    def wrap_tree_or_blob(mode, path, id)
-      type = mode.get_object_type == Constants::OBJ_TREE ? RJGit::Tree : RJGit::Blob
+    def wrap_tree_or_blob(type, mode, path, id)
       walk = RevWalk.new(@jrepo)
-      type.new(@jrepo, mode.get_bits, path, walk.parse_any(id)) 
+      RJGit.const_get(type).new(@jrepo, mode, path, walk.parse_any(id)) 
+    end
+
+    def obj_type(mode)
+      mode.get_object_type == Constants::OBJ_BLOB ? :Blob : :Tree
     end
     
   end

data/lib/version.rb

@@ -1,3 +1,3 @@
 module RJGit
-  VERSION = "6.4.0.0"
+  VERSION = "6.5.0.0"
 end

metadata

@@ -1,18 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: rjgit
 version: !ruby/object:Gem::Version
-  version: 6.4.0.0
+  version: 6.5.0.0
 platform: ruby
 authors:
-- Maarten Engelen
 - Bart Kamphorst
 - Dawa Ometto
-- Arlette van Wissen
-- Steven Woudenberg
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-01-06 00:00:00.000000000 Z
+date: 2023-03-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   requirement: !ruby/object:Gem::Requirement
@@ -49,10 +46,11 @@ files:
 - lib/java/jars/bcpkix-jdk15on-168.jar
 - lib/java/jars/bcprov-jdk15on-168.jar
 - lib/java/jars/jsch-0.1.55.jar
-- lib/java/jars/org.eclipse.jgit-6.4.0.202211300538-r.jar
+- lib/java/jars/org.eclipse.jgit-6.5.0.202303070854-r.jar
 - lib/java/jars/org.eclipse.jgit.ssh.jsch-6.2.0.202206071550-r.jar
 - lib/java/jars/slf4j-api-1.7.2.jar
 - lib/java/jars/slf4j-simple-1.7.12.jar
+- lib/note.rb
 - lib/repo.rb
 - lib/rjgit.rb
 - lib/rjgit_helpers.rb