gon 2.1.2 → 2.2.0

data/README.md

@@ -149,31 +149,45 @@ Profit of using Rabl with gon:
   5. And so on
 
 For using gon with Rabl you need to create new Rabl template and map gon
-to it. 
+to it.
 For example you have model Post with attributes :title and :body.
 You want to get all your posts in your js as an Array.
 That's what you need to do:
 
-  1. Create Rabl template. I prefer creating special directory for
-     templates which are not view templates.
+  1. Create Rabl template. You can choose spepicific directory but better
+     use default directory for action.
 
-    `app/goners/posts/index.rabl`
+    `app/views/posts/index.json.rabl`
 
     ``` rabl
     collection @posts => 'posts'
     attributes :id, :title, :body
     ```
 
-  2. All you need to do after that is only to map this template to gon.
+  2. If you create template in default directory for action, you just write in this action:
 
-    `app/controllers/post_controller.rb#index`
+    `app/controllers/posts_controller.rb#index`
 
     ``` ruby
     def index
       # some controller logic
       @posts = Post.all # Rabl works with instance variables of controller
 
-      gon.rabl 'app/goners/posts/index.rabl'
+      gon.rabl
+      # some controller logic
+    end
+    ```
+
+     But if you choose some specific category - you need to map this template to gon.
+
+    `app/controllers/posts_controller.rb#index`
+
+    ``` ruby
+    def index
+      # some controller logic
+      @posts = Post.all # Rabl works with instance variables of controller
+
+      gon.rabl :template => 'app/goners/posts/index.rabl'
       # some controller logic
     end
     ```
@@ -217,7 +231,7 @@ gon mapping method:
 ``` ruby
 # your controller stuff here
 
-gon.rabl 'path/to/rabl/file', :as => 'alias'
+gon.rabl :as => 'alias'
 ```
 
 ## Usage with Jbuilder
@@ -243,7 +257,8 @@ Jbuilder works now only on Ruby 1.9+, so Gon support for Jbuilder works on 1.9+
     json.posts @posts, :id, :title, :body
     ```
 
-  2. In your controller you should map this template to gon.
+  2. In your controller you should just call 'gon.jbuilder' - if your template in
+     default directory for action. In the other case - you still can use :template option.
 
     ``` ruby
     def index
@@ -287,13 +302,13 @@ wouldn't work. You can read about this in common usage above.
 Puts this line into `Gemfile` then run `$ bundle`:
 
 ``` ruby
-gem 'gon', '2.1.2'
+gem 'gon', '2.2.0'
 ```
 
 Or if you are old-school Rails 2 developer put this into `config/environment.rb` and run `$ rake gems:install`:
 
 ``` ruby
-config.gem 'gon', :version => '2.1.2'
+config.gem 'gon', :version => '2.2.0'
 ```
 
 Or manually install gon gem: `$ gem install gon`

data/Rakefile

@@ -1,4 +1,9 @@
 require 'rubygems'
 require 'rake'
 require 'bundler'
-Bundler::GemHelper.install_tasks
+Bundler::GemHelper.install_tasks
+
+desc 'Run all tests by default'
+task :default do
+  system("rspec spec")
+end

data/gon.gemspec

@@ -23,4 +23,5 @@ Gem::Specification.new do |s|
   s.add_development_dependency "rabl"
   s.add_development_dependency "rspec"
   s.add_development_dependency "jbuilder"
+  s.add_development_dependency "rake"
 end

data/lib/gon.rb

@@ -1,4 +1,4 @@
-if RUBY_VERSION =~ /9/ && defined?(Jbuilder)
+if RUBY_VERSION > '1.9' && defined?(Jbuilder)
   gem 'blankslate'
 end
 require 'action_view'
@@ -8,7 +8,7 @@ require 'gon/escaper'
 if defined?(Rabl)
   require 'gon/rabl'
 end
-if RUBY_VERSION =~ /9/ && defined?(Jbuilder)
+if RUBY_VERSION > '1.9' && defined?(Jbuilder)
   require 'gon/jbuilder'
 end
 
@@ -19,10 +19,6 @@ module Gon
       @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
@@ -48,7 +44,7 @@ module Gon
 
     def method_missing(m, *args, &block)
       if ( m.to_s =~ /=$/ )
-        if public_methods.include? m.to_s[0..-2].to_sym
+        if public_methods.include?(RUBY_VERSION > '1.9' ? m.to_s[0..-2].to_sym : m.to_s[0..-2])
           raise "You can't use Gon public methods for storing data"
         end
         set_variable(m.to_s.delete('='), args[0])
@@ -65,50 +61,64 @@ 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 = {})
-      if !defined?(Gon::Rabl)
-        raise NoMethodError.new('You should define Rabl in your Gemfile')
-      end
+    %w(rabl jbuilder).each do |builder_name|
+      define_method builder_name do |*options|
+        if options.first.is_a? String
+          warn "[DEPRECATION] view_path argument is now optional. If you need to specify it please use #{builder}(:template => 'path')"
+          options = options.extract_options!.merge(:template => options[0])
+        elsif options.first.is_a? Hash
+          options = options ? options.first : { }
+        else
+          raise ArgumentError.new("You pass wrong argument type to template generator method: #{options.first.class.to_s}")
+        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'))
-      if options[:as]
-        set_variable(options[:as].to_s, rabl_data)
-      elsif rabl_data.is_a? Hash
-        rabl_data.each do |key, value|
-          set_variable(key, value)
+        builder_module = get_builder(builder_name)
+
+        data = builder_module.send("parse_#{builder_name}", get_template_path(options, builder_name), get_controller(options))
+
+        if options[:as]
+          set_variable(options[:as].to_s, data)
+        elsif data.is_a? Hash
+          data.each do |key, value|
+            set_variable(key, value)
+          end
+        else
+          set_variable(builder_name, data)
         end
-      else
-        set_variable('rabl', rabl_data)
       end
     end
+    alias_method :orig_jbuilder, :jbuilder
+
+    def jbuilder(*options)
+      raise NoMethodError.new('You can use Jbuilder support only in 1.9+') if RUBY_VERSION < '1.9'
+      orig_jbuilder(*options)
+    end
+
+    private
 
-    def jbuilder(view_path, options = {})
-      if RUBY_VERSION !~ /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')
+    def get_builder(builder_name)
+      begin
+        "Gon::#{builder_name.classify}".constantize
+      rescue
+        raise NoMethodError.new("You should define #{builder_name.classify} in your Gemfile")
       end
+    end
 
-      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'))
-      if options[:as]
-        set_variable(options[:as].to_s, jbuilder_data)
-      elsif jbuilder_data.is_a? Hash
-        jbuilder_data.each do |key, value|
-          set_variable(key, value)
-        end
+    def get_controller(options)
+      options[:controller] ||
+        @request_env['action_controller.instance'] ||
+        @request_env['action_controller.rescue.response'].
+        instance_variable_get('@template').
+        instance_variable_get('@controller')
+    end
+
+    def get_template_path(options, extension)
+      if options[:template]
+        File.extname(options[:template]) == ".#{extension}" ? options[:template] : "#{options[:template]}.#{extension}"
       else
-        set_variable('jbuilder', jbuilder_data)
+        "app/views/#{get_controller(options).controller_path}/#{get_controller(options).action_name}.json.#{extension}"
       end
     end
-  end
 
+  end
 end

data/lib/gon/version.rb

@@ -1,3 +1,3 @@
 module Gon
-  VERSION = '2.1.2'
+  VERSION = '2.2.0'
 end

data/spec/gon/gon_spec.rb

@@ -1,29 +1,33 @@
 # gon_spec_rb
 require 'gon'
 
-describe Gon, '#all_variables' do
+describe Gon do
 
   before(:each) do
     Gon.request_env = {}
   end
 
-  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
+  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
 
-  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
 
   describe '#include_gon' do
@@ -62,65 +66,154 @@ describe Gon, '#all_variables' do
   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
 
-  context 'render json from rabl template' do
+  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]}
+    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
+    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
-      require 'rabl'
-      require 'gon/rabl'
-      Gon.rabl 'spec/test_data/sample.rabl', :controller => controller
+      Gon.rabl :template =>'spec/test_data/sample.rabl', :controller => controller
       Gon.objects.length.should == 2
     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.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.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.send(:get_template_path, {:controller => controller}, 'rabl').should eql('app/views/action_controller/base/show.json.rabl')
+          end
+        end
+
+      end
+    end
+
   end
 
-  if RUBY_VERSION =~ /1.9/
+  if RUBY_VERSION > '1.9'
     require 'jbuilder'
     require 'gon/jbuilder'
 
-    it 'render json from jbuilder template' do
-      Gon.clear
-      controller = ActionController::Base.new
-      objects = [1,2]
-      controller.instance_variable_set('@objects', objects)
-      Gon.jbuilder 'spec/test_data/sample.json.jbuilder', :controller => controller
-      Gon.objects.length.should == 2
-    end
+    describe '.jbuilder' do
+      context 'render jbuilder templates' do
 
-    it 'render json from jbuilder template with a partial' do
-      Gon.clear
-      controller = ActionController::Base.new
-      controller.view_paths << 'spec/test_data'
-      objects = [1,2]
-      controller.instance_variable_set('@objects', objects)
-      Gon.jbuilder 'spec/test_data/sample_with_partial.json.jbuilder', :controller => controller
-      Gon.objects.length.should == 2
-    end
+        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 throw error if you use gon.jbuilder with ruby < 1.9+' do
-      RUBY_VERSION = '1.8.7'
+      it 'should throw error if you use gon.jbuilder with ruby < 1.9+' do
+        RUBY_VERSION = '1.8.7'
+
+        expect { Gon.jbuilder 'some_path'}.to raise_error(NoMethodError, /1.9/)
+      end
+
+      it 'should raise error if you use gon.jbuilder without requiring jbuilder gem' do
+        RUBY_VERSION = '1.9.2'
+        Gon.send(:remove_const, :Jbuilder)
+
+        expect { Gon.jbuilder 'some_path' }.to raise_error(NoMethodError, /Gemfile/)
+        load 'jbuilder.rb'
+        load 'gon/jbuilder.rb'
+      end
 
-      expect { Gon.jbuilder 'some_path' }.to raise_error(NoMethodError, /1.9/)
     end
 
-    it 'should raise error if you use gon.jbuilder without requairing jbuilder gem' do
-      RUBY_VERSION = '1.9.2'
-      Gon.send(:remove_const, :Jbuilder)
+    describe '.get_template_path' do
+      context 'template is specified' do
+
+        it 'add the extension if not included in the template name' do
+          Gon.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.send(:get_template_path, { :template => 'spec/test_data/sample.jbuilder'}, 'jbuilder').should eql('spec/test_data/sample.jbuilder')
+        end
+
+      end
 
-      expect { Gon.jbuilder 'some_path' }.to raise_error(NoMethodError, /Gemfile/)
+      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.send(:get_template_path, {:controller => controller}, 'jbuilder').should eql('app/views/action_controller/base/show.json.jbuilder')
+          end
+        end
+
+      end
     end
+
   end
 
   def request

metadata

@@ -1,79 +1,118 @@
---- !ruby/object:Gem::Specification
+--- !ruby/object:Gem::Specification 
 name: gon
-version: !ruby/object:Gem::Version
-  version: 2.1.2
+version: !ruby/object:Gem::Version 
+  hash: 7
   prerelease: 
+  segments: 
+  - 2
+  - 2
+  - 0
+  version: 2.2.0
 platform: ruby
-authors:
+authors: 
 - gazay
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-03-07 00:00:00.000000000Z
-dependencies:
-- !ruby/object:Gem::Dependency
+
+date: 2012-03-07 00:00:00 Z
+dependencies: 
+- !ruby/object:Gem::Dependency 
   name: actionpack
-  requirement: &70100875330620 !ruby/object:Gem::Requirement
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
     none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 2
+        - 3
+        - 0
         version: 2.3.0
   type: :runtime
-  prerelease: false
-  version_requirements: *70100875330620
-- !ruby/object:Gem::Dependency
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
   name: json
-  requirement: &70100875329900 !ruby/object:Gem::Requirement
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
     none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
   type: :runtime
-  prerelease: false
-  version_requirements: *70100875329900
-- !ruby/object:Gem::Dependency
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
   name: rabl
-  requirement: &70100875328820 !ruby/object:Gem::Requirement
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
     none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
   type: :development
-  prerelease: false
-  version_requirements: *70100875328820
-- !ruby/object:Gem::Dependency
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
   name: rspec
-  requirement: &70100875328180 !ruby/object:Gem::Requirement
+  prerelease: false
+  requirement: &id004 !ruby/object:Gem::Requirement 
     none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
   type: :development
-  prerelease: false
-  version_requirements: *70100875328180
-- !ruby/object:Gem::Dependency
+  version_requirements: *id004
+- !ruby/object:Gem::Dependency 
   name: jbuilder
-  requirement: &70100875327400 !ruby/object:Gem::Requirement
+  prerelease: false
+  requirement: &id005 !ruby/object:Gem::Requirement 
     none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
   type: :development
+  version_requirements: *id005
+- !ruby/object:Gem::Dependency 
+  name: rake
   prerelease: false
-  version_requirements: *70100875327400
-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:
+  requirement: &id006 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id006
+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
 executables: []
+
 extensions: []
+
 extra_rdoc_files: []
-files:
+
+files: 
 - .gitignore
 - .travis.yml
 - Gemfile
@@ -95,29 +134,38 @@ files:
 - spec/test_data/sample_with_partial.json.jbuilder
 homepage: https://github.com/gazay/gon
 licenses: []
+
 post_install_message: 
 rdoc_options: []
-require_paths:
+
+require_paths: 
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement
+required_ruby_version: !ruby/object:Gem::Requirement 
   none: false
-  requirements:
-  - - ! '>='
-    - !ruby/object:Gem::Version
-      version: '0'
-required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
   none: false
-  requirements:
-  - - ! '>='
-    - !ruby/object:Gem::Version
-      version: '0'
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
 requirements: []
+
 rubyforge_project: gon
 rubygems_version: 1.8.15
 signing_key: 
 specification_version: 3
 summary: Get your Rails variables in your JS
-test_files:
+test_files: 
 - spec/gon/gon_spec.rb
 - spec/test_data/_sample_partial.json.jbuilder
 - spec/test_data/sample.json.jbuilder