rails_admin_import 0.1.0

data/README.md

@@ -0,0 +1,61 @@
+Rails Admin Import functionality
+========
+
+Plugin functionality to add generic import to Rails Admin interface
+
+Installation
+========
+
+* First, add to Gemfile:
+    
+        gem "rails_admin_import", :git => "git://github.com/stephskardal/demo.git"
+
+* Next, mount in your application by adding:
+
+        mount RailsAdminImport::Engine => '/rails_admin_import', :as => 'rails_admin_import'" to config/routes
+
+* Add to cancan to allow access to import:
+
+        can :import, [User, Model1, Model2]
+
+* Define configuration:
+
+        RailsAdminImport.config do |config| 
+          config.model User do
+            excluded_fields do
+              [:field1, :field2, :field3]
+            end
+            label :name
+            extra_fields do
+              [:field3, :field4, :field5]
+            end
+          end
+        end
+
+* (Optional) Define instance methods to be hooked into the import process, if special/additional processing is required on the data:
+
+        # some model
+        def before_import_save(row, map)
+          self.set_permalink
+          self.import_nested_data(row, map)
+        end
+
+* "import" action must be added inside config.actions block in main application RailsAdmin configuration.
+
+  config.actions do
+    ...
+    import
+
+  end
+
+  Refer to RailAdmin documentation on custom actions that must be present in this block.
+
+TODO
+========
+
+* Testing
+
+Copyright
+========
+
+Copyright (c) 2011 End Point & Steph Skardal. See LICENSE.txt for further details.

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

@@ -0,0 +1,102 @@
+<% if @response -%>
+<% if @response.has_key?(:error) -%>
+<div class="alert-message error">
+<%= @response[:error] %>
+</div>
+<% end -%>
+<% if @response.has_key?(:notice) -%>
+<div class="alert-message notice">
+<%= @response[:notice] %>
+</div>
+<% end -%>
+<% end -%>
+
+<h1>Import <%= @abstract_model.to_param.titleize %></h1>
+
+<small>The following fields may be included in the import file</small>
+<table width="100%" cellpadding="0" cellspacing="0">
+<tr>
+<td width="20%" valign="top">
+<h3>Standard Fields</h3>
+<ul>
+<% @abstract_model.model.import_fields.each do |field| -%>
+<li><%= field %></li>
+<% end -%>
+</ul>
+</td>
+
+<% if @abstract_model.model.belongs_to_fields.any? -%>
+<td width="20%" valign="top">
+<h3>Belongs To Fields</h3>
+<ul>
+<% @abstract_model.model.belongs_to_fields.each do |field| -%>
+<li><%= field %></li>
+<% end -%>
+</ul>
+<small>These fields map to other items in the database, lookup via attribute selected below.</small>
+</td>
+<% end -%>
+
+<% if @abstract_model.model.file_fields.any? -%>
+<td width="20%" valign="top">
+<h3>File Fields</h3>
+<ul>
+<% @abstract_model.model.file_fields.each do |field| -%>
+<li><%= field %></li>
+<% end -%>
+</ul>
+<small>These must be a downloadable URL.</small>
+</td>
+<% end -%>
+
+<% if @abstract_model.model.many_fields.any? -%>
+<td width="20%" valign="top">
+<h3>Multiple Fields</h3>
+<ul>
+<% @abstract_model.model.many_fields.each do |field| -%>
+<li><%= field %></li>
+<% end -%>
+</ul>
+<small>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.</small>
+</td>
+<% end -%>
+
+<% if RailsAdminImport.config(@abstract_model.model).extra_fields.any? -%>
+<td width="20%" valign="top">
+<h3>Extra Fields</h3>
+<ul>
+<% RailsAdminImport.config(@abstract_model.model).extra_fields.each do |field| -%>
+<li><%= field %></li>
+<% end -%>
+</ul>
+<small>Additional application specific fields.</small>
+</td>
+<% end -%>
+	</tr>
+</table>
+
+<%= form_tag rails_admin.import_url(@abstract_model.to_param), :multipart => true do |f| -%>
+  <%= file_field_tag :file %>
+
+  <p>
+  <%= check_box_tag :update_if_exists %> Update if Exists<br />
+  Update lookup field
+  <select name="update_lookup">
+    <% @abstract_model.model.new.attributes.keys.each do |key| -%>
+  	<option value="<%= key %>"><%= key %></option>
+	<% end -%>
+  </select>
+  </p>
+
+  <% [@abstract_model.model.belongs_to_fields, @abstract_model.model.many_fields].flatten.each do |field| -%>
+  <div style="display:inline-block; width: 45%;background:#cecece;margin: 5px;padding: 5px;">
+  <label style="width:200px;"><%= field %> mapping</label>&nbsp;&nbsp;
+  <select name="<%= field %>">
+    <% field.to_s.classify.constantize.new.attributes.keys.each do |key| -%>
+  	<option value="<%= key %>"><%= key %></option>
+	<% end -%>
+  <select>
+  </div>
+  <% end -%><br />
+  <%= submit_tag "Upload", :disable_with => "Uploading..." %>
+<% end -%>

data/config/locales/import.en.yml

@@ -0,0 +1,11 @@
+
+en:
+  admin:
+    actions:
+      import:
+        title: "Import"
+        menu: "Import"
+        breadcrumb: "Import"
+        link: "Import"
+        bulk_link: "Import"
+        done: "Imported"

data/lib/rails_admin_import.rb

@@ -0,0 +1,57 @@
+require "rails_admin_import/engine"
+require "rails_admin_import/import"
+require "rails_admin_import/config"
+
+module RailsAdminImport
+  def self.config(entity = nil, &block)
+    if entity
+    RailsAdminImport::Config.model(entity, &block)
+    elsif block_given? && ENV['SKIP_RAILS_ADMIN_INITIALIZER'] != "true"
+      block.call(RailsAdminImport::Config)
+  else
+    RailsAdminImport::Config
+    end
+  end
+
+  def self.reset
+    RailsAdminImport::Config.reset
+  end
+end
+
+require 'rails_admin/config/actions'
+
+module RailsAdmin
+  module Config
+    module Actions
+      class Import < Base
+        RailsAdmin::Config::Actions.register(self)
+        
+        register_instance_option :collection do
+          true
+        end
+
+        register_instance_option :http_methods do
+          [:get, :post]
+        end
+
+        register_instance_option :controller do
+          Proc.new do
+            @response = {}
+
+            if request.post?
+              results = @abstract_model.model.run_import(params)
+              @response[:notice] = results[:success].join("<br />").html_safe if results[:success].any?
+              @response[:error] = results[:error].join("<br />").html_safe if results[:error].any?
+            end
+
+            render :action => @action.template_name
+          end
+        end
+
+        register_instance_option :link_icon do
+          'icon-folder-open'
+        end
+      end
+    end
+  end
+end

data/lib/rails_admin_import/config.rb

@@ -0,0 +1,52 @@
+require 'rails_admin_import/config/model'
+# require 'active_support/core_ext/class/attribute_accessors'
+
+module RailsAdminImport
+  module Config
+    class << self
+      # Stores model configuration objects in a hash identified by model's class
+      # name.
+      #
+      # @see RailsAdminImport::Config.model
+      attr_reader :registry
+
+      # Loads a model configuration instance from the registry or registers
+      # a new one if one is yet to be added.
+      #
+      # First argument can be an instance of requested model, its class object,
+      # its class name as a string or symbol or a RailsAdminImport::AbstractModel
+      # instance.
+      #
+      # If a block is given it is evaluated in the context of configuration instance.
+      #
+      # Returns given model's configuration
+      #
+      # @see RailsAdminImport::Config.registry
+      def model(entity, &block)
+        key = entity.name.to_sym
+
+        config = @registry[key] ||= RailsAdminImport::Config::Model.new(entity)
+        config.instance_eval(&block) if block
+        config
+      end
+            
+      # Reset all configurations to defaults.
+      #
+      # @see RailsAdminImport::Config.registry
+      def reset
+        @registry = {}
+      end
+
+      # Reset a provided model's configuration.
+      #
+      # @see RailsAdminImport::Config.registry
+      def reset_model(model)
+        key = model.kind_of?(Class) ? model.name.to_sym : model.to_sym
+        @registry.delete(key)
+      end
+    end
+
+    # Set default values for configuration options on load
+    self.reset
+  end
+end

data/lib/rails_admin_import/config/base.rb

@@ -0,0 +1,62 @@
+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

@@ -0,0 +1,23 @@
+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/engine.rb

@@ -0,0 +1,4 @@
+module RailsAdminImport
+  class Engine < Rails::Engine
+  end
+end

data/lib/rails_admin_import/import.rb

@@ -0,0 +1,186 @@
+require 'open-uri'
+  
+module RailsAdminImport
+  module Import
+    extend ActiveSupport::Concern
+  
+    module ClassMethods
+      def file_fields
+        if self.methods.include?(:attachment_definitions) && !self.attachment_definitions.nil?
+          return self.attachment_definitions.keys
+        end
+        [] 
+      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)
+        if !params.has_key?(:file)
+          return results = { :success => [], :error => ["You must select a file."] }
+        end
+
+        file = CSV.new(params[:file].tempfile)
+        map = {}
+  
+        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 
+  
+        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])] = 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])] = c; hash }
+        end
+ 
+        label_method = RailsAdminImport.config(self).label
+
+        update = params.has_key?(:update_if_exists) && params[:update_if_exists] ? params[:update_lookup].to_sym : nil
+ 
+        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
+              results[:success] << "#{verb}d: #{object.send(label_method)}"
+            else
+              results[:error] << "Failed to #{verb}: #{object.send(label_method)}. Errors: #{object.errors.full_messages.join(', ')}."
+            end
+          else
+            results[:error] << "Errors before save: #{object.send(label_method)}. Errors: #{object.errors.full_messages.join(', ')}."
+          end
+        end
+  
+        results
+      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 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

data/lib/rails_admin_import/version.rb

@@ -0,0 +1,3 @@
+module RailsAdminImport
+  VERSION = "0.0.1"
+end

metadata

@@ -0,0 +1,55 @@
+--- !ruby/object:Gem::Specification
+name: rails_admin_import
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+  prerelease: 
+platform: ruby
+authors:
+- Steph Skardal
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-07-05 00:00:00.000000000 Z
+dependencies: []
+description: 
+email: steph@endpoint.com
+executables: []
+extensions: []
+extra_rdoc_files:
+- README.md
+files:
+- app/views/rails_admin/main/import.html.erb
+- config/locales/import.en.yml
+- lib/rails_admin_import.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/engine.rb
+- lib/rails_admin_import/import.rb
+- lib/rails_admin_import/version.rb
+- README.md
+homepage: 
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.11
+signing_key: 
+specification_version: 3
+summary: Import functionality for rails admin
+test_files: []