jekyll_html_truncatewords 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 19cd98177b7ba8c36be921e7316be12b92a5871a6ba8e244408a6b3f592a2b06
+  data.tar.gz: beead4981228ceb21022eb8cb6957f466c346c88a7819860e63acf2f6f24418d
+SHA512:
+  metadata.gz: 955a40e67d833d6ba70e4657a646613171f5ffb3f4994a70d87b1af643d5f0f2e8edb2bf44536cc1a4fb7654a4900a4db4e5ec13065b53c59c0debfd3764a9ef
+  data.tar.gz: 8e5e9c3d10e9a966ebd958cea1af3b9bf9df314032acb817667c832611de6409fe8395b9466f3f6e7ac196443c1d07391de915043fbc2836e569e92f6a8c19cb

data/.github/workflows/test.yml

@@ -0,0 +1,28 @@
+name: Ruby
+
+on:
+  push:
+    branches: [ master ]
+  pull_request:
+    branches: [ master ]
+
+jobs:
+  test:
+
+    runs-on: ubuntu-latest
+
+    strategy:
+      matrix:
+        ruby-version: [2.4, 2.5, 2.6, 2.7]
+
+    steps:
+    - uses: actions/checkout@v2
+    - name: Set up Ruby
+      uses: ruby/setup-ruby@v1
+      with:
+        bundler-cache: true
+        ruby-version: ${{ matrix.ruby-version }}
+    - name: Install dependencies
+      run: bundle install
+    - name: Run tests
+      run: bundle exec rake

data/.gitignore

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

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.travis.yml

@@ -0,0 +1,6 @@
+---
+language: ruby
+cache: bundler
+rvm:
+  - 2.7.1
+before_install: gem install bundler -v 2.1.4

data/Gemfile

@@ -0,0 +1,7 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in jekyll_html_truncatewords.gemspec
+gemspec
+
+gem "rake", "~> 12.0"
+gem "rspec", "~> 3.0"

data/Gemfile.lock

@@ -0,0 +1,43 @@
+PATH
+  remote: .
+  specs:
+    jekyll_html_truncatewords (0.1.0)
+      liquid
+      liquid-c
+      nokogiri
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    diff-lcs (1.4.4)
+    liquid (4.0.3)
+    liquid-c (4.0.0)
+      liquid (>= 3.0.0)
+    mini_portile2 (2.4.0)
+    nokogiri (1.10.10)
+      mini_portile2 (~> 2.4.0)
+    rake (12.3.3)
+    rspec (3.10.0)
+      rspec-core (~> 3.10.0)
+      rspec-expectations (~> 3.10.0)
+      rspec-mocks (~> 3.10.0)
+    rspec-core (3.10.0)
+      rspec-support (~> 3.10.0)
+    rspec-expectations (3.10.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.10.0)
+    rspec-mocks (3.10.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.10.0)
+    rspec-support (3.10.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  jekyll_html_truncatewords!
+  rake (~> 12.0)
+  rspec (~> 3.0)
+
+BUNDLED WITH
+   2.1.4

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2020 Mike Kasberg
+
+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,42 @@
+# JekyllHtmlTruncatewords
+
+**WIP:** This gem is not ready for production use yet.`
+
+Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/jekyll/html/truncatewords`. To experiment with that code, run `bin/console` for an interactive prompt.
+
+TODO: Delete this and the text above, and describe your gem
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'jekyll_html_truncatewords'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install jekyll_html_truncatewords
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+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`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/jekyll_html_truncatewords.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

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 "jekyll/html/truncatewords"
+
+# 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/jekyll_html_truncatewords.gemspec

@@ -0,0 +1,31 @@
+require_relative 'lib/jekyll_html_truncatewords/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "jekyll_html_truncatewords"
+  spec.version       = JekyllHtmlTruncatewords::VERSION
+  spec.authors       = ["Mike Kasberg"]
+  spec.email         = ["mike@mikekasberg.com"]
+
+  spec.summary       = %q{A Jekyll filter to truncate HTML}
+  spec.description   = %q{The Liquid truncatewords filter can't operate on HTML because it isn't aware of tags. But Jekyll blog posts usually contain HTML, so this makes it difficult to, for example, use the first 50 words of a blog post as the preview. jekyll_html_truncatewords solves that problem. It works the same as truncatewords, but it is aware of HTML tags so it counts words correctly within HTML and won't break HTML.}
+  spec.homepage      = "https://github.com/mkasberg/jekyll_html_trunctewords"
+  spec.license       = "MIT"
+  spec.required_ruby_version = Gem::Requirement.new(">= 2.4.0")
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = "https://github.com/mkasberg/jekyll_html_trunctewords"
+  spec.metadata["changelog_uri"] = "https://www.mikekasberg.com" # TODO
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |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 'liquid'
+  spec.add_runtime_dependency 'liquid-c'
+  spec.add_runtime_dependency 'nokogiri'
+end

data/lib/jekyll_html_truncatewords.rb

@@ -0,0 +1,62 @@
+require 'jekyll_html_truncatewords/version'
+require 'liquid'
+require 'nokogiri'
+
+module JekyllHtmlTruncatewords
+  # Extending Liquid::StandardFilters allows us to call the Liquid version of truncatewords
+  # instead of re-creating our own.
+  extend Liquid::StandardFilters
+
+  extend self
+
+  # Truncate HTML input to have `words` words when rendered as HTML.
+  # Preserve HTML structure so tags are correctly matched.
+  def html_truncatewords(input, words = 15, truncate_string = "...")
+    words = words.to_i
+    fragment = Nokogiri::HTML.fragment(input)
+
+    if fragment.inner_text.split.length <= words
+      return input
+    end
+
+    truncate_node(fragment, words, truncate_string)
+
+    fragment.to_html
+  end
+
+  # A recursive function to truncate the node, if necessary.
+  # Return the words remaining after accounting for the current node.
+  private def truncate_node(node, words_remaining, truncate_string)
+    if node.text?
+      wordlist = node.text.to_s.split
+      if wordlist.length < words_remaining
+        return words_remaining - wordlist.length
+      elsif wordlist.length == words_remaining
+        node.content = node.content.rstrip + truncate_string
+        return 0
+      else
+        node.content = truncate_text(node.text, words_remaining, truncate_string)
+        return 0
+      end
+    else
+      node.children.each do |n|
+        if words_remaining > 0
+          words_remaining = truncate_node(n, words_remaining, truncate_string)
+        else
+          n.remove
+        end
+      end
+      
+      return words_remaining
+    end
+  end
+
+  private def truncate_text(input, words, truncate_string)
+    leading_spaces = input.match(/^[ ]+/)
+    lead = leading_spaces.nil? ? '' : leading_spaces[0]
+    
+    lead + truncatewords(input, words, truncate_string)
+  end
+end
+
+Liquid::Template.register_filter(JekyllHtmlTruncatewords)

data/lib/jekyll_html_truncatewords/version.rb

@@ -0,0 +1,3 @@
+module JekyllHtmlTruncatewords
+  VERSION = "0.1.0"
+end

metadata

@@ -0,0 +1,106 @@
+--- !ruby/object:Gem::Specification
+name: jekyll_html_truncatewords
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Mike Kasberg
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2020-12-12 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: liquid
+  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: liquid-c
+  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: nokogiri
+  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'
+description: The Liquid truncatewords filter can't operate on HTML because it isn't
+  aware of tags. But Jekyll blog posts usually contain HTML, so this makes it difficult
+  to, for example, use the first 50 words of a blog post as the preview. jekyll_html_truncatewords
+  solves that problem. It works the same as truncatewords, but it is aware of HTML
+  tags so it counts words correctly within HTML and won't break HTML.
+email:
+- mike@mikekasberg.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".github/workflows/test.yml"
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- jekyll_html_truncatewords.gemspec
+- lib/jekyll_html_truncatewords.rb
+- lib/jekyll_html_truncatewords/version.rb
+homepage: https://github.com/mkasberg/jekyll_html_trunctewords
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/mkasberg/jekyll_html_trunctewords
+  source_code_uri: https://github.com/mkasberg/jekyll_html_trunctewords
+  changelog_uri: https://www.mikekasberg.com
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.4.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.2
+signing_key: 
+specification_version: 4
+summary: A Jekyll filter to truncate HTML
+test_files: []