netzke-basepack 0.7.7 → 0.8.0

data/test/basepack_test_app/app/components/book_grid_loader.rb

@@ -1,24 +1,37 @@
 class BookGridLoader < Netzke::Base
-  js_property :layout, :fit
+  component :book_grid_one do |c|
+    c.klass = Netzke::Basepack::Grid
+    c.model = "Book"
+    c.title = "One"
+  end
 
-  component :book_grid_one, :class_name => "Netzke::Basepack::GridPanel", :model => "Book", :lazy_loading => true
-  component :book_grid_two, :class_name => "Netzke::Basepack::GridPanel", :model => "Book", :lazy_loading => true
+  component :book_grid_two do |c|
+    c.klass = Netzke::Basepack::Grid
+    c.model = "Book"
+    c.title = "Two"
+  end
 
   action :load_one
   action :load_two
 
-  js_method :on_load_one, <<-JS
-    function(){
-      this.loadNetzkeComponent({name: 'book_grid_one', container: this.id});
-    }
-  JS
+  js_configure do |c|
+    c.layout = :fit
 
-  js_method :on_load_two, <<-JS
-    function(){
-      this.loadNetzkeComponent({name: 'book_grid_two', container: this.id});
-    }
-  JS
+    c.on_load_one = <<-JS
+      function(){
+        this.netzkeLoadComponent('book_grid_one');
+      }
+    JS
 
-  js_property :bbar, [:load_one.action, :load_two.action]
+    c.on_load_two = <<-JS
+      function(){
+        this.netzkeLoadComponent('book_grid_two');
+      }
+    JS
+  end
 
-end
+  def configure(c)
+    super
+    c.bbar = [:load_one, :load_two]
+  end
+end

data/test/basepack_test_app/app/components/book_grid_with_custom_columns.rb

@@ -1,27 +1,51 @@
-class BookGridWithCustomColumns < Netzke::Basepack::GridPanel
-  js_property :title, "Books"
-
-  model "Book"
-
-  column :author__first_name, :renderer => :my_renderer
-  column :author__last_name, :renderer => :uppercase
-  column :author__name, :flex => 1, :text => "Author"
-  column :title, :flex => 1
-  column :digitized
-  column :rating,
-    :editor => {
+class BookGridWithCustomColumns < Netzke::Basepack::Grid
+  column :author__first_name do |c|
+    c.renderer = :my_renderer
+  end
+
+  column :author__last_name do |c|
+    c.renderer = :uppercase
+  end
+
+  column :author_name do |c|
+    c.flex = 1
+    c.text = "Author"
+  end
+
+  column :title do |c|
+    c.flex = 1
+  end
+
+  column :extra_column do |c|
+    c.text = "Extra"
+  end
+
+  column :rating do |c|
+    c.editor = {
       :trigger_action => :all,
       :xtype => :combo,
       :store => [[1, "Good"], [2, "Average"], [3, "Poor"]]
-    },
-    :renderer => "function(v){return ['', 'Good', 'Average', 'Poor'][v];}"
-  column :exemplars
-  column :updated_at
-
-  js_method :my_renderer, <<-JS
-    function(value){
-      return value ? "*" + value + "*" : "";
     }
-  JS
 
+    c.renderer = "function(v){return ['', 'Good', 'Average', 'Poor'][v];}"
+  end
+
+  def configure(c)
+    c.model = "Book"
+    c.columns = [ :author__first_name, :author__last_name, :author__name, :title, :digitized, :rating, :exemplars, :updated_at ]
+    super
+  end
+
+  # This way we'll always have the extra_column, independent of the columns provided in the configuration
+  def columns
+    super + [:extra_column]
+  end
+
+  js_configure do |c|
+    c.my_renderer = <<-JS
+      function(value){
+        return value ? "*" + value + "*" : "";
+      }
+    JS
+  end
 end

data/test/basepack_test_app/app/components/book_grid_with_default_values.rb

@@ -1,9 +1,27 @@
-class BookGridWithDefaultValues < Netzke::Basepack::GridPanel
-  model "Book"
-  js_property :title, "Books"
-
-  column :title, :default_value => "Lolita"
-  column :author__last_name, :default_value => Author.first.id
-  column :exemplars, :default_value => 100
-  column :digitized, :default_value => true
+class BookGridWithDefaultValues < Netzke::Basepack::Grid
+  def configure(c)
+    c.model = "Book"
+    c.title = "Books"
+    super
+  end
+
+  column :title do |c|
+    c.default_value = "Lolita"
+  end
+
+  column :author__last_name do |c|
+    c.default_value = Author.first.id
+  end
+
+  column :exemplars do |c|
+    c.default_value = 100
+  end
+
+  column :digitized do |c|
+    c.default_value = true
+  end
+
+  def columns
+    [ :title, :author__last_name, :exemplars, :digitized ]
+  end
 end

data/test/basepack_test_app/app/components/book_grid_with_excluded_columns.rb

@@ -0,0 +1,11 @@
+class BookGridWithExcludedColumns < Netzke::Basepack::Grid
+  model "Book"
+
+  column :notes do |c|
+    c.excluded = true
+  end
+
+  column :exemplars do |c|
+    c.excluded = true
+  end
+end

data/test/basepack_test_app/app/components/book_grid_with_extra_feedback.rb

@@ -1,8 +1,8 @@
-class BookGridWithExtraFeedback < Netzke::Basepack::GridPanel
+class BookGridWithExtraFeedback < Netzke::Basepack::Grid
   model "Book"
 
   # Override the get_data endpoint
   def get_data_endpoint(params)
     super.merge(:netzke_feedback => "Data loaded!")
   end
-end
+end

data/test/basepack_test_app/app/components/book_grid_with_extra_filters.rb

@@ -1,14 +1,15 @@
 # This requires a patch to Ext examples/ux/grid
-class BookGridWithExtraFilters < Netzke::Basepack::GridPanel
+# NOTE: not used!
+class BookGridWithExtraFilters < Netzke::Basepack::Grid
+  model "Book"
+
   js_include Netzke::Core.ext_path.join("examples", "ux/grid/filter/EneFilter.js")
   js_include Netzke::Core.ext_path.join("examples", "ux/grid/menu/EneMenu.js")
 
   Netzke::Core.external_ext_css << "#{Netzke::Core.ext_uri}/examples/ux/grid/css/EneMenu"
 
-  def default_config
-    super.merge(
-      :model => "Book",
-      :columns => [{:name => :title, :filter => {:type => :ene}}, :exemplars, :digitized, :notes]
-    )
+  def configure(c)
+    super
+    c.columns = [{:name => :title, :filter => {:type => :ene}}, :exemplars, :digitized, :notes]
   end
 end

data/test/basepack_test_app/app/components/book_grid_with_mass_assignment_security.rb

@@ -0,0 +1,9 @@
+class BookGridWithMassAssignmentSecurity < Netzke::Basepack::Grid
+  def configure(c)
+    c.model = "Book"
+    # Only allow assigning those attributes that are accessible for the :user role in the Book model
+    c.role = :user
+
+    super
+  end
+end

data/test/basepack_test_app/app/components/book_grid_with_nested_attributes.rb

@@ -1,13 +1,13 @@
-class BookGridWithNestedAttributes < Netzke::Basepack::GridPanel
-  def configuration
-    super.merge(
-      :model => "Book",
-      :columns => [:title, {:name => :author__first_name, :nested_attribute => true}, {:name => :author__last_name, :nested_attribute => true}]
-    )
+class BookGridWithNestedAttributes < Netzke::Basepack::Grid
+  def configure(c)
+    c.columns = [:title, {:name => :author__first_name, :nested_attribute => true}, {:name => :author__last_name, :nested_attribute => true}]
+    c.model = "Book"
+    super
   end
 
-  def default_fields_for_forms
-    [{:name => :title}, {:name => :author__first_name, :nested_attribute => true}, {:name => :author__last_name, :nested_attribute => true}]
+  # Override edit_window component in order to provide a custom list of fields for the form
+  def edit_window_component(c)
+    super
+    c.form_config.items = [{:name => :title}, {:name => :author__first_name, :nested_attribute => true}, {:name => :author__last_name, :nested_attribute => true}]
   end
-
 end

data/test/basepack_test_app/app/components/book_grid_with_overridden_columns.rb

@@ -1,8 +1,10 @@
-class BookGridWithOverriddenColumns < Netzke::Basepack::GridPanel
+class BookGridWithOverriddenColumns < Netzke::Basepack::Grid
   model "Book"
 
   # First way to override a column
-  override_column :title, :renderer => "uppercase"
+  column :title do |c|
+    c.renderer = "uppercase"
+  end
 
   # Second way to override a column
   # def default_config
@@ -12,4 +14,4 @@ class BookGridWithOverriddenColumns < Netzke::Basepack::GridPanel
   #     }
   #   end
   # end
-end
+end

data/test/basepack_test_app/app/components/book_grid_with_paging.rb

@@ -1,10 +1,8 @@
-class BookGridWithPaging < Netzke::Basepack::GridPanel
-  js_property :title, "Books with paging"
-
-  def default_config
-    super.merge(
-      :model => "Book",
-      :rows_per_page => 2
-    )
+class BookGridWithPaging < Netzke::Basepack::Grid
+  def configure(c)
+    c.model = "Book"
+    c.title = "Books with paging"
+    c.rows_per_page = 2
+    super
   end
 end

data/test/basepack_test_app/app/components/book_grid_with_persistence.rb

@@ -1,8 +1,10 @@
 class BookGridWithPersistence < BookGrid
+  column :author__name do |c|
+    c.excluded = true
+  end
 
-  override_column :author__name, :included => false
-
-  def default_config
-    super.merge :persistence => true
+  def configure(c)
+    c.persistence = true
+    super
   end
 end

data/test/basepack_test_app/app/components/book_grid_with_scope.rb

@@ -0,0 +1,6 @@
+class BookGridWithScope < BookGrid
+  def configure(c)
+    super
+    c.scope = lambda {|r| r.where(author_id: Author.first.try(:id))}
+  end
+end

data/test/basepack_test_app/app/components/book_grid_with_scoped_authors.rb

@@ -1,8 +1,11 @@
-class BookGridWithScopedAuthors < Netzke::Basepack::GridPanel
-  def configuration
-    super.tap do |c|
-      c[:model] = "Book"
-      c[:columns] = [:title, {:name => :author__first_name, :scope => lambda{ |r| r.where(:first_name.matches => "%tom%") }}]
-    end
+# NOTE: not used
+class BookGridWithScopedAuthors < Netzke::Basepack::Grid
+
+  model "Book"
+
+  def configure(c)
+    super
+    c.columns = [:title, {:name => :author__first_name, :scope => lambda{ |r| r.where("first_name LIKE ?", "%tom%")}}]
   end
-end
+
+end

data/test/basepack_test_app/app/components/book_grid_with_virtual_attributes.rb

@@ -1,21 +1,29 @@
-class BookGridWithVirtualAttributes < Netzke::Basepack::GridPanel
-  js_property :title, "Books"
-
+# This has been excluded from tests in 0-8. In 0-8 the values in the association columns/fields are passed as integers (id of associated record), not as string. So, the author_first_name_setter won't work as planned here.
+class BookGridWithVirtualAttributes < Netzke::Basepack::Grid
   include Extras::BookPresentation
 
-  def default_config
-    super.merge(
-      :model => "Book",
-      :columns => default_fields_for_forms
-    )
+  model "Book"
+
+  def columns
+    custom_fields
+  end
+
+  component :add_window do |c|
+    super(c)
+    c.form_config.items = custom_fields
+  end
+
+  component :edit_window do |c|
+    super(c)
+    c.form_config.items = custom_fields
   end
 
-  def default_fields_for_forms
+  def custom_fields
     [
-      {:name => :title},
-      {:name => :author__first_name, :setter => author_first_name_setter},
-      {:name => :exemplars},
-      {:name => :in_abundance, :getter => in_abundance_getter}
+      :title,
+      {:name => "author__first_name", :setter => author_first_name_setter},
+      :exemplars,
+      {:name => "in_abundance", :getter => in_abundance_getter}
     ]
   end
 end

data/test/basepack_test_app/app/components/book_paging_form.rb

@@ -0,0 +1,21 @@
+class BookPagingForm < Netzke::Basepack::PagingForm
+  def configure(c)
+    c.title = "Digitized books"
+    c.model = "Book"
+    c.record = Book.first
+    # :scope => {:digitized => true},
+    c.mode = :lockable
+    c.items = [{:layout => :hbox, :label_align => :top, :border => false, :defaults => {:border => false}, :items => [{
+      :flex => 2,
+      :layout => :anchor,
+      :defaults => {:anchor => "-8"},
+      :items => [:title, :notes, :digitized, :created_at, :updated_at, :last_read_at]
+    },{
+      :flex => 1,
+      :layout => :anchor,
+      :defaults => {:anchor => "-8"},
+      :items => [:author__name, {:name => :author__first_name, :read_only => true}, :exemplars, :published_on]
+    }]}]
+    super
+  end
+end

data/test/basepack_test_app/app/components/book_query_builder.rb

@@ -1,8 +1,9 @@
 class BookQueryBuilder < Netzke::Basepack::QueryBuilder
-  def default_config
-    super.tap do |s|
-      s[:model] = "Book"
-      s[:auto_scroll] = true
-    end
+  def configure(c)
+    super
+
+    c.model = "Book"
+    c.auto_scroll = true
+    c.fields = []
   end
-end
+end

data/test/basepack_test_app/app/components/book_with_custom_primary_key_grid.rb

@@ -1,10 +1,9 @@
-class BookWithCustomPrimaryKeyGrid < Netzke::Basepack::GridPanel
+class BookWithCustomPrimaryKeyGrid < Netzke::Basepack::Grid
 
-  js_property :title, "Books (model with non-standard id)"
-
-  def default_config
-    super.merge(
-      :model => "BookWithCustomPrimaryKey"
-    )
+  def configure(c)
+    c.title = "Books (model with non-standard id)"
+    c.model = "BookWithCustomPrimaryKey"
+    super
   end
+
 end

data/test/basepack_test_app/app/components/books_bound_to_author.rb

@@ -1,10 +1,12 @@
 # Grid with books that belong to the first author in the DB (assumes the existence of at least 1 author)
-class BooksBoundToAuthor < Netzke::Basepack::GridPanel
-  def default_config
-    super.merge(
-      :model => "Book",
-      :scope => {:author_id => Author.first.id},
-      :strong_default_attrs => {:author_id => Author.first.id}
-    )
+class BooksBoundToAuthor < Netzke::Basepack::Grid
+
+  model "Book"
+
+  def configure(c)
+    c.scope = {:author_id => Author.first.id}
+    c.strong_default_attrs = {:author_id => Author.first.id}
+    super
   end
+
 end