module SimpleFeed

Main namespace module for the SimpleFeed gem. It provides several shortcuts and entry points into the library, such as ability to define and fetch new feeds via define, and so on.

Constants

TIME_FORMAT
VERSION

Attributes

registry[R]

@return Hash<Symbol, Feed> the registry of the defined feeds

Public Class Methods

class_attributes(klass) click to toggle source

Returns list of class attributes based on the setter methods. Not fool-proof, but works in this context.

# File lib/simplefeed.rb, line 71
def self.class_attributes(klass)
  klass.instance_methods.grep(/[^=!]=$/).map { |m| m.to_s.gsub(/=/, '').to_sym }
end

define(name, **options) { |feed| ... } click to toggle source

@param <Symbol> name of the feed @param <Hash> options any key-value pairs to set on the feed

@return [Feed] the feed with the given name, and defined via options and a block

# File lib/simplefeed.rb, line 32
def define(name, **options)
  name = name.to_sym unless name.is_a?(Symbol)

  registry[name] ||= Feed.new(name)
  registry[name].tap do |feed|
    feed.configure(options) do
      yield(feed) if block_given?
    end
  end
end

get(name) click to toggle source

@param [Symbol] name @return <Feed> the pre-defined feed with the given name

# File lib/simplefeed.rb, line 45
def get(name)
  registry[name.to_sym]
end

method_missing(name, *args, **opts, &block) click to toggle source

Forward all other method calls to the Provider

Calls superclass method

# File lib/simplefeed.rb, line 64
def method_missing(name, *args, **opts, &block)
  registry[name] || super
end

provider(provider_name, *args, **opts, &block) click to toggle source

A factory method that constructs an instance of a provider based on the provider name and arguments.

@param <Symbol> provider_name short name of the provider, eg, :redis, :hash, etc. @param <Array> args constructor array arguments of the provider @param <Hash, NilClass> opts constructor hash arguments of the provider

@return <Provider>

# File lib/simplefeed.rb, line 56
def provider(provider_name, *args, **opts, &block)
  provider_class = SimpleFeed::Providers.registry[provider_name]
  raise ArgumentError, "No provider named #{provider_name} was found, #{SimpleFeed::Providers.registry.inspect}" unless provider_class

  provider_class.new(*args, **opts, &block)
end

symbolize!(hash) click to toggle source

Shortcut method to symbolize hash keys, using Hashie::Extensions

# File lib/simplefeed.rb, line 76
def self.symbolize!(hash)
  Hashie::Extensions::SymbolizeKeys.symbolize_keys!(hash)
end