day_planner 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 7a2a1486d2af1a3439a34e767e576e3a7f35a186
+  data.tar.gz: df3c42df197b2e4abe2af7a03b0f657cde4d4b93
+SHA512:
+  metadata.gz: be3e16005d5f5a48ba2fdbc29804ea1ee575415e28963d59734e115865fc2a4e55d38deae0dbb16cc958cf67edbc6c8a386e2db4f4b2752189db40fd4dc2364d
+  data.tar.gz: 5a4b80de0b271862877071eb4d0cfd8da3858c17611988e62d1a2f699d836c32469c373ffea094206414da4aa66b88ef1fd575ef8bcfca5a7580b86dfbe2e814

data/.gitignore

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

data/Gemfile

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

data/LICENSE

@@ -0,0 +1,20 @@
+The MIT License (MIT)
+
+Copyright (c) 2013 dsiefert
+
+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/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Damon Siefert
+
+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,53 @@
+# DayPlanner
+
+Day Planner is a simple tool to manage in-process execution of scheduled tasks. There are a lot of tools for running scheduled tasks outside the process ([Clockwork](http://rubygems.org/gems/clockwork) is probably what you're looking for if you want an elegant implementation of scheduled tasks outside the main process.)
+
+I wrote this because I needed a simple, lightweight tool to schedule small, light tasks on an application running on Heroku, without the extra cost of a dedicated clock process to handle it, but executing more frequently than Heroku's free scheduler permits.
+
+Schedule management is in a thread of its own; each scheduled task is run in a thread as well, meaning that lots of long-running tasks could result in lots of threads. Ruby 2.0's handling of threading is improved over the 1.9 branch, so I require that as a minimum, but I obviously can't guarantee that you won't encounter situations in which poorly behaved tasks block your application's main thread. If you want assurances against that, use any of the other tools (did I mention [Clockwork](http://rubygems.org/gems/clockwork)?)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'day_planner'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install day_planner
+
+If you're using Rails, it'll expect to find a file listing scheduled tasks in 'config/day_planner_tasks.rb'. If you're not using Rails, do whatever makes you happy. Stick some scheduled tasks somewhere and make sure it's somewhere that runs when your application starts.
+
+## Usage
+
+Here's an example of a scheduled task:
+
+    DayPlanner.schedule(every: 2.minutes) do
+    	MyClass.my_class_method
+    end
+
+Obviously you only get those cute little time methods in Rails; otherwise, pass in an integer number of seconds. More sophisticated ways of scheduling tasks are intended in the future, but for now you'll just have to cope. If you don't specify an interval with 'every', it'll happen once and never again.
+
+The tasks in the schedule will each be performed on startup and then thereafter according to their stated intervals.
+
+By default, DayPlanner checks for tasks to be performed once per minute. You have the power to change this:
+
+    DayPlanner.interval = 5.seconds
+
+Or, like
+
+    DayPlanner.interval = 5
+
+Note that if you try to schedule a task with an interval shorter than DayPlanner's interval, it'll complain and fail. If you shorten DayPlanner's interval to less than that of one of its tasks, it'll probably also complain and fail. Use your best judgment.
+
+## Contributing
+
+1. Fork it
+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/day_planner.gemspec

@@ -0,0 +1,25 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'day_planner/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "day_planner"
+  spec.version       = DayPlanner::VERSION
+  spec.authors       = ["Damon Siefert"]
+  spec.email         = ["siefert@gmail.com"]
+  spec.description   = %q{Simple gem to handle in-process scheduling of tasks}
+  spec.summary       = %q{Built to have a way to schedule tasks without running an extra process and incurring extra costs on Heroku.}
+  spec.homepage      = ""
+  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_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+
+  spec.required_ruby_version = ">= 2.0.0"
+end

data/lib/day_planner/base.rb

@@ -0,0 +1,92 @@
+module DayPlanner
+	@@tasks = []
+
+	class << self
+		def tasks
+			@@tasks
+		end
+
+		def schedule(options, &block)
+			raise ArgumentError unless options.is_a?(Hash)
+
+			Task.new(options, &block)
+		end
+
+		def activate
+			@@master.kill if defined?(@@master)
+
+			@@master = Thread.new do
+				while true
+					check_schedule
+					sleep(interval)
+				end
+			end
+		end
+
+		def interval
+			defined?(@@interval) ? @@interval : 60
+		end
+
+		def interval=(value)
+			tasks.each do |t|
+				Rails.logger.warn("DayPlanner: Check interval exceeds the interval of one of its tasks. The task will perform at most every #{value.inspect}.") if t.interval > value
+			end
+
+			@@interval = value
+		end
+
+	private
+		def check_schedule
+			# Rails.logger.debug("DayPlanner is checking for tasks to perform")
+
+			tasks.each do |t|
+				if Time.now > t.last_executed + t.interval
+					begin
+						t.perform
+					rescue => e
+						Rails.logger.warn("DayPlanner: Scheduled task threw an error! Behave yourselves!")
+						Rails.logger.warn(e.inspect)
+					end
+				end
+			end
+		end
+	end
+
+	class Task
+		attr_reader :last_executed, :interval
+
+		def perform
+			@last_executed = Time.now
+
+			@thread.kill if defined?(@thread)
+
+			@thread = Thread.new do
+				@task.call
+			end
+		end
+
+		def initialize(options, &block)
+			if options[:every]
+				@interval = options[:every]
+				raise ArgumentError, "DayPlanner: Task interval is less than scheduler interval. Task not scheduled." if @interval < DayPlanner.interval
+			else
+				raise ArgumentError, "DayPlanner: Scheduling tasks at anything other than simple intervals using 'every' is still not implemented, not even a little bit."
+			end
+
+			@task = block
+
+			DayPlanner.tasks.push(self)
+
+			begin
+				perform
+			rescue => e
+				Rails.logger.warn("DayPlanner: Task caused error on first performance. There's no second chance for a good first impression!")
+				Rails.logger.warn(e.inspect)
+			end
+		end
+	end
+end
+
+DayPlanner.activate
+
+require Rails.root.join('config', 'day_planner_tasks') if defined?(Rails)

data/lib/day_planner/version.rb

@@ -0,0 +1,8 @@
+module DayPlanner
+	MAJOR = 0
+	MINOR = 0
+	TINY  = 1
+	BUILD = nil
+
+  VERSION = [MAJOR, MINOR, TINY, BUILD].compact.join(".")
+end

data/lib/day_planner.rb

@@ -0,0 +1,2 @@
+require "day_planner/version"
+require "day_planner/base"

metadata

@@ -0,0 +1,83 @@
+--- !ruby/object:Gem::Specification
+name: day_planner
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Damon Siefert
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-12-28 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !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'
+description: Simple gem to handle in-process scheduling of tasks
+email:
+- siefert@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE
+- LICENSE.txt
+- README.md
+- Rakefile
+- day_planner.gemspec
+- lib/day_planner.rb
+- lib/day_planner/base.rb
+- lib/day_planner/version.rb
+homepage: ''
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: 2.0.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.0.14
+signing_key: 
+specification_version: 4
+summary: Built to have a way to schedule tasks without running an extra process and
+  incurring extra costs on Heroku.
+test_files: []