html_aware_truncation 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 81d7b744f16d55b31ecb503a6d98fe9b1575751a
+  data.tar.gz: 783c9c22e310d260e8e357fc1b08517b6cf983ba
+SHA512:
+  metadata.gz: a78a2d9a01ccf0fd98a6cd449292231d16eebef9e4aab4c3bf956a40dd93a033a942ce372914f960031d9bcf27ce27998a56d8ab0fb9039d41a03048999e791f
+  data.tar.gz: 9abc87ca6410bb25d55c84d4d67b8b1dc201df3091807d5890f8eab70aa77026bd3f718e0f4a01a3adbe8e21e2694cf84f33cbcd55b0c4d36a90d7451d8fcaf9

data/.gitignore

@@ -0,0 +1,12 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+.byebug_history
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.3.3
+before_install: gem install bundler -v 1.14.5

data/Gemfile

@@ -0,0 +1,6 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in html_aware_truncation.gemspec
+gemspec
+
+gem "byebug", group: [:development, :test]

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 Jonathan Rochkind
+
+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,89 @@
+# HtmlAwareTruncation
+[![Gem Version](https://badge.fury.io/rb/html_aware_truncation.svg)](https://badge.fury.io/rb/html_aware_truncation)
+[![Build Status](https://travis-ci.org/jrochkind/html_aware_truncation.svg?branch=master)](https://travis-ci.org/jrochkind/html_aware_truncation)
+
+
+Yet another ruby html-aware truncation routine. Truncate HTML to max text characters,
+resulting in still legal HTML without any unclosed tags etc.
+
+I was unable to find an existing solution that met my needs:
+* Uses [nokogiri](https://github.com/sparklemotion/nokogiri) (cause it's really good at handling somewhat invalid HTML input, and you probably already have it as a dependency)
+* Does not monkey-patch nokogiri or String or anything else.
+* Follows Rails [truncate helper](http://api.rubyonrails.org/classes/ActionView/Helpers/TextHelper.html#method-i-truncate)
+  semantics, including a custom :separator that can be a string or regex, usually for word boundaries.
+
+
+## Usage
+
+```ruby
+require 'html_aware_truncation'
+string = "<p>Lots of html <b>with bolded stuff</b></p>"
+HtmlAwareTruncation.truncate_html(string, length: 10)
+# => "<p>Lots of h…</p>"
+HtmlAwareTruncation.truncate_html(string, length: 10, separator: /\b/)
+# => "<p>Lots of …</p>"
+HtmlAwareTruncation.truncate_html(string, length: 10, separator: /\b/, omission: '--')
+# => "<p>Lots of --</p>"
+```
+
+If you already have a Nokogiri node, or want to do the Nokogiri
+parsing and serialization yourself, you can pass a single Nokogiri node
+to `truncate_nokogiri_node`. Often a `Nokogiri::HTML::DocumentFragment` makes sense:
+
+```ruby
+node = Nokogiri::HTML::DocumentFragment.parse(some_html_str)
+HtmlAwareTruncation.truncate_nokogiri_node(some_html_str, length: 10)
+# => Returns a Nokogiri node, may mutate original passed in, not entirely sure.
+```
+
+For convenience, you can `include` the `HtmlAwareTruncation` module, to
+get it's methods as mixins.
+
+```ruby
+require 'html_aware_truncation'
+class Something
+  include HtmlAwareTruncation
+
+  def something
+    truncate_html(whatever)
+  end
+end
+```
+
+## Known problems
+
+This isn't perfect, but it's good enough for me to use in several production
+apps. In edge cases, it may sometimes:
+
+* May in some cases be an extra character (or a few) above the specified `length` limit (off by one error maybe?)
+* put the omission mark in a node of it's own, which is kind of silly: `"<p>Stuff <b>…</b></p>"`
+* leave one or more empty nodes at the end: `"<p>Stuff and...<b></b></p>"`
+* Put the omission mark in a tag/node that really ought not to have text content: `"<ul><li>stuff</li>…</ul>"
+  (This one bothers me the most, it's the only case I know this gem produces slightly illegal HTML, but generally happens rarely)
+
+Some specs marked `pending` demonstrate some "bad behavior", but there may be others un-tested.
+
+In general though, this has not caused me real problems in production, it works out.
+I still find this preferable to other alternative gems I know about, so I packaged it up in
+case you do too. Patches welcome.
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/jrochkind/html_aware_truncation.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+
+## Alternatives
+
+I adapted some code or tests from some of these. I mostly adapted from
+an example in [a blog post now only in the wayback machine](https://web-beta.archive.org/web/20160116165808/http://blog.madebydna.com/all/code/2010/06/04/ruby-helper-to-cleanly-truncate-html.html).
+Alternative examples can also be useful to look at to see how/if they solve the known problems with this gem, for ideas.
+
+* https://github.com/nono/HTML-Truncator
+* https://github.com/hgmnz/truncate_html
+* https://github.com/ianwhite/truncate_html
+
+

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "html_aware_truncation"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/html_aware_truncation.gemspec

@@ -0,0 +1,28 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'html_aware_truncation/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "html_aware_truncation"
+  spec.version       = HtmlAwareTruncation::VERSION
+  spec.authors       = ["Jonathan Rochkind"]
+  spec.email         = ["jrochkind@chemheritage.org"]
+
+  spec.summary       = %q{Yet another ruby html-aware truncation routine}
+  #spec.homepage      = "TODO: Put your gem's website or public repo URL here."
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  # spec.bindir        = "exe"
+  # spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_runtime_dependency "nokogiri", "~> 1.0"
+
+  spec.add_development_dependency "bundler", "~> 1.14"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec", "~> 3.0"
+end

data/lib/html_aware_truncation.rb

@@ -0,0 +1,72 @@
+require "html_aware_truncation/version"
+require 'nokogiri'
+
+module HtmlAwareTruncation
+  define_singleton_method(:default_length) { @default_length }
+  define_singleton_method(:default_length=) { |val| @default_length = val }
+  self.default_length = 200
+  define_singleton_method(:default_omission) { @default_omission }
+  define_singleton_method(:default_omission=) { |val| @default_omission = val }
+  self.default_omission = '…'
+
+  def truncate_html(str,
+                    length: HtmlAwareTruncation.default_length,
+                    omission: HtmlAwareTruncation.default_omission,
+                    separator: nil)
+
+    HtmlAwareTruncation.truncate_nokogiri_node(
+      Nokogiri::HTML::DocumentFragment.parse(str),
+      length: length,
+      omission: omission,
+      separator: separator
+    ).to_html
+  end
+  module_function :truncate_html
+
+  # HTML-aware truncation of a `Nokogiri::HTML::DocumentFragment`, perhaps
+  # one you created with `Nokogiri::HTML::DocumentFragment.parse(str)`
+  # Returns a TODO. (may mutate input?)
+  #
+  # See also truncate_string, which will take and return a string, parsing
+  # for you for convenience.
+  def truncate_nokogiri_node(node,
+                                 length: HtmlAwareTruncation.default_length,
+                                 omission: HtmlAwareTruncation.default_omission,
+                                 separator: nil)
+    if node.kind_of?(::Nokogiri::XML::Text)
+      if node.content.length > length
+        allowable_endpoint = [0, length - omission.length].max
+        if separator
+          allowable_endpoint = (node.content.rindex(separator, allowable_endpoint) || allowable_endpoint)
+        end
+
+        ::Nokogiri::XML::Text.new(node.content.slice(0, allowable_endpoint) + omission, node.parent)
+      else
+        node.dup
+      end
+    else # DocumentFragment or Element
+      return node if node.inner_text.length <= length
+
+      truncated_node = node.dup
+      truncated_node.children.remove
+      remaining_length = length
+
+      node.children.each do |child|
+        if remaining_length == 0
+          truncated_node.add_child ::Nokogiri::XML::Text.new(omission, truncated_node)
+          break
+        elsif remaining_length < 0
+          break
+        end
+        truncated_node.add_child HtmlAwareTruncation.truncate_nokogiri_node(child, length: remaining_length, omission: omission, separator: separator)
+        # can end up less than 0 if the child was truncated to fit, that's
+        # fine:
+        remaining_length = remaining_length - child.inner_text.length
+
+      end
+      truncated_node
+    end
+  end
+  module_function :truncate_nokogiri_node
+
+end

data/lib/html_aware_truncation/version.rb

@@ -0,0 +1,3 @@
+module HtmlAwareTruncation
+  VERSION = "1.0.0"
+end

metadata

@@ -0,0 +1,112 @@
+--- !ruby/object:Gem::Specification
+name: html_aware_truncation
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Jonathan Rochkind
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-03-28 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: nokogiri
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.14'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.14'
+- !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: rspec
+  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: 
+email:
+- jrochkind@chemheritage.org
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- html_aware_truncation.gemspec
+- lib/html_aware_truncation.rb
+- lib/html_aware_truncation/version.rb
+homepage: 
+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.5.2
+signing_key: 
+specification_version: 4
+summary: Yet another ruby html-aware truncation routine
+test_files: []