postwave 0.1.2 → 0.1.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b4511f2e9288a14247515ff919efbcdfaf4aef9f7e6ae5d7de5c207795307d73
-  data.tar.gz: 6997bdd3f519948e40fbf701d792bc761e0d563f23bd171b47cf35b6ba652fb8
+  metadata.gz: d0eb03ce8fdc3e97f2f54515cbfaa7d527e2f0df541ffd4d993966535b7a8483
+  data.tar.gz: c4b81108e5facc67d6e1799c8907f9d220f34ab9779e270b18bf9787408ca571
 SHA512:
-  metadata.gz: 3248a5fdd235809dee5026f53ecf5dd637c96a3e69e6acff19d91617a6632ae61e49989a79dd16f91258b21de14d54ed748b31af5dbb2974d3e0c97d6f65accf
-  data.tar.gz: 74bd0b0f980cb534b63c06a3374e4d1e807c68113cf18cc56f1bf6aa601adb4b4c2ae0c5bb55103ed2d2a496064b1b730435933dda937eb2aa446a92bf3279fc
+  metadata.gz: 84e334c164a2b1d02ff90b03657493bfd693985f52ef171311dd0319b915439ee04fa315982ab4b6052a295ea229ac0443421e9bbe08fe8ff9050023c4f26be9
+  data.tar.gz: 4f98af33627b143439e7aa75827705c5a74162791e2d066ba3024f99afa5de0df0b13437801da31f40ac00051bea9cca26f96b57c15484f83cab26a9594329ac

data/README.md

@@ -4,12 +4,16 @@
 
 Write your posts statically. Interact with them dynamically.
 
+[postwave.blog](https://postwave.blog/)
+
 ## What is Postwave?
 
 Postwave is an opinionated flat-file based based blog engine.
 
 It lets you write posts in Markdown and then display them on a dynamic site using the client functionality.
 
+Read more about the philosophy behind [what Postwave is for](https://postwave.blog/posts/what-is-postwave-for).
+
 ## Installation
 
 ```
@@ -113,18 +117,20 @@ postwave_client = Postwave::Client.new("path/to/config/postwave.yaml", preload:
 
 ### Get a Single Post
 
-Pass in the stub (the filename without '.md') for the post.
+Pass in the stub (the filename without the date and '.md') for the post.
 ```ruby
 post = postwave_client.post("my-great-post")
 
-# <Postwave::Post title="My Great Post", date=<Time ...>, tags=["tag1"], body="bla bla bla..">
+# <Postwave::Post title="My Great Post", date=<Time ...>, tags=["tag1"], body="bla bla bla">
 
 puts post.title
 # "My Great Post"
 puts post.body
-# "bla bla bla..."
+# "bla bla bla"
 puts post.body_html # uses Redcarpt to convert body Markdown to HTML
-# "<p>bla bla bla...</p>"
+# "<p>bla bla bla</p>"
+puts post.body_preview(8) # an HTML free preview of the post with optional `limit` and `ellipsis` params
+# "bla bla..." 
 ```
 
 ### Get a Collection of Posts
@@ -227,6 +233,10 @@ archive = postwave_client.archive(by: "month")
 # }
 ```
 
+## Example Site
+
+The code for [postwave.blog](https://postwave.blog/) is available at [github.com/dorkrawk/postwave-site](https://github.com/dorkrawk/postwave-site) and serves as a good example of how to use Postwave in a real world project.
+
 ## Run Tests
 
 ```

data/lib/postwave/client.rb

@@ -32,7 +32,7 @@ module Postwave
 
     def archive(by: "year")
       working_index = @full_index || get_full_index
-      post_hash = posts.group_by { |post| post.date.year }.transform_values { |posts| posts.sort_by(&:date) }
+      post_hash = working_index.group_by { |post| post.date.year }.transform_values { |posts| posts.sort_by(&:date) }
       if by == "month"
         post_hash.each do |key, value|
           post_hash[key] = value.group_by { |post| post.date.month }
@@ -119,7 +119,7 @@ module Postwave
 
     def get_summary
       summary_file_path = File.join(@blog_root, POSTS_DIR, META_DIR, SUMMARY_FILE_NAME)
-      YAML.load_file(summary_file_path)
+      YAML.load_file(summary_file_path, permitted_classes: [Time, Symbol])
     end
   end
 end

data/lib/postwave/post.rb

@@ -1,5 +1,6 @@
 require_relative "blog_utilities"
 require "redcarpet"
+require "cgi"
 
 module Postwave
   class Post
@@ -7,7 +8,8 @@ module Postwave
 
     KNOWN_FIELDS = %w(title date tags title_slug body draft)
     REQUIRED_FIELDS = %w(title date)
-    MEATADATA_DELIMTER = "---"
+    METADATA_DELIMITER = "---"
+    FILE_NAME_DATE_LEN = 11 # YYYY-MM-DD-
 
     attr_accessor :file_name
 
@@ -20,7 +22,7 @@ module Postwave
 
       File.readlines(path).each do |line|
         clean_line = line.strip
-        if clean_line == MEATADATA_DELIMTER
+        if clean_line == METADATA_DELIMITER
           metadata_delimter_count += 1
           next
         end
@@ -65,11 +67,18 @@ module Postwave
         instance_variable_set("@#{field}", value) unless self.instance_variables.include?("@#{field}".to_sym)
         self.class.send(:attr_reader, field) unless self.public_methods.include?(field.to_sym)
       end
+
+      @slug = file_name_slug&.empty? ? title_slug : file_name_slug
     end
 
     def title_slug
       @title_slug ||= @title.downcase.strip.gsub(' ', '-').gsub(/[^\w-]/, '')
     end
+
+    def file_name_slug
+      # YYYY-MM-DD-slug.md
+      File.basename(@file_name, ".md")[FILE_NAME_DATE_LEN..]
+    end
     
     def slug
       @slug ||= @title_slug
@@ -80,7 +89,34 @@ module Postwave
     end
 
     def body_html
-      @@markdown.render(@body)
+      @body_html ||= @@markdown.render(@body)
+    end
+
+    def body_preview(limit = 100, ellipsis = "...")
+      text = body_html.to_s
+
+      # Turn common block boundaries into newlines first
+      text = text.gsub(/<(br|\/p|\/div|\/h\d|\/li)[^>]*>/i, "\n")
+      # Strip remaining tags
+      text = text.gsub(/<[^>]*>/, "")
+      # Decode entities
+      text = CGI.unescapeHTML(text)
+      # Collapse spaces but keep single newlines
+      text = text.gsub(/[ \t]+/, " ").gsub(/\n+/, "\n").strip
+
+      # Unicode-safe character counting (grapheme clusters)
+      graphemes = text.scan(/\X/)
+      return text if graphemes.length <= limit
+
+      candidate = graphemes.first(limit).join
+
+      # If we cut mid-word, trim back to the previous word boundary.
+      # Word characters = letters, numbers, marks, connector punctuation (e.g., underscore)
+      # This removes a trailing partial word if present.
+      cut = candidate.sub(/[\p{L}\p{N}\p{M}\p{Pc}]+\z/u, "").rstrip
+
+      # If the very first "word" exceeds the limit, we err under limit and just show an ellipsis.
+      cut.empty? ? ellipsis : "#{cut}#{ellipsis}"
     end
 
     def generated_file_name

data/lib/postwave/rss_helper.rb

@@ -15,16 +15,17 @@ module Postwave
     end
     
     def feed_content(posts)
-      link = config_values[:url]
+      link = config_values[:url].chomp("/")
       updated = Time.now.iso8601.to_s
       title = config_values[:name]
       description = config_values[:description]
 
       markdown = Redcarpet::Markdown.new(Redcarpet::Render::HTML, fenced_code_blocks: true)
       feed_posts = posts.map do |post|
-        post_link = "#{config_values[:url]}/#{config_values[:posts_path]}/#{post.slug}"
+        post_link = "#{link}/#{config_values[:posts_path]}/#{post.slug}"
         html_body = CGI.unescapeHTML(markdown.render(post.body))
-        FeedPost.new(post.title, post_link, html_body, post.date.iso8601, post.tags)
+        post_title = CGI.escapeHTML(post.title)
+        FeedPost.new(post_title, post_link, html_body, post.date.iso8601, post.tags)
       end
 
       path = File.join(__dir__, "templates/feed.erb")

data/lib/postwave/version.rb

@@ -1,3 +1,3 @@
 module Postwave
-  VERSION = "0.1.2"
+  VERSION = "0.1.4"
 end

data/postwave.gemspec

@@ -19,7 +19,12 @@ Gem::Specification.new do |spec|
   spec.require_paths = ["lib"]
 
   spec.add_dependency "redcarpet", '~> 3.6'
+  spec.add_dependency "csv"
+  spec.add_dependency "time"
+  spec.add_dependency "yaml"
+
 
   spec.add_development_dependency "bundler"
   spec.add_development_dependency "rake", "~> 12.3"
+  spec.add_development_dependency "rss"
 end

metadata

@@ -1,14 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: postwave
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.1.4
 platform: ruby
 authors:
 - Dave Schwantes
-autorequire:
 bindir: bin
 cert_chain: []
-date: 2025-03-13 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: redcarpet
@@ -24,6 +23,48 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.6'
+- !ruby/object:Gem::Dependency
+  name: csv
+  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: time
+  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: yaml
+  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: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -52,6 +93,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '12.3'
+- !ruby/object:Gem::Dependency
+  name: rss
+  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'
 description: Write your posts statically. Interact with them dynamically.
 email:
 - dave.schwantes@gmail.com
@@ -83,7 +138,6 @@ homepage: https://github.com/dorkrawk/postwave
 licenses:
 - MIT
 metadata: {}
-post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -98,8 +152,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.22
-signing_key:
+rubygems_version: 3.7.1
 specification_version: 4
 summary: An opinionated flatfile based blog engine.
 test_files: []