Magnetize

CLI and library for generating Magento local.xml files. Generates both app/etc/local.xml and errors/local.xml from the a specified TOML configuration file. Also supports converting an existing Magento XML configuration file into a TOML file.

Prefixes the TOML data with the type of Magento configuration file so that multiple Magento local.xml files can be stored in a common configuration and then separate files be generated later.

Supports arbitrary values in the both the local.xml and toml config, so new configuration can be added without prior knowledge.

Installation

Add this line to your application's Gemfile:

gem 'magnetize'

Or install it yourself as:

$ gem install magnetize

Usage

CLI

$ magnetize help

Library

require 'magnetize'

opts = {
  :types => {
    'app' => {
      :magento => 'app/etc/local.xml',
      :toml => 'config.toml',
      :content => nil # optional raw content
    },
    'errors' => {
      :magento => 'errors/local.xml',
      :toml => 'config.toml',
      :content => nil # optional raw content
    }
  }
}

Magnetize::Convert.new.to_toml(opts)

# => {"app"=> "[app.config.admin.routers.adminhtml.args]\nfrontName = \"admin\"\n[app.config.global]\ndisable_local_modules = \"false\"\n[app.config.global.crypt]\nkey = \"foo\"\n[app.config.global.install]\ndate = \"Tue, 04 Feb 2014\"...", "errors"=> "..."}

Magnetize::Convert.new.to_magento(opts)

# => {"app"=> "<config><admin><routers><adminhtml><args><frontName>admin</frontName></args></adminhtml></routers></admin><global><disable_local_modules>false</disable_local_modules><crypt><key>foo</key></crypt><install><date>Tues, 04 Feb 2014...," "error"=> ".."}

Capistrano

Capfile:

require 'magnetize/capistrano'

This adds two tasks to your Cap:

magentize:push: sends your configured local TOML up to the servers as Magento XML.
magnetize:pull: pulls down a local copy of the configured Magento XML as TOML.

And then to deploy every time:

deploy.rb:

before 'deploy:check:linked_files', 'magnetize:push'

Configuration and default values

set :magnetize_roles, :app # roles to magnetize on push
set :magnetize_dir, '.' # local magnento dir, relative to capistrano
set :magnetize_appxml_path, 'app/etc' # app/etc/local.xml directory relative to cap
set :magnetize_errorsxml_path, 'errors' # errors/local.xml directory relative to cap
set :magnetize_toml, 'config.toml' # toml to magnetize
set :magnetize_force, false # overwrite existing TOML (takes effect on PULL only)

To use a different TOML per stage you could do something like:

in deploy/production.rb: set :magnetize_toml, 'magnetize.production.toml'

in deploy/staging.rb: set :magnetize_toml, 'magnetize.staging.toml'

Version 1

Version 1 is functionally equivalent in that it generates local.xml files from ENV. However it relies on all configuration values being present in the template it's output to. This means it's inflexible when dealing with new configuration options.

Version 2 is a complete re-write and is API incompatible with V1. V1 is available here on this branch

Contributing

Fork it ( http://github.com//magnetize/fork )
Create your feature branch (git checkout -b my-new-feature)
Commit your changes (git commit -am 'Add some feature')
Push to the branch (git push origin my-new-feature)
Create new Pull Request