csvash 0.2 → 1.0.0

data/README.md

@@ -36,12 +36,24 @@ To get a collection of hashes containing the csv data you can call:
 Csvash.hashify '/path/of/your/file.csv'
 ```
 
-If you prefer a collection of already filled objects from a specific class you can pass the csv path and the class:
+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:
 
 ```ruby
-Csvash.modelify '/path/of/your/file.csv', User
+Csvash.modelify_and_export '/path/to/file.csv', collection
 ```
 
+_Where **collection** is an array of User objects, for example_
+
+However, to import from a csv file you can pass the path where the file is allocated and a class, as usual:
+
+```ruby
+Csvash.modelify_and_import '/path/of/your/file.csv', User
+```
+
+_* 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:
@@ -54,7 +66,7 @@ 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.
-# Csvash.mass_assignment_safe = true
+# config.mass_assignment_safe = true
 ```
 
 ## Contributing

data/lib/csvash.rb

@@ -1,39 +1,34 @@
 require 'csvash/version'
 require 'csv'
-require 'fileutils'
 
 module Csvash
   class << self; attr_accessor :mass_assignment_safe end
+  @@mass_assignment_safe = false
 
-  # <b>DEPRECATED:</b> Please use <tt>hashify</tt> instead.
-  def self.import_from_path(path)
-    warn "[DEPRECATION] `import_from_path` is deprecated. Please use `hashify` instead."
-    hashify path
+  def self.setup
+    yield self
   end
 
+  def self.respond_to?(method)
+    (method =~ /^modelify_and_\w+$/) || super
+  end
+
+private
   def self.hashify(path)
     import path do |collection, current_line|
       collection << current_line
     end
   end
 
-  # <b>DEPRECATED:</b> Please use <tt>modelify_and_export</tt> or <tt>modelify_and_import</tt> instead.
   def self.modelify(path, klass, *args)
     klass = klass.to_s.classify.constantize if klass.is_a?(String) || klass.is_a?(Symbol)
     method = args.first
-    # rejecting attributes
-    unless method.is_a?Hash
-      self.public_send method , path, klass do |collection, current_line|
-        handle_mass_assignment(klass, current_line)
-        collection << klass.new(current_line)
-      end
-    else
+    self.public_send method, path, klass do |collection, current_line|
+      handle_mass_assignment(klass, current_line)
+      collection << klass.new(current_line)
     end
   end
 
-
-private
-
   def self.import(path, *optionals, &block)
     cols = nil
     collection = []
@@ -55,40 +50,32 @@ private
     collection
   end
 
-  def self.handle_mass_assignment(klass, line)
-    if mass_assignment_safe
-      attr_cols = klass.instance_methods(false)
-      line = line.delete_if {|col| !attr_cols.include? col}
-    end
-  end
-
   # generates a csv file into a given path
   # a path must be given (ex: *path/to/file.csv)
   def self.export(file, collection, &block)
-    rows = []
-    file = self.full_path(file)
-    fields = ""
+    file = full_path(file)
+
     unless collection.empty?
-      # retrieving instance method names (getters)
-      collection.first.class.instance_methods(false).delete_if {|m| rows << m unless m.to_s.include?"=" }
+      headers = retrieve_headers collection
       begin
-        csv_return = nil
-        CSV.open(file, 'wb') do |csv|
-          csv << rows
+        CSV.open(file, 'wb', :col_sep => "\;") do |csv|
+          csv << headers
           collection.each do |item|
-            lines = []
-            rows.each {|attribute| lines << item.send(attribute)}
-            csv << lines
+            csv << retrieve_fields(item, headers)
           end
-          csv_return = csv
         end
-        csv_return
       rescue Errno::ENOENT => e
         puts e
       end
     end
   end
 
+  def self.handle_mass_assignment(klass, line)
+    if mass_assignment_safe
+      attr_cols = klass.instance_methods(false)
+      line = line.delete_if { |col| !attr_cols.include? col }
+    end
+  end
 
   # shifts the method calling towards export() or import()
   # ex: modelify_and_import("path/to/file.csv", collection), modelify_and_export("path/to/custom_filename.csv", collection)
@@ -97,22 +84,22 @@ private
     Csvash.public_send(:modelify, *args, $1)
   end
 
-  # overriding respond_to method
-  def respond_to?(method)
-    (method =~ /^modelify_and_(\w+)$/) || super
-  end
-
   # creates the full path
   def self.full_path(file)
     splitted = file.split("/")
     current_file = file.split("/").last
     current_path = splitted.shift(splitted.size-1)
     current_full_path = current_path.join("/") + "/"
-    if File.directory?(current_full_path)
-      (current_full_path).concat(current_file)
-    else
-      FileUtils.mkdir_p(current_full_path)
-      (current_full_path).concat(current_file)
-    end
+
+    FileUtils.mkdir_p(current_full_path) unless File.directory? current_full_path
+    current_full_path.concat current_file
+  end
+
+  def self.retrieve_headers collection
+    collection.first.class.instance_methods(false).select { |m| m.to_s !~ /=$/ }
+  end
+
+  def self.retrieve_fields item, headers
+    headers.map { |attribute| item.public_send(attribute) }
   end
 end

data/lib/csvash/version.rb

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

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

@@ -1,2 +1,4 @@
-# If set to true it will only retain fields that matches the class to be filled. Default is false.
-# Csvash.mass_assignment_safe = true
+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
+end

data/test/modelifying_test.rb

@@ -1,6 +1,5 @@
 require 'minitest/spec'
 require 'minitest/autorun'
-require 'fileutils'
 require 'csvash'
 require "./test/test_helper"
 
@@ -23,24 +22,34 @@ describe 'Modelifying' do
     end
 
     it "Mass assignment Safe Mode ON" do
-      Csvash.mass_assignment_safe = true
+      Csvash.setup { |config| config.mass_assignment_safe = true }
       cars_extracted = Csvash.modelify_and_import fetch_fixture_path('example_mass_assignment.csv'), Car
     end
   end
   describe "export" do
+    before :each do
+      Dir.mkdir(fetch_fixture_path('tmp'))
+    end
+    after :each do
+      FileUtils.rm_rf fetch_fixture_path('tmp')
+    end
+
+    let(:cars_path) { fetch_fixture_path('tmp/cars.csv') }
+
     it "passing a collection of Car object" do
       cars = []
-      car = Car.new(
-        year: '1997',
-        make: 'Ford',
-        model: 'E350',
-        description: 'ac, abs, moon',
-        price: '3000.00'
-      )
-      cars << car
-      cars_exported = Csvash.modelify_and_export fetch_fixture_path('tmp/cars.csv'), cars
-      cars_exported.wont_be_nil
-      FileUtils.rm_rf(fetch_fixture_path('tmp/'))
+      3.times do
+        cars << Car.new(
+          year: '1997',
+          make: 'Ford',
+          model: 'E350',
+          description: 'ac, abs, moon',
+          price: '3000.00'
+        )
+      end
+      cars_exported = Csvash.modelify_and_export cars_path, cars
+      File.exists?(cars_path).must_equal true
+      File.stat(cars_path).size.must_equal 145
     end
   end
 

data/test/overrides_test.rb

@@ -0,0 +1,13 @@
+require 'minitest/spec'
+require 'minitest/autorun'
+require 'csvash'
+require "./test/test_helper"
+
+include TestHelper
+
+describe 'Overrides' do
+  it "checks for the import and export methods existence" do
+    Csvash.respond_to?('modelify_and_import').wont_equal false
+    Csvash.respond_to?('modelify_and_export').wont_equal false
+  end
+end

data/test/test_helper.rb

@@ -4,5 +4,4 @@ module TestHelper
   def fetch_fixture_path(path)
     File.join(BASE_PATH, path)
   end
-
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: csvash
 version: !ruby/object:Gem::Version
-  version: '0.2'
+  version: 1.0.0
   prerelease: 
 platform: ruby
 authors:
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-09-11 00:00:00.000000000 Z
+date: 2012-09-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -60,6 +60,7 @@ files:
 - test/fixtures/example_values.txt
 - test/hashifying_test.rb
 - test/modelifying_test.rb
+- test/overrides_test.rb
 - test/test_helper.rb
 homepage: https://github.com/lukasalexandre/csvash
 licenses: []
@@ -94,4 +95,5 @@ test_files:
 - test/fixtures/example_values.txt
 - test/hashifying_test.rb
 - test/modelifying_test.rb
+- test/overrides_test.rb
 - test/test_helper.rb