simple-feed 2.1.0 → 3.0.1

data/lib/simplefeed/feed.rb

@@ -2,11 +2,17 @@
 
 require_relative 'providers'
 require_relative 'activity/base'
-require 'simplefeed/key/template'
+require_relative 'providers/key'
 
 module SimpleFeed
   class Feed
-    attr_accessor :per_page, :max_size, :batch_size, :meta, :namespace
+    attr_accessor :per_page,
+                  :max_size,
+                  :batch_size,
+                  :namespace,
+                  :data_key_transformer,
+                  :meta_key_transformer
+
     attr_reader :name
 
     SimpleFeed::Providers.define_provider_methods(self) do |feed, method, opts, &block|
@@ -14,19 +20,21 @@ module SimpleFeed
     end
 
     def initialize(name)
-      @name         = name
-      @name         = name.underscore.to_sym unless name.is_a?(Symbol)
+      @name = name
+      @name = name.underscore.to_sym unless name.is_a?(Symbol)
       # set the defaults if not passed in
-      @meta         = {}
-      @namespace    = nil
+      @meta = {}
+      @namespace = nil
       @per_page ||= 50
       @max_size ||= 1000
       @batch_size ||= 10
+      @meta_key_transformer = nil
+      @data_key_transformer = nil
       @proxy = nil
     end
 
     def provider=(definition)
-      @proxy      = Providers::Proxy.from(definition)
+      @proxy = Providers::Proxy.from(definition)
       @proxy.feed = self
       @proxy
     end
@@ -63,12 +71,15 @@ module SimpleFeed
     end
 
     def key(user_id)
-      SimpleFeed::Providers::Key.new(user_id, key_template)
+      SimpleFeed::Providers::Key.new(user_id,
+                                     namespace:            namespace,
+                                     data_key_transformer: data_key_transformer,
+                                     meta_key_transformer: meta_key_transformer)
     end
 
     def eql?(other)
       other.class == self.class &&
-        %i(per_page max_size name).all? { |m| send(m).equal?(other.send(m)) } &&
+        %i(per_page max_size name namespace data_key_transformer meta_key_transformer).all? { |m| send(m).equal?(other.send(m)) } &&
         provider.provider.class == other.provider.provider.class
     end
 

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

@@ -58,7 +58,7 @@ module SimpleFeed
         def with_response_batched(user_ids, external_response = nil)
           with_response(external_response) do |response|
             batch(user_ids) do |key|
-              response.for(key.user_id) { yield(key, response) }
+              response.for(key.consumer) { yield(key, response) }
             end
           end
         end

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

@@ -46,7 +46,7 @@ module SimpleFeed
         def delete_if(user_ids:)
           with_response_batched(user_ids) do |key|
             activity(key).map do |event|
-              if yield(event, key.user_id)
+              if yield(event, key.consumer)
                 __delete(key, event)
                 event
               end
@@ -80,7 +80,7 @@ module SimpleFeed
         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 }
+              activity(key).reject { |event| event.at < user_meta_record(key).last_read.to_f }
             elsif since
               activity(key).reject { |event| event.at < since.to_f }
             else
@@ -94,7 +94,7 @@ module SimpleFeed
 
         def reset_last_read(user_ids:, at: Time.now)
           with_response_batched(user_ids) do |key|
-            user_record(key)[:last_read] = at
+            user_meta_record(key)[:last_read] = at
             at
           end
         end
@@ -107,13 +107,13 @@ module SimpleFeed
 
         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 }
+            activity(key).count { |event| event.at > user_meta_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
+            user_meta_record(key).last_read
           end
         end
 
@@ -122,7 +122,7 @@ module SimpleFeed
         end
 
         def total_users
-          h.size
+          h.size / 2
         end
 
         private
@@ -139,27 +139,37 @@ module SimpleFeed
           (size_before > size_after)
         end
 
-        def create_user_record
+        def create_meta_record
           Hashie::Mash.new(
-            { last_read: 0, activity: SortedSet.new }
+            { last_read: 0 }
           )
         end
 
-        def user_record(key)
-          h[key.data] ||= create_user_record
+        def create_data_record
+          Hashie::Mash.new(
+            { activity: SortedSet.new }
+          )
+        end
+
+        def user_data_record(key)
+          h[key.data] ||= create_data_record
+        end
+
+        def user_meta_record(key)
+          h[key.meta] ||= create_meta_record
         end
 
         def wipe_user_record(key)
-          h[key.data] = create_user_record
+          h[key.data] = create_data_record
         end
 
         def activity(key, event = nil)
-          user_record(key)[:activity] << event if event
-          user_record(key)[:activity].to_a
+          user_data_record(key)[:activity] << event if event
+          user_data_record(key)[:activity].to_a
         end
 
         def add_event(event, key)
-          uas = user_record(key)[:activity]
+          uas = user_data_record(key)[:activity]
           if uas.include?(event)
             false
           else
@@ -172,11 +182,11 @@ module SimpleFeed
         end
 
         def __last_read(key, _value = nil)
-          user_record(key)[:last_read]
+          user_meta_record(key)[:last_read]
         end
 
         def __delete(key, event)
-          user_record(key)[:activity].delete(event)
+          user_data_record(key)[:activity].delete(event)
         end
 
         def create_event(*args, **opts)

data/lib/simplefeed/providers/key.rb

@@ -2,10 +2,6 @@
 
 require 'base62-rb'
 require 'hashie/mash'
-require 'simplefeed/key/template'
-require 'simplefeed/key/type'
-
-require 'forwardable'
 
 module SimpleFeed
   module Providers
@@ -15,66 +11,85 @@ module SimpleFeed
     #              ↓        ↓
     #          "ff|u.f23098.m"
     #           ↑         ↑
-    #         namespace user_id(base62)
+    #         namespace consumer(base62)
     #
     class Key
-      attr_accessor :user_id, :key_template
+      class << self
+        def rot13(value)
+          value.tr('abcdefghijklmnopqrstuvwxyz',
+                   'nopqrstuvwxyzabcdefghijklm')
+        end
+      end
 
-      extend Forwardable
-      def_delegators :@key_template, :key_names, :key_types
+      SERIALIZED_DATA_TEMPLATE = '{{namespace}}u.{{data_id}}.d'
+      SERIALIZED_META_TEMPLATE = '{{namespace}}u.{{meta_id}}.m'
 
-      def initialize(user_id, key_template)
-        self.user_id = user_id
-        self.key_template = key_template
+      attr_reader :consumer, :namespace, :data_key_transformer, :meta_key_transformer
 
-        define_key_methods
+      def initialize(consumer,
+                     namespace: nil,
+                     data_key_transformer: nil,
+                     meta_key_transformer: nil)
+        @consumer = consumer
+        @namespace = namespace
+        @data_key_transformer = data_key_transformer
+        @meta_key_transformer = meta_key_transformer
       end
 
-      # Defines #data and #meta methods.
-      def define_key_methods
-        key_template.key_types.each do |type|
-          key_name = type.name
-          next if respond_to?(key_name)
-
-          self.class.send(:define_method, key_name) do
-            instance_variable_get("@#{key_name}") ||
-              instance_variable_set("@#{key_name}", type.render(render_options))
-          end
-        end
+      def data
+        @data ||= render(SERIALIZED_DATA_TEMPLATE)
       end
 
-      def base62_user_id
-        @base62_user_id ||= if user_id.is_a?(Numeric)
-                              ::Base62.encode(user_id)
-                            else
-                              rot13(user_id.to_s)
-                            end
+      def meta
+        @meta ||= render(SERIALIZED_META_TEMPLATE)
       end
 
       def keys
-        key_names.map { |name| send(name) }
-      end
-
-      def render_options
-        key_template.render_options.merge!({
-                                             'user_id' => user_id,
-                                             'base62_user_id' => base62_user_id
-                                           })
+        [data, meta]
       end
 
       def to_s
-        super + { user_id: user_id, base62_user_id: base62_user_id, keys: keys }.to_s
+        super + key_params.to_s
       end
 
       def inspect
-        render_options.inspect
+        super + key_params.inspect
       end
 
       private
 
-      def rot13(value)
-        value.tr('abcdefghijklmnopqrstuvwxyz',
-                 'nopqrstuvwxyzabcdefghijklm')
+      def render(template)
+        template.dup.tap do |output|
+          key_params.each_pair do |key, value|
+            output.gsub!(/{{#{key}}}/, value.to_s)
+          end
+        end
+      end
+
+      def obscure_value(id)
+        id = id.to_i if id.is_a?(String) && id =~ /^[\d]+$/
+
+        if id.is_a?(Numeric)
+          ::Base62.encode(id)
+        else
+          self.class.rot13(id.to_s)
+        end
+      end
+
+      def key_params
+        @key_params ||= Hashie::Mash.new(
+          namespace: namespace ? "#{namespace}|" : '',
+          data_id:   obscure_value(data_id),
+          meta_id:   obscure_value(meta_id)
+        )
+      end
+
+      def meta_id
+        meta_key_transformer&.call(consumer) || consumer
+      end
+
+      def data_id
+        data_key_transformer&.call(consumer) || consumer
       end
     end
   end

data/lib/simplefeed/providers/proxy.rb

@@ -2,6 +2,8 @@
 
 module SimpleFeed
   module Providers
+    RUBY_MAJOR_VERSION = RUBY_VERSION.split('.')[0..1].join.to_i
+
     class Proxy
       attr_accessor :provider
 
@@ -15,7 +17,7 @@ module SimpleFeed
       end
 
       def initialize(provider_or_klass, *args, **options)
-        self.provider = if provider_or_klass.is_a?(::String)
+        self.provider = if provider_or_klass.is_a?(::String) || provider_or_klass.is_a?(::Symbol)
                           ::Object.const_get(provider_or_klass).new(*args, **options)
                         else
                           provider_or_klass
@@ -26,12 +28,23 @@ module SimpleFeed
         end
       end
 
-      # Forward all other method calls to Provider
-      def method_missing(name, *args, **opts, &block)
-        if provider&.respond_to?(name)
-          provider.send(name, *args, **opts, &block)
-        else
-          super(name, *args, **opts, &block)
+      if RUBY_MAJOR_VERSION >= 27
+        # Forward all other method calls to Provider
+        def method_missing(name, *args, **opts, &block)
+          if provider&.respond_to?(name)
+            provider.send(name, *args, **opts, &block)
+          else
+            super(name, *args, **opts, &block)
+          end
+        end
+      else
+        # Forward all other method calls to Provider
+        def method_missing(name, *args, &block)
+          if provider&.respond_to?(name)
+            provider.send(name, *args, &block)
+          else
+            super(name, *args, &block)
+          end
         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/response.rb

@@ -28,7 +28,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.0.1'
 end

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'
@@ -30,10 +31,13 @@ Gem::Specification.new do |spec|
   spec.add_dependency 'hashie'
   spec.add_dependency 'hiredis'
   spec.add_dependency 'redis'
+  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'