entityjs 0.4.1 → 0.4.2

data/lib/entityjs/config.rb

@@ -5,12 +5,20 @@ module Entityjs
   class Config
     
     def self.file_name
-      'config.yml'
+      'game.json'
     end
     
+    def self.preprocess(data, ops={})
+      self.instance.preprocess(data, ops)
+    end
+
     def self.assets_folder
       return 'assets'
     end
+
+    def self.styles_folder
+      return 'styles'
+    end
     
     def self.tests_folder
       'tests'
@@ -20,8 +28,8 @@ module Entityjs
       return 'scripts'
     end
     
-    def self.builds_folder
-      return 'builds'
+    def self.build_folder
+      return 'build'
     end
     
     def self.sounds_folder
@@ -41,9 +49,16 @@ module Entityjs
     end
     
     def reload
-      if File.exists?(Config.file_name)
-        @yml = YAML::load(File.open(Config.file_name))
+      if File.exists?('config.yml')
+        puts "Warning: config.yml will be deprecated soon. Rename to #{Config.file_name}"
+
+        @data = YAML::load(IO.read('config.yml'))
+
+      elsif File.exists?(Config.file_name)
+        data = IO.read(Config.file_name)
+        @data = JSON::parse(data)
       end
+
     end
     
     def initialize
@@ -51,79 +66,101 @@ module Entityjs
     end
     
     def width
-      if @yml.nil?
-        return 500
-      end
-      @yml['width'] || 500
+      get_attr('width', 500)
     end
     
-    def canvas_border
-      if @yml.nil?
-        return true
-      end
-      
-      return @yml['canvas-border'] || true
+    def height
+      get_attr('height', 400)
     end
     
-    def height
-      if @yml.nil?
-        return 400
-      end
-      @yml['height'] || 400
+    def canvas_id
+      get_attr('canvas-id', 'game-canvas')
     end
     
+    def canvas_container
+      get_attr('canvas-container', 'canvas-container')
+    end
+
     def scripts_ignore
-      if @yml.nil?
-        return []
-      end
-      
-      y = @yml['scripts-ignore']
-      if !y.nil?
-        y.split(" ")
-      end
+      return split_attr('scripts-ignore')
     end
     
+    def build_scripts_ignore
+      return split_attr('build-scripts-ignore')
+    end
+
+    def tests_scripts_ignore
+      return split_attr('tests-scripts-ignore')
+    end
+
     def scripts_order
-      if @yml.nil?
-        return []
-      end
-      
-      y = @yml['order']
-      if !y.nil?
-        y.split(" ")
-      end
+      return split_attr('order')
     end
     
     def tests_ignore
-      if @yml.nil?
-        return []
-      end
-      
-      y = @yml['tests-ignore']
-      if !y.nil?
-        y.split(" ")
-      end
+      return split_attr('tests-ignore')
     end
     
     def entity_ignore
-      if @yml.nil?
-        return []
-      end
-      
-      y = @yml['entity-ignore']
-      if !y.nil?
-        y.split(" ")
-      end
+      return split_attr('entity-ignore')
     end
     
-    def canvas_id
-      if @yml.nil?
-        return 'game-canvas'
-      end
-      
-      @yml['canvas-id'] || 'game-canvas'
+    def build_entity_ignore
+      return split_attr('build-entity-ignore')
     end
-    
+
+    def build_name
+      return get_attr('build-name', self.title_slug+'.min')
+    end
+
+    def build_styles_name
+      return get_attr('build_styles_name', self.build_name)
+    end
+
+    def build_styles_ignore
+      return split_attr('build-styles-ignore')
+    end
+
+    def tests_entity_ignore
+      return split_attr('tests-entity-ignore')
+    end
+
+    def title
+      return get_attr('title', 'game')
+    end
+
+    def title_slug
+      return title.downcase.gsub(' ', '-')
+    end
+
+    def styles_ignore
+      return split_attr('styles-ignore')
+    end
+
+    def build_head
+      return get_attr('build-head', '')
+    end
+
+    def build_foot
+      return get_attr('build-foot', '')
+    end
+
+    def build_ignore_play
+      return get_attr('build-ignore-play', nil)
+    end
+
+    def build_path
+      return get_attr('build-path', Config.build_folder)
+    end
+
+    def build_assets_path
+      return get_attr('build-assets-path', Config.assets_folder)
+    end
+
+    def build_styles_path
+      return get_attr('build-styles-path', Config.styles_folder)
+    end
+
     def license
       contents = IO.read(Entityjs::root+'/license.txt')
       
@@ -132,6 +169,73 @@ module Entityjs
       return contents+"\n"
     end
     
+    #replaces config variables in js/html strings with whats defined in config.json
+    # say if the contents inside config.json were:
+    # {"title":"My Game"}
+    # All js and html files with the word RE_TITLE will be replaced with My Game
+    # example, inside init.js:
+    # re.ready(function(){
+    #   re.title = "RE_TITLE"; //this will be replaced
+    #   re.RE_TITLE //this will be replaced with My Game
+    # });
+    def preprocess(contents, ops={})
+      
+      #reload config for changes
+      self.reload
+      
+      attrs = @data || {}
+
+      #setup default attrs
+      attrs['canvas-id'] = self.canvas_id
+      attrs['width'] = self.width
+      attrs['height'] = self.height
+      attrs['title'] = self.title
+      attrs['canvas-container'] = self.canvas_container
+
+      attrs.each do |k,v|
+        val = k.upcase
+
+        if val == 'JS' || val == 'CSS'
+          puts "Warning cannot use JS or CSS as config key. Rename it to something else!"
+        end
+
+        contents = contents.gsub("RE_#{val}", v.to_s)
+      end
+
+      #set width, height and canvas id
+      #contents = contents.sub("RE_WIDTH", Config.instance.width.to_s)
+      #contents = contents.sub("RE_HEIGHT", Config.instance.height.to_s)
+      #contents = contents.sub("RE_CANVAS_ID", Config.instance.canvas_id)
+      
+      return contents
+    end
+
+    protected
+    #returns the wanted attr from data else returns the default
+    def get_attr(at, default=nil)
+      if @data.nil?
+        return default
+      end
+      
+      return @data[at] || default
+    end
+
+    #returns the wanted attr in an array form
+    def split_attr(at)
+      if @data.nil?
+        return []
+      end
+      
+      y = @data[at]
+      if !y.nil?
+        if y.is_a? Array
+          return y
+        else
+          return y.split(" ")
+        end
+      end
+      return []
+    end
     
   end
   

data/lib/entityjs/dirc.rb

@@ -19,6 +19,11 @@ module Entityjs
       return false
     end
     
+    #checks if a local file exists
+    def self.exists?(file)
+      return File.file? Dirc.game_root+'/'+file
+    end
+
     def self.to_game_root
       Dir.chdir(@game_root)
     end
@@ -28,6 +33,29 @@ module Entityjs
       @game_root
     end
     
+    def self.find_styles(ignore=nil)
+      ignore ||= []
+
+      styles = Dir["#{Dirc.game_root}/#{Config.styles_folder}/**/*.css"].sort
+
+      if ignore.any?
+        styles.delete_if {|i| !i.match(/#{ignore.join('|')}/).nil?}
+      end
+
+      return styles
+    end
+
+    def self.find_styles_url(ignore=nil)
+      styles = self.find_styles(ignore)
+      
+      #remove extra folders
+      styles = styles.collect do |i|
+        i[i.rindex(Config.styles_folder+'/')..-1]
+      end
+
+      return styles
+    end
+
     def self.find_tests_url(ignore=nil)
       valids = Compile.valid_scripts.join(",")
       ignore ||= []

data/lib/entityjs/page.rb

@@ -7,12 +7,18 @@ module Entityjs
       return '.js'
     end
     
-    def self.render_play
-      self.set_vars("play.html")
+    def self.render_play_page(ops={})
+      self.set_vars("play.html", ops)
     end
     
-    def self.render_tests
-      self.set_vars('tests.html', true)
+    def self.render_favicon
+      path = Entityjs::public_path+'/favicon.ico'
+      
+      return IO.read(path)
+    end
+
+    def self.render_test_page
+      self.set_vars('test.html', :tests=>true)
     end
     
     def self.render_entityjs_src(path)
@@ -22,49 +28,67 @@ module Entityjs
     end
     
     def self.render_test(path)
-      file = path.sub(/#{self.processor_ext}$/i, '');
+      file = path.sub(/#{self.processor_ext}$/i, '')
       
-      return Compile.test_to_js(file)
+      return Config.preprocess(Compile.test_to_js(file))
     end
     
     def self.render_script(path)
-      file = path.sub(/#{self.processor_ext}$/i, '');
-      return Compile.script_to_js(file)
+      file = path.sub(/#{self.processor_ext}$/i, '')
+      return Config.preprocess(Compile.script_to_js(file))
     end
     
     def self.render_eunit(path)
       IO.read(Entityjs::root+"/public/qunit/#{path}")
     end
-    
+
     protected
-    #defines varaibles on the template htmls for view on webpage
-    def self.set_vars(path, tests=false)
+    def self.set_vars(path, ops={})
       #search locally first
-      local = Dirc.game_root+'/'+path
-      if File.file? local
-        contents = IO.read(local);
+      if Dirc::exists?(path)
+        contents = IO.read(Dirc.game_root+'/'+path);
       else
-        contents = IO.read("#{Entityjs::root}/public/#{path}")
+        contents = IO.read("#{Entityjs::public_path}/#{path}")
       end
-      
-      #reload config for changes
-      Config.instance.reload
-      
-      #set width, height and canvas id
-      contents = contents.sub("$WIDTH", Config.instance.width.to_s)
-      contents = contents.sub("$HEIGHT", Config.instance.height.to_s)
-      contents = contents.sub("$CANVAS_ID", Config.instance.canvas_id)
-      
-      if !Config.instance.canvas_border
-        contents = contents.sub('border:1px #333 solid;', '')
-      end
-      
+
+      contents = Config.preprocess(contents)
+
       #set javascript srcs
-      contents.sub("$JS", self.compile_js_html(tests))
+      if !ops[:js]
+        js = self.compile_js_html(ops[:tests])
+      else
+        js = ops[:js]
+      end
+
+      contents = contents.sub("RE_JS", js)
+
+      #add css
+      if !ops[:css]
+        css = self.compile_css_html
+      else
+        css = ops[:css]
+      end
+
+      contents = contents.sub("RE_CSS", css)
     end
-    
+
+    def self.compile_css_html
+      styles_url = Dirc.find_styles_url(Config.instance.styles_ignore)
+
+      css = ''
+
+      styles_url.each do |s|
+
+        css += "\t<link rel=\"stylesheet\" href=\"#{s}\" type=\"text/css\"/>\n"
+      end
+
+      return css
+    end
+
     #compiles html js tags for render on webpage
     def self.compile_js_html(tests=false)
+      tests ||= false
+
       js = %Q(
       <script type=\"text/javascript\">
       window.addEventListener\(\"load\", function(){
@@ -73,8 +97,16 @@ module Entityjs
         }\);
       </script>
 )
-      ent = Dirc.find_entity_src_url(Config.instance.entity_ignore)
-      srcs = Dirc.find_scripts_url(Config.instance.scripts_ignore, Config.instance.scripts_order)
+      ent_ignore = Config.instance.entity_ignore
+      srcs_ignore = Config.instance.scripts_ignore
+
+      if tests
+        ent_ignore += Config.instance.tests_entity_ignore
+        srcs_ignore += Config.instance.tests_scripts_ignore
+      end
+
+      ent = Dirc.find_entity_src_url(ent_ignore)
+      srcs = Dirc.find_scripts_url(srcs_ignore, Config.instance.scripts_order)
       
       if tests
         tests_src = Dirc.find_tests_url(Config.instance.tests_ignore)
@@ -90,14 +122,21 @@ module Entityjs
       merg.each do |s|
         
         #output a divider for each js root
-        first_folder = s.split('/').shift
+        folders = s.split('/')
+
+        #remove file at the end
+        folders.pop
+        folders.join('/')
+
+        first_folder = folders
         if last != first_folder
           js += "\n\n\t<!-- #{first_folder} -->\n"
           last = first_folder
         end
         
         #add processor extension to non-js files so the server processes it into js
-        if s.match(/\.js$/).nil?
+        if !s.match(/^scripts\//).nil?
+          #add processor to all files, because preprocessor needs it to activate
           s += self.processor_ext
         end