jax 1.1.1 → 2.0.0

data/lib/generators/jax/install/install_generator.rb

@@ -0,0 +1,27 @@
+require 'rails/generators'
+
+module Jax
+  module Generators
+    class InstallGenerator < ::Rails::Generators::Base
+      include Jax::Generators::CoffeeGenerator
+      extend  Jax::Generators::SourceRoot
+
+      desc <<DESC
+Description:
+  Install Jax into your Rails application.
+DESC
+
+      def route_jax_mount_point
+        route %{mount Jax::Engine => "/jax" unless Rails.env == "production"}
+      end
+      
+      def create_jax_application_controller
+        coffee_template_with_fallback "application_controller.js", 'app/assets/jax/controllers/application_controller.js'
+      end
+
+      def create_jax_application_helper
+        coffee_template_with_fallback "application_helper.js", 'app/assets/jax/helpers/application_helper.js'
+      end
+    end
+  end
+end

data/lib/generators/jax/jax_generator.rb

@@ -0,0 +1,13 @@
+require File.expand_path("all", File.dirname(__FILE__))
+
+class JaxGenerator < ::Rails::Generators::Base
+  def show_helpful_info
+    say "You can invoke the following Jax generators:\n\n"
+    Jax::Generators.constants.each do |const_name|
+      const = Jax::Generators.const_get const_name
+      unless const.name =~ /Base$/ or not const.is_a? Class
+        say "  #{const.banner}"
+      end
+    end
+  end
+end

data/lib/generators/jax/light/light_generator.rb

@@ -0,0 +1,23 @@
+require File.expand_path("../all", File.dirname(__FILE__))
+
+module Jax
+  module Generators
+    class LightGenerator < Jax::Generators::NamedBase
+      argument :type
+      
+      def light_type
+        case type
+        when 'spot', 'directional', 'point'
+          type.upcase + "_LIGHT"
+        else
+          raise "Invalid light type. Expected one of ['spot', 'directional', 'point']"
+        end
+      end
+      
+      def create_light_source
+        template "light_source.resource.erb",
+          File.join('app/assets/jax/resources/light_sources', "#{file_name}.resource")
+      end
+    end
+  end
+end

data/lib/{jax/generators → generators/jax}/material/USAGE

@@ -1,6 +1,3 @@
-Usage:
-  jax generate material NAME [list of shaders]
-
 Generates a new material. If no arguments other than NAME are given, then the
 material will support only lighting and color. More advanced capabilities like
 texturing, normal mapping, shadow map support, and so forth must be specified
@@ -11,11 +8,11 @@ obvious performance implications of using complicated materials, some shaders
 may flat-out not compile if, for instance, the length of the source code
 exceeds the capabilities of the graphics processor.
 
-Processors supported by your application:
+Shaders supported by your application:
 
-<%supported_shaders.each do |shader| -%>
-  - <%=shader.name.ljust(20)%> : <%=shader.description.strip.gsub(/\n/, "\n"+" "*25)%>
-<%end -%>
+<% all_shaders.each do |shader|
+%>  - <%=shader[:name].ljust(20)%> : <%=shader[:description].strip.gsub(/\n/, "\n"+" "*25)%>
+<% end %>
 
 You can specify a shader more than once. For instance, you can create a
 material that uses three textures and two normal maps:
@@ -26,4 +23,3 @@ You can also pass the --append option to update an existing material rather
 than generate an all-new one:
 
   jax generate material NAME --append texture
-

data/lib/generators/jax/material/material_generator.rb

@@ -0,0 +1,112 @@
+require File.expand_path("../all", File.dirname(__FILE__))
+
+module Jax
+  module Generators
+    class MaterialGenerator < Jax::Generators::NamedBase
+      class_option :append, :default => false, :type => :boolean,
+                   :desc => "if it already exists, append shaders to the end of this material"
+      class_option :skip_lighting, :default => false, :type => :boolean,
+                   :desc => "do not add the 'Lighting' shader to this material"
+                   
+      def self.desc(description = nil)
+        # TODO This can be removed under future versions of Rails, which use ERB for Usage out of the box.
+        # TODO it would help if one could configure the location of USAGE
+        return super if description
+        usage = source_root && File.expand_path("USAGE", File.dirname(__FILE__))
+
+        @desc ||= if usage && File.exist?(usage)
+          ERB.new(File.read(usage)).result(binding)
+        else
+          super
+        end
+      end
+      
+      def self.all_shaders
+        shaders = []
+        ::Rails.application.assets.each_logical_path do |path|
+          if path =~ /shaders\/(.*)\/manifest.yml/
+            info = (YAML.load(StringIO.new ::Rails.application.assets[path].to_s) || {}).with_indifferent_access
+            info[:name] ||= $1
+            info[:description] ||= ""
+            shaders << info
+          end
+        end
+        shaders.sort { |a,b| a['name'] <=> b['name'] }
+      end
+      
+      def initialize(args = [], options = [], config = {})
+        if args.length > 1
+          super([args.shift], options, config)
+          @shaders = args
+        else
+          super
+          @shaders = []
+        end
+      end
+      
+      def prepend_lighting_shader
+        unless options[:skip_lighting] or shader_selected?('lighting') or File.file?(relative_path)
+          @shaders.unshift 'lighting'
+        end
+      end
+      
+      def create_resource_file
+        template 'material.resource.erb', relative_path unless options[:append] and File.file?(absolute_path)
+      end
+      
+      def append_shaders
+        # first line of array is just array header stuff, we can do without it
+        options = shader_options.to_yaml.lines.to_a[1..-1].collect { |line| "  "+line }.join
+        append_file relative_path, options
+      end
+      
+      protected
+      # tries to find the asset with the given path, returning nil if an error is encountered.
+      def try_find_asset(*path)
+        ::Rails.application.assets[File.join *path]
+      rescue Sprockets::FileOutsidePaths
+        return nil
+      end
+      
+      def shader_options
+        shaders.collect do |shader|
+          asset = try_find_asset("shaders", shader.underscore, "fragment.glsl") ||
+                  try_find_asset("shaders", shader.underscore, "vertex.glsl")
+                  
+          raise ArgumentError, "Couldn't find #{File.join 'shaders', shader.underscore}" unless asset
+          
+          options = { 'type' => shader.camelize }
+          if manifest = try_find_asset("shaders", shader.underscore, "manifest.yml")
+            options.merge!((YAML::load(manifest.to_s) || {})['options'] || {})
+          end
+          
+          options
+        end
+      end
+      
+      def shader_selected?(name)
+        !shaders.select { |shader| shader.underscore == name.underscore }.empty?
+      end
+      
+      def shaders
+        @shaders
+      end
+      
+      def absolute_path
+        File.expand_path relative_path, destination_root
+      end
+      
+      def relative_path
+        File.join material_path, file_name
+      end
+      
+      def material_path
+        File.join "app", "assets", "jax", "resources", "materials"
+      end
+      
+      def file_name
+        super + ".resource"
+      end
+    end
+  end
+end

data/lib/generators/jax/model/model_generator.rb

@@ -0,0 +1,24 @@
+require File.expand_path("../all", File.dirname(__FILE__))
+
+module Jax
+  module Generators
+    class ModelGenerator < Jax::Generators::RailsBase
+      argument :attributes, :type => :array, :default => [], :banner => "field:type field:type"
+      rails_equivalent { (orm = ::Rails::Generators.options[:rails][:orm]) && "#{orm}:model" }
+      
+      def create_model_file
+        coffee_template_with_fallback "model.js",
+          File.join('app/assets/jax/models', "#{file_name}.js")
+      end
+      
+      def create_spec_file
+        coffee_template_with_fallback "model_spec.js",
+          File.join('spec/javascripts/jax/models', "#{file_name}_spec.js")
+      end
+      
+      def create_resource_file
+        template 'model_defaults.resource.erb', File.join("app/assets/jax/resources", file_name.pluralize, "default.resource")
+      end
+    end
+  end
+end

data/lib/generators/jax/plugin/plugin_generator.rb

@@ -0,0 +1,72 @@
+require File.expand_path("../all", File.dirname(__FILE__))
+require 'rest_client'
+
+module Jax
+  module Generators
+    class PluginGenerator < Jax::Generators::NamedBase
+      class_option :local, :type => :boolean, :desc => "Does not connect to the plugin server for any reason",
+                   :default => false
+      include Jax::Generators::PluginBase
+      include Jax::Generators::Actions
+      
+      def check_for_remote_name_conflicts
+        return if options[:local]
+        
+        message = catch :aborted do
+          begin
+            plugins = find_plugin_list get_remote_plugins_matching(name)
+            if plugins.length == 1 && (plugin = plugins.shift)['name'].downcase == name.downcase
+              say "A plugin named '#{name}' would conflict with an existing upstream plugin called '#{plugin['name']}'."
+              prompt_yn "Attempts to publish your plugin will be rejected. Are you sure you wish to proceed?"
+            end
+          rescue RestClient::Exception, Errno::ECONNREFUSED
+            say $!.message
+            say ""
+            say "An error occurred while checking for conflicting plugin names. If"
+            say "a plugin named '#{name}' already exists, you will not be able to"
+            say "publish your plugin until it is renamed."
+            prompt_yn "Do you wish to continue? "
+          end
+          nil
+        end
+        if message
+          say_status :aborted, message, :yellow
+          exit
+        end
+      end
+      
+      def check_for_local_name_conflicts
+        if File.directory? plugin_base_directory
+          message = catch(:aborted) do
+            prompt_yn("'#{name}' conflicts with another installed plugin of the same name. Overwrite?")
+            FileUtils.rm_rf plugin_base_directory
+            say_status :remove, plugin_relative_directory, :green
+            nil
+          end
+          if message
+            say_status :aborted, message, :yellow
+            exit
+          end
+        end
+      end
+      
+      def create_plugin_directory
+        directory "new_plugin", plugin_relative_directory
+      end
+      
+      def create_manifest
+        Jax::Plugin::Manifest.new(name).save
+        say_status :create, File.join("vendor/plugins", name, 'manifest.yml')
+      end
+      
+      private
+      def plugin_relative_directory
+        File.join "vendor/plugins", name
+      end
+      
+      def plugin_base_directory
+        ::Rails.application.root.join(plugin_relative_directory).to_s
+      end
+    end
+  end
+end

data/lib/generators/jax/scaffold/scaffold_generator.rb

@@ -0,0 +1,35 @@
+require File.expand_path("../all", File.dirname(__FILE__))
+
+module Jax
+  module Generators
+    class ScaffoldGenerator < Jax::Generators::RailsBase
+      argument :attributes, :type => :array, :default => [], :banner => "field:type field:type"
+      rails_equivalent { 'scaffold' }
+      
+      def invoke_model_generator
+        ::Rails::Generators.invoke "jax:model", [name] + attributes + option_args,
+                                   :destination_root => destination_root,
+                                   :shell => shell
+      end
+      
+      def invoke_controller_generator
+        ::Rails::Generators.invoke "jax:controller", [name] + option_args,
+                                   :destination_root => destination_root,
+                                   :shell => shell
+      end
+      
+      def invoke_material_generator
+        ::Rails::Generators.invoke "jax:material", [name] + option_args,
+                                   :destination_root => destination_root,
+                                   :shell => shell
+      end
+      
+      protected
+      def option_args
+        [].tap do |args|
+          args << "--without-coffeescript" if options[:without_coffeescript]
+        end
+      end
+    end
+  end
+end

data/lib/generators/jax/shader/shader_generator.rb

@@ -0,0 +1,38 @@
+require File.expand_path("../all", File.dirname(__FILE__))
+require 'rails/generators/rails/model/model_generator'
+
+module Jax
+  module Generators
+    class ShaderGenerator < Jax::Generators::NamedBase
+      def create_common_shader_file
+        template "shader_common.glsl.erb",
+          File.join('app/assets/jax/shaders', file_name, "common.glsl")
+      end
+
+      def create_vertex_shader_file
+        template "shader_vertex.glsl.erb",
+          File.join('app/assets/jax/shaders', file_name, "vertex.glsl")
+      end
+
+      def create_fragment_shader_file
+        template "shader_fragment.glsl.erb",
+          File.join('app/assets/jax/shaders', file_name, "fragment.glsl")
+      end
+      
+      def create_material_file
+        coffee_template_with_fallback "shader_material.js",
+          File.join('app/assets/jax/shaders', file_name, "material.js")
+      end
+      
+      def create_manifest_file
+        template "shader_manifest.yml.erb",
+          File.join('app/assets/jax/shaders', file_name, "manifest.yml")
+      end
+      
+      def create_spec_file
+        coffee_template_with_fallback "shader_spec.js",
+          File.join('spec/javascripts/jax/shaders', "#{file_name}_spec.js")
+      end
+    end
+  end
+end

data/lib/jax/commands/plugin_manager.rb

@@ -0,0 +1,240 @@
+require File.expand_path("../../generators/jax/all", File.dirname(__FILE__))
+require 'rest_client'
+
+module Jax
+  class PluginManager < Thor
+    include Jax::Util::Tar
+    include Thor::Actions
+    include Jax::Generators::PluginBase
+    include Jax::Generators::Actions
+    
+    desc "install NAME [NAME2...]", "Installs the named plugin from the plugin repository"
+    long_desc "Searches for a plugin by the specified name and installs it. The "   \
+              "search is case-insensitive. If an exact match (other than case) is " \
+              "found, the matching plugin will be installed. Otherwise, a list of " \
+              "potential matches will be shown, and you will be prompted with a "   \
+              "selection."
+    method_option :version, :type => :string, :default => false, :aliases => '-v',
+                  :desc => "The exact version to install. If not given, the latest will be used."
+    def install(name, *other_names)
+      catch(:complete) do
+        message = catch(:aborted) do
+          list = matching_plugins(name)
+          if list.empty?
+            raise "No plugin names match or begin with the text '#{name}'."
+          elsif list.length == 1
+            if list[0]['name'] != name
+              prompt_yn "Plugin '#{name}' was not found, but '#{list[0]['name']}' was. Install it instead?"
+            end
+            install_plugin list[0]
+          else
+            say "No plugin was found with the name '#{name}', but the following candidates were found:"
+            menu list.collect { |c| c['name'] } do |selected_name, selected_index|
+              install_plugin list[selected_index]
+            end
+          end
+          throw :complete
+        end
+        say_status :aborted, message, :yellow
+        return # cancel any additional plugins if this one was aborted
+      end
+      
+      install *other_names unless other_names.empty?
+    end
+    
+    desc "uninstall NAME", "Removes the named plugin from this application"
+    long_desc "Removes the plugin with the given name from this application."
+    def uninstall(name)
+      catch :complete do
+        message = catch :aborted do
+          plugin_path = ::Rails.application.root.join("vendor/plugins/#{name}")
+          if File.exist?(plugin_path.to_s)
+            uninstall_plugin name, plugin_path
+          else
+            # see if it's a partial name
+            matches = search installed_plugins, name
+            throw :aborted, "Plugin '#{name}' does not seem to be installed." if matches.empty?
+
+            if matches.length == 1 && match = matches.shift
+              prompt_yn "Plugin '#{name}' is not installed, but '#{match[0]}' was. Delete it instead?"
+              uninstall_plugin *match
+            else
+              say "Plugin '#{name}' is not installed, but the following partial matches are:"
+              menu matches.keys.sort, :allow_all => true do |name,index|
+                uninstall_plugin name, matches[name]
+              end
+            end
+          end
+
+          throw :complete
+        end
+        
+        say_status :aborted, message, :yellow
+      end
+    end
+    
+    desc "push", "Pushes this plugin to the repository, making it available to other people"
+    long_desc "Releases the plugin to the plugin repository. If you do not have an "   \
+              "account, you will be prompted to create one. The name of the plugin "   \
+              "must be unique."
+    def push
+      if destination_root =~ /^#{Regexp::escape ::Rails.application.root.join("vendor/plugins").to_s}\/?([^\/]+)(\/|$)/
+        plugin_name = $1
+        plugin_dir = ::Rails.application.root.join("vendor/plugins", plugin_name)
+        manifest = plugin_dir.join("manifest.yml").to_s
+        if File.exist? manifest
+          manifest = Jax::Plugin::Manifest.find(plugin_name)
+          if manifest.description.blank?
+            say "Please enter a plugin description in the manifest.yml file"
+          else
+            publish_plugin manifest
+          end
+        else
+          say "Plugin manifest is missing!"
+          say "A default manifest file will be written. Please modify "
+          say "this file before continuing."
+          say ""
+          Jax::Plugin::Manifest.new(plugin_name).save
+          say_status :created, "manifest.yml", :green
+        end
+      else
+        say_status :aborted, "Please run this script from within a plugin directory.", :red
+      end
+    end
+    
+    desc "list [NAME]", "Lists all plugins, or searches for a plugin by the specified name"
+    long_desc "Lists all plugins, or searches for a plugin that starts with the specified name."
+    method_option :detailed, :type => :boolean, :default => false,
+                  :desc => "Lists the plugins with detailed multiline descriptions."
+    method_option :local, :type => :boolean, :default => false,
+                  :desc => "Lists only plugins that are currently installed."
+    def list(name = nil)
+      if options[:local] && matching_plugins(name).empty?
+        say_status :missing, "There do not seem to be any plugins installed for this application."
+        return
+      else
+        each_plugin(name) do |plugin|
+          name, description = plugin['name'], plugin['description']
+
+          if options[:detailed]
+            say name
+            say "  #{description}"
+            say ""
+          else
+            if description.length > 60
+              description = description[0...57] + "..."
+            end
+            say "#{name.ljust 19} #{description}"
+          end
+        end
+      end
+      say ""
+    end
+    
+    def self.source_root
+      File.expand_path("../../../../templates", File.dirname(__FILE__))
+    end
+
+    protected
+    def publish_plugin(manifest)
+      credentials = Jax::Plugin::Credentials.new(:shell => shell)
+      api_key = credentials.api_key
+      plugin_filename = "#{manifest.name}-#{manifest.version}.tgz"
+      targz = gzip(tar ::Rails.application.root.join("vendor/plugins", manifest.name).to_s)
+      
+      # This is probably bad practice, but it just
+      # seems so silly to create a whole new subclass
+      # just for one accessor
+      class << targz; attr_accessor :path; end
+      targz.path = plugin_filename
+
+      plugin = {
+        :single_access_token => api_key,
+        :plugin => {
+          :name => manifest.name,
+          :description => manifest.description,
+          :version => manifest.version,
+          :stream => targz
+        }
+      }
+      
+      begin
+        res = Hash.from_xml(credentials.plugins.post plugin).with_indifferent_access
+        if res && res[:hash] && !res[:hash][:error].blank?
+          say_status :error, res[:hash][:error], :red
+        else
+          say_status :done, "Plugin #{plugin_filename} published", :green
+        end
+      rescue RestClient::RequestFailed
+        res = Hash.from_xml($!.http_body)
+        if error = res['hash'] && res['hash']['error']
+          say_status :error, error, :red
+        else
+          say_status :error, "A server-side error has occurred.", :red
+        end
+      end
+    end
+    
+    def uninstall_plugin(name, plugin_path)
+      run_uninstall_script plugin_path
+      FileUtils.rm_rf plugin_path
+      say_status :complete, "Plugin '#{name}' has been removed.", :green
+    end
+    
+    def install_plugin(details)
+      name, version = details['name'], plugin_version(details)
+      plugin_dir = ::Rails.application.root.join("vendor/plugins/#{name}")
+      overwrite plugin_dir
+
+      tarfile = download_tgz(name, version)
+      untar ungzip(tarfile), plugin_dir
+      run_install_script plugin_dir
+      
+      save_manifest plugin_dir, details unless File.exist?(File.join(plugin_dir, "manifest.yml"))
+      
+      say_status :installed, "#{plugin_dir} -v=#{version}", :green
+    end
+    
+    def save_manifest(plugin_dir, details)
+      # collect necessary details
+      details = details.inject({}) do |hash,(k,v)|
+        case k.to_s
+        when 'name', 'description', 'version' then hash[k.to_s] = v
+        when 'releases' then
+          version = v.last['version']
+          hash['version'] = version if hash['version'].blank? || hash['version'] < version
+        end
+        hash
+      end
+      
+      File.open(File.join(plugin_dir, "manifest.yml"), "w") do |f|
+        f.print details.to_yaml
+      end
+    end
+    
+    def run_uninstall_script(plugin_dir)
+      run_script plugin_dir, "uninstall.rb"
+    end
+    
+    def run_script(plugin_dir, script_filename)
+      script = File.join(plugin_dir, script_filename)
+      load script if File.exist? script
+    end
+    
+    def run_install_script(plugin_dir)
+      run_script plugin_dir, "install.rb"
+    end
+    
+    def download_tgz(name, version)
+      filename = "#{name}-#{version}.tgz"
+      tgz = rest_resource("plugins/#{name}.tgz").get(:params => { :version => version })
+      StringIO.new tgz
+    end
+    
+    class << self
+      def basename
+        "jax plugin"
+      end
+    end
+  end
+end

data/lib/jax/commands.rb

@@ -0,0 +1,69 @@
+# Required by script/jax in a Jax (non-Rails) project.
+require 'jax'
+
+module Jax
+  module Commands
+    class << self
+      def setup_generator_invocation
+        require APP_PATH
+        require 'rails/generators'
+        Dir.chdir(::Rails.application.root)
+        
+        def (::Rails::Generators::Base).banner
+         "jax generate #{namespace.sub(/^jax:/,'')} #{self.arguments.map{ |a| a.usage }.join(' ')} [options]".gsub(/\s+/, ' ')
+        end
+
+        ::Rails.application.initialize!
+      end
+      
+      def invoke_jax_generator(name, args, options = {})
+        ::Rails::Generators.invoke name, args, options
+      end
+      
+      def invoke!(*args)
+        case command = args.shift
+          when 'package'
+            puts "The `jax package` command has been deprecated."
+            puts
+            puts "Please run this command instead:"
+            puts
+            puts "    rake assets:precompile"
+            puts
+          when 'g', 'generate'
+            setup_generator_invocation
+            invoke_jax_generator args.shift, args
+          when 'destroy'
+            setup_generator_invocation
+            invoke_jax_generator args.shift, args, :behavior => :revoke
+          when 'server'
+            Jax::Server.new(*args).tap do |server|
+              require APP_PATH
+              Dir.chdir(::Rails.application.root)
+              server.start
+            end
+          when NilClass # no args given
+            usage
+          else
+            raise ArgumentError, "Command not recognized: #{command.inspect}"
+        end
+      end
+      
+      def usage
+        puts "Jax version #{Jax::Version::STRING}"
+        puts
+        puts "Usage:"
+        puts "  jax server        - start development server"
+        puts "  jax generate      - list all available generators"
+        puts "  jax generate NAME - invoke a generator"
+        puts
+      end
+    end
+  end
+end
+
+begin
+  Jax::Commands.invoke! *ARGV
+rescue ArgumentError => err
+  puts err.message
+end
+