RubyGems - rails_jq_grid - Versions diffs - 0.0.2 - Mend

rails_jq_grid 0.0.2

Files changed (160) hide show

data/README.rdoc ADDED Viewed

@@ -0,0 +1,176 @@
+= Rails JqGrid
+This Rails 3 Enginge allows you to use jQGrid into your applications with REST support.
+When used with rest sudgrids and details grids are treated as nestet resources. URL's
+are constructect from mastergrid-url + selecedted id + detail/sub-grid-url.
+It' is bundled with jqGrid 3.7.2 and some themes. To use your
+custom themes put them under
+RAILS_ROOT\public\stylesheets\rails-jqgrid\themes
+== Usage
+=== Controller
+  include RailsJqGrid::ActsAsJqGridAble
+  acts_as_jqgrid_able
+  order_by_cols :col_name1, :col_name2
+  def action
+    ...
+    @records = MyModel.all(:order => order_by, :limit => records_per_page, :offset => current_offset)
+     respond_to do |format|
+        format.html {  }
+        format.xml {  }
+        format.json {
+          #for multiple pages
+          render :json => jqgrid_json(:total_records => @total_records,
+                                      :default_records_per_page => @default_records_per_page,
+                                      :data =>  @records)
+          #or for a single page
+          #render :json => jqgrid_json(:data =>  @records)
+        }
+     end
+   end
+=== View
+  <head>
+    ...
+    <%= jqgrid_stylesheets_tags(:theme => "start") %>
+    <%= jqgrid_js_tags %>
+    ...
+  </head>
+  ...
+  <%=jqgrid("Article", "article", url_for(:action => "index"), :restful => true) do |a|
+    a.autowidth true
+    a.width 300
+    a.height 500
+    a.shrink_to_fit true
+    a.row_num 10
+    a.row_list [10,20,50,100]
+    a.search true
+    a.gridview true
+    a.multiselect false
+    a.on_select_row raw "function(){alert('test');}"
+    a.column "ean" do |c|
+      c.label "EAN"
+      c.autowidth true
+      c.resizable true
+      c.editable true
+    end
+    a.column "article_number" do |c|
+      c.label "Article"
+      c.resizable true
+      c.editable true
+    end
+    a.jqgrid "Prices", "prices", url_for(:controller => :prices),
+                                 :url_append_ids => true,
+                                 :type => :sub_grid,
+                                 :restful => true do |p|
+      p.autowidth true
+      p.width 300
+      p.height 500
+      p.shrink_to_fit true
+      p.row_num 10
+      p.row_list [10,20,50,100]
+      p.search true
+      p.gridview true
+      p.multiselect false
+      p.on_select_row << "function(id,status){alert('test2');}"
+      p.column "price" do
+        c.autowidth true
+        c.resizable true
+      end
+      p.column "valid_from"
+    end
+    a.jqgrid "Prices Detail", "prices_detail",
+                              url_for(:controller => :prices ,
+                                      :action => "index"),
+                              :caption_append_ids => true,
+                              :type => :detail_grid do |p|
+      p.autowidth true
+      p.width 300
+      p.height 500
+      p.shrink_to_fit true
+      p.row_num 10
+      p.row_list [10,20,50,100]
+      p.search true
+      p.gridview true
+      p.multiselect false
+      p.on_select_row << "function(id,status){alert('test2');}"
+      p.column "ean" do
+        c.label "EAN"
+        c.autowidth true
+        c.resizable true
+      end
+      p.column "article_number" do
+        c.label "Article"
+        c.resizable true
+      end
+      # some columns with the same options
+      p.columns "col1", "col2" , "col3", "col4" do |c|
+        c.autowidth true
+        c.resizable true
+        c.editable true
+        c.height "30px"
+      end
+      #alter options for one column
+      p.column "col1" do |c|
+        c.editable false
+        c.height "40px"
+      end
+    end
+  end  %>
+=== Model
+  class MyModel < ActiveRecord::Base
+    self.include_root_in_json = false
+  end
+=== I18N
+  When a column doesn't set label then human_attribute_name is used for the fieldname
+  to guess the label. To use I18N just setup your local and create a local file like:
+   -RAILS_ROOT
+   |-config
+     |-locales
+       | - en.yml
+  content for en.yml:
+    en:
+      attributes:
+         col1: "Label for Col1"
+         col2: "Label for Col2"
+== Copyright
+Copyright (c) 2010 Dieter Spaeth. See GPL-LICENSE for details.

data/Rakefile ADDED Viewed

@@ -0,0 +1,47 @@
+require 'rubygems'
+require "rake"
+require 'rake/testtask'
+require 'rake/rdoctask'
+begin
+  require "jeweler"
+  Jeweler::Tasks.new do |gem|
+    gem.name = "rails_jq_grid"
+    gem.summary = "Add JqGrid to your Rails 3 app"
+    gem.email = "dieter.spaeth@gmx.de"
+    gem.authors = ["Dieter Spaeth"]
+    gem.homepage = "http://github.com/consu/rails-jqgrid"
+    gem.add_development_dependency "rspec", ">= 1.2.9"
+    gem.files = Dir["*", "{lib}/**/*", "{public}/**/*", "{spec}/**/*", "{app}/**/*"]
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: sudo gem install jeweler"
+end
+require 'spec/rake/spectask'
+Spec::Rake::SpecTask.new(:spec) do |spec|
+  spec.libs << 'lib' << 'spec'
+  spec.spec_files = FileList['spec/**/*_spec.rb']
+end
+Spec::Rake::SpecTask.new(:rcov) do |spec|
+  spec.libs << 'lib' << 'spec'
+  spec.pattern = 'spec/**/*_spec.rb'
+  spec.rcov = true
+end
+task :spec => :check_dependencies
+task :default => :spec
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "ko #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION ADDED Viewed

	@@ -0,0 +1 @@
1	+ 0.0.2

data/app/helpers/rails_jq_grid/jq_grid_css_helper.rb ADDED Viewed

@@ -0,0 +1,29 @@
+# To change this template, choose Tools | Templates
+# and open the template in the editor.
+module RailsJqGrid
+  module JqGridCssHelper
+   STYLESHEETS_BASE = "/stylesheets/rails-jqgrid"
+   JQUERY_UI_THEMES_BASE   = STYLESHEETS_BASE + "/themes"
+   JQUERY_UI_VERSION = "1.8.4"
+    def jqgrid_stylesheets_tags(options={})
+      [jqgrid_ui_stylesheet_tag(options),
+       jquery_ui_stylesheet_tag(options)
+      ].join("\n").html_safe
+    end
+    def jqgrid_ui_stylesheet_tag(options={})
+      (stylesheet_link_tag STYLESHEETS_BASE + "/ui.jqgrid.css").html_safe
+    end
+    def jquery_ui_stylesheet_tag(options={})
+      (stylesheet_link_tag JQUERY_UI_THEMES_BASE + "/#{jquery_theme(options)}" +"/jquery-ui-#{JQUERY_UI_VERSION}.custom.css").html_safe
+    end
+    def jquery_theme(options={})
+      options[:theme] || "start"
+    end
+  end
+end

data/app/helpers/rails_jq_grid/jq_grid_helper.rb ADDED Viewed

@@ -0,0 +1,21 @@
+# To change this template, choose Tools | Templates
+# and open the template in the editor.
+require 'rails_jq_grid/jq_grid'
+module RailsJqGrid
+  module JqGridHelper
+    include JqGridJsHelper
+    include JqGridCssHelper
+    def jqgrid(title, dom_id, url_for_options, options={}, &option_block)
+      if url_for_options.is_a?(Hash)
+        url_for_options[:controller]||=controller.controller_name
+      end
+      ::RailsJqGrid::JqGrid.new(title, dom_id, url_for_options, options, &option_block).to_html
+    end
+  end
+end

data/app/helpers/rails_jq_grid/jq_grid_js_helper.rb ADDED Viewed

@@ -0,0 +1,30 @@
+# To change this template, choose Tools | Templates
+# and open the template in the editor.
+module RailsJqGrid
+  module JqGridJsHelper
+    JS_BASE = "/javascripts/rails-jqgrid"
+    JQUERY_VERSION = "1.4.2"
+    def jqgrid_js_tags(options={})
+      [jquery_js_tag,
+       jqgrid_i18n_js_tag(options),
+       jqgrid_js_tag
+      ].join("\n").html_safe
+    end
+    def jquery_js_tag
+      (javascript_include_tag JS_BASE + "/jquery-#{JQUERY_VERSION}.min.js").html_safe
+    end
+    def jqgrid_js_tag
+      (javascript_include_tag JS_BASE + "/jquery.jqGrid.min.js").html_safe
+    end
+    def jqgrid_i18n_js_tag(options={})
+      options[:local] ||=  I18n.locale rescue :en
+      (javascript_include_tag JS_BASE + "/i18n/grid.locale-#{options[:local]}.js").html_safe
+    end
+  end
+end

data/app/models/rails_jq_grid/jq_grid.rb ADDED Viewed

@@ -0,0 +1,315 @@
+# To change this template, choose Tools | Templates
+# and open the template in the editor.
+module RailsJqGrid
+  class JqGrid
+    extend ActiveModel::Translation
+    include ActionView::Helpers::JavaScriptHelper
+    include ActionView::Helpers::TagHelper
+    include Rails.application.routes.url_helpers
+    include JqGridMethodMissing
+    attr_accessor :title, :dom_id, :columns_data, :detail_grids, :sub_grid_data,
+                  :proc_binding, :options
+    DEFAULT_OPTIONS = {:row_num             => '10',
+                       :row_list            => [10,25,50,100],
+                       :sortname            => '',
+                       :sortcolumn          => '',
+                       :sortorder           => '',
+                       :scroll              => false,
+                       :scrollrows          => false,
+                       :shrink_to_fit       => true,
+                       :height              => 150,
+                       :width               => 150,
+                       :gridview            => false,
+                       :error_handler       => 'null',
+                       :inline_edit_handler => 'null',
+                       :inline_edit         => false,
+                       :add                 => true,
+                       :delete              => true,
+                       :edit                => true,
+                       :refresh             => true,
+                       :search              => true,
+                       :editurl             => '',
+                       :autowidth           => false,
+                       :rownumbers          => false,
+                       :footerrow           => false,
+                       :user_data_on_footer => false,
+                       :initial_empty       => false,
+                       :viewrecords         => true,
+                       :col_names           => [],
+                       }
+    def initialize(title, dom_id, url_for_options, options={},&option_block)
+      self.title = JqGrid.human_attribute_name(title)
+      self.dom_id = dom_id
+      self.init_jq_grid_js_options DEFAULT_OPTIONS
+      self.columns_data = []
+      self.detail_grids = []
+      self.proc_binding = option_block.binding
+      self.options = options
+      #fancier syntax, but heavier to handle
+      #self.instance_eval(&option_block) if block_given?
+      self.url my_url_for(url_for_options)
+      if self.is_restful?
+        self.editurl my_url_for(url_for_options)
+      end
+      option_block.call(self) if block_given?
+      detail_grids_connect_js_to_options
+      sub_grid_js_to_options
+    end
+    def my_url_for(url_for_options = nil)
+      case url_for_options
+      when String
+        url_for_options
+      when nil, Hash
+        url_for_options ||= {:action => "blub"}
+        url_for_options[:only_path]=true
+        url_for(url_for_options)
+      else
+         polymorphic_url(url_for_options, :only_path => true)
+      end
+    end
+    def jqgrid(title, dom_id, url, options={} ,&option_block)
+      options[:type] ||= :detail_grid
+      grid = {:jqgrid => JqGrid.new(title, dom_id, url, options, &option_block), :options => options}
+      if  options[:type] == :detail_grid
+        self.detail_grids << grid
+      else
+        self.sub_grid_data = grid
+      end
+    end
+    def pager_id
+      "#{dom_id}pager"
+    end
+    def columns(*fields,&block)
+      fields.each do |field|
+        self.column(field,&block)
+      end
+    end
+    def column(field,&block)
+      find_or_create_column(field).set_column_options(&block)
+    end
+    def find_or_create_column(field)
+      col = self.columns_data.find{|col| col.field == field}
+      if col.nil?
+        col = JqGridColumn.new(field)
+        self.columns_data << col
+      end
+      col
+    end
+    def to_html
+      parts =[]
+      parts << javascript_tag(jq_grid_function_js)
+      parts << "<table id='#{dom_id}'></table> <div id='#{pager_id}'></div> ".html_safe
+      parts << detail_grids_html
+      parts.join("\n").html_safe
+    end
+    def jq_grid_function_js
+      js_str=<<-EO_JS
+      jQuery(document).ready(function(){
+        #{jq_grid_js}
+        #{nav_grid_js}
+      });
+      EO_JS
+      js_str.html_safe
+    end
+    def jq_grid_js
+      <<-EO_JS
+        var jqgrid_#{dom_id} = jQuery("##{dom_id}").jqGrid({
+        caption: "#{self.title}",
+        datatype: '#{jq_grid_js_options[:initial_empty] == "true" ? "local" : "json"}',
+        pager: '##{pager_id}',
+        jsonReader: {
+          repeatitems: false,	cell: "",
+          root:  "data",
+          page:  "currentpage",
+          total: "totalpages",
+          records: "totalrecords"
+        },
+        colModel: #{col_models},
+        colNames: #{col_names},
+        #{options_to_jqgrid_options}
+        });
+      EO_JS
+    end
+    def col_models
+      "[" +
+      self.columns_data.map {|col|
+        "{ " + col.options_to_jqgrid_options + "}\n"
+      }.join(",\n") +
+      "]"
+    end
+    def col_names
+      "[" +
+      self.columns_data.map {|col|
+        col.name.to_json
+      }.join(",\n") +
+      "]"
+    end
+    def nav_grid_js
+      params=[nav_grid_parameters]
+      params.push(nav_grid_restful_extensions).flatten! if is_restful?
+      <<-EO_JS
+        jQuery("##{dom_id}").jqGrid('navGrid','##{pager_id}',#{params.join(",\n")} );
+      EO_JS
+    end
+    def is_restful?
+      self.options[:restful]
+    end
+    def nav_grid_parameters
+      <<-EO_JS
+        {edit:#{jq_grid_js_options[:edit]},
+         add:#{jq_grid_js_options[:add]},
+         del:#{jq_grid_js_options[:delete]},
+         search:#{jq_grid_js_options[:search]},
+         refresh:#{jq_grid_js_options[:refresh]}
+        }
+      EO_JS
+    end
+    def nav_grid_restful_extensions
+      #url = articles_path
+      [restful_param_edit, restful_param_add, restful_param_delete]
+    end
+    def restful_param_edit
+      <<-EO_JS
+           { mtype: "PUT",
+             onclickSubmit: function(rp_ge, postdata) {
+                              selrow = jQuery("##{dom_id}").jqGrid('getGridParam','selrow');
+                              if (selrow!=null){
+                                rp_ge.url = jQuery("##{dom_id}").jqGrid('getGridParam','editurl') + '/' + selrow;
+                              }
+                              return {};
+                            }
+           }
+      EO_JS
+    end
+    def restful_param_add
+      <<-EO_JS
+           { mtype: "POST" }
+      EO_JS
+    end
+    def restful_param_delete
+      <<-EO_JS
+           { mtype: "DELETE",
+             onclickSubmit: function(rp_ge, postdata) {
+                              rp_ge.url = jQuery("##{dom_id}").jqGrid('getGridParam','editurl') + '/' + postdata
+                              return {};
+                            }
+           }
+      EO_JS
+    end
+    def detail_grids_html
+      self.detail_grids.map do |detail_grid|
+        detail_grid[:jqgrid].to_html
+      end.join("\n").html_safe
+    end
+    def detail_grids_connect_js_to_options
+      if self.detail_grids.count > 0
+        # it hast to be raw and not << because of execution order and key creation
+        on_select_row raw detail_grids_connect_js
+      end
+    end
+    def detail_grids_connect_js
+      parts = ["function(ids,status){"]
+      if self.jq_grid_js_options.has_key? :on_select_row
+        parts << "custom_function = #{self.jq_grid_js_options[:on_select_row].escaped_value};"
+        parts << "custom_function(ids,status);"
+      end
+      parts << self.detail_grids.map do |detail_grid|
+                  detail_grid_connect_js(detail_grid[:jqgrid],detail_grid[:options])
+               end
+      parts << "}"
+      parts.flatten.join("\n").html_safe
+    end
+    def detail_grid_connect_js(detail_grid, options)
+      caption = "'#{detail_grid.title}'"
+      if options[:js_caption]
+        caption = options[:js_caption]
+      elsif options[:caption_append_ids]
+        caption = "'#{detail_grid.title}: '+ids"
+      end
+      detail_grid_url = detail_grid.get_jq_grid_js_options(:url).escaped_value
+      js_url = %Q("#{detail_grid_url}?&id="+ids)
+      if detail_grid.is_restful? && self.is_restful?
+        js_url = %Q(#{self.get_jq_grid_js_options(:url).escaped_value}+'/'+ids+#{detail_grid_url})
+        js_url ="#{js_url}, editurl:#{js_url}"
+      end
+      <<-EO_JS
+        jQuery("##{detail_grid.dom_id}").setGridParam({url:#{js_url},page:1})
+                  .setCaption(#{caption})
+                  .trigger('reloadGrid');
+      EO_JS
+    end
+    def sub_grid_js_to_options
+      unless self.sub_grid_data.nil?
+        grid = self.sub_grid_data[:jqgrid]
+        sub_grid true
+        # Grid-View and SubGrid doesn't work together http://www.trirand.com/jqgridwiki/doku.php?id=wiki:jq_grid_js_options
+        grid_view false
+        if self.sub_grid_data[:options] && self.sub_grid_data[:options][:url_append_ids] && ! (grid.is_restful? && self.is_restful?)
+          grid.url raw grid.get_jq_grid_js_options(:url).escaped_value + "+'&id='+row_id"
+        end
+        if grid.is_restful? && self.is_restful?
+          grid.url raw self.get_jq_grid_js_options(:url).escaped_value + "+'/'+row_id+" + grid.get_jq_grid_js_options(:url).escaped_value
+          grid.editurl raw grid.get_jq_grid_js_options(:url).escaped_value
+        end
+        sub_grid_row_expanded raw <<-EO_JS
+          function(subgrid_id, row_id) {
+            subgrid_table_id = subgrid_id+"_t";
+            jQuery("#"+subgrid_id).html("<table id='#{grid.dom_id}' class='scroll'></table><div id='#{grid.pager_id}'></div>");
+            #{grid.jq_grid_js}
+          }
+        EO_JS
+      end
+    end
+  end
+end

data/app/models/rails_jq_grid/jq_grid_column.rb ADDED Viewed

@@ -0,0 +1,33 @@
+# To change this template, choose Tools | Templates
+# and open the template in the editor.
+module RailsJqGrid
+  class JqGridColumn
+    extend ActiveModel::Translation
+    include JqGridMethodMissing
+    attr_accessor :field
+    def initialize(field, &option_block)
+      self.field = field
+      self.init_jq_grid_js_options "name" => field, "index" => field
+      self.label JqGridColumn.human_attribute_name(field)
+      #fancier syntax, but heavier to handle
+      #self.instance_eval(&option_block) if block_given?
+      set_column_options(&option_block)
+    end
+    def set_column_options(&option_block)
+      option_block.call(self) if block_given?
+    end
+    def name
+      self.jq_grid_js_options[:label]
+    end
+  end
+end

data/app/models/rails_jq_grid/jq_grid_method_missing.rb ADDED Viewed

@@ -0,0 +1,50 @@
+# To change this template, choose Tools | Templates
+# and open the template in the editor.
+module RailsJqGrid
+  module JqGridMethodMissing
+    attr_accessor :jq_grid_js_options
+    def method_missing(symbol, *args, &block)
+      #method_name = symbol.to_s
+      #if method_name.eql?("url_for") || method_name =~ /_path$/
+      #  call_parent symbol, *args, &block
+      #else
+      #  RAILS_DEFAULT_LOGGER.debug "Method Missing #{symbol} #{args.inspect}"
+      self.jq_grid_js_options ||={}
+      self.jq_grid_js_options[symbol] = JqGridOptionOrMethod.new(symbol, args[0])
+      #end
+    end
+    # def call_parent(*args)
+    #   # Dirty Hack to get url_for to work
+    #   # when called from a detail jqgrid in a block
+    #   parent_context = eval('self', self.proc_binding)
+    #   parent_context.send *args
+    # end
+    def raw(*args)
+      {:type => :raw, :value => args[0]}
+    end
+    def get_jq_grid_js_options(symbol)
+      self.jq_grid_js_options[symbol]
+    end
+    def init_jq_grid_js_options(new_options)
+      self.jq_grid_js_options ||={}
+      new_options.each do |key, value|
+        self.jq_grid_js_options[key] = JqGridOptionOrMethod.new(key, value)
+      end
+    end
+    def options_to_jqgrid_options
+      jqgrid_options = []
+      self.jq_grid_js_options.each_value { |option|
+        jqgrid_options << "#{option.escaped_name}: #{option.escaped_value}"
+      }
+      jqgrid_options.sort.join(",\n ")
+    end
+  end
+end