markdown-helpers 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 7d195ce1a339bdbd1d82427afd58d0634bd9af51
+  data.tar.gz: 35b15149f335408471568967cdbc2a178a814690
+SHA512:
+  metadata.gz: 6af36d716dc6b80b54ff3b0742a51a0034750f913c1e08f8ab9feef2fd17cb234f9fde2d5317a46f988ec738224a873c1c41eb9aa22412f54f652c9f81951368
+  data.tar.gz: 74b256a38c0a59e61ac6b9cba1905d386ef84451a0f30555689da285f7d519371a6d221b448040e7649af79ad7b8c29bbe441eee5c0b19e31a9dad36e2656d6a

data/bin/markdownh

@@ -0,0 +1,20 @@
+#!/usr/bin/env ruby
+require 'markdown-helpers'
+require 'thor'
+
+# 'markdownh' CLI
+class MarkdownH < Thor
+  desc 'check_links CONFIG', 'check for broken links'
+  def check_links(config)
+    LinkChecker.new(config).check
+  end
+
+  desc 'generate_index CONFIG', 'generate a markdown link tree'
+  def generate_index(config)
+    doc_builder = DocBuilder.new(config)
+    doc_builder.generate_index
+    doc_builder.write
+  end
+end
+
+MarkdownH.start(ARGV)

data/lib/markdown-helpers/doc_tree_builder.rb

@@ -0,0 +1,104 @@
+require 'erb'
+require 'yaml'
+
+# Class for building an index tree from
+# erb and directory root
+class DocBuilder
+  def initialize(config_file)
+    @config = YAML.load_file(config_file)
+    @config['base_header'] ||= ''
+    @config['base_level'] ||= 1
+    if @config['base_level'] < 1
+      puts ':base_level must be greater than 0'
+      exit
+    end
+    @config['ignore'] ||= []
+    @doc_index = ''
+  end
+
+  # recursive call on directories starting at @doc_directory
+  # writes indented list block for each directory
+  def generate_index(
+    options = {
+      directory: @config['doc_directory'],
+      level: @config['base_level'],
+      header_level: @config['base_header']
+    }
+  )
+    sub_directories = Dir.entries(options[:directory])
+    directory_last = true
+    sub_directories.each do |filename|
+      next if ignore_file?(filename, options[:directory])
+      path = File.join(options[:directory], filename)
+      if File.directory?(path)
+        # case where two directories are back to back
+        options[:level] = options[:level] - 1 if directory_last && options[:level] > 0
+        concat_directory(path, options[:level] + 1, options[:header_level])
+        directory_last = true
+      else
+        concat_file(path, options[:level])
+        directory_last = false
+      end
+    end
+  end
+
+  def write
+    template = File.read(@config['erb_path'])
+    erb = ERB.new(template)
+    File.write(@config['output_file'], erb.result(binding))
+  end
+
+  private
+
+  # format and concat directory
+  def concat_directory(path, level, header_level)
+    indent = '  ' * (level)
+    description = File.basename(path)
+                  .split('_') # split on underscores
+                  .map(&:capitalize) # capitalize each word
+                  .join(' ') # make it one string
+    repo_path = path.sub(File.dirname(@config['output_file']), '.')
+    # return if nothing below directory
+    return if empty_directory?(path)
+    @doc_index << "\n#{indent}#{header_level} [#{description}](#{repo_path})\n"
+    generate_index(directory: path, level: level, header_level: header_level + '#')
+  end
+
+  # format and concat file
+  def concat_file(path, level)
+    indent = '  ' * (level)
+    line = File.open(path, &:readline)
+    repo_path = path.sub(File.dirname(@config['output_file']), '.')
+    description = line.sub(/^#* */, '').chomp
+    @doc_index << "#{indent}- [#{description}](#{repo_path})\n"
+  end
+
+  # empty == no subdirectories with .md files
+  def empty_directory?(directory)
+    Dir.entries(directory).each do |filename|
+      next if ignore_file?(filename, directory)
+      return false if filename.include?('.md')
+      path = File.join(directory, filename)
+      return false if File.directory?(path) && !empty_directory?(path)
+    end
+    return true
+  end
+
+  def ignore_file?(filename, directory)
+    path = File.join(directory, filename)
+    # current or parent dir
+    if filename == '.' || filename == '..'
+      return true
+    # explicit ignore in config
+    elsif @config['ignore'].include?(filename)
+      return true
+    # symlinks, because of infinite loops on dir's
+    elsif File.symlink?(path)
+      return true
+    # is it a non-md file?
+    elsif File.file?(path) && !filename.include?('.md')
+      return true
+    end
+    return false
+  end
+end

data/lib/markdown-helpers/link_checker.rb

@@ -0,0 +1,162 @@
+require 'net/http'
+require 'octokit'
+require 'yaml'
+
+# Class to help verify local and external links
+class LinkChecker
+  HTTP_ERRORS = [
+    EOFError,
+    Errno::ECONNRESET,
+    Errno::EINVAL,
+    Net::HTTPBadResponse,
+    Net::HTTPHeaderSyntaxError,
+    Net::ProtocolError,
+    Timeout::Error,
+    SocketError
+  ]
+  def initialize(config_file)
+    @config = YAML.load_file(config_file)
+    unless @config['include'] && @config['include'].any?
+      puts "Must declare files in 'include' of config".red
+      exit 1
+    end
+    @broken_links = []
+  end
+
+  def check
+    @config['include'].each do |included|
+      included_object = IncludeItem.new(included)
+      included_object.check_paths
+      @broken_links << included_object.broken_links.flatten
+    end
+    @broken_links.flatten!
+    if @broken_links.any?
+      @broken_links.each do |link_hash|
+        output = "Broken link: '#{link_hash['link']}'\n" \
+          " in file: '#{link_hash[:file]}'\n" \
+          " on line '#{link_hash[:line_number]}'"
+        puts output.red
+      end
+      exit(1)
+    else
+      puts 'No broken links :)'
+    end
+  end
+
+  # Helper class for dealing with each included item in config
+  class IncludeItem
+    attr_reader :broken_links
+
+    def initialize(config)
+      @config = config
+      @broken_links = []
+      @config['replacements'] ||= {}
+      @config['private_github'] ||= false
+      return unless @config['private_github']
+      unless ENV['GITHUB_OAUTH_TOKEN']
+        puts "Must specify 'GITHUB_OAUTH_TOKEN' env variable to use 'private_github' config option"
+        exit(1)
+      end
+      @github_client = Octokit::Client.new(access_token: ENV['GITHUB_OAUTH_TOKEN'])
+    end
+
+    # iterate over list of paths
+    def check_paths
+      @config['paths'].each do |path|
+        check_path(path)
+      end
+    end
+
+    # glob each path
+    def check_path(path)
+      files = Dir.glob(path).select { |f| File.file?(f) } # only want files
+      files.each do |filename|
+        check_file(filename)
+      end
+    end
+
+    def check_file(filename)
+      file = File.open(filename, 'r')
+      file.each_with_index do |line, index|
+        return false if @config['exclude_comment'] && line.include?(@config['exclude_comment'])
+        links = line.scan(@config['pattern']).flatten
+        check_links(links, filename, index + 1) if links.any?
+      end
+    end
+
+    def check_links(links, file, line_number)
+      links.each do |link|
+        link = replace_values(link)
+        link = link.sub(/#.*$/, '') # scrub the anchor
+        next if check_link(link, file)
+        @broken_links << {
+          'link' => link,
+          :file => file,
+          :line_number => line_number
+        }
+      end
+    end
+
+    def check_link(link, file)
+      if link.match(%r{https://github.com}) && @config['private_github']
+        check_github_link(link)
+      elsif link.match(/^http.*/)
+        check_external_link(link)
+      elsif link.match(/^#.*/)
+        check_section_link(link, file)
+      else
+        check_internal_link(link, file)
+      end
+    end
+
+    def check_github_link(link)
+      repo = link.match(%r{github\.com/([^/]*/[^/]*)/.*})[1]
+      path = link.match(%r{github\.com/.*/.*/blob/[^/]*/(.*)})[1]
+      begin
+        @github_client.rate_limit
+        @github_client.contents(repo, path: path)
+      rescue Octokit::NotFound
+        return false
+      end
+      true
+    end
+
+    def check_external_link(link)
+      uri = URI(link)
+      begin
+        response = Net::HTTP.get_response(uri)
+      rescue *HTTP_ERRORS
+        puts "Error querying #{link}".red
+        return false
+      end
+      response.is_a?(Net::HTTPSuccess) ? true : false
+    end
+
+    def check_section_link(link, file)
+      section = link.sub(%r{/#*/}, '').split('-').each(&:capitalize).join(' ')
+      File.readlines(file).grep(/#{section}/i).size > 0
+    end
+
+    def check_internal_link(link, file)
+      File.exist?(File.join(File.dirname(file), link)) ? true : false
+    end
+
+    def replace_values(link)
+      @config['replacements'].each do |pair|
+        link = link.sub(pair['match'], pair['value'])
+      end
+      link
+    end
+  end
+end
+
+# Add colorize to the String class
+class String
+  def colorize(color_code)
+    "\e[#{color_code}m#{self}\e[0m"
+  end
+
+  def red
+    colorize(31)
+  end
+end

data/lib/markdown-helpers.rb

@@ -0,0 +1,2 @@
+require_relative './markdown-helpers/link_checker.rb'
+require_relative './markdown-helpers/doc_tree_builder.rb'

metadata

@@ -0,0 +1,76 @@
+--- !ruby/object:Gem::Specification
+name: markdown-helpers
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Mike
+- Wood
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-10-30 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: octokit
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: thor
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.19'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.19'
+description: some helpers for working with github markdown
+email: michael.wood@optimizely.com
+executables:
+- markdownh
+extensions: []
+extra_rdoc_files: []
+files:
+- bin/markdownh
+- lib/markdown-helpers.rb
+- lib/markdown-helpers/doc_tree_builder.rb
+- lib/markdown-helpers/link_checker.rb
+homepage: https://rubygems.org/gems/markdown-helpers
+licenses: []
+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: some helpers for working with github markdown
+test_files: []