active_import 0.0.2

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (44) hide show
  1. data/MIT-LICENSE +20 -0
  2. data/README.rdoc +56 -0
  3. data/Rakefile +37 -0
  4. data/lib/active_import.rb +13 -0
  5. data/lib/active_import/import_csv.rb +99 -0
  6. data/lib/active_import/import_excel.rb +110 -0
  7. data/lib/active_import/model_converter.rb +119 -0
  8. data/lib/active_import/version.rb +3 -0
  9. data/lib/generators/active_import/model_converter_generator.rb +25 -0
  10. data/lib/generators/active_import/templates/data.csv.erb +1 -0
  11. data/lib/generators/active_import/templates/model_converter.rb.erb +45 -0
  12. data/lib/tasks/active_import_tasks.rake +139 -0
  13. data/test/active_import_test.rb +7 -0
  14. data/test/dummy/Rakefile +7 -0
  15. data/test/dummy/app/assets/javascripts/application.js +9 -0
  16. data/test/dummy/app/assets/stylesheets/application.css +7 -0
  17. data/test/dummy/app/controllers/application_controller.rb +3 -0
  18. data/test/dummy/app/helpers/application_helper.rb +2 -0
  19. data/test/dummy/app/views/layouts/application.html.erb +14 -0
  20. data/test/dummy/config.ru +4 -0
  21. data/test/dummy/config/application.rb +45 -0
  22. data/test/dummy/config/boot.rb +10 -0
  23. data/test/dummy/config/database.yml +25 -0
  24. data/test/dummy/config/environment.rb +5 -0
  25. data/test/dummy/config/environments/development.rb +30 -0
  26. data/test/dummy/config/environments/production.rb +60 -0
  27. data/test/dummy/config/environments/test.rb +39 -0
  28. data/test/dummy/config/initializers/backtrace_silencers.rb +7 -0
  29. data/test/dummy/config/initializers/inflections.rb +10 -0
  30. data/test/dummy/config/initializers/mime_types.rb +5 -0
  31. data/test/dummy/config/initializers/secret_token.rb +7 -0
  32. data/test/dummy/config/initializers/session_store.rb +8 -0
  33. data/test/dummy/config/initializers/wrap_parameters.rb +14 -0
  34. data/test/dummy/config/locales/en.yml +5 -0
  35. data/test/dummy/config/routes.rb +58 -0
  36. data/test/dummy/db/test.sqlite3 +0 -0
  37. data/test/dummy/log/test.log +0 -0
  38. data/test/dummy/public/404.html +26 -0
  39. data/test/dummy/public/422.html +26 -0
  40. data/test/dummy/public/500.html +26 -0
  41. data/test/dummy/public/favicon.ico +0 -0
  42. data/test/dummy/script/rails +6 -0
  43. data/test/test_helper.rb +10 -0
  44. metadata +169 -0
@@ -0,0 +1,3 @@
1
+ module ActiveImport
2
+ VERSION = "0.0.2"
3
+ end
@@ -0,0 +1,25 @@
1
+ require 'rails/generators'
2
+
3
+ module ActiveImport
4
+ module Generators
5
+ class ModelConverterGenerator < Rails::Generators::NamedBase
6
+ class_option :converter_name, :type => :string, :default => nil, :desc => "Names the converter file, defaults to the model name"
7
+
8
+ def self.source_root
9
+ @source_root ||= File.join(File.dirname(__FILE__), 'templates')
10
+ end
11
+
12
+ def create_files
13
+ Dir.mkdir("app/model_converters") unless File.directory?("app/model_converters")
14
+ @model_name = file_name
15
+ @class_name = class_name
16
+ @model = eval(@class_name)
17
+ @attributes = @model.attribute_names
18
+ @converter_name = options.converter_name || @class_name
19
+ template 'model_converter.rb.erb', "app/model_converters/#{@converter_name.underscore}_converter.rb"
20
+ Dir.mkdir("db/active_import") unless File.directory?("db/active_import")
21
+ template 'data.csv.erb', "db/active_import/#{@converter_name.underscore}.csv"
22
+ end
23
+ end
24
+ end
25
+ end
@@ -0,0 +1 @@
1
+ <%= CSV.generate { |csv| csv << eval("#{@class_name}.attribute_names") - ["id", "created_at", "updated_at"] } %>
@@ -0,0 +1,45 @@
1
+ # ImportConverter created by ActiveImport
2
+
3
+ class <%= @converter_name.camelize %>Converter < ActiveImport::ModelConverter
4
+ def setup
5
+ <% @attributes.each do |attribute| -%>
6
+ <% unless ["id", "created_at", "updated_at"].include? attribute -%>
7
+ add_column :<%= attribute %>, :match => "<%= attribute %>", :type => :<%= @model.columns_hash[attribute].type %>, :mandatory => true
8
+ <% end -%>
9
+ <% end -%>
10
+ end
11
+
12
+ def before
13
+ end
14
+
15
+ def <%= @model_name %>_attributes
16
+ attributes = {}
17
+
18
+ [<%= [].tap {|list| (@attributes - ["id", "created_at", "updated_at"]).each {|attr| list << ":#{attr}"}}.join(", ") %>].each do |attribute|
19
+ attributes[attribute] = converted_values[attribute]
20
+ end
21
+
22
+ return attributes
23
+ end
24
+
25
+ def save
26
+ # The following line prevents nil values coming from the import overwriting the model attributes
27
+ remove_nil_from_converted_values
28
+
29
+ # For create only
30
+ <%= @model_name %> = <%= @class_name %>.new
31
+ # For create or update, use the following instead and change the attribute name as required
32
+ # <%= @model_name %> = <%= @class_name %>.find_or_create_by_id(converted_values[:id])
33
+
34
+ <%= @model_name %>.update_attributes <%= @model_name %>_attributes
35
+
36
+ return <%= @model_name %>
37
+ end
38
+
39
+ def after
40
+ end
41
+
42
+ def report
43
+ ""
44
+ end
45
+ end
@@ -0,0 +1,139 @@
1
+ require "active_import"
2
+ require "colorize"
3
+
4
+ def import_file_with_path file
5
+ f = file.strip
6
+ unless /^\//.match(f)
7
+ f = File.join(Rails.root, "db", "active_import", f)
8
+ end
9
+ f
10
+ end
11
+
12
+ def process_converter_options options_string
13
+ converter_options = {}
14
+ if options_string
15
+ options = options_string.split(";")
16
+ options.each do |option|
17
+ s = option.split("=")
18
+ converter_options[s[0].strip] = s[1].strip
19
+ end
20
+ end
21
+ converter_options
22
+ end
23
+
24
+ def process_import_options
25
+ converter = ENV["converter"] || ENV["CONVERTER"]
26
+ converter_model = "#{converter.camelize}Converter"
27
+ options = ENV["converter_options"] || ENV["CONVERTER_OPTIONS"]
28
+ converter_options = process_converter_options options
29
+
30
+ puts "Converter Model: #{converter_model.cyan}"
31
+ puts "Converter Options: #{converter_options.to_s.cyan}"
32
+ file = ENV["file"] || ENV["FILE"]
33
+ file ||= "#{converter.underscore}.csv"
34
+ data_file = import_file_with_path file
35
+
36
+ if File.exists?(data_file)
37
+ puts "Found import file: #{data_file}".green
38
+ else
39
+ puts "File doesn't exist': #{data_file}".red
40
+ end
41
+ model_converter = eval("#{converter_model}.new")
42
+ model_converter.options = converter_options
43
+
44
+ return {:data_file => data_file, :model_converter => model_converter}
45
+ end
46
+
47
+ def parse(import, model_converter)
48
+ model_converter.before
49
+ import.parse do |import_row, converter, row_number, total_rows|
50
+ model_converter.process_values import_row
51
+ model = model_converter.save
52
+ if model.respond_to?("errors")
53
+ print "#{row_number.to_s.cyan}: "
54
+ if model.errors.empty?
55
+ puts "OK".green
56
+ else
57
+ model.errors.full_messages.each { |message| puts message.red }
58
+ end
59
+ end
60
+ end
61
+ model_converter.after
62
+ puts model_converter.report
63
+ end
64
+
65
+ def seed_from_file(seed_file_name)
66
+ seed_file = File.open(seed_file_name, "r")
67
+ seed_file.each_line do |seed_line|
68
+ unless (/^#/.match(seed_line))
69
+ seed_info = seed_line.split("|")
70
+ data_file_name = seed_info[0]
71
+ converter_name = seed_info[1]
72
+
73
+ unless data_file_name.nil? || converter_name.nil?
74
+ data_file_name = import_file_with_path data_file_name
75
+
76
+ if (File.exists? data_file_name)
77
+ converter_name.strip!
78
+ converter_options = process_converter_options seed_info[2]
79
+
80
+ puts "Importing from: #{data_file_name.cyan}"
81
+ puts "Using converter: #{converter_name.cyan}"
82
+ puts "Options: #{converter_options.to_s.cyan}"
83
+
84
+ model_converter = eval("#{converter_name.camelize}Converter.new")
85
+ model_converter.options = converter_options
86
+
87
+ import = nil
88
+ extension = File.extname(data_file_name).downcase.strip
89
+ case extension
90
+ when ".xls"
91
+ puts "Excel file detected".yellow
92
+ import = ActiveImport::ImportExcel.new(model_converter, data_file_name)
93
+ when ".xlsx"
94
+ puts "Excel(X) file detected".yellow
95
+ import = ActiveImport::ImportExcel.new(model_converter, data_file_name)
96
+ when ".csv"
97
+ puts "CSV file detected".yellow
98
+ import = ActiveImport::ImportCsv.new(model_converter, data_file_name)
99
+ else
100
+ puts "File type cannot be processed".red
101
+ end
102
+ parse(import, model_converter) unless import.nil?
103
+ else
104
+ puts "Skipping non existing file: #{data_file_name}".red
105
+ end
106
+ end
107
+ end
108
+ end
109
+ end
110
+
111
+ namespace :active_import do
112
+ desc "Load csv file into a model using a model converter"
113
+ task :csv => :environment do
114
+ result = process_import_options
115
+ unless result[:data_file].nil?
116
+ import = ActiveImport::ImportCsv.new(result[:model_converter], result[:data_file])
117
+ parse(import, result[:model_converter])
118
+ end
119
+ end
120
+ desc "Load excel file into a model using a model converter"
121
+ task :excel => :environment do
122
+ result = process_import_options
123
+ unless result[:data_file].nil?
124
+ import = ActiveImport::ImportExcel.new(result[:model_converter], result[:data_file])
125
+ parse(import, result[:model_converter])
126
+ end
127
+ end
128
+ desc "Seed a list of import files"
129
+ task :seed => :environment do
130
+ set = ENV["set"] || ENV["SET"] || ::Rails.env
131
+ seed_file_name = File.join(Rails.root, "db", "active_import", "#{set}.seed")
132
+ if File.exists?(seed_file_name)
133
+ puts "Seeding from file: '#{seed_file_name.yellow}'"
134
+ seed_from_file seed_file_name
135
+ else
136
+ puts "Cannot find seed file: '#{seed_file_name}'".red
137
+ end
138
+ end
139
+ end
@@ -0,0 +1,7 @@
1
+ require 'test_helper'
2
+
3
+ class ActiveImportTest < ActiveSupport::TestCase
4
+ test "truth" do
5
+ assert_kind_of Module, ActiveImport
6
+ end
7
+ end
@@ -0,0 +1,7 @@
1
+ #!/usr/bin/env rake
2
+ # Add your own tasks in files placed in lib/tasks ending in .rake,
3
+ # for example lib/tasks/capistrano.rake, and they will automatically be available to Rake.
4
+
5
+ require File.expand_path('../config/application', __FILE__)
6
+
7
+ Dummy::Application.load_tasks
@@ -0,0 +1,9 @@
1
+ // This is a manifest file that'll be compiled into including all the files listed below.
2
+ // Add new JavaScript/Coffee code in separate files in this directory and they'll automatically
3
+ // be included in the compiled file accessible from http://example.com/assets/application.js
4
+ // It's not advisable to add code directly here, but if you do, it'll appear at the bottom of the
5
+ // the compiled file.
6
+ //
7
+ //= require jquery
8
+ //= require jquery_ujs
9
+ //= require_tree .
@@ -0,0 +1,7 @@
1
+ /*
2
+ * This is a manifest file that'll automatically include all the stylesheets available in this directory
3
+ * and any sub-directories. You're free to add application-wide styles to this file and they'll appear at
4
+ * the top of the compiled file, but it's generally better to create a new file per style scope.
5
+ *= require_self
6
+ *= require_tree .
7
+ */
@@ -0,0 +1,3 @@
1
+ class ApplicationController < ActionController::Base
2
+ protect_from_forgery
3
+ end
@@ -0,0 +1,2 @@
1
+ module ApplicationHelper
2
+ end
@@ -0,0 +1,14 @@
1
+ <!DOCTYPE html>
2
+ <html>
3
+ <head>
4
+ <title>Dummy</title>
5
+ <%= stylesheet_link_tag "application" %>
6
+ <%= javascript_include_tag "application" %>
7
+ <%= csrf_meta_tags %>
8
+ </head>
9
+ <body>
10
+
11
+ <%= yield %>
12
+
13
+ </body>
14
+ </html>
@@ -0,0 +1,4 @@
1
+ # This file is used by Rack-based servers to start the application.
2
+
3
+ require ::File.expand_path('../config/environment', __FILE__)
4
+ run Dummy::Application
@@ -0,0 +1,45 @@
1
+ require File.expand_path('../boot', __FILE__)
2
+
3
+ require 'rails/all'
4
+
5
+ Bundler.require
6
+ require "active_import"
7
+
8
+ module Dummy
9
+ class Application < Rails::Application
10
+ # Settings in config/environments/* take precedence over those specified here.
11
+ # Application configuration should go into files in config/initializers
12
+ # -- all .rb files in that directory are automatically loaded.
13
+
14
+ # Custom directories with classes and modules you want to be autoloadable.
15
+ # config.autoload_paths += %W(#{config.root}/extras)
16
+
17
+ # Only load the plugins named here, in the order given (default is alphabetical).
18
+ # :all can be used as a placeholder for all plugins not explicitly named.
19
+ # config.plugins = [ :exception_notification, :ssl_requirement, :all ]
20
+
21
+ # Activate observers that should always be running.
22
+ # config.active_record.observers = :cacher, :garbage_collector, :forum_observer
23
+
24
+ # Set Time.zone default to the specified zone and make Active Record auto-convert to this zone.
25
+ # Run "rake -D time" for a list of tasks for finding time zone names. Default is UTC.
26
+ # config.time_zone = 'Central Time (US & Canada)'
27
+
28
+ # The default locale is :en and all translations from config/locales/*.rb,yml are auto loaded.
29
+ # config.i18n.load_path += Dir[Rails.root.join('my', 'locales', '*.{rb,yml}').to_s]
30
+ # config.i18n.default_locale = :de
31
+
32
+ # Configure the default encoding used in templates for Ruby 1.9.
33
+ config.encoding = "utf-8"
34
+
35
+ # Configure sensitive parameters which will be filtered from the log file.
36
+ config.filter_parameters += [:password]
37
+
38
+ # Enable the asset pipeline
39
+ config.assets.enabled = true
40
+
41
+ # Version of your assets, change this if you want to expire all your assets
42
+ config.assets.version = '1.0'
43
+ end
44
+ end
45
+
@@ -0,0 +1,10 @@
1
+ require 'rubygems'
2
+ gemfile = File.expand_path('../../../../Gemfile', __FILE__)
3
+
4
+ if File.exist?(gemfile)
5
+ ENV['BUNDLE_GEMFILE'] = gemfile
6
+ require 'bundler'
7
+ Bundler.setup
8
+ end
9
+
10
+ $:.unshift File.expand_path('../../../../lib', __FILE__)
@@ -0,0 +1,25 @@
1
+ # SQLite version 3.x
2
+ # gem install sqlite3
3
+ #
4
+ # Ensure the SQLite 3 gem is defined in your Gemfile
5
+ # gem 'sqlite3'
6
+ development:
7
+ adapter: sqlite3
8
+ database: db/development.sqlite3
9
+ pool: 5
10
+ timeout: 5000
11
+
12
+ # Warning: The database defined as "test" will be erased and
13
+ # re-generated from your development database when you run "rake".
14
+ # Do not set this db to the same as development or production.
15
+ test:
16
+ adapter: sqlite3
17
+ database: db/test.sqlite3
18
+ pool: 5
19
+ timeout: 5000
20
+
21
+ production:
22
+ adapter: sqlite3
23
+ database: db/production.sqlite3
24
+ pool: 5
25
+ timeout: 5000
@@ -0,0 +1,5 @@
1
+ # Load the rails application
2
+ require File.expand_path('../application', __FILE__)
3
+
4
+ # Initialize the rails application
5
+ Dummy::Application.initialize!
@@ -0,0 +1,30 @@
1
+ Dummy::Application.configure do
2
+ # Settings specified here will take precedence over those in config/application.rb
3
+
4
+ # In the development environment your application's code is reloaded on
5
+ # every request. This slows down response time but is perfect for development
6
+ # since you don't have to restart the web server when you make code changes.
7
+ config.cache_classes = false
8
+
9
+ # Log error messages when you accidentally call methods on nil.
10
+ config.whiny_nils = true
11
+
12
+ # Show full error reports and disable caching
13
+ config.consider_all_requests_local = true
14
+ config.action_controller.perform_caching = false
15
+
16
+ # Don't care if the mailer can't send
17
+ config.action_mailer.raise_delivery_errors = false
18
+
19
+ # Print deprecation notices to the Rails logger
20
+ config.active_support.deprecation = :log
21
+
22
+ # Only use best-standards-support built into browsers
23
+ config.action_dispatch.best_standards_support = :builtin
24
+
25
+ # Do not compress assets
26
+ config.assets.compress = false
27
+
28
+ # Expands the lines which load the assets
29
+ config.assets.debug = true
30
+ end
@@ -0,0 +1,60 @@
1
+ Dummy::Application.configure do
2
+ # Settings specified here will take precedence over those in config/application.rb
3
+
4
+ # Code is not reloaded between requests
5
+ config.cache_classes = true
6
+
7
+ # Full error reports are disabled and caching is turned on
8
+ config.consider_all_requests_local = false
9
+ config.action_controller.perform_caching = true
10
+
11
+ # Disable Rails's static asset server (Apache or nginx will already do this)
12
+ config.serve_static_assets = false
13
+
14
+ # Compress JavaScripts and CSS
15
+ config.assets.compress = true
16
+
17
+ # Don't fallback to assets pipeline if a precompiled asset is missed
18
+ config.assets.compile = false
19
+
20
+ # Generate digests for assets URLs
21
+ config.assets.digest = true
22
+
23
+ # Defaults to Rails.root.join("public/assets")
24
+ # config.assets.manifest = YOUR_PATH
25
+
26
+ # Specifies the header that your server uses for sending files
27
+ # config.action_dispatch.x_sendfile_header = "X-Sendfile" # for apache
28
+ # config.action_dispatch.x_sendfile_header = 'X-Accel-Redirect' # for nginx
29
+
30
+ # Force all access to the app over SSL, use Strict-Transport-Security, and use secure cookies.
31
+ # config.force_ssl = true
32
+
33
+ # See everything in the log (default is :info)
34
+ # config.log_level = :debug
35
+
36
+ # Use a different logger for distributed setups
37
+ # config.logger = SyslogLogger.new
38
+
39
+ # Use a different cache store in production
40
+ # config.cache_store = :mem_cache_store
41
+
42
+ # Enable serving of images, stylesheets, and JavaScripts from an asset server
43
+ # config.action_controller.asset_host = "http://assets.example.com"
44
+
45
+ # Precompile additional assets (application.js, application.css, and all non-JS/CSS are already added)
46
+ # config.assets.precompile += %w( search.js )
47
+
48
+ # Disable delivery errors, bad email addresses will be ignored
49
+ # config.action_mailer.raise_delivery_errors = false
50
+
51
+ # Enable threaded mode
52
+ # config.threadsafe!
53
+
54
+ # Enable locale fallbacks for I18n (makes lookups for any locale fall back to
55
+ # the I18n.default_locale when a translation can not be found)
56
+ config.i18n.fallbacks = true
57
+
58
+ # Send deprecation notices to registered listeners
59
+ config.active_support.deprecation = :notify
60
+ end