rexport 0.4.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: aac4ec78dc853794fb76c0f05eaa383faca03e52
+  data.tar.gz: d2a1a8f5d7441d50acaf2cf129baf4dfbbd32017
+SHA512:
+  metadata.gz: cbaa46236aac25bbc9c23210cd6a87dd787418f169fa20f85b5244f7b1b7bb9a32cfba424a36bbded225c767256493a3e6066ef9d849cb5324448f74d995dd8d
+  data.tar.gz: 03ab41bbedd051d566e7a9cfa8cae3ff5b710084facc4b8a27536d1c903abee5f62f65416876131bbe0b8bca74241da97f4299cd9fb2f41def6f8a95714bc54f

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2011 Aaron Baldwin, WWIDEA INC.
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.rdoc

@@ -0,0 +1,17 @@
+=Rexport
+
+Ruby on Rails gem to manage exports
+
+
+==Installation
+1. install gem
+2. copy migration into application db/migrate folder and run
+3. create models and mix in corresponding module
+* export => export_methods
+* export_item => export_item_methods
+* export_filter => export_filter_methods
+
+
+==License
+
+Copyright (c) 2008-2012 WWIDEA, released under the MIT license

data/Rakefile

@@ -0,0 +1,38 @@
+#!/usr/bin/env rake
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+begin
+  require 'rdoc/task'
+rescue LoadError
+  require 'rdoc/rdoc'
+  require 'rake/rdoctask'
+  RDoc::Task = Rake::RDocTask
+end
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'Rexport'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+
+
+
+Bundler::GemHelper.install_tasks
+
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = false
+end
+
+
+task :default => :test

data/app/helpers/exports_helper.rb

@@ -0,0 +1,25 @@
+module ExportsHelper
+  def filter_value_field(rexport_model, field)
+    filter_field = rexport_model.field_path(rexport_model.filter_column(field))
+    tag_name = "export[export_filter_attributes][#{filter_field.to_s}]"
+    value = @export.filter_value(filter_field)
+
+    case field.type
+      when :boolean
+        select_tag(tag_name, options_for_select([nil, ['true', 1], ['false', 0]], (value.to_i unless value.nil?)))
+      when :association
+        association, text_method = field.method.split('.')
+        select_tag( tag_name,
+              ('<option value=""></option>' +
+              options_from_collection_for_select(
+                rexport_model.collection_from_association(association),
+                :id,
+                text_method,
+                value.to_i)).html_safe)
+      when :datetime, nil
+        '&nbsp;'.html_safe
+      else
+        text_field_tag(tag_name, value)
+    end
+  end
+end

data/app/views/export_filters/_export_filter.html.erb

@@ -0,0 +1,7 @@
+<tr class="<%= cycle('odd','even') %>">
+  <td class="row_title"><%= export_filter.filter_field %></td>
+  <td><%= export_filter.display_value %></td>
+  <td class="table_icons">
+    <%= link_to_delete(export_filter, :text => false) %>
+  </td>
+</tr>

data/app/views/export_items/_export_item.html.erb

@@ -0,0 +1,8 @@
+<tr id="<%= dom_id(export_item) %>" class="<%= cycle('odd','even') %> <%= @export.modifiable? ? 'handle' : '' %>">
+  <td class="row_title"><%= export_item.name %></td>
+  <td><%= export_item.rexport_field %></td>
+  <td class="table_icons">
+    <%= link_to(image_tag('icon_edit.gif'), edit_export_item_path(export_item)) if @export.modifiable? %>
+    <%= link_to_delete(export_item, :text => false) if @export.modifiable? %>
+  </td>
+</tr>

data/app/views/export_items/edit.html.erb

@@ -0,0 +1,15 @@
+<h1>Editing Export Item</h1>
+
+<%= form_for(@export_item) do |f| %>
+  <%= f.error_messages %>
+
+  <p>
+    <%= f.label :name %><br />
+    <%= f.text_field :name %>
+  </p>
+  <p>
+    <%= f.submit "Update" %>
+  </p>
+<% end %>
+
+<%= link_to_cancel export_path(@export_item.export) %>

data/app/views/exports/_edit.html.erb

@@ -0,0 +1,7 @@
+<h1>Edit Export</h1>
+
+<%= render :partial => 'form' %>
+
+<p>
+  <%= link_to_cancel @export %>
+</p>

data/app/views/exports/_filters.html.erb

@@ -0,0 +1,9 @@
+<table class='series'>
+  <caption>Export Filters</caption>
+  <tr>
+    <th>Field</th>
+    <th>Value</th>
+    <th class='action_icons'>&nbsp;</th>
+  </tr>
+  <%= render :partial => @export.export_filters %>
+</table>

data/app/views/exports/_form.html.erb

@@ -0,0 +1,25 @@
+<div id="rexport">
+  <%= form_for(@export) do |f| %>
+    <%= f.error_messages %>
+    
+      <div class="export_base_info">
+        <%= f.label :name %>
+        <%= f.text_field :name %>
+      </div>
+      <div  class="export_base_info">
+        <%= f.label :description %>
+        <%= f.text_area :description %>
+      </div>
+
+    <%= render :partial => 'local_form', :locals => { :form => f } %>
+  
+    <h3>Export Items</h3>
+    <%= render :partial => 'rexport_model', :collection => @export.rexport_models %>
+  
+    <%= f.hidden_field :model_name %>
+  
+    <div>
+      <%= f.submit 'Save Export' %>
+    </div>
+  <% end %>
+</div>

data/app/views/exports/_local_form.html.erb

@@ -0,0 +1 @@
+<!-- override to add additional fields -->

data/app/views/exports/_rexport_model.html.erb

@@ -0,0 +1,17 @@
+<table class='series'>
+  <caption><%= rexport_model.name %> (<%= rexport_model.path %>)</caption>
+  <tr>
+    <th>Export</th>
+    <th>Data Field</th>
+    <th>Filter Value</th>
+  </tr>
+  <% for field in rexport_model.rexport_fields_array %>
+    <tr class="<%= cycle('odd','even') %>">
+      <td><%= check_box_tag "export[rexport_fields][#{rexport_model.field_path(field.name)}]", 1, @export.has_rexport_field?(rexport_model.field_path(field.name))  %></td>
+      <td class="row_title"><%= field.name.titleize %></td>
+      <td class='row_title'>
+        <%= filter_value_field(rexport_model, field) %>
+      </td>
+    </tr>
+  <% end %>
+</table>

data/app/views/exports/_show.html.erb

@@ -0,0 +1,53 @@
+<h1><%= @export.name %></h1>
+<div id="custom_export_options">
+  <h4>Options</h4>
+  <ul>
+    <li><%= link_to("#{image_tag('icon_edit.gif')} Edit".html_safe, edit_export_path(@export)) if @export.modifiable? %></li>
+    <li><%= link_to "#{image_tag('icon_export.png')} Export".html_safe, export_path(@export, :format => :csv)  %></li>
+    <li><%= link_to "#{image_tag('icon_copy.png')} Copy".html_safe, exports_path(:original_export_id => @export.id), :method => :post %></li>
+  </ul>
+</div>
+<div class="show_export_info">
+  <p>
+    <label>Category:</label>
+    <%= @export.model_name %>
+  </p>
+  </div>
+  <div class="show_export_info">
+  <p>
+    <label>Description:</label>
+  </p>
+    <%= simple_format @export.description %>
+</div>
+
+<table>
+  <caption>Export Items</caption>
+  <thead>
+    <tr>
+      <th>Name</th>
+      <th>Export Field</th>
+      <th class='action_icons'>&nbsp;</th>
+    </tr>
+  </thead>
+  <%= content_tag :tbody, {:id => 'export_items'}.merge(@export.modifiable? ? {:class => 'sortable', 'data-url' => export_item_sorting_path} : {}) do %>
+    <%= render :partial => @export.export_items.ordered %>
+  <% end %>
+</table>
+
+<%= content_tag(:p, 'Drag and drop the rows in the table above to re-order the export data left to right in the output (see sample below).', :class => 'instructions') if @export.modifiable? %>
+
+<%= render(:partial => 'filters') unless @export.export_filters.blank? %>
+
+<div class='scrolling'>
+  <table>
+    <caption>Sample Output (first <%= Rexport::SAMPLE_SIZE %> records)</caption>
+    <tr>
+      <%= (@export.header.map {|heading| content_tag(:th, heading)} * '').html_safe %>
+    </tr>
+    <% for record in @export.sample_records %>
+      <tr class="<%= cycle('odd','even') %>">
+        <%= (record.map { |item| content_tag(:td, item) } * '').html_safe  %>
+      </tr>
+    <% end %>
+  </table>
+</div>

data/app/views/exports/edit.html.erb

@@ -0,0 +1 @@
+<%= render :partial => 'edit' %>

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

@@ -0,0 +1,33 @@
+<%= form_for Export.new, :url => new_export_path, :html => {:method => :get} do |f| %>
+  <fieldset>
+    <legend>Create New Export</legend>
+    <div class='dropdown'>
+      <%= f.select :model_name, Export.models %>
+      <%= f.submit 'Create' %>
+    </div>
+  </fieldset>
+<% end %>
+
+<table>
+  <caption>Export List</caption>
+  <tr>
+    <th>Name</th>
+    <th>Description</th>
+    <th>Created</th>
+    <th class='action_icons wider'>&nbsp;</th>
+  </tr>
+
+  <% for export in @exports %>
+    <tr class="<%= cycle('odd', 'even') %>">
+      <td class="row_title"><%= link_to export.full_name, export %></td>
+      <td class='description'><%= export.description %></td>
+      <td><%= print_date export.created_at %></td>
+      <td class="table_icons">
+        <%= link_to_export export_path(export, :format => :csv), :text => false  %>
+        <%= link_to_show export, :text => false %>
+        <%= link_to(image_tag('icon_edit.gif'), edit_export_path(export), :title => 'Edit') if export.modifiable? %>
+        <%= link_to_delete(export, :text => false) if export.modifiable? %>
+      </td>
+    </tr>
+  <% end %>
+</table>

data/app/views/exports/new.html.erb

@@ -0,0 +1,7 @@
+<h1>New <%= @export.model_name %> Export</h1>
+
+<%= render :partial => 'form' %>
+
+<div>
+  <%= link_to_cancel exports_path %>
+</div>

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

@@ -0,0 +1 @@
+<%= render :partial => 'show' %>

data/config/routes.rb

@@ -0,0 +1,11 @@
+Rails.application.routes.draw do
+  # singleton resources
+  resource :export_item_sorting,  :only => [:update]
+  
+  # collection resources
+  resources :export_items,        :only => [:edit, :update, :destroy]
+  resources :export_filters,      :only => [:edit, :update, :destroy]
+  resources :exports do
+    resources :export_filters, :only => [:new]
+  end
+end

data/db/migrate/20091105182959_create_export_tables.rb

@@ -0,0 +1,34 @@
+class CreateExportTables < ActiveRecord::Migration
+  def self.up
+    create_table "export_filters", :force => true do |t|
+      t.integer  "export_id"
+      t.string   "field"
+      t.string   "value"
+      t.datetime "created_at"
+      t.datetime "updated_at"
+    end
+
+    create_table "export_items", :force => true do |t|
+      t.integer  "export_id"
+      t.integer  "position"
+      t.string   "name"
+      t.string   "rexport_field"
+      t.datetime "created_at"
+      t.datetime "updated_at"
+    end
+
+    create_table "exports", :force => true do |t|
+      t.string   "name"
+      t.string   "model_name"
+      t.text     "description"
+      t.datetime "created_at"
+      t.datetime "updated_at"
+    end
+  end
+
+  def self.down
+    drop_table :export_filters
+    drop_table :export_items
+    drop_table :exports
+  end
+end

data/lib/rexport.rb

@@ -0,0 +1,17 @@
+require 'rexport/data_fields'
+require 'rexport/export_filter_methods'
+require 'rexport/export_filters_controller_methods'
+require 'rexport/export_item_methods'
+require 'rexport/export_item_sortings_controller_methods'
+require 'rexport/export_items_controller_methods'
+require 'rexport/export_methods'
+require 'rexport/exports_controller_methods'
+require 'rexport/tree_node'
+
+module Rexport
+
+  class Engine < ::Rails::Engine
+    config.paths['app/views'] << File.join(File.dirname(__FILE__),'../app/views')
+  end
+
+end

data/lib/rexport/data_fields.rb

@@ -0,0 +1,152 @@
+module Rexport #:nodoc:
+
+  # Stores the name and method of the export data item
+  class DataField
+    include Comparable
+    attr_accessor :name, :method, :type
+
+    def initialize(name, options = {})
+      self.name = name.to_s
+      self.method = options[:method].blank? ? self.name : options[:method].to_s
+      self.type = options[:type]
+    end
+
+    def <=>(rf)
+      self.name <=> rf.name
+    end
+  end
+
+  module DataFields
+    def self.included( base )
+      base.extend( ClassMethods )
+      base.class_eval do
+        include InstanceMethods
+        class << self
+          alias_method_chain :reset_column_information, :rexport_reset
+        end
+      end
+    end
+
+    module ClassMethods
+      # Returns hash of exportable data items
+      def rexport_fields
+        unless @rexport_fields
+          @rexport_fields = HashWithIndifferentAccess.new
+          initialize_rexport_fields
+        end
+        @rexport_fields
+      end
+
+      # Returns sorted array of rexport DataFields
+      def rexport_fields_array
+        rexport_fields.merge(dynamic_rexport_fields).values.sort
+      end
+
+      # Adds a data item to rexport_fields
+      def add_rexport_field(name, options = {})
+        rexport_fields[name.to_s] = DataField.new(name, options)
+      end
+
+      # Adds associated methods to rexport_fields
+      #   :associations - an association or arrary of associations
+      #   :methods - a method or array of methods
+      #   :filter - if true will send :type => :association to add_report_field
+      def add_association_methods(options = {})
+        options.stringify_keys!
+        options.assert_valid_keys(%w(associations methods filter))
+
+        methods = options.reverse_merge('methods' => 'name')['methods']
+        methods = [methods] if methods.kind_of?(String)
+
+        associations = options['associations']
+        associations = [associations] if associations.kind_of?(String)
+
+        type = options['filter'] ? :association : nil
+
+        associations.each do |association|
+          methods.each do |method|
+            add_rexport_field("#{association}_#{method}", :method => "#{association}.#{method}", :type => type)
+          end
+        end
+      end
+
+      # Removes files from rexport_fields
+      # useful to remove content columns you don't want included in exports
+      def remove_rexport_fields(*fields)
+        fields.flatten.each {|field| rexport_fields.delete(field.to_s)}
+      end
+
+      # Returns an array of export methods corresponding with field_names
+      def get_rexport_methods(*field_names)
+        field_names.flatten.map do |f|
+          begin
+            components = f.to_s.split('.')
+            field_name = components.pop
+            components.push(get_klass_from_associations(components).get_rexport_method(field_name)) * '.'
+          rescue NoMethodError
+            'undefined_rexport_field'
+          end
+        end
+      end
+
+      # Returns the associated class by following the associations
+      def get_klass_from_associations(*associations)
+        associations.flatten!
+        return self if associations.empty?
+        reflect_on_association(associations.shift.to_sym).klass.get_klass_from_associations(associations)
+      end
+
+      # Returns the export method for a given field_name
+      def get_rexport_method(field_name)
+        raise NoMethodError unless rexport_fields[field_name] or dynamic_rexport_fields[field_name]
+        if rexport_fields[field_name]
+          rexport_fields[field_name].method
+        else
+          dynamic_rexport_fields[field_name].method
+        end
+      end
+
+      def reset_column_information_with_rexport_reset
+        reset_column_information_without_rexport_reset
+        @rexport_fields = nil
+      end
+
+      private
+
+      # Adds content columns and columns ending in "_count" to rexport_fields, includes callback initialize_local_rexport_fields
+      # for client defined initialization
+      def initialize_rexport_fields
+        (content_columns + columns.select {|c| c.name =~ /_count$/}).each do |f|
+          add_rexport_field(f.name, :type => f.type)
+        end
+        initialize_local_rexport_fields if respond_to?(:initialize_local_rexport_fields)
+      end
+
+      def dynamic_rexport_fields
+        respond_to?(:initialize_dynamic_rexport_fields) ? initialize_dynamic_rexport_fields : {}
+      end
+    end
+
+    module InstanceMethods
+      # Return an array of formatted export for the passed methods
+      def export(*methods)
+        methods.flatten.map do |method|
+          case value = (eval("self.#{method}", binding) rescue nil)
+            when Date, Time
+              value.strftime("%m/%d/%y")
+            when TrueClass
+              'Y'
+            when FalseClass
+              'N'
+            else value.to_s
+          end
+        end
+      end
+
+      # Returns string indicating this field is undefined
+      def undefined_rexport_field
+        'UNDEFINED EXPORT FIELD'
+      end
+    end
+  end
+end