maruto 0.0.1 → 0.0.2

data/lib/maruto.rb

@@ -1,4 +1,5 @@
-require "maruto/version"
+require 'maruto/version'
+require 'maruto/magento_config'
 
 module Maruto
   # Your code goes here...

data/lib/maruto/magento_config.rb

@@ -0,0 +1,134 @@
+require 'tsort'
+
+module Maruto
+	class MagentoConfig
+		include TSort
+
+		def initialize(magento_root)
+
+			@modules = {}
+			@global_events_observers = {}
+			@warnings = []
+
+			Dir.chdir(magento_root) do
+
+				# load module definitions
+				Dir.glob('app/etc/modules/*.xml') do |file|
+					f = File.open(file)
+					doc = Nokogiri::XML(f) { |config| config.strict }
+					f.close
+
+					doc.xpath('//modules/*').each do |node|
+						load_module_definition(file, node)
+					end
+				end
+
+				# sort modules dependency graph, then load their config
+				modules().each do |mm_name, mm_config|
+					if mm_config[:active] then
+						# check dependencies
+						mm_config[:dependencies].each do |dep|
+							@warnings << "module:#{mm_name} - missing dependency (#{dep})" unless is_active_module?(dep)
+						end
+
+						# puts mm_name
+						# puts mm_config
+
+						parts = mm_name.split('_')
+						abort "module:#{mm_name} - unrecognized module name format" unless parts.size == 2
+						config_path = "app/code/#{mm_config[:code_pool]}/#{parts[0]}/#{parts[1]}/etc/config.xml"
+
+						if !File.exists?(config_path)
+							@warnings << "module:#{mm_name} is defined (#{mm_config[:defined]}) but does not exists (#{config_path})"
+							next
+						end
+
+						f = File.open(config_path)
+						doc = Nokogiri::XML(f) { |config| config.strict }
+						f.close
+
+						mm_config[:version] = doc.at_xpath("/config/modules/#{mm_name}/version").content if doc.at_xpath("/config/modules/#{mm_name}/version")
+
+						# TODO same for:
+						# '/config/frontend/events/*'
+						# '/config/adminhtml/events/*'
+						doc.xpath('/config/global/events/*').each do |node|
+							# puts node
+							event = node.name
+							observers = @global_events_observers[event] ||= {}
+
+							# puts node if mm_name == 'Enterprise_Reminder'
+
+							node.xpath("observers/*").each do |observer_node|
+								observer_name = observer_node.name
+								if observers.include? observer_name
+									mod_first  = observers[observer_name][:defined]
+									mod_second = mm_name
+									@warnings << "event:#{event} observer:#{observer_name} - defined in #{mod_first} and redefined in #{mod_second}"
+									# TODO check if there is a dependency path between mod_first and mod_second
+									# print_module(mod_first)
+									# print_module(mod_second)
+								end
+								observers[observer_name] = {
+									:class  => observer_node.at_xpath('class').content,
+									:method => observer_node.at_xpath('method').content,
+									:defined => mm_name,
+								}
+							end
+
+							@global_events_observers[event] = observers
+						end
+
+					end
+				end
+
+			end
+		end
+
+		def modules()
+			Hash[tsort.map { |name| [name, @modules[name]] }]
+		end
+
+		def events()
+			@global_events_observers
+		end
+
+		def is_active_module?(name)
+			@modules.include?(name) && @modules[name][:active]
+		end
+
+		def print_module(name)
+			puts @modules[name]
+		end
+
+		def print_warnings()
+			puts @warnings
+		end
+
+		def tsort_each_node(&block)
+			@modules.each_key(&block)
+		end
+
+		def tsort_each_child(node, &block)
+			@modules[node][:dependencies].each(&block)
+		end
+
+		private
+
+		def load_module_definition(file, xml_node)
+			name = xml_node.name
+			config = {
+				:active       => xml_node.at_xpath('active').content == 'true',
+				:code_pool    => xml_node.at_xpath('codePool').content,
+				:dependencies => xml_node.xpath('depends/*').map(&:name),
+				:defined      => file,
+			}
+			if @modules.include? name then
+				# TODO test this
+				@warnings << "module:#{name} - duplicate module definition (#{@modules[name][:defined]} and file)"
+			end
+			@modules[name] = config
+		end
+
+	end
+end

data/lib/maruto/runner.rb

@@ -1,23 +1,22 @@
 require 'maruto'
+require 'nokogiri'
+require 'pathname'
 require 'thor'
 
 class Maruto::Runner < Thor
 	include Thor::Actions
 
-	desc "lint MAGENTO_ROOT", "lint php files"
-	def lint(magento_root)
-
-		# TODO move this into a magento_folder? method
+	desc "magento? MAGENTO_ROOT", "check if MAGENTO_ROOT contains a magento app"
+	def magento?(magento_root)
 		magento_root = Pathname.new(magento_root).cleanpath
+		check_magento_folder(magento_root)
+	end
 
-		raise Thor::Error, "not a folder: #{magento_root}" unless magento_root.directory?
+	desc "lint MAGENTO_ROOT", "lint php files in MAGENTO_ROOT/app/code"
+	def lint(magento_root)
 
-		is_magento = (magento_root + 'app').directory? &&
-		             (magento_root + 'app/code').directory? &&
-		             (magento_root + 'app/etc').directory? &&
-		             (magento_root + 'app/etc/modules').directory? &&
-		             (magento_root + 'app/etc/local.xml').file?
-		raise Thor::Error, "could not find magento in this folder: #{magento_root}" unless is_magento
+		magento_root = Pathname.new(magento_root).cleanpath
+		check_magento_folder(magento_root)
 
 		# TODO move this into a lint_php method
 		inside(magento_root) do
@@ -34,6 +33,35 @@ class Maruto::Runner < Thor
 		end
 	end
 
+	desc "events MAGENTO_ROOT", "list events and their observers"
+	def events(magento_root)
+
+		magento_root = Pathname.new(magento_root).cleanpath
+		check_magento_folder(magento_root)
+
+		magento_config = Maruto::MagentoConfig.new magento_root
+
+		magento_config.events.sort_by { |k, v| k }.each do |event, observers|
+			puts event
+			observers.each do |observer|
+				puts "   #{observer}"
+			end
+		end
+
+	end
+
+	no_commands do
+		def check_magento_folder(magento_root)
+			raise Thor::Error, "not a folder: #{magento_root}" unless magento_root.directory?
+
+			is_magento = (magento_root + 'app').directory? &&
+			             (magento_root + 'app/code').directory? &&
+			             (magento_root + 'app/etc').directory? &&
+			             (magento_root + 'app/etc/modules').directory? &&
+			             (magento_root + 'app/etc/local.xml').file?
+			raise Thor::Error, "could not find magento in this folder: #{magento_root}" unless is_magento
+		end
+	end
 end
 
 

data/lib/maruto/version.rb

@@ -1,3 +1,3 @@
 module Maruto
-  VERSION = "0.0.1"
+  VERSION = "0.0.2"
 end

data/maruto.gemspec

@@ -10,7 +10,7 @@ Gem::Specification.new do |spec|
   spec.email         = ["jlgeering.13@gmail.com"]
   spec.description   = %q{Magento Ruby Tools}
   spec.summary       = %q{config parser and analyser, ...}
-  spec.homepage      = ""
+  spec.homepage      = "https://github.com/jlgeering/maruto"
   spec.license       = "MIT"
 
   spec.files         = `git ls-files`.split($/)

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: maruto
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-03-28 00:00:00.000000000 Z
+date: 2013-03-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: nokogiri
@@ -91,10 +91,11 @@ files:
 - Rakefile
 - bin/maruto
 - lib/maruto.rb
+- lib/maruto/magento_config.rb
 - lib/maruto/runner.rb
 - lib/maruto/version.rb
 - maruto.gemspec
-homepage: ''
+homepage: https://github.com/jlgeering/maruto
 licenses:
 - MIT
 post_install_message: 
@@ -107,18 +108,12 @@ required_ruby_version: !ruby/object:Gem::Requirement
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
-      segments:
-      - 0
-      hash: -1944508487977522432
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
-      segments:
-      - 0
-      hash: -1944508487977522432
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.23