kete_trackable_items 0.0.1

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

@@ -0,0 +1,11 @@
+<% @title = t('.title', :name => h(@repository.name)) -%>
+
+<h2><%= @title -%></h2>
+
+<%= render :partial => 'tracking_lists', :locals => { :repository => @repository, :tracking_lists => @tracking_lists } -%>
+
+<p><%= button_to t('.new'),
+       repository_tracking_lists_url(:repository_id => @repository, :method => :post) %></p>
+
+<p><%= link_to t('.back_to', :name => h(@repository.name)), repository_url(:id => @repository) %></p>
+

data/app/views/tracking_lists/show.html.erb

@@ -0,0 +1,45 @@
+<% @title = t('.title', :state_name => @tracking_list.current_state_humanized) -%>
+<fieldset class="tracking_list">
+  <h3><%=  @title -%> (<%= link_to(t('.download_for_excel'), repository_tracking_list_url(:id => @tracking_list, :repository_id => @tracking_list.repository, :format => :xls)) -%>)</h3>
+  <table class="order">
+    <tr>
+      <th abbr="Actions for Tracked Item"><%= t '.tracked_item_actions' %></th>
+      <th abbr="Tracked Item Series No"><%= t '.tracked_item_series_no' -%></th>
+      <th abbr="Tracked Item Box No"><%= t '.tracked_item_box_no' -%></th>
+      <th abbr="Tracked Item Item No"><%= t '.tracked_item_item_no' -%></th>
+      <th abbr="Tracked Item Shelf Code"><%= t '.tracked_item_shelf_code' -%></th>
+      <th abbr="Tracked Item"><%= t '.tracked_item_description' -%></th>
+    </tr>
+
+    <% if @tracking_list.tracked_items.count > 0 -%>
+      <%= render :partial => 'tracked_items/tracked_item', :collection => @tracking_list.tracked_items, :locals => { :tracking_list => @tracking_list } -%>
+    <% else -%>
+      <tr><td><%= t '.not_items_in_tracking_list' %></td></tr>
+    <% end -%>
+
+    <tr class="order-buttons">
+      <td><%= t '.tracking_list_controls_preface' -%></td>
+
+      <td colspan="5">
+	<% if @tracking_list.current_state.name == :new -%>
+	  <%= add_trackable_items_links -%>
+        <% end -%>
+
+	<% if @tracking_list.tracked_items.count > 0 -%>
+	  <%= render :partial => 'event_button', :collection => @possible_events, :locals => { :tracking_list => @tracking_list } %>
+	<% end -%>
+
+	<%= button_to(t('.delete_tracking_list'), repository_tracking_list_url(:id => @tracking_list, :repository_id => @repository),
+	:confirm => t('.are_you_sure'),
+	:method => :delete) %>
+      </td>
+
+    </tr>
+  </table>
+
+  <div id="trackable_item_search_form" style="display: none;">
+    <%= render :partial => 'trackable_item_search_form', :locals => { :target => @tracking_list } -%>
+  </div>
+</fieldset>
+
+<%= link_to t('.back_to', :name => h(@repository.name)), repository_url(:id => @repository) %>

data/app/views/tracking_lists/show.xls.builder

@@ -0,0 +1,48 @@
+xml.instruct! :xml, :version=>"1.0", :encoding=>"UTF-8" 
+xml.Workbook({
+  'xmlns'      => "urn:schemas-microsoft-com:office:spreadsheet", 
+  'xmlns:o'    => "urn:schemas-microsoft-com:office:office",
+  'xmlns:x'    => "urn:schemas-microsoft-com:office:excel",    
+  'xmlns:html' => "http://www.w3.org/TR/REC-html40",
+  'xmlns:ss'   => "urn:schemas-microsoft-com:office:spreadsheet" 
+  }) do
+
+  xml.Worksheet 'ss:Name' => t('.tracked_items') do
+    xml.Table do
+      # Tracked List Header
+      xml.Row do
+        xml.Cell { xml.Data 'List ID', 'ss:Type' => 'String' }
+        xml.Cell { xml.Data 'Repository', 'ss:Type' => 'String' }
+        xml.Cell { xml.Data 'Current State', 'ss:Type' => 'String' }
+      end
+
+      # Tracked List Data
+      xml.Row do
+        xml.Cell { xml.Data @tracking_list.id, 'ss:Type' => 'String' }
+        xml.Cell { xml.Data @tracking_list.repository.name, 'ss:Type' => 'String' }
+        xml.Cell { xml.Data @tracking_list.current_state_humanized, 'ss:Type' => 'String' }
+      end
+
+      # Tracked Items Header
+      xml.Row do
+        xml.Cell { xml.Data 'Series No', 'ss:Type' => 'String' }
+        xml.Cell { xml.Data 'Box No', 'ss:Type' => 'String' }
+        xml.Cell { xml.Data 'Item No', 'ss:Type' => 'String' }
+        xml.Cell { xml.Data 'Shelf Code', 'ss:Type' => 'String' }
+        xml.Cell { xml.Data 'Description', 'ss:Type' => 'String' }
+      end
+
+      # Rows
+      for tracked_item in @tracking_list.tracked_items
+      	topic = Topic.find(tracked_item.trackable_item.id)
+        xml.Row do
+          xml.Cell { xml.Data topic.series_no, 'ss:Type' => 'String' }
+          xml.Cell { xml.Data topic.box_no, 'ss:Type' => 'String' }
+          xml.Cell { xml.Data topic.item_no, 'ss:Type' => 'String' }
+          xml.Cell { xml.Data topic.shelf_locations.first.code, 'ss:Type' => 'String' }
+          xml.Cell { xml.Data topic.title, 'ss:Type' => 'String' }
+        end
+      end
+    end
+  end
+end

data/config/locales/en.yml

@@ -0,0 +1,151 @@
+---
+en:
+  application_helper:
+    add_trackable_items_links:
+      add_items_to_tracking_list: "{{t.base.add.capitalize}} {{t.base.trackable_item.pluralize}}"
+      close_add_items_to_tracking_list: "{{t.base.close.capitalize}} {{t.base.add}} {{t.base.trackable_item.pluralize}}"
+  base:
+    action: action
+    allocate: allocate
+    allocated: allocated
+    deallocate: deallocate
+    repository: repository
+    shelf_location: shelf location
+    shelf_locations: "{{t.base.shelf_location.pluralize}}"
+    status: status
+    trackable_item: trackable item
+    tracked_item: tracked item
+    tracking_list: tracking list
+    tracking_lists: "{{t.base.tracking_list.pluralize}}"
+  repositories:
+    edit:
+      back_to_repositories: "{{t.base.back.capitalize}} to {{t.base.repository.pluralize}}"
+      edit_repository: "{{t.base.edit.capitalize}} {{t.base.repository}}"
+    form:
+      create: "{{t.base.create}}"
+      name_field: "{{t.base.name}}"
+      save: "{{t.base.save}}"
+    index:
+      edit: "{{t.base.edit.capitalize}}"
+      name: "{{t.base.name.capitalize}}"
+      new: "{{t.base.new.capitalize}} {{t.base.repository}}"
+      show: "{{t.base.show.capitalize}}"
+      title: "{{t.base.repository.pluralize.capitalize}}"
+    new:
+      back_to_repositories: "{{t.base.back.capitalize}} to {{t.base.repository.pluralize}}"
+      title: "{{t.base.new.capitalize}} {{t.base.repository}}"
+    show:
+      add_shelf_location: "{{t.base.add.capitalize}} {{t.base.shelf_location}}"
+      add_tracking_list: "{{t.base.add.capitalize}} {{t.base.tracking_list}}"
+      are_you_sure: "{{t.base.are_you_sure}}"
+      back_to_repositories: "{{t.base.back.capitalize}} to {{t.base.repository.pluralize}}"
+      edit: "{{t.base.edit.capitalize}}"
+      delete: "{{t.base.delete.capitalize}}"
+      shelf_locations: "{{t.base.shelf_location.pluralize.capitalize}}"
+      title: "{{t.base.repository.capitalize}}: {{name}}"
+      tracking_lists: "{{t.base.tracking_list.pluralize.capitalize}}"
+  shelf_locations:
+    form:
+      allocate_to: "{{t.base.allocated.capitalize}} these items to {{t.base.shelf_location}}:"
+      code: "{{t.base.code}}"
+      create: "{{t.base.create}}"
+      do_not_add: "Do not add this item"
+      no_matches: "No matching {{t.base.trackable_item.pluralize}}."
+      save: "{{t.base.save}}"
+    edit:
+      back_to: "{{t.base.back.capitalize}} to {{name}}"
+      title: "{{t.base.edit.capitalize}} {{t.base.shelf_location}} for {{name}} {{t.base.repository}}"
+    index:
+      title: "{{name}} {{t.base.shelf_locations}}"
+      for_code_pattern: " that match {{code_pattern}}"
+    new:
+      back_to: "{{t.base.back.capitalize}} to {{name}}"
+      title: "{{t.base.new.capitalize}} {{t.base.shelf_location}} for {{name}} {{t.base.repository}}"
+    shelf_location:
+      are_you_sure: "{{t.base.are_you_sure}}"
+      edit: "{{t.base.edit.capitalize}}"
+      delete: "{{t.base.delete.capitalize}}"
+    shelf_locations:
+      action: "Action"
+      code: "{{t.base.code.capitalize}}"
+      status: "{{t.base.status.capitalize}}"
+    show:
+      allocated_for: "{{t.base.allocated.capitalize}} for:"
+      are_you_sure: "{{t.base.are_you_sure}}"
+      back_to: "{{t.base.back.capitalize}} to {{name}}"
+      edit: "{{t.base.edit.capitalize}}"
+      delete: "{{t.base.delete.capitalize}} {{t.base.shelf_location}}"
+      item_actions: "{{t.base.action.pluralize.capitalize}}"
+      item_description: "{{t.base.tracked_item.capitalize}}"
+      not_currently_allocated: "Not currently {{t.base.allocated}}"
+      shelf_location_controls_preface: "{{t.base.shelf_location.capitalize}} {{t.base.action.pluralize}}:"
+      status: "{{t.base.status.capitalize}}"
+      title: "{{code}} {{t.base.shelf_location}} for {{name}} {{t.base.repository}}"
+    trackable_item:
+      deallocate: "{{t.base.deallocate.capitalize}}"
+      are_you_sure: "{{t.base.are_you_sure}}"
+    update:
+      state_change_failed: "We failed to {{event_transition}} the {{t.base.tracking_list}}."
+  trackable_items_helper:
+    add_to_shelf_location: "{{t.base.add.capitalize}} to {{t.base.shelf_location}}"
+    add_to_additional_shelf_location: "{{t.base.add.capitalize}} to additional {{t.base.shelf_location}}"
+  trackable_item_shelf_location:
+    previously_allocated_reactivate_instead: "previously allocated to this {{t.base.trackable_item}}, reactitvate instead?"
+    shelf_location_blank_or_does_not_match: "left blank or does not match existing {{t.base.shelf_location}}"
+    trackable_item_blank_or_does_not_match: "left blank or does not match existing {{t.base.trackable_item}}"
+  trackable_item_shelf_locations:
+    new:
+      back_to: "{{t.base.back.capitalize}} to {{name}}"
+      create: "{{t.base.allocate}}"
+      getting_shelf_locations_codes: "Getting {{t.base.shelf_locations}}. "
+      looking_up_shelf_locations_codes: "Looking up matching {{t.base.shelf_locations}}"
+      repository: "{{t.base.repository}}"
+      repository_label: "{{t.base.repository.capitalize}}:"
+      shelf_location_code: "{{t.base.shelf_location.capitalize}} {{t.base.code}}"
+      title: "{{t.base.allocate.capitalize}} {{t.base.shelf_location}} to {{reference}}"
+      title_with_shelf_location: "{{t.base.choose.capitalize}} {{t.base.item}} to {{t.base.allocate.capitalize}} to {{reference}}"
+  tracked_item:
+    already_in_tracking_list: "This item is already in this tracking list"
+  tracked_items:
+    tracked_item:
+      are_you_sure: "{{t.base.are_you_sure}}"
+      delete: "Drop from list"
+  tracking_lists:
+    edit:
+      back_to: "{{t.base.back.capitalize}} to {{t.base.tracking_list}}"
+      title: "{{t.base.edit.capitalize}} {{t.base.tracking_list}} for {{name}} {{t.base.repository}}"
+    form:
+      add: "{{t.base.add.capitalize}} to {{t.base.tracking_list}}"
+      do_not_add: "Skip this line"
+      no_matches: "No {{t.base.trackable_item.pluralize}} matching your criteria. Are you sure they have been {{t.base.allocated}} a {{t.base.shelf_location}}."
+    index:
+      back_to: "{{t.base.back.capitalize}} to {{name}}"
+      new: "{{t.base.new.capitalize}} {{t.base.tracking_list}}"
+      title: "{{name}} {{t.base.tracking_lists}}"
+    new:
+      back_to: "{{t.base.back.capitalize}} to {{name}}"
+      title: "{{t.base.new.capitalize}} {{t.base.tracking_list}} for {{name}} {{t.base.repository}}"
+    show:
+      are_you_sure: "{{t.base.are_you_sure}}"
+      back_to: "{{t.base.back.capitalize}} to {{name}} {{t.base.repository}}"
+      delete_tracking_list: "{{t.base.delete.capitalize}} {{t.base.tracking_list}}"
+      download_for_excel: "Download for Excel"
+      not_items_in_tracking_list: "No {{t.base.tracked_item.pluralize}} in {{t.base.tracking_list}}"
+      title: "{{state_name}} {{t.base.tracking_list.capitalize}}"
+      tracked_item_actions: "{{t.base.action.pluralize.capitalize}}"
+      tracked_item_description: "{{t.base.tracked_item.capitalize}}"
+      tracked_item_box_no: "Box No"
+      tracked_item_item_no: "Item No"
+      tracked_item_series_no: "Series No"
+      tracked_item_shelf_code: "Shelf Code"
+      tracking_list_controls_preface: "{{t.base.tracking_list.capitalize}} {{t.base.action.pluralize}}:"
+    trackable_item_search_form:
+      search_button: "{{t.base.search}}"
+      search_for_trackable_items_for_target: "{{t.base.search.capitalize}} for {{t.base.trackable_item.pluralize}} to {{t.base.add}}"
+      topic_search: "{{t.base.zoom_types.topic.capitalize.pluralize}}"
+    tracking_lists:
+      id: "{{t.base.tracking_list.capitalize}}"
+      number_of_tracked_items: "Number of {{t.base.trackable_item.pluralize}}"
+      status: "{{t.base.status.capitalize}}"
+    update:
+      state_change_failed: "We failed to {{event_transition}} the {{t.base.tracking_list}}."

data/config/routes.rb

@@ -0,0 +1,6 @@
+# Routes needs more thought since some default routes in ArchivesCentral are taking precedence.
+ActionController::Routing::Routes.draw do |map|
+  map.resources :tracked_items, :path_prefix => ':urlified_name', :only => [:create]
+  map.resources :trackable_item_shelf_locations, :path_prefix => ':urlified_name', :only => [:new, :create, :update]
+  map.resources :repositories, :path_prefix => ':urlified_name', :has_many => [:shelf_locations, :tracking_lists]
+end

data/generators/kete_trackable_items_migrations/USAGE

@@ -0,0 +1,2 @@
+Description:
+	Generates the migrations necessary for using the kete_trackable_items gem in Kete application.

data/generators/kete_trackable_items_migrations/kete_trackable_items_migrations_generator.rb

@@ -0,0 +1,19 @@
+class KeteTrackableItemsMigrationsGenerator < Rails::Generator::Base
+  def manifest
+    record do |m|
+      m.migration_template 'create_repositories.rb', 'db/migrate', { :migration_file_name => "create_repositories" }
+      m.sleep(1)
+      m.migration_template 'create_tracking_lists.rb', 'db/migrate', { :migration_file_name => "create_tracking_lists" }
+      m.sleep(1)
+      m.migration_template 'create_shelf_locations.rb', 'db/migrate', { :migration_file_name => "create_shelf_locations" }
+      m.sleep(1)
+      m.migration_template 'create_tracked_items.rb', 'db/migrate', { :migration_file_name => "create_tracked_items" }
+      m.sleep(1)
+      m.migration_template 'create_trackable_item_shelf_locations.rb', 'db/migrate', { :migration_file_name => "create_trackable_item_shelf_locations" }
+      m.sleep(1)
+      m.migration_template 'create_on_loan_organizations.rb', 'db/migrate', { :migration_file_name => "create_on_loan_organizations" }
+      m.sleep(1)
+      m.migration_template 'add_trackable_item_columns_to_topics.rb', 'db/migrate', { :migration_file_name => "add_trackable_item_columns_to_topics" }
+    end
+  end
+end

data/generators/kete_trackable_items_migrations/templates/add_trackable_item_columns_to_topics.rb

@@ -0,0 +1,15 @@
+class AddTrackableItemColumnsToTopics < ActiveRecord::Migration
+  def self.up
+    change_table :topics do |t|
+      t.integer :on_loan_organization_id
+      t.string :workflow_state, :default => 'unallocated', :null => false
+    end
+  end
+
+  def self.down
+    change_table :topics do |t|
+      t.remove :on_loan_organization_id
+      t.remove :workflow_state
+    end
+  end
+end

data/generators/kete_trackable_items_migrations/templates/create_on_loan_organizations.rb

@@ -0,0 +1,14 @@
+class CreateOnLoanOrganizations < ActiveRecord::Migration
+  def self.up
+    create_table :on_loan_organizations do |t|
+      t.string :name, :null => false
+      t.text :contact_details
+
+      t.timestamps
+    end
+  end
+
+  def self.down
+    drop_table :on_loan_organizations
+  end
+end

data/generators/kete_trackable_items_migrations/templates/create_repositories.rb

@@ -0,0 +1,14 @@
+class CreateRepositories < ActiveRecord::Migration
+  def self.up
+    create_table :repositories do |t|
+      t.integer :basket_id, :null => false
+      t.string :name, :null => false
+
+      t.timestamps
+    end
+  end
+
+  def self.down
+    drop_table :repositories
+  end
+end

data/generators/kete_trackable_items_migrations/templates/create_shelf_locations.rb

@@ -0,0 +1,15 @@
+class CreateShelfLocations < ActiveRecord::Migration
+  def self.up
+    create_table :shelf_locations do |t|
+      t.string :code, :null => false
+      t.integer :repository_id, :null => false
+      t.string :workflow_state, :default => 'available', :null => false
+
+      t.timestamps
+    end
+  end
+
+  def self.down
+    drop_table :shelf_locations
+  end
+end

data/generators/kete_trackable_items_migrations/templates/create_trackable_item_shelf_locations.rb

@@ -0,0 +1,16 @@
+class CreateTrackableItemShelfLocations < ActiveRecord::Migration
+  def self.up
+    create_table :trackable_item_shelf_locations do |t|
+      t.integer :shelf_location_id, :null => false
+      t.integer :trackable_item_id, :null => false, :references => nil
+      t.string :trackable_item_type, :null => false
+      t.string :workflow_state, :default => 'active', :null => false
+
+      t.timestamps
+    end
+  end
+
+  def self.down
+    drop_table :trackable_item_shelf_locations
+  end
+end

data/generators/kete_trackable_items_migrations/templates/create_tracked_items.rb

@@ -0,0 +1,15 @@
+class CreateTrackedItems < ActiveRecord::Migration
+  def self.up
+    create_table :tracked_items do |t|
+      t.integer :tracking_list_id, :null => false
+      t.integer :trackable_item_id, :null => false, :references => nil
+      t.string :trackable_item_type, :null => false
+
+      t.timestamps
+    end
+  end
+
+  def self.down
+    drop_table :tracked_items
+  end
+end

data/generators/kete_trackable_items_migrations/templates/create_tracking_lists.rb

@@ -0,0 +1,15 @@
+class CreateTrackingLists < ActiveRecord::Migration
+  def self.up
+    create_table :tracking_lists do |t|
+      t.integer :repository_id, :null => false
+      t.string :workflow_state, :default => 'new', :null => false
+
+      t.timestamps
+    end
+  end
+
+  def self.down
+    drop_table :tracking_lists
+  end
+
+end

data/kete_trackable_items.gemspec

@@ -0,0 +1,25 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "kete_trackable_items/version"
+
+Gem::Specification.new do |s|
+  s.name        = "kete_trackable_items"
+  s.version     = KeteTrackableItems::VERSION
+  s.authors     = ["Walter McGinnis", "Noel Gomez", "Chris Toynbee"]
+  s.email       = ["ctoynbee@gmail.com","walter@katipo.co.nz"]
+  s.homepage    = "https://github.com/kete/kete_trackable_items"
+  s.summary     = %Q{A Rails engine gem that works in conjunction with kete_gets_trollied to track where an item (with a corresponding physical archive) is physically located.}
+  s.description = %Q{A Kete application add-on that allows for tracking the location of an item in a physical archive that corresponds to the item in the Kete application.} 
+
+  s.rubyforge_project = "kete_trackable_items"
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+
+  # specify any dependencies here; for example:
+  s.add_development_dependency "thoughtbot-shoulda"
+  s.add_development_dependency "jeweler"
+  # s.add_runtime_dependency "rest-client"
+end

data/lib/kete_trackable_items/controller_helpers.rb

@@ -0,0 +1,7 @@
+module KeteTrackableItems
+  module ControllerHelpers
+    def appropriate_repositories_for_basket
+      @current_basket == @site_basket ? Repository.all : @current_basket.repositories
+    end
+  end
+end

data/lib/kete_trackable_items/extensions/helpers/application_helper.rb

@@ -0,0 +1,29 @@
+ApplicationHelper.module_eval do
+  def add_trackable_items_links
+    html = link_to(t('application_helper.add_trackable_items_links.add_items_to_tracking_list'),
+                   '#', :id => 'add-items-button', :tabindex => 2)
+
+    html += link_to(t('application_helper.add_trackable_items_links.close_add_items_to_tracking_list'),
+                    '#', :id => 'close-add-items-button', :tabindex => 2, :style => 'display: none;' )
+
+    html += javascript_tag("jQuery(document).ready(function(){
+			    jQuery('#add-items-button').click(function() {
+		            jQuery('#trackable_item_search_form').slideDown('slow',
+			    function() {
+		            jQuery('#add-items-button').hide();
+			    jQuery('#close-add-items-button').show();
+			    });
+			    });
+			    jQuery('#close-add-items-button').click(function() {
+		            jQuery('#trackable_item_search_form').slideUp('slow',
+			    function() {
+			    jQuery('#close-add-items-button').hide();
+		            jQuery('#add-items-button').show();
+			    });
+			    });
+			    });
+			    ")
+
+    html
+  end
+end