simple-feed 2.1.0 → 3.1.2

data/lib/simplefeed.rb

@@ -9,45 +9,49 @@ 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
+    # @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,20 @@ 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.1.2
 platform: ruby
 authors:
 - Konstantin Gredeskoul
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2020-05-24 00:00:00.000000000 Z
+date: 2022-02-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
@@ -109,13 +123,41 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: awesome_print
+  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:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: tty-box
+  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: 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 +192,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 +317,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".codeclimate.yml"
+- ".envrc"
 - ".github/workflows/rubocop.yml"
 - ".github/workflows/ruby.yml"
 - ".gitignore"
@@ -270,6 +327,7 @@ files:
 - ".rubocop_todo.yml"
 - ".travis.yml"
 - ".yardopts"
+- CHANGELOG.md
 - Gemfile
 - Guardfile
 - LICENSE.txt
@@ -277,7 +335,7 @@ files:
 - 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 +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
@@ -316,7 +370,7 @@ homepage: https://github.com/kigster/simple-feed
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -331,8 +385,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.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

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

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

@@ -1,188 +0,0 @@
-# frozen_string_literal: true
-
-require 'base62-rb'
-require 'hashie'
-require 'set'
-require 'objspace'
-
-require 'simplefeed/event'
-require_relative 'paginator'
-require_relative '../key'
-require_relative '../base/provider'
-
-module SimpleFeed
-  module Providers
-    module Hash
-      class Provider < ::SimpleFeed::Providers::Base::Provider
-        attr_accessor :h
-
-        include SimpleFeed::Providers::Hash::Paginator
-
-        def self.from_yaml(file)
-          new(YAML.parse(File.read(file)))
-        end
-
-        def initialize(opts)
-          self.h = {}
-          h.merge!(opts)
-        end
-
-        def store(user_ids:, value:, at: Time.now)
-          event = create_event(value, at)
-          with_response_batched(user_ids) do |key|
-            add_event(event, key)
-          end
-        end
-
-        def delete(user_ids:, value:, at: nil)
-          event = create_event(value, at)
-          with_response_batched(user_ids) do |key|
-            changed_activity_size?(key) do
-              __delete(key, event)
-            end
-          end
-        end
-
-        def delete_if(user_ids:)
-          with_response_batched(user_ids) do |key|
-            activity(key).map do |event|
-              if yield(event, key.user_id)
-                __delete(key, event)
-                event
-              end
-            end.compact
-          end
-        end
-
-        def wipe(user_ids:)
-          with_response_batched(user_ids) do |key|
-            deleted = !activity(key).empty?
-            wipe_user_record(key)
-            deleted
-          end
-        end
-
-        def paginate(user_ids:,
-                     page:,
-                     per_page: feed.per_page,
-                     with_total: false,
-                     reset_last_read: false)
-
-          reset_last_read_value(user_ids: user_ids, at: reset_last_read) if reset_last_read
-
-          with_response_batched(user_ids) do |key|
-            activity = activity(key)
-            result = page && page > 0 ? activity[((page - 1) * per_page)...(page * per_page)] : activity
-            with_total ? { events: result, total_count: activity.length } : result
-          end
-        end
-
-        def fetch(user_ids:, since: nil, reset_last_read: false)
-          response = with_response_batched(user_ids) do |key|
-            if since == :unread
-              activity(key).reject { |event| event.at < user_record(key).last_read.to_f }
-            elsif since
-              activity(key).reject { |event| event.at < since.to_f }
-            else
-              activity(key)
-            end
-          end
-          reset_last_read_value(user_ids: user_ids, at: reset_last_read) if reset_last_read
-
-          response
-        end
-
-        def reset_last_read(user_ids:, at: Time.now)
-          with_response_batched(user_ids) do |key|
-            user_record(key)[:last_read] = at
-            at
-          end
-        end
-
-        def total_count(user_ids:)
-          with_response_batched(user_ids) do |key|
-            activity(key).size
-          end
-        end
-
-        def unread_count(user_ids:)
-          with_response_batched(user_ids) do |key|
-            activity(key).count { |event| event.at > user_record(key).last_read.to_f }
-          end
-        end
-
-        def last_read(user_ids:)
-          with_response_batched(user_ids) do |key|
-            user_record(key).last_read
-          end
-        end
-
-        def total_memory_bytes
-          ObjectSpace.memsize_of(h)
-        end
-
-        def total_users
-          h.size
-        end
-
-        private
-
-        #===================================================================
-        # Methods below operate on a single user only
-        #
-
-        def changed_activity_size?(key)
-          ua          = activity(key)
-          size_before = ua.size
-          yield(key, ua)
-          size_after = activity(key).size
-          (size_before > size_after)
-        end
-
-        def create_user_record
-          Hashie::Mash.new(
-            { last_read: 0, activity: SortedSet.new }
-          )
-        end
-
-        def user_record(key)
-          h[key.data] ||= create_user_record
-        end
-
-        def wipe_user_record(key)
-          h[key.data] = create_user_record
-        end
-
-        def activity(key, event = nil)
-          user_record(key)[:activity] << event if event
-          user_record(key)[:activity].to_a
-        end
-
-        def add_event(event, key)
-          uas = user_record(key)[:activity]
-          if uas.include?(event)
-            false
-          else
-            uas << event.dup
-            if uas.size > feed.max_size
-              uas.delete(uas.to_a.last)
-            end
-            true
-          end
-        end
-
-        def __last_read(key, _value = nil)
-          user_record(key)[:last_read]
-        end
-
-        def __delete(key, event)
-          user_record(key)[:activity].delete(event)
-        end
-
-        def create_event(*args, **opts)
-          ::SimpleFeed::Event.new(*args, **opts)
-        end
-      end
-    end
-  end
-end