scenejs_on_rails 1.0.4 → 1.0.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 42433597c72560514a0af05a3c4e4f3e9f55fafc
-  data.tar.gz: 9af5cb634972f03e969005714e418e49f8033040
+  metadata.gz: 641822c9bc3d6e6aee5c5b7185b9305c63dddef0
+  data.tar.gz: 65f889792a6defaaf2966f665298daf977477f8f
 SHA512:
-  metadata.gz: 15c3bab9d79cc221de26f3b5d91f627d1304c30ace237919b8028977cb98c9c05b9d6005efe16859b70d15cc9044f0720f1cf521df95b117259536962cf10699
-  data.tar.gz: 4eb342fba1e60b4be276925ac747ccb192679f070b690db312ce900df2c42e3d1d5430114eea73fb1b029ea415c4c793c5c2ad8d70eac1283b899ec150f87ac5
+  metadata.gz: 7a0449fa272e84054179c43f4205c00750a04c139b5266eeb4da693246b6380e06db3fbb6e2d85587623b40a4c7b9e546802a3f89ac90e5014095db255e15c47
+  data.tar.gz: eb1814165999b1569a9fbd802ede0f9c7f9c31b8ad3f66cce93386edda184fe01f7aada33c7c62e20719092db3a29ff78ee925c1049ce20a23fe67776ccab2f5

data/README.md

@@ -1,5 +1,5 @@
 # Scenejs On Rails
-## Plugins last updated October 24th, 2013
+## Currently Running SceneJS V3.2
 
 First off, if you dont know about [Scenejs](http://scenejs.org/), go take a look so you can appreciate what this gem does.
 
@@ -28,14 +28,12 @@ Add this line to your application's Gemfile:
 
 And then execute:
 
-    $ bundle
+    $ bundle install
 
 Or install it yourself as:
 
     $ gem install scenejs_on_rails
 
-
-
 Then add this to your routes.rb
     
     get '/scenejs/get_scenejs_data'
@@ -103,19 +101,24 @@ Simply by declaring
   type: 'myplugin/path'
 ```
 for a node, scenejs will send a request to your app for the plugin data it needs. If it is looking for javascripts that define the node,
-it will recieve them as raw inline javascript and then mark that plugin as loaded. It looks in your /vendor/assets/javascripts/scenejs_plugins folder
-THEN in its own directory for the javascripts. If it doesn't find the data, the scenejs controller (within rails) raises a 
+it will recieve them as raw inline javascript and then mark that plugin as loaded. It looks in your /lib/assets/javascripts/scenejs_plugins folder
+then /vendor/assets/javascripts/scenejs_plugins and finally in its own directory for the javascripts. If it doesn't find the data, the scenejs controller (within rails) raises a 
 ActionController::RoutingError error.
 
-If you want to link to a image within a plugin you made you should set this in your init function
+It is an extremely good idea to have your node type data be based on your filesystem for your plugins. For example, if you are creating a plugin like
+
 ```javascript
-  SceneJS.Types.addType("objects/space/my_planets/awesome_sun", {
+  SceneJS.Types.addType("objects/space/planets/awesome_sun", {
     
     init:function (params) {
 
-      var texturePath = "node/objects/space/my_planets/awesome_sun/";
+      var texturePath = "node/objects/space/planets/awesome_sun/";
 ```
-Then set your texture nodes like so
+Then your plugin should have its main js file be at Rails.root / lib / assets / javascripts / scenejs_plugins / node / objects / space / planets / awesome_sun.js
+
+For your images, they should be in Rails.root / lib / assets / javascripts / scenejs_plugins / node / objects / space / planets / awesome_sun (with awesome_sun being
+a directory) and then linked like so:
+
 ```javascript
   type: "texture",
   layers: [
@@ -128,7 +131,7 @@ This will tell scenejs to grab the image data from scenejs controller's get_plug
 
 ### NOTE!
 
-If you plan on using images / whatever as textures within an init file (something that defines the base scene like above), just use your asset pipeline.
+If you plan on using images / whatever as textures within an init script (something that defines the base scene like the earth example), you can use your asset pipeline.
 
 ```javascript
   type: "texture",
@@ -138,10 +141,24 @@ If you plan on using images / whatever as textures within an init file (somethin
     }
   ],
 ```
+You can also setup a path to grab these from if you dont want too many images in your pipeline (advanced graphics may use very large images). For example you could store
+ your images in Rails.root / lib / assets / javascripts / scenejs_plugins / generic_images and then link to your images like this:
+
+```javascript
+  type: "texture",
+  layers: [
+    {
+      src: "generic_images/mytexture.jpg"
+    }
+  ],
+
+```
+It is always better to store images used in the init script in the pipeline! You dont have a choice for plugins however. It is highly recommended to write all your objects
+as plugins to better utilize DRY which allows you to use the least amount of code possible to render your scene from the init script.
 
 ## Vulnerability via looking for the files?
 
-For the security minded, the scenejs controller figures out where to find its files from params[:file] then searching in two possible locations for that data.
+For the security minded, the scenejs controller figures out where to find its files from params[:file] then searching in three possible locations for that data.
 As the location parser uses File.join() it was possible for an attacker to use '..' to dig up files they are not meant to find. This has been prevented through
 statements that scan the params[:file] string. If this occurs, the controller will raise a ActionController::UnpermittedParameters error. This will never occur
 normally.
@@ -150,7 +167,7 @@ normally.
 
 ```javascript
   SceneJS.setConfigs({
-   pluginPath: (((location.protocol.length === 0) ? 'http://' : location.protocol + '//') + location.host + '/scenejs/get_scenejs_data?file=')
+   pluginPath: (((location.protocol.length === 0) ? 'http://' : location.protocol + '//') + location.host + '/scenejs/get_scenejs_data.js?file=')
   });
 ```
 
@@ -161,7 +178,7 @@ Louis Alridge had originally written some hacks into the source to get things to
 
 ## SceneJS Libraries
 
-Certain libraries like stats.min must be included through the asset pipeline in your application.js like this:
+Certain libraries like stats.min can be included through the asset pipeline in your application.js like this:
 
     //= require scenejs_lib/stats.min
 

data/app/controllers/scenejs_controller.rb

@@ -28,10 +28,13 @@ class ScenejsController < ApplicationController
       end
 
       in_gem_file_ref = File.join(File.expand_path(File.dirname(__FILE__)), '..', '..', "vendor","assets","javascripts","scenejs_plugins", params[:file])
-      in_app_file_ref = Rails.root.join("vendor","assets","javascripts","scenejs_plugins", params[:file])
+      in_app_vendor_file_ref = Rails.root.join("vendor","assets","javascripts","scenejs_plugins", params[:file])
+      in_app_lib_file_ref = Rails.root.join("lib","assets","javascripts","scenejs_plugins", params[:file])
 
-      if File.exist?(in_app_file_ref)
-        fileloc = in_app_file_ref
+      if File.exist?(in_app_lib_file_ref)
+        fileloc = in_app_lib_file_ref
+      elsif File.exist?(in_app_vendor_file_ref)
+        fileloc = in_app_vendor_file_ref
       elsif File.exist?(in_gem_file_ref)
         fileloc = in_gem_file_ref
       end

data/lib/scenejs_on_rails/version.rb

@@ -1,4 +1,4 @@
 module ScenejsOnRails
-  VERSION = "1.0.4"
+  VERSION = "1.0.5"
   SCENEJS_VERSION = "3.2"
 end

data/vendor/assets/javascripts/scenejs_plugins/node/objects/space/planets/earth.js

@@ -49,14 +49,17 @@ SceneJS.Types.addType("objects/space/planets/earth", {
 //                                                                                },
                                         {
                                             src:texturePath + "earth.jpg",
+                                            flipY: true,
                                             applyTo:"color"
                                         },
                                         {
                                             src:texturePath + "earth-specular.jpg",
+                                            flipY: true,
                                             applyTo:"specular"
                                         } ,
                                         {
                                             src:texturePath + "earth-lights.gif",
+                                            flipY: true,
                                             applyTo:"emit"
                                         }
                                     ],

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: scenejs_on_rails
 version: !ruby/object:Gem::Version
-  version: 1.0.4
+  version: 1.0.5
 platform: ruby
 authors:
 - Louis Alridge
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-11-03 00:00:00.000000000 Z
+date: 2014-04-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -203,7 +203,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: scenejs_on_rails
-rubygems_version: 2.0.6
+rubygems_version: 2.1.11
 signing_key: 
 specification_version: 4
 summary: Scenejs On Rails Smart Asset Management