Comprehensive Wiki here : https://github.com/autotelik/datashift/wiki
Datashift is a suite of tools to help you import or export data from a Rails application.
Formats currently supported are Excel, CSV files and paperclip attachments.
Add gem 'datashift' to your Gemfile/bundle or use
Win OLE and MS Excel are NOT required to use the Excel functionality.
Datashift automatically maps your files headers to your active record model attributes.
When your files differ from your models, it provides tools to generate a mapping document, so you can map source headers, to the destination target in your database.
Data transformations are supported, again via configuration setttings, which support
Defaults - Where your column is empty, provide a default value to be used.
Overrides - When you want to provide a default value in all cases, or set a value even when you have no inbound data.
Prefixes/Postfixes - Amend data on the fly. e.g if you wish to prepend a string id to a reference type field.
Paperclip support enables the bulk load of paperclip supported filetypes from the filesystem.
The loaded content is automatically attached to the model containing the
Matching to this right attachment model instance, is performed using the filename.
The database field to match on, and the filename matching pattern are all configurable.
Current high level applications, are provided through command line tasks, although the API is available to use throughout your app.
An engine version with MVC applications is in the pipeline.
To use the Thor command line applications, pull in the tasks.
Create or add to a high level .thor file in your lib/tasks or root directory
Edit the file and add the following to pull in the datashift thor commands :
require 'thor' require 'datashift' DataShift::load_commands
To keep the availability to only development mode use
To check the available tasks run
bundle exec thor list datashift
To get usage information use thor help , for example
bundle exec thor help datashift:generate:excel
Use CSV or Excel/OpenOffice/LibraOffice etc (.xls) files to Import or Export your database (ActiveRecord) models
Bulk import tools from filesystem, for Paperclip attachments, takes folder of attachments such as images/mp3s/files and use the file name to find and attach to DB models. For example look up a product, by it's '''SKU''', based on the SKU being present the image filename, and attache that image to the product's '''images''' association
Supports export of all association types, in either hash or json formats.
Association types to include/exclude can be set in configuration as well as speciifc columsn to exclude.
Rails standard columns such as id, created_at etc can also be easily excluded via Configuration.
Set default values, substitutions and transformations per column for Imports.
Generate sample templates, with only headers.
Export template and populate with model data.
Please use thor list and thor help to get latest command lines, for example
'''ruby bundle exec thor datashift:import:csv --model BlogPost --input BlogPostImport.csv '''
Imports are based on column headings with Semi-Smart Name Lookup
On import, a dictionary of all possible attributes and associations is created for the AR class.
This enables lookup, of a user supplied name (column heading), managing white space, pluralisation etc .
Example usage, load from a file or spreadsheet where the column names are only an approximation of the actual associations, so given 'Product Properties' heading, finds real association 'product_properties' to send or call on the AR object
Can import 'belongs_to, 'has_many' and 'has_one' associations, including assignment of multiple objects via either multiple columns, or via single column containing multiple entries in json/HASH format.
See Wiki for more details on DSL syntax.
You can now configure datashift with a standard initialisation block
To generate a configuration file template, for import see
thor help datashift:generate:config:import
Specs run against a rails sandbox app, so have own Gemfile, so you can specify versions of active record that you want specs to run against : Edit
Then run :
cd spec bundle install
A sandbox will be generated in spec/sandbox if no such directory exists. **N.B Manual Step** When changing versions you probably need to **delete this whole directory** spec/sandbox. Next time you run spree specs it will be auto generated using latest Rails versions The database are created in sqlite3 and are stored in spec/fixtures. When switching versions, of say Spree, you will probably want to and to clear out old versions and retrigger the migrations rm spec/fixtures/*.sqlite You will probably also want to remove lock file : rm spec/Gemfile.lock First time the sandbox is regenerated, alot of tests may fail,perhaps not everything loads correctly during regeneration process. Invariably the next run, the specs pass, so a fix is low priority.
Run the Tests
** N.B You should run the specs from within the specs directory. **
bundle exec rspec -c .
A datashift **log **will be written within **spec/logs**, which hooks into the standard active record logger /log/datashift.log spec/logs/datashift_spec.log
Copyright:: (c) Autotelik Media Ltd 2016
Author :: Tom Statter
Date :: April 2016
The MIT License
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.