@@ -8,25 +8,14 @@ This simple plugin gives you the ability to call to_csv to a collection of activ @users = User.all # - # defaults are export header and all fields except id, and timestamps + # defaults are export headers and all fields # @users.to_csv @users.to_csv(:only => [:last_name, :role]) - @users.to_csv(:timestamps => true, :id => true, :header => false) + @users.to_csv(:headers => false) @users.to_csv(:except => [:last_name, :role]) - @users.to_csv(:except => :role, :methods => [:name, :admin?]) - - # - # NEW FEATURE - # Now you can call methods of a has_one or belongs_to association - # (for now you can go up/down 1 level) - # - - # A note belongs_to :user - @notes = Note.all - @notes.to_csv(:methods => [{:user => :name}]) - + @users.to_csv(:except => :role, :methods => :admin?) == Real life example @@ -73,7 +62,7 @@ I got ideas and influence from Mike Clarks recipe #35 in Rails Recipes book, som == Note Does not work on a single activerecord, ie, User.first.to_csv. -Cannot style output. + Copyright (c) 2008 Ary Djmal, released under the MIT license README.rdoc @@ -1,52 +1,26 @@ class Array def to_csv(options = {}) + return '' if self.empty? + + all_columns = self.first.class.columns.collect { |c| c.name.to_sym } + if options[:only] columns = options[:only].to_a else - columns = self.first.class.columns.collect {|c| c.name.to_sym} - options[:except].to_a - columns -= [:created_at, :updated_at] unless options[:timestamps] == true - columns -= [:id] unless options[:id] == true + columns = all_columns - options[:except].to_a end - # Expand methods, [{:user => [:name, :id]}] => [{:user => :name}, {:user => :id}] - if methods = options[:methods] - methods = methods.collect do |method| - if method.is_a?(Symbol) - method - else - if method[method.keys.first].is_a?(Array) - method[method.keys.first].collect {|association_method| [{method.keys.first => association_method}]} - else - method - end - end - end - columns << methods - end + columns = columns & all_columns + + columns += options[:methods].to_a - columns = columns.flatten + return '' if columns.empty? output = FasterCSV.generate do |csv| - - unless options[:header] == false - csv << columns.collect do |column| - if column.is_a?(Symbol) - column - else - "#{column.keys.first}_#{column[column.keys.first]}" - end - end - end - + csv << columns unless options[:headers] == false self.each do |item| - csv << columns.collect do |column| - if column.kind_of?(Hash) - item.send(column.keys.first).send(column[column.keys.first]) - else - item.send(column) - end - end + csv << columns.collect { |column| item.send(column) } end end lib/to_csv.rb @@ -12,20 +12,40 @@ class ToCsvTest < Test::Unit::TestCase @users << User.new(:id => 2, :name => 'Nati', :age => 21) end + def test_with_empty_array + assert_equal( "", [].to_csv ) + end + def test_with_no_options - assert_equal( "name,age\nAry,24\nNati,21\n", @users.to_csv ) + assert_equal( "id,name,age\n1,Ary,24\n2,Nati,21\n", @users.to_csv ) end - def test_with_id - assert_equal( "id,name,age\n1,Ary,24\n2,Nati,21\n", @users.to_csv(:id => true) ) + def test_with_no_headers + assert_equal( "1,Ary,24\n2,Nati,21\n", @users.to_csv(:headers => false) ) end def test_with_only assert_equal( "name\nAry\nNati\n", @users.to_csv(:only => :name) ) end + def test_with_empty_only + assert_equal( "", @users.to_csv(:only => "") ) + end + + def test_with_only_and_wrong_column_names + assert_equal( "name\nAry\nNati\n", @users.to_csv(:only => [:name, :yoyo]) ) + end + + def test_with_except + assert_equal( "age\n24\n21\n", @users.to_csv(:except => [:id, :name]) ) + end + + def test_with_except_and_only_should_listen_to_only + assert_equal( "name\nAry\nNati\n", @users.to_csv(:except => [:id, :name], :only => :name) ) + end + def test_with_except - assert_equal( "age\n24\n21\n", @users.to_csv(:except => :name) ) + assert_equal( "id,name,age,is_old?\n1,Ary,24,false\n2,Nati,21,false\n", @users.to_csv(:methods => [:is_old?]) ) end end test/to_csv_test.rb @@ -10,6 +10,10 @@ class User def self.columns COLUMNS.collect { |column| Column.new(column) } end + + def is_old? + age > 40 + end end class Column test/user_model.rb e718e58cac8e485a815e279ed01236106ee1f4fe Ary Djmal arydjmal@gmail.com http://github.com/arydjmal/to_csv/commit/6fbf202981c53c3b8f923baceb2d353bdcebd260 6fbf202981c53c3b8f923baceb2d353bdcebd260 2008-12-23T14:04:46-08:00 2008-12-23T14:04:46-08:00 removed ability to call methods of associations, this is against rails best practices; added more tests; d382fb333a22c1baf58893890f1a1b968413eada Ary Djmal arydjmal@gmail.com