twig 1.0.0

data/spec/twig/options_spec.rb

@@ -0,0 +1,126 @@
+require 'spec_helper'
+
+describe Twig::Options do
+  before :each do
+    @twig = Twig.new
+  end
+
+  describe '#read_config_file!' do
+    before :each do
+      File.should_receive(:expand_path).with(Twig::CONFIG_FILE).
+        and_return(Twig::CONFIG_FILE)
+    end
+
+    it 'reads and sets a single option' do
+      @twig.stub(:branch_names => ['test'])
+      file = double('file')
+      File.should_receive(:readable?).with(Twig::CONFIG_FILE).and_return(true)
+      File.should_receive(:open).with(Twig::CONFIG_FILE).and_yield(file)
+      file.should_receive(:read).and_return(%{
+        branch: test
+      }.gsub(/^\s+/, ''))
+      @twig.options[:branch].should be_nil # Precondition
+
+      @twig.read_config_file!
+
+      @twig.options[:branch].should == 'test'
+    end
+
+    it 'reads and sets multiple options' do
+      @twig.stub(:branch_names => ['test'])
+      file = double('file')
+      File.should_receive(:readable?).with(Twig::CONFIG_FILE).and_return(true)
+      File.should_receive(:open).with(Twig::CONFIG_FILE).and_yield(file)
+      file.should_receive(:read).and_return(%{
+        branch:        test
+        except-branch: test-except
+        only-branch:   test-only
+        max-days-old:  30.5
+      }.gsub(/^\s+/, ''))
+      @twig.options[:branch].should be_nil # Precondition
+      @twig.options[:branch_except].should be_nil # Precondition
+      @twig.options[:branch_only].should be_nil # Precondition
+      @twig.options[:max_days_old].should be_nil # Precondition
+
+      @twig.read_config_file!
+
+      @twig.options[:branch].should == 'test'
+      @twig.options[:branch_except].should == /test-except/
+      @twig.options[:branch_only].should == /test-only/
+      @twig.options[:max_days_old].should == 30.5
+    end
+
+    it 'fails gracefully if the config file is not readable' do
+      File.should_receive(:readable?).with(Twig::CONFIG_FILE).and_return(false)
+      lambda { @twig.read_config_file! }.should_not raise_exception
+    end
+  end
+
+  describe '#set_option' do
+    context 'when setting a :branch option' do
+      before :each do
+        @twig.options[:branch].should be_nil # Precondition
+      end
+
+      it 'succeeds' do
+        @twig.should_receive(:branch_names).and_return(%[foo bar])
+        @twig.set_option(:branch, 'foo')
+        @twig.options[:branch].should == 'foo'
+      end
+
+      it 'fails if the branch is unknown' do
+        @twig.should_receive(:branch_names).and_return([])
+        @twig.should_receive(:abort)
+
+        @twig.set_option(:branch, 'foo')
+
+        @twig.options[:branch].should be_nil
+      end
+    end
+
+    it 'sets a :branch_except option' do
+      @twig.options[:branch_except].should be_nil # Precondition
+      @twig.set_option(:branch_except, 'unwanted_prefix_')
+      @twig.options[:branch_except].should == /unwanted_prefix_/
+    end
+
+    it 'sets a :branch_only option' do
+      @twig.options[:branch_only].should be_nil # Precondition
+      @twig.set_option(:branch_only, 'important_prefix_')
+      @twig.options[:branch_only].should == /important_prefix_/
+    end
+
+    context 'when setting a :max_days_old option' do
+      before :each do
+        @twig.options[:max_days_old].should be_nil # Precondition
+      end
+
+      it 'succeeds' do
+        @twig.set_option(:max_days_old, 1)
+        @twig.options[:max_days_old].should == 1
+      end
+
+      it 'fails if the option is not numeric' do
+        @twig.should_receive(:abort)
+        @twig.set_option(:max_days_old, 'blargh')
+        @twig.options[:max_days_old].should be_nil
+      end
+    end
+
+    it 'sets an :unset_property option' do
+      @twig.options[:unset_property].should be_nil # Precondition
+      @twig.set_option(:unset_property, 'unwanted_property')
+      @twig.options[:unset_property].should == 'unwanted_property'
+    end
+  end
+
+  describe '#unset_option' do
+    it 'unsets an option' do
+      @twig.set_option(:max_days_old, 1)
+      @twig.options[:max_days_old].should == 1 # Precondition
+
+      @twig.unset_option(:max_days_old)
+      @twig.options[:max_days_old].should be_nil
+    end
+  end
+end

data/spec/twig/util_spec.rb

@@ -0,0 +1,16 @@
+require 'spec_helper'
+
+describe Twig::Util do
+  describe '.numeric?' do
+    it 'returns true if an object is numeric' do
+      Twig::Util.numeric?(1).should be_true
+      Twig::Util.numeric?('1').should be_true
+    end
+
+    it 'returns false if an object is not numeric' do
+      Twig::Util.numeric?('x').should be_false
+      Twig::Util.numeric?([]).should be_false
+      Twig::Util.numeric?({}).should be_false
+    end
+  end
+end

data/spec/twig_spec.rb

@@ -0,0 +1,220 @@
+require 'spec_helper'
+
+describe Twig do
+  describe '#initialize' do
+    it 'creates a Twig instance' do
+      twig = Twig.new
+      twig.options.should == {}
+    end
+
+    it 'creates a Twig instance with arbitrary options' do
+      options = {:foo => 'bar'}
+      twig = Twig.new(options)
+
+      twig.options.should == options
+    end
+  end
+
+  describe '#current_branch_name' do
+    it 'returns the current branch name' do
+      twig        = Twig.new
+      branch_name = 'fix_all_the_things'
+      Twig.should_receive(:run).
+        with('git symbolic-ref -q HEAD').
+        once. # Should memoize
+        and_return(Twig::REF_PREFIX + branch_name)
+
+      2.times { twig.current_branch_name.should == branch_name }
+    end
+  end
+
+  describe '#all_branches' do
+    before :each do
+      @branch_names = %w[
+        fix_some_of_the_things
+        fix_some_other_of_the_things
+        fix_nothing
+      ]
+      branch_refs = @branch_names.map { |name| Twig::REF_PREFIX + name }
+      @commit_time_strings = ['2001-01-01',   '2002-02-02',   '2003-03-03'  ]
+      @commit_time_agos    = ['111 days ago', '222 days ago', '333 days ago']
+      @command =
+        %{git for-each-ref #{Twig::REF_PREFIX} --format="#{Twig::REF_FORMAT}"}
+
+      @branch_tuples = (0..2).map do |i|
+        "#{branch_refs[i]},#{@commit_time_strings[i]},#{@commit_time_agos[i]}"
+      end.join("\n")
+    end
+
+    it 'returns an array of branches' do
+      Twig.should_receive(:run).with(@command).and_return(@branch_tuples)
+      twig = Twig.new
+
+      branches = twig.all_branches
+
+      branches[0].name.should == @branch_names[0]
+      branches[0].last_commit_time.to_s.
+        should =~ %r{#{@commit_time_strings[0]} .* \(111d ago\)}
+      branches[1].name.should == @branch_names[1]
+      branches[1].last_commit_time.to_s.
+        should =~ %r{#{@commit_time_strings[1]} .* \(222d ago\)}
+      branches[2].name.should == @branch_names[2]
+      branches[2].last_commit_time.to_s.
+        should =~ %r{#{@commit_time_strings[2]} .* \(333d ago\)}
+    end
+
+    it 'memoizes the result' do
+      Twig.should_receive(:run).with(@command).once.and_return(@branch_tuples)
+      twig = Twig.new
+
+      2.times { twig.all_branches }
+    end
+  end
+
+  describe '#branches' do
+    before :each do
+      @twig = Twig.new
+      branch_names = %w[
+        fix_some_of_the_things
+        fix_some_other_of_the_things
+        fix_nothing
+      ]
+      commit_times = [
+        Twig::CommitTime.new(Time.now - 86400 * 10, '10 days ago'),
+        Twig::CommitTime.new(Time.now - 86400 * 20, '20 days ago'),
+        Twig::CommitTime.new(Time.now - 86400 * 30, '30 days ago')
+      ]
+      @branches = [
+        Twig::Branch.new(branch_names[0], :last_commit_time => commit_times[0]),
+        Twig::Branch.new(branch_names[1], :last_commit_time => commit_times[1]),
+        Twig::Branch.new(branch_names[2], :last_commit_time => commit_times[2])
+      ]
+      @twig.stub(:all_branches => @branches)
+    end
+
+    it 'returns all branches' do
+      @twig.branches.should == @branches
+    end
+
+    it 'returns only branches matching a name pattern' do
+      @twig.set_option(:branch_only, /fix_some/)
+      @twig.branches.map { |branch| branch.name }.
+        should == [@branches[0].name, @branches[1].name]
+    end
+
+    it 'returns all branches except those matching a name pattern' do
+      @twig.set_option(:branch_except, /fix_some/)
+      @twig.branches.map { |branch| branch.name }.should == [@branches[2].name]
+    end
+
+    it 'returns only branches below a certain age' do
+      @twig.set_option(:max_days_old, 25)
+      @twig.branches.map { |branch| branch.name }.
+        should == [@branches[0].name, @branches[1].name]
+    end
+  end
+
+  describe '#branch_names' do
+    it 'returns an array of branch names' do
+      twig = Twig.new
+      branch_names = %w[foo bar baz]
+      branches = branch_names.map { |name| Twig::Branch.new(name) }
+      twig.should_receive(:branches).and_return(branches)
+
+      twig.branch_names.should == branch_names
+    end
+  end
+
+  describe '#list_branches' do
+    before :each do
+      @twig = Twig.new
+      @list_headers = '[branch list headers]'
+      commit_times = [
+        Twig::CommitTime.new(Time.now, '111 days ago'),
+        Twig::CommitTime.new(Time.now, '222 days ago')
+      ]
+      commit_times[0].stub(:to_i => 2000_01_01 )
+      commit_times[0].stub(:to_s =>'2000-01-01')
+      commit_times[1].stub(:to_i => 2000_01_02 )
+      commit_times[1].stub(:to_s =>'2000-01-02')
+      @branches = [
+        Twig::Branch.new('foo', :last_commit_time => commit_times[0]),
+        Twig::Branch.new('foo', :last_commit_time => commit_times[1])
+      ]
+      @branch_lines = ['[foo line]', '[bar line]']
+    end
+
+    it 'returns a list of branches, most recently modified first' do
+      @twig.should_receive(:branches).at_least(:once).and_return(@branches)
+      @twig.should_receive(:branch_list_headers).and_return(@list_headers)
+      @twig.should_receive(:branch_list_line).with(@branches[0]).
+        and_return(@branch_lines[0])
+      @twig.should_receive(:branch_list_line).with(@branches[1]).
+        and_return(@branch_lines[1])
+      result = @twig.list_branches
+
+      result.should == "\n" + @list_headers +
+        @branch_lines[1] + "\n" + @branch_lines[0]
+    end
+
+    it 'returns a message if all branches were filtered out by options' do
+      @twig.stub(:all_branches => %[foo bar])
+      @twig.stub(:branches => [])
+
+      @twig.list_branches.should include(
+        'There are no branches matching your selected options'
+      )
+    end
+
+    it 'returns a message if the repo has no branches' do
+      @twig.stub(:all_branches => [])
+      @twig.stub(:branches => [])
+
+      @twig.list_branches.should include('This repository has no branches')
+    end
+  end
+
+  describe '#get_branch_property' do
+    before :each do
+      @twig   = Twig.new
+      @branch = Twig::Branch.new('test')
+    end
+
+    it 'calls `Twig::Branch#get_property`' do
+      property_name  = 'foo'
+      property_value = 'bar'
+      Twig::Branch.should_receive(:new).with(@branch.name).and_return(@branch)
+      @branch.should_receive(:get_property).with(property_name).
+        and_return(property_value)
+
+      result = @twig.get_branch_property(@branch.name, property_name)
+      result.should == property_value
+    end
+  end
+
+  describe '#set_branch_property' do
+    it 'calls `Twig::Branch#set_property`' do
+      twig   = Twig.new
+      branch = Twig::Branch.new('test')
+      property_name  = 'foo'
+      property_value = 'bar'
+      Twig::Branch.should_receive(:new).with(branch.name).and_return(branch)
+      branch.should_receive(:set_property).with(property_name, property_value)
+
+      twig.set_branch_property(branch.name, property_name, property_value)
+    end
+  end
+
+  describe '#unset_branch_property' do
+    it 'calls `Twig::Branch#unset_property`' do
+      twig   = Twig.new
+      branch = Twig::Branch.new('test')
+      property_name = 'foo'
+      Twig::Branch.should_receive(:new).with(branch.name).and_return(branch)
+      branch.should_receive(:unset_property).with(property_name)
+
+      twig.unset_branch_property(branch.name, property_name)
+    end
+  end
+
+end

data/twig.gemspec

@@ -0,0 +1,38 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'twig/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'twig'
+  spec.version       = Twig::VERSION
+  spec.date          = '2012-12-13'
+  spec.authors       = ['Ron DeVera']
+  spec.email         = ["hello@rondevera.com"]
+  spec.homepage      = 'https://github.com/rondevera/twig'
+  spec.summary       = %{Track progress on your Git branches.}
+  spec.description   =
+    'Twig is a command-line tool for tracking progress on your Git ' <<
+    'branches, remembering ticket ids for each branch, and more. Twig ' <<
+    'supports subcommands for managing branches however you want.'
+  spec.post_install_message =
+    "\n**************************************************************" <<
+    "\n*                                                            *" <<
+    "\n* Welcome to Twig!                                           *" <<
+    "\n*                                                            *" <<
+    "\n* To get started, run `twig` to list your Git branches, and  *" <<
+    "\n* `twig --help` for more info.                               *" <<
+    "\n*                                                            *" <<
+    "\n**************************************************************" <<
+    "\n\n"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}).map { |file| File.basename(file) }
+  spec.require_paths = ['lib']
+  spec.test_files    = spec.files.grep(%r{^spec/})
+
+  spec.required_ruby_version = '>= 1.8.7'
+  spec.add_runtime_dependency     'json',  '~> 1.7.5'
+  spec.add_development_dependency 'rake',  '~> 0.9.2'
+  spec.add_development_dependency 'rspec', '~> 2.11.0'
+end

metadata

@@ -0,0 +1,166 @@
+--- !ruby/object:Gem::Specification 
+name: twig
+version: !ruby/object:Gem::Version 
+  hash: 23
+  prerelease: 
+  segments: 
+  - 1
+  - 0
+  - 0
+  version: 1.0.0
+platform: ruby
+authors: 
+- Ron DeVera
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2012-12-13 00:00:00 -08:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: json
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 1
+        segments: 
+        - 1
+        - 7
+        - 5
+        version: 1.7.5
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: rake
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 63
+        segments: 
+        - 0
+        - 9
+        - 2
+        version: 0.9.2
+  type: :development
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 35
+        segments: 
+        - 2
+        - 11
+        - 0
+        version: 2.11.0
+  type: :development
+  version_requirements: *id003
+description: Twig is a command-line tool for tracking progress on your Git branches, remembering ticket ids for each branch, and more. Twig supports subcommands for managing branches however you want.
+email: 
+- hello@rondevera.com
+executables: 
+- twig
+- twig-gh-open
+- twig-gh-update
+- twig-help
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- .gitignore
+- .rvmrc
+- CONTRIBUTING.md
+- Gemfile
+- HISTORY.md
+- LICENSE.md
+- README.md
+- Rakefile
+- bin/twig
+- bin/twig-gh-open
+- bin/twig-gh-update
+- bin/twig-help
+- install
+- lib/twig.rb
+- lib/twig/branch.rb
+- lib/twig/cli.rb
+- lib/twig/commit_time.rb
+- lib/twig/display.rb
+- lib/twig/options.rb
+- lib/twig/util.rb
+- lib/twig/version.rb
+- spec/spec_helper.rb
+- spec/twig/branch_spec.rb
+- spec/twig/cli_spec.rb
+- spec/twig/commit_time_spec.rb
+- spec/twig/display_spec.rb
+- spec/twig/options_spec.rb
+- spec/twig/util_spec.rb
+- spec/twig_spec.rb
+- twig.gemspec
+has_rdoc: true
+homepage: https://github.com/rondevera/twig
+licenses: []
+
+post_install_message: |+
+  
+  **************************************************************
+  *                                                            *
+  * Welcome to Twig!                                           *
+  *                                                            *
+  * To get started, run `twig` to list your Git branches, and  *
+  * `twig --help` for more info.                               *
+  *                                                            *
+  **************************************************************
+  
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 57
+      segments: 
+      - 1
+      - 8
+      - 7
+      version: 1.8.7
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.5.2
+signing_key: 
+specification_version: 3
+summary: Track progress on your Git branches.
+test_files: 
+- spec/spec_helper.rb
+- spec/twig/branch_spec.rb
+- spec/twig/cli_spec.rb
+- spec/twig/commit_time_spec.rb
+- spec/twig/display_spec.rb
+- spec/twig/options_spec.rb
+- spec/twig/util_spec.rb
+- spec/twig_spec.rb