csv_creator 0.9.1 → 0.9.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 50fa518f5b034a07d9faed2f2553312ca89e1474
-  data.tar.gz: 789b0250a03153444bbd47ca2c0e15b3f9e21f68
+  metadata.gz: 77591e2a208645116ab085c32e1edf107e87d215
+  data.tar.gz: d32c84d8ed38cf004495eb7cd714ae33266532a1
 SHA512:
-  metadata.gz: bef1657c111cedc0c8f1a43ea81129a50f9c2d7a8f5ba6c18d9ce4c70196b7189b34f2562dfa0a5f30d602c3fbbe1a27df0991bb339998589937f5aae8d19e10
-  data.tar.gz: 6062236d4b0c8b626d2803d527072b247504ab7b1a3f9b2972a65e939baf8f5f341ce28dfcb6f10370ebbb550ca003c7e5efaac71109df74e84af2cdbc18829d
+  metadata.gz: b499241e9ddd19a1e1defc0c40820a6ad2279637c1c77a777d0b1d72823142624d06f7efe7cdac3d73307fe18a89e011c471f5c11f052aa6d3ee885555cffd62
+  data.tar.gz: 9d4c8ab2c0b8b9df2c4efa83dcb44169de4e1ba8e0e98be9db01d1042b61b9238ec67fc4ff7a792b5a19103b7c3c09b81c12f03384f77d4e1a65e2c0174748b8

data/README.md

@@ -1,6 +1,6 @@
 # CsvCreator
 
-Description
+CsvCreator provides nice, configurable interface which will generate CSV file for you, from collection you want (database or array with non-db related objects).
 
 ## Installation
 
@@ -20,17 +20,70 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+Basic usage with default options (see below) is just by calling `create` method on `CsvCreator` module.
+There is also an alias method `generate`. It does the same thing and takes the same arguments.
 
-## Development
+```ruby
+CsvCreator.create(my_collection)
+```
+
+### Options
+
+Options can be passed as second argument to the `create` method. The default options hash looks like this.
+```ruby
+{
+  csv: { force_quotes: true, headers: true },
+  only: nil,
+  without: nil,
+  order: [],
+  order_direction: :asc,
+  translate: {},
+  callbacks: {}
+}
+```
+
+### Options explanation
+
+* **csv** - In `csv` key you can pass all options that you would usually pass to the `CSV.generate`. 
+Yoo can find more about them under [this link](http://ruby-doc.org/stdlib-2.2.2/libdoc/csv/rdoc/CSV.html). Look for "DEFAULT_OPTIONS".
+```ruby
+CsvCreator.create(my_collection, { csv: { force_quotes: false } })
+```
+
+* **only** - It's self explanatory. By passing an array of field names you will get in your CSV data only for that fields.
+```ruby
+CsvCreator.create(my_collection, { only: [:id, :name] })
+```
 
-After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+* **without** - Like above, but this time, fields that are in the array passed under this key will be skipped during generation process.
+```ruby
+CsvCreator.create(my_collection, { without: [:id, :name] })
+```
 
-To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+* **order** - Makes sense only for collections that are not from database. Obviously it's way better to sort collection with use of database queries. But if you want, `CsvCreator` can sort given collection for you. Under the hood there is simple [sort_by](http://ruby-doc.org/core-2.2.2/Enumerable.html#method-i-sort_by) method.
+```ruby
+CsvCreator.create(my_collection, { order: [:name] })
+```
+
+* **order_direction** - If you defined some fields that you want to order by your collection, you can manipulate direction.
+```ruby
+CsvCreator.create(my_collection, { order: [:name], order_direction: :desc })
+```
+
+* **translate** - Useful if you want to somehow change how the column header will be displayed in the CSV document. Very useful for language translations.
+```ruby
+CsvCreator.create(my_collection, { translate: { name: 'Translated Name Field' })
+```
+
+* **callbacks** - Callbacks can help you with modifying result for each row exactly for the CSV document. For example by formatting date time field or some other calculations.
+```ruby
+options = { callbacks: { birth_date: ->(person) { person.birth_date.strftime('%m/%d/%Y') } } }
+CsvCreator.create(my_collection, options)
+```
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/csv_creator.
+Bug reports and pull requests are welcome on GitHub at https://github.com/dsawa/csv_creator.
 
 ## License
 

data/lib/csv_creator/creator.rb

@@ -1,3 +1,5 @@
+require 'csv'
+
 module CsvCreator
   class Creator
     attr_reader :collection

data/lib/csv_creator/version.rb

@@ -1,3 +1,3 @@
 module CsvCreator
-  VERSION = '0.9.1'
+  VERSION = '0.9.2'
 end

data/lib/csv_creator.rb

@@ -1,8 +1,6 @@
 require 'csv_creator/version'
 require 'csv_creator/creator'
-require 'csv'
 require 'active_support/core_ext/hash'
-require 'pry'
 
 module CsvCreator
   def self.create(collection, options = {})
@@ -18,4 +16,9 @@ module CsvCreator
 
     Creator.new(collection, options_with_defaults).generate_csv(options_with_defaults)
   end
+
+  # Alias
+  def self.generate(collection, options = {})
+    create(collection, options)
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: csv_creator
 version: !ruby/object:Gem::Version
-  version: 0.9.1
+  version: 0.9.2
 platform: ruby
 authors:
 - Dorian Sawa
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2015-06-14 00:00:00.000000000 Z
+date: 2015-06-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport