chrono_trigger 1.0.0 → 1.0.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: cbca0c2caa1b69582cd2e5e35bb6df578b9ae913d2da07f8e3b84d76c812ade7
-  data.tar.gz: 02c0808b8df6dc06be2aa7c8812f1cac72bfb53192c97acb0ba9ba6a48f5225e
+  metadata.gz: 02eacba629d85393eb1079826cea360b4b9bf4c6ab98e21df5a3d0359fc017ec
+  data.tar.gz: 86fc4dc406ad41a089a62ee674e579f30969fe4d680cd29a2eee14749ae61c1b
 SHA512:
-  metadata.gz: 016a3b4aacbf0c960de0c17885287eb4505da012d130eb6c0ea9a96cd4098d1848cc37af9072d4907816e3c25bc6d2f712ef0f449245cff598020cad6bea184d
-  data.tar.gz: dfb36735721ce71346ac77bbd0a031f91ffa98082850f89fc1d201a5dafe6de0875cfe36fa6c95f6b39b3233593b5e0006c3bc6792eb2d887991fc19806f74c6
+  metadata.gz: cac2cd072ad1f2fa00fc7f024ab6819a778f50a602d60018c770e7fdddfe5e8c5789b54e16da8aa9c25cd9f8f8206f64c02e65bfe1417baea4983a340821a78c
+  data.tar.gz: f6d6c901a5e73ac682ed954f92b2878ad5ec7c975ca27c86dfd8f571b2434765290c1b55b994888c86b12c57688ec2b886dd74d38fa3370f0c467b2d67e80a13

data/README.md

@@ -1,2 +1,89 @@
-# Initial page
+---
+description: Make Rails apps that feel alive.
+---
+
+# ChronoTrigger
+
+[![GitHub stars](https://img.shields.io/github/stars/leastbad/chrono_trigger?style=social)](https://github.com/leastbad/chrono_trigger) [![GitHub forks](https://img.shields.io/github/forks/leastbad/chrono_trigger?style=social)](https://github.com/leastbad/chrono_trigger) [![Twitter follow](https://img.shields.io/twitter/follow/theleastbad?style=social)](https://twitter.com/theleastbad) [![Discord](https://img.shields.io/discord/681373845323513862)](https://discord.gg/GnweR3)
+
+ChronoTrigger is a clock-based scheduler that runs inside your Rails app. Use it to run code \(events\) at specific times and intervals.
+
+![](.gitbook/assets/chrono-trigger.jpg)
+
+## Why use ChronoTrigger?
+
+Nobody wants to be the first person to arrive at a club, and yet, this is exactly what most app onboarding processes feel like.
+
+A typical visitor will spend _7-12 seconds_ evaluating your hard work before deciding if they will engage. You must convey that _exciting things are happening_, or they will close the tab and forget you exist.
+
+**ChronoTrigger is a tool designed to breathe life into otherwise static user interfaces and onboarding experiences.**
+
+It allows you to subtly expose users to a crafted narrative that nudges them forward, without feeling like a canned theme park ride. The story is advanced by their actions and their engagement is rewarded with simulated interaction, even if they are user number one.
+
+## Is ChronoTrigger for you?
+
+If you spend months building something cool, and then hustle to get people to check it out, you get exactly one chance to make your first and only impression. It's up to you to do everything you can to make sure that your app is special enough to love. To succeed long-term, you need these first users to become cheerleaders and evangelize to their friends.
+
+If you think about the stand-out [onboarding success stories](https://www.useronboard.com/user-onboarding-teardowns/) like Slack, they all prioritize anticipating what the user will be thinking, feeling and wondering during each _moment_ of the first minutes the user spends on the site.
+
+ChronoTrigger is for developers who are proud of what they have created; tech founders looking for a way to give new users an aspirational story to tell themselves. This converging path leads to feelings of ownership and drives conversion without a hard sell.
+
+You will use ChronoTrigger to orchestrate the onboarding experience your app deserves:
+
+* interactive demos, charts and UI elements
+* automation / wizards that feel personal
+* placeholder content that changes to help tell a story
+* a path through features instead of just clicking everything
+* simulated human responses and exchanges
+
+### Why not ActiveJob?
+
+ActiveJob is amazing, but creating Jobs for typical ChronoTrigger use cases feels like taking a taxi to the next house.
+
+Jobs are not designed to run immediately, and priority should be given to important things like mail delivery. There's also functionality in the Event class that would be hard to retrofit to Job classes.
+
+It's also worth mentioning that requiring Sidekiq would require Heroku users to set up a worker dyno, even if you're not using ActiveJob. Finally, Sidekiq sometimes runs jobs multiple times!
+
+## How does ChronoTrigger work?
+
+ChronoTrigger runs on real world time, like trains. Every second, on the second, ChronoTrigger decides whether there are new events to run. If so, there's a thread-safe and highly-optimized pool of workers waiting.
+
+{% hint style="info" %}
+Other event scheduling libraries tend to be either `cron` wrappers or use timing offsets \(think: `sleep 1`\) from whenever they are called and don't factor in their own timing footprint. In other words, 1000 loops later, more than 1000 seconds have passed. No good!
+{% endhint %}
+
+You start the ChronoTrigger Clock after your web server, and it runs inside your Rails app process.
+
+ChronoTrigger Events live in `app/events` and follow a structure that will be familiar to ActiveJob users.
+
+You can schedule Events from anywhere in your application that it makes sense to do so, such as:
+
+* Controller actions and webhook callbacks
+* ActiveRecord model callbacks
+* Devise session/registration callbacks
+* Reflex action methods
+* ActionCable Connection/Channel subscription callbacks
+
+## Design concepts and goals
+
+* Not a replacement for ActiveJob \(or cron!\)
+* Events are ephemeral and disposable; failure should be fine 🤷
+* Borrow the best ideas from the ActiveJob and CableReady APIs
+* ActiveSupport::TimeWithZone all the way down
+* All times are today, rounded to 1s for easy comparison
+* Times are memoized to avoid side effects
+* Events should be short term and soon; _there is no tomorrow_
+* Run in-process with no additional infrastructure dependencies
+
+## Key features and advantages
+
+* A natural fit with [CableReady](https://cableready.stimulusreflex.com/)
+* Easy to learn, quick to implement
+* Plays well with tools such as [StimulusReflex](https://docs.stimulusreflex.com/) and [Turbo Drive](https://turbo.hotwire.dev/handbook/drive)
+* Configurable via an optional initializer file
+* Worker pool provided by the excellent [concurrent-ruby](https://github.com/ruby-concurrency/concurrent-ruby) library
+
+## Try it now
+
+![](.gitbook/assets/soon.jpg)
 

data/SUMMARY.md

@@ -1,4 +1,8 @@
 # Table of contents
 
-* [Initial page](README.md)
+* [ChronoTrigger](README.md)
+* [Setup](setup.md)
+* [Events](events.md)
+* [The Clock](the-clock.md)
+* [The Timeline](the-timeline.md)
 

data/lib/chrono_trigger.rb

@@ -4,6 +4,8 @@ require "rails/engine"
 require "active_support/all"
 require "singleton"
 require "concurrent-edge"
+require "chrono_trigger/helpers/mitf"
+require "chrono_trigger/helpers/now"
 require "chrono_trigger/clock"
 require "chrono_trigger/config"
 require "chrono_trigger/event"

data/lib/chrono_trigger/event.rb

@@ -15,7 +15,6 @@ module ChronoTrigger
           after: @after
         )
         new(options, args)
-        id
       end
 
       def scope(value)
@@ -43,7 +42,6 @@ module ChronoTrigger
         return self unless value
         value = Time.zone.parse(value) if value.is_a?(String)
         @at = moment_in_the_future(value) if value.is_a?(ActiveSupport::TimeWithZone)
-        puts @at.class
         self
       end
 
@@ -63,15 +61,7 @@ module ChronoTrigger
 
       private
 
-      def moment_in_the_future(time_with_zone)
-        Time.zone.today + time_with_zone.hour.hours + time_with_zone.min.minutes + time_with_zone.sec.seconds
-      end
-    end
-
-    class LostInTimeError < StandardError
-    end
-
-    class TodayIsTomorrowsYesterday < StandardError
+      include ChronoTrigger::Helpers::MITF
     end
 
     attr_reader :id, :scope, :args, :every, :before, :after, :purge
@@ -98,15 +88,11 @@ module ChronoTrigger
       @purge = true
     end
 
-    def right_now
-      now = Time.zone.now
-      Time.zone.today + now.hour.hours + now.min.minutes + now.sec.seconds
-    end
+    include ChronoTrigger::Helpers::MITF
+    include ChronoTrigger::Helpers::Now
 
-    def moment_in_the_future(time_with_zone)
-      raise(LostInTimeError, "Argument must be of type ActiveSupport::TimeWithZone eg. right_now + 1.second") unless time_with_zone.is_a?(ActiveSupport::TimeWithZone)
-      raise(TodayIsTomorrowsYesterday, "Time must be in the future eg. 1.second.from_now") unless time_with_zone.future?
-      Time.zone.today + time_with_zone.hour.hours + time_with_zone.min.minutes + time_with_zone.sec.seconds
+    def to_s
+      inspect
     end
 
     private

data/lib/chrono_trigger/helpers/mitf.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module ChronoTrigger
+  module Helpers
+    module MITF
+      class LostInTimeError < StandardError
+      end
+  
+      class TodayIsTomorrowsYesterday < StandardError
+      end
+      
+      def moment_in_the_future(time_with_zone)
+        raise(LostInTimeError, "Argument must be of type ActiveSupport::TimeWithZone eg. right_now + 1.second") unless time_with_zone.is_a?(ActiveSupport::TimeWithZone)
+        raise(TodayIsTomorrowsYesterday, "Time must be in the future eg. 1.second.from_now") unless time_with_zone.future?
+        Time.zone.today + time_with_zone.hour.hours + time_with_zone.min.minutes + time_with_zone.sec.seconds
+      end
+    end
+  end
+end

data/lib/chrono_trigger/helpers/now.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+module ChronoTrigger
+  module Helpers
+    module Now
+      def right_now
+        now = Time.zone.now
+        Time.zone.today + now.hour.hours + now.min.minutes + now.sec.seconds
+      end
+    end
+  end
+end

data/lib/chrono_trigger/schedule.rb

@@ -19,6 +19,8 @@ module ChronoTrigger
     end
 
     def remove(uuid)
+      return self unless uuid
+      uuid = uuid.id if uuid.is_a?(ChronoTrigger::Event)
       uuid_regex = /^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$/
       @events.each { |event| event.purge! if event.id == uuid } if uuid && uuid_regex.match?(uuid.to_s.downcase)
       self
@@ -63,9 +65,6 @@ module ChronoTrigger
 
     private
 
-    def right_now
-      now = Time.zone.now
-      Time.zone.today + now.hour.hours + now.min.minutes + now.sec.seconds
-    end
+    include ChronoTrigger::Helpers::Now
   end
 end

data/lib/chrono_trigger/timeline.rb

@@ -4,25 +4,11 @@ module ChronoTrigger
   module Timeline
     extend ::ActiveSupport::Concern
 
-    class LostInTimeError < StandardError
-    end
-
-    class TodayIsTomorrowsYesterday < StandardError
-    end
-
     def chrono_trigger
       ChronoTrigger::Schedule.instance
     end
 
-    def right_now
-      now = Time.zone.now
-      Time.zone.today + now.hour.hours + now.min.minutes + now.sec.seconds
-    end
-
-    def moment_in_the_future(time_with_zone)
-      raise(LostInTimeError, "Argument must be of type ActiveSupport::TimeWithZone eg. right_now + 1.second") unless time_with_zone.is_a?(ActiveSupport::TimeWithZone)
-      raise(TodayIsTomorrowsYesterday, "Time must be in the future eg. 1.second.from_now") unless time_with_zone.future?
-      Time.zone.today + time_with_zone.hour.hours + time_with_zone.min.minutes + time_with_zone.sec.seconds
-    end
+    include ChronoTrigger::Helpers::MITF
+    include ChronoTrigger::Helpers::Now
   end
 end

data/lib/chrono_trigger/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module ChronoTrigger
-  VERSION = "1.0.0"
+  VERSION = "1.0.5"
 end

data/lib/chrono_trigger/worker.rb

@@ -4,7 +4,7 @@ module ChronoTrigger
   class Worker < Concurrent::Actor::RestartingContext
     def on_message(event)
       Rails.logger.debug "ChronoTrigger: #{event.inspect}"
-      event.perform(*event.args) if event.at.nil? || (event.before && event.at < event.before)
+      event.perform(*event.args) if event.at.nil? || (event.at && event.before.nil?) || (event.before && event.at < event.before)
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: chrono_trigger
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.0.5
 platform: ruby
 authors:
 - leastbad
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-04-12 00:00:00.000000000 Z
+date: 2021-04-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -161,14 +161,18 @@ files:
 - lib/chrono_trigger/clock.rb
 - lib/chrono_trigger/config.rb
 - lib/chrono_trigger/event.rb
+- lib/chrono_trigger/helpers/mitf.rb
+- lib/chrono_trigger/helpers/now.rb
 - lib/chrono_trigger/schedule.rb
 - lib/chrono_trigger/timeline.rb
 - lib/chrono_trigger/version.rb
 - lib/chrono_trigger/worker.rb
-homepage: https://github.com/leastbad/chrono_trigger
+homepage: https://chronotrigger.leastbad.com/
 licenses:
 - MIT
-metadata: {}
+metadata:
+  source_code_uri: https://github.com/leastbad/chrono_trigger
+  documentation_uri: https://chronotrigger.leastbad.com/
 post_install_message: 
 rdoc_options: []
 require_paths: