simple-feed 2.0.2 → 2.1.0

data/Rakefile

@@ -1,30 +1,29 @@
+# frozen_string_literal: true
+
 require 'bundler/gem_tasks'
 require 'rspec/core/rake_task'
 
 require 'yard'
 
-
 def shell(*args)
   puts "running: #{args.join(' ')}"
   system(args.join(' '))
 end
 
 task :permissions do
-  shell('rm -rf pkg/')
+  shell('rm -rf pkg/ tmp/ coverage/')
   shell("chmod -v o+r,g+r * */* */*/* */*/*/* */*/*/*/* */*/*/*/*/*")
   shell("find . -type d -exec chmod o+x,g+x {} \\;")
 end
 
-task :build => :permissions
-
+task build: :permissions
 
 YARD::Rake::YardocTask.new(:doc) do |t|
   t.files = %w(lib/**/*.rb exe/*.rb - README.md LICENSE.txt)
   t.options.unshift('--title', '"SimpleFeed — Fast and Scalable "write-time" Simple Feed for Social Networks, with a Redis-based default backend implementation."')
-  t.after = ->() { exec('open doc/index.html') } if RUBY_PLATFORM =~ /darwin/
+  t.after = -> { exec('open doc/index.html') } if RUBY_PLATFORM =~ /darwin/
 end
 
-
 RSpec::Core::RakeTask.new(:spec)
 
-task :default => :spec
+task default: :spec

data/bin/console

@@ -1,4 +1,5 @@
 #!/usr/bin/env ruby
+# frozen_string_literal: true
 
 require "bundler/setup"
 require "activity/feed"

data/examples/shared/provider_example.rb

@@ -5,9 +5,17 @@ $LOAD_PATH.unshift File.expand_path('../../../lib', __FILE__)
 raise ArgumentError, 'No @feed defined in the enclosing example' unless defined?(@feed)
 
 require 'simplefeed'
+require 'uuid'
+
+srand(Time.now.to_i % 100003)
+
+@number_of_users = ARGV[0] ? ARGV[0].to_i : 2
+@users = @number_of_users.times.map do |n|
+  n % 2 == 0 ? UUID.generate : rand(100003)
+end
+
+pp @users
 
-@number_of_users = ARGV[0] ? ARGV[0].to_i : 1
-@users           = Array.new(@number_of_users) { rand(200_000_000...800_000_000) }
 @activity        = @feed.activity(@users)
 @uid             = @users.first
 
@@ -24,7 +32,6 @@ def p(*args)
 end
 
 with_activity(@activity) do
-
   header "#{@activity.feed.provider_type} provider example"
 
   wipe

data/lib/simple-feed.rb

@@ -1 +1,3 @@
+# frozen_string_literal: true
+
 require 'simplefeed'

data/lib/simple_feed.rb

@@ -1 +1,3 @@
+# frozen_string_literal: true
+
 require 'simplefeed'

data/lib/simplefeed.rb

@@ -1,5 +1,8 @@
+# frozen_string_literal: true
+
 require 'hashie/extensions/symbolize_keys'
 require 'simplefeed/version'
+require 'hashie'
 
 Hashie.logger = Logger.new(nil)
 
@@ -17,9 +20,7 @@ module SimpleFeed
 
   class << self
     # @return [Hash<Symbol, Feed>] the registry of the defined feeds
-    def registry
-      @registry
-    end
+    attr_reader :registry
 
     # @param name [Symbol] feed name
     # @param options [Hash] any key-value pairs to set on the feed
@@ -27,9 +28,9 @@ module SimpleFeed
     # @return [Feed] the feed with the given name, and defined via options and a block
     def define(name, **options, &block)
       name = name.to_sym unless name.is_a?(Symbol)
-      feed = registry[name] ? registry[name] : SimpleFeed::Feed.new(name)
+      feed = registry[name] || SimpleFeed::Feed.new(name)
       feed.configure(options) do
-        block.call(feed) if block
+        block&.call(feed)
       end
       registry[name] = feed
       feed
@@ -50,11 +51,12 @@ module SimpleFeed
     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 +64,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/lib/simplefeed/activity/base.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module SimpleFeed
   module Activity
     class Base

data/lib/simplefeed/activity/multi_user.rb

@@ -1,10 +1,11 @@
+# frozen_string_literal: true
+
 require 'forwardable'
 require_relative 'base'
 
 module SimpleFeed
   module Activity
     class MultiUser < Base
-
       attr_reader :user_ids
 
       extend Forwardable
@@ -16,7 +17,7 @@ module SimpleFeed
       # API Examples
       # ============
       #
-      #```ruby
+      # ```ruby
       # @multi = SimpleFeed.get(:feed_name).activity(User.active.map(&:id))
       #
       # @multi.store(value:, at:)
@@ -54,15 +55,15 @@ module SimpleFeed
       # # => [Response] { user_id => [Time] last_read, ... }
       #
       # @multi.total_count
-      # # => [Response] { user_id => [Integer] total_count, ... }
+      # # => [Response] { user_id => [Integer, String] total_count, ... }
       #
       # @multi.unread_count
-      # # => [Response] { user_id => [Integer] unread_count, ... }
+      # # => [Response] { user_id => [Integer, String] unread_count, ... }
       #
       # @multi.last_read
       # # => [Response] { user_id => [Time] last_read, ... }
       #
-      #```
+      # ```
 
       SimpleFeed::Providers.define_provider_methods(self) do |instance, method, *args, **opts, &block|
         opts.merge!(user_ids: instance.user_ids)
@@ -71,8 +72,9 @@ module SimpleFeed
           opts.delete(:event)
         end
         response = instance.feed.send(method, *args, **opts, &block)
-        yield(response) if block_given?
+        block&.call(response)
         raise StandardError, "Nil response from provider #{instance.feed.provider&.provider&.class}, method #{method}(#{opts})" unless response
+
         response
       end
 

data/lib/simplefeed/activity/single_user.rb

@@ -1,8 +1,9 @@
+# frozen_string_literal: true
+
 require_relative 'base'
 
 module SimpleFeed
   module Activity
-
     # Lazy implementation of SingleUser based on delegating an array of
     # one user_id to +MultiUser+
 
@@ -16,7 +17,7 @@ module SimpleFeed
         yield(user_id)
       end
 
-      #```ruby
+      # ```ruby
       #  @activity = SimpleFeed.get(:feed_name).activity(current_user.id)
       #
       #  @activity.store(value:, at:)
@@ -61,14 +62,14 @@ module SimpleFeed
       #  @activity.last_read
       #  # => [Time] last_read
 
-
       SimpleFeed::Providers.define_provider_methods(self) do |instance, method, *args, **opts, &block|
         response = instance.user_activity.send(method, *args, **opts, &block)
         unless response.has_user?(instance.user_id)
           raise StandardError, "Nil response from provider #{instance.feed.provider&.provider&.class}, method #{method}(#{opts}) — user_id #{instance.user_id}"
         end
+
         response = response[instance.user_id]
-        yield(response) if block_given?
+        block&.call(response)
         response
       end
 

data/lib/simplefeed/dsl.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require_relative 'providers'
 require 'simplefeed'
 require_relative 'dsl/activities'
@@ -22,7 +24,7 @@ module SimpleFeed
       attr_accessor :debug
 
       def debug?
-        self.debug
+        debug
       end
     end
 

data/lib/simplefeed/dsl/activities.rb

@@ -1,8 +1,9 @@
+# frozen_string_literal: true
+
 require_relative 'formatter'
 module SimpleFeed
   module DSL
     class Activities
-
       include SimpleFeed::DSL::Formatter
 
       attr_accessor :activity, :feed
@@ -14,7 +15,7 @@ module SimpleFeed
           self.class.instance_eval do
             attr_accessor key
           end
-          self.send("#{key}=".to_sym, value)
+          send("#{key}=".to_sym, value)
         end
       end
 
@@ -60,7 +61,7 @@ module SimpleFeed
 
       def print_debug_info(method, **opts)
         brackets = opts.empty? ? ['', ''] : %w{( )}
-        printf "\n#{self.feed.name.to_s.blue}.#{method.to_s.cyan.bold}#{brackets[0]}#{opts.to_s.gsub(/[{}]/, '').blue}#{brackets[1]} \n" if SimpleFeed::DSL.debug?
+        printf "\n#{feed.name.to_s.blue}.#{method.to_s.cyan.bold}#{brackets[0]}#{opts.to_s.gsub(/[{}]/, '').blue}#{brackets[1]} \n" if SimpleFeed::DSL.debug?
         response = yield if block_given?
         puts response.inspect.yellow if SimpleFeed::DSL.debug?
         response

data/lib/simplefeed/dsl/formatter.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'simplefeed/dsl'
 require 'simplefeed/activity/single_user'
 require 'simplefeed/activity/multi_user'
@@ -13,9 +15,9 @@ module SimpleFeed
 
       def color_dump(this_activity = activity)
         this_activity = if this_activity.is_a?(SimpleFeed::Activity::SingleUser)
-                      this_activity.feed.activity([this_activity.user_id])
-                    else
-                      this_activity
+                          this_activity.feed.activity([this_activity.user_id])
+                        else
+                          this_activity
                     end
         _puts
 
@@ -32,8 +34,7 @@ module SimpleFeed
 
             [['User ID', user_id, "\n"],
              ['Activities', sprintf('%d total, %d unread', total_count[user_id], unread_count[user_id]), "\n"],
-             ['Last Read', this_last_read ? Time.at(this_last_read) : 'N/A'],
-            ].each do |field, value, *args|
+             ['Last Read', this_last_read ? Time.at(this_last_read) : 'N/A'],].each do |field, value, *args|
               field(field, value, *args)
             end
 
@@ -42,7 +43,6 @@ module SimpleFeed
             this_events       = fetch[user_id]
             this_events_count = this_events.size
             this_events.each_with_index do |_event, _index|
-
               if this_last_event_at.nil? && _event.at < this_last_read
                 print_last_read_separator(this_last_read)
               elsif this_last_event_at && this_last_read < this_last_event_at && this_last_read > _event.at
@@ -86,12 +86,12 @@ module SimpleFeed
 
     def field_value(value)
       case value
-        when Numeric
-          sprintf '%-20d', value
-        when Time
-          sprintf '%-30s', value.strftime(TIME_FORMAT)
-        else
-          sprintf '%-20s', value.to_s
+      when Numeric
+        sprintf '%-20d', value
+      when Time
+        sprintf '%-30s', value.strftime(TIME_FORMAT)
+      else
+        sprintf '%-20s', value.to_s
       end
     end
 

data/lib/simplefeed/event.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'json'
 
 module SimpleFeed
@@ -6,7 +8,7 @@ module SimpleFeed
     include Comparable
 
     def initialize(*args, value: nil, at: Time.now)
-      if args && args.size > 0
+      if args && !args.empty?
         self.value = args[0]
         self.at    = args[1]
       end
@@ -44,7 +46,7 @@ module SimpleFeed
       self.value.hash
     end
 
-    def to_json
+    def to_json(*_args)
       to_h.to_json
     end
 
@@ -75,6 +77,5 @@ module SimpleFeed
         raise ArgumentError, "Required arguments missing, value=[#{value}], at=[#{at}]"
       end
     end
-
   end
 end

data/lib/simplefeed/feed.rb

@@ -1,10 +1,11 @@
+# frozen_string_literal: true
+
 require_relative 'providers'
 require_relative 'activity/base'
 require 'simplefeed/key/template'
 
 module SimpleFeed
   class Feed
-
     attr_accessor :per_page, :max_size, :batch_size, :meta, :namespace
     attr_reader :name
 
@@ -18,14 +19,10 @@ module SimpleFeed
       # set the defaults if not passed in
       @meta         = {}
       @namespace    = nil
-      @per_page     ||= 50
-      @max_size     ||= 1000
-      @batch_size   ||= 10
-      @proxy        = nil
-    end
-
-    def key_template
-      SimpleFeed::Key::Template.new(namespace)
+      @per_page ||= 50
+      @max_size ||= 1000
+      @batch_size ||= 10
+      @proxy = nil
     end
 
     def provider=(definition)
@@ -38,10 +35,6 @@ module SimpleFeed
       @proxy
     end
 
-    def key(user_id)
-      SimpleFeed::Providers::Key.new(user_id, key_template)
-    end
-
     def provider_type
       SimpleFeed::Providers::Base::Provider.class_to_registry(@proxy.provider.class)
     end
@@ -61,28 +54,32 @@ module SimpleFeed
         user_activity(one_or_more_users)
     end
 
-    # @deprecated Please use {#activity} instead
-    def for(*args)
-      STDERR.puts 'WARNING: method #for is deprecated, please use #activity'
-      activity(*args)
-    end
-
     def configure(hash = {})
       SimpleFeed.symbolize!(hash)
       class_attrs.each do |attr|
-        self.send("#{attr}=", hash[attr]) if hash.key?(attr)
+        send("#{attr}=", hash[attr]) if hash.key?(attr)
       end
       yield self if block_given?
     end
 
+    def key(user_id)
+      SimpleFeed::Providers::Key.new(user_id, key_template)
+    end
+
     def eql?(other)
       other.class == self.class &&
-        %i(per_page max_size name).all? { |m| self.send(m).equal?(other.send(m)) } &&
-        self.provider.provider.class == other.provider.provider.class
+        %i(per_page max_size name).all? { |m| send(m).equal?(other.send(m)) } &&
+        provider.provider.class == other.provider.provider.class
     end
 
     def class_attrs
       SimpleFeed.class_attributes(self.class)
     end
+
+    private
+
+    def key_template
+      SimpleFeed::Key::Template.new(namespace)
+    end
   end
 end

data/lib/simplefeed/key/template.rb

@@ -1,14 +1,15 @@
+# frozen_string_literal: true
+
 require 'base62-rb'
 require 'hashie/mash'
 
 module SimpleFeed
   module Key
-
     class TextTemplate < Struct.new(:text)
       def render(params = {})
-        output = self.text.dup
+        output = text.dup
         params.each_pair do |key, value|
-          output.gsub!(%r[{{\s*#{key}\s*}}], value.to_s)
+          output.gsub!(/{{\s*#{key}\s*}}/, value.to_s)
         end
         output
       end
@@ -21,8 +22,7 @@ module SimpleFeed
 
       def initialize(namespace,
                      key_types = DEFAULT_TYPES,
-                     text_template = DEFAULT_TEXT_TEMPLATE
-      )
+                     text_template = DEFAULT_TEXT_TEMPLATE)
 
         self.namespace     = namespace
         self.key_types     = key_types
@@ -43,10 +43,6 @@ module SimpleFeed
       def key_names
         key_types.map(&:name).map(&:to_s).sort
       end
-
-      private
-
     end
   end
 end
-