ruby2js 1.11.1 → 1.12.0

data/lib/ruby2js/filter/react.rb

@@ -0,0 +1,396 @@
+# A filter to support usage of React.  Overview of translations provided:
+#   * classes that inherit from React are converted to React.createClass
+#     calls.
+#   * Wunderbar style element definitions are converted to
+#     React.createElement calls.
+#
+# Related files:
+#   spec/react_spec.rb contains a specification
+#   demo/react-tutorial.rb contains a working sample
+#
+# Experimental conversions provided:
+#  *  $x becomes this.refs.x
+#  *  @x becomes this.state.x
+#  * @@x becomes this.props.x
+#  *  ~x becomes this.refs.x.getDOMNode()
+#
+require 'ruby2js'
+
+module Ruby2JS
+  module Filter
+    module React
+      include SEXP
+
+      # Example conversion
+      #  before:
+      #    (class (const nil :Foo) (const nil :React) nil)
+      #  after:
+      #    (casgn nil :foo, (send :React :createClass (hash (sym :displayName)
+      #       (:str, "Foo"))))
+      def on_class(node)
+        cname, inheritance, *body = node.children
+        return super unless cname.children.first == nil
+        return super unless inheritance == s(:const, nil, :React)
+
+        # traverse down to actual list of class statements
+        if body.length == 1 
+          if not body.first
+            body = []
+          elsif body.first.type == :begin
+            body = body.first.children 
+          end
+        end
+
+        # abort conversion unless all body statements are method definitions
+        return super unless body.all? {|child| child.type == :def}
+
+        begin
+          react, @react = @react, true
+
+          # automatically capture the displayName for the class
+          pairs = [s(:pair, s(:sym, :displayName), 
+            s(:str, cname.children.last.to_s))]
+
+          # add a proc/function for each method
+          body.each do |child|
+            mname, args, *block = child.children
+            pairs << s(:pair, s(:sym, mname), s(:block, s(:send, nil, :proc), 
+              args, process(s((child.is_method? ? :begin : :autoreturn),
+              *block))))
+          end
+        ensure
+          @react = react
+        end
+
+        # emit a createClass statement
+        s(:casgn, nil, cname.children.last, 
+          s(:send, inheritance, :createClass, s(:hash, *pairs)))
+      end
+
+      def on_send(node)
+        # enable React filtering within React class method calls
+        if node.children.first == s(:const, nil, :React)
+          begin
+            react, @react = @react, true
+            return super
+          ensure
+            @react = react
+          end
+        end
+
+        return super unless @react
+
+        if node.children[0] == nil and node.children[1] == :_
+          # text nodes
+          node.children[2]
+
+        elsif node.children[0] == nil and node.children[1] =~ /^_\w/
+          # map method calls starting with an underscore to React calls
+          # to create an element.  
+          #
+          # input:
+          #   _a 'name', href: 'link'
+          # output:
+          #  React.createElement("a", {href: "link"}, "name")
+          #
+          tag = node.children[1].to_s[1..-1]
+          pairs = []
+          text = block = nil
+          node.children[2..-1].each do |child|
+            if child.type == :hash
+              # convert _ to - in attribute names
+              pairs += child.children.map do |pair|
+                key, value = pair.children
+                if key.type == :sym
+                  s(:pair, s(:str, key.children[0].to_s.gsub('_', '-')), value)
+                else
+                  pair
+                end
+              end
+
+            elsif child.type == :block
+              # :block arguments are inserted by on_block logic below
+              block = child
+
+            else
+              # everything else added as text
+              text = child
+            end
+          end
+
+          # extract all class names
+          classes = pairs.find_all do |pair|
+            key = pair.children.first.children.first
+            [:class, 'class', :className, 'className'].include? key
+          end
+
+          # combine all classes into a single value (or expression)
+          if classes.length > 0
+            expr = nil
+            values = classes.map do |pair|
+              if [:sym, :str].include? pair.children.last.type
+                pair.children.last.children.first.to_s
+              else
+                expr = pair.children.last
+                ''
+              end
+            end
+            pairs -= classes
+            value = s(:str, values.join(' '))
+            value = s(:send, value, :+, expr) if expr
+            pairs.unshift s(:pair, s(:sym, :className), value)
+          end
+
+          # search for the presence of a 'for' attribute
+          htmlFor = pairs.find_index do |pair|
+            ['for', :for].include? pair.children.first.children.first
+          end
+
+          # replace 'for' attribute (if any) with 'htmlFor'
+          if htmlFor
+            pairs[htmlFor] = s(:pair, s(:sym, :htmlFor),
+              pairs[htmlFor].children.last)
+          end
+
+          # construct hash (or nil) from pairs
+          hash = (pairs.length > 0 ? process(s(:hash, *pairs)) : s(:nil))
+
+          # based on case of tag name, build a HTML tag or React component
+          if tag =~ /^[A-Z]/
+            params = [s(:const, nil, tag), hash]
+          else
+            params = [s(:str, tag), hash]
+          end
+
+          # handle nested elements
+          if block
+
+            # traverse down to actual list of nested statements
+            args = block.children[2..-1]
+            if args.length == 1 
+              if not args.first
+                args = []
+              elsif args.first.type == :begin
+                args = args.first.children 
+              end
+            end
+
+            # check for normal case: only elements and text
+            simple = args.all? do |arg|
+              arg = arg.children.first if arg.type == :block
+              while arg.type == :send and arg.children.first != nil
+                arg = arg.children.first
+              end
+              arg.type == :send and arg.children[1] =~ /^_/
+            end
+
+            begin
+              if simple
+                # in the normal case, each process each argument
+                reactApply, @reactApply = @reactApply, false
+                params += args.map {|arg| process(arg)}
+              else
+                reactApply, @reactApply = @reactApply, true
+
+                # collect children and apply.  Intermediate representation
+                # will look something like the following:
+                #
+                #   React.createElement(*proc {
+                #     $_ = ['tag', hash]
+                #     $_.push(React.createElement(...))
+                #   }())
+                #
+                # Base Ruby2JS processing will convert the 'splat' to 'apply'
+                params = [s(:splat, s(:send, s(:block, s(:send, nil, :proc), 
+                  s(:args), s(:begin, s(:lvasgn, :$_, s(:array, *params)),
+                  *args.map {|arg| process arg},
+                  s(:return, s(:lvar, :$_)))), :[]))]
+              end
+            ensure
+              @reactApply = reactApply
+            end
+
+          elsif text
+            # add text
+            params << process(text)
+          end
+
+          # construct element using params
+          element = s(:send, s(:const, nil, :React), :createElement, *params)
+
+          if @reactApply
+            # if apply is set, emit code that pushes result
+            s(:send, s(:gvar, :$_), :push, element)
+          else
+            # simple/normal case: simply return the element
+            element
+          end
+
+        # map method calls involving i/g/c vars to straight calls
+        #
+        # input:
+        #   @x.(a,b,c)
+        # output:
+        #   @x(a,b,c)
+        elsif node.children[1] == :call
+          if [:ivar, :gvar, :cvar].include? node.children.first.type
+            return process(s(:send, node.children.first, nil,
+              *node.children[2..-1]))
+          else
+            return super
+          end
+
+        elsif node.children[1] == :~
+          # map ~expression.method to $(expression).method
+
+          if node.children[0] and node.children[0].type == :op_asgn
+            asgn = node.children[0]
+            if asgn.children[0] and asgn.children[0].type == :send
+              inner = asgn.children[0]
+              return on_send s(:send, s(:send, inner.children[0],
+                (inner.children[1].to_s+'=').to_sym,
+                s(:send, s(:send, s(:send, inner.children[0], :~),
+                *inner.children[1..-1]), *asgn.children[1..-1])), :~)
+            else
+              return on_send asgn.updated nil, [s(:send, asgn.children[0], :~),
+                *asgn.children[1..-1]]
+            end
+          end
+
+          rewrite_tilda = proc do |node|
+            # Example conversion:
+            #   before:
+            #    (send (send nil :a) :text) :~)
+            #   after:
+            #    (send (send (gvar :$a), :getDOMNode)), :text)
+            if node.type == :send and node.children[0]
+              if node.children[1] == :~ and node.children[0].children[1] == :~
+                # consecutive tildes
+                if node.children[0].children[0].children[1] == :~
+                  result = node.children[0].children[0].children[0]
+                else
+                  result = s(:attr, node.children[0].children[0], :~)
+                end
+                s(:attr, s(:attr, process(result), :~), :~)
+              else
+                # possible getter/setter
+                method = node.children[1]
+                method = method.to_s.chomp('=') if method =~ /=$/
+                rewrite = [rewrite_tilda[node.children[0]], 
+                  method, *node.children[2..-1]]
+                rewrite[1] = node.children[1]
+                node.updated nil, rewrite
+              end
+            elsif node.children.first == nil and Symbol === node.children[1]
+              # innermost expression is a scalar
+              s(:send, s(:gvar, "$#{node.children[1]}"), :getDOMNode)
+            elsif node.type == :lvar
+              s(:send, s(:gvar, "$#{node.children[0]}"), :getDOMNode)
+            else
+              # leave alone
+              node
+            end
+          end
+
+          return process rewrite_tilda[node].children[0]
+
+        elsif node.children[0] and node.children[0].type == :send
+          # determine if markaby style class and id names are being used
+          child = node
+          test = child.children.first
+          while test and test.type == :send and not test.is_method?
+            child, test = test, test.children.first
+          end
+
+          if child.children[0] == nil and child.children[1] =~ /^_\w/
+            # capture the arguments provided on the current node
+            children = node.children[2..-1]
+
+            # convert method calls to id and class values
+            while node != child
+              if node.children[1] !~ /!$/
+                # convert method name to hash {className: name} pair
+                pair = s(:pair, s(:sym, :className), 
+                  s(:str, node.children[1].to_s.gsub('_','-')))
+              else
+                # convert method name to hash {id: name} pair
+                pair = s(:pair, s(:sym, :id), 
+                  s(:str, node.children[1].to_s[0..-2].gsub('_','-')))
+              end
+
+              # if a hash argument is already passed, merge in id value
+              hash = children.find_index {|node| node.type == :hash}
+              if hash
+                children[hash] = s(:hash, pair, *children[hash].children)
+              else
+                children.unshift s(:hash, pair)
+              end
+
+              # advance to next node
+              node = node.children.first
+            end
+
+            # collapse series of method calls into a single call
+            return process(s(:send, *node.children[0..1], *children))
+          else
+            super
+          end
+
+        else
+          super
+        end
+      end
+
+      # convert blocks to proc arguments
+      def on_block(node)
+        return super unless @react
+        return super unless node.children[1].children.empty?
+
+        # traverse through potential "css proxy" style method calls
+        child = node.children.first
+        test = child.children.first
+        while test and test.type == :send and not test.is_method?
+          child, test = test, test.children.first
+        end
+
+        # append block as a standalone proc to wunderbar style method call
+        if child.children[0] == nil and child.children[1] =~ /^_\w/
+          block = s(:block, s(:send, nil, :proc), 
+            s(:args, s(:arg, :_index), s(:arg, :_parent)),
+            *node.children[2..-1])
+          return on_send s(:send, *node.children.first.children, block)
+        end
+
+        super
+      end
+
+      # convert global variables to refs
+      def on_gvar(node)
+        return super unless @react
+        s(:attr, s(:attr, s(:self), :refs), node.children.first.to_s[1..-1])
+      end
+
+      # convert instance variables to state
+      def on_ivar(node)
+        return super unless @react
+        s(:attr, s(:attr, s(:self), :state), node.children.first.to_s[1..-1])
+      end
+
+      # convert instance variable assignments to setState calls
+      def on_ivasgn(node)
+        return super unless @react
+        s(:send, s(:self), :setState, s(:hash, s(:pair,
+          s(:str, node.children.first.to_s[1..-1]),
+          process(node.children.last))))
+      end
+
+      # convert class variables to props
+      def on_cvar(node)
+        return super unless @react
+        s(:attr, s(:attr, s(:self), :props), node.children.first.to_s[2..-1])
+      end
+    end
+
+    DEFAULTS.push React
+  end
+end

data/lib/ruby2js/version.rb

@@ -1,8 +1,8 @@
 module Ruby2JS
   module VERSION #:nodoc:
     MAJOR = 1
-    MINOR = 11
-    TINY  = 1
+    MINOR = 12
+    TINY  = 0
 
     STRING = [MAJOR, MINOR, TINY].join('.')
   end

data/ruby2js.gemspec

@@ -2,17 +2,18 @@
 
 Gem::Specification.new do |s|
   s.name = "ruby2js"
-  s.version = "1.11.1"
+  s.version = "1.12.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Sam Ruby"]
-  s.date = "2015-01-02"
+  s.date = "2015-01-23"
   s.description = "    The base package maps Ruby syntax to JavaScript semantics.\n    Filters may be provided to add Ruby-specific or framework specific\n    behavior.\n"
   s.email = "rubys@intertwingly.net"
-  s.files = ["ruby2js.gemspec", "README.md", "lib/ruby2js", "lib/ruby2js/converter.rb", "lib/ruby2js/version.rb", "lib/ruby2js/filter", "lib/ruby2js/filter/jquery.rb", "lib/ruby2js/filter/return.rb", "lib/ruby2js/filter/underscore.rb", "lib/ruby2js/filter/angularrb.rb", "lib/ruby2js/filter/minitest-jasmine.rb", "lib/ruby2js/filter/camelCase.rb", "lib/ruby2js/filter/strict.rb", "lib/ruby2js/filter/functions.rb", "lib/ruby2js/filter/angular-resource.rb", "lib/ruby2js/filter/angular-route.rb", "lib/ruby2js/sinatra.rb", "lib/ruby2js/rails.rb", "lib/ruby2js/cgi.rb", "lib/ruby2js/converter", "lib/ruby2js/converter/self.rb", "lib/ruby2js/converter/arg.rb", "lib/ruby2js/converter/dstr.rb", "lib/ruby2js/converter/xstr.rb", "lib/ruby2js/converter/sym.rb", "lib/ruby2js/converter/return.rb", "lib/ruby2js/converter/break.rb", "lib/ruby2js/converter/for.rb", "lib/ruby2js/converter/defined.rb", "lib/ruby2js/converter/cvasgn.rb", "lib/ruby2js/converter/whilepost.rb", "lib/ruby2js/converter/logical.rb", "lib/ruby2js/converter/args.rb", "lib/ruby2js/converter/def.rb", "lib/ruby2js/converter/prototype.rb", "lib/ruby2js/converter/class.rb", "lib/ruby2js/converter/nthref.rb", "lib/ruby2js/converter/opasgn.rb", "lib/ruby2js/converter/module.rb", "lib/ruby2js/converter/kwbegin.rb", "lib/ruby2js/converter/send.rb", "lib/ruby2js/converter/boolean.rb", "lib/ruby2js/converter/masgn.rb", "lib/ruby2js/converter/hash.rb", "lib/ruby2js/converter/cvar.rb", "lib/ruby2js/converter/ivasgn.rb", "lib/ruby2js/converter/case.rb", "lib/ruby2js/converter/const.rb", "lib/ruby2js/converter/vasgn.rb", "lib/ruby2js/converter/untilpost.rb", "lib/ruby2js/converter/begin.rb", "lib/ruby2js/converter/ivar.rb", "lib/ruby2js/converter/while.rb", "lib/ruby2js/converter/next.rb", "lib/ruby2js/converter/nil.rb", "lib/ruby2js/converter/blockpass.rb", "lib/ruby2js/converter/super.rb", "lib/ruby2js/converter/defs.rb", "lib/ruby2js/converter/array.rb", "lib/ruby2js/converter/block.rb", "lib/ruby2js/converter/if.rb", "lib/ruby2js/converter/until.rb", "lib/ruby2js/converter/regexp.rb", "lib/ruby2js/converter/casgn.rb", "lib/ruby2js/converter/undef.rb", "lib/ruby2js/converter/literal.rb", "lib/ruby2js/converter/var.rb", "lib/ruby2js.rb"]
+  s.files = ["ruby2js.gemspec", "README.md", "lib/ruby2js", "lib/ruby2js/converter.rb", "lib/ruby2js/version.rb", "lib/ruby2js/filter", "lib/ruby2js/filter/jquery.rb", "lib/ruby2js/filter/return.rb", "lib/ruby2js/filter/underscore.rb", "lib/ruby2js/filter/angularrb.rb", "lib/ruby2js/filter/minitest-jasmine.rb", "lib/ruby2js/filter/camelCase.rb", "lib/ruby2js/filter/strict.rb", "lib/ruby2js/filter/functions.rb", "lib/ruby2js/filter/angular-resource.rb", "lib/ruby2js/filter/react.rb", "lib/ruby2js/filter/angular-route.rb", "lib/ruby2js/sinatra.rb", "lib/ruby2js/rails.rb", "lib/ruby2js/cgi.rb", "lib/ruby2js/converter", "lib/ruby2js/converter/self.rb", "lib/ruby2js/converter/arg.rb", "lib/ruby2js/converter/dstr.rb", "lib/ruby2js/converter/xstr.rb", "lib/ruby2js/converter/sym.rb", "lib/ruby2js/converter/return.rb", "lib/ruby2js/converter/break.rb", "lib/ruby2js/converter/for.rb", "lib/ruby2js/converter/defined.rb", "lib/ruby2js/converter/cvasgn.rb", "lib/ruby2js/converter/whilepost.rb", "lib/ruby2js/converter/logical.rb", "lib/ruby2js/converter/args.rb", "lib/ruby2js/converter/def.rb", "lib/ruby2js/converter/prototype.rb", "lib/ruby2js/converter/class.rb", "lib/ruby2js/converter/nthref.rb", "lib/ruby2js/converter/opasgn.rb", "lib/ruby2js/converter/module.rb", "lib/ruby2js/converter/kwbegin.rb", "lib/ruby2js/converter/send.rb", "lib/ruby2js/converter/boolean.rb", "lib/ruby2js/converter/masgn.rb", "lib/ruby2js/converter/hash.rb", "lib/ruby2js/converter/cvar.rb", "lib/ruby2js/converter/ivasgn.rb", "lib/ruby2js/converter/case.rb", "lib/ruby2js/converter/const.rb", "lib/ruby2js/converter/vasgn.rb", "lib/ruby2js/converter/untilpost.rb", "lib/ruby2js/converter/begin.rb", "lib/ruby2js/converter/ivar.rb", "lib/ruby2js/converter/while.rb", "lib/ruby2js/converter/next.rb", "lib/ruby2js/converter/nil.rb", "lib/ruby2js/converter/blockpass.rb", "lib/ruby2js/converter/super.rb", "lib/ruby2js/converter/defs.rb", "lib/ruby2js/converter/array.rb", "lib/ruby2js/converter/block.rb", "lib/ruby2js/converter/if.rb", "lib/ruby2js/converter/until.rb", "lib/ruby2js/converter/regexp.rb", "lib/ruby2js/converter/casgn.rb", "lib/ruby2js/converter/undef.rb", "lib/ruby2js/converter/literal.rb", "lib/ruby2js/converter/var.rb", "lib/ruby2js.rb"]
   s.homepage = "http://github.com/rubys/ruby2js"
   s.licenses = ["MIT"]
   s.require_paths = ["lib"]
+  s.required_ruby_version = Gem::Requirement.new(">= 1.9.3")
   s.rubygems_version = "1.8.23"
   s.summary = "Minimal yet extensible Ruby to JavaScript conversion."
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ruby2js
 version: !ruby/object:Gem::Version
-  version: 1.11.1
+  version: 1.12.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-01-02 00:00:00.000000000 Z
+date: 2015-01-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: parser
@@ -47,6 +47,7 @@ files:
 - lib/ruby2js/filter/strict.rb
 - lib/ruby2js/filter/functions.rb
 - lib/ruby2js/filter/angular-resource.rb
+- lib/ruby2js/filter/react.rb
 - lib/ruby2js/filter/angular-route.rb
 - lib/ruby2js/sinatra.rb
 - lib/ruby2js/rails.rb
@@ -111,7 +112,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ! '>='
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.9.3
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements: