twig 1.2.1 → 1.3

data/spec/twig/github_spec.rb

@@ -0,0 +1,299 @@
+require 'spec_helper'
+
+describe Twig::GithubRepo do
+
+  before :each do
+    @github_https_url           = 'https://github.com/rondevera/twig.git'
+                                  # Read-only or read/write
+    @github_git_read_only_url   = 'git://github.com/rondevera/twig.git'
+    @github_ssh_read_write_url  = 'git@github.com:rondevera/twig.git'
+
+    @generic_https_url          = 'https://example.com/rondevera/twig.git'
+    @generic_git_read_only_url  = 'git://example.com/rondevera/twig.git'
+    @generic_ssh_read_write_url = 'git@example.com:rondevera/twig.git'
+  end
+
+  describe '#initialize' do
+    it 'runs the given block' do
+      Twig.stub(:repo?) { true }
+      Twig::GithubRepo.any_instance.stub(:origin_url) { @github_ssh_read_write_url }
+      Twig::GithubRepo.any_instance.stub(:username)   { 'username' }
+      Twig::GithubRepo.any_instance.stub(:repository) { 'repository' }
+
+      block_has_run = false
+      Twig::GithubRepo.new do |gh_repo|
+        block_has_run = true
+      end
+
+      block_has_run.should be_true
+    end
+
+    it 'aborts if this is not a Git repo' do
+      Twig.stub(:repo?) { false }
+      Twig::GithubRepo.any_instance.stub(:origin_url) { @github_ssh_read_write_url }
+      Twig::GithubRepo.any_instance.stub(:username)   { 'username' }
+      Twig::GithubRepo.any_instance.stub(:repository) { 'repository' }
+      Twig::GithubRepo.any_instance.should_receive(:abort) do |message|
+        message.should include('not a git repository')
+      end
+
+      Twig::GithubRepo.new { |gh_repo| } # Do nothing
+    end
+
+    it 'aborts if the repo origin URL is empty' do
+      Twig.stub(:repo?) { true }
+      Twig::GithubRepo.any_instance.stub(:origin_url) { '' }
+      Twig::GithubRepo.any_instance.stub(:username)   { 'username' }
+      Twig::GithubRepo.any_instance.stub(:repository) { 'repository' }
+      Twig::GithubRepo.any_instance.should_receive(:abort_for_non_github_repo)
+
+      Twig::GithubRepo.new { |gh_repo| } # Do nothing
+    end
+
+    it 'aborts if the repo username is empty' do
+      Twig.stub(:repo?) { true }
+      Twig::GithubRepo.any_instance.stub(:origin_url) { @github_ssh_read_write_url }
+      Twig::GithubRepo.any_instance.stub(:username)   { '' }
+      Twig::GithubRepo.any_instance.stub(:repository) { 'repository' }
+      Twig::GithubRepo.any_instance.should_receive(:abort_for_non_github_repo)
+
+      Twig::GithubRepo.new { |gh_repo| } # Do nothing
+    end
+
+    it 'aborts if the repo name is empty' do
+      Twig.stub(:repo?) { true }
+      Twig::GithubRepo.any_instance.stub(:origin_url) { @github_ssh_read_write_url }
+      Twig::GithubRepo.any_instance.stub(:username)   { 'username' }
+      Twig::GithubRepo.any_instance.stub(:repository) { '' }
+      Twig::GithubRepo.any_instance.should_receive(:abort_for_non_github_repo)
+
+      Twig::GithubRepo.new { |gh_repo| } # Do nothing
+    end
+
+    it 'aborts if the repo is not hosted by GitHub' do
+      Twig.stub(:repo?) { true }
+      Twig::GithubRepo.any_instance.stub(:origin_url) { @generic_ssh_read_write_url }
+      Twig::GithubRepo.any_instance.stub(:username)   { 'username' }
+      Twig::GithubRepo.any_instance.stub(:repository) { 'repository' }
+      Twig::GithubRepo.any_instance.should_receive(:abort_for_non_github_repo)
+
+      Twig::GithubRepo.new { |gh_repo| } # Do nothing
+    end
+  end
+
+  describe '#origin_url' do
+    before :each do
+      Twig.stub(:repo?) { true }
+      Twig::GithubRepo.any_instance.stub(:username)   { 'username' }
+      Twig::GithubRepo.any_instance.stub(:repository) { 'repository' }
+    end
+
+    it 'gets the origin URL from the repo config' do
+      origin_url = @github_ssh_read_write_url
+      Twig.should_receive(:run).
+        with('git config remote.origin.url').once { origin_url }
+
+      Twig::GithubRepo.new do |gh_repo|
+        2.times { gh_repo.origin_url }
+      end
+    end
+  end
+
+  describe '#origin_url_parts' do
+    before :each do
+      Twig.stub(:repo?) { true }
+      Twig::GithubRepo.any_instance.stub(:username)   { 'username' }
+      Twig::GithubRepo.any_instance.stub(:repository) { 'repository' }
+    end
+
+    it 'splits the origin URL into useful parts' do
+      origin_url = @github_ssh_read_write_url
+      Twig::GithubRepo.any_instance.stub(:origin_url) { origin_url }
+
+      origin_url_parts = nil
+      Twig::GithubRepo.new do |gh_repo|
+        origin_url_parts = gh_repo.origin_url_parts
+      end
+
+      origin_url_parts.should == %w[
+        git@github.com
+        rondevera
+        twig.git
+      ]
+    end
+  end
+
+  describe '#github_repo?' do
+    before :each do
+      Twig.stub(:repo?) { true }
+    end
+
+    context 'with a GitHub HTTPS URL' do
+      before :each do
+        Twig::GithubRepo.any_instance.stub(:origin_url) { @github_https_url }
+      end
+
+      it 'returns true' do
+        is_github_repo = nil
+        Twig::GithubRepo.new do |gh_repo|
+          is_github_repo = gh_repo.github_repo?
+        end
+
+        is_github_repo.should be_true
+      end
+    end
+
+    context 'with a GitHub Git read-only URL' do
+      before :each do
+        Twig::GithubRepo.any_instance.stub(:origin_url) { @github_git_read_only_url }
+      end
+
+      it 'returns true' do
+        is_github_repo = nil
+        Twig::GithubRepo.new do |gh_repo|
+          is_github_repo = gh_repo.github_repo?
+        end
+
+        is_github_repo.should be_true
+      end
+    end
+
+    context 'with a GitHub SSH read/write URL' do
+      before :each do
+        Twig::GithubRepo.any_instance.stub(:origin_url) { @github_ssh_read_write_url }
+      end
+
+      it 'returns true' do
+        is_github_repo = nil
+        Twig::GithubRepo.new do |gh_repo|
+          is_github_repo = gh_repo.github_repo?
+        end
+
+        is_github_repo.should be_true
+      end
+    end
+
+    context 'with a generic HTTPS URL' do
+      before :each do
+        Twig::GithubRepo.any_instance.stub(:origin_url) { @generic_https_url }
+        Twig::GithubRepo.any_instance.stub(:abort_for_non_github_repo)
+      end
+
+      it 'returns false' do
+        is_github_repo = nil
+        Twig::GithubRepo.new do |gh_repo|
+          is_github_repo = gh_repo.github_repo?
+        end
+
+        is_github_repo.should be_false
+      end
+    end
+
+    context 'with a generic Git read-only URL' do
+      before :each do
+        Twig::GithubRepo.any_instance.stub(:origin_url) { @generic_git_read_only_url }
+        Twig::GithubRepo.any_instance.stub(:abort_for_non_github_repo)
+      end
+
+      it 'returns false' do
+        is_github_repo = nil
+        Twig::GithubRepo.new do |gh_repo|
+          is_github_repo = gh_repo.github_repo?
+        end
+
+        is_github_repo.should be_false
+      end
+    end
+
+    context 'with a generic SSH read/write URL' do
+      before :each do
+        Twig::GithubRepo.any_instance.stub(:origin_url) { @generic_ssh_read_write_url }
+        Twig::GithubRepo.any_instance.stub(:abort_for_non_github_repo)
+      end
+
+      it 'returns false' do
+        is_github_repo = nil
+        Twig::GithubRepo.new do |gh_repo|
+          is_github_repo = gh_repo.github_repo?
+        end
+
+        is_github_repo.should be_false
+      end
+    end
+  end
+
+  describe '#username' do
+    before :each do
+      Twig.stub(:repo?) { true }
+      Twig::GithubRepo.any_instance.stub(:repository) { 'repository' }
+    end
+
+    it 'gets the username for a HTTPS repo' do
+      Twig::GithubRepo.any_instance.stub(:origin_url) { @github_ssh_read_write_url }
+      username = nil
+      Twig::GithubRepo.new do |gh_repo|
+        username = gh_repo.username
+      end
+
+      username.should == 'rondevera'
+    end
+
+    it 'gets the username for a Git read-only repo' do
+      Twig::GithubRepo.any_instance.stub(:origin_url) { @github_git_read_only_url }
+      username = nil
+      Twig::GithubRepo.new do |gh_repo|
+        username = gh_repo.username
+      end
+
+      username.should == 'rondevera'
+    end
+
+    it 'gets the username for a SSH read/write repo' do
+      Twig::GithubRepo.any_instance.stub(:origin_url) { @github_ssh_read_write_url }
+      username = nil
+      Twig::GithubRepo.new do |gh_repo|
+        username = gh_repo.username
+      end
+
+      username.should == 'rondevera'
+    end
+  end
+
+  describe '#repository' do
+    before :each do
+      Twig.stub(:repo?) { true }
+      Twig::GithubRepo.any_instance.stub(:username) { 'repository' }
+    end
+
+    it 'gets the repo name for a HTTPS repo' do
+      Twig::GithubRepo.any_instance.stub(:origin_url) { @github_https_url }
+      repository = nil
+      Twig::GithubRepo.new do |gh_repo|
+        repository = gh_repo.repository
+      end
+
+      repository.should == 'twig'
+    end
+
+    it 'gets the repo name for a Git read-only repo' do
+      Twig::GithubRepo.any_instance.stub(:origin_url) { @github_git_read_only_url }
+      repository = nil
+      Twig::GithubRepo.new do |gh_repo|
+        repository = gh_repo.repository
+      end
+
+      repository.should == 'twig'
+    end
+
+    it 'gets the repo name for a SSH read/write repo' do
+      Twig::GithubRepo.any_instance.stub(:origin_url) { @github_ssh_read_write_url }
+      repository = nil
+      Twig::GithubRepo.new do |gh_repo|
+        repository = gh_repo.repository
+      end
+
+      repository.should == 'twig'
+    end
+  end
+
+end

data/spec/twig/options_spec.rb

@@ -12,7 +12,7 @@ describe Twig::Options do
     end
 
     it 'reads and sets a single option' do
-      @twig.stub(:branch_names => ['test'])
+      @twig.stub(:all_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)
@@ -25,18 +25,23 @@ describe Twig::Options do
     end
 
     it 'reads and sets multiple options' do
-      @twig.stub(:branch_names => ['test'])
+      @twig.stub(:all_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([
+        # Filtering branches:
         'branch:        test',
-        'header-style:  green bold',
         'max-days-old:  30.5',
         'except-branch: test-except-branch',
         'only-branch:   test-only-branch',
         'except-foo:    test-except-foo',
-        'only-foo:      test-only-foo'
+        'only-foo:      test-only-foo',
+
+        # Displaying branches:
+        'header-style:  green bold',
+        'reverse:       true',
+        'foo-width:     4'
       ].join("\n"))
 
       # Check preconditions
@@ -46,6 +51,8 @@ describe Twig::Options do
       @twig.options[:max_days_old].should be_nil
       @twig.options[:property_except].should be_nil
       @twig.options[:property_only].should be_nil
+      @twig.options[:property_width].should be_nil
+      @twig.options[:reverse].should be_nil
 
       @twig.read_config_file!
 
@@ -61,6 +68,8 @@ describe Twig::Options do
         :branch => /test-only-branch/,
         :foo    => /test-only-foo/
       }
+      @twig.options[:property_width].should == { :foo => 4 }
+      @twig.options[:reverse].should be_true
     end
 
     it 'skips comments' do
@@ -70,7 +79,8 @@ describe Twig::Options do
       file.should_receive(:read).and_return([
         '# max-days-old: 40',
         'max-days-old: 30',
-        '# max-days-old: 20'
+        '# max-days-old: 20',
+        ' # foo-width: 4'
       ].join("\n"))
       @twig.options[:max_days_old].should be_nil # Precondition
 
@@ -113,7 +123,7 @@ describe Twig::Options do
 
       it 'succeeds' do
         branch_name = 'foo'
-        @twig.should_receive(:branch_names).and_return(%[foo bar])
+        @twig.should_receive(:all_branch_names).and_return(%[foo bar])
 
         @twig.set_option(:branch, branch_name)
 
@@ -122,7 +132,7 @@ describe Twig::Options do
 
       it 'fails if the branch is unknown' do
         branch_name = 'foo'
-        @twig.should_receive(:branch_names).and_return([])
+        @twig.should_receive(:all_branch_names).and_return([])
         @twig.should_receive(:abort) do |message|
           message.should include(%{branch "#{branch_name}" could not be found})
         end
@@ -173,6 +183,37 @@ describe Twig::Options do
       @twig.options[:property_only].should == { :branch => /important_prefix_/ }
     end
 
+    it 'sets a :property_width option' do
+      width = 10
+      @twig.should_receive(:set_property_width_option).with(width)
+
+      @twig.set_option(:property_width, width)
+    end
+
+    context 'when setting a :reverse option' do
+      before :each do
+        @twig.options[:reverse].should be_nil # Precondition
+      end
+
+      it 'sets the option to true when input is truthy' do
+        input = 'yes'
+        Twig::Util.should_receive(:truthy?).with(input).and_call_original
+
+        @twig.set_option(:reverse, input)
+
+        @twig.options[:reverse].should be_true
+      end
+
+      it 'sets the option to false when input is not truthy' do
+        input = 'blargh'
+        Twig::Util.should_receive(:truthy?).with(input).and_call_original
+
+        @twig.set_option(:reverse, input)
+
+        @twig.options[:reverse].should be_false
+      end
+    end
+
     it 'sets an :unset_property option' do
       @twig.options[:unset_property].should be_nil # Precondition
       @twig.set_option(:unset_property, 'unwanted_property')
@@ -265,6 +306,66 @@ describe Twig::Options do
     end
   end
 
+  describe '#set_property_width_option' do
+    before :each do
+      @twig.options[:property_width].should be_nil # Precondition
+    end
+
+    it 'succeeds' do
+      @twig.set_option(:property_width, :foo => '20', :bar => '40')
+      @twig.options[:property_width].should == { :foo => 20, :bar => 40 }
+    end
+
+    it 'fails if width is not numeric' do
+      width = 'blargh'
+      @twig.should_receive(:abort) do |message|
+        message.should include("`--branch-width=#{width}` is invalid")
+        abort # Original behavior, but don't show message in test output
+      end
+
+      begin
+        @twig.set_option(:property_width, :branch => width)
+      rescue SystemExit => exception
+      end
+
+      @twig.options[:property_width].should be_nil
+    end
+
+    it 'fails if width is below minimum value' do
+      min_width = Twig::Options::MIN_PROPERTY_WIDTH
+      width     = min_width - 1
+      @twig.should_receive(:abort) do |message|
+        message.should include("`--x-width=#{width}` is too low. ")
+        message.should include("The minimum is #{min_width}.")
+        abort
+      end
+
+      begin
+        @twig.set_option(:property_width, :x => width)
+      rescue SystemExit => exception
+      end
+
+      @twig.options[:property_width].should be_nil
+    end
+
+    it 'fails if width is below width of property name' do
+      property_name = :foobarbaz
+      width = property_name.to_s.size - 1
+      @twig.should_receive(:abort) do |message|
+        message.should include("`--#{property_name}-width=#{width}` is too low. ")
+        message.should include(%{The minimum is 9 (width of "#{property_name}")})
+        abort
+      end
+
+      begin
+        @twig.set_option(:property_width, property_name => width)
+      rescue SystemExit => exception
+      end
+
+      @twig.options[:property_width].should be_nil
+    end
+  end
+
   describe '#unset_option' do
     it 'unsets an option' do
       @twig.set_option(:max_days_old, 1)