Add support for Exports. Refs #41

afimb · Jun 7, 2012 · 7c0ae62 · 7c0ae62
1 parent 1d72c64
commit 7c0ae62
Show file tree

Hide file tree

Showing 32 changed files with 563 additions and 6 deletions.
diff --git a/app/assets/images/download-small.png b/app/assets/images/download-small.png
diff --git a/app/assets/images/export-completed.png b/app/assets/images/export-completed.png
diff --git a/app/assets/images/export-failed.png b/app/assets/images/export-failed.png
diff --git a/app/assets/images/export-pending.png b/app/assets/images/export-pending.png
diff --git a/app/assets/javascripts/exports.js.coffee b/app/assets/javascripts/exports.js.coffee
@@ -0,0 +1,3 @@
+# Place all the behaviors and hooks related to the matching controller here.
+# All this logic will automatically be available in application.js.
+# You can use CoffeeScript in this file: http://jashkenas.github.com/coffee-script/
diff --git a/app/assets/stylesheets/common.css.scss b/app/assets/stylesheets/common.css.scss
@@ -49,6 +49,9 @@
             a.remove {
                 background: url(image-path('user_interface/ui/remove-small.png')) no-repeat 0% 50%;
             }
+            a.download {
+                background: url(image-path('download-small.png')) no-repeat 0% 50%;
+            }
         }
 
         p {

diff --git a/app/assets/stylesheets/exports.css.scss b/app/assets/stylesheets/exports.css.scss
@@ -0,0 +1,41 @@
+// Place all the styles related to the Exports controller here.
+// They will automatically be included in application.css.
+// You can use Sass (SCSS) here: http://sass-lang.com/
+
+@import "common";
+
+#workspace.exports.index
+{
+    .export:after { 
+        @include after_div_for_object;  
+    }
+
+    .exports {
+        margin-top: 20px;
+    }
+
+    .exports:after {
+        @include content_to_clear;
+    }
+
+    .export {
+        @include div_for_object;
+
+        /* to create multi-column index */
+        width: 300px;
+        float: left;
+        padding-right: 10px;
+    }
+}
+
+#workspace.exports.show {
+    table {
+        th {
+            text-align: center;
+            font-style: italic;
+        }
+        td.message, td.created_at, td.position {
+            padding: 0 20px;
+        }
+    }                       
+}
diff --git a/app/controllers/exports_controller.rb b/app/controllers/exports_controller.rb
@@ -0,0 +1,34 @@
+class ExportsController < ChouetteController
+
+  respond_to :html, :xml, :json
+  respond_to :zip, :only => :show
+
+  belongs_to :referential
+
+  def create
+    create! do |success, failure|
+      success.html { redirect_to referential_exports_path(@referential) }
+    end
+  end
+
+  def show
+    show! do |format|
+      format.zip { send_file @export.file, :type => :zip }
+    end
+  end
+
+
+  protected
+
+  # FIXME why #resource_id is nil ??
+  def build_resource
+    super.tap do |export|
+      export.referential_id = @referential.id
+    end
+  end
+
+  def collection
+    @exports ||= end_of_association_chain.paginate(:page => params[:page])
+  end
+
+end
diff --git a/app/helpers/exports_helper.rb b/app/helpers/exports_helper.rb
@@ -0,0 +1,2 @@
+module ExportsHelper
+end
diff --git a/app/models/export.rb b/app/models/export.rb
@@ -0,0 +1,84 @@
+class Export < ActiveRecord::Base
+
+  belongs_to :referential
+  validates_presence_of :referential_id
+
+  validates_inclusion_of :status, :in => %w{ pending completed failed }
+
+  has_many :log_messages, :class_name => "ExportLogMessage", :order => :position, :dependent => :destroy
+
+  serialize :options
+
+  def self.option(name)
+    name = name.to_s
+
+    define_method(name) do
+      self.options[name]
+    end
+
+    define_method("#{name}=") do |prefix|
+      self.options[name] = prefix
+    end
+  end
+
+  def options
+    read_attribute(:options) || write_attribute(:options, {})
+  end
+
+  @@root = "#{Rails.root}/tmp/exports"
+  cattr_accessor :root
+
+  after_destroy :destroy_file
+  def destroy_file
+    FileUtils.rm file if File.exists? file
+  end
+
+  def file
+    "#{root}/#{id}.zip"
+  end
+
+  def name
+    "#{self.class.model_name.human} #{id}"
+  end
+
+  def export_options
+    { :export_id => self.id, :output_file => file }
+  end
+
+  before_validation :define_default_attributes, :on => :create
+  def define_default_attributes
+    self.status ||= "pending"
+  end
+
+  after_create :delayed_export
+  def delayed_export
+    delay.export
+  end
+
+  def export
+    FileUtils.mkdir_p root
+
+    begin
+      log_messages.create :key => :started
+
+      # TODO
+      # Make real export here
+
+      update_attribute :status, "completed"
+    rescue => e
+      Rails.logger.error "Export #{id} failed : #{e}, #{e.backtrace}"
+      update_attribute :status, "failed"
+    end
+
+    log_messages.create :key => status
+  end
+
+  def self.new(attributes = {}, options = {}, &block)
+    if self == Export
+      Object.const_get(attributes.delete(:type) || "NeptuneExport").new(attributes, options)
+    else
+      super
+    end
+  end
+
+end
diff --git a/app/models/export_log_message.rb b/app/models/export_log_message.rb
@@ -0,0 +1,36 @@
+class ExportLogMessage < ActiveRecord::Base
+  belongs_to :export
+
+  acts_as_list :scope => :export
+
+  validates_presence_of :key
+  validates_inclusion_of :severity, :in => %w{info warning error}
+
+  def arguments=(arguments)
+    write_attribute :arguments, (arguments.to_json if arguments.present?)
+  end
+
+  def arguments
+    @decoded_arguments ||= 
+      begin
+        if (stored_arguments = raw_attributes).present?
+          ActiveSupport::JSON.decode stored_arguments
+        else
+          {}
+        end
+      end
+  end
+
+  def raw_attributes
+    read_attribute(:arguments)
+  end
+
+  before_validation :define_default_attributes, :on => :create
+  def define_default_attributes
+    self.severity ||= "info"
+  end
+
+  def full_message
+    I18n.translate key, arguments.symbolize_keys.merge(:scope => "export_log_messages.messages")
+  end
+end
diff --git a/app/models/neptune_export.rb b/app/models/neptune_export.rb
@@ -0,0 +1,7 @@
+class NeptuneExport < Export
+
+  def export_options
+    super.merge(:format => :neptune)
+  end
+
+end
diff --git a/app/models/referential.rb b/app/models/referential.rb
@@ -9,6 +9,7 @@ class Referential < ActiveRecord::Base
   validates_format_of :prefix, :with => %r{\A[0-9a-zA-Z_]+\Z}
 
   has_many :imports, :dependent => :destroy
+  has_many :exports, :dependent => :destroy
 
   def human_attribute_name(*args)
     self.class.human_attribute_name(*args)

diff --git a/app/views/exports/_export.erb b/app/views/exports/_export.erb
@@ -0,0 +1,14 @@
+<%= div_for(export, :class => :export) do %>
+  <%= link_to(referential_export_path(@referential, export), :class => "preview") do %>
+    <%= image_tag "export-#{export.status}.png" %>
+  <% end %>
+  <%= link_to(export.name, referential_export_path(@referential, export)) %>
+  <div class="info">
+    <%= l export.created_at %>
+
+    <div class="actions">  
+      <%= link_to t("exports.actions.download"), referential_export_path(@referential, export, :format => :zip), :class => "download" %>
+      <%= link_to t("actions.destroy"), referential_export_path(@referential, export), :method => :delete, :confirm =>  t('exports.actions.destroy_confirm'), :class => "remove" %>
+    </div>
+  </div>
+<% end %>
diff --git a/app/views/exports/index.html.erb b/app/views/exports/index.html.erb
@@ -0,0 +1,20 @@
+<%= title_tag t('.title') %> 
+
+<div class="pagination">
+  <div class="page_info">
+    <%= page_entries_info @exports %>
+  </div>
+  <%= will_paginate @exports, :container => false %>
+</div>
+<div class="exports paginated_content">
+  <%= render :partial => "export", :collection => @exports %>
+</div>
+<div class="pagination">
+  <%= will_paginate @exports, :container => false %>
+</div>
+
+<% content_for :sidebar do %>
+<ul class="actions">
+  <li><%= link_to t('exports.actions.new'), new_referential_export_path(@referential), :class => "add" %></li> 
+</ul>
+<% end %>
diff --git a/app/views/exports/new.html.erb b/app/views/exports/new.html.erb
@@ -0,0 +1,9 @@
+<%= title_tag t(".title") %>
+
+<%= semantic_form_for [@referential, @export], :as => :export, :url => referential_exports_path(@referential) do |form| %>
+  <%= form.buttons do %>
+    <%= form.commit_button true %>
+    <li><%= t('or') %></li>
+    <li><%= link_to t('cancel'), :back %></li>
+  <% end %>
+<% end %>
diff --git a/app/views/exports/show.html.erb b/app/views/exports/show.html.erb
@@ -0,0 +1,39 @@
+<%= title_tag @export.name %>
+
+<div class="export_show">
+  <div class="summary">
+    <p>
+      <label><%= Export.human_attribute_name(:created_at) %>: </label>
+      <%= l @export.created_at %>
+    </p>
+    <p>
+      <label><%= Export.human_attribute_name(:status) %>: </label>
+      <%= t @export.status, :scope => "exports.statuses" %>
+    </p>
+  </div>
+
+  <h3><%= t(".report") %></h3>
+  <table>
+    <tr>
+      <th></th>
+      <th><%= ExportLogMessage.human_attribute_name(:created_at) %></th>
+      <th><%= ExportLogMessage.human_attribute_name(:position) %></th>
+      <th><%= ExportLogMessage.human_attribute_name(:full_message) %></th>
+    </tr>
+    <% @export.log_messages.each do |message| %>
+    <tr>
+      <td class="severity"><%= image_tag "severity-#{message.severity}.png", :alt => t(message.severity, :scope => "export_log_messages.severities") %></td>
+      <td class="created_at"><%= l message.created_at, :format => :short %></td>
+      <td class="position"><%= message.position %></td>
+      <td class="message"><%= message.full_message %></td>
+    </tr>
+    <% end %>
+  </table>
+</div>
+
+<% content_for :sidebar do %>
+<ul class="actions">
+  <li><%= link_to  t('exports.actions.download'), referential_export_path(@referential, @export, :format => :zip), :class => "download" %></li>
+  <li><%= link_to  t('exports.actions.destroy'), referential_export_path(@referential, @export), :method => :delete, :confirm =>  t('exports.actions.destroy_confirm'), :class => "remove" %></li>
+</ul>
+<% end %>
diff --git a/app/views/layouts/application.html.erb b/app/views/layouts/application.html.erb
@@ -45,6 +45,7 @@
             <li><%= tab_link_to Chouette::TimeTable, referential_time_tables_path(@referential) %></li>
 
             <li><%= tab_link_to Import, referential_imports_path(@referential) %></li>
+            <li><%= tab_link_to Export, referential_exports_path(@referential) %></li>
           <% end %>    
         </ul>
       </div>

diff --git a/config/initializers/apartment.rb b/config/initializers/apartment.rb
@@ -1,6 +1,6 @@
 Apartment.configure do |config|
   # set your options (described below) here
-  config.excluded_models = ["Referential", "User", "Import", "ImportLogMessage", "Delayed::Backend::ActiveRecord::Job"]        # these models will not be multi-tenanted, but remain in the global (public) namespace
+  config.excluded_models = ["Referential", "User", "Import", "ImportLogMessage", "Export", "ExportLogMessage", "Delayed::Backend::ActiveRecord::Job"]        # these models will not be multi-tenanted, but remain in the global (public) namespace
 
   # Dynamically get database names to migrate
   config.database_names = lambda{ Referential.select(:slug).map(&:slug) }

diff --git a/config/initializers/mime_types.rb b/config/initializers/mime_types.rb
@@ -3,3 +3,5 @@
 # Add new mime types for use in respond_to blocks:
 # Mime::Type.register "text/richtext", :rtf
 # Mime::Type.register_alias "text/html", :iphone
+
+ Mime::Type.register "application/zip", :zip