huborg 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: bca5b4b64bf1da62ccbb67ce27f6cf459ca1ec65c3989ed1d8fb095cdf8bb956
-  data.tar.gz: 2c44b381a4cdd5cabcae0afa7f35e83dbbd643b5d5f6df2025fcdc5687033736
+  metadata.gz: 77b0a3fbcce8421c99cb40deb90fd3428b85ac81f238ab0f8b5121d81299a57b
+  data.tar.gz: c4a93167f48a1cf45894e445872a583715df7b6dfe44f5710bd0b70ef1951fdc
 SHA512:
-  metadata.gz: e6c8b6fe6e75a86ee922a0e52dc2515aae8a47f01394b04c2c8c17ddf785c04d9f7bf547bf227d8736ae638e2ca3b25d8b53ac9b856a3123e34ce1c6c068508b
-  data.tar.gz: 67bdc6e7138eb137393d34c2ffd9275fe6db99979c93bac6bfb17feb0e47c15f6f1b570f36db7e605bd0e9b40bb6b8482720bde62c5551e41a09ca87626d820b
+  metadata.gz: e88edb17cbb567fef94563a2a2d060ee8140a5f9f5de0d10618253fb5da229efeac1485d05eaf942a5329afbe24209de021c28b8b8279914cd2291f276cf3126
+  data.tar.gz: 4ffc1475e19ac6b86c127d34c90037b2476e9e92b24b1cfbaeb7d9eb4086df94b380a7cd71b8f0c2a13ecfe57acb3427fdfa9f36672d1452d082d1fd611e2df2

data/CHANGELOG.md

@@ -1,5 +1,36 @@
 # Changelog
 
+## [v0.3.0](https://github.com/samvera-labs/huborg/tree/v0.3.0) (2020-04-28)
+
+[Full Changelog](https://github.com/samvera-labs/huborg/compare/v0.2.0...v0.3.0)
+
+**Fixed bugs:**
+
+- Fixing gemspec's changelog\_uri [\#9](https://github.com/samvera-labs/huborg/pull/9) ([jeremyf](https://github.com/jeremyf))
+
+**Merged pull requests:**
+
+- Adding Huborg::Client\#each\_pull\_request\_with\_repo [\#10](https://github.com/samvera-labs/huborg/pull/10) ([jeremyf](https://github.com/jeremyf))
+- Adding guidance on determining Semantic Versioning [\#8](https://github.com/samvera-labs/huborg/pull/8) ([jeremyf](https://github.com/jeremyf))
+- Highlighting links to API documentation [\#7](https://github.com/samvera-labs/huborg/pull/7) ([jeremyf](https://github.com/jeremyf))
+
+## [v0.2.0](https://github.com/samvera-labs/huborg/tree/v0.2.0) (2020-02-29)
+
+[Full Changelog](https://github.com/samvera-labs/huborg/compare/v0.1.0...v0.2.0)
+
+**Implemented enhancements:**
+
+- Adding release process [\#4](https://github.com/samvera-labs/huborg/pull/4) ([jeremyf](https://github.com/jeremyf))
+
+**Merged pull requests:**
+
+- Tweaking documentation [\#5](https://github.com/samvera-labs/huborg/pull/5) ([jeremyf](https://github.com/jeremyf))
+- Adding Huborg::Client\#synchronize\_mailmap! [\#3](https://github.com/samvera-labs/huborg/pull/3) ([jeremyf](https://github.com/jeremyf))
+- Adding Huborg::Client\#audit\_license [\#2](https://github.com/samvera-labs/huborg/pull/2) ([jeremyf](https://github.com/jeremyf))
+- Adding Huborg::Client\#clone\_and\_rebase! [\#1](https://github.com/samvera-labs/huborg/pull/1) ([jeremyf](https://github.com/jeremyf))
+
+# Changelog
+
 ## [v0.2.0](https://github.com/samvera-labs/huborg/tree/v0.2.0) (2020-02-28)
 
 [Full Changelog](https://github.com/samvera-labs/huborg/compare/v0.1.0...v0.2.0)
@@ -22,3 +53,6 @@
 - Adding Huborg::Client\#push\_template! ([jeremyf](https://github.com/jeremyf))
 
 \* *This Changelog was automatically generated by [github_changelog_generator](https://github.com/github-changelog-generator/github-changelog-generator)*
+
+
+\* *This Changelog was automatically generated by [github_changelog_generator](https://github.com/github-changelog-generator/github-changelog-generator)*

data/README.md

@@ -1,8 +1,8 @@
 # huborg
 
-Code: [![Version](https://badge.fury.io/rb/huborg.png)](http://badge.fury.io/rb/huborg)
+Code: [![Version](https://badge.fury.io/rb/huborg.svg)](https://rubygems.org/gems/huborg)
 
-Docs: [![Contribution Guidelines](http://img.shields.io/badge/CONTRIBUTING-Guidelines-blue.svg)](./CONTRIBUTING.md)
+Docs: [![Code Documentation](https://img.shields.io/badge/CODE-Documentation-blue.svg)](https://www.rubydoc.info/gems/huborg/) [![Contribution Guidelines](http://img.shields.io/badge/CONTRIBUTING-Guidelines-blue.svg)](./CONTRIBUTING.md)
 [![Apache 2.0 License](http://img.shields.io/badge/APACHE2-license-blue.svg)](./LICENSE)
 
 Jump in: [![Slack Status](http://slack.samvera.org/badge.svg)](http://slack.samvera.org/)
@@ -98,6 +98,21 @@ iterates on all of the repositories, adding any non-duplicates, then
 writing back to the template before creating pull requests against
 each of the organization's non-archived repositories.
 
+```ruby
+require 'huborg'
+# NOTE: You will need to include GITHUB_ACCESS_TOKEN in your ENV
+client = Huborg::Client.new(org_names: ["samvera", "samvera-labs"])
+File.open(File.join(ENV["HOME"], "/Desktop/pull-requests.tsv"), "w+") do |file|
+  file.puts "REPO_FULL_NAME\tPR_CREATED_AT\tPR_URL\tPR_TITLE"
+  client.each_pull_request_with_repo do |pull, repo|
+    file.puts "#{repo.full_name}\t#{pull.created_at}\t#{pull.html_url}\t#{pull.title}"
+  end
+end
+```
+
+The above will write a tab separated file of all of the open pull requests for
+the non-archived samvera and samvera-labs repositories.
+
 **All of the commands have several parameters, many set to default values.**
 
 ## Prerequisites
@@ -153,6 +168,7 @@ Below is the checklist:
 - [ ] Pull down the latest version of master
 - [ ] Update the Huborg::VERSION (in ./lib/huborg/version.rb); Remember, huborg
       uses [Semantic Versioning](https://semver.org). (_**NOTE:** Do not commit the version change_)
+      - [ ] To give some insight on what version to use, you can use `yard diff`. With a clean master branch, run `yard`. Then run `yard diff huborg-<Huborg::VERSION> .yardoc` (where Huborg::VERSION is something like 0.1.0 and `.yarddoc` is the output directory of `yard`).
 - [ ] Run `bundle exec rake changelog` to generate [CHANGELOG.md](./CHANGELOG.md)
 - [ ] Review the new Huborg::VERSION CHANGELOG.md entries as they might prompt
       you to consider a different version (e.g. what you thought was a bug fix

data/huborg.gemspec

@@ -13,7 +13,8 @@ Gem::Specification.new do |spec|
 
   spec.metadata["homepage_uri"] = spec.homepage
   spec.metadata["source_code_uri"] = "https://github.com/samvera-labs/huborg/"
-  spec.metadata["changelog_uri"] = "https://github.com/samvera-labs/huborg/CHANGELOG.md"
+  spec.metadata["changelog_uri"] = "https://github.com/samvera-labs/huborg/blob/master/CHANGELOG.md"
+  spec.metadata["documentation_uri"] = "https://www.rubydoc.info/gems/huborg/"
 
   # Specify which files should be added to the gem when it is released.
   # The `git ls-files -z` loads the files in the RubyGem that have been added into git.

data/lib/huborg.rb

@@ -256,6 +256,39 @@ module Huborg
       true
     end
 
+    # @api public
+    # @since v0.3.0
+    #
+    # Yield each pull request, and associated repository that matches the given
+    # parameters
+    #
+    # @param skip_archived [Boolean] skip any archived projects
+    # @param query [Hash] the query params to use when selecting pull requests
+    #
+    # @yieldparam [Oktokit::PullRequest] responds to #created_at, #title, #html_url, etc
+    # @yieldparam [Oktokit::Repository] responds to #full_name
+    #
+    # @example
+    #   require 'huborg'
+    #   client = Huborg::Client.new(org_names: ["samvera", "samvera-labs"])
+    #   File.open(File.join(ENV["HOME"], "/Desktop/pull-requests.tsv"), "w+") do |file|
+    #     file.puts "REPO_FULL_NAME\tPR_CREATED_AT\tPR_URL\tPR_TITLE"
+    #     client.each_pull_request_with_repo do |pull, repo|
+    #       file.puts "#{repo.full_name}\t#{pull.created_at}\t#{pull.html_url}\t#{pull.title}"
+    #     end
+    #   end
+    #
+    # @see https://developer.github.com/v3/pulls/#list-pull-requests
+    def each_pull_request_with_repo(skip_archived: true, query: { state: :open})
+      each_github_repository do |repo|
+        next if skip_archived && repo.archived?
+        fetch_rel_for(rel: :pulls, from: repo, query: query).each do |pull|
+          yield(pull, repo)
+        end
+      end
+      true
+    end
+
     private
 
     # Fetch all of the repositories for the initialized :org_names that
@@ -271,7 +304,7 @@ module Huborg
       repos = []
       org_names.each do |org_name|
         org = client.org(org_name)
-        repos += fetch_rel_for(rel: :repos, org: org)
+        repos += fetch_rel_for(rel: :repos, from: org)
       end
 
       repos.each do |repo|
@@ -376,26 +409,27 @@ module Huborg
     #
     # @param rel [Symbol] The name of the related object(s) for the
     #        given org
-    # @param org [Object] An Organization object (provided by Oktokit
-    #        object) from which this method fetchs the related :rel
+    # @param from [Object] The receiver of the rels method call. This could be
+    #        but is not limited to an Oktokit::Organization or
+    #        Oktokit::Repository.
     #
     # @return [Array<Object>]
-    def fetch_rel_for(rel:, org:)
+    def fetch_rel_for(rel:, from:, query: {})
       # Build a list of repositories, note per Github's API, these are
       # paginated.
-      logger.info "Fetching rels[#{rel.inspect}] for '#{org.login}' with pattern #{repository_pattern.inspect}"
-      source = org.rels[rel].get
+      from_to_s = from.respond_to?(:name) ? from.name : from.to_s
+      logger.info "Fetching rels[#{rel.inspect}] for '#{from_to_s}' with pattern #{repository_pattern.inspect} and query #{query.inspect}"
+      source = from.rels[rel].get(query)
       rels = []
       while source
         rels += source.data
         if source.rels[:next]
-          source = source.rels[:next].get
+          source = source.rels[:next].get(query)
         else
           source = nil
         end
       end
-      rels
-      logger.info "Finished rels[#{rel.inspect}] for '#{org.login}' with pattern #{repository_pattern.inspect}"
+      logger.info "Finished fetching rels[#{rel.inspect}] for '#{from_to_s}' with pattern #{repository_pattern.inspect} and query #{query.inspect}"
       if block_given?
         rels
       else

data/lib/huborg/version.rb

@@ -1,5 +1,5 @@
 module Huborg
   # The current version of Huborg, as per Semantic Versioning
   # @see https://semver.org
-  VERSION = "0.2.0"
+  VERSION = "0.3.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: huborg
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Jeremy Friesen
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-02-29 00:00:00.000000000 Z
+date: 2020-04-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: octokit
@@ -92,7 +92,8 @@ licenses: []
 metadata:
   homepage_uri: https://github.com/samvera-labs/huborg/
   source_code_uri: https://github.com/samvera-labs/huborg/
-  changelog_uri: https://github.com/samvera-labs/huborg/CHANGELOG.md
+  changelog_uri: https://github.com/samvera-labs/huborg/blob/master/CHANGELOG.md
+  documentation_uri: https://www.rubydoc.info/gems/huborg/
 post_install_message: 
 rdoc_options: []
 require_paths: