weneedfeed 0.4.1 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ecf62208b1e01240706300879ec4b276f29f53a4ae638ee317c738e6ed6e4f21
-  data.tar.gz: 4e8e892bbcbfcbe36b6c621a7bb964eee8898b71c865367cf13e42c19cf5d032
+  metadata.gz: 0fdaa4a0f724b7018d6b1b2b585aeaf970eff37538df7ca7aaf760fc217b56dc
+  data.tar.gz: 9f34a11d59aaada2d5afd689263f722c0143af5e59b9741e7d6f34d16d807c57
 SHA512:
-  metadata.gz: d9af62e115d6e06561968497d555ecfaa779bec8f22ba5397a55de7306ce697be2e4e2adffbab324b122e888215b7d10b57ccc7193ea19fb4bc33ca2291af203
-  data.tar.gz: 52359b481eee6b05d7afba4d4aa33b0a584716f3c38cc0222aa568f842cc4b8d02ba57722cb469bf9649b07726cbdd5de70b6e53be1cf958e711d1c64dff28eb
+  metadata.gz: 878189a82437b83ed25d0c25c5a6de0f4b840c1daf117ccd83d31be1ecbbe2db0d97289bd5ab93e327508562843ddea253948cad63324d3557ab28a0d5052268
+  data.tar.gz: 8c56392e937c331456b44c869a96316c892b5321fd85611325c91c3987de079d101144998a4399f4fa668c46181e3f0c51f79fe157bf333d211fcf5ae0aeec87

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/CHANGELOG.md

@@ -7,6 +7,16 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## Unreleased
 
+## 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

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    weneedfeed (0.4.1)
+    weneedfeed (0.5.0)
       faraday
       hibana
       nokogiri

data/README.md

@@ -25,34 +25,62 @@ Or install it yourself as:
 gem install weneedfeed
 ```
 
-## Usage
+## Schema
 
-### Schema
+You need to write a schema file named with `weneedfeed.yml` to use this gem.
 
-Write `weneedfeed.yml`.
+### Example
 
 ```yaml
 pages:
   example1:
     title: example site 1
     url: http://example.com/1
-    selectors:
-      item: li
-      item_description: p:nth-child(3)
-      item_link: a
-      item_time: time[datetime]
-      item_title: p:nth-child(2)
+    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)
   example2:
     title: example site 2
     url: http://example.com/2
-    selectors:
-      item: //li
-      item_description: .//p[3]
-      item_link: .//a/@href
-      item_time: .//time/@datetime
-      item_title: .//p[2]
+    item_selector: //li
+    item_description_selector: .//p[3]
+    item_link_selector: .//a/@href
+    item_time_selector: .//time
+    item_title_selector: .//p[2]
 ```
 
+### `title`
+
+Feed title, used for RSS `<title>` element in `<channel>` element.
+
+### `url`
+
+URL to fetch HTML page for building feed.
+
+### `item_selector`
+
+CSS or XPath selector to search each item, equivalent unit to RSS `<item>` element.
+
+### `item_link_selector`
+
+CSS or XPath selector to find `<a>` element in each item, used for `<link>` in `<item>`.
+
+### `item_time_selector`
+
+CSS or XPath selector to find element with datetime information in each item, used for `<pubDate>` in `<item>`. Its `datetime` attribute or its inner HTML is used to calculate datetime.
+
+### `item_title_selector`
+
+CSS or XPath selector to find element with title information in each item, used for `<pubDate>` in `<item>`.
+
+### `item_description_selector`
+
+CSS or XPath selector to find element with description information in each item, used for `<description>` in `<item>`.
+
+## Usage
+
 ### Build
 
 Run `weneedfeed build` to build static files.

data/lib/weneedfeed/controllers/show_feed.rb

@@ -20,11 +20,11 @@ module Weneedfeed
         end
 
         scraping = ::Weneedfeed::Scraping.new(
-          item_description_selector: properties['selectors']['item_description'],
-          item_link_selector: properties['selectors']['item_link'],
-          item_time_selector: properties['selectors']['item_time'],
-          item_title_selector: properties['selectors']['item_title'],
-          item_selector: properties['selectors']['item'],
+          item_description_selector: properties['item_description_selector'],
+          item_link_selector: properties['item_link_selector'],
+          item_time_selector: properties['item_time_selector'],
+          item_title_selector: properties['item_title_selector'],
+          item_selector: properties['item_selector'],
           title: properties['title'],
           url: properties['url']
         )

data/lib/weneedfeed/item.rb

@@ -62,9 +62,17 @@ module Weneedfeed
 
     private
 
+    # @return [Nokogiri::Node, nil]
+    def time_node
+      @node.at(@time_selector)
+    end
+
     # @return [String]
     def time_string
-      @node.at(@time_selector).inner_html
+      node = time_node
+      return unless node
+
+      node['datetime'] || node.inner_html
     end
   end
 end

data/lib/weneedfeed/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: weneedfeed
 version: !ruby/object:Gem::Version
-  version: 0.4.1
+  version: 0.5.0
 platform: ruby
 authors:
 - Ryo Nakamura
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-11-08 00:00:00.000000000 Z
+date: 2020-11-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday