jive 0.4.0 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 154a09fc65037768dd5356b9b09c02f2f25f8548be75663893e6867922d0f0d1
-  data.tar.gz: 9fa27240f2f7e0f009f271e95606ac3c162b8836fa5cf4b79b31ef79271bcf2d
+  metadata.gz: 907ad4223ef1469a013283c0dc7c781e27ee5da0b4cb0ee6e3b7b9651cb4d986
+  data.tar.gz: 9bae7e21dc61f89d4272896280673e28e687f3f88d98ecddea1918f8bad92c3d
 SHA512:
-  metadata.gz: 3dffd40c02972768c156c6755b9f01af441ae64dc715f27fd515ed10f0a4d849c5c69919129dffaf82a68f052a0950693e4613c1d035c7d8ec318a35651b72fa
-  data.tar.gz: 5931d35f12bb6bd418ad4ac732992e3674c6dfb2dd7eec34e0691440fa4c279d3636dcd3a59564c794e5c35bf120a5839bb6436cd75dfa81a63d36bef927f094
+  metadata.gz: 51b4173ac6ad187e61f911418fc022d664d93ced8c540e59c6fb73cdcded37531d223160902227f95fcf2b5fb559ec73fedb42f517090d111672c035c9f82adc
+  data.tar.gz: 9a25ed11f67d138d940f0dcc0c3b294f99115a9cf8ebd0a725379435d8faf7fbd9fd1bd54d236b1ea63d2883f5188946e9cd05c2c95aca54ce48ff6cb1e35577

data/exe/jive

@@ -3,4 +3,13 @@
 
 require "jive/cli"
 
-::Jive::Cli::App.start(ARGV)
+Signal.trap("INT") do
+  exit 1
+end
+
+begin
+  ::Jive::Cli::App.start(ARGV)
+rescue StandardError => e
+  puts "ERROR: #{e.message}"
+  exit 1
+end

data/jive.gemspec

@@ -30,6 +30,8 @@ Gem::Specification.new do |spec|
       $ jive setup
   MESSAGE
 
+  spec.add_dependency "cli-ui", "~> 1.5"
+  spec.add_dependency "rugged", "~> 1.1"
   spec.add_dependency "thor", "~> 1.1"
   spec.add_development_dependency "minitest", "~> 5.0"
   spec.add_development_dependency "rake", "~> 13.0"

data/lib/jive.rb

@@ -2,13 +2,17 @@
 
 require "fileutils"
 require "open3"
+require "rugged"
+require "uri"
 
 require "jive/batch_runner"
 require "jive/docker"
 require "jive/git"
+require "jive/issue"
 require "jive/popen"
 require "jive/project"
 require "jive/pull_request"
+require "jive/repo"
 require "jive/runner"
 require "jive/shell"
 require "jive/version"
@@ -27,4 +31,18 @@ module Jive
   def self.shell
     @shell ||= ::Jive::Shell.new
   end
+
+  def self.home
+    @home ||= Pathname(Dir.home).join(".jive")
+  end
+
+  def self.prompt?(items, display: ->(x) { x })
+    CLI::UI::Prompt.ask("Choose?") do |handler|
+      items.each do |item|
+        handler.option(display.call(item)) do |_selection|
+          return item
+        end
+      end
+    end
+  end
 end

data/lib/jive/cli.rb

@@ -1,5 +1,6 @@
 # frozen_string_literal: true
 
+require "cli/ui"
 require "pathname"
 require "thor"
 require "yaml"
@@ -52,6 +53,22 @@ module Jive
         end
       end)
 
+      desc "issue SUBCOMMAND ...ARGS", "issue things"
+      subcommand "issue", (Class.new(Thor) do
+        desc "list <type>", "List the issues"
+        def list(type = Issue.what_type?)
+          issues = Issue.for(type)
+          issue = Jive.prompt?(issues, display: ->(x) { x.file_name })
+          issue.edit
+        end
+
+        desc "create <type>", "Create a new issue"
+        def create(type = Issue.what_type?)
+          issue = Issue.create!(name: ask("Name:"), type: type)
+          issue.edit
+        end
+      end)
+
       desc "cd <org>/<project>", "cd to ~/src/github.com/<org>/<project>"
       def cd(slug)
         Jive.shell.run_safely { Git.new(Jive.shell).cd(slug) }
@@ -74,9 +91,9 @@ module Jive
           .bootstrap(Jive.shell)
       end
 
-      desc "pr URL", "pull request"
-      def pr(url)
-        pr = PullRequest.new(url)
+      desc "pr", "pull request"
+      def pr
+        pr = PullRequest.new(repo: Repo.current)
         pr.edit(ENV["EDITOR"])
       end
 

data/lib/jive/issue.rb

@@ -0,0 +1,67 @@
+# frozen_string_literal: true
+
+module Jive
+  class Issue
+    class << self
+      def what_type?
+        Jive.prompt?(
+          Jive.root
+            .join("lib/jive/templates")
+            .glob("*.md")
+            .map { |x| x.basename.to_s.gsub(".md", "") }
+        )
+      end
+
+      def create!(name:, type:, repo: Repo.current)
+        new(repo: repo, name: name, type: type)
+      end
+
+      def for(type, repo: Repo.current)
+        dir_for(type, repo: repo).glob("*.md").map do |x|
+          name = x.basename.to_s.gsub(".md", "")
+          new(repo: repo, name: name, type: type)
+        end
+      end
+
+      def dir_for(type, repo: Repo.current)
+        Jive.home
+            .join(repo.uri.host)
+            .join(repo.nwo)
+            .join(type)
+      end
+    end
+
+    def initialize(name:, type:, repo: Repo.current)
+      @repo = repo
+      @type = type
+      @name = name
+    end
+
+    def file_name
+      "#{name.gsub(/[^a-z0-9\-_]+/i, "-").downcase}.md"
+    end
+
+    def edit(editor: ENV["EDITOR"])
+      Jive.shell.execute([editor, issue.to_s])
+    end
+
+    private
+
+    attr_reader :repo, :name, :type
+
+    def issue
+      @issue ||=
+        begin
+          dir = self.class.dir_for(type, repo: repo)
+          Jive.shell.execute([:mkdir, "-p", dir])
+          dir.join(file_name).tap do |file|
+            file.write(template_for(type).read) unless file.exist?
+          end
+        end
+    end
+
+    def template_for(type)
+      Jive.root.join("lib/jive/templates/#{type}.md")
+    end
+  end
+end

data/lib/jive/pull_request.rb

@@ -4,9 +4,8 @@ module Jive
   class PullRequest
     attr_reader :dir, :uri
 
-    def initialize(url)
-      @uri = URI.parse(url)
-      @dir = Pathname(Dir.home).join(".jive").join(uri.host).join(uri.path[1..-1])
+    def initialize(repo: Repo.current)
+      @dir = Jive.home.join(repo.uri.host).join(repo.branch)
       Jive.shell.execute([:mkdir, "-p", @dir]) unless @dir.exist?
     end
 
@@ -17,7 +16,7 @@ module Jive
     private
 
     def template
-      Jive.root.join("lib/jive/templates/pull_request_template.md")
+      Jive.root.join("lib/jive/templates/pull_request.md")
     end
 
     def readme

data/lib/jive/repo.rb

@@ -0,0 +1,59 @@
+# frozen_string_literal: true
+
+module Jive
+  class Repo
+    SSH_REGEX = %r{\Agit@(?<host>.+):(?<account>.+)/(?<repo>.+)\z}.freeze
+
+    def initialize(path)
+      @repo = Rugged::Repository.new(path.to_s)
+    end
+
+    def uri
+      @uri ||= URI.parse(canonical_url)
+    end
+
+    def canonical_url
+      remote = @repo.remotes.find { |x| x.name == "origin" }
+      return if remote.nil?
+
+      ssh?(remote) ? url_for_ssh(remote) : url_for(remote)
+    end
+
+    def nwo
+      segments = uri.path.split("/")
+      "#{segments[1]}/#{segments[2].gsub(".git", "")}"
+    end
+
+    def branch
+      uri.path[1..-1]
+    end
+
+    class << self
+      def current
+        @current ||= new(Pathname.pwd)
+      end
+    end
+
+    private
+
+    def ssh?(remote)
+      remote.url.match?(SSH_REGEX)
+    end
+
+    def url_for_ssh(remote)
+      match = remote.url.match(SSH_REGEX)
+      [
+        "https:/",
+        match[:host],
+        match[:account],
+        match[:repo],
+        @repo.head.name
+      ].join("/")
+    end
+
+    def url_for(remote)
+      uri = URI.parse(remote.url)
+      [uri.host, uri.path, @repo.head.name].join("/")
+    end
+  end
+end

data/lib/jive/shell.rb

@@ -6,7 +6,7 @@ module Jive
       cd: "/usr/bin/cd",
       echo: "/usr/bin/echo",
       git: "/usr/bin/git",
-      mkdir: "/usr/bin/mkdir"
+      mkdir: "/bin/mkdir"
     }.freeze
 
     def run_each(tasks)

data/lib/jive/templates/bug.md

@@ -0,0 +1,45 @@
+---
+title: "Defect Template"
+description: |
+---
+
+### Summary
+
+<!-- Summarize the defect encountered concisely. -->
+
+### Steps to reproduce
+
+<!--
+Describe how one can reproduce the issue - this is very important.
+Please use an ordered list.
+-->
+
+### Example Project
+
+<!--
+Please create an example project here on GitHub.com that exhibits the problematic
+behavior, and link to it here in the bug report.
+
+If you are using an older version of GitHub.com,
+this will also determine whether the bug is fixed
+in a more recent version.
+-->
+
+### What is the current *bug* behavior?
+
+<!-- Describe what actually happens. -->
+
+### What is the expected *correct* behavior?
+
+<!-- Describe what you should see instead. -->
+
+### Relevant logs and/or screenshots
+
+<!--
+Paste any relevant logs - please use code blocks (```) to format console output,
+logs, and code.
+-->
+
+### Possible fixes
+
+<!-- If you can, link to the line of code that might be responsible for the problem. -->

data/lib/jive/templates/feature.md

@@ -0,0 +1,49 @@
+---
+title: "Feature Template"
+description: |
+  This is used to break-up a large piece of work into smaller,
+  discrete tasks that can move independently through the build workflow steps.
+---
+
+As a `[persona]`, I `[want to]`, so that `[goal]`.
+
+# Why are we doing this work?
+
+<!--
+A brief explanation of the why, not the what or how.
+Assume the reader doesn't know the background and won't have time to dig-up
+information from comment threads.
+-->
+
+# Tasks
+
+<!--
+Steps and the parts of the code that will need to get updated.
+The plan can also call-out responsibilities for other team members or teams.
+
+e.g.:
+
+- [ ] ~frontend Step 1
+  - [ ] `@person` Step 1a
+- [ ] ~frontend Step 2
+- [ ] ~backend Step 3
+-->
+
+# Relevant links
+
+<!--
+Information that developers might need to refer to when implementing the issue.
+
+- [Design Issue](https://github.com/xlgmokha/project/issues/<id>)
+- [Similar implementation](https://github.com/xlgmokha/project/pull/<id>)
+-->
+
+# Non-functional requirements
+
+<!-- Add details for required items and delete others. -->
+
+- [ ] Documentation:
+- [ ] Feature flag:
+- [ ] Observability:
+- [ ] Performance:
+- [ ] Testing:

data/lib/jive/templates/{pull_request_template.md → pull_request.md}

@@ -1,6 +1,15 @@
-# Pull Request Template
+---
+title: "Pull Request Template"
+checklist:
+- [ ] Clear description explaining the relevancy of the contribution.
+- [ ] Unit, integration, and system tests.
+- [ ] Regression and bugs are covered with tests.
+- [ ] [Performance guidelines](https://docs.gitlab.com/ee/development/merge_request_performance_guidelines.html)
+- [ ] [Secure coding guidelines](https://docs.gitlab.com/ee/development/secure_coding_guidelines.html)
+- [ ] Documentation Updated
+---
 
-## Why is this needed?
+# Why is this needed?
 
 ## What does this do?
 
@@ -16,15 +25,15 @@ Fixes # (issue)
 
 Before:
 
-![before]()
+![Before][before]
 
 After:
 
-![after]()
+![After][after]
 
 ## Type of change
 
-Delete options that are not relevant.
+<!-- Delete options that are not relevant. -->
 
 - [ ] Bug fix (non-breaking change which fixes an issue)
 - [ ] New feature (non-breaking change which adds functionality)
@@ -33,19 +42,10 @@ Delete options that are not relevant.
 
 ## Verification Plan
 
-How are we going to verify this change?
+<!-- How are we going to verify this change? -->
 
 - [ ] Step 1
 - [ ] Step 2
 
-## Checklist
-
-- [ ] Clear description explaining the relevancy of the contribution.
-- [ ] Unit, integration, and system tests.
-- [ ] Regression and bugs are covered with tests.
-- [ ] [Performance guidelines][performance]
-- [ ] [Secure coding guidelines][secure]
-- [ ] Documentation Updated
-
-[performance]: https://docs.gitlab.com/ee/development/merge_request_performance_guidelines.html
-[secure]: https://docs.gitlab.com/ee/development/secure_coding_guidelines.html
+[after]: https://user-images.githubusercontent.com/x/y.png
+[before]: https://user-images.githubusercontent.com/x/y.png

data/lib/jive/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Jive
-  VERSION = "0.4.0"
+  VERSION = "0.5.0"
 end

metadata

@@ -1,15 +1,43 @@
 --- !ruby/object:Gem::Specification
 name: jive
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.5.0
 platform: ruby
 authors:
 - mo khan
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-02-28 00:00:00.000000000 Z
+date: 2021-05-14 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: cli-ui
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+- !ruby/object:Gem::Dependency
+  name: rugged
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
 - !ruby/object:Gem::Dependency
   name: thor
   requirement: !ruby/object:Gem::Requirement
@@ -112,12 +140,16 @@ files:
 - lib/jive/cli.rb
 - lib/jive/docker.rb
 - lib/jive/git.rb
+- lib/jive/issue.rb
 - lib/jive/popen.rb
 - lib/jive/project.rb
 - lib/jive/pull_request.rb
+- lib/jive/repo.rb
 - lib/jive/runner.rb
 - lib/jive/shell.rb
-- lib/jive/templates/pull_request_template.md
+- lib/jive/templates/bug.md
+- lib/jive/templates/feature.md
+- lib/jive/templates/pull_request.md
 - lib/jive/version.rb
 homepage: https://rubygems.org/gems/jive
 licenses: