maiha-merb_background 0.1

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 maiha@wota.jp
+
+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

@@ -0,0 +1,105 @@
+MerbBackground
+==============
+
+A slice for the Merb framework that offers background tasks for DataMapper.
+This is ported from background-fu that works with Rails + AR.
+
+Original:
+  http://github.com/ncr/background-fu/
+
+
+Methods
+=======
+
+same as background-fu.
+
+  MerbBackground::Job.enqueue!(ExampleWorker, :add, 1, 2)
+
+
+Setup
+=====
+
+  MerbBackground::Job.auto_upgrade!
+
+or
+  rake slices:merb_background:migrate
+
+
+Daemon
+======
+
+  ruby slices/merb_background/script/background.rb
+
+
+
+------------------------------------------------------------------------------
+   
+
+To see all available tasks for MerbBackground run:
+
+rake -T slices:merb_background
+
+------------------------------------------------------------------------------
+
+Instructions for installation:
+
+file: config/init.rb
+
+# add the slice as a regular dependency
+
+dependency 'merb_background'
+
+# if needed, configure which slices to load and in which order
+
+Merb::Plugins.config[:merb_slices] = { :queue => ["MerbBackground", ...] }
+
+# optionally configure the plugins in a before_app_loads callback
+
+Merb::BootLoader.before_app_loads do
+  
+  Merb::Slices::config[:merb_background][:option] = value
+  
+end
+
+file: config/router.rb
+
+# example: /merb_background/:controller/:action/:id
+
+add_slice(:MerbBackground)
+
+# example: /:lang/:controller/:action/:id
+
+add_slice(:MerbBackground, :path => ':lang')
+
+# example: /:controller/:action/:id
+
+slice(:MerbBackground)
+
+Normally you should also run the following rake task:
+
+rake slices:merb_background:install
+
+------------------------------------------------------------------------------
+
+You can put your application-level overrides in:
+
+host-app/slices/merb_background/app - controllers, models, views ...
+
+Templates are located in this order:
+
+1. host-app/slices/merb_background/app/views/*
+2. gems/merb_background/app/views/*
+3. host-app/app/views/*
+
+You can use the host application's layout by configuring the
+merb_background slice in a before_app_loads block:
+
+Merb::Slices.config[:merb_background] = { :layout => :application }
+
+By default :merb_background is used. If you need to override
+stylesheets or javascripts, just specify your own files in your layout
+instead/in addition to the ones supplied (if any) in 
+host-app/public/slices/merb_background.
+
+In any case don't edit those files directly as they may be clobbered any time
+rake merb_background:install is run.

data/Rakefile

@@ -0,0 +1,55 @@
+require 'rubygems'
+require 'rake/gempackagetask'
+
+require 'merb-core'
+require 'merb-core/tasks/merb'
+
+GEM_NAME = "merb_background"
+AUTHOR = "maiha"
+EMAIL = "maiha@wota.jp"
+HOMEPAGE = "http://github.com/maiha/merb_background"
+SUMMARY = "A slice for the Merb framework that offers background tasks for DataMapper"
+GEM_VERSION = "0.1"
+
+spec = Gem::Specification.new do |s|
+  s.rubyforge_project = 'merb'
+  s.name = GEM_NAME
+  s.version = GEM_VERSION
+  s.platform = Gem::Platform::RUBY
+  s.has_rdoc = true
+  s.extra_rdoc_files = ["README", "LICENSE", 'TODO']
+  s.summary = SUMMARY
+  s.description = s.summary
+  s.author = AUTHOR
+  s.email = EMAIL
+  s.homepage = HOMEPAGE
+  s.add_dependency('merb-slices', '>= 1.0.11')
+  s.require_path = 'lib'
+  s.files = %w(LICENSE README Rakefile TODO) + Dir.glob("{lib,spec,app,public,stubs}/**/*")
+end
+
+Rake::GemPackageTask.new(spec) do |pkg|
+  pkg.gem_spec = spec
+end
+
+desc "Install the gem"
+task :install do
+  Merb::RakeHelper.install(GEM_NAME, :version => GEM_VERSION)
+end
+
+desc "Uninstall the gem"
+task :uninstall do
+  Merb::RakeHelper.uninstall(GEM_NAME, :version => GEM_VERSION)
+end
+
+desc "Create a gemspec file"
+task :gemspec do
+  File.open("#{GEM_NAME}.gemspec", "w") do |file|
+    file.puts spec.to_ruby
+  end
+end
+
+require 'spec/rake/spectask'
+require 'merb-core/test/tasks/spectasks'
+desc 'Default: run spec examples'
+task :default => 'spec'

data/TODO

@@ -0,0 +1,13 @@
+TODO:
+
+- Add rake tasks especially for control daemons
+- Add BonusFeature
+- Add codes for AR
+
+Remove anything that you don't need:
+
+- app/controllers/main.rb MerbBackground::Main controller
+- app/views/layout/merb_background.html.erb
+- spec/controllers/main_spec.rb controller specs
+- public/* any public files
+- stubs/* any stub files

data/app/controllers/application.rb

@@ -0,0 +1,5 @@
+class MerbBackground::Application < Merb::Controller
+  
+  controller_for_slice
+  
+end

data/app/controllers/main.rb

@@ -0,0 +1,7 @@
+class MerbBackground::Main < MerbBackground::Application
+  
+  def index
+    render
+  end
+  
+end

data/app/helpers/application_helper.rb

@@ -0,0 +1,64 @@
+module Merb
+  module MerbBackground
+    module ApplicationHelper
+      
+      # @param *segments<Array[#to_s]> Path segments to append.
+      #
+      # @return <String> 
+      #  A path relative to the public directory, with added segments.
+      def image_path(*segments)
+        public_path_for(:image, *segments)
+      end
+      
+      # @param *segments<Array[#to_s]> Path segments to append.
+      #
+      # @return <String> 
+      #  A path relative to the public directory, with added segments.
+      def javascript_path(*segments)
+        public_path_for(:javascript, *segments)
+      end
+      
+      # @param *segments<Array[#to_s]> Path segments to append.
+      #
+      # @return <String> 
+      #  A path relative to the public directory, with added segments.
+      def stylesheet_path(*segments)
+        public_path_for(:stylesheet, *segments)
+      end
+      
+      # Construct a path relative to the public directory
+      # 
+      # @param <Symbol> The type of component.
+      # @param *segments<Array[#to_s]> Path segments to append.
+      #
+      # @return <String> 
+      #  A path relative to the public directory, with added segments.
+      def public_path_for(type, *segments)
+        ::MerbBackground.public_path_for(type, *segments)
+      end
+      
+      # Construct an app-level path.
+      # 
+      # @param <Symbol> The type of component.
+      # @param *segments<Array[#to_s]> Path segments to append.
+      #
+      # @return <String> 
+      #  A path within the host application, with added segments.
+      def app_path_for(type, *segments)
+        ::MerbBackground.app_path_for(type, *segments)
+      end
+      
+      # Construct a slice-level path.
+      # 
+      # @param <Symbol> The type of component.
+      # @param *segments<Array[#to_s]> Path segments to append.
+      #
+      # @return <String> 
+      #  A path within the slice source (Gem), with added segments.
+      def slice_path_for(type, *segments)
+        ::MerbBackground.slice_path_for(type, *segments)
+      end
+      
+    end
+  end
+end

data/app/views/layout/merb_background.html.erb

@@ -0,0 +1,16 @@
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
+<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en-us" lang="en-us">
+  <head>
+    <meta http-equiv="content-type" content="text/html; charset=utf-8" />
+    <title>Fresh MerbBackground Slice</title>
+    <link href="<%= public_path_for :stylesheet, 'master.css' %>" type="text/css" charset="utf-8" rel="stylesheet" media="all" />
+    <script src="<%= public_path_for :javascript, 'master.js' %>" type="text/javascript" charset="utf-8"></script>
+  </head>
+  <!-- you can override this layout at slices/merb_background/app/views/layout/merb_background.html.erb -->
+  <body class="merb_background-slice">
+  <div id="container">
+	  <h1>MerbBackground Slice</h1>
+    <div id="main"><%= catch_content :for_layout %></div>
+  </div>
+  </body>
+</html>

data/app/views/main/index.html.erb

@@ -0,0 +1 @@
+<strong><%= slice.description %></strong> (v. <%= slice.version %>)

data/lib/merb_background.rb

@@ -0,0 +1,88 @@
+if defined?(Merb::Plugins)
+
+  $:.unshift File.dirname(__FILE__)
+
+  dependency 'merb-slices', :immediate => true
+  Merb::Plugins.add_rakefiles "merb_background/merbtasks", "merb_background/slicetasks", "merb_background/spectasks"
+
+  # Register the Slice for the current host application
+  Merb::Slices::register(__FILE__)
+  
+  # Slice configuration - set this in a before_app_loads callback.
+  # By default a Slice uses its own layout, so you can swicht to 
+  # the main application layout or no layout at all if needed.
+  # 
+  # Configuration options:
+  # :layout - the layout to use; defaults to :merb_background
+  # :mirror - which path component types to use on copy operations; defaults to all
+  Merb::Slices::config[:merb_background][:layout] ||= :merb_background
+  
+  # All Slice code is expected to be namespaced inside a module
+  module MerbBackground
+
+    # Slice metadata
+    self.description = "a merb slice for background-fu"
+    self.version = "0.0.1"
+    self.author = "maiha"
+
+    Config = Mash.new(
+                      :cleanup_interval => :on_startup,
+                      :monitor_interval => 10
+                      )
+    
+    # Stub classes loaded hook - runs before LoadClasses BootLoader
+    # right after a slice's classes have been loaded internally.
+    def self.loaded
+      require 'merb_background/job'
+    end
+    
+    # Initialization hook - runs before AfterAppLoads BootLoader
+    def self.init
+    end
+    
+    # Activation hook - runs after AfterAppLoads BootLoader
+    def self.activate
+    end
+    
+    # Deactivation hook - triggered by Merb::Slices.deactivate(MerbBackground)
+    def self.deactivate
+    end
+    
+    # Setup routes inside the host application
+    #
+    # @param scope<Merb::Router::Behaviour>
+    #  Routes will be added within this scope (namespace). In fact, any 
+    #  router behaviour is a valid namespace, so you can attach
+    #  routes at any level of your router setup.
+    #
+    # @note prefix your named routes with :merb_background_
+    #   to avoid potential conflicts with global named routes.
+    def self.setup_router(scope)
+      # example of a named route
+      scope.match('/index(.:format)').to(:controller => 'main', :action => 'index').name(:index)
+      # the slice is mounted at /merb_background - note that it comes before default_routes
+      scope.match('/').to(:controller => 'main', :action => 'index').name(:home)
+      # enable slice-level default routes by default
+      scope.default_routes
+    end
+    
+  end
+  
+  # Setup the slice layout for MerbBackground
+  #
+  # Use MerbBackground.push_path and MerbBackground.push_app_path
+  # to set paths to merb_background-level and app-level paths. Example:
+  #
+  # MerbBackground.push_path(:application, MerbBackground.root)
+  # MerbBackground.push_app_path(:application, Merb.root / 'slices' / 'merb_background')
+  # ...
+  #
+  # Any component path that hasn't been set will default to MerbBackground.root
+  #
+  # Or just call setup_default_structure! to setup a basic Merb MVC structure.
+  MerbBackground.setup_default_structure!
+  
+  # Add dependencies for other MerbBackground classes below. Example:
+  # dependency "merb_background/other"
+  
+end

data/lib/merb_background/job.rb

@@ -0,0 +1,138 @@
+# Example:
+# 
+# job = Job.enqueue!(MyWorker, :my_method, "my_arg_1", "my_arg_2")
+
+#require File.dirname(__FILE__) + '/job/ar.rb'
+require File.dirname(__FILE__) + '/job/dm.rb'
+
+class MerbBackground::Job
+  cattr_accessor :states
+  self.states = %w(pending running finished failed)
+
+#  attr_readonly :worker_class, :worker_method, :args
+  
+  def self.enqueue!(worker_class, worker_method, *args)
+    job = create!(
+      :worker_class  => worker_class.to_s,
+      :worker_method => worker_method.to_s,
+      :args          => args
+    )
+
+    logger.info("MerbBackground: Job enqueued. Job(id: #{job.id}, worker: #{worker_class}, method: #{worker_method}, argc: #{args.size}).")
+    
+    job
+  end
+
+  def self.execute!(config = nil)
+    config = MerbBackground::Config.merge(config || {})
+    cleanup_finished_jobs if config[:cleanup_interval] == :at_start
+
+    config.each do |k,v| 
+      logger.info "MerbBackground: #{k}: #{v}"
+    end
+
+    loop do
+      if job = pending.ready.first(:order => [:priority.desc, :start_at.asc])
+        job.get_done!
+      else
+        logger.info("MerbBackground: Waiting for jobs...")
+        sleep config[:monitor_interval]
+      end
+      cleanup_finished_jobs if config[:cleanup_interval] == :continuous
+    end
+  end
+
+
+  # Invoked by a background daemon.
+  def get_done!
+    initialize_worker
+    invoke_worker
+  rescue Exception => e
+    rescue_worker(e)
+  ensure
+    ensure_worker
+  end
+  
+  # Restart a failed job.
+  def restart!
+    if failed? 
+      update_attributes!(
+        :result     => nil, 
+        :progress   => nil, 
+        :started_at => nil, 
+        :state      => "pending"
+      )
+      logger.info("MerbBackground: Job restarted. Job(id: #{id}).")
+    end
+  end
+  
+  def initialize_worker
+    update_attributes!(:started_at => Time.now, :state => "running")
+    @worker = worker_class.constantize.new
+    logger.info("MerbBackground: Job initialized. Job(id: #{id}).")
+  end
+  
+  def invoke_worker
+    self.result = @worker.send(worker_method, *args)
+    self.state  = "finished"
+    logger.info("MerbBackground: Job finished. Job(id: #{id}).")
+  end
+  
+  def rescue_worker(exception)
+    self.result = [exception.message, exception.backtrace.join("\n")].join("\n\n")
+    self.state  = "failed"
+    logger.info("MerbBackground: Job failed. Job(id: #{id}).")
+  end
+  
+  def ensure_worker
+    self.progress = @worker.instance_variable_get("@progress")
+    save!
+  rescue StaleObjectError
+    # Ignore this exception as its only purpose is
+    # not allowing multiple daemons execute the same job.
+    logger.info("MerbBackground: Race condition handled (It's OK). Job(id: #{id}).")
+  end
+
+  # Delete finished jobs that are more than a week old.
+  def self.cleanup_finished_jobs
+    logger.info "MerbBackground: Cleaning up finished jobs."
+
+    # TODO: AR compats
+    Job.finished.all(:updated_at.lt => 1.week.ago).destroy!
+  end
+  
+  def self.generate_state_helpers
+    states.each do |state_name|
+      define_method("#{state_name}?") do
+        state == state_name
+      end
+
+      # Job.running => array of running jobs, etc.
+      self.class.send(:define_method, state_name) do
+        all(:state => state_name, :order => [:id.desc])
+      end
+    end
+  end
+  generate_state_helpers
+
+  def setup_state
+    return unless state.blank?
+
+    self.state = "pending" 
+  end
+  
+  # Default priority is 0. Jobs will be executed in descending priority order (negative priorities allowed).
+  def setup_priority
+    return unless priority.blank?
+    
+    self.priority = 0
+  end
+  
+  # Job will be executed after this timestamp.
+  def setup_start_at
+    return unless start_at.blank?
+    
+    self.start_at = Time.now
+  end
+
+end  

data/lib/merb_background/job/ar.rb

@@ -0,0 +1,10 @@
+class MerbBackground::Job < ActiveRecord::Base
+  cattr_accessor :states
+  self.states = %w(pending running finished failed)
+
+  serialize :args, Array
+  serialize :result
+
+  before_create :setup_state, :setup_priority, :setup_start_at
+  validates_presence_of :worker_class, :worker_method
+end

data/lib/merb_background/job/ar2dm.rb

@@ -0,0 +1,37 @@
+module DataMapper
+  module ActiveRecordMethods
+    def self.included(model)
+      model.class_eval do
+        extend  ClassMethods
+        include InstanceMethods
+      end
+    end
+
+    class RecordNotSaved < DataMapper::PersistenceError; end
+
+    module InstanceMethods
+      def logger
+        self.class.logger
+      end
+
+      def bang(&block)
+        block.call or raise RecordNotSaved
+        return self
+      end
+      
+      def update_attributes!(hash)
+        bang{update_attributes(hash)}
+      end
+    end
+
+    module ClassMethods
+      def logger
+        DataMapper.logger
+      end
+
+      def create!(attributes)
+        new(attributes).bang{save}
+      end
+    end
+  end
+end

data/lib/merb_background/job/bonus_features.rb

@@ -0,0 +1,98 @@
+module Job::BonusFeatures
+  
+  def self.included(base)
+    base.states += %w(stopping stopped)
+    base.generate_state_helpers
+
+    base.alias_method_chain :invoke_worker, :threads
+    base.alias_method_chain :ensure_worker, :threads
+    base.alias_method_chain :restart!,      :threads
+  end
+  
+  def invoke_worker_with_threads
+    monitor_worker
+    
+    res = catch(:stopping) do
+      invoke_worker_without_threads; nil
+    end
+    
+    self.reload
+    self.state = res ? "stopped" : "finished"
+  end
+
+  def ensure_worker_with_threads
+    ensure_worker_without_threads
+    cleanup_after_threads
+  end
+  
+  # The record_progress() method becomes available when your worker class includes
+  # Background::WorkerMonitoring.
+  #
+  # Every time worker invokes record_progress() is a possible stopping place.
+  #
+  # How it works:
+  # 1. invoke job.stop! to set a state (stopping) in a db
+  # 2. Monitoring thread picks up the state change from db
+  #    and sets @stopping to true in the worker.
+  # 3. The worker invokes a register_progress() somewhere during execution.
+  # 4. The record_progress() method throws :stopping symbol if @stopping == true
+  # 5. The job catches the :stopping symbol and reacts upon it.
+  # 6. The job is stopped in a merciful way. No one gets harmed.
+  def stop!
+    if running?
+      update_attribute(:state, "stopping")
+      logger.info("BackgroundFu: Stopping job. Job(id: #{id}).")
+    end
+  end
+  
+  # Overridden because of new "stopped" state.
+  def restart_with_threads!
+    if stopped? || failed?
+      update_attributes!(
+        :result     => nil, 
+        :progress   => nil, 
+        :started_at => nil, 
+        :state      => "pending"
+      ) 
+      logger.info("BackgroundFu: Restarting job. Job(id: #{id}).")
+    end
+  end
+
+  # Monitors the worker and updates the job progress.  If the job's status
+  # is changed to 'stopping', the worker is requested to stop.
+  def monitor_worker
+    Thread.new do
+      while running? && !Job.find(id).stopping?
+        current_progress = @worker.instance_variable_get("@progress")
+
+        if current_progress == progress
+          sleep 5
+        else
+          update_attribute(:progress, current_progress)
+          sleep 1
+        end
+      end
+
+      if Job.find(id).stopping?
+        @worker.instance_variable_set("@stopping", true)
+      end
+    end
+    
+    logger.info("BackgroundFu: Job monitoring started. Job(id: #{id}).")
+  end
+
+  # Closes database connections left after finished threads.
+  def cleanup_after_threads
+    ActiveRecord::Base.verify_active_connections!
+  end
+  
+  def elapsed
+    (updated_at.to_f - started_at.to_f).to_i if !pending?
+  end
+  
+  # seconds to go, based on estimated and progress
+  def estimated
+    ((elapsed * 100) / progress) - elapsed if running? && (1..99).include?(progress.to_i)
+  end
+
+end

data/lib/merb_background/job/dm.rb

@@ -0,0 +1,34 @@
+require File.dirname(__FILE__) + '/ar2dm'
+
+class MerbBackground::Job
+  include DataMapper::Resource
+
+  property :id, Serial
+  property :worker_class, String, :size => 255
+  property :worker_method, String, :size => 255
+  property :args, Yaml
+  property :result, Yaml
+  property :priority, Integer
+  property :progress, Integer
+  property :state, String
+  property :lock_version, Integer, :default => 0
+      
+  property :start_at, DateTime
+  property :started_at, DateTime
+
+  property :created_at, DateTime
+  property :updated_at, DateTime
+
+  before :save, :setup_state
+  before :save, :setup_priority
+  before :save, :setup_start_at
+
+  validates_present :worker_class, :worker_method
+
+  include DataMapper::ActiveRecordMethods
+
+  def self.ready
+    all(:start_at.lte => Time.now)
+  end
+end
+

data/lib/merb_background/merbtasks.rb

@@ -0,0 +1,103 @@
+namespace :slices do
+  namespace :merb_background do
+  
+    desc "Install MerbBackground"
+    task :install => [:preflight, :setup_directories, :copy_assets, :migrate]
+    
+    desc "Test for any dependencies"
+    task :preflight do # see slicetasks.rb
+    end
+  
+    desc "Setup directories"
+    task :setup_directories do
+      puts "Creating directories for host application"
+      MerbBackground.mirrored_components.each do |type|
+        if File.directory?(MerbBackground.dir_for(type))
+          if !File.directory?(dst_path = MerbBackground.app_dir_for(type))
+            relative_path = dst_path.relative_path_from(Merb.root)
+            puts "- creating directory :#{type} #{File.basename(Merb.root) / relative_path}"
+            mkdir_p(dst_path)
+          end
+        end
+      end
+    end
+    
+    # desc "Copy stub files to host application"
+    # task :stubs do
+    #   puts "Copying stubs for MerbBackground - resolves any collisions"
+    #   copied, preserved = MerbBackground.mirror_stubs!
+    #   puts "- no files to copy" if copied.empty? && preserved.empty?
+    #   copied.each { |f| puts "- copied #{f}" }
+    #   preserved.each { |f| puts "! preserved override as #{f}" }
+    # end
+    
+    # desc "Copy stub files and views to host application"
+    # task :patch => [ "stubs", "freeze:views" ]
+  
+    desc "Copy public assets to host application"
+    task :copy_assets do
+      puts "Copying assets for MerbBackground - resolves any collisions"
+      copied, preserved = MerbBackground.mirror_public!
+      puts "- no files to copy" if copied.empty? && preserved.empty?
+      copied.each { |f| puts "- copied #{f}" }
+      preserved.each { |f| puts "! preserved override as #{f}" }
+    end
+    
+    desc "Migrate the database"
+    task :migrate do # see slicetasks.rb
+    end
+    
+    desc "Freeze MerbBackground into your app (only merb_background/app)" 
+    task :freeze => [ "freeze:app" ]
+
+    namespace :freeze do
+      
+      # desc "Freezes MerbBackground by installing the gem into application/gems"
+      # task :gem do
+      #   ENV["GEM"] ||= "merb_background"
+      #   Rake::Task['slices:install_as_gem'].invoke
+      # end
+      
+      desc "Freezes MerbBackground by copying all files from merb_background/app to your application"
+      task :app do
+        puts "Copying all merb_background/app files to your application - resolves any collisions"
+        copied, preserved = MerbBackground.mirror_app!
+        puts "- no files to copy" if copied.empty? && preserved.empty?
+        copied.each { |f| puts "- copied #{f}" }
+        preserved.each { |f| puts "! preserved override as #{f}" }
+      end
+      
+      desc "Freeze all views into your application for easy modification" 
+      task :views do
+        puts "Copying all view templates to your application - resolves any collisions"
+        copied, preserved = MerbBackground.mirror_files_for :view
+        puts "- no files to copy" if copied.empty? && preserved.empty?
+        copied.each { |f| puts "- copied #{f}" }
+        preserved.each { |f| puts "! preserved override as #{f}" }
+      end
+      
+      desc "Freeze all models into your application for easy modification" 
+      task :models do
+        puts "Copying all models to your application - resolves any collisions"
+        copied, preserved = MerbBackground.mirror_files_for :model
+        puts "- no files to copy" if copied.empty? && preserved.empty?
+        copied.each { |f| puts "- copied #{f}" }
+        preserved.each { |f| puts "! preserved override as #{f}" }
+      end
+      
+      desc "Freezes MerbBackground as a gem and copies over merb_background/app"
+      task :app_with_gem => [:gem, :app]
+      
+      desc "Freezes MerbBackground by unpacking all files into your application"
+      task :unpack do
+        puts "Unpacking MerbBackground files to your application - resolves any collisions"
+        copied, preserved = MerbBackground.unpack_slice!
+        puts "- no files to copy" if copied.empty? && preserved.empty?
+        copied.each { |f| puts "- copied #{f}" }
+        preserved.each { |f| puts "! preserved override as #{f}" }
+      end
+      
+    end
+    
+  end
+end

data/lib/merb_background/slicetasks.rb

@@ -0,0 +1,21 @@
+namespace :slices do
+  namespace :merb_background do 
+    
+    # add your own merb_background tasks here
+    
+    # # Uncomment the following lines and edit the pre defined tasks
+    #
+    # # implement this to test for structural/code dependencies
+    # # like certain directories or availability of other files
+    # desc "Test for any dependencies"
+    # task :preflight do
+    # end
+    # 
+    # # implement this to perform any database related setup steps
+    desc "Migrate the database"
+    task :migrate do
+      MerbBackground::Job.auto_upgrade!
+    end
+    
+  end
+end

data/lib/merb_background/spectasks.rb

@@ -0,0 +1,53 @@
+namespace :slices do
+  namespace :merb_background do
+      
+    desc "Run slice specs within the host application context"
+    task :spec => [ "spec:explain", "spec:default" ]
+    
+    namespace :spec do
+      
+      slice_root = File.expand_path(File.join(File.dirname(__FILE__), '..', '..'))
+      
+      task :explain do
+        puts "\nNote: By running MerbBackground specs inside the application context any\n" +
+             "overrides could break existing specs. This isn't always a problem,\n" +
+             "especially in the case of views. Use these spec tasks to check how\n" +
+             "well your application conforms to the original slice implementation."
+      end
+      
+      Spec::Rake::SpecTask.new('default') do |t|
+        t.spec_opts = ["--format", "specdoc", "--colour"]
+        t.spec_files = Dir["#{slice_root}/spec/**/*_spec.rb"].sort
+      end
+
+      desc "Run all model specs, run a spec for a specific Model with MODEL=MyModel"
+      Spec::Rake::SpecTask.new('model') do |t|
+        t.spec_opts = ["--format", "specdoc", "--colour"]
+        if(ENV['MODEL'])
+          t.spec_files = Dir["#{slice_root}/spec/models/**/#{ENV['MODEL']}_spec.rb"].sort
+        else
+          t.spec_files = Dir["#{slice_root}/spec/models/**/*_spec.rb"].sort
+        end
+      end
+
+      desc "Run all request specs, run a spec for a specific request with REQUEST=MyRequest"
+      Spec::Rake::SpecTask.new('request') do |t|
+        t.spec_opts = ["--format", "specdoc", "--colour"]
+        if(ENV['REQUEST'])
+          t.spec_files = Dir["#{slice_root}/spec/requests/**/#{ENV['REQUEST']}_spec.rb"].sort
+        else    
+          t.spec_files = Dir["#{slice_root}/spec/requests/**/*_spec.rb"].sort
+        end
+      end
+
+      desc "Run all specs and output the result in html"
+      Spec::Rake::SpecTask.new('html') do |t|
+        t.spec_opts = ["--format", "html"]
+        t.libs = ['lib', 'server/lib' ]
+        t.spec_files = Dir["#{slice_root}/spec/**/*_spec.rb"].sort
+      end
+      
+    end
+    
+  end
+end

data/public/stylesheets/master.css

@@ -0,0 +1,2 @@
+html, body { margin: 0; padding: 0; }
+#container { width: 800px; margin: 4em auto; padding: 4em 4em 6em 4em; background: #DDDDDD; }

data/spec/merb_background_spec.rb

@@ -0,0 +1,20 @@
+require File.dirname(__FILE__) + '/spec_helper'
+
+describe "MerbBackground (module)" do
+  
+  # Implement your MerbBackground specs here
+  
+  # To spec MerbBackground you need to hook it up to the router like this:
+  
+  # before :all do
+  #   Merb::Router.prepare { add_slice(:MerbBackground) } if standalone?
+  # end
+  # 
+  # after :all do
+  #   Merb::Router.reset! if standalone?
+  # end
+  #
+  #
+  # it "should have proper specs"
+  
+end

data/spec/requests/main_spec.rb

@@ -0,0 +1,30 @@
+require File.join(File.dirname(__FILE__), '..', 'spec_helper.rb')
+
+describe  "/merb_background/" do
+  
+  before(:all) do
+    mount_slice
+  end
+  
+  describe "GET /" do
+    
+    before(:each) do
+      @response = request("/merb_background/")
+    end
+    
+    it "should be successful" do
+      @response.status.should be_successful
+    end
+    
+    # This is just an example of what you can do
+    # You can also use the other webrat methods to click links,
+    # fill up forms etc...
+    it "should render the default slice layout" do
+      @response.should have_tag(:h1, :content => "MerbBackground Slice")
+      @response.should have_selector("div#container div#main")
+      @response.should have_xpath("//div[@id='container']/div[@id='main']")
+    end
+    
+  end
+  
+end

data/spec/spec_helper.rb

@@ -0,0 +1,58 @@
+require 'rubygems'
+require 'merb-core'
+require 'merb-slices'
+require 'spec'
+
+# Add merb_background.rb to the search path
+Merb::Plugins.config[:merb_slices][:auto_register] = true
+Merb::Plugins.config[:merb_slices][:search_path]   = File.join(File.dirname(__FILE__), '..', 'lib', 'merb_background.rb')
+
+# Require merb_background.rb explicitly so any dependencies are loaded
+require Merb::Plugins.config[:merb_slices][:search_path]
+
+# Using Merb.root below makes sure that the correct root is set for
+# - testing standalone, without being installed as a gem and no host application
+# - testing from within the host application; its root will be used
+Merb.start_environment(
+  :testing => true, 
+  :adapter => 'runner', 
+  :environment => ENV['MERB_ENV'] || 'test',
+  :session_store => 'memory'
+)
+
+module Merb
+  module Test
+    module SliceHelper
+      
+      # The absolute path to the current slice
+      def current_slice_root
+        @current_slice_root ||= File.expand_path(File.join(File.dirname(__FILE__), '..'))
+      end
+      
+      # Whether the specs are being run from a host application or standalone
+      def standalone?
+        Merb.root == ::MerbBackground.root
+      end
+      
+    end
+  end
+end
+
+Spec::Runner.configure do |config|
+  config.include(Merb::Test::ViewHelper)
+  config.include(Merb::Test::RouteHelper)
+  config.include(Merb::Test::ControllerHelper)
+  config.include(Merb::Test::SliceHelper)
+end
+
+# You can add your own helpers here
+#
+Merb::Test.add_helpers do
+  def mount_slice
+    Merb::Router.prepare { add_slice(:MerbBackground, "merb_background") } if standalone?
+  end
+
+  def dismount_slice
+    Merb::Router.reset! if standalone?
+  end
+end

data/stubs/app/controllers/application.rb

@@ -0,0 +1,2 @@
+class MerbBackground::Application < Merb::Controller
+end

data/stubs/app/controllers/main.rb

@@ -0,0 +1,2 @@
+class MerbBackground::Main < MerbBackground::Application
+end

metadata

@@ -0,0 +1,101 @@
+--- !ruby/object:Gem::Specification 
+name: maiha-merb_background
+version: !ruby/object:Gem::Version 
+  version: "0.1"
+platform: ruby
+authors: 
+- maiha
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-05-01 00:00:00 -07:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: merb-slices
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 1.0.11
+    version: 
+description: A slice for the Merb framework that offers background tasks for DataMapper
+email: maiha@wota.jp
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README
+- LICENSE
+- TODO
+files: 
+- LICENSE
+- README
+- Rakefile
+- TODO
+- lib/merb_background
+- lib/merb_background/config.rb
+- lib/merb_background/spectasks.rb
+- lib/merb_background/job.rb
+- lib/merb_background/job
+- lib/merb_background/job/dm.rb
+- lib/merb_background/job/ar2dm.rb
+- lib/merb_background/job/ar.rb
+- lib/merb_background/job/bonus_features.rb
+- lib/merb_background/slicetasks.rb
+- lib/merb_background/merbtasks.rb
+- lib/merb_background.rb
+- spec/merb_background_spec.rb
+- spec/spec_helper.rb
+- spec/requests
+- spec/requests/main_spec.rb
+- app/views
+- app/views/layout
+- app/views/layout/merb_background.html.erb
+- app/views/main
+- app/views/main/index.html.erb
+- app/controllers
+- app/controllers/main.rb
+- app/controllers/application.rb
+- app/helpers
+- app/helpers/application_helper.rb
+- public/stylesheets
+- public/stylesheets/master.css
+- public/javascripts
+- public/javascripts/master.js
+- stubs/app
+- stubs/app/controllers
+- stubs/app/controllers/main.rb
+- stubs/app/controllers/application.rb
+has_rdoc: true
+homepage: http://github.com/maiha/merb_background
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: merb
+rubygems_version: 1.2.0
+signing_key: 
+specification_version: 3
+summary: A slice for the Merb framework that offers background tasks for DataMapper
+test_files: []
+