simple-feed 2.0.2 → 3.1.2

data/examples/shared/provider_example.rb

@@ -1,3 +1,6 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
 $LOAD_PATH.unshift File.expand_path('../../../lib', __FILE__)
 
 # Please set @feed in the enclosing context
@@ -5,9 +8,15 @@ $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
 
-@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
 
@@ -20,48 +29,64 @@ class Object
 end
 
 def p(*args)
-  printf "%-40s %s\n", args[0].blue, args[1].bold.red
+  printf "%40s  ❯ %s\n", args[0].strip.blue.bold, args[1].bold.red
 end
 
 with_activity(@activity) do
-
-  header "#{@activity.feed.provider_type} provider example"
+  header "#{@activity.feed.provider_type} provider example".upcase,
+         "Starting with a blank feed, no items",
+         align: :center
 
   wipe
 
-  store('value one') { p 'storing new value', 'value one' }
-  store('value two') { p 'storing new value', 'value two' }
-  store('value three') { p 'storing new value', 'value three' }
-
-  hr
+  store('value one')        { p 'storing new value', 'value one' }
+  store('value two')        { p 'storing new value', 'value two' }
+  store('value three')      { p 'storing new value', 'value three' }
 
-  total_count { |r| p 'total_count is now', "#{r[@uid]._v}" }
-  unread_count { |r| p 'unread_count is now', "#{r[@uid]._v}" }
+  total_count               { |r| p 'total_count is now', "#{r[@uid]._v}" }
+  unread_count              { |r| p 'unread_count is now', "#{r[@uid]._v}" }
 
-  header 'paginate(page: 1, per_page: 2)'
+  header 'activity.paginate(page: 1, per_page: 2)'
   paginate(page: 1, per_page: 2) { |r| puts r[@uid].map(&:to_color_s) }
-  header 'paginate(page: 2, per_page: 2, reset_last_read: true)'
-  paginate(page: 2, per_page: 2, reset_last_read: true) { |r| puts r[@uid].map(&:to_color_s) }
 
-  hr
+  header 'activity.paginate(page: 2, per_page: 2, reset_last_read: true)'
+  paginate(page: 2, per_page: 2, reset_last_read: true) { |r| puts r[@uid].map(&:to_color_s) }
 
-  total_count { |r| p 'total_count ', "#{r[@uid]._v}" }
-  unread_count { |r| p 'unread_count ', "#{r[@uid]._v}" }
+  total_count           { |r| p 'total_count ', "#{r[@uid]._v}" }
+  unread_count              { |r| p 'unread_count ', "#{r[@uid]._v}" }
 
-  hr
-  store('value four') { p 'storing', 'value four' }
+  store('value four')   { p 'storing', 'value four' }
 
   color_dump
 
   header 'deleting'
 
-  delete('value three') { p 'deleting', 'value three' }
-  total_count { |r| p 'total_count ', "#{r[@uid]._v}" }
-  unread_count { |r| p 'unread_count ', "#{r[@uid]._v}" }
+  delete('value three')     { p 'deleting', 'value three' }
+
+  total_count               { |r| p 'total_count ', "#{r[@uid]._v}" }
+  unread_count              { |r| p 'unread_count ', "#{r[@uid]._v}" }
+
   hr
-  delete('value four') { p 'deleting', 'value four' }
-  total_count { |r| p 'total_count ', "#{r[@uid]._v}" }
-  unread_count { |r| p 'unread_count ', "#{r[@uid]._v}" }
 
+  delete('value four')      { p 'deleting', 'value four' }
+  total_count               { |r| p 'total_count ', "#{r[@uid]._v}" }
+  unread_count              { |r| p 'unread_count ', "#{r[@uid]._v}" }
+
+  puts
+end
+
+notes = [
+  'Thanks for trying SimpleFeed!', 'For any questions, reach out to',
+  'kigster@gmail.com',
+]
+
+unless ENV['REDIS_DEBUG']
+  notes << [
+  '———',
+    'To see REDIS commands, set REDIS_DEBUG environment variable to true,',
+    'and re-run the example.'
+  ]
 end
 
+header notes.flatten,
+       align: :center

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/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,20 +62,20 @@ 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
 
       def initialize(user_id:, feed:)
-        @feed              = feed
-        @user_id           = user_id
+        @feed = feed
+        @user_id = user_id
         self.user_activity = MultiUser.new(feed: feed, user_ids: [user_id])
       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,6 +1,12 @@
+# frozen_string_literal: true
+
+require 'tty-box'
+require 'tty-screen'
 require 'simplefeed/dsl'
 require 'simplefeed/activity/single_user'
 require 'simplefeed/activity/multi_user'
+require 'awesome_print'
+
 module SimpleFeed
   module DSL
     # This module exports method #color_dump which receives an activity and
@@ -13,45 +19,46 @@ 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
-                    end
+                          this_activity.feed.activity([this_activity.user_id])
+                        else
+                          this_activity
+                        end
         _puts
 
-        header do
-          field('Feed Name', feed.name, "\n")
-          field('Provider', feed.provider.provider.class, "\n")
-          field('Max Size', feed.max_size, "\n")
+        feed_header(feed) do
+          [
+            field('Feed Name', feed.name, "\n"),
+            field('Provider', feed.provider.provider.class, "\n"),
+            field('Max Size', feed.max_size, "\n")
+          ]
         end
 
         with_activity(this_activity) do
-          this_activity.each do |user_id|
+          this_activity.each_with_index do |user_id, index|
             this_last_event_at = nil
             this_last_read     = (last_read[user_id] || 0.0).to_f
 
+            fields = []
             [['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|
-              field(field, value, *args)
+             ['Last Read', this_last_read ? Time.at(this_last_read) : 'N/A'],].each do |field, value, *args|
+              fields << field(field, value, *args)
             end
 
-            _puts; hr '¨'
+            header(title: { top_center: " « User Activity #{index + 1} » " }, style: { fg: :green }) { fields }
 
             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
+            this_events.each_with_index do |evt, idx|
+              if this_last_event_at.nil? && evt.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
+              elsif this_last_event_at && this_last_read < this_last_event_at && this_last_read > evt.at
                 print_last_read_separator(this_last_read)
               end
 
-              this_last_event_at = _event.at # float
-              _print "[%2d] %16s %s\n", _index, _event.time.strftime(TIME_FORMAT).blue.bold, _event.value
-              if _index == this_events_count - 1 && this_last_read < _event.at
+              this_last_event_at = evt.at # float
+              output "[%2d] %16s %s\n", idx, evt.time.strftime(TIME_FORMAT).blue.bold, evt.value
+              if idx == this_events_count - 1 && this_last_read < evt.at
                 print_last_read_separator(this_last_read)
               end
             end
@@ -60,17 +67,18 @@ module SimpleFeed
       end
 
       def print_last_read_separator(lr)
-        _print ">>>> %16s <<<< last read\n", Time.at(lr).strftime(TIME_FORMAT).red.bold
+        output "———— %16s [last read] ———————————— \n", Time.at(lr).strftime(TIME_FORMAT).red.bold
       end
     end
 
+    # This allows redirecting output in tests.
     @print_method = :printf
 
     class << self
       attr_accessor :print_method
     end
 
-    def _print(*args, **opts, &block)
+    def output(*args, **opts, &block)
       send(SimpleFeed::DSL.print_method, *args, **opts, &block)
     end
 
@@ -82,35 +90,66 @@ module SimpleFeed
       sprintf ' %20s ', text
     end
 
-    TIME_FORMAT = '%Y-%m-%d %H:%M:%S.%L'
-
     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
 
-    def field(label, value, sep = '')
-      _print field_label(label).italic + field_value(value).cyan.bold + sep
+    def field(label, value, _sep = '')
+      field_label(label) + ' ❯ ' + field_value(value)
+    end
+
+    def hr
+      output hr_string.magenta
+    end
+
+    def hr_string
+      '―' * width + "\n"
+    end
+
+    def width
+      @width ||= [[TTY::Screen.width - 5, 60].max, 75].min
     end
 
-    def hr(char = '—')
-      _print(_hr(char).magenta)
+    def feed_header(feed, &block)
+      header title:  { top_left: " « #{feed.name.capitalize} Feed » " },
+             border: :thick,
+             style:  {
+               fg:     :black,
+               bg:     :green,
+               border: { fg: :bright_black, bg: :green }
+             }, &block
     end
 
-    def _hr(char = '—')
-      char * 75 + "\n"
+    def header(*args, **opts)
+      message = args.join("\n")
+      msg     = block_given? ? (yield || message) : message + "\n"
+      config  = box_config(**opts)
+      lines   = Array(msg).flatten
+      box     = TTY::Box.frame(*lines, **config)
+      output "\n#{box}"
     end
 
-    def header(message = nil)
-      _print(_hr.green.bold)
-      block_given? ? yield : _print(message.green.italic + "\n")
-      _print(_hr.green.bold)
+    private
+
+    def box_config(**opts)
+      {
+        width:   width,
+        align:   :left,
+        padding: [1, 3],
+        style:   {
+          fg:     :bright_yellow,
+          border: {
+            fg: :bright_magenta,
+          }
+        }
+      }.merge(opts)
     end
   end
 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/event.rb

@@ -1,12 +1,30 @@
+# frozen_string_literal: true
+
 require 'json'
 
 module SimpleFeed
   class Event
     attr_accessor :value, :at
+
     include Comparable
 
+    class << self
+      attr_accessor :is_time
+    end
+
+    # This proc can be overridden in a configuration if needed.
+    # @example To always assume this is time, set it like so,
+    # before defining your feeds.
+    #
+    #     SimpleFeed::Event.is_time = ->(*) { true }
+    #
+    self.is_time = ->(float) {
+      # assume it's time if epoch is > June 1974 and < December 2040.
+      float < 2_237_932_800.0 && float > 139_276_800.0
+    }
+
     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
@@ -20,7 +38,11 @@ module SimpleFeed
     end
 
     def time
+      return nil unless Event.is_time[at]
+
       Time.at(at)
+    rescue ArgumentError
+      nil
     end
 
     def <=>(other)
@@ -36,15 +58,11 @@ module SimpleFeed
         self.value == other.value
     end
 
-    def to_h
-      { value: value, at: at, time: time }
-    end
-
     def hash
       self.value.hash
     end
 
-    def to_json
+    def to_json(*_args)
       to_h.to_json
     end
 
@@ -52,16 +70,38 @@ module SimpleFeed
       YAML.dump(to_h)
     end
 
+    def to_h
+      return @to_h if @to_h
+
+      @to_h ||= { value: value, at: at }
+      @to_h.merge!(time: time) if time
+      @to_h
+    end
+
     def to_s
-      "<SimpleFeed::Event: value='#{value}', at='#{at}', time='#{time}'>"
+      return @to_s if @to_s
+
+      output = StringIO.new
+      output.print "<SimpleFeed::Event: "
+      output.print(time.nil? ? "[#{at}]" : "[#{time&.strftime(::SimpleFeed::TIME_FORMAT)}]")
+      output.print ", [\"#{value}\"]"
+      @to_s = output.string
     end
 
+    COLOR_MAP = {
+      1 => ->(word) { word.green.bold },
+      3 => ->(word) { word.yellow.bold },
+    }.freeze
+
     def to_color_s
-      counter = 0
-      to_s.split(/[']/).map do |word|
-        counter += 1
-        counter.even? ? word.yellow.bold : word.blue
-      end.join('')
+      return @to_color_s if @to_color_s
+
+      output = StringIO.new
+      to_s.split(/[\[\]]/).each_with_index do |word, index|
+        output.print(COLOR_MAP[index]&.call(word) || word.cyan)
+      end
+      output.print '>'
+      @to_color_s = output.string
     end
 
     def inspect
@@ -75,6 +115,5 @@ module SimpleFeed
         raise ArgumentError, "Required arguments missing, value=[#{value}], at=[#{at}]"
       end
     end
-
   end
 end

data/lib/simplefeed/feed.rb

@@ -1,11 +1,18 @@
+# frozen_string_literal: true
+
 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,
+                  :namespace,
+                  :data_key_transformer,
+                  :meta_key_transformer
 
-    attr_accessor :per_page, :max_size, :batch_size, :meta, :namespace
     attr_reader :name
 
     SimpleFeed::Providers.define_provider_methods(self) do |feed, method, opts, &block|
@@ -13,23 +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
-      @per_page     ||= 50
-      @max_size     ||= 1000
-      @batch_size   ||= 10
-      @proxy        = nil
-    end
-
-    def key_template
-      SimpleFeed::Key::Template.new(namespace)
+      @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
@@ -38,10 +43,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 +62,35 @@ 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,
+                                     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| self.send(m).equal?(other.send(m)) } &&
-        self.provider.provider.class == other.provider.provider.class
+        %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
 
     def class_attrs
       SimpleFeed.class_attributes(self.class)
     end
+
+    private
+
+    def key_template
+      SimpleFeed::Key::Template.new(namespace)
+    end
   end
 end