postwave 0.1.0 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3659ecd8d7d5b7d1fdfaddb0b8538b86414e34687febec04f29c3352dff8d6c2
-  data.tar.gz: f877ba937e8361518ca4a0c16f5d3ae77dfb101ac94becd0e2f2c3ae5f01abf4
+  metadata.gz: b4511f2e9288a14247515ff919efbcdfaf4aef9f7e6ae5d7de5c207795307d73
+  data.tar.gz: 6997bdd3f519948e40fbf701d792bc761e0d563f23bd171b47cf35b6ba652fb8
 SHA512:
-  metadata.gz: a866429e4ad00e427b8302527e4eafcd488d16b938b51d12f370104d9a8dc0abdec1f5b868f62c0afb7b10ac162a120bbe2494d6b4347f521c9c6f35cf9c00cd
-  data.tar.gz: 89575f81e742ca2bcd40d14c6e54ed3618daf4ad8434720ed65b6cdd4350e2189ba0721265351d62d565c49c9ac8c9a4686e96e93eabc358e29984a66999f3c1
+  metadata.gz: 3248a5fdd235809dee5026f53ecf5dd637c96a3e69e6acff19d91617a6632ae61e49989a79dd16f91258b21de14d54ed748b31af5dbb2974d3e0c97d6f65accf
+  data.tar.gz: 74bd0b0f980cb534b63c06a3374e4d1e807c68113cf18cc56f1bf6aa601adb4b4c2ae0c5bb55103ed2d2a496064b1b730435933dda937eb2aa446a92bf3279fc

data/README.md

@@ -121,6 +121,10 @@ post = postwave_client.post("my-great-post")
 
 puts post.title
 # "My Great Post"
+puts post.body
+# "bla bla bla..."
+puts post.body_html # uses Redcarpt to convert body Markdown to HTML
+# "<p>bla bla bla...</p>"
 ```
 
 ### Get a Collection of Posts
@@ -175,12 +179,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

@@ -8,6 +8,7 @@ require "yaml"
 
 Postwave::PostStub = Struct.new(:date, :title, :slug)
 Postwave::Tag = Struct.new(:name, :count, :post_slugs)
+Postwave::Pagination = Struct.new(:current_page, :prev_page, :next_page, :total_pages)
 
 module Postwave
   class Client
@@ -29,6 +30,18 @@ module Postwave
       working_index[offset, count]
     end
 
+    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) }
+      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
@@ -69,6 +82,16 @@ module Postwave
       rss.read
     end
 
+    # reuturns: a Pagination Struct - <struct Pagination current_page=3, prev_page=2, next_page=4, total_pages=20>
+    def pagination(current_page: 1, per_page: 10)
+      summary = @blog_summary || get_summary
+      total_pages = (summary[:post_count].to_f / per_page).ceil
+      in_bound_current = current_page.clamp(1, total_pages)
+      prev_page = in_bound_current > 1 ? in_bound_current - 1 : nil
+      next_page = in_bound_current < total_pages ? in_bound_current + 1 : nil
+      Postwave::Pagination.new(in_bound_current, prev_page, next_page, total_pages)
+    end
+
     private
 
     def is_valid_config?(config_path)

data/lib/postwave/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: postwave
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.2
 platform: ruby
 authors:
 - Dave Schwantes
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2025-01-17 00:00:00.000000000 Z
+date: 2025-03-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: redcarpet