simple-feed 2.0.2 → 2.1.0

data/lib/simplefeed/key/type.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require_relative 'template'
 
 module SimpleFeed
@@ -11,7 +13,8 @@ module SimpleFeed
       end
 
       def render(opts = {})
-        self.template.render(opts.merge({ 'key_type' => name, 'key_marker' => marker }))
+        template.render(opts.merge({ key_type:   name,
+                                     key_marker: marker }))
       end
     end
 
@@ -21,6 +24,5 @@ module SimpleFeed
     ].map do |type|
       Type.new(type[:name], type[:marker], DEFAULT_TEXT_TEMPLATE)
     end
-
   end
 end

data/lib/simplefeed/providers.rb

@@ -1,33 +1,48 @@
+# frozen_string_literal: true
+
 require_relative 'providers/key'
 require_relative 'providers/proxy'
 
 module SimpleFeed
   module Providers
     @registry = {}
-    
+
     def self.registry
       @registry
     end
-    
+
     def self.register(provider_name, provider_class)
-      self.registry[provider_name] = provider_class
+      registry[provider_name] = provider_class
     end
-    
+
     # These methods must be implemented by each Provider, and operation on a given
     # set of users passed via the user_ids: parameter.
-    ACTIVITY_METHODS = %i(store delete delete_if wipe reset_last_read last_read paginate fetch total_count unread_count)
+    ACTIVITY_METHODS = %i[
+      store
+      delete
+      delete_if
+      wipe
+      reset_last_read
+      last_read paginate
+      fetch
+      total_count
+      unread_count
+    ].freeze
 
-    # These methods must be implemented in order to gather statistics about each provider's
+    # These optional methods must be implemented in order to gather statistics about each provider's
     # memory consumption and state.
-    FEED_METHODS = %i(total_memory_bytes total_users)
+    FEED_METHODS = %i[
+      total_memory_bytes
+      total_users
+    ].freeze
 
-    REQUIRED_METHODS = ACTIVITY_METHODS + FEED_METHODS
+    REQUIRED_METHODS = (ACTIVITY_METHODS + FEED_METHODS).freeze
 
     def self.define_provider_methods(klass, prefix = nil, &block)
       # Methods on the class instance
       klass.class_eval do
         SimpleFeed::Providers::REQUIRED_METHODS.each do |m|
-          method_name = prefix ? "#{prefix}_#{m.to_s}".to_sym : m
+          method_name = prefix ? "#{prefix}_#{m}".to_sym : m
           define_method(method_name) do |*args, **opts, &b|
             block.call(self, m, *args, **opts, &b)
           end

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

@@ -1,4 +1,8 @@
+# frozen_string_literal: true
+
 require 'simplefeed/providers/key'
+require 'date'
+require 'time'
 
 module SimpleFeed
   module Providers
@@ -27,7 +31,7 @@ module SimpleFeed
           at = at.to_time if at.respond_to?(:to_time)
           at = at.to_f if at.respond_to?(:to_f)
 
-          if self.respond_to?(:reset_last_read)
+          if respond_to?(:reset_last_read)
             reset_last_read(user_ids: user_ids, at: at)
           else
             raise ArgumentError, "Class #{self.class} does not implement #reset_last_read method"
@@ -70,7 +74,7 @@ module SimpleFeed
         def with_response(response = nil)
           response ||= SimpleFeed::Response.new
           yield(response)
-          if self.respond_to?(:transform_response)
+          if respond_to?(:transform_response)
             response.transform do |user_id, result|
               # calling into a subclass
               transform_response(user_id, result)
@@ -78,7 +82,6 @@ module SimpleFeed
           end
           response
         end
-
       end
     end
   end

data/lib/simplefeed/providers/hash.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module SimpleFeed
   module Providers
     module Hash

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module SimpleFeed
   module Providers
     module Hash
@@ -6,7 +8,6 @@ module SimpleFeed
       #
       # 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)
@@ -16,11 +17,12 @@ module SimpleFeed
         end
 
         def paginate_items(items, page: nil, per_page: nil)
-          (page && page > 0) ? items[((page - 1) * per_page)...(page * per_page)] : items
+          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

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

@@ -1,11 +1,9 @@
+# frozen_string_literal: true
+
 require 'base62-rb'
 require 'hashie'
 require 'set'
-
-begin
-  require 'knjrbfw'
-rescue LoadError
-end
+require 'objspace'
 
 require 'simplefeed/event'
 require_relative 'paginator'
@@ -21,10 +19,10 @@ module SimpleFeed
         include SimpleFeed::Providers::Hash::Paginator
 
         def self.from_yaml(file)
-          self.new(YAML.load(File.read(file)))
+          new(YAML.parse(File.read(file)))
         end
 
-        def initialize(**opts)
+        def initialize(opts)
           self.h = {}
           h.merge!(opts)
         end
@@ -45,14 +43,12 @@ module SimpleFeed
           end
         end
 
-        def delete_if(user_ids:, &block)
+        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
-              else
-                nil
               end
             end.compact
           end
@@ -60,7 +56,7 @@ module SimpleFeed
 
         def wipe(user_ids:)
           with_response_batched(user_ids) do |key|
-            deleted = activity(key).size > 0
+            deleted = !activity(key).empty?
             wipe_user_record(key)
             deleted
           end
@@ -76,7 +72,7 @@ module SimpleFeed
 
           with_response_batched(user_ids) do |key|
             activity = activity(key)
-            result = (page && page > 0) ? activity[((page - 1) * per_page)...(page * per_page)] : activity
+            result = page && page > 0 ? activity[((page - 1) * per_page)...(page * per_page)] : activity
             with_total ? { events: result, total_count: activity.length } : result
           end
         end
@@ -122,16 +118,11 @@ module SimpleFeed
         end
 
         def total_memory_bytes
-          if defined?(::Knj)
-            analyzer = Knj::Memory_analyzer::Object_size_counter.new(self.h)
-            analyzer.calculate_size
-          else
-            raise LoadError, 'Please run "gem install knjrbfw" to get accurate hash size'
-          end
+          ObjectSpace.memsize_of(h)
         end
 
         def total_users
-          self.h.size
+          h.size
         end
 
         private
@@ -140,7 +131,6 @@ module SimpleFeed
         # Methods below operate on a single user only
         #
 
-
         def changed_activity_size?(key)
           ua          = activity(key)
           size_before = ua.size
@@ -181,7 +171,7 @@ module SimpleFeed
           end
         end
 
-        def __last_read(key, value = nil)
+        def __last_read(key, _value = nil)
           user_record(key)[:last_read]
         end
 

data/lib/simplefeed/providers/key.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'base62-rb'
 require 'hashie/mash'
 require 'simplefeed/key/template'
@@ -22,36 +24,40 @@ module SimpleFeed
       def_delegators :@key_template, :key_names, :key_types
 
       def initialize(user_id, key_template)
-        self.user_id  = user_id
+        self.user_id = user_id
         self.key_template = key_template
 
         define_key_methods
       end
 
+      # Defines #data and #meta methods.
       def define_key_methods
         key_template.key_types.each do |type|
           key_name = type.name
-          unless self.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
+          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
       end
 
       def base62_user_id
-        @base62_user_id ||= ::Base62.encode(user_id)
+        @base62_user_id ||= if user_id.is_a?(Numeric)
+                              ::Base62.encode(user_id)
+                            else
+                              rot13(user_id.to_s)
+                            end
       end
 
       def keys
-        key_names.map { |name| self.send(name) }
+        key_names.map { |name| send(name) }
       end
 
       def render_options
         key_template.render_options.merge!({
-                                             'user_id'        => user_id,
+                                             'user_id' => user_id,
                                              'base62_user_id' => base62_user_id
                                            })
       end
@@ -66,7 +72,10 @@ module SimpleFeed
 
       private
 
+      def rot13(value)
+        value.tr('abcdefghijklmnopqrstuvwxyz',
+                 'nopqrstuvwxyzabcdefghijklm')
+      end
     end
   end
 end
-

data/lib/simplefeed/providers/proxy.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module SimpleFeed
   module Providers
     class Proxy
@@ -6,19 +8,18 @@ module SimpleFeed
       def self.from(definition)
         if definition.is_a?(::Hash)
           ::SimpleFeed.symbolize!(definition)
-          self.new(definition[:klass], *definition[:args], **definition[:opts])
+          new(definition[:klass], *definition[:args], **definition[:opts])
         else
-          self.new(definition)
+          new(definition)
         end
-
       end
 
       def initialize(provider_or_klass, *args, **options)
-        if provider_or_klass.is_a?(::String)
-          self.provider = ::Object.const_get(provider_or_klass).new(*args, **options)
-        else
-          self.provider = provider_or_klass
-        end
+        self.provider = if provider_or_klass.is_a?(::String)
+                          ::Object.const_get(provider_or_klass).new(*args, **options)
+                        else
+                          provider_or_klass
+                        end
 
         SimpleFeed::Providers::REQUIRED_METHODS.each do |m|
           raise ArgumentError, "Invalid provider #{provider.class}\nMethod '#{m}' is required." unless provider.respond_to?(m)
@@ -26,11 +27,11 @@ module SimpleFeed
       end
 
       # Forward all other method calls to Provider
-      def method_missing(name, *args, &block)
-        if self.provider && provider.respond_to?(name)
-          self.provider.send(name, *args, &block)
+      def method_missing(name, *args, **opts, &block)
+        if provider&.respond_to?(name)
+          provider.send(name, *args, **opts, &block)
         else
-          super(name, *args, &block)
+          super(name, *args, **opts, &block)
         end
       end
     end

data/lib/simplefeed/providers/redis.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module SimpleFeed
   module Providers
     module Redis

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'redis'
 require 'redis/connection/hiredis'
 require 'connection_pool'
@@ -12,10 +14,10 @@ module SimpleFeed
       @debug = ENV['REDIS_DEBUG']
 
       def self.debug?
-        self.debug
+        debug
       end
 
-      def self.with_debug(&block)
+      def self.with_debug
         previous_value                     = SimpleFeed::Providers::Redis.debug
         SimpleFeed::Providers::Redis.debug = true
         result                             = yield if block_given?
@@ -48,10 +50,11 @@ module SimpleFeed
               colors     = [:blue, nil, :blue, :blue, :yellow, :cyan, nil, :blue]
               components = [
                 Time.now.strftime('%H:%M:%S.%L'), ' rtt=',
-                (sprintf '%.5f', delta*1000), ' ms ',
+                (sprintf '%.5f', delta * 1000), ' ms ',
                 (sprintf '%15s ', m.to_s.upcase),
                 (sprintf '%-40s', args.inspect.gsub(/[",\[\]]/, '')), ' ⇒ ',
-                (result.is_a?(::Redis::Future) ? '' : result.to_s)]
+                (result.is_a?(::Redis::Future) ? '' : result.to_s)
+              ]
               components.each_with_index do |component, index|
                 color = self.class.disable_color ? nil : colors[index]
                 component = component.send(color) if color
@@ -71,18 +74,16 @@ module SimpleFeed
 
         attr_accessor :pool
 
-=begin
-
-Various ways of defining a new Redis driver:
-
-SimpleFeed::Redis::Driver.new(pool: ConnectionPool.new(size: 2) { Redis.new })
-SimpleFeed::Redis::Driver.new(redis: -> { Redis.new }, pool_size: 2)
-SimpleFeed::Redis::Driver.new(redis: Redis.new)
-SimpleFeed::Redis::Driver.new(redis: { host: 'localhost', port: 6379, db: 1, timeout: 0.2 }, pool_size: 1)
-
-=end
-        def initialize(**opts)
-          if opts[:pool] && opts[:pool].respond_to?(:with)
+        #
+        # Various ways of defining a new Redis driver:
+        #
+        # SimpleFeed::Redis::Driver.new(pool: ConnectionPool.new(size: 2) { Redis.new })
+        # SimpleFeed::Redis::Driver.new(redis: -> { Redis.new }, pool_size: 2)
+        # SimpleFeed::Redis::Driver.new(redis: Redis.new)
+        # SimpleFeed::Redis::Driver.new(redis: { host: 'localhost', port: 6379, db: 1, timeout: 0.2 }, pool_size: 1)
+        #
+        def initialize(opts)
+          if opts[:pool]&.respond_to?(:with)
             self.pool = opts[:pool]
 
           elsif opts[:redis]
@@ -104,7 +105,7 @@ SimpleFeed::Redis::Driver.new(redis: { host: 'localhost', port: 6379, db: 1, tim
             end
           end
 
-          raise ArgumentError, "Unable to construct Redis connection from arguments: #{opts.inspect}" unless self.pool && self.pool.respond_to?(:with)
+          raise ArgumentError, "Unable to construct Redis connection from arguments: #{opts.inspect}" unless pool&.respond_to?(:with)
         end
 
         %i(set get incr decr setex expire del setnx exists zadd zrange).each do |method|
@@ -117,7 +118,7 @@ SimpleFeed::Redis::Driver.new(redis: { host: 'localhost', port: 6379, db: 1, tim
         alias_method :rm, :del
         alias_method :exists?, :exists
 
-        def exec(redis_method, *args, **opts, &block)
+        def exec(redis_method, *args, **_opts, &block)
           send_proc = redis_method if redis_method.respond_to?(:call)
           send_proc ||= ->(redis) { redis.send(redis_method, *args, &block) }
 
@@ -125,7 +126,7 @@ SimpleFeed::Redis::Driver.new(redis: { host: 'localhost', port: 6379, db: 1, tim
         end
 
         class MockRedis
-          def method_missing(name, *args, &block)
+          def method_missing(name, *args, **_opts, &block)
             puts "calling redis.#{name}(#{args.to_s.gsub(/[\[\]]/, '')}) { #{block ? block.call : nil} }"
           end
         end
@@ -133,7 +134,7 @@ SimpleFeed::Redis::Driver.new(redis: { host: 'localhost', port: 6379, db: 1, tim
         def with_redis
           with_retries do
             pool.with do |redis|
-              yield(self.debug? ? LoggingRedis.new(redis) : redis)
+              yield(debug? ? LoggingRedis.new(redis) : redis)
             end
           end
         end
@@ -170,13 +171,12 @@ SimpleFeed::Redis::Driver.new(redis: { host: 'localhost', port: 6379, db: 1, tim
             on_error e
           end
         rescue ::Redis::CommandError => e
-          (e.message =~ /loading/i || e.message =~ /connection/i) ? on_error(e) : raise(e)
+          e.message =~ /loading/i || e.message =~ /connection/i ? on_error(e) : raise(e)
         end
 
         def on_error(e)
-          raise Error.new(e)
+          raise Error, e
         end
-
       end
     end
   end