active_admin_import 1.0.1 → 2.0.0

data/README.md

@@ -14,14 +14,20 @@ https://github.com/zdennis/activerecord-import
 
     # +back+:: resource action to redirect after processing
     # +col_sep+:: column separator used for CSV parsing
-    # +validate+:: rue|false, means perfoem validations or not
+    # +validate+:: true|false, means perfoem validations or not
     # +batch_size+:: integer value of max  record count inserted by 1 query/transaction
-    # +before_import+:: proc for before import action, called with resource, file, options arguments
-    # +before_batch_import+:: proc for before each batch action, called with imported data and headers arguments
-    # +after_batch_import+:: proc for after each batch action, called with imported data and headers arguments
+    # +before_import+:: proc for before import action, hook called with  importer object
+    # +after_import+:: proc for after import action, hook called with  importer object
+    # +before_batch_import+:: proc for before each batch action, called with  importer object
+    # +after_batch_import+:: proc for after each batch action, called with  importer object
     # +on_duplicate_key_update+:: an Array or Hash, tells activerecord-import to use MySQL's ON DUPLICATE KEY UPDATE ability.
     # +timestamps+::  true|false, tells activerecord-import to not add timestamps (if false) even if record timestamps is disabled in ActiveRecord::Base
     # +ignore+::  true|false, tells activerecord-import toto use MySQL's INSERT IGNORE ability
+    # +params_keys+:: params values available in callbacks
+    # +template+:: custom template rendering
+    # +locals+:: local variables for template
+    # +resource_class+:: resource class name
+    # +resource_label+:: resource label value
 
 
 #Example
@@ -30,7 +36,7 @@ https://github.com/zdennis/activerecord-import
        active_admin_import :validate => false,
                             :col_sep => ',',
                             :back => :index ,
-                            :before_import => proc{|data|  Post.delete_all},
+                            :before_import => proc{|importer|  resource.delete_all},
                             :batch_size => 1000
     
     

data/active_admin_import.gemspec

@@ -4,7 +4,7 @@ require File.expand_path('../lib/active_admin_import/version', __FILE__)
 Gem::Specification.new do |gem|
   gem.authors       = ["Igor Fedoronchuk"]
   gem.email         = ["fedoronchuk@gmail.com"]
-  gem.description   = "CSV import for Active Admin"
+  gem.description   = "The most efficient way to import for Active Admin"
   gem.summary       = "ActiveAdmin import based on activerecord-import gem."
   gem.homepage      = "http://github.com/Fivell/active_admin_import"
 
@@ -15,6 +15,5 @@ Gem::Specification.new do |gem|
   gem.require_paths = ["lib"]
   gem.version       = ActiveAdminImport::VERSION
 
-  gem.add_runtime_dependency('chronic')
   gem.add_runtime_dependency('activerecord-import','0.3.0')
 end

data/app/views/admin/import.html.erb

@@ -1,7 +1,11 @@
-<%= form_for :import, :url => {:action => :do_import}, :html => {:multipart => true} do |f| %>
-  <%= label_tag  "import_file", "File for import:" %><br>
-  <%= f.file_field :file %>
-  <hr />
-  <%= submit_tag 'Import' %>
-<% end %>
-
+    <p>
+       <small> <%= raw(@active_admin_import_model.hint)  %> </small>
+    </p>
+<%= semantic_form_for @active_admin_import_model ,  :url => {:action => :do_import}, :html => {:multipart => true} do |f| %>
+    <%= f.inputs do %>
+    <%= f.input :file, :as=>:file %>
+    <% end %>
+     <%= f.actions do %>
+    <%= f.action :submit , :label =>t("active_admin_import.import_btn") ,:button_html => { :disable_with => t("active_admin_import.import_btn_disabled") }%>
+        <% end %>
+<% end %>

data/lib/active_admin_import.rb

@@ -3,5 +3,14 @@ require 'active_admin_import/version'
 require 'active_admin_import/engine'
 require 'active_admin_import/dsl'
 require 'active_admin_import/importer'
-
+require 'active_admin_import/model'
 ::ActiveAdmin::DSL.send(:include, ActiveAdminImport::DSL)
+
+module ActiveAdminImport
+    class Railtie < ::Rails::Railtie
+    config.after_initialize do
+      require 'active_support/i18n'
+      I18n.load_path.unshift *Dir[File.expand_path('../active_admin_import/locales/*.yml', __FILE__)]
+    end
+  end
+end

data/lib/active_admin_import/dsl.rb

@@ -7,45 +7,89 @@ module ActiveAdminImport
     # Options
     # +back+:: resource action to redirect after processing
     # +col_sep+:: column separator used for CSV parsing
-    # +validate+:: rue|false, means perfoem validations or not
+    # +validate+:: true|false, means perfoem validations or not
     # +batch_size+:: integer value of max  record count inserted by 1 query/transaction
-    # +before_import+:: proc for before import action, called with resource, file, options arguments
-    # +before_batch_import+:: proc for before each batch action, called with imported data and headers arguments
-    # +after_batch_import+:: proc for after each batch action, called with imported data and headers arguments
+    # +before_import+:: proc for before import action, hook called with  importer object
+    # +after_import+:: proc for after import action, hook called with  importer object
+    # +before_batch_import+:: proc for before each batch action, called with  importer object
+    # +after_batch_import+:: proc for after each batch action, called with  importer object
     # +on_duplicate_key_update+:: an Array or Hash, tells activerecord-import to use MySQL's ON DUPLICATE KEY UPDATE ability.
     # +timestamps+::  true|false, tells activerecord-import to not add timestamps (if false) even if record timestamps is disabled in ActiveRecord::Base
     # +ignore+::  true|false, tells activerecord-import toto use MySQL's INSERT IGNORE ability
+    # +fetch_extra_options_from_params+:: params values available in callbacks in importer.extra_options hash
+    # +template+:: custom template rendering
+    # +locals+:: local variables for template
+    # +resource_class+:: resource class name
+    # +resource_label+:: resource label value
+    #
     def active_admin_import options = {}
       default_options = {
-        :back => :import,
-        :col_sep => ','
+          :back => :import,
+          :col_sep => ',',
+          :template => "admin/import",
+          :template_object => ActiveAdminImport::Model.new,
+          :fetch_extra_options_from_params => [],
+          :resource_class => nil,
+          :resource_label => nil,
+          :headers_rewrites => {}
+
+
       }
       options = default_options.merge(options)
-      action_item :only => :index do
-        link_to "Import #{active_admin_config.resource_name.pluralize}", :action => 'import'
-      end
+      params_key = ActiveModel::Naming.param_key(options[:template_object])
+
 
       collection_action :import, :method => :get do
-        render "admin/import"
+        @active_admin_import_model = options[:template_object]
+        render :template => options[:template]
+      end
+
+
+      action_item :only => :index do
+        link_to(I18n.t('active_admin_import.import_model',
+                :model => (options[:resource_label] || active_admin_config.resource_name)),
+                        :action => 'import')
       end
 
+
       collection_action :do_import, :method => :post do
-        if params[:import].blank?
-          flash[:alert] = "Please, select file to import"
-          return redirect_to :action => options[:back]
+        if params[params_key].blank?
+          flash[:alert] =  I18n.t('active_admin_import.no_file_error')
+          return redirect_to :back
         end
-        unless params[:import]['file'].try(:content_type) && params[:import]['file'].content_type.in?(["text/csv"])
-          flash[:alert] = "You can import file only with extension csv"
-          return redirect_to :action => options[:back]
+        content_types_allow = [
+            'text/csv',
+            'text/x-csv',
+            'text/comma-separated-values',
+            'application/csv',
+            'application/vnd.ms-excel',
+            'application/vnd.msexcel'
+        ]
+        unless params[params_key]['file'].try(:content_type) && params[params_key]['file'].content_type.in?(content_types_allow)
+          flash[:alert] = I18n.t('active_admin_import.file_format_error')
+          return redirect_to :back
         end
-        importer = Importer.new( active_admin_config.resource_class, params[:import][:file], options)
 
+        importer = Importer.new((options[:resource_class] || active_admin_config.resource_class),
+                                params[params_key][:file],
+                                options,
+                                params[params_key].to_hash.slice(*options[:fetch_extra_options_from_params])
+        )
+        result = importer.import
+
+        flash[:notice] =  I18n.t('active_admin_import.imported',
+                                    :count=> result[:imported].to_i,
+                                    :model => (options[:resource_label] || active_admin_config.resource_label).downcase,
+                                    :plural_model =>  (options[:resource_label].present? ? options[:resource_label].to_s.pluralize : active_admin_config.plural_resource_label).downcase
+
+                                ) if  result[:imported].to_i > 0
+
+        flash[:error] =  I18n.t('active_admin_import.failed',
+                                    :count=> result[:failed].count,
+                                    :model => (options[:resource_label] || active_admin_config.resource_label).downcase,
+                                     :plural_model =>  (options[:resource_label].present? ? options[:resource_label].to_s.pluralize : active_admin_config.plural_resource_label).downcase
 
-          result = importer.import
-          flash[:notice] = "#{view_context.pluralize(result[:imported].to_i,active_admin_config.resource_name)} was imported"
-          unless result[:failed].count == 0
-            flash[:error] =  "#{view_context.pluralize(result[:failed].count,active_admin_config.resource_name)} was failed to imported"
-          end
+                                ) if  result[:failed].count > 0
 
         redirect_to :action => options[:back]
       end

data/lib/active_admin_import/importer.rb

@@ -2,28 +2,33 @@ require 'csv'
 module ActiveAdminImport
   class Importer
 
-    attr_reader :resource, :file, :options , :result
+    attr_reader :resource, :file, :options , :extra_options , :result ,
+    :cycle_data, :headers , :csv_lines
 
-    def store data, headers
+    def store
       result = @resource.transaction do
-        options[:before_batch_import].call(data, headers) if options[:before_batch_import].is_a?(Proc)
-        result = resource.import headers, data, {
+        options[:before_batch_import].call(self) if options[:before_batch_import].is_a?(Proc)
+
+
+        result = resource.import headers.values, csv_lines, {
             :validate => options[:validate],
             :on_duplicate_key_update => options[:on_duplicate_key_update],
             :ignore => options[:ignore],
             :timestamps => options[:timestamps]
         }
-        options[:after_batch_import].call(data, headers) if options[:after_batch_import].is_a?(Proc)
+        options[:after_batch_import].call(self) if options[:after_batch_import].is_a?(Proc)
         result
       end
-      {:imported => data.count -  result.failed_instances.count , :failed => result.failed_instances}
+      {:imported => csv_lines.count -  result.failed_instances.count , :failed => result.failed_instances}
     end
 
     def prepare_headers(headers)
-      Hash[headers.zip(headers.map { |el| el.underscore.gsub(/\s+/, '_') })]
+      @headers =  Hash[headers.zip(headers.map { |el| el.underscore.gsub(/\s+/, '_') })]
+      @headers.merge!(options[:headers_rewrites])
+      @headers
     end
 
-    def initialize resource, file, options
+    def initialize resource, file, options , extra_options = nil
       @resource = resource
       @file = file
       @options = {
@@ -36,20 +41,22 @@ module ActiveAdminImport
         :failed => [],
         :imported => 0
       }
+      @extra_options = extra_options
+      @csv_options = @options.slice(:col_sep, :row_sep)
     end
 
     def cycle(lines)
-       lines = CSV.parse(lines.join)
-       @result.merge!(self.store(lines, @headers.values)){|key,val1,val2| val1+val2}
+       @csv_lines = CSV.parse(lines.join, @csv_options)
+       @result.merge!(self.store){|key,val1,val2| val1+val2}
     end
 
     def import
-      options[:before_import].call(@resource, @file, @options) if options[:before_import].is_a?(Proc)
+      options[:before_import].call(self) if options[:before_import].is_a?(Proc)
       lines = []
-      batch_size = @options[:batch_size].to_i
+      batch_size = options[:batch_size].to_i
       IO.foreach(file.path) do |line|
-        if @headers.empty?
-          @headers = prepare_headers(CSV.parse(line).first)
+        if headers.empty?
+          prepare_headers(CSV.parse(line, @csv_options).first)
         else
           lines << line
           if lines.size >= batch_size
@@ -59,7 +66,7 @@ module ActiveAdminImport
         end
       end
       cycle(lines) unless lines.blank?
-      options[:after_import].call(@result) if options[:after_import].is_a?(Proc)
+      options[:after_import].call(self) if options[:after_import].is_a?(Proc)
       result
     end
   end

data/lib/active_admin_import/locales/en.yml

@@ -0,0 +1,15 @@
+en:
+  active_admin:
+    import: "Import"
+  active_admin_import:
+    file_format_error: "You can import only valid csv file"
+    no_file_error: "Please, select file to import"
+    imported:
+      one: "Successfully imported 1 %{model}"
+      other: "Successfully imported %{count} %{plural_model}"
+    failed:
+      one:   "Failed to import 1 %{model}"
+      other: "Failed to import %{count} %{plural_model}"
+    import_model: "Import %{model}"
+    import_btn: "Import"
+    import_btn_disabled: "Wait..."

data/lib/active_admin_import/locales/it.yml

@@ -0,0 +1,15 @@
+it:
+  active_admin:
+    import: "Importa"
+  active_admin_import:
+    file_format_error: "Puoi importare solo CSV conformi"
+    no_file_error: "Per favore, seleziona un file da importare"
+    imported:
+      one: "Importato 1 %{model} con successo"
+      other: "Importati %{count} %{plural_model} con successo"
+    failed:
+      one:   "Importazione di 1 %{model} fallita"
+      other: "Importazione di %{count} %{plural_model} fallita"
+    import_model: "Importa %{model}"
+    import_btn: "Importa"
+    import_btn_disabled: "In attesa..."

data/lib/active_admin_import/model.rb

@@ -0,0 +1,27 @@
+module ActiveAdminImport
+  class Model
+    extend ActiveModel::Naming
+    include ActiveModel::Conversion
+    
+    attr_accessor :file
+    attr_accessor :hint 
+    attr_reader :attributes
+    
+    def initialize(attributes={})
+      self.hint= attributes.delete(:hint)
+      @attributes = attributes
+      @attributes.each do |key,value|
+              #generate methods for instance object by attributes
+              singleton_class.class_eval do
+                define_method(key) { self.attributes[key] } unless method_defined? key
+                define_method("#{key}=") { |new_value|  @attributes[key] = new_value } unless method_defined? "#{key}="
+              end
+        end
+    end
+
+    def persisted?
+      false
+    end
+
+  end
+end

data/lib/active_admin_import/version.rb

@@ -1,3 +1,3 @@
 module ActiveAdminImport
-  VERSION = "1.0.1"
+  VERSION = "2.0.0"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: active_admin_import
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 2.0.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,22 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-03-11 00:00:00.000000000 Z
+date: 2013-05-20 00:00:00.000000000 Z
 dependencies:
-- !ruby/object:Gem::Dependency
-  name: chronic
-  requirement: &70313477456520 !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :runtime
-  prerelease: false
-  version_requirements: *70313477456520
 - !ruby/object:Gem::Dependency
   name: activerecord-import
-  requirement: &70313477471600 !ruby/object:Gem::Requirement
+  requirement: &70124414344240 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - =
@@ -32,8 +21,8 @@ dependencies:
         version: 0.3.0
   type: :runtime
   prerelease: false
-  version_requirements: *70313477471600
-description: CSV import for Active Admin
+  version_requirements: *70124414344240
+description: The most efficient way to import for Active Admin
 email:
 - fedoronchuk@gmail.com
 executables: []
@@ -51,6 +40,9 @@ files:
 - lib/active_admin_import/dsl.rb
 - lib/active_admin_import/engine.rb
 - lib/active_admin_import/importer.rb
+- lib/active_admin_import/locales/en.yml
+- lib/active_admin_import/locales/it.yml
+- lib/active_admin_import/model.rb
 - lib/active_admin_import/version.rb
 homepage: http://github.com/Fivell/active_admin_import
 licenses: []