magnetize 2.0.0 → 2.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 3d8b644b0a8c6dfe892a68db2e9ae1ed86c07eb7
-  data.tar.gz: cbf056152442454a0316fa56e5912e078e098010
+  metadata.gz: 00ff7b00bb1b5c515f9c29bdaaef0a3035b4e152
+  data.tar.gz: aa82c320aba75b03924325648911dac54d56941c
 SHA512:
-  metadata.gz: 4bbbf8569217b460960001da052650642bf69b96807c33111d314c32d410589eae3e8df7d831fa2648b3c421c9d69cbe30182e270f2c553e6dc1148549960a80
-  data.tar.gz: e714f703eaf7a62c644f2f32f39c650bec866c40a65c79880ccd070dba088356442331fb1a06a5587ce89996aea4896fa518ac21d63213314e244001a154fad3
+  metadata.gz: cca97b3a16b13df03c4bf78e42d5d9392a4128a308cf5ac0f760957426f76ae49e3917bfe7e25c80fee97d0cd3d5335072c689fa62567a19160b43aad2ed1d53
+  data.tar.gz: f4a61f916052fa0b46d772d3a985b2b7eaf1e1054bed2f4417cdb7b1daf1f53a3def29243d76aae44b007f3dcb2b2f1d6e0bb4654690347aa9f8fb16b27b9f2d

data/README.md

@@ -4,9 +4,9 @@ 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 seperate files be generated larter.
+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 configration can be added without prior knowlege.
+Supports arbitrary values in the both the `local.xml` and toml config, so new configuration can be added without prior knowledge.
 
 
 ## Installation
@@ -35,11 +35,13 @@ opts = {
   :types => {
     'app' => {
       :magento => 'app/etc/local.xml',
-      :toml => 'config.toml'
+      :toml => 'config.toml',
+      :content => nil # optional raw content
     },
     'errors' => {
       :magento => 'errors/local.xml',
-      :toml => 'config.toml'
+      :toml => 'config.toml',
+      :content => nil # optional raw content
     }
   }
 }
@@ -55,11 +57,49 @@ Magnetize::Convert.new.to_magento(opts)
 ```
 
 
+### Capistrano
+
+`Capfile`:
+```ruby
+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 which it's output to. This means it's inflexible when dealing with new configuration options.
+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 as such is API incompatable with V1. V1 is available here on [this branch](https://github.com/rjocoleman/magnetize/tree/v1)
+Version 2 is a complete re-write and is API incompatible with V1. V1 is available here on [this branch](https://github.com/rjocoleman/magnetize/tree/v1)
 
 
 ## Contributing

data/lib/magnetize/capistrano.rb

@@ -0,0 +1,5 @@
+require 'magnetize/convert'
+require 'highline/import'
+
+# Load capistrano tasks
+load File.expand_path('../tasks/magnetize.rake', __FILE__)

data/lib/magnetize/cli.rb

@@ -3,34 +3,38 @@ require 'thor'
 module Magnetize
   class CLI < Thor
     default_task :help
-    
+
     desc 'to_magento', 'Write Magento XML from TOML config'
     method_option :type,   :type =>  :string,  :required => false, :desc => 'Type of Magento config (e.g. app, errors). TOML is pulled from this prefix.' # ['app', 'errors']
     method_option :input,  :type =>  :string,  :required => false, :desc => 'Path to input TOML file' # local.toml
     method_option :output, :type =>  :string,  :required => false, :desc => 'Path to output XML file' # app/etc/local.xml
     method_option :force,  :type =>  :boolean, :required => false, :desc => 'Overwrite existing output file'
+    method_option :dir,    :type =>  :string,  :required => false, :desc => 'Magento directory', :default => '.'
     def to_magento
       unless options[:type] && options[:input] && options[:output]
         Magnetize::Convert.new.to_magento write: true
       else
         Magnetize::Convert.new.to_magento write: true, types: { options[:type] => { :magento => options[:output], :toml => options[:input] }}
       end
-      
+
     end
-    
+
     desc 'to_toml', 'Write TOML from existing Magento config'
     method_option :type,   :type => :string,  :required => false, :desc => 'Type of Magento config (e.g. app, errors). Used as prefix in TOML.' # ['app', 'errors']
     method_option :input,  :type => :string,  :required => false, :desc => 'Path to input XML file' # app/etc/local.xml
     method_option :output, :type => :string,  :required => false, :desc => 'Path to output TOML file' # local.toml
     method_option :force,  :type => :boolean, :required => false, :desc => 'Overwrite existing output file'
+    method_option :dir,    :type => :string,  :required => false, :desc => 'Magento directory', :default => '.'
     def to_toml
-      unless options[:type] && options[:input] && options[:output]
-        Magnetize::Convert.new.to_toml write: true
-      else
-        Magnetize::Convert.new.to_toml write: true, types: { options[:type] => { :magento => options[:input], :toml => options[:output] }}
+      Dir.chdir(options[:dir]) do
+        unless options[:type] && options[:input] && options[:output]
+          Magnetize::Convert.new.to_toml write: true
+        else
+          Magnetize::Convert.new.to_toml write: true, types: { options[:type] => { :magento => options[:input], :toml => options[:output] }}
+        end
       end
     end
-    
+
   end
 end
 

data/lib/magnetize/convert.rb

@@ -2,52 +2,66 @@ require 'toml'
 require 'active_support/core_ext/hash'
 require 'gyoku'
 require 'thor'
+require 'deep_merge'
 
 module Magnetize
   class Convert < Thor
     include Thor::Shell
-    
+
     DEFAULTS = {
       :force => false,
       :write => false,
       :types => {
         'app' => {
           :magento => 'app/etc/local.xml',
-          :toml => 'config.toml'
+          :toml => 'config.toml',
+          :content => nil
         },
         'errors' => {
           :magento => 'errors/local.xml',
-          :toml => 'config.toml'
+          :toml => 'config.toml',
+          :content => nil
         }
       }
     }
-    
+
     no_commands do
       def to_magento(options = {})
-        options = DEFAULTS.merge(options)
+        options = DEFAULTS.deep_merge(options)
         result = {}
         options[:types].each do |type, config|
           input = File.expand_path(config[:toml])
           output = File.expand_path(config[:magento])
-          hash = read_toml(input)
-          xml = make_xml(hash[type.to_sym])
+          if config[:content]
+            hash = TOML.load(config[:content])
+          else
+            hash = read_toml(input)
+          end
+          xml = make_xml(hash[type.to_s])
           if options[:write]
             write(output, xml, options[:force])
           else
-            result[type] = xml
+            result[config[:magento]] = xml
           end
         end
         return result unless options[:write]
       end
-    
+
       def to_toml(options = {})
-        options = DEFAULTS.merge(options)
+        options = DEFAULTS.deep_merge(options)
         result = {}
         options[:types].each do |type, config|
           input = File.expand_path(config[:magento])
-          output = File.expand_path(config[:toml])
-          hash = { type.to_sym => read_xml(input) }
-          toml = make_toml(hash)
+          output = File.expand_path(config[:toml]) if config[:toml]
+          if config[:content]
+            xml = config[:content]
+          else
+            xml = IO.read(input)
+          end
+          hash = { type.to_s => read_xml(xml) }
+          config = read_toml(output)
+          config.merge!(hash)
+          toml = make_toml(config)
           if options[:write]
             write(output, toml, options[:force])
           else
@@ -56,27 +70,31 @@ module Magnetize
         end
         return result unless options[:write]
       end
-      
+
     end # no_commands
-    
+
     private
-    
+
     def read_toml(path)
-      TOML.load_file(path, symbolize_keys: true)
+      if !path.nil? && File.exists?(path)
+        TOML.load_file(path)
+      else
+        {}
+      end
     end
-    
+
     def make_toml(hash)
-      TOML.dump(hash)
+      TOML::Generator.new(hash).body
     end
-    
-    def read_xml(path)
-      Hash.from_xml(IO.read(path))
+
+    def read_xml(xml)
+      replace_nil(Hash.from_xml(xml))
     end
-    
+
     def make_xml(hash)
       Gyoku.xml(hash, { :key_converter => :none, :builder => { :indent => 2 } })
     end
-    
+
     def write(path, content, force=false)
       FileUtils.mkdir_p(File.dirname(path))
       unless force
@@ -88,22 +106,16 @@ module Magnetize
       File.open(path, 'w') {|f| f.write(content)}
       puts "----> Wrote #{File.basename(path)}"
     end
-    
-  end
-end
 
-# yuck, bad bad hack
-module TOML
-  class Dumper
-    def to_toml(obj)
-      case
-      when obj.is_a?(Time)
-        obj.strftime('%Y-%m-%dT%H:%M:%SZ')
-      when obj.nil?
-        obj = '""'
-      else
-        obj.inspect
+    def replace_nil(h)
+      h.each_pair do |k,v|
+        if v.is_a?(Hash)
+          replace_nil(v)
+        else
+          h[k] = v.to_s if v.nil?
+        end
       end
     end
+
   end
 end

data/lib/magnetize/tasks/magnetize.rake

@@ -0,0 +1,74 @@
+namespace :magnetize do
+  desc 'Push local TOML config to remote Magento installation as Magento config file format'
+  task :push do
+    Dir.chdir(fetch(:magnetize_dir)) do
+      on roles fetch(:magnetize_roles), in: :parallel do
+        config = Magnetize::Convert.new.to_magento({
+          :write => false,
+          :types => {
+            'app' => {
+              :magento => "#{fetch(:magnetize_appxml_path)}/local.xml",
+              :content => IO.read(fetch(:magnetize_toml))
+            },
+            'errors' => {
+              :magento => "#{fetch(:magnetize_errorsxml_path)}/local.xml",
+              :content => IO.read(fetch(:magnetize_toml))
+            }
+          }
+        })
+        config.each do |path, config|
+          upload! StringIO.new(config), "#{shared_path}/#{path}"
+        end
+      end
+    end
+  end
+
+  desc 'Pull remote Magento config to local TOML config'
+  task :pull do
+    Dir.chdir(fetch(:magnetize_dir)) do
+      on primary fetch(:magnetize_roles) do
+        within "#{shared_path}" do
+          config = Magnetize::Convert.new.to_toml({
+            :write => false,
+            :types => {
+              'app' => {
+                :content => capture(:cat, "#{fetch(:magnetize_localxml_path)}/local.xml"),
+                :toml => nil
+              },
+              'errors' => {
+                :content => capture(:cat, "#{fetch(:magnetize_errorsxml_path)}/local.xml"),
+                :toml => nil
+              }
+            }
+          })
+          run_locally do
+            # yeah sooo, welcome to my nightmare. Capistrano v3's ask method doesn't cut it for this use case.
+            if File.exists?(fetch(:magnetize_toml)) && !fetch(:magnetize_force)
+              fail "#{fetch(:magnetize_dir)}/#{fetch(:magnetize_toml)} already exists, remove it or set :magnetize_force, true"
+            elsif File.exists?(fetch(:magnetize_toml)) && fetch(:magnetize_force)
+              info "#{fetch(:magnetize_dir)}/#{fetch(:magnetize_toml)} already exists - Forced overwriting (:magnetize_force is true)"
+            end
+            if !File.exists?(fetch(:magnetize_toml)) || fetch(:magnetize_force)
+              File.open(fetch(:magnetize_toml), 'w') {|f| f.write( config.values.join ) }
+              info "#{fetch(:magnetize_dir)}/#{fetch(:magnetize_toml)} has been written"
+            end
+          end
+        end
+      end
+    end
+  end
+
+end
+
+namespace :load do
+  task :defaults do
+
+    set :magnetize_roles, :app
+    set :magnetize_dir, '.'
+    set :magnetize_appxml_path, 'app/etc'
+    set :magnetize_errorsxml_path, 'errors'
+    set :magnetize_toml, 'config.toml'
+    set :magnetize_force, false
+
+  end
+end

data/lib/magnetize/version.rb

@@ -1,3 +1,3 @@
 module Magnetize
-  VERSION = '2.0.0'
+  VERSION = '2.2.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: magnetize
 version: !ruby/object:Gem::Version
-  version: 2.0.0
+  version: 2.2.0
 platform: ruby
 authors:
 - Robert Coleman
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-02-04 00:00:00.000000000 Z
+date: 2014-03-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -38,20 +38,6 @@ dependencies:
     - - '>='
       - !ruby/object:Gem::Version
         version: '0'
-- !ruby/object:Gem::Dependency
-  name: pry
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - '>='
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - '>='
-      - !ruby/object:Gem::Version
-        version: '0'
 - !ruby/object:Gem::Dependency
   name: thor
   requirement: !ruby/object:Gem::Requirement
@@ -67,7 +53,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0.18'
 - !ruby/object:Gem::Dependency
-  name: toml-rb
+  name: toml
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ~>
@@ -108,6 +94,20 @@ dependencies:
     - - ~>
       - !ruby/object:Gem::Version
         version: '1.1'
+- !ruby/object:Gem::Dependency
+  name: deep_merge
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.0'
 description: CLI/library for generating Magento local.xml files
 email:
 - github@robert.net.nz
@@ -116,18 +116,15 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
-- .gitignore
-- .ruby-version
-- Gemfile
-- LICENSE.txt
-- README.md
-- Rakefile
 - bin/magnetize
-- lib/magnetize.rb
+- lib/magnetize/capistrano.rb
 - lib/magnetize/cli.rb
 - lib/magnetize/convert.rb
+- lib/magnetize/tasks/magnetize.rake
 - lib/magnetize/version.rb
-- magnetize.gemspec
+- lib/magnetize.rb
+- LICENSE.txt
+- README.md
 homepage: https://github.com/rjocoleman/magnetize/
 licenses:
 - MIT
@@ -153,3 +150,4 @@ signing_key:
 specification_version: 4
 summary: CLI/library for generating Magento local.xml files
 test_files: []
+has_rdoc: 

data/.gitignore

@@ -1,17 +0,0 @@
-*.gem
-*.rbc
-.bundle
-.config
-.yardoc
-Gemfile.lock
-InstalledFiles
-_yardoc
-coverage
-doc/
-lib/bundler/man
-pkg
-rdoc
-spec/reports
-test/tmp
-test/version_tmp
-tmp

data/.ruby-version

@@ -1 +0,0 @@
-ruby-2.0.0

data/Gemfile

@@ -1,4 +0,0 @@
-source 'https://rubygems.org'
-
-# Specify your gem's dependencies in magnetize.gemspec
-gemspec

data/Rakefile

@@ -1 +0,0 @@
-require 'bundler/gem_tasks'

data/magnetize.gemspec

@@ -1,29 +0,0 @@
-# coding: utf-8
-lib = File.expand_path('../lib', __FILE__)
-$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require 'magnetize/version'
-
-Gem::Specification.new do |spec|
-  spec.name          = 'magnetize'
-  spec.version       = Magnetize::VERSION
-  spec.authors       = ['Robert Coleman']
-  spec.email         = ['github@robert.net.nz']
-  spec.summary       = %q{CLI/library for generating Magento local.xml files}
-  spec.description   = %q{CLI/library for generating Magento local.xml files}
-  spec.homepage      = 'https://github.com/rjocoleman/magnetize/'
-  spec.license       = 'MIT'
-
-  spec.files         = `git ls-files`.split($/)
-  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
-  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
-  spec.require_paths = ['lib']
-
-  spec.add_development_dependency 'bundler', '~> 1.5'
-  spec.add_development_dependency 'rake'
-  spec.add_development_dependency 'pry'
-
-  spec.add_dependency 'thor', '~> 0.18'
-  spec.add_dependency 'toml-rb', '~> 0.1'
-  spec.add_dependency 'activesupport', '~> 4.0'
-  spec.add_dependency 'gyoku', '~> 1.1'
-end