weneedfeed 0.7.2 → 0.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2731eafeff7f8a49cd49467cbcdf2dc9b7d156d475d6a6409d9e73ee6fbfd305
-  data.tar.gz: 65f0569ec54413e9a0b0f44612782804177cb06dbdc9bed0d2054f0a68655cb8
+  metadata.gz: a2634d6a72650518bf2845381116e208a65fbb9f067b6e19f58352bb46ecb5ba
+  data.tar.gz: 1ccc6647e1a02d34af10460b34d5cd594eb5a184cbe18e2244d45637a38d9d96
 SHA512:
-  metadata.gz: 544c38f0a268f66386432b2895133a84c39b68bfcd48e6922fe14f4f543a4260283e8df10c10c788ca999d75cef6d37621dca0e571e33489be6a3ed453e52388
-  data.tar.gz: bab5629580e689faf7271e0119cc73dce75d4348e844f3a7bcf8e419609a452d5aa55148b5dc9537e25f9be57f5ce6bfb549e7764d19725ef88637452193a35f
+  metadata.gz: 18d069fc8460e37e79b67869bd91f64d28f865d052c4464d6f169f811ad32c27698ccad3235f4b7f047160cd68341f56a576701758bb367d9766e9f8d46dc9c3
+  data.tar.gz: b4f5e74955365a5184b90ea2ce877b0f548e55da5a9eb55e1f92ad64e66f0426397fb441ccda7d4a678ec5c9acb2b4f782c0185fdbe511139b53087b0e6e0a05

data/CHANGELOG.md

@@ -7,6 +7,16 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## Unreleased
 
+## 0.8.0 - 2020-11-25
+
+### Added
+
+- Add page description for writing channel description.
+
+### Changed
+
+- Change channel link content from feeds index URL to page URL.
+
 ## 0.7.2 - 2020-11-25
 
 ### Fixed

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    weneedfeed (0.7.2)
+    weneedfeed (0.8.0)
       activesupport
       builder
       faraday

data/README.md

@@ -34,7 +34,8 @@ You need to write a schema file named with `weneedfeed.yml` to use this gem.
 ```yaml
 pages:
   - id: example1
-    title: Example feed with CSS Selector
+    title: Example 1
+    description: Example feed with CSS Selector
     url: http://example.com/1
     item_selector: li
     item_description_selector: p:nth-child(3)
@@ -42,7 +43,8 @@ pages:
     item_time_selector: time
     item_title_selector: p:nth-child(2)
   - id: example2
-    title: Example feed with XPath
+    title: Example 2
+    description: Example feed with XPath
     url: http://example.com/2
     item_selector: //li
     item_description_selector: .//p[3]
@@ -56,7 +58,7 @@ pages:
 Feed ID.
 
 - required
-- Used for feed URL.
+- Used for feed URL and `<link>` element in `<channel>` element.
 
 ### `title`
 
@@ -65,6 +67,13 @@ Feed title.
 - required
 - Used for RSS `<title>` element in `<channel>` element.
 
+### `description`
+
+Feed description.
+
+- optional
+- Used for RSS `<description>` element in `<channel>` element.
+
 ### `url`
 
 HTML source URL.

data/lib/weneedfeed/controllers/show_feed.rb

@@ -11,6 +11,7 @@ module Weneedfeed
         end
 
         scraping = ::Weneedfeed::Scraping.new(
+          description: page_schema.description,
           item_description_selector: page_schema.item_description_selector,
           item_link_selector: page_schema.item_link_selector,
           item_time_selector: page_schema.item_time_selector,

data/lib/weneedfeed/page.rb

@@ -2,12 +2,16 @@
 
 module Weneedfeed
   class Page
+    # @return [String, nil]
+    attr_reader :description
+
     # @return [String]
     attr_reader :title
 
     # @return [String]
     attr_reader :url
 
+    # @param [String, nil] description
     # @param [String, nil] item_description_selector
     # @param [String] item_link_selector
     # @param [String, nil] item_time_selector
@@ -17,6 +21,7 @@ module Weneedfeed
     # @param [String] title
     # @param [String] url
     def initialize(
+      description:,
       item_description_selector:,
       item_link_selector:,
       item_time_selector:,
@@ -26,6 +31,7 @@ module Weneedfeed
       title:,
       url:
     )
+      @description = description
       @item_description_selector = item_description_selector
       @item_link_selector = item_link_selector
       @item_time_selector = item_time_selector

data/lib/weneedfeed/page_schema.rb

@@ -2,6 +2,7 @@
 
 module Weneedfeed
   PageSchema = Struct.new(
+    :description,
     :id,
     :item_description_selector,
     :item_link_selector,

data/lib/weneedfeed/schema.rb

@@ -24,6 +24,7 @@ module Weneedfeed
     def page_schemata
       @raw['pages'].map do |hash|
         ::Weneedfeed::PageSchema.new(
+          description: hash['description'],
           id: hash['id'],
           item_description_selector: hash['item_description_selector'],
           item_link_selector: hash['item_link_selector'],

data/lib/weneedfeed/scraping.rb

@@ -14,6 +14,7 @@ module Weneedfeed
       end
     end
 
+    # @param [String, nil] description
     # @param [String, nil] item_description_selector
     # @param [String] item_link_selector
     # @param [String, nil] item_time_selector
@@ -22,6 +23,7 @@ module Weneedfeed
     # @param [String] title
     # @param [String] url
     def initialize(
+      description:,
       item_description_selector:,
       item_link_selector:,
       item_time_selector:,
@@ -30,6 +32,7 @@ module Weneedfeed
       title:,
       url:
     )
+      @description = description
       @item_description_selector = item_description_selector
       @item_link_selector = item_link_selector
       @item_time_selector = item_time_selector
@@ -42,6 +45,7 @@ module Weneedfeed
     # @return [Weneedfeed::Page]
     def call
       ::Weneedfeed::Page.new(
+        description: @description,
         node: parsed_body,
         item_description_selector: @item_description_selector,
         item_selector: @item_selector,

data/lib/weneedfeed/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Weneedfeed
-  VERSION = '0.7.2'
+  VERSION = '0.8.0'
 end

data/templates/show_feed.xml.erb

@@ -4,9 +4,9 @@
   xmlns:content="http://purl.org/rss/1.0/modules/content/">
   <channel>
     <title><![CDATA[<%= @page.title %>]]></title>
-    <link><%= "#{request.base_url}#{top_page_path}" %></link>
+    <link><%= "#{@page.url}" %></link>
     <atom:link href="<%= "#{request.base_url}#{request.path}" %>" rel="self"/>
-    <description><![CDATA[Recent content on <%= @page.title %>]]></description>
+    <description><![CDATA[<%= @page.description %>]]></description>
     <lastBuildDate><%= Time.now.rfc822 %></lastBuildDate>
     <% items.each do |item| %>
     <item>

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: weneedfeed
 version: !ruby/object:Gem::Version
-  version: 0.7.2
+  version: 0.8.0
 platform: ruby
 authors:
 - Ryo Nakamura