js2 0.1.7 → 0.1.8

data/CHANGELOG

@@ -1,3 +1,7 @@
+## Version 0.1.8
+* Adding JS2.Observable module to boostrap
+* Fixed "STR2CSTR" bug when used in Ruby 1.9.x
+
 ## Version 0.1.7
 * Support for Ruby 1.9.x
 

data/README.md

@@ -1,65 +1,75 @@
-* [Features](http://github.com/jeffsu/js2/blob/master/wiki/features.md) (simple documentation)
-* [Installation](http://github.com/jeffsu/js2/blob/master/wiki/installation.md)
-* [Source Code](http://github.com/jeffsu/js2)
-
-## OO Javascript
-
-For every Javascript developer that has ever wanted to create a library for his/her project, there comes a time when an Object Oriented approach is necessary (or extremely desired). Fortunately, there are a plethora of options to choose from:
+[JS2](http://github.com/jeffsu/js2) - Friendly Cross Browser Object Oriented Javascript
+=======================================================================================
 
->     using prototype (not the framework) and hashes:
->       var MyClass = function () {
->         this.member1 = "member";
->       };
->       MyClass.prototype = {
->         method1: function () { alert('method1 called'); }
->       }
->     embedding functions right in the instantiator:
->       function MyClass () {
->         this.member1 = "member1";
->         function method1 () {
->            alert("method1 called");
->         }
->       }
->     using jQuery (or any of the js OO frameworks) by passing in hashes:
->       var MyClass = Class.create({
->           member1: "member1",
->           method1: function(){ alert("method1 called") },
->       });
-Unfortunately, these solutions are dissimilar to Java, Ruby, and C-based languages.
+JS2 is a way to write classes in a more familiar way for programmers who are used to syntax in languages such as: Java, Ruby, C++, etc...
+The main motivation is to provide a clean and a less verbose syntax for creating classes, inheritance and modules in Javascript.  JS2 plays
+nicely with most of the popular frameworks including: jQuery and prototype.  It also provides some syntactic sugar on the repetative aspects
+of Javascript.
 
-## JS2 Solution
+Sample Syntax:
+    class Rectangle {
+      property height;
+      property width;
+    
+      function area () {
+        return this.height * this.width;
+      }
+    }
+    
+    class Square extends Rectangle {
+      function area () {
+        return this.width * this.width;
+      }
+    }
+    
+    var s = new Square();
 
-JS2 language that is a superset of Javascript and the problem it tries to solve is bringing "natural" OO syntax to Javascript by adding a compilation layer.
+* [Installation](http://github.com/jeffsu/js2/blob/master/wiki/installation.md)
+* [Language Features and Examples](http://github.com/jeffsu/js2/blob/master/wiki/features.md)
+* [Compiler Features](http://github.com/jeffsu/js2/blob/master/wiki/compiler.md)
+* [Source](http://github.com/jeffsu/js2)
 
-So in myClass.js2 one could write:
+Things You need to run JS2
+--------------------------
+* Ruby - language used to parse js2 and generate javascript
+* Ruby Gems - ruby package manager
+  * js2
+  * RubyInline
+  * haml (optional)
 
-    class MyClass {
-      var member1 = "member1";
+Quick Start Guide
+-----------------
+Create a js2 file (foo.js2):
+    class Person {
+      function speak() {
+        alert("Hello! I'm a person!");
+      }
 
-      function method1 () {
-         alert("method1 called");
+      function walk() {
+        alert("Walking!");
       }
     }
 
-And after compilation myClass.js (notice the .js extension vs the .js2) would be:
-
-    var MyClass = function () { };
-    MyClass.prototype = {
-      member1: "member1",
-      method1: function () { alert("method1 called"); }
+    class Student extends Person {
+      function speak() {
+        alert("Hello, I'm a student!");
+      }
     }
 
-One of the nice things about this solution is that it allows us to "calculate" things like mixins and inheritance at compile time rather than runtime. This compilation layer opens the doors for features such as:
+    var person  = new Person();
+    var student = new Student();
+
+    person.speak();
+    student.speak();
+    person.walk();
+    student.walk();
 
-* Inheritance
-* Mixins (Ruby's multiple inheritance solution)
-* getters and setters
-* IoC (Dependency Injection)
-* AOP (Aspect Oriented Programming)
-* foreach
-* currying
-* More Features
+Run js2 in the same directory
+    js2 compile
 
-## Inspiration
+You should now see these files in that directory:
+* foo.js2
+* foo.js
+* js2bootstrap.js
 
-HAML, SASS, Ruby, Perl, jQuery, Prototype.js
+Include these js2bootstrap.js and foo.js (make sure js2bootstrap.js is included first) in your html page.

data/Rakefile

@@ -2,9 +2,10 @@ require 'rubygems'
 require 'rake'
 require 'echoe'
 
-JS2_VERSION = '0.1.7'
+JS2_VERSION = '0.1.8'
 Echoe.new('js2', JS2_VERSION) do |p|
-  p.description    = ""
+  p.summary        = "Cross-Browser Object Oriented Javascript Compiler"
+  p.description    = "Cross-Browser Object Oriented Javascript Compiler"
   p.url            = "http://github.com/jeffsu/js2"
   p.author         = "Jeff Su"
   p.email          = "me@jeffsu.com"
@@ -16,7 +17,7 @@ end
 
 namespace :js2 do
   task :compile do
-    system("pushd lib/js2/ragel/; ruby helper.rb; ragel -C tokenizer.rl; mv tokenizer.c ../parser/tokenizer.rb")
+    system("cd ./lib/js2/ragel/; ruby helper.rb; ragel -C tokenizer.rl; mv tokenizer.c ../parser/tokenizer.rb")
   end
 
   task :install do

data/js2.gemspec

@@ -2,13 +2,13 @@
 
 Gem::Specification.new do |s|
   s.name = %q{js2}
-  s.version = "0.1.7"
+  s.version = "0.1.8"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 1.2") if s.respond_to? :required_rubygems_version=
   s.authors = ["Jeff Su"]
-  s.date = %q{2010-10-08}
+  s.date = %q{2010-10-21}
   s.default_executable = %q{js2}
-  s.description = %q{}
+  s.description = %q{Cross-Browser Object Oriented Javascript Compiler}
   s.email = %q{me@jeffsu.com}
   s.executables = ["js2"]
   s.extra_rdoc_files = ["README.md", "CHANGELOG", "bin/js2", "lib/js2.rb", "lib/js2/parser/haml.rb", "lib/js2/parser/haml_engine.rb", "lib/js2/parser/lexer.rb", "lib/js2/parser/tokenizer.rb", "lib/js2/ragel/helper.rb", "lib/js2/ragel/tokenizer.rl", "lib/js2/ragel/tokenizer.rl.erb", "lib/js2/standard/class_node.rb", "lib/js2/standard/factory.rb", "lib/js2/standard/node.rb", "lib/js2/util/compilation.rb", "lib/js2/util/config.rb", "lib/js2/util/exec.rb", "lib/js2/util/file_handler.rb", "lib/js2/util/js2bootstrap.js2", "lib/js2/util/processor.rb", "lib/js2/util/rdoc.rb", "lib/js2/util/sel_decorator.rb", "lib/js2/util/haml_filter.rb", "lib/js2/util/jamis.rb"]
@@ -18,7 +18,7 @@ Gem::Specification.new do |s|
   s.require_paths = ["lib"]
   s.rubyforge_project = %q{js2}
   s.rubygems_version = %q{1.3.7}
-  s.summary = %q{}
+  s.summary = %q{Cross-Browser Object Oriented Javascript Compiler}
   s.test_files = ["test/test_js2.rb", "test/test_helper.rb"]
 
   if s.respond_to? :specification_version then

data/lib/js2/parser/tokenizer.rb

@@ -21,7 +21,7 @@ class JS2::Parser::Tokenizer
       // convert ruby string to char*
       VALUE r_str     = argv[0];
       int data_length = #{RUBY_VERSION.match(/^1\.8/) ? "RSTRING(r_str)->len" : "RSTRING_LEN(r_str)"};
-      char* data      = STR2CSTR(r_str);
+      char* data      = StringValuePtr(r_str);
 
       int in_class  = 0;
       int in_module = 0;
@@ -2498,7 +2498,7 @@ _resume:
 	while ( _nacts-- > 0 ) {
 		switch ( *_acts++ ) {
 	case 6:
-#line 1 "tokenizer.rl"
+#line 1 "NONE"
 	{ts = p;}
 	break;
 #line 2505 "tokenizer.c"
@@ -2592,7 +2592,7 @@ _eof_trans:
 	{regexp_start = p;}
 	break;
 	case 7:
-#line 1 "tokenizer.rl"
+#line 1 "NONE"
 	{te = p+1;}
 	break;
 	case 8:
@@ -3392,7 +3392,7 @@ _eof_trans:
     }}
 	break;
 	case 139:
-#line 1 "tokenizer.rl"
+#line 1 "NONE"
 	{	switch( act ) {
 	case 1:
 	{{p = ((te))-1;} 
@@ -3495,7 +3495,7 @@ _again:
 	while ( _nacts-- > 0 ) {
 		switch ( *_acts++ ) {
 	case 5:
-#line 1 "tokenizer.rl"
+#line 1 "NONE"
 	{ts = 0;}
 	break;
 #line 3502 "tokenizer.c"

data/lib/js2/ragel/tokenizer.rl

@@ -434,8 +434,8 @@ class JS2::Parser::Tokenizer
     int tokenize (int argc, VALUE *argv, VALUE self) {
       // convert ruby string to char*
       VALUE r_str     = argv[0];
-      int data_length = RSTRING(r_str)->len;
-      char* data      = STR2CSTR(r_str);
+      int data_length = #{RUBY_VERSION.match(/^1\.8/) ? "RSTRING(r_str)->len" : "RSTRING_LEN(r_str)"};
+      char* data      = StringValuePtr(r_str);
 
       int in_class  = 0;
       int in_module = 0;

data/lib/js2/ragel/tokenizer.rl.erb

@@ -257,7 +257,7 @@ class JS2::Parser::Tokenizer
       // convert ruby string to char*
       VALUE r_str     = argv[0];
       int data_length = #{RUBY_VERSION.match(/^1\.8/) ? "RSTRING(r_str)->len" : "RSTRING_LEN(r_str)"};
-      char* data      = STR2CSTR(r_str);
+      char* data      = StringValuePtr(r_str);
 
       int in_class  = 0;
       int in_module = 0;

data/lib/js2/util/js2bootstrap.js2

@@ -399,3 +399,50 @@ class JS2.App.JQuery extends JS2.App {
   }
 }
 
+module JS2.Observable {
+  function addListener (namespace, funct) {
+    this._initializeObservable(namespace);
+
+    var id    = this._listenerCount++;
+    var chain = this._listeners[namespace];
+    var index = chain.length;
+    var info  = [ funct, id, namespace ];
+
+    this._listenerLookup[id.toString()] = info;
+    chain.push(info);
+  }
+
+  function trigger () {
+    if (! this._listeners) return;
+
+    var namespace = arguments[0];
+    var chain = this._listeners[namespace];
+    if (! chain) return;
+
+    var args = [];
+    for (var i=1; i<arguments.length; i++) {
+      args.push(arguments[i]);
+    }
+
+    if (chain) {
+      foreach (var ele in chain) {
+        ele[0].apply(this, args);
+      }
+    }
+  }
+
+  private
+
+  function _initializeObservable (namespace) {
+    if (! this._listeners) {
+      this._listeners      = {};
+      this._listenerLookup = {};
+      this._listenerCount  = 1;
+    }
+
+    if (! this._listeners[namespace]) {
+      this._listeners[namespace] = [];
+    }
+  }
+}
+

data/wiki/features.md

@@ -1,106 +1,73 @@
-## Object Oriented
-
-### Class Definition
-
->     class Foo {
->       function method () {
->       }
->     }
-
-### Inheritance
-
->     class Vehicle {
->       function drive () {
->         alert('drive');
->       }
->     }
->
->     class Car extends Vehicle {
->     }
-
-### Getters and Setters
-
->     class Duck {
->       property color; // adds getColor() and setColor()
->     }
-
-### Mixins (Ruby's multiple inheritance solution)
-
->     module Flyable {
->       function fly () {
->         alert('Flying!');
->       }
->     }
->
->     class Duck {
->       include Flyable;
->     }
-
-### AOP (Aspect Oriented Programming)
-
->     var me = new Human();
->     me.addListener('walk', function () { alert('walking') });
-
-### Static Methods
-
->     class Human {
->       static function getCount () {
->         return this.count;
->       }
->       static function create () {
->         if (this.count) {
->           this.count++;
->         } else {
->           this.count = 1;
->         }
->         return new this();
->       }
->     }
-
-## Syntactic Sugar
-
-### Currying
-
->     var nonScoped = [ ... lots of data .. ];
->     var submitBtn = new Button();
->     var ele = document.getElementById('submitBtn'); 
->     ele.onClick = curry (evt) with (submitBtn) {
->       submitBtn.click();
->     };
-
-### Foreach
-
->     foreach (var item in array) alert(item);
->     foreach (var item:i in array) alert(i + ' is ' + item);
->     curry (arg1, arg2) with (scopeVar1, scopeVar2) { };
-
-##Other Features
-
-### Templating in HAML/SASS (useful for ajax applications)
-
->     //--- in uiBuilder.js2.haml
->     UIBuilder
->       button(name)
->         %div.button= "#name#"
->
->     //--- in uiBuilder.js2
->     class UIBuilder {
->       function getButton (name) {
->         this.htmlCache.button(name);
->       }
->     }
->
->     //--- in page.html
->     var ui  = new UIBuilder();
->     var ele = document.getElementById('buttonContainer');
->     ele.innerHTML = ui.button('my button');
-
-### Selenium Testing Integration
-
-... Coming soon ...
-
-This is a little bit harder to explain, and is only for Ruby Selenium RC developers. The idea is that complex javascript applications usually reference most important DOM elements in javascript for things such as altering html or adding event handlers. What selenium integration in js2 means is that one can use annotations in his/her code to "mark" DOM elements instead of using xpaths.
-
-One of the pain points in Selenium testing is that the xpaths are always changing with each iteration of the view layer. In a complex javascript application, one has to maintain the references to DOM objects in javascript anyway, so this would be an easier way to maintain the Selenium references to the DOM.
-
-While this is available, its not quite ready for public consumption.
+[JS2](http://github.com/jeffsu/js2) - Friendly Cross Browser Object Oriented Javascript
+=======================================================================================
+
+Classes and Methods
+--------------------
+To create a class, use the "class" keyword followed by matching curly braces.  If the class
+has an "initialize" method defined, it will run that right after an instance is created.
+Getters and setters can be created by using the "property" keyword.
+
+
+Here is an example of a class:
+
+    class Person {
+      // creates getName() and setName(name) methods
+      property name;
+
+      // creates getAge() and setAge(age) methods
+      property age;
+
+      // called after new Person(age) is called
+      function initialize(age) {
+        this.age = age;
+      }
+    }
+
+    var p = new Person(14);
+    p.setName("Jeff");
+    var age = p.getAge(); // 14
+
+Modules/Mixins/Multiple Inheritance
+-----------------------------------
+JS2 uses a Ruby-inspired methodology for multiple inheritance.  Here is an example
+of how it works:
+
+    module Flyable {
+      function fly() {
+        alert("I believe I can fly!");
+      }
+    }
+
+    class Duck {
+      include Flyable;
+    }
+
+    var duck = new Duck();
+    duck.fly();
+
+Syntactic Sugar
+---------------
+
+*Foreach*: iterating through an array without having to manually create temp variables:
+
+    var items = [ 'foo', 'bar', 'baz' ]
+    foreach (var item in items) {
+      alert(item);
+    }
+
+    // with index
+    foreach (var item:i in items) {
+      alert(i + ':' + item);
+    }
+
+*Currying*: tightly scoped anonymous functions to prevent memory leaks
+   
+    var bigData = getBigData();
+    var inScope = getSmallData();
+
+    element.onClick = curry (evt) with (inScope, this) { 
+      alert("curry" + inScope);
+      // variable "self" is available as the "this" in the outer scope
+    }
+
+

data/wiki/installation.md

@@ -1,53 +1,13 @@
-## Basic Installation and Usage
+[JS2](http://github.com/jeffsu/js2) - Installation
+=======================================================================================
 
->     gem install js2
->     js2 --help
->
->     js2 --out-dir=/dir/to/write/js /dir/with/js2
+  1. Install Ruby Gems
+  2. Install js2
+      gem install js2
 
-## For Rails
+You should now have the js2 executable in your path.  Running this command should bring up the 
+help page.
 
-This really depends on where you're writing your js2 files. Its recommended that you put it in app/js2, but its really up to you.
+   js2
 
-From the rails root directory
 
->     js2 --out-dir=./public/javascripts ./app/js2
-
-To daemonize it and have it routinely check for changes (every 0.5 secs):
-
->     js2 -d --out-dir=./public/javascripts ./app/js2
-
-## Quick Tutorial
-
-In a new directory, do this:
-
-> mkdir js2
-> mkdir js
-
-Now create some js2 classes: vi js2/base.js2
-
->     class My.Base {
->       function sayHi () {
->         alert("hi");
->       }
->     }
-
-vi js2/concrete.js2
-
->     class My.Concrete {
->       function sayHello () {
->         alert("hello");
->       }
->     }
-
-compile:
-
->     js2 --out-dir=./js ./js2
-
-Be sure to include js/classes.js, js/base.js, and concrete.js (order matters as far as classes is concerned) in your browser.
-
-Now you can run this in javascript:
-
->     var obj = new My.Concrete();
->     obj.sayHi();
->     obj.sayHello();

metadata

@@ -5,8 +5,8 @@ version: !ruby/object:Gem::Version
   segments: 
   - 0
   - 1
-  - 7
-  version: 0.1.7
+  - 8
+  version: 0.1.8
 platform: ruby
 authors: 
 - Jeff Su
@@ -14,7 +14,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-10-08 00:00:00 -07:00
+date: 2010-10-21 00:00:00 -07:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -30,7 +30,7 @@ dependencies:
         version: "0"
   type: :runtime
   version_requirements: *id001
-description: ""
+description: Cross-Browser Object Oriented Javascript Compiler
 email: me@jeffsu.com
 executables: 
 - js2
@@ -144,7 +144,7 @@ rubyforge_project: js2
 rubygems_version: 1.3.7
 signing_key: 
 specification_version: 3
-summary: ""
+summary: Cross-Browser Object Oriented Javascript Compiler
 test_files: 
 - test/test_js2.rb
 - test/test_helper.rb