rgen_ext 0.0.1

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/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in rgen_ext.gemspec
+gemspec

data/LICENSE

@@ -0,0 +1,202 @@
+Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "{}"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright {yyyy} {name of copyright owner}
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.
+

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Federico Tomassetti
+
+MIT 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/README.md

@@ -0,0 +1,63 @@
+# RGen-Ext
+
+We love RGen and use it over and over. Sometimes we feel there are some operations we implement ourself in different projects.
+The maintainers of RGen want to keep the gem essential, so this project want to pack these common extensions which do not fit directly in RGen.
+
+## Examples
+
+### Comparison
+
+There are two kinds of Comparator: a ShallowComparator (considering only attributes) and a DeepComparator (which considers also references, recursively).
+You can use them like that:
+
+    include RGen::Ext::Comparison
+
+    ShallowComparator.eql?(ferrari_enzo,ferrari_superenzo)
+    DeepComparator.eql?(ferrari_enzo,ferrari_superenzo)
+    
+### Navigation
+
+Do you feel that the RGen objects should be able to give a list of all their children (direct and indirect)?
+In RGen-ext you do that in this way:
+
+    class AddressBook < RGen::MetamodelBuilder::MMBase
+      include RGen::Ext::NavigationExtensions
+      contains_many_uni 'entries', AddressBookEntry
+    end
+    
+    jones_address_book.all_children # this returnes all entries
+    jones_address_book.all_children_deep # this returns all entries and all the children of all entries and so on
+    
+It is also possible to iterate among all the children and the children of the children and so on. Quite handy when you have to traverse a tree:
+
+   jones_address_book.traverse {|n| puts "Traversing #{n}" }
+   
+You have to add the extension only on the classes on which you want to invoke these methods directly, not necessarily on all the classes of the hierarchy.
+
+### Other stuff
+
+For that I am looking for YOUR contributions!
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'rgen_ext'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install rgen_ext
+
+## Contributing
+
+I am really open to contributions and I would revise them fast and include them even faster, so just start write them.
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,9 @@
+require "bundler/gem_tasks"
+require 'rake/testtask'
+
+Rake::TestTask.new do |t|
+  t.libs << 'test'
+end
+
+desc "Run tests"
+task :default => :test

data/lib/rgen/ext/comparison.rb

@@ -0,0 +1,96 @@
+# RGen-ext
+# Common extension to the RGen Framework
+# Federico Tomassetti, 2013
+
+module RGen
+module Ext
+module Comparison
+
+  module UnorderedComparison
+
+    def self.eql?(left,right,element_comparator)
+      return false unless left.count==right.count
+      left.each do |l|
+        return false unless how_many_times_in(l,left,element_comparator)==how_many_times_in(l,right,element_comparator)
+      end
+      true
+    end
+
+    private
+
+    def self.how_many_times_in(el,array,element_comparator)
+      count = 0
+      array.each do |other|
+        if element_comparator
+          count += 1 if element_comparator.eql?(el,other)
+        else
+          count += 1 if el.eql?(other)
+        end
+      end
+      count
+    end
+
+  end
+
+  module ShallowComparator
+
+    # It does not check references, so that infinite recursion
+    # is avoided
+    def self.eql?(left,right)
+      return false if right==nil
+      return false unless left.class==right.class
+      left.class.ecore.eAllAttributes.each do |attribute|
+        raise "Attrib <nil> for class #{left.class.ecore.name}" unless attribute
+        left_value  = left.send(attribute.name)
+        right_value = right.send(attribute.name)
+        if (!attribute.many) || attribute.ordered
+          return false unless left_value.eql?(right_value)
+        else
+          return false unless UnorderedComparison.eql?(left_value,right_value,nil)
+        end
+      end
+      true
+    end  
+
+  end
+
+  module DeepComparator
+
+    # It checks all the containment references recursively
+    # while it compare the non-containment references using
+    # ShallowComparator, to avoid infinite recursion
+    def self.eql?(left,right)   
+      return false unless ShallowComparator.eql?(left,right)
+      left.class.ecore.eAllReferences.each do |ref|
+        left_value = left.send(ref.name)
+        right_value = right.send(ref.name)
+        # it should ignore relations which has as opposite a containment
+        unless (ref.getEOpposite and ref.getEOpposite.containment)
+          comparison_method = ref.containment ? DeepComparator : ShallowComparator
+          if left_value==nil || right_value==nil          
+            # if one value is nil, both should be nil
+            return false unless left_value==right_value
+          elsif ref.many
+            # compare each children
+            return false unless left_value.count==right_value.count
+            if ref.ordered
+              for i in 0...left_value.count             
+                return false unless comparison_method.send(:eql?,left_value[i],right_value[i])      
+              end
+            else
+              return false unless UnorderedComparison.eql?(left_value,right_value,DeepComparator)
+            end
+          else              
+            # compare the only child
+            return false unless comparison_method.send(:eql?,left_value,right_value)                                             
+          end
+        end           
+      end
+      true    
+    end
+
+  end
+
+end
+end
+end

data/lib/rgen/ext/navigation_extensions.rb

@@ -0,0 +1,61 @@
+# RGen-ext
+# Common extension to the RGen Framework
+# Federico Tomassetti, 2013
+
+module RGen
+module Ext
+
+# This module is intended to be included in a class extending MMBase
+# to plug-in additional functionalities to navigate the model
+#
+# The methods use a parameter is used to make the method
+# work on elements of the subtree which do not include
+# this module
+module NavigationExtensions
+
+  # Return the root of the model
+  def root(of=self)
+    return of unless of.eContainer
+    root(of.eContainer)
+  end  
+
+  def all_children(of=self)
+    arr = []
+    ecore = of.class.ecore
+    ecore.eAllReferences.select {|r| r.containment}.each do |ref|
+      res = of.send(ref.name.to_sym)
+      if ref.many
+        res.each do |el|
+          arr << el unless el==nil
+        end
+      elsif res!=nil
+        arr << res
+      end
+    end
+    arr
+  end
+
+  def all_children_deep(of=self)
+    arr = []
+    of.all_children.each do |c|
+      arr << c
+      c.all_children_deep.each do |cc|
+        arr << cc
+      end
+    end     
+    arr
+  end
+
+  # The node itself and all the node in the sub-tree
+  # are passed to the given block
+  def traverse(&op)
+    op.call(self)
+    all_children_deep.each do |c|
+      op.call(c)
+    end
+  end  
+
+end
+
+end
+end

data/lib/rgen/ext/version.rb

@@ -0,0 +1,3 @@
+module RgenExt
+  VERSION = "0.0.1"
+end

data/lib/rgen/ext.rb

@@ -0,0 +1,3 @@
+require "rgen/ext/version"
+require "rgen/ext/comparison"
+require "rgen/ext/navigation_extensions"

data/rgen_ext.gemspec

@@ -0,0 +1,26 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'rgen/ext/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "rgen_ext"
+  spec.version       = RgenExt::VERSION
+  spec.authors       = ["Federico Tomassetti"]
+  spec.email         = ["f.tomassetti@gmail.com"]
+  spec.description   = %q{Extensions of general use to RGen}
+  spec.summary       = %q{Extensions of general use to RGen}
+  spec.homepage      = "http://github.com/ftomassetti/rgen_ext"
+  spec.license       = "Apache License v2"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "rgen"
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "simplecov"
+end

data/test/helper.rb

@@ -0,0 +1,8 @@
+require 'simplecov'
+SimpleCov.start do
+    add_filter "/test/"        
+end
+
+require 'rgen/metamodel_builder'
+require 'rgen/ext'
+require 'test/unit'

data/test/test_comparison.rb

@@ -0,0 +1,275 @@
+require 'helper'
+
+class ComparisonTest < Test::Unit::TestCase
+  
+  include RGen::Ext::Comparison
+
+  module OrderedTestMetamodel
+
+    class Address < RGen::MetamodelBuilder::MMBase
+      has_attr 'type', String
+      has_attr 'street', String
+      has_attr 'number', String
+    end
+
+    class AddressBookEntry < RGen::MetamodelBuilder::MMBase
+      has_attr 'name', String
+      contains_many_uni 'addresses', Address
+    end
+
+    class AddressBook < RGen::MetamodelBuilder::MMBase
+      contains_many_uni 'entries', AddressBookEntry
+    end
+
+  end
+
+  module UnorderedTestMetamodel
+
+    class Country < RGen::MetamodelBuilder::MMBase
+      has_many_attr 'qualities', String, ordered: false
+    end
+
+    class World < RGen::MetamodelBuilder::MMBase
+      contains_many_uni 'countries', Country, ordered: false
+    end
+
+  end
+
+  module CarMetamodel
+
+    class Engine < RGen::MetamodelBuilder::MMBase
+      has_attr 'code',String
+      has_attr 'horse_power',Integer
+    end    
+
+    class Car < RGen::MetamodelBuilder::MMBase
+      contains_one_uni 'engine', Engine
+    end
+
+  end
+   
+  def setup
+    # Ordered data
+
+    @jones_work_address = OrderedTestMetamodel::Address.new
+    @jones_work_address.type = 'work'
+
+    @jones_home_address = OrderedTestMetamodel::Address.new
+    @jones_home_address.type = 'home'    
+
+    @jones_book_entry = OrderedTestMetamodel::AddressBookEntry.new
+    @jones_book_entry.name = 'Mr. Jones'
+    @jones_book_entry.addAddresses(@jones_work_address)
+    @jones_book_entry.addAddresses(@jones_home_address)
+
+    @smith_shop_address = OrderedTestMetamodel::Address.new
+    @smith_shop_address.type = 'shop'
+
+    @smith_home_address = OrderedTestMetamodel::Address.new
+    @smith_home_address.type = 'home'      
+
+    @smith_book_entry = OrderedTestMetamodel::AddressBookEntry.new
+    @smith_book_entry.name = 'Mr. Smith'
+    @smith_book_entry.addAddresses(@smith_shop_address)
+    @smith_book_entry.addAddresses(@smith_home_address)
+
+    @green_book_entry = OrderedTestMetamodel::AddressBookEntry.new
+    @green_book_entry.name = 'Mr. Green'
+
+    @address_book_1 = OrderedTestMetamodel::AddressBook.new
+    @address_book_1.addEntries(@jones_book_entry)
+    @address_book_1.addEntries(@smith_book_entry)
+    @address_book_1.addEntries(@green_book_entry)
+
+    # Unordered data
+
+    @c_1 = UnorderedTestMetamodel::Country.new
+    @c_1.addQualities 'sunny'
+    @c_1.addQualities 'open-minded'
+    
+    @c_2 = UnorderedTestMetamodel::Country.new
+    @c_2.addQualities 'open-minded'
+    @c_2.addQualities 'sunny'
+    
+    @c_3 = UnorderedTestMetamodel::Country.new
+    @c_3.addQualities 'open-minded'
+    @c_3.addQualities 'sunny'
+    @c_3.addQualities 'sunny'
+    
+    @c_4 = UnorderedTestMetamodel::Country.new
+    @c_4.addQualities 'open-minded'
+    @c_4.addQualities 'open-minded'
+
+    @world_1 = UnorderedTestMetamodel::World.new    
+    @world_1.addCountries @c_1
+    @world_1.addCountries @c_2
+    @world_1.addCountries @c_3
+
+    @world_2 = UnorderedTestMetamodel::World.new
+    @world_2.addCountries @c_2
+    @world_2.addCountries @c_1
+    @world_2.addCountries @c_3
+    
+    @world_3 = UnorderedTestMetamodel::World.new
+    @world_3.addCountries @c_3
+    @world_3.addCountries @c_1
+    @world_3.addCountries @c_2    
+
+    @world_4 = UnorderedTestMetamodel::World.new
+    @world_4.addCountries @c_2
+    @world_4.addCountries @c_1
+    @world_4.addCountries @c_2    
+
+    # Car test data
+    @ferrari_v8   = CarMetamodel::Engine.new({:horse_power => 800, :code => 'Ferrari-V8'})
+    @ferrari_enzo = CarMetamodel::Car.new
+    @ferrari_enzo.engine = @ferrari_v8
+
+    @ferrari_v8b  = CarMetamodel::Engine.new({:horse_power => 800, :code => 'Ferrari-V8'})
+    @ferrari_superenzo = CarMetamodel::Car.new
+    @ferrari_superenzo.engine = @ferrari_v8b
+
+    @ferrari_v9  = CarMetamodel::Engine.new({:horse_power => 900, :code => 'Ferrari-V9'})
+    @ferrari_superextraenzo = CarMetamodel::Car.new
+    @ferrari_superextraenzo.engine = @ferrari_v9
+
+    @auto_without_engine = CarMetamodel::Car.new 
+  end
+
+  def test_deep_comparator_based_on_unordered_attributes
+    assert_equal true, DeepComparator.eql?(@c_1,@c_1)
+    assert_equal true, DeepComparator.eql?(@c_1,@c_2)
+    assert_equal false,DeepComparator.eql?(@c_1,@c_3)
+    assert_equal false,DeepComparator.eql?(@c_1,@c_4)
+    assert_equal true, DeepComparator.eql?(@c_2,@c_1)
+    assert_equal true, DeepComparator.eql?(@c_2,@c_2)
+    assert_equal false,DeepComparator.eql?(@c_2,@c_3)
+    assert_equal false,DeepComparator.eql?(@c_2,@c_4)
+    assert_equal false,DeepComparator.eql?(@c_3,@c_1)
+    assert_equal false,DeepComparator.eql?(@c_3,@c_2)
+    assert_equal true, DeepComparator.eql?(@c_3,@c_3)
+    assert_equal false,DeepComparator.eql?(@c_3,@c_4)
+    assert_equal false,DeepComparator.eql?(@c_4,@c_1)
+    assert_equal false,DeepComparator.eql?(@c_4,@c_2)
+    assert_equal false,DeepComparator.eql?(@c_4,@c_3)
+    assert_equal true, DeepComparator.eql?(@c_4,@c_4)    
+  end
+
+  def test_shallow_comparator_based_on_unordered_attributes
+    assert_equal true, ShallowComparator.eql?(@c_1,@c_1)
+    assert_equal true, ShallowComparator.eql?(@c_1,@c_2)
+    assert_equal false,ShallowComparator.eql?(@c_1,@c_3)
+    assert_equal false,ShallowComparator.eql?(@c_1,@c_4)
+    assert_equal true, ShallowComparator.eql?(@c_2,@c_1)
+    assert_equal true, ShallowComparator.eql?(@c_2,@c_2)
+    assert_equal false,ShallowComparator.eql?(@c_2,@c_3)
+    assert_equal false,ShallowComparator.eql?(@c_2,@c_4)
+    assert_equal false,ShallowComparator.eql?(@c_3,@c_1)
+    assert_equal false,ShallowComparator.eql?(@c_3,@c_2)
+    assert_equal true, ShallowComparator.eql?(@c_3,@c_3)
+    assert_equal false,ShallowComparator.eql?(@c_3,@c_4)
+    assert_equal false,ShallowComparator.eql?(@c_4,@c_1)
+    assert_equal false,ShallowComparator.eql?(@c_4,@c_2)
+    assert_equal false,ShallowComparator.eql?(@c_4,@c_3)
+    assert_equal true, ShallowComparator.eql?(@c_4,@c_4)    
+  end  
+
+  def test_deep_comparator_based_on_unordered_references
+    assert_equal true,  DeepComparator.eql?(@world_1,@world_1)
+    assert_equal true, DeepComparator.eql?(@world_1,@world_2)
+    assert_equal true, DeepComparator.eql?(@world_1,@world_3)
+    assert_equal false, DeepComparator.eql?(@world_1,@world_4)
+    assert_equal true, DeepComparator.eql?(@world_2,@world_1)
+    assert_equal true,  DeepComparator.eql?(@world_2,@world_2)
+    assert_equal true, DeepComparator.eql?(@world_2,@world_3)
+    assert_equal false, DeepComparator.eql?(@world_2,@world_4)
+    assert_equal true, DeepComparator.eql?(@world_3,@world_1)
+    assert_equal true, DeepComparator.eql?(@world_3,@world_2)
+    assert_equal true,  DeepComparator.eql?(@world_3,@world_3)
+    assert_equal false, DeepComparator.eql?(@world_3,@world_4)    
+    assert_equal false, DeepComparator.eql?(@world_4,@world_1)
+    assert_equal false, DeepComparator.eql?(@world_4,@world_2)
+    assert_equal false, DeepComparator.eql?(@world_4,@world_3)
+    assert_equal true,  DeepComparator.eql?(@world_4,@world_4)    
+  end    
+
+  def test_deep_comparator_based_on_ordered_attributes_positive_case
+      same_as_jones_work_address = OrderedTestMetamodel::Address.new
+      same_as_jones_work_address.type = 'work'
+
+      assert_equal true,DeepComparator.eql?(same_as_jones_work_address,@jones_work_address)
+      assert_equal true,DeepComparator.eql?(@jones_work_address,same_as_jones_work_address)
+  end
+
+  def test_deep_comparator_based_on_ordered_attributes_negative_case
+      assert_equal false,DeepComparator.eql?(@jones_work_address,@jones_home_address)
+      assert_equal false,DeepComparator.eql?(@jones_home_address,@jones_work_address)
+  end  
+
+  def test_shallow_comparator_based_on_ordered_attributes_negative_case
+      assert_equal false,ShallowComparator.eql?(@jones_home_address,@jones_work_address)
+      assert_equal false,ShallowComparator.eql?(@jones_work_address,@jones_home_address)
+  end  
+
+  def test_shallow_comparator_based_on_ordered_attributes_positive_case
+      same_as_jones_work_address = OrderedTestMetamodel::Address.new
+      same_as_jones_work_address.type = 'work'
+
+      assert_equal true,ShallowComparator.eql?(same_as_jones_work_address,@jones_work_address)
+      assert_equal true,ShallowComparator.eql?(@jones_work_address,same_as_jones_work_address)
+  end
+
+  def test_shallow_comparator_based_on_ordered_attributes_and_children
+      same_as_jones_work_address = OrderedTestMetamodel::Address.new
+      same_as_jones_work_address.type = 'work'
+
+      same_as_jones_home_address = OrderedTestMetamodel::Address.new
+      same_as_jones_home_address.type = 'home'
+      
+      similar_to_jones_book_entry = OrderedTestMetamodel::AddressBookEntry.new
+      similar_to_jones_book_entry.name = 'Mr. Jones'
+
+      assert_equal true,ShallowComparator.eql?(@jones_book_entry,similar_to_jones_book_entry)
+
+      similar_to_jones_book_entry.addAddresses(same_as_jones_work_address)
+      similar_to_jones_book_entry.addAddresses(same_as_jones_home_address)
+
+      assert_equal true,ShallowComparator.eql?(@jones_home_address,same_as_jones_home_address)
+      assert_equal true,ShallowComparator.eql?(@jones_work_address,same_as_jones_work_address)
+      assert_equal true,ShallowComparator.eql?(@jones_book_entry,similar_to_jones_book_entry)      
+  end 
+
+  def test_deep_comparator_based_on_ordered_attributes_and_children
+      same_as_jones_work_address = OrderedTestMetamodel::Address.new
+      same_as_jones_work_address.type = 'work'
+
+      same_as_jones_home_address = OrderedTestMetamodel::Address.new
+      same_as_jones_home_address.type = 'home'
+      
+      similar_to_jones_book_entry = OrderedTestMetamodel::AddressBookEntry.new
+      similar_to_jones_book_entry.name = 'Mr. Jones'
+
+      assert_equal false,DeepComparator.eql?(@jones_book_entry,similar_to_jones_book_entry)
+
+      similar_to_jones_book_entry.addAddresses(same_as_jones_work_address)
+      similar_to_jones_book_entry.addAddresses(same_as_jones_home_address)
+
+      assert_equal true,DeepComparator.eql?(@jones_home_address,same_as_jones_home_address)
+      assert_equal true,DeepComparator.eql?(@jones_work_address,same_as_jones_work_address)
+      assert_equal true,DeepComparator.eql?(@jones_book_entry,similar_to_jones_book_entry)      
+  end  
+
+  def test_comparison_with_null_reference_shallow_comparator
+    assert_equal true, ShallowComparator.eql?(@ferrari_enzo,@auto_without_engine)
+  end
+
+  def test_comparison_with_null_reference_deep_comparator
+    assert_equal false, DeepComparator.eql?(@ferrari_enzo,@auto_without_engine)
+  end  
+
+  def test_comparison_only_child_equal_deep_comparator
+    assert_equal true,  DeepComparator.eql?(@ferrari_enzo,@ferrari_superenzo)
+    assert_equal false, DeepComparator.eql?(@ferrari_enzo,@ferrari_superextraenzo)
+  end
+
+end

data/test/test_navigation_extensions.rb

@@ -0,0 +1,144 @@
+require 'helper'
+
+class NavigationExtensionsTest < Test::Unit::TestCase
+  
+  module TestMetamodel
+
+    class Address < RGen::MetamodelBuilder::MMBase
+      include RGen::Ext::NavigationExtensions
+      has_attr 'type', String
+      has_attr 'street', String
+      has_attr 'number', String
+    end
+
+    class AddressBookEntry < RGen::MetamodelBuilder::MMBase
+      include RGen::Ext::NavigationExtensions
+      has_attr 'name', String
+      contains_many_uni 'addresses', Address
+    end
+
+    class AddressBook < RGen::MetamodelBuilder::MMBase
+      include RGen::Ext::NavigationExtensions
+      contains_many_uni 'entries', AddressBookEntry
+    end
+
+    class Engine < RGen::MetamodelBuilder::MMBase
+      has_attr 'code',String
+      has_attr 'horse_power',Integer
+    end    
+
+    class Car < RGen::MetamodelBuilder::MMBase
+      include RGen::Ext::NavigationExtensions
+      contains_one_uni 'engine', Engine
+    end
+
+  end
+   
+  def setup
+    @jones_work_address = TestMetamodel::Address.new
+    @jones_work_address.type = 'work'
+
+    @jones_home_address = TestMetamodel::Address.new
+    @jones_home_address.type = 'home'    
+
+    @jones_book_entry = TestMetamodel::AddressBookEntry.new
+    @jones_book_entry.name = 'Mr. Jones'
+    @jones_book_entry.addAddresses(@jones_work_address)
+    @jones_book_entry.addAddresses(@jones_home_address)
+
+    @smith_shop_address = TestMetamodel::Address.new
+    @smith_shop_address.type = 'shop'
+
+    @smith_home_address = TestMetamodel::Address.new
+    @smith_home_address.type = 'home'      
+
+    @smith_book_entry = TestMetamodel::AddressBookEntry.new
+    @smith_book_entry.name = 'Mr. Smith'
+    @smith_book_entry.addAddresses(@smith_shop_address)
+    @smith_book_entry.addAddresses(@smith_home_address)
+
+    @green_book_entry = TestMetamodel::AddressBookEntry.new
+    @green_book_entry.name = 'Mr. Green'
+
+    @address_book_1 = TestMetamodel::AddressBook.new
+    @address_book_1.addEntries(@jones_book_entry)
+    @address_book_1.addEntries(@smith_book_entry)
+    @address_book_1.addEntries(@green_book_entry)
+
+    @ferrari_v8   = TestMetamodel::Engine.new({:horse_power => 800, :code => 'Ferrari-V8'})
+    @ferrari_enzo = TestMetamodel::Car.new
+    @ferrari_enzo.engine = @ferrari_v8
+  end
+
+  def test_root_is_self_object_for_dangling_object
+    a = TestMetamodel::Address.new
+    assert a==a.root
+  end
+
+  def test_root_is_direct_container
+    a1 = TestMetamodel::Address.new
+    a1.type = 'work'
+    a2 = TestMetamodel::Address.new
+    a2.type = 'home'    
+    abe = TestMetamodel::AddressBookEntry.new
+    abe.addAddresses(a1)
+    abe.addAddresses(a2)
+    assert abe==a1.root
+    assert abe==a2.root
+    assert abe==abe.root
+  end
+
+  def test_root_is_top_container
+    a1 = TestMetamodel::Address.new
+    a1.type = 'work'
+    a2 = TestMetamodel::Address.new
+    a2.type = 'home'    
+    abe = TestMetamodel::AddressBookEntry.new
+    abe.name = 'Mr. Jones'
+    abe.addAddresses(a1)
+    abe.addAddresses(a2)
+    ab = TestMetamodel::AddressBook.new
+    ab.addEntries(abe)
+    assert ab==a1.root
+    assert ab==a2.root
+    assert ab==abe.root
+  end  
+
+  def test_all_children_empty
+    # this node has not containment relations
+    assert_equal [],@jones_work_address.all_children
+    # this node has containment relations
+    assert_equal [],@green_book_entry.all_children
+  end
+
+  def test_all_children_not_empty
+    assert_equal(
+      [@jones_book_entry,@smith_book_entry,@green_book_entry], 
+      @address_book_1.all_children)
+  end 
+
+  def test_all_children_single_containement
+    assert_equal([@ferrari_v8], @ferrari_enzo.all_children)
+  end 
+
+  def test_all_children_deep_not_empty
+    assert_equal 7,@address_book_1.all_children_deep.count
+    # direct children
+    assert @address_book_1.all_children_deep.include?(
+      @jones_book_entry)
+    assert @address_book_1.all_children_deep.include?(
+      @smith_book_entry)
+    assert @address_book_1.all_children_deep.include?(
+      @green_book_entry)
+    # non-direct children
+    assert @address_book_1.all_children_deep.include?(
+      @jones_work_address)
+    assert @address_book_1.all_children_deep.include?(
+      @jones_home_address)    
+    assert @address_book_1.all_children_deep.include?(
+      @smith_shop_address)
+    assert @address_book_1.all_children_deep.include?(
+      @smith_home_address)        
+  end    
+
+end

data/test/test_traverse.rb

@@ -0,0 +1,65 @@
+require 'helper'
+
+class TraverseTest < Test::Unit::TestCase
+  
+	class C < RGen::MetamodelBuilder::MMBase
+      	include RGen::Ext::NavigationExtensions
+		has_attr 'id',Integer
+	end
+
+	class D < RGen::MetamodelBuilder::MMBase
+      	include RGen::Ext::NavigationExtensions
+		has_attr 'id',Integer
+		contains_one_uni  'c', C
+	end
+
+	class B < RGen::MetamodelBuilder::MMBase
+      	include RGen::Ext::NavigationExtensions
+		has_attr 'id',Integer
+		contains_many_uni 'ds', D
+	end
+
+	class A < RGen::MetamodelBuilder::MMBase
+      	include RGen::Ext::NavigationExtensions
+		has_attr 'id',Integer
+		contains_many_uni 'bs', B
+		contains_one_uni  'c', C
+	end
+
+	def setup
+		@d_1  = D.new({:id => 1  })
+		@d_2  = D.new({:id => 2  })
+		@d_3  = D.new({:id => 3  })
+		@c_4  = C.new({:id => 4  })
+		@c_5  = C.new({:id => 5  })
+		@c_6  = C.new({:id => 6  })
+		@b_7  = B.new({:id => 7  })
+		@b_8  = B.new({:id => 8  })
+		@b_9  = B.new({:id => 9  })
+		@a_10 = A.new({:id => 10 })
+
+		@d_1.c = @c_5
+
+		@b_8.addDs @d_2
+		@b_8.addDs @d_3
+		@b_9.addDs @d_1	
+
+		@a_10.addBs @b_9
+		@a_10.addBs @b_8
+		@a_10.c = @c_6
+	end
+
+	def assert_ids(expected,actual)
+		assert_equal expected.count,actual.count
+		expected.each do |e|
+			assert actual.find {|a| a.id==e}, "Element with id #{e} not found"
+		end
+	end  
+
+	def test_traverse
+		l = []
+		@a_10.traverse {|n| l<<n if n }
+		assert_ids [10,6,8,9,2,3,1,5], l
+	end
+
+end

metadata

@@ -0,0 +1,135 @@
+--- !ruby/object:Gem::Specification
+name: rgen_ext
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease:
+platform: ruby
+authors:
+- Federico Tomassetti
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2013-11-06 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rgen
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+    none: false
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+    none: false
+  prerelease: false
+  type: :runtime
+- !ruby/object:Gem::Dependency
+  name: bundler
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+    none: false
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+    none: false
+  prerelease: false
+  type: :development
+- !ruby/object:Gem::Dependency
+  name: rake
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+    none: false
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+    none: false
+  prerelease: false
+  type: :development
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+    none: false
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+    none: false
+  prerelease: false
+  type: :development
+description: Extensions of general use to RGen
+email:
+- f.tomassetti@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/rgen/ext.rb
+- lib/rgen/ext/comparison.rb
+- lib/rgen/ext/navigation_extensions.rb
+- lib/rgen/ext/version.rb
+- rgen_ext.gemspec
+- test/helper.rb
+- test/test_comparison.rb
+- test/test_navigation_extensions.rb
+- test/test_traverse.rb
+homepage: http://github.com/ftomassetti/rgen_ext
+licenses:
+- Apache License v2
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      segments:
+      - 0
+      version: '0'
+      hash: 2
+  none: false
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      segments:
+      - 0
+      version: '0'
+      hash: 2
+  none: false
+requirements: []
+rubyforge_project:
+rubygems_version: 1.8.24
+signing_key:
+specification_version: 3
+summary: Extensions of general use to RGen
+test_files:
+- test/helper.rb
+- test/test_comparison.rb
+- test/test_navigation_extensions.rb
+- test/test_traverse.rb