maruto 0.0.7 → 0.0.8

data/lib/maruto/magento_instance.rb

@@ -1,10 +1,13 @@
 
+require 'maruto/magento_version'
 require 'maruto/module_definition'
 require 'maruto/module_configuration'
 
 module Maruto::MagentoInstance
 	def self.load(magento_root)
 		Dir.chdir(magento_root) do
+			magento_version = Maruto::MagentoVersion.read_magento_version()
+
 			all_modules = Maruto::ModuleDefinition.parse_all_module_definitions()
 			sorted_modules, active_modules = Maruto::ModuleDefinition.analyse_module_definitions(all_modules)
 
@@ -25,6 +28,7 @@ module Maruto::MagentoInstance
 				:all_modules     => Hash[all_modules.collect { |m| [m[:name], m]}],
 				:sorted_modules  => sorted_modules,
 				:event_observers => event_observers,
+				:version         => magento_version,
 				:warnings        => warnings,
 			}
 		end

data/lib/maruto/magento_version.rb

@@ -0,0 +1,57 @@
+require 'maruto/base'
+require 'nokogiri'
+
+module Maruto::MagentoVersion
+
+	def self.read_magento_version()
+		mage = 'app/Mage.php'
+		return nil unless File.exists? mage
+		File.open mage do |file|
+			# newer magento version have a getVersionInfo function
+			newer = file.find { |line| line =~ /getVersionInfo/ }
+			file.rewind
+			if newer
+				# newer Magento version
+				function = read_function(file, 'getVersionInfo')
+				match    = function.match(/return array\(.*'major'.*'(\d+)'.*'minor'.*'(\d+)'.*'revision'.*'(\d+)'.*'patch'.*'(\d+)'.*'stability'.*'number'.*\)/)
+				version    = []
+				version[0] = match[1].to_i unless match[1].nil?
+				version[1] = match[2].to_i unless match[2].nil?
+				version[2] = match[3].to_i unless match[3].nil?
+				version[3] = match[4].to_i unless match[4].nil?
+				return version
+			else
+				# older Magento version
+				function = read_function(file, 'getVersion')
+				match    = function.match(/return '(\d+)\.(\d+)\.?(\d+)?\.?(\d+)?';/)
+				version    = []
+				version[0] = match[1].to_i unless match[1].nil?
+				version[1] = match[2].to_i unless match[2].nil?
+				version[2] = match[3].to_i unless match[3].nil?
+				version[3] = match[4].to_i unless match[4].nil?
+				return version
+			end
+		end
+	end
+
+private
+
+	def self.read_function(file, function_name)
+		func = nil
+		file.rewind
+		file.each_line do |line|
+			if func then
+				func += line
+				if /}/ =~ line
+					break
+				end
+			else
+				if /public static function #{function_name}\(\)/ =~ line
+					func = line
+				end
+			end
+		end
+		func.delete("\n")
+	end
+
+end

data/lib/maruto/module_configuration.rb

@@ -124,8 +124,17 @@ module Maruto::ModuleConfiguration
 					events[event_name] ||= Hash.new
 					event[:observers].each do |observer|
 						observer_name = observer[:name]
-						if events[event_name].include? observer_name
-							add_module_config_warning(m, "event_observer:#{area}/#{event_name}/#{observer_name} - defined in #{events[event_name][observer_name][:module]} and redefined in #{m[:name]}")
+						if events[event_name].include? observer_name then
+							if observer[:type] != :disabled
+								add_module_config_warning(m, "event_observer:#{area}/#{event_name}/#{observer_name} - defined in module:#{events[event_name][observer_name][:module]} and redefined in module:#{m[:name]} (use type: disabled instead)")
+							end
+							unless m.include? :dependencies and m[:dependencies].include? events[event_name][observer_name][:module]
+								add_module_config_warning(m, "module:#{m[:name]} should have a dependency on module:#{events[event_name][observer_name][:module]} because of event_observer:#{area}/#{event_name}/#{observer_name}")
+							end
+						else
+							if observer[:type] == :disabled
+								add_module_config_warning(m, "event_observer:#{area}/#{event_name}/#{observer_name} - cannot disable an inexistant event observer")
+							end
 						end
 						events[event_name][observer_name] = observer
 						events[event_name][observer_name][:module] = m[:name]

data/lib/maruto/runner.rb

@@ -8,9 +8,17 @@ class Maruto::Runner < Thor
 
 	map "-v" => :version, "--version" => :version
 
-	desc "version", "Show Maruto version"
+	desc "version", "Show Maruto and Magento version"
+	method_option :magento_root, :aliases => "-m", :default => "."
 	def version
 		say "Maruto #{Maruto::VERSION}"
+		begin
+			magento_root = check_magento_folder()
+			magento = Maruto::MagentoInstance.load(magento_root)
+			say "Magento #{magento[:version].join('.')}"
+		rescue Thor::Error
+			# do nothing
+		end
 	end
 
 	desc "magento?", "check if MAGENTO_ROOT contains a magento app"
@@ -32,7 +40,8 @@ class Maruto::Runner < Thor
 				begin
 					firstline = File.open(file, &:readline)
 					# TODO return list of warnings
-					puts file unless firstline.start_with?("<?php")
+					# TODO case insensitive
+					puts file unless firstline.start_with?("<?php") or firstline.start_with?("<?PHP")
 				rescue
 					# TODO return list of errors
 					puts "error in " + file
@@ -140,7 +149,7 @@ class Maruto::Runner < Thor
 									 (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/etc/modules/Mage_All.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.7"
+  VERSION = "0.0.8"
 end

data/maruto.gemspec

@@ -23,6 +23,6 @@ Gem::Specification.new do |spec|
 
   spec.add_development_dependency "bundler", "~> 1.3"
   spec.add_development_dependency "rake"
-  spec.add_development_dependency "minitest"
+  spec.add_development_dependency "minitest", "~> 5"
   # spec.add_development_dependency "minitest-reporters"
 end

data/spec/magento_version_spec.rb

@@ -0,0 +1,57 @@
+require 'spec_helper'
+
+require 'maruto/magento_version'
+
+module Maruto
+
+	describe "when reading the magento version" do
+
+		before do
+			# Magento Community Edition
+			@magento_root_1_0     = File.expand_path('../../fixtures/magento_1.0', __FILE__)
+			@magento_root_1_3_3_0 = File.expand_path('../../fixtures/magento_1.3.3.0', __FILE__)
+			@magento_root_1_4_0_0 = File.expand_path('../../fixtures/magento_1.4.0.0', __FILE__)
+			@magento_root_1_7_0_2 = File.expand_path('../../fixtures/magento_1.7.0.2', __FILE__)
+			# Magento Enterprise Edition
+			@magento_root_1_13_0_0 = File.expand_path('../../fixtures/magento_1.13.0.0', __FILE__)
+		end
+
+		it "will return an array" do
+			Dir.chdir(@magento_root_1_0) do
+				version = MagentoVersion.read_magento_version()
+				version.must_be_kind_of Array
+			end
+		end
+		it "will read version 1.0" do
+			Dir.chdir(@magento_root_1_0) do
+				version = MagentoVersion.read_magento_version()
+				version.must_equal [1,0]
+			end
+		end
+		it "will read version 1.3.3.0" do
+			Dir.chdir(@magento_root_1_3_3_0) do
+				version = MagentoVersion.read_magento_version()
+				version.must_equal [1,3,3,0]
+			end
+		end
+		it "will read version 1.4.0.0" do
+			Dir.chdir(@magento_root_1_4_0_0) do
+				version = MagentoVersion.read_magento_version()
+				version.must_equal [1,4,0,0]
+			end
+		end
+		it "will read version 1.7.0.2" do
+			Dir.chdir(@magento_root_1_7_0_2) do
+				version = MagentoVersion.read_magento_version()
+				version.must_equal [1,7,0,2]
+			end
+		end
+		it "will read version 1.13.0.0" do
+			Dir.chdir(@magento_root_1_13_0_0) do
+				version = MagentoVersion.read_magento_version()
+				version.must_equal [1,13,0,0]
+			end
+		end
+
+	end
+end

data/spec/module_events_spec.rb

@@ -301,18 +301,19 @@ module Maruto
 				@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' }
 
-				@observer_1 = { :name => 'a_o1', :type => 'singleton', :class => 'Mage_A_Model_Observer', :method => 'global_1' }
+				@observer_1 = { :name => 'a_o1', :type => :singleton, :class => 'Mage_A_Model_Observer', :method => 'global_1' }
+				@observer_2 = { :name => 'a_o2', :type => :singleton, :class => 'Mage_A_Model_Observer', :method => 'global_2' }
 
 				@module_a[:events] = {
 					:global => [{ :name => 'e1', :observers => [
 						@observer_1,
-						{ :name => 'a_o2', :type => 'singleton', :class => 'Mage_A_Model_Observer', :method => 'global_2' }
+						@observer_2
 					] }],
 					:adminhtml => [{ :name => 'e1', :observers => [
-						{ :name => 'a_o1', :type => 'singleton', :class => 'Mage_A_Model_Observer', :method => 'adminhtml_1' }
+						{ :name => 'a_o1', :type => :singleton, :class => 'Mage_A_Model_Observer', :method => 'adminhtml_1' }
 					] }],
 					:frontend => [{ :name => 'e1', :observers => [
-						{ :name => 'a_o1', :type => 'singleton', :class => 'Mage_A_Model_Observer', :method => 'frontend_1' }
+						{ :name => 'a_o1', :type => :singleton, :class => 'Mage_A_Model_Observer', :method => 'frontend_1' }
 					] }]
 				}
 
@@ -341,19 +342,54 @@ module Maruto
 				@module_b[:events] = {
 					:global => [{ :name => 'e1', :observers => [ @observer_1 ] }]
 				}
+				@module_b[:dependencies] = [:Mage_A]
 				h = ModuleConfiguration.collect_scoped_event_observers(:global, [@module_a, @module_b])
 
 				@module_b.must_include :warnings
 				@module_b[:warnings].size.must_equal 1
 			end
-			it "will add a warning when overwriting an observer without module dependency" do
-				# TODO
-			end
 			it "wont add a warning when overwriting an observer to disable it" do
-				# TODO
+				disabled_observer = @observer_1.clone
+				disabled_observer[:type] = :disabled
+				@module_b[:events] = {
+					:global => [{ :name => 'e1', :observers => [ disabled_observer ] }]
+				}
+				@module_b[:dependencies] = [:Mage_A]
+				h = ModuleConfiguration.collect_scoped_event_observers(:global, [@module_a, @module_b])
+
+				@module_b.wont_include :warnings
+			end
+			it "will add a warning when overwriting an observer without module dependency" do
+				disabled_observer = @observer_2.clone
+				disabled_observer[:type] = :disabled
+
+				@module_b[:events] = {
+					:global => [{ :name => 'e1', :observers => [ @observer_1 ] }]
+				}
+				@module_c[:events] = {
+					:global => [{ :name => 'e1', :observers => [ disabled_observer ] }]
+				}
+				@module_d[:events] = {
+					:global => [{ :name => 'e1', :observers => [ @observer_1, disabled_observer ] }]
+				}
+
+				h = ModuleConfiguration.collect_scoped_event_observers(:global, [@module_a, @module_b])
+				@module_b.must_include :warnings
+				@module_b[:warnings].size.must_equal 2 # 1 for overwriting + 1 for missing dependency
+
+				h = ModuleConfiguration.collect_scoped_event_observers(:global, [@module_a, @module_c])
+				@module_c.must_include :warnings
+				@module_c[:warnings].size.must_equal 1 # 1 for missing dependency
+
+				h = ModuleConfiguration.collect_scoped_event_observers(:global, [@module_a, @module_d])
+				@module_d.must_include :warnings
+				@module_d[:warnings].size.must_equal 3 # 1 for overwriting + 2 for missing dependency
 			end
 			it "will add a warning when disabling a non-existing observer" do
-				# TODO
+				@observer_1[:type] = :disabled
+				h = ModuleConfiguration.collect_scoped_event_observers(:global, [@module_a])
+				@module_a.must_include :warnings
+				@module_a[:warnings].size.must_equal 1
 			end
 
 
@@ -401,31 +437,5 @@ module Maruto
 			end
 		end
 
-		describe "when analysing event observers" do
-
-			it "will add a warning when an observer has already been declared" do
-
-			end
-
-			# it "will warn when an event has no observers" do
-			# 	xml_node_no_obs = Nokogiri::XML('''
-			# 		<config><scope><events><first_event></first_event></events></scope></config>
-			# 	''').root
-			# 	events, warnings = ModuleConfiguration.parse_scoped_event_observers('root', xml_node_no_obs.xpath('/config/scope'))
-			# 	events.size.must_equal 0
-			# 	warnings.size.must_equal 1
-			# 	warnings[0].must_include 'root/events/first_event'
-			# end
-			# it "will warn when an event has an empty observers node" do
-			# 	xml_node_empty_obs = Nokogiri::XML('''
-			# 		<config><scope><events><first_event><observers></observers></first_event></events></scope></config>
-			# 	''').root
-			# 	events, warnings = ModuleConfiguration.parse_scoped_event_observers('root', xml_node_empty_obs.xpath('/config/scope'))
-			# 	events.size.must_equal 0
-			# 	warnings.size.must_equal 1
-			# 	warnings[0].must_include 'root/events/first_event/observers'
-			# end
-
-		end
 	end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: maruto
 version: !ruby/object:Gem::Version
-  version: 0.0.7
+  version: 0.0.8
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-05-15 00:00:00.000000000 Z
+date: 2013-05-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: nokogiri
@@ -80,17 +80,17 @@ dependencies:
   requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - ! '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '5'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - ! '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '5'
 description: Magento Ruby Tools
 email:
 - jlgeering.13@gmail.com
@@ -107,6 +107,11 @@ files:
 - README.md
 - Rakefile
 - bin/maruto
+- fixtures/magento_1.0/app/Mage.php
+- fixtures/magento_1.13.0.0/app/Mage.php
+- fixtures/magento_1.3.3.0/app/Mage.php
+- fixtures/magento_1.4.0.0/app/Mage.php
+- fixtures/magento_1.7.0.2/app/Mage.php
 - fixtures/magento_root/app/code/core/Mage/A/etc/config.xml
 - fixtures/magento_root/app/code/core/Mage/B/etc/config.xml
 - fixtures/magento_root/app/code/core/Mage/C/etc/config.xml
@@ -118,11 +123,13 @@ files:
 - lib/maruto/base.rb
 - lib/maruto/magento_config.rb
 - lib/maruto/magento_instance.rb
+- lib/maruto/magento_version.rb
 - lib/maruto/module_configuration.rb
 - lib/maruto/module_definition.rb
 - lib/maruto/runner.rb
 - lib/maruto/version.rb
 - maruto.gemspec
+- spec/magento_version_spec.rb
 - spec/module_definition_spec.rb
 - spec/module_events_spec.rb
 - spec/module_version_spec.rb
@@ -153,6 +160,7 @@ signing_key:
 specification_version: 3
 summary: config parser and analyser, ...
 test_files:
+- spec/magento_version_spec.rb
 - spec/module_definition_spec.rb
 - spec/module_events_spec.rb
 - spec/module_version_spec.rb