twit 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 289a3be1ed0e67bea59cffdce6e82f2802511b2c
+  data.tar.gz: 7690c43ff2be9ab8f81a26757f754162b4f57818
+SHA512:
+  metadata.gz: bcbd3f91dd0a59ea2c4162b0449ea8b999e2d45e05105cc11c9fd6a71ddba3775da26ff7f901805d1f1af8a7a614e4f8e680c643476dfd1302807982c102bf0b
+  data.tar.gz: 7a2097cad0b49b9c9a312433dfe344b5ad4ce5f2c29d18e53a31cc41adaa6c4493417565cbf890a62575d6a40f74c468123db3b99d01d35d55d55e3d59371112

data/.gitignore

@@ -0,0 +1,18 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+bin

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--format progress

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in twit.gemspec
+gemspec

data/IDEAS.txt

@@ -0,0 +1,69 @@
+# Twit: simplified git wrapper
+
+## UI
+
+### Local
+
+twit init
+
+    git init
+
+twit list
+
+    git branch
+
+twit new <branch>
+
+    git checkout -b <branch>
+
+twit save <message>
+
+    git add --all && git commit -m <message>
+
+twit saveas <branch>
+
+    git checkout -b <branch> && git add --all && git commit -m "New branch: <branch>"
+
+twit overwrite <branch>
+
+    PATCH="$(mktemp /tmp/patchXXXXXX)"
+    git add --all && git diff --cached <branch> > $PATCH && git reset --hard && git checkout <branch> && git apply "${PATCH}" && rm "${PATCH}" && git add --all && git commit -m "Overwrite <branch>"
+
+twit open <branch>
+
+    git checkout <branch>
+
+twit delete <branch>
+
+    git branch -d <branch>
+
+twit discard
+
+    git reset --hard HEAD
+
+twit history
+
+    git log --pretty=format:'%C(yellow)%h %Cred%ad%Cblue%d %Creset%s %Cgreen[%an]' --date=relative --graph --branches
+
+twit merge <from-branch>
+
+    git merge --no-ff <from-branch>
+
+### Remote
+
+twit connect <url>
+
+    git remote add origin <url>
+
+twit sync <branch>
+
+    git pull --rebase origin <branch> && git push origin <branch>
+
+twit publish <tag> <message>
+
+    git tag -a <tag> <message> && git push origin tag
+
+## Impl
+
+- Ruby
+- Thor

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Ben Pringle
+
+MIT License
+
+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,66 @@
+# Twit: simplified git wrapper
+
+Twit makes [git](http://git-scm.com) easier for beginners.
+
+## Installation
+
+To install, simply run:
+
+    gem install twit
+
+(On some systems, this may require `sudo`.)
+
+## Usage
+
+### `init` -- create a new repository
+
+    twit init
+
+Initialize a new git repository in the current directory.
+
+### `save` -- take a snapshot of all files
+
+    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.
+
+## API
+
+All command-line functions are available for use as a Ruby library as well.
+
+    require 'twit'
+
+    # Create a new repository
+    repo = Twit.init
+
+    # Make some changes to the directory
+    File.open('foo', 'w') { |f| f.write('bar\n') }
+
+    # Take a snapshot
+    Twit.save "Add some foo"
+
+## Development
+
+### Setup
+
+Clone the repository.
+
+Install dependencies with:
+
+    bundle install --binstubs
+
+### Testing
+
+Run the tests with:
+
+    bin/rspec
+
+### Documentation
+
+Generate the docs with
+
+    bin/yard
+
+They will appear in the `./doc` folder.

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/exe/twit

@@ -0,0 +1,3 @@
+#!/usr/bin/env ruby
+require 'twit/cli'
+Twit::CLI.start(ARGV)

data/lib/twit.rb

@@ -0,0 +1,15 @@
+require "twit/version"
+require "twit/repo"
+require "twit/init"
+require "twit/error"
+
+# This module exposes twit commands as methods.
+module Twit
+
+  # Get a {Twit::Repo} representing the repository for the current working
+  # directory.
+  def self.repo
+    Twit::Repo.new
+  end
+
+end

data/lib/twit/cli.rb

@@ -0,0 +1,31 @@
+require 'thor'
+require 'twit'
+
+module Twit
+
+  # Automatically-built command-line interface (using Thor).
+  class CLI < Thor
+
+    desc "init", "Create an empty repository in the current directory"
+    # Pass method to Twit module
+    def init
+      Twit.init
+    end
+
+    desc "save <DESCRIBE_CHANGES>", "Take a snapshot of all files"
+    # Pass method to default repo
+    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
+      end
+      begin
+        Twit.repo.save message
+      rescue NothingToCommitError
+        puts "No new edits to save"
+      end
+    end
+
+  end
+
+end

data/lib/twit/error.rb

@@ -0,0 +1,13 @@
+module Twit
+
+  # A generic error raised by Twit. (All other errors inherit from this one.)
+  class Error < RuntimeError; end
+
+  # Raised when commands are executed in a directory that is not part of a git
+  # repository.
+  class NotARepositoryError < Error; end
+
+  # Raised when trying to commit nothing.
+  class NothingToCommitError < Error; end
+
+end

data/lib/twit/init.rb

@@ -0,0 +1,21 @@
+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.rb

@@ -0,0 +1,35 @@
+require 'open3'
+require 'twit/error'
+require 'twit/repo/save'
+
+module Twit
+
+  # An object to represent a git repository.
+  class Repo
+
+    # The root directory of the repository.
+    attr_reader :root
+
+    # Takes an optional argument of a Dir object to treat as the repository
+    # root. If not, try to detect the root of the current repository.
+    #
+    # When run without arguments in a directory not part of a git repository,
+    # raise {Twit::NotARepositoryError}.
+    def initialize root = nil
+      if root.nil?
+        stdout, stderr, status = Open3.capture3 "git rev-parse --show-toplevel"
+        if status != 0
+          case stderr
+          when /Not a git repository/
+            raise NotARepositoryError
+          else
+            raise Error, stderr
+          end
+        end
+        root = stdout.strip
+      end
+      @root = root
+    end
+  end
+
+end

data/lib/twit/repo/save.rb

@@ -0,0 +1,23 @@
+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/lib/twit/version.rb

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

data/spec/twit/cli_spec.rb

@@ -0,0 +1,39 @@
+require "twit/cli"
+
+describe Twit::CLI do
+
+  before do
+    @cli = Twit::CLI.new
+
+    # Mock out Twit library to avoid accidentally clobbering anything during
+    # testing.
+    stub_const("Twit", double('Twit'))
+  end
+
+  describe "init" do
+    it "calls Twit.init" do
+      Twit.should_receive(:init)
+      @cli.invoke :init
+    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)
+
+      @cli.invoke :save, [message]
+    end
+    it "asks for commit message" do
+      $stderr.should_receive(:puts).with /message/
+      expect {
+        @cli.invoke :save
+      }.to raise_error SystemExit
+    end
+  end
+
+end

data/spec/twit/init_spec.rb

@@ -0,0 +1,43 @@
+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

@@ -0,0 +1,55 @@
+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

data/spec/twit/repo_spec.rb

@@ -0,0 +1,61 @@
+require 'tmpdir'
+require 'tempfile'
+
+require 'twit/repo'
+require 'twit/error'
+
+describe Twit::Repo do
+  describe "#new" do
+
+    before do
+      @tmpdir = Dir.mktmpdir
+
+      # OS X uses /private/tmp and /tmp interchangably, so straight comparison
+      # of directories sometimes fails. Instead, detect this particular
+      # directory by creating a file in an end checking for its existence.
+      @file_in_dir = Tempfile.new '.detect', @tmpdir
+    end
+
+    def expect_root dir
+      path = Pathname.new File.join(dir, File.basename(@file_in_dir))
+      expect(path).to be_exist
+    end
+
+    after do
+      FileUtils.remove_entry @tmpdir
+    end
+
+    it "works with a directory argument" do
+      repo = Twit::Repo.new @tmpdir
+      expect_root repo.root
+    end
+
+    it "detects git root while at root (no args)" do
+      Dir.chdir @tmpdir do
+        `git init`
+        repo = Twit::Repo.new
+        expect_root repo.root
+      end
+    end
+
+    it "detects git root while in subdirectory (no args)" do
+      Dir.chdir @tmpdir do
+        `git init`
+        Dir.mkdir 'subdir'
+        Dir.chdir 'subdir' do
+          repo = Twit::Repo.new
+          expect_root repo.root
+        end
+      end
+    end
+
+    it "raises an error when not in a repo (no args)" do
+      Dir.chdir @tmpdir do
+        expect {
+          repo = Twit::Repo.new
+        }.to raise_error Twit::NotARepositoryError
+      end
+    end
+
+  end
+end

data/spec/twit_spec.rb

@@ -0,0 +1,12 @@
+require "twit"
+
+describe Twit do
+
+  describe "::repo" do
+    it "returns a repo object" do
+      repo = Twit.repo
+      expect(repo).to be_instance_of(Twit::Repo)
+    end
+  end
+
+end

data/twit.gemspec

@@ -0,0 +1,28 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'twit/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "twit"
+  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.homepage      = "https://github.com/Pringley/twit"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_runtime_dependency "thor"
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec"
+  spec.add_development_dependency "yard"
+end

metadata

@@ -0,0 +1,142 @@
+--- !ruby/object:Gem::Specification
+name: twit
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Ben Pringle
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2013-08-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: thor
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Create a simpler abstraction over the git command
+email:
+- ben.pringle@gmail.com
+executables:
+- twit
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- Gemfile
+- IDEAS.txt
+- LICENSE.txt
+- README.markdown
+- Rakefile
+- exe/twit
+- 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/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
+homepage: https://github.com/Pringley/twit
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.0.2
+signing_key: 
+specification_version: 4
+summary: Simplified git wrapper
+test_files:
+- 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: