rjax 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 05b33d7cc946a1aaa2f9a5277644700d402ceade
+  data.tar.gz: ed4585c29a78e0aadff71aa550de05eee220e1dd
+SHA512:
+  metadata.gz: adc9d0fcaa58363020f6c320c2f2b96ca3ea7116558057373495c10365000d41152e95955b7a605ae6c27d658c4f93b986cae33f5418b5ca00a399bcbd4996a1
+  data.tar.gz: d2ba335efade55bf37327857c55d3b194353adc1d350789de294cd732e65cf0d11c5503e33aa5cf25ec7fc4fe3b65c82ce78ed250ec6547649d2ac9f748d15a4

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+tmp
+/gemfiles/*.lock
+/.rspec

data/.travis.yml

@@ -0,0 +1,10 @@
+language: ruby
+rvm:
+  - 1.9.3
+  - 2.0.0
+  - rbx-19mode
+  - jruby-19mode
+gemfile:
+  - gemfiles/rails_31
+  - gemfiles/rails_32
+  - gemfiles/rails_40

data/Gemfile

@@ -0,0 +1,6 @@
+source 'https://rubygems.org'
+
+gemspec
+
+gem 'rails'
+gem 'debugger', :platform => [:mri_19, :mri_20]

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Sergey Pchelincev
+
+MIT License
+
+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:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.rdoc

@@ -0,0 +1,79 @@
+= Rjax
+
+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://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]
+
+== Installation
+
+Add this line to your application's Gemfile:
+
+  gem 'rjax'
+
+And then execute:
+
+  $ bundle
+
+Or install it yourself as:
+
+  $ gem install rjax
+
+== Usage
+
+Rjax will be useful if you have a lot action which serve http and ajax request. It might looks like:
+
+  def index
+    @users = User.all
+    render :partials => 'users', :locals => { :users => @users }  if request.xhr?
+    # or
+    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
+  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:
+
+  # config/initializers/rjax.rb
+  Rjax.config do |config|
+    config.suffix = "suffix"
+    config.prefix = "prefix"
+  end
+
+  prefix_%action_name%_suffix
+
+  _prefix_%partial_name%_suffix
+
+== Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,7 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new('spec')
+
+desc "Run all specs"
+task :default => :spec

data/gemfiles/rails_31

@@ -0,0 +1,5 @@
+source 'https://rubygems.org'
+
+gem 'rails', '~> 3.1.0'
+
+gemspec :path => ".."

data/gemfiles/rails_32

@@ -0,0 +1,5 @@
+source 'https://rubygems.org'
+
+gem 'rails', '~> 3.2.0'
+
+gemspec :path => ".."

data/gemfiles/rails_40

@@ -0,0 +1,5 @@
+source 'https://rubygems.org'
+
+gem 'rails', '~> 4.0.0'
+
+gemspec :path => ".."

data/lib/rjax.rb

@@ -0,0 +1,28 @@
+require 'active_support'
+
+module Rjax
+  autoload :Config,                    'rjax/config'
+  autoload :InvalidConfigurationError, 'rjax/errors'
+  autoload :Resolver,                  'rjax/resolver'
+  autoload :PartialMissingError,      'rjax/errors'
+
+  def self.config(&block)
+    @config ||= ::Rjax::Config.new
+    if block_given?
+      yield(@config)
+      @config.validate!
+    else
+      @config
+    end
+  end
+end
+
+ActiveSupport.on_load(:action_controller) do
+  class_eval do
+    private
+
+    def rjax(options = nil)
+      render(Rjax::Resolver.process(options, self)) if request.xhr?
+    end
+  end
+end

data/lib/rjax/config.rb

@@ -0,0 +1,20 @@
+class Rjax::Config
+  attr_accessor :prefix, :suffix
+
+  def suffix
+    return @suffix if defined?(@suffix)
+    @suffix = 'rjax'
+  end
+
+  def suffix?
+    suffix && !suffix.empty?
+  end
+
+  def prefix?
+    prefix && !prefix.empty?
+  end
+
+  def validate!
+    raise Rjax::InvalidConfigurationError, "provide suffix or prefix" unless suffix? || prefix?
+  end
+end

data/lib/rjax/errors.rb

@@ -0,0 +1,11 @@
+module Rjax
+  class BaseError < ::StandardError
+  end
+
+  class InvalidConfigurationError < BaseError
+  end
+
+  class PartialMissingError < BaseError
+  end
+end
+

data/lib/rjax/resolver.rb

@@ -0,0 +1,57 @@
+require 'active_support/core_ext/string'
+
+class Rjax::Resolver < Struct.new(:options, :controller)
+  def self.process(*args)
+    new(*args).process
+  end
+
+  def process
+    case options
+    when Hash     then general_partial
+    when Array    then collection_partial
+    when NilClass then template_name
+    else
+      instance_partial
+    end
+  end
+
+  private
+
+  def general_partial
+    { :partial => partial_name(:multi), :locals => options, :layout => false }
+  end
+
+  def collection_partial
+    { :partial => partial_name, :collection => options, :as => singular_name, :layout => false }
+  end
+
+  def instance_partial
+    { :partial => partial_name, :locals => { singular_name.to_sym => options }, :layout => false }
+  end
+
+  def template_name
+    rjax_version(controller.action_name).to_sym
+  end
+
+  def partial_name(multi = false)
+    name = multi ? singular_name.pluralize : singular_name
+    result = [rjax_version(name), name].detect { |item| controller.template_exists?(item, prefixes, true) }
+    result ? result : raise(Rjax::PartialMissingError, name)
+  end
+
+  def singular_name
+    @singular_name ||= controller.controller_name.singularize
+  end
+
+  def rjax_version(base)
+    result = ""
+    result << "#{ Rjax.config.prefix }_" if Rjax.config.prefix?
+    result << base
+    result << "_#{ Rjax.config.suffix }" if Rjax.config.suffix?
+    result
+  end
+
+  def prefixes
+    @prefixes ||= controller.send(:_normalize_render)[:prefixes]
+  end
+end

data/lib/rjax/version.rb

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

data/rjax.gemspec

@@ -0,0 +1,26 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'rjax/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "rjax"
+  spec.version       = Rjax::VERSION
+  spec.authors       = ["Sergey Pchelincev"]
+  spec.email         = ["jalkoby91@gmail.com"]
+  spec.description   = %q{Solve template dispatch on ajax request}
+  spec.summary       = spec.description
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "actionpack", ">= 3.1.0"
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec", "~> 2.14.0"
+  spec.add_development_dependency "rack-test"
+end

data/spec/dummy/application.rb

@@ -0,0 +1,63 @@
+require 'action_controller/railtie'
+require 'action_view/railtie'
+
+class Dummy < Rails::Application
+  # Set Rails.root to the same folder as this file
+  config.root = File.dirname(__FILE__)
+
+  # Rails needs these keys, but they don't really have to be secret for our tests
+  config.session_store :cookie_store, key: '****************************************'
+  config.secret_token = '****************************************'
+
+  config.logger = Logger.new(STDOUT)
+  Rails.logger = config.logger
+
+  config.action_controller.view_path
+
+  # Our routes
+  routes.draw do
+    resources :users, :only => [:index, :show] do
+      get :search, :popular, :on => :collection
+    end
+    resources :articles, :only => [:index, :show] do
+      get :search, :on => :collection
+    end
+  end
+end
+
+class BaseController < ActionController::Base
+  prepend_view_path Rails.root
+end
+
+class UsersController < BaseController
+  def index
+    @users = %w(Sam Alise John)
+    rjax
+  end
+
+  def search
+    rjax :users => %w(Sam John)
+  end
+
+  def popular
+    rjax %w(Jessy Walt)
+  end
+
+  def show
+    rjax "Alex"
+  end
+end
+
+class ArticlesController < BaseController
+  def index
+    rjax %w(Monday Tuesday Sunday)
+  end
+
+  def search
+    rjax :articles => %w(Monday Sunday)
+  end
+
+  def show
+    rjax "Monday"
+  end
+end

data/spec/dummy/articles/_article.erb

@@ -0,0 +1 @@
+<%= article %>

data/spec/dummy/articles/_articles.erb

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

data/spec/dummy/layouts/rjax.erb

@@ -0,0 +1 @@
+layout - <%= yield %>

data/spec/dummy/users/_user_rjax.erb

@@ -0,0 +1 @@
+<%= user %>

data/spec/dummy/users/_users_rjax.erb

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

data/spec/dummy/users/index_rjax.erb

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

data/spec/rjax/rjax_resolver_spec.rb

@@ -0,0 +1,27 @@
+require 'spec_helper'
+
+describe Rjax::Resolver do
+  context '#rjax_version' do
+    let(:controller) { double("Controller", :action_name => "index" ) }
+    let(:config)     { Rjax.config }
+    subject          { described_class.process(nil, controller) }
+
+    specify { should == :index_rjax }
+
+    it 'with custom suffix' do
+      config.suffix = "ajax"
+      should == :index_ajax
+    end
+
+    it 'with prefix' do
+      config.prefix = "super"
+      should == :super_index_rjax
+    end
+
+    it 'with prefix and without suffix' do
+      config.suffix = false
+      config.prefix = "ajax"
+      should == :ajax_index
+    end
+  end
+end

data/spec/rjax/rjax_spec.rb

@@ -0,0 +1,61 @@
+require 'spec_helper'
+
+describe Rjax, :type => :request do
+  let(:app)  { Rails.application }
+  let(:body) { last_response.body.strip }
+
+  it 'rjax template' do
+    ajax '/users'
+
+    body.should == 'Sam, Alise, John'
+  end
+
+  it 'rjax general partial' do
+    ajax '/users/search'
+
+    body.should == 'Sam, John'
+  end
+
+  it 'rjax collection partial' do
+    ajax '/users/popular'
+
+    body.should == "Jessy\nWalt"
+  end
+
+  it 'rjax instance template' do
+    ajax '/users/1'
+
+    body.should == 'Alex'
+  end
+
+  it 'convention general partial' do
+    ajax '/articles'
+
+    body.should == "Monday\nTuesday\nSunday"
+  end
+
+  it 'convention collection partial' do
+    ajax '/articles/search'
+
+    body.should == "Monday, Sunday"
+  end
+
+  it 'collection instance partial' do
+    ajax '/articles/1'
+
+    body.should == "Monday"
+  end
+
+  it 'raise error is configurated incorrect' do
+    expect do
+      described_class.config do |config|
+        config.suffix = ""
+        config.prefix = ""
+      end
+    end.to raise_error(Rjax::InvalidConfigurationError)
+  end
+
+  def ajax(path)
+    get path, {}, { "HTTP_X_REQUESTED_WITH" => "XMLHttpRequest", 'HTTP_ACCEPT' => '*/*' }
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,19 @@
+require 'bundler/setup'
+Bundler.require(:default)
+
+ENV["RAILS_ENV"] ||= 'test'
+require "#{ File.dirname(__FILE__) }/dummy/application"
+
+Dir["#{ File.dirname(__FILE__) }/support/**/*.rb"].each { |f| require f }
+
+RSpec.configure do |config|
+  config.treat_symbols_as_metadata_keys_with_true_values = true
+  config.filter_run :focus => true
+  config.run_all_when_everything_filtered = true
+
+  config.include Rack::Test::Methods, :type => :request
+
+  config.before(:each) do
+    Rjax.instance_variable_set("@config", nil)
+  end
+end

metadata

@@ -0,0 +1,149 @@
+--- !ruby/object:Gem::Specification
+name: rjax
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Sergey Pchelincev
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-10-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: actionpack
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 3.1.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 3.1.0
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.14.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.14.0
+- !ruby/object:Gem::Dependency
+  name: rack-test
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Solve template dispatch on ajax request
+email:
+- jalkoby91@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .travis.yml
+- Gemfile
+- LICENSE.txt
+- README.rdoc
+- Rakefile
+- gemfiles/rails_31
+- gemfiles/rails_32
+- gemfiles/rails_40
+- lib/rjax.rb
+- lib/rjax/config.rb
+- lib/rjax/errors.rb
+- lib/rjax/resolver.rb
+- lib/rjax/version.rb
+- rjax.gemspec
+- spec/dummy/application.rb
+- spec/dummy/articles/_article.erb
+- spec/dummy/articles/_articles.erb
+- spec/dummy/layouts/rjax.erb
+- spec/dummy/users/_user_rjax.erb
+- spec/dummy/users/_users_rjax.erb
+- spec/dummy/users/index_rjax.erb
+- spec/rjax/rjax_resolver_spec.rb
+- spec/rjax/rjax_spec.rb
+- spec/spec_helper.rb
+homepage: ''
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.0.3
+signing_key: 
+specification_version: 4
+summary: Solve template dispatch on ajax request
+test_files:
+- spec/dummy/application.rb
+- spec/dummy/articles/_article.erb
+- spec/dummy/articles/_articles.erb
+- spec/dummy/layouts/rjax.erb
+- spec/dummy/users/_user_rjax.erb
+- spec/dummy/users/_users_rjax.erb
+- spec/dummy/users/index_rjax.erb
+- spec/rjax/rjax_resolver_spec.rb
+- spec/rjax/rjax_spec.rb
+- spec/spec_helper.rb