chrono_trigger 0.2.0 → 1.0.3

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: '08632b380302ee5a2b70860bc5c60ea3dfed1a1e28dfb160d72b59f563b965fc'
+  data.tar.gz: d9ab5cfe642b09cf271cc85d142511ec6f346802d30e359ccf0941aee3b2a79f
+SHA512:
+  metadata.gz: 57079c8c26383947f59a3f690be8634261149b1aca695da1ac461572b3231564f49d8a739a314a8d14a64a544be4b930577ff5cd21853d719a0870be673e116c
+  data.tar.gz: c57f6fe1a0cde287243454be84ee711df6d9603621b99b08f43a84199375b0013afe82a37d3c35f4e8c4e3bb50cbddaab2d95fd6e35b95a92e48a6bce3ae59cf

data/Gemfile

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in cable_ready.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,167 @@
+PATH
+  remote: .
+  specs:
+    chrono_trigger (1.0.0)
+      concurrent-ruby (~> 1.1, >= 1.1.8)
+      concurrent-ruby-edge (~> 0.6, >= 0.6.0)
+      rails (~> 5.2)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    actioncable (5.2.5)
+      actionpack (= 5.2.5)
+      nio4r (~> 2.0)
+      websocket-driver (>= 0.6.1)
+    actionmailer (5.2.5)
+      actionpack (= 5.2.5)
+      actionview (= 5.2.5)
+      activejob (= 5.2.5)
+      mail (~> 2.5, >= 2.5.4)
+      rails-dom-testing (~> 2.0)
+    actionpack (5.2.5)
+      actionview (= 5.2.5)
+      activesupport (= 5.2.5)
+      rack (~> 2.0, >= 2.0.8)
+      rack-test (>= 0.6.3)
+      rails-dom-testing (~> 2.0)
+      rails-html-sanitizer (~> 1.0, >= 1.0.2)
+    actionview (5.2.5)
+      activesupport (= 5.2.5)
+      builder (~> 3.1)
+      erubi (~> 1.4)
+      rails-dom-testing (~> 2.0)
+      rails-html-sanitizer (~> 1.0, >= 1.0.3)
+    activejob (5.2.5)
+      activesupport (= 5.2.5)
+      globalid (>= 0.3.6)
+    activemodel (5.2.5)
+      activesupport (= 5.2.5)
+    activerecord (5.2.5)
+      activemodel (= 5.2.5)
+      activesupport (= 5.2.5)
+      arel (>= 9.0)
+    activestorage (5.2.5)
+      actionpack (= 5.2.5)
+      activerecord (= 5.2.5)
+      marcel (~> 1.0.0)
+    activesupport (5.2.5)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 0.7, < 2)
+      minitest (~> 5.1)
+      tzinfo (~> 1.1)
+    arel (9.0.0)
+    ast (2.4.2)
+    builder (3.2.4)
+    coderay (1.1.3)
+    concurrent-ruby (1.1.8)
+    concurrent-ruby-edge (0.6.0)
+      concurrent-ruby (~> 1.1.6)
+    crass (1.0.6)
+    erubi (1.10.0)
+    globalid (0.4.2)
+      activesupport (>= 4.2.0)
+    i18n (1.8.10)
+      concurrent-ruby (~> 1.0)
+    loofah (2.9.1)
+      crass (~> 1.0.2)
+      nokogiri (>= 1.5.9)
+    magic_frozen_string_literal (1.2.0)
+    mail (2.7.1)
+      mini_mime (>= 0.1.1)
+    marcel (1.0.1)
+    method_source (0.9.2)
+    mini_mime (1.1.0)
+    minitest (5.14.4)
+    nio4r (2.5.7)
+    nokogiri (1.11.3-x86_64-linux)
+      racc (~> 1.4)
+    parallel (1.20.1)
+    parser (3.0.0.0)
+      ast (~> 2.4.1)
+    pry (0.12.2)
+      coderay (~> 1.1.0)
+      method_source (~> 0.9.0)
+    pry-nav (0.3.0)
+      pry (>= 0.9.10, < 0.13.0)
+    racc (1.5.2)
+    rack (2.2.3)
+    rack-test (1.1.0)
+      rack (>= 1.0, < 3)
+    rails (5.2.5)
+      actioncable (= 5.2.5)
+      actionmailer (= 5.2.5)
+      actionpack (= 5.2.5)
+      actionview (= 5.2.5)
+      activejob (= 5.2.5)
+      activemodel (= 5.2.5)
+      activerecord (= 5.2.5)
+      activestorage (= 5.2.5)
+      activesupport (= 5.2.5)
+      bundler (>= 1.3.0)
+      railties (= 5.2.5)
+      sprockets-rails (>= 2.0.0)
+    rails-dom-testing (2.0.3)
+      activesupport (>= 4.2.0)
+      nokogiri (>= 1.6)
+    rails-html-sanitizer (1.3.0)
+      loofah (~> 2.3)
+    railties (5.2.5)
+      actionpack (= 5.2.5)
+      activesupport (= 5.2.5)
+      method_source
+      rake (>= 0.8.7)
+      thor (>= 0.19.0, < 2.0)
+    rainbow (3.0.0)
+    rake (13.0.3)
+    regexp_parser (2.1.1)
+    rexml (3.2.4)
+    rubocop (1.11.0)
+      parallel (~> 1.10)
+      parser (>= 3.0.0.0)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8, < 3.0)
+      rexml
+      rubocop-ast (>= 1.2.0, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 3.0)
+    rubocop-ast (1.4.1)
+      parser (>= 2.7.1.5)
+    rubocop-performance (1.10.1)
+      rubocop (>= 0.90.0, < 2.0)
+      rubocop-ast (>= 0.4.0)
+    ruby-progressbar (1.11.0)
+    sprockets (4.0.2)
+      concurrent-ruby (~> 1.0)
+      rack (> 1, < 3)
+    sprockets-rails (3.2.2)
+      actionpack (>= 4.0)
+      activesupport (>= 4.0)
+      sprockets (>= 3.0.0)
+    standard (1.0.4)
+      rubocop (= 1.11.0)
+      rubocop-performance (= 1.10.1)
+    standardrb (1.0.0)
+      standard
+    thor (1.1.0)
+    thread_safe (0.3.6)
+    tzinfo (1.2.9)
+      thread_safe (~> 0.1)
+    unicode-display_width (2.0.0)
+    websocket-driver (0.7.3)
+      websocket-extensions (>= 0.1.0)
+    websocket-extensions (0.1.5)
+
+PLATFORMS
+  x86_64-linux
+
+DEPENDENCIES
+  chrono_trigger!
+  magic_frozen_string_literal (~> 1.2.0)
+  pry (~> 0.12.2)
+  pry-nav (~> 0.3.0)
+  rake (~> 13.0, >= 13.0.3)
+  standardrb (~> 1.0.0)
+
+BUNDLED WITH
+   2.2.3

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2021 leastbad
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,89 @@
+---
+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/Rakefile

@@ -1,25 +1,4 @@
-# %w[rubygems rake rake/clean fileutils newgem rubigen rake/testtask].each { |f| require f }
-# require File.dirname(__FILE__) + '/lib/chrono_trigger'
-
-require 'rake/testtask'
-
-Rake::TestTask.new do |t|
-  t.libs << 'test'
-end
-
-desc "Run tests"
-task :default => :test
-
-begin
-  require 'jeweler'
-  Jeweler::Tasks.new do |s|
-    s.name = "chrono_trigger"
-    s.summary = "TODO"
-    s.email = "darful@gmail.com"
-    s.homepage = ""
-    s.description = "TODO"
-    s.authors = ["Jon Ciccone"]
-  end
-rescue LoadError
-  puts "Jeweler not available. Install it with: sudo gem install technicalpickles-jeweler -s http://gems.github.com"
-end
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "pry"

data/SUMMARY.md

@@ -0,0 +1,5 @@
+# Table of contents
+
+* [ChronoTrigger](README.md)
+* [Setup](setup.md)
+

data/bin/console

@@ -0,0 +1,7 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "chrono_trigger"
+require "pry"
+
+Pry.start

data/bin/loc

@@ -0,0 +1,3 @@
+#!/usr/bin/env bash
+
+cloc --exclude-dir=node_modules,test --include-ext=rb,js .

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/bin/standardize

@@ -0,0 +1,4 @@
+#!/usr/bin/env bash
+
+bundle exec magic_frozen_string_literal
+bundle exec standardrb --fix

data/lib/chrono_trigger.rb

@@ -1,11 +1,32 @@
-$:.unshift(File.dirname(__FILE__)) unless
-  $:.include?(File.dirname(__FILE__)) || $:.include?(File.expand_path(File.dirname(__FILE__)))
+# frozen_string_literal: true
+
+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"
+require "chrono_trigger/schedule"
+require "chrono_trigger/timeline"
+require "chrono_trigger/version"
+require "chrono_trigger/worker"
 
 module ChronoTrigger
-  VERSION = '0.2.0'
-end
+  class Engine < Rails::Engine
+  end
 
-require "active_support/all"
-require "chrono_trigger/shell"
-require "chrono_trigger/trigger"
-require "chrono_trigger/cron_entry"
+  def self.config
+    ChronoTrigger::Config.instance
+  end
+
+  def self.schedule
+    ChronoTrigger::Schedule.instance
+  end
+
+  def self.configure
+    yield config
+  end
+end

data/lib/chrono_trigger/clock.rb

@@ -0,0 +1,50 @@
+# frozen_string_literal: true
+
+module ChronoTrigger
+  class Clock
+    class << self
+      attr_reader :status, :ticks
+
+      def init
+        @ticks = 0
+        @status ||= :stopped
+      end
+
+      def start
+        init
+        if stopped?
+          last_tick = Time.zone.now
+          Rails.logger.info "ChronoTrigger: Clock started with a #{ChronoTrigger.config.interval}s interval"
+          ChronoTrigger.schedule.refresh
+          task = Concurrent::TimerTask.new(execution_interval: ChronoTrigger.config.interval) do |task|
+            if Time.zone.now - last_tick >= 1
+              last_tick += 1
+              @ticks += 1
+              ChronoTrigger.schedule.process_events
+            end
+            task.shutdown if stopped?
+          end
+          task.execute
+        end
+
+        @status = :started
+      end
+
+      def stop
+        if ticking?
+          Rails.logger.info "ChronoTrigger: Timer stopped"
+          @status = :stopped
+        end
+        @status
+      end
+
+      def ticking?
+        @status == :started
+      end
+
+      def stopped?
+        @status == :stopped
+      end
+    end
+  end
+end