magnetize 2.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 3d8b644b0a8c6dfe892a68db2e9ae1ed86c07eb7
+  data.tar.gz: cbf056152442454a0316fa56e5912e078e098010
+SHA512:
+  metadata.gz: 4bbbf8569217b460960001da052650642bf69b96807c33111d314c32d410589eae3e8df7d831fa2648b3c421c9d69cbe30182e270f2c553e6dc1148549960a80
+  data.tar.gz: e714f703eaf7a62c644f2f32f39c650bec866c40a65c79880ccd070dba088356442331fb1a06a5587ce89996aea4896fa518ac21d63213314e244001a154fad3

data/.gitignore

@@ -0,0 +1,17 @@
+*.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

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

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Robert Coleman
+
+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.

data/README.md

@@ -0,0 +1,71 @@
+# 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 seperate files be generated larter.
+
+Supports arbitrary values in the both the `local.xml` and toml config, so new configration can be added without prior knowlege.
+
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'magnetize'
+
+Or install it yourself as:
+
+    $ gem install magnetize
+
+
+## Usage
+
+### CLI
+
+* `$ magnetize help`
+
+### Library
+
+```ruby
+require 'magnetize'
+
+opts = {
+  :types => {
+    'app' => {
+      :magento => 'app/etc/local.xml',
+      :toml => 'config.toml'
+    },
+    'errors' => {
+      :magento => 'errors/local.xml',
+      :toml => 'config.toml'
+    }
+  }
+}
+
+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"=> ".."}
+
+```
+
+
+## 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 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)
+
+
+## Contributing
+
+1. Fork it ( http://github.com/<my-github-username>/magnetize/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

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

data/bin/magnetize

@@ -0,0 +1,9 @@
+#!/usr/bin/env ruby
+
+Signal.trap("INT") do
+  puts "\nSIGINT recieved.. terminated."
+  exit 1
+end
+
+require 'magnetize'
+Magnetize::CLI.start

data/lib/magnetize/cli.rb

@@ -0,0 +1,36 @@
+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'
+    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'
+    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] }}
+      end
+    end
+    
+  end
+end
+

data/lib/magnetize/convert.rb

@@ -0,0 +1,109 @@
+require 'toml'
+require 'active_support/core_ext/hash'
+require 'gyoku'
+require 'thor'
+
+module Magnetize
+  class Convert < Thor
+    include Thor::Shell
+    
+    DEFAULTS = {
+      :force => false,
+      :write => false,
+      :types => {
+        'app' => {
+          :magento => 'app/etc/local.xml',
+          :toml => 'config.toml'
+        },
+        'errors' => {
+          :magento => 'errors/local.xml',
+          :toml => 'config.toml'
+        }
+      }
+    }
+    
+    no_commands do
+      def to_magento(options = {})
+        options = DEFAULTS.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 options[:write]
+            write(output, xml, options[:force])
+          else
+            result[type] = xml
+          end
+        end
+        return result unless options[:write]
+      end
+    
+      def to_toml(options = {})
+        options = DEFAULTS.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)
+          if options[:write]
+            write(output, toml, options[:force])
+          else
+            result[type] = toml
+          end
+        end
+        return result unless options[:write]
+      end
+      
+    end # no_commands
+    
+    private
+    
+    def read_toml(path)
+      TOML.load_file(path, symbolize_keys: true)
+    end
+    
+    def make_toml(hash)
+      TOML.dump(hash)
+    end
+    
+    def read_xml(path)
+      Hash.from_xml(IO.read(path))
+    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
+        if File.exists?(path)
+          say("#{path} already exists. ", :red)
+          abort("----> Skipped #{File.basename(path)}") if no?("Overwrite? (y/N):", :yellow)
+        end
+      end
+      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
+      end
+    end
+  end
+end

data/lib/magnetize/version.rb

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

data/lib/magnetize.rb

@@ -0,0 +1,3 @@
+require 'magnetize/version'
+require 'magnetize/convert'
+require 'magnetize/cli'

data/magnetize.gemspec

@@ -0,0 +1,29 @@
+# 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

metadata

@@ -0,0 +1,155 @@
+--- !ruby/object:Gem::Specification
+name: magnetize
+version: !ruby/object:Gem::Version
+  version: 2.0.0
+platform: ruby
+authors:
+- Robert Coleman
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-02-04 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.5'
+- !ruby/object:Gem::Dependency
+  name: rake
+  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: 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
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.18'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.18'
+- !ruby/object:Gem::Dependency
+  name: toml-rb
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.1'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '4.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '4.0'
+- !ruby/object:Gem::Dependency
+  name: gyoku
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.1'
+description: CLI/library for generating Magento local.xml files
+email:
+- github@robert.net.nz
+executables:
+- magnetize
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .ruby-version
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/magnetize
+- lib/magnetize.rb
+- lib/magnetize/cli.rb
+- lib/magnetize/convert.rb
+- lib/magnetize/version.rb
+- magnetize.gemspec
+homepage: https://github.com/rjocoleman/magnetize/
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.0.14
+signing_key: 
+specification_version: 4
+summary: CLI/library for generating Magento local.xml files
+test_files: []