rexport 0.5.4 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: c1feb585dc87a52250b3856dfb0431730f5c2cc0
-  data.tar.gz: 7f4eb61376b04dd6fd2206535421d8c155e76091
+SHA256:
+  metadata.gz: 2d78c303332bc96efaf4f0a9548db0a0604250e48089e512cc7d106853c47efb
+  data.tar.gz: 32469341766f9e0a262ce8d16fb0872172d0190f9b03c0023af81ecf7f2cd5f8
 SHA512:
-  metadata.gz: d19ae468e08d54cf89046c1e685fc819b7282ca316312fdd52fca7a5d3e4891c0389a2685381fa6dc07e0c4041c2128ed1133e3141c8e25f819a5992de1bbc5d
-  data.tar.gz: 915035b53f2ae3c990a41534f8661ce896bcad70509ac79892a1bb07eb808dba6d62256a488b949803e8ed3117833526ea2cdee5a6221f495b77161c9c868b20
+  metadata.gz: 4bb5f6249a4cb8903d7c2b713c9857da2b959094879c9f7ba1acbd92130c37ff073de275d7fc36841c44adab534917b87c2c6246fa055b57f334d025b784e264
+  data.tar.gz: 18f5b364174c6f3b0f24b50f82b7a9a39484d2e0147437eec923a25074442c6dd7d45dd082832fb6fd731a459610a27710852551183a9c036e7f546332d48a67

data/Rakefile

@@ -1,38 +1,10 @@
-#!/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'
+require "bundler/gem_tasks"
+require "rake/testtask"
 
 Rake::TestTask.new(:test) do |t|
-  t.libs << 'lib'
-  t.libs << 'test'
-  t.pattern = 'test/**/*_test.rb'
-  t.verbose = false
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList["test/**/*_test.rb"]
 end
 
-
-task :default => :test
+task default: :test

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

@@ -2,6 +2,6 @@
   <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) %>
+    <%= link_to_delete(export_filter, text: false) %>
   </td>
-</tr>
+</tr>

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

@@ -3,6 +3,6 @@
   <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? %>
+    <%= link_to_delete(export_item, text: false) if @export.modifiable? %>
   </td>
-</tr>
+</tr>

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

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

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

@@ -5,5 +5,5 @@
     <th>Value</th>
     <th class='action_icons'>&nbsp;</th>
   </tr>
-  <%= render :partial => @export.export_filters %>
+  <%= render partial: @export.export_filters %>
 </table>

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

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

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

@@ -14,4 +14,4 @@
       </td>
     </tr>
   <% end %>
-</table>
+</table>

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

@@ -3,8 +3,8 @@
   <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>
+    <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">
@@ -29,14 +29,14 @@
       <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 %>
+  <%= 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? %>
+<%= 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? %>
+<%= render(partial: 'filters') unless @export.export_filters.blank? %>
 
 <div class='scrolling'>
   <table>

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

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

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

@@ -1,4 +1,4 @@
-<%= form_for Export.new, :url => new_export_path, :html => {:method => :get} do |f| %>
+<%= form_for Export.new, url: new_export_path, html: {method: :get} do |f| %>
   <fieldset>
     <legend>Create New Export</legend>
     <div class='dropdown'>
@@ -23,10 +23,10 @@
       <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? %>
+        <%= 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 %>

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

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

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

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

data/config/routes.rb

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

data/db/migrate/20091105182959_create_export_tables.rb

@@ -1,6 +1,6 @@
 class CreateExportTables < ActiveRecord::Migration
   def self.up
-    create_table "export_filters", :force => true do |t|
+    create_table "export_filters", force: true do |t|
       t.integer  "export_id"
       t.string   "field"
       t.string   "value"
@@ -8,7 +8,7 @@ class CreateExportTables < ActiveRecord::Migration
       t.datetime "updated_at"
     end
 
-    create_table "export_items", :force => true do |t|
+    create_table "export_items", force: true do |t|
       t.integer  "export_id"
       t.integer  "position"
       t.string   "name"
@@ -17,7 +17,7 @@ class CreateExportTables < ActiveRecord::Migration
       t.datetime "updated_at"
     end
 
-    create_table "exports", :force => true do |t|
+    create_table "exports", force: true do |t|
       t.string   "name"
       t.string   "model_class_name"
       t.text     "description"

data/lib/rexport.rb

@@ -1,3 +1,4 @@
+require 'rexport/data_field'
 require 'rexport/data_fields'
 require 'rexport/export_filter_methods'
 require 'rexport/export_filters_controller_methods'
@@ -6,12 +7,13 @@ require 'rexport/export_item_sortings_controller_methods'
 require 'rexport/export_items_controller_methods'
 require 'rexport/export_methods'
 require 'rexport/exports_controller_methods'
+require 'rexport/rexport_model'
 require 'rexport/tree_node'
 
 module Rexport
+  SAMPLE_SIZE = 5
 
   class Engine < ::Rails::Engine
     config.paths['app/views'] << File.join(File.dirname(__FILE__),'../app/views')
   end
-
 end

data/lib/rexport/data_field.rb

@@ -0,0 +1,17 @@
+module Rexport
+  class DataField
+    include Comparable
+    attr_accessor :name, :method, :type
+
+    # Stores the name and method of the export data item
+    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
+end

data/lib/rexport/data_fields.rb

@@ -1,33 +1,11 @@
 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
-        prepend ClassMethods
-      end
-    end
+    extend ActiveSupport::Concern
 
     module ClassMethods
       # Returns hash of exportable data items
       def rexport_fields
+        @rexport_fields ||= nil
         unless @rexport_fields
           @rexport_fields = HashWithIndifferentAccess.new
           initialize_rexport_fields
@@ -37,7 +15,7 @@ module Rexport #:nodoc:
 
       # Returns sorted array of rexport DataFields
       def rexport_fields_array
-        rexport_fields.merge(dynamic_rexport_fields).values.sort
+        rexport_fields.values.sort
       end
 
       # Adds a data item to rexport_fields
@@ -48,7 +26,7 @@ module Rexport #:nodoc:
       # 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
+      #   :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))
@@ -63,7 +41,7 @@ module Rexport #:nodoc:
 
         associations.each do |association|
           methods.each do |method|
-            add_rexport_field("#{association}_#{method}", :method => "#{association}.#{method}", :type => type)
+            add_rexport_field("#{association}_#{method}", method: "#{association}.#{method}", type: type)
           end
         end
       end
@@ -71,7 +49,7 @@ module Rexport #:nodoc:
       # 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)}
+        fields.flatten.each { |field| rexport_fields.delete(field.to_s) }
       end
 
       # Returns an array of export methods corresponding with field_names
@@ -96,11 +74,10 @@ module Rexport #:nodoc:
 
       # 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
+          raise NoMethodError
         end
       end
 
@@ -111,40 +88,32 @@ module Rexport #:nodoc:
 
       private
 
-      # Adds content columns and columns ending in "_count" to rexport_fields, includes callback initialize_local_rexport_fields
-      # for client defined initialization
+      # Adds content columns 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
+        content_columns.each { |field| add_rexport_field(field.name, type: field.type) }
         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
+    # Return an array of formatted export values 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
+    # Returns string indicating this field is undefined
+    def undefined_rexport_field
+      'UNDEFINED EXPORT FIELD'
     end
   end
 end

data/lib/rexport/export_filter_methods.rb

@@ -1,34 +1,56 @@
 module Rexport #:nodoc:
   module ExportFilterMethods
-    def self.included(base)
-      base.class_eval do
-        include InstanceMethods
+    extend ActiveSupport::Concern
 
-        belongs_to :export
-        validates_presence_of :filter_field
-      end
+    included do
+      belongs_to :export
+      validates_presence_of :filter_field
+    end
+
+    def display_value
+      filter_on_associated_object? ? associated_object_value : value
+    end
+
+    def attributes_for_copy
+      attributes.slice('filter_field', 'value')
     end
 
-    module InstanceMethods
-      def display_value
-        return value unless filter_field[/_id$/]
-        path = filter_field.split('.')
-        foreign_key = path.pop
-        association = export.get_klass_from_path(path).reflect_on_all_associations(:belongs_to).detect do |association|
-          association.foreign_key == foreign_key
-        end
-        return 'UNDEFINED ASSOCIATION' unless association
-        begin
-          object = association.klass.find(value)
-          return object.respond_to?(:name) ? object.name : object.to_s
-        rescue ActiveRecord::RecordNotFound
-          return 'ASSOCIATED OBJECT NOT FOUND'
-        end
+    private
+
+    def associated_object_value
+      return 'UNDEFINED ASSOCIATION' unless filter_association
+      begin
+        object = filter_association.klass.find(value)
+        return object.respond_to?(:name) ? object.name : object.to_s
+      rescue ActiveRecord::RecordNotFound
+        return 'ASSOCIATED OBJECT NOT FOUND'
       end
-      
-      def attributes_for_copy
-        attributes.slice('filter_field', 'value')
+    end
+
+    def filter_association
+      @filter_on_assocation ||= find_filter_association
+    end
+
+    def find_filter_association
+      belongs_to_associations.detect do |association|
+        association.foreign_key == filter_foreign_key
       end
     end
+
+    def belongs_to_associations
+      export.get_klass_from_path(filter_path).reflect_on_all_associations(:belongs_to)
+    end
+
+    def filter_path
+      filter_field.split('.')[0..-2]
+    end
+
+    def filter_foreign_key
+      filter_field.split('.').last
+    end
+
+    def filter_on_associated_object?
+      filter_field[/_id$/]
+    end
   end
 end