maruto 0.0.4 → 0.0.5

data/fixtures/magento_root/app/etc/modules/Bad_Example.xml

@@ -0,0 +1,12 @@
+<?xml version="1.0"?>
+<config>
+    <modules>
+        <Bad_Example>
+            <active>maybe</active>
+            <codePool>other</codePool>
+            <depends>
+                <Hello />
+            </depends>
+        </Bad_Example>
+    </modules>
+</config>

data/lib/maruto.rb

@@ -7,4 +7,4 @@ module Maruto
 		magento = MagentoInstance.load(magento_root)
 		magento[:warnings]
 	end
-end
+end

data/lib/maruto/magento_instance.rb

@@ -13,9 +13,10 @@ module Maruto::MagentoInstance
 				# ModuleConfiguration.analyse(m, active_modules)
 			end
 
+			# TODO move to function: collect_warnings + write spec
 			warnings = []
 			all_modules.each do |m|
-				warnings.concat m[:warnings].map{|w| "[module:#{m[:name]}] #{w}"} if m.include? :warnings
+				warnings.concat m[:warnings].map{|w| w.merge(:module => m[:name]) } if m.include? :warnings
 			end
 
 			{

data/lib/maruto/module_configuration.rb

@@ -15,19 +15,19 @@ module Maruto::ModuleConfiguration
 		xml_node = xml_root.at_xpath('/config/modules')
 		if xml_node.nil?
 			m[:warnings] ||= []
-			m[:warnings] << "config.xml is missing a <modules></modules> node (in '#{m[:config_path]}')"
+			m[:warnings] << { :file => m[:config_path], :message => "config.xml is missing a /config/modules node" }
 			return m
 		end
 
 		unless xml_node.at_xpath("./#{m[:name]}")
 			m[:warnings] ||= []
-			m[:warnings] << "config.xml is missing a <modules><#{m[:name]}></#{m[:name]}></modules> node (in '#{m[:config_path]}')"
+			m[:warnings] << { :file => m[:config_path], :message => "config.xml is missing a /config/modules/#{m[:name]} node" }
 		end
 
 		xml_node.xpath("./*").each do |n|
 			unless n.name.to_sym == m[:name]
 				m[:warnings] ||= []
-				m[:warnings] << "config.xml contains configuration for a different module (<modules><#{n.name}></#{n.name}></modules> in '#{m[:config_path]}')"
+				m[:warnings] << { :file => m[:config_path], :message => "config.xml contains configuration for a different module (/config/modules/#{n.name})" }
 			end
 		end
 

data/lib/maruto/module_definition.rb

@@ -15,11 +15,13 @@ module Maruto::ModuleDefinition
 		module_definition[:dependencies] = deps if deps.size > 0
 
 		unless /^(true|false|off)$/ =~ xml_node.at_xpath('active').content then
-			module_definition[:warnings] = ["value for active element should be in ['true','false','off'] (element: #{xml_node.at_xpath('active')})"]
+			module_definition[:warnings] = []
+			module_definition[:warnings] << { :message => "value for active element should be in ['true','false','off'] (element: #{xml_node.at_xpath('active')})" }
 		end
 
 		unless /^(core|community|local)$/ =~ xml_node.at_xpath('codePool').content then
-			module_definition[:warnings] = ["value for codePool element should be in ['core','community','local'] (element: #{xml_node.at_xpath('codePool')})"]
+			module_definition[:warnings] ||= []
+			module_definition[:warnings] << { :message => "value for codePool element should be in ['core','community','local'] (element: #{xml_node.at_xpath('codePool')})" }
 		end
 
 		module_definition
@@ -30,7 +32,17 @@ module Maruto::ModuleDefinition
 		doc = Nokogiri::XML(f) { |config| config.strict }
 		f.close
 
-		doc.xpath('//modules/*').map { |xml_node| self.parse_module_definition(xml_node).merge({:defined => path}) }
+		modules = doc.xpath('//modules/*').map { |xml_node| self.parse_module_definition(xml_node).merge({:defined => path}) }
+
+		modules.each do |m|
+			if m.include? :warnings then
+				m[:warnings].each do |w|
+					w[:file] = path
+				end
+			end
+		end
+
+		modules
 	end
 
 	def self.parse_all_module_definitions()
@@ -62,19 +74,19 @@ module Maruto::ModuleDefinition
 					# disable first module
 					h[mod_name][:active] = false
 					m[:warnings] ||= []
-					m[:warnings] << "defined_in:#{m[:defined]} - duplicate module definition (in '#{h[mod_name][:defined]}' and '#{m[:defined]}')"
+					m[:warnings] << { :file => m[:defined], :message => "duplicate module definition (in '#{h[mod_name][:defined]}' and '#{m[:defined]}')" }
 				end
 				parts = mod_name.to_s.split('_')
 				h[mod_name] = m
 				if parts.size != 2
 					m[:warnings] ||= []
-					m[:warnings] << "defined_in:#{m[:defined]} - invalid module name" unless parts.size == 2
+					m[:warnings] << { :file => m[:defined], :message => "invalid module name" }
 					m[:active] = false
 				else
 					m[:config_path] = "app/code/#{m[:code_pool]}/#{parts[0]}/#{parts[1]}/etc/config.xml"
 					if !File.exists?(m[:config_path])
 						m[:warnings] ||= []
-						m[:warnings]<< "config.xml is missing (searching '#{m[:config_path]}' for #{m[:name]} defined in #{m[:defined]})"
+						m[:warnings]<< { :file => m[:defined], :message => "config.xml is missing (searching '#{m[:config_path]}' for #{m[:name]})" }
 						m[:active] = false
 					end
 				end
@@ -92,13 +104,13 @@ module Maruto::ModuleDefinition
 			m[:dependencies] = dependencies.keys
 			if duplicates.size > 0
 				m[:warnings] ||= []
-				m[:warnings] << "duplicate dependencies (#{duplicates.join(', ')}) in '#{m[:defined]}'"
+				m[:warnings] << { :file => m[:defined], :message => "duplicate dependencies (#{duplicates.join(', ')})" }
 			end
-			m[:dependencies].each do |d|
+			m[:dependencies].delete_if do |d|
 				unless h.include? d
-					m[:dependencies].delete d
 					m[:warnings] ||= []
-					m[:warnings] << "missing dependency: '#{d}' in '#{m[:defined]}'"
+					m[:warnings] << { :file => m[:defined], :message => "missing dependency: '#{d}'" }
+					true
 				end
 			end
 		end

data/lib/maruto/runner.rb

@@ -6,6 +6,13 @@ require 'thor'
 class Maruto::Runner < Thor
 	include Thor::Actions
 
+	map "-v" => :version, "--version" => :version
+
+	desc "version", "Show Maruto version"
+	def version
+		say "Maruto #{Maruto::VERSION}"
+	end
+
 	desc "magento?", "check if MAGENTO_ROOT contains a magento app"
 	method_option :magento_root, :aliases => "-m", :default => "."
 	def magento?()
@@ -45,9 +52,12 @@ class Maruto::Runner < Thor
 
 		# next gen maruto:
 
-		warnings = Maruto::warnings magento_root
-		warnings.each do |w|
-			puts "#{w}"
+		all_warnings = Maruto::warnings magento_root
+		all_warnings.group_by { |e| e[:module] }.each do |m,module_warnings|
+			puts "[module:#{m}]"
+			module_warnings.each do |w|
+				puts "   [file:#{w[:file]}] #{w[:message]}"
+			end
 		end
 
 	end
@@ -91,10 +101,10 @@ class Maruto::Runner < Thor
 			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?
+									 (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.realpath}#{options[:magento_root] == '.' ? ' (try -m MAGENTO_ROOT)' : ''}" unless is_magento
 
 			return magento_root

data/lib/maruto/version.rb

@@ -1,3 +1,3 @@
 module Maruto
-  VERSION = "0.0.4"
+  VERSION = "0.0.5"
 end

data/spec/module_definition_spec.rb

@@ -97,6 +97,8 @@ describe Maruto::ModuleDefinition do
 			''').root)
 			h.must_include :active
 			h.must_include :warnings
+			h[:warnings].size.must_equal 1
+			h[:warnings][0].must_include :message
 			# any string that is not false or off => active
 			# TODO empty string => inactive (check in php)
 			h[:active].must_equal true
@@ -111,6 +113,8 @@ describe Maruto::ModuleDefinition do
 				</modname>
 			''').root)
 			h.must_include :warnings
+			h[:warnings].size.must_equal 1
+			h[:warnings][0].must_include :message
 		end
 	end
 
@@ -122,6 +126,25 @@ describe Maruto::ModuleDefinition do
 			a[0].must_include :name
 			a[0][:name].must_equal :Mage_Api
 		end
+		it "will return an Array of module definitions" do
+			a = Maruto::ModuleDefinition.parse_module_definition_file('app/etc/modules/Mage_Api.xml')
+			a.must_be_kind_of Array
+			a.size.must_equal 1
+			a[0].must_include :name
+			a[0][:name].must_equal :Mage_Api
+		end
+		it "will add the definition file path to all warnings" do
+			file = 'app/etc/modules/Bad_Example.xml'
+			a = Maruto::ModuleDefinition.parse_module_definition_file(file)
+			a.must_be_kind_of Array
+			a.size.must_equal 1
+			a[0].must_include :warnings
+			a[0][:warnings].size.wont_equal 0
+			a[0][:warnings].each do |w|
+				w.must_include :file
+				w[:file].must_equal file
+			end
+		end
 		it "will include the relative path to the file to the module definition" do
 			file = 'app/etc/modules/Mage_All.xml'
 			a = Maruto::ModuleDefinition.parse_module_definition_file(file)
@@ -171,6 +194,7 @@ describe Maruto::ModuleDefinition do
 			a,h = Maruto::ModuleDefinition.analyse_module_definitions(parsed_module_definitions)
 			h[:Mage_A][:dependencies].size.must_equal 1
 			h[:Mage_A][:warnings].size.must_equal 2
+			h[:Mage_A][:warnings][-1][:file].must_equal @module_a[:defined]
 		end
 		it "will remove duplicate dependencies and add a warning" do
 			parsed_module_definitions = [
@@ -181,6 +205,7 @@ describe Maruto::ModuleDefinition do
 			a,h = Maruto::ModuleDefinition.analyse_module_definitions(parsed_module_definitions)
 			h[:Mage_A][:dependencies].size.must_equal 2
 			h[:Mage_A][:warnings].size.must_equal 2
+			h[:Mage_A][:warnings][-1][:file].must_equal @module_a[:defined]
 		end
 		it "will deactivate modules with an invalid name and add a warning" do
 			parsed_module_definitions = [
@@ -189,7 +214,8 @@ describe Maruto::ModuleDefinition do
 			a,h = Maruto::ModuleDefinition.analyse_module_definitions(parsed_module_definitions)
 			parsed_module_definitions[0][:active].must_equal false
 			parsed_module_definitions[0][:warnings].size.must_equal 2
-			parsed_module_definitions[0][:warnings][-1].must_include "invalid module name"
+			parsed_module_definitions[0][:warnings][-1][:message].must_include "invalid module name"
+			parsed_module_definitions[0][:warnings][-1][:file].must_equal 'a'
 		end
 		it "will add the path to the module's config.xml" do
 			parsed_module_definitions = [
@@ -206,6 +232,7 @@ describe Maruto::ModuleDefinition do
 			a,h = Maruto::ModuleDefinition.analyse_module_definitions(parsed_module_definitions)
 			parsed_module_definitions[0][:active].must_equal false
 			parsed_module_definitions[0][:warnings].size.must_equal 2
+			parsed_module_definitions[0][:warnings][-1][:file].must_equal 'hello'
 		end
 		it "will sort the Array according to module dependencies" do
 			parsed_module_definitions = [
@@ -229,6 +256,7 @@ describe Maruto::ModuleDefinition do
 			a[0][:active].must_equal true
 			a[0][:defined].must_equal 'b'
 			a[0].must_include :warnings
+			a[0][:warnings][0][:file].must_equal 'b'
 		end
 	end
 

data/spec/module_version_spec.rb

@@ -4,66 +4,64 @@ require 'maruto/module_configuration'
 
 module Maruto
 
-	describe ModuleConfiguration do
+	describe "when parsing a module config.xml and reading the module version" do
 
 		before do
 			@module_a = { :name => :Mage_A, :active => true, :code_pool => :core, :defined => 'a', :config_path => 'app/code/core/Mage/A/etc/config.xml' }
 			@module_b = { :name => :Mage_B, :active => true, :code_pool => :core, :defined => 'b', :config_path => 'app/code/core/Mage/B/etc/config.xml' }
 			@module_c = { :name => :Mage_C, :active => true, :code_pool => :core, :defined => 'c', :config_path => 'app/code/core/Mage/C/etc/config.xml' }
 			@module_d = { :name => :Mage_D, :active => true, :code_pool => :core, :defined => 'd', :config_path => 'app/code/core/Mage/D/etc/config.xml' }
+			@xml_config_root = Nokogiri::XML('''
+				<config><modules>
+					<Mage_A>
+						<version>0.0.1</version>
+					</Mage_A>
+				</modules></config>
+			''').root
 		end
 
-		describe "when parsing a module config.xml" do
-			describe "and reading the module version" do
-				before do
-					@xml_config_root = Nokogiri::XML('''
-						<config><modules>
-							<Mage_A>
-								<version>0.0.1</version>
-							</Mage_A>
-						</modules></config>
-					''').root
-				end
-				it "will return the module definition hash" do
-					m = ModuleConfiguration.read_module_version(@module_a, @xml_config_root)
-					m.must_be_kind_of Hash
-					m.must_equal @module_a
-				end
-				it "will add the version to the hash" do
-					m = ModuleConfiguration.read_module_version(@module_a, @xml_config_root)
-					m.must_include :version
-					m[:version].must_equal '0.0.1'
-				end
-				it "will add a warning when then modules node is missing" do
-					w = @module_a.merge({ :warnings => ['first warning'] })
-					m = ModuleConfiguration.read_module_version(w, Nokogiri::XML('<config><a></a></config>').root)
-					m[:warnings].size.must_equal 2
-					m[:warnings][-1].must_include '<modules'
-				end
-				it "will add a warning when then node with the module's name is missing" do
-					w = @module_a.merge({ :warnings => ['first warning'] })
-					m = ModuleConfiguration.read_module_version(w, Nokogiri::XML('<config><modules></modules></config>').root)
-					m[:warnings].size.must_equal 2
-					m[:warnings][-1].must_include '<modules'
-					m[:warnings][-1].must_include '<Mage_A'
-				end
-				it "will add a warning when there is a node from a different module" do
-					xml_config_root = Nokogiri::XML('''
-						<config><modules>
-							<Mage_A>
-								<version>0.0.1</version>
-							</Mage_A>
-							<Mage_B>
-								<version>0.0.1</version>
-							</Mage_B>
-						</modules></config>
-					''').root
-					w = @module_a.merge({ :warnings => ['first warning'] })
-					m = ModuleConfiguration.read_module_version(w, xml_config_root)
-					m[:warnings].size.must_equal 2
-					m[:warnings][-1].must_include 'Mage_B'
-				end
-			end
+		it "will return the module definition hash" do
+			m = ModuleConfiguration.read_module_version(@module_a, @xml_config_root)
+			m.must_be_kind_of Hash
+			m.must_equal @module_a
 		end
+		it "will add the version to the hash" do
+			m = ModuleConfiguration.read_module_version(@module_a, @xml_config_root)
+			m.must_include :version
+			m[:version].must_equal '0.0.1'
+		end
+		it "will add a warning when then modules node is missing" do
+			w = @module_a.merge({ :warnings => ['first warning'] })
+			m = ModuleConfiguration.read_module_version(w, Nokogiri::XML('<config><a></a></config>').root)
+			m[:warnings].size.must_equal 2
+			m[:warnings][-1][:file].must_equal m[:config_path]
+			m[:warnings][-1][:message].must_include '/config/modules'
+		end
+		it "will add a warning when then node with the module's name is missing" do
+			w = @module_a.merge({ :warnings => ['first warning'] })
+			m = ModuleConfiguration.read_module_version(w, Nokogiri::XML('<config><modules></modules></config>').root)
+			m[:warnings].size.must_equal 2
+			m[:warnings][-1][:file].must_equal m[:config_path]
+			m[:warnings][-1][:message].must_include '/config/modules/Mage_A'
+		end
+		it "will add a warning when there is a node from a different module" do
+			xml_config_root = Nokogiri::XML('''
+				<config><modules>
+					<Mage_A>
+						<version>0.0.1</version>
+					</Mage_A>
+					<Mage_B>
+						<version>0.0.1</version>
+					</Mage_B>
+				</modules></config>
+			''').root
+			w = @module_a.merge({ :warnings => ['first warning'] })
+			m = ModuleConfiguration.read_module_version(w, xml_config_root)
+			m[:warnings].size.must_equal 2
+			m[:warnings][-1][:file].must_equal m[:config_path]
+			m[:warnings][-1][:message].must_include 'Mage_B'
+		end
+
 	end
+
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: maruto
 version: !ruby/object:Gem::Version
-  version: 0.0.4
+  version: 0.0.5
   prerelease: 
 platform: ruby
 authors:
@@ -111,6 +111,7 @@ files:
 - fixtures/magento_root/app/code/core/Mage/B/etc/config.xml
 - fixtures/magento_root/app/code/core/Mage/C/etc/config.xml
 - fixtures/magento_root/app/code/core/Mage/D/etc/config.xml
+- fixtures/magento_root/app/etc/modules/Bad_Example.xml
 - fixtures/magento_root/app/etc/modules/Mage_All.xml
 - fixtures/magento_root/app/etc/modules/Mage_Api.xml
 - lib/maruto.rb