pomelo-citrus-scheduler 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 602975c89705979ad0a6b2477c38134e4c0ed8f2
+  data.tar.gz: 481027405914536c19e7300e5d93b2824a75397b
+SHA512:
+  metadata.gz: 9e6929058f53f2b85b78370423e02668b718e23bc13606f141165ac2c02f56072c8abc77fae589562c76f3f89618eb33a4d1be9d3a6241d0de7c2411c035f2e9
+  data.tar.gz: e1c5c5ab749fa8a56a5218fb147027f52619231c6288444e0ec4a4f84ca40853e9c8cc58072f38918bf5fdbcf072fa94e140e45bfe1a92912eadbb96c0d44270

data/README.md

@@ -0,0 +1,20 @@
+## Welcome to pomelo-citrus-scheduler
+
+pomelo-citrus-scheduler is a simple clone of pomelo-scheduler written in Ruby using EventMachine.
+
+## Motivation
+
+Since NodeJS is influenced by Ruby EventMachine and Python's Twisted model, Ruby should also be able to have its own game server framework like pomelo.
+
+Ruby is a very expressive and eloquent programming language. I was an RoR programmer before and I really like Ruby, When developing this project, I have used many skills like meta-programming and they give me the real pleasures.
+
+Recently, I would focus on my daily work, so I open source this project and hope to have more people participate in this project.
+
+## Todo
+
+This gem is the very first gem I have done in my whole work, it needs to be improved but it already has the ablity to provide the basic infrastructure to other gems, other gems exist in my own repository.
+
+## Links
+
+* [EventMachine](https://github.com/eventmachine/eventmachine)
+* [pomelo-scheduler](https://github.com/NetEase/pomelo-scheduler)

data/citrus-scheduler.gemspec

@@ -0,0 +1,27 @@
+# Author:: MinixLi (gmail: MinixLi1986)
+# Homepage:: http://citrus.inspawn.com
+# Date:: 15 July 2014
+
+$:.push File.expand_path('../lib', __FILE__)
+
+require 'citrus-scheduler/version'
+
+Gem::Specification.new do |spec|
+  spec.name        = 'pomelo-citrus-scheduler'
+  spec.version     = CitrusScheduler::VERSION
+  spec.platform    = Gem::Platform::RUBY
+  spec.authors     = ['MinixLi']
+  spec.email       = 'MinixLi1986@gmail.com'
+  spec.description = %q{pomelo-citrus-scheduler is a simple clone of pomelo-scheduler, it is a schedule tool and provide a schedule module which is highly efficient and can support large number job schedule}
+  spec.summary     = %q{pomelo-scheduler clone written in Ruby using EventMachine}
+  spec.homepage    = 'https://github.com/minixli/pomelo-citrus-scheduler'
+  spec.license     = 'MIT'
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ['lib']
+
+  spec.add_dependency('algorithms', '~> 0')
+  spec.add_dependency('eventmachine', '~> 0')
+end

data/lib/citrus-scheduler.rb

@@ -0,0 +1,8 @@
+# Author:: MinixLi (gmail: MinixLi1986)
+# Homepage:: http://citrus.inspawn.com
+# Date:: 15 July 2014
+
+$:.unshift(File.dirname(__FILE__) + '/../lib')
+
+require 'eventmachine'
+require 'citrus-scheduler/schedule'

data/lib/citrus-scheduler/cron_trigger.rb

@@ -0,0 +1,19 @@
+# Author:: MinixLi (gmail: MinixLi1986)
+# Homepage:: http://citrus.inspawn.com
+# Date:: 15 July 2014
+
+require 'citrus-scheduler/cron_trigger_decoder'
+
+module CitrusScheduler
+  # CronTrigger
+  #
+  #
+  class CronTrigger
+    # Create a new cron trigger
+    #
+    # @param [String] args
+    # @param [Object] job
+    def initialize args='', job
+    end
+  end
+end

data/lib/citrus-scheduler/cron_trigger_decoder.rb

@@ -0,0 +1,14 @@
+# Author:: MinixLi (gmail: MinixLi1986)
+# Homepage:: http://citrus.inspawn.com
+# Date:: 15 July 2014
+
+module CitrusScheduler
+  # CronTrigger
+  #
+  #
+  class CronTriggerDecoder
+    # Create a new cron trigger decoder
+    def initialize
+    end
+  end
+end

data/lib/citrus-scheduler/job.rb

@@ -0,0 +1,66 @@
+# Author:: MinixLi (gmail: MinixLi1986)
+# Homepage:: http://citrus.inspawn.com
+# Date:: 15 July 2014
+
+require 'citrus-scheduler/cron_trigger'
+require 'citrus-scheduler/simple_trigger'
+
+module CitrusScheduler
+  # Job
+  #
+  #
+  class Job
+    @job_id = 1
+    @job_count = 0
+
+    class << self
+      attr_accessor :job_id, :job_count
+    end
+
+    attr_reader :job_id, :run_time
+
+    # Create a new job
+    #
+    # @param [#call]        job_cb
+    # @param [Hash]         job_cb_args
+    # @param [Hash, String] trigger_args
+    def initialize job_cb, job_cb_args={}, trigger_args={}
+      @job_cb = job_cb
+      @job_cb_args = job_cb_args
+
+      if trigger_args.instance_of? Hash
+        @type = :simple_job
+        @trigger = SimpleTrigger.new trigger_args, self
+      elsif trigger_args.instance_of? String
+        @type = :cron_job
+        @trigger = CronTrigger.new trigger_args, self
+      else
+      end
+
+      @job_id = Job.job_id
+      Job.job_id += 1
+
+      @run_time = 0
+    end
+
+    # Run the job
+    def run
+      begin
+        Job.job_count += 1
+        @run_time += 1
+        @job_cb.call @job_cb_args
+      rescue => err
+      end
+    end
+
+    # Get the current execution time
+    def execute_time
+      @trigger.execute_time
+    end
+
+    # Get the next execution time
+    def next_execute_time
+      @trigger.next_execute_time
+    end
+  end
+end

data/lib/citrus-scheduler/schedule.rb

@@ -0,0 +1,114 @@
+# Author:: MinixLi (gmail: MinixLi1986)
+# Homepage:: http://citrus.inspawn.com
+# Date:: 15 July 2014
+
+require 'algorithms'
+require 'citrus-scheduler/job'
+
+module CitrusScheduler
+  @jobs_map = {}
+  @jobs_queue = Containers::PriorityQueue.new
+  @timer = nil
+  @accuracy = 0.01
+
+  # Schedule a new job
+  #
+  # @param [#call] job_cb
+  # @param [Hash]  job_cb_args
+  # @param [Hash]  trigger_args
+  def self.schedule_job job_cb, job_cb_args={}, trigger_args={}
+    job = Job.new job_cb, job_cb_args, trigger_args
+    job_id = job.job_id
+    execute_time = job.execute_time
+
+    @jobs_map[job_id] = job
+    element = {
+      :job_id => job_id,
+      :execute_time => execute_time
+    }
+
+    cur_job = @jobs_queue.next
+    unless cur_job && execute_time >= cur_job[:execute_time]
+      @jobs_queue.push element, -execute_time
+      set_timer job
+      return job_id
+    end
+
+    @jobs_queue.push element, -execute_time
+    return job_id
+  end
+
+  # Cancel a job
+  #
+  # @param [Integer] job_id
+  def self.cancel_job job_id
+    cur_job = @jobs_queue.next
+    if cur_job && job_id == cur_job[:job_id]
+      @jobs_queue.pop
+      @jobs_map.delete job_id
+      @timer.cancel
+      execute_job
+    end
+    @jobs_map.delete job_id
+    true
+  end
+
+  # Clear last timeout and schedule the next job, it will automatically
+  # run the job that need to run now
+  #
+  # @param [Object] job
+  def self.set_timer job
+    @timer.cancel if @timer
+    @timer = EM::Timer.new(job.execute_time - Time.now.to_f) {
+      execute_job
+    }
+  end
+
+  # Execute job
+  def self.execute_job
+    job = peek_next_job
+
+    while job && (job.execute_time - Time.now.to_f) < @accuracy
+      job.run
+      @jobs_queue.pop
+
+      next_time = job.next_execute_time
+
+      if next_time
+        element = {
+          :job_id => job.job_id,
+          :execute_time => next_time
+        }
+        @jobs_queue.push element, -next_time
+      else
+        @jobs_map.delete job.job_id
+      end
+      job = peek_next_job
+    end
+
+    return unless job
+    set_timer job
+  end
+
+  # Peek next job
+  def self.peek_next_job
+    return nil if @jobs_queue.size <= 0
+
+    job = nil
+    loop do
+      job = @jobs_map[@jobs_queue.next[:job_id]]
+      @jobs_queue.pop unless job
+      break if job || @jobs_queue.size <= 0
+    end
+    job
+  end
+
+  # Get next job
+  def self.get_next_job
+    job = nil
+    while !job && @jobs_queue.size > 0
+      job = @jobs_map[@jobs_queue.pop[:job_id]]
+    end
+    job
+  end
+end

data/lib/citrus-scheduler/simple_trigger.rb

@@ -0,0 +1,38 @@
+# Author:: MinixLi (gmail: MinixLi1986)
+# Homepage:: http://citrus.inspawn.com
+# Date:: 15 July 2014
+
+module CitrusScheduler
+  # SimpleTrigger
+  #
+  #
+  class SimpleTrigger
+    # Create a new simple trigger
+    #
+    # @param [Hash] args Options
+    #
+    # @option args [Integer] start_time
+    # @option args [Integer] interval
+    # @option args [Integer] count
+    # @option args [Object]  job
+    def initialize args={}, job
+      @next_time = args[:start_time] || Time.now.to_f
+      @interval = args[:interval] || -1
+      @count = args[:count] || -1
+      @job = job
+    end
+
+    # Get the current execution time
+    def execute_time
+      @next_time
+    end
+
+    # Get the next execution time
+    def next_execute_time
+      if (@count > 0 && @count <= @job.run_time) || @interval <= 0
+        return nil
+      end
+      @next_time += @interval
+    end
+  end
+end

data/lib/citrus-scheduler/version.rb

@@ -0,0 +1,7 @@
+# Author:: MinixLi (gmail: MinixLi1986)
+# Homepage:: http://citrus.inspawn.com
+# Date:: 16 July 2014
+
+module CitrusScheduler
+  VERSION = '0.0.1'
+end

data/test/test_schedule.rb

@@ -0,0 +1,28 @@
+# Author:: MinixLi (gmail: MinixLi1986)
+# Homepage:: http://citrus.inspawn.com
+# Date:: 16 July 2014
+
+require File.expand_path('../../lib/citrus-scheduler', __FILE__)
+
+def simple_job_cb args={}
+  puts "simple job #{args[:id]} with interval: #{args[:interval]} executed at #{Time.now}"
+end
+
+def test_simple_job_schedule count
+  count.times do |count|
+    start_time = Time.now.to_f + rand * 10
+    interval = rand * 60 + 0.1
+    args = [
+      method(:simple_job_cb),
+      { :id => count, :interval => interval },
+      { :start_time => start_time, :interval => interval }
+    ]
+    CitrusScheduler.schedule_job *args
+  end
+end
+
+def test
+  test_simple_job_schedule 5
+end
+
+EM.run { test }

metadata

@@ -0,0 +1,85 @@
+--- !ruby/object:Gem::Specification
+name: pomelo-citrus-scheduler
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- MinixLi
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-09-26 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: algorithms
+  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: eventmachine
+  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'
+description: pomelo-citrus-scheduler is a simple clone of pomelo-scheduler, it is
+  a schedule tool and provide a schedule module which is highly efficient and can
+  support large number job schedule
+email: MinixLi1986@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- README.md
+- Rakefile
+- citrus-scheduler.gemspec
+- lib/citrus-scheduler.rb
+- lib/citrus-scheduler/cron_trigger.rb
+- lib/citrus-scheduler/cron_trigger_decoder.rb
+- lib/citrus-scheduler/job.rb
+- lib/citrus-scheduler/schedule.rb
+- lib/citrus-scheduler/simple_trigger.rb
+- lib/citrus-scheduler/version.rb
+- test/test_schedule.rb
+homepage: https://github.com/minixli/pomelo-citrus-scheduler
+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.2.2
+signing_key: 
+specification_version: 4
+summary: pomelo-scheduler clone written in Ruby using EventMachine
+test_files:
+- test/test_schedule.rb