csvash 1.0.0 → 1.1.1

data/README.md

@@ -1,6 +1,7 @@
 # Csvash
 
-Csvash automates your CSV extraction by mapping its headers with the columns contents and turning them into hashes that can be easily converted into ruby models.
+Got tired of parsing CSV files to your Models, or exporting into it?
+Csvash automates that process for you. It handles your CSV extraction by mapping the document headers with your model properties and automagically creating new filled instances.
 
 ## Installation
 
@@ -16,7 +17,7 @@ And then execute:
 $ bundle
 ```
 
-Or install it yourself as:
+Not using Rails? install it yourself with:
 
 ```
 $ gem install csvash
@@ -30,30 +31,27 @@ First of all you have to require it in your file:
 require 'csvash'
 ```
 
-To get a collection of hashes containing the csv data you can call:
+In order to import from a CSV file you can pass the path where the file is allocated and a class:
 
 ```ruby
-Csvash.hashify '/path/of/your/file.csv'
+Csvash.modelify_and_import '/path/of/your/file.csv', User
 ```
 
-Note: You can use `modelify_and_export` or `modelify_and_import` methods to generate or parse csv files respectively.
-
-In order to export, you can pass the desired path and CSV filename. Finally, you can pass a collection of already filled objects from a specific class you can pass the array:
+However, to export you can pass the desired path and CSV filename. Finally, you can pass a collection of already filled objects from a specific class:
 
 ```ruby
 Csvash.modelify_and_export '/path/to/file.csv', collection
 ```
 
 _Where **collection** is an array of User objects, for example_
+_* The path and its directories are created automatically_
 
-However, to import from a csv file you can pass the path where the file is allocated and a class, as usual:
+To get just a collection of hashes containing the csv data you can call:
 
 ```ruby
-Csvash.modelify_and_import '/path/of/your/file.csv', User
+Csvash.hashify '/path/of/your/file.csv'
 ```
 
-_* The path and its directories are created automatically_
-
 ##Options
 
 There are some behavior options that can be changed with its initializer. To create it just type:
@@ -67,6 +65,9 @@ These are the avaiable options
 ```ruby
 # If set to true it will only retain fields that matches the class to be filled. Default is false.
 # config.mass_assignment_safe = true
+
+# Defines the default column separator to be used. Default is ';'
+# column_separator = ';'
 ```
 
 ## Contributing

data/lib/csvash/version.rb

@@ -1,3 +1,3 @@
 module Csvash
-  VERSION = "1.0.0"
+  VERSION = "1.1.1"
 end

data/lib/csvash.rb

@@ -2,8 +2,11 @@ require 'csvash/version'
 require 'csv'
 
 module Csvash
-  class << self; attr_accessor :mass_assignment_safe end
-  @@mass_assignment_safe = false
+  class << self
+    attr_accessor :mass_assignment_safe, :column_separator
+  end
+  self.mass_assignment_safe = false
+  self.column_separator = ";"
 
   def self.setup
     yield self
@@ -34,7 +37,7 @@ private
     collection = []
     first_line = true
 
-    CSV.foreach(path, :encoding => "ISO-8859-1:UTF-8", :col_sep => "\;") do |line|
+    CSV.foreach(path, :encoding => "ISO-8859-1:UTF-8", :col_sep => self.column_separator) do |line|
       if first_line
         # getting colum names and turning them into symbols
         cols = line.map! { |c| c.downcase.to_sym }
@@ -58,7 +61,7 @@ private
     unless collection.empty?
       headers = retrieve_headers collection
       begin
-        CSV.open(file, 'wb', :col_sep => "\;") do |csv|
+        CSV.open(file, 'wb', :col_sep => self.column_separator) do |csv|
           csv << headers
           collection.each do |item|
             csv << retrieve_fields(item, headers)

data/lib/generators/initializer/templates/csvash.rb

@@ -1,4 +1,7 @@
 Csvash.setup do |config|
   # If set to true it will only retain fields that matches the class to be filled. Default is false.
   # config.mass_assignment_safe = true
+
+  # Defines the default column separator to be used. Default is ';'
+  # column_separator = ';'
 end

data/test/fixtures/example_comma.csv

@@ -0,0 +1,5 @@
+Year,Make,Model,Description,Price
+1997,Ford,E350,"ac, abs, moon",3000.00
+1999,"Chevy","Venture Extended Edition","",4900.00
+1999,"Chevy","Venture Extended Edition","Very Large","",5000.00
+1996,"Jeep","Grand Cherokee","MUST SELL! air, moon roof, loaded",4799.00

data/test/modelifying_test.rb

@@ -7,6 +7,12 @@ include TestHelper
 
 describe 'Modelifying' do
   describe "import" do
+    before :each do
+      Csvash.setup do |config|
+        config.mass_assignment_safe = false
+        config.column_separator = ";"
+      end
+    end
     it "passing the class" do
       cars_extracted = Csvash.modelify_and_import fetch_fixture_path('example.csv'), Car
       car = Car.new(
@@ -25,6 +31,11 @@ describe 'Modelifying' do
       Csvash.setup { |config| config.mass_assignment_safe = true }
       cars_extracted = Csvash.modelify_and_import fetch_fixture_path('example_mass_assignment.csv'), Car
     end
+
+    it "Changing default column separator" do
+      Csvash.setup { |config| config.column_separator = "," }
+      cars_extracted = Csvash.modelify_and_import fetch_fixture_path('example_comma.csv'), Car
+    end
   end
   describe "export" do
     before :each do

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: csvash
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.1
   prerelease: 
 platform: ruby
 authors:
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-09-27 00:00:00.000000000 Z
+date: 2012-10-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -56,6 +56,7 @@ files:
 - test/.DS_Store
 - test/fixtures/.DS_Store
 - test/fixtures/example.csv
+- test/fixtures/example_comma.csv
 - test/fixtures/example_mass_assignment.csv
 - test/fixtures/example_values.txt
 - test/hashifying_test.rb
@@ -91,6 +92,7 @@ test_files:
 - test/.DS_Store
 - test/fixtures/.DS_Store
 - test/fixtures/example.csv
+- test/fixtures/example_comma.csv
 - test/fixtures/example_mass_assignment.csv
 - test/fixtures/example_values.txt
 - test/hashifying_test.rb