active_admin_csv_import 1.3.1 → 2.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 2c9d7a33e6c9e9fffec9f8419ea64d952ffbada9
+  data.tar.gz: 0e232f0c116103a0bf0a9b36003fa6415ca60e71
+SHA512:
+  metadata.gz: 80657c5898a31b15f3ae616d85ef0d3e94be6fd11ef027490d7ce4f71d5cefcecc2fe2e60d215050519bf8681cf57e1e2c03f753878949f526e29215f05ba81d
+  data.tar.gz: 33c6d1e53db05fa0f0e14468128aa22589f8657b18a61f2589a2374ff8bab7d1af95799ff493687dafcba6702dd1addf844e6033d29f4725e4a6565aa8eb2e40

data/README.md

@@ -0,0 +1,68 @@
+ActiveAdminCSVImport
+=======================
+
+[![Build Status](https://travis-ci.org/Papercloud/active_admin_csv_import.svg?branch=master)](https://travis-ci.org/Papercloud/active_admin_csv_import)
+
+- Add CSV import with one line of code
+- Parses the file client-side and imports line-by-line to avoid Heroku timeouts
+- Validates the CSV has the correct column names before importing.
+
+Inspired by https://github.com/krhorst/active_admin_importable and makes use of Recline.js. This is a relatively heavy solution with a lot of JS dependencies, but should be easier for large imports on Heroku than first uploading to a file server.
+
+## Compatibility
+
+As of v2.0.0 Active Admin master with Rails 4.1 is supported. For older versions of Active Admin use v1 of active_admin_csv_import.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'active_admin_csv_import'
+
+And then execute:
+
+    $ bundle
+
+## Usage
+
+Add 'csv_importable' into your active admin resource:
+
+```
+ActiveAdmin.register Thing do
+  csv_importable :columns => [:code, :name, :state_name],
+                              :import_unique_key => :code
+end
+```
+
+An import button should appear on the resource's index page. All columns are expected other than id, updated_at and created_at.
+
+## Demo
+
+http://active-admin-csv-import.herokuapp.com/admin
+```
+admin@example.com
+password
+```
+Source: https://github.com/Papercloud/active-admin-csv-import-example
+
+## Use other delimiter than semicolon
+
+In `config/initializers/active_admin.rb`, search `csv_options` and set the csv separator as it's showed in the file.
+
+## Wishlist / TODOS
+
+1. Add Appraisal to test against multiple versions of Rails
+
+## Specs
+```
+bundle exec rspec spec
+```
+The test suite is limited, but it's a start.
+
+## Contributing
+
+1. Fork it
+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

data/app/models/concerns/active_admin_csv_import/convenience.rb

@@ -1,26 +1,27 @@
-module ActiveAdminCsvImport::Convenience
-  extend ActiveSupport::Concern
+module ActiveAdminCsvImport
+  module Convenience
+    extend ActiveSupport::Concern
 
-  module ClassMethods
-    # Look up a belongs_to association by name.
-    # E.g.
-    # lookup_belongs_to :state, by: :name
-    # Adds state_name as an ivar.
-    def lookup_belongs_to(name, options)
+    module ClassMethods
+      # Look up a belongs_to association by name.
+      # E.g.
+      # lookup_belongs_to :state, by: :name
+      # Adds state_name as an ivar.
+      def lookup_belongs_to(name, options)
+        lookup_by = options[:by]
 
-      lookup_by = options[:by]
+        code = <<-eoruby
+        attr_accessor :#{name}_#{lookup_by}
 
-      code = <<-eoruby
-      attr_accessor :#{name}_#{lookup_by}
+        before_validation :lookup_#{name}_by_#{lookup_by}
 
-      before_validation :lookup_#{name}_by_#{lookup_by}
-
-      def lookup_#{name}_by_#{lookup_by}
-        return if self.#{name}_#{lookup_by}.blank?
-        self.#{name} = '#{name}'.camelize.constantize.where(#{lookup_by}: self.#{name}_#{lookup_by}).first
+        def lookup_#{name}_by_#{lookup_by}
+          return if self.#{name}_#{lookup_by}.blank?
+          self.#{name} = '#{name}'.camelize.constantize.where(#{lookup_by}: self.#{name}_#{lookup_by}).first
+        end
+        eoruby
+        class_eval(code)
       end
-      eoruby
-      class_eval(code)
     end
   end
 end

data/lib/active_admin_csv_import.rb

@@ -1,10 +1,10 @@
-require "active_admin_csv_import/engine"
-require "active_admin_csv_import/dsl"
-require "active_admin_csv_import/railtie"
-require "active_admin_csv_import/version"
+require 'active_admin_csv_import/engine'
+require 'active_admin_csv_import/dsl'
+require 'active_admin_csv_import/railtie'
+require 'active_admin_csv_import/version'
 require 'activeadmin'
 
 module ActiveAdminCsvImport
 end
 
-::ActiveAdmin::DSL.send(:include, ActiveAdminCsvImport::DSL)
+::ActiveAdmin::DSL.send(:include, ActiveAdminCsvImport::DSL)

data/lib/active_admin_csv_import/dsl.rb

@@ -2,17 +2,17 @@ require 'csv'
 
 module ActiveAdminCsvImport
   module DSL
-
-    def csv_importable(options={})
-
+    def csv_importable(options = {})
       # All columns
-      columns = options[:columns] ||= active_admin_config.resource_class.columns.map(&:name) - ["id", "updated_at", "created_at"]
+      columns = options[:columns] ||= active_admin_config.resource_class.columns.map(&:name) - %(id updated_at created_at)
 
-      # Required columns. A subset of all columns. A client-side validation error is raised if one of these is not found.
+      # Required columns. A subset of all columns.
+      # A client-side validation error is raised if one of these is not found.
       required_columns = options[:required_columns] ||= columns
 
-      action_item :only => :index do
-        link_to "Import #{active_admin_config.resource_name.to_s.pluralize}", :action => 'import_csv'
+      action_item :import_csv, :only => :index do
+        link_to "Import #{active_admin_config.resource_name.to_s.pluralize}",
+                :action => 'import_csv'
       end
 
       # Returns an example CSV based on the columns expected for import.
@@ -20,27 +20,31 @@ module ActiveAdminCsvImport
         csv_column_names = CSV.generate do |csv|
           csv << columns.map(&:to_s).map(&:humanize)
         end
-        send_data(csv_column_names, :type => 'text/csv; charset=utf-8; header=present', :filename => active_admin_config.resource_class.name.to_s.pluralize + ".csv")
+        send_data(csv_column_names,
+                  type: 'text/csv; charset=utf-8; header=present',
+                  filename: active_admin_config
+                            .resource_class.name.to_s.pluralize + '.csv')
       end
 
-      # Shows the form and JS which accepts a CSV file, parses it and posts each row to the server.
+      # Shows the form and JS which accepts a CSV file,
+      # parses it and posts each row to the server.
       collection_action :import_csv do
         @columns           = columns
         @required_columns  = required_columns
 
         @post_path  = options[:path].try(:call)
-        @post_path ||= collection_path + "/import_rows"
+        @post_path ||= collection_path + '/import_rows'
 
         @redirect_path = options[:redirect_path].try(:call)
         @redirect_path ||= collection_path
 
         @delimiter = options[:delimiter]
 
-        render "admin/csv/import_csv"
+        render 'admin/csv/import_csv'
       end
 
       # Receives each row and saves it
-      collection_action :import_rows, :method => :post do
+      collection_action :import_rows, method: :post do
 
         @failures = []
 
@@ -49,9 +53,9 @@ module ActiveAdminCsvImport
           row_number = row_params.delete('_row')
 
           resource = existing_row_resource(options[:import_unique_key], row_params)
-          resource ||= active_admin_config.resource_class.new()
+          resource ||= active_admin_config.resource_class.new
 
-          if not update_row_resource(resource, row_params)
+          unless update_row_resource(resource, row_params)
             @failures << {
               row_number: row_number,
               resource: resource
@@ -59,7 +63,7 @@ module ActiveAdminCsvImport
           end
         end
 
-        render :partial => "admin/csv/import_csv_failed_row", :status => 200
+        render partial: 'admin/csv/import_csv_failed_row', status: 200
       end
 
       # Rails 4 Strong Parameters compatibility and backwards compatibility.
@@ -90,11 +94,9 @@ module ActiveAdminCsvImport
           value = params[lookup_column]
           return unless value.present?
 
-          return active_admin_config.resource_class.send(finder_method, value)
+          active_admin_config.resource_class.send(finder_method, value)
         end
       end
-
     end
-
   end
 end

data/lib/active_admin_csv_import/railtie.rb

@@ -1,8 +1,8 @@
 class Railtie < ::Rails::Railtie
-  initializer "active_admin_csv_import.setup_vendor", :after => "active_admin_csv_import.setup", :group => :all do |app|
-    vendor_path = File.expand_path("../../vendor/assets", __FILE__)
+  initializer 'active_admin_csv_import.setup_vendor', after: 'active_admin_csv_import.setup', group: :all do |app|
+    vendor_path = File.expand_path('../../vendor/assets', __FILE__)
     app.config.assets.paths.push(vendor_path.to_s)
 
     app.config.assets.precompile += %w( active_admin_csv_import/import_csv.js )
   end
-end
+end

data/lib/active_admin_csv_import/version.rb

@@ -1,3 +1,3 @@
 module ActiveAdminCsvImport
-  VERSION = "1.3.1"
+  VERSION = "2.0.0"
 end

metadata

@@ -1,38 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: active_admin_csv_import
 version: !ruby/object:Gem::Version
-  version: 1.3.1
-  prerelease: 
+  version: 2.0.0
 platform: ruby
 authors:
 - Tomas Spacek
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-01-13 00:00:00.000000000 Z
+date: 2015-01-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
-  requirement: &70177170926380 !ruby/object:Gem::Requirement
-    none: false
+  requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '3.1'
+        version: '4.0'
   type: :runtime
   prerelease: false
-  version_requirements: *70177170926380
-- !ruby/object:Gem::Dependency
-  name: railties
-  requirement: &70177170940860 !ruby/object:Gem::Requirement
-    none: false
+  version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '3.1'
-  type: :runtime
-  prerelease: false
-  version_requirements: *70177170940860
+        version: '4.0'
 description: CSV import for Active Admin capable of handling CSV files too large to
   import via direct file upload to Heroku
 email:
@@ -41,16 +32,19 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- MIT-LICENSE
+- README.md
+- Rakefile
 - app/assets/javascripts/active_admin_csv_import/import_csv.js
 - app/models/concerns/active_admin_csv_import/convenience.rb
 - app/views/admin/csv/_import_csv_failed_row.html.erb
 - app/views/admin/csv/_instructions.html.erb
 - app/views/admin/csv/import_csv.html.erb
+- lib/active_admin_csv_import.rb
 - lib/active_admin_csv_import/dsl.rb
 - lib/active_admin_csv_import/engine.rb
 - lib/active_admin_csv_import/railtie.rb
 - lib/active_admin_csv_import/version.rb
-- lib/active_admin_csv_import.rb
 - vendor/assets/javascripts/backbone/backbone.js
 - vendor/assets/javascripts/backbone/json2.js
 - vendor/assets/javascripts/backbone/underscore.js
@@ -58,32 +52,28 @@ files:
 - vendor/assets/javascripts/recline/backend.memory.js
 - vendor/assets/javascripts/recline/model.js
 - vendor/assets/javascripts/underscore.string.min.js
-- MIT-LICENSE
-- Rakefile
-- README.rdoc
 homepage: http://www.papercloud.com.au
 licenses: []
+metadata: {}
 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.15
+rubygems_version: 2.2.2
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: Add CSV import to Active Admin
 test_files: []
 has_rdoc: 

data/README.rdoc

@@ -1,3 +0,0 @@
-= ActiveAdminCsvImport
-
-This project rocks and uses MIT-LICENSE.