trackable_tasks 0.0.1

data/spec/dummy/public/javascripts/rails.js

@@ -0,0 +1,191 @@
+(function() {
+  // Technique from Juriy Zaytsev
+  // http://thinkweb2.com/projects/prototype/detecting-event-support-without-browser-sniffing/
+  function isEventSupported(eventName) {
+    var el = document.createElement('div');
+    eventName = 'on' + eventName;
+    var isSupported = (eventName in el);
+    if (!isSupported) {
+      el.setAttribute(eventName, 'return;');
+      isSupported = typeof el[eventName] == 'function';
+    }
+    el = null;
+    return isSupported;
+  }
+
+  function isForm(element) {
+    return Object.isElement(element) && element.nodeName.toUpperCase() == 'FORM'
+  }
+
+  function isInput(element) {
+    if (Object.isElement(element)) {
+      var name = element.nodeName.toUpperCase()
+      return name == 'INPUT' || name == 'SELECT' || name == 'TEXTAREA'
+    }
+    else return false
+  }
+
+  var submitBubbles = isEventSupported('submit'),
+      changeBubbles = isEventSupported('change')
+
+  if (!submitBubbles || !changeBubbles) {
+    // augment the Event.Handler class to observe custom events when needed
+    Event.Handler.prototype.initialize = Event.Handler.prototype.initialize.wrap(
+      function(init, element, eventName, selector, callback) {
+        init(element, eventName, selector, callback)
+        // is the handler being attached to an element that doesn't support this event?
+        if ( (!submitBubbles && this.eventName == 'submit' && !isForm(this.element)) ||
+             (!changeBubbles && this.eventName == 'change' && !isInput(this.element)) ) {
+          // "submit" => "emulated:submit"
+          this.eventName = 'emulated:' + this.eventName
+        }
+      }
+    )
+  }
+
+  if (!submitBubbles) {
+    // discover forms on the page by observing focus events which always bubble
+    document.on('focusin', 'form', function(focusEvent, form) {
+      // special handler for the real "submit" event (one-time operation)
+      if (!form.retrieve('emulated:submit')) {
+        form.on('submit', function(submitEvent) {
+          var emulated = form.fire('emulated:submit', submitEvent, true)
+          // if custom event received preventDefault, cancel the real one too
+          if (emulated.returnValue === false) submitEvent.preventDefault()
+        })
+        form.store('emulated:submit', true)
+      }
+    })
+  }
+
+  if (!changeBubbles) {
+    // discover form inputs on the page
+    document.on('focusin', 'input, select, texarea', function(focusEvent, input) {
+      // special handler for real "change" events
+      if (!input.retrieve('emulated:change')) {
+        input.on('change', function(changeEvent) {
+          input.fire('emulated:change', changeEvent, true)
+        })
+        input.store('emulated:change', true)
+      }
+    })
+  }
+
+  function handleRemote(element) {
+    var method, url, params;
+
+    var event = element.fire("ajax:before");
+    if (event.stopped) return false;
+
+    if (element.tagName.toLowerCase() === 'form') {
+      method = element.readAttribute('method') || 'post';
+      url    = element.readAttribute('action');
+      params = element.serialize();
+    } else {
+      method = element.readAttribute('data-method') || 'get';
+      url    = element.readAttribute('href');
+      params = {};
+    }
+
+    new Ajax.Request(url, {
+      method: method,
+      parameters: params,
+      evalScripts: true,
+
+      onComplete:    function(request) { element.fire("ajax:complete", request); },
+      onSuccess:     function(request) { element.fire("ajax:success",  request); },
+      onFailure:     function(request) { element.fire("ajax:failure",  request); }
+    });
+
+    element.fire("ajax:after");
+  }
+
+  function handleMethod(element) {
+    var method = element.readAttribute('data-method'),
+        url = element.readAttribute('href'),
+        csrf_param = $$('meta[name=csrf-param]')[0],
+        csrf_token = $$('meta[name=csrf-token]')[0];
+
+    var form = new Element('form', { method: "POST", action: url, style: "display: none;" });
+    element.parentNode.insert(form);
+
+    if (method !== 'post') {
+      var field = new Element('input', { type: 'hidden', name: '_method', value: method });
+      form.insert(field);
+    }
+
+    if (csrf_param) {
+      var param = csrf_param.readAttribute('content'),
+          token = csrf_token.readAttribute('content'),
+          field = new Element('input', { type: 'hidden', name: param, value: token });
+      form.insert(field);
+    }
+
+    form.submit();
+  }
+
+
+  document.on("click", "*[data-confirm]", function(event, element) {
+    var message = element.readAttribute('data-confirm');
+    if (!confirm(message)) event.stop();
+  });
+
+  document.on("click", "a[data-remote]", function(event, element) {
+    if (event.stopped) return;
+    handleRemote(element);
+    event.stop();
+  });
+
+  document.on("click", "a[data-method]", function(event, element) {
+    if (event.stopped) return;
+    handleMethod(element);
+    event.stop();
+  });
+
+  document.on("submit", function(event) {
+    var element = event.findElement(),
+        message = element.readAttribute('data-confirm');
+    if (message && !confirm(message)) {
+      event.stop();
+      return false;
+    }
+
+    var inputs = element.select("input[type=submit][data-disable-with]");
+    inputs.each(function(input) {
+      input.disabled = true;
+      input.writeAttribute('data-original-value', input.value);
+      input.value = input.readAttribute('data-disable-with');
+    });
+
+    var element = event.findElement("form[data-remote]");
+    if (element) {
+      handleRemote(element);
+      event.stop();
+    }
+  });
+
+  document.on("ajax:after", "form", function(event, element) {
+    var inputs = element.select("input[type=submit][disabled=true][data-disable-with]");
+    inputs.each(function(input) {
+      input.value = input.readAttribute('data-original-value');
+      input.removeAttribute('data-original-value');
+      input.disabled = false;
+    });
+  });
+
+  Ajax.Responders.register({
+    onCreate: function(request) {
+      var csrf_meta_tag = $$('meta[name=csrf-token]')[0];
+
+      if (csrf_meta_tag) {
+        var header = 'X-CSRF-Token',
+            token = csrf_meta_tag.readAttribute('content');
+
+        if (!request.options.requestHeaders) {
+          request.options.requestHeaders = {};
+        }
+        request.options.requestHeaders[header] = token;
+      }
+    }
+  });
+})();

data/spec/dummy/script/rails

@@ -0,0 +1,6 @@
+#!/usr/bin/env ruby
+# This command will automatically be run when you run "rails" with Rails 3 gems installed from the root of your application.
+
+APP_PATH = File.expand_path('../../config/application',  __FILE__)
+require File.expand_path('../../config/boot',  __FILE__)
+require 'rails/commands'

data/spec/integration/navigation_spec.rb

@@ -0,0 +1,9 @@
+require 'spec_helper'
+
+describe "Navigation" do
+  include Capybara
+  
+  it "should be a valid app" do
+    ::Rails.application.should be_a(Dummy::Application)
+  end
+end

data/spec/models/task_run_spec.rb

@@ -0,0 +1,100 @@
+require 'spec_helper'
+include TrackableTasks
+
+describe TaskRun do
+  describe "validations" do
+    before(:each) do
+      @valid_attributes = {
+        :start_time => Time.now,
+        :task_type => "my_task",
+        :success => false
+      }
+      @run = TaskRun.new()
+    end
+
+    it "should be valid" do
+      @run.attributes = @valid_attributes
+      @run.should be_valid
+    end
+
+    it "should require task type" do
+      @run.should have(1).error_on(:task_type)
+    end
+    
+    it "should require start time" do
+      @run.should have(1).error_on(:start_time)
+    end
+    
+    it "should require success" do
+      @run.success = nil
+      @run.should have(1).error_on(:success)
+    end
+
+    it "should default to success = false" do
+      @run.success.should == false
+      @run.should have(0).error_on(:success)
+    end
+
+    it "end time should be after start time" do
+    end
+  end
+
+  describe "add_log_text method" do
+    before(:each) do
+      @run = TaskRun.new()
+      @text = "This trackable task is cool"
+    end
+
+    it "should take one parameter" do
+      @run.method(:add_log_text).arity.should == 1
+    end
+
+    it "should add a newline after the input text" do
+      @run.add_log_text(@text)
+      @run.log_text.should == (@text + "\n")
+    end
+
+    it "should save the string to the log_text if it is empty" do
+      @run.add_log_text(@text)
+      @run.log_text.should match @text
+    end
+    
+    it "should append the string to the text if it is not empty" do
+      original_text = "first log text"
+      @run.log_text = original_text
+      @run.add_log_text(@text)
+      @run.log_text.should match original_text
+      @run.log_text.should match @text
+    end
+
+  end
+
+  describe "add_error_text method" do
+    before(:each) do
+      @run = TaskRun.new()
+      @text = "This trackable task is erroring"
+    end
+
+    it "should take one parameter" do
+      @run.method(:add_error_text).arity.should == 1
+    end
+
+    it "should add a newline after the input text" do
+      @run.add_error_text(@text)
+      @run.error_text.should == (@text + "\n")
+    end
+
+    it "should save the string to the error_text if it is empty" do
+      @run.add_error_text(@text)
+      @run.error_text.should match @text
+    end
+    
+    it "should append the string to the text if it is not empty" do
+      original_text = "first log text"
+      @run.error_text = original_text
+      @run.add_error_text(@text)
+      @run.error_text.should match original_text
+      @run.error_text.should match @text
+    end
+  end
+end

data/spec/rake_task_spec.rb

@@ -0,0 +1,29 @@
+require "spec_helper"
+require "rake"
+
+# only doing light testing of the rake tasks
+# probably could increase coverage at some point but I can't figure out how to stub the run_trackable_task function
+describe "trackable_task rake tasks" do
+  before(:each) do
+    @rake = Rake::Application.new
+    Rake.application = @rake
+    Rake.application.rake_require "dummy/lib/tasks/trackable_tasks"
+    Rake::Task.define_task(:environment)
+  end
+
+  describe "dynamic rake task" do
+    it "should load the file names in the lib/trackable_tasks folder" do
+      @task_name = "trackable_task:my_task"
+      @rake[@task_name].invoke
+      TrackableTasks::TaskRun.last.task_type.should == "MyTask"
+    end
+  end
+
+  describe "run rake task" do
+    before(:each) do
+      @task_name = "trackable_task:run task_name=my_task"
+      @rake[@task_name].invoke
+      TrackableTasks::TaskRun.last.task_type.should == "MyTask"
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,37 @@
+# Configure Rails Envinronment
+ENV["RAILS_ENV"] = "test"
+
+require "ruby-debug"
+require File.expand_path("../dummy/config/environment.rb",  __FILE__)
+require "rails/test_help"
+require "rspec/rails"
+
+ActionMailer::Base.delivery_method = :test
+ActionMailer::Base.perform_deliveries = true
+ActionMailer::Base.default_url_options[:host] = "test.com"
+
+Rails.backtrace_cleaner.remove_silencers!
+
+# Configure capybara for integration testing
+require "capybara/rails"
+Capybara.default_driver   = :rack_test
+Capybara.default_selector = :css
+
+# Run any available migration
+ActiveRecord::Migrator.migrate File.expand_path("../dummy/db/migrate/", __FILE__)
+
+# Load support files
+Dir["#{File.dirname(__FILE__)}/support/**/*.rb"].each { |f| require f }
+
+RSpec.configure do |config|
+  # Remove this line if you don't want RSpec's should and should_not
+  # methods or matchers
+  require 'rspec/expectations'
+  config.include RSpec::Matchers
+
+  # == Mock Framework
+  config.mock_with :rspec
+
+  # use transactions
+  config.use_transactional_fixtures = true
+end

data/spec/support/sample_tasks.rb

@@ -0,0 +1,26 @@
+class MyTask < TrackableTasks::Base
+  
+  # convenience method to make our lives easier
+  # @task_run is not noramlly visible
+  def task_run
+    @task_run
+  end
+  
+  def run
+    #log "Running MyTask"
+  end
+end
+
+class ErroringTask < TrackableTasks::Base
+
+  def error_text
+    "This task is supposed to error so here it is."
+  end
+
+  def run
+    raise error_text
+  end
+end
+
+class TaskWithoutRun < TrackableTasks::Base
+end

data/spec/trackable_task_base_spec.rb

@@ -0,0 +1,168 @@
+require 'spec_helper'
+
+describe TrackableTasks::Base do
+  describe "initialize method" do
+    before(:each) do 
+      @mt = MyTask.new
+    end
+
+    it "should create a task run instance" do
+      TrackableTasks::TaskRun.all.length.should == 1
+    end
+
+    it "should set the start time" do
+      @mt.task_run.start_time.should_not be_nil
+    end
+
+    it "should set the type" do
+      @mt.task_run.task_type.should == "MyTask"
+    end
+    
+    it "should be successful" do
+      # it should be successful on initialization
+      @mt.task_run.success.should be_true
+    end
+
+    it "should default to notice if no log level is set" do
+      # this awesome piece of code adds a method to @mt on the fly so I can
+      # access the log_level instance variable
+      # I am pretty sure this is the wrong way to do things
+      def @mt.log_level
+        @log_level
+      end
+      @mt.log_level.should == :notice
+    end
+  end
+
+  describe "allowable_log_level method" do
+    before(:each) do
+      @mt = MyTask.new
+    end
+
+    it "should change the log level to notice if not an allowable level" do
+      @mt.allowable_log_level(:illegal_level).should == :notice
+    end
+
+    it "should not change the level if it is allowable" do
+      @mt.allowable_log_level(:notice).should == :notice
+    end
+
+    it "should convert the input to a string before comparing if it is nil" do
+      @mt.allowable_log_level(nil).should == :notice
+    end
+
+    it "should convert the input to a symbol before comparing it against the allowable log levels" do
+      @mt.allowable_log_level("error").should == :error
+    end
+  end
+
+  describe "run_task" do
+    before(:each) do 
+      @mt = MyTask.new
+    end
+
+    it "should call the run method" do
+      @mt.should_receive(:run)
+      @mt.run_task
+    end
+
+    it "should be successful if no errors were raised" do
+      @mt.run_task
+      @mt.task_run.success.should be_true
+    end
+
+    it "should handle errors from the run method by saving them to the error log" do
+      @erroring_task = ErroringTask.new
+      @erroring_task.run_task
+      @task_run = TrackableTasks::TaskRun.last
+      @task_run.error_text.should match ""
+    end
+
+    it "should not be successful if any errors were raised" do
+      @erroring_task = ErroringTask.new
+      @erroring_task.run_task
+      @task_run = TrackableTasks::TaskRun.last
+      @task_run.success.should be_false
+    end
+  end
+
+  describe "run method" do
+    it "should error if it isn't overriden" do
+      @t = TaskWithoutRun.new
+      @t.run_task
+      @task_run = TrackableTasks::TaskRun.last
+      @task_run.error_text.should match "The run method must be overridden"
+      @task_run.error_text.should match "NotImplementedError"
+    end
+  end
+
+  describe "log method" do
+    before(:each) do 
+      @mt = MyTask.new
+    end
+
+    it "should take one argument" do
+      # I don't know why this is -2
+      # Maybe we should just remove this test
+      @mt.method(:log).arity.should == -2
+    end
+
+    it "should call the task run's add_log_text method" do
+      @mt.log("test log text")
+      @mt.run_task
+      @mt.task_run.log_text.should match "test log text"
+    end
+
+    it "should default to a log level of notice" do
+      @mt = MyTask.new(:error)
+      @mt.log("text that shouldn't be saved")
+      @mt.task_run.log_text.should be_nil
+    end
+
+    it "should call allowable_log_level" do
+      @mt.should_receive(:allowable_log_level).and_return(:notice)
+      @mt.log("some random text")
+    end
+
+    # test each of the three log levels to see if it saves at the correct time
+    it "should save debug logs if the log level is set to debug" do
+      # whether or not to save at each of the levels
+      levels = { :debug => true, :notice => false, :error => false }
+      levels.each_pair do |level, save|
+        @mt = MyTask.new(level)
+        @mt.log("some debugging text", :debug)
+        if save
+          @mt.task_run.log_text.should match "some debugging text"
+        else
+          @mt.task_run.log_text.should be_nil
+        end
+      end
+    end
+
+    it "should save notice logs if the log level is debug or notice" do
+      levels = { :debug => true, :notice => true, :error => false }
+      levels.each_pair do |level, save|
+        @mt = MyTask.new(level)
+        @mt.log("some debugging text", :notice)
+        if save
+          @mt.task_run.log_text.should match "some debugging text"
+        else
+          @mt.task_run.log_text.should be_nil
+        end
+      end
+    end
+
+    it "should save error logs to the task run's error log on any level" do
+      levels = { :debug => true, :notice => true, :error => true }
+      levels.each_pair do |level, save|
+        @mt = MyTask.new(level)
+        @mt.log("some debugging text", :error)
+        if save
+          @mt.task_run.error_text.should match "some debugging text"
+        else
+          @mt.task_run.error_text.should_not match "some debugging text"
+        end
+      end
+    end
+  end
+end

data/spec/trackable_tasks_spec.rb

@@ -0,0 +1,7 @@
+require 'spec_helper'
+
+describe TrackableTasks do
+  it "should be valid" do
+    TrackableTasks.should be_a(Module)
+  end
+end