jekyll-hyphenate_filter 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: a09f1859dd01c032edac992368b4b78ac18bcb3d
+  data.tar.gz: c2a0687578ca3b5ba22fd6fb311525d3d8752895
+SHA512:
+  metadata.gz: 78c143b3f0f79ba74589232b5c86b8e70a8e8a5e81ea6209455db99bac553ac9d5507f4d8e37c82d0b56e4564e62ae23fab6c8d5c87066e2febd51cd85b0d441
+  data.tar.gz: 83322cc1dd9563fb55bf9902d9903662e4cb75b1dae23b7d65a550d0b9cb7b59a5999a7df7e6a10cd5c7d87a63a6912e6e723c0bdc1b05982468d10b1c5a2506

data/CHANGELOG.markdown

@@ -0,0 +1 @@
+# Jekyll::HyphenateFilter ChangeLog

data/Gemfile

@@ -0,0 +1,5 @@
+source "https://rubygems.org"
+gem "nokogiri"
+gem "liquid"
+gem "text-hyphen"
+gem "test-unit"

data/Gemfile.lock

@@ -0,0 +1,23 @@
+GEM
+  remote: https://rubygems.org/
+  specs:
+    liquid (3.0.6)
+    mini_portile2 (2.0.0)
+    nokogiri (1.6.7.2)
+      mini_portile2 (~> 2.0.0.rc2)
+    power_assert (0.2.2)
+    test-unit (3.0.8)
+      power_assert
+    text-hyphen (1.4.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  liquid
+  nokogiri
+  test-unit
+  text-hyphen
+
+BUNDLED WITH
+   1.10.5

data/LICENSE

@@ -0,0 +1,9 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Michael Glaesemann
+
+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.markdown

@@ -0,0 +1,67 @@
+# Jekyll HyphenateFilter
+
+Jekyll Liquid filter to apply [Text::Hyphen][] to content.
+
+[text::hyphen]: https://github.com/halostatue/text-hyphen
+
+## Installation
+
+Install the `jekyll-hyphenate_filter` gem in a [Jekyll-approved
+manner](https://jekyllrb.com/docs/plugins/#installing-a-plugin).
+
+## Use
+
+To hyphenate content, you can use the filter like this:
+
+    {{ content | hyphenate }}
+
+## Configuration
+
+There are a few configurable parameters which control hyphenation behavior.
+These parameters are `language`, `left`, and `right`. These take the same
+values as [Text::Hyphen][]. In brief:
+
+ * `language` - language of the content. Defaults to `en_us`.
+ * `left` - minimum number of characters to the left of the hyphen.
+   Defaults to 2.
+ * `right` - minimum number of characters to the right of the hyphen.
+   Defaults to 2.
+
+In addition, you can specify the string used to indicate hyphenation points
+with the `hyphen` parameter. The default is the UTF-8 soft-hyphen character
+(Unicode code U+00AD). Note that this is the UTF-8 character, not an entity.
+
+You can update `_config.yml` to set these parameters. For example:
+
+    hyphenate_filter:
+      language: en_uk
+      left: 4
+      right: 3
+      hyphen: "­"
+
+This configuration sets the language to UK English, with a minimum of 4
+characters to the left of the hyphenation, minimum 3 characters to the right,
+and the HTML entity `­` to indicate hyphenation points.
+
+## Notes
+
+HyphenateFilter builds upon the [Jekyll::HyphenateFilter][] from
+[Jekyll plugins by Aucor][aucor-jekyll-plugins].
+
+Two behavior differences between the Aucor Oy filter (as of 2013-09-20) and the
+one provided here:
+
+ * This filter will descend into subelements (such as tags). Paragraphs
+   containing tags is effectively skipped by the Aucor Oy filter.
+ * The Aucor Oy filter rightly does not hyphenate the final word of a paragraph.
+   However, all instances of that word in the paragraph will not be hyphenated.
+   This filter does not special case the final word in the paragraph: all words
+   are subject to the hyphenation rules.
+
+[Jekyll::HyphenateFilter]: https://github.com/aucor/jekyll-plugins/blob/1bbc2aeacc24c816a0f1cad74c71f3ccd4eb307b/hyphenate.rb
+[aucor-jekyll-plugins]: https://github.com/aucor/jekyll-plugins
+
+## Copyright
+
+Copyright 2016 Michael Glaesemann. Released under the MIT License (see LICENSE
+for details).

data/jekyll-hyphenate_filter.gemspec

@@ -0,0 +1,36 @@
+lib = File.expand_path("../lib/", __FILE__)
+$LOAD_PATH.unshift lib unless $LOAD_PATH.include?(lib)
+require "rake"
+require "jekyll/hyphenate_filter/version"
+
+Gem::Specification.new do |spec|
+  spec.name = "jekyll-hyphenate_filter"
+  spec.version = Jekyll::HyphenateFilter::VERSION
+  spec.licenses = ["MIT"]
+  spec.summary = "jekyll-hyphenate_filter"
+  spec.date = "2016-05-01"
+  spec.description = "Jekyll Hyphenation Filter"
+  spec.authors = ["Michael Glaesemann"]
+  spec.email = ["grzm@seespotcode.net"]
+  spec.files = FileList["{lib,test}/**/*.*",
+                        "jekyll-hyphenate_filter.gemspec",
+                        "rakefile",
+                        "LICENSE",
+                        "README.markdown",
+                        "CHANGELOG.markdown",
+                        "Gemfile",
+                        "Gemfile.lock"].to_a
+  spec.require_path = %(lib)
+  spec.test_files = FileList["test/**/*.*"].to_a
+  spec.extra_rdoc_files = ["LICENSE", "README.markdown"]
+  spec.homepage = "http://rubygems.org/gems/jekyll-hyphenate_filter"
+  [["text-hyphen", ["~> 1.4"]],
+   ["nokogiri", ["~> 1.6"]]].each do |dep|
+    spec.add_runtime_dependency(*dep)
+  end
+
+  [["test-unit", ["~> 3.0"]]].each do |dep|
+    spec.add_development_dependency(*dep)
+  end
+
+end

data/lib/jekyll/hyphenate_filter/hyphenator.rb

@@ -0,0 +1,47 @@
+# coding: utf-8
+require "nokogiri"
+require "text/hyphen"
+
+module Jekyll
+  module HyphenateFilter
+    class Hyphenator
+
+      SOFT_HYPHEN_CHAR = '­'
+      SOFT_HYPHEN_ENTITY = '­'
+
+      def initialize(opts = {})
+        language = opts[:language] || "en_us"
+        left = opts[:left] || 2
+        right = opts[:right] || 2
+        @hyphenator = Text::Hyphen.new(language: language,
+                                       left: left,
+                                       right: right)
+        @hyphen = opts[:hyphen] || SOFT_HYPHEN_CHAR
+        @selector = opts[:selector] || 'p'
+      end
+
+      def hyphenate(content)
+        fragment = Nokogiri::HTML::DocumentFragment.parse(content)
+
+        fragment.css(@selector).each do |el|
+          el.traverse do |node|
+            node.content = hyphenate_text(node.to_s) if node.text?
+          end
+        end
+
+        fragment.to_s
+      end
+
+      def hyphenate_text(text)
+        words = text.split
+        words.each do |word|
+          regex = /#{Regexp.escape(word)}(?!\z)/
+          hyphenated_word = @hyphenator.visualize(word, @hyphen)
+          text.gsub!(regex, hyphenated_word)
+        end
+        text
+      end
+      
+    end
+  end
+end

data/lib/jekyll/hyphenate_filter/version.rb

@@ -0,0 +1,5 @@
+module Jekyll
+  module HyphenateFilter
+    VERSION = "0.0.1"
+  end
+end

data/lib/jekyll/hyphenate_filter.rb

@@ -0,0 +1,22 @@
+require_relative "hyphenate_filter/hyphenator"
+
+module Jekyll
+  module HyphenateFilter
+    def hyphenate(content)
+      config = @context.registers[:site].config['hyphenate_filter'] || {}
+      config = {'language' => 'en_us',
+                'left' => 2,
+                'right' => 2,
+                'hyphen' => Hyphenator::SOFT_HYPHEN_CHAR,
+                'selector' => 'p'}.merge!(config)
+      hyphenator = Hyphenator.new(language: config['language'],
+                                  left: config['left'],
+                                  right: config['right'],
+                                  hyphen: config['hyphen'],
+                                  selector: config['selector'])
+      hyphenator.hyphenate(content)
+    end
+  end
+end
+
+Liquid::Template.register_filter(Jekyll::HyphenateFilter)

data/rakefile

@@ -0,0 +1,8 @@
+require 'rake/testtask'
+
+Rake::TestTask.new do |t|
+  t.libs << 'test'
+  t.verbose = true
+end
+
+task :default => :test

data/test/test_hyphenate.rb

@@ -0,0 +1,75 @@
+# coding: utf-8
+require "rubygems"
+require "bundler/setup"
+require_relative "../lib/jekyll/hyphenate_filter/hyphenator"
+require "test/unit"
+
+class TestHyphenate < Test::Unit::TestCase
+
+  def test_no_sub_elements
+    content = <<-EOS
+    <p>The nested set however, has performance limitations on insert, update, and
+delete. This arises because the nested set model encodes the hierarchy based on
+what the set contains: when a node is inserted or deleted, all of the sets
+containing the node must be updated as well. In other words, the encoding
+depends on the current state of the database. This behavior makes the nested set
+model less desirable for large, dynamic hierarchies. There are limitations</p>
+    EOS
+    expected = <<-EOS
+    <p>The nested set how­ev­er, has per­for­mance lim­i­ta­tions on insert, update, and
+delete. This arises because the nested set model encodes the hier­ar­chy based on
+what the set con­tains: when a node is inserted or delet­ed, all of the sets
+con­tain­ing the node must be updated as well. In other words, the encod­ing
+depends on the cur­rent state of the data­base. This behav­ior makes the nested set
+model less desir­able for large, dynamic hier­ar­chies. There are limitations</p>
+EOS
+    hyphenated = Jekyll::HyphenateFilter::Hyphenator.new.hyphenate(content)
+    assert_equal(expected, hyphenated)
+  end
+
+  def test_with_tag
+    content = <<-EOS
+<p>The <a href="https://example.com/path/to/article?id=100" title="article name">nested set model</a>
+is a convenient way to represent hierarchies in SQL. By
+taking advantage of the set nature of relations, it provides quick and
+relatively simple queries to determine, for example, all descendants of a given
+node. Such queries are more computationally difficult using adjacency lists.</p>
+    EOS
+    expected = <<-EOS
+<p>The <a href="https://example.com/path/to/article?id=100" title="article name">nested set model</a>
+is a con­ve­nient way to rep­re­sent hier­ar­chies in SQL. By
+tak­ing advan­tage of the set nature of rela­tions, it pro­vides quick and
+rel­a­tively sim­ple queries to deter­mine, for exam­ple, all descen­dants of a given
+node. Such queries are more com­pu­ta­tion­ally dif­fi­cult using adja­cency lists.</p>
+    EOS
+    hyphenated = Jekyll::HyphenateFilter::Hyphenator.new.hyphenate(content)
+
+    assert_equal(expected, hyphenated)
+  end
+
+  def test_nested
+    content = <<-EOS
+<ul>
+  <li>
+    <p>Vadim Tropashko, <cite><a href="https://example.com/path/to/article?id=100" title="Tropashko on nested intervals">Trees in SQL: Nested Sets and Materialized Path</a></cite></p>
+  </li>
+  <li>
+    <p>Vadim Tropashko, <cite><a href="https://example.com/path/to/article?id=200" title="Tropashko on relocating subtrees of nested intervals">Relocating Subtrees in Nested Intervals Model</a></cite></p>
+  </li>
+</ul>
+EOS
+    expected = <<-EOS
+<ul>
+  <li>
+    <p>Vadim Tropashko, <cite><a href="https://example.com/path/to/article?id=100" title="Tropashko on nested intervals">Trees in SQL: Nested Sets and Mate­ri­al­ized Path</a></cite></p>
+  </li>
+  <li>
+    <p>Vadim Tropashko, <cite><a href="https://example.com/path/to/article?id=200" title="Tropashko on relocating subtrees of nested intervals">Relo­cat­ing Sub­trees in Nested Inter­vals Model</a></cite></p>
+  </li>
+</ul>
+EOS
+    hyphenated = Jekyll::HyphenateFilter::Hyphenator.new(selector: "p").hyphenate(content)
+    assert_equal(expected, hyphenated)
+  end
+  
+end

metadata

@@ -0,0 +1,100 @@
+--- !ruby/object:Gem::Specification
+name: jekyll-hyphenate_filter
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Michael Glaesemann
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-05-01 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: text-hyphen
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.4'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.4'
+- !ruby/object:Gem::Dependency
+  name: nokogiri
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !ruby/object:Gem::Dependency
+  name: test-unit
+  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'
+description: Jekyll Hyphenation Filter
+email:
+- grzm@seespotcode.net
+executables: []
+extensions: []
+extra_rdoc_files:
+- LICENSE
+- README.markdown
+files:
+- CHANGELOG.markdown
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- README.markdown
+- jekyll-hyphenate_filter.gemspec
+- lib/jekyll/hyphenate_filter.rb
+- lib/jekyll/hyphenate_filter/hyphenator.rb
+- lib/jekyll/hyphenate_filter/version.rb
+- rakefile
+- test/test_hyphenate.rb
+homepage: http://rubygems.org/gems/jekyll-hyphenate_filter
+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.4.5
+signing_key: 
+specification_version: 4
+summary: jekyll-hyphenate_filter
+test_files:
+- test/test_hyphenate.rb