sync_issues 0.5.0 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e6ec2a1e421c8518f79623a00467957940783a15
-  data.tar.gz: 36447ea778835cca858463eeeec3e633b03c1ed0
+  metadata.gz: 44337f4aa3175ff1ba7e15f4583309ce034a251a
+  data.tar.gz: 29027fe887bb51d2412cf2fc9c4bba32d482b7db
 SHA512:
-  metadata.gz: fd6ca399baa4a34133cca84e434b129b07b9c9b9f478ae5d6f9b3d8c9a929a2267864a51625375471369c67dbdb0145d299f5f6a7f22d98ab041153894e2c562
-  data.tar.gz: 905384ce86b6e966b01b474750705d130d9379be3f01ef910e3567f964e390defeba6897f89e69225b0466fa37645e1200a7f75bcbc51106e892c9f1ec2db50a
+  metadata.gz: 9049e78d7fc5c02cfe7783d2f7676d3049218d627adf02dea2696da59b93f332277936d879b5b84cd78b614c54485a28ed02060ebdca11e33dd0923a104396d7
+  data.tar.gz: 120b8502dcb8ec42c1679ad735e0f80f2b2964ed4a491120ed7fba6cd3474e89b7fe006e618e228d28cb22496b5ea148a9472c3e5a725bfdbd21d4f23c3ccb71

data/README.md

@@ -65,6 +65,36 @@ The frontmatter of an issue file can contain the following attributes:
 * __assignee__: (optional) Assign or reassign the issue to the github username
   specified. Existing assignee will not be removed on sync if the field is not
   provided.
-* __label__: (optional) Set the labels of the issue to this comma-separated
-  string of issues. Existing labels will not be cleared on sync when the field
-  is not provided.
+* __labels__: (optional) When provided and the issue does not have any labels
+  this list of labels will be added to the issue. Labels will be dynamically
+  created with the default grey color if they don't already exist on the
+  repository. If you desire to reset the labels for each issue, run
+  ``sync_issues`` with the ``--reset-labels`` flag.
+
+## Synchronizing Labels
+
+A path to a yaml file can be provided to synchronize labels on a
+repository. This path is provided like so:
+
+    sync_issues --labels yaml_file.yml task_directory org/repo
+
+The yaml file can contain two attributes:
+
+* __keep_existing__: (optional) When ``false`` (default ``true``) all labels
+  that aren't in ``labels`` will be deleted. Set to ``false`` and provide no
+  labels to clear all labels.
+* __labels__: (optional) A mapping of label names to their 6-character
+  hexidecimal color code without a `#` prefix. Color codes that contain only
+  numeric digits, e.g., `000000`, must be contained within quotes.
+
+### Example labels yaml file
+
+```yaml
+keep_existing: false
+labels:
+  in progress: bfe5bf
+  merged: "009800"
+  unstarted: fef2c0
+  waiting on developer: f7c6c7
+  waiting on reviewer: fad8c7
+```

data/lib/sync_issues/command.rb

@@ -18,7 +18,10 @@ module SyncIssues
     Options:
       -h --help       Output this help information.
       -u --update     Only update existing issues.
+      --labels FILE   A yaml file listing labels that are to be available.
       --no-assignees  Do not synchronize assignees.
+      --no-labels     Do not synchronize labels.
+      --reset-labels  Reset labels on a per-issue basis.
       --version       Output the sync_issues version (#{VERSION}).
     DOC
 
@@ -46,9 +49,19 @@ module SyncIssues
 
     def handle_args(options)
       SyncIssues.synchronizer(options['DIRECTORY'], options['REPOSITORY'],
+                              label_yaml: read_file(options['--labels']),
+                              reset_labels: options['--reset-labels'],
                               sync_assignees: !options['--no-assignees'],
+                              sync_labels: !options['--no-labels'],
                               update_only: options['--update']).run
       @exit_status
     end
+
+    def read_file(filename)
+      return nil if filename.nil?
+      File.read(filename)
+    rescue Errno::ENOENT
+      raise Error, "not found: #{filename}"
+    end
   end
 end

data/lib/sync_issues/comparison.rb

@@ -3,15 +3,16 @@ require_relative 'error'
 module SyncIssues
   # Comparison represents differences between Issues (local and GitHub)
   class Comparison
-    attr_reader :assignee, :changed, :content, :title
+    attr_reader :assignee, :changed, :content, :labels, :title
 
-    def initialize(issue, github_issue, sync_assignee)
+    def initialize(issue, github_issue, reset_labels: false,
+                   sync_assignee: true, sync_labels: true)
       @changed = []
       @assignee = github_issue.assignee && github_issue.assignee.login
       @content = github_issue.body
-      @sync_assignee = sync_assignee
+      @labels = github_issue.labels.map { |label| label[:name] }
       @title = github_issue.title
-      compare(issue)
+      compare(issue, reset_labels, sync_assignee, sync_labels)
     end
 
     def changed?
@@ -20,11 +21,15 @@ module SyncIssues
 
     private
 
-    def compare(issue)
-      if @sync_assignee && issue.assignee != @assignee
+    def compare(issue, reset_labels, sync_assignee, sync_labels)
+      if sync_assignee && issue.assignee != @assignee
         @changed << 'assignee'
         @assignee = issue.assignee
       end
+      if sync_labels && update_label?(issue, reset_labels)
+        @changed << 'labels'
+        @labels = issue.labels
+      end
       unless issue.new_title.nil?
         @changed << 'title'
         @title = issue.new_title
@@ -38,5 +43,15 @@ module SyncIssues
       second.delete!("\r")
       first.gsub(/\[x\]/, '[ ]') == second.gsub(/\[x\]/, '[ ]')
     end
+
+    def labels_match?(new_labels)
+      # Label uniqueness is not case-sensitive.
+      new_labels.map(&:downcase) == @labels.map(&:downcase)
+    end
+
+    def update_label?(issue, reset_labels)
+      !issue.labels.nil? && (reset_labels && !labels_match?(issue.labels) ||
+                             @labels.size == 0)
+    end
   end
 end

data/lib/sync_issues/github.rb

@@ -5,14 +5,17 @@ require 'safe_yaml/load'
 module SyncIssues
   # GitHub is responsible access to GitHub's API
   class GitHub
+    attr_reader :client
+
     def initialize
       @client = Octokit::Client.new access_token: token
       @client.auto_paginate = true
     end
 
-    def create_issue(repository, issue, add_assignee)
+    def create_issue(repository, issue, add_assignee, add_labels)
       kwargs = {}
       kwargs[:assignee] = issue.assignee if add_assignee
+      kwargs[:labels] = issue.labels if add_labels
       @client.create_issue(repository.full_name, issue.title, issue.content,
                            **kwargs)
     end
@@ -21,6 +24,10 @@ module SyncIssues
       @client.issues(repository.full_name, state: :all)
     end
 
+    def labels(repository)
+      @client.labels(repository.full_name)
+    end
+
     def repository(repository_name)
       @client.repository(repository_name)
     rescue Octokit::InvalidRepository => exc
@@ -29,9 +36,11 @@ module SyncIssues
       raise Error, 'repository not found'
     end
 
-    def update_issue(repository, issue_number, title, content, assignee)
-      @client.update_issue(repository.full_name, issue_number, title, content,
-                           assignee: assignee)
+    def update_issue(repository, issue_number, comparison)
+      @client.update_issue(repository.full_name, issue_number,
+                           comparison.title, comparison.content,
+                           assignee: comparison.assignee,
+                           labels: comparison.labels)
     end
 
     private

data/lib/sync_issues/issue.rb

@@ -6,22 +6,36 @@ module SyncIssues
   # new_title is only used when an issue should be renamed. Issues with
   # new_title set will never be created
   class Issue
-    attr_reader :assignee, :content, :new_title, :title
+    attr_reader :assignee, :content, :labels, :new_title, :title
 
-    def initialize(content, title:, assignee: nil, new_title: nil)
+    def initialize(content, title:, assignee: nil, labels: nil, new_title: nil)
       @assignee = verify_string 'assignee', assignee
       @content = content
-      @title = verify_string 'title', title, allow_nil: false
+      @labels = verify_labels(labels)
       @new_title = verify_string 'new_title', new_title, allow_nil: true
+      @title = verify_string 'title', title, allow_nil: false
     end
 
     private
 
+    def verify_labels(labels)
+      return nil if labels.nil?
+      if labels.is_a?(String)
+        [verify_string('labels', labels, allow_nil: false)]
+      elsif !labels.is_a?(Array)
+        raise IssueError, "'labels' must be an Array or a String"
+      else
+        labels.each_with_index.map do |label, i|
+          verify_string("labels[#{i}]", label, allow_nil: false)
+        end
+      end
+    end
+
     def verify_string(field, value, allow_nil: true)
       if value.nil?
         raise IssueError, "'#{field}' must be provided" unless allow_nil
       elsif !value.is_a?(String)
-        raise IssueError, "'#{field}' must be a string"
+        raise IssueError, "'#{field}' must be a String"
       else
         value.strip!
         raise IssueError, "'#{field}' must not be blank" if value == ''

data/lib/sync_issues/label_sync.rb

@@ -0,0 +1,93 @@
+require_relative 'error'
+require 'safe_yaml/load'
+
+module SyncIssues
+  # Synchronizer is responsible for the actual synchronization.
+  class LabelSync
+    attr_reader :do_work, :keep_existing, :labels
+
+    def initialize(github, file_yaml)
+      @github = github
+      @labels = @keep_existing = nil
+      @do_work = file_yaml.nil? ? false : parse_yaml(file_yaml)
+    end
+
+    def synchronize(repository)
+      return unless @do_work
+      existing = existing_labels(repository)
+      make_changes(existing, repository)
+    end
+
+    private
+
+    def add_labels(labels, repository)
+      labels.each do |label, color|
+        puts "\tadd label: #{label}"
+        @github.client.add_label(repository.full_name, label, color)
+      end
+    end
+
+    def delete_labels(labels, repository)
+      labels.each do |label, _|
+        if @keep_existing
+          puts "\tkeeping label: #{label}"
+        else
+          puts "\tdelete label: #{label}"
+          @github.client.delete_label!(repository.full_name, label)
+        end
+      end
+    end
+
+    def make_changes(existing, repository)
+      changes = { add: [], update: [] }
+      @labels.each do |label, color|
+        if existing.include?(label)
+          changes[:update] << [label, color] unless existing[label] == color
+          existing.delete(label)
+        else
+          changes[:add] << [label, color]
+        end
+      end
+
+      add_labels(changes[:add], repository)
+      update_labels(changes[:update], repository)
+      delete_labels(existing, repository)
+    rescue Octokit::UnprocessableEntity => exc
+      raise unless exc.errors.count == 1 && exc.errors[0][:resource] == 'Label'
+      error = exc.errors[0]
+      raise Error, "Label error: #{error[:code]} #{error[:field]}"
+    end
+
+    def existing_labels(repository)
+      Hash[@github.labels(repository).map do |label|
+        [label[:name], label[:color]]
+      end]
+    end
+
+    def parse_yaml(yaml)
+      data = SafeYAML.load(yaml)
+      return nil unless data
+      if data.include?('labels') && data['labels'].is_a?(Hash)
+        @labels = Hash[data['labels'].map do |label, color|
+          if color.is_a?(Integer)
+            raise Error, 'Label error: add quotes around numeric color values'
+          end
+          [label, color.to_s.downcase]
+        end]
+      else
+        @labels = {}
+      end
+      @keep_existing = data['keep_existing'] != false
+      @labels.size > 0 || !@keep_existing
+    rescue Psych::SyntaxError
+      raise ParseError, 'invalid label yaml file'
+    end
+
+    def update_labels(labels, repository)
+      labels.each do |label, color|
+        puts "\tupdate label: #{label}"
+        @github.client.update_label(repository.full_name, label, color: color)
+      end
+    end
+  end
+end

data/lib/sync_issues/synchronizer.rb

@@ -1,23 +1,27 @@
 require_relative 'comparison'
 require_relative 'error'
+require_relative 'label_sync'
 require_relative 'parser'
 require 'English'
 
 module SyncIssues
   # Synchronizer is responsible for the actual synchronization.
   class Synchronizer
-    def initialize(directory, repository_names, sync_assignees: true,
-                   update_only: false)
+    def initialize(directory, repository_names, label_yaml: nil,
+                   reset_labels: false, sync_assignees: true,
+                   sync_labels: true, update_only: false)
       @github = SyncIssues.github
       @issues = issues(directory)
+      @label_sync = LabelSync.new(@github, label_yaml)
       @repositories = repositories(repository_names)
+      @reset_labels = reset_labels
       @sync_assignees = sync_assignees
+      @sync_labels = sync_labels
       @update_only = update_only
     end
 
     def run
       puts "Synchronize #{@issues.count} issue#{@issues.count == 1 ? '' : 's'}"
-      @issues.each { |issue| puts " * #{issue.title}" }
       @repositories.each { |repository| synchronize(repository) }
     end
 
@@ -62,6 +66,7 @@ module SyncIssues
 
     def synchronize(repository)
       puts "Repository: #{repository.full_name}"
+      @label_sync.synchronize(repository) if @sync_labels
 
       existing_by_title = {}
       @github.issues(repository).each do |issue|
@@ -84,18 +89,20 @@ module SyncIssues
         puts "Skipping create issue: #{issue.title}"
       else
         puts "Adding issue: #{issue.title}"
-        @github.create_issue(repository, issue, @sync_assignees)
+        @github.create_issue(repository, issue, @sync_assignees, @sync_labels)
       end
     end
 
     def update_issue(repository, issue, github_issue)
-      comparison = Comparison.new(issue, github_issue, @sync_assignees)
+      comparison = Comparison.new(issue, github_issue,
+                                  reset_labels: @reset_labels,
+                                  sync_assignee: @sync_assignees,
+                                  sync_labels: @sync_labels)
       return unless comparison.changed?
 
       changed = comparison.changed.join(', ')
       puts "Updating #{changed} on ##{github_issue.number}"
-      @github.update_issue(repository, github_issue.number, comparison.title,
-                           comparison.content, comparison.assignee)
+      @github.update_issue(repository, github_issue.number, comparison)
     end
   end
 end

data/lib/sync_issues/version.rb

@@ -1,4 +1,4 @@
 # SyncIssues
 module SyncIssues
-  VERSION = '0.5.0'.freeze
+  VERSION = '0.6.0'.freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sync_issues
 version: !ruby/object:Gem::Version
-  version: 0.5.0
+  version: 0.6.0
 platform: ruby
 authors:
 - Bryce Boe
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-03-10 00:00:00.000000000 Z
+date: 2016-03-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: docopt
@@ -70,6 +70,7 @@ files:
 - lib/sync_issues/error.rb
 - lib/sync_issues/github.rb
 - lib/sync_issues/issue.rb
+- lib/sync_issues/label_sync.rb
 - lib/sync_issues/parser.rb
 - lib/sync_issues/sync_issues_module.rb
 - lib/sync_issues/synchronizer.rb