simple-feed 2.1.0 → 3.2.0

data/lib/simplefeed/providers/redis/driver.rb

@@ -1,12 +1,10 @@
 # frozen_string_literal: true
 
 require 'redis'
-require 'redis/connection/hiredis'
 require 'connection_pool'
 require 'colored2'
 require 'hashie/mash'
 require 'yaml'
-require 'pp'
 
 module SimpleFeed
   module Providers
@@ -99,7 +97,7 @@ module SimpleFeed
             end
 
             if redis_proc
-              self.pool = ::ConnectionPool.new(size: (opts[:pool_size] || 2)) do
+              self.pool = ::ConnectionPool.new(size: opts[:pool_size] || 2) do
                 redis_proc.call
               end
             end
@@ -139,12 +137,10 @@ module SimpleFeed
           end
         end
 
-        def with_pipelined
+        def with_pipelined(&block)
           with_retries do
             with_redis do |redis|
-              redis.pipelined do
-                yield(redis)
-              end
+              redis.pipelined(&block)
             end
           end
         end

data/lib/simplefeed/providers/redis/provider.rb

@@ -51,9 +51,9 @@ module SimpleFeed
           raise ArgumentError, '#delete_if must be called with a block that receives (user_id, event) as arguments.' unless block_given?
 
           with_response_batched(user_ids) do |key|
-            fetch(user_ids: [key.user_id])[key.user_id].map do |event|
+            fetch(user_ids: [key.consumer])[key.consumer].map do |event|
               with_redis do |redis|
-                if yield(event, key.user_id)
+                if yield(event, key.consumer)
                   redis.zrem(key.data, event.value) ? event : nil
                 end
               end
@@ -90,7 +90,7 @@ module SimpleFeed
 
           response = with_response_pipelined(user_ids) do |redis, key|
             if since == :unread
-              redis.zrevrangebyscore(key.data, '+inf', (last_read_response.delete(key.user_id) || 0).to_f, withscores: true)
+              redis.zrevrangebyscore(key.data, '+inf', (last_read_response.delete(key.consumer) || 0).to_f, withscores: true)
             elsif since
               redis.zrevrangebyscore(key.data, '+inf', since.to_f, withscores: true)
             else
@@ -120,7 +120,7 @@ module SimpleFeed
             get_users_last_read(redis, key)
           end
           with_response_pipelined(response.user_ids, response) do |redis, key, _response|
-            last_read = _response.delete(key.user_id).to_f
+            last_read = _response.delete(key.consumer).to_f
             redis.zcount(key.data, last_read, '+inf')
           end
         end
@@ -223,7 +223,7 @@ module SimpleFeed
         def with_response_pipelined(user_ids, response = nil)
           with_response(response) do |response|
             batch_pipelined(user_ids) do |redis, key|
-              response.for(key.user_id) { yield(redis, key, response) }
+              response.for(key.consumer) { yield(redis, key, response) }
             end
           end
         end
@@ -231,7 +231,7 @@ module SimpleFeed
         def with_response_multi(user_ids, response = nil)
           with_response(response) do |response|
             batch_multi(user_ids) do |redis, key|
-              response.for(key.user_id) { yield(redis, key, response) }
+              response.for(key.consumer) { yield(redis, key, response) }
             end
           end
         end

data/lib/simplefeed/providers.rb

@@ -52,5 +52,4 @@ module SimpleFeed
   end
 end
 
-require_relative 'providers/hash'
 require_relative 'providers/redis'

data/lib/simplefeed/response.rb

@@ -12,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
@@ -28,7 +26,7 @@ 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 || yield(@result[user_id])

data/lib/simplefeed/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module SimpleFeed
-  VERSION = '2.1.0'
+  VERSION ||= '3.2.0'
 end

data/lib/simplefeed.rb

@@ -6,48 +6,52 @@ require 'hashie'
 
 Hashie.logger = Logger.new(nil)
 
-::Dir.glob(::File.expand_path('../simplefeed/*.rb', __FILE__)).each { |f| require_relative(f) }
+::Dir.glob(::File.expand_path('../simplefeed/*.rb', __FILE__)).sort.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
+    # @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] || SimpleFeed::Feed.new(name)
-      feed.configure(options) do
-        block&.call(feed)
+
+      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

data/simple-feed.gemspec

@@ -2,7 +2,8 @@
 
 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'
@@ -24,16 +25,19 @@ Gem::Specification.new do |spec|
   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 'sorted_set'
+  spec.add_dependency 'tty-box'
+  spec.add_dependency 'tty-screen'
 
-  spec.add_development_dependency 'awesome_print'
   spec.add_development_dependency 'bundler'
   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'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: simple-feed
 version: !ruby/object:Gem::Version
-  version: 2.1.0
+  version: 3.2.0
 platform: ruby
 authors:
 - Konstantin Gredeskoul
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2020-05-24 00:00:00.000000000 Z
+date: 2024-07-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -24,6 +24,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: awesome_print
+  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: base62-rb
   requirement: !ruby/object:Gem::Requirement
@@ -81,7 +95,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: hiredis
+  name: redis
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -95,7 +109,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: redis
+  name: sorted_set
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -109,13 +123,27 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: awesome_print
+  name: tty-box
   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:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  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:
@@ -150,6 +178,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: codecov
+  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: rake
   requirement: !ruby/object:Gem::Requirement
@@ -261,6 +303,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".codeclimate.yml"
+- ".envrc"
 - ".github/workflows/rubocop.yml"
 - ".github/workflows/ruby.yml"
 - ".gitignore"
@@ -270,14 +313,16 @@ files:
 - ".rubocop_todo.yml"
 - ".travis.yml"
 - ".yardopts"
+- CHANGELOG.md
 - Gemfile
 - Guardfile
 - LICENSE.txt
 - README.adoc
+- README.pdf
 - 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
@@ -291,13 +336,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
@@ -316,7 +357,7 @@ homepage: https://github.com/kigster/simple-feed
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -331,8 +372,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.3
-signing_key: 
+rubygems_version: 3.5.9
+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

data/examples/hash_provider_example.rb

@@ -1,24 +0,0 @@
-#!/usr/bin/env ruby
-
-# This is an executable example of working with a Redis feed, and storing
-# events for various users.
-# 
-# DEPENDENCIES: 
-#  gem install colored2
-#  gem install awesome_print
-#
-# RUNNING
-#  ruby redis-feed.rb
-#
-
-$LOAD_PATH.unshift File.expand_path('../../lib', __FILE__)
-
-require 'simplefeed'
-
-@feed = SimpleFeed.define(:news) do |f|
-  f.provider = SimpleFeed.provider(:hash)
-  f.max_size = 1000
-end
-
-require_relative 'shared/provider_example'
-

data/lib/simplefeed/key/template.rb

@@ -1,48 +0,0 @@
-# frozen_string_literal: true
-
-require 'base62-rb'
-require 'hashie/mash'
-
-module SimpleFeed
-  module Key
-    class TextTemplate < Struct.new(:text)
-      def render(params = {})
-        output = text.dup
-        params.each_pair do |key, value|
-          output.gsub!(/{{\s*#{key}\s*}}/, value.to_s)
-        end
-        output
-      end
-    end
-
-    DEFAULT_TEXT_TEMPLATE = TextTemplate.new('{{ namespace }}u.{{ base62_user_id }}.{{ key_marker }}')
-
-    class Template
-      attr_accessor :namespace, :key_types, :text_template
-
-      def initialize(namespace,
-                     key_types = DEFAULT_TYPES,
-                     text_template = DEFAULT_TEXT_TEMPLATE)
-
-        self.namespace     = namespace
-        self.key_types     = key_types
-        self.text_template = text_template
-
-        self.key_types.each do |type|
-          type.template ||= text_template if text_template
-        end
-      end
-
-      def render_options
-        h = {}
-        h.merge!({ 'namespace' => namespace ? "#{namespace}|" : '' })
-        h
-      end
-
-      # Returns array of key names, such as [:meta, :data]
-      def key_names
-        key_types.map(&:name).map(&:to_s).sort
-      end
-    end
-  end
-end

data/lib/simplefeed/key/type.rb

@@ -1,28 +0,0 @@
-# frozen_string_literal: true
-
-require_relative 'template'
-
-module SimpleFeed
-  module Key
-    class Type < Struct.new(:name, :marker)
-      attr_accessor :template
-
-      def initialize(name, marker, template = nil)
-        super(name, marker)
-        self.template = template
-      end
-
-      def render(opts = {})
-        template.render(opts.merge({ key_type:   name,
-                                     key_marker: marker }))
-      end
-    end
-
-    DEFAULT_TYPES = [
-      { name: :data, marker: 'd' },
-      { name: :meta, marker: 'm' }
-    ].map do |type|
-      Type.new(type[:name], type[:marker], DEFAULT_TEXT_TEMPLATE)
-    end
-  end
-end

data/lib/simplefeed/providers/hash/paginator.rb

@@ -1,33 +0,0 @@
-# frozen_string_literal: true
-
-module SimpleFeed
-  module Providers
-    module Hash
-      # Include this module into any provider etc that has access to the +feed.fetch+
-      # methods, and it will provide +paginate+ method based on all.
-      #
-      # Of course this is not very efficient, because it requires fetching all events for the user.
-      module Paginator
-        def paginate(user_ids:, page: nil, per_page: feed.per_page, &block)
-          response = feed.fetch(user_ids: user_ids)
-          response = SimpleFeed::Response.new(response.to_h)
-          response.transform do |*, events|
-            paginate_items(order_events(events, &block), page: page, per_page: per_page)
-          end
-        end
-
-        def paginate_items(items, page: nil, per_page: nil)
-          page && page > 0 ? items[((page - 1) * per_page)...(page * per_page)] : items
-        end
-
-        def order_events(events, &block)
-          return nil unless events
-
-          events.sort do |a, b|
-            block ? yield(a, b) : b.at <=> a.at
-          end
-        end
-      end
-    end
-  end
-end