twig 1.5 → 1.6

data/spec/twig/commit_time_spec.rb

@@ -12,8 +12,12 @@ describe Twig::CommitTime do
     end
 
     it 'stores a "time ago" string as its shortened version' do
+      expect(Twig::CommitTime.new(@time, '1 year, 1 month ago').
+        instance_variable_get(:@time_ago)).to eq('1y ago')
       expect(Twig::CommitTime.new(@time, '2 years, 2 months ago').
         instance_variable_get(:@time_ago)).to eq('2y ago')
+      expect(Twig::CommitTime.new(@time, '1 year ago').
+        instance_variable_get(:@time_ago)).to eq('1y ago')
       expect(Twig::CommitTime.new(@time, '2 years ago').
         instance_variable_get(:@time_ago)).to eq('2y ago')
       expect(Twig::CommitTime.new(@time, '2 months ago').

data/spec/twig/display_spec.rb

@@ -103,6 +103,28 @@ describe Twig::Display do
       )
     end
 
+    it 'only includes certain property names' do
+      @twig.set_option(:property_only_name, /foo/)
+
+      result = @twig.branch_list_headers({})
+      result_lines = result.split("\n")
+
+      expect(result_lines[0]).to include('foo')
+      expect(result_lines[0]).not_to include('quux')
+      expect(result_lines[0]).to include('branch')
+    end
+
+    it 'excludes certain property names' do
+      @twig.set_option(:property_except_name, /foo/)
+
+      result = @twig.branch_list_headers({})
+      result_lines = result.split("\n")
+
+      expect(result_lines[0]).not_to include('foo')
+      expect(result_lines[0]).to include('quux')
+      expect(result_lines[0]).to include('branch')
+    end
+
     it 'sets a header width' do
       @twig.set_option(:property_width, :foo => 4)
 
@@ -127,7 +149,7 @@ describe Twig::Display do
     end
 
     it 'sets a header color' do
-      result = @twig.branch_list_headers({ :header_color => :green })
+      result = @twig.branch_list_headers(:header_color => :green)
       header_line = result.split("\n").first
       color = Twig::Display::COLORS[:green]
       expect(header_line.gsub(/\s/, '')).to eq(
@@ -138,7 +160,7 @@ describe Twig::Display do
     end
 
     it 'sets a header weight' do
-      result = @twig.branch_list_headers({ :header_weight => :bold })
+      result = @twig.branch_list_headers(:header_weight => :bold)
       header_line = result.split("\n").first
       weight = Twig::Display::WEIGHTS[:bold]
       expect(header_line.gsub(/\s/, '')).to eq(
@@ -149,7 +171,7 @@ describe Twig::Display do
     end
 
     it 'sets a header color and weight' do
-      result = @twig.branch_list_headers({ :header_color => :red, :header_weight => :bold })
+      result = @twig.branch_list_headers(:header_color => :red, :header_weight => :bold)
       header_line = result.split("\n").first
       color, weight = Twig::Display::COLORS[:red], Twig::Display::WEIGHTS[:bold]
       expect(header_line.gsub(/\s/, '')).to eq(
@@ -219,6 +241,30 @@ describe Twig::Display do
       expect(result).to include('line breaks')
     end
 
+    it 'only includes certain property names' do
+      @twig.set_option(:property_only_name, /foo/)
+      branch = @current_branch
+      expect(branch).to receive(:get_properties).
+        with(['foo']).
+        and_return('foo' => 'foo!')
+
+      result = @twig.branch_list_line(branch)
+
+      expect(result).to include('foo!')
+    end
+
+    it 'excludes certain property names' do
+      @twig.set_option(:property_except_name, /foo/)
+      branch = @current_branch
+      expect(branch).to receive(:get_properties).
+        with(['bar']).
+        and_return('bar' => 'bar!')
+
+      result = @twig.branch_list_line(branch)
+
+      expect(result).to include('bar!')
+    end
+
     it 'returns a line with custom column widths' do
       branch = @other_branch
       @twig.set_option(:property_width, :foo => 5)
@@ -274,8 +320,8 @@ describe Twig::Display do
 
   describe '#branches_json' do
     before :each do
-      @commit_time = Twig::CommitTime.new(Time.now, '')
-      allow(@commit_time).to receive(:to_s).and_return('2000-01-01')
+      @property_names = %w[foo bar]
+      allow(@twig).to receive(:property_names).and_return(@property_names)
     end
 
     it 'returns JSON for an array of branches' do
@@ -288,8 +334,12 @@ describe Twig::Display do
         { 'name' => 'branch2' }
       ]
       expect(@twig).to receive(:branches).and_return(branches)
-      expect(branches[0]).to receive(:to_hash).and_return(branch_hashes[0])
-      expect(branches[1]).to receive(:to_hash).and_return(branch_hashes[1])
+      expect(branches[0]).to receive(:to_hash).
+        with(@property_names).
+        and_return(branch_hashes[0])
+      expect(branches[1]).to receive(:to_hash).
+        with(@property_names).
+        and_return(branch_hashes[1])
 
       result = @twig.branches_json
 

data/spec/twig/options_spec.rb

@@ -213,7 +213,7 @@ describe Twig::Options do
 
     it 'reads and sets a single option' do
       path = Twig::CONFIG_PATH
-      allow(@twig).to receive(:all_branch_names) { ['test'] }
+      allow(Twig::Branch).to receive(:all_branch_names) { ['test'] }
       expect(@twig).to receive(:readable_config_file_path).and_return(path)
       expect(@twig).to receive(:parse_config_file).with(path).and_return(
         'branch' => 'test'
@@ -227,7 +227,7 @@ describe Twig::Options do
 
     it 'reads and sets multiple options' do
       path = Twig::CONFIG_PATH
-      allow(@twig).to receive(:all_branch_names) { ['test'] }
+      allow(Twig::Branch).to receive(:all_branch_names) { ['test'] }
       expect(@twig).to receive(:readable_config_file_path).and_return(path)
       expect(@twig).to receive(:parse_config_file).with(path).and_return(
         # Filtering branches:
@@ -239,10 +239,12 @@ describe Twig::Options do
         'only-foo'      => 'test-only-foo',
 
         # Displaying branches:
-        'format'        => 'json',
-        'header-style'  => 'green bold',
-        'reverse'       => 'true',
-        'foo-width'     => '4',
+        'format'          => 'json',
+        'except-property' => 'foo',
+        'only-property'   => 'bar',
+        'header-style'    => 'green bold',
+        'reverse'         => 'true',
+        'foo-width'       => '4',
 
         # GitHub integration:
         'github-api-uri-prefix' => 'https://github-enterprise.example.com/api/v3',
@@ -263,6 +265,8 @@ describe Twig::Options do
       expect(@twig.options[:max_days_old]).to be_nil
       expect(@twig.options[:property_except]).to be_nil
       expect(@twig.options[:property_only]).to be_nil
+      expect(@twig.options[:property_except_name]).to be_nil
+      expect(@twig.options[:property_only_name]).to be_nil
       expect(@twig.options[:property_width]).to be_nil
       expect(@twig.options[:reverse]).to be_nil
 
@@ -287,6 +291,8 @@ describe Twig::Options do
         :branch => /test-only-branch/,
         :foo    => /test-only-foo/
       )
+      expect(@twig.options[:property_except_name]).to eq(/foo/)
+      expect(@twig.options[:property_only_name]).to eq(/bar/)
       expect(@twig.options[:property_width]).to eq(:foo => 4)
       expect(@twig.options[:reverse]).to be_true
     end
@@ -300,7 +306,7 @@ describe Twig::Options do
 
       it 'succeeds' do
         branch_name = 'foo'
-        expect(@twig).to receive(:all_branch_names).and_return(%[foo bar])
+        expect(Twig::Branch).to receive(:all_branch_names).and_return(%[foo bar])
 
         @twig.set_option(:branch, branch_name)
 
@@ -309,7 +315,7 @@ describe Twig::Options do
 
       it 'fails if the branch is unknown' do
         branch_name = 'foo'
-        expect(@twig).to receive(:all_branch_names).and_return([])
+        expect(Twig::Branch).to receive(:all_branch_names).and_return([])
         expect(@twig).to receive(:abort) do |message|
           expect(message).to include(%{branch `#{branch_name}` could not be found})
         end
@@ -390,6 +396,18 @@ describe Twig::Options do
       expect(@twig.options[:property_only]).to eq(:branch => /important_prefix_/)
     end
 
+    it 'sets a :property_except_name option' do
+      expect(@twig.options[:property_except_name]).to be_nil
+      @twig.set_option(:property_except_name, /foo/)
+      expect(@twig.options[:property_except_name]).to eq(/foo/)
+    end
+
+    it 'sets a :property_only_name option' do
+      expect(@twig.options[:property_only_name]).to be_nil
+      @twig.set_option(:property_only_name, /foo/)
+      expect(@twig.options[:property_only_name]).to eq(/foo/)
+    end
+
     it 'sets a :property_width option' do
       width = 10
       expect(@twig).to receive(:set_property_width_option).with(width)
@@ -430,7 +448,6 @@ describe Twig::Options do
 
   describe '#set_header_style_option' do
     before :each do
-      # Preconditions:
       expect(@twig.options[:header_color]).to eq(Twig::DEFAULT_HEADER_COLOR)
       expect(@twig.options[:header_weight]).to be_nil
     end
@@ -519,7 +536,7 @@ describe Twig::Options do
     end
 
     it 'succeeds' do
-      @twig.set_option(:property_width, :foo => '20', :bar => '40')
+      @twig.set_property_width_option(:foo => '20', :bar => '40')
       expect(@twig.options[:property_width]).to eq(:foo => 20, :bar => 40)
     end
 
@@ -531,11 +548,11 @@ describe Twig::Options do
       end
 
       begin
-        @twig.set_option(:property_width, :branch => width)
+        @twig.set_property_width_option(:branch => width)
       rescue SystemExit => exception
       end
 
-      expect(@twig.options[:property_width]).to be_nil
+      expect(@twig.options[:property_width]).to eq({})
     end
 
     it 'fails if width is below minimum value' do
@@ -548,11 +565,11 @@ describe Twig::Options do
       end
 
       begin
-        @twig.set_option(:property_width, :x => width)
+        @twig.set_property_width_option(:x => width)
       rescue SystemExit => exception
       end
 
-      expect(@twig.options[:property_width]).to be_nil
+      expect(@twig.options[:property_width]).to eq({})
     end
 
     it 'fails if width is below width of property name' do
@@ -565,11 +582,11 @@ describe Twig::Options do
       end
 
       begin
-        @twig.set_option(:property_width, property_name => width)
+        @twig.set_property_width_option(property_name => width)
       rescue SystemExit => exception
       end
 
-      expect(@twig.options[:property_width]).to be_nil
+      expect(@twig.options[:property_width]).to eq({})
     end
   end
 

data/spec/twig_spec.rb

@@ -32,6 +32,22 @@ describe Twig do
         :header_color => Twig::DEFAULT_HEADER_COLOR
       )
     end
+
+    it 'reads config files and command-line options when `:read_options` is true' do
+      expect_any_instance_of(Twig).to receive(:read_config_file!)
+      expect_any_instance_of(Twig).to receive(:read_cli_options!)
+
+      Twig.new(:read_options => true)
+    end
+
+    it 'does not read config files or command-line options when `:read_options` is falsy' do
+      expect_any_instance_of(Twig).not_to receive(:read_config_file!)
+      expect_any_instance_of(Twig).not_to receive(:read_cli_options!)
+
+      Twig.new(:read_options => false)
+      Twig.new(:read_options => nil)
+      Twig.new
+    end
   end
 
   describe '#current_branch_name' do
@@ -47,52 +63,23 @@ describe Twig do
     end
   end
 
-  describe '#all_branches' do
+  describe '#target_branch_name' do
     before :each do
-      @branch_names = %w[
-        fix_some_of_the_things
-        fix_some_other_of_the_things
-        fix_nothing
-      ]
-      @commit_time_strings = ['2001-01-01',   '2002-02-02',   '2003-03-03'           ]
-      @commit_time_agos    = ['111 days ago', '2 months ago', '3 years, 3 months ago']
-      @command =
-        %{git for-each-ref #{Twig::REF_PREFIX} --format="#{Twig::REF_FORMAT}"}
-
-      @branch_tuples = (0..2).map do |i|
-        [
-          @branch_names[i],
-          @commit_time_strings[i],
-          @commit_time_agos[i]
-        ].join(Twig::REF_FORMAT_SEPARATOR)
-      end.join("\n")
+      @current_branch_name = 'current-branch'
+      @twig = Twig.new
+      allow(@twig).to receive(:current_branch_name).and_return(@current_branch_name)
     end
 
-    it 'returns an array of branches' do
-      expect(Twig).to receive(:run).with(@command).and_return(@branch_tuples)
-      twig = Twig.new
-
-      branches = twig.all_branches
+    it 'returns the branch specified in options' do
+      feature_branch_name = 'feature-branch'
+      expect(Twig::Branch).to receive(:all_branch_names).and_return([feature_branch_name])
+      @twig.set_option(:branch, feature_branch_name)
 
-      expect(branches[0].name).to eq(@branch_names[0])
-      expect(branches[0].last_commit_time.to_s).to match(
-        %r{#{@commit_time_strings[0]} .* \(111d ago\)}
-      )
-      expect(branches[1].name).to eq(@branch_names[1])
-      expect(branches[1].last_commit_time.to_s).to match(
-        %r{#{@commit_time_strings[1]} .* \(2mo ago\)}
-      )
-      expect(branches[2].name).to eq(@branch_names[2])
-      expect(branches[2].last_commit_time.to_s).to match(
-        %r{#{@commit_time_strings[2]} .* \(3y ago\)}
-      )
+      expect(@twig.target_branch_name).to eq(feature_branch_name)
     end
 
-    it 'memoizes the result' do
-      expect(Twig).to receive(:run).with(@command).once.and_return(@branch_tuples)
-      twig = Twig.new
-
-      2.times { twig.all_branches }
+    it 'returns the current branch by default' do
+      expect(@twig.target_branch_name).to eq(@current_branch_name)
     end
   end
 
@@ -117,7 +104,7 @@ describe Twig do
         Twig::Branch.new(branch_names[2], :last_commit_time => commit_times[2]),
         Twig::Branch.new(branch_names[3], :last_commit_time => commit_times[3])
       ]
-      allow(@twig).to receive(:all_branches) { @branches }
+      allow(Twig::Branch).to receive(:all_branches) { @branches }
     end
 
     it 'returns all branches' do
@@ -193,14 +180,30 @@ describe Twig do
     end
   end
 
-  describe '#all_branch_names' do
-    it 'returns an array of all branch names' do
-      twig = Twig.new
-      branch_names = %w[foo bar baz]
-      branches = branch_names.map { |name| Twig::Branch.new(name) }
-      expect(twig).to receive(:all_branches).and_return(branches)
+  describe '#property_names' do
+    before :each do
+      @twig = Twig.new
+      property_names = %w[foo bar baz]
+      expect(Twig::Branch).to receive(:all_property_names).and_return(property_names)
+    end
+
+    it 'returns an array of all property names' do
+      property_names = @twig.property_names
+      expect(property_names).to eq(%w[foo bar baz])
+    end
+
+    it 'returns an array with only certain property names' do
+      @twig.set_option(:property_only_name, /ba/)
+      property_names = @twig.property_names
+
+      expect(property_names).to eq(%w[bar baz])
+    end
+
+    it 'returns an array without certain property names' do
+      @twig.set_option(:property_except_name, /ba/)
+      property_names = @twig.property_names
 
-      expect(twig.all_branch_names).to eq(branch_names)
+      expect(property_names).to eq(%w[foo])
     end
   end
 
@@ -240,7 +243,7 @@ describe Twig do
     end
 
     it 'returns a message if all branches were filtered out by options' do
-      allow(@twig).to receive(:all_branches) { %w[foo bar] }
+      allow(Twig::Branch).to receive(:all_branches) { %w[foo bar] }
       allow(@twig).to receive(:branches) { [] }
 
       expect(@twig.list_branches).to include(
@@ -249,7 +252,7 @@ describe Twig do
     end
 
     it 'returns a message if the repo has no branches' do
-      allow(@twig).to receive(:all_branches) { [] }
+      allow(Twig::Branch).to receive(:all_branches) { [] }
       allow(@twig).to receive(:branches) { [] }
 
       expect(@twig.list_branches).to include('This repository has no branches')

data/twig.gemspec

@@ -14,18 +14,24 @@ Gem::Specification.new do |spec|
   spec.summary       = %{Your personal Git branch assistant.}
   spec.description   = %w[
     Twig is your personal Git branch assistant. It's a command-line tool for
-    listing your most recent branches, and for remembering each branch's ticket
-    ids, todos, and other details. Twig supports subcommands for managing
-    branches however you want. It's flexible enough to fit your every Git
-    workflow, and will save you a ton of time.
+    listing your most recent branches, and for remembering branch details for
+    you, like issue tracker ids and todos. It supports subcommands, like
+    automatically fetching statuses from your issue tracking system. It's
+    flexible enough to fit your everyday Git workflow, and will save you a ton
+    of time.
   ].join(' ')
   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* Quick start:                                               *" <<
+    "\n*                                                            *" <<
+    "\n* 1. Run `twig init` to set up tab completion.               *" <<
+    "\n* 2. Run `twig` to list your Git branches.                   *" <<
+    "\n*                                                            *" <<
+    "\n* For more info, run `twig --help` or visit                  *" <<
+    "\n* #{sprintf('%-59s', Twig::HOMEPAGE)                        }*" <<
     "\n*                                                            *" <<
     "\n**************************************************************" <<
     "\n\n"
@@ -36,8 +42,9 @@ Gem::Specification.new do |spec|
   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_runtime_dependency     'launchy',  '~> 2.3.0'
-  spec.add_development_dependency 'rake',     '~> 0.9.2'
-  spec.add_development_dependency 'rspec',    '~> 2.14.1'
+  spec.add_runtime_dependency     'json',        '~> 1.7.5'
+  spec.add_runtime_dependency     'launchy',     '~> 2.3.0'
+  spec.add_development_dependency 'rake',        '~> 0.9.2'
+  spec.add_development_dependency 'rspec',       '~> 2.14.1'
+  spec.add_development_dependency 'rspec-radar', '~> 0.1.0'
 end