sync_issues 0.0.1a1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 0b6a0252d1b5582610e2b01359cf5841bd606d53
+  data.tar.gz: e2231679897dca717069ffa4f99a4b89711e8b70
+SHA512:
+  metadata.gz: fb399b702215518077d1ef0cadc442785ae33e30d2b7658857019befa57a3a473ecf7216a5bdaceb3c2cb9cc69bb9c6f6b29a14882970c81f578da6b427ea21f
+  data.tar.gz: 0264b355338743058a3b017da78ba9b8122f9371880ba14650ed7569bf28ff78f481ed800f2b25554915fccfffb21f42f812659128f9b60a9f29649af62155d2

data/LICENSE.txt

@@ -0,0 +1,23 @@
+Copyright (c) 2016, AppFolio, Inc.
+Copyright (c) 2016, Bryce Boe
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met:
+
+1. Redistributions of source code must retain the above copyright notice, this
+   list of conditions and the following disclaimer.
+2. Redistributions in binary form must reproduce the above copyright notice,
+   this list of conditions and the following disclaimer in the documentation
+   and/or other materials provided with the distribution.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
+ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
+WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
+FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

data/README.md

@@ -0,0 +1,44 @@
+# Sync Issues for GitHub
+
+sync_issues is a ruby gem to that allows the easy creation and synchronization
+of issues on GitHub with structured local data.
+
+
+## Installation
+
+To install sync_issues run:
+
+    gem install sync_issues
+
+## Running sync_issues
+
+Run sync_issues via:
+
+    sync_tasks /path/to/tasks/directory bboe/repo1 appfolio/repo2
+
+
+## Local Issue Directory
+
+Locally you will want to have a directory of markdown files each of which will
+represent a single issue on GitHub. When syncing new issues will be created
+according to lexicographic filename order if an issue doesn't already exist
+with a matching title as specified in the file's frontmatter. Existing issues
+will be updated if necessary.
+
+## Issue File
+
+Each issue file is a markdown file with a `yaml` frontmatter (a format used by
+[jeykll](http://jekyllrb.com/docs/frontmatter/)).
+
+### Task Frontmatter
+
+The frontmatter of an issue file can contain the following attributes:
+
+* __title__: (required) Used as the title of the issue on GitHub. The title is
+  used as the unique key when syncing updated tasks with existing issues.
+* __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.

data/bin/sync_issues

@@ -0,0 +1,3 @@
+#!/usr/bin/env ruby
+require 'sync_issues'
+exit SyncIssues.command.run

data/lib/sync_issues/command.rb

@@ -0,0 +1,47 @@
+require 'docopt'
+require_relative 'error'
+require_relative 'synchronizer'
+require_relative 'version'
+
+module SyncIssues
+  # Provides the command line interface to SyncIssues
+  class Command
+    DOC = <<-DOC
+    sync_issues: A tool that synchronizes a local directory with GitHub issues.
+
+    Usage:
+      sync_issues DIRECTORY REPOSITORY...
+      sync_issues -h | --help
+      sync_issues --version
+
+    Options:
+      -h --help  Output this help information.
+      --version  Output the sync_issues version (#{VERSION}).
+    DOC
+
+    def initialize
+      @exit_status = 0
+    end
+
+    def run
+      handle_args(Docopt.docopt(DOC, version: VERSION))
+    rescue Docopt::Exit => exc
+      exit_with_status(exc.message, exc.class.usage != '')
+    rescue Error => exc
+      exit_with_status(exc.message)
+    end
+
+    private
+
+    def exit_with_status(msg, condition = true)
+      puts msg
+      @exit_status == 0 && condition ? 1 : @exit_status
+    end
+
+    def handle_args(options)
+      SyncIssues.synchronizer(options['DIRECTORY'],
+                              options['REPOSITORY']).run
+      @exit_status
+    end
+  end
+end

data/lib/sync_issues/error.rb

@@ -0,0 +1,4 @@
+module SyncIssues
+  class Error < StandardError
+  end
+end

data/lib/sync_issues/sync_issues_module.rb

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

data/lib/sync_issues/synchronizer.rb

@@ -0,0 +1,23 @@
+module SyncIssues
+  # Synchronizer is responsible for the actual synchronization.
+  class Synchronizer
+    def initialize(directory, repositories)
+      @directory = check_directory(directory)
+      @repositories = check_repositories(repositories)
+    end
+
+    def run
+      puts "Sync #{@directory} to #{@repositories.inspect}."
+    end
+
+    private
+
+    def check_directory(directory)
+      directory
+    end
+
+    def check_repositories(repositories)
+      repositories
+    end
+  end
+end

data/lib/sync_issues/version.rb

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

data/lib/sync_issues.rb

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

metadata

@@ -0,0 +1,69 @@
+--- !ruby/object:Gem::Specification
+name: sync_issues
+version: !ruby/object:Gem::Version
+  version: 0.0.1a1
+platform: ruby
+authors:
+- Bryce Boe
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-01-28 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: docopt
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.5'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.5'
+description: |2
+      sync_issues is a ruby gem to that allows the easy creation and
+      synchronization of issues on GitHub with structured local data.
+email: bryce.boe@appfolio.com
+executables:
+- sync_issues
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE.txt
+- README.md
+- bin/sync_issues
+- lib/sync_issues.rb
+- lib/sync_issues/command.rb
+- lib/sync_issues/error.rb
+- lib/sync_issues/sync_issues_module.rb
+- lib/sync_issues/synchronizer.rb
+- lib/sync_issues/version.rb
+homepage: https://github.com/bboe/sync_issues
+licenses:
+- Simplified BSD
+metadata: {}
+post_install_message: Happy syncing!
+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: 1.3.1
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.8
+signing_key: 
+specification_version: 4
+summary: A tool that synchronizes a local directory with GitHub issues.
+test_files: []