simple-feed 2.0.2 → 3.1.2

data/lib/simplefeed/response.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'hashie'
 require 'forwardable'
 require 'simplefeed'
@@ -10,11 +12,9 @@ module SimpleFeed
 
     include Enumerable
 
-    def each
+    def each(&block)
       if block_given?
-        @result.each_pair do |user_id, result|
-          yield(user_id, result)
-        end
+        @result.each_pair(&block)
       else
         @result.keys.to_enum
       end
@@ -26,10 +26,10 @@ module SimpleFeed
 
     def for(key_or_user_id, result = nil)
       user_id = key_or_user_id.is_a?(SimpleFeed::Providers::Key) ?
-        key_or_user_id.user_id :
+        key_or_user_id.consumer :
         key_or_user_id
 
-      @result[user_id] = result ? result : yield(@result[user_id])
+      @result[user_id] = result || yield(@result[user_id])
     end
 
     def user_ids
@@ -61,7 +61,7 @@ module SimpleFeed
     end
 
     def result(user_id = nil)
-      if user_id then
+      if user_id
         @result[user_id]
       else
         if @result.values.size == 1

data/lib/simplefeed/version.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module SimpleFeed
-  VERSION = '2.0.2'
+  VERSION ||= '3.1.2'
 end

data/lib/simplefeed.rb

@@ -1,60 +1,66 @@
+# frozen_string_literal: true
+
 require 'hashie/extensions/symbolize_keys'
 require 'simplefeed/version'
+require 'hashie'
 
 Hashie.logger = Logger.new(nil)
 
 ::Dir.glob(::File.expand_path('../simplefeed/*.rb', __FILE__)).each { |f| require_relative(f) }
 
 require 'simplefeed/providers/redis'
-require 'simplefeed/providers/hash'
 require 'simplefeed/dsl'
+require 'simplefeed/feed'
 
 # 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.
 module SimpleFeed
+  TIME_FORMAT = '%Y-%m-%d %H:%M:%S.%L'
+
   @registry = {}
 
   class << self
-    # @return [Hash<Symbol, Feed>] the registry of the defined feeds
-    def registry
-      @registry
-    end
+    # @return Hash<Symbol, Feed> the registry of the defined feeds
+    attr_reader :registry
 
-    # @param name [Symbol] feed name
-    # @param options [Hash] any key-value pairs to set on the feed
+    # @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
-    def define(name, **options, &block)
+    # @return [Feed]  the feed with the given name, and defined via options and a block
+    def define(name, **options)
       name = name.to_sym unless name.is_a?(Symbol)
-      feed = registry[name] ? registry[name] : SimpleFeed::Feed.new(name)
-      feed.configure(options) do
-        block.call(feed) if block
+
+      registry[name] ||= Feed.new(name)
+      registry[name].tap do |feed|
+        feed.configure(options) do
+          yield(feed) if block_given?
+        end
       end
-      registry[name] = feed
-      feed
     end
 
-    # @return [Feed] the pre-defined feed with the given name
+    # @param [Symbol] name
+    # @return <Feed> the pre-defined feed with the given name
     def get(name)
       registry[name.to_sym]
     end
 
     # A factory method that constructs an instance of a provider based on the provider name and arguments.
     #
-    # @param provider_name [Symbol] short name of the provider, eg, :redis, :hash, etc.
-    # @params args [Array] constructor array arguments of the provider
-    # @params opts [Hash] constructor hash arguments of the provider
+    # @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]
+    # @return <Provider>
     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
 
     # Forward all other method calls to the Provider
-    def method_missing(name, *args, &block)
+    def method_missing(name, *args, **opts, &block)
       registry[name] || super
     end
   end
@@ -62,7 +68,7 @@ module SimpleFeed
   # Returns list of class attributes based on the setter methods.
   # Not fool-proof, but works in this context.
   def self.class_attributes(klass)
-    klass.instance_methods.grep(%r{[^=!]=$}).map { |m| m.to_s.gsub(/=/, '').to_sym }
+    klass.instance_methods.grep(/[^=!]=$/).map { |m| m.to_s.gsub(/=/, '').to_sym }
   end
 
   # Shortcut method to symbolize hash keys, using Hashie::Extensions

data/simple-feed.gemspec

@@ -1,7 +1,9 @@
-# coding: utf-8
-lib = File.expand_path('../lib', __FILE__)
+# frozen_string_literal: true
+
+lib = File.expand_path('lib', __dir__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require 'simplefeed/version'
+# noinspection RubyResolve
+load File.expand_path("#{lib}/simplefeed/version.rb")
 
 Gem::Specification.new do |spec|
   spec.name          = 'simple-feed'
@@ -9,8 +11,8 @@ Gem::Specification.new do |spec|
   spec.authors       = ['Konstantin Gredeskoul']
   spec.email         = ['kigster@gmail.com']
 
-  spec.summary       = %q{Create multiple types of social networking activity feeds with simple-feed gem, which uses a pluggable backend provider implementation, and ships with a Redis provider by default.}
-  spec.description   = %q{This gem implements flexible time-ordered activity feeds commonly used withing social networking applications. As events occur, they are pushed into the Feed and distributed to all users that need to see the event. Upon the user visiting their "feed page", a pre-populated ordered list of events is returned by the library. Typically the data stored in the feed is a short-hand condensed variant of models, but it can also be a fully Marshalled objects, or JSON serializations. }
+  spec.summary       = 'Create multiple types of social networking activity feeds with simple-feed gem, which uses a pluggable backend provider implementation, and ships with a Redis provider by default.'
+  spec.description   = 'This gem implements flexible time-ordered activity feeds commonly used withing social networking applications. As events occur, they are pushed into the Feed and distributed to all users that need to see the event. Upon the user visiting their "feed page", a pre-populated ordered list of events is returned by the library. Typically the data stored in the feed is a short-hand condensed variant of models, but it can also be a fully Marshalled objects, or JSON serializations. '
   spec.homepage      = 'https://github.com/kigster/simple-feed'
   spec.license       = 'MIT'
 
@@ -22,21 +24,26 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ['lib']
 
+  spec.add_dependency 'activesupport'
+  spec.add_dependency 'awesome_print'
   spec.add_dependency 'base62-rb'
+  spec.add_dependency 'colored2'
+  spec.add_dependency 'connection_pool', '~> 2'
+  spec.add_dependency 'hashie'
   spec.add_dependency 'hiredis'
   spec.add_dependency 'redis'
-  spec.add_dependency 'hashie'
-  spec.add_dependency 'connection_pool', '~> 2'
-  spec.add_dependency 'activesupport'
-  spec.add_dependency 'colored2'
+  spec.add_dependency 'sorted_set'
+  spec.add_dependency 'tty-box'
+  spec.add_dependency 'tty-screen'
 
-  spec.add_development_dependency 'awesome_print'
-  spec.add_development_dependency 'yard'
-  spec.add_development_dependency 'simplecov', '~> 0.12'
-  spec.add_development_dependency 'codeclimate-test-reporter', '~> 1.0'
-  spec.add_development_dependency 'knjrbfw'
   spec.add_development_dependency 'bundler'
-  spec.add_development_dependency 'rake', '~> 10.0'
-  spec.add_development_dependency 'rspec', '~> 3.5'
+  spec.add_development_dependency 'codeclimate-test-reporter'
+  spec.add_development_dependency 'codecov'
+  spec.add_development_dependency 'rake'
+  spec.add_development_dependency 'rspec'
   spec.add_development_dependency 'rspec-its'
+  spec.add_development_dependency 'rubocop'
+  spec.add_development_dependency 'simplecov'
+  spec.add_development_dependency 'uuid'
+  spec.add_development_dependency 'yard'
 end

metadata

@@ -1,17 +1,17 @@
 --- !ruby/object:Gem::Specification
 name: simple-feed
 version: !ruby/object:Gem::Version
-  version: 2.0.2
+  version: 3.1.2
 platform: ruby
 authors:
 - Konstantin Gredeskoul
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2017-12-07 00:00:00.000000000 Z
+date: 2022-02-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: base62-rb
+  name: activesupport
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -25,7 +25,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: hiredis
+  name: awesome_print
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -39,7 +39,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: redis
+  name: base62-rb
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -53,7 +53,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: hashie
+  name: colored2
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -81,7 +81,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '2'
 - !ruby/object:Gem::Dependency
-  name: activesupport
+  name: hashie
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -95,7 +95,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: colored2
+  name: hiredis
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -109,13 +109,13 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: awesome_print
+  name: redis
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-  type: :development
+  type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
@@ -123,13 +123,13 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: yard
+  name: sorted_set
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-  type: :development
+  type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
@@ -137,35 +137,49 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: simplecov
+  name: tty-box
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '0.12'
-  type: :development
+        version: '0'
+  type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '0.12'
+        version: '0'
 - !ruby/object:Gem::Dependency
-  name: codeclimate-test-reporter
+  name: tty-screen
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.0'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.0'
+        version: '0'
 - !ruby/object:Gem::Dependency
-  name: knjrbfw
+  name: codeclimate-test-reporter
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -179,7 +193,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: bundler
+  name: codecov
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -196,30 +210,30 @@ dependencies:
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '3.5'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '3.5'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rspec-its
   requirement: !ruby/object:Gem::Requirement
@@ -234,6 +248,62 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: uuid
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: 'This gem implements flexible time-ordered activity feeds commonly used
   withing social networking applications. As events occur, they are pushed into the
   Feed and distributed to all users that need to see the event. Upon the user visiting
@@ -247,19 +317,25 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".codeclimate.yml"
+- ".envrc"
+- ".github/workflows/rubocop.yml"
+- ".github/workflows/ruby.yml"
 - ".gitignore"
+- ".relaxed-rubocop-2.4.yml"
 - ".rspec"
 - ".rubocop.yml"
+- ".rubocop_todo.yml"
 - ".travis.yml"
 - ".yardopts"
+- CHANGELOG.md
 - Gemfile
 - Guardfile
 - LICENSE.txt
-- README.md
+- README.adoc
 - Rakefile
 - bin/console
 - bin/setup
-- examples/hash_provider_example.rb
+- codecov.yml
 - examples/redis_provider_example.rb
 - examples/shared/provider_example.rb
 - lib/simple-feed.rb
@@ -273,13 +349,9 @@ files:
 - lib/simplefeed/dsl/formatter.rb
 - lib/simplefeed/event.rb
 - lib/simplefeed/feed.rb
-- lib/simplefeed/key/template.rb
-- lib/simplefeed/key/type.rb
 - lib/simplefeed/providers.rb
 - lib/simplefeed/providers/base/provider.rb
 - lib/simplefeed/providers/hash.rb
-- lib/simplefeed/providers/hash/paginator.rb
-- lib/simplefeed/providers/hash/provider.rb
 - lib/simplefeed/providers/key.rb
 - lib/simplefeed/providers/proxy.rb
 - lib/simplefeed/providers/redis.rb
@@ -298,7 +370,7 @@ homepage: https://github.com/kigster/simple-feed
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -313,9 +385,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.6.13
-signing_key: 
+rubygems_version: 3.3.7
+signing_key:
 specification_version: 4
 summary: Create multiple types of social networking activity feeds with simple-feed
   gem, which uses a pluggable backend provider implementation, and ships with a Redis