entityjs 0.3.1 → 0.3.2

data/README.md

@@ -3,13 +3,11 @@ An HTML5 javascript game engine utlizing the entity-component design. Write high
 
 [EntityJS Website](http://entityjs.com) | [Demos](http://entityjs.com/demos) | [Tutorials](http://entityjs.com/tutorials) | [API](http://entityjs.com/api)
 
-## Version 0.3
+## Version 0.3.2
 
-Version 0.3 is a major release with many revisions and a brand new ruby gem to work with. You can now type `entityjs new game-name` and a new game will be created. Of course there are more commands, check below.
-
-There is a new directory structure, testing framework, better minifier, better config file and more.
-
-**Warning:** there are many name changes which will break older entity games!
+* Coffeescript is now supported.
+* Assets directory is now used for external loading only.
+* Scripts directory now accepts, tmx, xml, json and coffee files.
 
 ## API
 Currently the [API](http://entityjs.com/api) is out of date. It will slowly be updated everyday.
@@ -58,17 +56,17 @@ See all available templates:
 
 `entityjs comp rock`
 
-This will create a new component called *rock* at scripts/rock.js and will create a test file inside test/rock.js
+This will create a new component called *rock* at scripts/rock.js and will create a test file.
 
 `entityjs comp display/hero`
 
-This will create a new component in the directory scripts/display.
+This will create a hero component in the directory scripts/display.
 
 ### Creating a Test
 
 `entityjs test name test1 test1`
 
-Create a test in tests/name_test.js with two test methods.
+Create a test in /tests/name_test.js with two test methods.
 
 ### Build Game
 
@@ -90,18 +88,18 @@ To run tests visit:
 Assets are located here:
 `localhost:2345/assets/*name`
 
+View [all commands](/bendangelo/EntityJS/wiki/commands)
+
 ## Directory Structure
 
 * Assets - Contains all external assets
   * Images - Add any images here and retrieve them with `re.assets.images`
   * Sounds - Add any sounds and retrieve them with `re.assets.sounds`
-  * [Custom] - Create any folders or files and they will be available in code.
-  * json, tmx, xml, sounds and images are accepted files.
 
 * Builds - Contains all finished builds
 
-* Scripts - Contains all javascript sources.
-  * Plugins - Contains external scripts from other authors.
+* Scripts - Contains all js, coffee sources. Xml, tmx and json files will be converted into js.
+  * Plugins - Contains minified scripts for plugin play.
 
 * Tests - Contains test files to run in [QUnit](http://docs.jquery.com/QUnit)
 
@@ -193,7 +191,7 @@ Simply create a new directory in /assets named levels or anything you like to sa
     re('level1.tmx')[0]; //assuming the file name is level1.tmx
     re('level'); //find all levels that are in the /assets/levels directory
 
-If you are still confused create a new platform game and view how the levels are used.
+If you are still confused create a new platform game and view levels are used.
 
 ## Quick Start Guide
 First you should install [ruby](http://rubyinstaller.org/) and the [entityjs gem](http://rubygems.org/gems/entityjs). 
@@ -205,3 +203,9 @@ Move into the `mygame` directory and play the game:
 `entityjs server`
 
 Open your browser and navigate to `localhost:2345`
+
+## Contributing
+
+Before sending a pull request it would be a good idea to run `rspec` and `rake jasmine` to make sure all tests pass in both ruby and javascript.
+
+Running rspec will generate a /mygame/ folder with test files. It will be ignored by git so don't worry about it.

data/entityjs.gemspec

@@ -25,6 +25,7 @@ Gem::Specification.new do |s|
   s.add_development_dependency "jasmine"
   
   s.add_dependency "sinatra"
+  s.add_dependency "coffee-script"
   s.add_dependency 'uglifier'
   s.add_dependency 'json'
   s.add_dependency 'cobravsmongoose'

data/lib/entityjs/assets.rb

@@ -3,180 +3,29 @@ module Entityjs
   
   class Assets
     
-    def self.valid_datas
-      ['xml', 'json', 'tmx']
+    def self.valid_images
+      ['gif', 'png', 'jpg', 'jpeg']
     end
     
-    def self.datas_regex
-      return /^.*\.#{self.valid_datas.join('|')}$/i
-    end
-    
-    def self.set_vars(contents, tests=false)
-      #read file for changes
-      Config.instance.reload
-      
-      contents = contents.gsub("$WIDTH", Config.instance.width.to_s)
-      contents = contents.gsub("$HEIGHT", Config.instance.height.to_s)
-      contents = contents.gsub("$CANVAS_ID", Config.instance.canvas_id)
-      
-      contents.gsub("$JS", Assets.to_html(tests))
-    end
-    
-    #combine all sources into valid html scripts
-    def self.to_html(tests=false)
-      js = %Q(
-      <script type='text/javascript'>
-      window.addEventListener\('load', function(){
-        #{Assets.to_js}
-        re.version = '#{VERSION}';
-        
-        }\);
-      </script>
-)
-      ent = Dirc.find_entity_src_url(Config.instance.entity_ignore)
-      srcs = Dirc.find_scripts_url(Config.instance.scripts_ignore, Config.instance.scripts_order)
-      
-      if tests
-        tests_src = Dirc.find_tests_url(Config.instance.tests_ignore)
-      else
-        tests_src = []
-      end
-      
-      merg = ent | srcs | tests_src
-      
-      merg.each do |s|
-        js += "\t<script src='#{s}' type='text/javascript'></script>\n"
-      end
-      js
-    end
-    
-    #converts all assets / info into a js game header
-    def self.to_js(path = nil, images = nil, sounds = nil, canvas = nil, datas = nil)
-      path ||= 'assets/'
-      images ||= self.images_to_js
-      sounds ||= self.sounds_to_js
-      canvas ||= Config.instance.canvas_id
-      datas ||= self.datas_to_js
-      
-      return %Q(
-      re.load.path = '#{path}';
-      re.assets = {
-        images:#{images},
-        sounds:#{sounds}
-        };
-      re.canvas = '##{canvas}';
-      #{datas}
-      )
-    end
-    
-    def self.images_to_js(images = nil)
-      images ||= self.search('images')
-      
-      s = images.collect{|i| "'#{i}'"}.join(', ')
-      
-      "[#{s}]"
-    end
-    
-    def self.sounds_to_js(sounds = nil)
-      sounds ||= self.search('sounds')
-      
-      s = sounds.collect{|i| "'#{i}'"}.join(', ')
-      
-      "[#{s}]"
-    end
-    
-    def self.datas_to_js
-      s = self.search
-      
-      out = ''
-      
-      s.each do |i|
-        
-        file = i
-        data = IO.read(Dirc.game_root+'/'+Config.assets_folder+'/'+i)
-        
-        out += self.data_to_js(i, data)
-        
-      end
-      
-      
-      out
-    end
-    
-    def self.data_to_js(file, data)
-      contents = self.data_to_json(file, data)
-      
-      basename = File.basename(file)
-      dirname = File.dirname(file)
-      
-      comps = []
-      
-      dirname.split('/').each do |i|
-        
-        #make singular
-        if i[-1] == 's'
-          i = i[0..-2]
-        end
-        
-        comps.push i
-        
-      end
-      
-      #remove dot because no base dir was given
-      comps.delete_if{|i| i=='.'}
-      
-      %Q(
-      re.e('#{basename} #{comps.join(' ')}')
-      .attr(#{contents});
-      )
-    end
-    
-    def self.data_to_json(file, data)
-      ext = file.downcase
-      
-        case ext
-          when /json$/
-            return data
-            
-          when /tmx$/
-            
-            return ParseTMX.parse(data)
-          
-          when /xml$/
-            return ParseXML.parse(data)
-            
-          when /csv$/
-            raise 'CSV files are not supported at the moment'
-            
-          when /yml$/
-            raise 'YML files are not supported at the moment'
-            
-          else
-            return data
-            
-        end
-        
-    end
-    
-    def self.file_to_json(file)
-        contents = IO.read(file)
-        
-        return self.data_to_json(file, contents)
+    def self.valid_sounds
+      ['mp3', 'ogg', 'aac', 'wav']
     end
     
     def self.search(type='*')
-      images_folder = Config.images_folder
-      sounds_folder = Config.sounds_folder
-      assets_folder = Config.assets_folder
       
       case type
         when 'images'
-          return self.find_files(images_folder+'/*').select{|i| i.match(/^*\.(gif|png|jpg|jpeg)$/i)}
+          images_folder = Config.images_folder
+          valid_images = self.valid_images.join(',')
+          return self.find_files(images_folder+"/**/*.{#{valid_images}}")
           
         when 'sounds'
-          return self.find_files(sounds_folder+'/*').select{|i| i.match(/^*\.(mp3|ogg|aac|wav)$/i)}
+          sounds_folder = Config.sounds_folder
+          valid_sounds = self.valid_sounds.join(',')
+          return self.find_files(sounds_folder+"/**/*.{#{valid_sounds}}")
           
         else
+          #TODO: fix up
           return self.search_datas
           
       end
@@ -184,7 +33,8 @@ module Entityjs
     end
     
     def self.search_datas
-      return self.find_files("#{Config.assets_folder}/*/*").select{|i| !i.match(/\/(images|sounds)\//i) && i.match(self.datas_regex)}
+      #TODO: find all other folders and generate a key in re.assets
+      return self.find_files("#{Config.assets_folder}/*/*").select{|i| i.match(/(images|sounds)\//i) == nil }
     end
     
     def self.find_files(search)

data/lib/entityjs/command.rb

@@ -25,6 +25,8 @@ module Entityjs
         
         when 'release'
           return Entityjs::Release.generate(args)
+        when 'eunit'
+          return Entityjs::Eunit.generate(args)
           
         when /^(comp|c)$/
           return Entityjs::Comp.generate(args)
@@ -35,11 +37,11 @@ module Entityjs
         when /^(font|f)$/
           return Entityjs::Font.generate(args)
           
-        when /^(version|v)$/
+        when /^(version|v|-v)$/
           puts 'EntityJS V'+Entityjs::VERSION
           return 0
           
-        when /^(help|h)$/
+        when /^(help|h|-h)$/
           puts ""
           puts '---- Commands ----'
           puts 'entityjs new [name]'
@@ -49,6 +51,7 @@ module Entityjs
           puts 'entityjs test [name]'
           puts 'entityjs test [name] [tests]+'
           puts 'entityjs font [name] (soon...)'
+          puts 'entityjs release'
           puts 'entityjs build'
           puts 'entityjs build [name]'
           puts 'entityjs server'

data/lib/entityjs/commands/build.rb

@@ -34,30 +34,18 @@ module Entityjs
       Dirc.create_dir('builds', true)
       
       #create new directory
-      if Dir.exists?(name)
+      if File.directory?(name)
         return 3
       end
       
-      assets_root = Dirc.game_root+'/'
+      assets_root = Dirc.game_root+'/'+assets_folder
       
       Dir.mkdir(name)
       Dir.chdir(name)
-        
-      #copy images and sounds into assets
-      Dirc.create_dir(assets_folder)
-      Dir.chdir(assets_folder) do
-        
-        if Dir.exists? assets_root+images_folder
-          puts "Copying images"
-          FileUtils.cp_r assets_root+images_folder, 'images'
-        end
-        
-        if Dir.exists? assets_root+sounds_folder
-          puts "Copying sounds"
-          FileUtils.cp_r assets_root+sounds_folder, 'sounds'
-        end
-        
-      end
+      
+      #copy everything inside the assets folder
+      puts "Copying assets folder"
+      FileUtils.cp_r assets_root, assets_folder
       
       #append all files into one big file
       puts "Compiling code"
@@ -121,20 +109,36 @@ module Entityjs
       return out
     end
     
+    #finds all js inside public/qunit and compiles into one string
+    def self.compile_eunit()
+      out = ''
+      
+      units = Dirc.find_eunit_src
+      
+      units.each do |i|
+        out += "\n"
+        out += IO.read(i)
+        out += "\n"
+      end
+      
+      return out
+    end
+    
     #compiles all game source and returns it
     def self.compile_scripts(ignore = nil, order=nil)
-      scripts = Dirc.find_scripts(ignore, order)
+      #find with short urls for proper data processing
+      scripts = Dirc.find_scripts_short(ignore, order)
       
       out = ''
       
       scripts.each do |i|
         out += "\n"
-        out += IO.read(i)
+        out += Compile.script_to_js(i)
         out += "\n"
       end
       
-      #add levels, animations etc data
-      out += Assets.to_js
+      #add js config
+      out += self.js_config
       
       return out
     end
@@ -145,13 +149,49 @@ module Entityjs
       code = Uglifier.compile(code, :copyright=>false)
       
       #add entity license statement
-      if license
+      if license.is_a? String
+        code = license + code
+      elsif license
         code = Config.instance.license + code
       end
       
       return code
     end
     
+    def self.js_config(path = nil, images = nil, sounds = nil, canvas = nil)
+      path ||= 'assets/'
+      images ||= self.images_to_js
+      sounds ||= self.sounds_to_js
+      canvas ||= Config.instance.canvas_id
+      
+      return %Q(
+      re.load.path = \"#{path}\";
+      re.assets = {
+        images:#{images},
+        sounds:#{sounds}
+        };
+      re.canvas = \"##{canvas}\";
+      )
+    end
+    
+    #returns all images in a js array
+    def self.images_to_js(images = nil)
+      images ||= Assets.search('images')
+      
+      s = images.collect{|i| "'#{i}'"}.join(', ')
+      
+      "[#{s}]"
+    end
+    
+    #returns all sounds in a js array
+    def self.sounds_to_js(sounds = nil)
+      sounds ||= Assets.search('sounds')
+      
+      s = sounds.collect{|i| "'#{i}'"}.join(', ')
+      
+      "[#{s}]"
+    end
+    
   end
   
 end

data/lib/entityjs/commands/eunit.rb

@@ -0,0 +1,44 @@
+module Entityjs
+  
+  #outputs eunit compiled code
+  class Eunit
+    
+    def self.generate(name=nil)
+      
+      if name.is_a? Array
+        name = name.first
+      end
+      
+      name ||= self.eunit_name
+      
+      puts "Collecting test src files"
+      
+      min = Entityjs::Build.compile_eunit
+      
+      puts "Minifying"
+      
+      license = "/* QUnit V1.5.0pre with EntityJS Entensions | http://docs.jquery.com/QUnit */\n"
+      
+      min = Entityjs::Build.minify(min, license)
+      
+      File.open(name, 'w') do |f|
+        
+        f.write(min)
+        
+      end
+      
+      puts "Done!"
+      puts "File is at"
+      puts "  ./#{name}"
+      
+      
+      return 0
+    end
+    
+    def self.eunit_name
+      return "eunit-#{Entityjs::VERSION}.min.js"
+    end
+    
+  end
+  
+end

data/lib/entityjs/commands/release.rb

@@ -1,6 +1,6 @@
 module Entityjs
   
-  #compiles entity source code
+  #compiles entity source code and outputs it
   class Release
     
     def self.generate(name=nil)

data/lib/entityjs/commands/server.rb

@@ -22,21 +22,36 @@ module Entityjs
     
     get '/' do
       
-      Assets.set_vars(IO.read("#{Entityjs::root}/public/play.html"))
+      Page.render_play()
       
     end
     
     get '/tests' do
       
-      Assets.set_vars(IO.read("#{Entityjs::root}/public/tests.html"), true)
+      Page.render_tests()
       
     end
     
+    #entity source code
     get '/entityjs/*' do
       content_type 'text/javascript'
-      IO.read(Entityjs::root+'/src/'+params[:splat].first)
+     
+      Page.render_entityjs_src(params[:splat].first)
     end
     
+    get '/scripts/*' do
+      content_type 'text/javascript'
+      
+      Page.render_script(params[:splat].first)
+    end
+    
+    get '/tests/*' do
+      content_type 'text/javascript'
+      
+      Page.render_test(params[:splat].first)
+    end
+    
+    #qunit testing stuff
     get '/qunit/*' do
       file = params[:splat].first
       if file.match /\.js$/
@@ -45,7 +60,7 @@ module Entityjs
         content_type 'text/css'
       end
       
-      IO.read(Entityjs::root+"/public/qunit/#{file}")
+      Page.render_eunit(file)
     end
     
     

data/lib/entityjs/compile.rb

@@ -0,0 +1,152 @@
+#The Compile class transforms text data into js
+#This includes, xml, tmx, json, coffeescript, etc
+module Entityjs
+  
+  class Compile
+    
+    def self.valid_datas
+      ['xml', 'json', 'tmx', 'csv', 'yml']
+    end
+    
+    def self.valid_scripts
+      ['js', 'coffee'] + self.valid_datas
+    end
+    
+    def self.datas_regex
+      return /^.*\.#{self.valid_datas.join('|')}$/i
+    end
+    
+    def self.valid_data?(file)
+      return file.match(datas_regex) != nil
+    end
+    
+    def self.path
+      if @path.nil?
+        @path = Dirc.game_root
+      end
+      
+      @path
+    end
+    
+    def self.path=(v)
+      @path = v
+    end
+    
+    def self.test_to_js(path, data=nil)
+      if data.nil?
+        #load
+        data = self.read_contents(Config.tests_folder+'/'+path)
+      end
+      
+      return self.data_to_js(path, data)
+    end
+    
+    def self.script_to_js(path, data=nil)
+      if data.nil?
+        #load
+        data = self.read_contents(Config.scripts_folder+'/'+path)
+      end
+      
+      return self.data_to_js(path, data)
+    end
+    
+    def self.data_to_js(path, data)
+      js = ''
+      
+      if self.valid_data?(path)
+        comps = path.split('/')
+        js = self.data_to_entity(comps, data)
+      elsif path.match /\.coffee$/
+        js = self.coffee_to_js(data)
+      else
+        js = data
+      end
+      
+      return js
+    end
+    
+    #compiles data files into entities
+    def self.data_to_entity(comps, data)
+      if comps.is_a? String
+        comps = [comps]
+      end
+      
+      #find extension for compiling, or else treat it as json
+      ext = comps.select{|i| !File.extname(i).empty? }.first
+      
+      if ext.nil?
+        ext = '.json'
+      else
+        ext = File.extname(ext)
+      end
+      
+      json = self.to_json(ext, data)
+      
+      return self.to_entity(comps, json)
+    end
+    
+    #converts given comps and json into an entityjs entity
+    # returns an entityjs component
+    def self.to_entity(comps, json)
+      
+      #remove plurals
+      comps.collect! do |i|
+        
+        #115 for ruby 1.8.7
+        if i[-1] == 's' || i[-1] == 115
+          i[0..-2]
+        else
+          i
+        end
+        
+      end
+      
+      #turn into one long strng
+      comps = comps.join(' ')
+      
+      #output entity
+      return "re.e('#{comps}')\n.attr(#{json})"
+    end
+    
+    #converts the given data to json
+    #the type defines the data type
+    #example:
+    # to_json('xml', "<map><bob>10</bob></map>")
+    # => "{"bob":{$:10}}"
+    def self.to_json(type, data)
+      
+      type.downcase!
+      
+      case type
+        when '.json'
+          return data
+        when '.tmx'
+          return self.tmx_to_json(data)
+        when '.xml'
+          return self.xml_to_json(data)
+        else
+          return data
+      end
+      
+    end
+    
+    def self.coffee_to_js(data)
+      return ParseCoffee.parse(data)
+    end
+    
+    def self.tmx_to_json(data)
+      return ParseTMX.parse(data)
+    end
+    
+    def self.xml_to_json(data)
+      return ParseXML.parse(data)     
+    end
+    
+    #used for stubbing
+    def self.read_contents(path)
+      IO.read(self.path+'/'+path)
+    end
+    
+  end
+  
+end