periodically 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 39405716f55a3c85a4674d38d0440ba293d9bea7e44a260e062b2e631dc230b8
-  data.tar.gz: f51dbc7e4d9a033778107700e6c82c8743374e9705e8526f84e7900ac56e6cdc
+  metadata.gz: 8606b68187a8ed711211079f83437e183a35b16c896d5e54f8c091717bd099cf
+  data.tar.gz: f30a109baee2a14159db2d8efb08b59a795c4ced31085e12fbc3a36878ef80cc
 SHA512:
-  metadata.gz: f65b70c130c7dffd6cb01da0c02992a4ff4bec0bf763a46ed996057a047709871aabd07f0efb5fa79708a40e5c2d4c33da263c4fdcb0726644af8ad3494517c0
-  data.tar.gz: fe4a38609d1b958f748cbeaae53f571ce0d005318599d49d96a6ae0d788db1bde0c96a05b32fb9908c33864b7529aa4930d09d2806d843b1948cd6cad81026ee
+  metadata.gz: 4a4062005b2f44f31febb25be53f77d1afd765555dba06656456cf882e782c2e889fb8fe2cf6a2346ace47a033be85a2ce798a2cf23e10a437ca877b0f83b46d
+  data.tar.gz: 6020c84dcd0e0829e1d1b3e1c2dcd5fe6cbee482ef66f9be43fb8102bdadb212c9c0301e4f4b02b21fd454a3d235467f8f548bc7f70dbc7fc557bcb917c9d98e

data/.editorconfig

@@ -4,6 +4,6 @@ root = true
 end_of_line = lf
 insert_final_newline = true
 
-[*.rb,*.gemspec]
+[*.{rb,gemspec}}]
 indent_style = space
 indent_size = 2

data/Gemfile

@@ -1,5 +1,14 @@
-source 'https://rubygems.org'
-
-gem 'activerecord'
-gem 'redis-namespace'
-gem 'rufus-scheduler'
+source 'https://rubygems.org'
+
+gem 'rake'
+gem 'activerecord'
+gem 'redis-namespace'
+gem 'rufus-scheduler'
+
+group :test do
+  gem 'minitest'
+end
+
+group :development, :test do
+  gem 'standard'
+end

data/Gemfile.lock

@@ -0,0 +1,68 @@
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activemodel (6.0.2.1)
+      activesupport (= 6.0.2.1)
+    activerecord (6.0.2.1)
+      activemodel (= 6.0.2.1)
+      activesupport (= 6.0.2.1)
+    activesupport (6.0.2.1)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 0.7, < 2)
+      minitest (~> 5.1)
+      tzinfo (~> 1.1)
+      zeitwerk (~> 2.2)
+    ast (2.4.0)
+    concurrent-ruby (1.1.5)
+    et-orbi (1.2.2)
+      tzinfo
+    fugit (1.3.3)
+      et-orbi (~> 1.1, >= 1.1.8)
+      raabro (~> 1.1)
+    i18n (1.7.0)
+      concurrent-ruby (~> 1.0)
+    jaro_winkler (1.5.4)
+    minitest (5.13.0)
+    parallel (1.19.1)
+    parser (2.7.0.1)
+      ast (~> 2.4.0)
+    raabro (1.1.6)
+    rainbow (3.0.0)
+    rake (13.0.1)
+    redis (4.1.3)
+    redis-namespace (1.7.0)
+      redis (>= 3.0.4)
+    rubocop (0.77.0)
+      jaro_winkler (~> 1.5.1)
+      parallel (~> 1.10)
+      parser (>= 2.6)
+      rainbow (>= 2.2.2, < 4.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 1.7)
+    rubocop-performance (1.5.2)
+      rubocop (>= 0.71.0)
+    ruby-progressbar (1.10.1)
+    rufus-scheduler (3.6.0)
+      fugit (~> 1.1, >= 1.1.6)
+    standard (0.1.7)
+      rubocop (~> 0.77.0)
+      rubocop-performance (~> 1.5.1)
+    thread_safe (0.3.6)
+    tzinfo (1.2.6)
+      thread_safe (~> 0.1)
+    unicode-display_width (1.6.0)
+    zeitwerk (2.2.2)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  activerecord
+  minitest
+  rake
+  redis-namespace
+  rufus-scheduler
+  standard
+
+BUNDLED WITH
+   2.1.2

data/README.md

@@ -11,18 +11,25 @@ Example usecases:
 - Launch a non-important sync operation depending on a specific condition (e.g. NULL value in some database column)
   - Achievable by checking the column against NULL inside the `on` condition
 
-### Example usage with Rails
+## Getting started with Rails
 
-```rb
-# config/initializers/periodically.rb
-require "periodically"
+**Add gem to Gemfile and install**
+
+`gem 'periodically'` && `bundle install`
 
-# Note: in development mode classes are loaded lazily, so periodical jobs only start once classes have been loaded
-# In production classes are loaded eagerly, so this is no problem
+**Add an initializer (e.g. `config/initializers/periodically.rb`)**
 
+```rb
+require "periodically"
 Periodically.start
 ```
 
+In Rails, Periodically jobs are only registered when the class is loaded.
+In production mode Rails (by default) eagerly loads all classes, meaning that everything is fine.
+However, in development mode you might want to either disable eager mode with `config.eager_load = false`
+
+**Utilize Periodically in e.g. a Model**
+
 ```rb
 # app/models/item.rb
 
@@ -41,12 +48,6 @@ class Item < ApplicationRecord
 end
 ```
 
-### Example usage with pure Ruby
-
-```rb
-# TODO
-```
-
 ## Execution model
 
 Periodically launches a single background thread, which executes registered queries every x seconds. If a pending query is found, the registered callback method is called in the same thread. Hence, a blocking callback method will also block execution of other pending queries.

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+require "standard/rake"
+
+Rake::TestTask.new(:test) do |test|
+  test.warning = true
+  test.pattern = "test/**/test_*.rb"
+end
+
+task default: [:standard, :test]

data/lib/periodically.rb

@@ -1,8 +1,9 @@
 # frozen_string_literal: true
 
 require "periodically/job"
+require "periodically/debug"
 require "periodically/redis"
-require "periodically/model" if defined?(::Rails::Engine)
+require "periodically/model"
 
 module Periodically
   @@registered = []
@@ -27,6 +28,10 @@ module Periodically
   def self.register(klass, method, opts)
     @@registered.push(Periodically::Job.new(klass, method, opts))
   end
+
+  def self._registered_jobs
+    @@registered
+  end
   
   def self.redis_pool
     @redis ||= Periodically::RedisConnection.create(REDIS_DEFAULTS)
@@ -40,13 +45,18 @@ module Periodically
   end
 
   def self.start
-    require 'rufus-scheduler'
+    require "rufus-scheduler"
     scheduler = Rufus::Scheduler.new
 
     Periodically.redis { |conn| conn.ping }
     
-    scheduler.interval '10s' do
+    scheduler.interval "10s" do
       Periodically.execute_next
     end
   end
 end
+
+if defined?(::Rails::Engine) && !Rails.application.config.eager_load
+  message = "Periodically initialized without Rails eager loading; some jobs may not be launched until the classes have been loaded"
+  Periodically.logger.warn(message) 
+end

data/lib/periodically/debug.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module Periodically
+  module Debug
+    def self.total_debug_dump
+      error_counts = Periodically.redis do |conn|
+        conn.scan_each(:match => "errors:*").to_a
+      end
+      locks = Periodically.redis do |conn|
+        conn.scan_each(:match => "locks:*").to_a
+      end
+      { job_count: Periodically._registered_jobs.size, error_counts: error_counts, locks: locks }
+    end
+  end
+end
+  

data/lib/periodically/job.rb

@@ -7,6 +7,7 @@ module Periodically
     def initialize(klass, method, opts)
       @klass = klass
       @method = method
+      @job_key = "#{klass.name}/#{method.to_s}"
       @opts = opts
     end
 
@@ -36,26 +37,26 @@ module Periodically
 
     private
 
-    def instance_key(instance)
-      instance.cache_key_with_version
-    end
-
-    def instance_locked?(instance)
-      Periodically.redis {|conn| conn.exists("locks:#{instance_key(instance)}")}
+    def full_instance_key(instance)
+      "#{@job_key}/#{instance.id}"
     end
 
     def increase_instance_error_count(instance)
-      error_count_key = "errors:#{instance_key(instance)}"
+      error_count_key = "errors:#{full_instance_key(instance)}"
       Periodically.redis {|conn| conn.incr(error_count_key)}
     end
 
     def clear_instance_error_count(instance)
-      error_count_key = "errors:#{instance_key(instance)}"
+      error_count_key = "errors:#{full_instance_key(instance)}"
       Periodically.redis {|conn| conn.del(error_count_key)}
     end
 
+    def instance_locked?(instance)
+      Periodically.redis {|conn| conn.exists("locks:#{full_instance_key(instance)}")}
+    end
+
     def lock_instance(instance, seconds)
-      lock_key = "locks:#{instance_key(instance)}"
+      lock_key = "locks:#{full_instance_key(instance)}"
 
       Periodically.redis do |conn|
         conn.multi do |multi|

data/lib/periodically/model.rb

@@ -1,17 +1,15 @@
-# frozen_string_literal: true
-
-module Periodically
-  module Model
-    extend ActiveSupport::Concern
-
-    def self.included(base)
-      base.extend ClassMethods
-    end
-
-    module ClassMethods
-      def periodically(symbol, **opts)
-        Periodically.register(self, symbol, opts)
-      end
-    end
-  end
-end
+# frozen_string_literal: true
+
+module Periodically
+  module Model
+    def self.included(base)
+      base.extend ClassMethods
+    end
+
+    module ClassMethods
+      def periodically(symbol, **opts)
+        Periodically.register(self, symbol, opts)
+      end
+    end
+  end
+end

data/periodically.gemspec

@@ -4,7 +4,7 @@ Gem::Specification.new do |gem|
 
   gem.files = `git ls-files | grep -Ev '^(test|myapp|examples)'`.split("\n")
   gem.name = "periodically"
-  gem.version = "0.0.1"
+  gem.version = "0.0.2"
   gem.required_ruby_version = ">= 2.5.0"
 
   gem.add_dependency "redis", ">= 4.1.0"

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: periodically
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - wyozi
@@ -60,10 +60,12 @@ extra_rdoc_files: []
 files:
 - ".editorconfig"
 - Gemfile
+- Gemfile.lock
 - README.md
+- Rakefile
 - lib/periodically.rb
 - lib/periodically/cli.rb
-- lib/periodically/condition.rb
+- lib/periodically/debug.rb
 - lib/periodically/job.rb
 - lib/periodically/model.rb
 - lib/periodically/redis.rb

data/lib/periodically/condition.rb

@@ -1,28 +0,0 @@
-# frozen_string_literal: true
-
-module Periodically
-  module Condition
-    def self.class()
-
-    end
-    
-    def self.evaluate(func)
-      condition = func.call()
-      
-      simple = simple_evaluation(condition)
-  
-      # Filter condition to skip 
-      if evaluated.is_a?(ActiveRecord::Base)
-  
-      end
-    end
-
-    private
-
-    def self.simple_evaluation(condition)
-      row = evaluated.first()
-      row if !Periodically.redis {|conn| conn.exists("")}
-    end
-
-  end
-end