git_dump 0.1.0

checksums.yaml

@@ -0,0 +1,15 @@
+---
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    ZDRlN2E3ZTg5MmUzZWI5M2IxNjhjYzU0Y2Y3ZmQ2YWZiYzU3MTcwMg==
+  data.tar.gz: !binary |-
+    MThmYjAxMzY5NGI3Yzg4YjU5ODg3ZDQwOTBlYTQ1MTJmOGYwZDk0Yw==
+SHA512:
+  metadata.gz: !binary |-
+    YTA2NjUwNWNmNDU4NDVhNDNjYzUxN2U1ZDFkODg5N2I2YzY4MmE0MGI5OGYy
+    Zjk2OGI3YzYxZTQ4NWY1NTFmYzRiNzgxNmQ0NzZiYTE3ZGNkZjgxOWE0ODMw
+    ZDgyMDhkZGFjNWFhM2IyNWE5MDVmMTI2MmE3OGUzMDMxZGQ3N2Q=
+  data.tar.gz: !binary |-
+    N2RiOTIxY2Y3ZTgxOWM2MTYzOTMyNWNlNDhiMGNiYjBhNzNlYzM3ZDk2NGFk
+    MzdiN2RmODBjZmE2NGU2Nzk3MThmYzJlYjM4NWU2NDEyNWE1ZjcwMDdmZDMz
+    NWQ2YzJiMzUzNzg5OTRhYjMyNmQ4NzEwMTlmMWVkNGRlZGVkYzA=

data/.gitignore

@@ -0,0 +1,14 @@
+/pkg/
+/*.gem
+
+/doc/
+/rdoc/
+/.yardoc/
+/coverage/
+
+Makefile
+*.o
+*.bundle
+/tmp/
+
+/Gemfile.lock

data/.rubocop.yml

@@ -0,0 +1,62 @@
+AllCops:
+  Exclude:
+    - '*.gemspec'
+
+Lint/EndAlignment:
+  AlignWith: variable
+
+Metrics/AbcSize:
+  Max: 25
+
+Metrics/CyclomaticComplexity:
+  Max: 10
+
+Metrics/MethodLength:
+  Max: 20
+
+Metrics/PerceivedComplexity:
+  Max: 8
+
+Style/AccessModifierIndentation:
+  EnforcedStyle: outdent
+
+Style/BracesAroundHashParameters:
+  Enabled: false
+
+Style/CaseIndentation:
+  IndentWhenRelativeTo: end
+
+Style/DotPosition:
+  EnforcedStyle: trailing
+
+Style/DoubleNegation:
+  Enabled: false
+
+Style/Encoding:
+  EnforcedStyle: when_needed
+
+Style/HashSyntax:
+  EnforcedStyle: hash_rockets
+
+Style/IfUnlessModifier:
+  MaxLineLength: 40
+
+Style/IndentHash:
+  EnforcedStyle: consistent
+
+Style/PercentLiteralDelimiters:
+  PreferredDelimiters:
+    '%w': '[]'
+    '%W': '[]'
+
+Style/Semicolon:
+  AllowAsExpressionSeparator: true
+
+Style/SpaceBeforeBlockBraces:
+  EnforcedStyle: no_space
+
+Style/SpaceInsideHashLiteralBraces:
+  EnforcedStyle: no_space
+
+Style/TrailingComma:
+  EnforcedStyleForMultiline: comma

data/.travis.yml

@@ -0,0 +1,37 @@
+language: ruby
+rvm:
+  - 1.8.7
+  - 1.9.3
+  - '2.0'
+  - '2.1'
+  - '2.2'
+  - jruby-18mode
+  - jruby-19mode
+  - ree
+script:
+  if [ -n "$RUBOCOP" ]; then
+    bundle exec rubocop
+  ; elif [ -n "$BENCHMARK" ]; then
+    RUGGED=0 bundle exec script/benchmark; RUGGED=1 bundle exec script/benchmark
+  ; else
+    bundle exec rspec
+  ; fi
+env:
+  -
+  - RUGGED=1
+matrix:
+  fast_finish: true
+  include:
+    - env: RUBOCOP=true
+      rvm: default
+    - env: BENCHMARK=true RUGGED=1
+      rvm: default
+  exclude:
+    - rvm: 1.8.7
+      env: RUGGED=1
+    - rvm: jruby-18mode
+      env: RUGGED=1
+    - rvm: jruby-19mode
+      env: RUGGED=1
+    - rvm: ree
+      env: RUGGED=1

data/Gemfile

@@ -0,0 +1,5 @@
+source 'https://rubygems.org'
+
+gemspec
+
+gem 'rugged' if ENV['RUGGED'] == '1'

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2012-2014 Ivan Kuchin
+
+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.markdown

@@ -0,0 +1,75 @@
+[![Gem Version](https://img.shields.io/gem/v/git_dump.svg?style=flat)](https://rubygems.org/gems/git_dump)
+[![Build Status](https://img.shields.io/travis/toy/git_dump/master.svg?style=flat)](https://travis-ci.org/toy/git_dump)
+[![Code Climate](https://img.shields.io/codeclimate/github/toy/git_dump.svg?style=flat)](https://codeclimate.com/github/toy/git_dump)
+[![Dependency Status](https://img.shields.io/gemnasium/toy/git_dump.svg?style=flat)](https://gemnasium.com/toy/git_dump)
+[![Inch CI](http://inch-ci.org/github/toy/git_dump.svg?branch=master&style=flat)](http://inch-ci.org/github/toy/git_dump)
+
+# git_dump
+
+Distributed versioned store using git.
+
+## Installation
+
+```sh
+gem install git_dump
+```
+
+## Usage
+
+Init:
+
+```rb
+dump = GitDump.new('dump.git', :create => true)
+```
+
+Create version:
+
+```rb
+version = dump.new_version
+version['a/b/c'] = 'string'
+version.store('b/c/d', StringIO.new('string'), 0644)
+version.store('d/e', File.open('path'), 0755)
+version.store_from('e/f', 'path')
+version.commit(:tags => 'test')
+```
+
+Read version:
+
+```rb
+version = dump.versions.last
+version['a/b/c'].open{ |f| f.read }
+version['a/b/c'].read
+version['a/b/c'].write_to('new_path')
+
+version.each do |path_object|
+  path_object.path
+end
+
+version.each_recursive do |entry|
+  entry.read
+end
+```
+
+Versions:
+
+```rb
+dump.versions.each do |version|
+  puts [version.id, version.time, version.commit_time].join(' ')
+end
+
+dump.versions.first.remove
+```
+
+Remote (url in any syntax supported by git including local paths):
+
+```rb
+ids = GitDump.remote_version_ids(url)
+
+dump.versions.last.push(url)
+
+dump.fetch(url, ids.first)
+```
+
+## Copyright
+
+Copyright (c) 2012-2014 Ivan Kuchin. See LICENSE.txt for details.

data/git_dump.gemspec

@@ -0,0 +1,22 @@
+# encoding: UTF-8
+
+Gem::Specification.new do |s|
+  s.name        = 'git_dump'
+  s.version     = '0.1.0'
+  s.summary     = %q{Distributed versioned store using git}
+  s.homepage    = "http://github.com/toy/#{s.name}"
+  s.authors     = ['Ivan Kuchin']
+  s.license     = 'MIT'
+
+  s.rubyforge_project = s.name
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = %w[lib]
+
+  s.add_development_dependency 'rspec', '~> 3.0'
+  if Gem::Version.new(RUBY_VERSION) >= Gem::Version.new('1.9.3')
+    s.add_development_dependency 'rubocop', '~> 0.27'
+  end
+end

data/lib/git_dump.rb

@@ -0,0 +1,41 @@
+require 'git_dump/repo'
+
+require 'forwardable'
+require 'securerandom'
+
+# Main interface, most instance methods forwarded to Repo
+class GitDump
+  # Initialize using existing repositiory
+  # use `:create => true` or `:create => :bare` to create bare repo if missing
+  # or `:create => :non_bare` for non bare one
+  def initialize(path, options = {})
+    @repo = Repo.new(path, options)
+  end
+
+  extend Forwardable
+
+  def_delegators :@repo, :path, :new_version, :versions, :fetch, :gc
+
+  class << self
+    # List remote version ids
+    def remote_version_ids(url)
+      Repo.remote_version_ids(url)
+    end
+  end
+
+  # hostname as returned by `hostname` or "unknown"
+  def self.hostname
+    @hostname ||= begin
+      hostname = `hostname`.chomp
+      hostname.empty? ? 'unknown' : hostname
+    end
+  end
+
+  # From 1.9 securerandom.rb, to replace with SecureRandom.uuid
+  def self.uuid
+    ary = SecureRandom.random_bytes(16).unpack('NnnnnN')
+    ary[2] = (ary[2] & 0x0fff) | 0x4000
+    ary[3] = (ary[3] & 0x3fff) | 0x8000
+    format '%08x-%04x-%04x-%04x-%04x%08x', *ary
+  end
+end

data/lib/git_dump/cmd.rb

@@ -0,0 +1,118 @@
+require 'shellwords'
+require 'English'
+
+class GitDump
+  # Running commands using system and popen
+  class Cmd
+    # Non succesfull exit code
+    class Failure < StandardError; end
+
+    # Run git command
+    def self.git(*args)
+      new(:git, *args)
+    end
+
+    # Command arguments
+    attr_reader :args
+
+    # Environment variables to set for command
+    attr_reader :env
+
+    # Working dir for running command
+    attr_reader :chdir
+
+    # Pipe /dev/null to stdin
+    attr_reader :no_stdin
+
+    # Redirect stdout to /dev/null
+    attr_reader :no_stdout
+
+    # Redirect stderr to /dev/null
+    attr_reader :no_stderr
+
+    # Construct command, last argument can be a hash of options with keys:
+    #   :env - hash of environment varibles
+    #   :chdir - working dir for running command
+    #   :no_stdin - pipe /dev/null to stdin
+    #   :no_stdout - redirect stdout to /dev/null
+    #   :no_stderr - redirect stderr to /dev/null
+    def initialize(*args)
+      args = args.dup
+      options = args.pop if args.last.is_a?(Hash)
+      @args = args.map(&:to_s)
+
+      parse_options(options) if options
+    end
+
+    # Construct command string
+    def to_s
+      cmd = args.shelljoin
+      if env
+        env_str = env.map{ |k, v| "#{k}=#{v}" }.shelljoin
+        cmd = "export #{env_str}; #{cmd}"
+      end
+      cmd = "cd #{chdir}; #{cmd}" if chdir
+      cmd << ' < /dev/null' if no_stdin
+      cmd << ' > /dev/null' if no_stdout
+      cmd << ' 2> /dev/null' if no_stderr
+      cmd
+    end
+
+    # Run using system
+    def run
+      success = system(*arguments)
+      return true if success
+      fail Failure, "`#{self}` failed with #{$CHILD_STATUS.exitstatus}"
+    end
+
+    # Run using popen
+    def popen(mode = 'r', &block)
+      if block
+        result = IO.popen(arguments, mode, &block)
+        return result if $CHILD_STATUS.success?
+        fail Failure, "`#{self}` failed with #{$CHILD_STATUS.exitstatus}"
+      else
+        IO.popen(arguments, mode)
+      end
+    end
+
+    # Capture output
+    def capture
+      popen(&:read)
+    end
+
+    # Captured lines
+    def stripped_lines
+      capture.split(/[\n\r]+/)
+    end
+
+    def inspect
+      "#<#{self.class} #{self}>"
+    end
+
+  private
+
+    # Parse options hash, fail on unknown options
+    def parse_options(options)
+      @env = options.delete(:env).to_hash if options.key?(:env)
+      @chdir = options.delete(:chdir).to_s if options.key?(:chdir)
+      @no_stdin = !!options.delete(:no_stdin) if options.key?(:no_stdin)
+      @no_stdout = !!options.delete(:no_stdout) if options.key?(:no_stdout)
+      @no_stderr = !!options.delete(:no_stderr) if options.key?(:no_stderr)
+
+      fail "Unknown options: #{options.inspect}" unless options.empty?
+    end
+
+    # For ruby < 1.9 and jruby use to_s, otherwise return args with env hash
+    # prepanded and options hash appended
+    def arguments
+      return to_s if RUBY_VERSION < '1.9' || defined?(JRUBY_VERSION)
+      options = {}
+      options[:chdir] = chdir if chdir
+      options[:in] = '/dev/null' if no_stdin
+      options[:out] = '/dev/null' if no_stdout
+      options[:err] = '/dev/null' if no_stderr
+      [env || {}] + args + [options]
+    end
+  end
+end

data/lib/git_dump/entry.rb

@@ -0,0 +1,31 @@
+require 'git_dump/path_object'
+
+class GitDump
+  # Entry at path
+  class Entry < PathObject
+    attr_reader :sha, :mode
+    def initialize(repo, dir, name, sha, mode)
+      super(repo, dir, name)
+      @sha, @mode = sha, (mode & 0100) == 0 ? 0644 : 0755
+    end
+
+    # Pipe for reading data
+    def open(&block)
+      repo.blob_pipe(sha, &block)
+    end
+
+    # Data
+    def read
+      repo.blob_read(sha)
+    end
+
+    # Write to path
+    def write_to(path)
+      repo.blob_unpack(sha, path, mode)
+    end
+
+    def inspect
+      "#<#{self.class} sha=#{@sha} mode=#{format '%03o', @mode}>"
+    end
+  end
+end