Returns information should be in the readme

[globalkeith]

Hey, great gem.

Just wanted to suggest that the returns stuff is added to the readme/examples.

I was just about to fork to implement this functionality but I see its already been done, just not mentioned in the help file.

thanks

[p-becker]

I just added a small Paragraph at the bottom of this Wiki page: https://github.com/zdennis/activerecord-import/wiki/Supported-Database-Adapters

Was this the right thing to do? And does this sufficiently document the methods?

[dillonwelch]

@jkowens I'm a little confused on what this one is asking for? Do you have a little more guidance on what needs to be added/copied over into the README file?

[jkowens]

The link above was outdated, here is the return object that I believe this was referring to:

activerecord-import/lib/activerecord-import/import.rb

Line 6 in 506f765

Result = Struct.new(:failed_instances, :num_inserts, :ids, :results)

activerecord-import/lib/activerecord-import/import.rb

Line 485 in 506f765

# This returns an object which responds to +failed_instances+ and +num_inserts+.

[dillonwelch]

It seems like the best way would be to just update that one line to directly reference that Result object something like returns a Result. I'm not super duper familiar with Ruby documentation on how to make that automagically link up to that line, do you have an idea on how to do that or is it off to Google we go?

[dillonwelch]

Thoughts @jkowens ?

[jkowens]

Maybe we could just display sample return objects in the examples:

articles = [
  Article.new(author_id: 1, title: 'First Article', content: 'This is the first article'), 
  Article.new(author_id: 2, title: 'Second Article', content: ''),
  Article.new(author_id: 3, content: '')
]
Article.import articles, returning: :title # => #<struct ActiveRecord::Import::Result failed_instances=[#<Article id: 3, author_id: 3, title: nil, content: "", created_at: nil, updated_at: nil>], num_inserts=1, ids=["1", "2"], results=["First Article", "Second Article"]>

The ids and results attributes will only be useful for those using Postgres. They will just be empty arrays for MySQL and SQLite.