team_hub 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: e4df2f63bba276e6f1f8384bc73b23535a90c630
+  data.tar.gz: 7d509f467496347c158a4bcd54c75e551de893f6
+SHA512:
+  metadata.gz: fdb16d6c49f90a8676593707f711b6b0f50b54101c5a6b907aa955dab3fbfc18b379582e7bd2c2f34a57216186bf1a4b09fc762d7406327eb51015513cd446ac
+  data.tar.gz: ad82faa6f3cf1f9a41be6a3ceda873ffd32bfffd4329d0fe3f820488d840bd0a9a4358dad6223ef56a88831d9d8c45431ed10de03673b889f4135dcc392469f7

data/README.md

@@ -0,0 +1,81 @@
+## team_hub Gem
+
+[![Gem Version](https://badge.fury.io/rb/team_hub.svg)](https://badge.fury.io/rb/team_hub)
+[![Build Status](https://travis-ci.org/18F/team_hub.svg?branch=master)](https://travis-ci.org/18F/team_hub)
+[![Code Climate](https://codeclimate.com/github/18F/team_hub/badges/gpa.svg)](https://codeclimate.com/github/18F/team_hub)
+[![Test Coverage](https://codeclimate.com/github/18F/team_hub/badges/coverage.svg)](https://codeclimate.com/github/18F/team_hub)
+
+Contains reusable components extracted from the [18F Hub
+implementation](https://github.com/18F/hub) for creating a team Hub using
+[Jekyll](http://jekyllrb.com/). See the [18F Public
+Hub](https://18f.gsa.gov/hub/) for a running example.
+
+Downloads and API docs are available on the [team_hub RubyGems
+page](https://rubygems.org/gems/team_hub). API documentation is written
+using [YARD markup](http://yardoc.org/).
+
+Contributed by the 18F team, part of the United States General Services
+Administration: https://18f.gsa.gov/
+
+### Motivation
+
+The [18F Hub repository](https://github.com/18F/hub) aims to provide a
+lightweight, easily-adaptable template for websites like the [18F Public
+Hub](https://18f.gsa.gov/hub/), [to empower Instigators across the US federal
+government and beyond to spread modern software development
+practices](https://18f.gsa.gov/2014/12/23/hub/).  Consequently, 18F will be
+extracting more and more generic, reusable components into this gem, leaving
+the plugins in the 18F Hub repository very lean and declarative, so that
+others may more easily understand how to adapt the Hub template to their own
+team's needs.
+
+### Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'team_hub'
+```
+
+And then execute:
+```
+$ bundle
+```
+
+Or install it yourself as:
+```
+$ gem install team_hub
+```
+
+### Usage
+
+More documentation will be forthcoming as this gem is built up with features
+extracted from the 18F Hub. For now, see the [18F Hub Plugins
+directory](https://github.com/18F/hub/tree/master/_plugins) to see how parts
+of `team_hub` are currently used, and to see hints of functionality that will
+be added to `team_hub` in the near future.
+
+### Contributing
+
+1. Fork it ( https://github.com/18F/team_hub/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request
+
+Feel free to ping [@mbland](https://github.com/mbland) with any questions you
+may have, especially if the current documentation should've addressed your
+needs, but didn't.
+
+### Public domain
+
+This project is in the worldwide [public domain](LICENSE.md). As stated in
+[CONTRIBUTING](CONTRIBUTING.md):
+
+> This project is in the public domain within the United States, and copyright
+> and related rights in the work worldwide are waived through the
+> [CC0 1.0 Universal public domain dedication](https://creativecommons.org/publicdomain/zero/1.0/).
+>
+> 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.

data/lib/team_hub.rb

@@ -0,0 +1,19 @@
+# team_hub - Components for creating a team Hub using Jekyll
+#
+# Written in 2015 by Mike Bland (michael.bland@gsa.gov)
+# on behalf of the 18F team, part of the US General Services Administration:
+# https://18f.gsa.gov/
+#
+# To the extent possible under law, the author(s) have dedicated all copyright
+# and related and neighboring rights to this software to the public domain
+# worldwide. This software is distributed without any warranty.
+#
+# You should have received a copy of the CC0 Public Domain Dedication along
+# with this software. If not, see
+# <https://creativecommons.org/publicdomain/zero/1.0/>.
+#
+# @author Mike Bland (michael.bland@gsa.gov)
+
+require 'team_hub/canonicalizer'
+require 'team_hub/version'
+require 'team_hub/page'

data/lib/team_hub/canonicalizer.rb

@@ -0,0 +1,28 @@
+# team_hub - Components for creating a team Hub using Jekyll
+#
+# Written in 2015 by Mike Bland (michael.bland@gsa.gov)
+# on behalf of the 18F team, part of the US General Services Administration:
+# https://18f.gsa.gov/
+#
+# To the extent possible under law, the author(s) have dedicated all copyright
+# and related and neighboring rights to this software to the public domain
+# worldwide. This software is distributed without any warranty.
+#
+# You should have received a copy of the CC0 Public Domain Dedication along
+# with this software. If not, see
+# <https://creativecommons.org/publicdomain/zero/1.0/>.
+#
+# @author Mike Bland (michael.bland@gsa.gov)
+
+module TeamHub
+
+  # Contains utility functions for canonicalizing names and the order of data.
+  class Canonicalizer
+
+    # Returns a canonicalized, URL-friendly substitute for an arbitrary string.
+    # +s+:: string to canonicalize
+    def self.canonicalize(s)
+      s.downcase.gsub(/\s+/, '-')
+    end
+  end
+end

data/lib/team_hub/page.rb

@@ -0,0 +1,129 @@
+# team_hub - Components for creating a team Hub using Jekyll
+#
+# Written in 2015 by Mike Bland (michael.bland@gsa.gov)
+# on behalf of the 18F team, part of the US General Services Administration:
+# https://18f.gsa.gov/
+#
+# To the extent possible under law, the author(s) have dedicated all copyright
+# and related and neighboring rights to this software to the public domain
+# worldwide. This software is distributed without any warranty.
+#
+# You should have received a copy of the CC0 Public Domain Dedication along
+# with this software. If not, see
+# <https://creativecommons.org/publicdomain/zero/1.0/>.
+#
+# @author Mike Bland (michael.bland@gsa.gov)
+
+require_relative 'canonicalizer'
+
+require 'jekyll'
+
+module TeamHub
+  # Hub-specfic Page object that standardizes how pages are generated.
+  #
+  # This Page object allows us to create target pages on the fly using
+  # ::Jekyll::Generator plugins. Just creating factory functions that invoke
+  # ::Jekyll::Page.new cause initialization failures, as
+  # ::Jekyll::Page::initialize will try to open the page specified by
+  # File.join(base, dir, filename) directly. 
+  class Page < ::Jekyll::Page
+    private_class_method :new
+
+    # @param site [Jekyll::Site] Jekyll site object
+    # @param page_dir [String] directory containing the generated page
+    # @param filename [String] generated page file name
+    # @param layout [String] Jekyll page layout for the generated page
+    # @param title [String] page title
+    def initialize(site, page_dir, filename, layout, title)
+      @site = site
+      @base = site.source
+      @dir = page_dir
+      @name = filename
+
+      self.process(filename)
+      self.read_yaml(File.join(site.source, '_layouts'), layout)
+      title_format = site.config['generated_page_title_format'] || '%s'
+      self.data['title'] = title_format % title
+    end
+
+    # Creates a +TeamHub::Page+ object and adds it to +site.pages+.
+    #
+    # @param site [Jekyll::Site] Jekyll site object
+    # @param page_dir [String] directory containing the generated page
+    # @param filename [String] generated page file name
+    # @param layout [String] Jekyll page layout for the generated page
+    # @param title [String] page title
+    # @return [TeamHub::Page]
+    def self.generate(site, page_dir, filename, layout, title)
+      page = new(site, page_dir, filename, layout, title)
+      site.pages << page
+      page
+    end
+
+    # Generates a series of +TeamHub::Page+ objects for each item in
+    # +site.data[+collection_name], where the collection is a
+    # +Hash<String, Hash>+ or an +Array<Hash>, and adds them to +site.pages+.
+    #
+    # @param site [Jekyll::Site] Jekyll site object
+    # @param collection_name [String] key into site.data
+    # @param item_name [String] identifies the item page layout using the
+    #   format "#{item_name}.html" and the property used to access item data
+    #   within the layout (i.e. +page.item_name+)
+    # @param title_key [String] hash key of the item field used to generate
+    #   the page title, i.e. item[title_key]
+    # @param primary_key [String] hash key corresponding to the unique
+    #   identifier within each item, i.e. item[primary_key]; required if the
+    #   collection is an Array
+    # @param collection_dir [String] if specified, the directory into which
+    #   pages will be generated; otherwise +collection_name+ will be used as
+    #   the directory name
+    # @param [String] if specified, a format string containing a '%s' field
+    #   used to generate page titles from item[title_key]; otherwise
+    #   item[title_key] will be used to generate the title directly
+    def self.generate_collection_item_pages(site, collection_name, item_name,
+      title_key, primary_key: nil, collection_dir: nil, title_format: '%s')
+      collection_dir = collection_name unless collection_dir
+      get_collection(site, collection_name, primary_key).each do |id, item|
+        page = generate(site, File.join(collection_dir, id),
+          'index.html', "#{item_name}.html", title_format % item[title_key])
+        page.data[item_name] = item
+      end
+    end
+
+    # Raised by +get_collection+ if +site.data[+collection_name] is of the
+    # wrong type.
+    class CollectionTypeError < ::Exception
+    end
+
+    # Retrieves site.data[collection_name]. Converts an Array<Hash> into a
+    # Hash, and returns the empty hash if site.data[collection_name] does not
+    # exist.
+    #
+    # @param site [Jekyll::Site] Jekyll site object
+    # @param collection_name [String] key into site.data
+    # @param primary_key [String] hash key corresponding to the unique
+    #   identifier within each item, i.e. item[primary_key]; required if the
+    #   collection is an Array
+    # @return [Hash] a hash from item ID => item
+    # @raise [CollectionTypeError] if site.data[collection_name] isn't a Hash
+    #   or an Array
+    def self.get_collection(site, collection_name, primary_key)
+      collection = site.data[collection_name] || {}
+
+      if collection.instance_of? ::Hash
+        collection
+      elsif collection.instance_of? ::Array
+        collection_hash = {}
+        collection.each do |item|
+          id = Canonicalizer.canonicalize(item[primary_key])
+          collection_hash[id] = item
+        end
+        collection_hash
+      else
+        raise CollectionTypeError.new("site.data[#{collection_name}] " +
+          "should be a Hash<String, Hash> or an Array<Hash>, " +
+          "but is of type #{collection.class}")
+      end
+    end
+  end
+end

data/lib/team_hub/version.rb

@@ -0,0 +1,27 @@
+# team_hub - Components for creating a team Hub using Jekyll
+#
+# Written in 2015 by Mike Bland (michael.bland@gsa.gov)
+# on behalf of the 18F team, part of the US General Services Administration:
+# https://18f.gsa.gov/
+#
+# To the extent possible under law, the author(s) have dedicated all copyright
+# and related and neighboring rights to this software to the public domain
+# worldwide. This software is distributed without any warranty.
+#
+# You should have received a copy of the CC0 Public Domain Dedication along
+# with this software. If not, see
+# <https://creativecommons.org/publicdomain/zero/1.0/>.
+#
+# @author Mike Bland (michael.bland@gsa.gov)
+#
+# ---
+#
+# This gem contains components from the 18F Hub that are reusable across Hub
+# implementations. The 18F Public Hub is hosted at:
+#   https://18f.gsa.gov/hub/
+# The 18F Hub repository is:
+#   https://github.com/18F/hub"
+
+module TeamHub
+  VERSION = "0.0.1"
+end

metadata

@@ -0,0 +1,152 @@
+--- !ruby/object:Gem::Specification
+name: team_hub
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Mike Bland
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-01-11 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: hash-joiner
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: weekly_snippets
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: jekyll
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: codeclimate-test-reporter
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: |-
+  Contains resuable components extracted from the 18F Hub implementation for creating a team hub using Jekyll. See the 18F Public Hub for a running example:
+    https://18f.gsa.gov/hub/
+  The 18F Hub repository is:
+    https://github.com/18F/hub
+email:
+- michael.bland@gsa.gov
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- README.md
+- lib/team_hub.rb
+- lib/team_hub/canonicalizer.rb
+- lib/team_hub/page.rb
+- lib/team_hub/version.rb
+homepage: https://github.com/18F/team_hub
+licenses:
+- CC0
+metadata: {}
+post_install_message: 
+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: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: Components for creating a team Hub using Jekyll
+test_files: []
+has_rdoc: