github_issue_exporter 0.2.1 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e6b637b45fea0775f61dbec3788145b2a8fc345e
-  data.tar.gz: 67e5feafb6fb20a48d73b1ebeea3e6f00c11f1ca
+  metadata.gz: 90da13ded1c07b94331081e6d4ec102e9e275355
+  data.tar.gz: 236daac34abdab9894117684c9a84f5fcd573585
 SHA512:
-  metadata.gz: 540fa1dc0bf08ead897b173d2430da55094498bc147880f39f7ac393e2a6fdcee2be4d53cd7e4cba0aec0c7c3b65078e105cae43eb7524fb6630139bd66f3cde
-  data.tar.gz: 079061fdd23c1b48d9a3756481efc76f3b9f6852c823192e5f3e6c3ae8d7bbd346dd78db017b60db67a83dafd7c1a34cb1c8148f118214fc5e3976e1ed23fea6
+  metadata.gz: 862a0f788bdbe2226a0bc26d3e727f2ddf2c2bba2ad41f17eb6e739cdb02ae99c4e824af8b45da884398217ecca1550c899b2e4e8db082e9c004782b2f15b130
+  data.tar.gz: 99a81d39d3ff687721134e82d6f92d2f81c2a12b6a76d8fe7d8067a2d1b841fcb1d86bdc585d6c830d6128ee2d642bd1bf1f87551437d8d4f6a5c1b5fd871c9d

data/README.md

@@ -31,6 +31,8 @@ The Exporter has a couple of options.
 
 `--output` Set the directory to store the issues in. By default it is the current directory.
 
+`--output-type` Sets the filetype to output. Current options are `file` (the default) and `csv`. The `multiple-files` flag will only work with `file`.
+
 `--closed` By default, only Open issues are exported. Adding this flag will include Closed ones as well.
 
 The issues will be exported into either a single `issues.json` file or multiple `issue-[NUMBER].json` files.
@@ -43,6 +45,8 @@ export-github-issues tallwave github_issue_exporter [TOKEN]
 export-github-issues --closed tallwave github_issue_exporter [TOKEN]
 
 export-github-issues --multiple-files --output ~/issues tallwave github_issue_exporter [TOKEN]
+
+export-github-issues --output-type csv tallwave github_issue_exporter [TOKEN]
 ```
 
 ### import-github-issues
@@ -62,6 +66,12 @@ import-github-issues --directory ~/issues tallwave github_issue_exporter [TOKEN]
 * Issues will be added to the repository as if they were brand new, so old issue numbers will not be used.
 * If your user does not have push access to the repository, assignees, milestones, and labels will not be set. Read more in the [GitHub documentation](https://developer.github.com/v3/issues/#create-an-issue).
 
+# Development
+This sees sporadic development but here's some info if you're interested:
+
+## Testing
+You'll need [bundler](http://bundler.io) installed. Run `bundle install --binstubs` to install dependencies and test binaries. You can then execute the specs with `bin/rspec` from the root folder.
+
 ## Roadmap
 
  * Better error handling.

data/bin/bundle

@@ -0,0 +1,105 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+#
+# This file was generated by Bundler.
+#
+# The application 'bundle' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require "rubygems"
+
+m = Module.new do
+    module_function
+
+  def invoked_as_script?
+    File.expand_path($0) == File.expand_path(__FILE__)
+  end
+
+  def env_var_version
+    ENV["BUNDLER_VERSION"]
+  end
+
+  def cli_arg_version
+    return unless invoked_as_script? # don't want to hijack other binstubs
+    return unless "update".start_with?(ARGV.first || " ") # must be running `bundle update`
+    bundler_version = nil
+    update_index = nil
+    ARGV.each_with_index do |a, i|
+      if update_index && update_index.succ == i && a =~ Gem::Version::ANCHORED_VERSION_PATTERN
+        bundler_version = a
+      end
+      next unless a =~ /\A--bundler(?:[= ](#{Gem::Version::VERSION_PATTERN}))?\z/
+      bundler_version = $1 || ">= 0.a"
+      update_index = i
+    end
+    bundler_version
+  end
+
+  def gemfile
+    gemfile = ENV["BUNDLE_GEMFILE"]
+    return gemfile if gemfile && !gemfile.empty?
+
+    File.expand_path("../../Gemfile", __FILE__)
+  end
+
+  def lockfile
+    lockfile =
+      case File.basename(gemfile)
+      when "gems.rb" then gemfile.sub(/\.rb$/, gemfile)
+      else "#{gemfile}.lock"
+      end
+    File.expand_path(lockfile)
+  end
+
+  def lockfile_version
+    return unless File.file?(lockfile)
+    lockfile_contents = File.read(lockfile)
+    return unless lockfile_contents =~ /\n\nBUNDLED WITH\n\s{2,}(#{Gem::Version::VERSION_PATTERN})\n/
+    Regexp.last_match(1)
+  end
+
+  def bundler_version
+    @bundler_version ||= begin
+      env_var_version || cli_arg_version ||
+        lockfile_version || "#{Gem::Requirement.default}.a"
+    end
+  end
+
+  def load_bundler!
+    ENV["BUNDLE_GEMFILE"] ||= gemfile
+
+    # must dup string for RG < 1.8 compatibility
+    activate_bundler(bundler_version.dup)
+  end
+
+  def activate_bundler(bundler_version)
+    if Gem::Version.correct?(bundler_version) && Gem::Version.new(bundler_version).release < Gem::Version.new("2.0")
+      bundler_version = "< 2"
+    end
+    gem_error = activation_error_handling do
+      gem "bundler", bundler_version
+    end
+    return if gem_error.nil?
+    require_error = activation_error_handling do
+      require "bundler/version"
+    end
+    return if require_error.nil? && Gem::Requirement.new(bundler_version).satisfied_by?(Gem::Version.new(Bundler::VERSION))
+    warn "Activating bundler (#{bundler_version}) failed:\n#{gem_error.message}\n\nTo install the version of bundler this project requires, run `gem install bundler -v '#{bundler_version}'`"
+    exit 42
+  end
+
+  def activation_error_handling
+    yield
+    nil
+  rescue StandardError, LoadError => e
+    e
+  end
+end
+
+m.load_bundler!
+
+if m.invoked_as_script?
+  load Gem.bin_path("bundler", "bundle")
+end

data/bin/export-github-issues

@@ -21,14 +21,18 @@ Usage: #{$PROGRAM_NAME} [OPTION]... [OWNER] [REPO] [TOKEN]
 
 Example: #{$PROGRAM_NAME} swilliams issue_exporter abcdef
 
--o, --output      DIRECTORY
-                    set output path
-                      (default: current working directory)
+    --closed      include closed issues (default: false)
 
     --multiple-files Use a separate file for each issue
                     (default: one single file)
 
-    --closed      include closed issues (default: false)
+-o, --output      DIRECTORY
+                    set output path
+                      (default: current working directory)
+
+    --output-type TYPE
+                    sets the filetype (csv or file)
+                      (default: file)
 
 -h, --help        display this help and exit
     --version     display the version
@@ -42,6 +46,7 @@ HERE
       @output = nil
       @multiple_files = false
       @include_closed_issues = false
+      @output_type = 'file'
     end
 
     def correct_number_of_args(arg_count)
@@ -52,6 +57,7 @@ HERE
       opts.on("-o", "--output ARG") { |arg| @output = arg }
       opts.on("--multiple-files")   { @multiple_files = true }
       opts.on("--closed")           { @include_closed_issues = true }
+      opts.on("--output-type ARG")      { |arg| @output_type = arg }
     end
 
     def process_input(arg, index)
@@ -68,7 +74,8 @@ HERE
     def perform_action
       options = { path: @output,
                   multiple_files: @multiple_files,
-                  include_closed_issues: @include_closed_issues }
+                  include_closed_issues: @include_closed_issues,
+                  output_type: @output_type }
       exporter = IssueExporting::Exporter.new(@owner, @repo, @token, options)
       exporter.export
     end

data/bin/htmldiff

@@ -0,0 +1,21 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+#
+# This file was generated by Bundler.
+#
+# The application 'htmldiff' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+bundle_binstub = File.expand_path("../bundle", __FILE__)
+load(bundle_binstub) if File.file?(bundle_binstub)
+
+require "pathname"
+ENV["BUNDLE_GEMFILE"] ||= File.expand_path("../../Gemfile",
+  Pathname.new(__FILE__).realpath)
+
+require "rubygems"
+require "bundler/setup"
+
+load Gem.bin_path("diff-lcs", "htmldiff")

data/bin/ldiff

@@ -0,0 +1,21 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+#
+# This file was generated by Bundler.
+#
+# The application 'ldiff' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+bundle_binstub = File.expand_path("../bundle", __FILE__)
+load(bundle_binstub) if File.file?(bundle_binstub)
+
+require "pathname"
+ENV["BUNDLE_GEMFILE"] ||= File.expand_path("../../Gemfile",
+  Pathname.new(__FILE__).realpath)
+
+require "rubygems"
+require "bundler/setup"
+
+load Gem.bin_path("diff-lcs", "ldiff")

data/bin/rake

@@ -0,0 +1,21 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+#
+# This file was generated by Bundler.
+#
+# The application 'rake' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+bundle_binstub = File.expand_path("../bundle", __FILE__)
+load(bundle_binstub) if File.file?(bundle_binstub)
+
+require "pathname"
+ENV["BUNDLE_GEMFILE"] ||= File.expand_path("../../Gemfile",
+  Pathname.new(__FILE__).realpath)
+
+require "rubygems"
+require "bundler/setup"
+
+load Gem.bin_path("rake", "rake")

data/bin/rspec

@@ -0,0 +1,21 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+#
+# This file was generated by Bundler.
+#
+# The application 'rspec' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+bundle_binstub = File.expand_path("../bundle", __FILE__)
+load(bundle_binstub) if File.file?(bundle_binstub)
+
+require "pathname"
+ENV["BUNDLE_GEMFILE"] ||= File.expand_path("../../Gemfile",
+  Pathname.new(__FILE__).realpath)
+
+require "rubygems"
+require "bundler/setup"
+
+load Gem.bin_path("rspec-core", "rspec")

data/bin/safe_yaml

@@ -0,0 +1,21 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+#
+# This file was generated by Bundler.
+#
+# The application 'safe_yaml' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+bundle_binstub = File.expand_path("../bundle", __FILE__)
+load(bundle_binstub) if File.file?(bundle_binstub)
+
+require "pathname"
+ENV["BUNDLE_GEMFILE"] ||= File.expand_path("../../Gemfile",
+  Pathname.new(__FILE__).realpath)
+
+require "rubygems"
+require "bundler/setup"
+
+load Gem.bin_path("safe_yaml", "safe_yaml")

data/github_issue_exporter.gemspec

@@ -6,12 +6,13 @@ Gem::Specification.new do |s|
   s.name                  = 'github_issue_exporter'
   s.version               = IssueExporting::VERSION
   s.required_ruby_version = '>= 2.0'
+  s.date                  = '2017-12-04'
   s.summary               = 'Tools to export GitHub Issues'
   s.description           = <<-HERE
-    Download Issues from a GitHub repository.
+    Export or Import issues from a GitHub repository.
   HERE
   s.license               = 'MIT'
-  s.author                = 'Scott Williams'
+  s.authors               = ['Scott Williams']
   s.email                 = 'scott@swilliams.me'
   s.homepage              = 'https://github.com/Tallwave/github_issue_exporter'
   s.files                 = Dir['{bin,lib}/**/*'] + ['github_issue_exporter.gemspec']

data/lib/issue_exporter/export.rb

@@ -1,6 +1,5 @@
 # Copyright (c) 2015 Scott Williams
 
-require "net/http"
 require "json"
 
 module IssueExporting
@@ -13,8 +12,9 @@ module IssueExporting
       @repo = repo
       @token = token
       @options = options
-      outputter_options = options.select { |k,v| [:path, :multiple_files].include? k }
-      @outputter = FileOutputter.new outputter_options
+      valid_option_keys = [:path, :multiple_files, :output_type]
+      outputter_options = options.select { |k,v| valid_option_keys.include? k }
+      @outputter = build_outputter outputter_options
     end
 
     def export
@@ -27,6 +27,17 @@ module IssueExporting
         outputter.write response
       end
     end
+
+    private
+    def build_outputter(outputter_options)
+      output_type = outputter_options[:output_type] || 'file'
+      case output_type
+      when 'csv'
+        return CsvOutputter.new(outputter_options)
+      else
+        return FileOutputter.new(outputter_options)
+      end
+    end
   end
 end
 

data/lib/issue_exporter/github.rb

@@ -1,5 +1,3 @@
-require "open-uri"
-
 module IssueExporting
   def self.api_url
     "https://api.github.com/repos/%s/%s/issues?access_token=%s"
@@ -13,7 +11,7 @@ module IssueExporting
   end
 
   def self.make_uri(owner, repo, token, options = {})
-    URI.parse IssueExporting.make_url(owner, repo, token, options)
+    URI(IssueExporting.make_url(owner, repo, token, options))
   end
 
   def self.turn_options_into_querystring(options)

data/lib/issue_exporter/outputter.rb

@@ -1,21 +1,17 @@
 # Copyright (c) 2015 Scott Williams
 
+require 'csv'
+
 module IssueExporting
-  class FileOutputter
+  class BaseOutputter
     def initialize(options = {})
       @options = options
     end
 
     def write(response_text)
-      path = @options[:path] || default_path
-      if @options[:multiple_files]
-        write_multi_file path, response_text
-      else
-        write_single_file path, response_text
-      end
     end
 
-    private
+    protected
     def default_path
       Dir.pwd
     end
@@ -24,11 +20,46 @@ module IssueExporting
       "issues.json"
     end
 
-    def write_single_file(dir, response_text)
+    def write_file(dir, text)
       path = "#{dir}/#{default_filename}"
-      File.open(path, 'w') { |f| f.write response_text }
+      File.open(path, 'w') { |f| f.write text }
+    end
+  end
+
+  class CsvOutputter < BaseOutputter
+    def write(response_text)
+      path = @options[:path] || default_path
+      array_of_issues = JSON.parse response_text
+      keys = ["number", "title", "state", "user.login", "created_at", "updated_at", "closed_at", "url"]
+      text = "Issue #,Title,State,Created By,Created At,Last Updated At,Closed At,GitHub URL\n"
+      mapped_values = array_of_issues.map do |issue|
+        values = keys.map do |key| 
+          args = key.split '.'
+          issue.dig(*args)
+        end
+        values.to_csv
+      end
+      csv_text = text + mapped_values.join("")
+      write_file path, csv_text
     end
 
+    protected
+    def default_filename
+      "issues.csv"
+    end
+  end
+
+  class FileOutputter < BaseOutputter
+    def write(response_text)
+      path = @options[:path] || default_path
+      if @options[:multiple_files]
+        write_multi_file path, response_text
+      else
+        write_file path, response_text
+      end
+    end
+
+    private
     def write_multi_file(dir, response_text)
       array_of_issues = JSON.parse response_text
       array_of_issues.each do |issue|

data/lib/issue_exporter/version.rb

@@ -1,5 +1,5 @@
 # Copyright (c) 2015 Scott Williams
 
 module IssueExporting
-  VERSION = "0.2.1"
+  VERSION = "0.3.0"
 end

data/lib/issue_exporter.rb

@@ -3,6 +3,7 @@
 require "English"
 require "shellwords"
 require "json"
+require "net/http"
 require "issue_exporter/github"
 require "issue_exporter/error_handler"
 require "issue_exporter/outputter"

metadata

@@ -1,17 +1,16 @@
 --- !ruby/object:Gem::Specification
 name: github_issue_exporter
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.3.0
 platform: ruby
 authors:
 - Scott Williams
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-07-22 00:00:00.000000000 Z
+date: 2017-12-04 00:00:00.000000000 Z
 dependencies: []
-description: |2
-      Download Issues from a GitHub repository.
+description: "    Export or Import issues from a GitHub repository.\n"
 email: scott@swilliams.me
 executables:
 - export-github-issues
@@ -23,8 +22,14 @@ extra_rdoc_files:
 files:
 - LICENSE
 - README.md
+- bin/bundle
 - bin/export-github-issues
+- bin/htmldiff
 - bin/import-github-issues
+- bin/ldiff
+- bin/rake
+- bin/rspec
+- bin/safe_yaml
 - github_issue_exporter.gemspec
 - lib/issue_exporter.rb
 - lib/issue_exporter/cli.rb
@@ -56,7 +61,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.2
+rubygems_version: 2.6.11
 signing_key: 
 specification_version: 4
 summary: Tools to export GitHub Issues