{{ "© Myles Braithwaite" | entities }}
77 | 78 |© Myles Braithwaite
79 | ``` 80 | 81 | ### Initial Quotes 82 | 83 | 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. 84 | 85 | ```html 86 |{{ "Today I'm going to the... coffeeshop." | smartypants }}
97 | 98 |Today I’m going to the… coffeeshop.
99 | ``` 100 | 101 | ### Widont 102 | 103 | 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. 104 | 105 | ```html 106 |{{ "There’s more to love with every click." | letter_spacing }}
137 | 138 |There’s more to love with every click
. 139 | ``` 140 | 141 | ### Em dash 142 | 143 | Identify em dashes and surround them with a span. 144 | 145 | ```html 146 |{{ "Upon discovering the errors—all 124 of them—the publisher immediately recalled the books." | jt_emdash }}
147 | 148 |Upon discovering the errors—all 124 of them—the publisher immediately recalled the books.
149 | ``` 150 | 151 | ## Development 152 | 153 | After checking out the repo, run `make setup` to install dependencies. Then, run `make console` for an interactive prompt that will allow you to experiment. 154 | 155 | 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` to create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org). 156 | 157 | ## Contributing 158 | 159 | See [CONTRIBUTING.md](CONTRIBUTING.md). 160 | -------------------------------------------------------------------------------- /Rakefile: -------------------------------------------------------------------------------- 1 | require "bundler/gem_tasks" 2 | require "rspec/core/rake_task" 3 | 4 | RSpec::Core::RakeTask.new(:spec) 5 | 6 | task :default => :spec 7 | -------------------------------------------------------------------------------- /bin/console: -------------------------------------------------------------------------------- 1 | #!/usr/bin/env ruby 2 | 3 | require "bundler/setup" 4 | require "jekyll/typogrify" 5 | 6 | require "pry" 7 | Pry.start 8 | -------------------------------------------------------------------------------- /jekyll-typogrify.gemspec: -------------------------------------------------------------------------------- 1 | # coding: utf-8 2 | lib = File.expand_path("../lib", __FILE__) 3 | $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib) 4 | require "jekyll/typogrify/version" 5 | 6 | Gem::Specification.new do |spec| 7 | spec.name = "jekyll-typogrify" 8 | spec.version = Jekyll::Typogrify::VERSION 9 | spec.summary = %q{A Jekyll plugin that improves the typography of your Liquid templates.} 10 | spec.description = %q{A Jekyll plugin that improves the typography of your Liquid templates.} 11 | spec.license = "MIT" 12 | 13 | spec.authors = ["Myles Braithwaite"] 14 | spec.email = ["me@mylesbraithwaite.com"] 15 | 16 | spec.homepage = "https://myles.github.io/jekyll-typogrify/" 17 | 18 | spec.files = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) } 19 | spec.bindir = "exe" 20 | spec.executables = spec.files.grep(%r{^exe/}) { |f| File.basename(f) } 21 | spec.require_paths = ["lib"] 22 | 23 | spec.add_runtime_dependency "titlecase" 24 | spec.add_runtime_dependency "typogruby" 25 | 26 | spec.add_development_dependency "bundler", "~> 1.7" 27 | spec.add_development_dependency "jekyll" 28 | spec.add_development_dependency "rake", "~> 13.0" 29 | spec.add_development_dependency "rspec", "~> 3.0" 30 | spec.metadata["rubygems_mfa_required"] = "true" 31 | end 32 | -------------------------------------------------------------------------------- /lib/jekyll-typogrify.rb: -------------------------------------------------------------------------------- 1 | # rubocop: disable Naming/FileName 2 | require "jekyll/typogrify" 3 | -------------------------------------------------------------------------------- /lib/jekyll/typogrify.rb: -------------------------------------------------------------------------------- 1 | require "jekyll/typogrify/version" 2 | 3 | require "rubypants" 4 | require "typogruby" 5 | require "titlecase" 6 | require "liquid" 7 | 8 | module Jekyll 9 | module TypogrifyFilter 10 | # converts a & surrounded by optional whitespace or a non-breaking space 11 | # to the HTML entity and surrounds it in a span with a styled class. 12 | # 13 | # @param [String] text input text 14 | # @return [String] input text with ampersands wrapped 15 | def amp(text) 16 | Typogruby.amp(text.to_s) 17 | end 18 | 19 | # surrounds two or more consecutive capital letters, perhaps with 20 | # interspersed digits and periods in a span with a styled class. 21 | # 22 | # @param [String] text input text 23 | # @return [String] input text with caps wrapped 24 | def caps(text) 25 | Typogruby.caps(text.to_s) 26 | end 27 | 28 | # Converts special characters (excluding HTML tags) to HTML entities. 29 | # 30 | # @param [String] text input text 31 | # @return [String] input text with all special characters converted to 32 | # HTML entities. 33 | def entities(text) 34 | Typogruby.entities(text.to_s) 35 | end 36 | 37 | # main function to do all the functions from the method. 38 | # 39 | # @param [String] text input text 40 | # @return [String] input text with all filters applied 41 | def improve(text) 42 | Typogruby.improve(text.to_s) 43 | end 44 | 45 | # encloses initial single or double quote, or their entities 46 | # (optionally preceded by a block element and perhaps an inline element) 47 | # with a span that can be styled. 48 | # 49 | # @param [String] text input text 50 | # @return [String] input text with initial quotes wrapped 51 | 52 | def initial_quotes(text) 53 | Typogruby.initial_quotes(text.to_s) 54 | end 55 | 56 | # Applies smartypants to a given piece of text 57 | # 58 | # @see https://rubygems.org/gems/rubypants 59 | # @param [String] text input text 60 | # @return [String] input text with smartypants applied 61 | def smartypants(text) 62 | Typogruby.smartypants(text.to_s) 63 | end 64 | 65 | # replaces space(s) before the last word (or tag before the last word) 66 | # before an optional closing element (a, em, 67 | # span, strong) before a closing tag (p, h[1-6], 68 | # li, dt, dd) or the end of the string. 69 | # 70 | # @see http://mucur.name/posts/widon-t-and-smartypants-helpers-for-rails 71 | # @see http://shauninman.com/archive/2006/08/22/widont_wordpress_plugin 72 | # @param [String] text input text 73 | # @return [String] input text with non-breaking spaces inserted 74 | def widont(text) 75 | Typogruby.widont(text.to_s) 76 | end 77 | 78 | # convert a given piece of text to titlecase 79 | # 80 | # @param [String] text input text 81 | # @return [String] input text convert to titlecase 82 | def titlecase(text) 83 | text.to_s.titlecase 84 | end 85 | 86 | # wraps words in a span class that can look like something else 87 | # 88 | # @param [String] text input text 89 | # @return [String] input text with words that look strange in a span 90 | def letter_spacing(text) 91 | text.gsub(/(click\S*|clint\S*|final\S*|curt\S*|flick\S*)\b/im) { |str| 92 | tag, before, word = $1, $2, $3 93 | "#{before}#{str}" 94 | } 95 | end 96 | 97 | # surrounds two or more consecutive capital letters, perhaps with 98 | # interspersed digits and periods in a span with a styled class. 99 | # 100 | # @param [String] text input text 101 | # @return [String] input text with caps wrapped 102 | def jt_caps(text) 103 | custom_caps(text.to_s) 104 | end 105 | 106 | # converts a — (em dash) by optional whitespace or a non-breaking space 107 | # to the HTML entity and surrounds it in a span with a styled class. 108 | # 109 | # @param [String] text input text 110 | # @return [String] input text with em dashes wrapped 111 | def jt_emdash(text) 112 | emdash(text.to_s) 113 | end 114 | 115 | private 116 | 117 | # custom modules to jekyll-typogrify 118 | 119 | # surrounds two or more consecutive capital letters, perhaps with 120 | # interspersed digits and periods in a span with a styled class. 121 | # 122 | # @param [String] text input text 123 | # @return [String] input text with caps wrapped 124 | def custom_caps(text) 125 | # $1 and $2 are excluded HTML tags, $3 is the part before the caps and $4 is the caps match 126 | text.gsub(%r{ 127 | (<[^/][^>]*?>)| # Ignore any opening tag, so we don't mess up attribute values 128 | (\s| |^|'|"|>|) # Make sure our capture is preceded by whitespace or quotes 129 | ([A-Z\d](?:(\.|'|-|&|&|&\#38;)?[A-Z\d][\.']?){1,}) # Capture capital words, with optional dots, numbers or ampersands in between 130 | (?!\w) # ...which must not be followed by a word character. 131 | }x) do |str| 132 | tag, before, caps = $1, $2, $3 133 | 134 | # Do nothing with the contents if ignored tags, the inside of an opening HTML element 135 | # so we don't mess up attribute values, or if our capture is only digits. 136 | if tag || caps =~ /^\d+\.?$/ 137 | str 138 | elsif $3 =~ /^[\d\.]+$/ 139 | before + caps 140 | else 141 | before + '' + caps + "" 142 | end 143 | end 144 | end 145 | 146 | # converts a — (em dash) by optional whitespace or a non-breaking space 147 | # to the HTML entity and surrounds it in a span with a styled class. 148 | # 149 | # @param [String] text input text 150 | # @return [String] input text with em dashes wrapped 151 | def emdash(text) 152 | text.gsub(/(\w|\s| )—(?:mdash;|#8212;)?(\w|\s| )/) { |_str| 153 | $1 + '—' + $2 154 | }.gsub(/(\w+)="(.*?)—<\/span>(.*?)"/, '\1="\2—\3"') 155 | end 156 | end 157 | end 158 | 159 | Liquid::Template.register_filter(Jekyll::TypogrifyFilter) 160 | -------------------------------------------------------------------------------- /lib/jekyll/typogrify/version.rb: -------------------------------------------------------------------------------- 1 | module Jekyll 2 | module Typogrify 3 | VERSION = "0.3.5" 4 | end 5 | end 6 | -------------------------------------------------------------------------------- /screenshots/after.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/myles/jekyll-typogrify/1481c6443220ed86fa3a162512bc874caab608a6/screenshots/after.png -------------------------------------------------------------------------------- /screenshots/before.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/myles/jekyll-typogrify/1481c6443220ed86fa3a162512bc874caab608a6/screenshots/before.png -------------------------------------------------------------------------------- /spec/fixtures/_config.yml: -------------------------------------------------------------------------------- 1 | timezone: UTC 2 | 3 | gems: 4 | - jekyll-typogrify 5 | 6 | defaults: 7 | - 8 | scope: 9 | path: "" 10 | type: pages 11 | values: 12 | layout: default -------------------------------------------------------------------------------- /spec/fixtures/_layouts/default.html: -------------------------------------------------------------------------------- 1 | --- 2 | --- 3 | 4 | 5 | 6 |{{ "This & That" | amp }}
7 | 8 |{{ "SCUBA is an acronym while IBM is an initialism" | caps }}
9 | 10 |{{ "©" | entities }}
11 | 12 |{{ '"Call me Ishmael" he said.' | initial_quotes }}
13 | 14 |{{ 'Myles "The Great" Braithwaite' | smartypants }}
15 | 16 |{{ "This is a rather long title and we don't want any widows or orphans." | widont }}
17 | 18 |{{ "'Neque porro quisquam' est qui dolorem ipsum quia dolor sit amet, consectetur, adipisci velit..." | improve }}
19 | 20 |{{ "🤖s Fighting 🐵s" | improve }}
21 | 22 |{{ "welcome to beautiful 東京都 (tokyo), japan" | titlecase }}
23 | 24 |{{ page.title | titlecase | improve }}
25 | 26 |{% assign assign_value = 'this is an assigned value' %}{{ assign_value | titlecase | improve }}
27 | 28 |{{ post.nil | improve | titlecase }}
29 | 30 |{{ post.doesntexist | improve | titlecase }}
31 | 32 |{{ post.empty | improve | titlecase }}
33 | 34 |{{ site.timezone | improve | titlecase }}
35 | 36 |{{ "Click, Clint's, and Flick." | letter_spacing }}
37 | 38 |{{ "The M65-A aircraft weights 10 tons." | caps }}
39 | 40 |{{ "The M65-A aircraft weights 10 tons." | jt_caps }}
41 | 42 |{{ "And yet, when the car was finally delivered—nearly three months after it was ordered—she decided she no longer wanted it, leaving the dealer with an oddly equipped car that would be difficult to sell." | jt_emdash }}
43 | 44 |{{ "The flight Vancouver — Toronto is around 4 hours and 30 minutes." | jt_emdash }}
45 | 46 | 47 | -------------------------------------------------------------------------------- /spec/fixtures/index.html: -------------------------------------------------------------------------------- 1 | --- 2 | title: this is the page title 3 | nil: nil 4 | empty: "" 5 | --- 6 | -------------------------------------------------------------------------------- /spec/jekyll/typogrify_spec.rb: -------------------------------------------------------------------------------- 1 | require "rbconfig" 2 | require "spec_helper" 3 | 4 | describe(Jekyll) do 5 | let(:overrides) do 6 | { 7 | "source" => source_dir, 8 | "destination" => dest_dir, 9 | "url" => "http://example.org", 10 | } 11 | end 12 | 13 | let(:config) do 14 | Jekyll.configuration(overrides) 15 | end 16 | 17 | let(:site) { Jekyll::Site.new(config) } 18 | let(:contents) { File.read(dest_dir("index.html")) } 19 | 20 | before(:each) do 21 | site.process 22 | end 23 | 24 | is_windows = (RbConfig::CONFIG["host_os"] =~ /mswin|mingw|cygwin/) 25 | 26 | it "has a version number" do 27 | expect(Jekyll::Typogrify::VERSION).not_to be nil 28 | end 29 | 30 | it "wraps ampersands in span with the class amp" do 31 | expect(contents).to match /This &<\/span> That<\/p>/
32 | expect(contents).to_not match / This & That<\/p>/
33 | end
34 |
35 | it "wraps acronyms and initialism in span with the class caps" do
36 | expect(contents).to match /SCUBA<\/span> is an acronym while IBM<\/span> is an initialism/
37 | expect(contents).to_not match /SCUBA is an acronym while IBM is an initialism/
38 | end
39 |
40 | it "converts special characters (excluding HTML tags) to HTML entities" do
41 | if not is_windows
42 | expect(contents).to match /©<\/strong>/
43 | expect(contents).to_not match /©<\/strong>/
44 | expect(contents).to_not match /<strong>©<\/strong>/
45 | end
46 | end
47 |
48 | it "wraps the first double/single quote in a span with the class dquo" do
49 | expect(contents).to match /"<\/span>Call me Ishmael" he said./
50 | expect(contents).to_not match /"Call me Ishmael" he said./
51 | end
52 |
53 | it "will apply the smartypants filter" do
54 | expect(contents).to match /Myles “The Great” Braithwaite/
55 | expect(contents).to_not match /Myles "The Great" Braithwaite/
56 | end
57 |
58 | it "will add a non-breaking-space between the last two words" do
59 | expect(contents).to match /This is a rather long title and we don't want any widows or orphans./
60 | expect(contents).to_not match /This is a rather long title and we don't want any widows or orphans./
61 | end
62 |
63 | it "runs all the filters" do
64 | expect(contents).to match /‘<\/span>Neque porro quisquam’ est qui dolorem ipsum quia dolor sit amet, consectetur, adipisci velit…/
65 | expect(contents).to_not match /'Neque porro quisquam' est qui dolorem ipsum quia dolor sit amet, consectetur, adipisci velit.../
66 | end
67 |
68 | it "run improve on a couple of emojis" do
69 | unless is_windows
70 | expect(contents).to_not match /🤖s Fighting 🐵s/
71 | expect(contents).to match /🤖s Fighting 🐵s/
72 | end
73 | end
74 |
75 | it "will apply the titlecase filter" do
76 | unless is_windows
77 | expect(contents).to_not match /welcome to beautiful 東京都 (tokyo), japan/
78 | # expect(contents).to match /Welcome to Beautiful 東京都 (Tokyo), Japan/
79 | end
80 | end
81 |
82 | it "test filter from a page variable" do
83 | expect(contents).to_not match /this is the page title/
84 | expect(contents).to match /This Is the Page Title/
85 | end
86 |
87 | it "test filter from an assign variable" do
88 | expect(contents).to_not match /this is an assigned value/
89 | expect(contents).to match /This Is an Assigned Value/
90 | end
91 |
92 | it "nothing should happen with nil" do
93 | expect(contents).to match / <\/p>/
94 | end
95 |
96 | it "nothing should happen if hte variable doesn't exist" do
97 | expect(contents).to match / <\/p>/
98 | end
99 |
100 | it "if the value is empty it should return nothing" do
101 | expect(contents).to match / <\/p>/
102 | end
103 |
104 | it "test the letter spacing filter" do
105 | expect(contents).to_not match / Click, Clint's, and Flick.<\/p>/
106 | expect(contents).to match / Click<\/span>, Clint's<\/span>, and Flick<\/span>.<\/p>/
107 | end
108 |
109 | it "test caps will not work with a hyphenated words" do
110 | expect(contents).to_not match / The M65-A<\/span> aircraft weights 10 tons.<\/p>/
111 | end
112 |
113 | it "test jt_caps will work with a hyphenated words" do
114 | expect(contents).to match / The M65-A<\/span> aircraft weights 10 tons.<\/p>/
115 | expect(contents).to_not match / The M65<\/span>-A aircraft weights 10 tons.<\/p>/
116 | end
117 |
118 | it "test jt_emdash" do
119 | expect(contents).to match / And yet, when the car was finally delivered—<\/span>nearly three months after it was ordered—<\/span>she decided she no longer wanted it, leaving the dealer with an oddly equipped car that would be difficult to sell.<\/p>/
120 | expect(contents).to_not match / And yet, when the car was finally delivered—nearly three months after it was ordered—she decided she no longer wanted it, leaving the dealer with an oddly equipped car that would be difficult to sell.<\/p>/
121 | end
122 |
123 | it "test jt_emdash with space" do
124 | expect(contents).to match / The flight Vancouver —<\/span> Toronto is around 4 hours and 30 minutes.<\/p>/
125 | expect(contents).to_not match / The flight Vancouver — Toronto is around 4 hours and 30 minutes.<\/p>/
126 | end
127 | end
128 |
--------------------------------------------------------------------------------
/spec/spec_helper.rb:
--------------------------------------------------------------------------------
1 | require "simplecov"
2 | SimpleCov.start
3 |
4 | $LOAD_PATH.unshift File.expand_path("../../lib", __FILE__)
5 | require "jekyll/typogrify"
6 | require "jekyll"
7 |
8 | Jekyll.logger.log_level = :error
9 |
10 | RSpec.configure do |config|
11 | config.run_all_when_everything_filtered = true
12 | config.filter_run :focus
13 | config.order = "random"
14 |
15 | SOURCE_DIR = File.expand_path("../fixtures", __FILE__)
16 | DEST_DIR = File.expand_path("../dest", __FILE__)
17 |
18 | def source_dir(*files)
19 | File.join(SOURCE_DIR, *files)
20 | end
21 |
22 | def dest_dir(*files)
23 | File.join(DEST_DIR, *files)
24 | end
25 | end
26 |
--------------------------------------------------------------------------------