jekyll-titles-from-content 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: ff8a481d7cdb1d7b6f9aa7dc89237c2161ff4a961a7223660306397c1805c5e0
+  data.tar.gz: 1643e62e6242c0732b70df2fd0318b18bf0ec5a0e26a14cc6289db4ae4846c15
+SHA512:
+  metadata.gz: 88dbff3cc44e0b615698eb92d688a7fbd3fea8da2de8fac572c14dd3bf1f047da3ed333953e518a0712951987bd710b31ca98894117c70ac3082f3aff3092954
+  data.tar.gz: b715015864a05e78f124b67fefb412658a6e1060a82b8de2c4f176902abdc88e772eb8d923f625fabc8772bb9aa97636f1a9d784dc50eb64a1be7482192ca0e1

data/LICENSE.md

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2020 Colin Seymour
+
+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,56 @@
+# Jekyll Titles from Content
+
+[![Actions Status](https://github.com/lildude/jekyll-titles-from-content/workflows/Testing/badge.svg)](https://github.com/lildude/jekyll-titles-from-content/actions)
+
+A Jekyll plugin to pull the page title from the first few words of the first line of the content if a title isn't set.
+
+## What it does
+
+If you have a Jekyll page that doesn't have a title specified in the YAML Front Matter, this plugin instructs Jekyll to use that first few words of the content as the page's title.
+
+## Why
+
+Because lots of plugins and templates rely on `page.title`. This doesn't play nicely with micro blogging which doesn't require a title.
+
+## Usage
+
+1. Add the following to your site's Gemfile:
+
+  ```ruby
+  gem 'jekyll-titles-from-content'
+  ```
+
+2. Add the following to your site's config file:
+
+  ```yml
+  plugins:
+    - jekyll-titles-from-content
+  ```
+
+  Note: If you are using a Jekyll version less than 3.5.0, use the `gems` key instead of `plugins`.
+
+## Configuration
+
+Configuration options are optional and placed in `_config.yml` under the `titles_from_content` key. They default to:
+
+```yml
+titles_from_content:
+  enabled:     true    # Easily toggle the plugin from your configuration.
+  words:       5       # The number of words to use for the title.
+  collections: true    # Apply the plugin to collections. Posts are collections.
+  dotdotdot:   ...     # The character(s) you'd like to append to truncated titles.
+```
+
+### Processing Collections
+
+If you want to enable this plugin for collection items, set the `collections` option to `true`.
+
+Since collection items (including posts) already have a title inferred from their filename, this option changes the behavior of this plugin to override the inferred title.
+
+### Disabling
+
+Even if the plugin is enabled (e.g., via the `:jekyll_plugins` group in your Gemfile) you can disable it by setting the `enabled` key to `false`.
+
+### Credit
+
+This plugin is heavily inspired by the [jekyll-titles-from-headings](https://github.com/benbalter/jekyll-titles-from-headings) plugin.

data/lib/jekyll-titles-from-content.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+require "jekyll"
+require "jekyll-titles-from-content/generator"
+
+module JekyllTitlesFromContent
+  autoload :Context, "jekyll-titles-from-content/context"
+  autoload :Filters, "jekyll-titles-from-content/filters"
+end

data/lib/jekyll-titles-from-content/context.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module JekyllTitlesFromContent
+  class Context
+    attr_reader :site
+
+    def initialize(site)
+      @site = site
+    end
+
+    def registers
+      { :site => site }
+    end
+  end
+end

data/lib/jekyll-titles-from-content/filters.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module JekyllTitlesFromContent
+  class Filters
+    include Jekyll::Filters
+    include Liquid::StandardFilters
+
+    def initialize(site)
+      @site    = site
+      @context = JekyllTitlesFromContent::Context.new(site)
+    end
+  end
+end

data/lib/jekyll-titles-from-content/generator.rb

@@ -0,0 +1,141 @@
+# frozen_string_literal: true
+
+module JekyllTitlesFromContent
+  class Generator < Jekyll::Generator
+    attr_accessor :site
+
+    CONVERTER_CLASS = Jekyll::Converters::Markdown
+    STRIP_MARKUP_FILTERS = [:markdownify, :strip_html, :normalize_whitespace].freeze
+
+    # Regex to strip extra markup still present after markdownify
+    # (footnotes at the moment).
+    EXTRA_MARKUP_REGEX = %r!\[\^[^\]]*\]!.freeze
+
+    CONFIG_KEY = "titles_from_content"
+    ENABLED_KEY = "enabled"
+    WORDS_KEY = "words"
+    COLLECTIONS_KEY = "collections"
+    DOTDOTDOT_KEY = "dotdotdot"
+
+    safe true
+    priority :lowest
+
+    def initialize(site)
+      @site = site
+    end
+
+    def generate(site)
+      @site = site
+      return if disabled?
+
+      documents = site.pages
+      documents = site.pages + site.docs_to_write if collections?
+
+      documents.each do |document|
+        next unless should_add_title?(document)
+        next if document.is_a?(Jekyll::StaticFile)
+
+        document.data["title"] = title_for(document)
+      end
+    end
+
+    def should_add_title?(document)
+      markdown?(document) && !title?(document)
+    end
+
+    def title?(document)
+      !inferred_title?(document) && !document.data["title"].nil?
+    end
+
+    def markdown?(document)
+      markdown_converter.matches(document.extname)
+    end
+
+    def markdown_converter
+      @markdown_converter ||= site.find_converter_instance(CONVERTER_CLASS)
+    end
+
+    def truncate(string, count, cont = "")
+      spl = string.split
+      tr = spl.first(count).join(" ")
+      tr += cont if spl.length > count
+      tr
+    end
+
+    def title_for(document)
+      return document.data["title"] if title?(document)
+
+      first_line = document.content.split("\n").find { |l| l unless strip_markup(l).empty? }
+      return truncate(strip_markup(first_line), count, dotdotdot) unless first_line.nil?
+
+      document.data["title"] # If we can't produce a title, we use the inferred one.
+    rescue ArgumentError => e
+      raise e unless e.to_s.start_with?("invalid byte sequence in UTF-8")
+    end
+
+    private
+
+    def strip_markup(string)
+      STRIP_MARKUP_FILTERS.reduce(string) do |memo, method|
+        filters.public_send(method, memo)
+      end.gsub(EXTRA_MARKUP_REGEX, "")
+    end
+
+    def option(key)
+      site.config[CONFIG_KEY] && site.config[CONFIG_KEY][key]
+    end
+
+    def disabled?
+      option(ENABLED_KEY) == false
+    end
+
+    def collections?
+      option(COLLECTIONS_KEY) == true
+    end
+
+    def dotdotdot
+      option(DOTDOTDOT_KEY) || ""
+    end
+
+    def count
+      option(WORDS_KEY) || 5
+    end
+
+    # Documents (posts and collection items) have their title inferred from the filename.
+    #
+    # This is a terribly slow hack as we're reading the YAML for every document, but I can't find
+    # a better way of doing this as I can't find a method of obtaining the original unprocessed
+    # frontmatter.
+    def inferred_title?(document)
+      return false unless document.is_a?(Jekyll::Document)
+
+      meta = read_yaml(File.dirname(document.path), File.basename(document.path))
+      !meta.key?("title")
+    end
+
+    def filters
+      @filters ||= JekyllTitlesFromContent::Filters.new(site)
+    end
+
+    # This is a slightly modified version of Jekyll::Convertible.read_yaml
+    def read_yaml(base, name)
+      filename = File.join(base, name)
+
+      begin
+        content = File.read(filename)
+        if content =~ Jekyll::Document::YAML_FRONT_MATTER_REGEXP
+          content = $POSTMATCH # rubocop:disable Lint/UselessAssignment
+          data = SafeYAML.load(Regexp.last_match(1))
+        end
+      rescue SyntaxError => e
+        Jekyll.logger.warn "YAML Exception reading #{filename}: #{e.message}"
+        raise e if site.config["strict_front_matter"]
+      rescue StandardError => e
+        Jekyll.logger.warn "Error reading file #{filename}: #{e.message}"
+        raise e if site.config["strict_front_matter"]
+      end
+
+      data || {}
+    end
+  end
+end

data/lib/jekyll-titles-from-content/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module JekyllTitlesFromContent
+  VERSION = "0.0.1"
+end

metadata

@@ -0,0 +1,197 @@
+--- !ruby/object:Gem::Specification
+name: jekyll-titles-from-content
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Colin Seymour
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2020-10-08 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'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.3'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: guard
+  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: guard-minitest
+  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: kramdown-parser-gfm
+  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: minitest
+  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: minitest-color
+  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: 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: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.71'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.71'
+- !ruby/object:Gem::Dependency
+  name: rubocop-jekyll
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.10'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.19'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.19'
+description:
+email:
+- colin@symr.io
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE.md
+- README.md
+- lib/jekyll-titles-from-content.rb
+- lib/jekyll-titles-from-content/context.rb
+- lib/jekyll-titles-from-content/filters.rb
+- lib/jekyll-titles-from-content/generator.rb
+- lib/jekyll-titles-from-content/version.rb
+homepage: https://github.com/lildude/jekyll-titles-from-content
+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: []
+rubygems_version: 3.0.3
+signing_key:
+specification_version: 4
+summary: A Jekyll plugin to pull the page title from the first X words of the content,
+  when none is specified.
+test_files: []