weneedfeed 0.2.0 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b6a5d43bf327c8b96247ed37ce2c98ec546e7a339a8eb777dc647a3a594450a4
-  data.tar.gz: e9ff73155c418c0989d29b0f3f4e4b4133ea5bbb33b92a349b492bddf5965f38
+  metadata.gz: 65814d68cfaf1936de388ce721e3aee49a0e4641c0ecd6ae2afb72c858fbd8f4
+  data.tar.gz: ed124803cfb9589dd3b8e44169454b07623a2460a7ac2412c1946d08e51d590f
 SHA512:
-  metadata.gz: 122215c08d29522f980db52d10de20b9c718a17d7064081a277c3587454f5aedb534e2cf3b3818c1cd42fb89db016d1b59eb096ad91f5dd45e563c45d0971935
-  data.tar.gz: 7f5ae31b297ad9b5dfad5053bb45baae7a3d844014f3269efed007103ff2146d5592d89984987c8a8dde0e13a4ce7845391e6a1215351e6f883f1c0342eb368e
+  metadata.gz: 486e7af49032ebf8124d6360cd835ec5ede778c4dc6911259fcee753247166ef6c53e3468bb3c386a3e2d794b3939685795c230a4ff24e65a67e615c5b39a800
+  data.tar.gz: 636f09f3860a1a7a16bf425facd29988e7037ae35a9ab8a11b8a37118339c9bdf750336eb01b8c36e2bee0d8b81ed2b1a9846269096428b702c09b27b873617a

data/.github/workflows/test.yml

@@ -5,16 +5,18 @@ on:
   push:
     branches:
       - master
+
 jobs:
   build:
     runs-on: ubuntu-18.04
     steps:
       - uses: actions/checkout@v2
-      - uses: actions/setup-ruby@v1
+      - uses: ruby/setup-ruby@v1
         with:
-          ruby-version: '2.7.2'
-      - run: bundle install --jobs=$(($(nproc) - 1)) --retry=3
-      - run: bundle exec rubocop --color --parallel
+          bundler-cache: true
+          ruby-version: 2.7.2
+      - uses: r7kamura/rubocop-problem-matchers-action@v1
+      - run: bundle exec rubocop --parallel
       - run: bundle exec rspec --force-color
 
 

data/.rspec

@@ -1 +1,2 @@
+--format doc
 --require spec_helper

data/.rubocop.yml

@@ -1,3 +1,6 @@
+AllCops:
+  TargetRubyVersion: 2.5
+
 Lint/SuppressedException:
   Enabled: false
 
@@ -6,3 +9,6 @@ Metrics:
 
 Style/Documentation:
   Enabled: false
+
+Style/TrailingCommaInArguments:
+  Enabled: false

data/CHANGELOG.md

@@ -7,6 +7,61 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## Unreleased
 
+## 0.6.0 - 2020-11-15
+
+### Changed
+
+- Change pages schema from Hash to Array.
+- Require hanami-router 2.0.0.alpha3 or later versions.
+- Ignore pubDate when item.time is not found.
+- Make some item_description_selector and item_time_selector optional.
+
+## 0.5.0 - 2020-11-14
+
+### Added
+
+- Add datetime attribute support on time element.
+
+### Changed
+
+- Change schema format about selectors.
+
+## 0.4.1 - 2020-11-08
+
+### Fixed
+
+- Fix error when item description is not found.
+
+## 0.4.0 - 2020-11-08
+
+### Added
+
+- Add CSS selector support.
+
+### Changed
+
+- Change schema key from `xpath` to `selectors`.
+- Change item_link_selector target from href attribute to a element.
+- Change some argument names from `_xpath` to `_selector`.
+- Change `weneedfeed build` description.
+- Change `weneedfeed server` description.
+- Change channel link from feed URL to top page URL.
+- Sort top page feeds by its title.
+
+## 0.3.0 - 2020-11-08
+
+### Added
+
+- Add channel description.
+- Add item description.
+- Add `weneedfeed build` command.
+- Add `weneedfeed server` command.
+
+### Changed
+
+- Surround channel title by CDATA.
+- Change channel children order.
+
 ## 0.2.0 - 2020-11-07
 
 ### Changed

data/Gemfile.lock

@@ -1,11 +1,13 @@
 PATH
   remote: .
   specs:
-    weneedfeed (0.1.0)
+    weneedfeed (0.6.0)
       faraday
+      hanami-router (= 2.0.0.alpha3)
       hibana
       nokogiri
       rack-capture (>= 0.4.0)
+      thor
 
 GEM
   remote: https://rubygems.org/
@@ -13,29 +15,28 @@ GEM
     addressable (2.7.0)
       public_suffix (>= 2.0.2, < 5.0)
     ast (2.4.1)
-    concurrent-ruby (1.1.7)
     crack (0.4.4)
     diff-lcs (1.4.4)
     faraday (1.1.0)
       multipart-post (>= 1.2, < 3)
       ruby2_keywords
-    hanami-router (1.3.2)
-      hanami-utils (~> 1.3)
-      http_router (= 0.11.2)
+    hanami-router (2.0.0.alpha3)
+      mustermann (~> 1.0)
+      mustermann-contrib (~> 1.0)
       rack (~> 2.0)
-    hanami-utils (1.3.6)
-      concurrent-ruby (~> 1.0)
-      transproc (~> 1.0)
+    hansi (0.2.0)
     hashdiff (1.0.1)
     hibana (0.1.1)
       hanami-router
       rack
       tilt
-    http_router (0.11.2)
-      rack (>= 1.0.0)
-      url_mount (~> 0.2.1)
     mini_portile2 (2.4.0)
     multipart-post (2.1.1)
+    mustermann (1.1.1)
+      ruby2_keywords (~> 0.0.1)
+    mustermann-contrib (1.1.1)
+      hansi (~> 0.2.0)
+      mustermann (= 1.1.1)
     nokogiri (1.10.10)
       mini_portile2 (~> 2.4.0)
     parallel (1.19.2)
@@ -77,11 +78,9 @@ GEM
       parser (>= 2.7.1.5)
     ruby-progressbar (1.10.1)
     ruby2_keywords (0.0.2)
+    thor (1.0.1)
     tilt (2.0.10)
-    transproc (1.1.1)
     unicode-display_width (1.7.0)
-    url_mount (0.2.1)
-      rack
     webmock (3.9.3)
       addressable (>= 2.3.6)
       crack (>= 0.3.2)

data/README.md

@@ -3,7 +3,7 @@
 [![](https://badge.fury.io/rb/weneedfeed.svg)](https://rubygems.org/gems/weneedfeed)
 [![](https://github.com/r7kamura/weneedfeed/workflows/test/badge.svg)](https://github.com/r7kamura/weneedfeed/actions?query=workflow%3Atest)
 
-Generate feeds from URL and XPath.
+Generate feeds from URL and selectors.
 
 ## Installation
 
@@ -25,38 +25,124 @@ Or install it yourself as:
 gem install weneedfeed
 ```
 
-## Usage
+## Schema
+
+You need to write a schema file named with `weneedfeed.yml` to use this gem.
 
-Write schema:
+### Example
 
 ```yaml
 pages:
-  example:
-    title: example name
-    url: http://example.com/
-    xpath:
-      item: //li
-      item_description: .//p[3]
-      item_link: .//a/@href
-      item_time: .//time/@datetime
-      item_title: .//p[2]
+  - id: example1
+    title: Example feed with CSS Selector
+    url: http://example.com/1
+    item_selector: li
+    item_description_selector: p:nth-child(3)
+    item_link_selector: a
+    item_time_selector: time
+    item_title_selector: p:nth-child(2)
+  - id: example2
+    title: Example feed with XPath
+    url: http://example.com/2
+    item_selector: //li
+    item_description_selector: .//p[3]
+    item_link_selector: .//a
+    item_time_selector: .//time
+    item_title_selector: .//p[2]
 ```
 
-And then call `Weneedfeed::Capture`:
+### `id`
 
-```ruby
-require 'weneedfeed'
+Feed ID.
+
+- required
+- Used for feed URL.
+
+### `title`
+
+Feed title.
+
+- required
+- Used for RSS `<title>` element in `<channel>` element.
+
+### `url`
+
+HTML source URL.
+
+- required
+- Used to fetch HTML page for building feed.
+
+### `item_selector`
+
+CSS or XPath selector to search each item.
+
+- required
+- Equivalent unit to RSS `<item>` element.
+
+### `item_link_selector`
+
+CSS or XPath selector to find `<a>` element in each item.
+
+- required
+- Used for `<link>` in `<item>`.
+
+### `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`
+
+CSS or XPath selector to find element with description information in each item.
+
+- optional
+- Used for `<description>` in `<item>`.
+
+### `item_time_selector`
+
+CSS or XPath selector to find element with datetime information in each item.
+
+- optional
+- Used for `<pubDate>` in `<item>`. Its `datetime` attribute or its inner HTML is used to calculate datetime.
+
+## Usage
+
+### Build
+
+Run `weneedfeed build` to build static files.
+
+```
+Usage:
+  weneedfeed build --base-url=BASE_URL
+
+Options:
+  --base-url=BASE_URL          # Base URL where to locate built files. (e.g. `"https://user.github.io/repo"`)
+  [--schema-path=SCHEMA_PATH]  # Path to weneedfeed YAML schema file.
+                               # Default: weneedfeed.yml
+
+Build static files.
+```
+
+### Server
+
+Run `weneedfeed server` to run HTTP server.
+
+```
+Usage:
+  weneedfeed server
+
+Options:
+  [--schema-path=SCHEMA_PATH]  # Path to weneedfeed YAML schema file.
+                               # Default: weneedfeed.yml
 
-Weneedfeed::Capture.call(
-  base_url: 'https://user.github.io/repo',
-  schema_path: 'schema.yml'
-)
+Run HTTP server.
 ```
 
-These files will be generated:
+## GitHub Actions Integration
 
-- output/index.html
-- output/feeds/example.xml
+Use [weneedfeed-action](https://github.com/r7kamura/weneedfeed-action) for invoking weneedfeed on GitHub Actions.
 
 ## Development
 

data/exe/weneedfeed

@@ -0,0 +1,6 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'weneedfeed'
+
+Weneedfeed::Command.start(ARGV)

data/lib/weneedfeed.rb

@@ -5,9 +5,13 @@ require 'weneedfeed/version'
 module Weneedfeed
   autoload :Application, 'weneedfeed/application'
   autoload :Capture, 'weneedfeed/capture'
+  autoload :Command, 'weneedfeed/command'
   autoload :Controllers, 'weneedfeed/controllers'
+  autoload :Helpers, 'weneedfeed/helpers'
   autoload :Item, 'weneedfeed/item'
   autoload :Page, 'weneedfeed/page'
+  autoload :PageSchema, 'weneedfeed/page_schema'
+  autoload :Schema, 'weneedfeed/schema'
   autoload :Scraping, 'weneedfeed/scraping'
   autoload :Views, 'weneedfeed/views'
 end

data/lib/weneedfeed/application.rb

@@ -6,12 +6,12 @@ module Weneedfeed
   class Application < ::Hibana::Application
     route do
       get '/', to: ::Weneedfeed::Controllers::ShowTopPage, as: :top_page
-      get '/feeds/:page_name.xml', to: ::Weneedfeed::Controllers::ShowFeed, as: :feed
+      get '/feeds/:page_id.xml', to: ::Weneedfeed::Controllers::ShowFeed, as: :feed
     end
 
     # @param [Hash] schema
     def initialize(schema:)
-      @schema = schema
+      @schema = ::Weneedfeed::Schema.new(schema)
       super()
     end
 
@@ -23,8 +23,8 @@ module Weneedfeed
 
     # @return [Array<String>]
     def paths
-      ['/'] + @schema['pages'].keys.map do |page_name|
-        "/feeds/#{page_name}.xml"
+      ['/'] + @schema.page_ids.map do |page_id|
+        "/feeds/#{page_id}.xml"
       end
     end
   end

data/lib/weneedfeed/command.rb

@@ -0,0 +1,63 @@
+# frozen_string_literal: true
+
+require 'rack'
+require 'thor'
+require 'yaml'
+
+module Weneedfeed
+  class Command < ::Thor
+    class << self
+      # @note Override for thor breaking change.
+      #   See https://github.com/erikhuda/thor/issues/244.
+      def exit_on_failure?
+        true
+      end
+    end
+
+    desc(
+      'build',
+      'Build static files.'
+    )
+
+    method_option(
+      :base_url,
+      desc: 'Base URL where to locate built files. (e.g. `"https://user.github.io/repo"`)',
+      required: true,
+      type: :string
+    )
+
+    method_option(
+      :schema_path,
+      default: 'weneedfeed.yml',
+      desc: 'Path to weneedfeed YAML schema file.',
+      type: :string
+    )
+
+    # @param [String] base_url
+    # @param [String] schema_path
+    def build
+      ::Weneedfeed::Capture.call(
+        base_url: options[:base_url],
+        schema_path: options[:schema_path]
+      )
+    end
+
+    desc(
+      'server',
+      'Run HTTP server.'
+    )
+
+    method_option(
+      :schema_path,
+      default: 'weneedfeed.yml',
+      desc: 'Path to weneedfeed YAML schema file.',
+      type: :string
+    )
+
+    def server
+      schema = ::YAML.load_file(options[:schema_path])
+      application = Weneedfeed::Application.new(schema: schema)
+      ::Rack::Handler.default.run(application)
+    end
+  end
+end

data/lib/weneedfeed/controllers.rb

@@ -2,6 +2,7 @@
 
 module Weneedfeed
   module Controllers
+    autoload :Base, 'weneedfeed/controllers/base'
     autoload :ShowFeed, 'weneedfeed/controllers/show_feed'
     autoload :ShowTopPage, 'weneedfeed/controllers/show_top_page'
   end

data/lib/weneedfeed/controllers/base.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module Weneedfeed
+  module Controllers
+    class Base < ::Hibana::Controller
+      include ::Weneedfeed::Helpers::Parameters
+
+      private
+
+      # @return [Weneedfeed::Schema]
+      def schema
+        request.env['weneedfeed.schema']
+      end
+    end
+  end
+end

data/lib/weneedfeed/controllers/show_feed.rb

@@ -2,31 +2,22 @@
 
 module Weneedfeed
   module Controllers
-    class ShowFeed < ::Hibana::Controller
+    class ShowFeed < ::Weneedfeed::Controllers::Base
       def call
-        env = request.env
-        page_name = env.dig(
-          'router.params',
-          :page_name
-        )
-        properties = env.dig(
-          'weneedfeed.schema',
-          'pages',
-          page_name
-        )
-        unless properties
+        page_schema = schema.find_page_schema(path_parameters[:page_id])
+        unless page_schema
           response.status = 404
           return
         end
 
         scraping = ::Weneedfeed::Scraping.new(
-          item_description_xpath: properties['xpath']['item_description'],
-          item_link_xpath: properties['xpath']['item_link'],
-          item_time_xpath: properties['xpath']['item_time'],
-          item_title_xpath: properties['xpath']['item_title'],
-          item_xpath: properties['xpath']['item'],
-          title: properties['title'],
-          url: properties['url']
+          item_description_selector: page_schema.item_description_selector,
+          item_link_selector: page_schema.item_link_selector,
+          item_time_selector: page_schema.item_time_selector,
+          item_title_selector: page_schema.item_title_selector,
+          item_selector: page_schema.item_selector,
+          title: page_schema.title,
+          url: page_schema.url,
         )
         page = scraping.call
 

data/lib/weneedfeed/controllers/show_top_page.rb

@@ -2,16 +2,13 @@
 
 module Weneedfeed
   module Controllers
-    class ShowTopPage < ::Hibana::Controller
+    class ShowTopPage < ::Weneedfeed::Controllers::Base
       def call
-        pages = request.env.dig(
-          'weneedfeed.schema',
-          'pages'
-        )
+        page_schemata = schema.page_schemata.sort_by(&:title)
         response.content_type = 'text/html'
         response.write(
           ::Weneedfeed::Views::ShowTopPage.new(
-            pages: pages,
+            page_schemata: page_schemata,
             partial_template_path: ::File.expand_path(
               'templates/show_top_page.html.erb',
               "#{__dir__}/../../.."

data/lib/weneedfeed/helpers.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module Weneedfeed
+  module Helpers
+    autoload :Parameters, 'weneedfeed/helpers/parameters'
+  end
+end

data/lib/weneedfeed/helpers/parameters.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module Weneedfeed
+  module Helpers
+    module Parameters
+      private
+
+      # @return [Hash]
+      def path_parameters
+        request.env['router.params']
+      end
+    end
+  end
+end

data/lib/weneedfeed/item.rb

@@ -15,56 +15,71 @@ module Weneedfeed
       end
     end
 
-    # @param [String] description_xpath
-    # @param [String] link_xpath
+    # @param [String, nil] description_selector
+    # @param [String, nil] link_selector
     # @param [Nokogiri::Node] node
-    # @param [String] time_xpath
-    # @param [String] title_xpath
+    # @param [String] time_selector
+    # @param [String] title_selector
     # @param [String] url
     def initialize(
-      description_xpath:,
-      link_xpath:,
+      description_selector:,
+      link_selector:,
       node:,
-      time_xpath:,
-      title_xpath:,
+      time_selector:,
+      title_selector:,
       url:
     )
-      @description_xpath = description_xpath
-      @link_xpath = link_xpath
+      @description_selector = description_selector
+      @link_selector = link_selector
       @node = node
-      @time_xpath = time_xpath
-      @title_xpath = title_xpath
+      @time_selector = time_selector
+      @title_selector = title_selector
       @url = url
     end
 
     # @return [String, nil]
     def description
-      @node.xpath(@description_xpath).inner_html
+      return unless @description_selector
+
+      @node.at(@description_selector)&.inner_html
     end
 
     # @return [String]
     def link
       ::URI.join(
         @url,
-        @node.xpath(@link_xpath).inner_html
+        @node.at(@link_selector)['href']
       ).to_s
     end
 
     # @return [Time, nil]
     def time
-      self.class.parse_time(time_string)
+      return unless @time_selector
+
+      string = time_string
+      return unless string
+
+      self.class.parse_time(string)
     end
 
-    # @return [String, nil]
+    # @return [String]
     def title
-      @node.xpath(@title_xpath).inner_text
+      @node.at(@title_selector).inner_text
     end
 
     private
 
-    # @return [String]
+    # @return [Nokogiri::Node, nil]
+    def time_node
+      @node.at(@time_selector)
+    end
+
+    # @return [String, nil]
     def time_string
-      @node.xpath(@time_xpath).inner_html
+      node = time_node
+      return unless node
+
+      node['datetime'] || node.inner_html
     end
   end
 end

data/lib/weneedfeed/page.rb

@@ -8,29 +8,29 @@ module Weneedfeed
     # @return [String]
     attr_reader :url
 
-    # @param [String] item_description_xpath
-    # @param [String] item_link_xpath
-    # @param [String] item_time_xpath
-    # @param [String] item_title_xpath
-    # @param [String] item_xpath
+    # @param [String, nil] item_description_selector
+    # @param [String] item_link_selector
+    # @param [String, nil] item_time_selector
+    # @param [String] item_title_selector
+    # @param [String] item_selector
     # @param [Nokogiri::Node] node
     # @param [String] title
     # @param [String] url
     def initialize(
-      item_description_xpath:,
-      item_link_xpath:,
-      item_time_xpath:,
-      item_title_xpath:,
-      item_xpath:,
+      item_description_selector:,
+      item_link_selector:,
+      item_time_selector:,
+      item_title_selector:,
+      item_selector:,
       node:,
       title:,
       url:
     )
-      @item_description_xpath = item_description_xpath
-      @item_link_xpath = item_link_xpath
-      @item_time_xpath = item_time_xpath
-      @item_title_xpath = item_title_xpath
-      @item_xpath = item_xpath
+      @item_description_selector = item_description_selector
+      @item_link_selector = item_link_selector
+      @item_time_selector = item_time_selector
+      @item_title_selector = item_title_selector
+      @item_selector = item_selector
       @node = node
       @title = title
       @url = url
@@ -38,13 +38,13 @@ module Weneedfeed
 
     # @return [Array<Weneedfeed::Item>]
     def items
-      @node.xpath(@item_xpath).map do |node|
+      @node.search(@item_selector).map do |node|
         ::Weneedfeed::Item.new(
-          description_xpath: @item_description_xpath,
-          link_xpath: @item_link_xpath,
+          description_selector: @item_description_selector,
+          link_selector: @item_link_selector,
           node: node,
-          time_xpath: @item_time_xpath,
-          title_xpath: @item_title_xpath,
+          time_selector: @item_time_selector,
+          title_selector: @item_title_selector,
           url: @url
         )
       end

data/lib/weneedfeed/page_schema.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module Weneedfeed
+  PageSchema = Struct.new(
+    :id,
+    :item_description_selector,
+    :item_link_selector,
+    :item_time_selector,
+    :item_title_selector,
+    :item_selector,
+    :title,
+    :url,
+    keyword_init: true,
+  )
+end

data/lib/weneedfeed/schema.rb

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+module Weneedfeed
+  class Schema
+    # @param [Hash] raw
+    def initialize(raw)
+      @raw = raw
+    end
+
+    # @param [String, nl] page_schema_id
+    # @return [Weneedfeed::PageSchema]
+    def find_page_schema(page_schema_id)
+      page_schemata.find do |page_schema|
+        page_schema.id == page_schema_id
+      end
+    end
+
+    # @return [Array<String>]
+    def page_ids
+      page_schemata.map(&:id)
+    end
+
+    # @return [Array<Weneedfeed::PageSchema>]
+    def page_schemata
+      @raw['pages'].map do |hash|
+        ::Weneedfeed::PageSchema.new(
+          id: hash['id'],
+          item_link_selector: hash['item_link_selector'],
+          item_time_selector: hash['item_time_selector'],
+          item_title_selector: hash['item_title_selector'],
+          item_selector: hash['item_selector'],
+          title: hash['title'],
+          url: hash['url'],
+        )
+      end
+    end
+  end
+end

data/lib/weneedfeed/scraping.rb

@@ -5,27 +5,27 @@ require 'nokogiri'
 
 module Weneedfeed
   class Scraping
-    # @param [String] item_description_xpath
-    # @param [String] item_link_xpath
-    # @param [String] item_time_xpath
-    # @param [String] item_title_xpath
-    # @param [String] item_xpath
+    # @param [String, nil] item_description_selector
+    # @param [String] item_link_selector
+    # @param [String, nil] item_time_selector
+    # @param [String] item_title_selector
+    # @param [String] item_selector
     # @param [String] title
     # @param [String] url
     def initialize(
-      item_description_xpath:,
-      item_link_xpath:,
-      item_time_xpath:,
-      item_title_xpath:,
-      item_xpath:,
+      item_description_selector:,
+      item_link_selector:,
+      item_time_selector:,
+      item_title_selector:,
+      item_selector:,
       title:,
       url:
     )
-      @item_description_xpath = item_description_xpath
-      @item_link_xpath = item_link_xpath
-      @item_time_xpath = item_time_xpath
-      @item_title_xpath = item_title_xpath
-      @item_xpath = item_xpath
+      @item_description_selector = item_description_selector
+      @item_link_selector = item_link_selector
+      @item_time_selector = item_time_selector
+      @item_title_selector = item_title_selector
+      @item_selector = item_selector
       @title = title
       @url = url
     end
@@ -34,11 +34,11 @@ module Weneedfeed
     def call
       ::Weneedfeed::Page.new(
         node: parsed_body,
-        item_description_xpath: @item_description_xpath,
-        item_xpath: @item_xpath,
-        item_link_xpath: @item_link_xpath,
-        item_time_xpath: @item_time_xpath,
-        item_title_xpath: @item_title_xpath,
+        item_description_selector: @item_description_selector,
+        item_selector: @item_selector,
+        item_link_selector: @item_link_selector,
+        item_time_selector: @item_time_selector,
+        item_title_selector: @item_title_selector,
         title: @title,
         url: @url
       )

data/lib/weneedfeed/version.rb

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

data/lib/weneedfeed/views/show_feed.rb

@@ -3,6 +3,8 @@
 module Weneedfeed
   module Views
     class ShowFeed < ::Hibana::View
+      include ::Weneedfeed::Helpers::Parameters
+
       # @param [Weneedfeed::Page] page
       def initialize(page:, **argv)
         super(**argv)
@@ -11,6 +13,11 @@ module Weneedfeed
 
       private
 
+      # @return [String]
+      def top_page_path
+        request.path.delete_suffix(router.path(:feed, page_id: page_id))
+      end
+
       # @return [Enumerable<Weneedfeed::Item>]
       def items
         @page.items.sort_by do |item|
@@ -19,8 +26,13 @@ module Weneedfeed
       end
 
       # @return [String]
-      def page_name
-        request.env['router.params'][:page_name]
+      def page_id
+        path_parameters[:page_id]
+      end
+
+      # @return [Hanami::Router]
+      def router
+        ::Weneedfeed::Application.router
       end
     end
   end

data/lib/weneedfeed/views/show_top_page.rb

@@ -3,10 +3,10 @@
 module Weneedfeed
   module Views
     class ShowTopPage < ::Hibana::View
-      # @param [Array<Weneedfeed::Page>] pages
-      def initialize(pages:, **argv)
+      # @param [Array<Hash>] page_schemata
+      def initialize(page_schemata:, **argv)
         super(**argv)
-        @pages = pages
+        @page_schemata = page_schemata
       end
 
       private
@@ -16,10 +16,10 @@ module Weneedfeed
         request.path.delete_suffix(router.path(:top_page))
       end
 
-      # @param [String] page_name
+      # @param [String] page_id
       # @return [String]
-      def feed_path(page_name:)
-        "#{base_path}#{router.path(:feed, page_name: page_name)}"
+      def feed_path(page_id:)
+        "#{base_path}#{router.path(:feed, page_id: page_id)}"
       end
 
       # @return [Hanami::Router]

data/templates/show_feed.xml.erb

@@ -3,16 +3,19 @@
   xmlns:atom="http://www.w3.org/2005/Atom"
   xmlns:content="http://purl.org/rss/1.0/modules/content/">
   <channel>
-    <description></description>
-    <link><%= "#{request.base_url}#{request.path}" %></link>
+    <title><![CDATA[<%= @page.title %>]]></title>
+    <link><%= "#{request.base_url}#{top_page_path}" %></link>
     <atom:link href="<%= "#{request.base_url}#{request.path}" %>" rel="self"/>
-    <title><%= @page.title %></title>
+    <description><![CDATA[Recent content on <%= @page.title %>]]></description>
     <lastBuildDate><%= Time.now.rfc822 %></lastBuildDate>
     <% items.each do |item| %>
     <item>
       <title><![CDATA[<%= item.title %>]]></title>
       <link><%= item.link %></link>
-      <pubDate><%= item.time.rfc822 %></pubDate>
+      <% if item.time %>
+        <pubDate><%= item.time.rfc822 %></pubDate>
+      <% end %>
+      <description><![CDATA[<%= item.description %>]]></description>
       <content:encoded><![CDATA[<%= item.description %>]]></content:encoded>
       <guid isPermaLink="true"><%= item.link %></guid>
     </item>

data/templates/show_top_page.html.erb

@@ -7,9 +7,9 @@
   </head>
   <body>
     <ul>
-      <% @pages.each do |page_name, hash| %>
+      <% @page_schemata.each do |page_schema| %>
       <li>
-        <a href="<%= feed_path(page_name: page_name) %>"><%= hash['title'] %></a>
+        <a href="<%= feed_path(page_id: page_schema.id) %>"><%= page_schema.title %></a>
       </li>
       <% end %>
     </ul>

data/weneedfeed.gemspec

@@ -8,7 +8,7 @@ Gem::Specification.new do |spec|
   spec.authors       = ['Ryo Nakamura']
   spec.email         = ['r7kamura@gmail.com']
 
-  spec.summary       = 'Generate feeds from URL and XPath.'
+  spec.summary       = 'Generate feeds from URL and selectors.'
   spec.homepage      = 'https://github.com/r7kamura/weneedfeed'
   spec.license       = 'MIT'
   spec.required_ruby_version = Gem::Requirement.new('>= 2.5.0')
@@ -21,10 +21,14 @@ Gem::Specification.new do |spec|
   spec.files = Dir.chdir(File.expand_path(__dir__)) do
     `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
   end
+  spec.bindir = 'exe'
+  spec.executables = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ['lib']
 
   spec.add_runtime_dependency 'faraday'
+  spec.add_runtime_dependency 'hanami-router', '2.0.0.alpha3'
   spec.add_runtime_dependency 'hibana'
   spec.add_runtime_dependency 'nokogiri'
   spec.add_runtime_dependency 'rack-capture', '>= 0.4.0'
+  spec.add_runtime_dependency 'thor'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: weneedfeed
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.6.0
 platform: ruby
 authors:
 - Ryo Nakamura
 autorequire: 
-bindir: bin
+bindir: exe
 cert_chain: []
-date: 2020-11-07 00:00:00.000000000 Z
+date: 2020-11-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -24,6 +24,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: hanami-router
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 2.0.0.alpha3
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 2.0.0.alpha3
 - !ruby/object:Gem::Dependency
   name: hibana
   requirement: !ruby/object:Gem::Requirement
@@ -66,10 +80,25 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 0.4.0
+- !ruby/object:Gem::Dependency
+  name: thor
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: 
 email:
 - r7kamura@gmail.com
-executables: []
+executables:
+- weneedfeed
 extensions: []
 extra_rdoc_files: []
 files:
@@ -85,14 +114,21 @@ files:
 - Rakefile
 - bin/console
 - bin/setup
+- exe/weneedfeed
 - lib/weneedfeed.rb
 - lib/weneedfeed/application.rb
 - lib/weneedfeed/capture.rb
+- lib/weneedfeed/command.rb
 - lib/weneedfeed/controllers.rb
+- lib/weneedfeed/controllers/base.rb
 - lib/weneedfeed/controllers/show_feed.rb
 - lib/weneedfeed/controllers/show_top_page.rb
+- lib/weneedfeed/helpers.rb
+- lib/weneedfeed/helpers/parameters.rb
 - lib/weneedfeed/item.rb
 - lib/weneedfeed/page.rb
+- lib/weneedfeed/page_schema.rb
+- lib/weneedfeed/schema.rb
 - lib/weneedfeed/scraping.rb
 - lib/weneedfeed/version.rb
 - lib/weneedfeed/views.rb
@@ -125,5 +161,5 @@ requirements: []
 rubygems_version: 3.1.2
 signing_key: 
 specification_version: 4
-summary: Generate feeds from URL and XPath.
+summary: Generate feeds from URL and selectors.
 test_files: []