acts_as_importable 0.2.0

data/Gemfile

@@ -0,0 +1,15 @@
+source "http://rubygems.org"
+# Add dependencies required to use your gem here.
+# Example:
+#   gem "activesupport", ">= 2.3.5"
+
+gem "activerecord", "~> 3.0.3"
+gem "actionpack", "~> 3.0.3"
+gem "fastercsv", "~> 1.5.3"
+
+# Add dependencies to develop your gem here.
+# Include everything needed to run rake, tests, features, etc.
+group :development do
+  gem "bundler", "~> 1.0.0"
+  gem "jeweler", "~> 1.5.2"
+end

data/Gemfile.lock

@@ -0,0 +1,52 @@
+GEM
+  remote: http://rubygems.org/
+  specs:
+    abstract (1.0.0)
+    actionpack (3.0.3)
+      activemodel (= 3.0.3)
+      activesupport (= 3.0.3)
+      builder (~> 2.1.2)
+      erubis (~> 2.6.6)
+      i18n (~> 0.4)
+      rack (~> 1.2.1)
+      rack-mount (~> 0.6.13)
+      rack-test (~> 0.5.6)
+      tzinfo (~> 0.3.23)
+    activemodel (3.0.3)
+      activesupport (= 3.0.3)
+      builder (~> 2.1.2)
+      i18n (~> 0.4)
+    activerecord (3.0.3)
+      activemodel (= 3.0.3)
+      activesupport (= 3.0.3)
+      arel (~> 2.0.2)
+      tzinfo (~> 0.3.23)
+    activesupport (3.0.3)
+    arel (2.0.6)
+    builder (2.1.2)
+    erubis (2.6.6)
+      abstract (>= 1.0.0)
+    fastercsv (1.5.3)
+    git (1.2.5)
+    i18n (0.5.0)
+    jeweler (1.5.2)
+      bundler (~> 1.0.0)
+      git (>= 1.2.5)
+      rake
+    rack (1.2.1)
+    rack-mount (0.6.13)
+      rack (>= 1.0.0)
+    rack-test (0.5.6)
+      rack (>= 1.0)
+    rake (0.8.7)
+    tzinfo (0.3.23)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  actionpack (~> 3.0.3)
+  activerecord (~> 3.0.3)
+  bundler (~> 1.0.0)
+  fastercsv (~> 1.5.3)
+  jeweler (~> 1.5.2)

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2010 Jagdeep Singh
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.rdoc

@@ -0,0 +1,90 @@
+= ActsAsImportable
+
+ActsAsImportable makes import/export of ActiveRecord models from csv files easier and less repetitive. It helps keep your code DRY, clean, and simple.
+
+== Usage
+
+=== Add the following to your controller:
+
+  acts_as_importable :product
+
+If model name is not specified, it will use the controller name to find the model name. So, the following is same as above if the controller name is "products"
+
+  acts_as_importable
+
+==== Scoping imported objects:
+
+  acts_as_importable :product, :scoped => :current_store
+
+This will import all material records within the current_store object returned by the controller#current_store method. Product should have a belongs_to association to Store for this feature to work.
+
+=== Add the following to your Model:
+
+  acts_as_importable :import_fields => ["name", "price"]
+
+This will populate the specified fields while importing the model records from csv.
+
+  acts_as_importable :import_fields => ["name", "price", "product_type.name"]
+
+If there is a field which is not a direct attribute or is an association eg. 'product_type.name' in the example above, you have to define a method like the following and it will be called while importing the data:
+
+  def assign_product_type(data_row)
+    name = data_row[2].strip
+    product_type = ProductType.find_by_name(name)
+    self.product_type_id = product_type.id if product_type
+  end
+
+NOTE: Any field which has a '.' in its name require a method with name like "assign_#{name_of_the_field}". Also as a parameter you get the entire row from the csv file. So you can operate on multiple columns to generate the value for this field.
+
+Another example of the method above:
+
+  def assign_category(data_row)
+    category = Category.find_by_name(data_row[3].strip)
+    self.category_id = category.id if category
+  end
+
+==== Customizing the export fields:
+
+You can specify a different list of fields to export if you want them to be different from the import fields e.g.
+
+  acts_as_importable :import_fields => ["name", "price", "product_type.name"],
+                     :export_fields => ["name", "product_type.name"]
+
+=== Add the following routes to your routes.rb:
+
+  resources :products do
+    collection do
+      post 'upload'
+      get 'import'
+      get 'export'
+    end
+  end
+
+=== Define the following constant (e.g. in an initializer):
+
+  UPLOADS_PATH = "#{Rails.root}/tmp/uploads"
+
+NOTE: This can be any file system path writable by the Rails process.
+
+== Contributing to acts_as_importable
+
+* Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet
+* Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it
+* Fork the project
+* Start a feature/bugfix branch
+* Commit and push until you are happy with your contribution
+* Make sure to add tests for it in the test/test_acts_as_importable project. This is important so I don't break it in a future version unintentionally.
+* Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.
+
+== Credit
+
+A big thanks goes to -
+
+* {Ennova}[http://ennova.com.au] for giving us an opportunity to extract and release this functionality as a gem for the larger community
+* {Bhavin Javia}[http://github.com/bhavinjavia] for helping with extracting, enhancing and releasing this gem
+
+== Copyright
+
+Copyright (c) 2010 Jagdeep Singh. See LICENSE.txt for
+further details.
+

data/Rakefile

@@ -0,0 +1,39 @@
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'rake'
+
+require 'jeweler'
+Jeweler::Tasks.new do |gem|
+  # gem is a Gem::Specification... see http://docs.rubygems.org/read/chapter/20 for more options
+  gem.name = "acts_as_importable"
+  gem.version = File.exist?('VERSION') ? File.read('VERSION') : ""
+  gem.homepage = "https://github.com/Ennova/acts_as_importable"
+  gem.license = "MIT"
+  gem.summary = %Q{Makes your model importable from .csv and exportable to .csv}
+  gem.description = %Q{Use this gem to add import/export to .csv functionality to your activerecord models}
+  gem.email = "jagdeepkh@gmail.com"
+  gem.authors = ["Jagdeep Singh"]
+  gem.files.exclude 'test'
+  gem.files.exclude '.rvmrc'
+  gem.files.exclude '.document'
+  gem.test_files.exclude 'test'
+end
+
+Jeweler::RubygemsDotOrgTasks.new
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "acts_as_importable #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.2.0

data/acts_as_importable.gemspec

@@ -0,0 +1,65 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{acts_as_importable}
+  s.version = "0.2.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Jagdeep Singh"]
+  s.date = %q{2011-01-02}
+  s.description = %q{Use this gem to add import/export to .csv functionality to your activerecord models}
+  s.email = %q{jagdeepkh@gmail.com}
+  s.extra_rdoc_files = [
+    "LICENSE.txt",
+    "README.rdoc"
+  ]
+  s.files = [
+    "Gemfile",
+    "Gemfile.lock",
+    "LICENSE.txt",
+    "README.rdoc",
+    "Rakefile",
+    "VERSION",
+    "acts_as_importable.gemspec",
+    "lib/acts_as_importable.rb",
+    "lib/import_export.rb",
+    "lib/import_export/controller_methods.rb",
+    "lib/import_export/routing.rb",
+    "lib/tasks/import_export.rake",
+    "views/import_export/import.html.erb"
+  ]
+  s.homepage = %q{https://github.com/Ennova/acts_as_importable}
+  s.licenses = ["MIT"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.7}
+  s.summary = %q{Makes your model importable from .csv and exportable to .csv}
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<activerecord>, ["~> 3.0.3"])
+      s.add_runtime_dependency(%q<actionpack>, ["~> 3.0.3"])
+      s.add_runtime_dependency(%q<fastercsv>, ["~> 1.5.3"])
+      s.add_development_dependency(%q<bundler>, ["~> 1.0.0"])
+      s.add_development_dependency(%q<jeweler>, ["~> 1.5.2"])
+    else
+      s.add_dependency(%q<activerecord>, ["~> 3.0.3"])
+      s.add_dependency(%q<actionpack>, ["~> 3.0.3"])
+      s.add_dependency(%q<fastercsv>, ["~> 1.5.3"])
+      s.add_dependency(%q<bundler>, ["~> 1.0.0"])
+      s.add_dependency(%q<jeweler>, ["~> 1.5.2"])
+    end
+  else
+    s.add_dependency(%q<activerecord>, ["~> 3.0.3"])
+    s.add_dependency(%q<actionpack>, ["~> 3.0.3"])
+    s.add_dependency(%q<fastercsv>, ["~> 1.5.3"])
+    s.add_dependency(%q<bundler>, ["~> 1.0.0"])
+    s.add_dependency(%q<jeweler>, ["~> 1.5.2"])
+  end
+end
+

data/lib/acts_as_importable.rb

@@ -0,0 +1,12 @@
+require "active_record"
+require "action_controller"
+require "fastercsv"
+
+require 'import_export'
+ActiveRecord::Base.send :include, ImportExport::ModelMethods
+
+# require 'import_export/routing'
+# ActionC::Routing::RouteSet::Mapper.send :include, ImportExport::Routing
+
+require 'import_export/controller_methods'
+ActionController::Base.send :include, ImportExport::ControllerMethods

data/lib/import_export/controller_methods.rb

@@ -0,0 +1,74 @@
+# ImportExport
+module ImportExport
+  module ControllerMethods
+
+    def self.included(base)
+      base.send :extend, ClassMethods
+    end
+
+    module ClassMethods
+      # any method placed here will apply to classes
+      def acts_as_importable(model_class_name = nil, context = {})
+        cattr_accessor :model_class
+        cattr_accessor :context
+        if model_class_name
+          self.model_class = model_class_name.to_s.classify.constantize
+        else
+          self.model_class = self.controller_name.singularize.classify.constantize
+        end
+        self.context = context
+        send :include, InstanceMethods
+      end
+    end
+
+    module InstanceMethods
+      def export
+        send_data self.class.model_class.export, :type => 'text/csv; charset=iso-8859-1; header=present', :disposition => "attachment; filename=#{export_file_name}"   
+      end
+
+      def import
+        @new_objects = []
+        filename = "#{UPLOADS_PATH}/#{self.controller_name}.csv"
+        context = {}
+        self.class.context.each_pair do |key, value|
+          context[key] = self.send(value)
+        end
+
+        if File.exists? filename
+          begin
+            @new_objects = self.class.model_class.import(filename, context)
+            flash[:notice] = "Import Successful - #{@new_objects.length} New #{self.class.model_class.name.underscore.humanize.pluralize}"
+          rescue Exception => e
+            logger.error "Error: Unable to process file. #{e}"
+            flash[:error] = "Error: Unable to process file. #{e}"
+          ensure
+            File.delete(filename)
+          end
+        else
+          @new_objects = []
+        end
+        render :template => "import_export/import"
+      end
+
+      def upload
+        require 'ftools'
+        if params[:csv_file] && File.extname(params[:csv_file].original_filename) == '.csv'
+          File.makedirs "#{UPLOADS_PATH}"
+          File.open("#{UPLOADS_PATH}/#{self.controller_name}.csv", "wb") { |f| f.write(params[:csv_file].read)}
+          flash[:notice] = "Successful import of #{self.controller_name} data file"
+        else
+          flash[:error] = "Error! Invalid file, please select a csv file."
+        end
+        redirect_to "/#{self.controller_name}/import"
+      end
+
+      private
+
+      def export_file_name
+        "#{Time.now.to_formatted_s(:number)}_#{self.controller_name}_export.csv"
+      end
+
+    end # end of module InstanceMethods
+
+  end # end of module ControllerMethods
+end

data/lib/import_export/routing.rb

@@ -0,0 +1,7 @@
+module ImportExport
+  module Routing
+    def import_export
+      # @set.add_route("/materials/import", {:controller => "materials", :action => "import"})
+    end
+  end
+end

data/lib/import_export.rb

@@ -0,0 +1,135 @@
+# ImportExport
+module ImportExport
+module ModelMethods
+  def self.included(base)
+    base.send :extend, ClassMethods
+  end
+
+  module ClassMethods
+    # any method placed here will apply to classes
+    def acts_as_importable(options = {})
+      cattr_accessor :import_fields, :export_fields
+      self.import_fields = options[:import_fields]
+      self.export_fields = options[:export_fields]
+      send :include, InstanceMethods
+    end
+    
+    def import(filename, context)
+
+      collection = []
+      headers, *data  = self.read_csv(filename)
+      scope_object = context[:scoped]
+
+      ActiveRecord::Base.transaction do
+        data.each_with_index do |data_row, index|
+          data_row.map{|d| d.strip! if d}
+          Rails.logger.info data_row.inspect
+
+          begin
+            element = self.new
+            element.send("#{scope_object.class.name.downcase}=", scope_object) if scope_object
+
+            self.import_fields.each_with_index do |field_name, field_index|
+              if field_name.include?('.')
+                method_name = 'assign_' + field_name.split('.')[0]
+                if element.respond_to?(method_name)
+                  element.send method_name, data_row
+                elsif element.respond_to?("#{field_name.split('.')[0]}_id")
+                  create_record = field_name.include?('!')
+                  split_field = field_name.gsub(/!/,'').split('.').compact
+                  initial_class = split_field[0].classify.constantize
+                  if initial_class and initial_class.respond_to?("find_by_#{split_field[1]}")
+                    begin
+                      e = initial_class.send("find_by_#{split_field[1]}", data_row[field_index])
+                    rescue
+                      e = nil
+                    end
+                    # try to create a new record if not found in database and if '!' is present
+                    if e.nil? and create_record and !data_row[field_index].blank?
+                      e = initial_class.create!("#{split_field[1]}" => data_row[field_index])
+                    end
+                    if e.kind_of?(ActiveRecord::Base)
+                      element["#{split_field[0]}_id"] = e.id
+                    end
+                  else
+                    e = nil
+                  end
+                end
+              else
+                element.send "#{field_name}=", data_row[field_index]
+              end
+            end
+
+            element.save!
+            collection << element
+          rescue Exception => e
+            Rails.logger.error "Invalid data found at line #{index + 2} !!!"
+            Rails.logger.error e.message
+            Rails.logger.error e.backtrace.join("\n")
+            raise e
+          end
+        end
+      end
+      return collection
+    end
+
+    def export
+      export_fields = self.import_fields || self.export_fields
+      FasterCSV.generate do |csv|
+        csv << export_fields.map{|f| f.split('.')[0]}
+
+        self.find_each(:batch_size => 2000) do |element|
+          collection = []
+          export_fields.each do |field_name|
+            begin
+              if field_name.include?('.')
+                method_names = field_name.gsub(/!/,'').split('.').compact
+                sub_element = element
+                method_names.each do |method_name|
+                  if sub_element || sub_element.respond_to?(method_name)
+                    sub_element = sub_element.send(method_name)
+                  else
+                    break
+                  end
+                end
+                collection << sub_element
+              else
+                collection << element.send(field_name)
+              end
+            rescue Exception => e
+              Rails.logger.info ">>>>>>>>> Exception Caught ImportExport >>>>>>>>>>>"
+              Rails.logger.error e.message
+              Rails.logger.error e.backtrace
+              collection << nil
+            end
+          end
+          csv << collection
+        end
+        
+      end
+    end
+
+    def read_csv(filename)
+      if File.exist?(filename)
+        begin
+          collection = FasterCSV.parse(File.open(filename, 'rb'))
+        rescue FasterCSV::MalformedCSVError => e
+          raise e
+        end
+
+        collection = collection.map{|w| w} unless collection.nil?
+        collection = [] if collection.nil?
+
+        return collection
+      else
+        raise ArgumentError, "File does not exist."
+      end
+    end
+  end
+
+  module InstanceMethods
+    # any method placed here will apply to instaces, like @hickwall
+  end
+
+end
+end

data/lib/tasks/import_export.rake

@@ -0,0 +1,4 @@
+# desc "Explaining what the task does"
+# task :import_export do
+#   # Task goes here
+# end

data/views/import_export/import.html.erb

@@ -0,0 +1,14 @@
+<h1>Import <%=controller.controller_name.capitalize%></h1>
+
+
+<% form_tag "/#{controller.controller_name}/upload", 
+            :multipart => true, :onsubmit => "Element.show('loading')" do %>
+  <%= file_field_tag 'csv_file', :style => 'width:220px;' %>
+  <% if @new_objects.empty? %>
+    <%= submit_tag 'Import', :class => 'long' %>
+  <% else %>
+    <%= submit_tag 'Import', :class => 'long', :confirm => "Are you sure you wish to re-import?" %>
+  <% end %>
+<% end %>
+  
+<p><%= link_to 'Back', "/#{controller.controller_name}" %></p>

metadata

@@ -0,0 +1,159 @@
+--- !ruby/object:Gem::Specification 
+name: acts_as_importable
+version: !ruby/object:Gem::Version 
+  hash: 23
+  prerelease: false
+  segments: 
+  - 0
+  - 2
+  - 0
+  version: 0.2.0
+platform: ruby
+authors: 
+- Jagdeep Singh
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-01-02 00:00:00 +05:30
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  prerelease: false
+  type: :runtime
+  name: activerecord
+  version_requirements: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 1
+        segments: 
+        - 3
+        - 0
+        - 3
+        version: 3.0.3
+  requirement: *id001
+- !ruby/object:Gem::Dependency 
+  prerelease: false
+  type: :runtime
+  name: actionpack
+  version_requirements: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 1
+        segments: 
+        - 3
+        - 0
+        - 3
+        version: 3.0.3
+  requirement: *id002
+- !ruby/object:Gem::Dependency 
+  prerelease: false
+  type: :runtime
+  name: fastercsv
+  version_requirements: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 5
+        segments: 
+        - 1
+        - 5
+        - 3
+        version: 1.5.3
+  requirement: *id003
+- !ruby/object:Gem::Dependency 
+  prerelease: false
+  type: :development
+  name: bundler
+  version_requirements: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 23
+        segments: 
+        - 1
+        - 0
+        - 0
+        version: 1.0.0
+  requirement: *id004
+- !ruby/object:Gem::Dependency 
+  prerelease: false
+  type: :development
+  name: jeweler
+  version_requirements: &id005 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 7
+        segments: 
+        - 1
+        - 5
+        - 2
+        version: 1.5.2
+  requirement: *id005
+description: Use this gem to add import/export to .csv functionality to your activerecord models
+email: jagdeepkh@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE.txt
+- README.rdoc
+files: 
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.rdoc
+- Rakefile
+- VERSION
+- acts_as_importable.gemspec
+- lib/acts_as_importable.rb
+- lib/import_export.rb
+- lib/import_export/controller_methods.rb
+- lib/import_export/routing.rb
+- lib/tasks/import_export.rake
+- views/import_export/import.html.erb
+has_rdoc: true
+homepage: https://github.com/Ennova/acts_as_importable
+licenses: 
+- MIT
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: Makes your model importable from .csv and exportable to .csv
+test_files: []
+