blythedunham-ar_dumper 1.2.0.1

data/lib/ar_dumper_controller.rb

@@ -0,0 +1,52 @@
+class ActionController::Base
+
+  #Change to :file to use regular files
+  cattr_accessor :dumper_target
+  @@dumper_target = :tmp_file
+  
+  
+  # send a dumped file
+  # Options are:
+  # <tt>klass</tt> - the active record to use. Animal or Contact or Author or Tumama
+  # <tt>send_options</tt> send_options include send_file options such as <tt>:type</tt> and <tt>:disposition</tt>
+  # <tt>dump_options</tt> options to send to the dumper. These options are in <tt>ArDumper.dump_to_csv</tt>
+  # * <tt>:find</tt> - a map of the finder options passed to find. For example, <tt>{:conditions => ['features.hair = ?', 'blonde'], :include => :features}</tt>
+  # * <tt>:header</tt> - when a hash is specified, maps the field name to the header name. For example <tt>{:a => 'COL A', :b => 'COL B'}</tt> would print 'COL A', 'COL B'
+  #                      when an array is specified uses this instead of the fields
+  #                      when true or by default prints the fields
+  #                      when false does not include a header
+  # * <tt>:csv</tt> - any options to pass to csv parser. Example <tt> :csv => { :col_sep => "\t" }</tt>
+  # * <tt>:xml</tt> - any options to pass to xml parser. Example <tt> :xml => { :indent => 4 }    </tt>
+  # * <tt>:page_size</tt> - the page size to use. Defaults to dumper_page_size or 50
+  def send_file_dump(format, klass, send_options={}, dump_options={})
+
+    #use the base name of the dump file name if specified
+    send_options[:filename] ||= File.basename(dump_options[:filename]) if dump_options[:filename]
+    
+    #never delete the file
+    dump_options[:delete_file] = false
+    
+    #use temporary files unless otherwise specified
+    dump_options[:target_type]||= @@dumper_target
+        
+    #send_options[:type] = 'application/xml; charset=utf-8;'
+    if send_options[:type].nil? && send_options[:disposition] == 'inline'
+      send_options[:type] =
+        case format.to_sym
+          when :xml then 'application/xml; charset=utf-8;'
+          when :csv then 'application/csv; charset=utf-8;'
+          when :yml then 'text/html; charset=utf-8;'
+        end
+
+    end
+
+    target = klass.dumper(format, dump_options)
+    
+    if dump_options[:target_type] == :string
+      send_data(target, send_options)
+    else
+      send_file(target, send_options)
+    end
+  end
+ 
+end

data/lib/xml_serializer_dumper_support.rb

@@ -0,0 +1,49 @@
+# Add support to ActiveRecord::XmlSerializer to have value based tags
+class ActiveRecord::XmlSerializer
+  #Add ability to set margin with options to serializer
+  def builder_with_margin#:nodoc:
+    @builder ||= begin
+      options[:indent] ||= 2
+      options[:margin] ||= 0
+      builder = options[:builder] ||= Builder::XmlMarkup.new(:indent => options[:indent], :margin => options[:margin])
+
+      unless options[:skip_instruct]
+        builder.instruct!
+        options[:skip_instruct] = true
+      end
+
+      builder
+    end
+  end
+
+  alias_method_chain :builder, :margin
+
+  # Adds a tag based on the name and value and the serializer options
+  # Decorations for the tag are derived from the value type
+  #
+  #  add_tag_for_value('my_tag', "some data")
+  #  # XML: <my-tag>some data</my-tag>
+  def add_tag_for_value(name, value)
+    add_tag(ValueAttribute.new(name, @record, value))
+  end
+  
+
+  # An attribute where the type and value are based on the
+  # values when created
+  class ValueAttribute < Attribute
+    def initialize(name, record, value)
+      @value = value
+      super(name, record)
+    end
+
+    def compute_value#:nodoc:
+      @value
+    end
+
+    def compute_type#:nodoc:
+      Hash::XML_TYPE_NAMES[@value.class.name] || :string
+    end
+  end
+end
+
+#ActiveRecord::XmlSerializer.send :include, XmlSerializerDumperSupport unless ActiveRecord.respond_to?(:add_procs_with_record)

data/test/ar_dumper_controller_test.rb

@@ -0,0 +1,10 @@
+require File.join( File.dirname( __FILE__ ), 'test_helper' )
+
+class ArDumperControllerTest < TestCaseSuperClass
+  fixtures :books
+
+  def test_dumper_should_dump_csv
+    assert(true)
+  end
+
+end

data/test/ar_dumper_test.rb

@@ -0,0 +1,101 @@
+require File.join( File.dirname( __FILE__ ), 'test_helper' )
+
+class ArDumperTest< TestCaseSuperClass
+
+  fixtures :books, :topics
+
+  #This allows us to easily create tests for all three output types
+  def self.add_dump_test(options={})
+    proc = options[:dump_options].delete(:procs) if options[:dump_options] && options[:dump_options][:procs]
+    dump_options_str = (options[:dump_options]||{}).inspect
+
+    if proc
+      proc_str = proc.collect{|k,v| "#{k.inspect} => #{v}"}.join(',')
+      dump_options_str.gsub!(/\}$/, ", :procs => { #{proc_str} } }")
+      dump_options_str.gsub!(/^\{,/, '{')
+    end
+
+    %w(xml yml csv).each do |export_type|
+
+      new_method = %{
+        def test_dumper_should_#{options[:name]||options[:expected_result]}_#{export_type}
+          file_name = Book.dumper :#{export_type}, #{dump_options_str}
+           result_file = assert_result_files(file_name, :expected_results => '#{options[:expected_result]}.#{export_type}',
+                          :file_name_match => /ardumper\\.book\\.\\d+\\.\\d+\\.#{export_type}/).first
+        end
+      }
+      #puts new_method
+      class_eval new_method, __FILE__, __LINE__
+    end
+  end
+
+  def setup
+    super
+    FileUtils.rm_r ArDumper.dumper_file_path, :force => true
+    FileUtils.mkdir_p ArDumper.dumper_file_path
+  end
+
+  def teardown
+    super
+    FileUtils.rm_r ArDumper.dumper_file_path
+  end
+
+  add_dump_test :name => 'dump', :expected_result => 'all_books'
+  add_dump_test :name => 'dump_second_book', :expected_result => 'second_book',
+                :dump_options => {:find => {:conditions => 'id = 2'}}
+  
+
+  add_dump_test :name => 'dump_only_option', :expected_result => 'only_title_and_author',
+                :dump_options => {:only => [:title, :author_name]}
+
+
+  add_dump_test :name => 'dump_except_option', :expected_result => 'except_title_and_author',
+                :dump_options => {:except => [:title, :author_name]}
+
+  
+  add_dump_test :name => 'dump_only_and_method', :expected_result => 'topic_name',
+                :dump_options => {:only => [:title, :author_name], :methods => [:topic_name]}
+
+  add_dump_test(:name => 'dump_custom_proc', :expected_result => 'proc',
+                 :dump_options => {
+                        :find => {:conditions => 'id in (3,4)'},
+                        :only => [:author_name],
+                        :procs => {:topic_content => "Proc.new{|options|  options[:record].topic ? options[:record].topic.content : 'NO CONTENT' }"}})
+                      
+
+  protected
+
+  def parse_csv( csv )
+    parsed_csv = FasterCSV.parse( csv )
+    headers = parsed_csv.first
+    data = parsed_csv[1..-1]
+    OpenStruct.new :headers=>headers, :data=>data, :size=>parsed_csv.size
+  end
+
+  def result_dir
+    @result_dir ||= File.expand_path(File.join(File.dirname( __FILE__ ), 'data', 'results'))
+  end
+
+  def assert_result_files(file_name, options={})
+    
+    assert_equal(result_dir, File.expand_path(File.dirname(file_name)))
+    assert file_name =~ options[:file_name_match], "File name #{file_name} did not match #{options[:file_name_match].inspect}" if options[:file_name_match]
+    
+    result_files = Dir.glob(File.join(ArDumper.dumper_file_path, '*'))
+
+    assert_equal(options[:file_count]||1, result_files.length)
+
+    if options[:expected_results]
+      assert_equal(File.read(expected_results_file(options[:expected_results])),
+                   File.read(result_files.first))
+    end
+    
+    result_files
+  end
+
+  def expected_results_file(file_name)
+    @expected_results_dir ||= File.expand_path(File.join(File.dirname( __FILE__ ), 'data', 'expected_results'))
+    File.join(@expected_results_dir, file_name)
+  end
+  
+end

data/test/data/expected_results/all_books.csv

@@ -0,0 +1,10 @@
+id,title,publisher,author_name,created_at,updated_at,topic_id,for_sale
+1,The Voyage of Jerle Shannara: Antrax,Del Rey,Terry Brooks,Sun Apr 12 21:17:34 -0600 2009,Sun Apr 12 21:17:34 -0600 2009,,true
+2,The Voyage of Jerle Shannara: Ilse Witch,Del Rey,Terry Brooks,Sun Apr 12 21:17:34 -0600 2009,Sun Apr 12 21:17:34 -0600 2009,,false
+3,The Voyage of Jerle Shannara: Jarka Ruus,Del Rey,Terry Brooks,Sun Apr 12 21:17:34 -0600 2009,Sun Apr 12 21:17:34 -0600 2009,,true
+4,The Voyage of Jerle Shannara: Morgwar,Del Rey,Terry Brooks,Sun Apr 12 21:17:34 -0600 2009,Sun Apr 12 21:17:34 -0600 2009,4,true
+5,Circle At Center,ACE Fantasy,Douglas Niles,Sun Apr 12 21:17:34 -0600 2009,Sun Apr 12 21:17:34 -0600 2009,,true
+6,WISDOM for the way,Hallmark Books,Charles R. Swindoll,Sun Apr 12 21:17:34 -0600 2009,Sun Apr 12 21:17:34 -0600 2009,,true
+7,High Tech Startup,Free Press,John L. Neshem,Sun Apr 12 21:17:34 -0600 2009,Sun Apr 12 21:17:34 -0600 2009,,true
+8,The Two Swords,Forgotten Realms,R.A. Salvatore,Sun Apr 12 21:17:34 -0600 2009,Sun Apr 12 21:17:34 -0600 2009,,true
+9,Come Thirsty,W Publishing Group,Max Lucado,Sun Apr 12 21:17:34 -0600 2009,Sun Apr 12 21:17:34 -0600 2009,,true

data/test/data/expected_results/all_books.xml

@@ -0,0 +1,93 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<books>
+  <book>
+    <author-name>Terry Brooks</author-name>
+    <created-at type="datetime">2009-04-12T21:17:34-06:00</created-at>
+    <for-sale type="boolean">true</for-sale>
+    <id type="integer">1</id>
+    <publisher>Del Rey</publisher>
+    <title>The Voyage of Jerle Shannara: Antrax</title>
+    <topic-id type="integer" nil="true"></topic-id>
+    <updated-at type="datetime">2009-04-12T21:17:34-06:00</updated-at>
+  </book>
+  <book>
+    <author-name>Terry Brooks</author-name>
+    <created-at type="datetime">2009-04-12T21:17:34-06:00</created-at>
+    <for-sale type="boolean">false</for-sale>
+    <id type="integer">2</id>
+    <publisher>Del Rey</publisher>
+    <title>The Voyage of Jerle Shannara: Ilse Witch</title>
+    <topic-id type="integer" nil="true"></topic-id>
+    <updated-at type="datetime">2009-04-12T21:17:34-06:00</updated-at>
+  </book>
+  <book>
+    <author-name>Terry Brooks</author-name>
+    <created-at type="datetime">2009-04-12T21:17:34-06:00</created-at>
+    <for-sale type="boolean">true</for-sale>
+    <id type="integer">3</id>
+    <publisher>Del Rey</publisher>
+    <title>The Voyage of Jerle Shannara: Jarka Ruus</title>
+    <topic-id type="integer" nil="true"></topic-id>
+    <updated-at type="datetime">2009-04-12T21:17:34-06:00</updated-at>
+  </book>
+  <book>
+    <author-name>Terry Brooks</author-name>
+    <created-at type="datetime">2009-04-12T21:17:34-06:00</created-at>
+    <for-sale type="boolean">true</for-sale>
+    <id type="integer">4</id>
+    <publisher>Del Rey</publisher>
+    <title>The Voyage of Jerle Shannara: Morgwar</title>
+    <topic-id type="integer">4</topic-id>
+    <updated-at type="datetime">2009-04-12T21:17:34-06:00</updated-at>
+  </book>
+  <book>
+    <author-name>Douglas Niles</author-name>
+    <created-at type="datetime">2009-04-12T21:17:34-06:00</created-at>
+    <for-sale type="boolean">true</for-sale>
+    <id type="integer">5</id>
+    <publisher>ACE Fantasy</publisher>
+    <title>Circle At Center</title>
+    <topic-id type="integer" nil="true"></topic-id>
+    <updated-at type="datetime">2009-04-12T21:17:34-06:00</updated-at>
+  </book>
+  <book>
+    <author-name>Charles R. Swindoll</author-name>
+    <created-at type="datetime">2009-04-12T21:17:34-06:00</created-at>
+    <for-sale type="boolean">true</for-sale>
+    <id type="integer">6</id>
+    <publisher>Hallmark Books</publisher>
+    <title>WISDOM for the way</title>
+    <topic-id type="integer" nil="true"></topic-id>
+    <updated-at type="datetime">2009-04-12T21:17:34-06:00</updated-at>
+  </book>
+  <book>
+    <author-name>John L. Neshem</author-name>
+    <created-at type="datetime">2009-04-12T21:17:34-06:00</created-at>
+    <for-sale type="boolean">true</for-sale>
+    <id type="integer">7</id>
+    <publisher>Free Press</publisher>
+    <title>High Tech Startup</title>
+    <topic-id type="integer" nil="true"></topic-id>
+    <updated-at type="datetime">2009-04-12T21:17:34-06:00</updated-at>
+  </book>
+  <book>
+    <author-name>R.A. Salvatore</author-name>
+    <created-at type="datetime">2009-04-12T21:17:34-06:00</created-at>
+    <for-sale type="boolean">true</for-sale>
+    <id type="integer">8</id>
+    <publisher>Forgotten Realms</publisher>
+    <title>The Two Swords</title>
+    <topic-id type="integer" nil="true"></topic-id>
+    <updated-at type="datetime">2009-04-12T21:17:34-06:00</updated-at>
+  </book>
+  <book>
+    <author-name>Max Lucado</author-name>
+    <created-at type="datetime">2009-04-12T21:17:34-06:00</created-at>
+    <for-sale type="boolean">true</for-sale>
+    <id type="integer">9</id>
+    <publisher>W Publishing Group</publisher>
+    <title>Come Thirsty</title>
+    <topic-id type="integer" nil="true"></topic-id>
+    <updated-at type="datetime">2009-04-12T21:17:34-06:00</updated-at>
+  </book>
+</books>

data/test/data/expected_results/all_books.yml

@@ -0,0 +1,90 @@
+--- 
+book_1: 
+  topic_id: ""
+  updated_at: Sun Apr 12 21:17:34 -0600 2009
+  author_name: Terry Brooks
+  title: "The Voyage of Jerle Shannara: Antrax"
+  id: "1"
+  publisher: Del Rey
+  for_sale: "true"
+  created_at: Sun Apr 12 21:17:34 -0600 2009
+
+book_2: 
+  topic_id: ""
+  updated_at: Sun Apr 12 21:17:34 -0600 2009
+  author_name: Terry Brooks
+  title: "The Voyage of Jerle Shannara: Ilse Witch"
+  id: "2"
+  publisher: Del Rey
+  for_sale: "false"
+  created_at: Sun Apr 12 21:17:34 -0600 2009
+
+book_3: 
+  topic_id: ""
+  updated_at: Sun Apr 12 21:17:34 -0600 2009
+  author_name: Terry Brooks
+  title: "The Voyage of Jerle Shannara: Jarka Ruus"
+  id: "3"
+  publisher: Del Rey
+  for_sale: "true"
+  created_at: Sun Apr 12 21:17:34 -0600 2009
+
+book_4: 
+  topic_id: "4"
+  updated_at: Sun Apr 12 21:17:34 -0600 2009
+  author_name: Terry Brooks
+  title: "The Voyage of Jerle Shannara: Morgwar"
+  id: "4"
+  publisher: Del Rey
+  for_sale: "true"
+  created_at: Sun Apr 12 21:17:34 -0600 2009
+
+book_5: 
+  topic_id: ""
+  updated_at: Sun Apr 12 21:17:34 -0600 2009
+  author_name: Douglas Niles
+  title: Circle At Center
+  id: "5"
+  publisher: ACE Fantasy
+  for_sale: "true"
+  created_at: Sun Apr 12 21:17:34 -0600 2009
+
+book_6: 
+  topic_id: ""
+  updated_at: Sun Apr 12 21:17:34 -0600 2009
+  author_name: Charles R. Swindoll
+  title: WISDOM for the way
+  id: "6"
+  publisher: Hallmark Books
+  for_sale: "true"
+  created_at: Sun Apr 12 21:17:34 -0600 2009
+
+book_7: 
+  topic_id: ""
+  updated_at: Sun Apr 12 21:17:34 -0600 2009
+  author_name: John L. Neshem
+  title: High Tech Startup
+  id: "7"
+  publisher: Free Press
+  for_sale: "true"
+  created_at: Sun Apr 12 21:17:34 -0600 2009
+
+book_8: 
+  topic_id: ""
+  updated_at: Sun Apr 12 21:17:34 -0600 2009
+  author_name: R.A. Salvatore
+  title: The Two Swords
+  id: "8"
+  publisher: Forgotten Realms
+  for_sale: "true"
+  created_at: Sun Apr 12 21:17:34 -0600 2009
+
+book_9: 
+  topic_id: ""
+  updated_at: Sun Apr 12 21:17:34 -0600 2009
+  author_name: Max Lucado
+  title: Come Thirsty
+  id: "9"
+  publisher: W Publishing Group
+  for_sale: "true"
+  created_at: Sun Apr 12 21:17:34 -0600 2009

data/test/data/expected_results/except_title_and_author.csv

@@ -0,0 +1,10 @@
+id,publisher,created_at,updated_at,topic_id,for_sale
+1,Del Rey,Sun Apr 12 21:17:34 -0600 2009,Sun Apr 12 21:17:34 -0600 2009,,true
+2,Del Rey,Sun Apr 12 21:17:34 -0600 2009,Sun Apr 12 21:17:34 -0600 2009,,false
+3,Del Rey,Sun Apr 12 21:17:34 -0600 2009,Sun Apr 12 21:17:34 -0600 2009,,true
+4,Del Rey,Sun Apr 12 21:17:34 -0600 2009,Sun Apr 12 21:17:34 -0600 2009,4,true
+5,ACE Fantasy,Sun Apr 12 21:17:34 -0600 2009,Sun Apr 12 21:17:34 -0600 2009,,true
+6,Hallmark Books,Sun Apr 12 21:17:34 -0600 2009,Sun Apr 12 21:17:34 -0600 2009,,true
+7,Free Press,Sun Apr 12 21:17:34 -0600 2009,Sun Apr 12 21:17:34 -0600 2009,,true
+8,Forgotten Realms,Sun Apr 12 21:17:34 -0600 2009,Sun Apr 12 21:17:34 -0600 2009,,true
+9,W Publishing Group,Sun Apr 12 21:17:34 -0600 2009,Sun Apr 12 21:17:34 -0600 2009,,true

data/test/data/expected_results/except_title_and_author.xml

@@ -0,0 +1,75 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<books>
+  <book>
+    <created-at type="datetime">2009-04-12T21:17:34-06:00</created-at>
+    <for-sale type="boolean">true</for-sale>
+    <id type="integer">1</id>
+    <publisher>Del Rey</publisher>
+    <topic-id type="integer" nil="true"></topic-id>
+    <updated-at type="datetime">2009-04-12T21:17:34-06:00</updated-at>
+  </book>
+  <book>
+    <created-at type="datetime">2009-04-12T21:17:34-06:00</created-at>
+    <for-sale type="boolean">false</for-sale>
+    <id type="integer">2</id>
+    <publisher>Del Rey</publisher>
+    <topic-id type="integer" nil="true"></topic-id>
+    <updated-at type="datetime">2009-04-12T21:17:34-06:00</updated-at>
+  </book>
+  <book>
+    <created-at type="datetime">2009-04-12T21:17:34-06:00</created-at>
+    <for-sale type="boolean">true</for-sale>
+    <id type="integer">3</id>
+    <publisher>Del Rey</publisher>
+    <topic-id type="integer" nil="true"></topic-id>
+    <updated-at type="datetime">2009-04-12T21:17:34-06:00</updated-at>
+  </book>
+  <book>
+    <created-at type="datetime">2009-04-12T21:17:34-06:00</created-at>
+    <for-sale type="boolean">true</for-sale>
+    <id type="integer">4</id>
+    <publisher>Del Rey</publisher>
+    <topic-id type="integer">4</topic-id>
+    <updated-at type="datetime">2009-04-12T21:17:34-06:00</updated-at>
+  </book>
+  <book>
+    <created-at type="datetime">2009-04-12T21:17:34-06:00</created-at>
+    <for-sale type="boolean">true</for-sale>
+    <id type="integer">5</id>
+    <publisher>ACE Fantasy</publisher>
+    <topic-id type="integer" nil="true"></topic-id>
+    <updated-at type="datetime">2009-04-12T21:17:34-06:00</updated-at>
+  </book>
+  <book>
+    <created-at type="datetime">2009-04-12T21:17:34-06:00</created-at>
+    <for-sale type="boolean">true</for-sale>
+    <id type="integer">6</id>
+    <publisher>Hallmark Books</publisher>
+    <topic-id type="integer" nil="true"></topic-id>
+    <updated-at type="datetime">2009-04-12T21:17:34-06:00</updated-at>
+  </book>
+  <book>
+    <created-at type="datetime">2009-04-12T21:17:34-06:00</created-at>
+    <for-sale type="boolean">true</for-sale>
+    <id type="integer">7</id>
+    <publisher>Free Press</publisher>
+    <topic-id type="integer" nil="true"></topic-id>
+    <updated-at type="datetime">2009-04-12T21:17:34-06:00</updated-at>
+  </book>
+  <book>
+    <created-at type="datetime">2009-04-12T21:17:34-06:00</created-at>
+    <for-sale type="boolean">true</for-sale>
+    <id type="integer">8</id>
+    <publisher>Forgotten Realms</publisher>
+    <topic-id type="integer" nil="true"></topic-id>
+    <updated-at type="datetime">2009-04-12T21:17:34-06:00</updated-at>
+  </book>
+  <book>
+    <created-at type="datetime">2009-04-12T21:17:34-06:00</created-at>
+    <for-sale type="boolean">true</for-sale>
+    <id type="integer">9</id>
+    <publisher>W Publishing Group</publisher>
+    <topic-id type="integer" nil="true"></topic-id>
+    <updated-at type="datetime">2009-04-12T21:17:34-06:00</updated-at>
+  </book>
+</books>