appium_doc_lint 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: e81bae7396d3274bda69140ee465c9c581afe2cb
+  data.tar.gz: 522aa1992b52fb5763cc98217f3bd1e8d352d4f1
+SHA512:
+  metadata.gz: 6bc03d6856b7a710dcf8398341ce5af44511866cfa92b8a5919fdd7543f4b24d005bbdf5c1769645cad7223aca722312a642b467be74edf0dfa783e9298eeed6
+  data.tar.gz: b1abb318bfe3c668a01c947b618a601a2b000dd05ce3ac44d65f37b6b9a2e6280e473e0213d18990e3aa91f998d5f71e3e8a6e0b7fc7ba01e5f9db6bcd97e760

data/.gitignore

@@ -0,0 +1,36 @@
+.*
+*.lock
+*.gem
+*.rbc
+/.config
+/coverage/
+/InstalledFiles
+/pkg/
+/spec/reports/
+/test/tmp/
+/test/version_tmp/
+/tmp/
+
+## Specific to RubyMotion:
+.dat*
+.repl_history
+build/
+
+## Documentation cache and generated files:
+/.yardoc/
+/_yardoc/
+/doc/
+/rdoc/
+
+## Environment normalisation:
+/.bundle/
+/lib/bundler/man/
+
+# for a library or gem, you might want to ignore these files since the code is
+# intended to run in multiple environments; otherwise, check them in:
+# Gemfile.lock
+# .ruby-version
+# .ruby-gemset
+
+# unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
+.rvmrc

data/.travis.yml

@@ -0,0 +1,3 @@
+language: ruby
+rvm:
+  - 2.1.1

data/Gemfile

@@ -0,0 +1,2 @@
+source 'https://rubygems.org'
+gemspec

data/LICENSE

@@ -0,0 +1,201 @@
+Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "{}"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright {yyyy} {name of copyright owner}
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

data/README.md

@@ -0,0 +1,4 @@
+appium_doc_lint [![Build Status](https://travis-ci.org/appium/appium_doc_lint.svg?branch=master)](https://travis-ci.org/appium/appium_doc_lint)
+===============
+
+lint tool to check for common issues in the appium docs before publishing with Slate

data/Rakefile

@@ -0,0 +1,167 @@
+# encoding: utf-8
+# ruby_console Rakefile
+require 'rubygems'
+require 'rake'
+require 'date'
+require 'posix/spawn'
+
+# rspec
+require 'rspec'
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new :spec
+task :default => :spec
+
+# Defines gem name.
+def repo_name; 'appium_doc_lint'; end # the rubygem name
+def gh_name; 'appium_doc_lint'; end # the name as used on github.com
+def version_file; File.expand_path Dir.glob("lib/#{repo_name}/**/version.rb").first; end
+def version_rgx; /VERSION = '([^']+)'/m; end
+
+def version
+  @version = @version || File.read(version_file).match(version_rgx)[1]
+end
+
+def bump
+  data = File.read version_file
+
+  v_line = data.match version_rgx
+  d_line = data.match /DATE\s*=\s*'([^']+)'/m
+
+  old_v = v_line[0]
+  old_d = d_line[0]
+
+  old_num = v_line[1]
+  new_num = old_num.split('.')
+  new_num[-1] = new_num[-1].to_i + 1
+  new_num = new_num.join '.'
+
+  new_v = old_v.sub old_num, new_num
+  puts "#{old_num} -> #{new_num}"
+
+  old_date = d_line[1]
+  new_date = Date.today.to_s
+  new_d = old_d.sub old_date, new_date
+  puts "#{old_date} -> #{new_date}" unless old_date == new_date
+
+  data.sub! old_v, new_v
+  data.sub! old_d, new_d
+
+  File.write version_file, data
+end
+
+desc 'Bump the version number and update the date.'
+task :bump do
+  bump
+end
+
+def tag_exists tag_name
+  cmd = %Q(git branch -a --contains "#{tag_name}")
+  POSIX::Spawn::Child.new(cmd).out.include? '* master'
+end
+
+# Inspired by Gollum's Rakefile
+desc 'Build and release a new gem to rubygems.org'
+task :release => :gem do
+  unless `git branch`.include? '* master'
+    puts 'Master branch required to release.'
+    exit!
+  end
+
+  # Commit then pull before pushing.
+  tag_name = "v#{version}"
+  raise 'Tag already exists!' if tag_exists tag_name
+
+  # Commit then pull before pushing.
+  sh "git commit --allow-empty -am 'Release #{version}'"
+  sh 'git pull'
+  sh "git tag #{tag_name}"
+  # update notes now that there's a new tag
+  Rake::Task['notes'].execute
+  sh "git commit --allow-empty -am 'Update release notes'"
+  sh 'git push origin master'
+  sh "git push origin #{tag_name}"
+  sh "gem push #{repo_name}-#{version}.gem"
+end
+
+desc 'Build and release a new gem to rubygems.org (same as release)'
+task :publish => :release do
+end
+
+desc 'Build a new gem'
+task :gem do
+  `chmod 0600 ~/.gem/credentials`
+  sh "gem build #{repo_name}.gemspec"
+end
+
+desc 'Build a new gem (same as gem task)'
+task :build => :gem do
+end
+
+desc 'Uninstall gem'
+task :uninstall do
+  cmd = "gem uninstall -aIx #{repo_name}"
+  # rescue on gem not installed error.
+  begin; sh "#{cmd}"; rescue; end
+end
+
+desc 'Install gem'
+task :install => [ :gem, :uninstall ] do
+  sh "gem install --no-rdoc --no-ri --local #{repo_name}-#{version}.gem"
+end
+
+desc 'Update release notes'
+task :notes do
+  tag_sort = ->(tag1,tag2) do
+    begin
+    tag1_numbers = tag1.match(/\.?v(\d+\.\d+\.\d+)$/)[1].split('.').map! { |n| n.to_i }
+    tag2_numbers = tag2.match(/\.?v(\d+\.\d+\.\d+)$/)[1].split('.').map! { |n| n.to_i }
+    tag1_numbers <=> tag2_numbers
+    rescue
+      raise "Match failed on\n'#{tag1}'\n'#{tag2}'"
+    end
+  end
+
+  tags = `git tag`.split "\n"
+  tags.sort! &tag_sort
+  pairs = []
+  tags.each_index { |a| pairs.push tags[a] + '..' + tags[a+1] unless tags[a+1].nil? }
+
+  notes = ''
+
+  dates = `git log --tags --simplify-by-decoration --pretty="format:%d %ad" --date=short`.split "\n"
+  #  " (tag: v0.0.21) 2013-03-22"
+  dates.reject! { |d| ! d.match /\(tag: v\d+\.\d+\.\d+\) \d+-\d+-\d+/ }
+
+  pairs.sort! &tag_sort
+  pairs.reverse! # pairs are in reverse order.
+
+  tag_date = []
+  pairs.each do |pair|
+    tag = pair.split('..').last
+    dates.each do |line|
+      # regular tag, or tag on master.
+      if line.include?(tag + ')') || line.include?(tag + ',')
+        tag_date.push tag + ' ' + line.match(/\d{4}-\d{2}-\d{2}/)[0]
+        break
+      end
+    end
+  end
+
+  pairs.each_index do |a|
+    data =`git log --pretty=oneline #{pairs[a]}`
+    new_data = ''
+    data.split("\n").each do |line|
+      hex = line.match(/[a-zA-Z0-9]+/)[0]
+      # use first 7 chars to match GitHub
+      comment = line.gsub(hex, '').strip
+      next if comment == 'Update release notes'
+      new_data += "- [#{hex[0...7]}](https://github.com/appium/#{gh_name}/commit/#{hex}) #{comment}\n"
+    end
+    data = new_data + "\n"
+
+    # last pair is the released version.
+    notes += "#### #{tag_date[a]}\n\n" + data + "\n"
+  end
+
+  File.open('release_notes.md', 'w') { |f| f.write notes.to_s.strip }
+end

data/appium_doc_lint.gemspec

@@ -0,0 +1,23 @@
+require_relative 'lib/appium_doc_lint'
+
+Gem::Specification.new do |s|
+  # 1.8.x is not supported
+  s.required_ruby_version = '>= 1.9.3'
+
+  s.name = 'appium_doc_lint'
+  s.version = Appium::Lint::VERSION
+  s.date = Appium::Lint::DATE
+  s.license = 'http://www.apache.org/licenses/LICENSE-2.0.txt'
+  s.description = s.summary = 'Appium Doc Lint'
+  s.description += '.' # avoid identical warning
+  s.authors = s.email = [ 'code@bootstraponline.com' ]
+  s.homepage = 'https://github.com/appium/appium_doc_lint' # published as appium_doc_lint
+  s.require_paths = [ 'lib' ]
+
+  s.add_development_dependency 'rake', '~> 10.3.1'
+  s.add_development_dependency 'rspec', '~> 2.14.1'
+  s.add_development_dependency 'posix-spawn', '~> 0.3.8'
+
+  s.executables   = [ 'appium_doc_lint' ]
+  s.files = `git ls-files`.split "\n"
+end

data/bin/appium_doc_lint

@@ -0,0 +1,13 @@
+#!/usr/bin/env ruby
+require 'rubygems'
+require_relative '../lib/appium_doc_lint'
+
+def run_glob
+  lint = Appium::Lint.new
+  dir  = File.join(Dir.pwd, '**', '*.md')
+
+  lint.report lint.glob dir
+end
+
+result = run_glob
+puts result if result

data/lib/appium_doc_lint/lint/base.rb

@@ -0,0 +1,32 @@
+module Appium
+  class Lint
+    # noinspection RubyArgCount
+    class Base
+      attr_reader :input, :warnings
+      # Appium::Lint::Base.new file: '/path/to/file'
+      #
+      # Appium::Lint::Base.new data: 'some **markdown**'
+      def initialize opts
+        @input    = opts.is_a?(OpenStruct) ? opts : Appium::Lint.new_input(opts)
+        @warnings = Hash.new []
+      end
+
+      # Record a warning on a zero indexed line number
+      #
+      # @param line_number [int] line number to warn on
+      # @return [warnings]
+      def warn line_number
+        warnings[line_number + 1] += [fail]
+        warnings
+      end
+
+      def fail
+        raise NotImplementedError
+      end
+
+      def call
+        raise NotImplementedError
+      end
+    end
+  end
+end

data/lib/appium_doc_lint/lint/h1_invalid.rb

@@ -0,0 +1,36 @@
+module Appium
+  class Lint
+    ###
+    # h1 must use the `#` syntax and not the `===` underline syntax.
+    # check for three = to reduce false positives
+    class H1Invalid < Base
+      def call
+        # === is always a h1 regardless of previous line
+        input.lines.each_with_index do |line, index|
+          h1_invalid = !!line.match(/^===+\s*$/)
+          warn index if h1_invalid
+        end
+
+        warnings
+      end
+
+      FAIL = 'h1 must not use === underline syntax. Use # instead'
+
+      def fail
+        FAIL
+      end
+    end
+  end
+end
+
+=begin
+md = Redcarpet::Markdown.new(Redcarpet::Render::HTML, autolink: true, tables: true)
+> md.render("hi\n=")
+=> "<h1>hi</h1>\n"
+> md.render("hi\n =")
+=> "<p>hi\n =</p>\n"
+> md.render("hi\n= ")
+=> "<h1>hi</h1>\n"
+> md.render("\n\n======")
+=> "<h1></h1>\n"
+=end

data/lib/appium_doc_lint/lint/h1_missing.rb

@@ -0,0 +1,25 @@
+module Appium
+  class Lint
+    ###
+    # Each file must have a h1
+    # This forms the title for the document and is used to anchor the
+    # #filename.md link.
+    #
+    # The file should start with the h1. This rule will fail if the document
+    # doesn't contain at least one h1
+    class H1Missing < Base
+      def call
+        # either the doc has a h1 or it doesn't
+        # attach warning to line 0
+        h1_missing = !input.data.match(/^#[^#]/m)
+        h1_missing ? warn(0) : warnings
+      end
+
+      FAIL = 'h1 is missing'
+
+      def fail
+        FAIL
+      end
+    end
+  end
+end

data/lib/appium_doc_lint/lint/h2_invalid.rb

@@ -0,0 +1,39 @@
+module Appium
+  class Lint
+    ###
+    # h2 must use the `##` syntax and not the `---` underline syntax.
+    # check for three - to reduce false positives
+    class H2Invalid < Base
+      def call
+        previous_line = ''
+
+        input.lines.each_with_index do |line, index|
+          # If the previous line is empty then --- triggers a line break
+          previous_line_not_empty = !previous_line.match(/^\s*$/)
+          h2_invalid              = previous_line_not_empty && line.match(/^---+\s*$/)
+          warn index if h2_invalid
+
+          previous_line = line
+        end
+
+        warnings
+      end
+
+      FAIL = 'h2 must not use --- underline syntax. Use ## instead'
+
+      def fail
+        FAIL
+      end
+    end
+  end
+end
+
+=begin
+md = Redcarpet::Markdown.new(Redcarpet::Render::HTML, autolink: true, tables: true)
+> md.render("hi\n--")
+=> "<h2>hi</h2>\n"
+> md.render("hi\n -")
+=> "<p>hi\n -</p>\n"
+> md.render("hi\n- ")
+=> "<h2>hi</h2>\n"
+=end

data/lib/appium_doc_lint/lint/h456_invalid.rb

@@ -0,0 +1,29 @@
+module Appium
+  class Lint
+    ###
+    # h4, h5, and h6 should not be used.
+    # Slate works best with h1, h2, or h3
+    class H456Invalid < Base
+      def call
+        input.lines.each_with_index do |line, index|
+          h456_invalid = !!line.match(/^\#{4,6}[^#]/)
+          warn index if h456_invalid
+        end
+
+        warnings
+      end
+
+      FAIL = 'h4, h5, h6 should not be used. Use h1, h2 or h3.'
+
+      def fail
+        FAIL
+      end
+    end
+  end
+end
+=begin
+> md.render("##### ok")
+=> "<h5>ok</h5>\n"
+> md.render(" ##### ok")
+=> "<p>##### ok</p>\n"
+=end

data/lib/appium_doc_lint/lint/line_break_invalid.rb

@@ -0,0 +1,41 @@
+module Appium
+  class Lint
+    ###
+    # line breaks such as `--` and `---` shouldn't be used
+    # on Slate. They will cause problems such as null divs
+    class LineBreakInvalid < Base
+      def call
+        previous_line = ''
+        input.lines.each_with_index do |line, index|
+          # If the previous line isn't empty then --- createa a h2 not a line break.
+          previous_line_empty = previous_line.match(/^\s*$/)
+          line_break_invalid  = previous_line_empty && line.match(/^--+\s*$/)
+          warn index if line_break_invalid
+
+          previous_line = line
+        end
+
+        warnings
+      end
+
+      FAIL = '`--` and `---` line breaks must not be used. Delete them.'
+
+      def fail
+        FAIL
+      end
+    end
+  end
+end
+
+=begin
+> md.render(" -- ")
+=> "<p>-- </p>\n"
+> md.render("-- ")
+=> "<h2></h2>\n"
+> md.render("--- ")
+=> "<hr>\n"
+> md.render("--- ok")
+=> "<p>--- ok</p>\n
+> md.render "hi\n--"
+=> "<h2>hi</h2>\n"
+=end

data/lib/appium_doc_lint/lint.rb

@@ -0,0 +1,92 @@
+require 'ostruct'
+
+module Appium
+  class Lint
+    require_relative 'lint/base'
+    require_relative 'lint/h1_invalid'
+    require_relative 'lint/h1_missing'
+    require_relative 'lint/h2_invalid'
+    require_relative 'lint/h456_invalid'
+    require_relative 'lint/line_break_invalid'
+
+    # OpenStruct.new data: '', lines: '', file: ''
+    attr_reader :input
+
+    def initialize
+      @rules = [H1Invalid, H1Missing, H2Invalid, H456Invalid, LineBreakInvalid]
+    end
+
+    def self.init_data opts={}, input
+      raise 'Input must exist' unless input
+      data = opts[:data]
+      if data
+        input.data  = data.freeze
+        input.lines = data.split(/\r?\n/).freeze
+        input.file  = nil
+      else
+        file = opts[:file]
+        raise 'File path must be provided' unless file
+        raise "File must exist and be readable #{file}" unless File.exist?(file) && File.readable?(file)
+        file = File.expand_path(file)
+
+        input.data  = File.read(file).freeze
+        input.lines = input.data.split(/\r?\n/).freeze
+        input.file  = file.freeze
+      end
+
+      input
+    end
+
+    def self.new_input opts
+      input = OpenStruct.new(data: '', lines: '', file: '')
+      self.init_data opts, input
+    end
+
+    def call opts={}
+      @input = self.class.new_input opts
+
+      all_warnings = {}
+      @rules.each do |rule|
+        warnings = rule.new(@input).call
+        unless warnings.empty?
+          all_warnings.merge!(warnings) do |key, old_val, new_val|
+            # flatten to prevent { :a => [[1, 2], 2]}
+            [old_val, new_val].flatten
+          end
+        end
+      end
+
+      return {} if all_warnings.empty?
+
+      # sort by line number
+      all_warnings = all_warnings.sort.to_h
+
+      # wrap with file path if available
+      input.file ? { input.file => all_warnings } : all_warnings
+    end
+
+    def glob dir_glob
+      results = {}
+      Dir.glob dir_glob do |markdown|
+        markdown = File.expand_path markdown
+        results.merge!(self.call(file: markdown))
+      end
+      results
+    end
+
+    # Format data into a report
+    def report data
+      return nil if data.nil? || data.empty?
+      result = ''
+      data.each do |file_name, analysis|
+        result += "\n#{File.basename(file_name)}\n"
+        analysis.each do |line_number, warning|
+          result += "  #{line_number}: #{warning.join(',')}\n"
+        end
+      end
+      result.strip!
+
+      result.empty? ? nil : result
+    end
+  end
+end

data/lib/appium_doc_lint/version.rb

@@ -0,0 +1,6 @@
+module Appium
+  class Lint
+    VERSION = '0.0.1' unless defined? ::Appium::Lint::VERSION
+    DATE    = '2014-04-18' unless defined? ::Appium::Lint::DATE
+  end
+end

data/lib/appium_doc_lint.rb

@@ -0,0 +1,2 @@
+require_relative 'appium_doc_lint/version'
+require_relative 'appium_doc_lint/lint'

data/spec/data/0.md

@@ -0,0 +1,5 @@
+h1
+====
+
+h2
+----

data/spec/data/1.md

@@ -0,0 +1,3 @@
+# h1
+
+## h2

data/spec/data/sub/3.md

@@ -0,0 +1,7 @@
+# h1
+
+--
+
+hi
+
+---

data/spec/helper.rb

@@ -0,0 +1,9 @@
+require 'rubygems'
+require 'rspec'
+require_relative '../lib/appium_doc_lint/lint'
+require_relative '../lib/appium_doc_lint/lint/base'
+require_relative '../lib/appium_doc_lint/lint/h1_missing'
+require_relative '../lib/appium_doc_lint/lint/h1_invalid'
+require_relative '../lib/appium_doc_lint/lint/h2_invalid'
+require_relative '../lib/appium_doc_lint/lint/h456_invalid'
+require_relative '../lib/appium_doc_lint/lint/line_break_invalid'

data/spec/lint_spec.rb

@@ -0,0 +1,260 @@
+require_relative 'helper'
+
+class Appium::Lint
+  describe 'Lint' do
+    it 'processes globbed files' do
+      lint   = Appium::Lint.new
+      dir    = File.join(Dir.pwd, 'spec', 'data', '**', '*.md')
+
+      actual = lint.glob dir
+
+      # 1.md has no problems so it doesn't show up in expected failures
+      expected = { '0.md' => { 1 => [H1Missing::FAIL],
+                               2 => [H1Invalid::FAIL],
+                               5 => [H2Invalid::FAIL] },
+                   '3.md' => { 3 => [LineBreakInvalid::FAIL],
+                               7 => [LineBreakInvalid::FAIL] } }
+
+      # convert path/to/0.md to 0.md
+      actual.keys.each do |key|
+        new_key = File.basename key
+        actual[new_key] = actual[key]
+        actual.delete key
+      end
+
+      expect(actual).to eq(expected)
+    end
+
+    it 'reports globbed files' do
+      lint   = Appium::Lint.new
+      dir    = File.join(Dir.pwd, 'spec', 'data', '**', '*.md')
+
+      actual = lint.report lint.glob dir
+      expected = (<<REPORT).strip
+0.md
+  1: #{H1Missing::FAIL}
+  2: #{H1Invalid::FAIL}
+  5: #{H2Invalid::FAIL}
+
+3.md
+  3: #{LineBreakInvalid::FAIL}
+  7: #{LineBreakInvalid::FAIL}
+REPORT
+
+      expect(actual).to eq(expected)
+    end
+
+    it 'empty report is falsey' do
+      lint   = Appium::Lint.new
+      actual = !! lint.report({})
+      expect(actual).to eq(false)
+    end
+
+    it 'processes all rules without raising an exception' do
+      lint = Appium::Lint.new
+
+      markdown = <<MARKDOWN
+hi
+====
+
+hi 2
+=====
+
+there
+------
+
+there 2
+--------
+
+--
+
+---
+
+#### h4
+##### h5
+###### h6
+MARKDOWN
+
+      expected = { 1  => [H1Missing::FAIL],
+                   2  => [H1Invalid::FAIL],
+                   5  => [H1Invalid::FAIL],
+                   8  => [H2Invalid::FAIL],
+                   11 => [H2Invalid::FAIL],
+                   13 => [LineBreakInvalid::FAIL],
+                   15 => [LineBreakInvalid::FAIL],
+                   17 => [H456Invalid::FAIL],
+                   18 => [H456Invalid::FAIL],
+                   19 => [H456Invalid::FAIL] }
+
+      actual = lint.call data: markdown
+
+      expect(actual).to eq(expected)
+    end
+  end
+
+  describe H1Missing do
+    it 'detects missing h1' do
+      rule     = H1Missing.new data: '## hi'
+      expected = { 1 => [rule.fail] }
+      actual   = rule.call
+
+      expect(actual).to eq(expected)
+    end
+
+    it 'detects h1 missing' do
+      rule     = H1Missing.new data: '# hi'
+      expected = {}
+      actual   = rule.call
+
+      expect(actual).to eq(expected)
+    end
+  end
+
+  describe H1Invalid do
+    it 'detects invalid h1' do
+      rule     = H1Invalid.new data: "hi\n==="
+      expected = { 2 => [rule.fail] }
+      actual   = rule.call
+
+      expect(actual).to eq(expected)
+    end
+
+    it 'detects multiple invalid h1' do
+      rule     = H1Invalid.new data: "hi\n===\nbye\n======\n\n===="
+      expected = { 2 => [rule.fail],
+                   4 => [rule.fail],
+                   6 => [rule.fail] }
+      actual   = rule.call
+
+      expect(actual).to eq(expected)
+    end
+
+    it 'detects valid h1' do
+      rule     = H1Invalid.new data: '# hi'
+      expected = {}
+      actual   = rule.call
+
+      expect(actual).to eq(expected)
+    end
+  end
+
+  describe H2Invalid do
+    it 'detects invalid h2' do
+      rule     = H2Invalid.new data: "hi\n---"
+      expected = { 2 => [rule.fail] }
+      actual   = rule.call
+
+      expect(actual).to eq(expected)
+    end
+
+    it 'detects multiple invalid h2' do
+      rule     = H2Invalid.new data: "hi\n---\nbye\n-------"
+      expected = { 2 => [rule.fail],
+                   4 => [rule.fail] }
+      actual   = rule.call
+
+      expect(actual).to eq(expected)
+    end
+
+    it 'detects valid h2' do
+      rule     = H2Invalid.new data: '## hi'
+      expected = {}
+      actual   = rule.call
+
+      expect(actual).to eq(expected)
+    end
+  end
+
+  describe H456Invalid do
+    it 'detects invalid h4, h5, h6' do
+      ['#### h4', '##### h5', '###### h6'].each do |data|
+        rule     = H456Invalid.new data: data
+        expected = { 1 => [rule.fail] }
+        actual   = rule.call
+
+        expect(actual).to eq(expected)
+      end
+    end
+
+    it 'detects multiple invalid h4, h5, h6' do
+      data = <<-MARKDOWN
+# h1
+## h2
+### h3
+#### h4
+##### h5
+###### h6
+ #### not actually a h4 due to leading space
+      MARKDOWN
+
+      rule     = H456Invalid.new data: data
+      expected = { 4 => [rule.fail],
+                   5 => [rule.fail],
+                   6 => [rule.fail] }
+      actual   = rule.call
+
+      expect(actual).to eq(expected)
+    end
+
+    it 'does not error on h1, h2, h3' do
+      data = <<-MARKDOWN
+# h1
+# h2
+# h3
+      MARKDOWN
+      rule     = H456Invalid.new data: data
+      expected = {}
+      actual   = rule.call
+
+      expect(actual).to eq(expected)
+    end
+  end
+
+  describe LineBreakInvalid do
+    it 'detects invalid line breaks' do
+      %w(-- --- ----).each do |data|
+        rule     = LineBreakInvalid.new data: data
+        expected = { 1 => [rule.fail] }
+        actual   = rule.call
+
+        expect(actual).to eq(expected)
+      end
+    end
+
+    it 'detects multiple invalid line breaks' do
+      data = <<-MARKDOWN
+ -- not a break
+ ------
+-- still not
+
+--
+
+---
+
+-----
+      MARKDOWN
+
+      rule     = LineBreakInvalid.new data: data
+      expected = { 5 => [rule.fail],
+                   7 => [rule.fail],
+                   9 => [rule.fail] }
+      actual   = rule.call
+
+      expect(actual).to eq(expected)
+    end
+
+    it 'does not error on valid data' do
+      data = <<-MARKDOWN
+some --
+ ------
+markdown--
+-- examples
+      MARKDOWN
+      rule     = LineBreakInvalid.new data: data
+      expected = {}
+      actual   = rule.call
+
+      expect(actual).to eq(expected)
+    end
+  end
+end

metadata

@@ -0,0 +1,109 @@
+--- !ruby/object:Gem::Specification
+name: appium_doc_lint
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- code@bootstraponline.com
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-04-18 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 10.3.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 10.3.1
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.14.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.14.1
+- !ruby/object:Gem::Dependency
+  name: posix-spawn
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.3.8
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.3.8
+description: Appium Doc Lint.
+email:
+- code@bootstraponline.com
+executables:
+- appium_doc_lint
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- appium_doc_lint.gemspec
+- bin/appium_doc_lint
+- lib/appium_doc_lint.rb
+- lib/appium_doc_lint/lint.rb
+- lib/appium_doc_lint/lint/base.rb
+- lib/appium_doc_lint/lint/h1_invalid.rb
+- lib/appium_doc_lint/lint/h1_missing.rb
+- lib/appium_doc_lint/lint/h2_invalid.rb
+- lib/appium_doc_lint/lint/h456_invalid.rb
+- lib/appium_doc_lint/lint/line_break_invalid.rb
+- lib/appium_doc_lint/version.rb
+- spec/data/0.md
+- spec/data/1.md
+- spec/data/sub/3.md
+- spec/helper.rb
+- spec/lint_spec.rb
+homepage: https://github.com/appium/appium_doc_lint
+licenses:
+- http://www.apache.org/licenses/LICENSE-2.0.txt
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 1.9.3
+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: Appium Doc Lint
+test_files: []