rexport 0.5.4 → 1.2.0

data/lib/rexport/exports_controller_methods.rb

@@ -3,75 +3,74 @@ module Rexport
     def index
       @exports = Export.categorical.alphabetical
     end
-    
+
     def show
-      @export = Export.find(params[:id])
-      
+      export
+
       respond_to do |format|
         format.html # show.html.erb
-        format.csv { send_data(@export.to_csv, :type => export_content_type, :filename => filename) }
+        format.csv { send_data(export.to_csv, type: export_content_type, filename: filename) }
       end
     end
-    
+
     def new
       @export = Export.new(export_params)
     end
-    
+
     def edit
-      @export = Export.find(params[:id])
+      export
     end
-    
+
     def create
       @export = params[:original_export_id] ? Export.find(params[:original_export_id]).copy : Export.new(export_params)
-      
+
       if @export.save
         redirect_to @export, notice: 'Export was successfully created.'
       else
         render :new
       end
     end
-    
+
     def update
-      @export = Export.find(params[:id])
-      
-      if @export.update_attributes(export_params)
-        redirect_to @export, notice: 'Export was successfully updated.'
+      if export.update(export_params)
+        redirect_to export, notice: 'Export was successfully updated.'
       else
         render :edit
       end
     end
-    
+
     def destroy
-      @export = Export.find(params[:id])
-      @export.destroy
-      
+      export.destroy
+
       redirect_to exports_url
     end
-    
+
     private
-    
-    def export_params
-      params.require(:export).permit(:name, :model_class_name, :description).merge(rexport_fields: rexport_fields, export_filter_attributes: export_filter_attributes)
-    end
-    
-    def rexport_fields
-      permit_all params[:export][:rexport_fields]
+
+    def export
+      @export ||= Export.find(params[:id])
     end
-    
-    def export_filter_attributes
-      permit_all params[:export][:export_filter_attributes]
+
+    def export_params
+      params.require(:export).permit(permitted_params)
     end
-    
-    def permit_all(params)
-      params ? params.permit! : []
+
+    def permitted_params
+      [
+        :name,
+        :model_class_name,
+        :description,
+        rexport_fields: {},
+        export_filter_attributes: {}
+      ]
     end
-    
+
     def export_content_type
       request.user_agent =~ /windows/i ? 'application/vnd.ms-excel' : 'text/csv'
     end
-    
+
     def filename
-      "#{@export.model_class_name}_#{@export.name.gsub(/ /, '_')}_#{Time.now.strftime('%Y%m%d')}.csv"
+      "#{export.model_class_name}_#{export.name.gsub(/ /, '_')}_#{Time.now.strftime('%Y%m%d')}.csv"
     end
   end
 end

data/lib/rexport/rexport_model.rb

@@ -0,0 +1,118 @@
+module Rexport #:nodoc:
+  class RexportModel
+    attr_accessor :klass, :path
+
+    def initialize(klass, path: nil)
+      self.klass = klass
+      self.path = path.to_s unless path.blank?
+      initialize_rexport_fields
+    end
+
+    def rexport_fields
+      @rexport_fields ||= HashWithIndifferentAccess.new
+    end
+
+    def rexport_fields_array
+      rexport_fields.values.sort
+    end
+
+    def field_path(field_name)
+      [path, field_name].compact * '.'
+    end
+
+    def collection_from_association(association)
+      if klass.respond_to?("find_#{association}_for_rexport")
+        klass.public_send("find_#{association}_for_rexport")
+      else
+        klass.reflect_on_association(association.to_sym).klass.all
+      end
+    end
+
+    def filter_column(field)
+      return field.method unless field.method.include?('.')
+      association = field.method.split('.').first
+      klass.reflect_on_association(association.to_sym).foreign_key
+    end
+
+    def name
+      klass.name
+    end
+
+    # Adds a data item to rexport_fields
+    def add_rexport_field(name, options = {})
+      rexport_fields[name.to_s] = DataField.new(name, options)
+    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
+
+    # 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
+
+    # 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_rexport_model(components).get_rexport_method(field_name)) * '.'
+        rescue NoMethodError
+          'undefined_rexport_field'
+        end
+      end
+    end
+
+    protected
+
+    # Returns a rexport_model for the associated class by following the chain of associations
+    def get_rexport_model(associations)
+      associations.empty? ? self : rexport_models[associations.dup]
+    end
+
+    # Memoize rexport_models to avoid initializing rexport_fields multiple times
+    def rexport_models
+      @rexport_models ||= Hash.new do |hash, key|
+        hash[key] = self.class.new(klass.get_klass_from_associations(key))
+      end
+    end
+
+    # Returns the export method for a given field_name
+    def get_rexport_method(field_name)
+      if rexport_fields[field_name]
+        rexport_fields[field_name].method
+      else
+        raise NoMethodError
+      end
+    end
+
+    private
+
+    def initialize_rexport_fields
+      klass.content_columns.each { |field| add_rexport_field(field.name, type: field.type) }
+      klass.initialize_local_rexport_fields(self) if klass.respond_to?(:initialize_local_rexport_fields)
+    end
+  end
+end

data/lib/rexport/tree_node.rb

@@ -2,44 +2,41 @@ module Rexport #:nodoc:
   # A basic tree for building up ActiveRecord find :include parameters
   class TreeNode
     attr_accessor :name, :children
-    
+
     # Initialize a tree node setting name and adding a child if one was passed
     def initialize(name, *names)
       self.name = name
       self.children = []
       add_child(names)
     end
-    
+
     # Add one or more children to the tree
     def add_child(*names)
       names.flatten!
       return unless name = names.shift
-      if node = children.find {|c| c.name == name}
-        node.add_child(names)
-      else
-        children << TreeNode.new(name, names)
-      end
+      node = children.find { |c| c.name == name }
+      node ? node.add_child(names) : (children << TreeNode.new(name, names))
     end
-    
+
     # Return an array representation of the tree
     def to_a
-      [name, children.map {|c| c.to_a}]
+      [name, children.map(&:to_a)]
     end
-    
+
     # Return a :include comptatible statement from the tree
     def to_include
-      children.map {|c| c.build_include}
+      children.map(&:build_include)
     end
-    
+
     # Return the include parameters for a child
     def build_include
-      leaf_node? ? name.to_sym : { name.to_sym => children.map {|c| c.build_include} }
+      leaf_node? ? name.to_sym : { name.to_sym => children.map(&:build_include) }
     end
-    
+
     private
-    
+
     def leaf_node?
       children.blank?
     end
   end
-end
+end

data/lib/rexport/version.rb

@@ -1,3 +1,3 @@
 module Rexport
-  VERSION = '0.5.4'
+  VERSION = '1.2.0'
 end

data/test/factories.rb

@@ -1,86 +1,91 @@
 module Rexport
   module Factories
-    
-    FactoryGirl.define do
-    
+
+    FactoryBot.define do
+
       factory :status do
-        name 'active'
+        name { 'active' }
       end
 
       factory :family do
-        name 'The Sample Family'
+        name { 'The Sample Family' }
       end
-      
+
       factory :student do
-        family        {|f| f.association(:family)}
-        name          'Sammy Sample'
-        date_of_birth Date.parse('2008-12-08')
+        family        { |family| family.association(:family) }
+        name          { 'Sammy Sample' }
+        date_of_birth { Date.parse('2008-12-08') }
       end
-      
+
       factory :enrollment do
-        status {|status| status.association(:status)}
-        student {|s| s.association(:student)}
-        grade   1
+        status      { |status|  status.association(:status) }
+        student     { |student| student.association(:student) }
+        grade       { 1 }
+        updated_at  { Time.now }
       end
-      
-      factory :second_grade_enrollment, :class => 'Enrollment' do
-        status {|status| status.association(:status)}
-        grade 2
+
+      factory :second_grade_enrollment, class: 'Enrollment' do
+        status  { |status| status.association(:status) }
+        grade   { 2 }
       end
-      
+
       factory :export do
-        name 'Enrollment Export'
-        model_class_name 'Enrollment'
+        name              { 'Enrollment Export' }
+        model_class_name  { 'Enrollment' }
         export_items do |items|
           %w(family_name_export_item grade_export_item status_name_export_item bogus_export_item).map do |item|
             items.association(item)
           end
         end
       end
-      
-      factory :filtered_export, :class => 'Export' do
-        name 'Filtered Enrollment Export'
-        model_class_name 'Enrollment'
+
+      factory :filtered_export, class: 'Export' do
+        name              { 'Filtered Enrollment Export' }
+        model_class_name  { 'Enrollment' }
+        export_items do |items|
+          %w(grade_export_item status_name_export_item).map do |item|
+            items.association(item)
+          end
+        end
         export_filters do |filters|
           %w(grade_filter status_filter).map do |filter|
             filters.association(filter)
           end
         end
       end
-      
-      factory :family_name_export_item, :class => 'ExportItem' do
-        position       1
-        name           'Family Name'
-        rexport_field  'student.family.name'
+
+      factory :family_name_export_item, class: 'ExportItem' do
+        position       { 1 }
+        name           { 'Family Name' }
+        rexport_field  { 'student.family.name' }
       end
-      
-      factory :grade_export_item, :class => 'ExportItem' do
-        position       2
-        name           'Grade'
-        rexport_field  'grade'
+
+      factory :grade_export_item, class: 'ExportItem' do
+        position       { 2 }
+        rexport_field  { 'grade' }
       end
-      
-      factory :status_name_export_item, :class => 'ExportItem' do
-        position       3
-        name           'Status'
-        rexport_field  'status_name'
+
+      factory :status_name_export_item, class: 'ExportItem' do
+        position       { 3 }
+        name           { 'Status' }
+        rexport_field  { 'status_name' }
       end
-      
-      factory :bogus_export_item, :class => 'ExportItem' do
-        position       4
-        name           'Bogus Item'
-        rexport_field  'bogus_field'
+
+      factory :bogus_export_item, class: 'ExportItem' do
+        position       { 4 }
+        name           { 'Bogus Item' }
+        rexport_field  { 'bogus_field' }
       end
-      
-      factory :grade_filter, :class => 'ExportFilter' do
-        filter_field   'grade'
-        value          '1'
+
+      factory :grade_filter, class: 'ExportFilter' do
+        filter_field   { 'grade' }
+        value          { '1' }
       end
-      
-      factory :status_filter, :class => 'ExportFilter' do
-        filter_field   'status.name'
-        value          'active'
+
+      factory :status_filter, class: 'ExportFilter' do
+        filter_field   { 'status.name' }
+        value          { 'active' }
       end
     end
   end
-end
+end

data/test/test_helper.rb

@@ -1,29 +1,26 @@
-require 'minitest/autorun'
-require 'rubygems'
+require 'simplecov'
+SimpleCov.start do
+  add_filter '/test/'
+end
+
+$LOAD_PATH.unshift File.expand_path("../../lib", __FILE__)
+require "rails"
 require 'active_record'
-require 'active_support/test_case'
-require 'logger'
-require 'factory_girl'
-require 'mocha/mini_test'
-require File.dirname(__FILE__) + '/factories'
-require File.dirname(__FILE__) + '/../lib/rexport/data_fields'
-require File.dirname(__FILE__) + '/../lib/rexport/export_methods'
-require File.dirname(__FILE__) + '/../lib/rexport/export_item_methods'
-require File.dirname(__FILE__) + '/../lib/rexport/export_filter_methods'
-require File.dirname(__FILE__) + '/../lib/rexport/tree_node'
+require "rexport"
 
-ActiveRecord::Base.establish_connection(:adapter => "sqlite3", :database => ":memory:")
+require 'minitest/autorun'
+require 'factory_bot'
+require 'mocha/minitest'
+require File.dirname(__FILE__) + '/factories'
 
-RAILS_DEFAULT_LOGGER = Logger.new(File.dirname(__FILE__) + '/log/test.log')
-RAILS_DEFAULT_LOGGER.level = Logger::DEBUG
-ActiveRecord::Base.logger = RAILS_DEFAULT_LOGGER
+ActiveRecord::Base.establish_connection(adapter: "sqlite3", database: ":memory:")
 
 class ActiveSupport::TestCase
-  include FactoryGirl::Syntax::Methods
+  include FactoryBot::Syntax::Methods
   include Rexport::Factories
 
   def setup
-    setup_db
+    suppress_output { setup_db }
     Enrollment.instance_variable_set('@rexport_fields', nil)
     Student.instance_variable_set('@rexport_fields', nil)
   end
@@ -32,17 +29,10 @@ class ActiveSupport::TestCase
     teardown_db
   end
 
-  # Placeholder so test/unit ignores test cases without any tests.
-  def default_test
-  end
-
   private
 
   def setup_db
-    old_stdout = $stdout
-    $stdout = StringIO.new
-
-    ActiveRecord::Schema.define(:version => 1) do
+    ActiveRecord::Schema.define(version: 1) do
       create_table :enrollments do |t|
         t.integer :student_id, :status_id, :grade
         t.boolean :active
@@ -85,8 +75,6 @@ class ActiveSupport::TestCase
       create_table :self_referential_checks do |t|
       end
     end
-
-    $stdout = old_stdout
   end
 
   def teardown_db
@@ -94,6 +82,14 @@ class ActiveSupport::TestCase
       ActiveRecord::Base.connection.drop_table(table)
     end
   end
+
+  def suppress_output
+    original_stdout = $stdout.clone
+    $stdout.reopen File.new('/dev/null', 'w')
+    yield
+  ensure
+    $stdout.reopen original_stdout
+  end
 end
 
 class ActiveRecord::Base
@@ -107,7 +103,7 @@ class Enrollment < ActiveRecord::Base
   include Rexport::DataFields
   belongs_to :student
   belongs_to :status
-  belongs_to :ilp_status, :class_name => 'Status', :foreign_key => 'ilp_status_id'
+  belongs_to :ilp_status, class_name: 'Status', foreign_key: 'ilp_status_id'
   belongs_to :self_referential_check
 
   def foo
@@ -116,10 +112,10 @@ class Enrollment < ActiveRecord::Base
 
   private
 
-  def Enrollment.initialize_local_rexport_fields
-    add_rexport_field(:foo_method, :method => :foo)
-    add_rexport_field(:bad_method, :method => 'bad_method')
-    add_association_methods(:associations => %w(status ilp_status))
+  def self.initialize_local_rexport_fields(rexport_model)
+    rexport_model.add_rexport_field(:foo_method, method: :foo)
+    rexport_model.add_rexport_field(:bad_method, method: 'bad_method')
+    rexport_model.add_association_methods(associations: %w(status ilp_status))
   end
 end
 
@@ -127,6 +123,10 @@ class Student < ActiveRecord::Base
   include Rexport::DataFields
   belongs_to :family
   has_many :enrollments
+
+  def self.find_family_for_rexport
+    Family.order(:name)
+  end
 end
 
 class Family < ActiveRecord::Base
@@ -139,8 +139,8 @@ class Family < ActiveRecord::Base
 
   private
 
-  def Family.initialize_local_rexport_fields
-    add_rexport_field(:foo_method, :method => :foo)
+  def self.initialize_local_rexport_fields(rexport_model)
+    rexport_model.add_rexport_field(:foo_method, method: :foo)
   end
 end
 
@@ -162,9 +162,6 @@ class ExportFilter < ActiveRecord::Base
 end
 
 class SelfReferentialCheck < ActiveRecord::Base
+  include Rexport::DataFields
   belongs_to :enrollment
-
-  def SelfReferentialCheck.rexport_fields
-    'trick get_rexport_models into believing we are exportable'
-  end
 end