jekyll-clean-descriptions 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 372f2c803ddc552a23f4f765fb3ef577b3150843e98a9df5be8d11a59ccfb742
+  data.tar.gz: cdcf79364f800744a20c7185c101780f9f4b48533145638df3af3b1d80e75bfb
+SHA512:
+  metadata.gz: 1cbc1d2e2241d1a037c0ed4b339686aa11aaae539ebe0580c15cf0865cbed3ca26f55a5cb837d395eeb32bccfe75ace097e97fc6ae4a2117a92b5e568160f513
+  data.tar.gz: 9e68985d1a9ab5cc895a164adc3da84f54a73cd0a80037ae2a3a181a0513dad15f2420788e25d24b517aebb21966dde80e63bdaf4dde2a56c9cb6b229337d5e0

data/.gitignore

@@ -0,0 +1,10 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+jekyll-clean-descriptions*.gem

data/.travis.yml

@@ -0,0 +1,7 @@
+---
+sudo: false
+language: ruby
+cache: bundler
+rvm:
+  - 2.5.3
+before_install: gem install bundler -v 2.0.1

data/Gemfile

@@ -0,0 +1,4 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in jekyll-clean-descriptions.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2019 dusty candland
+
+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,49 @@
+# Jekyll::Clean::Descriptions
+
+Use this to automatically create shorter descriptions based on the excerpt value.
+It will clean HTML, remove new lines, and truncate to 160 characters.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+group :jekyll_plugins do
+  gem 'jekyll-clean-descriptions'
+end
+```
+
+Add to your `_config.yml` file:
+
+```yml
+plugins:
+  gem 'jekyll-clean-descriptions'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install jekyll-clean-descriptions
+
+## Usage
+
+Currently none. Uses Jekyll Hooks to automatically shorten post excerpts and set
+a description variable for [jekyll-seo-tag]() and anything else that looks for
+`page.description` to be set.
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` 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/candland/jekyll-clean-descriptions.
+
+## 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,10 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList["test/**/*_test.rb"]
+end
+
+task :default => :test

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "jekyll/clean/descriptions"
+
+# 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-clean-descriptions.gemspec

@@ -0,0 +1,42 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "jekyll/clean/descriptions/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "jekyll-clean-descriptions"
+  spec.version       = Jekyll::Clean::Descriptions::VERSION
+  spec.authors       = ["dusty candland"]
+  spec.email         = ["candland@gmail.com"]
+
+  spec.summary       = %q{Clean and shorten Jekyll descriptions.}
+  spec.homepage      = "https://github.com/candland/jekyll-clean-descriptions"
+  spec.license       = "MIT"
+
+  # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
+  # to allow pushing to a single host or delete this section to allow pushing to any host.
+  if spec.respond_to?(:metadata)
+    spec.metadata["allowed_push_host"] = "https://rubygems.org"
+
+    spec.metadata["homepage_uri"] = spec.homepage
+    spec.metadata["source_code_uri"] = "https://github.com/candland/jekyll-clean-descriptions"
+    spec.metadata["changelog_uri"] = "https://github.com/candland/jekyll-clean-descriptions/CHANGELOG.md"
+  else
+    raise "RubyGems 2.0 or newer is required to protect against " \
+      "public gem pushes."
+  end
+
+  # 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_dependency "jekyll", "~> 3.3"
+  spec.add_development_dependency "bundler", "~> 2.0"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "minitest", "~> 5.0"
+end

data/lib/jekyll/clean/descriptions.rb

@@ -0,0 +1,15 @@
+require "jekyll/clean/descriptions/version"
+require_relative "./descriptions/cleaner.rb"
+
+module Jekyll
+  module Clean
+    module Descriptions
+      class Error < StandardError; end
+      # Your code goes here...
+    end
+  end
+end
+
+Jekyll::Hooks.register :posts, :pre_render do |container, payload|
+  Jekyll::Clean::Descriptions::Cleaner.new.call(container)
+end

data/lib/jekyll/clean/descriptions/cleaner.rb

@@ -0,0 +1,46 @@
+module Jekyll
+  module Clean
+    module Descriptions
+      class Cleaner
+        FORMAT_STRING_METHODS = [
+          :strip_html, :strip_newlines, :normalize_whitespace, :escape_once,
+        ].freeze
+
+        def filters
+          @filters ||= Filters.new(Liquid::Context.new)
+        end
+
+        def initialize
+        end
+
+        def call page
+          if !page.data['description']
+            if page.data['excerpt']
+              description = cleanup(page.data['excerpt'])
+              if description and !description.empty?
+                page.data['description'] = description
+              end
+            end
+          end
+          page
+        end
+
+        def cleanup description
+          description = FORMAT_STRING_METHODS.reduce(description) do |memo, method|
+            filters.public_send(method, memo)
+          end
+          filters.truncate(description, 160)
+        end
+
+        class Filters
+          include Jekyll::Filters
+          include Liquid::StandardFilters
+
+          def initialize(context)
+            @context = context
+          end
+        end
+      end
+    end
+  end
+end

data/lib/jekyll/clean/descriptions/version.rb

@@ -0,0 +1,7 @@
+module Jekyll
+  module Clean
+    module Descriptions
+      VERSION = "0.1.0"
+    end
+  end
+end

metadata

@@ -0,0 +1,117 @@
+--- !ruby/object:Gem::Specification
+name: jekyll-clean-descriptions
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- dusty candland
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2019-02-27 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: jekyll
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.3'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+description: 
+email:
+- candland@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- CHANGELOG.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- jekyll-clean-descriptions.gemspec
+- lib/jekyll/clean/descriptions.rb
+- lib/jekyll/clean/descriptions/cleaner.rb
+- lib/jekyll/clean/descriptions/version.rb
+homepage: https://github.com/candland/jekyll-clean-descriptions
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+  homepage_uri: https://github.com/candland/jekyll-clean-descriptions
+  source_code_uri: https://github.com/candland/jekyll-clean-descriptions
+  changelog_uri: https://github.com/candland/jekyll-clean-descriptions/CHANGELOG.md
+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.7.6
+signing_key: 
+specification_version: 4
+summary: Clean and shorten Jekyll descriptions.
+test_files: []