gon 5.2.3 → 6.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 43277ce7c2fa158208c211171b2e2e522ed84cfa
-  data.tar.gz: 161e43d9aada6fe673fd2f938c856defdcb59810
+  metadata.gz: 1797244a5882bb22566a77182ee6e1c3f5327998
+  data.tar.gz: 506c013713108e2f32a57b1c4ddd3bf734bfc9bc
 SHA512:
-  metadata.gz: 54085e90ee7e4dbc0a754b6e56b273943fd9f2fb972073a6abd86875a1c067f740f6a79a2e02c133dc437e666181f8adfa54451087a0d5343be96c07ea7a659c
-  data.tar.gz: 15c74e24cdfa5e890d6ceb0b408acce28259748ed157d58a1ebcef3bebc1d6ebd21bceec6a93e14c354f9876ffd81abe7721cc6fedd3c12e72305be26a18c2b8
+  metadata.gz: 2352e7136f09f3f4bb709e75b29105f9793d1e67b7150cecbc6353877423a1271727d88118dedd2397cc756c471558c2285ed91d9f191e64e19fd39be68d29f9
+  data.tar.gz: 0c8c02ed9855110af818b65f30884bc648bd6bd4a1224e43c1000f7da6355c075af91cf44b471c303c0d2340a4138172f2aed1475ffa6e50d73233b493f8ec98

data/.travis.yml

@@ -1,9 +1,10 @@
 language: ruby
+sudo: false
 rvm:
   - 1.9.3
   - 2.0.0
-  - 2.1.0
-  - 2.1.4
+  - 2.1.6
+  - 2.2.2
   - jruby-19mode # JRuby in 1.9 mode
   - rbx
 matrix:

data/CHANGELOG.md

@@ -1,5 +1,12 @@
 # CHANGELOG
 
+## 6.0.0
+
+  * Refactoring
+  * nonce option. Thanks to @joeljackson
+  * Included rails url_helpers into jbuilder. Thanks to @razum2um
+  * Welcome @takiy33 as contributor!
+
 ## 5.2.3
 
   * Coffescript implementation of watch.js. Thanks to @willcosgrove

data/Gemfile

@@ -1,4 +1,4 @@
-source "http://rubygems.org"
+source "https://rubygems.org"
 
 # Specify your gem's dependencies in gon.gemspec
 gemspec

data/LICENSE

@@ -1,6 +1,6 @@
 The MIT License
 
-Copyright (c) 2011-2014 gazay
+Copyright (c) 2011-2015 gazay
 
 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:
 

data/README.md

@@ -1,9 +1,10 @@
 # Gon gem — get your Rails variables in your js
 
+[![Join the chat at https://gitter.im/gazay/gon](https://badges.gitter.im/Join%20Chat.svg)](https://gitter.im/gazay/gon?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
+
 ![Gon. You should try this. If you look closer - you will see an elephant.](https://github.com/gazay/gon/raw/master/doc/logo_small.png)
 
-[![Build Status](https://secure.travis-ci.org/gazay/gon.png)](http://travis-ci.org/gazay/gon) [![CodeClimate](https://codeclimate.com/github/gazay/gon.png)](https://codeclimate.com/github/gazay/gon)
-[![gon API Documentation](https://www.omniref.com/ruby/gems/gon.png)](https://www.omniref.com/ruby/gems/gon)
+[![Build Status](https://secure.travis-ci.org/gazay/gon.png)](http://travis-ci.org/gazay/gon) [![CodeClimate](https://codeclimate.com/github/gazay/gon/badges/gpa.svg)](https://codeclimate.com/github/gazay/gon)
 
 If you need to send some data to your js files and you don't want to do this with long way through views and parsing - use this force!
 
@@ -15,6 +16,10 @@ For Sinatra available [gon-sinatra](https://github.com/gazay/gon-sinatra).
 
 For .Net MVC available port [NGon](https://github.com/brooklynDev/NGon).
 
+<a href="https://evilmartians.com/?utm_source=gon">
+<img src="https://evilmartians.com/badges/sponsored-by-evil-martians.svg" alt="Sponsored by Evil Martians" width="236" height="54">
+</a>
+
 ## An example of typical use
 
 ### Very good and detailed example and reasons to use is considered in [railscast](http://railscasts.com/episodes/324-passing-data-to-javascript) by Ryan Bates
@@ -68,9 +73,6 @@ in modern web applications!
 
 ### More details about configuration and usage you can find in [gon wiki](https://github.com/gazay/gon/wiki)
 
-Old readme available in [./README_old.md](https://github.com/gazay/gon/blob/master/README_old.md)
-
-
 `app/views/layouts/application.html.erb`
 
 ``` erb
@@ -81,6 +83,14 @@ Old readme available in [./README_old.md](https://github.com/gazay/gon/blob/mast
   ...
 ```
 
+For rails 4:
+``` erb
+  <%= Gon::Base.render_data %>
+  ...
+```
+
+
+
 You can pass some [options](https://github.com/gazay/gon/wiki/Options)
 to `include_gon` method.
 
@@ -113,10 +123,10 @@ 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. 
+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
@@ -218,6 +228,7 @@ Gon uses `MultiJson` with autodetect mode, so all you need is just require your
 ## Contributors
 
 * @gazay
+* @takiy33
 
 Special thanks to @brainopia, @kossnocorp and @ai.
 

data/Rakefile

@@ -1,5 +1,3 @@
-require 'rubygems'
-require 'rake'
 require 'bundler'
 Bundler::GemHelper.install_tasks
 

data/gon.gemspec

@@ -13,19 +13,17 @@ Gem::Specification.new do |s|
   s.summary     = %q{Get your Rails variables in your JS}
   s.description = %q{If you need to send some data to your js files and you don't want to do this with long way trough views and parsing - use this force!}
 
-  s.rubyforge_project = 'gon'
-
   s.files         = `git ls-files`.split("\n")
-  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
-  s.executables   = `git ls-files -- bin/*`.split("\n").map { |f| File.basename(f) }
   s.require_paths = ['lib']
-  s.add_dependency 'actionpack', '>= 2.3.0'
-  s.add_dependency 'request_store', '>= 1.0.5'
-  s.add_dependency 'json'
-  s.add_dependency 'multi_json'
-  s.add_development_dependency 'rabl'
-  s.add_development_dependency 'rabl-rails'
-  s.add_development_dependency 'rspec'
-  s.add_development_dependency 'jbuilder'
-  s.add_development_dependency 'rake'
+  s.required_ruby_version = '> 1.8.7'
+  s.add_dependency 'actionpack', '~> 2.3'
+  s.add_dependency 'request_store', '~> 1.0'
+  s.add_dependency 'json', '~> 0'
+  s.add_dependency 'multi_json', '~> 0'
+  s.add_development_dependency 'rabl', '0.11.3'
+  s.add_development_dependency 'rabl-rails', '~> 0'
+  s.add_development_dependency 'rspec', '~> 3.0'
+  s.add_development_dependency 'jbuilder', '~> 0'
+  s.add_development_dependency 'railties', '~> 2.3'
+  s.add_development_dependency 'rake', '~> 0'
 end

data/lib/gon.rb

@@ -4,6 +4,7 @@ require 'action_controller'
 require 'multi_json'
 
 require 'gon/base'
+require 'gon/env_finder'
 require 'gon/global'
 require 'gon/watch'
 require 'gon/request'
@@ -11,6 +12,7 @@ require 'gon/helpers'
 require 'gon/escaper'
 require 'gon/rabl'
 require 'gon/jbuilder'
+require 'gon/jbuilder/parser'
 require 'gon/json_dumper'
 
 # NOTE : ActionDispatch::Request#uuid appears only in Rails 3.2.1
@@ -116,13 +118,7 @@ class Gon
     end
 
     def public_method_name?(method)
-      public_methods.include?(
-        if RUBY_VERSION > '1.9'
-          method.to_s[0..-2].to_sym
-        else
-          method.to_s[0..-2]
-        end
-      )
+      public_methods.include?(method.to_s[0..-2].to_sym)
     end
 
     # JbuilderTemplate will not be defined if jbuilder is required

data/lib/gon/base.rb

@@ -1,107 +1,92 @@
+require 'ostruct'
+
 class Gon
   module Base
-    ENV_CONTROLLER_KEY = 'action_controller.instance'
+    VALID_OPTION_DEFAULTS = {
+        namespace: 'gon',
+        camel_case: false,
+        camel_depth: 1,
+        watch: false,
+        need_tag: true,
+        type: false,
+        cdata: true,
+        global_root: 'global',
+        namespace_check: false,
+        amd: false,
+        nonce: nil
+    }
 
     class << self
 
-      def render_data(options)
-        namespace, tag, cameled, camel_depth, watch, type, cdata, global_root, namespace_check = parse_options(options)
-        script = namespace_check ? "window.#{namespace}=window.#{namespace}||{};" : "window.#{namespace}={};"
+      def render_data(options = {})
+        _o = define_options(options)
 
-        script << formatted_data(namespace, cameled, camel_depth, watch, global_root)
+        script = formatted_data(_o)
         script = Gon::Escaper.escape_unicode(script)
-        script = Gon::Escaper.javascript_tag(script, type, cdata) if tag
+        script = Gon::Escaper.javascript_tag(script, _o.type, _o.cdata, _o.nonce) if _o.tag
 
         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
+      private
 
-      def get_controller(options = {})
-        options[:controller] ||
-          (
-            current_gon &&
-            current_gon.env[Gon::Base::ENV_CONTROLLER_KEY] ||
-            current_gon.env['action_controller.rescue.response'].
-              instance_variable_get('@template').
-              instance_variable_get('@controller')
-          )
-      end
+      def define_options(options)
+        _o = OpenStruct.new
 
-      def get_template_path(options, extension)
-        if options[:template]
-          if right_extension?(extension, options[:template])
-            options[:template]
-          else
-            [options[:template], extension].join('.')
-          end
-        else
-          controller = get_controller(options).controller_path
-          action = get_controller(options).action_name
-          "app/views/#{controller}/#{action}.json.#{extension}"
+        VALID_OPTION_DEFAULTS.each do |opt_name, default|
+          _o.send("#{opt_name}=", options.fetch(opt_name, default))
         end
-      end
-
-      private
-
-      def current_gon
-        RequestStore.store[:gon]
-      end
+        _o.watch     = options[:watch] || !Gon.watch.all_variables.empty?
+        _o.tag       = _o.need_tag
+        _o.cameled   = _o.camel_case
 
-      def parse_options(options)
-        namespace   = options[:namespace] || 'gon'
-        need_tag    = options[:need_tag].nil? || options[:need_tag]
-        cameled     = options[:camel_case]
-        camel_depth = options[:camel_depth] || 1
-        watch       = options[:watch] || !Gon.watch.all_variables.empty?
-        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_check = options.has_key?(:namespace_check) ? options[:namespace_check] : false
-
-        [namespace, tag, cameled, camel_depth, watch, type, cdata, global_root, namespace_check]
+        _o
       end
 
-      def formatted_data(namespace, keys_cameled, camel_depth, watch, global_root)
+      def formatted_data(_o)
         script = ''
+        before, after = render_wrap(_o)
+        script << before
 
-        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
-
-        if watch and Gon::Watch.all_variables.present?
-          script << Gon.watch.render
-        end
+        script << gon_variables(_o.global_root).
+                    map { |key, val| render_variable(_o, key, val) }.join
+        script << (render_watch(_o) || '')
 
+        script << after
         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)};"
+      def render_wrap(_o)
+        if _o.amd
+          ["define('#{_o.namespace}',[],function(){var gon={};", 'return gon;});']
+        else
+          before = \
+            if _o.namespace_check
+              "window.#{_o.namespace}=window.#{_o.namespace}||{};"
+            else
+              "window.#{_o.namespace}={};"
+            end
+          [before, '']
         end
+      end
 
-        if watch and Gon::Watch.all_variables.present?
-          script << Gon.watch.render_amd
+      def render_variable(_o, key, value)
+        js_key = _o.cameled ? key.to_s.camelize(:lower) : key.to_s
+        if _o.amd
+          "gon['#{js_key}']=#{to_json(value, _o.camel_depth)};"
+        else
+          "#{_o.namespace}.#{js_key}=#{to_json(value, _o.camel_depth)};"
         end
+      end
 
-        script
+      def render_watch(_o)
+        if _o.watch and Gon::Watch.all_variables.present?
+          if _o.amd
+            Gon.watch.render_amd
+          else
+            Gon.watch.render
+          end
+        end
       end
 
       def to_json(value, camel_depth)
@@ -113,14 +98,14 @@ class Gon
         return value if current_depth > (max_depth.is_a?(Symbol) ? 1000 : max_depth)
 
         case value
-          when Hash
-            Hash[value.map { |k, v|
-              [ k.to_s.camelize(:lower), convert_hash_keys(v, current_depth + 1, max_depth) ]
-            }]
-          when Enumerable
-            value.map { |v| convert_hash_keys(v, current_depth + 1, max_depth) }
-          else
-            value
+        when Hash
+          Hash[value.map { |k, v|
+            [ k.to_s.camelize(:lower), convert_hash_keys(v, current_depth + 1, max_depth) ]
+          }]
+        when Enumerable
+          value.map { |v| convert_hash_keys(v, current_depth + 1, max_depth) }
+        else
+          value
         end
       end
 
@@ -138,10 +123,6 @@ class Gon
         data.merge(Gon.all_variables)
       end
 
-      def right_extension?(extension, template_path)
-        File.extname(template_path) == ".#{extension}"
-      end
-
     end
   end
 end

data/lib/gon/env_finder.rb

@@ -0,0 +1,46 @@
+class Gon
+  module EnvFinder
+    ENV_CONTROLLER_KEY = 'action_controller.instance'
+    ENV_RESPONSE_KEY = 'action_controller.rescue.response'
+
+    class << self
+
+      def controller_env(options = {})
+        options[:controller] ||
+          (
+            current_gon &&
+            current_gon.env[ENV_CONTROLLER_KEY] ||
+            current_gon.env[ENV_RESPONSE_KEY].
+              instance_variable_get('@template').
+              instance_variable_get('@controller')
+          )
+      end
+
+      def template_path(options, extension)
+        if options[:template]
+          if right_extension?(extension, options[:template])
+            options[:template]
+          else
+            [options[:template], extension].join('.')
+          end
+        else
+          controller = controller_env(options).controller_path
+          action = controller_env(options).action_name
+          "app/views/#{controller}/#{action}.json.#{extension}"
+        end
+      end
+
+      private
+
+      def right_extension?(extension, template_path)
+        File.extname(template_path) == ".#{extension}"
+      end
+
+      def current_gon
+        RequestStore.store[:gon]
+      end
+
+    end
+
+  end
+end

data/lib/gon/escaper.rb

@@ -12,9 +12,12 @@ class Gon
         end
       end
 
-      def javascript_tag(content, type, cdata)
-        type = { type: 'text/javascript' } if type
-        content_tag(:script, javascript_cdata_section(content, cdata).html_safe, type)
+      def javascript_tag(content, type, cdata, nonce)
+        options = {}
+        options.merge!( { type: 'text/javascript' } ) if type
+        options.merge!( { nonce: nonce } ) if nonce
+
+        content_tag(:script, javascript_cdata_section(content, cdata).html_safe, options)
       end
 
       def javascript_cdata_section(content, cdata)