team_api 0.0.8 → 0.0.9

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b082409d55f76bea8898d5a6c1de80965ba7c131
-  data.tar.gz: aba420884aa800ce9b6f081c7cb19f52d7322a02
+  metadata.gz: bf53595241cc4fe02b10a666a10f9f3ab5ca8389
+  data.tar.gz: a1bf4c5f116949067db9fb6c661f552ee958d455
 SHA512:
-  metadata.gz: c65b65e63296bc6df730f2fca3b79c9a1223170d73ae86d53d587556a6c195e891b761cba248ed37e1e2927170877044e53eac5cd1ff735ed523689d9fb4e439
-  data.tar.gz: 9992a74f2887388b34a7c5742a358b138e6bb77a7d01326c931ca73f12c2b90bf43305ddaf73cb57be6f5a3e6833c80a51f217525341eb85e456d9b682e7acec
+  metadata.gz: 01198398379e2c70866c6face0ef88b760fe86f515b97672571d16c40a2075b342bea5ee156b5304c547d68275f4c40947a423c94135b9df364dc74c761a4567
+  data.tar.gz: 9e3d039c425ad69a4d96d253c87aaaf542088a887ad5476543eab2c0db407ec5b7992c23f00b9834ad3869d87535a7a95cba60310af1c4fffe72fab65c1f3799

data/CONTRIBUTING.md

@@ -1,14 +1,5 @@
 ## Welcome!
 
-### Code of conduct
-
-We aspire to create a welcoming environment for collaboration on this project.
-To that end, we follow the [18F Code of
-Conduct](https://github.com/18F/code-of-conduct/blob/master/code-of-conduct.md)
-and ask that all contributors do the same.
-
-### Getting started
-
 We're so glad you're thinking about contributing to an 18F open source project!
 If you're unsure or afraid of anything, just ask or submit the issue or pull
 request anyways. The worst that can happen is that you'll be politely asked to
@@ -16,25 +7,13 @@ change something. We appreciate any sort of contribution, and don't want a wall
 of rules to get in the way of that.
 
 Before contributing, we encourage you to read our CONTRIBUTING policy (you are
-here), our [LICENSE](LICENSE.md), and our [README](REAMDE.md). If you have any
-questions, or want to read more about our underlying policies, you can consult
-the [18F Open Source Policy GitHub
-repository](https://github.com/18f/open-source-policy), or just shoot us an
-email/official government letterhead note to [18f@gsa.gov](mailto:18f@gsa.gov).
-
-### Submitting a pull request
-
-1. Fork the repository or create a branch if you are part of the 18F Team on
-   GitHub
-2. Implement your feature or bug fix (and add test coverage if applicable)
-3. Run the tests (`$ ./go test`) to make sure nothing is broken
-4. Add, commit, and push your changes
-5. [Submit a pull
-   request](https://help.github.com/articles/using-pull-requests/)
-6. Another contributor will merge your pull request into master when it is deemed
-   ready
-
-### Public domain
+here), our LICENSE, and our README, all of which should be in this repository.
+If you have any questions, or want to read more about our underlying policies,
+you can consult the 18F Open Source Policy GitHub repository at
+https://github.com/18f/open-source-policy, or just shoot us an email/official
+government letterhead note to [18f@gsa.gov](mailto:18f@gsa.gov).
+
+## Public domain
 
 This project is in the public domain within the United States, and
 copyright and related rights in the work worldwide are waived through
@@ -43,3 +22,64 @@ the [CC0 1.0 Universal public domain dedication](https://creativecommons.org/pub
 All contributions to this project will be released under the CC0
 dedication. By submitting a pull request, you are agreeing to comply
 with this waiver of copyright interest.
+
+## Starting work on an issue
+
+Issues that are marked with the `ready` label are ripe for the picking!  Simply
+assign yourself to the issue to and change its label to `in progress` to
+indicate that you are working on it.
+
+If the issue involves writing code or producing some other change that will
+result in a pull request, begin by creating yourself a branch with a short
+descriptive name of the work that includes the issue number at the end, e.g.,
+`document-pr-process-#36`.
+
+**Note:** If you are not a part of the 18F Team, please fork the repository
+first and then create a branch for yourself with the same convention.
+
+Once your local branch is created, simply push it remotely and this will
+assign the issue to you and move it to be `in progress` automatically.
+
+## Submitting a pull request and completing work
+
+When you are satisfied with your work and ready to submit it to be completed,
+please submit a pull request for review.  If you haven't already, please
+follow the instructions above and create a branch for yourself first.  Prior
+to submitting the pull request, please make note of the following:
+
+1. Code changes should be accompanied by tests.
+2. Please run the tests (`$ ./go test`) to make sure there are no regressions.
+
+Once everything is ready to go, [submit your pull request](https://help.github.com/articles/using-pull-requests/)!
+When creating a pull request please be sure to reference the issue number it
+is associated with, preferably in the title.
+
+If you are working in a branch off of the 18F/team_api repo directly, you can
+reference the issue like this:
+`Closes #45: Short sentence describing the pull request`
+
+If you are working in a forked copy of the repo, please reference the issue
+like this:
+`Closes 18F/team_api#45:  Short sentence describing the pull request`
+
+In both cases, please include a descriptive summary of the change in the body
+of the pull request as that will help greatly in reviewing the change and
+understanding what should be taking place inside of it.
+
+By referencing the issue in the pull request as noted above, this will
+automatically update the issue with a `needs review` label and notify the
+collaborators on the project that something is ready for a review.  One of us
+will take a look as soon as we can and initiate the review process, provide
+feedback as necessary, and ultimately merge the change.
+
+Once the code is merged, the branch will be deleted and the `in review`
+label will be removed.  The issue will be automatically updated again to be
+marked as Done and Closed.
+
+## Performing a review of a pull request
+
+If you are performing a review of a pull request please add the `in review`
+label to the pull request and be sure keep the `needs review` label
+associated with it.  This will help keep our Waffle board up-to-date and
+reflect that the pull request is being actively reviewed.  Also, please
+assign yourself so others know who the primary reviewer is.

data/lib/team_api/cross_reference_data.rb

@@ -55,27 +55,32 @@ module TeamApi
     # @param source_to_target_field [String] if specified, the field from this
     #   collection's objects that contain identifiers of objects stored within
     #   target; if not specified, target.collection_name will be used instead
-    def create_xrefs(target, source_to_target_field: nil)
+    def create_xrefs(target, source_to_target_field: nil, alternate_names: nil)
+      item_xref_fields << 'deprecated_name'
+
       target_collection_field = source_to_target_field || target.collection_name
       data.values.each do |source|
-        create_xrefs_for_source source, target_collection_field, target
+        create_xrefs_for_source source, target_collection_field, target, alternate_names
       end
       target.data.values.each { |item| (item[collection_name] || []).uniq! }
     end
 
     private
 
-    def create_xrefs_for_source(source, target_collection_field, target)
+    def create_xrefs_for_source(source, target_collection_field, target, alternate_names)
       source_xref = item_to_xref source
-      target_ids = filter_target_ids target, source, target_collection_field
+      target_ids = filter_target_ids target, source, target_collection_field, alternate_names
       link_source_to_targets source_xref, target_ids, target
       source[target_collection_field] = target_xrefs target, target_ids
     end
 
-    def filter_target_ids(target_xref, source_item, target_collection_field)
+    def filter_target_ids(target_xref, source_item, target_collection_field, alternate_names)
       (source_item[target_collection_field] || []).map do |target_id|
         if target_xref.data.member? target_id
           target_id
+        elsif alternate_names && alternate_names[target_id] &&
+            (target_xref.data.member? alternate_names[target_id])
+          alternate_names[target_id]
         elsif !public_mode
           fail UnknownCrossReferenceTargetId, unknown_cross_reference_msg(
             collection_name, source_item, target_collection_field,

data/lib/team_api/cross_referencer.rb

@@ -23,9 +23,13 @@ module TeamApi
       team, projects, working_groups, guilds = create_xref_data site
 
       projects.create_xrefs team
+      name_xrefs = create_name_xrefs team
+
       [working_groups, guilds].each do |grouplet|
-        grouplet.create_xrefs team, source_to_target_field: 'leads'
-        grouplet.create_xrefs team, source_to_target_field: 'members'
+        grouplet.create_xrefs team, source_to_target_field: 'leads',
+            alternate_names: name_xrefs
+        grouplet.create_xrefs team, source_to_target_field: 'members',
+            alternate_names: name_xrefs
       end
 
       xref_tags_and_team_members site, TAG_CATEGORIES, team
@@ -41,6 +45,15 @@ module TeamApi
     end
     private_class_method :create_xref_data
 
+    def self.create_name_xrefs(team)
+      name_xrefs = {}
+      team.data.each do |member|
+        name_xrefs[member.last['deprecated_name']] =
+            member.last['name'] if member.last['deprecated_name']
+      end
+      name_xrefs
+    end
+
     def self.xref_tags_and_team_members(site, tag_categories, team_xref)
       team = (site.data['team'] || {})
       tag_categories.each do |category|

data/lib/team_api/joiner.rb

@@ -151,7 +151,8 @@ module TeamApi
 
     def store_project_errors(project, errors)
       project['errors'] = errors
-      name = project['github'][0] || project['name']
+      name = project['github'][0] if project['github']
+      name ||= project['name']
       data['errors'][name] = errors
     end
 

data/lib/team_api/version.rb

@@ -1,5 +1,5 @@
 # @author Mike Bland (michael.bland@gsa.gov)
 
 module TeamApi
-  VERSION = '0.0.8'
+  VERSION = '0.0.9'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: team_api
 version: !ruby/object:Gem::Version
-  version: 0.0.8
+  version: 0.0.9
 platform: ruby
 authors:
 - Mike Bland
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-11-02 00:00:00.000000000 Z
+date: 2015-12-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler