metaruby 1.0.0 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 209d7c5d2bfb1aef6d4370e9b87d5635f4cbe093
-  data.tar.gz: ebbba741e3cb1511ebf7f05a6e4e4d242b23ffda
+  metadata.gz: d4a39a36eff3dfcc3885b69729b7fc1f20d08803
+  data.tar.gz: 2d6a47cba4d1e6658aabd7a54f682d62e9cfc7c0
 SHA512:
-  metadata.gz: 6fffccb4135deee4fa523fc09b79a9ab66eb8783ec7de35bc88a29876842909210795adca46afc8514b4ae28de51ed9c4045a0e8f54da06cf8948424629edc2c
-  data.tar.gz: 2b832a3185e0b0a4c657979a1b0a86f362541d4cb09364355b40c50d7bbcd86de4fe5356131f36af6d669ea8dd08f7d7faadb5710d303abff23d1ff488d0779c
+  metadata.gz: 0ef497f6483f83756ede50becd59106c9bd5c87700172fb1de2090bfe9e0ee56317c50a0e4c6e7d9ee71a8a74e3d497a23bcb76bd8c15572c5ab1a1f27947e66
+  data.tar.gz: 32ed5a1675c2598bdba4690ab9214bfe39b5c4125e04b0a825f2513cedaceb5a4297bab53a1393e5a0fe910143ea53efebc5cc11e9792830e66525f58be2dff5

data/.travis.yml

@@ -1,11 +1,14 @@
 sudo: false
 language: ruby
 rvm:
-  - 2.0.0
   - 2.1.6
   - 2.2.2
-  - 2.3.0
-  - jruby-9.0.4.0
+  - 2.3.3
+  - 2.4.1
+  - jruby-9.1.13.0
 script:
     - bundle exec rake
     - bundle exec rake test
+allow_failures:
+    - rvm: jruby-9.1.13.0
+bundler_args: --without gui

data/Gemfile

@@ -1,3 +1,9 @@
 source 'https://rubygems.org'
 
+platform :mri do
+    group 'gui' do
+        gem 'qtbindings'
+    end
+end
+
 gemspec

data/Rakefile

@@ -3,11 +3,21 @@ require "rake/testtask"
 
 task :default
 
+has_gui = begin
+              require 'Qt'
+              true
+          rescue LoadError
+              false
+          end
+
 Rake::TestTask.new(:test) do |t|
     t.libs << "lib"
     t.libs << "."
-    t.ruby_opts << '-w'
-    t.test_files = FileList['test/suite.rb']
+
+    file_list = FileList['test/**/test_*.rb']
+    if !has_gui
+        file_list.exclude('test/gui/**/test_*.rb')
+    end
 end
 
 task :gem => :build

data/lib/metaruby.rb

@@ -1,6 +1,8 @@
 require 'utilrb/object/attribute'
 require 'weakref'
 
+require 'metaruby/backward/singleton_class_p'
+
 require 'metaruby/attributes'
 require 'metaruby/registration'
 require 'metaruby/model_as_module'

data/lib/metaruby/attributes.rb

@@ -23,8 +23,6 @@ module MetaRuby
     # @example promotion to update back references
     #   class Port; attr_accessor :component_model end
     #   class Component
-    #       inherited_attribute(:ports, :port, map: true) { Hash.new }
-    #
     #       # Update #component_model to make it point to the receiver instead
     #       # of the original model. Note that metaruby does not memoize the
     #       # result, so it has to be done in the promote method if it is
@@ -34,6 +32,8 @@ module MetaRuby
     #           port.component_model = self
     #           port
     #       end
+    #
+    #       inherited_attribute(:ports, :port, map: true) { Hash.new }
     #   end
     module Attributes
         def included(mod)
@@ -72,6 +72,21 @@ module MetaRuby
             nil
         end
 
+        ANCESTORS_ACCESS =
+            if RUBY_VERSION < "2.1.0"
+                <<-EOCODE
+                ancestors = self.ancestors
+                if ancestors.first != self
+                    ancestors.unshift self
+                end
+                EOCODE
+            else
+                <<-EOCODE
+                ancestors = self.ancestors
+                EOCODE
+            end
+                
+
         # @api private
         #
         # Helper method for {#inherited_single_value_attribute} in case there
@@ -79,10 +94,7 @@ module MetaRuby
         def define_single_value_without_promotion(method_name, ivar)
             class_eval <<-EOF, __FILE__, __LINE__+1
             def #{method_name}
-                ancestors = self.ancestors
-                if ancestors.first != self
-                    ancestors.unshift self
-                end
+                #{ANCESTORS_ACCESS}
 
                 has_value = false
                 for klass in ancestors
@@ -118,10 +130,7 @@ module MetaRuby
         def define_single_value_with_promotion(method_name, promotion_method_name, ivar)
             class_eval <<-EOF, __FILE__, __LINE__+1
             def #{method_name}
-                ancestors = self.ancestors
-                if ancestors.first != self
-                    ancestors.unshift self
-                end
+                #{ANCESTORS_ACCESS}
 
                 promotions = []
                 for klass in ancestors
@@ -130,7 +139,7 @@ module MetaRuby
                         value = klass.instance_variable_get(:#{ivar})
                         break
                     end
-                    promotions.unshift(klass) if klass.respond_to?("#{promotion_method_name}")
+                    promotions.unshift(klass) if klass.respond_to?(:#{promotion_method_name})
                 end
                 if !has_value && respond_to?(:#{method_name}_default)
                     # Look for default
@@ -281,13 +290,10 @@ module MetaRuby
                     nil
                 end
                 def has_#{name}?(key)
-                    ancestors = self.ancestors
-                    if ancestors.first != self
-                        ancestors.unshift self
-                    end
+                    #{ANCESTORS_ACCESS}
                     for klass in ancestors
-                        if klass.instance_variable_defined?(:@#{attribute_name})
-                            return true if klass.#{attribute_name}.has_key?(key)
+                        if attr = klass.instance_variable_get(:@#{attribute_name})
+                            return true if attr.has_key?(key)
                         end
                     end
                     false
@@ -305,8 +311,8 @@ module MetaRuby
             def clear_#{attribute_name}
                 #{attribute_name}.clear
                 for klass in ancestors
-                    if klass.instance_variable_defined?(:@#{attribute_name})
-                        klass.#{attribute_name}.clear
+                    if attr = klass.instance_variable_get(:@#{attribute_name})
+                        attr.clear
                     end
                 end
             end
@@ -338,23 +344,20 @@ module MetaRuby
                     return enum_for(:each_#{name}, key, uniq)
                 end
 
-                ancestors = self.ancestors
-                if ancestors.first != self
-                    ancestors.unshift self
-                end
+                #{ANCESTORS_ACCESS}
                 if key
                     for klass in ancestors
-                        if klass.instance_variable_defined?(:@#{attribute_name})
-                            if klass.#{attribute_name}.has_key?(key)
-                                yield(klass.#{attribute_name}[key])
+                        if attr = klass.instance_variable_get(:@#{attribute_name})
+                            if attr.has_key?(key)
+                                yield(attr[key])
                                 return self if uniq
                             end
                         end
                     end
                 elsif !uniq
                     for klass in ancestors
-                        if klass.instance_variable_defined?(:@#{attribute_name})
-                            klass.#{attribute_name}.#{enum_with} do |el|
+                        if attr = klass.instance_variable_get(:@#{attribute_name})
+                            attr.#{enum_with} do |el|
                                 yield(el)
                             end
                         end
@@ -362,8 +365,8 @@ module MetaRuby
                 else
                     seen = Set.new
                     for klass in ancestors
-                        if klass.instance_variable_defined?(:@#{attribute_name})
-                            klass.#{attribute_name}.#{enum_with} do |el_key, el| 
+                        if attr = klass.instance_variable_get(:@#{attribute_name})
+                            attr.#{enum_with} do |el_key, el| 
                                 if !seen.include?(el_key)
                                     seen << el_key
                                     #{if yield_key then 'yield(el_key, el)' else 'yield(el)' end}
@@ -386,17 +389,12 @@ module MetaRuby
         def self.nomap_without_promotion(name, attribute_name, enum_with: :each)
             code, file, line =<<-EOF, __FILE__, __LINE__+1
             def each_#{name}
-                if !block_given?
-                    return enum_for(:each_#{name})
-                end
+                return enum_for(__method__) if !block_given?
 
-                ancestors = self.ancestors
-                if ancestors.first != self
-                    ancestors.unshift self
-                end
+                #{ANCESTORS_ACCESS}
                 for klass in ancestors
-                    if klass.instance_variable_defined?(:@#{attribute_name})
-                        klass.#{attribute_name}.#{enum_with} { |el| yield(el) }
+                    if attr = klass.instance_variable_get(:@#{attribute_name})
+                        attr.#{enum_with} { |el| yield(el) }
                     end
                 end
                 self
@@ -416,16 +414,13 @@ module MetaRuby
                     return enum_for(:each_#{name}, key, uniq)
                 end
 
-                ancestors = self.ancestors
-                if ancestors.first != self
-                    ancestors.unshift self
-                end
+                #{ANCESTORS_ACCESS}
                 if key
                     promotions = []
                     for klass in ancestors
-                        if klass.instance_variable_defined?(:@#{attribute_name})
-                            if klass.#{attribute_name}.has_key?(key)
-                                value = klass.#{attribute_name}[key]
+                        if attr = klass.instance_variable_get(:@#{attribute_name})
+                            if attr.has_key?(key)
+                                value = attr[key]
                                 for p in promotions
                                     value = p.promote_#{name}(key, value)
                                 end
@@ -433,27 +428,27 @@ module MetaRuby
                                 return self if uniq
                             end
                         end
-                        promotions.unshift(klass) if klass.respond_to?("promote_#{name}")
+                        promotions.unshift(klass) if klass.respond_to?(:promote_#{name})
                     end
                 elsif !uniq
                     promotions = []
                     for klass in ancestors
-                        if klass.instance_variable_defined?(:@#{attribute_name})
-                            klass.#{attribute_name}.#{enum_with} do |k, v|
+                        if attr = klass.instance_variable_get(:@#{attribute_name})
+                            attr.#{enum_with} do |k, v|
                                 for p in promotions
                                     v = p.promote_#{name}(k, v)
                                 end
                                 #{if yield_key then 'yield(k, v)' else 'yield(v)' end}
                             end
                         end
-                        promotions.unshift(klass) if klass.respond_to?("promote_#{name}")
+                        promotions.unshift(klass) if klass.respond_to?(:promote_#{name})
                     end
                 else
                     seen = Set.new
                     promotions = []
                     for klass in ancestors
-                        if klass.instance_variable_defined?(:@#{attribute_name})
-                            klass.#{attribute_name}.#{enum_with} do |k, v|
+                        if attr = klass.instance_variable_get(:@#{attribute_name})
+                            attr.#{enum_with} do |k, v|
                                 unless seen.include?(k)
                                     for p in promotions
                                         v = p.promote_#{name}(k, v)
@@ -463,7 +458,7 @@ module MetaRuby
                                 end
                             end
                         end
-                        promotions.unshift(klass) if klass.respond_to?("promote_#{name}")
+                        promotions.unshift(klass) if klass.respond_to?(:promote_#{name})
                     end
                 end
                 self
@@ -483,21 +478,18 @@ module MetaRuby
                     return enum_for(:each_#{name})
                 end
 
-                ancestors = self.ancestors
-                if ancestors.first != self
-                    ancestors.unshift self
-                end
+                #{ANCESTORS_ACCESS}
                 promotions = []
                 for klass in ancestors
-                    if klass.instance_variable_defined?(:@#{attribute_name})
-                        klass.#{attribute_name}.#{enum_with} do |value|
+                    if attr = klass.instance_variable_get(:@#{attribute_name})
+                        attr.#{enum_with} do |value|
                             for p in promotions
                                 value = p.promote_#{name}(value)
                             end
                             yield(value)
                         end
                     end
-                    promotions.unshift(klass) if klass.respond_to?("promote_#{name}")
+                    promotions.unshift(klass) if klass.respond_to?(:promote_#{name})
                 end
                 self
             end

data/lib/metaruby/backward/singleton_class_p.rb

@@ -0,0 +1,14 @@
+class Module
+    if !method_defined?(:singleton_class?)
+        # It so happens that this method to determine whether a class is a
+        # singleton class is valid for ruby 2.0 and breaks on 2.1 ... However
+        # (!) on 2.1 singleton_class? is defined
+        def singleton_class?
+            if instance_variable_defined?(:@__singleton_class)
+                @__singleton_class
+            else
+                @__singleton_class = (ancestors.first != self)
+            end
+        end
+    end
+end

data/lib/metaruby/dsls.rb

@@ -2,7 +2,37 @@ require 'metaruby/dsls/doc'
 require 'metaruby/dsls/find_through_method_missing'
 
 module MetaRuby
-    # Helper functions to build DSLs
+    # DSLs-related tools
+    #
+    # == Find through method missing
+    #
+    # The find through method missing functionality is meant to allow classes to
+    # turn objects that can be found (with a method that finds an object by its
+    # name) into an attribute call as e.g.
+    #
+    #   task.test_event # => task.find_event("test")
+    #
+    # See {DSLs::FindThroughMethodMissing} for a complete description
+    # 
+    # == Documentation parsing
+    #
+    # This provides the logic to find a documentation block above a DSL-like
+    # object creation. For instance, given a class that looks like
+    #
+    #   class Task
+    #     def event(name) # creates an event object with the given name
+    #     end
+    #   end
+    #
+    # Used in a DSL context like so:
+    #
+    #   # The test event allows us
+    #   #
+    #   # To provide an example
+    #   event 'test'
+    #
+    # The parse_documentation method allows to extract the comment block above
+    # the 'event' call. See {DSLs.parse_documentation} for more information
     module DSLs
     end
 end

data/lib/metaruby/dsls/doc.rb

@@ -10,21 +10,34 @@ module MetaRuby
         #   the element whose documentation we are looking for.
         # @return [String,nil] the parsed documentation, or nil if there is no
         #   documentation
+        #
+        # @example find the documentation block of an event creation
+        #   # assuming the following toplevel DSL code in a file called test.orogen
+        #   task "Task" do
+        #     # Just an example event
+        #     event "test"
+        #   end
+        #
+        #   # One would use the following code to extract the documentation
+        #   # above the test event declaration. The call must be made within the
+        #   # event creation code
+        #   MetaRuby::DSLs.parse_documentation_block(/test\.orogen$/, "event")
+        #   
         def self.parse_documentation_block(file_match, trigger_method = /.*/)
             last_method_matched = false
-            call_stack.each do |call|
+            caller_locations(1).each do |call|
                 this_method_matched =
-                    if trigger_method === call[2].to_s
+                    if trigger_method === call.label
                         true
-                    elsif call[2] == :method_missing
+                    elsif call.label == 'method_missing'
                         last_method_matched
                     else
                         false
                     end
 
-                if !this_method_matched && last_method_matched && (file_match === call[0])
-                    if File.file?(call[0])
-                        return parse_documentation_block_at(call[0], call[1])
+                if !this_method_matched && last_method_matched && (file_match === call.absolute_path)
+                    if File.file?(call.absolute_path)
+                        return parse_documentation_block_at(call.absolute_path, call.lineno)
                     else return
                     end
                 end
@@ -47,31 +60,26 @@ module MetaRuby
             # Lines are given 1-based (as all editors work that way), and we
             # want the line before the definition. Remove two
             line = line - 2
+
+            space_count = nil
             while true
-                case l = lines[line]
-                when /^\s*$/
-                    break
-                when /^\s*#/
-                    block << l
+                l = lines[line]
+                comment_match = /^\s*#/.match(l)
+                if comment_match
+                    comment_line  = comment_match.post_match.rstrip
+                    stripped_line = comment_line.lstrip
+                    leading_spaces = comment_line.size - stripped_line.size
+                    if !stripped_line.empty? && (!space_count || space_count > leading_spaces)
+                        space_count = leading_spaces
+                    end
+                    block.unshift(comment_line)
                 else break
                 end
                 line = line - 1
             end
-            block = block.map do |l|
-                l.strip.gsub(/^\s*#/, '')
-            end
-            # Now remove the same amount of spaces in front of each lines
-            space_count = block.map do |l|
-                l =~ /^(\s*)/
-                if $1.size != l.size
-                    $1.size
-                end
-            end.compact.min
-            block = block.map do |l|
-                l[space_count..-1]
-            end
             if !block.empty?
-                block.reverse.join("\n")
+                space_count ||= 0
+                block.map { |l| l[space_count..-1] }.join("\n")
             end
         end
     end