gon 5.1.0 → 5.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c117fb1e03d8437b1cb22592a559d8c230bffdd6
-  data.tar.gz: e20b61c0441603d5328c54c00b7b16b69edba560
+  metadata.gz: 1ef96285cbcd0c7f1cf74fe2ca0c0735dfcfb282
+  data.tar.gz: f01d459182fee2c6d24ed36295cf79a5770d6087
 SHA512:
-  metadata.gz: eeb234b14c08b522304e7dc5578b9ac1b4d900f594dd64ad12b35475d8700132b81caec1b534250d41974b891773f32ed93af0cadcc08a781c78d8334946bbeb
-  data.tar.gz: a17e689b89609a7fd35202d3c3d9c306cc88792da71632c6b9423a651a1232652cd493d27760287b45f779fc123f459730434a283a0ed53967451f16b1490ff4
+  metadata.gz: 2b314d4df0e993c5bb0de5b0b61541652201930f51305420e5f56bc621daf3a13d4479e4b1e819b298c06c07f7112fac8eecc9502a053d46477901bf67b9b9fd
+  data.tar.gz: 209002b52bdddf14de95f121434388bff62f6a17d571ca23577238a3c4e2180e30b3948f96a0bd3eab9754c6e372f34cfcd578cdc88dfcc07e2407cb874e1491

data/README.md

@@ -175,6 +175,11 @@ great for some init data.
 [Instruction](https://github.com/gazay/gon/wiki/Usage-gon-global) for
 usage gon.global.
 
+## Speed up Gon
+
+You can use any [JSON Engine](https://github.com/intridea/multi_json#supported-json-engines) you want.
+Gon uses `MultiJson` with autodetect mode, so all you need is just require your JSON library.
+
 ## Contributors
 
 * @gazay

data/gon.gemspec

@@ -22,7 +22,7 @@ Gem::Specification.new do |s|
   s.add_dependency 'actionpack', '>= 2.3.0'
   s.add_dependency 'request_store', '>= 1.0.5'
   s.add_dependency 'json'
-  s.add_dependency 'oj' unless RUBY_PLATFORM =~ /java/
+  s.add_dependency 'multi_json'
   s.add_development_dependency 'rabl'
   s.add_development_dependency 'rabl-rails'
   s.add_development_dependency 'rspec'

data/lib/gon.rb

@@ -1,6 +1,7 @@
 require 'request_store'
 require 'action_view'
 require 'action_controller'
+require 'multi_json'
 
 require 'gon/base'
 require 'gon/global'
@@ -12,18 +13,13 @@ require 'gon/rabl'
 require 'gon/jbuilder'
 require 'gon/json_dumper'
 
-# NOTE : JRuby greater than 1.7 doesn't support C-extensions
-if RUBY_PLATFORM =~ /java/
-  require 'gon/json_dumper/active_support'
-else
-  require 'gon/json_dumper/oj'
-end
-
 # NOTE : ActionDispatch::Request#uuid appears only in Rails 3.2.1
 unless ActionDispatch::Request.public_instance_methods.include?(:uuid)
   require 'gon/compatibility/old_rails'
 end
 
+require 'gon/spec_helpers'
+
 class Gon
   class << self
 

data/lib/gon/base.rb

@@ -1,12 +1,14 @@
 class Gon
   module Base
+    ENV_CONTROLLER_KEY = 'action_controller.instance'
+
     class << self
 
       def render_data(options)
-        namespace, tag, cameled, camel_depth, watch, type, cdata = parse_options(options)
+        namespace, tag, cameled, camel_depth, watch, type, cdata, global_root = parse_options(options)
         script = "window.#{namespace}={};"
 
-        script << formatted_data(namespace, cameled, camel_depth, watch)
+        script << formatted_data(namespace, cameled, camel_depth, watch, global_root)
         script = Gon::Escaper.escape_unicode(script)
         script = Gon::Escaper.javascript_tag(script, type, cdata) if tag
 
@@ -17,7 +19,7 @@ class Gon
         options[:controller] ||
           (
             current_gon &&
-            current_gon.env['action_controller.instance'] ||
+            current_gon.env[Gon::Base::ENV_CONTROLLER_KEY] ||
             current_gon.env['action_controller.rescue.response'].
               instance_variable_get('@template').
               instance_variable_get('@controller')
@@ -53,14 +55,15 @@ class Gon
         tag         = need_tag
         type        = options[:type].nil? || options[:type]
         cdata       = options[:cdata].nil? || options[:cdata]
+        global_root = options.has_key?(:global_root) ? options[:global_root] : 'global'
 
-        [namespace, tag, cameled, camel_depth, watch, type, cdata]
+        [namespace, tag, cameled, camel_depth, watch, type, cdata, global_root]
       end
 
-      def formatted_data(namespace, keys_cameled, camel_depth, watch)
+      def formatted_data(namespace, keys_cameled, camel_depth, watch, global_root)
         script = ''
 
-        gon_variables.each do |key, val|
+        gon_variables(global_root).each do |key, val|
           js_key = keys_cameled ? key.to_s.camelize(:lower) : key.to_s
           script << "#{namespace}.#{js_key}=#{to_json(val, camel_depth)};"
         end
@@ -92,14 +95,18 @@ class Gon
         end
       end
 
-      def gon_variables
-        data = Gon.all_variables || {}
+      def gon_variables(global_root)
+        data = {}
 
         if Gon.global.all_variables.present?
-          data[:global] = Gon.global.all_variables
+          if global_root.blank?
+            data = Gon.global.all_variables
+          else
+            data[global_root.to_sym] = Gon.global.all_variables
+          end
         end
 
-        data
+        data.merge(Gon.all_variables)
       end
 
       def right_extension?(extension, template_path)

data/lib/gon/escaper.rb

@@ -7,7 +7,7 @@ class Gon
 
       def escape_unicode(javascript)
         if javascript
-          result = escape_line_separator(escape_special_chars javascript)
+          result = escape_line_separator(javascript)
           javascript.html_safe? ? result.html_safe : result
         end
       end
@@ -31,10 +31,6 @@ class Gon
         javascript.gsub(/\\u2028/u, '
')
       end
 
-      def escape_special_chars(javascript)
-        javascript.gsub(/(\<)/u, '\u003c').gsub(/(\>)/u, '\u003e')
-      end
-
     end
   end
 end

data/lib/gon/json_dumper.rb

@@ -1,7 +1,8 @@
 class Gon
   module JsonDumper
     def self.dump(object)
-      raise NotImplementedError
+      MultiJson.dump object,
+        mode: :compat, escape_mode: :xss_safe, time_format: :ruby
     end
   end
 end

data/lib/gon/spec_helpers.rb

@@ -0,0 +1,27 @@
+class Gon
+  module SpecHelper
+    module Rails
+      extend ActiveSupport::Concern
+
+      module ClassMethods
+        module GonSession
+          def process(*)
+            # preload threadlocal & store controller instance
+            controller.gon
+            Gon.send(:current_gon).env[Gon::Base::ENV_CONTROLLER_KEY] = controller
+            super
+          end
+        end
+
+        def new(*)
+          super.extend(GonSession)
+        end
+      end
+    end
+  end
+end
+
+if defined?(ActionController::TestCase::Behavior)
+  ActionController::TestCase::Behavior.send :include, Gon::SpecHelper::Rails
+end
+

data/lib/gon/version.rb

@@ -1,3 +1,3 @@
 class Gon
-  VERSION = '5.1.0'
+  VERSION = '5.1.1'
 end

data/spec/gon/global_spec.rb

@@ -59,8 +59,8 @@ describe Gon::Global do
       expect(@base.include_gon).to eq("<script type=\"text/javascript\">" +
                                     "\n//<![CDATA[\n" +
                                     "window.gon={};" +
-                                    "gon.int=1;" +
                                     "gon.global={\"int\":1};" +
+                                    "gon.int=1;" +
                                     "\n//]]>\n" +
                                   "</script>")
     end
@@ -77,11 +77,11 @@ describe Gon::Global do
 
     it 'outputs correct js with a script string' do
       Gon.global.str = %q(</script><script>alert('!')</script>)
-      escaped_str = "\"\\u003c/script\\u003e\\u003cscript\\u003ealert('!')\\u003c/script\\u003e\""
+      escaped_str = "\\u003c/script\\u003e\\u003cscript\\u003ealert('!')\\u003c/script\\u003e"
       expect(@base.include_gon).to eq("<script type=\"text/javascript\">" +
                                     "\n//<![CDATA[\n" +
                                     "window.gon={};" +
-                                    "gon.global={\"str\":#{escaped_str}};" +
+                                    "gon.global={\"str\":\"#{escaped_str}\"};" +
                                     "\n//]]>\n" +
                                   "</script>")
     end
@@ -96,6 +96,17 @@ describe Gon::Global do
                                   "</script>")
     end
 
+    it 'outputs locally overridden value' do
+      Gon.str = 'local value'
+      Gon.global.str = 'global value'
+      expect(@base.include_gon(global_root: '')).to eq("<script type=\"text/javascript\">" +
+                                     "\n//<![CDATA[\n" +
+                                     "window.gon={};" +
+                                     "gon.str=\"local value\";" +
+                                     "\n//]]>\n" +
+                                     "</script>")
+    end
+
   end
 
   it 'returns exception if try to set public method as variable' do

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: gon
 version: !ruby/object:Gem::Version
-  version: 5.1.0
+  version: 5.1.1
 platform: ruby
 authors:
 - gazay
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-06-30 00:00:00.000000000 Z
+date: 2014-07-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: actionpack
@@ -53,7 +53,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: oj
+  name: multi_json
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - '>='
@@ -165,10 +165,9 @@ files:
 - lib/gon/helpers.rb
 - lib/gon/jbuilder.rb
 - lib/gon/json_dumper.rb
-- lib/gon/json_dumper/active_support.rb
-- lib/gon/json_dumper/oj.rb
 - lib/gon/rabl.rb
 - lib/gon/request.rb
+- lib/gon/spec_helpers.rb
 - lib/gon/version.rb
 - lib/gon/watch.rb
 - spec/gon/basic_spec.rb

data/lib/gon/json_dumper/active_support.rb

@@ -1,7 +0,0 @@
-class Gon
-  module JsonDumper
-    def self.dump(object)
-      object.to_json
-    end
-  end
-end

data/lib/gon/json_dumper/oj.rb

@@ -1,16 +0,0 @@
-require 'oj'
-
-class Gon
-  module JsonDumper
-    def self.dump(object)
-      Oj.dump(object, mode: :compat, time_format: :ruby)
-    end
-  end
-
-  # NOTE : If we are using Oj, gsub works only with \u, not \\u
-  module Escaper
-    def self.escape_line_separator(javascript)
-      javascript.gsub(/\u2028/u, '
')
-    end
-  end
-end