vidibus-version_scheduler 0.1.0

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2011 Andre Pankratz
+
+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,36 @@
+# Vidibus::VersionScheduler [![](http://travis-ci.org/vidibus/vidibus-version_scheduler.png)](http://travis-ci.org/vidibus/vidibus-version_scheduler) [![](http://stillmaintained.com/vidibus/vidibus-version_scheduler.png)](http://stillmaintained.com/vidibus/vidibus-version_scheduler)
+
+Schedules migration to future versions created by Vidibus::Versioning.
+
+This gem is part of [Vidibus](http://vidibus.org), an open source toolset for building distributed (video) applications.
+
+
+## Installation
+
+Add `gem "vidibus-version_scheduler"` to your Gemfile. Then call `bundle install` on your console.
+
+
+## Usage
+
+To use scheduling on a versioned model, just include the lib and you're done:
+
+```ruby
+class Book
+  include Mongoid::Document
+  include Vidibus::Versioning::Mongoid
+  include Vidibus::VersionScheduler::Mongoid
+end
+```
+
+Whenever a version gets created that has a future `created_at` timestamp, a `DelayedJob` will be created to
+migrate your model to that version at the specified time.
+
+
+## TODO
+
+* Solve the serious bug with DelayedJob and Mongoid. See ISSUES.md
+
+
+## Copyright
+
+© 2011 Andre Pankratz. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,25 @@
+require "bundler"
+require "rdoc/task"
+require "rspec"
+require "rspec/core/rake_task"
+
+Bundler::GemHelper.install_tasks
+
+$LOAD_PATH.unshift File.expand_path("../lib", __FILE__)
+require "vidibus/version_scheduler/version"
+
+RSpec::Core::RakeTask.new(:rcov) do |t|
+  t.pattern = "spec/**/*_spec.rb"
+  t.rcov = true
+  t.rcov_opts = ["--exclude", "^spec,/gems/"]
+end
+
+Rake::RDocTask.new do |rdoc|
+  rdoc.rdoc_dir = "rdoc"
+  rdoc.title = "vidibus-sysinfo #{Vidibus::VersionScheduler::VERSION}"
+  rdoc.rdoc_files.include("README*")
+  rdoc.rdoc_files.include("lib/**/*.rb")
+  rdoc.options << "--charset=utf-8"
+end
+
+task :default => :rcov

data/lib/vidibus-version_scheduler.rb

@@ -0,0 +1,7 @@
+require "mongoid"
+require "delayed_job"
+require "delayed_job_mongoid"
+require "vidibus-uuid"
+require "vidibus-versioning"
+
+require "vidibus/version_scheduler"

data/lib/vidibus/version_scheduler.rb

@@ -0,0 +1,7 @@
+require "vidibus/version_scheduler/mongoid"
+require "vidibus/version_scheduler/scheduled_version"
+require "vidibus/version_scheduler/migration_job"
+require "vidibus/version_scheduler/version_observer"
+
+Mongoid.observers = Vidibus::VersionScheduler::VersionObserver
+Mongoid.instantiate_observers

data/lib/vidibus/version_scheduler/migration_job.rb

@@ -0,0 +1,19 @@
+module Vidibus
+  module VersionScheduler
+    class MigrationJob < Struct.new(:version_uuid)
+      def initialize(uuid)
+        self.version_uuid = uuid or raise(ArgumentError)
+      end
+
+      def perform
+        return unless version = Vidibus::Versioning::Version.where(:uuid => version_uuid).first
+        return unless versioned = version.versioned
+        begin
+          versioned.migrate!(version.number)
+          ScheduledVersion.where(:version_uuid => version.uuid).destroy_all
+        rescue Vidibus::Versioning::MigrationError
+        end
+      end
+    end
+  end
+end

data/lib/vidibus/version_scheduler/mongoid.rb

@@ -0,0 +1,15 @@
+module Vidibus
+  module VersionScheduler
+    module Mongoid
+      extend ActiveSupport::Concern
+
+      included do
+        has_many :scheduled_versions, :as => :scheduled, :class_name => "Vidibus::VersionScheduler::ScheduledVersion", :dependent => :destroy
+      end
+
+      def next_scheduled_version
+        @next_scheduled_version ||= scheduled_versions.where(:run_at.gt => Time.now).asc(:run_at).limit(1).first
+      end
+    end
+  end
+end

data/lib/vidibus/version_scheduler/scheduled_version.rb

@@ -0,0 +1,49 @@
+module Vidibus
+  module VersionScheduler
+    class ScheduledVersion
+      include ::Mongoid::Document
+
+      belongs_to :scheduled, :polymorphic => true
+
+      field :run_at, :type => Time
+      field :version_uuid, :type => String
+      field :job_id, :type => String
+
+      before_validation :set_run_at
+      validates :version_uuid, :version, :presence => true
+
+      before_create :ensure_job
+      before_destroy :remove_job
+
+      def version
+        @version ||= Vidibus::Versioning::Version.where(:uuid => version_uuid).first
+      end
+
+      def job
+        @job ||= begin
+          Delayed::Backend::Mongoid::Job.find(job_id) if job_id
+        rescue ::Mongoid::Errors::DocumentNotFound
+        end
+      end
+
+      protected
+
+      def set_run_at
+        return unless version
+        self.run_at ||= version.created_at
+      end
+
+      def ensure_job
+        return if job
+        if version and Time.now < run_at
+          @job = Delayed::Job.enqueue(MigrationJob.new(version_uuid), :priority => 1, :run_at => run_at)
+          self.job_id = @job.id
+        end
+      end
+
+      def remove_job
+        job.destroy if job
+      end
+    end
+  end
+end

data/lib/vidibus/version_scheduler/version.rb

@@ -0,0 +1,5 @@
+module Vidibus
+  module VersionScheduler
+    VERSION = "0.1.0"
+  end
+end

data/lib/vidibus/version_scheduler/version_observer.rb

@@ -0,0 +1,39 @@
+module Vidibus
+  module VersionScheduler
+    class VersionObserver < ::Mongoid::Observer
+      observe Vidibus::Versioning::Version
+
+      def after_save(version)
+        schedule(version) if scheduled?(version)
+      end
+
+      def after_destroy(version)
+        unschedule(version) if scheduled?(version)
+      end
+
+      protected
+
+      def scheduled?(version)
+        version.versioned_type.constantize.ancestors.include?(Vidibus::VersionScheduler::Mongoid)
+      end
+
+      def schedule(version)
+        scheduled = ScheduledVersion.where(:version_uuid => version.uuid)
+        if version.created_at > Time.now
+          different = scheduled.where(:run_at.ne => version.created_at)
+          different.destroy_all if different.any?
+          ScheduledVersion.create!(:version_uuid => version.uuid, :scheduled => version.versioned) unless scheduled.any?
+        else
+          unschedule(version)
+        end
+      end
+
+      def unschedule(version)
+        scheduled = ScheduledVersion.where(:version_uuid => version.uuid)
+        if scheduled.any?
+          scheduled.destroy_all
+        end
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,206 @@
+--- !ruby/object:Gem::Specification 
+name: vidibus-version_scheduler
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 0
+  - 1
+  - 0
+  version: 0.1.0
+platform: ruby
+authors: 
+- Andre Pankratz
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-07-14 00:00:00 +02:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: mongoid
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 2
+        version: "2"
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: delayed_job
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: delayed_job_mongoid
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  name: vidibus-uuid
+  prerelease: false
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id004
+- !ruby/object:Gem::Dependency 
+  name: vidibus-versioning
+  prerelease: false
+  requirement: &id005 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id005
+- !ruby/object:Gem::Dependency 
+  name: bundler
+  prerelease: false
+  requirement: &id006 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 1
+        - 0
+        - 0
+        version: 1.0.0
+  type: :development
+  version_requirements: *id006
+- !ruby/object:Gem::Dependency 
+  name: rdoc
+  prerelease: false
+  requirement: &id007 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id007
+- !ruby/object:Gem::Dependency 
+  name: rake
+  prerelease: false
+  requirement: &id008 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id008
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id009 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 2
+        version: "2"
+  type: :development
+  version_requirements: *id009
+- !ruby/object:Gem::Dependency 
+  name: rr
+  prerelease: false
+  requirement: &id010 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id010
+- !ruby/object:Gem::Dependency 
+  name: rcov
+  prerelease: false
+  requirement: &id011 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id011
+description: Schedules migration to future versions created by Vidibus::Versioning.
+email: andre@vidibus.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- lib/vidibus/version_scheduler/migration_job.rb
+- lib/vidibus/version_scheduler/mongoid.rb
+- lib/vidibus/version_scheduler/scheduled_version.rb
+- lib/vidibus/version_scheduler/version.rb
+- lib/vidibus/version_scheduler/version_observer.rb
+- lib/vidibus/version_scheduler.rb
+- lib/vidibus-version_scheduler.rb
+- LICENSE
+- README.md
+- Rakefile
+has_rdoc: true
+homepage: https://github.com/vidibus/vidibus-version_scheduler
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 1
+      - 3
+      - 6
+      version: 1.3.6
+requirements: []
+
+rubyforge_project: vidibus-version_scheduler
+rubygems_version: 1.3.6
+signing_key: 
+specification_version: 3
+summary: Provides scheduling of future versions
+test_files: []
+