gon 2.0.6 → 2.1.0

data/README.md

@@ -1,5 +1,7 @@
 # Gon gem — get your Rails variables in your js
 
+![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)
+
 
 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!
 
@@ -9,6 +11,8 @@ For Sinatra available [gon-sinatra](https://github.com/gazay/gon-sinatra).
 
 ## 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
+
 When you need to send some start data from your controller to your js
 you might be doing something like this:
 
@@ -124,6 +128,14 @@ alert(customNamespace.yourHash)
 Now you can write your variables assign logic to templates with [Rabl](https://github.com/nesquena/rabl).
 The way of writing Rabl templates is very clearly described in their repo.
 
+Add Rabl to your Gemfile
+
+  `Gemfile`
+
+  ``` ruby
+  gem 'rabl'
+  ```
+
 Profit of using Rabl with gon:
 
   1. You can clean your controllers now!
@@ -292,7 +304,7 @@ Special thanks to @brainopia, @kossnocorp and @ai.
 
 The MIT License
 
-Copyright (c) 2011 gazay
+Copyright (c) 2011-2012 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/gon.gemspec

@@ -19,8 +19,8 @@ Gem::Specification.new do |s|
   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 "rabl"
   s.add_dependency "json"
+  s.add_development_dependency "rabl"
   s.add_development_dependency "rspec"
   s.add_development_dependency "jbuilder"
 end

data/lib/gon.rb

@@ -4,17 +4,24 @@ end
 require 'action_view'
 require 'action_controller'
 require 'gon/helpers'
-require 'gon/rabl'
+if defined?(Rabl)
+  require 'gon/rabl'
+end
 if RUBY_VERSION =~ /9/ && defined?(Jbuilder)
   require 'gon/jbuilder'
 end
 
 module Gon
   class << self
+
     def all_variables
       @request_env[:gon]
     end
 
+    def all_variables=(values)
+      raise "You can't use Gon public methods for storing data"
+    end
+
     def clear
       @request_env[:gon] = {}
     end
@@ -35,7 +42,7 @@ module Gon
     end
 
     def request=(request_id)
-      @request_id = request_id      
+      @request_id = request_id
     end
 
     def method_missing(m, *args, &block)
@@ -57,9 +64,14 @@ module Gon
       @request_env[:gon][name] = value
     end
 
+    # TODO: Remove required argument view_path, and by default use current action
     def rabl(view_path, options = {})
-      rabl_data = Gon::Rabl.parse_rabl(view_path, options[:controller] || 
-                                                  @request_env['action_controller.instance'] || 
+      if !defined?(Gon::Rabl)
+        raise NoMethodError.new('You should define Rabl in your Gemfile')
+      end
+
+      rabl_data = Gon::Rabl.parse_rabl(view_path, options[:controller] ||
+                                                  @request_env['action_controller.instance'] ||
                                                   @request_env['action_controller.rescue.response'].
                                                     instance_variable_get('@template').
                                                     instance_variable_get('@controller'))
@@ -76,13 +88,13 @@ module Gon
 
     def jbuilder(view_path, options = {})
       if RUBY_VERSION !~ /9/
-        raise NoMethodError.new('You can use Jbuilder support only in 1.9+') 
+        raise NoMethodError.new('You can use Jbuilder support only in 1.9+')
       elsif !defined?(Gon::Jbuilder)
-        raise NoMethodError.new('You should define Jbuilder in your Gemfile') 
+        raise NoMethodError.new('You should define Jbuilder in your Gemfile')
       end
 
-      jbuilder_data = Gon::Jbuilder.parse_jbuilder(view_path, options[:controller] || 
-                                                  @request_env['action_controller.instance'] || 
+      jbuilder_data = Gon::Jbuilder.parse_jbuilder(view_path, options[:controller] ||
+                                                  @request_env['action_controller.instance'] ||
                                                   @request_env['action_controller.rescue.response'].
                                                     instance_variable_get('@template').
                                                     instance_variable_get('@controller'))
@@ -97,4 +109,5 @@ module Gon
       end
     end
   end
+
 end

data/lib/gon/helpers.rb

@@ -1,5 +1,6 @@
 module Gon
   module Helpers
+
     def self.included base
       base.send(:include, InstanceMethods)
     end
@@ -9,17 +10,17 @@ module Gon
         if Gon.request_env && Gon.all_variables.present?
           data = Gon.all_variables
           namespace = options[:namespace] || 'gon'
-          script = "<script>window." + namespace + " = {};"
-          unless options[:camel_case]
+          script = '<script>window.' + namespace + ' = {};'
+          if options[:camel_case]
             data.each do |key, val|
-              script += namespace + "." + key.to_s + '=' + val.to_json + ";"
+              script << namespace + '.' + key.to_s.camelize(:lower) + '=' + val.to_json + ';'
             end
           else
             data.each do |key, val|
-              script += namespace + "." + key.to_s.camelize(:lower) + '=' + val.to_json + ";"
+              script << namespace + '.' + key.to_s + '=' + val.to_json + ';'
             end
           end
-          script += "</script>"
+          script << '</script>'
           script.html_safe
         else
           ""
@@ -43,6 +44,7 @@ module Gon
       end
     end
   end
+
 end
 
 ActionView::Base.send :include, Gon::Helpers

data/lib/gon/jbuilder.rb

@@ -41,6 +41,7 @@ module Gon
           end
         end.flatten
       end
+
     end
   end
 end

data/lib/gon/rabl.rb

@@ -3,12 +3,14 @@ require 'rabl'
 module Gon
   module Rabl
     class << self
+
       def parse_rabl(rabl_path, controller)
         source = File.read(rabl_path)
         rabl_engine = ::Rabl::Engine.new(source, :format => 'json')
         output = rabl_engine.render(controller, {})
         JSON.parse(output)
       end
+
     end
   end
 end

data/lib/gon/version.rb

@@ -1,3 +1,3 @@
 module Gon
-  VERSION = '2.0.6'
+  VERSION = '2.1.0'
 end

data/spec/gon/gon_spec.rb

@@ -1,7 +1,7 @@
 # gon_spec_rb
 require 'gon'
 
-describe Gon, '#all_variables' do 
+describe Gon, '#all_variables' do
 
   before(:each) do
     Gon.request_env = {}
@@ -41,13 +41,26 @@ describe Gon, '#all_variables' do
     lambda { Gon.all_variables = 123 }.should raise_error
   end
 
-  it 'render json from rabl template' do
-    Gon.clear
-    controller = ActionController::Base.new
-    objects = [1,2]
-    controller.instance_variable_set('@objects', objects)
-    Gon.rabl 'spec/test_data/sample.rabl', :controller => controller
-    Gon.objects.length.should == 2
+  context 'render json from rabl template' do
+    before :each do
+      Gon.clear
+      controller.instance_variable_set('@objects', objects)
+    end
+
+    let(:controller) { ActionController::Base.new}
+    let(:objects) { [1,2]}
+
+    it 'raises an error if rabl is not included' do
+      expect { Gon.rabl 'spec/test_data/sample.rabl', :controller => controller}.to raise_error
+    end
+
+    it 'works if rabl is included' do
+      require 'rabl'
+      require 'gon/rabl'
+      Gon.rabl 'spec/test_data/sample.rabl', :controller => controller
+      Gon.objects.length.should == 2
+    end
+
   end
 
   if RUBY_VERSION =~ /1.9/

metadata

@@ -1,7 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: gon
 version: !ruby/object:Gem::Version 
-  version: 2.0.6
+  hash: 11
+  prerelease: 
+  segments: 
+  - 2
+  - 1
+  - 0
+  version: 2.1.0
 platform: ruby
 authors: 
 - gazay
@@ -9,59 +15,80 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2012-01-23 00:00:00 +08:00
-default_executable: 
+date: 2012-02-15 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: actionpack
-  type: :runtime
-  version_requirement: 
-  version_requirements: !ruby/object:Gem::Requirement 
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 2
+        - 3
+        - 0
         version: 2.3.0
-    version: 
-- !ruby/object:Gem::Dependency 
-  name: rabl
   type: :runtime
-  version_requirement: 
-  version_requirements: !ruby/object:Gem::Requirement 
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: json
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
         version: "0"
-    version: 
-- !ruby/object:Gem::Dependency 
-  name: json
   type: :runtime
-  version_requirement: 
-  version_requirements: !ruby/object:Gem::Requirement 
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: rabl
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
         version: "0"
-    version: 
+  type: :development
+  version_requirements: *id003
 - !ruby/object:Gem::Dependency 
   name: rspec
-  type: :development
-  version_requirement: 
-  version_requirements: !ruby/object:Gem::Requirement 
+  prerelease: false
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
         version: "0"
-    version: 
+  type: :development
+  version_requirements: *id004
 - !ruby/object:Gem::Dependency 
   name: jbuilder
-  type: :development
-  version_requirement: 
-  version_requirements: !ruby/object:Gem::Requirement 
+  prerelease: false
+  requirement: &id005 !ruby/object:Gem::Requirement 
+    none: false
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
         version: "0"
-    version: 
+  type: :development
+  version_requirements: *id005
 description: 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!
 email: 
 - alex.gaziev@gmail.com
@@ -76,6 +103,8 @@ files:
 - Gemfile
 - README.md
 - Rakefile
+- doc/logo.png
+- doc/logo_small.png
 - gon.gemspec
 - lib/gon.rb
 - lib/gon/helpers.rb
@@ -87,7 +116,6 @@ files:
 - spec/test_data/sample.json.jbuilder
 - spec/test_data/sample.rabl
 - spec/test_data/sample_with_partial.json.jbuilder
-has_rdoc: true
 homepage: https://github.com/gazay/gon
 licenses: []
 
@@ -97,21 +125,27 @@ rdoc_options: []
 require_paths: 
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
       version: "0"
-  version: 
 required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
       version: "0"
-  version: 
 requirements: []
 
 rubyforge_project: gon
-rubygems_version: 1.3.5
+rubygems_version: 1.8.15
 signing_key: 
 specification_version: 3
 summary: Get your Rails variables in your JS