poppins 0.0.1

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in poppins.gemspec
+gemspec

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Aaron Massey
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,47 @@
+# Poppins
+
+Poppins formats Markdown files to ensure that reference links are
+numbered and appear in numerical order.  Currently, this is a seriously
+basic tool.  Still, it does what I needed, and I hope to expand it.
+Poppins was inspired by [Dr. Drang's script][1] for tidying reference
+links.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'poppins'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install poppins
+
+## Usage
+
+Poppins: a Markdown cleaner and formatter
+Usage: poppins [options] <filename>
+
+Examples:
+  poppins ./README.md
+  poppins --output 'output.md' ./input.md
+
+Options:
+    -o, --output [FILE]              Write the clean, formatted Markdown to FILE.
+    -h, --help                       Show this message
+    -v, --version                    Show version
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Added some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request
+
+
+[1]: http://www.leancrew.com/all-this/2012/09/tidying-markdown-reference-links/
+

data/Rakefile

@@ -0,0 +1,2 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"

data/bin/poppins

@@ -0,0 +1,44 @@
+#!/usr/bin/env ruby
+
+require 'optparse'
+require_relative '../lib/poppins'
+
+@output = nil 
+
+op = OptionParser.new do |opts|
+  opts.banner = "Poppins: a Markdown cleaner and formatter"
+  opts.define_head "Usage: poppins [options] <filename>"
+  opts.separator ""
+  opts.separator "Examples:"
+  opts.separator "  poppins ./README.md"
+  opts.separator "  poppins --output 'output.md' ./input.md"
+  opts.separator ""
+  opts.separator "Options:"
+
+  opts.on("-o", "--output [FILE]", "Write the clean, formatted Markdown to FILE.") do |file|
+    @output = file
+  end
+
+  opts.on_tail("-h", "--help", "Show this message") do
+    puts opts
+    exit
+  end
+
+  opts.on_tail("-v", "--version", "Show version") do
+    puts Poppins::VERSION
+    exit
+  end
+end
+
+op.parse!
+
+input = ARGV.shift.to_s.strip
+
+if input.empty?
+  puts op
+  exit 1
+end
+
+poppins = Poppins::Document.new input, @output
+
+poppins.clean_and_format

data/lib/poppins/document.rb

@@ -0,0 +1,85 @@
+module Poppins
+  class Document
+
+    def initialize(input, output=nil)
+      @input = File.open(input, 'r').readlines.join
+      @output = output
+
+      # RegEx for matching reference links in the text.  (Avoid footnotes!)
+      @links = /\[([^\]]+)\]\[([^^\]]+)\]/
+      # RegEx for matching labels for reference links.  (Avoid footnotes!)
+      @labels = /^\[([^^\]]+)\]:\s+(.+)$/
+    end
+
+    ##
+    # Returns an array of the links found in the document in order.
+    def links 
+      @input.scan(@links)
+    end
+
+    def labels
+      Hash[@input.scan(@labels)]
+    end
+
+    def order_of_first_appearance
+      order = []
+      links.each do |l|
+        order.push(l[1]) unless order.include?(l[1])
+      end
+
+      order
+    end
+
+    def ordinal_references
+      references = []
+      order_of_first_appearance.each_with_index do |o, i| 
+        references.push("[#{i+1}]: #{labels[o]}")
+      end
+
+      references 
+    end
+
+    ##
+    # Returns an array of the link text and the new reference number when
+    # passed links based on the old reference numbering system
+    def get_replacement(string)
+      md = string.match(@links)
+      link_text = md[1].to_s
+      reference_number = (order_of_first_appearance.index(md[2]) + 1).to_s
+
+      return [link_text, reference_number]
+    end
+
+
+    ##
+    # Produces the clean, formatted version of the Markdown with new
+    # reference numbers.
+    def clean_and_format
+      # Remove old references (TOOD: Need to remove blank lines resulting from
+      # this.)
+      result = @input.gsub(@labels, '')
+      #
+      # Add new references
+      ordinal_references.each do |r| 
+        result += r.to_s + "\n"
+      end
+
+      # Replace old reference numbers with the new ones
+      result = result.gsub(@links) do |m| 
+        replacement = get_replacement(m) 
+        "[#{replacement[0]}][#{replacement[1]}]"
+      end
+
+      # output the result
+      # puts result
+
+      if @output
+        File.open(@output, 'w') do |f|
+          f.write(result)
+        end
+      else 
+        puts result
+      end
+    end
+  end
+end

data/lib/poppins/version.rb

@@ -0,0 +1,3 @@
+module Poppins
+  VERSION = "0.0.1"
+end

data/lib/poppins.rb

@@ -0,0 +1,6 @@
+require_relative "poppins/version"
+require_relative "poppins/document"
+
+module Poppins
+  # Your code goes here...
+end

data/poppins.gemspec

@@ -0,0 +1,20 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/poppins/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.authors       = ["Aaron Massey"]
+  gem.email         = ["akmassey@gatech.edu"]
+  gem.description   = %q{Poppins is a basic formatter for Markdown files.}
+  gem.summary       = %q{Poppins formats Markdown files to ensure that reference links are numbered and appear in numerical order.}
+  gem.homepage      = ""
+
+  gem.files         = `git ls-files`.split($\)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.name          = "poppins"
+  gem.require_paths = ["lib"]
+  gem.version       = Poppins::VERSION
+
+
+  gem.add_development_dependency 'rspec'
+end

data/spec/data/sample.md

@@ -0,0 +1,26 @@
+Species and their hybrids, How simply are these facts! How
+strange that the pollen of each But we may thus have
+[succeeded][2] in selecting so many exceptions to this rule.
+but the species would not all the same species living on the
+White Mountains, in the arctic regions of that large island.
+The exceptions which are now large, and triumphant, and
+which are known to every naturalist: scarcely a single
+[character][4] in the descendants of the Glacial period,
+would have been of use to the plants, have been accumulated
+and if, in both regions.
+
+Supposed to be extinct and unknown, form. We have seen that
+it yields readily, when subjected as [under confinement][3],
+to new and improved varieties will have been much
+compressed, we may assume that the species, which are
+already present in the ordinary spines serve as a prehensile
+or snapping apparatus. Thus every gradation, from animals
+with true lungs are descended from a marsupial form), "and
+if so, there can be followed by which viscid matter, such as
+that of making [slaves][1]. Let it be remembered that
+selection may be extended--to the stigma of.
+
+[1]: http://daringfireball.net/markdown/
+[2]: http://www.google.com/
+[3]: http://docs.python.org/library/index.html
+[4]: http://www.kungfugrippe.com/

data/spec/lib/document_spec.rb

@@ -0,0 +1,28 @@
+require 'spec_helper'
+
+describe Poppins::Document do
+
+  before do
+    @file = File.dirname(__FILE__) + '/../data/sample.md'
+  end
+
+  it "should be instantiatable" do 
+    Poppins::Document.new(@file).should_not be_nil
+  end
+
+  it "should accurately identify links in the text" do 
+    Poppins::Document.new(@file).links.should == [["succeeded", "2"], ["character", "4"], ["under confinement", "3"], ["slaves", "1"]]
+  end
+
+  it "should accuaretely identify a hash of the references" do 
+    Poppins::Document.new(@file).labels.should == {"1"=>"http://daringfireball.net/markdown/", "2"=>"http://www.google.com/", "3"=>"http://docs.python.org/library/index.html", "4"=>"http://www.kungfugrippe.com/"}
+  end
+
+  it "should correctly idenfity the order of the links as they appear in the text" do
+    Poppins::Document.new(@file).order_of_first_appearance.should == ["2", "4", "3", "1"]
+  end
+
+  it "should correctly generate a new list of references" do 
+    Poppins::Document.new(@file).ordinal_references.should == ["[1]: http://www.google.com/", "[2]: http://www.kungfugrippe.com/", "[3]: http://docs.python.org/library/index.html", "[4]: http://daringfireball.net/markdown/"]
+  end
+end

data/spec/poppins_spec.rb

@@ -0,0 +1,8 @@
+require 'spec_helper'
+ 
+describe Poppins do
+  it "should have a VERSION" do
+    Poppins::VERSION.should == "0.0.1"
+  end
+end
+

data/spec/spec_helper.rb

@@ -0,0 +1 @@
+require 'poppins'

metadata

@@ -0,0 +1,87 @@
+--- !ruby/object:Gem::Specification
+name: poppins
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Aaron Massey
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-10-01 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Poppins is a basic formatter for Markdown files.
+email:
+- akmassey@gatech.edu
+executables:
+- poppins
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- bin/poppins
+- lib/poppins.rb
+- lib/poppins/document.rb
+- lib/poppins/version.rb
+- poppins.gemspec
+- spec/data/sample.md
+- spec/lib/document_spec.rb
+- spec/poppins_spec.rb
+- spec/spec_helper.rb
+homepage: ''
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: -1494761217159726976
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: -1494761217159726976
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.23
+signing_key: 
+specification_version: 3
+summary: Poppins formats Markdown files to ensure that reference links are numbered
+  and appear in numerical order.
+test_files:
+- spec/data/sample.md
+- spec/lib/document_spec.rb
+- spec/poppins_spec.rb
+- spec/spec_helper.rb