postwave 0.1.1 → 0.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ee98e42b5e3436991cfb73764252e21db5ed18c9bfd2760045ee268250d1c79a
-  data.tar.gz: 63e682e894bb2838ee0a46393b75b600ad83197a1fc4b9735b2a7e77897dafe8
+  metadata.gz: d05bcd73c7411550217ca5ecbeed284b472a25aac71493b401bac88b8c756cab
+  data.tar.gz: 58b7c971cc36fe07783176414d530ec96962d9b921a854d2d1580322fc9fb718
 SHA512:
-  metadata.gz: 7df94a047a4875a2f317ed26f0c30bec4f1a6178967ab721280cb5c40fdb41e35f790537ccbf40a151c9fcddf61862adad0c058ffc04f5dab944ccec48b58652
-  data.tar.gz: 182ae4013b7064810db4f5358d5202100ef8ce3563c79edcfc0af121f4f95f622f9641f5b9b53563916deb8c385123697b1443260ef1377b0a66d695792cc1be
+  metadata.gz: 9ea1bcd8a913e043d49b99a3687fd3d97c12a1dbc60d938b3f35ceb3995df7eec1b33801f2f1adcc2295ebde903d5be6d90c21655b4bc23b19f137b7195d6130
+  data.tar.gz: 7b52272bb286fe4ed33490e70ed541a9853e1d8191a5f5397292ecb38e45bbae4dffaa8b20a5828423f81bca88c14468a5ee16ff588833741db6d429d3d8f02d

data/README.md

@@ -113,18 +113,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
@@ -179,12 +181,54 @@ tag = postwave_clinet.tag("tag1")
 
 ### Get Text For An RSS Feed
 
+This will give you the text for an Atom feed of your blog.
+
 ```ruby
 rss = postwave_client.rss
 
 # "<?xml version="1.0" encoding="utf-8"?>..."
 ```
 
+### Get Pagination Information
+
+This will give you a `Postwave::Pagination` object that you can use to build pagination in your Postwave powered site.
+
+```ruby
+pagination = postwave_client.pagination(current_page: 3, per_page: 10)
+
+# <Postwave::Pagination current_page=3, prev_page=2, next_page=4, total_pages=20>
+```
+
+### Get An Archive of Posts
+
+This returns a Hash with year as the key and an ordered array of PostStubs
+
+```ruby
+archive = postwave_client.archive
+
+# {
+#   2025 => 
+#     [<Postwave::PostStub title="My Great Post"...>, <PostwaveStub...>, ...], 
+#   2024 => 
+#     [<PostwaveStub...>, <PostwaveStub...>]
+# }
+```
+
+You can pass in a `by: "month"` parameter to further subdivide the archive by month.
+
+```ruby
+archive = postwave_client.archive(by: "month")
+
+# {
+#   2025 =>
+#     1 => [<PostwaveStub...>, <PostwaveStub...>],
+#     2 => [<PostwaveStub...>, <PostwaveStub...>]
+#   2024 =>
+#     11 => [<PostwaveStub...>, <PostwaveStub...>],
+#     12 => [<PostwaveStub...>, <PostwaveStub...>]
+# }
+```
+
 ## Run Tests
 
 ```

data/lib/postwave/client.rb

@@ -30,6 +30,18 @@ module Postwave
       working_index[offset, count]
     end
 
+    def archive(by: "year")
+      working_index = @full_index || get_full_index
+      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 }
+        end
+      end
+
+      post_hash
+    end
+
     # returns: a post - Postwave::Post
     def post(slug)
       post_file_path = Dir["#{File.join(@blog_root, POSTS_DIR)}/*#{slug}.md"].first
@@ -107,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/version.rb

@@ -1,3 +1,3 @@
 module Postwave
-  VERSION = "0.1.1"
+  VERSION = "0.1.3"
 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.1
+  version: 0.1.3
 platform: ruby
 authors:
 - Dave Schwantes
-autorequire:
 bindir: bin
 cert_chain: []
-date: 2025-02-24 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: []