maruto 0.0.2 → 0.0.3

data/README.md

@@ -18,7 +18,7 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+    $ maruto help
 
 ## Contributing
 

data/lib/maruto/magento_config.rb

@@ -7,7 +7,10 @@ module Maruto
 		def initialize(magento_root)
 
 			@modules = {}
+
+			@global_model_groups = {}
 			@global_events_observers = {}
+
 			@warnings = []
 
 			Dir.chdir(magento_root) do
@@ -49,6 +52,32 @@ module Maruto
 
 						mm_config[:version] = doc.at_xpath("/config/modules/#{mm_name}/version").content if doc.at_xpath("/config/modules/#{mm_name}/version")
 
+						##########################################################################################
+						# MODELS
+
+						doc.xpath('/config/global/models/*').each do |node|
+							load_model(mm_name, node)
+						end
+
+						if mm_name.start_with? "Mage_" then
+							# special case for Mage_NAME modules: if not defined, fallback to Mage_Model_NAME
+							group_name = mm_name.sub("Mage_", "").downcase
+							if !@global_model_groups.include? group_name then
+								@global_model_groups[group_name] = {
+									:class   => "#{mm_name}_Model",
+									:defined => :fallback,
+								}
+							end
+							if !@global_model_groups[group_name][:class] then
+								# TODO warn? => missing dep?
+								@global_model_groups[group_name][:class]   = "#{mm_name}_Model"
+								@global_model_groups[group_name][:defined] = :fallback
+							end
+						end
+
+						##########################################################################################
+						# EVENTS
+
 						# TODO same for:
 						# '/config/frontend/events/*'
 						# '/config/adminhtml/events/*'
@@ -57,8 +86,6 @@ module Maruto
 							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
@@ -70,8 +97,8 @@ module Maruto
 									# print_module(mod_second)
 								end
 								observers[observer_name] = {
-									:class  => observer_node.at_xpath('class').content,
-									:method => observer_node.at_xpath('method').content,
+									:class   => observer_node.at_xpath('class').content,
+									:method  => observer_node.at_xpath('method').content,
 									:defined => mm_name,
 								}
 							end
@@ -80,16 +107,28 @@ module Maruto
 						end
 
 					end
+				end # modules().each
+
+				# check if all model_groups have a class attribute
+				# TODO write test
+				@global_model_groups.each do |group_name, model_group|
+					if !model_group[:class] && !group_name.end_with?('_mysql4') then
+						@warnings << "module:#{model_group[:define]} model_group:#{group_name} - missing class attribute for model"
+					end
 				end
 
-			end
+			end # Dir.chdir(magento_root)
 		end
 
 		def modules()
 			Hash[tsort.map { |name| [name, @modules[name]] }]
 		end
 
-		def events()
+		def models()
+			@global_model_groups
+		end
+
+		def observers()
 			@global_events_observers
 		end
 
@@ -130,5 +169,62 @@ module Maruto
 			@modules[name] = config
 		end
 
+		def load_model(module_name, xml_node)
+			group_name = xml_node.name
+
+			# this xml_node declares a new model
+			load_model_definition(module_name, group_name, xml_node) if xml_node.at_xpath('class')
+
+			# this xml_node declares a model rewrite
+			load_model_rewrite(module_name, group_name, xml_node)    if xml_node.at_xpath('rewrite')
+
+			if !xml_node.at_xpath('class') && !xml_node.at_xpath('rewrite') && !xml_node.at_xpath('entities')
+				@warnings << "module:#{module_name} model_group:#{group_name} - unrecognized model"
+			end
+
+		end
+
+		def load_model_definition(module_name, group_name, xml_node)
+			# check for redefinition
+			if @global_model_groups.include?(group_name) && @global_model_groups[group_name][:class] then
+				mod_first  = @global_model_groups[group_name][:defined]
+				mod_second = module_name
+				@warnings << "model_group:#{group_name} - defined in #{mod_first} and redefined in #{mod_second}"
+			end
+
+			# model_group hash could alread have been created (rewrites for this model in another module)
+			model_group = @global_model_groups[group_name] ||= {}
+
+			model_group[:class]   = xml_node.at_xpath('class').content
+			model_group[:defined] = module_name
+			# optional
+			model_group[:resource_model] = xml_node.at_xpath('resourceModel').content if xml_node.at_xpath('resourceModel')
+		end
+
+		def load_model_rewrite(module_name, group_name, xml_node)
+			# check if model_group already defined, else warn missing dependency relation
+			# TODO is this an issue or is this allowed?
+			# if !@global_model_groups.include? group_name then
+			# 	@warnings << "module:#{module_name} - rewrites model_group:#{group_name} which isn't defined yet (missing dependency?)"
+			# end
+
+			# model_group and model_group[:rewrites] hashes could alread have been created
+			model_group = @global_model_groups[group_name] ||= {}
+			rewrites    = model_group[:rewrites]           ||= {}
+
+			xml_node.xpath("rewrite/*").each do |rewrite_node|
+				rewrite_name = rewrite_node.name
+				if rewrites.include? rewrite_name
+					# TODO check if there is a dependency path between mod_first and mod_second?
+					mod_first  = rewrites[rewrite_name][:defined]
+					mod_second = module_name
+					@warnings << "model_group:#{group_name} rewrite:#{rewrite_name} - defined in #{mod_first} and redefined in #{mod_second}"
+				end
+				rewrites[rewrite_name] = {
+					:class   => rewrite_node.content,
+					:defined => module_name,
+				}
+			end
+		end
 	end
 end

data/lib/maruto/runner.rb

@@ -6,17 +6,18 @@ require 'thor'
 class Maruto::Runner < Thor
 	include Thor::Actions
 
-	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)
+	desc "magento?", "check if MAGENTO_ROOT contains a magento app"
+	method_option :magento_root, :aliases => "-m", :default => "."
+	def magento?()
+		check_magento_folder()
+		puts "OK"
 	end
 
-	desc "lint MAGENTO_ROOT", "lint php files in MAGENTO_ROOT/app/code"
-	def lint(magento_root)
+	desc "lint", "lint php files in MAGENTO_ROOT/app/code"
+	method_option :magento_root, :aliases => "-m", :default => "."
+	def lint()
 
-		magento_root = Pathname.new(magento_root).cleanpath
-		check_magento_folder(magento_root)
+		magento_root = check_magento_folder()
 
 		# TODO move this into a lint_php method
 		inside(magento_root) do
@@ -33,15 +34,41 @@ class Maruto::Runner < Thor
 		end
 	end
 
-	desc "events MAGENTO_ROOT", "list events and their observers"
-	def events(magento_root)
+	desc "warnings", "list potential problems found in the config"
+	method_option :magento_root, :aliases => "-m", :default => "."
+	def warnings()
 
-		magento_root = Pathname.new(magento_root).cleanpath
-		check_magento_folder(magento_root)
+		magento_root = check_magento_folder()
 
 		magento_config = Maruto::MagentoConfig.new magento_root
+		magento_config.print_warnings
 
-		magento_config.events.sort_by { |k, v| k }.each do |event, observers|
+	end
+
+	desc "models", "list models sorted and grouped by their group_name"
+	method_option :magento_root, :aliases => "-m", :default => "."
+	def models()
+
+		magento_root = check_magento_folder()
+
+		magento_config = Maruto::MagentoConfig.new magento_root
+
+		magento_config.models.sort_by { |k, v| k }.each do |name,group|
+			puts "#{name} #{group}"
+		end
+
+
+	end
+
+	desc "observers", "list observers sorted and grouped by their events"
+	method_option :magento_root, :aliases => "-m", :default => "."
+	def observers()
+
+		magento_root = check_magento_folder()
+
+		magento_config = Maruto::MagentoConfig.new magento_root
+
+		magento_config.observers.sort_by { |k, v| k }.each do |event, observers|
 			puts event
 			observers.each do |observer|
 				puts "   #{observer}"
@@ -51,7 +78,9 @@ class Maruto::Runner < Thor
 	end
 
 	no_commands do
-		def check_magento_folder(magento_root)
+		def check_magento_folder()
+			magento_root = Pathname.new(options[:magento_root]).cleanpath
+
 			raise Thor::Error, "not a folder: #{magento_root}" unless magento_root.directory?
 
 			is_magento = (magento_root + 'app').directory? &&
@@ -59,7 +88,9 @@ class Maruto::Runner < Thor
 			             (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
+			raise Thor::Error, "could not find magento in this folder: #{magento_root.realpath}#{options[:magento_root] == '.' ? ' (try -m MAGENTO_ROOT)' : ''}" unless is_magento
+
+			return magento_root
 		end
 	end
 end

data/lib/maruto/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: maruto
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-03-29 00:00:00.000000000 Z
+date: 2013-04-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: nokogiri