csvash 0.1.1 → 0.2

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 1.9.2
+  - 1.9.3

data/README.md

@@ -6,19 +6,56 @@ Csvash automates your CSV extraction by mapping its headers with the columns con
 
 Add this line to your application's Gemfile:
 
-    gem 'csvash'
+```ruby
+gem 'csvash'
+```
 
 And then execute:
 
-    $ bundle
+```
+$ bundle
+```
 
 Or install it yourself as:
 
-    $ gem install csvash
+```
+$ gem install csvash
+```
 
 ## Usage
 
-    Csvash.import_from_path '/path/of/your/file.csv'
+First of all you have to require it in your file:
+
+```ruby
+require 'csvash'
+```
+
+To get a collection of hashes containing the csv data you can call:
+
+```ruby
+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:
+
+```ruby
+Csvash.modelify '/path/of/your/file.csv', User
+```
+
+##Options
+
+There are some behavior options that can be changed with its initializer. To create it just type:
+
+```
+$ rails generate initializer csvash
+```
+
+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
+```
 
 ## Contributing
 
@@ -26,4 +63,4 @@ Or install it yourself as:
 2. Create your feature branch (`git checkout -b my-new-feature`)
 3. Commit your changes (`git commit -am 'Added some feature'`)
 4. Push to the branch (`git push origin my-new-feature`)
-5. Create new Pull Request
+5. Create new Pull Request

data/csvash.gemspec

@@ -3,12 +3,11 @@ require File.expand_path('../lib/csvash/version', __FILE__)
 
 Gem::Specification.new do |gem|
   gem.name          = "csvash"
-  gem.authors       = ["Lukas Alexandre"]
-  gem.email         = ["lukeskytm@gmail.com"]
+  gem.authors       = ["Lukas Alexandre", "Uriel Juliatti"]
+  gem.email         = ["lukeskytm@gmail.com", "uriel.juliattivalle@gmail.com"]
   gem.description   = %q{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.}
   gem.summary       = %q{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.}
   gem.homepage      = "https://github.com/lukasalexandre/csvash"
-
   gem.files         = `git ls-files`.split($\)
   gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
   gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})

data/lib/csvash/version.rb

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

data/lib/csvash.rb

@@ -1,8 +1,11 @@
-require "csvash/version"
+require 'csvash/version'
 require 'csv'
+require 'fileutils'
 
 module Csvash
-  # <b>DEPRECATED:</b> Please use <tt>useful</tt> instead.
+  class << self; attr_accessor :mass_assignment_safe end
+
+  # <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
@@ -14,18 +17,27 @@ module Csvash
     end
   end
 
-  def self.modelify(path, klass)
+  # <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)
-    params = import path do |collection, current_line|
-      collection << klass.new(current_line)
+    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
     end
   end
 
+
 private
-  def self.import(path, &block)
+
+  def self.import(path, *optionals, &block)
     cols = nil
-    first_line = true
     collection = []
+    first_line = true
 
     CSV.foreach(path, :encoding => "ISO-8859-1:UTF-8", :col_sep => "\;") do |line|
       if first_line
@@ -42,4 +54,65 @@ private
     end
     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 = ""
+    unless collection.empty?
+      # retrieving instance method names (getters)
+      collection.first.class.instance_methods(false).delete_if {|m| rows << m unless m.to_s.include?"=" }
+      begin
+        csv_return = nil
+        CSV.open(file, 'wb') do |csv|
+          csv << rows
+          collection.each do |item|
+            lines = []
+            rows.each {|attribute| lines << item.send(attribute)}
+            csv << lines
+          end
+          csv_return = csv
+        end
+        csv_return
+      rescue Errno::ENOENT => e
+        puts e
+      end
+    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)
+  def self.method_missing(method_name, *args)
+    super unless method_name =~ /^modelify_and_(\w+)$/
+    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
+  end
 end

data/lib/generators/initializer/USAGE

@@ -0,0 +1,8 @@
+Description:
+    Explain the generator
+
+Example:
+    rails generate initializer csvash
+
+    This will create:
+        config/initializers/csvash.rb

data/lib/generators/initializer/initializer_generator.rb

@@ -0,0 +1,7 @@
+class InitializerGenerator < Rails::Generators::NamedBase
+  source_root File.expand_path("../templates", __FILE__)
+
+  def copy_initializer_file
+    copy_file "csvash.rb", "config/initializers/csvash.rb"
+  end
+end

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

@@ -0,0 +1,2 @@
+# If set to true it will only retain fields that matches the class to be filled. Default is false.
+# Csvash.mass_assignment_safe = true

data/test/fixtures/example_mass_assignment.csv

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

data/test/modelifying_test.rb

@@ -1,33 +1,56 @@
 require 'minitest/spec'
 require 'minitest/autorun'
+require 'fileutils'
 require 'csvash'
 require "./test/test_helper"
 
 include TestHelper
 
 describe 'Modelifying' do
-  it "passing the class" do
-    cars_extracted = Csvash.modelify fetch_fixture_path('example.csv'), Car
-    car = Car.new(
-      year: '1997',
-      make: 'Ford',
-      model: 'E350',
-      description: 'ac, abs, moon',
-      price: '3000.00'
-    )
-    cars_extracted.first.instance_variables.each do |name|
-      cars_extracted.first.instance_variable_get(name).must_equal car.instance_variable_get(name)
+  describe "import" do
+    it "passing the class" do
+      cars_extracted = Csvash.modelify_and_import fetch_fixture_path('example.csv'), Car
+      car = Car.new(
+        year: '1997',
+        make: 'Ford',
+        model: 'E350',
+        description: 'ac, abs, moon',
+        price: '3000.00'
+      )
+      cars_extracted.first.instance_variables.each do |name|
+        cars_extracted.first.instance_variable_get(name).must_equal car.instance_variable_get(name)
+      end
+    end
+
+    it "Mass assignment Safe Mode ON" do
+      Csvash.mass_assignment_safe = true
+      cars_extracted = Csvash.modelify_and_import fetch_fixture_path('example_mass_assignment.csv'), Car
+    end
+  end
+  describe "export" do
+    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/'))
     end
   end
+
 end
 
 class Car
   def initialize(params)
-    self.year = params[:year]
-    self.make = params[:make]
-    self.model = params[:model]
-    self.description = params[:description]
-    self.price = params[:price]
+    params.each do |key, value|
+      self.public_send("#{key}=", value)
+    end
   end
   attr_accessor :year, :make, :model, :description, :price
 end

data/test/test_helper.rb

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

metadata

@@ -1,15 +1,16 @@
 --- !ruby/object:Gem::Specification
 name: csvash
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: '0.2'
   prerelease: 
 platform: ruby
 authors:
 - Lukas Alexandre
+- Uriel Juliatti
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-08-29 00:00:00.000000000 Z
+date: 2012-09-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -32,11 +33,14 @@ description: Csvash automates your CSV extraction by mapping its headers with th
   ruby models.
 email:
 - lukeskytm@gmail.com
+- uriel.juliattivalle@gmail.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- .DS_Store
 - .gitignore
+- .travis.yml
 - Gemfile
 - LICENSE
 - README.md
@@ -44,7 +48,15 @@ files:
 - csvash.gemspec
 - lib/csvash.rb
 - lib/csvash/version.rb
+- lib/generators/.DS_Store
+- lib/generators/initializer/.DS_Store
+- lib/generators/initializer/USAGE
+- lib/generators/initializer/initializer_generator.rb
+- lib/generators/initializer/templates/csvash.rb
+- test/.DS_Store
+- test/fixtures/.DS_Store
 - test/fixtures/example.csv
+- test/fixtures/example_mass_assignment.csv
 - test/fixtures/example_values.txt
 - test/hashifying_test.rb
 - test/modelifying_test.rb
@@ -75,7 +87,10 @@ specification_version: 3
 summary: 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.
 test_files:
+- test/.DS_Store
+- test/fixtures/.DS_Store
 - test/fixtures/example.csv
+- test/fixtures/example_mass_assignment.csv
 - test/fixtures/example_values.txt
 - test/hashifying_test.rb
 - test/modelifying_test.rb