Class Gitlab::Git::Blob
In: lib/gitlab_git/blob.rb
Parent: Object

Methods

binary?   commit   data   empty?   find   find_entry_by_path   lfs_oid   lfs_pointer?   lfs_size   load_all_data!   name   new   raw   remove   rename   submodule_blob   truncated?  

Included Modules

Linguist::BlobHelper EncodingHelper

Constants

MAX_DATA_DISPLAY_SIZE = 10485760   This number is the maximum amount of data that we want to display to the user. We load as much as we can for encoding detection (Linguist) and LFS pointer parsing. All other cases where we need full blob data should use load_all_data!.

Attributes

binary  [RW] 
commit_id  [RW] 
data  [RW] 
id  [RW] 
loaded_size  [RW] 
mode  [RW] 
name  [RW] 
path  [RW] 
size  [RW] 

Public Class methods

commit(repository, options, action = :add)

Commit file in repository and return commit sha

options should contain next structure: 

  file: {
    content: 'Lorem ipsum...',
    path: 'documents/story.txt',
    update: true
  },
  author: {
    email: 'user@example.com',
    name: 'Test User',
    time: Time.now
  },
  committer: {
    email: 'user@example.com',
    name: 'Test User',
    time: Time.now
  },
  commit: {
    message: 'Wow such commit',
    branch: 'master',
    update_ref: false
  }
find_entry_by_path(repository, root_id, path)

Recursive search of blob id by path

Ex. 

  blog/            # oid: 1a
    app/           # oid: 2a
      models/      # oid: 3a
      file.rb      # oid: 4a

Blob.find_entry_by_path(repo, ‘1a’, ‘app/file.rb’) # => ‘4a‘

remove(repository, options)

Remove file from repository and return commit sha

options should contain next structure: 

  file: {
    path: 'documents/story.txt'
  },
  author: {
    email: 'user@example.com',
    name: 'Test User',
    time: Time.now
  },
  committer: {
    email: 'user@example.com',
    name: 'Test User',
    time: Time.now
  },
  commit: {
    message: 'Remove FILENAME',
    branch: 'master'
  }
rename(repository, options)

Rename file from repository and return commit sha

options should contain next structure: 

  file: {
    previous_path: 'documents/old_story.txt'
    path: 'documents/story.txt'
    content: 'Lorem ipsum...',
    update: true
  },
  author: {
    email: 'user@example.com',
    name: 'Test User',
    time: Time.now
  },
  committer: {
    email: 'user@example.com',
    name: 'Test User',
    time: Time.now
  },
  commit: {
    message: 'Rename FILENAME',
    branch: 'master'
  }

Public Instance methods

lfs_pointer?()

Valid LFS object pointer is a text file consisting of version oid size see github.com/github/git-lfs/blob/v1.1.0/docs/spec.md#the-pointer

load_all_data!(repository)

Load all blob data (not just the first MAX_DATA_DISPLAY_SIZE bytes) into memory as a Ruby string.

[Validate]