lifer 0.10.0 → 0.10.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f1d33c1f633f27b80005a2e2e7c1919f43d86a5fdba9f12523dd4dcdb4e47422
-  data.tar.gz: 37927e9a39b49363ee0de3f34294c4e8ccf82b83a7a73b8d86ebc1bae8243947
+  metadata.gz: ae7d44054aac227a4d75940cf8c6d30b46ba403780f5d8583d0db22dfd8cf36e
+  data.tar.gz: 7c8ac4e684afa95e23f22dc1b6ad0472391c3fc946a6b7bbbdf9acfbf46ac31d
 SHA512:
-  metadata.gz: db511f0ace1e617851b7e4de0fd12f9a615c283db318d3c05013cdadbae40ab89cd6be06bc429f4c443caf5d1c67f1d385276f4596788eadbfe3d22916e9c20d
-  data.tar.gz: 917d189530c40b4c15fb57a9d1bfce28a809b00fd07267b5a2485997adcb8c3e557dcf242def3a515297b908a5000902a1e7fcbe4bff29240791a88681b2fa1f
+  metadata.gz: 464566f240f05e2c5e199582555ccecd9bc6449ad477d53adb24905d76e07b9f93c13d050f69cd6c5923f9f9434edca1d14b4d01d674c5b4148bb5d9c85723df
+  data.tar.gz: 270f4d8c20bc24b180ae474a6d62037b2f2347a4d9e25f7a4af207d0e85d6df66fec0f92a82f57248e05ac34966ba69ff542a30c9e36d4f90e99fe41a46eeba6

data/CHANGELOG.md

@@ -1,9 +1,25 @@
 ## Next
 
+## v0.10.1
+
+This release resolves a bug with `Entry#summary`. When I originally implemented
+summaries as first paragraphs, I didn't realize that using the Kramdown
+representation of the document would result in special characters being
+transformed badly:
+
+    In the ldquorealmrdquo where dreams dance
+
+This change ensures that we don't end up with trash like that, or other HTML
+trash.
+
+The summary is meant to be ideal for things like `<meta>` description tags,
+which should only contain plain text.
+
+
 ## v0.10.0
 
-These commits collect work to let all layout files (either Liquid or ERB files)
-provide a reference to parent, or "root", layout files that should wrap the via
+This release lets all layout files (either Liquid or ERB files) provide a
+reference to parent, or "root", layout files that should wrap the via
 frontmatter.
 
 Previously, we did this for Liquid layouts using the custom `layout` tag. But

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    lifer (0.10.0)
+    lifer (0.10.1)
       i18n (< 2)
       kramdown (~> 2.4)
       liquid (~> 5.6, < 6)

data/README.md

@@ -107,6 +107,10 @@ Then, build and push the gem to RubyGems:
     $ gem build
     $ gem push lifer-<new_version_without_the_v_prefix>.gem
 
+And ensure that the release commit(s) are on the `main` branch:
+
+    $ git push origin main
+
 ## Contributing
 
 I'm not currently accepting unsolicited contributions to Lifer. I'm still

data/lib/lifer/entry/markdown.rb

@@ -30,14 +30,16 @@ class Lifer::Entry::Markdown < Lifer::Entry
   def summary
     return super if super
 
-    return if first_paragraph.nil?
-    return first_paragraph if first_paragraph.length <= TRUNCATION_THRESHOLD
+    return if raw_first_paragraph_text.nil?
 
-    truncated_paragraph = first_paragraph[0..TRUNCATION_THRESHOLD]
-    if (index_of_final_fullstop = truncated_paragraph.rindex ". ")
-      truncated_paragraph[0..index_of_final_fullstop]
+    text = raw_first_paragraph_text
+    return text if text.length <= TRUNCATION_THRESHOLD
+
+    truncated_text = text[0..TRUNCATION_THRESHOLD]
+    if (index_of_final_fullstop = text.rindex ". ")
+      truncated_text[0..index_of_final_fullstop]
     else
-      "%s..." % truncated_paragraph
+      "%s..." % truncated_text
     end
   end
 
@@ -57,7 +59,7 @@ class Lifer::Entry::Markdown < Lifer::Entry
   #
   # @return [String] The HTML for the body of the entry.
   def to_html
-    Kramdown::Document.new(body).to_html
+    @to_html ||= Kramdown::Document.new(body).to_html
   end
 
   private
@@ -75,25 +77,20 @@ class Lifer::Entry::Markdown < Lifer::Entry
     end.uniq
   end
 
-  # Using Kramdown we can detect the first paragraph of the entry.
+  # Detects the raw paragraph text from the entry.
   #
+  # @fixme It would be easier and less error prone to do this with Nokogiri. But
+  #   we currently don't need the dependency for any other reason, so let's
+  #   defer adding it until then.
   # @private
-  def first_paragraph
-    @first_paragraph ||=
-      kramdown_paragraph_text(
-        Kramdown::Document.new(body).root
-          .children
-          .detect { |child| child.type == :p }
-      )
-  end
+  def raw_first_paragraph_text
+    paragraphs = to_html.match %r{<p[^>]*>(.*?)</p>}im
+    paragraph = paragraphs ? paragraphs[1].strip : nil
 
-  # @private
-  def kramdown_paragraph_text(kramdown_element)
-    return if kramdown_element.nil?
+    return unless paragraph
 
-    kramdown_element.children
-      .flat_map { |child| child.value || kramdown_paragraph_text(child) }
-      .join
-      .gsub(/\n/, " ")
+    paragraph = paragraph.gsub /<\/?[^>]*>/, ""
+    paragraph = CGI.unescapeHTML paragraph
+    paragraph.gsub(/[\s\n\t]+/, " ").strip
   end
 end

data/lib/lifer/version.rb

@@ -1,3 +1,3 @@
 module Lifer
-  VERSION = "0.10.0"
+  VERSION = "0.10.1"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: lifer
 version: !ruby/object:Gem::Version
-  version: 0.10.0
+  version: 0.10.1
 platform: ruby
 authors:
 - benjamin wil
@@ -210,8 +210,8 @@ licenses:
 - MIT
 metadata:
   allowed_push_host: https://rubygems.org
-  homepage_uri: https://github.com/benjaminwil/lifer/blob/v0.10.0/README.md
-  source_code_uri: https://github.com/benjaminwil/lifer/tree/v0.10.0
+  homepage_uri: https://github.com/benjaminwil/lifer/blob/v0.10.1/README.md
+  source_code_uri: https://github.com/benjaminwil/lifer/tree/v0.10.1
   changelog_uri: https://github.com/benjaminwil/lifer/blob/main/CHANGELOG.md
 post_install_message:
 rdoc_options: []