trackable_tasks 0.0.3 → 0.0.4

data/CHANGELOG

@@ -1,3 +1,7 @@
+== 0.0.4
+
+* Added a basic controller to display information about the task runs
+
 == 0.0.3
 
 * Moved sqlite and capybara to the development gems

data/VERSION

@@ -1 +1 @@
-0.0.3
+0.0.4

data/app/controllers/trackable_tasks/task_runs_controller.rb

@@ -0,0 +1,24 @@
+# Index and show controller for TaskRuns 
+# TaskRuns should not be created or edited here because they are generate by rake tasks 
+class TrackableTasks::TaskRunsController < ApplicationController
+  # Lists all tasks in task run 
+  def index    
+    @task_runs = TrackableTasks::TaskRun.all
+    
+    respond_to do |format|
+      format.html # index.html.erb
+    end
+  end
+  
+  # Lists specific task run 
+  def show
+    @task_run = TrackableTasks::TaskRun.find_by_id(params[:id])
+    
+    
+    respond_to do |format|
+      format.html # show.html.erb
+    end
+    
+  end
+end
+  

data/app/models/trackable_tasks/task_run.rb

@@ -35,5 +35,30 @@ module TrackableTasks
       self.error_text = "" if self.error_text.nil?
       self.error_text += text + "\n"
     end
+    
+    # Creates run time based on start and end time
+    # If there is no end_time, display 'Run has not completed.'  
+    # @return [String] The run time formatted in hours, minutes and seconds
+    # @return [String] Message that run has not completed 
+    def run_time
+      if self.end_time         
+         return Time.at(self.end_time - self.start_time).gmtime.strftime('%R:%S')
+      else
+         return "Run has not completed."
+      end
+    end 
+    
+    # Determines error message color based on success and whether or not there is error text  
+    # Return value corresponds to a css color 
+    # @return [String] The color of the status/error message
+    def status_color
+      if self.success && self.error_text.nil?
+        return 'green'
+      elsif self.success
+        return 'yellow'
+      else
+        return 'red'
+      end
+    end       
   end
 end

data/app/views/trackable_tasks/task_runs/index.html.erb

@@ -0,0 +1,27 @@
+<table>
+  <tr>
+    <th>Task Type </th>
+    <th>Start Time </th>
+    <th>Run Time </th>
+    <th>Status </th>
+    <th> </th>
+  </tr>
+ 
+
+  <% if !@task_runs.empty? %>
+    <% @task_runs.each do |task_run| %>
+  	  <tr>
+        <td> <%= task_run.task_type %> </td>
+        <td> <%= task_run.start_time.strftime('%D') %> </td>
+        <td> <%= task_run.run_time %>
+        <td> <span style="color: <%= task_run.status_color %>"><%= task_run.success %>  </span></td>
+        <td> <%= link_to 'Show', task_run %> </td>
+  	  </tr>
+    <% end %>
+  <% else %>
+    <tr>
+	  <td>There are no records. </td>
+	</tr>
+  <% end %>
+</table>
+     

data/app/views/trackable_tasks/task_runs/show.html.erb

@@ -0,0 +1,8 @@
+<h2> <%= @task_run.task_type %> </h2>
+
+<p><strong>Start time: </strong> <%= @task_run.start_time.strftime('%D') %> </p>
+<p><strong>End time: </strong> <%= @task_run.end_time.strftime('%D') %> </p>
+<p><strong>Run time: </strong> <%= @task_run.run_time %> </p>
+<p><strong>Success: </strong> <span style="color: <%= @task_run.status_color %>"> <%= @task_run.success %> </span></p>
+<p><strong>Error text: </strong> <%= @task_run.error_text %> </p>
+<p><strong>Log text: </strong> <%= @task_run.log_text %> </p>

data/config/routes.rb

@@ -0,0 +1,5 @@
+Rails.application.routes.draw do
+  namespace :trackable_tasks do
+    resources :task_runs
+  end
+end

data/spec/dummy/features/step_definitions/trackable_tasks_steps.rb

@@ -0,0 +1,64 @@
+Given /^a task_run does not exist$/ do
+  TrackableTasks::TaskRun.nil?
+end
+
+Then (/^I should see "([^"]*)" $/) do |no_reconds|
+  task_run = TrackableTasks::TaskRun.last
+  page.should have_content(no_records)
+end
+
+Given /^a task_run exists$/ do
+  TrackableTasks::TaskRun.create(:start_time => Time.now, :task_type => 'Test Task', :success => true)
+end
+
+Given /^a task_run exists with the following values$/ do |table|
+  attributes = {}  
+  table.hashes.each do |key_pair|   
+    if key_pair["key"] != 'key'      
+      attributes[key_pair["key"]] = key_pair["value"]
+    end     
+  end  
+  TrackableTasks::TaskRun.create(attributes) 
+  TrackableTasks::TaskRun.all.count.should > 0 
+end
+
+Given /^end_time does not exist$/ do
+  task_run = TrackableTasks::TaskRun.last
+  task_run.end_time.nil?
+end
+
+Then /^I should see the data for that task_run$/ do
+  task_run = TrackableTasks::TaskRun.last 
+  page.should have_content(task_run.start_time.strftime('%D'))
+  page.should have_content(task_run.task_type)
+  page.should have_content(task_run.success)
+end
+
+Then (/^I should see "([^"]*)" in the run_time column$/) do |run_time_message|
+  task_run = TrackableTasks::TaskRun.last
+  task_run.run_time == run_time_message
+end
+
+Given /^success is true$/ do
+  task_run = TrackableTasks::TaskRun.last
+  task_run.success == true
+end
+
+Given /^there is no error_text$/ do
+  task_run = TrackableTasks::TaskRun.last
+  task_run.error_text.nil?
+end
+
+Then /^status_color should be green$/ do 
+  task_run = TrackableTasks::TaskRun.last  
+  page.body.should match("color: green") #had to use match here, have_content was not getting the html with css
+end
+
+Then /^I should see the show data for that task_run$/ do  
+  task_run = TrackableTasks::TaskRun.last   
+  page.should have_content(task_run.start_time.strftime('%D'))
+  page.should have_content(task_run.task_type)
+  page.should have_content(task_run.success)  
+  page.should have_content(task_run.log_text)
+  page.should have_content(task_run.error_text)
+end

data/spec/dummy/features/step_definitions/web_steps.rb

@@ -0,0 +1,214 @@
+# TL;DR: YOU SHOULD DELETE THIS FILE
+#
+# This file was generated by Cucumber-Rails and is only here to get you a head start
+# These step definitions are thin wrappers around the Capybara/Webrat API that lets you
+# visit pages, interact with widgets and make assertions about page content.
+#
+# If you use these step definitions as basis for your features you will quickly end up
+# with features that are:
+#
+# * Hard to maintain
+# * Verbose to read
+#
+# A much better approach is to write your own higher level step definitions, following
+# the advice in the following blog posts:
+#
+# * http://benmabey.com/2008/05/19/imperative-vs-declarative-scenarios-in-user-stories.html
+# * http://dannorth.net/2011/01/31/whose-domain-is-it-anyway/
+# * http://elabs.se/blog/15-you-re-cuking-it-wrong
+#
+
+
+require 'uri'
+require 'cgi'
+require File.expand_path(File.join(File.dirname(__FILE__), "..", "support", "paths"))
+require File.expand_path(File.join(File.dirname(__FILE__), "..", "support", "selectors"))
+
+module WithinHelpers
+  def with_scope(locator)
+    locator ? within(*selector_for(locator)) { yield } : yield
+  end
+end
+World(WithinHelpers)
+
+# Single-line step scoper
+When /^(.*) within (.*[^:])$/ do |step, parent|
+  with_scope(parent) { When step }
+end
+
+# Multi-line step scoper
+When /^(.*) within (.*[^:]):$/ do |step, parent, table_or_string|
+  with_scope(parent) { When "#{step}:", table_or_string }
+end
+
+Given /^(?:|I )am on (.+)$/ do |page_name|
+  visit path_to(page_name)
+end
+
+When /^(?:|I )go to (.+)$/ do |page_name|
+  visit path_to(page_name)
+end
+
+When /^(?:|I )press "([^"]*)"$/ do |button|
+  click_button(button)
+end
+
+When /^(?:|I )follow "([^"]*)"$/ do |link|
+  click_link(link)
+end
+
+When /^(?:|I )fill in "([^"]*)" with "([^"]*)"$/ do |field, value|
+  fill_in(field, :with => value)
+end
+
+When /^(?:|I )fill in "([^"]*)" for "([^"]*)"$/ do |value, field|
+  fill_in(field, :with => value)
+end
+
+# Use this to fill in an entire form with data from a table. Example:
+#
+#   When I fill in the following:
+#     | Account Number | 5002       |
+#     | Expiry date    | 2009-11-01 |
+#     | Note           | Nice guy   |
+#     | Wants Email?   |            |
+#
+# TODO: Add support for checkbox, select og option
+# based on naming conventions.
+#
+When /^(?:|I )fill in the following:$/ do |fields|
+  fields.rows_hash.each do |name, value|
+    When %{I fill in "#{name}" with "#{value}"}
+  end
+end
+
+When /^(?:|I )select "([^"]*)" from "([^"]*)"$/ do |value, field|
+  select(value, :from => field)
+end
+
+# moved to maniuplation steps
+When /^(?:|I )check "([^"]*)"$/ do |field|
+  check(field)
+end
+
+When /^(?:|I )uncheck "([^"]*)"$/ do |field|
+  uncheck(field)
+end
+
+When /^(?:|I )choose "([^"]*)"$/ do |field|
+  choose(field)
+end
+
+When /^(?:|I )attach the file "([^"]*)" to "([^"]*)"$/ do |path, field|
+  attach_file(field, File.expand_path(path))
+end
+
+Then /^(?:|I )should see "([^"]*)"$/ do |text|
+  if page.respond_to? :should
+    page.should have_content(text)
+  else
+    assert page.has_content?(text)
+  end
+end
+
+Then /^(?:|I )should see \/([^\/]*)\/$/ do |regexp|
+  regexp = Regexp.new(regexp)
+
+  if page.respond_to? :should
+    page.should have_xpath('//*', :text => regexp)
+  else
+    assert page.has_xpath?('//*', :text => regexp)
+  end
+end
+
+Then /^(?:|I )should not see "([^"]*)"$/ do |text|
+  if page.respond_to? :should
+    page.should have_no_content(text)
+  else
+    assert page.has_no_content?(text)
+  end
+end
+
+Then /^(?:|I )should not see \/([^\/]*)\/$/ do |regexp|
+  regexp = Regexp.new(regexp)
+
+  if page.respond_to? :should
+    page.should have_no_xpath('//*', :text => regexp)
+  else
+    assert page.has_no_xpath?('//*', :text => regexp)
+  end
+end
+
+Then /^the "([^"]*)" field(?: within (.*))? should contain "([^"]*)"$/ do |field, parent, value|
+  with_scope(parent) do
+    field = find_field(field)
+    field_value = (field.tag_name == 'textarea') ? field.text : field.value
+    if field_value.respond_to? :should
+      field_value.should =~ /#{value}/
+    else
+      assert_match(/#{value}/, field_value)
+    end
+  end
+end
+
+Then /^the "([^"]*)" field(?: within (.*))? should not contain "([^"]*)"$/ do |field, parent, value|
+  with_scope(parent) do
+    field = find_field(field)
+    field_value = (field.tag_name == 'textarea') ? field.text : field.value
+    if field_value.respond_to? :should_not
+      field_value.should_not =~ /#{value}/
+    else
+      assert_no_match(/#{value}/, field_value)
+    end
+  end
+end
+
+# moved to generic steps
+#Then /^the "([^"]*)" checkbox(?: within (.*))? should be checked$/ do |label, parent|
+#  with_scope(parent) do
+#    field_checked = find_field(label)['checked']
+#    if field_checked.respond_to? :should
+#      field_checked.should be_true
+#    else
+#      assert field_checked
+#    end
+#  end
+#end
+
+# moved to generic steps
+#Then /^the "([^"]*)" checkbox(?: within (.*))? should not be checked$/ do |label, parent|
+#  with_scope(parent) do
+#    field_checked = find_field(label)['checked']
+#    if field_checked.respond_to? :should
+#      field_checked.should be_false
+#    else
+#      assert !field_checked
+#    end
+#  end
+#end
+ 
+Then /^(?:|I )should be on (.+)$/ do |page_name|
+  current_path = URI.parse(current_url).path
+  if current_path.respond_to? :should
+    current_path.should == path_to(page_name)
+  else
+    assert_equal path_to(page_name), current_path
+  end
+end
+
+Then /^(?:|I )should have the following query string:$/ do |expected_pairs|
+  query = URI.parse(current_url).query
+  actual_params = query ? CGI.parse(query) : {}
+  expected_params = {}
+  expected_pairs.rows_hash.each_pair{|k,v| expected_params[k] = v.split(',')} 
+  
+  if actual_params.respond_to? :should
+    actual_params.should == expected_params
+  else
+    assert_equal expected_params, actual_params
+  end
+end
+
+Then /^show me the page$/ do
+  save_and_open_page
+end

data/spec/dummy/features/support/paths.rb

@@ -0,0 +1,31 @@
+module NavigationHelpers
+  # Maps a name to a path. Used by the
+  #
+  #   When /^I go to (.+)$/ do |page_name|
+  #
+  # step definition in web_steps.rb
+  #
+  def path_to(page_name)
+    case page_name
+
+    when /the [h|H]ome\s?page/
+           '/'
+    when /the task_run index page/
+           trackable_tasks_task_runs_path
+    when /the task_run show page/ 
+           trackable_tasks_task_run_path(TrackableTasks::TaskRun.last)
+                   
+    else
+      begin
+        page_name =~ /the (.*) page/
+        path_components = $1.split(/\s+/)
+        self.send(path_components.push('path').join('_').to_sym)
+      rescue Object => e
+        raise "Can't find mapping from \"#{page_name}\" to a path.\n" +
+          "Now, go and add a mapping in #{__FILE__}"
+      end
+    end
+  end
+end
+
+World(NavigationHelpers)

data/spec/dummy/features/support/selectors.rb

@@ -0,0 +1,39 @@
+module HtmlSelectorsHelpers
+  # Maps a name to a selector. Used primarily by the
+  #
+  #   When /^(.+) within (.+)$/ do |step, scope|
+  #
+  # step definitions in web_steps.rb
+  #
+  def selector_for(locator)
+    case locator
+
+    when "the page"
+      "html > body"
+
+    # Add more mappings here.
+    # Here is an example that pulls values out of the Regexp:
+    #
+    #  when /^the (notice|error|info) flash$/
+    #    ".flash.#{$1}"
+
+    # You can also return an array to use a different selector
+    # type, like:
+    #
+    #  when /the header/
+    #    [:xpath, "//header"]
+
+    # This allows you to provide a quoted selector as the scope
+    # for "within" steps as was previously the default for the
+    # web steps:
+    when /^"(.+)"$/
+      $1
+
+    else
+      raise "Can't find mapping from \"#{locator}\" to a selector.\n" +
+        "Now, go and add a mapping in #{__FILE__}"
+    end
+  end
+end
+
+World(HtmlSelectorsHelpers)

data/spec/dummy/features/task_run.feature

@@ -0,0 +1,38 @@
+Feature: task_run controller index and show pages 
+
+	Scenario: should show task runs on the index page
+	  Given a task_run exists
+	  When I go to the task_run index page
+	  Then I should see the data for that task_run
+	
+	Scenario: no task runs
+	  Given a task_run does not exist
+	  When I go to the task_run index page
+	  Then I should see "There are no records"
+	
+	Scenario: no end time
+	  Given a task_run exists
+	  And end_time does not exist
+	  When I go to the task_run index page
+	  Then I should see "Run time not completed" in the run_time column
+	
+	Scenario: success is true
+	  Given a task_run exists with the following values
+	    | key | value |
+	    | start_time | 2011-11-03 16:31:19 -0400 |
+	    | task_type | Task type 3 |
+	    | success | true |	  
+	  When I go to the task_run index page
+	  Then status_color should be green
+	
+	Scenario: should show task run on the show page
+	  Given a task_run exists with the following values
+	    | key | value |
+	    | start_time | 2011-11-03 16:31:19 -0400 |
+	    | end_time | 2011-11-03 17:53:40 -0400  |
+	    | task_type | Task type 4 |
+	    | success | true |
+	    | error_text | This is some error text |
+	    | log_text | This is some log text |
+	  When I go to the task_run show page
+	  Then I should see the show data for that task_run

data/spec/models/task_run_spec.rb

@@ -14,7 +14,7 @@ describe TaskRun do
 
     it "should be valid" do
       @run.attributes = @valid_attributes
-      @run.should be_valid
+      @run.should be_valid      
     end
 
     it "should require task type" do
@@ -97,4 +97,45 @@ describe TaskRun do
       @run.error_text.should match @text
     end
   end
+  
+  describe "status_color method" do
+    before(:each) do
+      @run = TaskRun.new()      
+    end
+    
+    it "should return green if success is true and error_text is empty (nil)" do
+      @run.success = true
+      @run.error_text = nil
+      @run.status_color.should == "green"  
+    end
+    
+    it "should return yellow if success is true but there is error_text" do
+      @run.success = true
+      @run.error_text = "Error text"
+      @run.status_color.should == "yellow"
+    end
+    
+    it "should return red if success is false" do
+      @run.success = false
+      @run.status_color.should == "red"      
+    end        
+  end
+  
+  describe "run_time method" do
+    before(:each) do
+      @run = TaskRun.new()      
+    end    
+    
+    it "should return the time formatted in hours, minutes and seconds if end_time is true" do
+      @run.start_time = Time.at(3)
+      @run.end_time = Time.at(946702800)
+      @run.run_time.should == Time.at(@run.end_time - @run.start_time).gmtime.strftime('%R:%S')       
+    end
+    
+    it "should return a string 'Run has not completed' if end_time is false" do
+      @run.end_time = false
+      @run.run_time.should == "Run has not completed."
+    end    
+  end
+
 end

data/trackable_tasks.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{trackable_tasks}
-  s.version = "0.0.3"
+  s.version = "0.0.4"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = [%q{Jeremiah Hemphill}]
-  s.date = %q{2011-09-01}
+  s.date = %q{2011-11-08}
   s.description = %q{Adds tracking to rake tasks including error capturing and logging.}
   s.email = %q{jeremiah@cloudspace.com}
   s.extra_rdoc_files = [
@@ -26,7 +26,10 @@ Gem::Specification.new do |s|
     "README.rdoc",
     "Rakefile",
     "VERSION",
+    "app/controllers/trackable_tasks/task_runs_controller.rb",
     "app/models/trackable_tasks/task_run.rb",
+    "app/views/trackable_tasks/task_runs/index.html.erb",
+    "app/views/trackable_tasks/task_runs/show.html.erb",
     "config/routes.rb",
     "lib/generators/trackable_tasks/install_generator.rb",
     "lib/generators/trackable_tasks/templates/migrations/install_migration.rb.erb",
@@ -58,7 +61,11 @@ Gem::Specification.new do |s|
     "spec/dummy/db/migrate/20110826183240_create_trackable_task_tables.rb",
     "spec/dummy/db/schema.rb",
     "spec/dummy/features/step_definitions/trackable_tasks_steps.rb",
+    "spec/dummy/features/step_definitions/web_steps.rb",
     "spec/dummy/features/support/env.rb",
+    "spec/dummy/features/support/paths.rb",
+    "spec/dummy/features/support/selectors.rb",
+    "spec/dummy/features/task_run.feature",
     "spec/dummy/lib/tasks/trackable_tasks.rake",
     "spec/dummy/lib/trackable_tasks/my_task.rb",
     "spec/dummy/public/404.html",

metadata

@@ -2,7 +2,7 @@
 name: trackable_tasks
 version: !ruby/object:Gem::Version 
   prerelease: 
-  version: 0.0.3
+  version: 0.0.4
 platform: ruby
 authors: 
 - Jeremiah Hemphill
@@ -10,7 +10,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-09-01 00:00:00 Z
+date: 2011-11-08 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: rails
@@ -196,7 +196,10 @@ files:
 - README.rdoc
 - Rakefile
 - VERSION
+- app/controllers/trackable_tasks/task_runs_controller.rb
 - app/models/trackable_tasks/task_run.rb
+- app/views/trackable_tasks/task_runs/index.html.erb
+- app/views/trackable_tasks/task_runs/show.html.erb
 - config/routes.rb
 - lib/generators/trackable_tasks/install_generator.rb
 - lib/generators/trackable_tasks/templates/migrations/install_migration.rb.erb
@@ -228,7 +231,11 @@ files:
 - spec/dummy/db/migrate/20110826183240_create_trackable_task_tables.rb
 - spec/dummy/db/schema.rb
 - spec/dummy/features/step_definitions/trackable_tasks_steps.rb
+- spec/dummy/features/step_definitions/web_steps.rb
 - spec/dummy/features/support/env.rb
+- spec/dummy/features/support/paths.rb
+- spec/dummy/features/support/selectors.rb
+- spec/dummy/features/task_run.feature
 - spec/dummy/lib/tasks/trackable_tasks.rake
 - spec/dummy/lib/trackable_tasks/my_task.rb
 - spec/dummy/public/404.html
@@ -264,7 +271,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      hash: -445895761062619372
+      hash: 2905551140248170763
       segments: 
       - 0
       version: "0"