gon 1.1.3 → 2.0.0

data/README.md

@@ -1,7 +1,33 @@
 # Gon gem — get your Rails variables in your js
 
+
 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!
 
+Now with [Rabl](https://github.com/nesquena/rabl) support!
+
+## A example of typical use
+
+When you need to send some start data from your controller to your js
+you probably doing something like this:
+
+  1. Write this data in controller(presenter/model) in some variable
+  2. In view for this action you put this data in some objects by data
+     attributes, or write js right in view
+  3. Then in js it depends - if you previously write data in data
+     attributes - you should parse this attributes and write data to some
+  js variable. If you write js right in view (many frontenders shame you for
+  that) - you just use data from this js - OK.
+  4. You can use your data in your js
+
+And everytime when you need some data from action to js you do this.
+
+With gon you configure it firstly - just put in layout one tag, and add
+gem line to your Gemfile and do two actions:
+
+  1. Write variables by gon.variable_name = variable_value
+  2. In your js you get this by gon.variable_name
+  3. profit?
+
 ## Usage
 
 `app/views/layouts/application.html.erb`
@@ -79,18 +105,94 @@ alert(customNamespace.yourArray)
 alert(customNamespace.yourHash)
 ```
 
+## Usage with Rabl
+
+Now you can write your variables assign logic in templates with [Rabl](https://github.com/nesquena/rabl).
+How write templates very clearly described in their repo.
+
+Profit of using Rabl with gon:
+
+  1. You can clean your controllers now!
+  2. Clear and easy work with database objects and collections
+  3. All power of Rabl
+  4. You still can be lazy and don't use common way to transfer data in js
+  5. And so on
+
+For using gon with Rabl you need to create new Rabl template and map gon
+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.
+Thats what you need to do:
+
+  1. Create Rabl template. I preffer creating special directory for
+     templates which are not view templates.
+
+    `app/goners/posts/index.rabl`
+
+    ``` rabl
+    collection @posts => 'posts'
+    attributes :id, :title, :body
+    ```
+
+  2. After that you need only map this template to gon.
+
+    `app/controllers/post_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'
+    end
+    ```
+
+    Thats it! In your js now you get gon.posts variable which is Array of
+    post objects with attributes :id, :title and :body.
+
+    P.s. If you didn't put include_gon tag in your html head area - it
+    wouldn't work. You can read about this in common usage above.
+
+### Some tips of usage Rabl with gon:
+
+If you don't use alias in Rabl template:
+
+``` rabl
+collection @posts
+....
+```
+
+instead of using that:
+
+``` rabl
+collection @posts => 'alias'
+....
+```
+
+Rabl will return you array and gon by default put it to variable
+gon.rabl
+
+Two way how you can change it - using aliases or you can add alias to
+gon mapping method:
+
+``` ruby
+# your controller stuff here
+
+gon.rabl 'path/to/rabl/file', :as => 'alias'
+```
+
 ## Installation
 
 Puts this line into `Gemfile` then run `$ bundle`:
 
 ``` ruby
-gem 'gon', '1.1.3'
+gem 'gon', '2.0.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 => '1.1.3'
+config.gem 'gon', :version => '2.0.0'
 ```
 
 Or manually install gon gem: `$ gem install gon`

data/gon.gemspec

@@ -19,5 +19,7 @@ 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 "rspec"
 end

data/lib/gon.rb

@@ -1,44 +1,59 @@
 require 'action_view'
 require 'action_controller'
 require 'gon/helpers'
+require 'gon/rabl'
 
 module Gon
-  def self.all_variables
-    @request_env[:gon]
-  end
-
-  def self.clear
-    @request_env[:gon] = {}
-  end
+  class << self
+    def all_variables
+      @request_env[:gon]
+    end
 
-  def self.request_env=(request_env)
-    @request_env = request_env
-  end
+    def clear
+      @request_env[:gon] = {}
+    end
 
-  def self.request_env
-    if defined?(@request_env)
-      return @request_env
+    def request_env=(request_env)
+      @request_env = request_env
+      @request_env[:gon] ||= {}
     end
-  end
 
-  def self.method_missing(m, *args, &block)
-    @request_env[:gon] ||= {}
+    def request_env
+      if defined?(@request_env)
+        return @request_env
+      end
+    end
 
-    if ( m.to_s =~ /=$/ )
-      if self.public_methods.include? m.to_s[0..-2].to_sym
-        raise "You can't use Gon public methods for storing data"
+    def method_missing(m, *args, &block)
+      if ( m.to_s =~ /=$/ )
+        if public_methods.include? m.to_s[0..-2].to_sym
+          raise "You can't use Gon public methods for storing data"
+        end
+        set_variable(m.to_s.delete('='), args[0])
+      else
+        get_variable(m.to_s)
       end
-      set_variable(m.to_s.delete('='), args[0])
-    else
-      get_variable(m.to_s)
     end
-  end
 
-  def self.get_variable(name)
-    @request_env[:gon][name]
-  end
+    def get_variable(name)
+      @request_env[:gon][name]
+    end
 
-  def self.set_variable(name, value)
-    @request_env[:gon][name] = value
+    def set_variable(name, value)
+      @request_env[:gon][name] = value
+    end
+
+    def rabl(view_path, options = {})
+      rabl_data = Gon::Rabl.parse_rabl(view_path, @request_env['action_controller.instance'])
+      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)
+        end
+      else
+        set_variable('rabl', rabl_data)
+      end
+    end
   end
 end

data/lib/gon/helpers.rb

@@ -6,7 +6,7 @@ module Gon
 
     module InstanceMethods
       def include_gon(options = {})
-        if Gon.request_env
+        if Gon.request_env && Gon.all_variables.present?
           data = Gon.all_variables
           namespace = options[:namespace] || 'gon'
           script = "<script>window." + namespace + " = {};"
@@ -45,4 +45,4 @@ module Gon
 end
 
 ActionView::Base.send :include, Gon::Helpers
-ActionController::Base.send :include, Gon::GonHelpers
+ActionController::Base.send :include, Gon::GonHelpers

data/lib/gon/rabl.rb

@@ -0,0 +1,12 @@
+require 'rabl'
+
+module Gon::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

data/lib/gon/version.rb

@@ -1,3 +1,3 @@
 module Gon
-  VERSION = '1.1.3'
+  VERSION = '2.0.0'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: gon
 version: !ruby/object:Gem::Version
-  version: 1.1.3
+  version: 2.0.0
   prerelease: 
 platform: ruby
 authors:
@@ -13,7 +13,7 @@ date: 2011-11-07 00:00:00.000000000Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: actionpack
-  requirement: &2156527520 !ruby/object:Gem::Requirement
+  requirement: &2158488420 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +21,32 @@ dependencies:
         version: 2.3.0
   type: :runtime
   prerelease: false
-  version_requirements: *2156527520
+  version_requirements: *2158488420
+- !ruby/object:Gem::Dependency
+  name: rabl
+  requirement: &2158488000 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *2158488000
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: &2158487540 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *2158487540
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &2156527100 !ruby/object:Gem::Requirement
+  requirement: &2158487120 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,7 +54,7 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *2156527100
+  version_requirements: *2158487120
 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:
@@ -48,6 +70,7 @@ files:
 - gon.gemspec
 - lib/gon.rb
 - lib/gon/helpers.rb
+- lib/gon/rabl.rb
 - lib/gon/version.rb
 - spec/gon/gon_spec.rb
 homepage: ''