tmp-repo 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+--- 
+SHA1: 
+  metadata.gz: 750d50105e4fe0fd086ed4c10c8bf3f4648b17c6
+  data.tar.gz: ebacae5e6fd5562a16c78ee84f1f262d45546620
+SHA512: 
+  metadata.gz: d57090af6e6155920bea50f1d8fd2513bcae60ec2030c9eb5bead81e0c2f9ff740e5165c27b244edf097a130ddf8ca1bd178f0c68e37dfbd93138a72a82ef943
+  data.tar.gz: ab3f893e67603d9a024f8bf18c44a042e82b2bd56a68771684daa7c793efb50233c7ed527524ac53906796c91d08b097e2c1b84ef818fd001f36e355bac60833

data/Gemfile

@@ -0,0 +1,13 @@
+source "https://rubygems.org"
+
+gemspec
+
+group :development, :test do
+  gem 'pry-nav'
+  gem 'rake'
+end
+
+group :test do
+  gem 'rspec'
+  gem 'rr'
+end

data/History.txt

@@ -0,0 +1,3 @@
+== 1.0.0
+
+* Birthday!

data/README.md

@@ -0,0 +1,120 @@
+tmp-repo
+========
+
+[![Build Status](https://travis-ci.org/camertron/tmp-repo.svg?branch=master)](http://travis-ci.org/camertron/tmp-repo)
+
+Creates and manages git repositories in the operating system's temporary directory. It does this by providing a thin wrapper around the git binary that's pointed at a randomly generated temporary folder.
+
+## Installation
+
+`gem install tmp-repo`
+
+## Usage
+
+```ruby
+require 'tmp-repo'
+```
+
+### Basics
+
+Creating a new `TmpRepo` will automatically create a randomly named folder in your system's temp directory and initialize a git repository in it:
+
+```ruby
+repo = TmpRepo.new
+repo.working_dir # => #<Pathname:/var/folders/3x/n10r69b16bq_rlcqr3fy0rwc0000gn/T/b068487773901ffe23e66a8259711fa1>
+```
+
+Once created, you can ask your `TmpRepo` questions and perform operations on it. Don't forget to clean up after yourself when you're finished:
+
+```ruby
+repo.unlink
+```
+
+### Creating Files
+
+```ruby
+repo.create_file('foo.txt') do |f|
+  f.write("I'm a new file!")
+end
+```
+
+OR
+
+```ruby
+file = repo.create_file('foo.txt')
+file.write("I'm a new file!")
+file.close
+```
+
+### Branching
+
+To create a new branch:
+
+```ruby
+repo.create_branch('my_new_branch')
+```
+
+To check out a branch:
+
+```ruby
+repo.checkout('my_other_branch')
+```
+
+To get the current branch:
+
+```ruby
+repo.current_branch  # => 'master'
+```
+
+### Staging and Committing
+
+To add all files to the git stage:
+
+```ruby
+repo.add_all
+```
+
+To commit staged files:
+
+```ruby
+repo.commit('Commit message')
+```
+
+### Repo Status
+
+`TmpRepo` instances provide a convenient way to retrieve the status of the repository via the `status` method. `status` return values are a simple hash of arrays:
+
+```ruby
+status = repo.status
+status[:new_file]  # => ['file1.txt', 'file2.txt']
+status[:deleted]   # => ['file3.txt']
+status[:modified]  # => ['file4.txt']
+```
+
+### Custom Commands
+
+This library only provides wrapper methods around the most common git commands. To run additional git commands, use the `git` method:
+
+```ruby
+repo.git('rebase master')
+```
+
+In addition, the lower-level `in_repo` method wraps the given block in a `Dir.chdir`, meaning the block is executed in the context of the repo's working directory:
+
+```ruby
+repo.in_repo do
+  `ls`  # list files in the repo's working directory
+end
+```
+
+## Requirements
+
+No external requirements.
+
+## Running Tests
+
+`bundle exec rake` should do the trick.
+
+## Authors
+
+* Cameron C. Dutro: http://github.com/camertron

data/Rakefile

@@ -0,0 +1,18 @@
+# encoding: UTF-8
+
+require 'rubygems' unless ENV['NO_RUBYGEMS']
+
+require 'bundler'
+require 'rspec/core/rake_task'
+require 'rubygems/package_task'
+
+require './lib/tmp-repo'
+
+Bundler::GemHelper.install_tasks
+
+task :default => :spec
+
+desc 'Run specs'
+RSpec::Core::RakeTask.new do |t|
+  t.pattern = './spec/**/*_spec.rb'
+end

data/lib/tmp-repo.rb

@@ -0,0 +1,117 @@
+# encoding: UTF-8
+
+require 'tmpdir'
+require 'pathname'
+require 'fileutils'
+require 'securerandom'
+
+class TmpRepo
+  class GitError < StandardError; end
+
+  attr_reader :working_dir
+
+  def initialize
+    @working_dir = Pathname(
+      File.join(Dir.tmpdir, SecureRandom.hex(16))
+    )
+
+    FileUtils.mkdir_p(working_dir)
+    git('init')
+  end
+
+  def unlink
+    FileUtils.rm_rf(working_dir.to_s)
+    nil
+  end
+
+  def create_file(new_file)
+    new_path = working_dir.join(new_file).to_s
+    handle = File.open(new_path, 'w+')
+
+    if block_given?
+      yield handle
+      handle.close
+    else
+      handle
+    end
+  end
+
+  def add_all
+    git('add -A')
+  end
+
+  def commit(message)
+    git("commit -m '#{message.gsub("'", "\\\\'")}'")
+  end
+
+  def checkout(ref)
+    git("checkout #{ref}")
+  end
+
+  def create_branch(branch_name)
+    git("checkout -b #{branch_name}")
+  end
+
+  def current_branch
+    git('rev-parse --abbrev-ref HEAD').strip
+  end
+
+  def status
+    parse_status(git('status'))
+  end
+
+  def git(command)
+    in_repo do
+      output = `git #{command}`
+
+      if $?.exitstatus != 0
+        raise GitError, output
+      end
+
+      output
+    end
+  end
+
+  def in_repo
+    Dir.chdir(working_dir.to_s) do
+      yield
+    end
+  end
+
+  private
+
+  def parse_status(status_text)
+    lines = status_text.split("\n")
+    status_hash = create_status_hash
+    statuses = possible_statuses_from(status_hash)
+
+    lines.each do |line|
+      index = -1
+
+      status = statuses.find do |status|
+        index = line =~ /#{Regexp.escape(status)}: /
+      end
+
+      if status
+        status = status_to_hash_key(status)
+        status_hash[status] << line[(index + status.size + 2)..-1].strip
+      end
+    end
+
+    status_hash
+  end
+
+  def status_to_hash_key(status)
+    status.gsub(' ', '_').to_sym
+  end
+
+  def possible_statuses_from(status_hash)
+    status_hash.keys.map do |status|
+      status.to_s.gsub('_', ' ').downcase
+    end
+  end
+
+  def create_status_hash
+    { modified: [], deleted: [], new_file: [] }
+  end  
+end

data/lib/tmp-repo/version.rb

@@ -0,0 +1,5 @@
+# encoding: UTF-8
+
+class TmpRepo
+  VERSION = '1.0.0'
+end

data/spec/spec_helper.rb

@@ -0,0 +1,9 @@
+# encoding: UTF-8
+
+require 'rspec'
+require 'tmp-repo'
+require 'pry-nav'
+
+RSpec.configure do |config|
+  config.mock_with :rr
+end

data/spec/tmp-repo_spec.rb

@@ -0,0 +1,183 @@
+# encoding: UTF-8
+
+require 'spec_helper'
+
+describe TmpRepo do
+  let(:repo) do
+    TmpRepo.new
+  end
+
+  before(:each) do
+    repo.git('config user.email tester@tester.com')
+    repo.git('config user.name Tester McTesterson')
+  end
+
+  after(:each) do
+    repo.unlink
+  end
+
+  def in_repo
+    Dir.chdir(repo.working_dir.to_s) do
+      yield
+    end
+  end
+
+  describe '#initialize' do
+    it 'should initialize the repository' do
+      expect(repo.working_dir.join('.git')).to exist
+    end
+  end
+
+  describe '#unlink' do
+    it 'should delete the temp directory' do
+      repo.unlink
+      expect(repo.working_dir).to_not exist
+    end
+  end
+
+  describe '#create_file' do
+    it 'yields a file handle if given a block' do
+      repo.create_file('foo.txt') do |f|
+        expect(f).to be_a(IO)
+        f.write('foobar')
+      end
+
+      contents = File.read(repo.working_dir.join('foo.txt').to_s)
+      expect(contents).to eq('foobar')
+    end
+
+    it 'returns a file handle if not given a block' do
+      handle = repo.create_file('foo.txt')
+      expect(handle).to be_a(IO)
+      handle.write('foobarbaz')
+      handle.close
+
+      contents = File.read(repo.working_dir.join('foo.txt').to_s)
+      expect(contents).to eq('foobarbaz')
+    end
+  end
+
+  describe '#add_all' do
+    it 'stages all files' do
+      repo.create_file('foo.txt') { |f| f.write('foobar') }
+      repo.add_all
+
+      in_repo do
+        expect(`git status`).to match(/new file:[\s]+foo\.txt/)
+      end
+    end
+  end
+
+  describe '#commit' do
+    it 'commits the stage' do
+      repo.create_file('foo.txt') { |f| f.write('foobar') }
+      repo.add_all
+      repo.commit('Committing foobar')
+
+      in_repo do
+        expect(`git log`).to match(/Committing foobar/)
+        expect(`git show --name-only HEAD`).to include('foo.txt')
+      end
+    end
+  end
+
+  context 'with a single commit' do
+    before(:each) do
+      repo.create_file('foo.txt') do |f|
+        f.write('foobar')
+      end
+
+      repo.add_all
+      repo.commit('Foobar committed')
+    end
+
+    describe '#checkout' do
+      it 'checks out the given branch' do
+        in_repo do
+          `git checkout -b my_branch && git checkout master`
+          expect(`git rev-parse --abbrev-ref HEAD`.strip).to eq('master')
+        end
+
+        repo.checkout('my_branch')
+
+        in_repo do
+          expect(`git rev-parse --abbrev-ref HEAD`.strip).to eq('my_branch')
+        end
+      end
+    end
+
+    describe '#create_branch' do
+      it 'creates a new branch' do
+        repo.create_branch('new_branch')
+
+        in_repo do
+          expect(`git branch`).to include('new_branch')
+        end
+      end
+    end
+
+    describe '#current_branch' do
+      it 'returns the current branch name' do
+        in_repo { `git checkout -b cool_branch` }
+        expect(repo.current_branch).to eq('cool_branch')
+      end
+    end
+
+    describe '#status' do
+      it 'returns no results when there are no uncommitted changes' do
+        repo.status.tap do |status|
+          expect(status[:new_file]).to be_empty
+          expect(status[:modified]).to be_empty
+          expect(status[:deleted]).to be_empty
+        end
+      end
+
+      it 'shows new files' do
+        repo.create_file('hello.txt') do |f|
+          f.write('blarg blegh')
+        end
+
+        repo.add_all
+
+        repo.status.tap do |status|
+          expect(status[:new_file]).to include('hello.txt')
+        end
+      end
+
+      it 'shows modified files' do
+        in_repo do
+          File.open('foo.txt', 'w+') do |f|
+            f.write("\nI'm a change!")
+          end
+
+          repo.add_all
+
+          repo.status.tap do |status|
+            expect(status[:modified]).to include('foo.txt')
+          end
+        end
+      end
+
+      it 'shows deleted files' do
+        in_repo do
+          File.unlink('foo.txt')
+          repo.add_all
+
+          repo.status.tap do |status|
+            expect(status[:deleted]).to include('foo.txt')
+          end
+        end
+      end
+    end
+
+    describe '#git' do
+      it 'facilitates executing custom git commands and returning their output' do
+        expect(repo.git('branch')).to include('master')
+      end
+
+      it 'raises an error if the command fails' do
+        expect(lambda { repo.git('') }).to raise_error(TmpRepo::GitError)
+      end
+    end
+  end
+end

data/tmp-repo.gemspec

@@ -0,0 +1,18 @@
+$:.unshift File.join(File.dirname(__FILE__), 'lib')
+require 'tmp-repo/version'  
+
+Gem::Specification.new do |s|
+  s.name     = "tmp-repo"
+  s.version  = ::TmpRepo::VERSION
+  s.authors  = ["Cameron Dutro"]
+  s.email    = ["camertron@gmail.com"]
+  s.homepage = "http://github.com/camertron"
+
+  s.description = s.summary = "Creates and manages a git repository in the operating system's temporary directory. Useful for running git operations in tests."
+
+  s.platform = Gem::Platform::RUBY
+  s.has_rdoc = true
+
+  s.require_path = 'lib'
+  s.files = Dir["{lib,spec}/**/*", "Gemfile", "History.txt", "README.md", "Rakefile", "tmp-repo.gemspec"]
+end

metadata

@@ -0,0 +1,61 @@
+--- !ruby/object:Gem::Specification 
+name: tmp-repo
+version: !ruby/object:Gem::Version 
+  version: 1.0.0
+platform: ruby
+authors: 
+- Cameron Dutro
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2014-08-21 00:00:00 Z
+dependencies: []
+
+description: Creates and manages a git repository in the operating system's temporary directory. Useful for running git operations in tests.
+email: 
+- camertron@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- Gemfile
+- History.txt
+- README.md
+- Rakefile
+- lib/tmp-repo.rb
+- lib/tmp-repo/version.rb
+- spec/spec_helper.rb
+- spec/tmp-repo_spec.rb
+- tmp-repo.gemspec
+homepage: http://github.com/camertron
+licenses: []
+
+metadata: {}
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - &id001 
+    - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - *id001
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: Creates and manages a git repository in the operating system's temporary directory. Useful for running git operations in tests.
+test_files: []
+