modbuild 1.0.0

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/.travis.yml

@@ -0,0 +1,3 @@
+language: ruby
+rvm:
+  - 1.9.3

data/Gemfile

@@ -0,0 +1,6 @@
+source :rubygems
+
+gem 'builder'
+gem 'rspec'
+gem 'logger'
+gem 'rake'

data/Gemfile.lock

@@ -0,0 +1,24 @@
+GEM
+  remote: http://rubygems.org/
+  specs:
+    builder (3.0.0)
+    diff-lcs (1.1.3)
+    logger (1.2.8)
+    rake (0.9.2.2)
+    rspec (2.11.0)
+      rspec-core (~> 2.11.0)
+      rspec-expectations (~> 2.11.0)
+      rspec-mocks (~> 2.11.0)
+    rspec-core (2.11.1)
+    rspec-expectations (2.11.2)
+      diff-lcs (~> 1.1.3)
+    rspec-mocks (2.11.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  builder
+  logger
+  rake
+  rspec

data/Rakefile

@@ -0,0 +1,8 @@
+#!/usr/bin/env rake
+
+require "bundler/gem_tasks"
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/Readme.md

@@ -0,0 +1,32 @@
+# Magento Package XML Builder for Modman
+
+[![Build Status](https://secure.travis-ci.org/punkstar/modbuild.png?branch=master)](http://travis-ci.org/punkstar/modbuild)
+
+I use [modman](https://github.com/colinmollenhour/modman) to manage any Magento Extensions that I write.  An extension must be packaged once it's complete.  I don't enjoy using the "Package Magento Extension" interface in the Magento admin, nor do I like writing the XML by hand.
+
+This script gives you a running start by generating an XML file that you can then load in the admin interface containing most of the information you'll need, such as all of the files included in the extension and any metadata that you've included in your modman file.
+
+### Example modman File
+
+You can include basic information, such as extension name, version, summary and description, in your modman file to be included in the generated XML file.  For example:
+
+    # Name: Meanbee_Topsecret
+    # Version: 1.0.0
+    # Description: This is a topsecret module, and no-one must know about it.
+    # Summary: I'm not telling.
+    
+    app/etc/modules/Meanbee_Topsecret.xml app/etc/modules/
+
+### Example Usage
+
+If I had a Magento installation in `~/Sites/meanbee/module_topsecret/`, and a modman compatible repoistory checked out in `~/Sites/meanbee/module_topsecreet/.modman/topsecret`, then I would run the following to generate an almost complete package file in `var/connect`:
+
+    modbuild ~/Sites/meanbee/module_topsecreet/.modman/topsecret > ~/Sites/meanbee/module_topsecret/var/connect/Meanbee_Topsecret.xml
+
+### 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/bin/modbuild

@@ -0,0 +1,29 @@
+#!/usr/bin/env ruby
+
+$LOAD_PATH.unshift File.dirname(__FILE__) + '/../lib'
+
+require 'modbuild'
+
+options = {}
+opts = OptionParser.new do |opts|
+  opts.banner = "Usage: modbuild.rb [options] filename"
+
+  opts.on("--debug", "Enable debug mode") do |v|
+    options[:debug] = v
+  end
+  
+  opts.on("--help", "Show help") do |v|
+    puts opts
+    exit
+  end
+end
+
+filename = opts.parse!
+
+if filename.length == 1
+  modbuild = Meanbee::Modbuild::Base.new filename[0]
+  modbuild.enable_debug() if options[:debug]
+  puts modbuild.build
+else
+  raise 'You need to provide a filename'
+end

data/lib/modbuild.rb

@@ -0,0 +1,273 @@
+require 'pathname'
+require 'logger'
+require 'builder'
+require 'optparse'
+
+module Meanbee
+  module Modbuild
+    VERSION = "1.0.0"
+
+    class Base
+      attr_accessor :package_name, :package_version, :package_summary, :package_description
+      
+      def initialize(module_directory)
+        @logger = Logger.new(STDERR)
+        @logger.level = Logger::FATAL
+        
+        @module_location = module_directory
+        @modman_location = File.join(module_directory, 'modman')
+        @magento_location = File.join(module_directory, '..', '..')
+        
+        @package_name = 'Unspecified_Name'
+        @package_version = '1.0.0'
+        @package_summary = 'Unspecified package summary'
+        @package_description = 'Unspecified package description'
+        @package_files = []
+        
+        @logger.debug "Module Directory: #{@module_location}"
+        @logger.debug "Modman Directory: #{@modman_location}"
+        @logger.debug "Magento Directory: #{@magento_location}"
+      end
+      
+      def enable_debug
+        @logger.level = Logger::DEBUG
+      end
+      
+      def build
+        get_package_files
+        
+        @logger.debug 'Generating XML file..'
+        package_xml = PackageXml.new @package_name, @package_version, @package_summary, @package_description
+        
+        @package_files.each do |file|
+          package_xml.add_file file
+        end
+        
+        return package_xml.to_string
+      end
+      
+      def get_package_files
+        # List all of the files related to this module, base on the modman contents
+        modman_file = File.new @modman_location, 'r'
+
+        @logger.debug "Reading modman file"
+        while (line = modman_file.gets)
+          line.chomp!
+          
+          if (line =~ /^\s*#/)
+            @logger.debug "  Comment line: #{line}"
+            if (/^#\s*(?<key>\w+)\s*:\s*(?<value>.*)$/ =~ line)
+              @logger.debug "    Extracted: #{key} = #{value}"
+              
+              case key.downcase.to_sym
+                when :name
+                  @package_name = value
+                when :version
+                  @package_version = value
+                when :summary
+                  @package_summary = value
+                when :description
+                  @package_description = value
+                else
+                  @logger.debug "      Unknown package variables"
+              end
+            end
+          elsif (line =~ /^.*\s+.*$/)
+            @logger.debug "  Line: #{line}"
+            # local_file is the file in the .modman directory, the magento_file is where
+            # the file is placed in the magento root
+            local_file, magento_file = line.split ' '
+
+            @logger.debug "    Local: #{local_file}"
+            @logger.debug "    Magento: #{magento_file}"
+
+            if local_file.match /\*$/
+              local_file_directory = File.dirname local_file
+
+              @logger.debug "      Identified as glob"
+              @logger.debug "      Local file directory: #{local_file_directory}"
+
+              Dir.glob(File.join(@module_location, local_file)).each do |f|
+                @logger.debug "        Globbed file: #{f}"
+
+                f_regex = Regexp.new "^#{@module_location}#{local_file_directory}\/?"
+                f_relative = f.gsub(f_regex, '')
+                f_magento = File.join(magento_file, f_relative)
+
+                @logger.debug "        Globbed file as relative: #{f_magento}"
+                @logger.debug "        Adding: #{f_magento}"
+                @package_files << f_magento
+              end
+            else
+              @logger.debug "    Adding: #{magento_file}"
+              @package_files << magento_file
+            end
+          end
+        end
+        
+        modman_file.close
+        
+        return @package_files
+      end
+    end
+    
+    class PackageXml
+      def initialize(name, version, summary, description)
+        @php_min = '5.2.0'
+        @php_max = '6.0.0'
+        @stability = 'stable'
+        @license = 'Open Software License v3.0 (OSL-3.0)'
+        @license_uri = 'http://opensource.org/licenses/OSL-3.0'
+        @name = name
+        @channel = 'community'
+        @summary = summary
+        @description = description
+        @version = version
+        @authors = []
+        @depends_packages = []
+        @depends_extensions = []
+        @files = []
+        
+        add_extension_dependency 'Core', '', ''
+      end
+      
+      def add_author(name, user, email)
+        @authors << {
+          :name => name,
+          :user => user,
+          :email => email
+        }
+      end
+      
+      def add_package_dependency(name, channel, min, max, files)
+        @depends_packages << {
+          :name => name,
+          :channel => channel,
+          :min => min,
+          :max => max,
+          :files => files
+        }
+      end
+      
+      def add_extension_dependency(name, min, max)
+        @depends_extensions << {
+          :name => name,
+          :min => min,
+          :max => max
+        }
+      end
+      
+      def add_file(name)
+        @files << identify_file(name)
+      end
+      
+      def to_string
+        xml = Builder::XmlMarkup.new(:indent => 4)
+        
+        xml._ {
+          xml.form_key "imtotallyirrelevant"
+          xml.name @name
+          xml.channel @channel
+          xml.version_id {
+            xml.version_ids 2
+          }
+          xml.summary @summary
+          xml.description @description
+          xml.license @license
+          xml.license_uri @license_uri
+          xml.version @version
+          xml.stability @stability
+          xml.notes @notes
+          xml.authors {
+            xml.names {
+              @authors.each do |a|
+                xml.name a[:name]
+              end
+            }
+            xml.user {
+              @authors.each do |a|
+                xml.user a[:user]
+              end
+            }
+            xml.email {
+              @authors.each do |a|
+                xml.email a[:email]
+              end
+            }
+          }
+          xml.depends_php_min @php_min
+          xml.depends_php_max @php_max
+          xml.depends {
+            xml.package {
+              [:name, :channel, :min, :max, :files].each do |key|
+                @depends_packages.each do |pkg|
+                  xml.tag!(key) {
+                    xml.tag!(key, pkg[key])
+                  }
+                end
+              end
+            }
+            
+            xml.extension {
+              [:name, :min, :max].each do |key|
+                @depends_extensions.each do |pkg|
+                  xml.tag!(key) {
+                    xml.tag!(key, pkg[key])
+                  }
+                end
+              end
+            }
+          }
+          xml.contents {
+            [:target, :path, :type].each do |key|
+              xml.tag!(key) {
+                @files.each do |f|
+                  xml.tag!(key, f[key])
+                end
+              }
+            end
+            [:include, :ignore].each do |key|
+              xml.tag!(key) {
+                @files.length.times do |i|
+                  xml.tag!(key)
+                end
+              }
+            end
+          }
+        }
+         
+        return xml.target!
+      end
+      
+      def identify_file(name)
+        targets = {
+          :magelocal     => 'app/code/local',
+          :magecommunity => 'app/code/community',
+          :magecore      => 'app/code/core',
+          :mageetc       => 'app/etc',
+          :magedesign    => 'app/design',
+          :mageskin      => 'skin'
+          # :mageweb is for everything else
+        }
+        
+        file_type = (name =~ /\w*\.\w+$/) ? 'file' : 'dir'
+        
+        targets.each do |key, value|
+          if name =~ /^#{value}/
+            return {
+              :target => key.to_s,
+              :path   => name.gsub(/^#{value}\/?/, ''),
+              :type   => file_type
+            }
+          end
+        end
+        
+        return {
+          :target => 'mageweb',
+          :path => name,
+          :type => file_type
+        }
+      end
+    end
+  end
+end

data/spec/fixtures/001_variables/modman

@@ -0,0 +1,4 @@
+# Name: My Magento Extension
+# Version: 1.0.1
+# Description: My extension description
+# Summary: My extension summary

data/spec/modbuild_spec.rb

@@ -0,0 +1,54 @@
+$LOAD_PATH.unshift File.dirname(__FILE__) + '/../lib'
+
+require 'modbuild'
+
+describe Meanbee::Modbuild::Base, '#get_package_files' do
+  it "should extract variables from comments" do
+    pkg = Meanbee::Modbuild::Base.new File.dirname(__FILE__) + '/fixtures/001_variables'
+    pkg.get_package_files
+    
+    pkg.package_name.should eq 'My Magento Extension'
+    pkg.package_version.should eq '1.0.1'
+    pkg.package_summary.should eq 'My extension summary'
+    pkg.package_description.should eq 'My extension description'
+  end
+end
+
+describe Meanbee::Modbuild::PackageXml, '#identify_file' do
+  it "should identify file targets" do
+    pkgxml = Meanbee::Modbuild::PackageXml.new 'a', 'b', 'c', 'd'
+    
+    pkgxml.identify_file('app/code/local/Meanbee/Awesome')[:target].should eq 'magelocal'
+    pkgxml.identify_file('app/code/community/Meanbee/Awesome')[:target].should eq 'magecommunity'
+    pkgxml.identify_file('app/code/core/Meanbee/Awesome')[:target].should eq 'magecore'
+    pkgxml.identify_file('app/etc/modules/Meanbee_Awesome.xml')[:target].should eq 'mageetc'
+    pkgxml.identify_file('app/design/frontend/base/default/template/meanbee/awesome')[:target].should eq 'magedesign'
+    pkgxml.identify_file('skin/frontend/base/default/css/awesome.css')[:target].should eq 'mageskin'
+    pkgxml.identify_file('random/directory/file.css')[:target].should eq 'mageweb'
+  end
+  
+  it "should differentiate between files and directories" do
+    pkgxml = Meanbee::Modbuild::PackageXml.new 'a', 'b', 'c', 'd'
+    
+    pkgxml.identify_file('app/code/local/Meanbee/Awesome')[:type].should eq 'dir'
+    pkgxml.identify_file('app/code/local/Meanbee/Awesome/')[:type].should eq 'dir'
+    pkgxml.identify_file('app/code/local/Meanbee/Awesome/etc/config.xml')[:type].should eq 'file'
+    pkgxml.identify_file('app/code/local/Meanbee/Awesome/etc/.htaccess')[:type].should eq 'file'
+    pkgxml.identify_file('app/code/local/Meanbee/Awesome/etc/.htaccess/')[:type].should eq 'dir'
+    pkgxml.identify_file('app/code/local/Meanbee/Awesome/etc/.htaccess/subdir')[:type].should eq 'dir'
+    pkgxml.identify_file('app/code/local/Meanbee/Awesome/etc/.htaccess/subdir/file.txt')[:type].should eq 'file'
+    pkgxml.identify_file('.htaccess')[:type].should eq 'file'
+  end
+  
+  it "should provide file paths relative to target base directories" do
+    pkgxml = Meanbee::Modbuild::PackageXml.new 'a', 'b', 'c', 'd'
+    
+    pkgxml.identify_file('app/code/local/Meanbee/Awesome')[:path].should eq 'Meanbee/Awesome'
+    pkgxml.identify_file('app/code/community/Meanbee/Awesome')[:path].should eq 'Meanbee/Awesome'
+    pkgxml.identify_file('app/code/core/Meanbee/Awesome')[:path].should eq 'Meanbee/Awesome'
+    pkgxml.identify_file('app/etc/modules/Meanbee_Awesome.xml')[:path].should eq 'modules/Meanbee_Awesome.xml'
+    pkgxml.identify_file('app/design/frontend/base/default/template/meanbee/awesome')[:path].should eq 'frontend/base/default/template/meanbee/awesome'
+    pkgxml.identify_file('skin/frontend/base/default/css/awesome.css')[:path].should eq 'frontend/base/default/css/awesome.css'
+    pkgxml.identify_file('random/directory/file.css')[:path].should eq 'random/directory/file.css'
+  end
+end

metadata

@@ -0,0 +1,62 @@
+--- !ruby/object:Gem::Specification
+name: modbuild
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+  prerelease: 
+platform: ruby
+authors:
+- Nick Jones
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-08-13 00:00:00.000000000 Z
+dependencies: []
+description: This script gives you a running start by generating an XML file that
+  you can then load in the admin interface containing most of the information you'll
+  need, such as all of the files included in the extension and any metadata that you've
+  included in your modman file.
+email:
+- nick@nicksays.co.uk
+executables:
+- modbuild
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .travis.yml
+- Gemfile
+- Gemfile.lock
+- Rakefile
+- Readme.md
+- bin/modbuild
+- lib/modbuild.rb
+- spec/fixtures/001_variables/modman
+- spec/modbuild_spec.rb
+homepage: https://github.com/punkstar/modbuild
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: Build a skeleton Magento Connect extension package file from your modman
+  contents
+test_files:
+- spec/fixtures/001_variables/modman
+- spec/modbuild_spec.rb