starter 0.1.7 → 0.1.8

data/lib/starter/markdown.rb

@@ -0,0 +1,86 @@
+require "pathname"
+require "term/ansicolor"
+
+module Starter
+
+  class Markdown
+
+    # From http://stackoverflow.com/questions/9268407/how-to-convert-markdown-style-links-using-regex
+    InlineLinkRegex = %r{
+      \[         # Literal opening bracket
+        (        # Capture what we find in here
+          [^\]]+ # One or more characters other than close bracket
+        )        # Stop capturing
+      \]         # Literal closing bracket
+      \(         # Literal opening parenthesis
+        (        # Capture what we find in here
+          [^)]+  # One or more characters other than close parenthesis
+        )        # Stop capturing
+      \)         # Literal closing parenthesis
+    }x
+
+    LinkDefRegex= %r{^\[(.+)\]:(.+)$}
+
+    attr_reader :linted_docs
+
+    def initialize(root_doc, options={})
+      @linted_docs = {}
+      @root_doc = root_doc
+      @directory = options[:directory]
+    end
+
+    def lint
+      lint_doc(@root_doc)
+      if @directory
+        files = Dir["#{@directory}/**/*.md"]
+        unseen = files.to_a - @linted_docs.keys
+        puts Term::ANSIColor.yellow("Unreferenced documents:")
+        unseen.each do |path|
+          puts "    " + Term::ANSIColor.yellow(path)
+        end
+      end
+    end
+
+    def lint_doc(path, source=nil)
+      # no point in repeating a check
+      return if @linted_docs[path]
+
+      begin
+        string = File.read(path)
+        puts "    Linting doc: #{path}"
+        lint_markdown(string, path)
+        @linted_docs[path] = true
+      rescue Errno::ENOENT
+        puts Term::ANSIColor.red("Broken link in #{source}: #{path}")
+      rescue => e
+        pp e
+      end
+    end
+
+
+    def lint_markdown(string, source=nil)
+      string.each_line do |line|
+        normal_link = InlineLinkRegex.match(line)
+        link_def = LinkDefRegex.match(line)
+        if normal_link
+          lint_link(normal_link, source)
+        end
+        if link_def
+          lint_link(link_def, source)
+        end
+      end
+    end
+
+    def lint_link(match, source)
+      _m, text, url = match.to_a
+      if url && url =~ /\.md$/ && url !~ /^https?:\/\/|#/
+        url = (Pathname.new(source).dirname + url).to_s
+        url.sub!(/#.*$/, "")
+        lint_doc(url, source)
+      end
+    end
+
+
+  end
+
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: starter
 version: !ruby/object:Gem::Version
-  version: 0.1.7
+  version: 0.1.8
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-01-07 00:00:00.000000000 Z
+date: 2013-01-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: git
@@ -43,6 +43,22 @@ dependencies:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: term-ansicolor
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 description: 
 email: 
 executables: []
@@ -55,6 +71,7 @@ files:
 - lib/starter/extensions/module.rb
 - lib/starter/extensions/string.rb
 - lib/starter/http.rb
+- lib/starter/markdown.rb
 - lib/starter/misc.rb
 - lib/starter/mixins/statistics.rb
 - lib/starter/password.rb