to-javascript 1.0.0

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2008 martin.rehfeld@glnetworks.de
+
+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.

data/lib/to-javascript.rb

@@ -0,0 +1,52 @@
+# to-javascript was designed to allow you to write comples dynamic javascript
+# using standard ruby object. Unlike <i>to_json<i> <i>to_js<i> creates code
+# exicutable only in javascript. This means its useless as a transport medium and
+# therefore is not trying to replace or improove upon json in anway.
+#
+# <i>to_js<i> is almost identical to to_json except certain object are converted 
+# into their code that create's their javascript equvalent rather then a string
+# equvalent 
+#
+# ==== Example:
+#   Date.new(2005,2,1).to_js
+#   # => "new Date(2005/02/01)"
+#
+#
+# Complex ruby objects are just as easily be converted into valid javascript.
+#
+# ==== Example:
+#   {
+#     :desc => 'my dog at my homework',
+#     :dates => [
+#       Date.new(2005,2,8),
+#       Date.new(2005,5,4),
+#       Date.new(2005,7,10),
+#       Date.new(2005,8,9)
+#     ],
+#     :location => 'window.location'.as_js
+#   }.to_js
+#
+#   # {
+#   #   "desc": "my dog at my homework", 
+#   #   "dates": [
+#   #     new Date('2005/02/08'), 
+#   #     new Date('2005/05/04'), 
+#   #     new Date('2005/07/10'), 
+#   #     new Date('2005/08/09')
+#   #   ], 
+#   #   "location": window.location
+#   # }
+#
+# This is extremely helpful in projects that dynamically generate large
+# amounts of javascript
+#
+require 'activesupport'
+require 'activerecord'
+require "to-javascript/encoding"
+# require "to-javascript/javascript"
+require "to-javascript/serializer"
+
+# Alias to ActiveSupport::JS::Code.new
+def JS(object)
+   ActiveSupport::JS::Code.new object
+end

data/lib/to-javascript/code.rb

@@ -0,0 +1,41 @@
+# The Javascript object is just a String that when parced into 
+# Javascript code isnt wrapped in quotes. 
+#
+# ==== Example:
+#   here = 'http://www.examples.com'
+#   {
+#     :isHere => Javascript("(window.location == #{here})"),
+#   }.to_js
+#
+#   # {
+#   #   "isHere": (window.location == http://www.examples.com)
+#   # }
+module ActiveSupport
+  module JS
+    
+    # A string that returns itself as Javascript code.
+    class Code < String
+      
+      def initialize(object)
+        if object.is_a? String
+          super(object)
+        elsif object.respond_to? :to_js
+          super(object.to_js)
+        else
+          super(object)
+        end
+      end
+      
+      # Returns an unquoted string to be exectuted as Javacript code
+      #
+      #   { :location => 'window.location'.as_js }.to_js
+      #   # => {"location": window.location}
+      def to_js(options=nil)
+        self
+      end
+      
+    end
+    
+  end
+end
+

data/lib/to-javascript/encoders/date.rb

@@ -0,0 +1,10 @@
+class Date
+  # Returns a Javascript string to create a Date object of the same date.
+  #
+  # ==== Example:
+  #   Date.new(2005,2,1).to_js
+  #   # => "new Date(2005/02/01)"
+  def to_js(options = nil)
+   ActiveSupport::JS::Code.new "new Date('#{strftime("%Y/%m/%d")}')"
+  end
+end

data/lib/to-javascript/encoders/date_time.rb

@@ -0,0 +1,10 @@
+class DateTime
+  # Returns a Javascript string to create a Date object of the same datetime.
+  #
+  # ==== Example:
+  #   DateTime.civil(2005,2,1,15,15,10).to_js
+  #   # => "new Date(2005/02/01 15:15:10 +0000)"
+  def to_js(options = nil)
+    ActiveSupport::JS::Code.new "new Date('#{strftime("%Y/%m/%d %H:%M:%S %z")}')"
+  end
+end

data/lib/to-javascript/encoders/enumerable.rb

@@ -0,0 +1,12 @@
+module Enumerable
+  # Returns a Javascript string representing the enumerable. Any +options+
+  # given will be passed on to its elements. For example:
+  #
+  #   users = User.find(:all)
+  #   # => users.to_js(:only => :name)
+  #
+  # will pass the <tt>:only => :name</tt> option to each user.
+  def to_js(options = {}) #:nodoc:
+    ActiveSupport::JS::Code.new "[#{map { |value| ActiveSupport::JS.encode(value, options) } * ', '}]"
+  end
+end

data/lib/to-javascript/encoders/false_class.rb

@@ -0,0 +1,5 @@
+class FalseClass
+  def to_js(options = nil) #:nodoc:
+    ActiveSupport::JS::Code.new to_json(options)
+  end
+end

data/lib/to-javascript/encoders/hash.rb

@@ -0,0 +1,48 @@
+class Hash
+  # Returns a Javascript string representing the hash.
+  #
+  # Just like to_json, without any +options+, the returned javascript equivalent the obejct
+  # For example:
+  #
+  #   { :name => "Konata Izumi", 'age' => 16, 1 => 2 }.to_js
+  #   # => {"name": "Konata Izumi", 1: 2, "age": 16}
+  #
+  # The keys in the javascript string are unordered due to the nature of hashes.
+  #
+  # Also like to_jason, the <tt>:only</tt> and <tt>:except</tt> options can be used to limit the
+  # attributes included, and will accept 1 or more hash keys to include/exclude.
+  #
+  #   { :name => "Konata Izumi", 'age' => 16, 1 => 2 }.to_js(:only => [:name, 'age'])
+  #   # => {"name": "Konata Izumi", "age": 16}
+  #
+  #   { :name => "Konata Izumi", 'age' => 16, 1 => 2 }.to_js(:except => 1)
+  #   # => {"name": "Konata Izumi", "age": 16}
+  #
+  # The +options+ also filter down to any hash values. This is particularly
+  # useful for converting hashes containing ActiveRecord objects or any object
+  # that responds to options in their <tt>to_js</tt> method. For example:
+  #
+  #   users = User.find(:all)
+  #   { :users => users, :count => users.size }.to_js(:include => :posts)
+  #
+  # would pass the <tt>:include => :posts</tt> option to <tt>users</tt>,
+  # allowing the posts association in the User model to be converted to javascript
+  # as well.
+  def to_js(options = {})
+    hash_keys = self.keys
+
+    if options[:except]
+      hash_keys = hash_keys - Array(options[:except])
+    elsif options[:only]
+      hash_keys = hash_keys & Array(options[:only])
+    end
+
+    returning result = ActiveSupport::JS::Code.new('{') do
+      result << hash_keys.map do |key|
+        "#{ActiveSupport::JS.encode(key)}: #{ActiveSupport::JS.encode(self[key], options)}"
+      end * ', '
+      result << '}'
+    end
+    
+  end
+end

data/lib/to-javascript/encoders/nil_class.rb

@@ -0,0 +1,5 @@
+class NilClass
+  def to_js(options = nil) #:nodoc:
+    ActiveSupport::JS::Code.new to_json(options)
+  end
+end

data/lib/to-javascript/encoders/numeric.rb

@@ -0,0 +1,5 @@
+class Numeric
+  def to_js(options = nil) #:nodoc:
+    ActiveSupport::JS::Code.new to_json(options)
+  end
+end

data/lib/to-javascript/encoders/object.rb

@@ -0,0 +1,8 @@
+class Object
+  def to_js(options = {}) #:nodoc:
+    ActiveSupport::JS::Code.new ActiveSupport::JS.encode(instance_values, options)
+  end
+  def as_js
+    to_js
+  end
+end

data/lib/to-javascript/encoders/regexp.rb

@@ -0,0 +1,5 @@
+class Regexp
+  def to_js(options = nil) #:nodoc:
+    ActiveSupport::JS::Code.new to_json(options)
+  end
+end

data/lib/to-javascript/encoders/string.rb

@@ -0,0 +1,22 @@
+class String
+  def to_js(options = nil) #:nodoc:
+    ActiveSupport::JS::Code.new to_json(options)
+  end
+  
+  # Synonymous with Javascript('string')
+  # Returns an unquoted Javascript object that will not be quoted when renderded as
+  # javasctipy
+  #
+  #   datecode = 'new Date()'.to_javascript
+  #   { :now => datecode }.to_js
+  #   # => { "now": new Date() }
+  #
+  #   { :location => 'window.location'.as_js }.to_js
+  #   # => {"location": window.location}
+  def as_js
+    ActiveSupport::JS::Code.new self
+  end
+  # def to_javascript
+  #   Javascript.new self
+  # end
+end

data/lib/to-javascript/encoders/symbol.rb

@@ -0,0 +1,5 @@
+class Symbol
+  def to_js(options = {}) #:nodoc:
+    ActiveSupport::JS::Code.new to_json(options)
+  end
+end

data/lib/to-javascript/encoders/time.rb

@@ -0,0 +1,10 @@
+class Time
+  # Returns a Javascript string to create a Date object of the same time.
+  #
+  # ==== Example:
+  #   Time.utc(2005,2,1,15,15,10).to_js
+  #   # => "new Date(2005/02/01 15:15:10 +0000)"
+  def to_js(options = nil)
+    ActiveSupport::JS::Code.new "new Date('#{strftime("%Y/%m/%d %H:%M:%S")} #{formatted_offset(false)}')"
+  end
+end

data/lib/to-javascript/encoders/time_with_zone.rb

@@ -0,0 +1,7 @@
+module ActiveSupport
+  class TimeWithZone
+    def to_js(options = nil) #:nodoc:
+      ActiveSupport::JS::Code.new %(new Date(#{to_json}))
+    end
+  end
+end

data/lib/to-javascript/encoders/true_class.rb

@@ -0,0 +1,5 @@
+class TrueClass
+  def to_js(options = nil) #:nodoc:
+    ActiveSupport::JS::Code.new to_json(options)
+  end
+end

data/lib/to-javascript/encoding.rb

@@ -0,0 +1,37 @@
+require "to-javascript/code"
+require "to-javascript/encoders/object" # Require explicitly for rdoc.
+Dir["#{File.dirname(__FILE__)}/encoders/**/*.rb"].each do |file|
+  basename = File.basename(file, '.rb')
+  unless basename == 'object'
+    require "#{file}"
+  end
+end
+
+module ActiveSupport
+  module JS
+    class CircularReferenceError < StandardError
+    end
+
+    class << self
+      REFERENCE_STACK_VARIABLE = :json_reference_stack #:nodoc:
+
+      # Converts a Ruby object into a Javascript string.
+      def encode(value, options = {})
+        raise_on_circular_reference(value) do
+          value.send(:to_js, options)
+        end
+      end
+
+      protected
+        def raise_on_circular_reference(value) #:nodoc:
+          stack = Thread.current[REFERENCE_STACK_VARIABLE] ||= []
+          raise CircularReferenceError, 'object references itself' if
+            stack.include? value
+          stack << value
+          yield
+        ensure
+          stack.pop
+        end
+    end
+  end
+end

data/lib/to-javascript/serializer.rb

@@ -0,0 +1,16 @@
+module ActiveRecord #:nodoc:
+  module Serialization
+    
+    # converts an object to executable javascript code (not json) 
+    def to_js(options = {})
+      JavascriptSerializer.new(self, options).to_s
+    end
+    
+    class JavascriptSerializer < ActiveRecord::Serialization::Serializer #:nodoc:
+      def serialize
+        serializable_record.to_js
+      end
+    end
+    
+  end
+end

metadata

@@ -0,0 +1,90 @@
+--- !ruby/object:Gem::Specification 
+name: to-javascript
+version: !ruby/object:Gem::Version 
+  version: 1.0.0
+platform: ruby
+authors: 
+- Jared Grippe
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2008-09-02 00:00:00 -07:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: activesupport
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 2.1.0
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: activerecord
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 2.1.0
+    version: 
+description: "Extends ActiveSupport adding: - to_js method to all objects that support to_json - Javascript class  this is used to convert objects into executable javascript code with the goal of supporting easier javascript generation in ruby"
+email: jared@deadlyicon.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README
+- MIT-LICENSE
+files: 
+- lib/to-javascript/code.rb
+- lib/to-javascript/encoders/date.rb
+- lib/to-javascript/encoders/date_time.rb
+- lib/to-javascript/encoders/enumerable.rb
+- lib/to-javascript/encoders/false_class.rb
+- lib/to-javascript/encoders/hash.rb
+- lib/to-javascript/encoders/nil_class.rb
+- lib/to-javascript/encoders/numeric.rb
+- lib/to-javascript/encoders/object.rb
+- lib/to-javascript/encoders/regexp.rb
+- lib/to-javascript/encoders/string.rb
+- lib/to-javascript/encoders/symbol.rb
+- lib/to-javascript/encoders/time.rb
+- lib/to-javascript/encoders/time_with_zone.rb
+- lib/to-javascript/encoders/true_class.rb
+- lib/to-javascript/encoding.rb
+- lib/to-javascript/serializer.rb
+- lib/to-javascript.rb
+- README
+- MIT-LICENSE
+has_rdoc: true
+homepage: http://tojavascript.rubyforge.org/
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: toJavascript
+rubygems_version: 1.1.1
+signing_key: 
+specification_version: 2
+summary: Converts objects into executable javascript code (not json)
+test_files: []
+