simple-feed 2.1.0 → 3.0.1

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.rb

@@ -11,43 +11,48 @@ Hashie.logger = Logger.new(nil)
 require 'simplefeed/providers/redis'
 require 'simplefeed/providers/hash'
 require 'simplefeed/dsl'
+require 'simplefeed/feed'
 
 # Main namespace module for the SimpleFeed gem. It provides several shortcuts and entry
 # points into the library, such as ability to define and fetch new feeds via +define+,
 # and so on.
 module SimpleFeed
+  TIME_FORMAT = '%Y-%m-%d %H:%M:%S.%L'
+
   @registry = {}
 
   class << self
-    # @return [Hash<Symbol, Feed>] the registry of the defined feeds
+    # @return Hash<Symbol, Feed> the registry of the defined feeds
     attr_reader :registry
 
-    # @param name [Symbol] feed name
-    # @param options [Hash] any key-value pairs to set on the feed
+    # @param <Symbol> name of the feed
+    # @param <Hash> options any key-value pairs to set on the feed
     #
-    # @return [Feed] the feed with the given name, and defined via options and a block
-    def define(name, **options, &block)
+    # @return [Feed]  the feed with the given name, and defined via options and a block
+    def define(name, **options)
       name = name.to_sym unless name.is_a?(Symbol)
-      feed = registry[name] || SimpleFeed::Feed.new(name)
-      feed.configure(options) do
-        block&.call(feed)
+
+      registry[name] ||= Feed.new(name)
+      registry[name].tap do |feed|
+        feed.configure(options) do
+          yield(feed) if block_given?
+        end
       end
-      registry[name] = feed
-      feed
     end
 
-    # @return [Feed] the pre-defined feed with the given name
+    # @param [Symbol] name
+    # @return <Feed> the pre-defined feed with the given name
     def get(name)
       registry[name.to_sym]
     end
 
     # A factory method that constructs an instance of a provider based on the provider name and arguments.
     #
-    # @param provider_name [Symbol] short name of the provider, eg, :redis, :hash, etc.
-    # @params args [Array] constructor array arguments of the provider
-    # @params opts [Hash] constructor hash arguments of the provider
+    # @param <Symbol> provider_name short name of the provider, eg, :redis, :hash, etc.
+    # @param <Array> args constructor array arguments of the provider
+    # @param <Hash, NilClass> opts constructor hash arguments of the provider
     #
-    # @return [Provider]
+    # @return <Provider>
     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

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,11 @@
 # frozen_string_literal: true
 
+require 'tty-box'
+require 'tty-screen'
 require 'simplefeed/dsl'
 require 'simplefeed/activity/single_user'
 require 'simplefeed/activity/multi_user'
+
 module SimpleFeed
   module DSL
     # This module exports method #color_dump which receives an activity and
@@ -18,27 +21,30 @@ 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} » " }) { fields.map(&:green) }
 
             this_events       = fetch[user_id]
             this_events_count = this_events.size
@@ -50,7 +56,7 @@ module SimpleFeed
               end
 
               this_last_event_at = _event.at # float
-              _print "[%2d] %16s %s\n", _index, _event.time.strftime(TIME_FORMAT).blue.bold, _event.value
+              output "[%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
                 print_last_read_separator(this_last_read)
               end
@@ -60,17 +66,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 +89,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 +100,52 @@ 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
     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:     :bright_red,
+               border: { fg: :white }
+             }, &block
     end
 
-    def _hr(char = '—')
-      char * 75 + "\n"
+    def header(*args, **opts)
+      message = args.join("\n")
+      msg = block_given? ? (yield || message) : message + "\n"
+      box = TTY::Box.frame(box_config(**opts)) { Array(msg).join("\n") }
+      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: [0, 3],
+        style:   {
+          fg:     :bright_yellow,
+          border: {
+            fg: :bright_magenta,
+          }
+        }
+      }.merge(opts)
     end
   end
 end

data/lib/simplefeed/event.rb

@@ -7,6 +7,21 @@ module SimpleFeed
     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 +37,11 @@ module SimpleFeed
     end
 
     def time
+      return nil unless Event.is_time[at]
+
       Time.at(at)
+    rescue ArgumentError
+      nil
     end
 
     def <=>(other)
@@ -38,10 +57,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 +69,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