gon 5.1.2 → 5.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 051e8aa58734e4cf43cc1ee84a6507fa0d6f69b1
-  data.tar.gz: 2a7cbbb9b8fa95b946977d69ddd4b8e7093be0bb
+  metadata.gz: f6490edc958229669a41401931a59c79cbb3826f
+  data.tar.gz: 9e0337987644e7f2bd4c80456a1a69da673ad640
 SHA512:
-  metadata.gz: e2e16546bba113eacdc27a966d4db2d27995409d9cdc3787db8d68ab00a960cdddd7a16b73f18777c168dd3ee371b7422f661571c04ad01a8e40968d2a21fe13
-  data.tar.gz: 2f9d67107a152d69fb9691617c9ac290b680c16c9f444c3f319a76739cf242e0daea283f0876e4c1467ddf0a57095133cb655eae6bbd6dc8fe1267ec3e9f2378
+  metadata.gz: ba65303d31b34f7d2b9bad0d775efb210fb0eba67f30e80190639736773e4a773ed072a4276795c3271507b7f08079f99ad8c5f9b0159eb46c496c59eb768a34
+  data.tar.gz: f543c36fea096b81de1c089fa9af7c1f8845eced67410485b9a345569aa9d181c8551e5a24f6c91866e1a16022b240e24cb1a8ced93b089c2840c2920161eeb8

data/CHANGELOG.md

@@ -1,5 +1,21 @@
 # CHANGELOG
 
+## 5.2.0
+
+  * fix issue where include_gon would raise exception if the controller did not assign any gon variables. Thanks to @asalme
+  * namespace_check option. Thanks to @tommyh
+  * Only inject gon into ActionController::Base-like object in spec_helper. Thanks to @kevinoconnor7
+  * AMD compatible version of including gon. Thanks to @vijoc
+
+## 5.1.2
+
+  * Clarifying helpers, dump gon#watch content to safe json before render. Thanks to @Strech
+
+## 5.1.1
+
+  * global_root option. Thanks to @rafaelliu
+  * MultiJson support. Thanks to @Strech
+
 ## 5.1.0
 
   * Many fixes https://github.com/gazay/gon/compare/91845f3f0debd0cb8fa569aad65f5dc40a7e28e5...8dc7400fbb83ba5a086bd36c76342a393690d53f

data/README.md

@@ -110,6 +110,40 @@ alert(gon.your_array)
 alert(gon.your_hash)
 ```
 
+### AMD compatible version: `include_gon_amd`
+
+If your site uses AMD modules you can use the `include_gon_amd` helper to 
+include the variables and watch function as a module. Options are mostly 
+the same as for `include_gon`, except for `namespace_check`, which does 
+nothing and `namespace`, which is used as the name of the defined module. 
+The end result will look somewhat like the following:
+
+```js
+define('yourNameSpace', [], function() {
+  var gon = {};
+  gon.yourVariable = yourValue;
+  // etc...
+
+  return gon;
+});
+```
+
+A (very) simplified usage example:
+
+`app/views/layouts/application.html.erb`
+
+```ruby
+include_gon_amd namespace: 'data'
+```
+
+`Some JavaScript module`
+
+```js
+define(['data'], function(data) {
+  alert(data.myVariable);
+});
+```
+
 ## gon.watch - renew your data easily!
 
 You can use gon for renewing your data without reloading pages and

data/lib/gon.rb

@@ -63,7 +63,7 @@ class Gon
     end
 
     def all_variables
-      current_gon.gon if current_gon
+      current_gon ? current_gon.gon : {}
     end
 
     def clear

data/lib/gon/base.rb

@@ -5,8 +5,8 @@ class Gon
     class << self
 
       def render_data(options)
-        namespace, tag, cameled, camel_depth, watch, type, cdata, global_root = parse_options(options)
-        script = "window.#{namespace}={};"
+        namespace, tag, cameled, camel_depth, watch, type, cdata, global_root, namespace_check = parse_options(options)
+        script = namespace_check ? "window.#{namespace}=window.#{namespace}||{};" : "window.#{namespace}={};"
 
         script << formatted_data(namespace, cameled, camel_depth, watch, global_root)
         script = Gon::Escaper.escape_unicode(script)
@@ -15,6 +15,19 @@ class Gon
         script.html_safe
       end
 
+      def render_data_amd(options)
+        namespace, tag, cameled, camel_depth, watch, type, cdata, global_root = parse_options(options)
+
+        script = "define('#{namespace}',[],function(){" 
+        script << amd_formatted_data(namespace, cameled, camel_depth, watch, global_root)
+        script << 'return gon;});'
+
+        script = Gon::Escaper.escape_unicode(script)
+        script = Gon::Escaper.javascript_tag(script, type, cdata) if tag
+
+        script.html_safe
+      end
+
       def get_controller(options = {})
         options[:controller] ||
           (
@@ -56,8 +69,9 @@ class Gon
         type        = options[:type].nil? || options[:type]
         cdata       = options[:cdata].nil? || options[:cdata]
         global_root = options.has_key?(:global_root) ? options[:global_root] : 'global'
+        namespace_check = options.has_key?(:namespace_check) ? options[:namespace_check] : false
 
-        [namespace, tag, cameled, camel_depth, watch, type, cdata, global_root]
+        [namespace, tag, cameled, camel_depth, watch, type, cdata, global_root, namespace_check]
       end
 
       def formatted_data(namespace, keys_cameled, camel_depth, watch, global_root)
@@ -75,6 +89,21 @@ class Gon
         script
       end
 
+      def amd_formatted_data(namespace, keys_cameled, camel_depth, watch, global_root)
+        script = 'var gon={};'
+
+        gon_variables(global_root).each do |key, val|
+          js_key = keys_cameled ? key.to_s.camelize(:lower) : key.to_s
+          script << "gon['#{js_key}']=#{to_json(val, camel_depth)};"
+        end
+
+        if watch and Gon::Watch.all_variables.present?
+          script << Gon.watch.render_amd
+        end
+
+        script
+      end
+
       def to_json(value, camel_depth)
         # starts at 2 because 1 is the root key which is converted in the formatted_data method
         Gon::JsonDumper.dump convert_hash_keys(value, 2, camel_depth)

data/lib/gon/helpers.rb

@@ -14,6 +14,10 @@ class Gon
       end
     end
 
+    def include_gon_amd(options={})
+      Gon::Base.render_data_amd(options)
+    end
+
     private
 
     def variables_for_request_present?

data/lib/gon/spec_helpers.rb

@@ -7,8 +7,11 @@ class Gon
         module GonSession
           def process(*)
             # preload threadlocal & store controller instance
-            controller.gon
-            Gon.send(:current_gon).env[Gon::Base::ENV_CONTROLLER_KEY] = controller
+            if controller.is_a? ActionController::Base
+              controller.gon
+              Gon.send(:current_gon).env[Gon::Base::ENV_CONTROLLER_KEY] =
+               controller
+            end
             super
           end
         end

data/lib/gon/version.rb

@@ -1,3 +1,3 @@
 class Gon
-  VERSION = '5.1.2'
+  VERSION = '5.2.0'
 end

data/lib/gon/watch.rb

@@ -8,6 +8,10 @@ class Gon
         JS_FUNCTION + "window.gon.watchedVariables=#{Gon::JsonDumper.dump all_variables};"
       end
 
+      def render_amd
+        JS_FUNCTION + "gon.watchedVariables=#{Gon::JsonDumper.dump all_variables};"
+      end
+
       def all_variables
         @watch_variables || {}
       end

data/spec/gon/basic_spec.rb

@@ -208,6 +208,98 @@ describe Gon do
       )
     end
 
+    it 'outputs correct js with namespace check' do
+      expect(@base.include_gon(namespace_check: true)).to eq( \
+                                  '<script type="text/javascript">' +
+                                    "\n//<![CDATA[\n" +
+                                    'window.gon=window.gon||{};'\
+                                    "\n//]]>\n" +
+                                  '</script>'
+      )
+    end
+
+    it 'outputs correct js without namespace check' do
+      expect(@base.include_gon(namespace_check: false)).to eq( \
+                                  '<script type="text/javascript">' +
+                                    "\n//<![CDATA[\n" +
+                                    'window.gon={};'\
+                                    "\n//]]>\n" +
+                                  '</script>'
+      )
+    end
+
+    context "without a current_gon instance" do
+
+      before(:each) do
+        RequestStore.store[:gon] = nil
+        allow(Gon).to receive(:current_gon).and_return(nil)
+      end
+
+      it "does not raise an exception" do
+        expect { @base.include_gon }.to_not raise_error(Exception)
+      end
+
+      it 'outputs correct js' do
+        expect(@base.include_gon).to eq("")
+      end
+
+      it 'outputs correct js with init' do
+        expect(@base.include_gon(init: true)).to eq( \
+                                    '<script type="text/javascript">' +
+                                      "\n//<![CDATA[\n" +
+                                      'window.gon={};'\
+                                      "\n//]]>\n" +
+                                    '</script>'
+        )
+      end
+
+    end
+
+
+  end
+
+  describe '#include_gon_amd' do
+
+    before(:each) do
+      Gon.clear
+      Gon::Request.
+        instance_variable_set(:@request_id, request.object_id)
+      @base = ActionView::Base.new
+      @base.request = request
+    end
+
+    it 'is included in ActionView::Base as a helper' do
+      expect(ActionView::Base.
+        instance_methods.
+        map(&:to_s).
+        include?('include_gon_amd')).to eq(true)
+    end
+
+    it 'outputs correct js without variables' do
+      expect(@base.include_gon_amd).to eq( wrap_script( \
+                                    'define(\'gon\',[],function(){'+
+                                    'var gon={};return gon;'+
+                                    '});')
+      )
+    end
+
+    it 'outputs correct js with an integer' do
+      Gon.int = 1
+
+      expect(@base.include_gon_amd).to eq( wrap_script( 
+                                    'define(\'gon\',[],function(){'+
+                                    'var gon={};gon[\'int\']=1;return gon;'+
+                                    '});')
+      )
+    end
+
+    it 'outputs correct module name when given a namespace' do
+      expect(@base.include_gon_amd(namespace: 'data')).to eq(wrap_script( 
+                                    'define(\'data\',[],function(){'+
+                                    'var gon={};return gon;'+
+                                    '});')
+      )
+    end
   end
 
   it 'returns exception if try to set public method as variable' do
@@ -239,4 +331,12 @@ describe Gon do
     @request ||= double 'request', :env => {}
   end
 
+  def wrap_script(content, type='text/javascript', cdata=true)
+    script = "<script type=\"#{type}\">"
+    script << "\n//<![CDATA[\n" if cdata
+    script << content
+    script << "\n//]]>\n" if cdata
+    script << '</script>'
+  end
+
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: gon
 version: !ruby/object:Gem::Version
-  version: 5.1.2
+  version: 5.2.0
 platform: ruby
 authors:
 - gazay
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-07-23 00:00:00.000000000 Z
+date: 2014-08-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: actionpack