loca 0.0.1 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 1d72e91059bc88a4090bd9eb2c6c8f1e45c13704
-  data.tar.gz: e8fda9734eaf1fc2446fdb85490e792db395d6ee
+  metadata.gz: f8d346e967391656b7e5270109caa97349ebd2e7
+  data.tar.gz: 8d24248adeaba1b73089eac6abb8d4a0deb1ba65
 SHA512:
-  metadata.gz: 71eb60e85d247ce2ee9e14905c685283632262618815a1dccf80af8039a449302f0945af2b40f144358e84ecad73129d72f1adac0183bbd48f6bd4439da611b3
-  data.tar.gz: 129bf8eb437ae3a064b5f9a77e284738eb961f8f6a55ba4c9390b6eba4a91623a73b8664fe200394dd414c083ca6b1e0d16ae348dba6686656889555455258ec
+  metadata.gz: a14f15ea2617100bc2a952d8b5e7a2348fa1b03c55e4071023f096ee12cf358ff374fd2f5024d6956955eca84e7b7ba6defbad2d9a544ee3409169ea016776f5
+  data.tar.gz: 33e0b60efc31955531b15c68d33b2184fbaa98e048828bfae87139f2349751ca6d59eacaccb2baaab9577fbeb6ca5d420d42cdde167de7a33bcc2536e6425927

data/bin/loca

@@ -1,5 +1,34 @@
 #!/usr/bin/env ruby
 
-require 'loca'
+# Based on https://github.com/colszowka/simplecov/issues/234
+# and http://stackoverflow.com/a/20505441/3456726
+if ENV["COVERAGE"]
+  require "simplecov"
 
-Loca::CLI.start(ARGV)
+  # As described in the issue, every process must have an unique name:
+  SimpleCov.command_name "loca #{ARGV.join(' ')} (Aruba)"
+
+  # When running with aruba simplecov was using /tmp/aruba as the root folder.
+  # This is to force using the project folder
+  SimpleCov.root(File.join(File.expand_path(File.dirname(__FILE__)), ".."))
+
+  SimpleCov.start do
+    filters.clear
+
+    # Because simplecov filters everything outside of the SimpleCov.root
+    # This should be added, cf.
+    # https://github.com/colszowka/simplecov#default-root-filter-and-coverage-for-things-outside-of-it
+    add_filter do |src|
+      !(src.filename =~ /^#{SimpleCov.root}/) unless src.filename =~ /loca/
+    end
+
+    # Ignoring test folders and tmp for Aruba
+    add_filter "/spec/"
+    add_filter "/test/"
+    add_filter "/features/"
+    add_filter "/tmp/"
+  end
+end
+
+require "loca"
+Loca::CLI.new(ARGV.dup).execute!

data/lib/loca.rb

@@ -1,14 +1,10 @@
 # Require all runtime dependencies first
-require 'thor'
-require 'colorize'
-require 'mixlib/shellout'
-require 'addressable/uri'
+require "addressable/uri"
+require "colorize"
+require "mixlib/shellout"
+require "require_all"
 
 # Start by requiring files with no dependencies on other files, then files with
 # only external gem runtime dependencies (specified above), then files with
 # dependencies on other files within the loca project itself
-require 'loca/version'
-require 'loca/error'
-require 'loca/url'
-require 'loca/git'
-require 'loca/cli'
+require_rel "./loca"

data/lib/loca/cli.rb

@@ -1,47 +1,73 @@
-module Loca
-  class CLI < Thor
-    include Thor::Actions # https://github.com/erikhuda/thor/wiki/Actions
-
-    map %w(--version -v) => :__print_version
+require "optparse"
 
-    desc '--version, -v', 'print the version'
-    def __print_version
-      puts Loca::VERSION
+module Loca
+  class CLI
+    def initialize(argv, stdin = STDIN, stdout = STDOUT, stderr = STDERR, kernel = Kernel)
+      @argv, @stdin, @stdout, @stderr, @kernel = argv, stdin, stdout, stderr, kernel
     end
 
-    desc 'c URL', 'Check out a pull request locally'
-    method_option :delete, aliases: '-d', desc: 'Delete the branch instead of creating it'
-    def c(pasted_url)
-      return d(pasted_url) if options[:delete]
-
-      git = Loca::Git.new(pasted_url)
-      branch_name = git.branch_name
-
-      if git.first_time_creating? || yes?("WARN: Branch '#{branch_name}' "\
-        ' already exists. Overwrite? (n)', :yellow)
-        git.fetch
-        git.checkout
-        say "Checked out #{branch_name}!", :green
-      else
-        fail Loca::Error::GitAborted, 'Git checkout aborted!'
+    def execute!
+      begin
+        parse_opts
+        parse_cmd
+      rescue Loca::Error::Standard, OptionParser::InvalidOption => e # colorize if so
+        @stderr.puts e.message.red
+        @stderr.puts e.backtrace if @options[:backtrace]
+        @stdout.puts parser # add if-user-error validation here
+        @kernel.exit(1)
       end
+      @kernel.exit(0)
     end
 
-    desc 'd URL', 'Delete the local branch for that URL'
-    def d(pasted_url)
-      git = Loca::Git.new(pasted_url)
-      branch_name = git.branch_name
+    private
 
-      git.delete
-      say "Deleted #{branch_name}!", :green
+    def parse_opts
+      parser.parse! @argv
     end
 
-    private # rubocop:disable Lint/UselessAccessModifier
+    def parse_cmd
+      fail Loca::Error::InvalidURL, "Need to pass in a single URL! Args: #{@argv}" unless @argv.count == 1
+      @parsed_url = Loca::URL::Parser.new(@argv[0]).parse
+
+      return delete if @options[:delete]
+      create
+    end
 
-    no_commands do # Thor primitive(s) that we want to stub in RSpec
-      def yes?(*args)
-        super
+    def parser # rubocop:disable Metrics/MethodLength
+      return @parser if @parser
+      @options = { delete: false, backtrace: false }
+      @parser = OptionParser.new do |opts|
+        opts.banner = "Usage: loca <url> [options]"
+        opts.on("-b", "--backtrace", "Display full stacktraces on error") do
+          @options[:backtrace] = true
+        end
+        opts.on("-d", "--delete", "Deletes the checked out branch") do
+          @options[:delete] = true
+        end
+        opts.on_tail("-h", "--help", "Displays Help") do
+          @stdout.puts opts
+          @kernel.exit(0)
+        end
+        opts.on_tail("-v", "--version", "Display Version") do
+          @stdout.puts Loca::VERSION
+          @kernel.exit(0)
+        end
       end
     end
+
+    def delete
+      Loca::Git::BranchDeleter.new(@parsed_url[:branch_name]).delete
+      @stdout.puts "Deleted branch #{@parsed_url[:branch_name]}".green
+    end
+
+    def create
+      Loca::Git::BranchCreator.new(
+        @parsed_url[:pull][:num],
+        @parsed_url[:branch_name],
+        @parsed_url[:remote][:name],
+        @parsed_url[:remote][:url]
+      ).create
+      @stdout.puts "Created and checked out branch #{@parsed_url[:branch_name]}".green
+    end
   end
 end

data/lib/loca/error.rb

@@ -2,20 +2,13 @@
 # and http://www.simonewebdesign.it/how-to-set-default-message-exception/
 module Loca
   module Error
-    class Base < StandardError
-      def initialize(message)
-        # To get the message in red
-        $stderr.puts message.red
-        @message = message
-      end
-    end
+    class Standard < StandardError; end
 
-    InvalidURL = Class.new(Base)
-
-    GitStdErrDetected = Class.new(Base)
-    UnstashedFilesFound = Class.new(Base)
-    OnlyOneBranch = Class.new(Base)
-    RemoteNotSet = Class.new(Base)
-    GitAborted = Class.new(Base)
+    InvalidURL = Class.new(Standard)
+    GitStdErrDetected = Class.new(Standard)
+    UnstashedFilesFound = Class.new(Standard)
+    OnlyOneBranch = Class.new(Standard)
+    RemoteNotSet = Class.new(Standard)
+    GitAborted = Class.new(Standard)
   end
 end

data/lib/loca/git/branch_creator.rb

@@ -0,0 +1,55 @@
+module Loca
+  module Git
+    class BranchCreator
+      include Common
+      include Utils
+
+      def initialize(pull_num, branch_name, remote_name, remote_url)
+        @pull_num, @branch_name, @remote_name, @remote_url = pull_num, branch_name, remote_name, remote_url
+      end
+
+      def create
+        run_git_checkers
+        add_remote
+        # To avoid fatal error: Refusing to fetch into current branch
+        delete unless first_time_creating?
+        fetch
+        checkout
+      end
+
+      def fetch
+        # Performs `git fetch upstream pull/PR_NUMBER/head:BRANCH_NAME`
+        git "fetch #{@remote_name} pull/#{@pull_num}/head:#{@branch_name}" # shellout has stderr for some reason
+      end
+
+      def checkout
+        git "checkout #{@branch_name}" # prints to stderr for some reason
+      end
+
+      private
+
+      def delete
+        BranchDeleter.new(@branch_name).delete
+      end
+
+      def first_time_creating?
+        branches.include?(@branch_name) ? false : true
+      end
+
+      def remote_mapping
+        names = git("remote show -n").split("\n")
+        mapping = {}
+        names.each do |name|
+          mapping[name] = git("config --get remote.#{name}.url").strip
+        end
+        mapping
+      end
+
+      def add_remote
+        match = remote_mapping.find { |_name, url| git_urls_match?(url, @remote_url) }
+        return @remote_name = match.first if match # avoid creating duplicate remotes
+        git "remote add #{@remote_name} #{@remote_url}"
+      end
+    end
+  end
+end

data/lib/loca/git/branch_deleter.rb

@@ -0,0 +1,32 @@
+module Loca
+  module Git
+    class BranchDeleter
+      include Common
+      include Utils
+
+      def initialize(branch)
+        @branch = branch
+      end
+
+      def delete
+        run_git_checkers
+        # Cannot delete a branch you are currently on:
+        checkout_another_branch if @branch == current_branch
+        git "branch -D #{@branch}"
+      end
+
+      private
+
+      def checkout_another_branch
+        another = "master" if branches.include?("master") # prefer to checkout master branch if it exists
+        another = branches.find { |branch| branch != current_branch } unless another
+        fail Loca::Error::OnlyOneBranch, "No other branch to checkout!" unless another
+        git "checkout #{another}" # prints to stderr for some reason
+      end
+
+      def current_branch
+        git("rev-parse --abbrev-ref HEAD").strip
+      end
+    end
+  end
+end

data/lib/loca/git/common.rb

@@ -0,0 +1,42 @@
+module Loca
+  module Git
+    module Common
+      def run_git_checkers
+        ensure_git_repo
+        ensure_no_unstashed_files
+      end
+
+      def git(cmd)
+        shellout = Mixlib::ShellOut.new "git #{cmd}"
+        shellout.run_command
+        shellout.error!
+        shellout.stdout
+      end
+
+      def branches
+        git("for-each-ref refs/heads/ --format='%(refname:short)'").split("\n")
+      end
+
+      # Example
+      #
+      # git_urls_match?("https://github.com/smoll/loca.git", "https://github.com/smoll/loca/") # note trailing slash
+      # => true
+      def git_urls_match?(git, http)
+        git_uri = Addressable::URI.parse git
+        http_uri = Addressable::URI.parse http
+        http_uri.host == git_uri.host && http_uri.path.chomp("/").chomp(".git") == git_uri.path.chomp("/").chomp(".git")
+      end
+
+      private
+
+      def ensure_git_repo
+        git "rev-parse"
+      end
+
+      def ensure_no_unstashed_files
+        val = git "status --porcelain"
+        fail Loca::Error::UnstashedFilesFound, "Commit or stash your files before continuing!" if non_empty_string?(val)
+      end
+    end
+  end
+end

data/lib/loca/url/parser.rb

@@ -0,0 +1,61 @@
+module Loca
+  module URL
+    class Parser
+      def initialize(url)
+        @url = url
+        @uri = Addressable::URI.parse(@url)
+        @segments = @uri.path.split("/").reject(&:empty?)
+      end
+
+      def to_s
+        @url
+      end
+
+      def parse
+        validate
+        parse_attrs
+        set_other_attrs
+        all_attrs
+      end
+
+      def all_attrs
+        {
+          branch_name: @branch_name,
+          pull: {
+            num: @pull_num,
+            url: @pull_url
+          },
+          remote: {
+            name: @remote_name,
+            url: @remote_url
+          }
+        }
+      end
+
+      private
+
+      def validate
+        Validator.new(@url).validate
+      end
+
+      def parse_attrs
+        @username = @segments[0]
+        @repo_name = @segments[1]
+        @pull_num = @segments[3]
+
+        pull_uri = @uri
+        pull_uri.path = @segments[0..3].join("/")
+        @pull_url = pull_uri.to_s
+
+        remote_uri = @uri
+        remote_uri.path = @segments[0..1].join("/") + ".git"
+        @remote_url = remote_uri.to_s
+      end
+
+      def set_other_attrs
+        @remote_name = "loca_r_#{@username}" # i.e. loca_r_USERNAME
+        @branch_name = "PULL_#{@pull_num}"
+      end
+    end
+  end
+end

data/lib/loca/url/validator.rb

@@ -0,0 +1,45 @@
+module Loca
+  module URL
+    class Validator
+      include Utils
+
+      def initialize(url)
+        @url = url
+        @uri = Addressable::URI.parse(@url)
+        @segments = @uri.path.split("/").reject(&:empty?)
+      end
+
+      def validate
+        return if valid_host? && valid_user_and_repo_segments? && valid_pull_segment? && valid_pull_number?
+        fail Loca::Error::InvalidURL, <<-MSG
+          Not a GitHub PR URL: #{@url}
+          Examples of valid URLs:
+          - https://github.com/smoll/loca/pull/1337
+          - https://github.com/smoll/loca/pull/1337/commits
+          - https://github.com/smoll/loca/pull/1337/files
+        MSG
+      end
+
+      private
+
+      def valid_host?
+        @uri.host == "github.com"
+      end
+
+      def valid_user_and_repo_segments?
+        non_empty_string?(@segments[0]) && non_empty_string?(@segments[1])
+      end
+
+      def valid_pull_segment?
+        @segments[2] == "pull"
+      end
+
+      def valid_pull_number?
+        Integer(@segments[3])
+        true
+      rescue ArgumentError
+        false
+      end
+    end
+  end
+end