tocify 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 tocify.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 pyro2927
+
+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,75 @@
+# Tocify
+
+Tocify aims to create a table of contents for your markdown files.  By default the generated ToC will be dumped to STDOUT.  Add the `-i` or `--inject` flag to put the table of contents back into your file.
+
+## Table of Contents
+* [Installation](#installation)
+* [Usage](#usage)
+* [Sample Output](#sample-output)
+* [Manual Insertion](#manual-insertion)
+    * [OS X](#os-x)
+    * [Linux](#linux)
+* [Contributing](#contributing)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'tocify'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install tocify
+
+## Usage
+
+By default tocify will check for a file named `README.md` in the current directory.
+
+    tocify
+
+Otherwise you can pass in a filename as a parameter.
+
+    tocify OTHERFILE.md
+ 
+To automatically insert the ToC into your README, run
+
+    tocify -i
+
+## Sample Output
+ 
+When running `tocify` on this file, you get:
+
+    ## Table of Contents
+    * [Installation](#installation)
+    * [Usage](#usage)
+    * [Sample Output](#sample-output)
+    * [Manual Insertion](#manual-insertion)
+        * [OS X](#os-x)
+        * [Linux](#linux)
+    * [Contributing](#contributing)
+
+## Manual Insertion
+
+If you want to manually insert the generated ToC you can.  An easy way is to pipe the output of `tocify` into your paste bufffer.
+
+### OS X
+
+    tocify | pbcopy
+
+### Linux
+
+    tocify | xclip
+
+_Requires xclip to be installed_
+ 
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,12 @@
+$LOAD_PATH.unshift File.expand_path("../lib", __FILE__)
+require 'bundler/version'
+require 'tocify/version'
+require "bundler/gem_tasks"
+ 
+task :build do
+  system 'gem build tocify.gemspec'
+end
+
+task :install do
+  system "gem install tocify-#{Tocify::VERSION}.gem"
+end

data/bin/tocify

@@ -0,0 +1,5 @@
+#!/usr/bin/env ruby
+
+require 'tocify'
+puts Tocify.filter_args(ARGV)
+

data/lib/tocify.rb

@@ -0,0 +1,66 @@
+require "tocify/version"
+
+module Tocify
+  def self.filter_args(args)
+    # see if we should inject this ToC back into the file
+    if args.include?("--inject") || args.include?("-i")
+      inject = true
+      args.delete("--inject")
+      args.delete("-i")
+    else
+      inject = false
+    end
+    
+    # pass in our file name if we have it
+    if args.length > 0
+      Tocify.run(args[0], inject)
+    else
+      Tocify.run(nil, inject)
+    end
+  end
+  def self.run(file_name = nil, inject = false)
+    # sanity checks
+    if file_name.nil?
+      if File.exist?('README.md')
+        file_name = 'README.md'
+      else
+        puts "You must provide a file name"
+        return
+      end
+    elsif File.exist?(file_name) == false
+      puts "The file '#{file_name}' doesn't exist"
+      return
+    end
+    toc = Tocify.generate(file_name)
+    if inject
+      Tocify.insert(toc, file_name)
+    end
+    toc
+  end
+
+  def self.generate(file_name)
+    toc = Array.new
+    toc << "## Table of Contents"
+
+    File.open(file_name).each do |line|
+      if line.start_with?("##") && line.start_with?(toc[0]) == false
+        # count number of lines, figure out how many leading paces we need
+        # two spaces for each hash after the second
+        spaces = " " * (line.split(" ").first.count("#") - 2) * 4
+        title = line.split(" ")
+        title.shift
+        # links are the title, downcased, and spaces replaced with hyphens
+        # also make sure to remove non-alphanumeric characters
+        link = title.map {|w| w.downcase } .join("-").delete('^a-zA-Z0-9\-')
+        toc << "#{spaces}* [#{title.join(" ")}](##{link})"
+      end
+    end
+    toc.join("\n")
+  end
+
+  def self.insert(toc, file_name)
+    content = File.read(file_name)
+    content.sub!(/(\n## Table of Contents.+?|)\n##/im, "\n" + toc + "\n\n##")
+    File.write(file_name, content)
+  end
+end

data/lib/tocify/version.rb

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

data/tocify.gemspec

@@ -0,0 +1,23 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'tocify/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "tocify"
+  spec.version       = Tocify::VERSION
+  spec.authors       = ["pyro2927"]
+  spec.email         = ["joseph@pintozzi.com"]
+  spec.description   = "Tocify is an easy way to generate a table of contents for your markdown file"
+  spec.summary       = ""
+  spec.homepage      = "https://github.com/pyro2927/tocify"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+end

metadata

@@ -0,0 +1,89 @@
+--- !ruby/object:Gem::Specification
+name: tocify
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- pyro2927
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-10-17 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  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: Tocify is an easy way to generate a table of contents for your markdown
+  file
+email:
+- joseph@pintozzi.com
+executables:
+- tocify
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/tocify
+- lib/tocify.rb
+- lib/tocify/version.rb
+- tocify.gemspec
+homepage: https://github.com/pyro2927/tocify
+licenses:
+- MIT
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.23
+signing_key: 
+specification_version: 3
+summary: ''
+test_files: []