nanoc-feeds 0.1.0 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 38ee68d42c7717f804ba0bf46a088cc7f168a86913927ac60f9cd93ded761147
-  data.tar.gz: d948b44d56cbd42265efe479523eaffc9897f97df0df97d78101baa6deaf8764
+  metadata.gz: f40b9f32b3ed641d3930ef1a5a6dc1020a8cda66c66176cea5497a47058a369c
+  data.tar.gz: 13bdb8b0b8497e288639650857a2f8f0df7a17e3053497ee153ff88a1c1c2424
 SHA512:
-  metadata.gz: 6615e98ee034e0c3fcb06dc33178e9c8a2049e7d2bd1b41661e7cf7170f8d7f2834cdb4afa87971de9d55614f1295034f05d3456bc752abd468e2f70e37baf93
-  data.tar.gz: 0d183ab7971865aaceb0d18b7da70b1559c666b8826bc325ef82d2493dfea611336a2de7b71694254afd6e8fa9227beba179599eecb355790b18d0f62c5b8ca5
+  metadata.gz: cb5f63cb408efe141e29af0b478ad02b387457e476372b9bf7ff51af3fb7b4aac2cd88f2ae732d82102dda2df0499d1b610a8381b05955389642e08f3789276e
+  data.tar.gz: 98b33920ee6695e209f2bcd4aa4df775a662d5bc2944aa55bbf3eee5b6fe0873505334a4e9d3ad7c3fc492d046711bf2da334856751b99daaa91ed44a558d14a

data/README.md

@@ -1,28 +1,48 @@
 # Nanoc::Feeds
 
-TODO: Delete this and the text below, and describe your gem
-
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/nanoc/feeds`. To experiment with that code, run `bin/console` for an interactive prompt.
+A set of helpers for generating additional feeds in nanoc. Currently JSON and Atom feeds are supported.
 
 ## Installation
 
-TODO: Replace `UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG` with your gem name right after releasing it to RubyGems.org. Please do not do it earlier due to security reasons. Alternatively, replace this section with instructions to install your gem from git if you don't plan to release to RubyGems.org.
-
-Install the gem and add to the application's Gemfile by executing:
+Install the gem and add to your nanoc project Gemfile by executing:
 
 ```bash
-bundle add UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG
+bundle add nanoc-feeds
 ```
 
 If bundler is not being used to manage dependencies, install the gem by executing:
 
 ```bash
-gem install UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG
+gem install nanoc-feeds
 ```
 
 ## Usage
 
-TODO: Write usage instructions here
+To generate JSON and Atom feeds add this gem to your `Gemfile` and then include the module in your `lib/helpers.rb` file:
+
+```ruby
+use_helper Nanoc::Feeds::Helpers::Feeds
+```
+
+Now create a `feed.erb` in your content folder using the helper provided:
+```erb
+<%= feed articles: sorted_articles %>
+```
+
+Finally add the following to your `Rules` file:
+```ruby
+compile "/feed.erb" do
+  filter :erb
+  write "/feed.xml"
+end
+
+compile "/feed.erb", rep: :json do
+  filter :erb
+  write "/feed.json"
+end
+```
+
+This will render a JSON (`feed.json`) and Atom (`feed.xml`) feed for your articles.
 
 ## Development
 
@@ -32,7 +52,7 @@ To install this gem onto your local machine, run `bundle exec rake install`. To
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/nanoc-feeds.
+Bug reports and pull requests are welcome on GitHub at https://github.com/michaelem/nanoc-feeds.
 
 ## License
 

data/lib/nanoc/feeds/helpers/feeds.rb

@@ -14,13 +14,17 @@ module Nanoc::Feeds::Helpers::Feeds
 
   def json_feed(params = {})
     articles = params[:articles]
+    articles = articles.first(params[:limit]) if params[:limit]
     title = params[:title] || @config[:title]
+
+    items = articles.map { |article| build_for_article(article, title) }
+
     {
       version: "https://jsonfeed.org/version/1.1",
       title: title,
       home_page_url: "#{config[:base_url]}",
-      feed_url: "#{config[:base_url]}/feed.json",
-      items: articles.map { |article| build_for_article(article, title) }
+      feed_url: feed_url,
+      items: items
     }.to_json
   end
 

data/lib/nanoc/feeds/version.rb

@@ -2,6 +2,6 @@
 
 module Nanoc
   module Feeds
-    VERSION = "0.1.0"
+    VERSION = "0.1.2"
   end
 end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: nanoc-feeds
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.2
 platform: ruby
 authors:
 - Michael Emhofer
 bindir: exe
 cert_chain: []
-date: 2025-01-19 00:00:00.000000000 Z
+date: 2025-01-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: zeitwerk