html2rss 0.17.0 → 0.19.0

data/lib/html2rss.rb

@@ -3,11 +3,10 @@
 require 'zeitwerk'
 
 loader = Zeitwerk::Loader.for_gem
+loader.inflector.inflect('cli' => 'CLI')
 loader.setup
 
-require 'addressable'
 require 'logger'
-require 'yaml'
 
 ##
 # The Html2rss namespace.
@@ -23,90 +22,87 @@ module Html2rss
   end
 
   ##
-  # The Html2rss::Error base class.
-  class Error < StandardError; end
-
-  ##
-  # Key for the feeds configuration in the YAML file.
-  CONFIG_KEY_FEEDS = :feeds
-
-  ##
-  # Returns an RSS object generated from the provided YAML file configuration.
-  #
-  # Example:
-  #
-  #    feed = Html2rss.feed_from_yaml_config(File.join(['spec', 'config.test.yml']), 'nuxt-releases')
-  #    # => #<RSS::Rss:0x00007fb2f6331228
+  # Loads a feed configuration from YAML.
   #
-  # @param file [String] Path to the YAML file.
-  # @param name [String, Symbol, nil] Name of the feed in the YAML file.
-  # @param global_config [Hash] Global options (e.g., HTTP headers).
-  # @param params [Hash] Dynamic parameters for the feed configuration.
-  # @return [RSS::Rss] RSS object generated from the configuration.
-  def self.feed_from_yaml_config(file, name = nil, global_config: {}, params: {})
-    yaml = YAML.safe_load_file(file, symbolize_names: true)
-    feeds = yaml[CONFIG_KEY_FEEDS] || {}
-
-    feed_config = find_feed_config(yaml, feeds, name, global_config)
-
-    feed(Config.new(feed_config, global_config, params))
+  # @param file [String] path to the YAML file
+  # @param feed_name [String, nil] optional feed name inside a multi-feed config
+  # @return [Hash{Symbol => Object}] loaded configuration hash
+  def self.config_from_yaml_file(file, feed_name = nil)
+    Config.load_yaml(file, feed_name)
   end
 
   ##
   # Returns an RSS object generated from the provided configuration.
   #
-  # Example:
-  #
-  #    feed = Html2rss.feed(
-  #      channel: { name: 'StackOverflow: Hot Network Questions', url: 'https://stackoverflow.com' },
-  #      selectors: {
-  #        items: { selector: '#hot-network-questions > ul > li' },
-  #        title: { selector: 'a' },
-  #        link: { selector: 'a', extractor: 'href' }
-  #      }
-  #    )
-  #    # => #<RSS::Rss:0x00007fb2f48d14a0 ...>
-  #
-  # @param config [Hash<Symbol, Object>, Html2rss::Config] Feed configuration.
-  # @return [RSS::Rss] RSS object generated from the configuration.
-  def self.feed(config)
-    config = Config.new(config) unless config.is_a?(Config)
-    RssBuilder.build(config)
+  # @param raw_config [Hash{Symbol => Object}] feed configuration
+  # @return [RSS::Rss] generated RSS feed
+  def self.feed(raw_config)
+    FeedPipeline.new(raw_config).to_rss
   end
 
   ##
-  # Builds the feed configuration based on the provided parameters.
+  # Returns a JSONFeed 1.1 hash generated from the provided configuration.
   #
-  # @param yaml [Hash] Parsed YAML content.
-  # @param feeds [Hash] Feeds from the YAML content.
-  # @param feed_name [String, Symbol, nil] Name of the feed in the YAML file.
-  # @param global_config [Hash] Global options (e.g., HTTP headers).
-  # @return [Hash] Feed configuration.
-  def self.find_feed_config(yaml, feeds, feed_name, global_config)
-    return yaml unless feed_name
-
-    feed_name = feed_name.to_sym
-    if feeds.key?(feed_name)
-      global_config.merge!(yaml.reject { |key| key == CONFIG_KEY_FEEDS })
-      feeds[feed_name]
-    else
-      yaml
-    end
+  # @param raw_config [Hash{Symbol => Object}] feed configuration
+  # @return [Hash] JSONFeed-compliant hash
+  def self.json_feed(raw_config)
+    FeedPipeline.new(raw_config).to_json_feed
   end
 
   ##
   # Scrapes the provided URL and returns an RSS object.
-  # No need for a "feed config".
   #
-  # @param url [String] the URL to automatically source the feed from
-  # @param strategy [Symbol] the request strategy to use
-  # @return [RSS::Rss]
-  def self.auto_source(url, strategy: :faraday)
-    ctx = RequestService::Context.new(url:, headers: {})
-    response = RequestService.execute(ctx, strategy:)
-
-    Html2rss::AutoSource.new(ctx.url, body: response.body, headers: response.headers).build
+  # @param url [String] source page URL
+  # @param strategy [Symbol] request strategy to use
+  # @param items_selector [String, nil] optional selector hint for item extraction
+  # @param max_redirects [Integer, nil] optional redirect limit override
+  # @param max_requests [Integer, nil] optional request budget override
+  # @return [RSS::Rss] generated RSS feed
+  def self.auto_source(url, strategy: :auto, items_selector: nil, max_redirects: nil, max_requests: nil)
+    feed(build_auto_source_config(url:, strategy:, items_selector:, max_redirects:, max_requests:))
   end
 
-  private_class_method :find_feed_config
+  ##
+  # Scrapes the provided URL and returns a JSONFeed 1.1 hash.
+  #
+  # @param url [String] source page URL
+  # @param strategy [Symbol] request strategy to use
+  # @param items_selector [String, nil] optional selector hint for item extraction
+  # @param max_redirects [Integer, nil] optional redirect limit override
+  # @param max_requests [Integer, nil] optional request budget override
+  # @return [Hash] JSONFeed-compliant hash
+  def self.auto_json_feed(url, strategy: :auto, items_selector: nil, max_redirects: nil, max_requests: nil)
+    json_feed(build_auto_source_config(url:, strategy:, items_selector:, max_redirects:, max_requests:))
+  end
+
+  class << self
+    private
+
+    def build_auto_source_config(url:, strategy:, items_selector:, max_redirects:, max_requests:)
+      Config.auto_source_config(
+        url:,
+        items_selector:,
+        request_controls: shortcut_request_controls(strategy:, max_redirects:, max_requests:)
+      )
+    end
+
+    def shortcut_request_controls(strategy:, max_redirects:, max_requests:)
+      RequestControls.new(
+        strategy:,
+        max_redirects:,
+        max_requests:,
+        explicit_keys: explicit_request_control_keys(strategy:, max_redirects:, max_requests:)
+      )
+    end
+
+    def explicit_request_control_keys(strategy:, max_redirects:, max_requests:)
+      keys = []
+      keys << :strategy unless strategy.nil? || strategy == Config.default_strategy_name
+      keys << :max_redirects unless max_redirects.nil?
+      keys << :max_requests unless max_requests.nil?
+      keys
+    end
+  end
 end
+
+loader.eager_load

data/lib/tasks/config_schema.rake

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+require 'json'
+require 'fileutils'
+require_relative '../html2rss'
+
+namespace :config do
+  desc 'Generate config JSON schema'
+  task :schema do
+    destination = Html2rss::Config.schema_path
+
+    FileUtils.mkdir_p(File.dirname(destination))
+    File.write(destination, "#{Html2rss::Config.json_schema_json}\n")
+
+    puts "Generated config schema at #{destination}"
+  end
+end