weneedfeed 0.3.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b201152f3a5b05f2c336caf0ba02416eea09da02834a46818dc00c86596ee0d3
-  data.tar.gz: 0fc63fe70919ac5284297c309545d0d1ea3a3253166d36f434bb6b598aa92721
+  metadata.gz: adfe67e7ae534a35ab0e8c7ae33272c9046187564304700e7b6eec52dd671d03
+  data.tar.gz: f4081b96371d71f0833ae6bf16e63d2719e4d341c9d23f8e17ab543f538ba6ac
 SHA512:
-  metadata.gz: a318105d868fc4ca2b91a03541feffde8bb1af257b4c3126716c2988f21703f7ee87699183ab0d8f3ab67d111008af9485ee4e219d464ef618e459b5a8b8fc1e
-  data.tar.gz: 726e20a19227146a81a309b32837396753a1fe572fe1ec6fd8ce44767dab61ebc337ccaa5af53d8d1449ba987bcefd76d6486db3988f4c95bd8d316f2440fd57
+  metadata.gz: e58d4b58d0813ecdbe5c995acbf8e4a2b55c3598fb81967b0a169fcdb72ebc7ee6717bd39fcc95c043b88345cb6396f2221aa507a0cae2a0a07b1936f3442751
+  data.tar.gz: b521aba54d499732ec09fc93de7d77ed642de53aaf828f49683b5f66c3616c781ed79675fbfb0df7a6aca4854897f57c92d2da09c0ad0f375bab12f71cdff7dd

data/CHANGELOG.md

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

data/Gemfile.lock

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

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
 
@@ -27,14 +27,25 @@ gem install weneedfeed
 
 ## Usage
 
-Write schema:
+### Schema
+
+Write `weneedfeed.yml`.
 
 ```yaml
 pages:
-  example:
-    title: example name
-    url: http://example.com/
-    xpath:
+  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)
+  example2:
+    title: example site 2
+    url: http://example.com/2
+    selectors:
       item: //li
       item_description: .//p[3]
       item_link: .//a/@href
@@ -42,21 +53,40 @@ pages:
       item_title: .//p[2]
 ```
 
-And then call `Weneedfeed::Capture`:
+### Build
 
-```ruby
-require 'weneedfeed'
+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/lib/weneedfeed/command.rb

@@ -16,7 +16,7 @@ module Weneedfeed
 
     desc(
       'build',
-      'Build static files for feeds.'
+      'Build static files.'
     )
 
     method_option(
@@ -44,7 +44,7 @@ module Weneedfeed
 
     desc(
       'server',
-      'Run HTTP server'
+      'Run HTTP server.'
     )
 
     method_option(

data/lib/weneedfeed/controllers/show_feed.rb

@@ -20,11 +20,11 @@ module Weneedfeed
         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'],
+          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'],
           title: properties['title'],
           url: properties['url']
         )

data/lib/weneedfeed/controllers/show_top_page.rb

@@ -7,7 +7,9 @@ module Weneedfeed
         pages = request.env.dig(
           'weneedfeed.schema',
           'pages'
-        )
+        ).sort_by do |_key, value|
+          value['title']
+        end
         response.content_type = 'text/html'
         response.write(
           ::Weneedfeed::Views::ShowTopPage.new(

data/lib/weneedfeed/item.rb

@@ -15,38 +15,38 @@ module Weneedfeed
       end
     end
 
-    # @param [String] description_xpath
-    # @param [String] link_xpath
+    # @param [String] description_selector
+    # @param [String] 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
+      @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
 
@@ -57,14 +57,14 @@ module Weneedfeed
 
     # @return [String, nil]
     def title
-      @node.xpath(@title_xpath).inner_text
+      @node.at(@title_selector).inner_text
     end
 
     private
 
     # @return [String]
     def time_string
-      @node.xpath(@time_xpath).inner_html
+      @node.at(@time_selector).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] item_description_selector
+    # @param [String] item_link_selector
+    # @param [String] 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/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] item_description_selector
+    # @param [String] item_link_selector
+    # @param [String] 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.3.0'
+  VERSION = '0.4.0'
 end

data/lib/weneedfeed/views/show_feed.rb

@@ -11,6 +11,11 @@ module Weneedfeed
 
       private
 
+      # @return [String]
+      def top_page_path
+        request.path.delete_suffix(router.path(:feed, page_name: page_name))
+      end
+
       # @return [Enumerable<Weneedfeed::Item>]
       def items
         @page.items.sort_by do |item|
@@ -22,6 +27,11 @@ module Weneedfeed
       def page_name
         request.env['router.params'][:page_name]
       end
+
+      # @return [Hanami::Router]
+      def router
+        ::Weneedfeed::Application.router
+      end
     end
   end
 end

data/templates/show_feed.xml.erb

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

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')

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: weneedfeed
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.4.0
 platform: ruby
 authors:
 - Ryo Nakamura
@@ -142,5 +142,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: []