octopress-filters 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: d40675a0cd8630124d45612741f89126ae9a2cb0
+  data.tar.gz: 05aad8da4369126ecc078e1528507efc132a2392
+SHA512:
+  metadata.gz: 09c6d4be84f20a2de65dff01847873fcf9d221aff3a89f58f46e27041d38fb21d7b3ac9ed751afc50b9552674fc22f68e5ad90ac8ea6fa799659dd9e1a4747f1
+  data.tar.gz: 0e736abdddd45f4f7292a634ab47dc87906f9368b531204390088f4a3436d487809708428e40b092fee90d21ccc0cb52325b1f8c7fad965297668ec7f1c02b85

data/.gitignore

@@ -0,0 +1,23 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log
+_site

data/.travis.yml

@@ -0,0 +1,5 @@
+language: ruby
+rvm:
+  - 2.0.0
+  - 1.9.3
+script: cd test && bundle exec clash

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Brandon Mathis
+
+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,81 @@
+# Octopress Filters
+
+A set of handy liquid filters used by Octopress.
+
+- full_urls - Replace relative urls with absolute urls.
+- titlecase - Properly capitalize titles based on John Gruber's [Title Case](http://daringfireball.net/2008/05/title_case).
+- unorphan - Insert a non-breaking space between the last two words in a title.
+- sluggify - Replaces all non-word characters in a string with dashes.
+- classify - An alias for sluggify (seems appropriate when working with CSS class names).
+- compact_newlines - Compact groups of empty lines into one, because Liquid templates have lots of whitespace.
+- join_lines - Remove all new lines, joining each line with a separator. (defaults to a space).
+
+[![Build Status](https://travis-ci.org/octopress/filters.svg)](https://travis-ci.org/octopress/filters)
+[![Gem Version](http://img.shields.io/gem/v/octopress-filters.svg)](https://rubygems.org/gems/octopress-filters)
+[![License](http://img.shields.io/:license-mit-blue.svg)](http://octopress.mit-license.org)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'octopress-filters'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install octopress-filters
+
+Next add it to your gems list in Jekyll's `_config.yml`
+
+    gems:
+      - octopress-filters
+
+## Examples
+
+### Full urls
+
+If you're working on an RSS feed, you'll need to be sure all of your relative urls are converted to full urls. In that case, when
+rendering the content of a page, just do this:
+
+    {{ post.content | full_urls }}
+
+Now any relative links in your site will be expanded with the `url` configuration in Jekyll's `_config.yml`.
+
+### Titlecase
+
+    {{ post.title | titlecase }}  //=> This Is a Properly Capitalized Title
+
+### Unorphan
+
+    {{ post.title | unorphan }}  //=> This Is a Properly Capitalized Title
+
+### Sluggify/Classify
+
+    <article class="{{ post.class | classify }}">
+
+### Compact newlines
+
+    {{ content | compact_newlines }}
+
+### Join lines
+
+    {% capture page_title %}
+    {{ page.title }}
+    {{ site.header.title }}
+    {% endcapture %}
+
+    <head>
+      <title>{{ page_title | join_lines: " - " }}</title>
+      …
+
+## Contributing
+
+1. Fork it ( https://github.com/octopress/filters/fork )
+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 a new Pull Request
+

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+

data/lib/octopress-filters.rb

@@ -0,0 +1,124 @@
+require "octopress-filters/version"
+require "octopress-filters/utils"
+
+unless defined? Octopress::Ink
+  require "octopress-filters/generator"
+end
+
+require "jekyll"
+
+module Octopress
+  module Filters
+
+    # Escapes HTML content for XML
+    def cdata_escape(input)
+      input.gsub(/<!\[CDATA\[/, '&lt;![CDATA[').gsub(/\]\]>/, ']]&gt;')
+    end
+
+    # Returns a title cased string based on John Gruber's title case 
+    # Info: http://daringfireball.net/2008/08/title_case_update
+    def titlecase(input)
+      Octopress::Utils.titlecase!(input)
+    end
+
+    # Formats a string for use as a css classname, removing illegal characters
+    def classify(input)
+      input.gsub(/ /,'-').gsub(/[^\w-]/,'').downcase
+    end
+
+    alias_method :sluggify, :classify
+
+    # Remove empty lines
+    def compact_newlines(input)
+      input.gsub(/\n{2,}/, "\n").gsub(/^ +\n/,"")
+    end
+
+    # Join newlines 
+    def join_lines(input, separator='')
+      compact_newlines(input).strip.gsub(/\s*\n\s*/, separator)
+    end
+
+    # Prevent orphans in text by inserting a non-breaking space between the two last words of a string.
+    def unorphan(input)
+      input.sub(/\s+(\S+)\s*$/, '&nbsp;\1')
+    end
+
+    # Prepends input with a url fragment
+    #
+    # input - An absolute url, e.g. /images/awesome.gif
+    # url   - The fragment to prepend the input, e.g. /blog
+    #
+    # Returns the modified url, e.g /blog
+    #
+    def expand_url(input, url=nil)
+      url ||= root
+      if input =~ /^#{url}/
+        input
+      else
+        File.join(url, input)
+      end
+    end
+
+    # Prepend all absolute urls with a url fragment
+    #
+    # input - The content of a page or post
+    # url   - The fragment to prepend absolute urls
+    #
+    # Returns input with modified urls
+    #
+    def expand_urls(input, url=nil)
+      url ||= root
+      input.gsub /(\s+(href|src|rel)\s*=\s*["|']{1})(\/[^\/>]{1}[^\"'>]*)/ do
+        $1 + expand_url($3, url)
+      end
+    end
+
+    # Prepend all urls with the full site url
+    #
+    # input - The content of a page or post
+    #
+    # Returns input with all urls expanded to include the full site url
+    # e.g. /images/awesome.gif => http://example.com/images/awesome.gif
+    #
+    def full_urls(input)
+      url = Ink.site.config['url']
+      if url.nil?
+        raise IOError.new "Could not expand urls: Please add your published url to your _config.yml, eg url: http://example.com/"
+      else
+        expand_urls(input, url)
+      end
+    end
+    
+    # Prepend a url with the full site url
+    #
+    # input - a url
+    #
+    # Returns input with all urls expanded to include the full site url
+    # e.g. /images/awesome.gif => http://example.com/images/awesome.gif
+    #
+    def full_url(input)
+      url = Ink.site.config['url']
+      if url.nil?
+        raise IOError.new "Could not expand url in #{input}: Please add your site's published url to your _config.yml, eg url: http://example.com/"
+      else
+        expand_url(input, url)
+      end
+    end
+
+    module_function *instance_methods
+    public *private_instance_methods
+
+    private
+
+    # Returns the site's config root or '/' if the config isn't set
+    #
+    def root
+      root_url = Ink.site.config['root']
+      root_url.nil? ? '/' : File.join('/', root_url)
+    end
+  end
+end
+
+
+
+Liquid::Template.register_filter Octopress::Filters

data/lib/octopress-filters/generator.rb

@@ -0,0 +1,17 @@
+module Octopress
+  module Ink
+    def self.site
+      @site
+    end
+
+    def self.site=(site)
+      @site = site
+    end
+
+    class SiteGrabber < Jekyll::Generator
+      def generate(site)
+        Octopress::Ink.site = site
+      end
+    end
+  end
+end

data/lib/octopress-filters/utils.rb

@@ -0,0 +1,42 @@
+module Octopress
+  module Utils
+    # Smart capitalization for titles
+    #
+    def self.titlecase(input)
+      small_words = %w(a an and as at but by en for if in of on or the to v v. via vs vs.)
+
+      x = input.split(" ").map do |word|
+        # note: word could contain non-word characters!
+        # downcase all small_words, capitalize the rest
+        small_words.include?(word.gsub(/\W/, "").downcase) ? word.downcase! : smart_capitalize!(word)
+        word
+      end
+      # capitalize first and last words
+      smart_capitalize!(x.first)
+      smart_capitalize!(x.last)
+      # small words are capitalized after colon, period, exclamation mark, question mark
+      x.join(" ").gsub(/(:|\.|!|\?)\s?(\W*#{small_words.join("|")}\W*)\s/) { "#{$1} #{smart_capitalize($2)} " }
+    end
+
+    def self.titlecase!(input)
+      input.replace(titlecase(input))
+    end
+
+    def self.smart_capitalize(input)
+      target = input.dup
+      # ignore any leading crazy characters and capitalize the first real character
+      if target =~ /^['"\(\[']*([a-z])/
+        i = input.index($1)
+        x = target[i,target.length]
+        # word with capitals and periods mid-word are left alone
+        target[i,1] = target[i,1].upcase unless x =~ /[A-Z]/ or x =~ /\.\w+/
+      end
+      target
+    end
+    
+    def self.smart_capitalize!(input)
+      input.replace(smart_capitalize(input))
+    end
+  end
+end
+

data/lib/octopress-filters/version.rb

@@ -0,0 +1,7 @@
+module Octopress
+  module Tags
+    module Filters
+      VERSION = "1.0.0"
+    end
+  end
+end

data/octopress-filters.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'octopress-filters/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "octopress-filters"
+  spec.version       = Octopress::Tags::Filters::VERSION
+  spec.authors       = ["Brandon Mathis"]
+  spec.email         = ["brandon@imathis.com"]
+  spec.summary       = %q{Return tag renders a variable with some nice features}
+  spec.description   = %q{Return tag renders a variable with some nice features}
+  spec.homepage      = "https://github.com/octopress/filters"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  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_runtime_dependency "jekyll"
+
+  spec.add_development_dependency "bundler", "~> 1.6"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "clash"
+  spec.add_development_dependency "octopress-filter-tag", "~> 1.0"
+end

data/test/.clash.yml

@@ -0,0 +1,2 @@
+build: true
+compare: _expected _site

data/test/Gemfile

@@ -0,0 +1,6 @@
+source 'https://rubygems.org'
+
+gem 'octopress-filters', path: '../'
+gem 'pry-debugger'
+gem 'octopress-filter-tag'
+gem 'clash'

data/test/_config.yml

@@ -0,0 +1,15 @@
+# Site settings
+title: Your awesome title
+email: your-email@domain.com
+baseurl: ""
+url: "http://yourdomain.com"
+timezone: UTC
+
+exclude:
+  - Gemfile*
+
+# Build settings
+markdown: kramdown
+gems:
+  - octopress-filters
+  - octopress-filter-tag

data/test/_expected/classify.html

@@ -0,0 +1,5 @@
+
+
+<div class="this-is-a-silly-classname"></div>
+<div class="this-is-a-silly-classname"></div>
+

data/test/_expected/compact_newlines.html

@@ -0,0 +1,6 @@
+There
+Is
+A
+Lot
+Of
+Whitespace

data/test/_expected/full_urls.html

@@ -0,0 +1,2 @@
+<a href="http://yourdomain.com/about">About</a>
+<script src="http://yourdomain.com/javascripts/foo.js"></script>

data/test/_expected/join_lines.html

@@ -0,0 +1,2 @@
+this,has,commas,man
+

data/test/_expected/titlecase.html

@@ -0,0 +1 @@
+This Title Could Use Some Capitals

data/test/_expected/unorphan.html

@@ -0,0 +1 @@
+This title is long so it might wrap

data/test/classify.html

@@ -0,0 +1,7 @@
+---
+---
+{% assign class = "this is a silly classname" %}
+
+<div class="{{ class | classify }}"></div>
+<div class="{{ class | sluggify }}"></div>
+

data/test/compact_newlines.html

@@ -0,0 +1,15 @@
+---
+---
+{% filter compact_newlines %}
+There
+
+Is
+
+A
+
+Lot
+
+Of
+
+Whitespace
+{% endfilter %}

data/test/full_urls.html

@@ -0,0 +1,6 @@
+---
+---
+{% filter full_urls %}
+<a href="/about">About</a>
+<script src="/javascripts/foo.js"></script>
+{% endfilter %}

data/test/join_lines.html

@@ -0,0 +1,9 @@
+---
+---
+{% filter join_lines: ',' %}
+this
+has
+commas
+man
+{% endfilter %}
+

data/test/titlecase.html

@@ -0,0 +1,5 @@
+---
+title: this title could use some capitals
+---
+
+{{ page.title | titlecase }}

data/test/unorphan.html

@@ -0,0 +1,5 @@
+---
+title: This title is long so it might wrap
+---
+
+{{ page.title | unorphan }}

metadata

@@ -0,0 +1,155 @@
+--- !ruby/object:Gem::Specification
+name: octopress-filters
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Brandon Mathis
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-07-21 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: jekyll
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !ruby/object:Gem::Dependency
+  name: rake
+  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: clash
+  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: octopress-filter-tag
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+description: Return tag renders a variable with some nice features
+email:
+- brandon@imathis.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/octopress-filters.rb
+- lib/octopress-filters/generator.rb
+- lib/octopress-filters/utils.rb
+- lib/octopress-filters/version.rb
+- octopress-filters.gemspec
+- test/.clash.yml
+- test/Gemfile
+- test/_config.yml
+- test/_expected/classify.html
+- test/_expected/compact_newlines.html
+- test/_expected/full_urls.html
+- test/_expected/join_lines.html
+- test/_expected/titlecase.html
+- test/_expected/unorphan.html
+- test/classify.html
+- test/compact_newlines.html
+- test/full_urls.html
+- test/join_lines.html
+- test/titlecase.html
+- test/unorphan.html
+homepage: https://github.com/octopress/filters
+licenses:
+- MIT
+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.2.2
+signing_key: 
+specification_version: 4
+summary: Return tag renders a variable with some nice features
+test_files:
+- test/.clash.yml
+- test/Gemfile
+- test/_config.yml
+- test/_expected/classify.html
+- test/_expected/compact_newlines.html
+- test/_expected/full_urls.html
+- test/_expected/join_lines.html
+- test/_expected/titlecase.html
+- test/_expected/unorphan.html
+- test/classify.html
+- test/compact_newlines.html
+- test/full_urls.html
+- test/join_lines.html
+- test/titlecase.html
+- test/unorphan.html