extjs_renderer 0.1.3

data/.gitignore

@@ -0,0 +1,8 @@
+.bundle/
+log/*.log
+pkg/
+spec/dummy/db/*.sqlite3
+spec/dummy/log/*.log
+spec/dummy/tmp/
+.rvmrc
+.rspec

data/.rspec

@@ -0,0 +1,2 @@
+--colour
+#--format documentation

data/Gemfile

@@ -0,0 +1,3 @@
+source "http://rubygems.org"
+
+gemspec

data/Gemfile.lock

@@ -0,0 +1,112 @@
+PATH
+  remote: .
+  specs:
+    extjs_renderer (0.1.3)
+      actionpack (> 3.0.0)
+
+GEM
+  remote: http://rubygems.org/
+  specs:
+    abstract (1.0.0)
+    actionmailer (3.0.11)
+      actionpack (= 3.0.11)
+      mail (~> 2.2.19)
+    actionpack (3.0.11)
+      activemodel (= 3.0.11)
+      activesupport (= 3.0.11)
+      builder (~> 2.1.2)
+      erubis (~> 2.6.6)
+      i18n (~> 0.5.0)
+      rack (~> 1.2.1)
+      rack-mount (~> 0.6.14)
+      rack-test (~> 0.5.7)
+      tzinfo (~> 0.3.23)
+    activemodel (3.0.11)
+      activesupport (= 3.0.11)
+      builder (~> 2.1.2)
+      i18n (~> 0.5.0)
+    activerecord (3.0.11)
+      activemodel (= 3.0.11)
+      activesupport (= 3.0.11)
+      arel (~> 2.0.10)
+      tzinfo (~> 0.3.23)
+    activeresource (3.0.11)
+      activemodel (= 3.0.11)
+      activesupport (= 3.0.11)
+    activesupport (3.0.11)
+    arel (2.0.10)
+    builder (2.1.2)
+    diff-lcs (1.1.3)
+    erubis (2.6.6)
+      abstract (>= 1.0.0)
+    factory_girl (2.3.0)
+      activesupport
+    factory_girl_rails (1.4.0)
+      factory_girl (~> 2.3.0)
+      railties (>= 3.0.0)
+    i18n (0.5.0)
+    json (1.6.1)
+    kaminari (0.12.4)
+      rails (>= 3.0.0)
+    mail (2.2.19)
+      activesupport (>= 2.3.6)
+      i18n (>= 0.4.0)
+      mime-types (~> 1.16)
+      treetop (~> 1.4.8)
+    mime-types (1.17.2)
+    polyglot (0.3.3)
+    rack (1.2.4)
+    rack-mount (0.6.14)
+      rack (>= 1.0.0)
+    rack-test (0.5.7)
+      rack (>= 1.0)
+    rails (3.0.11)
+      actionmailer (= 3.0.11)
+      actionpack (= 3.0.11)
+      activerecord (= 3.0.11)
+      activeresource (= 3.0.11)
+      activesupport (= 3.0.11)
+      bundler (~> 1.0)
+      railties (= 3.0.11)
+    railties (3.0.11)
+      actionpack (= 3.0.11)
+      activesupport (= 3.0.11)
+      rake (>= 0.8.7)
+      rdoc (~> 3.4)
+      thor (~> 0.14.4)
+    rake (0.9.2.2)
+    rdoc (3.11)
+      json (~> 1.4)
+    rspec (2.7.0)
+      rspec-core (~> 2.7.0)
+      rspec-expectations (~> 2.7.0)
+      rspec-mocks (~> 2.7.0)
+    rspec-core (2.7.1)
+    rspec-expectations (2.7.0)
+      diff-lcs (~> 1.1.2)
+    rspec-mocks (2.7.0)
+    rspec-rails (2.7.0)
+      actionpack (~> 3.0)
+      activesupport (~> 3.0)
+      railties (~> 3.0)
+      rspec (~> 2.7.0)
+    sqlite3 (1.3.4)
+    thor (0.14.6)
+    treetop (1.4.10)
+      polyglot
+      polyglot (>= 0.3.1)
+    tzinfo (0.3.31)
+    will_paginate (3.0.2)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  extjs_renderer!
+  factory_girl_rails
+  kaminari
+  rails (~> 3.0.0)
+  rspec (~> 2.7.0)
+  rspec-rails (~> 2.7.0)
+  sqlite3
+  will_paginate (~> 3.0.0)

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2011 Mark H Winkler
+
+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.md

@@ -0,0 +1,63 @@
+# ExtjsRenderer
+
+Rails 3 Renderer to send JSON compatible with Sencha Extjs 3+
+
+## Usage
+
+### ActiveRecord Relations
+
+JSON root defaults to resource:
+
+	Controller action:
+
+	def index
+		@items = Item.order('name')
+		respond_with @items do |format|
+			format.json { render :extjs => @items }
+		end
+	end
+
+	Output:
+
+	{"total":1,"item":[{"id":1,"name":"widget"}]}
+	
+Custom JSON root and to_json params:
+
+	Controller action:
+
+	def index
+		@items = Item.order('name')
+		respond_with @items do |format|
+			format.json { render :extjs => @items, :root => "product", :only => [:name], :methods => [:custom] }
+		end
+	end
+
+	Or
+
+	def index
+		@items = Item.order('name')
+		respond_with @items do |format|
+			format.json { render :extjs => @items, :root => "product", :except => [:id], :methods => [:custom] }
+		end
+	end
+
+	Output:
+
+	{"total":1,"product":[{"name":"widget","custom":"custom method output"}]}
+	
+### Single Resource
+
+Root defaults to 'data' or :root => 'custom':
+
+	Controller action:
+
+		def edit
+			@item = Item.find(params[:id])
+			respond_with @items do |format|
+				format.json { render :extjs => @item, :only => [:name], :methods => [:custom] }
+			end
+		end
+
+	Output:
+
+	{"success":true,"data":[{"name":"widget","custom":"custom method output"}]}

data/Rakefile

@@ -0,0 +1,25 @@
+# encoding: UTF-8
+require 'rubygems'
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+require 'rake'
+require 'rake/rdoctask'
+
+require 'rspec/core'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec
+
+Rake::RDocTask.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'ExtjsRenderer'
+  rdoc.options << '--line-numbers' << '--inline-source'
+  rdoc.rdoc_files.include('README.md')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/extjs_renderer.gemspec

@@ -0,0 +1,26 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "extjs_renderer/version"
+
+Gem::Specification.new do |s|
+  s.name        = "extjs_renderer"
+  s.version     = ExtjsRenderer::VERSION
+  s.authors     = ["Mark H Winkler"]
+  s.email       = ["mhwinkler@gmail.com"]
+  s.homepage    = "https://github.com/mojomaze/extjs_renderer"
+  s.summary     = "Rails 3 Renderer for ExtJ3+"
+  s.description = "Rails 3 Renderer for JSON compatible with Sencha Extjs 3+"
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {spec}/*`.split("\n")
+  s.require_paths = ["lib"]
+
+  s.add_development_dependency "rails", "~> 3.0.0"
+  s.add_development_dependency "sqlite3"
+  s.add_development_dependency "rspec", "~> 2.7.0"
+  s.add_development_dependency "rspec-rails", "~> 2.7.0"
+  s.add_development_dependency "factory_girl_rails"
+  s.add_development_dependency "will_paginate", "~> 3.0.0"
+  s.add_development_dependency "kaminari"
+  s.add_runtime_dependency "actionpack", "> 3.0.0"
+end

data/lib/extjs_renderer/renderer.rb

@@ -0,0 +1,31 @@
+module ExtjsRenderer
+  require "action_controller"
+
+  ActionController::Renderers.add :extjs do |resource, options|
+    if resource.is_a?(ActiveRecord::Relation)
+      # get or set the total
+      if options && options.has_key?(:total)
+        total = options[:total]  # set if passed
+      elsif resource.respond_to?(:total_count)
+        total = resource.total_count # kaminari total found
+      elsif resource.respond_to?(:total_entries)
+        total = resource.total_entries # will_paginate total found
+      else
+        total = resource.size # total in relation
+      end
+
+      # set root to passed or resource
+      root = options && options.has_key?(:root) ? options[:root] : resource.last.class.name.downcase
+
+      json = '{"total":'+total.to_s+',"'+root+'":'+resource.to_json(options)+'}'
+    
+    else
+      # set root to passed or 'data' which is used by extjs to load forms
+      root = options && options.has_key?(:root) ? options[:root] : 'data'
+
+      json = '{"success":true,"'+root+'":'+resource.to_json(options)+'}'
+    end
+
+    send_data(json, :type => :json)
+  end
+end

data/lib/extjs_renderer/version.rb

@@ -0,0 +1,3 @@
+module ExtjsRenderer
+  VERSION = "0.1.3"
+end

data/lib/extjs_renderer.rb

@@ -0,0 +1,2 @@
+require "extjs_renderer/version"
+require "extjs_renderer/renderer"

data/spec/dummy/Rakefile

@@ -0,0 +1,7 @@
+# Add your own tasks in files placed in lib/tasks ending in .rake,
+# for example lib/tasks/capistrano.rake, and they will automatically be available to Rake.
+
+require File.expand_path('../config/application', __FILE__)
+require 'rake'
+
+Dummy::Application.load_tasks

data/spec/dummy/app/controllers/application_controller.rb

@@ -0,0 +1,3 @@
+class ApplicationController < ActionController::Base
+  protect_from_forgery
+end

data/spec/dummy/app/controllers/items_controller.rb

@@ -0,0 +1,17 @@
+class ItemsController < ApplicationController
+  respond_to :html, :json
+  
+  def index
+    @items = Item.order('name')
+    respond_with @items do |format|
+      format.json { render :extjs => @items }
+    end
+  end
+  
+  def edit
+    @item = Item.find(params[:id])
+    respond_with @item do |format|
+      format.json { render :extjs => @item }
+    end
+  end
+end

data/spec/dummy/app/controllers/orders_controller.rb

@@ -0,0 +1,115 @@
+class OrdersController < ApplicationController
+  respond_to :html, :json
+  def index
+    @orders = Order.order('name')
+    respond_with @orders do |format|
+      format.json { render :extjs => @orders }
+    end
+  end
+  
+  def index_with_nested_resource
+    @orders = Order.order('name')
+    respond_with @orders do |format|
+      format.json { render :extjs => @orders, :include => :items }
+    end
+  end
+  
+  def change_root
+    @orders = Order.order('name')
+    respond_with @orders do |format|
+      format.json { render :extjs => @orders, :root => 'custom_root' }
+    end
+  end
+  
+  def change_total
+    @orders = Order.order('name')
+    respond_with @orders do |format|
+      format.json { render :extjs => @orders, :total => 34 }
+    end
+  end
+  
+  def with_method
+    @orders = Order.order('name')
+    respond_with @orders do |format|
+      format.json { render :extjs => @orders, :root => 'custom_root', :total => 34, 
+                          :methods => [:custom] }
+    end
+  end
+  
+  def only_and_method
+    @orders = Order.order('name')
+    respond_with @orders do |format|
+      format.json { render :extjs => @orders, :root => 'custom_root', :total => 34, 
+                        :only => :name, :methods => :custom }
+    end
+  end
+  
+  def except_and_method
+    @orders = Order.order('name')
+    respond_with @orders do |format|
+      format.json { render :extjs => @orders, :root => 'custom_root', :total => 34, 
+                        :except => [:created_at, :updated_at], :methods => :custom }
+    end
+  end
+  
+  # pagination
+  def index_will_paginate
+    @orders = Order.where("name LIKE ?", '%order%').paginate(:page => 1, :per_page => 25)
+    respond_with @orders do |format|
+      format.json { render :extjs => @orders }
+    end
+  end
+  
+  def index_kaminari_pagination
+    @orders = Order.where("name LIKE ?", '%order%').page(1)
+    respond_with @orders do |format|
+      format.json { render :extjs => @orders }
+    end
+  end
+  
+  def edit
+    @order = Order.find(params[:id])
+    respond_with @order do |format|
+      format.json { render :extjs => @order }
+    end
+  end
+  
+  def edit_change_root
+    @order = Order.find(params[:id])
+    respond_with @order do |format|
+      format.json { render :extjs => @order, :root => 'custom_root' }
+    end
+  end
+  
+  def edit_with_method
+    @order = Order.find(params[:id])
+    respond_with @order do |format|
+      format.json { render :extjs => @order, :root => 'custom_root',
+                        :methods => :custom }
+    end
+  end
+  
+  def edit_only_and_method
+    @order = Order.find(params[:id])
+    respond_with @order do |format|
+      format.json { render :extjs => @order, :root => 'custom_root',
+                        :methods => :custom, :only => [:id, :name] }
+    end
+  end
+  
+  def edit_except_and_method
+    @order = Order.find(params[:id])
+    respond_with @order do |format|
+      format.json { render :extjs => @order, :root => 'custom_root',
+                        :methods => :custom, :except => [:created_at, :updated_at] }
+    end
+  end
+  
+  def edit_with_nested_resource
+    @order = Order.find(params[:id])
+    respond_with @order do |format|
+      format.json { render :extjs => @order, :include => :items }
+    end
+  end
+
+end

data/spec/dummy/app/helpers/application_helper.rb

@@ -0,0 +1,2 @@
+module ApplicationHelper
+end

data/spec/dummy/app/helpers/orders_helper.rb

@@ -0,0 +1,2 @@
+module OrdersHelper
+end

data/spec/dummy/app/models/item.rb

@@ -0,0 +1,8 @@
+class Item < ActiveRecord::Base
+  belongs_to :order
+  
+  def as_json(options=nil)
+    serializable_hash({:only => [:id, :name] })
+  end
+  
+end

data/spec/dummy/app/models/order.rb

@@ -0,0 +1,10 @@
+class Order < ActiveRecord::Base
+  has_many :items
+  
+  attr_accessor :custom
+  
+  # custom attribute
+  def custom
+     "Populated Custom Value"
+  end
+end

data/spec/dummy/app/views/items/index.html.erb

@@ -0,0 +1,2 @@
+<h1>Items#index</h1>
+<p>Find me in app/views/items/index.html.erb</p>

data/spec/dummy/app/views/layouts/application.html.erb

@@ -0,0 +1,14 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title>Dummy</title>
+  <%= stylesheet_link_tag :all %>
+  <%= javascript_include_tag :defaults %>
+  <%= csrf_meta_tag %>
+</head>
+<body>
+
+<%= yield %>
+
+</body>
+</html>

data/spec/dummy/app/views/orders/index.html.erb

@@ -0,0 +1,2 @@
+<h1>Orders#index</h1>
+<p>Find me in app/views/orders/index.html.erb</p>

data/spec/dummy/config/application.rb

@@ -0,0 +1,48 @@
+require File.expand_path('../boot', __FILE__)
+
+require "active_model/railtie"
+require "active_record/railtie"
+require "action_controller/railtie"
+require "action_view/railtie"
+require "action_mailer/railtie"
+
+Bundler.require
+
+#require "kaminari"
+require "will_paginate"
+require "extjs_renderer"
+
+module Dummy
+  class Application < Rails::Application
+    # Settings in config/environments/* take precedence over those specified here.
+    # Application configuration should go into files in config/initializers
+    # -- all .rb files in that directory are automatically loaded.
+
+    # Custom directories with classes and modules you want to be autoloadable.
+    # config.autoload_paths += %W(#{config.root}/extras)
+
+    # Only load the plugins named here, in the order given (default is alphabetical).
+    # :all can be used as a placeholder for all plugins not explicitly named.
+    # config.plugins = [ :exception_notification, :ssl_requirement, :all ]
+
+    # Activate observers that should always be running.
+    # config.active_record.observers = :cacher, :garbage_collector, :forum_observer
+
+    # Set Time.zone default to the specified zone and make Active Record auto-convert to this zone.
+    # Run "rake -D time" for a list of tasks for finding time zone names. Default is UTC.
+    # config.time_zone = 'Central Time (US & Canada)'
+
+    # The default locale is :en and all translations from config/locales/*.rb,yml are auto loaded.
+    # config.i18n.load_path += Dir[Rails.root.join('my', 'locales', '*.{rb,yml}').to_s]
+    # config.i18n.default_locale = :de
+
+    # JavaScript files you want as :defaults (application.js is always included).
+    # config.action_view.javascript_expansions[:defaults] = %w(jquery rails)
+
+    # Configure the default encoding used in templates for Ruby 1.9.
+    config.encoding = "utf-8"
+
+    # Configure sensitive parameters which will be filtered from the log file.
+    config.filter_parameters += [:password]
+  end
+end

data/spec/dummy/config/boot.rb

@@ -0,0 +1,10 @@
+require 'rubygems'
+gemfile = File.expand_path('../../../../Gemfile', __FILE__)
+
+if File.exist?(gemfile)
+  ENV['BUNDLE_GEMFILE'] = gemfile
+  require 'bundler'
+  Bundler.setup
+end
+
+$:.unshift File.expand_path('../../../../lib', __FILE__)

data/spec/dummy/config/database.yml

@@ -0,0 +1,22 @@
+# SQLite version 3.x
+#   gem install sqlite3
+development:
+  adapter: sqlite3
+  database: db/development.sqlite3
+  pool: 5
+  timeout: 5000
+
+# Warning: The database defined as "test" will be erased and
+# re-generated from your development database when you run "rake".
+# Do not set this db to the same as development or production.
+test:
+  adapter: sqlite3
+  database: db/test.sqlite3
+  pool: 5
+  timeout: 5000
+
+production:
+  adapter: sqlite3
+  database: db/production.sqlite3
+  pool: 5
+  timeout: 5000

data/spec/dummy/config/environment.rb

@@ -0,0 +1,5 @@
+# Load the rails application
+require File.expand_path('../application', __FILE__)
+
+# Initialize the rails application
+Dummy::Application.initialize!

data/spec/dummy/config/environments/development.rb

@@ -0,0 +1,26 @@
+Dummy::Application.configure do
+  # Settings specified here will take precedence over those in config/application.rb
+
+  # In the development environment your application's code is reloaded on
+  # every request.  This slows down response time but is perfect for development
+  # since you don't have to restart the webserver when you make code changes.
+  config.cache_classes = false
+
+  # Log error messages when you accidentally call methods on nil.
+  config.whiny_nils = true
+
+  # Show full error reports and disable caching
+  config.consider_all_requests_local       = true
+  config.action_view.debug_rjs             = true
+  config.action_controller.perform_caching = false
+
+  # Don't care if the mailer can't send
+  config.action_mailer.raise_delivery_errors = false
+
+  # Print deprecation notices to the Rails logger
+  config.active_support.deprecation = :log
+
+  # Only use best-standards-support built into browsers
+  config.action_dispatch.best_standards_support = :builtin
+end
+

data/spec/dummy/config/environments/production.rb

@@ -0,0 +1,49 @@
+Dummy::Application.configure do
+  # Settings specified here will take precedence over those in config/application.rb
+
+  # The production environment is meant for finished, "live" apps.
+  # Code is not reloaded between requests
+  config.cache_classes = true
+
+  # Full error reports are disabled and caching is turned on
+  config.consider_all_requests_local       = false
+  config.action_controller.perform_caching = true
+
+  # Specifies the header that your server uses for sending files
+  config.action_dispatch.x_sendfile_header = "X-Sendfile"
+
+  # For nginx:
+  # config.action_dispatch.x_sendfile_header = 'X-Accel-Redirect'
+
+  # If you have no front-end server that supports something like X-Sendfile,
+  # just comment this out and Rails will serve the files
+
+  # See everything in the log (default is :info)
+  # config.log_level = :debug
+
+  # Use a different logger for distributed setups
+  # config.logger = SyslogLogger.new
+
+  # Use a different cache store in production
+  # config.cache_store = :mem_cache_store
+
+  # Disable Rails's static asset server
+  # In production, Apache or nginx will already do this
+  config.serve_static_assets = false
+
+  # Enable serving of images, stylesheets, and javascripts from an asset server
+  # config.action_controller.asset_host = "http://assets.example.com"
+
+  # Disable delivery errors, bad email addresses will be ignored
+  # config.action_mailer.raise_delivery_errors = false
+
+  # Enable threaded mode
+  # config.threadsafe!
+
+  # Enable locale fallbacks for I18n (makes lookups for any locale fall back to
+  # the I18n.default_locale when a translation can not be found)
+  config.i18n.fallbacks = true
+
+  # Send deprecation notices to registered listeners
+  config.active_support.deprecation = :notify
+end