RUIC 0.5.0 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 105e49557e0d92a463d1630cd6fa42d078048e44
-  data.tar.gz: 21db139d873cbcfa3ad7f9c66c85a2ffc151f9ac
+  metadata.gz: 2a99bfd85a630d1804e5c38b33296883a2f43342
+  data.tar.gz: f3233b7830899344bcee0c969fdb130e88143b1d
 SHA512:
-  metadata.gz: 2e4f62d1164c63510bb3cc931870b3b353e28439fecf38076b6ac8ad3dca09a528c5fedb32c6b613115b1d248fda324a11fac912d873da83e57fd16bd1a82586
-  data.tar.gz: 0eeb2a2ab41c848feef5859a7f0810584de7f89beb785c9bb29a1c7f55a72495a7234ecc5514e8e45b765ba13aea650a0e7685f7d9a903fcd08baa45527fa19e
+  metadata.gz: 474bf2cda9e565b3a050fadb9b266980f3b36075f0a953eabf69106695e623575e980fab75c007e78e47f6de6f5e58f0fad217261008392616b47eeca66207d7
+  data.tar.gz: 5a3066ad987ce4597b0ef47d935c8db28bc477ffb281300406184d1119539f84d6130478e3f7ca6dbb3b025d0603567cea0c208fa89867c75d81031832d1a8a0

data/HISTORY

@@ -1,3 +1,26 @@
+## v0.6.0
+
+### Backwards Incompatible Changes
+
+* Changed `FileBacked#resolve_file_path` to `FileBacked#absolute_path`, and added `FileBacked#relative_path`.
+* Removed `.errors?` and `.errors` for application and assets.
+
+### New/Changed Features
+
+* State machines properly report on visual actions.
+  * _Only `<set-attribute>` properly implemented so far._
+* Added much improved `Presentation#referenced_files`, `Application#missing_files`, `Application#unused_files`.
+* Tweaked REPL output.
+  * `nil` results no longer print `#=> nil` in the REPL.
+  * `show` prefixes the result with `#=>`.
+  * Multi-line results are now wrapped, with each line prefixed with `#=>`.
+* Added beginnings of support for effects and renderplugins.
+* Presentations do not cause a runtime error if a custom class (e.g. behavior, effect, custom material) cannot be found.
+
+### Bug Fixes
+* Fix bug that caused some properties to report their type as `nil` or `float` instead of `Float`.
+* Presentations are slightly more capable if they are created without an existing file.
+
 ## v0.5.0 - 2014-Nov-26
 
 * Fix bug that prevented loading an application from the command line in another directory.

data/README.md

@@ -167,7 +167,7 @@ There are two ways to enter interactive mode:
   the application and enter the REPL:
 
       $ ruic myapp.uia
-      (RUIC v0.2.2 interactive session; 'quit' or ctrl-d to end)
+      (RUIC v0.6.0 interactive session; 'quit' or ctrl-d to end)
 
       uia "test/projects/SimpleScene/SimpleScene.uia"
       #=> <UIC::Application 'SimpleScene.uia'>
@@ -176,7 +176,7 @@ There are two ways to enter interactive mode:
   by supplying the `-i` command-line switch:
 
       $ ruic -i test/referencematerials.ruic
-      (RUIC v0.2.2 interactive session; 'quit' or ctrl-d to end)
+      (RUIC v0.6.0 interactive session; 'quit' or ctrl-d to end)
 
       app
       #=> <UIC::Application 'ReferencedMaterials.uia'>

data/lib/ruic.rb

@@ -10,8 +10,11 @@ require_relative 'ruic/assets'
 require_relative 'ruic/interfaces'
 require_relative 'ruic/application'
 require_relative 'ruic/behaviors'
+require_relative 'ruic/effect'
+require_relative 'ruic/renderplugin'
 require_relative 'ruic/statemachine'
 require_relative 'ruic/presentation'
+require_relative 'ruic/ripl'
 
 # The `RUIC` class provides the interface for running scripts using the special DSL,
 # and for running the interactive REPL.
@@ -67,11 +70,11 @@ class RUIC
 				require 'ripl/irb'
 				require 'ripl/multi_line'
 				require 'ripl/multi_line/live_error.rb'
-				require_relative 'ruic/ripl-after-result'
 				Ripl::MultiLine.engine = Ripl::MultiLine::LiveError
 				Ripl::Shell.include Ripl::MultiLine.engine
 				Ripl::Shell.include Ripl::AfterResult
-				Ripl.config.merge! prompt:"", result_prompt:'#=> ', multi_line_prompt:'  ', irb_verbose:false, after_result:"\n"
+				Ripl::Shell.include Ripl::FormatResult
+				Ripl.config.merge! prompt:"", result_prompt:'#=> ', multi_line_prompt:'  ', irb_verbose:false, after_result:"\n", result_line_limit:120, prefix_result_lines:true, skip_nil_results:true
 				ARGV.clear # So that RIPL doesn't try to interpret the options
 				puts "(RUIC v#{RUIC::VERSION} interactive session; 'quit' or ctrl-d to end)"
 				ruic.instance_eval{ puts @apps.map{ |n,app| "(#{n} is #{app.inspect})" } }
@@ -150,7 +153,12 @@ class RUIC
 
 	# Nicer name for `puts` to be used in the DSL, printing the
 	# 'nice' string equivalent for all supplied arguments.
-	def show(*a); puts *a.map(&:to_s); end
+	def show(*a)
+		a=a.first if a.length==1 && a.first.is_a?(Array)
+		opts = { result_prompt:'# ', result_line_limit:120, prefix_result_lines:true, to_s:true }
+		a.each{ |x| puts Ripl::FormatResult.format_result(x,opts) }
+		nil # so that Ripl won't show the result
+	end
 
 	def inspect
 		"<RUIC #{@apps.empty? ? "(no app loaded)" : Hash[ @apps.map{ |id,app| [id,File.basename(app.file)] } ]}>"

data/lib/ruic/application.rb

@@ -1,6 +1,6 @@
 # The `Application` represents the root of your UIC application, corresponding to a `.uia` file.
 class UIC::Application
-	include UIC::FileBacked
+	include UIC::XMLFileBacked
 
 	def inspect
 		"<UIC::Application '#{File.basename(file)}'#{:' FILENOTFOUND' unless file_found?}>"
@@ -14,18 +14,16 @@ class UIC::Application
 	#        If omitted you will need to later set the `.file = ` for the
 	#        instance and then call {#load_from_file}.
 	def initialize(metadata,uia_path=nil)
+		@assets   = {}
 		@metadata = metadata
 		self.file = uia_path
-		@assets = {}
-		load_from_file if file_found?
 	end
 
 	# Loads the application from the file. If you pass the path to your `.uia`
 	# to {#initialize} then this method is called automatically.
 	#
 	# @return [nil]
-	def load_from_file
-		self.doc = Nokogiri.XML(File.read(file,encoding:'utf-8'))
+	def on_doc_loaded
 		@assets  = @doc.search('assets *').map do |el|
 			case el.name
 				when 'behavior'     then UIC::Application::Behavior
@@ -37,18 +35,6 @@ class UIC::Application
 		nil
 	end
 
-	# @return [Boolean] true if there are any errors with the application.
-	def errors?
-		!errors.empty?
-	end
-
-	# @example
-	#   show app.errors if app.errors?
-	# @return [Array<String>] an array (possibly empty) of all errors in this application (including referenced assets).
-	def errors
-		file_found? ? assets.flat_map(&:errors) : ["File not found: '#{file}'"]
-	end
-
 	# Find an asset by `.uia` identifier or path to the asset.
 	# @example
 	#   main1 = app['#main']
@@ -71,17 +57,37 @@ class UIC::Application
 		end
 	end
 
-	# @private do not document until working
+	# Files in the application directory not used by the application.
+	#
+	# @return [Array<String>] absolute paths of files in the directory not used by the application.
 	def unused_files
-		referenced_files - directory_files
+		(directory_files - referenced_files).sort
 	end
 
-	# @private do not document until working
+	# Files referenced by the application but not present in the directory.
+	#
+	# @return [Array<String>] absolute paths of files referenced but gone.
+	def missing_files
+		(referenced_files - directory_files).sort
+	end
+
+
+	# @return [Array<String>] absolute paths of files referenced by the application.
 	def referenced_files
 		# TODO: state machines can reference external scripts
 		# TODO: behaviors can reference external scripts
-		assets.map{ |asset| resolve_file_path(asset.src) }
-		+ presentations.flat_map{ |pres| pres.referenced_files }
+		(
+			[file] +
+			assets.map{ |asset| absolute_path(asset.src) } +
+			statemachines.flat_map(&:referenced_files) +
+			presentations.flat_map(&:referenced_files)
+		).uniq
+	end
+
+	# @return [Array<String>] absolute paths of all files present in the application directory (used or not).
+	def directory_files
+		dir = File.dirname(file)
+		Dir.chdir(dir){ Dir['**/*.*'] }.map{ |f| File.expand_path(f,dir) }
 	end
 
 	# @return [Array] all assets referenced by the application. Ordered by the order they appear in the `.uia`.

data/lib/ruic/attributes.rb

@@ -7,7 +7,7 @@ class UIC::Property
 	attr_accessor :default
 	def initialize(el); @el = el; end
 	def name; @name||=@el['name']; end
-	def type; @type||=@el['type']; end
+	def type; @type||=@el['type'] ? (@el['type']=='float' ? 'Float' : @el['type']) : 'Float'; end
 	def formal; @formal||=@el['formalName'] || @el['name']; end
 	def min; @el['min']; end
 	def max; @el['max']; end
@@ -129,10 +129,18 @@ class UIC::Property
 		end
 	end
 
+	class Font < self
+		self.default = 'Arimo-Regular'
+		def get(asset,slide); "fonts/#{super}.ttf"; end # TODO: how to support non-ttf fonts?
+		def set(asset,new_value,slide_name_or_index)
+			# TODO: how to support non-ttf fonts?
+			super( asset, new_value.sub(%r{^\.[/\\]},'').sub(%r{^fonts[/\\]},'').sub(%r{\.ttf$},''), slide_name_or_index )
+		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

data/lib/ruic/behaviors.rb

@@ -1,22 +1,9 @@
 class UIC::Behavior
 	include UIC::FileBacked
-	attr_reader :lua
 	def initialize( lua_path )
 		self.file = lua_path
-		load_from_file if file_found?
 	end
-	def load_from_file
-		@lua = File.read(file,encoding:'utf-8')
-	end
-
-	def errors?
-		!errors.empty?
-	end
-
-	def errors
-		file_found? ? [] : ["File not found: '#{file}'"]
-	end
-
+	alias_method :lua, :file_content
 end
 
 class UIC::Application::Behavior < UIC::Behavior
@@ -27,6 +14,6 @@ class UIC::Application::Behavior < UIC::Behavior
 	def initialize(application,el)
 		self.owner = application
 		self.el    = el
-		super( application.resolve_file_path(src) )
+		super( application.absolute_path(src) )
 	end
 end

data/lib/ruic/effect.rb

@@ -0,0 +1,32 @@
+class UIC::Effect
+	include UIC::FileBacked
+	attr_reader :lua
+	def initialize( lua_path )
+		self.file = lua_path
+		load_from_file if file_found?
+	end
+	def load_from_file
+		@lua = File.read(file,encoding:'utf-8')
+	end
+
+	def errors?
+		!errors.empty?
+	end
+
+	def errors
+		file_found? ? [] : ["File not found: '#{file}'"]
+	end
+
+end
+
+class UIC::Application::Effect < UIC::Effect
+	include UIC::ElementBacked
+	# @!parse extend UIC::ElementBacked::ClassMethods
+	xmlattribute :id
+	xmlattribute :src
+	def initialize(application,el)
+		self.owner = application
+		self.el    = el
+		super( application.absolute_path(src) )
+	end
+end

data/lib/ruic/interfaces.rb

@@ -1,17 +1,23 @@
-# Supports classes that represent an XML file on disk (e.g. `.uia` and `.uip`).
+# Supports classes that represent a file on disk (e.g. `.uia` and `.uip`).
 module UIC::FileBacked
-	# @return [Nokogiri::XML::Document] the Nokogiri document representing the instance.
-	attr_accessor :doc
-
 	# @return [String] the absolute path to the underlying file.
 	attr_accessor :file
 
+	# @return [String] the content of the file.
+	attr_accessor :file_content
+
 	# @param relative [String] a file path relative to this file.
 	# @return [String] the full path resolved relative to this file.
-	def resolve_file_path( relative )
+	def absolute_path( relative )
 		File.expand_path( relative.gsub('\\','/'), File.dirname(file) )
 	end
 
+	def relative_path(path)
+		my_dir = File.dirname(file) << "/"
+		absolute_path(path).tap{ |s| s.slice!(my_dir) }
+
+	end
+
 	# @return [String] the name of the file (without any directories).
 	def filename
 		File.basename(file)
@@ -27,6 +33,39 @@ module UIC::FileBacked
 	# @return [String]
 	def file=( new_path )
 		@file = File.expand_path(new_path)
+		if file_found?
+			@file_content = File.read(@file,encoding:'utf-8')
+			on_file_loaded if respond_to?(:on_file_loaded)
+		end
+	end
+
+	# Overwrite the associated file on disk with the `@file_content` of this class.
+	# @return [true]
+	def save!
+		File.open(file,'w:utf-8'){ |f| f << @file_content }
+		true
+	end
+
+	# Save to the supplied file path. Subsequent calls to {#save!} will save to the new file, not the original file name.
+	def save_as(new_file)
+		File.open(new_file,'w:utf-8'){ |f| f << @file_content }
+		self.file = new_file
+	end
+end
+
+# Supports classes that represent an XML file on disk.
+module UIC::XMLFileBacked
+	include UIC::FileBacked
+
+	# @return [Nokogiri::XML::Document] the Nokogiri document representing the instance.
+	attr_accessor :doc
+
+	def file=( new_path )
+		super
+		if file_found?
+			@doc = Nokogiri.XML(file_content,&:noblanks)
+			on_doc_loaded if respond_to?(:on_doc_loaded)
+		end
 	end
 
 	# @return [String] the XML representation of the document.
@@ -37,20 +76,19 @@ module UIC::FileBacked
 	# Overwrite the associated file on disk with the {#to_xml} representation of this class.
 	# @return [true]
 	def save!
-		File.open(file,'w:utf-8'){ |f| f << to_xml }
-		true
+		self.file_content = to_xml
+		super
 	end
 
 	# Save to the supplied file path. Subsequent calls to {#save!} will save to the new file, not the original file name.
 	def save_as(new_file)
-		File.open(new_file,'w:utf-8'){ |f| f << to_xml }
-		self.file = new_file
+		self.file_content = to_xml
+		super
 	end
 end
 
 # Supports classes that represent an XML element (e.g. `<presentation id="main" src="foo.uip"/>`).
 module UIC::ElementBacked
-
 	# @return [Object] the object in charge of this instance.
 	attr_accessor :owner
 
@@ -65,10 +103,10 @@ module UIC::ElementBacked
 	module ClassMethods
 		# Add methods to instances of the class which gets/sets from an XML attribute.
 		# @param name [String] the name of an XML attribute to expose.
-		# @param getblock [Proc] a proc to run
+		# @param getblock [Proc] a proc to run to fetch the value.
 		def xmlattribute(name,getblock=nil,&setblock)
-			define_method(name){ getblock ? getblock[@el[name]] : @el[name] }
-			define_method("#{name}="){ |new_value| @el[name] = (setblock ? setblock[new_value] : new_value).to_s }
+			define_method(name){ getblock ? getblock[@el[name],self] : @el[name] }
+			define_method("#{name}="){ |new_value| @el[name] = (setblock ? setblock[new_value,self] : new_value).to_s }
 		end
 	end
 end

data/lib/ruic/presentation.rb

@@ -1,22 +1,28 @@
 # A `Presentation` represents a `.uip` presentation, created and edited by UI Composer Studio.
 class UIC::Presentation
-	include UIC::FileBacked
+	include UIC::XMLFileBacked
 
 	# Create a new presentation. If you do not specify the `uip_path` to load from, you must
 	# later set the `.file = `for the presentation, and then call the {#load_from_file} method.
 	# @param uip_path [String] path to the `.uip` to load.
 	def initialize( uip_path=nil )
-		self.file = uip_path
-		load_from_file if file_found?
+		@doc = Nokogiri.XML('<UIP version="3"><Project><Graph><Scene id="Scene"/></Graph><Logic><State name="Master Slide" component="#Scene"/></Logic></Project></UIP>')
+		@graph = @doc.at('Graph')
+		@scene = @graph.at('Scene')
+		@logic = @doc.at('Logic')
+		@missing_classes = []
+		@asset_by_el  = {} # indexed by asset graph element
+		@slides_for   = {} # indexed by asset graph element
+		@slides_by_el = {} # indexed by slide state element
+		self.file = uip_path if uip_path
 	end
 
 	# Load information for the presentation from disk.
 	# If you supply a path to a `.uip` file when creating the presentation
 	# this method is automatically called.
+	#
 	# @return [nil]
-	def load_from_file
-		# TODO: this method assumes an application to find the metadata on; the metadata should be part of this class instance instead, shared with the app when present
-		@doc = Nokogiri.XML( File.read( file, encoding:'utf-8' ), &:noblanks )
+	def on_doc_loaded
 		@graph = @doc.at('Graph')
 		@scene = @graph.at('Scene')
 		@logic = @doc.at('Logic')
@@ -24,10 +30,6 @@ class UIC::Presentation
 		generate_custom_classes
 		rebuild_caches_from_document
 
-		@asset_by_el  = {} # indexed by asset graph element
-		@slides_for   = {} # indexed by asset graph element
-		@slides_by_el = {} # indexed by slide state element
-
 		nil
 	end
 
@@ -42,6 +44,7 @@ class UIC::Presentation
 	# Called once during initial load of the file.
 	# @return [nil]
 	def generate_custom_classes
+		# TODO: this method assumes an application to find the metadata on; the metadata should be part of this class instance instead, shared with the app when present
 		parent_class_name = {
 			'CustomMaterial' => 'MaterialBase',
 			'Effect'         => 'Effect',
@@ -49,8 +52,8 @@ class UIC::Presentation
 		}
 		@class_by_ref = {}
 		@doc.xpath('/UIP/Project/Classes/*').each do |reference|
-			path = resolve_file_path( reference['sourcepath'] )
-			raise "Cannot find file '#{path}' referenced by #{self.inspect}" unless File.exist?( path )
+			path = absolute_path( reference['sourcepath'] )
+			next unless File.exist?( path )
 			parent_class = app.metadata.by_name[ parent_class_name[reference.name] ]
 			parent_props = parent_class.properties
 			new_defaults = Hash[ reference.attributes.map{ |name,attr| [name,attr.value] }.select{ |name,val| parent_props[name] } ]
@@ -169,16 +172,39 @@ class UIC::Presentation
 	# Find or create an asset for a scene graph element.
 	# @param el [Nokogiri::XML::Element] the scene graph element.
 	def asset_for_el(el)
-		(@asset_by_el[el] ||= el['class'] ? @class_by_ref[el['class']].new(self,el) : app.metadata.new_instance(self,el))
+		@asset_by_el[el] ||= begin
+			if el['class'] && @class_by_ref[el['class']]
+				@class_by_ref[el['class']].new(self,el)
+			else
+				app.metadata.new_instance(self,el)
+			end
+		end
 	end
 	private :asset_for_el
 
+	# Which files are used by the presentation.
+	# @return [Array<String>] array of absolute file paths referenced by this presentation.
 	def referenced_files
 		(
-			(images + behaviors + effects + meshes + materials ).map(&:file)
-			+ effects.flat_map(&:images)
-			+ fonts
-		).sort_by{ |f| parts = f.split(/[\/\\]/); [parts.length,parts] }
+			[file] +
+			%w[sourcepath importfile].flat_map do |att|
+				find(att=>/./).flat_map do |asset|
+					asset[att].values.compact.map do |path|
+						path.sub!(/#.+/,'')
+						absolute_path(path) unless path.empty?
+					end.compact
+				end
+			end +
+			find.flat_map do |asset|
+				asset.properties.select{ |name,prop| prop.type=='Texture' }.flat_map do |name,prop|
+					asset[name].values.compact.uniq.map{ |path| absolute_path(path) }
+				end
+			end +
+			find(_type:'Text').flat_map do |asset|
+				asset['font'].values.compact.map{ |font| absolute_path(font) }
+			end +
+			@doc.xpath('/UIP/Project/Classes/*/@sourcepath').map{ |att| absolute_path att.value }
+		).uniq
 	end
 
 	# @return [MetaData::Scene] the root scene asset for the presentation.
@@ -243,7 +269,7 @@ class UIC::Presentation
 
 	# @return [Array<String>] an array (possibly empty) of all errors in this presentation.
 	def errors
-		(file_found? ? [] : ["File not found: '#{file}'"])
+		@errors
 	end
 
 	# Find an element or asset in this presentation by scripting path.
@@ -599,7 +625,7 @@ class UIC::Presentation
 		cols = hier.map{ |i,a| a ? [ [i,a.name].join, a.type, elide[a.path] ] : [i,"",""] }
 		maxs = cols.transpose.map{ |col| col.map(&:length).max }
 		tmpl = maxs.map{ |n| "%-#{n}s" }.join('  ')
-		cols.map{ |a| tmpl % a }.join("\n").prepend("\n").extend(RUIC::SelfInspecting)
+		cols.map{ |a| tmpl % a }.join("\n").extend(RUIC::SelfInspecting)
 	end
 
 	# @private
@@ -643,7 +669,7 @@ class UIC::Application::Presentation < UIC::Presentation
 	def initialize(application,el)
 		self.owner = application
 		self.el    = el
-		super( application.resolve_file_path(src) )
+		super( application.absolute_path(src) )
 	end
 	alias_method :app, :owner