active_admin_importer 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c4469bf0e26ddf3c84800aed672a1729c0893b06
-  data.tar.gz: b85ef234d5ed264bb327f2d4936a79e245032827
+  metadata.gz: 63ec9935374bfd592cc9c2035ce8304660ca4e1b
+  data.tar.gz: 5674df2b7741e145b0b6d128397170cfb64ed11e
 SHA512:
-  metadata.gz: 8f84bb74980ef292b9946ec7bf1105f81ff1ee574becf5389e41e317d38d2a6d9623d1de016a26f00233781e2f0daee81f51795336f6ebe8dd3e02c318322dfb
-  data.tar.gz: d6d117b5e3f695b6f56d17c30676961e661457b76aff559244fac8db8cdf72fd31a202fb226d8aab401901b2f49c42a021de5e665b74a8adaeeebbdc1eb41bfb
+  metadata.gz: be21e9b80705a71d7fcdda60bf34cdf0057b9ffe06a9e45301e19f41b6fb0349f6a0a14dfbd7f05a187d1e2fb136a491723714b7be2c10fc4ea42ea34594a759
+  data.tar.gz: 4d08eaf02625782de3537837cf5357091835f4129064cd044c06ab099df9e2247c6be3a34e9289c91018b86f9918c8d47c31b7c2fba012c4730a5be548007157

data/README.md

@@ -12,27 +12,61 @@ Simple CSV imports for active_admin, that (shouldn't) destroy your servers memor
 
 ``` ruby
 ::ActiveAdmin.register Product do
-  define_import_for :products do |model, import_params, controller|
-    product_attributes = import_params.slice(*[:name, :price])
-    product_attributes[:user_id] = controller.current_user.id
-    model.create!(product_attributes)
+  define_import_for :products do
+    each_row do |params, import|
+      product_attributes = params.slice(*[:name, :price])
+      product_attributes[:user_id] = import.controller.current_user.id
+      import.model.create!(product_attributes)
+    end
   end
 
   #Example: require headers to be present
-  define_import_for :products_on_sale, :required_headers => ["sale_price"] do |model, import_params, controller|
-    product_attributes = import_params.slice(*[:name, :price, :sale_price])
-    product_attributes[:user_id] = controller.current_user.id
-    model.create!(product_attributes)
+  define_import_for :products_on_sale do
+    required_headers "sale_price", "price"
+
+    each_row do |params, import|
+      product_attributes = params.slice(*[:name, :price, :sale_price])
+      product_attributes[:user_id] = import.controller.current_user.id
+      import.model.create!(product_attributes)
+    end
   end
 
   # Example: using a custom view
   # assume the view has a dropdown which allows you to select a particular store during import
-  define_import_for :products_for_store, :view => "myactiveadmin/products/upload_products_for_store_csv"
-  do |model, import_params, controller|
-    product_attributes = import_params.slice(*[:name, :price, :sale_price])
-    product_attributes[:user_id] = controller.current_user.id
-    product_attributes[:store_id] = controller.params["store_id"]
-    model.create!(product_attributes)
+  define_import_for :products_for_store do
+    view "myactiveadmin/products/upload_products_for_store_csv"
+
+    each_row do |params, import|
+      product_attributes = params.slice(*[:name, :price, :sale_price])
+      product_attributes[:user_id] = import.controller.current_user.id
+      product_attributes[:store_id] = import.controller.params["store_id"]
+      import.model.create!(product_attributes)
+    end
+  end
+
+  # Example: using a Trax::Core transformer class,
+  # or transformer that responds to to_hash
+  define_import_for :products_for_store do
+    view "myactiveadmin/products/upload_products_for_store_csv"
+    transformer ::ProductForStoreTransformer
+
+    each_row do |params, import|
+      product_attributes[:user_id] = import.controller.current_user.id
+      product_attributes[:store_id] = import.controller.params["store_id"]
+      import.model.create!(product_attributes)
+    end
+  end
+
+  # Example: using transform as callback
+  define_import_for :products_for_store do
+    view "myactiveadmin/products/upload_products_for_store_csv"
+    transform { |row| ::ProductForStoreTransformer.new(row).to_hash }
+
+    each_row do |params, import|
+      product_attributes[:user_id] = import.controller.current_user.id
+      product_attributes[:store_id] = import.controller.params["store_id"]
+      import.model.create!(product_attributes)
+    end
   end
 end
 ```

data/lib/active_admin_importer.rb

@@ -1,14 +1,17 @@
 require "active_admin_importer/version"
 require "active_support/all"
 require "active_admin_importer/engine"
+require "pry"
 
 module ActiveAdminImporter
   extend ::ActiveSupport::Autoload
 
+  autoload :Definition
   autoload :DSL
   autoload :Engine
   autoload :CsvFile
   autoload :Import
+  autoload :Registry
 
   def self.import(csv_file, **options, &block)
     io = csv_file.is_a?(::ActionDispatch::Http::UploadedFile) ? csv_file.tempfile : csv_file
@@ -22,4 +25,21 @@ module ActiveAdminImporter
     _import.run if _import.valid?
     _import
   end
+
+  def self.[](val)
+    registry[val]
+  end
+
+  def self.registry
+    @registry ||= ::ActiveAdminImporter::Registry.new
+  end
+
+  def self.register(definition)
+    @registry[definition.key] = definition
+  end
+end
+
+unless ENV["SKIP_ACTIVE_ADMIN_REQUIRE"]
+  require 'activeadmin' unless defined?(::ActiveAdmin)
+  ::ActiveAdmin::DSL.send(:include, ActiveAdminImporter::DSL)
 end

data/lib/active_admin_importer/definition.rb

@@ -0,0 +1,63 @@
+module ActiveAdminImporter
+  class Definition
+    def initialize(_name=:records, _controller,  &block)
+      @_name = _name
+      @_action = "import_#{@_name}"
+      @_form_action = "upload_#{@_name}"
+      @_view = "admin/csv/upload"
+      @_required_headers ||= []
+      @_controller = _controller
+      @_model = @_controller.resource_class
+      @_each_row = lambda{ |params| @_model.create!(params) }
+      self.instance_eval(&block) if block_given?
+    end
+
+    def [](val)
+      self.instance_variable_get(:"@_#{val}")
+    end
+
+    def action(val)
+      @_action = val
+    end
+
+    def after(&block)
+      @_after = block
+    end
+
+    def before(&block)
+      @_before = block
+    end
+
+    def key
+      "#{self[:controller].name.underscore}/#{self[:name]}"
+    end
+
+    def model(val)
+      @_model = val
+    end
+
+    def each_row(&block)
+      @_each_row = block
+    end
+
+    def form_action(val)
+      @_form_action = val
+    end
+
+    def required_headers(*_values)
+      @_required_headers = _values
+    end
+
+    def transformer(val)
+      @_transformer = val
+    end
+
+    def transform(&block)
+      @_transform = block
+    end
+
+    def view(value)
+      @_view = value
+    end
+  end
+end

data/lib/active_admin_importer/dsl.rb

@@ -1,29 +1,23 @@
 module ActiveAdminImporter
   module DSL
-    def define_import_for(name='records', **options, &block)
-      options[:action] ||= "import_#{name}"
-      options[:form_action] ||= "upload_#{name}"
-      options[:view] ||= "admin/csv/upload"
-      options[:required_headers] ||= []
+    def define_import_for(name='records', &block)
+      definition = ::ActiveAdminImporter::Definition.new(name, self.controller, &block)
 
       action_item :edit, :only => :index do
-        link_to options[:action].titleize, :action => options[:form_action]
+        link_to definition[:action].titleize, :action => definition[:form_action]
       end
 
-      collection_action(options[:form_action]) do
-        render options[:view], :locals => { :target_action => options[:action] }
+      collection_action(definition[:form_action]) do
+        render definition[:view], :locals => { :target_action => definition[:action] }
       end
 
-      collection_action(options[:action], :method => :post) do
+      collection_action(definition[:action], :method => :post) do
         parent if parent?
-        import = ::ActiveAdminImporter.import(params[:dump][:file],
-                                              :model => active_admin_config.resource_class,
-                                              :controller => self,
-                                              :required_headers => options[:required_headers],
-                                              &block)
-
+        import = ::ActiveAdminImporter.import(params[:dump][:file], :controller => self, :definition => definition)
         redirect_to collection_path(), alert: import.result
       end
+
+      ::ActiveAdminImporter.register(definition)
     end
   end
 end

data/lib/active_admin_importer/engine.rb

@@ -3,10 +3,5 @@ require 'rails'
 module ActiveAdminImporter
   class Engine < ::Rails::Engine
     config.mount_at = '/'
-
-    config.after_initialize do
-      require "active_admin"
-      ::ActiveAdmin::DSL.send(:include, ActiveAdminImporter::DSL)
-    end
   end
 end

data/lib/active_admin_importer/import.rb

@@ -1,14 +1,14 @@
 module ActiveAdminImporter
   class Import
-    attr_reader :current_row, :csv_file
+    attr_reader :controller, :current_row, :csv_file, :definition, :model
 
-    def initialize(csv_file, controller:, model:, required_headers:[], &block)
+    def initialize(csv_file, definition:, controller:)
       @csv_file = ::ActiveAdminImporter::CsvFile.new(csv_file)
       @controller = controller
-      @model = model
-      @required_headers = required_headers
+      @definition = definition
+      @model = definition[:model]
+      @required_headers = definition[:required_headers]
       @current_row = 0
-      @block = block if block_given?
     end
 
     def failed_rows
@@ -19,7 +19,12 @@ module ActiveAdminImporter
       @headers ||= @csv_file.headers
     end
 
+    def md5
+      @md5 ||= @csv_file.md5
+    end
+
     def run
+      run_before_callback if run_before_callback?
       log_info("STARTING IMPORT")
 
       ::CSV.parse(@csv_file, :headers => true, :header_converters => :symbol) do |row|
@@ -32,6 +37,7 @@ module ActiveAdminImporter
 
       log_error("FAILED TO PARSE ROWS #{failed_rows}") if failed_rows.any?
       log_info("FINISHED IMPORT")
+      run_after_callback if run_after_callback?
     end
 
     def result
@@ -50,17 +56,23 @@ module ActiveAdminImporter
 
     private
 
+    def log_error(message)
+      ::Rails.logger.error("[IMPORT: #{self.md5}]: #{message}")
+    end
+
+    def log_info(message)
+      ::Rails.logger.info("[IMPORT: #{self.md5}]: #{message}")
+    end
+
     def process_row(row)
       @current_row += 1
       log_info("IMPORTING ROW - #{current_row}")
       data = row.to_hash
 
       if data.present?
-        if @block
-          @block.call(@model, data, @controller)
-        else
-          @model.create!(data)
-        end
+        data = @definition[:transformer].new(data).to_hash if @definition[:transformer]
+        data = @definition[:transform].call(data) if @definition[:transform]
+        @definition[:each_row].call(data, self)
       end
     end
 
@@ -71,12 +83,20 @@ module ActiveAdminImporter
       ::Rails.logger.error(e.message)
     end
 
-    def log_error(message)
-      ::Rails.logger.error("[IMPORT: #{@csv_file.md5}]: #{message}")
+    def run_after_callback
+      self.instance_eval(&@definition[:after])
     end
 
-    def log_info(message)
-      ::Rails.logger.info("[IMPORT: #{@csv_file.md5}]: #{message}")
+    def run_after_callback?
+      @definition[:after]
+    end
+
+    def run_before_callback
+      self.instance_eval(&@definition[:before])
+    end
+
+    def run_before_callback?
+      @definition[:before]
     end
   end
 end

data/lib/active_admin_importer/registry.rb

@@ -0,0 +1,11 @@
+module ActiveAdminImporter
+  class Registry < SimpleDelegator
+    def initialize
+      @obj = {}
+    end
+
+    def [](val)
+      @obj[val]
+    end
+  end
+end

data/lib/active_admin_importer/version.rb

@@ -1,3 +1,3 @@
 module ActiveAdminImporter
-  VERSION = "0.1.0"
+  VERSION = "0.1.1"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: active_admin_importer
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Jason Ayre
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-03-23 00:00:00.000000000 Z
+date: 2017-04-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -143,9 +143,11 @@ files:
 - bin/setup
 - lib/active_admin_importer.rb
 - lib/active_admin_importer/csv_file.rb
+- lib/active_admin_importer/definition.rb
 - lib/active_admin_importer/dsl.rb
 - lib/active_admin_importer/engine.rb
 - lib/active_admin_importer/import.rb
+- lib/active_admin_importer/registry.rb
 - lib/active_admin_importer/version.rb
 homepage: https://github.com/jasonayre/active_admin_importer
 licenses: