RubyGems - rails_jq_grid - Versions diffs - 0.0.2 → 0.0.3.pre1 - Mend

rails_jq_grid 0.0.2 → 0.0.3.pre1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (18) hide show

data/README.rdoc +46 -6
data/Rakefile +12 -1
data/VERSION +1 -1
data/app/helpers/rails_jq_grid/jq_grid_css_helper.rb +13 -2
data/app/helpers/rails_jq_grid/jq_grid_helper.rb +10 -2
data/app/helpers/rails_jq_grid/jq_grid_js_helper.rb +15 -2
data/app/models/rails_jq_grid/jq_grid.rb +19 -57
data/app/models/rails_jq_grid/jq_grid_column.rb +13 -12
data/app/models/rails_jq_grid/jq_grid_method_missing.rb +26 -16
data/app/models/rails_jq_grid/jq_grid_nav_grid.rb +133 -0
data/app/models/rails_jq_grid/jq_grid_nav_grid_parameter.rb +31 -0
data/app/models/rails_jq_grid/jq_grid_option_or_method.rb +17 -2
data/lib/rails_jq_grid/acts_as_jq_grid_able.rb +29 -5
data/lib/rails_jq_grid/engine.rb +11 -10
data/lib/rails_jq_grid.rb +11 -2
data/rails_jq_grid.gemspec +6 -4
metadata +15 -11
data/lib/rails_jq_grid/acts_as_jq_grid_data_source.rb +0 -34

data/README.rdoc CHANGED Viewed

@@ -18,8 +18,8 @@ RAILS_ROOT\public\stylesheets\rails-jqgrid\themes
   def action
     ...
-    @records = MyModel.all(:order => order_by, :limit => records_per_page, :offset => current_offset)
+    relation = MyModel.order(order_by).limit(records_per_page).offset(current_offset)
+    @records = relation.all
      respond_to do |format|
         format.html {  }
@@ -35,6 +35,14 @@ RAILS_ROOT\public\stylesheets\rails-jqgrid\themes
      end
    end
+   # or shorter
+   respond_to :html, :json
+   def action
+     ...
+     respond_with(jqgrid_json(:data =>  @records))
+   end
 === View
   <head>
     ...
@@ -59,6 +67,35 @@ RAILS_ROOT\public\stylesheets\rails-jqgrid\themes
     a.on_select_row raw "function(){alert('test');}"
+    a.nav_grid do |n|
+      # Defaults
+      # n.add   true
+      # n.del   true
+      # n.edit  true
+      # n.refresh true
+      # n.search  true
+      n.prm_edit do |p|
+        p.close_after_edit  false
+      end
+      n.prm_add do |p|
+        # set some options
+      end
+      n.prm_del do |p|
+      end
+      n.prm_search do |p|
+      end
+      n.prm_view do |p|
+      end
+    end
     a.column "ean" do |c|
       c.label "EAN"
       c.autowidth true
@@ -98,7 +135,7 @@ RAILS_ROOT\public\stylesheets\rails-jqgrid\themes
     end
-    a.jqgrid "Prices Detail", "prices_detail",
+    a.jqgrid "prices_detail", "prices_detail",
                               url_for(:controller => :prices ,
                                       :action => "index"),
                               :caption_append_ids => true,
@@ -156,7 +193,9 @@ RAILS_ROOT\public\stylesheets\rails-jqgrid\themes
 === 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:
+  to guess the label. This also applys to grid title.
+  To use I18N just setup your local and create a local file like:
    -RAILS_ROOT
    |-config
@@ -166,8 +205,9 @@ RAILS_ROOT\public\stylesheets\rails-jqgrid\themes
   content for en.yml:
     en:
       attributes:
-         col1: "Label for Col1"
-         col2: "Label for Col2"
+         prices_detail: "Prices details table"
+         col1: "Label for col1"
+         col2: "Label for col2"

data/Rakefile CHANGED Viewed

@@ -1,3 +1,13 @@
+#  This program is free software; you can redistribute it and/or
+#  modify it under the terms of the GNU General Public License
+#  as published by the Free Software Foundation; either version 3
+#  of the License, or (at your option) any later version.
+#  Author::    Dieter Spaeth  (mailto:dieter.spaeth@gmx.de)
+#  Copyright:: Copyright (c) 2010 Dieter Spaeth
 require 'rubygems'
 require "rake"
 require 'rake/testtask'
@@ -8,6 +18,7 @@ begin
   Jeweler::Tasks.new do |gem|
     gem.name = "rails_jq_grid"
     gem.summary = "Add JqGrid to your Rails 3 app"
+    gem.description = "This gems is a Rails 3 Enginge that helps you to create jqGrid. It's bundled with jqGrid and some themes."
     gem.email = "dieter.spaeth@gmx.de"
     gem.authors = ["Dieter Spaeth"]
     gem.homepage = "http://github.com/consu/rails-jqgrid"
@@ -43,5 +54,5 @@ Rake::RDocTask.new do |rdoc|
   rdoc.rdoc_dir = 'rdoc'
   rdoc.title = "ko #{version}"
   rdoc.rdoc_files.include('README*')
-  rdoc.rdoc_files.include('lib/**/*.rb')
+  rdoc.rdoc_files.include('lib/**/*.rb', 'app/**/*.rb')
 end

data/VERSION CHANGED Viewed

	@@ -1 +1 @@
1	- 0.0.2
1	+ 0.0.3.pre1

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

@@ -1,5 +1,11 @@
-# To change this template, choose Tools | Templates
-# and open the template in the editor.
+#  This program is free software; you can redistribute it and/or
+#  modify it under the terms of the GNU General Public License
+#  as published by the Free Software Foundation; either version 3
+#  of the License, or (at your option) any later version.
+#  Author::    Dieter Spaeth  (mailto:dieter.spaeth@gmx.de)
+#  Copyright:: Copyright (c) 2010 Dieter Spaeth
 module RailsJqGrid
   module JqGridCssHelper
@@ -7,12 +13,17 @@ module RailsJqGrid
    JQUERY_UI_THEMES_BASE   = STYLESHEETS_BASE + "/themes"
    JQUERY_UI_VERSION = "1.8.4"
+    # Includes the following stylesheets:
+    # * ui.jqgrid.css
+    # * /stylesheets/rails-jqgrid/themes/[theme_name]/jquery-ui-...custom.css
+    # options:: :theme name of the theme folder, default start
     def jqgrid_stylesheets_tags(options={})
       [jqgrid_ui_stylesheet_tag(options),
        jquery_ui_stylesheet_tag(options)
       ].join("\n").html_safe
     end
+    protected
     def jqgrid_ui_stylesheet_tag(options={})
       (stylesheet_link_tag STYLESHEETS_BASE + "/ui.jqgrid.css").html_safe
     end

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

@@ -1,5 +1,12 @@
-# To change this template, choose Tools | Templates
-# and open the template in the editor.
+#  This program is free software; you can redistribute it and/or
+#  modify it under the terms of the GNU General Public License
+#  as published by the Free Software Foundation; either version 3
+#  of the License, or (at your option) any later version.
+#  Author::    Dieter Spaeth  (mailto:dieter.spaeth@gmx.de)
+#  Copyright:: Copyright (c) 2010 Dieter Spaeth
 require 'rails_jq_grid/jq_grid'
@@ -9,6 +16,7 @@ module RailsJqGrid
     include JqGridJsHelper
     include JqGridCssHelper
+    # Creates javascript-code for jqGrid
     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

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

@@ -1,11 +1,23 @@
-# To change this template, choose Tools | Templates
-# and open the template in the editor.
+#  This program is free software; you can redistribute it and/or
+#  modify it under the terms of the GNU General Public License
+#  as published by the Free Software Foundation; either version 3
+#  of the License, or (at your option) any later version.
+#  Author::    Dieter Spaeth  (mailto:dieter.spaeth@gmx.de)
+#  Copyright:: Copyright (c) 2010 Dieter Spaeth
 module RailsJqGrid
   module JqGridJsHelper
     JS_BASE = "/javascripts/rails-jqgrid"
     JQUERY_VERSION = "1.4.2"
+    # Includes the following javascript libraries:
+    # * jquery-...min.js
+    # * jquery.jqGrid.min.js
+    # * grid.locale-...js
+    # options:: :local local to use, default :en
     def jqgrid_js_tags(options={})
       [jquery_js_tag,
        jqgrid_i18n_js_tag(options),
@@ -13,6 +25,7 @@ module RailsJqGrid
       ].join("\n").html_safe
     end
+    protected
     def jquery_js_tag
       (javascript_include_tag JS_BASE + "/jquery-#{JQUERY_VERSION}.min.js").html_safe
     end

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

@@ -1,5 +1,11 @@
-# To change this template, choose Tools | Templates
-# and open the template in the editor.
+#  This program is free software; you can redistribute it and/or
+#  modify it under the terms of the GNU General Public License
+#  as published by the Free Software Foundation; either version 3
+#  of the License, or (at your option) any later version.
+#  Author::    Dieter Spaeth  (mailto:dieter.spaeth@gmx.de)
+#  Copyright:: Copyright (c) 2010 Dieter Spaeth
 module RailsJqGrid
   class JqGrid
@@ -12,7 +18,7 @@ module RailsJqGrid
     include JqGridMethodMissing
     attr_accessor :title, :dom_id, :columns_data, :detail_grids, :sub_grid_data,
-                  :proc_binding, :options
+                  :proc_binding, :options, :nav_grid_data
     DEFAULT_OPTIONS = {:row_num             => '10',
                        :row_list            => [10,25,50,100],
@@ -53,6 +59,8 @@ module RailsJqGrid
       self.proc_binding = option_block.binding
       self.options = options
+      self.nav_grid_data = JqGridNavGrid.new(dom_id, pager_id)
       #fancier syntax, but heavier to handle
       #self.instance_eval(&option_block) if block_given?
@@ -102,7 +110,7 @@ module RailsJqGrid
     end
     def column(field,&block)
-      find_or_create_column(field).set_column_options(&block)
+      find_or_create_column(field).set_jqgrid_options(&block)
     end
     def find_or_create_column(field)
@@ -114,6 +122,10 @@ module RailsJqGrid
       col
     end
+    def nav_grid(&block)
+      self.nav_grid_data.set_jqgrid_options(&block)
+    end
     def to_html
       parts =[]
       parts << javascript_tag(jq_grid_function_js)
@@ -171,64 +183,14 @@ module RailsJqGrid
     end
     def nav_grid_js
-      params=[nav_grid_parameters]
-      params.push(nav_grid_restful_extensions).flatten! if is_restful?
+      self.nav_grid_data.restfull = is_restful?
-      <<-EO_JS
-        jQuery("##{dom_id}").jqGrid('navGrid','##{pager_id}',#{params.join(",\n")} );
-      EO_JS
+      nav_grid_data.to_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
+    end
     def detail_grids_html
       self.detail_grids.map do |detail_grid|

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

@@ -1,7 +1,15 @@
-# To change this template, choose Tools | Templates
-# and open the template in the editor.
+#  This program is free software; you can redistribute it and/or
+#  modify it under the terms of the GNU General Public License
+#  as published by the Free Software Foundation; either version 3
+#  of the License, or (at your option) any later version.
+#  Author::    Dieter Spaeth  (mailto:dieter.spaeth@gmx.de)
+#  Copyright:: Copyright (c) 2010 Dieter Spaeth
 module RailsJqGrid
+  # Container for all options and methods for a column in jqgrid
   class JqGridColumn
     extend ActiveModel::Translation
@@ -13,17 +21,10 @@ module RailsJqGrid
       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
+      self.label JqGridColumn.human_attribute_name(field)
-    def set_column_options(&option_block)
-      option_block.call(self) if block_given?
-    end
+      set_jqgrid_options(&option_block)
+    end
     def name
       self.jq_grid_js_options[:label]

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

@@ -1,36 +1,41 @@
-# To change this template, choose Tools | Templates
-# and open the template in the editor.
+#  This program is free software; you can redistribute it and/or
+#  modify it under the terms of the GNU General Public License
+#  as published by the Free Software Foundation; either version 3
+#  of the License, or (at your option) any later version.
+#  Author::    Dieter Spaeth  (mailto:dieter.spaeth@gmx.de)
+#  Copyright:: Copyright (c) 2010 Dieter Spaeth
 module RailsJqGrid
+  # Method-Missing implementation
+  # converts unknown method to options
+  # and save it's values
   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}"
+    # every unknown method is treated as a jqgrid
+    # option oder method name
+    def method_missing(symbol, *args, &block)
       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
+    end
+    # Values market with raw are not convertet to_json
+    # they will be outputet as they are see JqGridOptionOrMethod.escaped_value
     def raw(*args)
       {:type => :raw, :value => args[0]}
     end
+    # returns the value of a option
     def get_jq_grid_js_options(symbol)
       self.jq_grid_js_options[symbol]
     end
+    # initialize options with default values
     def init_jq_grid_js_options(new_options)
       self.jq_grid_js_options ||={}
       new_options.each do |key, value|
@@ -38,6 +43,7 @@ module RailsJqGrid
       end
     end
+    # converts options to a string for jqgrid
     def options_to_jqgrid_options
       jqgrid_options = []
       self.jq_grid_js_options.each_value { |option|
@@ -46,5 +52,9 @@ module RailsJqGrid
       jqgrid_options.sort.join(",\n ")
     end
+    def set_jqgrid_options(&option_block)
+      option_block.call(self) if block_given?
+    end
   end
 end

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

@@ -0,0 +1,133 @@
+#  This program is free software; you can redistribute it and/or
+#  modify it under the terms of the GNU General Public License
+#  as published by the Free Software Foundation; either version 3
+#  of the License, or (at your option) any later version.
+#  Author::    Dieter Spaeth  (mailto:dieter.spaeth@gmx.de)
+#  Copyright:: Copyright (c) 2010 Dieter Spaeth
+module RailsJqGrid
+  class JqGridNavGrid
+    include JqGridMethodMissing
+     DEFAULT_OPTIONS = {:add                 => true,
+                        :del                 => true,
+                        :edit                => true,
+                        :refresh             => true,
+                        :search              => true,
+                       }
+    DEFAULT_PRM_OPTIONS = { :close_after_add => true,
+                            :close_after_edit => true,
+                            :close_on_escape => true
+                          }
+    attr_accessor :dom_id, :pager_id, :restfull,
+                  :prm_edit_data, :prm_add_data, :prm_del_data, :prm_search_data,
+                  :prm_view_data
+    def initialize(dom_id, pager_id , &option_block)
+      self.dom_id = dom_id
+      self.pager_id = pager_id
+      self.prm_edit_data = JqGridNavGridParameter.new(DEFAULT_PRM_OPTIONS)
+      self.prm_add_data = JqGridNavGridParameter.new(DEFAULT_PRM_OPTIONS)
+      self.prm_del_data = JqGridNavGridParameter.new(DEFAULT_PRM_OPTIONS)
+      self.prm_search_data = JqGridNavGridParameter.new(DEFAULT_PRM_OPTIONS)
+      self.prm_view_data = JqGridNavGridParameter.new(DEFAULT_PRM_OPTIONS)
+      self.init_jq_grid_js_options DEFAULT_OPTIONS
+      option_block.call(self) if block_given?
+    end
+    def prm_edit(&block)
+      prm_edit_data.set_jqgrid_options(&block)
+    end
+    def prm_add(&block)
+      prm_add_data.set_jqgrid_options(&block)
+    end
+    def prm_del(&block)
+      prm_del_data.set_jqgrid_options(&block)
+    end
+    def prm_search(&block)
+      prm_search_data.set_jqgrid_options(&block)
+    end
+    def prm_view(&block)
+      prm_view_data.set_jqgrid_options(&block)
+    end
+    def to_js
+      params=[nav_grid_parameters]
+      if is_restful?
+        set_nav_grid_restful_extensions
+      end
+      params.push([prm_edit_data.to_js,
+                   prm_add_data.to_js,
+                   prm_del_data.to_js,
+                   prm_search_data.to_js,
+                   prm_view_data.to_js]).flatten!
+      <<-EO_JS
+        jQuery("##{dom_id}").jqGrid('navGrid','##{pager_id}',#{params.join(",\n")} );
+      EO_JS
+    end
+    def nav_grid_parameters
+      <<-EO_JS
+        {
+          #{options_to_jqgrid_options}
+        }
+      EO_JS
+    end
+    def set_nav_grid_restful_extensions
+      restful_param_edit
+      restful_param_add
+      restful_param_delete
+    end
+    def restful_param_edit
+      prm_edit_data.mtype "PUT"
+      prm_edit_data.onclick_submit raw <<-EO_JS
+           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
+      prm_add_data.mtype "POST"
+    end
+    def restful_param_delete
+      prm_del_data.mtype "DELETE"
+      prm_del_data.onclick_submit raw <<-EO_JS
+          function(rp_ge, postdata) {
+             rp_ge.url = jQuery("##{dom_id}").jqGrid('getGridParam','editurl') + '/' + postdata
+             return {};
+          }
+      EO_JS
+    end
+    def is_restfull?
+      self.restfull
+    end
+  end
+end

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

@@ -0,0 +1,31 @@
+#  This program is free software; you can redistribute it and/or
+#  modify it under the terms of the GNU General Public License
+#  as published by the Free Software Foundation; either version 3
+#  of the License, or (at your option) any later version.
+#  Author::    Dieter Spaeth  (mailto:dieter.spaeth@gmx.de)
+#  Copyright:: Copyright (c) 2010 Dieter Spaeth
+module RailsJqGrid
+  class JqGridNavGridParameter
+    include JqGridMethodMissing
+    def initialize(default_options = {}, &option_block)
+      self.jq_grid_js_options ||={}
+      self.init_jq_grid_js_options default_options
+      option_block.call(self) if block_given?
+    end
+    def to_js
+      <<-EO_JS
+        {
+          #{options_to_jqgrid_options}
+        }
+      EO_JS
+    end
+  end
+end

data/app/models/rails_jq_grid/jq_grid_option_or_method.rb CHANGED Viewed

@@ -1,7 +1,16 @@
-# To change this template, choose Tools | Templates
-# and open the template in the editor.
+#  This program is free software; you can redistribute it and/or
+#  modify it under the terms of the GNU General Public License
+#  as published by the Free Software Foundation; either version 3
+#  of the License, or (at your option) any later version.
+#  Author::    Dieter Spaeth  (mailto:dieter.spaeth@gmx.de)
+#  Copyright:: Copyright (c) 2010 Dieter Spaeth
 module RailsJqGrid
+  # Contains all information for one option or method
   class JqGridOptionOrMethod
     include ActiveSupport::Inflector
@@ -20,16 +29,22 @@ module RailsJqGrid
     end
+    # works like JqGridMethodMissing.raw
     def <<(*args)
       RAILS_DEFAULT_LOGGER.debug "#{args.inspect}"
       self.type = :raw
       self.value = args[0]
     end
+    # option name ist camalized with a lower start character
+    # transforms from ruby style to jqgrid style
+    # before_submit => beforeSubmit
     def escaped_name
       self.name.to_s.camelize(:lower)
     end
+    # every value is transformed to json
+    # as lang es it isn't marked es raw
     def escaped_value
       if self.type == :raw
         self.value

data/lib/rails_jq_grid/acts_as_jq_grid_able.rb CHANGED Viewed

@@ -1,5 +1,12 @@
-# To change this template, choose Tools | Templates
-# and open the template in the editor.
+#  This program is free software; you can redistribute it and/or
+#  modify it under the terms of the GNU General Public License
+#  as published by the Free Software Foundation; either version 3
+#  of the License, or (at your option) any later version.
+#  Author::    Dieter Spaeth  (mailto:dieter.spaeth@gmx.de)
+#  Copyright:: Copyright (c) 2010 Dieter Spaeth
 module RailsJqGrid
   module ActsAsJqGridAble
@@ -8,7 +15,8 @@ module RailsJqGrid
     end
     module ActsAsClassMethod
-      ## any method placed here will apply to classes, like Hickwall
+      # any method placed here will apply to classes
       def acts_as_jqgrid_able
         send :include, InstanceMethods
         cattr_accessor :allowed_order_by_cols
@@ -18,16 +26,25 @@ module RailsJqGrid
     end
     module ClassMethods
+      # Contains an array of column names which can safely be used
+      # for order by. Columns not configured here can't be user
+      # by #order_by
       def order_by_cols(*args)
         self.allowed_order_by_cols ||= []
         self.allowed_order_by_cols.push(args.map{|arg| arg.to_s})
         self.allowed_order_by_cols.flatten!
-        logger.info "Array: " + self.allowed_order_by_cols.inspect
       end
     end
     module InstanceMethods
+      # creates json string for jqGrid
+      # options:: :total_records count records totaly to display in grid, default :data.count
+      #           :default_records_per_page when nothing is specified how many
+      #            records are shown on a page, default :data.count
+      #           :data  the records as an array
       def jqgrid_json(options)
         options[:total_records] ||= options[:data].count
         options[:default_records_per_page] ||= options[:data].count
@@ -41,18 +58,25 @@ module RailsJqGrid
         json_data.to_json
       end
+      # calculates the current offset by page and records per page
       def current_offset(default_recs_per_page = 10)
         (current_page - 1) * records_per_page(default_recs_per_page)
       end
+      # returns the current page retrieved from jqgrid request
+      # default 1
       def current_page
         (params[:page] || 1).to_i
       end
+      # returns records per page retrieved from jqgrid request
+      # default 1
       def records_per_page(default_recs_per_page = 10)
         (params[:rows] || default_recs_per_page).to_i
       end
+      # tests jqgrid request parameter sidx and sord
+      # and returns a sanatized order by statement
       def order_by
         order_column = params[:sidx] || ""

data/lib/rails_jq_grid/engine.rb CHANGED Viewed

@@ -1,18 +1,19 @@
+#  This program is free software; you can redistribute it and/or
+#  modify it under the terms of the GNU General Public License
+#  as published by the Free Software Foundation; either version 3
+#  of the License, or (at your option) any later version.
+#  Author::    Dieter Spaeth  (mailto:dieter.spaeth@gmx.de)
+#  Copyright:: Copyright (c) 2010 Dieter Spaeth
 require 'rails_jq_grid'
 require 'rails'
 module RailsJqGrid
   class Engine < Rails::Engine
-    config.autoload_paths += %W(#{config.root}/lib)
-#    paths.app.controllers     = "app/controllers"
-#    paths.app.helpers         = "app/helpers"
-#    paths.app.models          = "app/models"
-#    paths.app.views           = "app/views"
-#     paths.lib                  "lib"
-#     paths.lib.tasks            "lib/tasks", :glob => "**/*.rake"
+    config.autoload_paths += %W(#{config.root}/lib)
     initializer "static assets" do |app|
       app.middleware.use ::ActionDispatch::Static, "#{root}/public"

data/lib/rails_jq_grid.rb CHANGED Viewed

@@ -1,7 +1,16 @@
+#  This program is free software; you can redistribute it and/or
+#  modify it under the terms of the GNU General Public License
+#  as published by the Free Software Foundation; either version 3
+#  of the License, or (at your option) any later version.
+#  Author::    Dieter Spaeth  (mailto:dieter.spaeth@gmx.de)
+#  Copyright:: Copyright (c) 2010 Dieter Spaeth
 module RailsJqGrid
   if defined?(Rails)
-    require 'rails_jq_grid/engine'
-    #require 'rails_jq_grid/jq_grid'
+    require 'rails_jq_grid/engine'
   end
 end

data/rails_jq_grid.gemspec CHANGED Viewed

@@ -5,11 +5,12 @@
 Gem::Specification.new do |s|
   s.name = %q{rails_jq_grid}
-  s.version = "0.0.2"
+  s.version = "0.0.3.pre1"
-  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.required_rubygems_version = Gem::Requirement.new("> 1.3.1") if s.respond_to? :required_rubygems_version=
   s.authors = ["Dieter Spaeth"]
-  s.date = %q{2010-10-04}
+  s.date = %q{2010-10-10}
+  s.description = %q{This gems is a Rails 3 Enginge that helps you to create jqGrid. It's bundled with jqGrid and some themes.}
   s.email = %q{dieter.spaeth@gmx.de}
   s.extra_rdoc_files = [
     "README.rdoc"
@@ -26,10 +27,11 @@ Gem::Specification.new do |s|
      "app/models/rails_jq_grid/jq_grid.rb",
      "app/models/rails_jq_grid/jq_grid_column.rb",
      "app/models/rails_jq_grid/jq_grid_method_missing.rb",
+     "app/models/rails_jq_grid/jq_grid_nav_grid.rb",
+     "app/models/rails_jq_grid/jq_grid_nav_grid_parameter.rb",
      "app/models/rails_jq_grid/jq_grid_option_or_method.rb",
      "lib/rails_jq_grid.rb",
      "lib/rails_jq_grid/acts_as_jq_grid_able.rb",
-     "lib/rails_jq_grid/acts_as_jq_grid_data_source.rb",
      "lib/rails_jq_grid/engine.rb",
      "lib/tasks/rails_jq_grid.rake",
      "public/javascripts/rails-jqgrid/Changes.txt",

metadata CHANGED Viewed

@@ -1,13 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rails_jq_grid
 version: !ruby/object:Gem::Version
-  hash: 27
-  prerelease: false
+  hash: 270495468
+  prerelease: true
   segments:
   - 0
   - 0
-  - 2
-  version: 0.0.2
+  - 3
+  - pre1
+  version: 0.0.3.pre1
 platform: ruby
 authors:
 - Dieter Spaeth
@@ -15,7 +16,7 @@ autorequire:
 bindir: bin
 cert_chain: []
-date: 2010-10-04 00:00:00 +02:00
+date: 2010-10-10 00:00:00 +02:00
 default_executable:
 dependencies:
 - !ruby/object:Gem::Dependency
@@ -34,7 +35,7 @@ dependencies:
         version: 1.2.9
   type: :development
   version_requirements: *id001
-description:
+description: This gems is a Rails 3 Enginge that helps you to create jqGrid. It's bundled with jqGrid and some themes.
 email: dieter.spaeth@gmx.de
 executables: []
@@ -54,10 +55,11 @@ files:
 - app/models/rails_jq_grid/jq_grid.rb
 - app/models/rails_jq_grid/jq_grid_column.rb
 - app/models/rails_jq_grid/jq_grid_method_missing.rb
+- app/models/rails_jq_grid/jq_grid_nav_grid.rb
+- app/models/rails_jq_grid/jq_grid_nav_grid_parameter.rb
 - app/models/rails_jq_grid/jq_grid_option_or_method.rb
 - lib/rails_jq_grid.rb
 - lib/rails_jq_grid/acts_as_jq_grid_able.rb
-- lib/rails_jq_grid/acts_as_jq_grid_data_source.rb
 - lib/rails_jq_grid/engine.rb
 - lib/tasks/rails_jq_grid.rake
 - public/javascripts/rails-jqgrid/Changes.txt
@@ -223,12 +225,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
-  - - ">="
+  - - ">"
     - !ruby/object:Gem::Version
-      hash: 3
+      hash: 25
       segments:
-      - 0
-      version: "0"
+      - 1
+      - 3
+      - 1
+      version: 1.3.1
 requirements: []
 rubyforge_project:

data/lib/rails_jq_grid/acts_as_jq_grid_data_source.rb DELETED Viewed

@@ -1,34 +0,0 @@
-module RailsJqGrid
-  module ActsAsJqGridDataSource
-    # To include this Module parente Class has to define
-    # [] each and count
-    def self.included(base)
-      base.send :extend, ClassMethods
-    end
-    module ClassMethods
-      ## any method placed here will apply to classes, like Hickwall
-      def acts_as_jqgrid
-        send :include, InstanceMethods
-      end
-      def to_jqgrid_data(current_page=nil, records_per_page=nil)
-        current_page ||= 1
-        records_per_page ||= count
-        total_records = count
-        total_pages = (count + records_per_page - 1).div(records_per_page)
-        json_data = {:currentpage => current_page, :totalpages => total_pages , :totalrecords => total_records  }
-      end
-    end
-    module InstanceMethods
-    end
-  end
-end