active_job-cron 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 8716c8fca2467b6158690d0468bf102a10dedfee
+  data.tar.gz: 1f3470b668a58861bfd470c626f703547c463552
+SHA512:
+  metadata.gz: 60756b6feb0df156c5e8ad6f5f36ab06da6eb2c8ede69c50fcfce99e9b79bb300f7cfd8621708a605a4139119204e0231951affb9906c29727718ed556704f67
+  data.tar.gz: 67885ccb0a23f1bfce098380cdbcd518151732d45e8ae38b5acdcd69da684b070e19df7cbdf4262e61b6c91f8bc8cc905da36c9264f763bcfa61699fd5676afc

data/.gitignore

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

data/.rspec

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

data/.travis.yml

@@ -0,0 +1,15 @@
+language: ruby
+sudo: false
+cache: bundler
+rvm:
+  - 2.0
+  - 2.1
+  - 2.2
+  - ruby-head
+
+notifications:
+  email:
+    recipients:
+      - stan001212@gmail.com
+    on_failure: change
+    on_success: never

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,13 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, we pledge to respect all people who contribute through reporting issues, posting feature requests, updating documentation, submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free experience for everyone, regardless of level of experience, gender, gender identity and expression, sexual orientation, disability, personal appearance, body size, race, ethnicity, age, or religion.
+
+Examples of unacceptable behavior by participants include the use of sexual language or imagery, derogatory comments or personal attacks, trolling, public or private harassment, insults, or other unprofessional conduct.
+
+Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct. Project maintainers who do not follow the Code of Conduct may be removed from the project team.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by opening an issue or contacting one or more of the project maintainers.
+
+This Code of Conduct is adapted from the [Contributor Covenant](http://contributor-covenant.org), version 1.0.0, available at [http://contributor-covenant.org/version/1/0/0/](http://contributor-covenant.org/version/1/0/0/)

data/Gemfile

@@ -0,0 +1,7 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in active_job-cron.gemspec
+gemspec
+
+gem "pry"
+gem "codeclimate-test-reporter", group: :test, require: nil

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Stan Lo
+
+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,75 @@
+[![Build Status](https://travis-ci.org/st0012/ActiveJob-Cron.svg)](https://travis-ci.org/st0012/ActiveJob-Cron)
+[![Code Climate](https://codeclimate.com/github/st0012/ActiveJob-Cron/badges/gpa.svg)](https://codeclimate.com/github/st0012/ActiveJob-Cron)
+[![Test Coverage](https://codeclimate.com/github/st0012/ActiveJob-Cron/badges/coverage.svg)](https://codeclimate.com/github/st0012/ActiveJob-Cron/coverage)
+
+# ActiveJob::Cron
+
+This gem provides recurrent functionality for your `ActiveJob`. The usage and implementation is highly inspired by [Sidetiq](https://github.com/tobiassvn/sidetiq).
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'active_job-cron'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install active_job-cron
+
+## Usage
+
+It's very simple to use, just include `ActiveJob::Cron`, and sets your job's recurrent frequency:
+
+```ruby
+class MyJob < ActiveJob::Base
+  include ActiveJob::Cron
+  
+  recurrence { daily }
+  
+  def perform
+    # do something.....
+  end
+end
+```
+
+Or you can specify more complex recurrence like:
+
+```ruby
+class MyJob < ActiveJob::Base
+  include ActiveJob::Cron
+  
+  recurrence { weekly.day(:thursday) }
+  
+  def perform
+    # do something.....
+  end
+end
+```
+
+I uses [IceCube](http://seejohncode.com/ice_cube/) as recurrence's DSL, you can see more usages in its documentation.
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+- More feature
+- More documentation
+- More tests
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/st0012/active_job-cron. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](contributor-covenant.org) code of conduct.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/active_job-cron.gemspec

@@ -0,0 +1,36 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'active_job/cron/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "active_job-cron"
+  spec.version       = ActiveJob::Cron::VERSION
+  spec.authors       = ["Stan Lo"]
+  spec.email         = ["a22301613@yahoo.com.tw"]
+
+  spec.summary       = %q{It provides functionality for actibe_jobs being triggered recurrently.}
+  spec.description   = %q{It provides functionality for actibe_jobs being triggered recurrently.}
+  spec.homepage      = "https://github.com/st0012/ActiveJob-Cron"
+  spec.license       = "MIT"
+
+  # Prevent pushing this gem to RubyGems.org by setting 'allowed_push_host', or
+  # delete this section to allow pushing this gem to any host.
+  # if spec.respond_to?(:metadata)
+  #   spec.metadata['allowed_push_host'] = "TODO: Set to 'http://mygemserver.com'"
+  # else
+  #   raise "RubyGems 2.0 or newer is required to protect against public gem pushes."
+  # end
+
+  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 "celluloid"
+  spec.add_dependency "ice_cube"
+  spec.add_dependency "rails", "~> 4.2"
+
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec"
+end

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "active_job/cron"
+
+# 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/lib/active_job/cron.rb

@@ -0,0 +1,60 @@
+require "celluloid"
+require "ice_cube"
+
+require "active_job/cron/version"
+require "active_job/cron/configuration"
+require "active_job/cron/schedulable"
+require "active_job/cron/trackable"
+require "active_job/cron/loggable"
+require "active_job/cron/clock"
+require "active_job/cron/handler"
+
+module ActiveJob
+  module Cron
+    extend Configurable
+    extend Trackable
+    extend Schedulable
+
+    def self.included(klass)
+      super
+
+      klass.extend(ActiveJob::Cron::Schedulable)
+      klass.extend(ActiveJob::Cron::Trackable)
+
+      subclasses << klass
+    end
+
+    class << self
+      def jobs
+        subclasses(true).select do |job|
+          job.method_defined?(:perform)
+        end
+      end
+
+      def handler
+        if handler = Supervisor.handler
+          handler
+        else
+          run!
+          Supervisor.handler
+        end
+      end
+
+      def clock
+        if clock = Supervisor.clock
+          clock
+        else
+          run!
+          Supervisor.clock
+        end
+      end
+
+      def run!
+        Supervisor.run!
+      end
+    end
+  end
+end
+
+require "active_job/cron/supervisor"
+require "active_job/cron/railtie"

data/lib/active_job/cron/clock.rb

@@ -0,0 +1,51 @@
+module ActiveJob
+  module Cron
+    class Clock
+      include Celluloid
+      include Loggable
+      attr_reader :schedules
+
+      def initialize # :nodoc:
+        super
+        after(1) do
+          loop!
+        end
+      end
+
+      # Get the schedule for `job`.
+      def schedule_for(job)
+        if job.respond_to?(:schedule)
+          job.schedule
+        end
+      end
+
+      # Tick a single clock.
+      def tick(time = gettime)
+        ActiveJob::Cron.jobs.each do |job|
+          ActiveJob::Cron.handler.dispatch(job, time)
+        end
+      end
+
+      # Returns the current time used by the clock.
+      def gettime
+        ActiveJob::Cron.config.utc ? Time.now.utc : Time.now
+      end
+
+      private
+
+      def loop!
+        after([time { tick }, 0].max) do
+          loop!
+        end
+      rescue StandardError => e
+        raise e
+      end
+
+      def time
+        start = gettime
+        yield
+        ActiveJob::Cron.config.resolution - (gettime.to_f - start.to_f)
+      end
+    end
+  end
+end

data/lib/active_job/cron/configuration.rb

@@ -0,0 +1,24 @@
+require "rails"
+
+module ActiveJob
+  module Cron
+    module Configurable
+      def configure
+        yield(config)
+      end
+
+      def config
+        @config ||= Configuration.new
+      end
+    end
+    class Configuration
+      attr_accessor :resolution, :utc, :handler_pool_size, :logger, :preload_jobs
+
+      def initialize
+        @resolution = 1
+        @utc = false
+        @preload_jobs = true
+      end
+    end
+  end
+end

data/lib/active_job/cron/handler.rb

@@ -0,0 +1,11 @@
+module ActiveJob
+  module Cron
+    class Handler
+      include Celluloid
+
+      def dispatch(job, time)
+        job.perform_later if job.ready_to_perform?(time)
+      end
+    end
+  end
+end

data/lib/active_job/cron/loggable.rb

@@ -0,0 +1,17 @@
+module ActiveJob
+  module Cron
+    module Loggable
+      %w(fatal error warn info debug).each do |level|
+        level = level.to_sym
+
+        define_method(level) do |msg|
+          if logger = ActiveJob::Cron.config.logger
+            logger.__send__(level, "[ActiveJob::Cron] #{msg}")
+          else
+            puts "[ActiveJob::Cron] #{level}: #{msg}"
+          end
+        end
+      end
+    end
+  end
+end

data/lib/active_job/cron/railtie.rb

@@ -0,0 +1,17 @@
+require "rails"
+
+module ActiveJob
+  module Cron
+    class Railtie < Rails::Railtie
+      config.after_initialize do
+        ActiveJob::Cron.config.logger = Rails.logger
+
+        Dir.glob(Rails.root + "app/jobs/*_job*.rb").each do |c|
+          require_dependency(c)
+        end if ActiveJob::Cron.config.preload_jobs
+
+        ActiveJob::Cron.run!
+      end
+    end
+  end
+end

data/lib/active_job/cron/schedulable.rb

@@ -0,0 +1,38 @@
+module ActiveJob
+  module Cron
+    module Schedulable
+      attr_reader :last_occurrence
+
+      def ready_to_perform?(time)
+        next_occurrence = schedule.next_occurrence(time).to_i
+        # See IceCube's document about how #next_occurrence works
+        if next_occurrence != last_occurrence
+          @last_occurrence = next_occurrence
+          true
+        else
+          false
+        end
+      end
+
+      def schedule
+        @schedule ||= IceCube::Schedule.new
+      end
+
+      def recurrence
+        yield
+      end
+
+      def method_missing(meth, *args, &block)
+        if IceCube::Rule.respond_to?(meth)
+          rule = IceCube::Rule.send(meth, *args, &block)
+          schedule.add_recurrence_rule(rule)
+          rule
+        elsif schedule.respond_to?(meth)
+          schedule.send(meth, *args, &block)
+        else
+          super
+        end
+      end
+    end
+  end
+end

data/lib/active_job/cron/supervisor.rb

@@ -0,0 +1,29 @@
+module ActiveJob
+  module Cron
+    class Supervisor < Celluloid::SupervisionGroup
+      supervise ActiveJob::Cron::Clock, as: :active_job_clock
+      if handler_pool_size = ActiveJob::Cron.config.handler_pool_size
+        pool ActiveJob::Cron::Handler,
+             as: :cron_job_handler,
+             size: handler_pool_size
+      else
+        pool ActiveJob::Cron::Handler,
+             as: :cron_job_handler
+      end
+
+      class << self
+        def clock
+          Celluloid::Actor[:active_job_clock]
+        end
+
+        def handler
+          Celluloid::Actor[:cron_job_handler]
+        end
+
+        def run
+          raise "Sidetiq::Supervisor should not be run in foreground."
+        end
+      end
+    end
+  end
+end

data/lib/active_job/cron/trackable.rb

@@ -0,0 +1,22 @@
+module ActiveJob
+  module Cron
+    module Trackable
+      def subclasses(deep = false)
+        @subclasses ||= []
+
+        if deep
+          @subclasses.inject([]) do |all, subclass|
+            (all << subclass) + subclass.subclasses(true)
+          end
+        else
+          @subclasses
+        end
+      end
+
+      def inherited(klass)
+        super
+        subclasses << klass
+      end
+    end
+  end
+end

data/lib/active_job/cron/version.rb

@@ -0,0 +1,5 @@
+module ActiveJob
+  module Cron
+    VERSION = "0.1.0"
+  end
+end

metadata

@@ -0,0 +1,136 @@
+--- !ruby/object:Gem::Specification
+name: active_job-cron
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Stan Lo
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2015-12-19 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: celluloid
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: ice_cube
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rails
+  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: 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: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: It provides functionality for actibe_jobs being triggered recurrently.
+email:
+- a22301613@yahoo.com.tw
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- active_job-cron.gemspec
+- bin/console
+- bin/setup
+- lib/active_job/cron.rb
+- lib/active_job/cron/clock.rb
+- lib/active_job/cron/configuration.rb
+- lib/active_job/cron/handler.rb
+- lib/active_job/cron/loggable.rb
+- lib/active_job/cron/railtie.rb
+- lib/active_job/cron/schedulable.rb
+- lib/active_job/cron/supervisor.rb
+- lib/active_job/cron/trackable.rb
+- lib/active_job/cron/version.rb
+homepage: https://github.com/st0012/ActiveJob-Cron
+licenses:
+- MIT
+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.5.1
+signing_key: 
+specification_version: 4
+summary: It provides functionality for actibe_jobs being triggered recurrently.
+test_files: []
+has_rdoc: