anchors 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 163b1b68541c2d11b9189be4a3acf89bc60529d1
+  data.tar.gz: ccf418e7425255accf64119986a923b670236bbd
+SHA512:
+  metadata.gz: 55a35235e831d45f673385e2b880caccd648029e953e0aba1e4e2e07a9f338e69f3edc431f57a1d3144cba48e3e2c25ef3370893db25429b50035315fa88e88e
+  data.tar.gz: 1e83423313f7de591ae85086bffc583233a808c3ecc17119d78c8e7a93488a420ec7a65e32c3341f0df49ea8dbbfd2811379d4c52475e3dd602f962d825917be

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 2.3.0
+before_install: gem install bundler -v 1.11.2

data/Gemfile

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

data/README.md

@@ -0,0 +1,51 @@
+# ⚓ Anchors ⚓
+
+This gem will add anchors to all of your websites h1-h6 headers. Its useful for static website generators, like Middleman.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'anchors'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install anchors
+
+## Usage
+
+Just use the middleware from your rack config.ru file or Middleman config.rb file as follows:
+
+```ruby
+require "anchors"
+use Anchors::Middleware
+```
+
+and the `body` will automatically have anchors applied to all of the h1-h6 tags.
+
+If you don't want to apply anchors to all of your requests, just pass a CSS selector into the middleware:
+
+```ruby
+require "anchors"
+use Anchors::Middleware,
+  css: "section.anchorize", # CSS headers are applied to. Defaults to 'body'
+  seperator: "-", # Change the seperator in the header. Defaults to _
+  link: false # Don't convert the headers into links to their own anchors. Defaults to true.
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/bradgessler/anchors.
+

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/anchors.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'anchors/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "anchors"
+  spec.version       = Anchors::VERSION
+  spec.authors       = ["Brad Gessler"]
+  spec.email         = ["bradgessler@gmail.com"]
+
+  spec.summary       = %q{Add anchors to your h1-h6 tags in Middleman or Rack}
+  spec.homepage      = "https://github.com/bradgessler/anchors"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.11"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "rack"
+  spec.add_development_dependency "rack-test"
+
+  spec.add_dependency "rack-plastic", "~> 0.1.0"
+end

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "anchors"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/anchors.rb

@@ -0,0 +1,46 @@
+require "anchors/version"
+require "rack-plastic"
+
+module Anchors
+  class Middleware < Rack::Plastic
+    CSS_SELECTOR = "body"
+    SEPERATOR = "_"
+    LINK = true
+
+    def change_nokogiri_doc(doc)
+      # Throw this CSS class into the HTML page where you
+      # want to have linkable anchor headers.
+      doc.css(css).each do |node|
+        node.css("h1,h2,h3,h4,h5,h6").each do |h|
+          id = dom_id(h)
+          h["id"] = id
+          if link?
+            a = Nokogiri::XML::Node.new "a", doc
+            a["href"] = "##{h["id"]}"
+            a.add_child h.clone
+            h.swap a
+          end
+        end
+      end
+      doc
+    end
+
+    private
+    # Super lame, but awesome way to get CSS options CSS selector.
+    def css
+      options[:css] || CSS_SELECTOR
+    end
+
+    def seperator
+      options[:seperator] || SEPERATOR
+    end
+
+    def link?
+      options[:link] || LINK
+    end
+
+    def dom_id(el)
+      el.content.downcase.gsub(/[^\d\w\s_]/, '').gsub(' ', '_')
+    end
+  end
+end

data/lib/anchors/version.rb

@@ -0,0 +1,3 @@
+module Anchors
+  VERSION = "0.1.0"
+end

metadata

@@ -0,0 +1,138 @@
+--- !ruby/object:Gem::Specification
+name: anchors
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Brad Gessler
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-02-19 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: rack
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rack-test
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rack-plastic
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.1.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.1.0
+description: 
+email:
+- bradgessler@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- README.md
+- Rakefile
+- anchors.gemspec
+- bin/console
+- bin/setup
+- lib/anchors.rb
+- lib/anchors/version.rb
+homepage: https://github.com/bradgessler/anchors
+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.5.1
+signing_key: 
+specification_version: 4
+summary: Add anchors to your h1-h6 tags in Middleman or Rack
+test_files: []