jekyll-typogrify 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: fd56418a3d4c78a6891a8c32f82823128b8fea85
-  data.tar.gz: 3ffde97032a6440d2260ed603e53628c28229888
+  metadata.gz: 0a7a52249e9456f56e2493916d691b1c5d61442d
+  data.tar.gz: 671eb9d8b6d1b07def4f1a4c55b84057ead7383a
 SHA512:
-  metadata.gz: affbbf18ee110f27dbf18edbec1f66e5caee37abca327a76ffe7b49cd2136f1a5659ce869ea64d3fbfabca56a7c1ad91721a670e701278483c732c8a1a4f3e4e
-  data.tar.gz: 3f840f9994667dbb65bcd73ed957000c9f741afdce15273ed83f579d42e5adf3819f05e373ff3faa7bce39769c6ebc64cf5bb9093a9ef612c2b236d92bc22f9d
+  metadata.gz: 10e8a84ed26241289868fde1dc772313f6eef5f2da07a8990441e95d5ae038328efdb3049622e491f8039df3d255b765a43ef9fcda8cf0b0c22be1b26b261cdb
+  data.tar.gz: 357660fef7529d17f3aa80e1ab5f7869a9daaadf09d0d2c6ef1ea0b8ad8581e556541d61039ddae7db357904de7aee37ecb89f084f974677aa5f19c7fafd2f7c

data/.editorconfig

@@ -0,0 +1,3 @@
+[*.rb]
+indent_style = space
+indent_size = 2

data/.gitignore

@@ -9,3 +9,4 @@
 /tmp/
 /vendor/
 /spec/dest/
+/designs/

data/CONTRIBUTING.md

@@ -0,0 +1,21 @@
+# Contributing
+
+I love to get pull requests from everyone. By participating in this project, you agree to abide by the [code of conduct](CODE_OF_CONDUCT.md).
+
+[Fork](https://github.com/myles/jekyll-typogrify/fork), then clone the repo:
+
+	git clone git@github.com:your-username/jekyll-typogrify.git
+
+Set up your machine:
+
+	./bin/setup
+
+Make sure the tests pass
+
+	./bin/test
+
+Make your change. Add tests for your change. Make the tests pass:
+
+	./bin/test
+
+Push to your fork and [submit a pull request](https://github.com/myles/jekyll-typogrify/compare/).

data/README.md

@@ -1,8 +1,12 @@
+[![Build Status](https://travis-ci.org/myles/jekyll-typogrify.svg?branch=master)](https://travis-ci.org/myles/jekyll-typogrify) [![Gem Version](https://badge.fury.io/rb/jekyll-typogrify.svg)](http://badge.fury.io/rb/jekyll-typogrify) [![Code Issues](https://www.quantifiedcode.com/api/v1/project/e017e34c1f35482e87e0ea12390ef7cc/badge.svg)](https://www.quantifiedcode.com/app/project/e017e34c1f35482e87e0ea12390ef7cc)
+
 # Jekyll::Typogrify
 
 Improves typography on your Jekyll site using [typogruby](http://avdgaag.github.io/typogruby/) and [titlecase](https://github.com/samsouder/titlecase).
 
-[![Build Status](https://travis-ci.org/myles/jekyll-typogrify.svg?branch=master)](https://travis-ci.org/myles/jekyll-typogrify) [![Gem Version](https://badge.fury.io/rb/jekyll-typogrify.svg)](http://badge.fury.io/rb/jekyll-typogrify)
+| Before | After |
+| ------ | ----- |
+| ![Before](https://raw.githubusercontent.com/myles/jekyll-typogrify/master/screenshots/before.png) | ![After](https://raw.githubusercontent.com/myles/jekyll-typogrify/master/screenshots/after.png) |
 
 ## Installation
 
@@ -20,8 +24,65 @@ Or install it yourself as:
 
     $ gem install jekyll-typogrify
 
+You now need to enable the plugin in your Jekyll web site. Append it to the `gems` array in your `_config.yml` file:
+
+```yaml
+gems:
+- jekyll-typogrify
+```
+
 ## Usage
 
+### Andpercent
+
+Converts an andpercent (ex. `&`) converts a & surrounded by optional whitespace or a non-breaking space to the HTML entity and surrounds it in a span with a styled class.
+
+```html
+<h1>{{ "Mr. & Mrs. Smith" | amp }}</h1>
+
+<h1>Mr. <span class="amp">&amp;</span> Mrs. Smith</h1>
+```
+
+### Capitalisation
+
+Surrounds two or more consecutive capital letters, perhaps with interspersed digits and periods in a span with a styled class.
+
+```html
+<h1>{{ "A.B.C. Corp." | caps }}</h1>
+
+<h1><span class="caps">A.B.C.</span> Corp.</h1>
+```
+
+### Entities
+
+Converts special characters (excluding HTML tags) to HTML entities.
+
+```html
+<p>© Myles Braithwaite</p>
+
+<p>&copy; Myles Braithwaite</p>
+```
+
+### Initial Quotes
+
+Encloses initial single or double quote, or their entities (optionally preceeded by a block element and perhaps an inline element) with a span that can be styled.
+
+```html
+<h1>{{ '"Do not cry because it is over, simile because it happened."' | initial_quotes }}</h1>
+
+<h1><span class="dquo">"</span>Do not cry because it is over, simile because it happened."</h1>
+```
+
+### Smartypants
+
+Applies smartypants to a given piece of text.
+
+```html
+<p>{{ "Today I'm going to the... coffeeshop." | smartypants }}</p>
+
+<p>Today I&#8217;m going to the&#8230; coffeeshop.</p>
+```
+
 ### Widont
 
 Replaces space(s) before the last word (or tag before the last word) before an optional closing element (a, em, span, strong) before a closing tag (p, h[1-6], li, dt, dd) or the end of the string.
@@ -32,6 +93,36 @@ Replaces space(s) before the last word (or tag before the last word) before an o
 <h1>This is a rather long&nbsp;title.</h1>
 ```
 
+### Titlecase
+
+Convert a given piece of text to titlecase.
+
+```html
+<h1>{{ "i love toronto" | titlecase }}</h1>
+
+<h1>I Love Toronto</h1>
+```
+
+### Improve
+
+Main function to do all the typogruby functions from the method.
+
+```html
+<h1>{{ "Improve This Title" | improve }}</h1>
+
+<h1>Improve This&nbsp;Title</h1>
+```
+
+### Letter Spacing
+
+Let's make sure click doesn't look like dick.
+
+```html
+<p>{{ "There’s more to love with every click." | letter_spacing }}</p>
+
+<p>There’s more to love with every <span class="fix-letter-spacing">click</p>.</p>
+```
+
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `bin/console` for an interactive prompt that will allow you to experiment.
@@ -40,8 +131,4 @@ To install this gem onto your local machine, run `bundle exec rake install`. To
 
 ## Contributing
 
-1. Fork it ( https://github.com/myles/jekyll-typogrify/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
+See [CONTRIBUTING.md](CONTRIBUTING.md).

data/bin/server

@@ -0,0 +1,5 @@
+#!/bin/bash
+set -euo pipefail
+IFS=$'\n\t'
+
+bundle exec jekyll serve --config ./spec/fixtures/_config.yml -d ./spec/dest -s ./spec/fixtures/ --watch

data/bin/setup

@@ -3,5 +3,3 @@ set -euo pipefail
 IFS=$'\n\t'
 
 bundle install --path vendor/bundle
-
-# Do any other automated setup that you need to do here

data/bin/test

@@ -0,0 +1,5 @@
+#!/bin/bash
+set -euo pipefail
+IFS=$'\n\t'
+
+bundle exec rake

data/jekyll-typogrify.gemspec

@@ -6,22 +6,23 @@ require 'jekyll/typogrify/version'
 Gem::Specification.new do |spec|
   spec.name          = "jekyll-typogrify"
   spec.version       = Jekyll::Typogrify::VERSION
-  spec.authors       = ["Myles Braithwaite"]
-  spec.email         = ["me@mylesbraithwaite.com"]
-
   spec.summary       = %q{A Jekyll plugin that bring the functions of typogruby.}
   spec.description   = %q{A Jekyll plugin that bring the functions of typogruby.}
-  spec.homepage      = "https://github.com/myles/jekyll-typogrify"
   spec.license       = "MIT"
 
+  spec.authors       = ["Myles Braithwaite"]
+  spec.email         = ["me@mylesbraithwaite.com"]
+
+  spec.homepage      = "http://myles.github.io/jekyll-typogrify/"
+
   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_runtime_dependency "typogruby"
-	spec.add_runtime_dependency "titlecase"
-  
+  spec.add_runtime_dependency "titlecase"
+
   spec.add_development_dependency "bundler", "~> 1.7"
   spec.add_development_dependency "rspec", "~> 3.0"
   spec.add_development_dependency "rake", "~> 10.0"

data/lib/jekyll/typogrify/version.rb

@@ -1,5 +1,5 @@
 module Jekyll
   module Typogrify
-    VERSION = "0.2.0"
+    VERSION = "0.3.0"
   end
 end

data/lib/jekyll/typogrify.rb

@@ -12,16 +12,16 @@ module Jekyll
     # @param [String] text input text
     # @return [String] input text with ampersands wrapped
     def amp(text)
-      return Typogruby.amp(text)
+      return Typogruby.amp(text.to_s)
     end
     
-    # surrounds two or more consecutive captial letters, perhaps with
+    # surrounds two or more consecutive capital letters, perhaps with
     # interspersed digits and periods in a span with a styled class.
     #
     # @param [String] text input text
     # @return [String] input text with caps wrapped
     def caps(text)
-      return Typogruby.caps(text)
+      return Typogruby.caps(text.to_s)
     end
     
     # Converts special characters (excluding HTML tags) to HTML entities.
@@ -30,7 +30,7 @@ module Jekyll
     # @return [String] input text with all special characters converted to
     #   HTML entities.
     def entities(text)
-      return Typogruby.entities(text)
+      return Typogruby.entities(text.to_s)
     end
     
     # main function to do all the functions from the method.
@@ -38,7 +38,7 @@ module Jekyll
     # @param [String] text input text
     # @return [String] input text with all filters applied
     def improve(text)
-      return Typogruby.improve(text)
+      return Typogruby.improve(text.to_s)
     end
     
     # encloses initial single or double quote, or their entities
@@ -49,7 +49,7 @@ module Jekyll
     # @return [String] input text with initial quotes wrapped
     
     def initial_quotes(text)
-      return Typogruby.initial_quotes(text)
+      return Typogruby.initial_quotes(text.to_s)
     end
     
     # Applies smartypants to a given piece of text
@@ -58,7 +58,7 @@ module Jekyll
     # @param [String] text input text
     # @return [String] input text with smartypants applied
     def smartypants(text)
-      return Typogruby.smartypants(text)
+      return Typogruby.smartypants(text.to_s)
     end
     
     # replaces space(s) before the last word (or tag before the last word)
@@ -71,13 +71,28 @@ module Jekyll
     # @param [String] text input text
     # @return [String] input text with non-breaking spaces inserted
     def widont(text)
-      return Typogruby.widont(text)
+      return Typogruby.widont(text.to_s)
     end
     
+    # convert a given piece of text to titlecase
+    #
+    # @param [String] text input text
+    # @return [String] input text convert to titlecase
     def titlecase(text)
-      return text.titlecase
+      return text.to_s.titlecase
+    end
+    
+    # wraps words in a span class that can look like something else
+    #
+    # @param [String] text input text
+    # @return [String] input text with words that look strange in a span
+    def letter_spacing(text)
+      text.gsub(/(click|clint|final|curt|flicks|flick|clicks|flickering)/im) { |str|
+        tag, before, word = $1, $2, $3
+        "#{before}<span class=\"fix-letter-spacing\">#{str}</span>"
+      }
     end
   end
 end
 
-Liquid::Template.register_filter(Jekyll::TypogrifyFilter)
+Liquid::Template.register_filter(Jekyll::TypogrifyFilter)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: jekyll-typogrify
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Myles Braithwaite
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-01-15 00:00:00.000000000 Z
+date: 2016-02-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: typogruby
@@ -101,21 +101,27 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".editorconfig"
 - ".gitignore"
 - ".rspec"
 - ".travis.yml"
 - CODE_OF_CONDUCT.md
+- CONTRIBUTING.md
 - Gemfile
 - LICENSE.txt
 - README.md
 - Rakefile
 - bin/console
+- bin/server
 - bin/setup
+- bin/test
 - jekyll-typogrify.gemspec
 - lib/jekyll-typogrify.rb
 - lib/jekyll/typogrify.rb
 - lib/jekyll/typogrify/version.rb
-homepage: https://github.com/myles/jekyll-typogrify
+- screenshots/after.png
+- screenshots/before.png
+homepage: http://myles.github.io/jekyll-typogrify/
 licenses:
 - MIT
 metadata: {}