feedstock 0.3.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b478a8e9dd24f3ac78e99189c959b247828f7a2980a979cc320a3b6f8c5306d1
-  data.tar.gz: 957fb142e5abef9289ca92f40ecf6f7425106a40271da4967c80c27f2b69c4eb
+  metadata.gz: f1a02c229edb1b2d7c98904d6263aab47cfe5ef4d605c5a3c78ec412c1bb2083
+  data.tar.gz: f0c35d3a675eeb01cbbc73952b85f484df631459a1542161d2b198b8c3b1ccf8
 SHA512:
-  metadata.gz: '0895e3a795d26151fc74a79107e0873afe8f0d99fe955cc4fffd94342d335075852ae71abbbfc61d47a637fc06e00c73c17f0ad023e7a712e2dd5e015e393554'
-  data.tar.gz: b4ef2dbf847a910813d4187b71208c50f773613cca75173152ed6f9343b3de220c98917aa074060851c89e72433f14866cf16539cf357725f8f3c5587d406062
+  metadata.gz: b31805cfc5c8aedaabf286f2a76b269df4883daf24850121a94edb349a219c1d7177e161df20a434d07b17eed3bd129c7529d94093559fc5520fe19bc0dc2b45
+  data.tar.gz: b47eac95bda32a4a5a7a7a4a904d4baeb6b1055a18e39f09d1d2ed38c1c7b0a6ab9d0672db4f614b210d5bb1969afbd3de962292d6ccf750895e00f6a4b13d6c

data/README.md

@@ -28,7 +28,7 @@ template but you can use your own, too.
 The [feeds.inqk.net repository][example] includes an example of how the
 Feedstock library can be used in practice.
 
-[example]: https://github.com/pyrmont/feeds.inqk.net/tree/4a95a438f8d3a707db7946238181ab76c029ee77/src/input
+[example]: https://github.com/pyrmont/feeds.inqk.net/
 "An example of using the Feedstock library"
 
 ## Installation
@@ -51,17 +51,17 @@ url = "https://example.org"
 
 # Define the rules
 rules = { info: { id: url,
-                  title: "div.title",
-                  updated: "span.date" },
-          entries: "div.story",
-          entry: { id: { path: "a",
-                         content: { attribute: "href" } },
-                   title: "h2",
-                   updated: "span.date",
-                   author: "span.byline",
-                   link: { path: "a",
-                           content: { attribute: "href" } },
-                   summary: "div.summary" } }
+                  title: Feedstock::Extract.new(selector: "div.title"),
+                  updated: Feedstock::Extract.new(selector: "span.date") },
+
+          entry: { id: Feedstock::Extract.new(selector: "a", content: { attribute: "href" }),
+                   title: Feedstock::Extract.new(selector: "h2"),
+                   updated: Feedstock::Extract.new(selector: "span.date"),
+                   author: Feedstock::Extract.new(selector: "span.byline"),
+                   link: Feedstock::Extract.new(selector: "a", content: { attribute: "href" }),
+                   summary: Feedstock::Extract.new(selector: "div.summary") },
+
+          entries: Feedstock::Extract.new(selector: "div.story") }
 
 # Using the default format and template
 Feedstock.feed url, rules

data/lib/feedstock/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Feedstock
-  VERSION = "0.3.0"
+  VERSION = "0.4.0"
 end

data/lib/feedstock.rb

@@ -6,14 +6,22 @@ require "open-uri"
 require "timeliness"
 
 module Feedstock
+  class Extract < Struct.new("Extract", :selector, :absolute, :content, :processor, :prefix,
+                             :suffix, :type, :filter, keyword_init: true); end
+
   class << self
-    def feed(url, rules, format = :html, template_file = "#{__dir__}/../default.xml")
+    def data(url, rules, format = :html)
       page    = download_page url, format
-      rules   = normalise_rules rules
 
       info    = extract_info page, rules
       entries = extract_entries page, rules
 
+      { info: info, entries: entries }
+    end
+
+    def feed(url, rules, format = :html, template_file = "#{__dir__}/../default.xml")
+      info, entries = data(url, rules, format).values_at(:info, :entries)
+
       create_feed info, entries, template_file
     end
 
@@ -34,7 +42,7 @@ module Feedstock
     end
 
     private def extract_content(node, rule)
-      case rule[:content]
+      case rule.content
       in { attribute: attribute }
         node[attribute]
       in "inner_html"
@@ -59,12 +67,12 @@ module Feedstock
       entries = Array.new
 
       rules[:entry].each do |name, rule|
-        if rule[:literal]
-          static[name.to_s] = rule[:literal]
-        elsif rule[:repeat]
-          static[name.to_s] = format_content page.at_css(rule[:path]), rule
+        if rule.is_a? String
+          static[name.to_s] = rule
+        elsif rule.absolute
+          static[name.to_s] = format_content page.at_css(rule.selector), rule
         else
-          page.css(rule[:path]).each.with_index do |match, i|
+          page.css(rule.selector).each.with_index do |match, i|
             entries[i] = Hash.new if entries[i].nil?
             entries[i].merge!({ name.to_s => format_content(match, rule) })
           end
@@ -81,16 +89,18 @@ module Feedstock
     private def extract_entries_wrapped(page, rules)
       entries = Array.new
 
-      page.css(rules[:entries][:path]).each.with_index do |node, i|
+      page.css(rules[:entries].selector).each.with_index do |parent, i|
         rules[:entry].each do |name, rule|
           entries[i] = Hash.new if entries[i].nil?
 
-          content = if rule[:literal]
-                      rule[:literal]
-                    elsif rule[:repeat]
-                      format_content page.at_css(rule[:path]), rule
+          content = if rule.is_a? String
+                      rule
+                    elsif rule.absolute
+                      format_content page.at_css(rule.selector), rule
+                    elsif rule.selector.empty?
+                      format_content parent, rule
                     else
-                      format_content node.at_css(rule[:path]), rule
+                      format_content parent.at_css(rule.selector), rule
                     end
 
           entries[i].merge!({ name.to_s => content })
@@ -98,19 +108,19 @@ module Feedstock
       end
 
 
-      return entries unless rules[:entries][:filter].is_a? Proc
+      return entries unless rules[:entries].filter.is_a? Proc
 
-      entries.filter(&rules[:entries][:filter])
+      entries.filter(&rules[:entries].filter)
     end
 
     private def extract_info(page, rules)
       info = Hash.new
 
       rules[:info].each do |name, rule|
-        if rule[:literal]
-          info[name.to_s] = rule[:literal]
+        if rule.is_a? String
+          info[name.to_s] = rule
         else
-          info[name.to_s] = format_content page.at_css(rule[:path]), rule
+          info[name.to_s] = format_content page.at_css(rule.selector), rule
         end
       end
 
@@ -124,7 +134,7 @@ module Feedstock
       processed = process_content text, rule
       wrapped   = wrap_content processed, rule
 
-      case rule[:type]
+      case rule.type
       when "cdata"
         "<![CDATA[#{wrapped}]]>"
       when "datetime"
@@ -134,34 +144,18 @@ module Feedstock
       end
     end
 
-    private def normalise_rules(rules)
-      rules.keys.each do |category|
-        case category
-        when :info, :entry
-          rules[category].each do |name, rule|
-            rules[category][name] = { :path => rule } unless rule.is_a? Hash
-          end
-        when :entries
-          rule = rules[category]
-          rules[category] = { :path => rule } unless rule.is_a? Hash
-        end
-      end
-
-      rules
-    end
-
     private def process_content(content, rule)
-      if rule[:processor]
-        rule[:processor].call content, rule
+      if rule.processor
+        rule.processor.call content, rule
       else
         content
       end
     end
 
     private def wrap_content(content, rule)
-      return content unless rule[:prepend] || rule[:append]
+      return content unless (rule.prefix || rule.suffix)
 
-      "#{rule[:prepend]}#{content}#{rule[:append]}"
+      "#{rule.prefix}#{content}#{rule.suffix}"
     end
   end
 end

metadata

@@ -1,14 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: feedstock
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.4.0
 platform: ruby
 authors:
 - Michael Camilleri
-autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-02-06 00:00:00.000000000 Z
+date: 2025-02-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: nokogiri
@@ -101,7 +100,6 @@ licenses:
 metadata:
   documentation_uri: https://github.com/pyrmont/feedstock/blob/v0.3.0/api.md
   allowed_push_host: https://rubygems.org
-post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
@@ -116,8 +114,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.3
-signing_key: 
+rubygems_version: 3.6.2
 specification_version: 4
 summary: A library for creating RSS feeds from webpages
 test_files: []