netzke-basepack 0.12.8 → 0.12.9

data/CHANGELOG.md

@@ -1,3 +1,8 @@
+# 0.12.9 - 2015-12-06
+* Grid: warn the user at an attempt to change the page when there are unapplied changes;
+  disable the warning by setting `disable_dirty_page_warning` to `true`.
+* Implement `scope` option for `Tree`
+
 # 0.12.8 - 2015-09-11
 * Fix regression in Tree that would (again) prevent snake_cased columns from being displayed
 

data/Gemfile

@@ -2,7 +2,7 @@ source 'http://rubygems.org'
 
 gemspec
 
-gem 'rails', '4.2.0'
+gem 'rails', '~>4.2.0'
 gem 'sqlite3'
 gem 'yard'
 gem 'rake'

data/lib/netzke/basepack/active_record/relation_extensions.rb

@@ -15,8 +15,10 @@ module Netzke
             self.where(scope)
           when Proc  # receives a relation, must return a relation
             scope.call(self)
+          when nil
+            self
           else
-            raise ArgumentError, "Wrong parameter type for ActiveRecord::Relation#extend_with"
+            raise ArgumentError, "Wrong parameter type for ActiveRecord::Relation#extend_with (#{scope.class.name})"
           end
         end
       end

data/lib/netzke/basepack/data_adapters/abstract_adapter.rb

@@ -225,17 +225,19 @@ module Netzke::Basepack::DataAdapters
       name.to_s.humanize
     end
 
-    # Return root record for tree-like data
+    # Returns root record for tree-like data
     def root
       model_class.root
     end
 
-    def find_record_children(r)
-      r.children
+    # Children records for given record in the tree; extra scope (lambda/proc) is optional
+    def find_record_children(r, scope = nil)
+      r.children.extend_with(scope)
     end
 
-    def find_root_records
-      model_class.where(parent_id: nil)
+    # All root records in the tree
+    def find_root_records(scope)
+      model_class.where(parent_id: nil).extend_with(scope)
     end
 
     # Does record respond to given method?

data/lib/netzke/basepack/grid.rb

@@ -29,7 +29,8 @@ module Netzke
     #
     # [scope]
     #
-    #   Specifies how the data should be filtered.
+    #   Specifies how the records should be scoped.
+    #
     #   When it's a symbol, it's used as a scope name.
     #   When it's a string, it's a SQL statement (passed directly to +where+).
     #   When it's a hash, it's a conditions hash (passed directly to +where+).
@@ -37,6 +38,11 @@ module Netzke
     #
     #     scope: ["id > ?", 100])
     #
+    #   When it's a Proc, it gets the current relation passed as the only parameter and is expected to return a
+    #   relation, e.g.:
+    #
+    #     scope: ->(relation) { relation.where(user_id: 100) }
+    #
     # [role]
     #
     #   Role for ActiveModel mass-assignment security
@@ -73,6 +79,10 @@ module Netzke
     #
     #   (defaults to 30) number of rows per page (ignored when +enable_pagination+ is set to +false+)
     #
+    # [disable_dirty_page_warning]
+    #
+    #   (defaults to false) do not warn the user about dirty records on the page when changing the page
+    #
     # [data_store]
     #
     #   (defaults to empty Hash) extra configuration for the JS class's internal store (see
@@ -367,7 +377,7 @@ module Netzke
         c.mixins << "Netzke.mixins.Basepack.Columns"
         c.mixins << "Netzke.mixins.Basepack.GridEventHandlers"
 
-        c.translate *%w[are_you_sure confirmation]
+        c.translate *%w[are_you_sure confirmation proceed_with_unapplied_changes]
 
         # JavaScript includes
         ex = Netzke::Core.ext_path.join("examples")

data/lib/netzke/basepack/grid/javascripts/grid.js

@@ -51,6 +51,9 @@
       this.dockedItems.push({
         xtype: 'pagingtoolbar',
         dock: 'bottom',
+        listeners: {
+          'beforechange': this.disableDirtyPageWarning ? {} : {fn: this.netzkeBeforePageChange, scope: this}
+        },
         store: this.store,
         items: this.bbar && ["-"].concat(this.bbar) // append the passed bbar
       });
@@ -171,5 +174,12 @@
 
   netzkeBuildReader: function() {
     return Ext.create('Netzke.classes.Basepack.Grid.ArrayReader');
+  },
+
+  netzkeBeforePageChange: function(){
+    var store = this.getStore();
+    if (store.getNewRecords().length > 0 || store.getModifiedRecords().length > 0) {
+      return confirm(this.i18n.proceedWithUnappliedChanges);
+    }
   }
 }

data/lib/netzke/basepack/tree.rb

@@ -52,6 +52,22 @@ module Netzke
     #   Note, that the root record can be hidden from the tree by specifying the `Ext.tree.Panel`'s `root_visible`
     #   config option set to `false`, which is probably what you want when you have multiple root records.
     #
+    # [scope]
+    #
+    #   Specifies how the records should be scoped.
+    #
+    #   When it's a symbol, it's used as a scope name.
+    #   When it's a string, it's a SQL statement (passed directly to +where+).
+    #   When it's a hash, it's a conditions hash (passed directly to +where+).
+    #   When it's an array, it's expanded into an SQL statement with arguments (passed directly to +where+), e.g.:
+    #
+    #     scope: ["id > ?", 100])
+    #
+    #   When it's a Proc, it gets the current relation passed as the only parameter and is expected to return a
+    #   relation, e.g.:
+    #
+    #     scope: ->(relation) { relation.where(user_id: 100) }
+    #
     # == Persisting nodes' expand/collapse state
     #
     # If the model includes the `expanded` DB field, the expand/collapse state will get stored in the DB.
@@ -90,9 +106,9 @@ module Netzke
 
       def get_records(params)
         if params[:id] == 'root'
-          data_adapter.find_root_records
+          data_adapter.find_root_records(config[:scope])
         else
-          data_adapter.find_record_children(data_adapter.find_record(params[:id]))
+          data_adapter.find_record_children(data_adapter.find_record(params[:id]), config[:scope])
         end
       end
 
@@ -108,7 +124,7 @@ module Netzke
       def node_to_hash(record, columns)
         data_adapter.record_to_hash(record, columns).tap do |hash|
           if is_node_expanded?(record)
-            hash["children"] = record.children.map {|child| node_to_hash(child, columns).netzke_literalize_keys}
+            hash["children"] = record.children.extend_with(config.scope).map {|child| node_to_hash(child, columns).netzke_literalize_keys}
           end
         end
       end
@@ -243,6 +259,11 @@ module Netzke
         c.rows_per_page = 30 if c.rows_per_page.nil?
         c.tools = %w{ refresh } if c.tools.nil?
       end
+
+      def self.server_side_config_options
+        super + [:scope]
+      end
+
     end
   end
 end

data/lib/netzke/basepack/version.rb

@@ -1,5 +1,5 @@
 module Netzke
   module Basepack
-    VERSION = "0.12.8"
+    VERSION = "0.12.9"
   end
 end

data/locales/en.yml

@@ -47,6 +47,7 @@ en:
 
         confirmation: Confirmation
         are_you_sure: Are you sure?
+        proceed_with_unapplied_changes: You will lose uncommitted changes - do you want to proceed?
 
       record_form_window:
         actions:

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: netzke-basepack
 version: !ruby/object:Gem::Version
-  version: 0.12.8
+  version: 0.12.9
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-09-11 00:00:00.000000000 Z
+date: 2015-12-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: netzke-core