loca 0.0.1 → 0.1.0

data/lib/loca/utils.rb

@@ -0,0 +1,12 @@
+module Loca
+  module Utils
+    # returns false if str is nil, or not a String, or an empty String
+    def non_empty_string?(str)
+      !str.strip.empty?
+    rescue NameError, NoMethodError
+      false
+    end
+
+    module_function :non_empty_string?
+  end
+end

data/lib/loca/version.rb

@@ -1,3 +1,3 @@
 module Loca
-  VERSION = '0.0.1'
+  VERSION = "0.1.0"
 end

data/spec/loca/cli_spec.rb

@@ -1,69 +1,47 @@
 describe Loca::CLI do
-  let(:invalid_url) { 'https://github.com/fakez/fakezz/pull/1' }
-  let(:url) { 'https://github.com/smoll/loca/pull/1' }
-  subject { described_class.new }
+  let(:cli) { described_class.new(argv, stdin, stdout, stderr) }
+  let(:stdin) { StringIO.new } # from http://stackoverflow.com/a/16507814/3456726
+  let(:stdout) { StringIO.new }
+  let(:stderr) { StringIO.new }
 
-  before do # ensure we don't shell out to git
-    allow_any_instance_of(Loca::Git).to receive(:fetch)
-    allow_any_instance_of(Loca::Git).to receive(:checkout)
-  end
-
-  describe 'c' do
-    it 'fetches and checks out the branch locally' do
-      expect_any_instance_of(Loca::Git).to receive(:branch_name).and_return 'PULL_1'
-      expect_any_instance_of(Loca::Git).to receive(:first_time_creating?).and_return true
-
-      output = capture(:stdout) { described_class.start(%W(c #{url})) }.strip
-      expect(output).to end_with 'Checked out PULL_1!'
-    end
-
-    it 'fetches and overwrites existing branch if the user says yes to overwrite' do
-      expect_any_instance_of(Loca::Git).to receive(:branch_name).and_return 'PULL_1'
-      expect_any_instance_of(Loca::Git).to receive(:first_time_creating?).and_return false
-      silence(:stdout) { allow_any_instance_of(described_class).to receive(:yes?).and_return true }
-
-      output = capture(:stdout) { described_class.start(%W(c #{url})) }.strip
-      expect(output).to end_with 'Checked out PULL_1!'
-    end
+  describe "#execute!" do
+    context "-v" do
+      let(:argv) { ["-v"] }
 
-    it 'raises an error when the branch exists and the user says no to overwrite' do
-      expect_any_instance_of(Loca::Git).to receive(:branch_name).and_return 'PULL_1'
-      expect_any_instance_of(Loca::Git).to receive(:first_time_creating?).and_return false
-      silence(:stdout) { allow_any_instance_of(described_class).to receive(:yes?).and_return false }
+      it "returns the version" do
+        expect do
+          cli.execute!
+          expect(stdout.string).to eq Loca::VERSION
+        end.to raise_error(SystemExit) # because execute! calls `exit 0` (or 1, etc.)
+        # from http://stackoverflow.com/a/28047771/3456726
+      end
 
-      expect { silence(:stderr) { described_class.start(%W(c #{url})) } }.to raise_error
+      it "exits cleanly" do
+        expect { cli.execute! }.to terminate.with_code 0
+      end
     end
 
-    it 'raises an error when an invalid repo is supplied' do
-      expect { silence(:stderr) { described_class.start(%W(c #{invalid_url})) } }.to raise_error
-    end
+    context "-h" do
+      let(:argv) { ["-h"] }
 
-    it 'deletes when the delete flag is appended' do
-      expect_any_instance_of(Loca::Git).to receive(:branch_name).and_return 'PULL_1'
-      expect_any_instance_of(Loca::Git).to receive(:delete)
+      it "returns the version" do
+        expect do
+          cli.execute!
+          expect(stdout.string).to include "Usage: loca <url> [options]"
+        end.to raise_error(SystemExit)
+      end
 
-      output = capture(:stdout) { described_class.start(%W(c #{url} -d)) }.strip
-      expect(output).to eq 'Deleted PULL_1!'
+      it "exits cleanly" do
+        expect { cli.execute! }.to terminate.with_code 0
+      end
     end
-  end
 
-  describe 'd' do
-    it 'deletes' do
-      expect_any_instance_of(Loca::Git).to receive(:branch_name).and_return 'PULL_1'
-      expect_any_instance_of(Loca::Git).to receive(:delete)
-
-      output = capture(:stdout) { described_class.start(%W(d #{url})) }.strip
-      expect(output).to eq 'Deleted PULL_1!'
-    end
-
-    it 'raises an error when an invalid repo is supplied' do
-      expect { silence(:stderr) { described_class.start(%W(d #{invalid_url})) } }.to raise_error
-    end
-  end
+    context "invalid option" do
+      let(:argv) { ["--invalid-option"] }
 
-  describe '--version' do
-    it 'returns the correct version' do
-      expect(capture(:stdout) { described_class.start(%w(-v)) }.strip).to eq(Loca::VERSION)
+      it "exits 1" do
+        expect { cli.execute! }.to terminate.with_code 1
+      end
     end
   end
 end

data/spec/loca/git/branch_creator_spec.rb

@@ -0,0 +1,18 @@
+describe Loca::Git::BranchCreator do
+  subject { described_class.new("1337", "PULL_1337", "loca_r_smoll", "https://github.com/smoll/loca") }
+
+  # This is probably better off being functionally tested
+  # Otherwise, we end up stubbing out specific `git` commands which is very brittle
+  # See https://sethvargo.com/unit-and-functional-testing-git-with-rspec/
+
+  describe "#add_remote" do
+    it "uses and avoids duplicating a preexisting remote" do
+      expect(subject).to receive(:git).with("remote show -n").and_return "origin\n"
+      expect(subject).to receive(:git)
+        .with("config --get remote.origin.url")
+        .and_return "https://github.com/smoll/loca\n"
+
+      subject.send :add_remote
+    end
+  end
+end

data/spec/loca/git/common_spec.rb

@@ -0,0 +1,46 @@
+describe Loca::Git::Common do
+  let(:dummy_class) { Class.new { include Loca::Git::Common } }
+  subject { dummy_class.new }
+
+  describe "#git" do
+    context "nonexistent command" do
+      let(:command) { "fakegitcmd" }
+
+      it "raises an error" do
+        expect { subject.git(command) }.to raise_error
+      end
+    end
+  end
+
+  describe "#git_urls_match?" do
+    # These should all equate with one another:
+    let(:remote_url) { "https://github.com/smoll/loca" }
+    let(:remote_url_with_git) { "https://github.com/smoll/loca.git" }
+    let(:remote_url_with_slash) { "https://github.com/smoll/loca/" }
+
+    it "matches when both have trailing '.git'" do
+      result = subject.git_urls_match?(remote_url_with_git, remote_url_with_git)
+      expect(result).to eq true
+    end
+
+    it "matches when both lack trailing '.git'" do
+      result = subject.git_urls_match?(remote_url, remote_url)
+      expect(result).to eq true
+    end
+
+    it "matches when only one has trailing '.git'" do
+      result = subject.git_urls_match?(remote_url_with_git, remote_url)
+      expect(result).to eq true
+    end
+
+    it "matches when one has a trailing slash" do
+      result = subject.git_urls_match?(remote_url_with_git, remote_url_with_slash)
+      expect(result).to eq true
+    end
+
+    it "returns false when they do not match" do
+      result = subject.git_urls_match?(remote_url, "https://github.com/smoll/locaz")
+      expect(result).to eq false
+    end
+  end
+end

data/spec/loca/url/parser_spec.rb

@@ -0,0 +1,88 @@
+describe Loca::URL::Parser do
+  subject { described_class.new(url) }
+
+  describe "#to_s" do
+    let(:url) { "https://github.com/smoll/loca/pull/1337/" }
+    it "returns the URL passed to the constructor" do
+      expect(subject.to_s).to eq url
+    end
+  end
+
+  describe "#parse" do
+    let(:parsed) { subject.parse }
+
+    context "valid commits url" do
+      let(:url) { "https://github.com/smoll/loca/pull/1337/commits" }
+
+      it "returns a hash" do
+        expect(parsed).to be_a Hash
+      end
+
+      it "returns the correct pull num" do
+        expect(parsed[:pull][:num].to_s).to eq "1337"
+      end
+
+      it "returns the correct pull url" do
+        expect(parsed[:pull][:url]).to eq "https://github.com/smoll/loca/pull/1337"
+      end
+
+      it "returns the correct remote url" do
+        expect(parsed[:remote][:url]).to eq "https://github.com/smoll/loca.git"
+      end
+
+      it "returns the expected branch name" do
+        expect(parsed[:branch_name]).to eq "PULL_1337"
+      end
+    end
+
+    context "valid files url" do
+      let(:url) { "https://github.com/smoll/loca/pull/1337/files" }
+
+      it "returns the correct remote url" do
+        expect(parsed[:remote][:url]).to eq "https://github.com/smoll/loca.git"
+      end
+
+      it "returns the expected branch name" do
+        expect(parsed[:branch_name]).to eq "PULL_1337"
+      end
+    end
+
+    context "valid pull url" do
+      let(:url) { "https://github.com/smoll/loca/pull/1337" }
+
+      it "returns the correct remote url" do
+        expect(parsed[:remote][:url]).to eq "https://github.com/smoll/loca.git"
+      end
+
+      it "returns the expected branch name" do
+        expect(parsed[:branch_name]).to eq "PULL_1337"
+      end
+    end
+
+    context "valid pull url with trailing slash" do
+      let(:url) { "https://github.com/smoll/loca/pull/1337/" }
+
+      it "returns the correct remote url" do
+        expect(parsed[:remote][:url]).to eq "https://github.com/smoll/loca.git"
+      end
+
+      it "returns the expected branch name" do
+        expect(parsed[:branch_name]).to eq "PULL_1337"
+      end
+    end
+
+    context "invalid host" do
+      let(:url) { "https://badhub.com/smoll/loca/pull/1337" }
+      it "raises an error" do
+        expect { parsed }.to raise_error
+      end
+    end
+
+    context "invalid url" do
+      let(:url) { "badhub.com" }
+      it "raises an error" do
+        expect { parsed }.to raise_error
+      end
+    end
+  end
+end

data/spec/loca/url/validator_spec.rb

@@ -0,0 +1,26 @@
+describe Loca::URL::Validator do
+  subject { described_class.new(url) }
+
+  describe "#validate" do
+    context "good url" do
+      let(:url) { "https://github.com/smoll/loca/pull/1337/commits" }
+      it "does not raise an error" do
+        expect { subject.validate }.not_to raise_error
+      end
+    end
+
+    context "bad url" do
+      let(:url) { "bad-url.com" }
+      it "raises an error" do
+        expect { subject.validate }.to raise_error
+      end
+    end
+
+    context "invalid pull number" do
+      let(:url) { "https://github.com/smoll/loca/pull/xyz/commits" }
+      it "raises an error" do
+        expect { subject.validate }.to raise_error
+      end
+    end
+  end
+end

data/spec/loca/utils_spec.rb

@@ -0,0 +1,40 @@
+describe Loca::Utils do
+  describe "#non_empty_string?" do
+    subject { Loca::Utils.non_empty_string?(param) }
+
+    context "nonempty string passed" do
+      let(:param) { "hi" }
+      it { is_expected.to eq true }
+    end
+
+    context "nonempty text after newline passed" do
+      let(:param) { "\nOK" }
+      it { is_expected.to eq true }
+    end
+
+    context "whitespace string passed" do
+      let(:param) { " " }
+      it { is_expected.to eq false }
+    end
+
+    context "newline string passed" do
+      let(:param) { "\n" }
+      it { is_expected.to eq false }
+    end
+
+    context "integer passed" do
+      let(:param) { 1 }
+      it { is_expected.to eq false }
+    end
+
+    context "float passed" do
+      let(:param) { 1.0 }
+      it { is_expected.to eq false }
+    end
+
+    context "nil passed" do
+      let(:param) { nil }
+      it { is_expected.to eq false }
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -1,27 +1,25 @@
 # Using https://raw.githubusercontent.com/bbatsov/rubocop/master/spec/spec_helper.rb as a guide
-require 'simplecov'
-require 'coveralls'
-require 'codeclimate-test-reporter'
-
-SimpleCov.formatter = SimpleCov::Formatter::MultiFormatter[
-  SimpleCov::Formatter::HTMLFormatter,
-  Coveralls::SimpleCov::Formatter,
-  CodeClimate::TestReporter::Formatter
-]
-SimpleCov.start
-
-require 'bundler/setup'
+require "simplecov"
+require "codeclimate-test-reporter"
+
+# Sending to Coveralls requires no set up, is done by rake task
+# Sending to Code Climate is set up here, but pushed in a rake task
+# ref: https://github.com/codeclimate/ruby-test-reporter#using-with-parallel_tests
+# ref: https://coveralls.zendesk.com/hc/en-us/articles/201769485-Ruby-Rails
+SimpleCov.add_filter "vendor"
+SimpleCov.formatters = [SimpleCov::Formatter::HTMLFormatter]
+SimpleCov.start CodeClimate::TestReporter.configuration.profile
+
+require "bundler/setup"
 Bundler.setup # From http://stackoverflow.com/a/4402193
 
-require 'loca'
+require "loca"
 
 # Requires supporting files with custom matchers and macros, etc,
 # in ./support/ and its subdirectories.
 Dir["#{File.dirname(__FILE__)}/support/**/*.rb"].each { |f| require f }
 
 RSpec.configure do |config|
-  config.include Features::GitHubHelper
-
   config.order = :random
 
   config.expect_with :rspec do |expectations|
@@ -37,48 +35,4 @@ RSpec.configure do |config|
   config.before do
     ARGV.replace []
   end
-
-  # From https://raw.githubusercontent.com/erikhuda/thor/master/spec/helper.rb
-  # Captures the output for analysis later
-  #
-  # @example Capture `$stderr`
-  #
-  #     output = capture(:stderr) { $stderr.puts "this is captured" }
-  #
-  # @param [Symbol] stream `:stdout` or `:stderr`
-  # @yield The block to capture stdout/stderr for.
-  # @return [String] The contents of $stdout or $stderr
-  # rubocop:disable Lint/Eval
-  def capture(stream)
-    begin
-      stream = stream.to_s
-      eval "$#{stream} = StringIO.new"
-      yield
-      result = eval("$#{stream}").string
-    ensure
-      eval("$#{stream} = #{stream.upcase}")
-    end
-
-    result
-  end
-  # rubocop:enable Lint/Eval
-
-  # This code was adapted from Ruby on Rails, available under MIT-LICENSE
-  # Copyright (c) 2004-2013 David Heinemeier Hansson
-  def silence_warnings
-    old_verbose, $VERBOSE = $VERBOSE, nil
-    yield
-  ensure
-    $VERBOSE = old_verbose
-  end
-
-  # Silences the output stream
-  #
-  # @example Silence `$stdout`
-  #
-  #     silence(:stdout) { $stdout.puts "hi" }
-  #
-  # @param [IO] stream The stream to use such as $stderr or $stdout
-  # @return [nil]
-  alias :silence :capture # rubocop:disable Style/Alias
 end

data/spec/support/matchers/terminate.rb

@@ -0,0 +1,37 @@
+RSpec::Matchers.define :terminate do |_code|
+  actual = nil
+
+  def supports_block_expectations?
+    true
+  end
+
+  match do |block|
+    begin
+      block.call
+    rescue SystemExit => e
+      actual = e.status
+    end
+    actual && actual == status_code
+  end
+
+  chain :with_code do |status_code|
+    @status_code = status_code
+  end
+
+  failure_message do |_block|
+    "expected block to call exit(#{status_code}) but exit" +
+      (actual.nil? ? " not called" : "(#{actual}) was called")
+  end
+
+  failure_message_when_negated do |_block|
+    "expected block not to call exit(#{status_code})"
+  end
+
+  description do
+    "expect block to call exit(#{status_code})"
+  end
+
+  def status_code
+    @status_code ||= 0
+  end
+end