gon 2.3.0 → 3.0.0

data/lib/gon/rabl.rb

@@ -1,9 +1,27 @@
+require 'action_view'
 require 'rabl'
 
 module Gon
   module Rabl
     class << self
 
+      def handler(args, global = false)
+        options = parse_options_from args, global
+        if global && !options[:template]
+          raise 'You should provide :template when use rabl with global variables'
+        end
+
+        include_helpers
+
+        data = parse_rabl \
+          Gon::Base.get_template_path(options, 'rabl'),
+          Gon::Base.get_controller(options)
+
+        [data, options]
+      end
+
+      private
+
       def parse_rabl(rabl_path, controller)
         source = File.read(rabl_path)
         rabl_engine = ::Rabl::Engine.new(source, :format => 'json')
@@ -11,6 +29,37 @@ module Gon
         JSON.parse(output)
       end
 
+      def parse_options_from(args, global)
+        if old_api? args
+          unless global
+            text =  "[DEPRECATION] view_path argument is now optional. "
+            text << "If you need to specify it, "
+            text << "please use gon.rabl(:template => 'path')"
+            warn text
+          end
+
+          args.extract_options!.merge(:template => args[0])
+        elsif new_api? args
+          args.first
+        else
+          {}
+        end
+      end
+
+      def include_helpers
+        unless ::Rabl::Engine.include? ::ActionView::Helpers
+          ::Rabl::Engine.send(:include, ::ActionView::Helpers)
+        end
+      end
+
+      def old_api?(args)
+        args.first.is_a? String
+      end
+
+      def new_api?(args)
+        args.first.is_a? Hash
+      end
+
     end
   end
 end

data/lib/gon/request.rb

@@ -0,0 +1,32 @@
+module Gon
+  module Request
+    class << self
+
+      def env
+        @request_env if defined? @request_env
+      end
+
+      def env=(environment)
+        @request_env = environment
+        @request_env['gon'] ||= {}
+      end
+
+      def id
+        @request_id if defined? @request_id
+      end
+
+      def id=(request_id)
+        @request_id = request_id
+      end
+
+      def gon
+        env['gon'] if env
+      end
+
+      def clear
+        @request_env['gon'] = {}
+      end
+
+    end
+  end
+end

data/lib/gon/version.rb

@@ -1,3 +1,3 @@
 module Gon
-  VERSION = '2.3.0'
+  VERSION = '3.0.0'
 end

data/spec/gon/basic_spec.rb

@@ -0,0 +1,79 @@
+require 'gon'
+
+describe Gon do
+
+  before(:each) do
+    Gon::Request.env = {}
+  end
+
+  describe '#all_variables' do
+
+    it 'returns all variables in hash' do
+      Gon.a = 1
+      Gon.b = 2
+      Gon.c = Gon.a + Gon.b
+      Gon.c.should == 3
+      Gon.all_variables.should == {'a' => 1, 'b' => 2, 'c' => 3}
+    end
+
+    it 'supports all data types' do
+      Gon.clear
+      Gon.int = 1
+      Gon.float = 1.1
+      Gon.string = 'string'
+      Gon.array = [ 1, 'string' ]
+      Gon.hash_var = { :a => 1, :b => '2'}
+      Gon.hash_w_array = { :a => [ 2, 3 ] }
+      Gon.klass = Hash
+    end
+
+  end
+
+  describe '#include_gon' do
+
+    before(:each) do
+      Gon.clear
+      Gon::Request.
+        instance_variable_set(:@request_id, request.object_id)
+      ActionView::Base.
+        instance_methods.
+        map(&:to_s).
+        include?('include_gon').should == true
+      @base = ActionView::Base.new
+      @base.request = request
+    end
+
+    it 'outputs correct js with an integer' do
+      Gon.int = 1
+      @base.include_gon.should == '<script>window.gon = {};' +
+                                    'gon.int=1;' +
+                                  '</script>'
+    end
+
+    it 'outputs correct js with a string' do
+      Gon.str = %q(a'b"c)
+      @base.include_gon.should == '<script>window.gon = {};' +
+                                    %q(gon.str="a'b\"c";) +
+                                  '</script>'
+    end
+
+    it 'outputs correct js with a script string' do
+      Gon.str = %q(</script><script>alert('!')</script>)
+      @base.include_gon.should == '<script>window.gon = {};' +
+                                    %q(gon.str="<\\/script><script>alert('!')<\\/script>";) +
+                                  '</script>'
+    end
+
+  end
+
+  it 'returns exception if try to set public method as variable' do
+    Gon.clear
+    lambda { Gon.all_variables = 123 }.should raise_error
+    lambda { Gon.rabl = 123 }.should raise_error
+  end
+
+  def request
+    @request ||= double 'request', :env => {}
+  end
+
+end

data/spec/gon/global_spec.rb

@@ -0,0 +1,120 @@
+require 'gon'
+
+describe Gon::Global do
+
+  before(:each) do
+    Gon::Global.clear
+  end
+
+  describe '#all_variables' do
+
+    it 'returns all variables in hash' do
+      Gon.global.a = 1
+      Gon.global.b = 2
+      Gon.global.c = Gon.global.a + Gon.global.b
+      Gon.global.c.should == 3
+      Gon.global.all_variables.should == {'a' => 1, 'b' => 2, 'c' => 3}
+    end
+
+    it 'supports all data types' do
+      Gon.global.clear
+      Gon.global.int = 1
+      Gon.global.float = 1.1
+      Gon.global.string = 'string'
+      Gon.global.array = [ 1, 'string' ]
+      Gon.global.hash_var = { :a => 1, :b => '2'}
+      Gon.global.hash_w_array = { :a => [ 2, 3 ] }
+      Gon.global.klass = Hash
+    end
+
+  end
+
+  describe '#include_gon' do
+
+    before(:each) do
+      Gon.clear
+      Gon.global.clear
+      ActionView::Base.
+        instance_methods.
+        map(&:to_s).
+        include?('include_gon').should == true
+      @base = ActionView::Base.new
+      @base.request = request
+    end
+
+    it 'outputs correct js with an integer' do
+      Gon.global.int = 1
+      @base.include_gon.should == "<script>window.gon = {};" +
+                                    "gon.global={\"int\":1};" +
+                                  "</script>"
+    end
+
+    it 'outputs correct js with an integer and integer in Gon' do
+      Gon::Request.
+        instance_variable_set(:@request_id, request.object_id)
+      Gon.int = 1
+      Gon.global.int = 1
+      @base.include_gon.should == "<script>window.gon = {};" +
+                                    "gon.int=1;" +
+                                    "gon.global={\"int\":1};" +
+                                  "</script>"
+    end
+
+    it 'outputs correct js with a string' do
+      Gon.global.str = %q(a'b"c)
+      @base.include_gon.should == "<script>window.gon = {};" +
+                                    "gon.global={\"str\":\"a'b\\\"c\"};" +
+                                  "</script>"
+    end
+
+    it 'outputs correct js with a script string' do
+      Gon.global.str = %q(</script><script>alert('!')</script>)
+      @base.include_gon.should == "<script>window.gon = {};" +
+                                    "gon.global={\"str\":\"<\\/script><script>alert('!')<\\/script>\"};" +
+                                  "</script>"
+    end
+
+  end
+
+  it 'returns exception if try to set public method as variable' do
+    Gon.global.clear
+    lambda { Gon.global.all_variables = 123 }.should raise_error
+    lambda { Gon.global.rabl = 123 }.should raise_error
+  end
+
+  context 'with jbuilder and rabl' do
+
+    before :each do
+      Gon.global.clear
+      controller.instance_variable_set('@objects', objects)
+    end
+
+    let(:controller) { ActionController::Base.new }
+    let(:objects) { [1,2] }
+
+    it 'works fine with rabl' do
+      Gon.global.rabl :template =>'spec/test_data/sample.rabl', :controller => controller
+      Gon.global.objects.length.should == 2
+    end
+
+    it 'works fine with jbuilder' do
+      Gon.global.jbuilder :template =>'spec/test_data/sample.json.jbuilder', :controller => controller
+      Gon.global.objects.length.should == 2
+    end
+
+    it 'should throw exception, if use rabl or jbuilder without :template' do
+      lambda { Gon.global.rabl }.should raise_error
+      lambda { Gon.global.jbuilder }.should raise_error
+    end
+
+  end
+
+  after(:all) do
+    Gon.global.clear
+  end
+
+  def request
+    @request ||= double 'request', :env => {}
+  end
+
+end

data/spec/gon/jbuilder_spec.rb

@@ -0,0 +1,52 @@
+# rabl_spec_rb
+require 'gon'
+
+describe Gon do
+
+  before(:each) do
+    Gon::Request.env = {}
+  end
+
+  require 'jbuilder'
+  require 'gon/jbuilder'
+
+  describe '.jbuilder' do
+    context 'render jbuilder templates' do
+
+      before do
+        Gon.clear
+        controller.instance_variable_set('@objects', objects)
+      end
+
+      let(:controller) { ActionController::Base.new }
+      let(:objects) { [1,2] }
+
+      it 'render json from jbuilder template' do
+        Gon.jbuilder 'spec/test_data/sample.json.jbuilder', :controller => controller
+        Gon.objects.length.should == 2
+      end
+
+      it 'render json from jbuilder template with a partial' do
+        controller.view_paths << 'spec/test_data'
+        Gon.jbuilder 'spec/test_data/sample_with_partial.json.jbuilder', :controller => controller
+        Gon.objects.length.should == 2
+      end
+
+    end
+
+    it 'should raise error if you use gon.jbuilder without requiring jbuilder gem' do
+      Gon.send(:remove_const, :Jbuilder)
+
+      expect { Gon.jbuilder 'some_path' }.to raise_error(NameError)
+      load 'jbuilder.rb'
+      load 'gon/jbuilder.rb'
+    end
+
+  end
+
+
+  def request
+    @request ||= double 'request', :env => {}
+  end
+
+end

data/spec/gon/rabl_spec.rb

@@ -0,0 +1,86 @@
+# rabl_spec_rb
+require 'gon'
+
+describe Gon do
+
+  before(:each) do
+    Gon::Request.env = {}
+  end
+
+  describe '.rabl' do
+
+    require 'rabl'
+    require 'gon/rabl'
+
+    before :each do
+      Gon.clear
+      controller.instance_variable_set('@objects', objects)
+    end
+
+    let(:controller) { ActionController::Base.new }
+    let(:objects) { [1,2] }
+
+    context 'render template with deprecation' do
+      it 'still works' do
+        Gon.rabl 'spec/test_data/sample.rabl', :controller => controller
+        Gon.objects.length.should == 2
+      end
+    end
+
+    it 'works if rabl is included' do
+      Gon.rabl :template =>'spec/test_data/sample.rabl', :controller => controller
+      Gon.objects.length.should == 2
+    end
+
+    it 'works with ActionView::Helpers' do
+      Gon.rabl :template =>'spec/test_data/sample_with_helpers.rabl', :controller => controller
+      Gon.objects.first['object']['time_ago'].should == 'about 6 hours'
+    end
+
+    it 'raise exception if rabl is not included' do
+      Gon.send :remove_const, 'Rabl'
+      expect { Gon.rabl :template =>'spec/test_data/sample.rabl', :controller => controller}.to raise_error
+      load 'rabl.rb'
+      load 'gon/rabl.rb'
+    end
+
+    context '.get_template_path' do
+      context 'template is specified' do
+
+        it 'add the extension if not included in the template name' do
+          Gon::Base.send(:get_template_path, { :template => 'spec/test_data/sample'}, 'rabl').should eql('spec/test_data/sample.rabl')
+        end
+
+        it 'return the specified template' do
+          Gon::Base.send(:get_template_path, { :template => 'spec/test_data/sample.rabl'}, 'rabl').should eql('spec/test_data/sample.rabl')
+        end
+
+      end
+
+      context 'template is not specified' do
+
+        before do
+          Gon.clear
+          controller.instance_variable_set('@objects', objects)
+          controller.action_name = 'show'
+        end
+
+        let(:controller) { ActionController::Base.new }
+        let(:objects) { [1,2] }
+
+        context 'the action doesn as a template at a different format' do
+          it 'return the same template as the action with rabl extension' do
+            Gon::Base.send(:get_template_path, {:controller => controller}, 'rabl').should eql('app/views/action_controller/base/show.json.rabl')
+          end
+        end
+
+      end
+    end
+
+  end
+
+  def request
+    @request ||= double 'request', :env => {}
+  end
+
+end

data/spec/gon/templates_spec.rb

@@ -0,0 +1,52 @@
+# rabl_spec_rb
+require 'gon'
+
+describe Gon do
+
+  before(:each) do
+    Gon::Request.env = {}
+  end
+
+  require 'jbuilder'
+  require 'gon/jbuilder'
+  require 'rabl'
+  require 'gon/rabl'
+
+  describe '.get_template_path' do
+    context 'template is specified' do
+
+      it 'add the extension if not included in the template name' do
+        Gon::Base.send(:get_template_path, { :template => 'spec/test_data/sample'}, 'jbuilder').should eql('spec/test_data/sample.jbuilder')
+      end
+
+      it 'return the specified template' do
+        Gon::Base.send(:get_template_path, { :template => 'spec/test_data/sample.jbuilder'}, 'jbuilder').should eql('spec/test_data/sample.jbuilder')
+      end
+
+    end
+
+    context 'template is not specified' do
+
+      before do
+        Gon.clear
+        controller.instance_variable_set('@objects', objects)
+        controller.action_name = 'show'
+      end
+
+      let(:controller) { ActionController::Base.new }
+      let(:objects) { [1,2] }
+
+      context 'the action doesn as a template at a different format' do
+        it 'return the same template as the action with rabl extension' do
+          Gon::Base.send(:get_template_path, {:controller => controller}, 'jbuilder').should eql('app/views/action_controller/base/show.json.jbuilder')
+        end
+      end
+
+    end
+  end
+
+  def request
+    @request ||= double 'request', :env => {}
+  end
+
+end