rjax 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 05b33d7cc946a1aaa2f9a5277644700d402ceade
-  data.tar.gz: ed4585c29a78e0aadff71aa550de05eee220e1dd
+  metadata.gz: e33c4aeca28f67ea7b66ce8983a1fb38b31e5c50
+  data.tar.gz: dca13bfccced618784302aba09a4a66cebf88d24
 SHA512:
-  metadata.gz: adc9d0fcaa58363020f6c320c2f2b96ca3ea7116558057373495c10365000d41152e95955b7a605ae6c27d658c4f93b986cae33f5418b5ca00a399bcbd4996a1
-  data.tar.gz: d2ba335efade55bf37327857c55d3b194353adc1d350789de294cd732e65cf0d11c5503e33aa5cf25ec7fc4fe3b65c82ce78ed250ec6547649d2ac9f748d15a4
+  metadata.gz: 339cde6898cca5b9441175062f38c68698fc6d31b959774e858efb86950eb05ce0f48048e7b188e24b0dd3e1b1820401c6746cd213d534d49ce69d8ac495560d
+  data.tar.gz: fff2c86b83649ddc85f5f4f233b60d19150e5800cdf6785375854e7e0773fb3d3976ce9e0fd335314ab715a17fd74673754c7409e6eec94322a22d88ff176c43

data/README.rdoc

@@ -2,7 +2,7 @@
 
 Solve template dispatch on ajax request
 
-{<img src="https://travis-ci.org/jalkoby/rjax.png?branch=master" alt="Build Status" />}[https://travis-ci.org/jalkoby/rjax]
+{<img src="https://codeclimate.com/github/jalkoby/rjax.png" />}[https://codeclimate.com/github/jalkoby/rjax]
 {<img src="https://travis-ci.org/jalkoby/rjax.png?branch=master" alt="Build Status" />}[https://travis-ci.org/jalkoby/rjax]
 {<img src="https://badge.fury.io/rb/rjax.png" alt="Gem Version" />}[http://badge.fury.io/rb/rjax]
 
@@ -22,7 +22,7 @@ Or install it yourself as:
 
 == Usage
 
-Rjax will be useful if you have a lot action which serve http and ajax request. It might looks like:
+Rjax will be useful if you have a lot actions which serve http and ajax requests. It might looks like:
 
   def index
     @users = User.all
@@ -31,34 +31,53 @@ Rjax will be useful if you have a lot action which serve http and ajax request.
     render :index_ajax if request.xhr?
   end
 
-Rjax replace it with single method call
-
-  def index
-    @users = User.all
-    rjax
-  end
-  # render index_rjax template
-
-  def index
-    @users = User.all
-    rjax @users
-  end
-  # render _user_rjax or _user partial with variable `user`
-
-  def index
-    @users = User.all
-    rjax :users => @users, :other => :variable
-  end
-  # render _users_rjax or _users partial with variables users & other
-
-  def show
-    @user = User.find(params[:id])
-    rjax @user
+Rjax adds `rjax` methods in rails controllers.
+
+  class UsersController < ApplicationController
+    def index
+      @users = User.all
+      rjax
+    end
+    # calling rjax method without arguments will render template;
+    # the name of template will contain action_name and wrapper;
+    # in this case expected `index_rjax` template;
+
+    def index
+      @users = User.all
+      rjax @users
+    end
+    # calling rjax method is similar to view helper render %collection%;
+    # the only different is also looks for partial with wrapped name;
+    # in this case it will look for partial `_user_rjax` or `_user` and pass variable `user`;
+
+    def index
+      @users = User.all
+      rjax :users => @users, :other => :variable
+    end
+    # calling rjax method with Hash will render partial with locals specified in hash;
+    # the name of partial might be specified in :partial key;
+    # if :partial key is missed expected that view folder contains partial with plural form of controller with or without wrapper;
+    # in this case it will be `_users_rjax` or `_users` partial
+
+    def show
+      @user = User.find(params[:id])
+      rjax @user
+    end
+    # in other cases rjax will render partial and pass this variable into partial;
+    # the name of partial will be singular form of controller with or without wrapper;
+    # in this case it will be `_user_rjax` or `_user` partial
+
+    # it also support respond_with
+    def index
+      respond_with do |format|
+        format.html { rjax }
+        format.json { rjax }
+        format.xml  { rjax }
+      end
+    end
   end
-  # render _user_rjax or _user partial with `user` variable
 
-The name of partial is based on controller name. If you don't like rjax suffix or it's out your team's convention
-feel free to configure wrapper:
+If you don't like rjax default wrapper you can configure it:
 
   # config/initializers/rjax.rb
   Rjax.config do |config|
@@ -66,9 +85,9 @@ feel free to configure wrapper:
     config.prefix = "prefix"
   end
 
-  prefix_%action_name%_suffix
+  prefix_%template%_suffix
 
-  _prefix_%partial_name%_suffix
+  _prefix_%partial%_suffix
 
 == Contributing
 

data/lib/rjax/resolver.rb

@@ -18,7 +18,8 @@ class Rjax::Resolver < Struct.new(:options, :controller)
   private
 
   def general_partial
-    { :partial => partial_name(:multi), :locals => options, :layout => false }
+    partial = options.has_key?(:partial) ? options.delete(:partial) : partial_name(:multi)
+    { :partial => partial, :locals => options, :layout => false }
   end
 
   def collection_partial

data/lib/rjax/version.rb

@@ -1,3 +1,3 @@
 module Rjax
-  VERSION = "0.1.0"
+  VERSION = "0.1.1"
 end

data/spec/dummy/application.rb

@@ -20,7 +20,7 @@ class Dummy < Rails::Application
       get :search, :popular, :on => :collection
     end
     resources :articles, :only => [:index, :show] do
-      get :search, :on => :collection
+      get :search, :popular, :on => :collection
     end
   end
 end
@@ -49,6 +49,8 @@ class UsersController < BaseController
 end
 
 class ArticlesController < BaseController
+  respond_to :html
+
   def index
     rjax %w(Monday Tuesday Sunday)
   end
@@ -57,7 +59,13 @@ class ArticlesController < BaseController
     rjax :articles => %w(Monday Sunday)
   end
 
+  def popular
+    rjax :articles => %w(Friday Saturday), :partial => 'popular'
+  end
+
   def show
-    rjax "Monday"
+    respond_with do |format|
+      format.html { rjax "Monday" }
+    end
   end
 end

data/spec/dummy/articles/_popular.erb

@@ -0,0 +1 @@
+<%= articles.join(', ') %>

data/spec/rjax/rjax_spec.rb

@@ -40,6 +40,12 @@ describe Rjax, :type => :request do
     body.should == "Monday, Sunday"
   end
 
+  it 'use custom partial' do
+    ajax '/articles/popular'
+
+    body.should == "Friday, Saturday"
+  end
+
   it 'collection instance partial' do
     ajax '/articles/1'
 
@@ -56,6 +62,6 @@ describe Rjax, :type => :request do
   end
 
   def ajax(path)
-    get path, {}, { "HTTP_X_REQUESTED_WITH" => "XMLHttpRequest", 'HTTP_ACCEPT' => '*/*' }
+    get path, { :format => :html }, { "HTTP_X_REQUESTED_WITH" => "XMLHttpRequest", 'HTTP_ACCEPT' => '*/*' }
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rjax
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Sergey Pchelincev
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-10-02 00:00:00.000000000 Z
+date: 2013-10-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: actionpack
@@ -105,6 +105,7 @@ files:
 - spec/dummy/application.rb
 - spec/dummy/articles/_article.erb
 - spec/dummy/articles/_articles.erb
+- spec/dummy/articles/_popular.erb
 - spec/dummy/layouts/rjax.erb
 - spec/dummy/users/_user_rjax.erb
 - spec/dummy/users/_users_rjax.erb
@@ -140,6 +141,7 @@ test_files:
 - spec/dummy/application.rb
 - spec/dummy/articles/_article.erb
 - spec/dummy/articles/_articles.erb
+- spec/dummy/articles/_popular.erb
 - spec/dummy/layouts/rjax.erb
 - spec/dummy/users/_user_rjax.erb
 - spec/dummy/users/_users_rjax.erb