twig 1.0.0

data/spec/twig/branch_spec.rb

@@ -0,0 +1,232 @@
+require 'spec_helper'
+
+describe Twig::Branch do
+  before :each do
+    @twig = Twig.new
+  end
+
+  describe '.all_properties' do
+    before :each do
+      Twig::Branch.instance_variable_set(:@_all_properties, nil)
+      @config = %{
+        user.name=Ron DeVera
+        branch.autosetupmerge=always
+        remote.origin.url=git@github.com:rondevera/twig.git
+        remote.origin.fetch=+refs/heads/*:refs/remotes/origin/*
+        branch.master.remote=origin
+        branch.master.merge=refs/heads/master
+        branch.master.test0=value0
+        branch.test_branch_1.remote=origin
+        branch.test_branch_1.merge=refs/heads/test_branch_1
+        branch.test_branch_1.test0=value1
+        branch.test_branch_1.test1=value1
+        branch.test_branch_2.remote=origin
+        branch.test_branch_2.merge=refs/heads/test_branch_2
+        branch.test_branch_2.test2=value2
+      }.gsub(/^\s+/, '')
+    end
+
+    it 'returns the union of properties for all branches' do
+      Twig.should_receive(:run).with('git config --list').and_return(@config)
+
+      result = Twig::Branch.all_properties
+      result.should == %w[test0 test1 test2]
+    end
+
+    it 'handles branch names that contain dots' do
+      @config << 'branch.dot1.dot2.dot3.dotproperty=dotvalue'
+      Twig.should_receive(:run).with('git config --list').and_return(@config)
+
+      result = Twig::Branch.all_properties
+      result.should == %w[dotproperty test0 test1 test2]
+    end
+
+    it 'handles branch names that contain equal signs' do
+      @config << 'branch.eq1=eq2=eq3.eqproperty=eqvalue'
+      Twig.should_receive(:run).with('git config --list').and_return(@config)
+
+      result = Twig::Branch.all_properties
+      result.should == %w[eqproperty test0 test1 test2]
+    end
+
+    it 'memoizes the result' do
+      Twig.should_receive(:run).once.and_return(@config)
+      2.times { Twig::Branch.all_properties }
+    end
+  end
+
+  describe '#initialize' do
+    it 'requires a name' do
+      branch = Twig::Branch.new('test')
+      branch.name.should == 'test'
+
+      lambda { Twig::Branch.new      }.should raise_exception
+      lambda { Twig::Branch.new(nil) }.should raise_exception
+      lambda { Twig::Branch.new('')  }.should raise_exception
+    end
+
+    it 'accepts a last commit time' do
+      commit_time = Twig::CommitTime.new(Time.now, '99 days ago')
+      branch = Twig::Branch.new('test', :last_commit_time => commit_time)
+      branch.last_commit_time.should == commit_time
+    end
+  end
+
+  describe '#to_s' do
+    it 'returns the branch name' do
+      branch = Twig::Branch.new('test')
+      branch.to_s.should == 'test'
+    end
+  end
+
+  describe '#sanitize_property' do
+    before :each do
+      @branch = Twig::Branch.new('test')
+    end
+
+    it 'removes whitespace from branch property names' do
+      @branch.sanitize_property('  foo bar  ').should == 'foobar'
+    end
+
+    it 'removes underscores from branch property names' do
+      @branch.sanitize_property('__foo_bar__').should == 'foobar'
+    end
+  end
+
+  describe '#get_property' do
+    it 'returns a property value' do
+      branch   = Twig::Branch.new('test')
+      property = 'test'
+      value    = 'value'
+      Twig.should_receive(:run).
+        with(%{git config branch.#{branch}.#{property}}).
+        and_return(value)
+
+      result = branch.get_property(property)
+      result.should == value
+    end
+  end
+
+  describe '#set_property' do
+    before :each do
+      @branch = Twig::Branch.new('test')
+    end
+
+    it 'sets a property value' do
+      property = 'test'
+      value    = 'value'
+      Twig.should_receive(:run).
+        with(%{git config branch.#{@branch}.#{property} "#{value}"}) do
+          `(exit 0)`; value # Set `$?` to `0`
+        end
+
+      result = @branch.set_property(property, value)
+      result.should include(
+        %{Saved property "#{property}" as "#{value}" for branch "#{@branch}"}
+      )
+    end
+
+    it 'does nothing if Git cannot set the property value' do
+      property = 'test'
+      value    = 'value'
+      Twig.stub(:run) { `(exit 1)`; value } # Set `$?` to `1`
+
+      result = @branch.set_property(property, value)
+      result.should include(
+        %{Could not save property "#{property}" as "#{value}" for branch "#{@branch}"}
+      )
+    end
+
+    it 'returns an error if trying to set a reserved branch property' do
+      property = 'merge'
+      value    = 'NOOO'
+      Twig.should_not_receive(:run)
+
+      result = @branch.set_property(property, value)
+      result.should include(%{Can't modify the reserved property "#{property}"})
+    end
+
+    it 'returns an error if trying to set a branch property to an empty string' do
+      property = 'test'
+      value    = ''
+      Twig.should_not_receive(:run)
+
+      result = @branch.set_property(property, value)
+      result.should include(%{Can't set a branch property to an empty string})
+    end
+
+    it 'removes whitespace from branch property names' do
+      bad_property = '  foo foo  '
+      property     = 'foofoo'
+      value        = 'bar'
+      Twig.should_receive(:run).
+        with(%{git config branch.#{@branch}.#{property} "#{value}"}) do
+          `(exit 0)`; value # Set `$?` to `0`
+        end
+
+      result = @branch.set_property(bad_property, value)
+      result.should include(
+        %{Saved property "#{property}" as "#{value}" for branch "#{@branch}"}
+      )
+    end
+
+    it 'removes underscores from branch property names' do
+      bad_property = 'foo_foo'
+      property     = 'foofoo'
+      value        = 'bar'
+      Twig.should_receive(:run).
+        with(%{git config branch.#{@branch}.#{property} "#{value}"}) do
+          `(exit 0)`; value # Set `$?` to `0`
+        end
+
+      result = @branch.set_property(bad_property, value)
+      result.should include(
+        %{Saved property "#{property}" as "#{value}" for branch "#{@branch}"}
+      )
+    end
+
+    it 'strips whitespace from a value before setting it as a property' do
+      property  = 'test'
+      bad_value = '  foo  '
+      value     = 'foo'
+      Twig.should_receive(:run).
+        with(%{git config branch.#{@branch}.#{property} "#{value}"}) do
+          `(exit 0)`; value # Set `$?` to `0`
+        end
+
+      result = @branch.set_property(property, bad_value)
+      result.should include(
+        %{Saved property "#{property}" as "#{value}" for branch "#{@branch}"}
+      )
+    end
+  end
+
+  describe '#unset_property' do
+    before :each do
+      @branch = Twig::Branch.new('test')
+    end
+
+    it 'unsets a branch property' do
+      property = 'test'
+      @branch.should_receive(:get_property).with(property).and_return('value')
+      Twig.should_receive(:run).
+        with(%{git config --unset branch.#{@branch}.#{property}})
+
+      result = @branch.unset_property(property)
+      result.should include(
+        %{Removed property "#{property}" for branch "#{@branch}"}
+      )
+    end
+
+    it 'returns an error if the branch does not have the given property' do
+      property = 'test'
+      @branch.should_receive(:get_property).with(property).and_return('')
+
+      result = @branch.unset_property(property)
+      result.should include(
+        %{The branch "#{@branch}" does not have the property "#{property}"}
+      )
+    end
+  end
+
+end

data/spec/twig/cli_spec.rb

@@ -0,0 +1,291 @@
+require 'spec_helper'
+
+describe Twig::Cli do
+
+  describe '#help_description' do
+    before :each do
+      @twig = Twig.new
+    end
+
+    it 'returns short text in a single line' do
+      text = 'The quick brown fox.'
+      result = @twig.help_description(text, :width => 80)
+      result.should == [text]
+    end
+
+    it 'returns long text in a string with line breaks' do
+      text = 'The quick brown fox jumps over the lazy, lazy dog.'
+      result = @twig.help_description(text, :width => 20)
+      result.should == [
+        'The quick brown fox',
+        'jumps over the lazy,',
+        'lazy dog.'
+      ]
+    end
+
+    it 'breaks a long word by max line length' do
+      text = 'Thequickbrownfoxjumpsoverthelazydog.'
+      result = @twig.help_description(text, :width => 20)
+      result.should == [
+        'Thequickbrownfoxjump',
+        'soverthelazydog.'
+      ]
+    end
+
+    it 'adds a separator line' do
+      text = 'The quick brown fox.'
+      result = @twig.help_description(text, :width => 80, :add_separator => true)
+      result.should == [text, ' ']
+    end
+  end
+
+  describe '#read_cli_options!' do
+    before :each do
+      @twig = Twig.new
+    end
+
+    it 'recognizes `-b` and sets a `:branch` option' do
+      @twig.should_receive(:branch_names).and_return(['test'])
+      @twig.options[:branch].should be_nil # Precondition
+
+      @twig.read_cli_options!(%w[-b test])
+
+      @twig.options[:branch].should == 'test'
+    end
+
+    it 'recognizes `--branch` and sets a `:branch` option' do
+      @twig.should_receive(:branch_names).and_return(['test'])
+      @twig.options[:branch].should be_nil # Precondition
+
+      @twig.read_cli_options!(%w[--branch test])
+
+      @twig.options[:branch].should == 'test'
+    end
+
+    it 'recognizes `--except-branch` and sets a `:branch_except` option' do
+      @twig.options[:branch_except].should be_nil # Precondition
+      @twig.read_cli_options!(%w[--except-branch test])
+      @twig.options[:branch_except].should == /test/
+    end
+
+    it 'recognizes `--only-branch` and sets a `:branch_only` option' do
+      @twig.options[:branch_only].should be_nil # Precondition
+      @twig.read_cli_options!(%w[--only-branch test])
+      @twig.options[:branch_only].should == /test/
+    end
+
+    it 'recognizes `--max-days-old` and sets a `:max_days_old` option' do
+      @twig.options[:max_days_old].should be_nil # Precondition
+      @twig.read_cli_options!(%w[--max-days-old 30])
+      @twig.options[:max_days_old].should == 30
+    end
+
+    it 'recognizes `--all` and unsets other options except `:branch`' do
+      @twig.set_option(:max_days_old, 30)
+      @twig.set_option(:branch_except, /test/)
+      @twig.set_option(:branch_only, /test/)
+
+      @twig.read_cli_options!(['--all'])
+
+      @twig.options[:max_days_old].should be_nil
+      @twig.options[:branch_except].should be_nil
+      @twig.options[:branch_only].should be_nil
+    end
+
+    it 'recognizes `--unset` and sets an `:unset_property` option' do
+      @twig.options[:unset_property].should be_nil # Precondition
+      @twig.read_cli_options!(%w[--unset test])
+      @twig.options[:unset_property].should == 'test'
+    end
+
+    it 'recognizes `--version` and prints the current version' do
+      @twig.should_receive(:puts).with(Twig::VERSION)
+      @twig.should_receive(:exit)
+
+      @twig.read_cli_options!(['--version'])
+    end
+
+    it 'handles invalid options' do
+      @twig.should_receive(:puts) do |message|
+        message.should include('invalid option: --foo')
+      end
+      @twig.should_receive(:puts) do |message|
+        message.should include('`twig --help`')
+      end
+      @twig.should_receive(:exit)
+
+      @twig.read_cli_options!(['--foo'])
+    end
+
+    it 'handles missing arguments' do
+      @twig.should_receive(:puts) do |message|
+        message.should include('missing argument: --branch')
+      end
+      @twig.should_receive(:puts) do |message|
+        message.should include('`twig --help`')
+      end
+      @twig.should_receive(:exit)
+
+      @twig.read_cli_options!(['--branch'])
+    end
+  end
+
+  describe '#read_cli_args!' do
+    before :each do
+      @twig = Twig.new
+    end
+
+    it 'lists branches' do
+      branch_list = %[foo bar]
+      @twig.should_receive(:list_branches).and_return(branch_list)
+      @twig.should_receive(:puts).with(branch_list)
+
+      @twig.read_cli_args!([])
+    end
+
+    context 'running a subcommand' do
+      before :each do
+        Twig.stub(:run)
+        @twig.stub(:current_branch_name => 'test')
+        @twig.stub(:puts)
+      end
+
+      it 'recognizes a subcommand' do
+        command_path = '/path/to/bin/twig-subcommand'
+        Twig.should_receive(:run).with('which twig-subcommand').
+          and_return(command_path)
+        @twig.should_receive(:exec).with(command_path)
+
+        @twig.read_cli_args!(['subcommand'])
+      end
+
+      it 'does not recognize a subcommand' do
+        Twig.should_receive(:run).with('which twig-subcommand').and_return('')
+        @twig.should_not_receive(:exec)
+
+        @twig.read_cli_args!(['subcommand'])
+      end
+    end
+
+    context 'getting properties' do
+      before :each do
+        @branch_name    = 'test'
+        @property_name  = 'foo'
+        @property_value = 'bar'
+      end
+
+      context 'with the current branch' do
+        before :each do
+          @twig.should_receive(:current_branch_name).and_return(@branch_name)
+        end
+
+        it 'gets a property' do
+          @twig.should_receive(:get_branch_property).
+            with(@branch_name, @property_name).and_return(@property_value)
+          @twig.should_receive(:puts).with(@property_value)
+
+          @twig.read_cli_args!([@property_name])
+        end
+
+        it 'shows an error if getting a property that is not set' do
+          @twig.should_receive(:get_branch_property).
+            with(@branch_name, @property_name).and_return('')
+          @twig.should_receive(:puts) do |error|
+            error.should include(
+              %{The branch "#{@branch_name}" does not have the property "#{@property_name}"}
+            )
+          end
+
+          @twig.read_cli_args!([@property_name])
+        end
+      end
+
+      context 'with a specified branch' do
+        before :each do
+          @twig.should_receive(:branch_names).and_return([@branch_name])
+          @twig.set_option(:branch, @branch_name)
+        end
+
+        it 'gets a property' do
+          @twig.should_receive(:get_branch_property).
+            with(@branch_name, @property_name).and_return(@property_value)
+          @twig.should_receive(:puts).with(@property_value)
+
+          @twig.read_cli_args!([@property_name])
+        end
+
+        it 'shows an error if getting a property that is not set' do
+          @twig.should_receive(:get_branch_property).
+            with(@branch_name, @property_name).and_return('')
+          @twig.should_receive(:puts) do |error|
+            error.should include(
+              %{The branch "#{@branch_name}" does not have the property "#{@property_name}"}
+            )
+          end
+
+          @twig.read_cli_args!([@property_name])
+        end
+      end
+
+    end
+
+    context 'setting properties' do
+      before :each do
+        @branch_name    = 'test'
+        @property_name  = 'foo'
+        @property_value = 'bar'
+        @message        = 'Saved.'
+      end
+
+      it 'sets a property for the current branch' do
+        @twig.should_receive(:current_branch_name).and_return(@branch_name)
+        @twig.should_receive(:set_branch_property).
+          with(@branch_name, @property_name, @property_value).
+          and_return(@message)
+        @twig.should_receive(:puts).with(@message)
+
+        @twig.read_cli_args!([@property_name, @property_value])
+      end
+
+      it 'sets a property for a specified branch' do
+        @twig.should_receive(:branch_names).and_return([@branch_name])
+        @twig.set_option(:branch, @branch_name)
+        @twig.should_receive(:set_branch_property).
+          with(@branch_name, @property_name, @property_value).
+          and_return(@message)
+        @twig.should_receive(:puts).with(@message)
+
+        @twig.read_cli_args!([@property_name, @property_value])
+      end
+    end
+
+    context 'unsetting properties' do
+      before :each do
+        @branch_name   = 'test'
+        @property_name = 'foo'
+        @message       = 'Removed.'
+        @twig.set_option(:unset_property, @property_name)
+      end
+
+      it 'unsets a property for the current branch' do
+        @twig.should_receive(:current_branch_name).and_return(@branch_name)
+        @twig.should_receive(:unset_branch_property).
+          with(@branch_name, @property_name).and_return(@message)
+        @twig.should_receive(:puts).with(@message)
+
+        @twig.read_cli_args!([])
+      end
+
+      it 'unsets a property for a specified branch' do
+        @twig.should_receive(:branch_names).and_return([@branch_name])
+        @twig.set_option(:branch, @branch_name)
+        @twig.should_receive(:unset_branch_property).
+          with(@branch_name, @property_name).and_return(@message)
+        @twig.should_receive(:puts).with(@message)
+
+        @twig.read_cli_args!([])
+      end
+    end
+  end
+
+end

data/spec/twig/commit_time_spec.rb

@@ -0,0 +1,47 @@
+require 'spec_helper'
+
+describe Twig::CommitTime do
+  before :each do
+    @time = Time.utc(2000, 12, 1, 12, 00, 00)
+  end
+
+  describe '#initialize' do
+    it 'stores a Time object' do
+      commit_time = Twig::CommitTime.new(@time, '99 days ago')
+      commit_time.instance_variable_get(:@time).should == @time
+    end
+
+    it 'stores a "time ago" string as its shortened version' do
+      Twig::CommitTime.new(@time, '2 years ago').
+        instance_variable_get(:@time_ago).should == '2y ago'
+      Twig::CommitTime.new(@time, '2 months ago').
+        instance_variable_get(:@time_ago).should == '2mo ago'
+      Twig::CommitTime.new(@time, '2 weeks ago').
+        instance_variable_get(:@time_ago).should == '2w ago'
+      Twig::CommitTime.new(@time, '2 days ago').
+        instance_variable_get(:@time_ago).should == '2d ago'
+      Twig::CommitTime.new(@time, '2 hours ago').
+        instance_variable_get(:@time_ago).should == '2h ago'
+      Twig::CommitTime.new(@time, '2 minutes ago').
+        instance_variable_get(:@time_ago).should == '2m ago'
+      Twig::CommitTime.new(@time, '2 seconds ago').
+        instance_variable_get(:@time_ago).should == '2s ago'
+    end
+  end
+
+  describe '#to_i' do
+    it 'returns the time as an integer' do
+      commit_time = Twig::CommitTime.new(@time, '99 days ago')
+      commit_time.to_i.should == @time.to_i
+    end
+  end
+
+  describe '#to_s' do
+    it 'returns a formatted string, including time ago' do
+      commit_time = Twig::CommitTime.new(@time, '99 days ago')
+      result = commit_time.to_s
+      result.should include('2000-12-01')
+      result.should include('(99d ago)')
+    end
+  end
+end

data/spec/twig/display_spec.rb

@@ -0,0 +1,117 @@
+require 'spec_helper'
+
+describe Twig::Display do
+  before :each do
+    @twig = Twig.new
+  end
+
+  describe '#column' do
+    it 'returns a string with an exact fixed width' do
+      @twig.column('foo', 1, :width => 8).should == 'foo' + (' ' * 5)
+    end
+
+    it 'returns a string that fits a column exactly' do
+      @twig.column('asdfasdf', 1, :width => 8).should == 'asdf... '
+    end
+
+    it 'truncates a wide string with an ellipsis' do
+      @twig.column('asdfasdfasdf', 1, :width => 8).should == 'asdf... '
+    end
+
+    it 'returns a string that spans multiple columns' do
+      @twig.column('foo', 2, :width => 8).should == 'foo' + (' ' * 13)
+    end
+
+    it 'returns a string that spans multiple columns and is truncated' do
+      @twig.column('asdf' * 5, 2, :width => 8).should == 'asdfasdfasdf... '
+    end
+
+    it 'passes options through to `format_string`' do
+      format_options = { :color => :red, :weight => :bold }
+      @twig.should_receive(:format_string).
+        with('foo' + (' ' * 5), format_options)
+
+      @twig.column('foo', 1, format_options)
+    end
+  end
+
+  describe '#branch_list_headers' do
+    it 'returns a string of branch properties and underlines' do
+      Twig::Branch.stub(:all_properties => %w[foo quux])
+
+      result = @twig.branch_list_headers({})
+      result_lines = result.split("\n")
+
+      column_width = 8
+      columns_for_date_time = 5
+      first_column_width = column_width * columns_for_date_time
+      result_lines[0].should == (' ' * first_column_width) +
+        'foo     ' + (' ' * column_width) +
+        'quux    ' + (' ' * column_width) +
+        '  branch' + (' ' * column_width)
+      result_lines[1].should == (' ' * first_column_width) +
+        '---     ' + (' ' * column_width) +
+        '----    ' + (' ' * column_width) +
+        '  ------' + (' ' * column_width)
+    end
+  end
+
+  describe '#branch_list_line' do
+    before :each do
+      @current_branch_name = 'my-branch'
+      Twig::Branch.stub(:all_properties => ['foo', 'bar'])
+      @twig.should_receive(:get_branch_property).
+        with(anything, 'foo').and_return('foo!')
+      @twig.should_receive(:get_branch_property).
+        with(anything, 'bar').and_return('bar!')
+      @twig.should_receive(:current_branch_name).
+        and_return(@current_branch_name)
+      @commit_time = Twig::CommitTime.new(Time.now, '')
+      @commit_time.should_receive(:to_s).and_return('2000-01-01')
+    end
+
+    it 'returns a line for the current branch' do
+      indicator     = Twig::Display::CURRENT_BRANCH_INDICATOR
+      branch        = Twig::Branch.new('my-branch')
+      branch_regexp = /#{Regexp.escape(indicator)}#{Regexp.escape(branch.name)}/
+      branch.should_receive(:last_commit_time).and_return(@commit_time)
+
+      result = @twig.branch_list_line(branch)
+
+      result.should =~ /2000-01-01\s+foo!\s+bar!\s+#{branch_regexp}/
+    end
+
+    it 'returns a line for a branch other than the current branch' do
+      branch = Twig::Branch.new('other-branch')
+      branch.should_receive(:last_commit_time).and_return(@commit_time)
+
+      result = @twig.branch_list_line(branch)
+
+      result.should =~ /2000-01-01\s+foo!\s+bar!\s+#{Regexp.escape(branch.name)}/
+    end
+  end
+
+  describe '#format_string' do
+    it 'returns a plain string' do
+      @twig.format_string('foo', {}).should == 'foo'
+    end
+
+    it 'returns a string with a color code' do
+      @twig.format_string('foo', :color => :red).
+        should == "\033[#{Twig::Display::COLORS[:red]}mfoo\033[0m"
+    end
+
+    it 'returns a string with a weight code' do
+      @twig.format_string('foo', :weight => :bold).
+        should == "\033[#{Twig::Display::WEIGHTS[:bold]}mfoo\033[0m"
+    end
+
+    it 'returns a string with a color and weight code 'do
+    color_code  = Twig::Display::COLORS[:red]
+    weight_code = Twig::Display::WEIGHTS[:bold]
+
+    @twig.format_string('foo', :color => :red, :weight => :bold).
+      should == "\033[#{color_code};#{weight_code}mfoo\033[0m"
+    end
+  end
+end