twit 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 289a3be1ed0e67bea59cffdce6e82f2802511b2c
-  data.tar.gz: 7690c43ff2be9ab8f81a26757f754162b4f57818
+  metadata.gz: 85fc88fe59a3282afb1f4e29af583408a35a3f29
+  data.tar.gz: a30902725f73eeeb3ca2b84666ef23908292e265
 SHA512:
-  metadata.gz: bcbd3f91dd0a59ea2c4162b0449ea8b999e2d45e05105cc11c9fd6a71ddba3775da26ff7f901805d1f1af8a7a614e4f8e680c643476dfd1302807982c102bf0b
-  data.tar.gz: 7a2097cad0b49b9c9a312433dfe344b5ad4ce5f2c29d18e53a31cc41adaa6c4493417565cbf890a62575d6a40f74c468123db3b99d01d35d55d55e3d59371112
+  metadata.gz: e82495bbc0018af33c6f33ae5ea9e14ebedd0a35c95ee6435fd6a0d0c227162dd76ebf93e70ab3f76687c481fd91d9979edf8024e50121da5c9da098b1d41812
+  data.tar.gz: 4a295fe77e361dd9769a72fe10494c50d9be7dcc4c6a854a5c2bfbf944ab59a6075e8d9e1e5229eb22ee8b33efab87a5e7e6c38034b1f7b4fdcd670b89a4ab51

data/.gitignore

@@ -16,3 +16,6 @@ test/tmp
 test/version_tmp
 tmp
 bin
+*~
+.*.swp
+Session.vim

data/README.markdown

@@ -1,6 +1,39 @@
-# Twit: simplified git wrapper
+# Twit: training wheels for Git
 
-Twit makes [git](http://git-scm.com) easier for beginners.
+Twit is a wrapper for [Git](http://git-scm.com) that abstracts concepts that
+many newcomers find tedious or confusing.
+
+When explaining version control to newcomers, the benefits are often unclear
+amid the complicated rules and syntax of a powerful tool like Git. Twit aims to
+provide an *easy and functional* demonstration of the usefulness of a branching
+version control system.
+
+For example, you can say that "version control allows you to save snapshots of
+your project history." However, in order to do this, you need to understand
+Git's two-step stage-then-commit workflow, with all its corner cases regarding
+new/deleted/moved files.
+
+Instead, Twit exposes a simple command to create a new commit with a snapshot
+of the repository:
+
+    twit save
+
+This stages any changes (including new files and deletions) and creates a
+commit, prompting the user for a commit message if needed.
+
+To create a new branch (and save any changes to the new branch as well):
+
+    twit saveas my_new_branch
+
+This quick-and-easy approach allows a new user to get started using version
+control right away, without having to learn Git's minutiae.
+
+However, this simple program is **not** meant to replace Git for the power
+user. The interface was designed to be user-friendly at the cost of
+flexibility. If you are a programmer, you should probably just buckle down and
+[learn git](http://gitref.org). Instead, Twit serves as an introduction to
+version control for users that would probably never learn Git, like writers or
+students.
 
 ## Installation
 
@@ -18,14 +51,53 @@ To install, simply run:
 
 Initialize a new git repository in the current directory.
 
-### `save` -- take a snapshot of all files
+Equivalent to: `git init`
+
+### `save` -- commit all new changes to the current branch
 
-    twit save <DESCRIBE_CHANGES>
+    twit save [DESCRIBE_CHANGES]
 
 Take a snapshot of all files in the directory.
 
 Any changes on the working tree will be committed to the current branch.
 
+Equivalent to: `git add --all && git commit -m <DESCRIBE_CHANGES>`
+
+### `saveas` -- commit all new changes to a new branch
+
+    twit saveas [NEW_BRANCH] [DESCRIBE_CHANGES]
+
+Equivalent to: `git checkout -b <NEW_BRANCH>` then `twit save`
+
+### `open` -- open another branch
+
+    twit open [BRANCH]
+
+Equivalent to: `git checkout <branch>`
+
+### `include` -- incorperate changes from another branch
+
+    twit include [OTHER_BRANCH]
+
+Incorperate changes from another branch, but do not save them yet. (The user
+can resolve any conflicts and then run `twit save` themselves.)
+
+Equivalent to: `git merge --no-ff --no-commit [OTHER_BRANCH]`
+
+### `discard` -- permanently delete unsaved changes
+
+    twit discard
+
+**Permanently** delete any unsaved changes to the current branch. Be careful!
+
+Equivalent to: `git reset --hard`
+
+### `list` -- show all branches
+
+    twit list
+
+Equivalent to: `git branch`
+
 ## API
 
 All command-line functions are available for use as a Ruby library as well.
@@ -41,6 +113,9 @@ All command-line functions are available for use as a Ruby library as well.
     # Take a snapshot
     Twit.save "Add some foo"
 
+    # Create a new branch
+    Twit.saveas "feature-branch"
+
 ## Development
 
 ### Setup

data/lib/twit.rb

@@ -1,8 +1,9 @@
 require "twit/version"
 require "twit/repo"
-require "twit/init"
 require "twit/error"
 
+require 'open3'
+
 # This module exposes twit commands as methods.
 module Twit
 
@@ -12,4 +13,90 @@ module Twit
     Twit::Repo.new
   end
 
+  # Initialize a git repository in a directory. Return a Twit::Repo object
+  # representing the new repository.
+  #
+  # If no argument is supplied, use the working directory.
+  #
+  # If init is called on a directory that is already part of a repository,
+  # simply do nothing.
+  def self.init dir = nil
+    dir ||= Dir.getwd
+
+    if is_repo? dir
+      return
+    end
+
+    Dir.chdir dir do
+      stdout, stderr, status = Open3.capture3 "git init"
+      if status != 0
+        raise Error, stderr
+      end
+    end
+    Repo.new dir
+  end
+
+  # Check if a given directory is a git repository.
+  #
+  # If no argument is supplied, use the working directory.
+  def self.is_repo? dir = nil
+    dir ||= Dir.getwd
+    Dir.chdir dir do
+      stdout, stderr, status = Open3.capture3 "git status"
+      if status != 0
+        if /Not a git repository/.match stderr
+          return false
+        else
+          raise Error, stderr
+        end
+      end
+      return true
+    end
+  end
+
+  # See {Twit::Repo#save}.
+  def self.save message
+    self.repo.save message
+  end
+
+  # See {Twit::Repo#saveas}.
+  def self.saveas branch, message = nil
+    self.repo.saveas branch, message
+  end
+
+  # See {Twit::Repo#discard}. (WARNING: PERMANENTLY DESTROYS DATA!)
+  def self.discard
+    self.repo.discard
+  end
+
+  # See {Twit::Repo#open}.
+  def self.open branch
+    self.repo.open branch
+  end
+
+  # See {Twit::Repo#include}.
+  def self.include branch
+    self.repo.include branch
+  end
+
+  # See {Twit::Repo#include_into}.
+  def self.include_into branch
+    self.repo.include_into branch
+  end
+
+  # See {Twit::Repo#list}.
+  def self.list
+    self.repo.list
+  end
+
+  # See {Twit::Repo#current_branch}.
+  def self.current_branch
+    self.repo.current_branch
+  end
+
+  # See {Twit::Repo#nothing_to_commit?}.
+  def self.nothing_to_commit?
+    self.repo.nothing_to_commit?
+  end
+
 end

data/lib/twit/cli.rb

@@ -5,24 +5,143 @@ module Twit
 
   # Automatically-built command-line interface (using Thor).
   class CLI < Thor
+    include Thor::Actions
 
     desc "init", "Create an empty repository in the current directory"
-    # Pass method to Twit module
+    # See {Twit::init}
     def init
-      Twit.init
+      begin
+        if Twit.is_repo?
+          say "You are already in a repository! (Root directory: #{Twit.repo.root})"
+          return
+        end
+        Twit.init
+      rescue Error => e
+        say "Error: #{e.message}"
+      end
     end
 
-    desc "save <DESCRIBE_CHANGES>", "Take a snapshot of all files"
-    # Pass method to default repo
+    desc "save [DESCRIBE_CHANGES]", "Take a snapshot of all files"
+    # See {Twit::Repo#save}.
     def save message = nil
-      if message.nil?
-        $stderr.puts "Please supply a message describing your changes.\n e.g.   twit save \"Update the README\""
-        exit false
+      begin
+        if Twit.nothing_to_commit?
+          say "No new edits to save"
+          return
+        end
+        while message.nil? || message.strip == ""
+          message = ask "Please supply a message describing your changes:"
+        end
+        Twit.save message
+      rescue Error => e
+        say "Error: #{e.message}"
+      end
+    end
+
+    desc "saveas [NEW_BRANCH] [DESCRIBE_CHANGES]", "Save snapshot to new branch"
+    # See {Twit::Repo#saveas}.
+    def saveas branch = nil, message = nil
+      while branch.nil? || branch.strip == ""
+        branch = ask "Please supply the name for your new branch:"
+      end
+      begin
+        if (not Twit.nothing_to_commit?) && message.nil?
+          message = ask "Please supply a message describing your changes:"
+        end
+        begin
+          Twit.saveas branch, message
+        rescue InvalidParameter => e
+          if /already exists/.match e.message
+            say "Cannot saveas to existing branch. See \"twit help include_into\""
+          else
+            say "Error: #{e.message}"
+          end
+        end
+      rescue Error => e
+        say "Error: #{e.message}"
+      end
+    end
+
+    desc "open [BRANCH]", "Open a branch"
+    # See {Twit::Repo#open}.
+    def open branch = nil
+      while branch.nil? || branch.strip == ""
+        branch = ask "Please enter the name of the branch to open:"
+      end
+      begin
+        Twit.open branch
+      rescue Error => e
+        say "Error: #{e.message}"
+      else
+        say "Opened #{branch}."
+      end
+    end
+
+    desc "list", "Display a list of branches"
+    # See {Twit::Repo#list} and {Twit::Repo#current_branch}
+    def list
+      begin
+        @current = Twit.current_branch
+        @others = Twit.list.reject { |b| b == @current }
+      rescue Error => e
+        say "Error: #{e.message}"
+        return
+      end
+      say "Current branch: #{@current}"
+      say "Other branches:"
+      @others.each do |branch|
+        say "- #{branch}"
+      end
+    end
+
+    desc "include", "Integrate changes from another branch"
+    # See {Twit::Repo#include}.
+    def include other_branch = nil
+      while other_branch.nil? || other_branch.strip == ""
+        other_branch = ask "Please enter the name of the branch to pull changes from:"
+      end
+      begin
+        @success = Twit.include other_branch
+      rescue Error => e
+        say "Error: #{e.message}"
+        return
+      end
+      if @success
+        say "Changes from #{other_branch} successfully included into #{Twit.current_branch}."
+        say "Use \"twit save\" to save them."
+      else
+        say "Conflicts detected! Fix them, then use \"twit save\" to save the changes."
       end
+    end
+
+    desc "include_into", "Integrate changes into another branch"
+    # See {Twit::Repo#include}.
+    def include_into other_branch = nil
+      while other_branch.nil? || other_branch.strip == ""
+        other_branch = ask "Please enter the name of the branch to push changes into:"
+      end
+      begin
+        @original = Twit.current_branch
+        @success = Twit.include_into other_branch
+      rescue Error => e
+        say "Error: #{e.message}"
+        return
+      end
+      if @success
+        say "Changes from #{@original} successfully included into #{other_branch}."
+        say "Use \"twit save\" to save them."
+      else
+        say "Conflicts detected! Fix them, then use \"twit save\" to save the changes."
+      end
+    end
+
+    desc "discard", "PERMANTENTLY delete all changes since last save"
+    # See {Twit::Repo#discard}.
+    def discard
       begin
-        Twit.repo.save message
-      rescue NothingToCommitError
-        puts "No new edits to save"
+        Twit.discard
+      rescue Error => e
+        say "Error: #{e.message}"
       end
     end
 

data/lib/twit/error.rb

@@ -10,4 +10,7 @@ module Twit
   # Raised when trying to commit nothing.
   class NothingToCommitError < Error; end
 
+  # Raised when a command receives an invalid parameter.
+  class InvalidParameter < Error; end
+
 end

data/lib/twit/repo.rb

@@ -1,6 +1,5 @@
 require 'open3'
 require 'twit/error'
-require 'twit/repo/save'
 
 module Twit
 
@@ -30,6 +29,177 @@ module Twit
       end
       @root = root
     end
+
+    # Update the snapshot of the current directory.
+    def save message
+      Dir.chdir @root do
+        cmd = "git add --all && git commit -m \"#{message}\""
+        stdout, stderr, status = Open3.capture3 cmd
+        if status != 0
+          if /nothing to commit/.match stdout
+            raise NothingToCommitError
+          elsif /Not a git repository/.match stderr
+            raise NotARepositoryError
+          else
+            raise Error, stderr
+          end
+        end
+      end
+    end
+
+    # Save the current state of the repository to a new branch.
+    def saveas newbranch, message = nil
+      message ||= "Create new branch: #{newbranch}"
+      # First, create the new branch and switch to it.
+      Dir.chdir @root do
+        cmd = "git checkout -b \"#{newbranch}\""
+        stdout, stderr, status = Open3.capture3 cmd
+        if status != 0
+          case stderr
+          when /not a valid branch name/
+            raise InvalidParameter, "#{newbranch} is not a valid branch name"
+          when /already exists/
+            raise InvalidParameter, "#{newbranch} already exists"
+          when /Not a git repository/
+            raise NotARepositoryError
+          else
+            raise Error, stderr
+          end
+        end
+      end
+      # Next, save any working changes.
+      begin
+        Twit.save message
+      rescue NothingToCommitError
+        # New changes are not required for saveas.
+      end
+    end
+
+    # Return an Array of branches in the repo.
+    def list
+      Dir.chdir @root do
+        cmd = "git branch"
+        stdout, stderr, status = Open3.capture3 cmd
+        if status != 0
+          case stderr
+          when /Not a git repository/
+            raise NotARepositoryError
+          else
+            raise Error, stderr
+          end
+        end
+        return stdout.split.map { |s|
+          # Remove trailing/leading whitespace and astericks
+          s.sub('*', '').strip
+        }.reject { |s|
+          # Drop elements created due to trailing newline
+          s.size == 0
+        }
+      end
+    end
+
+    # Return the current branch.
+    def current_branch
+      Dir.chdir @root do
+        cmd = "git rev-parse --abbrev-ref HEAD"
+        stdout, stderr, status = Open3.capture3 cmd
+        if status != 0
+          case stderr
+          when /unknown revision/
+            raise Error, "could not determine branch of repo with no commits"
+          when /Not a git repository/
+            raise NotARepositoryError
+          else
+            raise Error, stderr
+          end
+        end
+        return stdout.strip
+      end
+    end
+
+    # Open a branch.
+    def open branch
+      Dir.chdir @root do
+        cmd = "git checkout \"#{branch}\""
+        stdout, stderr, status = Open3.capture3 cmd
+        if status != 0
+          case stderr
+          when /Not a git repository/
+            raise NotARepositoryError
+          when /pathspec '#{branch}' did not match any/
+            raise InvalidParameter, "#{branch} does not exist"
+          else
+            raise Error, stderr
+          end
+        end
+      end
+    end
+
+    # Clean the working directory (permanently deletes changes!!!).
+    def discard
+      Dir.chdir @root do
+        # First, add all files to the index. (Otherwise, we won't discard new
+        # files.) Then, hard reset to revert to the last saved state.
+        cmd = "git add --all && git reset --hard"
+        stdout, stderr, status = Open3.capture3 cmd
+        if status != 0
+          case stderr
+          when /Not a git repository/
+            raise NotARepositoryError
+          else
+            raise Error, stderr
+          end
+        end
+      end
+    end
+
+    # Incorperate changes from another branch, but do not commit them.
+    #
+    # Return true if the merge was successful without conflicts; false if there
+    # are conflicts.
+    def include other_branch
+      Dir.chdir @root do
+        cmd = "git merge --no-ff --no-commit \"#{other_branch}\""
+        stdout, stderr, status = Open3.capture3 cmd
+        if status != 0
+          if /Not a git repository/.match stderr
+            raise NotARepositoryError
+          elsif /Automatic merge failed/.match stdout
+            return false
+          else
+            raise Error, stderr
+          end
+        end
+      end
+      return true
+    end
+
+    # Reverse of {Twit::Repo#include} -- incorperate changes from the current
+    # branch into another.
+    def include_into other_branch
+      original_branch = current_branch
+      open other_branch
+      include(original_branch)
+    end
+
+    # Return true if there is nothing new to commit.
+    def nothing_to_commit?
+      Dir.chdir @root do
+        cmd = "git status"
+        stdout, stderr, status = Open3.capture3 cmd
+        if status != 0
+          case stderr
+          when /Not a git repository/
+            raise NotARepositoryError
+          else
+            raise Error, stderr
+          end
+        end
+        # Check if status indicates nothing to commit
+        return /nothing to commit/.match stdout
+      end
+    end
+
   end
 
 end

data/lib/twit/version.rb

@@ -1,4 +1,4 @@
 module Twit
   # Gem version
-  VERSION = "0.0.1"
+  VERSION = "0.0.2"
 end

data/spec/spec_helper.rb

@@ -0,0 +1,15 @@
+require 'tmpdir'
+require 'twit'
+
+shared_context "temp repo" do
+  before do
+    @tmpdir = Dir.mktmpdir
+    @repo = Twit.init @tmpdir
+    @oldwd = Dir.getwd
+    Dir.chdir @tmpdir
+  end
+  after do
+    Dir.chdir @oldwd
+    FileUtils.remove_entry @tmpdir
+  end
+end

data/spec/twit/cli_spec.rb

@@ -11,28 +11,44 @@ describe Twit::CLI do
   end
 
   describe "init" do
-    it "calls Twit.init" do
-      Twit.should_receive(:init)
-      @cli.invoke :init
+    context "is not repo" do
+      before do
+        Twit.stub(:'is_repo?') { false }
+      end
+      it "calls Twit.init" do
+        expect(Twit).to receive(:init)
+        @cli.invoke :init
+      end
     end
   end
 
   describe "save" do
-    it "calls Twit.repo.save" do
-      message = "my test commit message"
-      repo = double('repo')
-
-      # Expected call is `Twit.repo.save message`
-      repo.should_receive(:save).with(message)
-      Twit.should_receive(:repo).and_return(repo)
+    context "need to commit" do
+      before do
+        Twit.stub(:'nothing_to_commit?') { false }
+      end
+      it "calls Twit.save" do
+        message = "my test commit message"
+        expect(Twit).to receive(:save).with(message)
+        @cli.invoke :save, [message]
+      end
+    end
+  end
 
-      @cli.invoke :save, [message]
+  describe "saveas" do
+    it "calls Twit.saveas" do
+      Twit.stub(:'nothing_to_commit?') { false }
+      branch = "my_branch"
+      message = "my test commit message"
+      expect(Twit).to receive(:saveas).with(branch, message)
+      @cli.invoke :saveas, [branch, message]
     end
-    it "asks for commit message" do
-      $stderr.should_receive(:puts).with /message/
-      expect {
-        @cli.invoke :save
-      }.to raise_error SystemExit
+  end
+
+  describe "discard" do
+    it "calls Twit.discard" do
+      expect(Twit).to receive(:discard)
+      @cli.invoke :discard
     end
   end
 

data/spec/twit/repo_spec.rb

@@ -1,10 +1,12 @@
 require 'tmpdir'
 require 'tempfile'
+require 'securerandom'
 
-require 'twit/repo'
-require 'twit/error'
+require 'twit'
+require 'spec_helper'
 
 describe Twit::Repo do
+
   describe "#new" do
 
     before do
@@ -58,4 +60,295 @@ describe Twit::Repo do
     end
 
   end
+
+  describe "#save" do
+
+    include_context "temp repo"
+
+    context "files in working tree" do
+      before do
+        3.times do |i|
+          File.open("file#{i}.txt", 'w') { |f| f.write("file#{i} contents\n") }
+        end
+      end
+      it "commits the entire working tree" do
+        @repo.save "created three files"
+        expect(`git status`).to include('working directory clean')
+      end
+      it "makes a commit" do
+        msg = "commit msg #{SecureRandom.hex(4)}"
+        @repo.save msg
+        expect(`git log`).to include(msg)
+      end
+    end
+
+    it "raises error in new repository" do
+      expect {
+        @repo.save "trying to save"
+      }.to raise_error(Twit::NothingToCommitError)
+    end
+
+    it "raises error with nothing to commit" do
+      # First, make sure there's at least one commit on the log.
+      File.open("foo", 'w') { |f| f.write("bar\n") }
+      `git add foo && git commit -m "add foo"`
+
+      # Now there should be nothing more to commit
+      expect {
+        @repo.save "trying to save"
+      }.to raise_error(Twit::NothingToCommitError)
+    end
+
+  end
+
+  describe "#list" do
+
+    include_context "temp repo"
+
+    it "should return an Array of branches" do
+      # Make sure there's at least one commit on master.
+      File.open("foo", 'w') { |f| f.write("bar\n") }
+
+      @repo.save "Initial commit"
+
+      branches = ['all', 'your', 'branch', 'are',
+                   'belong', 'to', 'us']
+      branches.each do |branch|
+        `git branch #{branch}`
+      end
+
+      expect(@repo.list).to match_array(branches + ['master'])
+    end
+
+    it "should return empty on an empty repo" do
+      expect(@repo.list).to match_array([])
+    end
+
+  end
+  
+  describe "#discard" do
+
+    include_context "temp repo"
+
+    context "with one commit and dirty working tree" do
+
+      before do
+        # Make sure there's at least one commit on master.
+        File.open("foo", 'w') { |f| f.write("bar\n") }
+        @repo.save "Initial commit"
+
+        # Pollute the working tree with spam
+        File.open("spam", 'w') { |f| f.write("eggs\n") }
+      end
+
+      it "should clean the working tree" do
+        @repo.discard
+        expect(`git status`).to include('working directory clean')
+      end
+
+      it "should delete the spam file" do
+        @repo.discard
+        expect(Pathname "spam").not_to exist
+      end
+
+    end
+
+  end
+
+  describe "#saveas" do
+    
+    include_context "temp repo"
+
+    context "files in working tree" do
+      before do
+        3.times do |i|
+          File.open("file#{i}.txt", 'w') { |f| f.write("file#{i} contents\n") }
+        end
+      end
+      it "commits the entire working tree" do
+        @repo.saveas "newbranch"
+        expect(`git status`).to include('working directory clean')
+      end
+      it "makes a commit" do
+        msg = "commit msg #{SecureRandom.hex(4)}"
+        @repo.saveas "newbranch", msg
+        expect(`git log`).to include(msg)
+      end
+      it "creates a new branch" do
+        new_branch = "branch-#{SecureRandom.hex(4)}"
+        @repo.saveas new_branch
+        current_branch = `git rev-parse --abbrev-ref HEAD`.strip
+        expect(current_branch).to eq(new_branch)
+      end
+    end
+
+    it "raises an error with an invalid branch name" do
+      expect {
+        @repo.saveas "new branch"
+      }.to raise_error(Twit::InvalidParameter)
+    end
+
+    it "raises an error when the branch already exists" do
+      branch = "my_branch"
+      File.open("foo", 'w') { |f| f.write("bar\n") }
+      @repo.saveas branch
+      expect {
+        @repo.saveas branch
+      }.to raise_error(Twit::InvalidParameter)
+    end
+
+    it "does not raise error in new repository" do
+      expect {
+        @repo.saveas "newbranch"
+      }.not_to raise_error
+    end
+
+    it "does not raise error with nothing to commit" do
+      # First, make sure there's at least one commit on the log.
+      File.open("foo", 'w') { |f| f.write("bar\n") }
+      `git add foo && git commit -m "add foo"`
+
+      # Now there should be nothing more to commit, but no error should be
+      # raised.
+      expect {
+        @repo.saveas "newbranch"
+      }.not_to raise_error
+    end
+
+  end
+
+  describe "#current_branch" do
+
+    include_context "temp repo"
+
+    it "returns the name of the current branch" do
+      new_branch = "branch-#{SecureRandom.hex(4)}"
+      File.open("foo", 'w') { |f| f.write("bar\n") }
+      @repo.saveas new_branch
+      expect(@repo.current_branch).to eq(new_branch)
+    end
+
+  end
+
+  describe "#nothing_to_commit?" do
+    include_context "temp repo"
+    it "returns true in fresh repo" do
+      expect(@repo.nothing_to_commit?).to be_true
+    end
+    it "returns false with file in working tree" do
+      File.open("foo", 'w') { |f| f.write("bar\n") }
+      expect(@repo.nothing_to_commit?).to be_false
+    end
+    it "returns true after one commit" do
+      File.open("foo", 'w') { |f| f.write("bar\n") }
+      @repo.save "commit"
+      expect(@repo.nothing_to_commit?).to be_true
+    end
+  end
+
+  describe "#open" do
+
+    include_context "temp repo"
+
+    it "opens a branch" do
+      new_branch1 = "branch-#{SecureRandom.hex(4)}"
+      File.open("foo", 'w') { |f| f.write("bar\n") }
+      @repo.saveas new_branch1
+
+      new_branch2 = "branch-#{SecureRandom.hex(4)}"
+      @repo.saveas new_branch2
+
+      @repo.open new_branch1
+      current_branch = `git rev-parse --abbrev-ref HEAD`.strip
+      expect(current_branch).to eq(new_branch1)
+    end
+
+    it "raises error when branch does not exist" do
+      expect {
+        @repo.open "spam"
+      }.to raise_error(Twit::InvalidParameter)
+    end
+
+  end
+
+  describe "#include" do
+
+    include_context "temp repo"
+
+    shared_examples "simple merge" do
+      it "will create a merge commit" do
+        expect(`git status`).to include('All conflicts fixed but you are still merging')
+      end
+    end
+
+    context "fast-forward merge" do
+      before do
+        # First commit to master
+        File.open("foo", 'w') { |f| f.write("bar\n") }
+        @repo.save "add foo"
+        # Next commit to feature
+        File.open("spam", 'w') { |f| f.write("eggs\n") }
+        @repo.saveas "feature"
+        @repo.open "master"
+        @mergestatus = @repo.include "feature"
+      end
+      include_examples "simple merge"
+    end
+
+    context "no-conflict merge" do
+      before do
+        # First commit to master
+        File.open("foo", 'w') { |f| f.write("bar\n") }
+        @repo.save "add foo"
+        # Next commit to feature
+        File.open("spam", 'w') { |f| f.write("eggs\n") }
+        @repo.saveas "feature"
+        # Add something else to master
+        @repo.open "master"
+        File.open("else", 'w') { |f| f.write("continued\n") }
+        @repo.save "continue work"
+        @mergestatus = @repo.include "feature"
+      end
+      include_examples "simple merge"
+    end
+
+    context "conflict merge" do
+      before do
+        # First commit to master
+        File.open("foo", 'w') { |f| f.write("bar\n") }
+        @repo.save "add foo"
+        # Next commit to feature
+        File.open("spam", 'w') { |f| f.write("eggs\n") }
+        @repo.saveas "feature"
+        # Conflicting commit to master
+        @repo.open "master"
+        File.open("spam", 'w') { |f| f.write("spam\n") }
+        @repo.save "continue work"
+        @mergestatus = @repo.include "feature"
+      end
+      it "returns false for conflicts" do
+        expect(@mergestatus).to be_false
+      end
+    end
+
+  end
+
+  describe "#include_into" do
+    include_context "temp repo"
+    it "calls current_branch, open, and include" do
+      current_branch = "feature"
+      other_branch = "master"
+
+      @repo.stub(:current_branch) { current_branch }
+      @repo.stub(:open)
+      @repo.stub(:include) { |branch| true }
+
+      @repo.include_into other_branch
+
+      expect(@repo).to have_received(:current_branch)
+      expect(@repo).to have_received(:open).with(other_branch)
+      expect(@repo).to have_received(:include).with(current_branch)
+    end
+  end
+
 end

data/spec/twit_spec.rb

@@ -1,5 +1,7 @@
 require "twit"
 
+require "tmpdir"
+
 describe Twit do
 
   describe "::repo" do
@@ -9,4 +11,160 @@ describe Twit do
     end
   end
 
+  describe "::init" do
+
+    before do
+      @tmpdir = Dir.mktmpdir
+    end
+
+    after do
+      FileUtils.remove_entry @tmpdir
+    end
+
+    # Check if the current working directory is a git repository.
+    def expect_cwd_to_be_repo
+      `git status`
+      expect($?.exitstatus).to eq(0)
+    end
+
+    it "initializes given directory" do
+      Twit.init @tmpdir
+      Dir.chdir @tmpdir do
+        expect_cwd_to_be_repo
+      end
+    end
+
+    it "initializes the working directory by default" do
+      Dir.chdir @tmpdir do
+        Twit.init
+        expect_cwd_to_be_repo
+      end
+    end
+
+    it "returns a repo object" do
+      repo = Twit.init @tmpdir
+      expect(repo).to be_instance_of(Twit::Repo)
+    end
+
+    it "does not raise error on double-initialize" do
+      Twit.init @tmpdir
+      expect {
+        Twit.init @tmpdir
+      }.not_to raise_error
+    end
+
+  end
+
+  shared_context "stub repo" do
+    before do
+      @repo = double('repo')
+      Twit.stub(:repo) { @repo }
+    end
+  end
+
+  describe "::save" do
+    include_context "stub repo"
+    it "passes to default Repo object" do
+      message = "my test commit message"
+      expect(@repo).to receive(:save).with(message)
+      Twit.save message
+    end
+  end
+
+  describe "::saveas" do
+    include_context "stub repo"
+    it "passes to default Repo object" do
+      branch = "my_branch"
+      message = "my test commit message"
+      expect(@repo).to receive(:saveas).with(branch, message)
+      Twit.saveas branch, message
+    end
+  end
+
+  describe "::discard" do
+    include_context "stub repo"
+    it "passes to default Repo object" do
+      expect(@repo).to receive(:discard)
+      Twit.discard
+    end
+  end
+
+  describe "::list" do
+    include_context "stub repo"
+    it "passes to default Repo object" do
+      expect(@repo).to receive(:list)
+      Twit.list
+    end
+  end
+
+  describe "::open" do
+    include_context "stub repo"
+    it "passes to default Repo object" do
+      branch = "my_branch"
+      expect(@repo).to receive(:open).with(branch)
+      Twit.open branch
+    end
+  end
+
+  describe "::include" do
+    include_context "stub repo"
+    it "passes to default Repo object" do
+      branch = "my_branch"
+      expect(@repo).to receive(:include).with(branch)
+      Twit.include branch
+    end
+  end
+
+  describe "::include_into" do
+    include_context "stub repo"
+    it "passes to default Repo object" do
+      branch = "my_branch"
+      expect(@repo).to receive(:include_into).with(branch)
+      Twit.include_into branch
+    end
+  end
+
+  describe "::current_branch" do
+    include_context "stub repo"
+    it "passes to default Repo object" do
+      expect(@repo).to receive(:current_branch)
+      Twit.current_branch
+    end
+  end
+
+  describe "::nothing_to_commit?" do
+    include_context "stub repo"
+    it "passes to default Repo object" do
+      expect(@repo).to receive(:'nothing_to_commit?')
+      Twit.nothing_to_commit?
+    end
+  end
+
+  describe "::is_repo?" do
+    context "with no repo" do
+      before do
+        @tmpdir = Dir.mktmpdir
+      end
+      after do
+        FileUtils.remove_entry @tmpdir
+      end
+      it "returns false on empty directory" do
+        expect(Twit.is_repo? @tmpdir).to be_false
+      end
+      it "detects the current directory" do
+        Dir.chdir @tmpdir do
+          expect(Twit.is_repo?).to be_false
+        end
+      end
+    end
+    context "with a real repo" do
+      it "takes a directory as argument" do
+        expect(Twit.is_repo? @tmpdir).to be_true
+      end
+      it "detects the current directory" do
+        expect(Twit.is_repo?).to be_true
+      end
+    end
+  end
+
 end

data/twit.gemspec

@@ -8,8 +8,8 @@ Gem::Specification.new do |spec|
   spec.version       = Twit::VERSION
   spec.authors       = ["Ben Pringle"]
   spec.email         = ["ben.pringle@gmail.com"]
-  spec.description   = %q{Create a simpler abstraction over the git command}
-  spec.summary       = %q{Simplified git wrapper}
+  spec.description   = %q{Create a simpler abstraction over the Git command}
+  spec.summary       = %q{Training wheels for Git}
   spec.homepage      = "https://github.com/Pringley/twit"
   spec.license       = "MIT"
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: twit
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Ben Pringle
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2013-08-02 00:00:00.000000000 Z
+date: 2013-08-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: thor
@@ -80,7 +80,7 @@ dependencies:
     - - '>='
       - !ruby/object:Gem::Version
         version: '0'
-description: Create a simpler abstraction over the git command
+description: Create a simpler abstraction over the Git command
 email:
 - ben.pringle@gmail.com
 executables:
@@ -99,13 +99,10 @@ files:
 - lib/twit.rb
 - lib/twit/cli.rb
 - lib/twit/error.rb
-- lib/twit/init.rb
 - lib/twit/repo.rb
-- lib/twit/repo/save.rb
 - lib/twit/version.rb
+- spec/spec_helper.rb
 - spec/twit/cli_spec.rb
-- spec/twit/init_spec.rb
-- spec/twit/repo/save_spec.rb
 - spec/twit/repo_spec.rb
 - spec/twit_spec.rb
 - twit.gemspec
@@ -132,11 +129,10 @@ rubyforge_project:
 rubygems_version: 2.0.2
 signing_key: 
 specification_version: 4
-summary: Simplified git wrapper
+summary: Training wheels for Git
 test_files:
+- spec/spec_helper.rb
 - spec/twit/cli_spec.rb
-- spec/twit/init_spec.rb
-- spec/twit/repo/save_spec.rb
 - spec/twit/repo_spec.rb
 - spec/twit_spec.rb
 has_rdoc: 

data/lib/twit/init.rb

@@ -1,21 +0,0 @@
-require 'open3'
-require 'twit/error'
-
-module Twit
-
-  # Initialize a git repository in a directory. Return a Twit::Repo object
-  # representing the new repository.
-  #
-  # If no argument is supplied, use the working directory.
-  def self.init dir = nil
-    dir ||= Dir.getwd
-    Dir.chdir dir do
-      stdout, stderr, status = Open3.capture3 "git init"
-      if status != 0
-        raise Error, stderr
-      end
-    end
-    Repo.new dir
-  end
-
-end

data/lib/twit/repo/save.rb

@@ -1,23 +0,0 @@
-require 'open3'
-require 'twit/error'
-
-module Twit
-  class Repo
-
-    # Update the snapshot of the current directory.
-    def save message
-      Dir.chdir @root do
-        cmd = "git add --all && git commit -m \"#{message}\""
-        stdout, stderr, status = Open3.capture3 cmd
-        if status != 0
-          if /nothing to commit/.match stdout
-            raise NothingToCommitError
-          else
-            raise Error, stderr
-          end
-        end
-      end
-    end
-
-  end
-end

data/spec/twit/init_spec.rb

@@ -1,43 +0,0 @@
-require 'tmpdir'
-
-require 'twit/init'
-require 'twit/repo'
-
-describe Twit do
-  describe "::init" do
-
-    before do
-      @tmpdir = Dir.mktmpdir
-    end
-
-    after do
-      FileUtils.remove_entry @tmpdir
-    end
-
-    # Check if the current working directory is a git repository.
-    def expect_cwd_to_be_repo
-      `git status`
-      expect($?.exitstatus).to eq(0)
-    end
-
-    it "initializes given directory" do
-      Twit.init @tmpdir
-      Dir.chdir @tmpdir do
-        expect_cwd_to_be_repo
-      end
-    end
-
-    it "initializes the working directory by default" do
-      Dir.chdir @tmpdir do
-        Twit.init
-        expect_cwd_to_be_repo
-      end
-    end
-
-    it "returns a repo object" do
-      repo = Twit.init @tmpdir
-      expect(repo).to be_instance_of(Twit::Repo)
-    end
-
-  end
-end

data/spec/twit/repo/save_spec.rb

@@ -1,55 +0,0 @@
-require 'tmpdir'
-require 'securerandom'
-
-require 'twit/repo'
-require 'twit/error'
-
-describe Twit::Repo, "#save" do
-
-  before do
-    @tmpdir = Dir.mktmpdir
-    @repo = Twit.init @tmpdir
-    @oldwd = Dir.getwd
-    Dir.chdir @tmpdir
-  end
-
-  after do
-    Dir.chdir @oldwd
-    FileUtils.remove_entry @tmpdir
-  end
-
-  context "files in working tree" do
-    before do
-      3.times do |i|
-        File.open("file#{i}.txt", 'w') { |f| f.write("file#{i} contents\n") }
-      end
-    end
-    it "commits the entire working tree" do
-      @repo.save "created three files"
-      expect(`git status`).to include('working directory clean')
-    end
-    it "makes a commit" do
-      msg = "commit msg #{SecureRandom.hex(4)}"
-      @repo.save msg
-      expect(`git log`).to include(msg)
-    end
-  end
-
-  it "raises error in new repository" do
-    expect {
-      @repo.save "trying to save"
-    }.to raise_error(Twit::NothingToCommitError)
-  end
-
-  it "raises error with nothing to commit" do
-    # First, make sure there's at least one commit on the log.
-    File.open("foo", 'w') { |f| f.write("bar\n") }
-    `git add foo && git commit -m "add foo"`
-
-    # Now there should be nothing more to commit
-    expect {
-      @repo.save "trying to save"
-    }.to raise_error(Twit::NothingToCommitError)
-  end
-
-end