sync_issues 0.0.1a1 → 0.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 0b6a0252d1b5582610e2b01359cf5841bd606d53
-  data.tar.gz: e2231679897dca717069ffa4f99a4b89711e8b70
+  metadata.gz: 851be84063a71f5f66d9f4433ef9e412b81ed1a4
+  data.tar.gz: 525105d38ebbb876c30e49c37b5b0e3ebbde1470
 SHA512:
-  metadata.gz: fb399b702215518077d1ef0cadc442785ae33e30d2b7658857019befa57a3a473ecf7216a5bdaceb3c2cb9cc69bb9c6f6b29a14882970c81f578da6b427ea21f
-  data.tar.gz: 0264b355338743058a3b017da78ba9b8122f9371880ba14650ed7569bf28ff78f481ed800f2b25554915fccfffb21f42f812659128f9b60a9f29649af62155d2
+  metadata.gz: ba04b87e9d73cc9ffd051750c9738a9bc7ec8a7edea7b759274fd89aaf3d970fbeed37bbbb5dd74f31c73da855681a9f4d862229d3c4198fbfa3d22ef8bfcf27
+  data.tar.gz: 4606a46c96a4468bc805cb9f68f6c1dd4fd87e20834410c9166e576a28d57c6d8e565df336ecdc8fd2405d27a27561ac45835409900610557062fc750697fcf2

data/lib/sync_issues/command.rb

@@ -10,13 +10,14 @@ module SyncIssues
     sync_issues: A tool that synchronizes a local directory with GitHub issues.
 
     Usage:
-      sync_issues DIRECTORY REPOSITORY...
+      sync_issues [options] DIRECTORY REPOSITORY...
       sync_issues -h | --help
       sync_issues --version
 
     Options:
-      -h --help  Output this help information.
-      --version  Output the sync_issues version (#{VERSION}).
+      -u --update  Only update existing issues.
+      -h --help    Output this help information.
+      --version    Output the sync_issues version (#{VERSION}).
     DOC
 
     def initialize
@@ -39,8 +40,8 @@ module SyncIssues
     end
 
     def handle_args(options)
-      SyncIssues.synchronizer(options['DIRECTORY'],
-                              options['REPOSITORY']).run
+      SyncIssues.synchronizer(options['DIRECTORY'], options['REPOSITORY'],
+                              update_only: options['--update']).run
       @exit_status
     end
   end

data/lib/sync_issues/error.rb

@@ -1,4 +1,10 @@
 module SyncIssues
   class Error < StandardError
   end
+
+  class IssueError < Error
+  end
+
+  class ParseError < Error
+  end
 end

data/lib/sync_issues/github.rb

@@ -0,0 +1,40 @@
+require_relative 'error'
+require 'octokit'
+require 'safe_yaml/load'
+
+module SyncIssues
+  # GitHub is responsible access to GitHub's API
+  class GitHub
+    def initialize
+      @client = Octokit::Client.new access_token: token
+    end
+
+    def create_issue(repository, issue)
+      @client.create_issue(repository.full_name, issue.title, issue.content)
+    end
+
+    def issues(repository)
+      @client.issues(repository)
+    end
+
+    def repository(repository_name)
+      @client.repository(repository_name)
+    rescue Octokit::InvalidRepository => exc
+      raise Error, exc.message
+    rescue Octokit::NotFound
+      raise Error, 'repository not found'
+    end
+
+    def update_issue(repository, github_issue, issue)
+      @client.update_issue(repository.full_name, github_issue.number,
+                           issue.new_title || issue.title, issue.content)
+    end
+
+    private
+
+    def token
+      path = File.expand_path('~/.config/sync_issues.yaml')
+      SafeYAML.load(File.read(path))['token']
+    end
+  end
+end

data/lib/sync_issues/issue.rb

@@ -0,0 +1,32 @@
+require_relative 'error'
+
+module SyncIssues
+  # Issue represents an issue to be added or updated.
+  #
+  # 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
+
+    def initialize(content, title:, assignee: nil, new_title: nil)
+      @assignee = verify_string 'assignee', assignee
+      @content = content
+      @title = verify_string 'title', title, allow_nil: false
+      @new_title = verify_string 'new_title', new_title, allow_nil: true
+    end
+
+    private
+
+    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"
+      else
+        value.strip!
+        raise IssueError, "'#{field}' must not be blank" if value == ''
+      end
+      value
+    end
+  end
+end

data/lib/sync_issues/parser.rb

@@ -0,0 +1,41 @@
+require_relative 'error'
+require_relative 'issue'
+require 'safe_yaml/load'
+
+module SyncIssues
+  # Synchronizer is responsible for the actual synchronization.
+  class Parser
+    attr_reader :issue
+
+    def initialize(data)
+      @issue = nil
+      parse(data)
+    end
+
+    def parse(data)
+      unless data =~ /\A(---\s*\n.*?\n?)^((---|\.\.\.)\s*$\n?)/m
+        raise ParseError, 'missing frontmatter'
+      end
+
+      if (content = $POSTMATCH).empty?
+        raise ParseError, 'empty markdown content'
+      elsif (metadata = SafeYAML.load(Regexp.last_match(1))).nil?
+        raise ParseError, 'empty frontmatter'
+      else
+        @issue = Issue.new content, **hash_keys_to_symbols(metadata)
+      end
+    rescue ArgumentError => exc
+      raise ParseError, exc.message
+    rescue Psych::SyntaxError
+      raise ParseError, 'invalid frontmatter'
+    end
+
+    private
+
+    def hash_keys_to_symbols(hash)
+      hash.each_with_object({}) do |(key, value), tmp_hash|
+        tmp_hash[key.to_sym] = value
+      end
+    end
+  end
+end

data/lib/sync_issues/sync_issues_module.rb

@@ -1,15 +1,20 @@
 require_relative 'command'
+require_relative 'github'
 require_relative 'synchronizer'
 
 # SyncIssues
 module SyncIssues
   class << self
     def command
-      @command ||= SyncIssues::Command.new
+      @command ||= Command.new
     end
 
-    def synchronizer(directory, repositories)
-      SyncIssues::Synchronizer.new(directory, repositories)
+    def github
+      @github ||= GitHub.new
+    end
+
+    def synchronizer(*args)
+      Synchronizer.new(*args)
     end
   end
 end

data/lib/sync_issues/synchronizer.rb

@@ -1,23 +1,97 @@
+require_relative 'error'
+require_relative 'parser'
+require 'English'
+
 module SyncIssues
   # Synchronizer is responsible for the actual synchronization.
   class Synchronizer
-    def initialize(directory, repositories)
-      @directory = check_directory(directory)
-      @repositories = check_repositories(repositories)
+    def initialize(directory, repository_names, update_only: false)
+      @issues = issues(directory)
+      @repositories = repositories(repository_names)
+      @update_only = update_only
     end
 
     def run
-      puts "Sync #{@directory} to #{@repositories.inspect}."
+      puts "Synchronize #{@issues.count} issue#{@issues.count == 1 ? '' : 's'}"
+      @issues.each { |issue| puts " * #{issue.title}" }
+      @repositories.each { |repository| synchronize(repository) }
     end
 
     private
 
-    def check_directory(directory)
-      directory
+    def issues(directory)
+      unless File.directory?(directory)
+        raise Error, "'#{directory}' is not a valid directory"
+      end
+
+      issues = Dir.glob(File.join(directory, '**/*')).map do |entry|
+        next unless entry.end_with?('.md') && File.file?(entry)
+        begin
+          Parser.new(File.read(entry)).issue
+        rescue ParseError => exc
+          puts "'#{entry}': #{exc}"
+          nil
+        end
+      end.compact
+
+      if issues.empty?
+        raise Error, "'#{directory}' does not contain any .md files"
+      end
+
+      issues
     end
 
-    def check_repositories(repositories)
+    def repositories(repository_names)
+      repositories = repository_names.map do |repository_name|
+        begin
+          SyncIssues.github.repository(repository_name)
+        rescue Error => exc
+          puts "'#{repository_name}' #{exc}"
+          nil
+        end
+      end.compact
+
+      raise Error, 'No valid repositories specified' if repositories.empty?
+
       repositories
     end
+
+    def synchronize(repository)
+      puts "Repository: #{repository.full_name}"
+
+      existing_by_title = {}
+      SyncIssues.github.issues(repository.full_name).each do |issue|
+        existing_by_title[issue.title] = issue
+      end
+
+      @issues.each do |issue|
+        if existing_by_title.include?(issue.title)
+          update_issue(repository, issue, existing_by_title[issue.title])
+        else
+          create_issue(repository, issue)
+        end
+      end
+    end
+
+    private
+
+    def create_issue(repository, issue)
+      if @update_only || issue.new_title
+        puts "Skipping create issue: #{issue.title}"
+      else
+        puts "Adding issue: #{issue.title}"
+        SyncIssues.github.create_issue(repository, issue)
+      end
+    end
+
+    def update_issue(repository, issue, github_issue)
+      changed = []
+      changed << 'title' unless issue.new_title.nil?
+      changed << 'body' unless issue.content == github_issue.body
+      return if changed.empty?
+
+      puts "Updating #{changed.join(', ')} on ##{github_issue.number}"
+      SyncIssues.github.update_issue(repository, github_issue, issue)
+    end
   end
 end

data/lib/sync_issues/version.rb

@@ -1,4 +1,4 @@
 # SyncIssues
 module SyncIssues
-  VERSION = '0.0.1a1'.freeze
+  VERSION = '0.0.1'.freeze
 end

data/lib/sync_issues.rb

@@ -1,3 +1,2 @@
-require 'sync_issues/command'
 require 'sync_issues/sync_issues_module'
 require 'sync_issues/version'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sync_issues
 version: !ruby/object:Gem::Version
-  version: 0.0.1a1
+  version: 0.0.1
 platform: ruby
 authors:
 - Bryce Boe
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-01-28 00:00:00.000000000 Z
+date: 2016-02-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: docopt
@@ -24,6 +24,34 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.5'
+- !ruby/object:Gem::Dependency
+  name: octokit
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.2'
+- !ruby/object:Gem::Dependency
+  name: safe_yaml
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
 description: |2
       sync_issues is a ruby gem to that allows the easy creation and
       synchronization of issues on GitHub with structured local data.
@@ -39,6 +67,9 @@ files:
 - lib/sync_issues.rb
 - lib/sync_issues/command.rb
 - lib/sync_issues/error.rb
+- lib/sync_issues/github.rb
+- lib/sync_issues/issue.rb
+- lib/sync_issues/parser.rb
 - lib/sync_issues/sync_issues_module.rb
 - lib/sync_issues/synchronizer.rb
 - lib/sync_issues/version.rb
@@ -57,9 +88,9 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">"
+  - - ">="
     - !ruby/object:Gem::Version
-      version: 1.3.1
+      version: '0'
 requirements: []
 rubyforge_project: 
 rubygems_version: 2.4.8