opal 0.2.2 → 0.3.0

data/lib/opal/opalfile/task.rb

@@ -1,96 +0,0 @@
-# 
-# task.rb
-# vienna
-# 
-# Created by Adam Beynon.
-# Copyright 2010 Adam Beynon.
-#
-# Permission is hereby granted, free of charge, to any person obtaining a copy
-# of this software and associated documentation files (the "Software"), to deal
-# in the Software without restriction, including without limitation the rights
-# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-# copies of the Software, and to permit persons to whom the Software is
-# furnished to do so, subject to the following conditions:
-# 
-# The above copyright notice and this permission notice shall be included in
-# all copies or substantial portions of the Software.
-# 
-# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
-# THE SOFTWARE.
-#
-
-module Vienna
-  
-  class Opalfile::Task
-    
-    # action for task
-    attr_accessor :action, :prerequisites
-    
-    def initialize(task_name, opalfile)
-      @task_name = task_name
-      @prerequisites = []
-      @opalfile = opalfile
-      @action = nil
-      @description = nil
-      @scope = opalfile.current_scope
-      @invoke_count = 0
-    end
-    
-    def invoke_with_call_array(invocation_array, task_scope_instance)
-      # puts "invoking #{@task_name}"
-      @task_scope = task_scope_instance
-      # puts "\n##### #@task_name #{self}\n"
-      unless invocation_array.include? @task_name
-        # puts "||||| #{@task_name} actually running"
-        invocation_array << @task_name
-        
-        invocation_array = invoke_prerequisites invocation_array
-        @invoke_count += 1
-        execute(task_scope_instance)
-      
-      else
-        # puts "!!!!! #@task_name already run this task"
-      end
-      # puts "~~~~~ Finished #@task_name\n\n"
-      invocation_array
-    end
-    
-    def invoke(task_scope_instance)
-      invoke_with_call_array [], task_scope_instance
-    end
-    
-    def invoke_prerequisites(invocation_array)
-      @prerequisites.each do |pre|
-        
-        ctx = Vienna::TaskScope.new
-        ctx.opalfile = @task_scope.opalfile
-        ctx.task_variables = @task_scope.task_variables
-        
-        task = @task_scope.opalfile[pre, @scope]
-        
-        @opalfile.task_scope_stack << ctx
-        
-        invocation_array = task.invoke_with_call_array(invocation_array, ctx)
-      end
-      invocation_array
-    end
-    
-    def execute(task_scope_instance)
-      if @action
-        task_scope_instance.instance_eval(&@action)
-      else
-        # puts "no action to run."
-      end
-    end
-    
-    def to_s
-      "#<Task name=#@task_name, scope=#@scope prereq=#{@prerequisites.inspect}>"
-    end
-    
-  end
-end

data/lib/opal/opalfile/task_manager.rb

@@ -1,63 +0,0 @@
-# 
-# task_manager.rb
-# vienna
-# 
-# Created by Adam Beynon.
-# Copyright 2010 Adam Beynon.
-#
-# Permission is hereby granted, free of charge, to any person obtaining a copy
-# of this software and associated documentation files (the "Software"), to deal
-# in the Software without restriction, including without limitation the rights
-# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-# copies of the Software, and to permit persons to whom the Software is
-# furnished to do so, subject to the following conditions:
-# 
-# The above copyright notice and this permission notice shall be included in
-# all copies or substantial portions of the Software.
-# 
-# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
-# THE SOFTWARE.
-#
-
-module Vienna
-  
-  class Opalfile
-    
-    def define_task task_name, &block
-      if task_name.is_a? Hash
-        name = task_name.keys.first
-        dep = task_name[name]
-      else
-        name = task_name
-        dep = []
-      end
-      
-      full_name = @namespace_scope.dup.push(name) * ":"
-      
-      # musrt assign new task to avoid overriding task meaning in other 
-      # opalfiles
-      task = (@tasks[full_name] = Task.new full_name, self)
-      task.action = block
-      task.prerequisites = dep
-      
-      @last_desc = nil
-    end
-    
-    def current_scope
-      @namespace_scope * ":"
-    end
-    
-    def define_namespace(name)
-      # puts "in new namespace #{name}"
-      @namespace_scope.push name
-      yield
-      @namespace_scope.pop
-    end
-    
-  end
-end

data/lib/opal/opalfile/task_scope.rb

@@ -1,52 +0,0 @@
-# 
-# task_scope.rb
-# vienna
-# 
-# Created by Adam Beynon.
-# Copyright 2010 Adam Beynon.
-#
-# Permission is hereby granted, free of charge, to any person obtaining a copy
-# of this software and associated documentation files (the "Software"), to deal
-# in the Software without restriction, including without limitation the rights
-# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-# copies of the Software, and to permit persons to whom the Software is
-# furnished to do so, subject to the following conditions:
-# 
-# The above copyright notice and this permission notice shall be included in
-# all copies or substantial portions of the Software.
-# 
-# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
-# THE SOFTWARE.
-#
-
-module Vienna
-  
-  # When we call each task, we instance_eval it into a scope so we can set
-  # various constants on that scope without effecing anything else....
-  # TaskScope is that context
-  class TaskScope
-    
-    # access the task variables: hash of names => values
-    attr_reader :task_variables
-    
-    # to maintain the righe opalfile for the current scope. The Task's actual
-    # opalfile might have some taks soverridden, so we cannot rely on using that
-    # opalfile to get prerequirement tasks. This task scope keeps us in the 
-    # correct scope.
-    attr_accessor :opalfile
-    
-    # custom setter. Actually set all variables in scope also
-    def task_variables=(task_variables)
-      @task_variables = task_variables
-      
-      task_variables.each do |key, value|
-        instance_variable_set "@#{key}", value
-      end
-    end
-  end
-end

data/lib/opal/rack/app_server.rb

@@ -1,119 +0,0 @@
-# 
-# app_server.rb
-# vienna
-# 
-# Created by Adam Beynon.
-# Copyright 2010 Adam Beynon.
-#
-# Permission is hereby granted, free of charge, to any person obtaining a copy
-# of this software and associated documentation files (the "Software"), to deal
-# in the Software without restriction, including without limitation the rights
-# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-# copies of the Software, and to permit persons to whom the Software is
-# furnished to do so, subject to the following conditions:
-# 
-# The above copyright notice and this permission notice shall be included in
-# all copies or substantial portions of the Software.
-# 
-# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
-# THE SOFTWARE.
-#
-
-require 'pp'
-
-module Vienna
-  
-  # App server for any opal project (single project)
-  class AppServer
-    
-    attr_accessor :project
-    
-    def initialize(project)
-      # we need rack
-      begin
-        require 'rack'
-      rescue LoadError
-        require 'rubygems'
-        require 'rack'
-      end
-      
-      @project = project
-      
-      # hash of paths => procs to return their result
-      @paths = {}
-      
-      # we need to reload/rebuild our project!
-      path '/', '/index.html' do
-        # we need to rebuild, so do that
-        rebuild!
-        # simply return /index.html from the project_dir (once built)
-        file '/index.html'
-      end
-      
-      # lets just return something to avoid missing file error
-      path '/favicon.ico' do
-        [200, {"Content-Type" => ::Rack::Mime.mime_type(File.extname('/favicon.ico'), 'text/plain')}, ""]
-      end
-      
-      port = 3030
-      puts "Starting server on port #{port}"
-      ::Rack::Handler::Mongrel.run self, :Port => port
-    end
-    
-    # Rebuild our project
-    def rebuild!
-      @project.build!
-    end
-    
-    # Project root/path
-    def project_root
-      @project_root ||= @project.project_root
-    end
-    
-    # We map the full given path to the given action. Whenever a request for the
-    # given path is received, we run the given action and return the result.
-    # 
-    # @param {String} path to resource - can take multiple strings
-    # @param {Proc} action to run and respond with
-    # 
-    def path(*path, &action)
-      path.each do |path|
-        # puts "need to map path: #{path}"
-        @paths[path] = action
-      end
-    end
-    
-    # Returns the content of the file, or method missing if it does not exist
-    def file(local_path)
-      path = File.join(project_root, local_path)
-      
-      if File.exist? path
-        [200, {"Content-Type" => ::Rack::Mime.mime_type(File.extname(path), 'text/plain')}, File.read(path)]
-      else
-        raise "file doest exist: #{path}"
-      end
-    end
-    
-    def call(env)
-      # @env = env
-      # pp env
-      request_path = env['REQUEST_PATH']
-      
-      puts "accessing #{request_path}"
-      
-      action = @paths[request_path]
-      
-      if action
-        # puts "we have an action! #{request_path}"
-        action.call
-      else
-        file request_path
-      end      
-    end
-  end
-end

data/lib/opal/rake/opal_task.rb

@@ -1,34 +0,0 @@
-require 'rake'
-require 'rake/tasklib'
-
-module Opal
-  module Rake
-    
-    class OpalTask < ::Rake::TaskLib
-      
-      attr_accessor :source
-      
-      attr_accessor :destination
-      
-      attr_accessor :options
-      
-      def initialize(name = :opal)
-        @name = name
-        @options = []
-        @source = []
-        @destination = []
-        yield self if block_given?
-        
-        define_rake_task
-      end
-      
-      def define_rake_task
-        desc "Build opal files"
-        task(@name) do
-          puts "running opal build task"
-          Opal.build!(([@source] + [@destination] + [@options]).flatten)
-        end
-      end
-    end
-  end
-end

data/opals/opal/README.md

@@ -1,37 +0,0 @@
-Opal: Ruby compiler/runtime for the browser
-=============================================
-
-### NOTE: opal has been renamed from vienna. Vienna is now just a code name for the build tools
-
-Opal is the runtime/standard lib for ruby in the browser.
-
-Installing
------------
-
-    # Insall gem from gemcutter/rubygems
-    sudo gem install opal
-
-Trying out
-----------
-To make a test project, use the following command where project_name is the name of the project to use.
-
-    # make the project
-    opal new project_name
-    # jump into the project
-    cd project_name
-
-The project also creates a Rakefile with an 'opal' task. Run this task, and then opal will continuously watch your ruby file for changes, and then recompile it everytime you change the code.
-
-    rake opal
-
-Open index.html in the browser to run the project.
-
-Next steps
-----------
-
-Opal has many of the libraries built. Check out the documentation (more coming soon), ask me questions on freenode (adambeynon): usually in #ruby, #ruby-lang, #javascript etc, or email me: adam.beynon@me.com.
-
-Command line tools / v8
------------------------
-
-I am playing with experimental support for therubyracer. Essentially, this gem allows you to embed the v8 javascript engine into ruby applications. Vienna has support for this allowing, firstly, a REPL system for trying out commands, but more importantly/interestingly, can run an entire opal application through the engine. The compilation step is not necessary as ruby files are compiled as they are required. For now, all specs are by default run through this system. Node, *nix (unix/linux) only, no windows support for opal command line.

data/opals/opal/browser/Opalfile

@@ -1,11 +0,0 @@
-mode :all do
-  config :browser,
-    :required => [:opal]
-end
-
-mode :spec do
-  config :browser,
-    
-    :lib_directories    => ['lib', 'spec'],
-    :bin_file           => :spec
-end

data/opals/opal/browser/README.md

@@ -1,146 +0,0 @@
-# Browser
-
-## Getting Started
-
-To build/run a browser project, you only require two files: the html file used to load the ruby, and a ruby source file with your application code. By default the build tools will look in a `lib/` directory for your sources, so for simplicity sakes we will use that directory for our code. Also, by default the base-name for the directory is used for loading the main ruby file.
-
-### Project Directory Structure
-
-Create the following files/directories for our "browser_test" project:
-
-    !!!plain
-    browser_test/
-      index.html
-      lib/
-        browser_test.rb
-
-With the new fresh project, the build tools need to be run in the project root, so jump into the browser_test directory.
-
-    !!!plain
-    cd path/to/browser_test
-
-### HTML file
-
-Out html file simply needs to require the resulting javascript file from our build tools, which (by default) has the same name as our project, so edit index.html to contain the following simple HTML5 document.
-    
-    !!!plain
-    <!DOCTYPE html>
-    <html>
-      <head>
-        <script src="javascripts/browser_test.js"></script>
-      </head>
-    </html>
-
-### Hello, World!
-
-For a very simple program, "Hello world" seems appropriate. Change the contents of the browser_test.rb file to the following:
-
-    puts "Hello, World!"
-    
-This, of course, is very simple ruby. We now need to use the build tools to build the project. This is simply done by running the following command in our root directory:
-
-    !!!plain
-    vn-build
-
-The build tool will then generate our `javascripts/browser_test.js` file, which is loaded by our HTML document in the browser. Our generated javascript file also contains the runtime needed (which includes the ruby implementation, the core library, and the browser opal).
-
-In any browser with a console (Firefox, Chrome, Safari, IE8 etc), open the HTML document and you will see the message in the console output:
-
-    "Hello, World!"
-    
-## Browser API
-
-### Document
-
-The `Document` module represents the common `document` object in javascript. Its functionality is extended beyond the javascript offering to add common features found in javascript frameworks.
-
-#### Document.ready?
-
-Ruby code in opal begins running as soon as the source file downloads. This may mean that the document is not yet ready to be manipulated. This method takes a block (or many blocks) that will be executed when the document is ready. Placing code in here ensures that it will not be run before the document can be manipulated, which is sure to yield errors. Place the following code in the browser_test.rb file.
-
-    puts "this should run first"
-    
-    Document.ready? do
-      puts "this should run third"
-    end
-    
-    puts "this should run second"
-
-Rebuild the project (`vn-build`) and refresh the html page in your browser. You should observe the console results in the following order:
-
-    "this should run first"
-    "this should run second"
-    "this should run third"
-    
-The puts statement in the block runs third because it is only then that the document is ready. Placing DOM manipulation code, or event handlers inside this `ready?` statement is recommended.
-
-`Document#ready?` can also be called without a block, which simply returns a boolean whether the document is now ready or not.
-
-    Document.ready?   # => false
-    
-    Document.ready? do
-      Document.ready? # => true
-    end
-    
-    Document.ready?   # => false
-    
-#### Document.[]
-
-This method is used for searching for selectors in the DOM. Every {Element} instance has a `[]` method, which uses itself as the context. For the document, the document itself is the context. This method takes either a string or symbol. In the case of a symbol, the document is searched for an element whose id matches the symbol name, or `nil` if an element with that id cannot be found.
-    
-    !!!plain
-    <div id="foo"></div>
-    <div id="bar"></div>
-    
-The above example would produce the following results:
-
-    Document[:foo]
-    # => #<Element div, id="foo">
-    
-    Document [:baz]
-    # => nil
-
-The returned element is an instance of the {Element} class.
-
-The second case, for a string, either returns a single element if the selector is for an id, or returns an array for any other selector type. Looking for an id will take the form `#element_id`. The hash indicates an id. As above, if the elements cannot be found, then `nil` is returned.
-
-HTML:
-
-    !!!plain
-    <div id="foo" class="a"></div>
-    <div class="b"></div>
-    <div class="a"></div>
-
-Ruby:
-    
-    Document['#foo']
-    # => #<Element div, id="foo", class="a">
-    Document['#bar']
-    # => nil
-    Document['.a']
-    # => [#<Element div, id="foo", class="a">, #<Element div, class="a">]
-    Document['.b']
-    # => [#<Element div, class="b">]
-    Document['.c']
-    # => nil
-
-## Implementation
-
-This section discusses the low level implementation details for dealing with the opal runtime. Every class in the browser opal uses pure opal class instances and object instances. No native objects (elements, xmlhttprequests) are accessible from the ruby. Due to cross browser differences, relying on adding opal methods to these natives causes issues, so all references to object's native counterparts are stored purely as an instance variable on the ruby object, so that no addition properties can affect different browser implementations.
-
-### Document
-
-The {Document} module has a private instance variable called `__element__` which points to the javascript `document` object.
-
-### Window
-
-The {Window} module also has a private instance variable called `__element__` which point to the native `window` object.
-
-### Element
-
-Every {Element} instance has a private instance variable called `__element__` which points to the native javascript element that this ruby object represents. To create an {Element} instance with a native element, the class method {Element.from_native} is used, and the native element is passed as a parameter. The result is an instance, with the element set as the private `__element__` variable.
-
-### Event
-
-Every {Event} instance wraps a native event with a private variable `__event__`. To create an Opal event from a native event, the {Event.from_native} method should be used, which returns a new instance of the {Event} class.
-