cob 0.0.15

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 698e8f72857d8052c532614332d07903b44e4b4da52a85debfcaf46745a3109d
+  data.tar.gz: c88940d9ac79e2bbdce31572d53ab1bb1b465ab680bd835fd69d34e15ac49161
+SHA512:
+  metadata.gz: 3d084dc142c8613fe784d70507705390538a3472271e747212f26699779e8b11656298e03227931be9ad55b0cdf00c52535f7eaf25ff479d8ac1f7a0c922c54b
+  data.tar.gz: 877eb16d44a54f1221d221d6d7e7f3f69347d125be7af500002c0e6093be8bba64212a8a5453bcbd6b2a59f408b7cd9fe2f7f8bfe92bafe5b902ab0b2a1e6cc7

data/bin/cob

@@ -0,0 +1,6 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'cob'
+
+Cob.run(ARGV)

data/lib/cob.rb

@@ -0,0 +1,62 @@
+# !/usr/bin/env ruby
+# frozen_string_literal: true
+
+#
+# _________  ________ __________
+# \_   ___ \ \_____  \\______   \
+# /    \  \/  /   |   \|    |  _/
+# \     \____/    |    \    |   \
+#  \______  /\_______  /______  /
+#         \/         \/       \/
+#
+# The ULTIMATE "cob" tool with a total of 3 distinct usages.
+# examples:
+#   $ cob                                                     # queries github and gives you a list of issues to pick from
+#   $ cob 2837                                                # queries github and checks out the matching issue using "cob" style formating
+#   $ cob "my string with #hashes and, other: . punctuations" # instant cob
+#   $ cob some sentence without special characters            # instant cob
+#
+
+require_relative './git.rb'
+require_relative './local_cob.rb'
+require_relative './string_refinements.rb'
+
+using StringRefinements
+
+module Cob
+  class << self
+    def run(args)
+      @args = args
+
+      if (@args.length == 1 && !@args[0].all_digits?) || @args.length > 1
+        run_local
+        exit 0
+      end
+
+      run_remote
+    rescue Interrupt
+      exit 1
+    end
+
+    private
+
+    def run_local
+      LocalCOB.run
+    end
+
+    def run_remote
+      require 'json'
+      require 'fileutils'
+      require 'tty-prompt'
+      require_relative './credentials.rb'
+      require_relative './paginator.rb'
+      require_relative './navigator.rb'
+      require_relative './remote_cob.rb'
+
+      RemoteCOB::Selection.run && exit(0) if @args.empty?
+      RemoteCOB::Fire.run      && exit(0) if @args.length == 1
+    rescue Interrupt
+      exit 1
+    end
+  end
+end

data/lib/credentials.rb

@@ -0,0 +1,83 @@
+# frozen_string_literal: true
+
+#
+# class to handle the credentials
+#
+# usage:
+#
+# c = Credentials.new
+# c.username
+# c.pa_token
+#
+class Credentials
+  def initialize
+    @config_file = ENV['GITHUB_CREDENTIALS_FILE'] ||
+                   "#{ENV['HOME']}/.cob/github_credentials.json"
+    @config = parse_config
+  end
+
+  def username
+    # USERNAME
+    @config['username'] || prompt_username
+  end
+
+  def pa_token
+    # PA_TOKEN
+    @config['paToken'] || prompt_pa_token
+  end
+
+  def overwrite_config
+    File.write(@config_file, @config.to_json)
+  end
+
+  def prompt_username
+    prompt = TTY::Prompt.new(active_color: :cyan)
+    username = prompt.ask('What is your github username?') do |q|
+      q.required true
+      q.modify   :lowercase
+    end
+
+    @config['username'] = username
+    overwrite_config
+
+    username
+  end
+
+  def prompt_pa_token
+    prompt = TTY::Prompt.new(active_color: :cyan)
+    token = prompt.ask('What is your github personal access token? You can get one from here: https://github.com/settings/tokens') do |q|
+      q.required true
+    end
+
+    @config['paToken'] = token
+    overwrite_config
+
+    token
+  end
+
+  def reset_config_file
+    File.write(@config_file, '{}')
+  end
+
+  def ensure_config_file_is_created
+    return if File.exist?(@config_file)
+
+    segments = @config_file.split('/')
+    paths    = segments[0..-2]
+    file     = segments[-1]
+    dir      = paths.join('/')
+    FileUtils.mkdir_p(dir)
+    FileUtils.touch(dir + '/' + file)
+
+    reset_config_file
+  end
+
+  private
+
+  def parse_config
+    JSON.parse(File.read(@config_file))
+  rescue StandardError => e
+    puts "Couldn't parse config file. Make sure the JSON is  correct:\n#{@config_file}"
+    raise e
+  end
+end

data/lib/git.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+# this class interfaces with the local `git` command
+module Git
+  class << self
+    def remote
+      `git config --list | grep remote.origin.url`&.strip&.split(':')&.last
+    end
+
+    def repository
+      remote.split('/').last.chomp('.git')
+    end
+
+    def repository_owner
+      remote.split('/').first
+    end
+
+    def checkout_branch(text)
+      branch = text.downcase.gsub(/[^a-zA-Z0-9#]+/, '_')
+      output = `git checkout -b #{branch} 2>&1`
+
+      if output.match?(/A branch named '#{branch}' already exists/)
+        `git checkout #{branch}`
+      end
+    end
+  end
+end

data/lib/local_cob.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+#  _                 _    ___ ___  ___
+# | |   ___  __ __ _| |  / __/ _ \| _ )
+# | |__/ _ \/ _/ _` | | | (_| (_) | _ \
+# |____\___/\__\__,_|_|  \___\___/|___/
+#
+#
+# This is the original COB
+#
+module LocalCOB
+  def self.run
+    Git.checkout_branch(ARGV.join(' '))
+  end
+end

data/lib/navigator.rb

@@ -0,0 +1,64 @@
+# frozen_string_literal: true
+
+# this class prompts the user for selection and shows "next..." and "prev..."
+# when the user can navigate to the next/prev pages.
+class Navigator
+  def initialize(paginator)
+    @paginator = paginator
+    @active_index = 1
+  end
+
+  def prompt_for_issue_selection
+    prompt = TTY::Prompt.new(active_color: :cyan)
+
+    if @paginator.no_issues?
+      puts 'No issues found.'
+      exit 0
+    end
+
+    @selected_index = prompt.select('Select issue:') do |menu|
+      menu.default @active_index
+
+      items.each.with_index(1) do |item, i|
+        menu.choice item.to_s, i
+      end
+    end
+
+    handle_selection
+  end
+
+  def items
+    ii = @paginator.formatted_issues
+    ii = ['prev...'] + ii if show_prev?
+    ii += ['next...'] if show_next?
+    ii
+  end
+
+  private
+
+  def show_prev?
+    @paginator.prev?
+  end
+
+  def show_next?
+    @paginator.next?
+  end
+
+  def handle_selection
+    choice = items[@selected_index - 1]
+
+    return choice unless ['next...', 'prev...'].include? choice
+
+    if choice == 'next...'
+      @paginator.inc
+      @active_index = 1
+    end
+
+    if choice == 'prev...'
+      @paginator.dec
+      @active_index = [items.count, 1].max
+    end
+
+    prompt_for_issue_selection
+  end
+end

data/lib/paginator.rb

@@ -0,0 +1,74 @@
+# frozen_string_literal: true
+
+# this class fetches and paginates the issues from github.com
+class Paginator
+  attr_reader :page
+
+  def initialize(credentials)
+    @credentials = credentials
+    @page = 1
+    @cache = {}
+    @next = {}
+  end
+
+  def issues
+    @cache[@page] ||= begin
+      issues = fetch_issues
+      @next[@page] = issues.count.positive?
+      issues
+    end
+  end
+
+  def no_issues?
+    @page == 1 && issues.empty?
+  end
+
+  def next?
+    issues && @next[@page]
+  end
+
+  def prev?
+    @page > 1
+  end
+
+  def format_issue(issue)
+    "#{issue['number']} --- #{issue['title']}"
+  end
+
+  def formatted_issues
+    issues.map { |i| format_issue(i) }
+  end
+
+  def dec
+    @page = [@page - 1, 1].max
+  end
+
+  def inc
+    @page += 1
+  end
+
+  private
+
+  def fetch_issues
+    _header, body = http_get_issues.split("\r\n\r\n")
+    data = JSON.parse(body)
+
+    # TODO: move elsewhere
+    if data.is_a?(Hash) && data['message'] == 'Bad credentials'
+      puts 'Your github credentials are wrong.'
+
+      @credentials.reset_config_file
+      exit 1
+    end
+
+    data.select { |i| i['pull_request'].nil? } # ignore pull requests
+  end
+
+  def http_get_issues
+    uname = @credentials.username
+    token = @credentials.pa_token
+    `curl -sS -i https://api.github.com/repos/#{Git.repository_owner}/#{Git.repository}/issues?page=#{@page} \
+          -u "#{uname}:#{token}" \
+          -H "Content-Type: application/json"`
+  end
+end

data/lib/remote_cob.rb

@@ -0,0 +1,61 @@
+# frozen_string_literal: true
+
+#
+#  ___               _          ___ ___  ___
+# | _ \___ _ __  ___| |_ ___   / __/ _ \| _ )
+# |   / -_) '  \/ _ \  _/ -_) | (_| (_) | _ \
+# |_|_\___|_|_|_\___/\__\___|  \___\___/|___/
+#
+#
+# this module contain the remote commands
+module RemoteCOB
+  def self.ensure_credentials_and_remote
+    Credentials.new.ensure_config_file_is_created
+
+    unless Git.remote
+      puts 'could not find remote git repository'
+      exit 1
+    end
+
+    unless Git.repository_owner && Git.repository
+      puts "couldn't retreive repo and owner from remote: #{remote}"
+      exit 1
+    end
+  end
+
+  # This is the code for querying github issues and displaying
+  # a select prompt to the user
+  module Selection
+    def self.run
+      RemoteCOB.ensure_credentials_and_remote
+      paginator = Paginator.new(Credentials.new)
+      issue = Navigator.new(paginator).prompt_for_issue_selection
+      Git.checkout_branch(issue)
+    end
+  end
+
+  # This is the code for automatically checking out the matching issue in github
+  module Fire
+    def self.run
+      RemoteCOB.ensure_credentials_and_remote
+      issue_number = ARGV[0].to_i
+      paginator = Paginator.new(Credentials.new)
+
+      while paginator.next?
+        issue = paginator.issues.detect { |i| i['number'] == issue_number }
+
+        if issue
+          Git.checkout_branch(paginator.format_issue(issue))
+          exit 0
+        end
+
+        puts "couldn't find issue on page: #{paginator.page}, fetching next..."
+
+        paginator.inc
+      end
+
+      puts "couldn't find issue on github."
+      exit 1
+    end
+  end
+end

data/lib/string_refinements.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module StringRefinements
+  refine String do
+    def all_digits?
+      scan(/\D/).empty?
+    end
+  end
+end

data/lib/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module Cob
+  VERSION = '0.0.15'
+end

metadata

@@ -0,0 +1,95 @@
+--- !ruby/object:Gem::Specification
+name: cob
+version: !ruby/object:Gem::Version
+  version: 0.0.15
+platform: ruby
+authors:
+- Yan
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2019-09-03 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: fileutils
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.2'
+- !ruby/object:Gem::Dependency
+  name: tty-prompt
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.19.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.19.0
+description: Format and checkout your branches
+email: yan@shiyason.com
+executables:
+- cob
+extensions: []
+extra_rdoc_files: []
+files:
+- bin/cob
+- lib/cob.rb
+- lib/credentials.rb
+- lib/git.rb
+- lib/local_cob.rb
+- lib/navigator.rb
+- lib/paginator.rb
+- lib/remote_cob.rb
+- lib/string_refinements.rb
+- lib/version.rb
+homepage: https://github.com/yanshiyason/cob
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.3
+signing_key: 
+specification_version: 4
+summary: Checkout github branches with style
+test_files: []