weneedfeed 0.17.0 → 0.18.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c5a85470ed37f8724012951976f2dbe1286d5b82dabace4e9c830e6104051129
-  data.tar.gz: 980537323111e8ebafd1d0f8496dd45edaf21be74a26aba78aa8f8439e28546d
+  metadata.gz: 15fe792e19590e141278496015fefd5f9b7b10c2fa467b2bb2d8f7b6b9206350
+  data.tar.gz: c0957471a1a209b3727a04eecec561aae7144c225b9ae469f7dfd66c9e698aa2
 SHA512:
-  metadata.gz: 040be9432bb6892d33cae5f8ddc4fd2e228b028fe6e9706fbb86cf58eaf97cef5bb005353a91dda4c972fba17319428b654dab6c6d9bd0ad90b3127cc4583911
-  data.tar.gz: c386bd0eb5fa38abda0f7e5006f90b6e77c803a9b5b2a6f5becf5ea1aa89c945ed6d07daeb1021187a5dd428eb9fd0b474d1495a34b454c0b616e50378484700
+  metadata.gz: 3a52e5daab18cd4f8d5f303e6a065d0018efd23babe7b364c112bb08c488eab67e179efc5fb2037563e5d9706ec71e4992433f83cd70c0b1245ce7b54f50f145
+  data.tar.gz: a01540c21b8ddb8737b862530089df9216e6814a084a8e3c132e4b4d30c41dcd571c835c42a1d1a00c41cf39372a093f41449d028ea13282e29a0d084f2eb1ae

data/CHANGELOG.md

@@ -7,6 +7,13 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## Unreleased
 
+## 0.18.0 - 2022-04-17
+
+### Added
+
+- Support configurable feeds title.
+- Add --port= option to server command.
+
 ## 0.17.0 - 2022-04-15
 
 ### Changed

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    weneedfeed (0.17.0)
+    weneedfeed (0.18.0)
       activesupport
       addressable
       builder

data/README.md

@@ -32,6 +32,8 @@ Weneedfeed requires `weneedfeed.yml` that describes URLs and selectors.
 ### Example
 
 ```yaml
+title: Example RSS feeds
+
 pages:
   - id: example1
     title: Example 1
@@ -55,70 +57,75 @@ pages:
     item_title_selector: .//p[2]
 ```
 
-### `id`
+### `title`
+
+- optional (default: `"Weneedfeed"`)
+- Used for feeds title on top page and OPML outline.
+
+### `pages.id`
 
 Feed ID.
 
 - required
 - Used for feed URL and `<link>` element in `<channel>` element.
 
-### `title`
+### `pages.title`
 
 Feed title.
 
 - required
 - Used for RSS `<title>` element in `<channel>` element.
 
-### `description`
+### `pages.description`
 
 Feed description.
 
 - optional
 - Used for RSS `<description>` element in `<channel>` element.
 
-### `url`
+### `pages.url`
 
 HTML source URL.
 
 - required
 - Used to fetch HTML page for building feed.
 
-### `item_selector`
+### `pages.item_selector`
 
 CSS or XPath selector to search each item.
 
 - required
 - Equivalent unit to RSS `<item>` element.
 
-### `item_link_selector`
+### `pages.item_link_selector`
 
 CSS or XPath selector to find `<a>` element in each item.
 
 - required
 - Used for `<link>` in `<item>`.
 
-### `item_title_selector`
+### `pages.item_title_selector`
 
 CSS or XPath selector to find element with title information in each item.
 
 - required
 - Used for `<title>` in `<item>`.
 
-### `item_description_selector`
+### `pages.item_description_selector`
 
 CSS or XPath selector to find element with description information in each item.
 
 - optional
 - Used for `<description>` in `<item>`.
 
-### `item_image_selector`
+### `pages.item_image_selector`
 
 CSS or XPath selector to find `<img>`element in each item.
 
 - optional
 - Used for `<enclosure>` in `<item>`.
 
-### `item_time_selector`
+### `pages.item_time_selector`
 
 CSS or XPath selector to find element with datetime information in each item.
 

data/lib/weneedfeed/command.rb

@@ -53,9 +53,16 @@ module Weneedfeed
       type: :string
     )
 
+    method_option(
+      :port,
+      default: '8080',
+      desc: 'TCP port to bind to.',
+      type: :string
+    )
+
     def server
       application = Weneedfeed::Application.new(schema_path: options[:schema_path])
-      ::Rack::Handler.default.run(application)
+      ::Rack::Handler.default.run(application, Port: options[:port])
     end
   end
 end

data/lib/weneedfeed/controllers/show_opml.rb

@@ -7,12 +7,12 @@ module Weneedfeed
         response.content_type = 'application/xml; charset=utf-8'
         response.write(
           ::Weneedfeed::Views::ShowOpml.new(
-            page_schemata: schema.page_schemata.sort_by(&:title),
             partial_template_path: ::File.expand_path(
               'templates/show_opml.xml.erb',
               "#{__dir__}/../../.."
             ),
-            request: request
+            request: request,
+            schema: schema
           ).to_s
         )
       end

data/lib/weneedfeed/controllers/show_top_page.rb

@@ -4,16 +4,15 @@ module Weneedfeed
   module Controllers
     class ShowTopPage < ::Weneedfeed::Controllers::Base
       def call
-        page_schemata = schema.page_schemata.sort_by(&:title)
         response.content_type = 'text/html'
         response.write(
           ::Weneedfeed::Views::ShowTopPage.new(
-            page_schemata: page_schemata,
             partial_template_path: ::File.expand_path(
               'templates/show_top_page.html.erb',
               "#{__dir__}/../../.."
             ),
-            request: request
+            request: request,
+            schema: schema
           ).to_s
         )
       end

data/lib/weneedfeed/schema.rb

@@ -4,6 +4,8 @@ require 'yaml'
 
 module Weneedfeed
   class Schema
+    DEFAULT_TITLE = 'Weneedfeed'
+
     class << self
       # @param [String] schema_path
       # @return [Weneedfeed::Schema]
@@ -48,5 +50,10 @@ module Weneedfeed
         )
       end
     end
+
+    # @return [String]
+    def title
+      @raw['title'] || DEFAULT_TITLE
+    end
   end
 end

data/lib/weneedfeed/version.rb

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

data/lib/weneedfeed/views/show_opml.rb

@@ -3,10 +3,10 @@
 module Weneedfeed
   module Views
     class ShowOpml < Base
-      # @param [Array<Hash>] page_schemata
-      def initialize(page_schemata:, **argv)
+      # @param [Weneedfeed::Schema] schema
+      def initialize(schema:, **argv)
         super(**argv)
-        @page_schemata = page_schemata
+        @schema = schema
       end
 
       private
@@ -21,6 +21,11 @@ module Weneedfeed
       def feed_path(page_id:)
         "#{base_path}#{router.path(:feed, page_id: page_id)}"
       end
+
+      # @return [Array<String>]
+      def page_schemata
+        @schema.page_schemata.sort_by(&:title)
+      end
     end
   end
 end

data/lib/weneedfeed/views/show_top_page.rb

@@ -3,10 +3,10 @@
 module Weneedfeed
   module Views
     class ShowTopPage < Base
-      # @param [Array<Hash>] page_schemata
-      def initialize(page_schemata:, **argv)
+      # @param [Weneedfeed::Schema] schema
+      def initialize(schema:, **argv)
         super(**argv)
-        @page_schemata = page_schemata
+        @schema = schema
       end
 
       private
@@ -27,6 +27,11 @@ module Weneedfeed
         "#{base_path}#{router.path(:opml)}"
       end
 
+      # @return [Array<String>]
+      def page_schemata
+        @schema.page_schemata.sort_by(&:title)
+      end
+
       # @return [Hanami::Router]
       def router
         ::Weneedfeed::Application.router

data/templates/show_opml.xml.erb

@@ -1,11 +1,11 @@
 <?xml version="1.0" encoding="UTF-8"?>
 <opml version="1.0">
   <head>
-    <title>Weneedfeed</title>
+    <title><%= @schema.title %></title>
   </head>
   <body>
-    <outline text="Weneedfeed" title="Weneedfeed">
-      <% @page_schemata.each do |page_schema| %>
+    <outline text="<%= @schema.title %>" title="<%= @schema.title %>">
+      <% page_schemata.each do |page_schema| %>
         <outline type="rss" text="<%= page_schema.title %>" title="<%= page_schema.title %>" xmlUrl="<%= "#{request.base_url}#{feed_path(page_id: page_schema.id)}" %>" htmlUrl="<%= page_schema.url %>"/>
       <% end %>
     </outline>

data/templates/show_top_page.html.erb

@@ -3,7 +3,7 @@
   <head>
     <meta charset="UTF-8">
     <meta name="viewport" content="width=device-width">
-    <title>Weneedfeed</title>
+    <title><%= @schema.title %></title>
   </head>
   <body>
     <section>
@@ -11,7 +11,7 @@
         <h1>Feeds</h1>
       </header>
       <ul>
-        <% @page_schemata.each do |page_schema| %>
+        <% page_schemata.each do |page_schema| %>
         <li>
           <a href="<%= feed_path(page_id: page_schema.id) %>"><%= page_schema.title %></a>
         </li>

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: weneedfeed
 version: !ruby/object:Gem::Version
-  version: 0.17.0
+  version: 0.18.0
 platform: ruby
 authors:
 - Ryo Nakamura
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-04-15 00:00:00.000000000 Z
+date: 2022-04-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport