fist_of_fury 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: aaac55f7aa5ff55179438b0849987c260000e695
+  data.tar.gz: cb691189d955e8d22fe2b2a25997da15f2321c47
+SHA512:
+  metadata.gz: daec4f0b46b06ae89773d9c68783ce2d59c2c201fde9ea21a5d59f3d17545790c1ecc293edf0227f93f8a39dcf9c5c35a8a9643816af688910d0712e7eb6b812
+  data.tar.gz: 90c799dab5cae395152b2bdecd623cd200a8e93ba0c1f48fae0d021faad3a720a12bf0d010b2c2d60bb095aa1dbcd95ccfb101af4e312ec261dd578345408e75

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/.rspec

@@ -0,0 +1 @@
+--color

data/Gemfile

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

data/Guardfile

@@ -0,0 +1,5 @@
+guard :rspec do
+  watch(%r{^spec/.+_spec\.rb$})
+  watch(%r{^lib/(.+)\.rb$})     { |m| "spec/lib/#{m[1]}_spec.rb" }
+  watch('spec/spec_helper.rb')  { "spec" }
+end

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Joshua Rieken
+
+MIT License
+
+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,79 @@
+# Fist of Fury
+
+Recurring jobs for [Sucker Punch](https://github.com/brandonhilkert/sucker_punch).
+
+**This is alpha software. Use at your own risk!**
+
+## Why
+
+Sucker Punch offers the capability to run background jobs within the web server process, allowing for less use of resources and utilization of free hosting on services such as Heroku. However, it does not include the ability to run jobs at scheduled intervals. This is where Fist of Fury comes in.
+
+## What
+
+Fist of Fury is heavily inspired by [Sidetiq](https://github.com/tobiassvn/sidetiq) for [Sidekiq](https://github.com/mperham/sidekiq). It uses the [ice_cube](https://github.com/seejohnrun/ice_cube) gem for easy creation of recurrence rules.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'fist_of_fury', '~> 0.1'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install fist_of_fury
+
+## Usage
+
+You can schedule your jobs within the jobs themselves:
+
+```Ruby
+# app/jobs/say_hi_job.rb
+
+class SayHiJob
+  include SuckerPunch::Job
+  include FistOfFury::Recurrent
+
+  recurs { minutely }
+
+  def perform
+    Rails.logger.info 'Hi!'
+  end
+end
+```
+
+Then in the initializer:
+
+```Ruby
+# config/initializers/fist_of_fury.rb
+
+# Ensures the jobs don't run while in the Rails console.
+unless defined?(Rails::Console)
+  FistOfFury.attack!
+end
+```
+
+Or you can even specify the recurrence rules all within the initializer:
+
+```Ruby
+# config/initializers/fist_of_fury.rb
+
+# Ensures the jobs don't run while in the Rails console.
+unless defined?(Rails::Console)
+  FistOfFury.attack! do
+    LogJob.recurs { secondly(3) }
+  end
+end
+```
+
+
+## Contributing
+
+1. Fork it ( http://github.com/<my-github-username>/fist_of_fury/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

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

data/fist_of_fury.gemspec

@@ -0,0 +1,30 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'fist_of_fury/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = 'fist_of_fury'
+  gem.version       = FistOfFury::VERSION
+  gem.authors       = ['Joshua Rieken']
+  gem.email         = ['joshua@joshuarieken.com']
+  gem.description   = %q{Recurring jobs for Sucker Punch}
+  gem.summary       = gem.description
+  gem.homepage      = 'https://github.com/facto/fist_of_fury'
+  gem.license       = 'MIT'
+
+  gem.files         = `git ls-files -z`.split("\x0")
+  gem.executables   = gem.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.require_paths = ['lib']
+
+  gem.add_development_dependency 'pry'
+  gem.add_development_dependency 'rake'
+  gem.add_development_dependency 'rspec'
+  gem.add_development_dependency 'guard'
+  gem.add_development_dependency 'guard-rspec'
+
+  gem.add_dependency 'sucker_punch', '>= 1.0.2'
+  gem.add_dependency 'celluloid',    '>= 0.15.2'
+  gem.add_dependency 'ice_cube',     '~> 0.11.3'
+end

data/lib/fist_of_fury/actor/clock.rb

@@ -0,0 +1,50 @@
+module FistOfFury
+  module Actor
+    class Clock
+      include Logging
+      include FistOfFury::Actor
+
+      attr_reader :schedules
+
+      def initialize(*args, &block)
+        after(0) do
+          debug 'FistOfFury::Clock looping...'
+          loop!
+        end
+      end
+
+      def schedule_for(worker)
+        worker.schedule if worker.respond_to? :schedule
+      end
+
+      def tick(tick = current_time)
+        FistOfFury.workers.each do |worker|
+          FistOfFury.dispatcher.dispatch(worker, tick)
+        end
+      end
+
+      def current_time
+        # TODO: configurable time zone support
+        Time.now
+      end
+
+      private
+
+      def loop!
+        after([time { tick }, 0].max) do
+          loop!
+        end
+      rescue StandardError => e
+        # TODO: global exception handling support
+        # handle_exception(e, context: 'FistOfFury::Clock#loop!')
+        raise e
+      end
+
+      def time
+        start = current_time
+        yield
+        1 - (current_time.to_f - start.to_f)
+      end
+    end
+  end
+end

data/lib/fist_of_fury/actor/dispatcher.rb

@@ -0,0 +1,32 @@
+module FistOfFury
+  module Actor
+    class Dispatcher
+      include Logging
+      include FistOfFury::Actor
+
+      def dispatch(worker, tick)
+        schedule = worker.schedule
+        return unless schedule.schedule_next?(tick)
+        enqueue(worker, schedule.next_occurrence(tick))
+      rescue StandardError => e
+        # TODO: exception handling support
+        raise e
+      end
+
+      private
+
+      def enqueue(worker, next_run_time)
+        klass = worker.to_s
+        info "Enqueue: #{klass}"
+        last_run_time = FistOfFury.store["#{klass}:next"] || -1
+        next_run_time = next_run_time.to_f
+        FistOfFury.store["#{klass}:last"] = last_run_time
+        FistOfFury.store["#{klass}:next"] = next_run_time
+        worker.new.async.perform
+      rescue StandardError => e
+        # TODO: exception handling support
+        raise e
+      end
+    end
+  end
+end

data/lib/fist_of_fury/actor.rb

@@ -0,0 +1,23 @@
+module FistOfFury
+  module Actor
+    def self.included(base)
+      base.__send__(:include, Celluloid)
+      base.finalizer :fist_of_fury_finalizer
+    end
+
+    def initialize(*args, &block)
+      log_call 'initialize'
+      super
+    end
+
+    private
+
+    def fist_of_fury_finalizer
+      log_call 'shutting down ...'
+    end
+
+    def log_call(call)
+      info "#{self.class.name} id: #{object_id} #{call}"
+    end
+  end
+end

data/lib/fist_of_fury/api.rb

@@ -0,0 +1,11 @@
+module FistOfFury
+  module API
+    def workers
+      FistOfFury::Recurrent.subclasses(true)
+    end
+
+    def schedules
+      workers.map(&:schedule)
+    end
+  end
+end

data/lib/fist_of_fury/logging.rb

@@ -0,0 +1,9 @@
+module FistOfFury
+  module Logging
+    [:fatal, :error, :warn, :info, :debug].each do |level|
+      define_method(level) do |msg|
+        FistOfFury.logger.__send__(level, "[FistOfFury] #{msg}")
+      end
+    end
+  end
+end

data/lib/fist_of_fury/railtie.rb

@@ -0,0 +1,6 @@
+module FistOfFury
+  class Railtie < ::Rails::Railtie
+    initializer 'fist_of_fury' do
+    end
+  end
+end

data/lib/fist_of_fury/recurrent.rb

@@ -0,0 +1,42 @@
+module FistOfFury
+  module Recurrent
+    extend SubclassTracking
+
+    module ClassMethods
+      include SubclassTracking
+
+      attr_writer :schedule
+
+      def schedule
+        @schedule ||= FistOfFury::Schedule.new
+      end
+
+      def last_scheduled_occurrence
+        scheduled_occurrence 'last'
+      end
+
+      def next_scheduled_occurrence
+        scheduled_occurrence 'next'
+      end
+
+      def recurs(options={}, &block)
+        schedule.instance_eval(&block)
+        schedule.options = options
+      end
+
+      private
+
+      def scheduled_occurrence(key)
+        (FistOfFury.store["#{self.class.to_s}:#{key}"] || -1).to_f
+      end
+    end
+
+    def self.included(klass)
+      super
+
+      klass.extend(FistOfFury::Recurrent::ClassMethods)
+      klass.extend(FistOfFury::SubclassTracking)
+      subclasses << klass
+    end
+  end
+end

data/lib/fist_of_fury/schedule.rb

@@ -0,0 +1,39 @@
+module FistOfFury
+  class Schedule
+    attr_accessor :options
+    attr_reader :last_occurrence
+
+    # TODO: configurable timezone support
+    START_TIME = Time.local(2010, 1, 1)
+
+    def initialize
+      @schedule = IceCube::Schedule.new(START_TIME)
+    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
+
+    def schedule_next?(time)
+      next_occurrence = @schedule.next_occurrence(time)
+      if @last_scheduled != next_occurrence
+        @last_scheduled = next_occurrence
+        true
+      else
+        false
+      end
+    end
+
+    def to_s
+      @schedule.to_s
+    end
+  end
+end

data/lib/fist_of_fury/subclass_tracking.rb

@@ -0,0 +1,20 @@
+module FistOfFury
+  module SubclassTracking
+    def subclasses(deep = false)
+      @subclasses ||= []
+
+      if deep
+        @subclasses.inject([]) do |result, subclass|
+          (result << subclass) + subclass.subclasses(true)
+        end
+      else
+        @subclasses
+      end
+    end
+
+    def inherited(klass)
+      super
+      subclasses << klass
+    end
+  end
+end

data/lib/fist_of_fury/supervisor.rb

@@ -0,0 +1,30 @@
+module FistOfFury
+  class Supervisor < Celluloid::SupervisionGroup
+    supervise FistOfFury::Actor::Clock, as: :fist_of_fury_clock
+    # TODO: configurable pool size. For now, use Celluloid's CPU-based default.
+    pool FistOfFury::Actor::Dispatcher, as: :fist_of_fury_dispatcher
+
+    class << self
+      include Logging
+
+      def clock
+        run! if Celluloid::Actor[:fist_of_fury_clock].nil?
+        Celluloid::Actor[:fist_of_fury_clock]
+      end
+
+      def dispatcher
+        run! if Celluloid::Actor[:fist_of_fury_dispatcher].nil?
+        Celluloid::Actor[:fist_of_fury_dispatcher]
+      end
+
+      def run!
+        info 'FistOfFury::Supervisor start'
+        super
+      end
+
+      def run
+        raise "FistOfFury::Supervisor should not be run in the foreground."
+      end
+    end
+  end
+end

data/lib/fist_of_fury/version.rb

@@ -0,0 +1,3 @@
+module FistOfFury
+  VERSION = "0.0.1"
+end

data/lib/fist_of_fury.rb

@@ -0,0 +1,59 @@
+# stdlib
+require 'ostruct'
+require 'singleton'
+require 'socket'
+require 'time'
+
+# gems
+require 'ice_cube'
+require 'sucker_punch'
+require 'celluloid'
+
+# internal
+require 'fist_of_fury/subclass_tracking'
+require 'fist_of_fury/api'
+require 'fist_of_fury/logging'
+require 'fist_of_fury/schedule'
+require 'fist_of_fury/recurrent'
+require 'fist_of_fury/version'
+
+# actor topology
+require 'fist_of_fury/actor'
+require 'fist_of_fury/actor/clock'
+require 'fist_of_fury/actor/dispatcher'
+require 'fist_of_fury/supervisor'
+
+module FistOfFury
+  include FistOfFury::API
+
+  extend self
+
+  class << self
+    attr_writer :logger
+  end
+
+  def logger
+    @logger ||= SuckerPunch.logger
+  end
+
+  def clock
+    FistOfFury::Supervisor.clock
+  end
+
+  def dispatcher
+    FistOfFury::Supervisor.dispatcher
+  end
+
+  def store
+    @store ||= {}
+  end
+
+  def attack!
+    return true if @attacking
+    yield if block_given?
+    FistOfFury::Supervisor.run!
+    @attacking = true
+  end
+end
+
+require 'fist_of_fury/railtie' if defined?(::Rails)

data/spec/fist_of_fury_spec.rb

@@ -0,0 +1,22 @@
+require 'spec_helper'
+
+describe FistOfFury do
+  describe 'logger' do
+    it "delegates get to Sucker Punch's logger" do
+      expect(FistOfFury.logger).to eq SuckerPunch.logger
+    end
+  end
+
+  describe 'clock' do
+    it "delegates get to FistOfFury::Supervisor's clock" do
+      expect(FistOfFury::Supervisor).to receive(:clock)
+      FistOfFury.clock
+    end
+  end
+
+  describe 'store' do
+    it 'starts out as an empty hash' do
+      expect(FistOfFury.store).to eq Hash.new
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,13 @@
+begin
+  require 'pry'
+rescue LoadError
+end
+
+require 'fist_of_fury'
+
+RSpec.configure do |config|
+  config.after(:each) do
+    # Clean up the master queue list
+    SuckerPunch::Queues.instance_variable_set(:@queues, Set.new)
+  end
+end

metadata

@@ -0,0 +1,180 @@
+--- !ruby/object:Gem::Specification
+name: fist_of_fury
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Joshua Rieken
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-03-19 00:00:00.000000000 Z
+dependencies:
+- !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: rake
+  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: 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'
+- !ruby/object:Gem::Dependency
+  name: guard
+  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: guard-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'
+- !ruby/object:Gem::Dependency
+  name: sucker_punch
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.0.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.0.2
+- !ruby/object:Gem::Dependency
+  name: celluloid
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.15.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.15.2
+- !ruby/object:Gem::Dependency
+  name: ice_cube
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.11.3
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.11.3
+description: Recurring jobs for Sucker Punch
+email:
+- joshua@joshuarieken.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- Gemfile
+- Guardfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- fist_of_fury.gemspec
+- lib/fist_of_fury.rb
+- lib/fist_of_fury/actor.rb
+- lib/fist_of_fury/actor/clock.rb
+- lib/fist_of_fury/actor/dispatcher.rb
+- lib/fist_of_fury/api.rb
+- lib/fist_of_fury/logging.rb
+- lib/fist_of_fury/railtie.rb
+- lib/fist_of_fury/recurrent.rb
+- lib/fist_of_fury/schedule.rb
+- lib/fist_of_fury/subclass_tracking.rb
+- lib/fist_of_fury/supervisor.rb
+- lib/fist_of_fury/version.rb
+- spec/fist_of_fury_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/facto/fist_of_fury
+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: Recurring jobs for Sucker Punch
+test_files:
+- spec/fist_of_fury_spec.rb
+- spec/spec_helper.rb