simple-feed 2.1.0 → 3.2.0

data/Rakefile

@@ -11,7 +11,7 @@ def shell(*args)
 end
 
 task :permissions do
-  shell('rm -rf pkg/ tmp/ coverage/')
+  shell('rm -rf pkg/')
   shell("chmod -v o+r,g+r * */* */*/* */*/*/* */*/*/*/* */*/*/*/*/*")
   shell("find . -type d -exec chmod o+x,g+x {} \\;")
 end

data/codecov.yml

@@ -0,0 +1,28 @@
+codecov:
+  require_ci_to_pass: no
+
+  notify:
+    after_n_builds: 30
+    wait_for_ci: yes
+
+parsers:
+  v1:
+    include_full_missed_files: true # To use with Ruby so we see files that have NO tests written
+
+coverage:
+  precision: 1
+  status:
+    project:
+      default: off
+      simplefeed:
+        target: 90%
+        threshold: 100%
+        informational: true
+        if_not_found: success
+        if_ci_failed: error
+        paths:
+          - lib/
+flags:
+  simplefeed:
+    paths:
+      - lib/

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
@@ -14,8 +17,6 @@ srand(Time.now.to_i % 100003)
   n % 2 == 0 ? UUID.generate : rand(100003)
 end
 
-pp @users
-
 @activity        = @feed.activity(@users)
 @uid             = @users.first
 
@@ -28,47 +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)'
+
+  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) }
 
-  hr
+  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/simplefeed/activity/single_user.rb

@@ -74,8 +74,8 @@ module SimpleFeed
       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/formatter.rb

@@ -1,8 +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
@@ -18,40 +22,43 @@ module SimpleFeed
                           this_activity.feed.activity([this_activity.user_id])
                         else
                           this_activity
-                    end
+                        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)
+              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,8 +90,6 @@ module SimpleFeed
       sprintf ' %20s ', text
     end
 
-    TIME_FORMAT = '%Y-%m-%d %H:%M:%S.%L'
-
     def field_value(value)
       case value
       when Numeric
@@ -95,22 +101,55 @@ module SimpleFeed
       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/event.rb

@@ -5,8 +5,24 @@ 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.empty?
         self.value = args[0]
@@ -22,7 +38,11 @@ module SimpleFeed
     end
 
     def time
+      return nil unless Event.is_time[at]
+
       Time.at(at)
+    rescue ArgumentError
+      nil
     end
 
     def <=>(other)
@@ -38,10 +58,6 @@ module SimpleFeed
         self.value == other.value
     end
 
-    def to_h
-      { value: value, at: at, time: time }
-    end
-
     def hash
       self.value.hash
     end
@@ -54,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

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/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