guides_style_18f 0.0.1 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 33166601f73e4e3de2c486510d864ba4a0287ddc
-  data.tar.gz: 59c1b03d44b1bc245abec3fcd3e2cdd6e185db95
+  metadata.gz: ea930944731dbf4c720382a295ad2f8d1298db6f
+  data.tar.gz: 5f462e287ce9fee7fc67bbd2ec146b991bdc56db
 SHA512:
-  metadata.gz: 5b2b60050dc12ada4d745a798b9a5f46d888513598f6bcc92062e6a3fa5dab617ca88e3fa254477fef21041aba1690ff0521cc77861272d68d2ce2ddb0971e53
-  data.tar.gz: e09a3773e817951991a3f5e64c73c0a4bddd962f1f93b59addd076168148c3ac46574bf0895ca59455800eedba43b657b4f7b7f50023312913b288e0f87b8569
+  metadata.gz: 308c09132a3f41e8fb39cc4b897753c3fc4cee371f13dce3ea4c44ed0152fc7e1df605ff7d3c91ce8623d0c905e599ca482a5125fcec2fa1883415b1d1916e2c
+  data.tar.gz: 9164d3b7762a6c7c7f0ace8e095ccc55f5824776a6c95e68b5e86cc1cac46fabc6a0888b9192c65222d10a8d60e93789bd3c017ef940912072190f81211885da

data/lib/guides_style_18f.rb

@@ -4,5 +4,7 @@ require 'guides_style_18f/assets'
 require 'guides_style_18f/generator'
 require 'guides_style_18f/includes'
 require 'guides_style_18f/layouts'
+require 'guides_style_18f/navigation'
+require 'guides_style_18f/repository'
 require 'guides_style_18f/sass'
 require 'guides_style_18f/version'

data/lib/guides_style_18f/generator.rb

@@ -1,6 +1,6 @@
 # @author Mike Bland (michael.bland@gsa.gov)
 
-require 'jekyll/generator'
+require 'jekyll'
 
 module GuidesStyle18F
   class Generator < ::Jekyll::Generator

data/lib/guides_style_18f/navigation.rb

@@ -0,0 +1,121 @@
+# @author Mike Bland (michael.bland@gsa.gov)
+
+require 'safe_yaml'
+
+module GuidesStyle18F
+  # Automatically updates the `navigation:` field in _config.yml.
+  #
+  # Does this by parsing the front matter from files in `pages/`. Preserves the
+  # existing order of items in `navigation:`, but new items may need to be
+  # reordered manually.
+  def self.update_navigation_configuration(basedir)
+    config_path = File.join basedir, '_config.yml'
+    config_data = SafeYAML.load_file config_path, safe: true
+    return unless config_data
+    nav_data = config_data['navigation'] || []
+    nav_data = update_navigation_data nav_data, basedir
+    write_navigation_data_to_config_file config_path, nav_data
+  end
+
+  def self.update_navigation_data(nav_data, basedir)
+    pages_data = pages_front_matter basedir
+    children = pages_data['children'].map { |child| child['title'].downcase }
+    nav_data.reject! { |nav| children.include? nav['text'].downcase }
+    update_parent_nav_data nav_data, pages_data['parents']
+    add_children_to_parents nav_data, pages_data['children']
+  end
+  private_class_method :update_navigation_data
+
+  def self.pages_front_matter(basedir)
+    front_matter = Dir[File.join basedir, 'pages', '**', '*.md'].map do |f|
+      SafeYAML.load_file f, safe: true
+    end
+    pages_data = front_matter.group_by do |fm|
+      fm['parent'].nil? ? 'parents' : 'children'
+    end
+    %w(parents children).each { |category| pages_data[category] ||= [] }
+    pages_data
+  end
+  private_class_method :pages_front_matter
+
+  def self.update_parent_nav_data(nav_data, parents)
+    nav_by_title = nav_data_by_title nav_data
+    parents.each do |page|
+      page_nav = page_nav page
+      title = page_nav['text'].downcase
+      if nav_by_title.member? title
+        nav_by_title[title].merge! page_nav
+      else
+        nav_data << page_nav
+      end
+    end
+  end
+  private_class_method :update_parent_nav_data
+
+  def self.nav_data_by_title(nav_data)
+    nav_data.map { |nav| [nav['text'].downcase, nav] }.to_h
+  end
+  private_class_method :nav_data_by_title
+
+  def self.page_nav(front_matter)
+    { 'text' => front_matter['title'],
+      'url' => "#{front_matter['permalink'].split('/').last}/",
+      'internal' => true,
+    }
+  end
+  private_class_method :page_nav
+
+  def self.add_children_to_parents(nav_data, children)
+    parents_by_title = nav_data_by_title nav_data
+    children.each { |child| add_child_to_parent child, parents_by_title }
+    nav_data
+  end
+  private_class_method :add_children_to_parents
+
+  def self.add_child_to_parent(child, parents_by_title)
+    child_nav_data = page_nav child
+    title = child_nav_data['text'].downcase
+    parent = parent child, parents_by_title
+    children = parent['children'] ||= []
+    children_by_title = children.map { |c| [c['text'].downcase, c] }.to_h
+
+    if children_by_title.member? title
+      children_by_title[title].merge! child_nav_data
+    else
+      children << child_nav_data
+    end
+  end
+  private_class_method :add_child_to_parent
+
+  def self.parent(child, parents_by_title)
+    parent = parents_by_title[child['parent'].downcase]
+    return parent unless parent.nil?
+    fail StandardError, 'Parent page not present in existing ' \
+      "config: \"#{child['parent']}\" needed by: \"#{child['title']}\""
+  end
+  private_class_method :parent
+
+  def self.write_navigation_data_to_config_file(config_path, nav_data)
+    lines = []
+    in_navigation = false
+    open(config_path).each_line do |line|
+      in_navigation = process_line line, lines, nav_data, in_navigation
+    end
+    File.write config_path, lines.join
+  end
+  private_class_method :write_navigation_data_to_config_file
+
+  def self.process_line(line, lines, nav_data, in_navigation = false)
+    if !in_navigation && line.start_with?('navigation:')
+      lines << line << nav_data.to_yaml["---\n".size..-1]
+      in_navigation = true
+    elsif in_navigation
+      in_navigation = line.start_with?(' ') || line.start_with?('-')
+      lines << line unless in_navigation
+    else
+      lines << line
+    end
+    in_navigation
+  end
+  private_class_method :process_line
+end

data/lib/guides_style_18f/repository.rb

@@ -0,0 +1,74 @@
+# @author Mike Bland (michael.bland@gsa.gov)
+
+require 'English'
+require 'fileutils'
+
+module GuidesStyle18F
+  TEMPLATE_FILES = %w(
+    pages/child-page.md
+    pages/config.md
+    pages/github.md
+    pages/images.md
+    pages/new-page.md
+    pages/posting.md
+    images/18f-pages.png
+    images/description.png
+    images/gh-add-guide.png
+    images/gh-branches-link.png
+    images/gh-default-branch.png
+    images/gh-settings-button.png
+    images/gh-webhook.png
+    images/images.png
+  )
+
+  def self.clear_template_files_and_create_new_repository(
+    basedir, outstream = $stdout)
+    remove_template_files basedir, outstream
+    delete_create_repo_command_from_go_script basedir, outstream
+    create_new_git_repository basedir, outstream
+  end
+
+  def self.remove_template_files(basedir, outstream)
+    Dir.chdir basedir do
+      outstream.puts 'Clearing Guides Template files.'
+      files = TEMPLATE_FILES.map { |f| File.join basedir, f }
+        .select { |f| File.exist? f }
+      File.delete(*files)
+    end
+  end
+
+  def self.delete_create_repo_command_from_go_script(basedir, outstream)
+    Dir.chdir basedir do
+      outstream.puts 'Removing `:create_repo` command from the `./go` script.'
+      go_script = File.join basedir, 'go'
+      content = File.read go_script
+      match = /\ndef_command\(\n  :create_repo,.*?end\n/m.match content
+      content = "#{match.pre_match}#{match.post_match}" unless match.nil?
+      File.write go_script, content
+    end
+  end
+
+  GIT_COMMANDS = {
+    'Creating a new git repository.' => 'git init',
+    'Creating 18f-pages branch.' => 'git checkout -b 18f-pages',
+    'Adding files for initial commit.' => 'git add .',
+  }
+
+  def self.create_new_git_repository(basedir, outstream)
+    Dir.chdir basedir do
+      outstream.puts 'Removing old git repository.'
+      FileUtils.rm_rf '.git'
+      GIT_COMMANDS.each do |description, command|
+        outstream.puts description
+        exec_cmd_capture_output command, outstream
+      end
+      outstream.puts "All done! Run \'git commit\' to create your first commit."
+    end
+  end
+  private_class_method :create_new_git_repository
+
+  def self.exec_cmd_capture_output(command, outstream)
+    opts = { out: outstream, err: outstream }
+    exit $CHILD_STATUS.exitstatus unless system command, opts
+  end
+end

data/lib/guides_style_18f/sass/_guides_style_18f_main.scss

@@ -168,10 +168,7 @@ Navigation
 
 .sidebar-nav a {
   display: block;
-  padding-bottom: 10px;
-  padding-right: 10px;
-  padding-left: 14px;
-  padding-top: 10px;
+  padding: 10px;
   -webkit-transition: .4s;
   transition: .4s;
   width: 80%;
@@ -203,6 +200,7 @@ Navigation
   list-style: none;
   border-bottom: 1px solid #babbbd;
   font-size: 1.125em;
+  padding-left: 4px;
   overflow: hidden;
 }
 

data/lib/guides_style_18f/version.rb

@@ -1,5 +1,5 @@
 # @author Mike Bland (michael.bland@gsa.gov)
 
 module GuidesStyle18F
-  VERSION = '0.0.1'
+  VERSION = '0.1.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: guides_style_18f
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.1.0
 platform: ruby
 authors:
 - Mike Bland
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-08-22 00:00:00.000000000 Z
+date: 2015-08-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: jekyll
@@ -66,6 +66,48 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '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'
+- !ruby/object:Gem::Dependency
+  name: coveralls
+  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: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -80,6 +122,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  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: Provides consistent style elements for documents based on the 18F Guides
   Template (https://pages.18f.gov/guides-template/). The 18F Guides theme is based
   on DOCter (https://github.com/cfpb/docter/) from CFPB (http://cfpb.github.io/).
@@ -117,6 +173,8 @@ files:
 - lib/guides_style_18f/includes/sidebar.html
 - lib/guides_style_18f/layouts.rb
 - lib/guides_style_18f/layouts/default.html
+- lib/guides_style_18f/navigation.rb
+- lib/guides_style_18f/repository.rb
 - lib/guides_style_18f/sass.rb
 - lib/guides_style_18f/sass/_guides_style_18f_custom.scss
 - lib/guides_style_18f/sass/_guides_style_18f_main.scss