importable_attachments 0.0.13

data/app/models/importable_attachments/attachment.rb

@@ -0,0 +1,143 @@
+require 'filemagic'
+require 'mime/types'
+require 'paper_trail'
+require 'paperclip'
+require 'smarter_dates'
+#require File.join(File.dirname(__FILE__), '../..', 'config/initializers/0_configuration')
+
+# An attachment represents a file within the system.
+module ImportableAttachments
+  class Attachment < ActiveRecord::Base
+    self.abstract_class = true
+    self.table_name = :importable_attachments_attachments
+
+    include SmarterDates if ::Configuration.for('smarter_dates').enabled
+    include Rails::MarkRequirements if ::Configuration.for('mark_requirements').enabled
+
+    if ::Configuration.for('versioning').enabled
+      has_paper_trail ignore: [:updated_at], class_name: 'ImportableAttachments::Version'
+    end
+
+    # url for client downloadable content
+    if ::Configuration.for('attachments').enabled
+      include Paperclip::Glue
+      if ::Configuration.for('attachments').include_revision_in_filename
+        CONTENT_URL = ::Configuration.for('versioned').url
+        CONTENT_PATH = ::Configuration.for('versioned').path
+      else
+        CONTENT_URL = ::Configuration.for('attachments').url
+        CONTENT_PATH = ::Configuration.for('attachments').path
+      end
+
+      has_attached_file :io_stream, :url => CONTENT_URL, :path => CONTENT_PATH,
+        :styles => {original: {io_stream_attr: :attach}},
+        :processors => [:save_upload]
+    end
+
+    # --------------------------------------------------------------------------
+    # define: attributes and relationships
+    belongs_to :attachable, :polymorphic => true
+
+    # --------------------------------------------------------------------------
+    # define: aliases and delegations
+    delegate :url, :to => :io_stream, :prefix => true
+
+    # --------------------------------------------------------------------------
+    # define: DTD i.e. validations
+
+    # NOTE: to save nested-model forms, new instances must be valid. Therefore,
+    #       attachable_id = nil must be valid when attachable is != nil
+    validates :attachable_id, :if => :attachable_id?,
+      :numericality => {only_integer: true, greater_than: 0}
+
+    validates :attachable_type, alpha_numeric: {punctuation: true}, existing_class: true, :if => :attachable_type?
+
+    validates_attachment :io_stream, :presence => true,
+      :size => {greater_than: 0}
+
+    validates :io_stream_file_name, :presence => true,
+      :alpha_numeric => {punctuation: true}
+
+    validates :io_stream_file_size, :presence => true,
+      :numericality => {only_integer: true, greater_than_or_equal_to: 0}
+
+    validates :io_stream_content_type, :presence => true,
+      :alpha_numeric => {punctuation: true}
+
+    validates :io_stream_updated_at, :chronic_parsable => true,
+      :if => :io_stream_updated_at?
+
+    # --------------------------------------------------------------------------
+    # define: scopes
+
+    attr_accessible :attachable_id, :attachable_type
+    attr_accessible :io_stream
+    attr_accessible :io_stream_file_name, :io_stream_content_type, :io_stream_file_size,
+      :io_stream_updated_at
+
+    # --------------------------------------------------------------------------
+    # define: behaviors
+
+    # :call-seq:
+    # revision_number
+    #
+    # yields an integer representing the version-index
+    #
+    # NOTE: paper_trail manages version-tracking automatically
+
+    def revision_number
+      ver = version
+      case
+      when live? then
+        versions.count
+      when ver then
+        ver.index
+      else
+        0
+      end
+    end
+
+    # :call-seq:
+    # io_stream_mime_type
+    #
+    # yields the files MIME::Type
+
+    def io_stream_mime_type
+      mime = new_record? ? io_stream.content_type : magic_mime_type
+      MIME::Types[mime].first
+    end
+
+    # :call-seq:
+    # magic_mime_type
+    #
+    # yields a saved attachments mime_type according to libmagic
+
+    def magic_mime_type
+      return if new_record?
+      return unless File.exists? io_stream.path
+      FileMagic.mime.file(io_stream.path).split(/;\s*/).first
+    end
+
+  end
+end
+
+# == Schema Information
+#
+# Table name: attachments
+#
+#  id                     :integer          not null, primary key
+#  attachable_type        :string(255)
+#  attachable_id          :string(255)
+#  io_stream_file_name    :string(255)
+#  io_stream_content_type :string(255)
+#  io_stream_file_size    :integer
+#  io_stream_updated_at   :datetime
+#  created_at             :datetime         not null
+#  updated_at             :datetime         not null
+#
+# Indexes
+#
+#  idx_importable_attachments_on_attachable_type_and_id  (attachable_type,attachable_id)
+#  index_attachments_on_io_stream_file_name              (io_stream_file_name)
+#
+

data/app/models/importable_attachments/version.rb

@@ -0,0 +1,50 @@
+# versions are managed by the paper_trail gem... providing a history of
+# instance-deltas
+module ImportableAttachments
+  class Version < ActiveRecord::Base
+    self.abstract_class = true
+    self.table_name = :importable_attachments_versions
+    attr_accessible :event, :item_id, :item_type, :object, :object_changes, :whodunnit
+
+    include SmarterDates if ::Configuration.for('smarter_dates').enabled
+    include Rails::MarkRequirements if ::Configuration.for('mark_requirements').enabled
+
+    belongs_to :item, polymorphic: true
+
+    # NOTE: to save nested-model forms, new instances must be valid. Therefore,
+    #       attachable_id = nil must be valid when attachable is != nil
+    #validates :item_id, if: :item_id?, numericality: {only_integer: true, greater_than: 0}
+    validates :item_id, alpha_numeric: {punctuation: true}, if: :item_id?
+
+    validates :item_type, alpha_numeric: {punctuation: true}, if: :item_type?
+
+    if ::Configuration.for('versioning').validate_item_type_constants
+      validates :item_type, existing_class: true, if: :item_type?
+    end
+
+    # :call-seq:
+    # object_has? :pattern
+    #
+    # yields versions in which the object contains a pattern
+
+    scope :object_has?, lambda { |pattern| where('object LIKE ?', "%#{pattern}%") }
+
+    # :call-seq:
+    # Klass.in_the_last N
+    #
+    # yields objects created in the last N (where N is a timestamp)
+
+    scope :in_the_last, lambda { |dt| where('created_at > ?', dt.ago) }
+
+    # :call-seq:
+    # yml_to_ruby
+    #
+    # loads the yaml object into a ruby-hash
+    # if this is the 'destroyed' version, then RTFM reify
+
+    def yml_to_ruby
+      Psych.load object
+    end
+
+  end
+end

data/app/validators/existing_class_validator.rb

@@ -0,0 +1,17 @@
+# validate field contains the name of an existing class
+class ExistingClassValidator < ActiveModel::EachValidator
+
+  # :call-seq:
+  # validate_each :record, :attr, :value
+  #
+  # validates that value is the name of an existing class
+
+  def validate_each(record, attr, value)
+    types = value.split(/::/).map(&:to_sym)
+    item_type_result = types.inject(Module) do |constant, name|
+      constant.const_get(name) if constant && constant.constants.include?(name)
+    end
+    record.errors[attr] << 'unknown module or class' unless item_type_result.present?
+  end
+
+end

data/app/validators/importable_attachments/csv_validator.rb

@@ -0,0 +1,36 @@
+require 'csv'
+
+# validate attachment is a CSV file
+module ImportableAttachments  # :nodoc:
+  class CsvValidator < ActiveModel::Validator
+
+    # :call-seq:
+    # validate :record
+    #
+    # ensures that the record's attachment file name has a .xls extension
+
+    def validate(record)
+      extension = record.attachment.io_stream_file_name.split('.').last
+      if extension.downcase != 'csv'
+        record.errors.add :attachment, 'invalid attachment'
+        record.attachment.errors.add :base, 'File must be a CSV (.csv) file'
+      end
+
+      if defined? FasterCSV
+        begin
+          FasterCSV.read record.attachment.io_stream
+        rescue FasterCSV::MalformedCSVError => err
+          record.errors.add :attachment, 'invalid attachment'
+          record.attachment.errors.add :base, err.messages.join(', ')
+        end
+      else
+        begin
+          CSV.read record.attachment.io_stream.path
+        rescue CSV::MalformedCSVError => err
+          record.errors.add :attachment, 'invalid attachment'
+          record.attachment.errors.add :base, err.messages.join(', ')
+        end
+      end
+    end
+  end
+end

data/app/validators/importable_attachments/excel.rb

@@ -0,0 +1,18 @@
+module ImportableAttachments  # :nodoc:
+  # validate attachment is an excel file
+  class ExcelValidator < ActiveModel::Validator
+
+    # :call-seq:
+    # validate :record
+    #
+    # ensures that the record's attachment file name has a .xls extension
+
+    def validate(record)
+      extension = record.attachment.io_stream_file_name.split('.').last
+      if extension != 'xls'
+        record.errors[:attachment] << 'File must be an Excel (.xls) file'
+      end
+    end
+
+  end
+end

data/app/validators/importable_attachments/excel_validator.rb

@@ -0,0 +1,18 @@
+module ImportableAttachments  # :nodoc:
+  # validate attachment is an excel file
+  class ExcelValidator < ActiveModel::Validator
+
+    # :call-seq:
+    # validate :record
+    #
+    # ensures that the record's attachment file name has a .xls extension
+
+    def validate(record)
+      extension = record.attachment.io_stream_file_name.split('.').last
+      if extension != 'xls'
+        record.errors[:attachment] << 'File must be an Excel (.xls) file'
+      end
+    end
+
+  end
+end

data/app/views/importable_attachments/attachments/_attachment.html.haml

@@ -0,0 +1,9 @@
+%tr.group_data
+  - img_tag = image_tag '/assets/importable_attachments/buttons/download_32.png', alt: "Download #{attachment.io_stream_file_name}", title: "Download #{attachment.io_stream_file_name.inspect}", id: "icon_file_download_#{attachment.id}", :class => 'faux_link'
+  %td.text_col{style: 'text-align: center;'}= link_to img_tag, attachment.io_stream.url
+  %td.text_col= link_to attachment.io_stream_file_name, attachment, title: "View metadata for #{attachment.io_stream_file_name.inspect}", alt: "View metadata for #{attachment.io_stream_file_name.inspect}"
+  %td.text_col{style: 'text-align: center;'}= attachment.revision_number
+  %td.text_col= attachment.updated_at.strftime('%Y-%m-%d %I:%M %p')
+  %td.action_col= link_to 'Edit', edit_attachment_path(attachment)
+  %td.action_col= link_to 'Destroy', attachment, confirm: 'Are you sure?', method: :delete
+

data/app/views/importable_attachments/attachments/_form.html.haml

@@ -0,0 +1,22 @@
+= javascript_include_tag 'importable_attachments/attachments'
+
+#spreadsheet_action_panel.actions_menu
+  = image_tag '/assets/importable_attachments/buttons/upload_32.png', alt: 'Upload File', title: 'Upload File', id: 'icon_file_upload', :class => 'faux_link'
+
+  - if attachment.new_record?
+    = image_tag '/assets/importable_attachments/buttons/download_32.png', alt: 'No File to Download', title: 'No File to Download', id: 'icon_file_download', :class => 'faux_link'
+  - else
+    - img_tag = image_tag '/assets/importable_attachments/buttons/download_32.png', alt: 'Download Original File', title: 'Download Original File', id: 'icon_file_download', :class => 'faux_link'
+    =link_to img_tag, attachment.io_stream_url
+
+%li
+  %label.label File name:
+  #file_name{disabled: 'disabled', value: attachment.io_stream_file_name || ""}
+  = f.inputs id: 'attachment_attributes_io_stream_fields' do
+    - opts = { as: :file, id: 'attachment_io_stream_input' }
+    - opts.merge! required: f.object.mark_required?(:io_stream) if ::Configuration.for('mark_requirements').enabled
+    = f.input :io_stream, opts
+
+    - if attachment.attachable_type || attachment.attachable_id
+      = f.input :attachable_type, as: :hidden, input_html: { value: attachment.attachable_type }
+      = f.input :attachable_id, as: :hidden, input_html: { value: attachment.attachable_id }

data/app/views/importable_attachments/attachments/_nested_form.html.haml

@@ -0,0 +1,20 @@
+= javascript_include_tag 'importable_attachments/attachments'
+
+#spreadsheet_action_panel.actions_menu
+  = image_tag '/assets/importable_attachments/buttons/upload_32.png', alt: 'Upload File', title: 'Upload File', id: 'icon_file_upload', :class => 'faux_link'
+
+  - if attachment.new_record?
+    = image_tag '/assets/importable_attachments/buttons/download_32.png', alt: 'No File to Download', title: 'No File to Download', id: 'icon_file_download', :class => 'faux_link'
+  - else
+    - img_tag = image_tag '/assets/importable_attachments/buttons/download_32.png', alt: 'Download Original File', title: 'Download Original File', id: 'icon_file_download', :class => 'faux_link'
+    =link_to img_tag, attachment.io_stream_url
+
+%li
+  %label.label File name
+  %input#file_name{disabled: 'disabled', value: attachment.io_stream_file_name}
+  = f.inputs id: 'attachment_attributes_io_stream_fields' do
+    - opts = { as: :file, id: 'attachment_io_stream_input' }
+    = f.semantic_fields_for :attachment do |attachment_form|
+      - opts.merge! required: attachment_form.object.mark_required?(:io_stream) if ::Configuration.for('mark_requirements').enabled
+      = attachment_form.inputs do
+        = attachment_form.input :io_stream, opts

data/app/views/importable_attachments/attachments/edit.html.haml

@@ -0,0 +1,39 @@
+%h2 Editing Attachment #{@attachment.io_stream_file_name}
+
+= semantic_form_for @attachment, url: attachment_path(@attachment), html: {multipart: true} do |f|
+  = f.inputs do
+    = render 'form', f: f, attachment: @attachment
+
+    = f.action :submit, input_html: { value: 'Upload File', onclick: "this.disabled=true;this.value='Please wait...';this.form.submit();" }
+
+- if @attachment.attachable_type
+  %p
+    %b Represents:
+    = "#{@attachment.attachable_type} id: #{@attachment.attachable_id}"
+
+%p
+  %b File Name:
+  =link_to @attachment.io_stream_file_name, @attachment.io_stream.url, title: @attachment.io_stream_file_name, alt: @attachment.io_stream_file_name
+
+- if %w(development test).include?(Rails.env)
+  %p
+    %b File Path:
+    =link_to @attachment.io_stream.path.sub(Rails.root.to_s + '/', ""), File.dirname(@attachment.io_stream.path)
+
+%p
+  %b File Size:
+  = "#{@attachment.io_stream_file_size} bytes"
+
+%p
+  %b Content Type:
+  = @attachment.io_stream.content_type
+
+%p
+  %b Version:
+  = @attachment.revision_number
+
+%br/
+= link_to 'Show', @attachment
+|
+= link_to 'View All Attachments', attachments_path
+

data/app/views/importable_attachments/attachments/index.html.haml

@@ -0,0 +1,23 @@
+%h2 Attachments
+
+= semantic_form_for Attachment.new, url: attachments_path, html: {multipart: true} do |f|
+  = f.inputs do
+    = render 'form', f: f, attachment: f.object
+
+    = f.action :submit, input_html: { value: 'Upload File', onclick: "this.disabled=true;this.value='Please wait...';this.form.submit();" }
+
+%table#resource_table{alt: 'Attachments'}
+  %thead
+    %tr
+      %th Download
+      %th File Name
+      %th Version
+      %th Last Modified
+      %th.action_col_header{colspan: 2} Actions
+
+  %tbody
+    = render @attachments
+
+%br/
+= link_to 'New Attachment', new_attachment_path, title: 'New Attachment'
+

data/app/views/importable_attachments/attachments/index.xml.builder

@@ -0,0 +1,23 @@
+xml.instruct! :xml, version: '1.0', encoding: 'UTF-8'
+xml.attachments do
+  xml.page params[:page]
+  xml.total_pages(@filtered_collection ? (@filtered_collection.count / params[:rows].to_f).ceil : 1)
+  xml.num_records(@filtered_collection ? @filtered_collection.count : 0)
+  xml.rows do
+    @attachments && @attachments.each do |u|
+      xml.attachment id: u.id do
+        xml.id u.id
+        xml.parent_type u.parent_type
+        xml.parent_id u.parent_id
+        xml.revision_number u.revision_number
+        xml.io_stream_file_name u.io_stream_file_name
+        xml.io_stream_content_type u.io_stream_content_type
+        xml.io_stream_file_size u.io_stream_file_size
+        xml.io_stream_updated_at u.io_stream_updated_at
+        xml.created_at u.created_at
+        xml.updated_at u.updated_at
+      end
+    end
+  end
+end
+

data/app/views/importable_attachments/attachments/new.html.haml

@@ -0,0 +1,10 @@
+%h2 New Attachment
+
+= semantic_form_for @attachment, url: attachments_path, html: {multipart: true} do |f|
+  = f.inputs do
+    = render 'form', f: f, attachment: @attachment
+
+    = f.action :submit, input_html: { value: 'Upload File', onclick: "this.disabled=true;this.value='Please wait...';this.form.submit();" }
+
+= link_to 'View All Attachments', attachments_path
+

data/app/views/importable_attachments/attachments/show.html.haml

@@ -0,0 +1,43 @@
+%h2 Attachment #{@attachment.io_stream_file_name}
+
+#spreadsheet_action_panel.actions_menu
+  - img_tag = image_tag '/assets/importable_attachments/buttons/download_32.png', alt: 'Download Original File', title: 'Download Original File', id: 'icon_file_download', :class => 'faux_link'
+  =link_to img_tag, @attachment.io_stream.url, title: @attachment.io_stream_file_name, alt: @attachment.io_stream_file_name
+
+- if @attachment.attachable_type
+  %p
+    %b Represents:
+    = "#{@attachment.attachable_type} id: #{@attachment.attachable_id}"
+
+%p
+  %b File Name:
+  =link_to @attachment.io_stream_file_name, @attachment.io_stream.url, title: @attachment.io_stream_file_name, alt: @attachment.io_stream_file_name
+
+- if %w(development test).include?(Rails.env)
+  %p
+    %b File Path:
+    =link_to @attachment.io_stream.path.sub(Rails.root.to_s + '/', ""), File.dirname(@attachment.io_stream.path)
+
+%p
+  %b File Size:
+  = "#{@attachment.io_stream_file_size} bytes"
+
+%p
+  %b Content Type:
+  = @attachment.io_stream_mime_type.try(:simplified) || 'Unknown'
+
+%p
+  %b Version:
+  = @attachment.revision_number
+
+%p
+  %b Last Modified:
+  = @attachment.updated_at.strftime('%Y-%m-%d %I:%M %p')
+
+%br/
+= link_to 'Edit', edit_attachment_path(@attachment)
+|
+= link_to 'Destroy', @attachment, confirm: 'Are you sure?', method: :delete
+|
+= link_to 'View All Attachments', attachments_path
+

data/app/views/importable_attachments/versions/_form.html.haml

@@ -0,0 +1,25 @@
+= form_for @version do |f|
+  - if @version.errors.any?
+    #error_explanation
+      %h2= "#{pluralize(@version.errors.count, "error")} prohibited this version from being saved:"
+      %ul
+        - @version.errors.full_messages.each do |msg|
+          %li= msg
+
+  .field
+    = f.label :item_type
+    = f.text_field :item_type
+  .field
+    = f.label :item_id
+    = f.text_field :item_id
+  .field
+    = f.label :event
+    = f.text_field :event
+  .field
+    = f.label :whodunit
+    = f.text_field :whodunit
+  .field
+    = f.label :object
+    = f.text_area :object
+  .actions
+    = f.submit 'Save'

data/app/views/importable_attachments/versions/edit.html.haml

@@ -0,0 +1,7 @@
+%h1 Editing version
+
+= render 'form'
+
+= link_to 'Show', @version
+\|
+= link_to 'Back', versions_path

data/app/views/importable_attachments/versions/index.html.haml

@@ -0,0 +1,27 @@
+%h1 Listing versions
+
+%table
+  %tr
+    %th Item type
+    %th Item
+    %th Event
+    %th Whodunit
+    %th Object
+    %th
+    %th
+    %th
+
+  - @versions.each do |version|
+    %tr
+      %td= version.item_type
+      %td= version.item_id
+      %td= version.event
+      %td= version.whodunit
+      %td= version.object
+      %td= link_to 'Show', version
+      %td= link_to 'Edit', edit_version_path(version)
+      %td= link_to 'Destroy', version, :method => :delete, :data => { :confirm => 'Are you sure?' }
+
+%br
+
+= link_to 'New Version', new_version_path

data/app/views/importable_attachments/versions/new.html.haml

@@ -0,0 +1,5 @@
+%h1 New version
+
+= render 'form'
+
+= link_to 'Back', versions_path

data/app/views/importable_attachments/versions/show.html.haml

@@ -0,0 +1,21 @@
+%p#notice= notice
+
+%p
+  %b Item type:
+  = @version.item_type
+%p
+  %b Item:
+  = @version.item_id
+%p
+  %b Event:
+  = @version.event
+%p
+  %b Whodunit:
+  = @version.whodunit
+%p
+  %b Object:
+  = @version.object
+
+= link_to 'Edit', edit_version_path(@version)
+\|
+= link_to 'Back', versions_path

data/app/views/layouts/_version.html.haml

@@ -0,0 +1,33 @@
+- current_version = collection.last || Version.new
+%h3
+  Current Version: #{collection.length}
+
+%b Created At:
+= current_version.created_at
+
+%br/
+= succeed ':' do
+  %b Admin
+
+%br/
+- if collection.length.to_i > 1
+  - if params[:version].to_i > 1 || !params[:version]
+    = link_to 'Previous version', {version: (params[:version] || collection.length).to_i - 1}
+
+    %br/
+
+  - if params[:version]
+    %h3
+      This is #{params[:version]} version
+
+    %b Modify at:
+    = collection[(params[:version].to_i - 1)].created_at
+
+    %br/
+
+    = succeed ':' do
+      %b Admin
+
+    %br/
+    = link_to 'Go to current version'
+

data/app/views/layouts/importable_attachments/application.html.haml

@@ -0,0 +1,48 @@
+!!! 1.1
+%html{lang: 'en', 'xml:lang' => 'en', xmlns: 'http://www.w3.org/1999/xhtml'}
+  %head
+    %meta{content: 'text/html; charset=utf-8', :'http-equiv' => 'Content-type'}/
+    %meta{name: 'document-rights', content: 'Copyrighted Work'}
+    %meta{name: 'Copyright', content: 'Copyright (c) Paul Belt'}
+    %meta{name: 'Rating', content: 'General'}
+    %meta{name: 'Keywords', content: 'attachments upload download'}
+    %meta{name: 'Description', content: 'Attachments Engine'}
+    %meta{name: 'csrf-token_name', content: request_forgery_protection_token}
+    %meta{name: 'csrf-token', content: form_authenticity_token}
+    %meta{name: 'csrf-param', content: 'authenticity_token'}
+
+    %title Attachments
+
+    = stylesheet_link_tag 'importable_attachments/application', media: 'all', charset: 'utf-8'
+    = javascript_include_tag 'importable_attachments/application', charset: 'utf-8'
+
+    /[if IE 6]
+      = stylesheet_link_tag 'formtastic_ie6'
+    /[if IE 7]
+      = stylesheet_link_tag 'formtastic_ie7'
+
+    - if protect_against_forgery?
+      = csrf_meta_tags # this must be last
+
+  %body
+    #flash
+      - flash.each do |key, value|
+        %div{:id => "flash_#{key}"}
+          %p{:style => 'float:right;'}
+            = link_to_function 'X', "Effect.Fade('flash_#{key}')"
+          %ul
+            - if value.is_a?(Hash)
+              %li.message
+                = h value[:message]
+              %li.flash_followup_action
+                = h value[:followup]
+            - else
+              %li.message
+                = h value
+          .clear
+
+    #contents
+      %noscript.noscript
+        %p Please enable JavaScript for a better experience.
+
+      = yield