octopress-filters 1.0.0 → 1.1.0

checksums.yaml

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

data/CHANGELOG.md

@@ -0,0 +1,11 @@
+# Changelog
+
+### 1.1.0 2014-07-21
+
+- Added smart quotes filter.
+- Added canonical_url filter.
+- Now relying on gem for titlecase and smartypants.
+
+### 1.0.0 - 2014-07-20
+
+- Initial release.

data/README.md

@@ -2,8 +2,11 @@
 
 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).
+- full_urls - Replace relative urls with absolute urls (searches for `href` and `src` properties).
+- full_url - Replace a relative url with an absolute url.
+- canonical_url - Convert a url to the proper canonical version.
+- titlecase - Properly capitalize titles with John Gruber’s [Title Case](http://daringfireball.net/2008/05/title_case).
+- smartquotes - Smartly curl your quotation marks with John Gruber’s [Smarty Pants](http://daringfireball.net/projects/smartypants/).
 - 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).
@@ -37,17 +40,35 @@ Next add it to your gems list in Jekyll's `_config.yml`
 
 ### 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:
+Any relative links in your site will be expanded with the `url` configuration in Jekyll's `_config.yml`. This filter only affects urls
+beginning with `/` inside of `href` or `src` attributes.
 
     {{ post.content | full_urls }}
 
-Now any relative links in your site will be expanded with the `url` configuration in Jekyll's `_config.yml`.
+You might use this if you're working on an RSS feed, you'll need to be sure all relative urls in your content are expanded to full urls.
+
+### Full url
+
+This filter prepends input with the `url` configuration in Jekyll's `_config.yml`.
+
+    {{ post.url | full_url }}
+
+### Canonical url
+
+This filter expands the url to be a full url, then removes "index.html" if it is present. Here are some examples.
+
+    {{ "about/index.html" | canonical_url }}  //=> http://example.com/about/
+    {{ "about.html" | canonical_url }}        //=> http://example.com/about.html
+    {{ "/" | canonical_url }}                 //=> http://example.com/
 
 ### Titlecase
 
     {{ post.title | titlecase }}  //=> This Is a Properly Capitalized Title
 
+### Smartquote
+
+    {{ post.content | smartquotes }}
+
 ### Unorphan
 
     {{ post.title | unorphan }}  //=> This Is a Properly Capitalized Title

data/lib/octopress-filters/version.rb

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

data/lib/octopress-filters.rb

@@ -1,15 +1,23 @@
 require "octopress-filters/version"
-require "octopress-filters/utils"
 
 unless defined? Octopress::Ink
   require "octopress-filters/generator"
 end
 
 require "jekyll"
+require "rubypants-unicode"
+require "titlecase"
 
 module Octopress
   module Filters
 
+    # 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
+
     # Escapes HTML content for XML
     def cdata_escape(input)
       input.gsub(/<!\[CDATA\[/, '&lt;![CDATA[').gsub(/\]\]>/, ']]&gt;')
@@ -18,7 +26,11 @@ module Octopress
     # 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)
+      input.titlecase
+    end
+
+    def smartquotes(input)
+      RubyPants.new(input).to_html
     end
 
     # Formats a string for use as a css classname, removing illegal characters
@@ -43,34 +55,10 @@ module Octopress
       input.sub(/\s+(\S+)\s*$/, '&nbsp;\1')
     end
 
-    # Prepends input with a url fragment
+    # Convert url input into a standard canonical url
     #
-    # 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
+    def canonical_url(input)
+      full_url(input).downcase.sub(/index\.html/, '')
     end
 
     # Prepend all urls with the full site url
@@ -105,17 +93,39 @@ module Octopress
       end
     end
 
-    module_function *instance_methods
-    public *private_instance_methods
-
-    private
+    # 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
 
-    # Returns the site's config root or '/' if the config isn't set
+    # Prepend all absolute urls with a url fragment
     #
-    def root
-      root_url = Ink.site.config['root']
-      root_url.nil? ? '/' : File.join('/', root_url)
+    # 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)\s*=\s*["|']{1})(\/[^\/>]{1}[^\"'>]*)/ do
+        $1 + expand_url($3, url)
+      end
     end
+
+    module_function *instance_methods
+    public *private_instance_methods.reject!{ |m| [:root].include?(m) }
+
   end
 end
 

data/octopress-filters.gemspec

@@ -19,6 +19,8 @@ Gem::Specification.new do |spec|
   spec.require_paths = ["lib"]
 
   spec.add_runtime_dependency "jekyll"
+  spec.add_runtime_dependency "rubypants-unicode"
+  spec.add_runtime_dependency "titlecase"
 
   spec.add_development_dependency "bundler", "~> 1.6"
   spec.add_development_dependency "rake"

data/test/Gemfile

@@ -3,4 +3,5 @@ source 'https://rubygems.org'
 gem 'octopress-filters', path: '../'
 gem 'pry-debugger'
 gem 'octopress-filter-tag'
+gem 'rubypants'
 gem 'clash'

data/test/_expected/canonical.html

@@ -0,0 +1,4 @@
+http://yourdomain.com/canonical.html
+http://yourdomain.com/
+http://yourdomain.com/foo/
+http://yourdomain.com/foo/

data/test/_expected/smartquotes.html

@@ -0,0 +1,27 @@
+“A first example”
+“A first “nested” example”
+”.
+“a
+’.
+‘a
+<p>He said, “‘Quoted’ words in a larger quote.”</p>
+“I like the 70’s”
+“I like the ’70s”
+“I like the ‘70!”
+
+pre”post
+pre “post
+pre&nbsp;“post
+pre–“post
+pre–”!
+
+pre’post
+pre ‘post
+pre&nbsp;‘post
+pre–‘post
+pre–’!
+<b>‘</b>
+foo<b>’</b>
+
+<pre>"this shouldn't be curled"</pre>
+<code>"this shouldn't be curled"</code>

data/test/canonical.html

@@ -0,0 +1,6 @@
+---
+---
+{{ page.url | canonical_url }}
+{{ "/index.html" | canonical_url }}
+{{ "foo/index.html" | canonical_url }}
+{{ "/foo/index.html" | canonical_url }}

data/test/smartquotes.html

@@ -0,0 +1,31 @@
+---
+---
+{% filter smartquotes %}
+"A first example"
+"A first "nested" example"
+".
+"a
+'.
+'a
+<p>He said, "'Quoted' words in a larger quote."</p>
+"I like the 70's"
+"I like the '70s"
+"I like the '70!"
+
+pre"post
+pre "post
+pre&nbsp;"post
+pre--"post
+pre--"!
+
+pre'post
+pre 'post
+pre&nbsp;'post
+pre--'post
+pre--'!
+<b>'</b>
+foo<b>'</b>
+
+<pre>"this shouldn't be curled"</pre>
+<code>"this shouldn't be curled"</code>
+{% endfilter %}

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: octopress-filters
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.0
 platform: ruby
 authors:
 - Brandon Mathis
@@ -24,6 +24,34 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubypants-unicode
+  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: titlecase
+  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
@@ -89,28 +117,32 @@ extra_rdoc_files: []
 files:
 - ".gitignore"
 - ".travis.yml"
+- CHANGELOG.md
 - 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/canonical.html
 - test/_expected/classify.html
 - test/_expected/compact_newlines.html
 - test/_expected/full_urls.html
 - test/_expected/join_lines.html
+- test/_expected/smartquotes.html
 - test/_expected/titlecase.html
 - test/_expected/unorphan.html
+- test/canonical.html
 - test/classify.html
 - test/compact_newlines.html
 - test/full_urls.html
 - test/join_lines.html
+- test/smartquotes.html
 - test/titlecase.html
 - test/unorphan.html
 homepage: https://github.com/octopress/filters
@@ -141,15 +173,19 @@ test_files:
 - test/.clash.yml
 - test/Gemfile
 - test/_config.yml
+- test/_expected/canonical.html
 - test/_expected/classify.html
 - test/_expected/compact_newlines.html
 - test/_expected/full_urls.html
 - test/_expected/join_lines.html
+- test/_expected/smartquotes.html
 - test/_expected/titlecase.html
 - test/_expected/unorphan.html
+- test/canonical.html
 - test/classify.html
 - test/compact_newlines.html
 - test/full_urls.html
 - test/join_lines.html
+- test/smartquotes.html
 - test/titlecase.html
 - test/unorphan.html

data/lib/octopress-filters/utils.rb

@@ -1,42 +0,0 @@
-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
-