RUIC 0.0.1 → 0.1.0

data/lib/ruic/attributes.rb

@@ -0,0 +1,164 @@
+#encoding: utf-8
+class UIC::Property
+	class << self; attr_accessor :default; end
+	def initialize(el); @el = el; end
+	def name; @name||=@el['name']; end
+	def type; @type||=@el['type']; end
+	def formal; @formal||=@el['formalName'] || @el['name']; end
+	def min; @el['min']; end
+	def max; @el['max']; end
+	def description; @desc||=@el['description']; end
+	def default; @def ||= (@el['default'] || self.class.default); end
+	def get(asset,slide)
+		if asset.slide? || asset.has_slide?(slide)
+			asset.presentation.get_attribute(asset.el,name,slide) || default
+		end
+	end
+	def set(asset,new_value,slide_name_or_index)
+		asset.presentation.set_attribute(asset.el,name,slide_name_or_index,new_value)
+	end
+	def inspect
+		"<#{type} '#{name}'>"
+	end
+
+	class String < self
+		self.default = ''
+	end
+	MultiLineString = String
+
+	class Float < self
+		self.default = 0.0
+		def get(asset,slide); super.to_f; end
+	end
+	class Long < self
+		self.default = 0
+		def get(asset,slide); super.to_i; end
+	end
+	class Boolean < self
+		self.default = false
+		def get(asset,slide); super=='True'; end
+		def set(asset,new_value,slide_name_or_index)
+			super( asset, new_value ? 'True' : 'False', slide_name_or_index )
+		end
+	end
+	class Vector < self
+		self.default = '0 0 0'
+		def get(asset,slide)
+			VectorValue.new(asset,self,slide,super)
+		end
+		def set(asset,new_value,slide_name_or_index)
+			new_value = new_value.join(' ') if new_value.is_a?(Array)
+			super( asset, new_value, slide_name_or_index )
+		end
+	end
+	Rotation = Vector
+	Color    = Vector
+	class Image < self
+		self.default = nil
+		def get(asset,slide)
+			if idref = super
+				result = asset.presentation.asset_by_id( idref[1..-1] )
+				slide ? result.on_slide( slide ) : result
+			end
+		end
+		def set(asset,new_value,slide)
+			raise "Setting image attributes not yet supported"
+		end
+	end
+	class Texture < String
+		def get(asset,slide)
+			if path=super
+				path.empty? ? nil : path
+			end
+		end
+	end
+
+	class ObjectRef < self
+		self.default = nil
+		def get(asset,slide)
+			ref  = super
+			type = :absolute
+			obj  = nil
+			unless ref=='' || ref.nil?
+				type = ref[0]=='#' ? :absolute : :path
+				ref = type==:absolute ? asset.presentation.asset_by_id( ref[1..-1] ) : asset.presentation.at( ref, asset.el )
+			end
+			ObjectReference.new(asset,self,slide,ref,type)
+		end
+		def set(asset,new_object,slide)
+			get(asset,slide).object = new_object
+		end
+	end
+
+	class ObjectReference
+		attr_reader :object, :type
+		def initialize(asset,property,slide,object=nil,type=nil)
+			@asset    = asset
+			@name     = property.name
+			@slide    = slide
+			@object   = object
+			@type     = type
+		end
+		def object=(new_object)
+			raise "ObjectRef must be set to an asset (not a #{new_object.class.name})" unless new_object.is_a?(UIC::Asset::Root)
+			@object = new_object
+			write_value!
+		end
+		def type=(new_type)
+			raise "ObjectRef types must be either :absolute or :path (not #{new_type.inspect})" unless [:absolute,:path].include?(new_type)
+			@type = new_type
+			write_value!
+		end
+		private
+		def write_value!
+			path = case @object
+				when NilClass then ""
+				else case @type
+					when :absolute then "##{@object.el['id']}"
+					when :path     then @asset.presentation.path_to( @object.el, @asset.el ).sub(/^[^:.]+:/,'')
+					# when :root     then @asset.presentation.path_to( @object.el ).sub(/^[^:.]+:/,'')
+				end
+			end
+			@asset.presentation.set_attribute( @asset.el, @name, @slide, path )
+		end
+	end
+
+	Import     = String #TODO: a real class
+	Mesh       = String #TODO: a real class
+	Renderable = String #TODO: a real class
+	Font       = String #TODO: a real class
+	FontSize   = Long
+
+	StringListOrInt = String #TODO: a real class
+
+	class VectorValue
+		attr_reader :x, :y, :z
+		def initialize(asset,property,slide,str)
+			@asset    = asset
+			@property = property
+			@slide    = slide
+			@x, @y, @z = str.split(/\s+/).map(&:to_f)
+		end
+		def setall
+			@property.set( @asset, to_s, @slide )
+		end
+		def x=(n); @x=n; setall end
+		def y=(n); @y=n; setall end
+		def z=(n); @z=n; setall end
+		alias_method :r, :x
+		alias_method :g, :y
+		alias_method :b, :z
+		alias_method :r=, :x=
+		alias_method :g=, :y=
+		alias_method :b=, :z=
+		def inspect
+			"<#{@asset.path}.#{@property.name}: #{self}>"
+		end
+		def to_s
+			to_a.join(' ')
+		end
+		def to_a
+			[x,y,z]
+		end
+	end
+end

data/lib/ruic/interfaces.rb

@@ -18,15 +18,15 @@ end
 
 module UIC::ElementBacked
 	attr_accessor :owner, :el
-  def self.included(base)
-    base.extend(ClassMethods)
-  end
-  module ClassMethods
+	def self.included(base)
+		base.extend(ClassMethods)
+	end
+	module ClassMethods
 		def xmlattribute(name,&block)
 			define_method(name){ @el[name] }
 			define_method("#{name}=", &(block || ->(new_value){ @el[name]=new_value.to_s }))
 		end
-  end	
+	end	
 end
 
 module UIC::PresentableHash

data/lib/ruic/presentation.rb

@@ -301,19 +301,25 @@ class UIC::Presentation
 				next if options.key?(:master) && master?(el)!= options[:master]
 				asset = asset_for_el(el)
 				next if options.key?(:attributes) && options[:attributes].any?{ |att,val|
-					value = asset[att.to_s].value
-					case val
-						when Regexp  then val !~ value.to_s
-						when Numeric then (val-value).abs >= 0.001
-						when Array   then value.to_a.zip(val).map{ |a,b| b && (a-b).abs>=0.001 }.any?
-						else value != val
-					end if asset.properties[att.to_s]
+					if asset.properties[att.to_s]
+						value = asset[att.to_s].value
+						case val
+							when Regexp  then val !~ value.to_s
+							when Numeric then (val-value).abs >= 0.001
+							when Array   then value.to_a.zip(val).map{ |a,b| b && (a-b).abs>=0.001 }.any?
+							else value != val
+						end
+					end
 				}
 				yield asset, index+=1 if block_given?
 				result << asset
 			end
 		end
 	end
+
+	def inspect
+		"<#{self.class} #{File.basename(file)}>"
+	end
 end
 
 def UIC.Presentation( uip_path )
@@ -341,10 +347,6 @@ class UIC::Application::Presentation < UIC::Presentation
 	def path_to( el, from=nil )
 		"#{id}:#{super}"
 	end
-
-	def inspect
-		"<presentation #{file}>"
-	end
 end
 
 class Nokogiri::XML::Element

data/lib/ruic/version.rb

@@ -1,3 +1,3 @@
-class RUIC
-	VERSION = '0.0.1'
+class RUIC
+	VERSION = '0.1.0'
 end

data/ruic.gemspec

@@ -1,23 +1,25 @@
-# encoding: UTF-8
-$: << File.expand_path("../lib", __FILE__)
-require "ruic/version"
-
-Gem::Specification.new do |s|
-  s.name        = "RUIC"
-  s.version     = RUIC::VERSION
-  s.platform    = Gem::Platform::RUBY
-  s.authors     = ["Gavin Kistner"]
-  s.email       = ["gavin@phrogz.net"]
-  s.license     = "MIT License"
-  s.summary     = %q{Library and DSL analyzing and manipulating UI Composer applications and presentations.}
-  s.description = %q{RUIC is a library that understands the XML formats used by NVIDIA's "UI Composer" tool suite. In addition to APIs for analyzing and manipulating these files—the UIC portion of the library—it also includes a mini DSL for writing scripts that can be run by the `ruic` interpreter.}
-  s.homepage    = "https://github.com/Phrogz/RUIC"
-
-  s.add_runtime_dependency "nokogiri", '~> 1'
-
-  s.files         = `git ls-files`.split("\n")
-  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
-  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
-  s.require_paths = ["lib"]
-  s.bindir        = 'bin'
+# encoding: UTF-8
+$: << File.expand_path("../lib", __FILE__)
+require "ruic/version"
+
+Gem::Specification.new do |s|
+  s.name        = "RUIC"
+  s.version     = RUIC::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["Gavin Kistner"]
+  s.email       = ["gavin@phrogz.net"]
+  s.license     = "MIT License"
+  s.summary     = %q{Library and DSL analyzing and manipulating UI Composer applications and presentations.}
+  s.description = %q{RUIC is a library that understands the XML formats used by NVIDIA's "UI Composer" tool suite. In addition to APIs for analyzing and manipulating these files—the UIC portion of the library—it also includes a mini DSL for writing scripts that can be run by the `ruic` interpreter.}
+  s.homepage    = "https://github.com/Phrogz/RUIC"
+
+  s.add_runtime_dependency "nokogiri", '~> 1'
+  s.add_runtime_dependency "ripl", '~> 0'
+  s.add_runtime_dependency "ripl-multi_line", '~> 0'
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+  s.bindir        = 'bin'
 end

data/test/filtering.ruic

@@ -1,39 +1,39 @@
-metadata 'MetaData.xml'
-
-uia 'projects/SimpleScene/SimpleScene.uia'
-show app.errors if app.errors?
-
-main = app.main_presentation
-
-assert main.find( type:'Model' ).length==4
-assert main.find( type:'Model', slide:0 ).length==3
-assert main.find( type:'Model', slide:1 ).length==4
-assert main.find( type:'Model', slide:1, master:false ).length==1
-assert main.find( type:'Model', attributes:{position:[-150,60,0]} ).length==2
-assert main.find( type:'Model', attributes:{position:[-150,60,0]} ).length==2
-assert main.find( type:'Model', attributes:{position:[nil,60,nil]} ).length==4
-assert main.find( type:'Model', attributes:{sourcepath:'#Cube'} ).length==1
-assert main.find( under:main/"Scene.Layer.Sphere1" ).length==1
-assert main.find( attributes:{name:'Material'} ).length==4
-assert main.find( attributes:{name:/^Sphere/} ).length==2
-
-# You can use name not as an attribute
-assert main.find( name:'Material' ).length==4
-assert main.find( name:/^Sphere/ ).length==2
-
-# Return values are in Scene graph order
-assert main.find.first == main/"Scene"
-assert main.find.last  == main/"Scene.Layer.NonMaster.Material"
-
-# Any asset can be used as the 'root'
-sphere = main/"Scene.Layer.Sphere1"
-assert sphere.find.length==1
-
-# Supplying a block will iterate, including the index
-expected = main.find type:'Model'
-found = 0
-main.find type:'Model' do |mod,i|
-	found += 1
-	assert mod == expected[i]
-end
+metadata 'MetaData.xml'
+
+uia 'projects/SimpleScene/SimpleScene.uia'
+show app.errors if app.errors?
+
+main = app.main_presentation
+
+assert main.find( type:'Model' ).length==4
+assert main.find( type:'Model', slide:0 ).length==3
+assert main.find( type:'Model', slide:1 ).length==4
+assert main.find( type:'Model', slide:1, master:false ).length==1
+assert main.find( type:'Model', attributes:{position:[-150,60,0]} ).length==2
+assert main.find( type:'Model', attributes:{position:[-150,60,0]} ).length==2
+assert main.find( type:'Model', attributes:{position:[nil,60,nil]} ).length==4
+assert main.find( type:'Model', attributes:{sourcepath:'#Cube'} ).length==1
+assert main.find( under:main/"Scene.Layer.Sphere1" ).length==1
+assert main.find( attributes:{name:'Material'} ).length==4
+assert main.find( attributes:{name:/^Sphere/} ).length==2
+
+# You can use name not as an attribute
+assert main.find( name:'Material' ).length==4
+assert main.find( name:/^Sphere/ ).length==2
+
+# Return values are in Scene graph order
+assert main.find.first == main/"Scene"
+assert main.find.last  == main/"Scene.Layer.NonMaster.Material"
+
+# Any asset can be used as the 'root'
+sphere = main/"Scene.Layer.Sphere1"
+assert sphere.find.length==1
+
+# Supplying a block will iterate, including the index
+expected = main.find type:'Model'
+found = 0
+main.find type:'Model' do |mod,i|
+	found += 1
+	assert mod == expected[i]
+end
 assert found==4

data/test/referencematerials.ruic

@@ -1,53 +1,52 @@
-require 'fileutils'
-FileUtils.copy_entry('projects/ReferencedMaterials','projects/_RefMat',false,false,true)
-
-metadata 'MetaData.xml'
-
-uia 'projects/_RefMat/ReferencedMaterials.uia'
-show app.errors if app.errors?
-
-layer   = app/'main:Scene.Layer'
-cubemat = layer/"Cube"/"Material"
-
-# Ensure that the diffuse attribute is linked and present on multiple slides
-assert cubemat['diffuse'].linked?
-assert cubemat.has_slide?(0)
-assert cubemat.has_slide?(1)
-assert cubemat.has_slide?(2)
-assert cubemat['diffuse',1].r == 0.5
-assert cubemat['diffuse',2].r == 0.5
-
-# When we do not unlink, values remain shared
-cubemat['diffuse',1].r = 1
-cubemat['diffuse',2].r = 0.2
-assert cubemat['diffuse',1].r == cubemat['diffuse',2].r
-
-# Ensure that we can unlink an attribute and vary the values per slide
-cubemat['diffuse'].unlink
-assert !cubemat['diffuse'].linked?
-cubemat['diffuse',1].r = 1
-cubemat['diffuse',2].r = 0.2
-assert cubemat['diffuse',1].r == 1
-assert cubemat['diffuse',2].r == 0.2
-
-# We can swap a material with a referenced material
-model = cubemat.parent
-assert model
-ref = cubemat.replace_with_referenced_material
-assert cubemat.parent.nil?                  # The old material is removed from the graph
-assert ref.parent==model                    # The new material is where the old was
-assert ref['id'] == cubemat['id']           # The new material has the same id and name
-assert ref.name == 'Material'
-assert ref['referencedmaterial',0].object.nil?       # New referenced materials start out with no reference
-assert ref['referencedmaterial',0].type == :absolute # New references default to absolute
-
-ref['referencedmaterial'].unlink
-%w[Sphere Sphere2].each.with_index do |name,s|
-	# You can set a reference directly to an object, or alternatively
-	# ref['referencedmaterial',1].object = layer/name/"Material"
-	ref['referencedmaterial',s+1] = layer/name/"Material"
-	ref['referencedmaterial',s+1].type = :path
-end
-
-
-app.save_all!
+require 'fileutils'
+FileUtils.copy_entry('projects/ReferencedMaterials','projects/_RefMat',false,false,true)
+
+metadata 'MetaData.xml'
+
+uia 'projects/_RefMat/ReferencedMaterials.uia'
+show app.errors if app.errors?
+
+layer   = app/'main:Scene.Layer'
+cubemat = layer/"Cube"/"Material"
+
+# Ensure that the diffuse attribute is linked and present on multiple slides
+assert cubemat['diffuse'].linked?
+assert cubemat.has_slide?(0)
+assert cubemat.has_slide?(1)
+assert cubemat.has_slide?(2)
+assert cubemat['diffuse',1].r == 0.5
+assert cubemat['diffuse',2].r == 0.5
+
+# When we do not unlink, values remain shared
+cubemat['diffuse',1].r = 1
+cubemat['diffuse',2].r = 0.2
+assert cubemat['diffuse',1].r == cubemat['diffuse',2].r
+
+# Ensure that we can unlink an attribute and vary the values per slide
+cubemat['diffuse'].unlink
+assert !cubemat['diffuse'].linked?
+cubemat['diffuse',1].r = 1
+cubemat['diffuse',2].r = 0.2
+assert cubemat['diffuse',1].r == 1
+assert cubemat['diffuse',2].r == 0.2
+
+# We can swap a material with a referenced material
+model = cubemat.parent
+assert model
+ref = cubemat.replace_with_referenced_material
+assert cubemat.parent.nil?                  # The old material is removed from the graph
+assert ref.parent==model                    # The new material is where the old was
+assert ref['id'] == cubemat['id']           # The new material has the same id and name
+assert ref.name == 'Material'
+assert ref['referencedmaterial',0].object.nil?       # New referenced materials start out with no reference
+assert ref['referencedmaterial',0].type == :absolute # New references default to absolute
+
+ref['referencedmaterial'].unlink
+%w[Sphere Sphere2].each.with_index do |name,s|
+	# You can set a reference directly to an object, or alternatively
+	# ref['referencedmaterial',1].object = layer/name/"Material"
+	ref['referencedmaterial',s+1] = layer/name/"Material"
+	ref['referencedmaterial',s+1].type = :path
+end
+
+app.save_all!