rails_admin_import 0.1.9 → 1.0.0

metadata

@@ -1,37 +1,107 @@
 --- !ruby/object:Gem::Specification
 name: rails_admin_import
 version: !ruby/object:Gem::Version
-  version: 0.1.9
+  version: 1.0.0
 platform: ruby
 authors:
 - Steph Skardal
+- Julien Vanier
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-05-22 00:00:00.000000000 Z
-dependencies: []
+date: 2015-06-09 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.2'
+- !ruby/object:Gem::Dependency
+  name: rails_admin
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.6.6
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.6.6
+- !ruby/object:Gem::Dependency
+  name: haml
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+- !ruby/object:Gem::Dependency
+  name: rchardet
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
 description: 
-email: steph@endpoint.com
+email:
+- steph@endpoint.com
+- jvanier@gmail.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- CHANGELOG.md
 - MIT-LICENSE
 - README.md
-- RELEASE_NOTES
 - Rakefile
-- app/views/rails_admin/main/import.html.erb
+- app/views/rails_admin/main/_results.html.haml
+- app/views/rails_admin/main/_section.html.haml
+- app/views/rails_admin/main/import.html.haml
 - config/locales/import.en.yml
 - lib/rails_admin_import.rb
+- lib/rails_admin_import/action.rb
 - lib/rails_admin_import/config.rb
-- lib/rails_admin_import/config/base.rb
-- lib/rails_admin_import/config/model.rb
+- lib/rails_admin_import/config/legacy_model.rb
+- lib/rails_admin_import/config/sections/import.rb
 - lib/rails_admin_import/engine.rb
-- lib/rails_admin_import/import.rb
+- lib/rails_admin_import/formats.rb
+- lib/rails_admin_import/formats/csv_importer.rb
+- lib/rails_admin_import/formats/dummy_importer.rb
+- lib/rails_admin_import/formats/file_importer.rb
+- lib/rails_admin_import/formats/json_importer.rb
 - lib/rails_admin_import/import_logger.rb
+- lib/rails_admin_import/import_model.rb
+- lib/rails_admin_import/importer.rb
+- lib/rails_admin_import/rails_admin_plugin.rb
 - lib/rails_admin_import/version.rb
-homepage: 
-licenses: []
+homepage: https://github.com/stephskardal/rails_admin_import
+licenses:
+- MIT
 metadata: {}
 post_install_message: 
 rdoc_options: []
@@ -49,8 +119,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.2
+rubygems_version: 2.4.5
 signing_key: 
 specification_version: 4
-summary: Import functionality for rails admin
+summary: Import functionality for Rails Admin
 test_files: []

data/app/views/rails_admin/main/import.html.erb

@@ -1,143 +0,0 @@
-<% if @response -%>
-<% if @response.has_key?(:error) -%>
-<div class="alert-error alert"><%= @response[:error] %></div>
-<% end -%>
-<% if @response.has_key?(:notice) -%>
-<div class="alert-success alert"><%= @response[:notice] %></div>
-<% end -%>
-<% end -%>
-
-<%= form_tag rails_admin.import_url(@abstract_model.to_param), :multipart => true, :class => 'form-horizontal' do |f| -%>
-  <fieldset>
-    <legend>
-      <i class="icon-chevron-down"></i>
-      Fields to import
-    </legend>
-    <div class="control-group">
-      <label class="control-label" data-original-title="Click to reverse selection" onclick="jQuery(this).siblings('.controls').find('input').click()" rel="tooltip">Fields from <%= @abstract_model.to_param %></label>
-      <div class="controls">
-        <ul>
-        <% @abstract_model.model.import_fields.each do |field| -%>
-          <li><%= field %></li>
-        <% end -%>
-        </ul>
-        <p class="help-block">The following fields may be included in the import file.</p>
-      </div>
-    </div>
-    <% if @abstract_model.model.belongs_to_fields.any? -%>
-    <div class="control-group">
-      <label class="control-label" data-original-title="Click to reverse selection" onclick="jQuery(this).siblings('.controls').find('input').click()" rel="tooltip">Belongs To Fields</label>
-      <div class="controls">
-        <ul>
-        <% @abstract_model.model.belongs_to_fields.each do |field| -%>
-          <li><a href="<%= url_for(:action => :index, :model_name => field) %>"><%= field.to_s.titleize %></a></li>
-        <% end -%>
-        </ul>
-        <p class="help-block">These fields map to other items in the database, lookup via attribute selected below.</p>
-      </div>
-    </div>
-    <% end -%>
-    <% if @abstract_model.model.file_fields.any? -%>
-    <div class="control-group">
-      <label class="control-label" data-original-title="Click to reverse selection" onclick="jQuery(this).siblings('.controls').find('input').click()" rel="tooltip">Belongs To Fields</label>
-      <div class="controls">
-        <ul>
-        <% @abstract_model.model.file_fields.each do |field| -%>
-          <li><%= field %></li>
-        <% end -%>
-        </ul>
-        <p class="help-block">These must be a downloadable URL.</p>
-      </div>
-    </div>
-    <% end -%>  
-    <% if @abstract_model.model.many_fields.any? -%>
-    <div class="control-group">
-      <label class="control-label" data-original-title="Click to reverse selection" onclick="jQuery(this).siblings('.controls').find('input').click()" rel="tooltip">Belongs To Fields</label>
-      <div class="controls">
-        <ul>
-        <% @abstract_model.model.many_fields.each do |field| -%>
-          <li><%= field %></li>
-        <% end -%>
-        </ul>
-        <p class="help-block">These fields map to other columns in the database, lookup via attribute selected below. There may be multiple columns with this header in the spreadsheet.</p>
-      </div>
-    </div>
-    <% end -%>
-    <% if RailsAdminImport.config(@abstract_model.model).extra_fields.any? -%>
-    <div class="control-group">
-      <label class="control-label" data-original-title="Click to reverse selection" onclick="jQuery(this).siblings('.controls').find('input').click()" rel="tooltip">Belongs To Fields</label>
-      <div class="controls">
-        <ul>
-        <% RailsAdminImport.config(@abstract_model.model).extra_fields.each do |field| -%>
-          <li><%= field %></li>
-        <% end -%>
-        </ul>
-        <p class="help-block">Additional application specific fields.</p>
-      </div>
-    </div>
-    <% end -%>
-  </fieldset>
-  <fieldset>
-    <legend>
-      <i class="icon-chevron-down"></i>
-      Upload file
-    </legend>
-    <div class="control-group">
-      <label class="control-label" data-original-title="Click to reverse selection" onclick="jQuery(this).siblings('.controls').find('input').click()" rel="tooltip">File</label>
-      <div class="controls">
-        <%= file_field_tag :file %>
-        <p class="help-block">Please limit upload file to <%= RailsAdminImport.config.line_item_limit %> line items.</p>
-      </div>
-    </div>
-    <div class="control-group">
-      <label class="control-label" data-original-title="Click to reverse selection" onclick="jQuery(this).siblings('.controls').find('input').click()" rel="tooltip">Update if exists</label>
-      <div class="controls">
-        <label class="checkbox">
-          <%= check_box_tag :update_if_exists %>
-        </label>
-      </div>
-    </div>
-    <div class="control-group">
-      <label class="control-label" data-original-title="Click to reverse selection" onclick="jQuery(this).siblings('.controls').find('input').click()" rel="tooltip">Update lookup field</label>
-      <div class="controls">
-        <select name="update_lookup">
-          <% @abstract_model.model.new.attributes.keys.each do |key| -%>
-          <option value="<%= key %>"><%= key %></option>
-          <% end -%>
-        </select>
-      </div>
-    </div>
-
-  </fieldset>
-  <% if @abstract_model.model.belongs_to_fields.any? -%>
-  <fieldset>
-    <legend>
-      <i class="icon-chevron-down"></i>
-      Related fields mapping
-    </legend>
-    <% [@abstract_model.model.belongs_to_fields, @abstract_model.model.many_fields].flatten.each do |field| -%>
-    <div class="control-group">
-      <label class="control-label" for="csv_options_encoding_to"><a href="<%= url_for(:action => :index, :model_name => field) %>"><%= field.to_s.titleize %></a> mapping</label>
-      <div class="controls">
-        <select name="<%= field %>">
-          <% field.to_s.classify.constantize.new.attributes.keys.each do |key| -%>
-          <option value="<%= key %>"><%= key %></option>
-          <% end -%>
-        </select>
-      </div>
-    </div>
-    <% end -%>
-  </fieldset>
-  <% end -%>
-  <div class="form-actions">
-    <button class="btn btn-primary" name="commit" type="submit" data-disable-with="Uploading...">
-      <i class="icon-white icon-ok"></i>
-      Import
-    </button>
-    <button class="btn" name="_continue" type="submit">
-      <i class="icon-remove"></i>
-      Cancel
-    </button>
-    <!--<%= submit_tag "Upload", :disable_with => "Uploading..." %>-->
-  </div>
-<% end -%>

data/lib/rails_admin_import/config/base.rb

@@ -1,62 +0,0 @@
-module RailsAdminImport
-  module Config
-    class Base
-      def initialize(parent = nil)
-      end
-
-      # Register an instance option for this object only
-      def register_instance_option(option_name, &default)
-        scope = class << self; self; end;
-        self.class.register_instance_option(option_name, scope, &default)
-      end
-
-      # Register an instance option. Instance option is a configuration
-      # option that stores its value within an instance variable and is
-      # accessed by an instance method. Both go by the name of the option.
-      def self.register_instance_option(option_name, scope = self, &default)
-        unless options = scope.instance_variable_get("@config_options")
-          options = scope.instance_variable_set("@config_options", {})
-        end
-
-        option_name = option_name.to_s
-
-        options[option_name] = nil
-
-        # If it's a boolean create an alias for it and remove question mark
-        if "?" == option_name[-1, 1]
-          scope.send(:define_method, "#{option_name.chop!}?") do
-            send(option_name)
-          end
-        end
-
-        # Define getter/setter by the option name
-        scope.send(:define_method, option_name) do |*args, &block|
-          if !args[0].nil? || block
-            # Invocation with args --> This is the declaration of the option, i.e. setter
-            instance_variable_set("@#{option_name}_registered", args[0].nil? ? block : args[0])
-          else
-            # Invocation without args nor block --> It's the use of the option, i.e. getter
-            value = instance_variable_get("@#{option_name}_registered")
-            case value
-              when Proc
-                # Track recursive invocation with an instance variable. This prevents run-away recursion
-                # and allows configurations such as
-                # label { "#{label}".upcase }
-                # This will use the default definition when called recursively.
-                if instance_variable_get("@#{option_name}_recurring")
-                  value = instance_eval &default
-                else
-                  instance_variable_set("@#{option_name}_recurring", true)
-                  value = instance_eval &value
-                  instance_variable_set("@#{option_name}_recurring", false)
-                end
-              when nil
-                value = instance_eval &default
-            end
-            value
-          end
-        end
-      end
-    end
-  end
-end

data/lib/rails_admin_import/config/model.rb

@@ -1,23 +0,0 @@
-require 'rails_admin_import/config'
-require 'rails_admin_import/config/base'
-
-module RailsAdminImport
-  module Config
-    class Model < RailsAdminImport::Config::Base
-      def initialize(entity)
-      end
-
-      register_instance_option(:label) do
-        :id
-      end
-
-      register_instance_option(:excluded_fields) do
-        []
-      end
-
-      register_instance_option(:extra_fields) do
-        []
-      end
-    end
-  end
-end

data/lib/rails_admin_import/import.rb

@@ -1,218 +0,0 @@
-require 'open-uri'
-require "rails_admin_import/import_logger"
-  
-module RailsAdminImport
-  module Import
-    extend ActiveSupport::Concern
-  
-    module ClassMethods
-      def file_fields
-        attrs = []
-        if self.methods.include?(:attachment_definitions) && !self.attachment_definitions.nil?
-          attrs = self.attachment_definitions.keys
-        end
-        attrs - RailsAdminImport.config(self).excluded_fields 
-      end
-  
-      def import_fields
-        fields = []  
-
-        fields = self.new.attributes.keys.collect { |key| key.to_sym }
-  
-        self.belongs_to_fields.each do |key|
-          fields.delete("#{key}_id".to_sym)
-        end
-  
-        self.file_fields.each do |key|
-          fields.delete("#{key}_file_name".to_sym)
-          fields.delete("#{key}_content_type".to_sym)
-          fields.delete("#{key}_file_size".to_sym)
-          fields.delete("#{key}_updated_at".to_sym)
-        end
- 
-        excluded_fields = RailsAdminImport.config(self).excluded_fields 
-        [:id, :created_at, :updated_at, excluded_fields].flatten.each do |key|
-          fields.delete(key)
-        end
-  
-        fields
-      end
- 
-      def belongs_to_fields
-        attrs = self.reflections.select { |k, v| v.macro == :belongs_to }.keys
-        attrs - RailsAdminImport.config(self).excluded_fields 
-      end
-  
-      def many_fields
-        attrs = []
-        self.reflections.each do |k, v|
-          if [:has_and_belongs_to_many, :has_many].include?(v.macro)
-            attrs << k.to_s.singularize.to_sym
-          end
-        end
-
-        attrs - RailsAdminImport.config(self).excluded_fields 
-      end 
-  
-      def run_import(params)
-        begin
-          if !params.has_key?(:file)
-            return results = { :success => [], :error => ["You must select a file."] }
-          end
-
-          if RailsAdminImport.config.logging
-            FileUtils.copy(params[:file].tempfile, "#{Rails.root}/log/import/#{Time.now.strftime("%Y-%m-%d-%H-%M-%S")}-import.csv")
-          end
-
-          text       = File.read(params[:file].tempfile)
-          clean      = text.force_encoding('BINARY').encode('UTF-8', :undef => :replace, :replace => '').gsub(/\n$/, '')
-          file_check = CSV.new(clean)
-          logger     = ImportLogger.new
-     
-          if file_check.readlines.size > RailsAdminImport.config.line_item_limit
-            return results = { :success => [], :error => ["Please limit upload file to #{RailsAdminImport.config.line_item_limit} line items."] }
-          end
-  
-          map = {}
-   
-          file = CSV.new(clean)
-          file.readline.each_with_index do |key, i|
-            if self.many_fields.include?(key.to_sym)
-              map[key.to_sym] ||= []
-              map[key.to_sym] << i
-            else
-              map[key.to_sym] = i 
-            end
-          end
-   
-          update = params.has_key?(:update_if_exists) && params[:update_if_exists] ? params[:update_lookup].to_sym : nil
-  
-          if update && !map.has_key?(params[:update_lookup].to_sym)
-            return results = { :success => [], :error => ["Your file must contain a column for the 'Update lookup field' you selected."] }
-          end 
-    
-          results = { :success => [], :error => [] }
-    
-          associated_map = {}
-          self.belongs_to_fields.flatten.each do |field|
-            associated_map[field] = field.to_s.classify.constantize.all.inject({}) { |hash, c| hash[c.send(params[field]).to_s] = c.id; hash }
-          end
-          self.many_fields.flatten.each do |field|
-            associated_map[field] = field.to_s.classify.constantize.all.inject({}) { |hash, c| hash[c.send(params[field]).to_s] = c; hash }
-          end
-   
-          label_method = RailsAdminImport.config(self).label
-  
-          file.each do |row|
-            object = self.import_initialize(row, map, update)
-            object.import_belongs_to_data(associated_map, row, map)
-            object.import_many_data(associated_map, row, map)
-            object.before_import_save(row, map)
-  
-            object.import_files(row, map)
-
-            verb = object.new_record? ? "Create" : "Update"
-            if object.errors.empty?
-              if object.save
-                logger.info "#{Time.now.to_s}: #{verb}d: #{object.send(label_method)}"
-                results[:success] << "#{verb}d: #{object.send(label_method)}"
-                object.after_import_save(row, map)
-              else
-                logger.info "#{Time.now.to_s}: Failed to #{verb}: #{object.send(label_method)}. Errors: #{object.errors.full_messages.join(', ')}."
-                results[:error] << "Failed to #{verb}: #{object.send(label_method)}. Errors: #{object.errors.full_messages.join(', ')}."
-              end
-            else
-              logger.info "#{Time.now.to_s}: Errors before save: #{object.send(label_method)}. Errors: #{object.errors.full_messages.join(', ')}."
-              results[:error] << "Errors before save: #{object.send(label_method)}. Errors: #{object.errors.full_messages.join(', ')}."
-            end
-          end
-    
-          results
-        rescue Exception => e
-          logger.info "#{Time.now.to_s}: Unknown exception in import: #{e.inspect}"
-          return results = { :success => [], :error => ["Could not upload. Unexpected error: #{e.to_s}"] }
-        end
-      end
-  
-      def import_initialize(row, map, update)
-        new_attrs = {}
-        self.import_fields.each do |key|
-          new_attrs[key] = row[map[key]] if map[key]
-        end
-
-        item = nil
-        if update.present?
-          item = self.send("find_by_#{update}", row[map[update]])
-        end 
-
-        if item.nil?
-          item = self.new(new_attrs)
-        else
-          item.attributes = new_attrs.except(update.to_sym)
-          item.save
-        end
-
-        item
-      end
-    end
-   
-    def before_import_save(*args)
-      # Meant to be overridden to do special actions
-    end
-
-	def after_import_save(*args)
-      # Meant to be overridden to do special actions
-    end
-
-    def import_display
-      self.id
-    end
-
-    def import_files(row, map)
-      if self.new_record? && self.valid?
-        self.class.file_fields.each do |key|
-          if map[key] && !row[map[key]].nil?
-            begin
-              # Strip file
-              row[map[key]] = row[map[key]].gsub(/\s+/, "")
-              format = row[map[key]].match(/[a-z0-9]+$/)
-              open("#{Rails.root}/tmp/#{self.permalink}.#{format}", 'wb') { |file| file << open(row[map[key]]).read }
-              self.send("#{key}=", File.open("#{Rails.root}/tmp/#{self.permalink}.#{format}"))
-            rescue Exception => e
-              self.errors.add(:base, "Import error: #{e.inspect}")
-            end
-          end
-        end
-      end
-    end
-
-    def import_belongs_to_data(associated_map, row, map)
-      self.class.belongs_to_fields.each do |key|
-        if map.has_key?(key) && row[map[key]] != ""
-          self.send("#{key}_id=", associated_map[key][row[map[key]]])
-        end
-      end
-    end
-
-    def import_many_data(associated_map, row, map)
-      self.class.many_fields.each do |key|
-        values = []
-
-        map[key] ||= []
-        map[key].each do |pos|
-          if row[pos] != "" && associated_map[key][row[pos]]
-            values << associated_map[key][row[pos]]
-          end
-        end
-
-        if values.any?
-          self.send("#{key.to_s.pluralize}=", values)
-        end
-      end
-    end
-  end
-end
-
-class ActiveRecord::Base
-  include RailsAdminImport::Import
-end