postwave 0.1.1 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ee98e42b5e3436991cfb73764252e21db5ed18c9bfd2760045ee268250d1c79a
-  data.tar.gz: 63e682e894bb2838ee0a46393b75b600ad83197a1fc4b9735b2a7e77897dafe8
+  metadata.gz: b4511f2e9288a14247515ff919efbcdfaf4aef9f7e6ae5d7de5c207795307d73
+  data.tar.gz: 6997bdd3f519948e40fbf701d792bc761e0d563f23bd171b47cf35b6ba652fb8
 SHA512:
-  metadata.gz: 7df94a047a4875a2f317ed26f0c30bec4f1a6178967ab721280cb5c40fdb41e35f790537ccbf40a151c9fcddf61862adad0c058ffc04f5dab944ccec48b58652
-  data.tar.gz: 182ae4013b7064810db4f5358d5202100ef8ce3563c79edcfc0af121f4f95f622f9641f5b9b53563916deb8c385123697b1443260ef1377b0a66d695792cc1be
+  metadata.gz: 3248a5fdd235809dee5026f53ecf5dd637c96a3e69e6acff19d91617a6632ae61e49989a79dd16f91258b21de14d54ed748b31af5dbb2974d3e0c97d6f65accf
+  data.tar.gz: 74bd0b0f980cb534b63c06a3374e4d1e807c68113cf18cc56f1bf6aa601adb4b4c2ae0c5bb55103ed2d2a496064b1b730435933dda937eb2aa446a92bf3279fc

data/README.md

@@ -179,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

@@ -30,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

data/lib/postwave/version.rb

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

metadata

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