waff 0.0.6 → 0.0.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ae6ede544fb5577239ae319898d03cbe1842fa98121e5aca07115987c5ec10a1
-  data.tar.gz: 90868e9d22cdc6cf444670512b84c41a2a7680426e91d66609ee0bec8c156315
+  metadata.gz: fed6162bd8143677a6666794272da27f47d5de3213b47b7bfcd5c816aa3a2fc3
+  data.tar.gz: 51fcdc741473a3043d811fc86343e3c4b1169d469c37a9a20d2d09993a34f6d9
 SHA512:
-  metadata.gz: bc7a20506959df2ac67dd68b95f46d93df12eb261bf1c534019fd23ca360fa39795175aa5c91a9bee401b0616d560ecc7e4ea658a9810afc223b89d20d6d7df4
-  data.tar.gz: 7a9ae012e20fb29ff6877b1df1cc6d1f63c49eea1dafe370b72813a826fde0dd3903c3b944734fcd748ce0db5aab84a8ece5390982c2034dbefa31796fec2b82
+  metadata.gz: 1c19509871fd2a69b952ad3593e58077b1b1cc43cea83108a44878a642a358a5fde0245ad71eee02e696630be41da687d9ec4d8fcb66efa4491993141f2a3403
+  data.tar.gz: 5ebbf2d157631ecd5806bfe8c6d713c50beab73e3fef6de37e395581b50bf059b6c9cba2f4dd4db86e6e95238a04de0b36b5745750112c22097e1944c574b4ec

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    waff (0.0.6)
+    waff (0.0.7)
       httparty (~> 0.16)
 
 GEM

data/README.md

@@ -0,0 +1,37 @@
+Welcome! `waff` is a tool that hopes to aid with github flow, specifically based on the style of Waffle.
+
+The goal is to be able to see what you are working on, see what's ready to be taken, take tasks and submit them from the command line,
+with as little work as possible.
+
+### Installation
+```
+gem install waff
+waff
+```
+It will prompt you for your github username and your personal access token. You can create one [here](https://github.com/settings/tokens/new). It just needs the `repo` access.
+
+Optionally you can set up the remote name to be used, with `origin` as default. This will create the local config file .waff.yml
+
+### Features
+
+#### List ready and in-progress issues
+`waff list`
+
+#### Show the information of a given issue
+`waff show` will try to infer the current issue from the current branch name (i.e 827-do-something => issue #827)
+
+`waff show 123` will show info of issue 123.
+
+#### Take an issue
+`waff take 123` will do the following stuff:
+* Set the issue with the `in progress` label, moving it to the progress column in waffle
+* assign yourself as assignee
+* create a branch named `123-issue-title-slug`, starting from the current branch. Normally you want to run this from master branch.
+
+#### Open an issue in the browser
+`waff open 123` will open the browser on issue 123
+
+`waff open` will open the browser on current issue
+
+#### Pause an issue
+`waff pause 123` will put the issue back in the `ready` column, but won't unassign you from it.

data/lib/waff/commander.rb

@@ -16,6 +16,8 @@ module Waff
           Commands::List.call(params)
         when 'show'
           Commands::Show.call(params)
+        when 'open'
+          Commands::Open.call(params)
         else
           puts HELP_TEXT
         end

data/lib/waff/commands/list.rb

@@ -4,8 +4,7 @@ module Waff
   module Commands
     class List < Command
       def call params
-        ready_issues = github_repo.get_open_issues 'ready'
-        ready_issues += github_repo.get_open_issues 'to do'
+        ready_issues = github_repo.get_open_issues Config.ready_label
         puts "Ready: \n\n"
         ready_issues.each do |issue|
           puts "##{issue.number}\t #{issue.title}"

data/lib/waff/commands/open.rb

@@ -0,0 +1,22 @@
+require_relative 'command'
+require_relative '../os'
+
+module Waff
+  module Commands
+    class Open < Command
+      def call params
+        issue_number = params.shift || LocalRepository.current_issue_number
+        issue_number || raise('No issue number given as argument or found as current branch')
+
+        open_in_browser github_repo.issue_url(issue_number)
+      end
+
+      private
+
+      def open_in_browser url
+        `xdg-open #{url}` if OS.linux?
+        `open #{url}` if OS.mac?
+      end
+    end
+  end
+end

data/lib/waff/config.rb

@@ -22,23 +22,35 @@ module Waff
         url[/:(.*)\.git/, 1] || raise(REMOTE_NOT_FOUND)
       end
 
+      def ready_label
+        config['ready_label'] || 'to do'
+      end
+
       def init_config!
         return if File.exist?(CONFIG_FILE)
 
         puts "No config file detected (#{CONFIG_FILE}). Will generate one now in current directory."
+
         print 'Github username: '
         user = $stdin.gets
+
         print 'Github password/personal token: '
         token = $stdin.gets
+
         print 'Git remote (leave empty for "origin"): '
         remote = $stdin.gets.strip
         remote = remote.empty? ? 'origin' : remote
 
+        print 'Ready label (leave empty for "to do"): '
+        ready_label = $stdin.gets.strip
+        ready_label = ready_label.empty? ? 'to do' : ready_label
+
         # Write config file
         File.open(CONFIG_FILE, 'w') do |file|
           file.puts "user: #{user}"
           file.puts "token: #{token}"
           file.puts "remote: #{remote}"
+          file.puts "ready_label: #{ready_label}"
         end
 
         # Write exclude file

data/lib/waff/issue.rb

@@ -21,17 +21,17 @@ module Waff
     end
 
     def mark_in_progress!
-      labels.delete 'ready'
-      labels.delete 'to do'
+      labels.delete Config.ready_label
       labels << 'in progress'
+      labels.uniq!
 
       repository.export_labels self
     end
 
     def mark_ready!
-      labels << 'ready'
-      labels << 'to do'
+      labels << Config.ready_label
       labels.delete 'in progress'
+      labels.uniq!
 
       repository.export_labels self
     end

data/lib/waff/os.rb

@@ -0,0 +1,17 @@
+module OS
+  def OS.windows?
+    (/cygwin|mswin|mingw|bccwin|wince|emx/ =~ RUBY_PLATFORM) != nil
+  end
+
+  def OS.mac?
+   (/darwin/ =~ RUBY_PLATFORM) != nil
+  end
+
+  def OS.unix?
+    !OS.windows?
+  end
+
+  def OS.linux?
+    OS.unix? and not OS.mac?
+  end
+end

data/lib/waff/repository.rb

@@ -11,7 +11,7 @@ module Waff
     end
 
     def get_issue(number)
-      response = self.class.get github_url ['issues', number]
+      response = self.class.get(github_api_url ['issues', number])
 
       if response.success?
         Issue.new(self, response.parsed_response)
@@ -21,8 +21,12 @@ module Waff
       end
     end
 
+    def issue_url(number)
+      github_url ['issues', number]
+    end
+
     def assign_issue(number)
-      url = github_url ['issues', number, 'assignees']
+      url = github_api_url ['issues', number, 'assignees']
       response = self.class.post url, body: { assignees: [@user] }.to_json
       if response.success?
         puts "Successfully assigned issue ##{number} to #{@user}."
@@ -33,7 +37,7 @@ module Waff
     end
 
     def export_labels issue
-      url = github_url ['issues', issue.number, 'labels']
+      url = github_api_url ['issues', issue.number, 'labels']
       response = self.class.put url, body: issue.labels.to_json
       if response.success?
         puts "Successfully assigned #{issue.labels.inspect} labels to  ##{issue.number}"
@@ -44,7 +48,7 @@ module Waff
     end
 
     def get_open_issues label
-      response = self.class.get github_url(['issues']), query: { labels: label }
+      response = self.class.get github_api_url(['issues']), query: { labels: label }
 
       if response.success?
         issues_data = response.parsed_response
@@ -58,9 +62,14 @@ module Waff
 
     private
 
-    def github_url(nodes)
+    def github_api_url(nodes)
       subpath = nodes.join '/'
       "https://api.github.com/repos/#{@owner_and_repo}/" + subpath
     end
+
+    def github_url(nodes)
+      subpath = nodes.join '/'
+      "https://github.com/#{@owner_and_repo}/" + subpath
+    end
   end
 end

data/lib/waff/version.rb

@@ -1,3 +1,3 @@
 module Waff
-  VERSION = '0.0.6'.freeze
+  VERSION = '0.0.7'.freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: waff
 version: !ruby/object:Gem::Version
-  version: 0.0.6
+  version: 0.0.7
 platform: ruby
 authors:
 - Armando Andini
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-07-30 00:00:00.000000000 Z
+date: 2018-08-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httparty
@@ -34,17 +34,20 @@ extra_rdoc_files: []
 files:
 - Gemfile
 - Gemfile.lock
+- README.md
 - bin/waff
 - lib/waff.rb
 - lib/waff/commander.rb
 - lib/waff/commands/command.rb
 - lib/waff/commands/list.rb
+- lib/waff/commands/open.rb
 - lib/waff/commands/pause.rb
 - lib/waff/commands/show.rb
 - lib/waff/commands/take.rb
 - lib/waff/config.rb
 - lib/waff/issue.rb
 - lib/waff/local_repository.rb
+- lib/waff/os.rb
 - lib/waff/repository.rb
 - lib/waff/version.rb
 - waff.gemspec