chron 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 2ec4b962469200571eee45bc30a33fa3261ea301
+  data.tar.gz: 5919a1c1b57c95701f44c4109c14e2f4bf5d27f4
+SHA512:
+  metadata.gz: 8fc075b1b1a993f8eddb6ab2510d77205eea6b86ce0b4799fab397b4fc94d5250b2c869c4683fdbb193438e0d428ca25217b58ed649d95db5bb696fd64e926e2
+  data.tar.gz: 31338405a80e3125f4d6f73381dd4a0e8c10edbdb36a4cc4c489f5bee9ea1c74bc2257a9e29bfe041a5f4165b2f6bbfe0dbed5b08cd4db5dbc42ffdd24f84f0f

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.ruby-gemset

@@ -0,0 +1 @@
+chron

data/.ruby-version

@@ -0,0 +1 @@
+2.1.5

data/.travis.yml

@@ -0,0 +1,3 @@
+language: ruby
+rvm:
+  - 2.1.5

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in chron.gemspec
+gemspec

data/README.md

@@ -0,0 +1,85 @@
+# Chron
+
+Allows one to declaratively supply a block of code to be fired for a resource at a given point in time.
+
+```ruby
+class Course < ActiveRecord::Base
+  include Chron::Observable
+
+  at_time :close_at do
+    Rails.logger.info "performing task for a given record when its start_at value passes"
+    update_column :state, 'closed' # set any state you want for this record
+    ## bake in any conditional business logic required here
+  end
+end
+```
+
+This gem encapsulates the ActiveJob classes required to trigger the above block in the background.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'chron'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install chron
+
+## Usage
+
+#### Declaring As Observable
+
+Mix `Chron::Observable` into `ActiveRecord::Base` children that you want to declare observations against.
+
+```ruby
+class Course < ActiveRecord::Base
+  include Chron::Observable
+end
+```
+
+#### Supplying Observations
+
+You can provide an arbitrary block of code to be fired against a given record at the time stored as the value in that column.
+
+```ruby
+at_time :close_at do
+  do_anything_for_this_resource
+  # self == self.class.find(id)
+  # self is an instance whose :close_at is now
+  # this block gets fired at the :close_at time
+end
+```
+
+#### Setting Up The Poller
+
+`Chron::Job` will poll observable records and trigger matching observation blocks.
+We recommend using the tomykaira/clockwork gem.
+
+`Clockwork.every(Chron::POLLING_WINDOW) { Chron::Job.perform_later }`
+
+Feel free to set your own value (in seconds) for Chron::POLLING_WINDOW if you'd prefer something larger/smaller.
+
+```ruby
+# in config/initializers/chron.rb
+Chron::POLLING_WINDOW = 60 # seconds
+
+# in Clockfile
+require 'config/initializers/chron'
+
+Clockwork.every(Chron::POLLING_WINDOW) { Chron::Job.perform_later }
+```
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/chron/fork )
+2. Create your feature branch (`git checkout -b feature/my-stuff`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin HEAD`)
+5. Create a new Pull Request

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "chron"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

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

data/chron.gemspec

@@ -0,0 +1,32 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'chron/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "chron"
+  spec.version       = Chron::VERSION
+  spec.authors       = ["winfred"]
+  spec.email         = ["winfred@hired.com"]
+
+  spec.summary       = %q{declare arbitrary block of code to be fired against a given record at the time stored as the value in that column.}
+  spec.homepage      = "http://github.com/hired/chron"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency 'activejob', '~> 4.2'
+  spec.add_dependency 'activerecord', '~> 4.2'
+  spec.add_dependency 'activesupport', '~> 4.2'
+  spec.add_development_dependency "bundler", "~> 1.8"
+  spec.add_development_dependency "rake", "~> 10.0"
+
+  spec.add_development_dependency "rspec", "~> 3.2.0"
+  spec.add_development_dependency "rspec-its"
+  spec.add_development_dependency "pry"
+  spec.add_development_dependency "pry-byebug"
+  spec.add_development_dependency "sqlite3"
+  spec.add_development_dependency "timecop"
+end

data/lib/chron/job.rb

@@ -0,0 +1,7 @@
+class Chron::Job < ActiveJob::Base
+  def perform
+    Chron.observable_resources.each do |class_name|
+      Chron::Observable::Job.perform_later(class_name)
+    end
+  end
+end

data/lib/chron/observable/job.rb

@@ -0,0 +1,16 @@
+class Chron::Observable::Job < Chron::Job
+  def perform(class_name)
+    Chron.observables_for(class_name).each do |column|
+      observe_records_for(class_name, column)
+    end
+  end
+
+  private
+
+  def observe_records_for(class_name, column)
+    class_name.constantize
+        .select(:id).where(column => Chron::POLLING_RANGE.call).find_each do |record|
+      Chron::Observable::RecordJob.perform_later(class_name, column.to_s, record.id)
+    end
+  end
+end

data/lib/chron/observable/record_job.rb

@@ -0,0 +1,7 @@
+class Chron::Observable::RecordJob < Chron::Job
+  def perform(class_name, column, id)
+    if record = class_name.constantize.where(id: id).first
+      record.instance_eval &Chron.observation(class_name, column)
+    end
+  end
+end

data/lib/chron/observable.rb

@@ -0,0 +1,13 @@
+module Chron::Observable
+  extend ActiveSupport::Concern
+
+  included do |base|
+    Chron.add_observable_resource(base)
+  end
+
+  module ClassMethods
+    def at_time(column, &block)
+      Chron.add_observation(to_s, column, block)
+    end
+  end
+end

data/lib/chron/version.rb

@@ -0,0 +1,3 @@
+module Chron
+  VERSION = "0.1.0"
+end

data/lib/chron.rb

@@ -0,0 +1,44 @@
+require "active_job"
+require "chron/version"
+
+module Chron
+  OBSERVABLES = {}
+
+  def self.observable_resources
+    OBSERVABLES.keys
+  end
+
+  def self.add_observable_resource(class_name)
+    OBSERVABLES[class_name.to_s] = {}
+  end
+
+  def self.observables_for(class_name)
+    observable = OBSERVABLES[class_name]
+    raise UnknownObservable if observable.blank?
+    observable.keys
+  end
+
+  def self.observation(class_name, column)
+    observation = OBSERVABLES[class_name][column]
+    raise UnknownObservation if observation.blank?
+    observation
+  end
+
+  def self.add_observation(class_name, column, block)
+    observable = OBSERVABLES[class_name]
+    raise ExistingObservable if observable[column].present?
+    observable[column] = block
+  end
+
+  class ExistingObservable < StandardError; end
+  class UnknownObservable < StandardError; end
+  class UnknownObservation < StandardError; end
+
+  POLLING_RANGE = -> { (Time.current - POLLING_WINDOW)..(Time.current + POLLING_WINDOW) }
+  POLLING_WINDOW = 5 * 60
+end
+
+require "chron/job"
+require "chron/observable"
+require "chron/observable/job"
+require "chron/observable/record_job"

metadata

@@ -0,0 +1,215 @@
+--- !ruby/object:Gem::Specification
+name: chron
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- winfred
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2015-04-21 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activejob
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.2'
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.2'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.2'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.2.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.2.0
+- !ruby/object:Gem::Dependency
+  name: rspec-its
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry-byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: timecop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: 
+email:
+- winfred@hired.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".ruby-gemset"
+- ".ruby-version"
+- ".travis.yml"
+- Gemfile
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- chron.gemspec
+- lib/chron.rb
+- lib/chron/job.rb
+- lib/chron/observable.rb
+- lib/chron/observable/job.rb
+- lib/chron/observable/record_job.rb
+- lib/chron/version.rb
+homepage: http://github.com/hired/chron
+licenses: []
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.3
+signing_key: 
+specification_version: 4
+summary: declare arbitrary block of code to be fired against a given record at the
+  time stored as the value in that column.
+test_files: []