margrid 0.0.1 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 83c794d5429839e68bb60d5d011985d7acff150a
-  data.tar.gz: 6f127550111511be4d2526f6dce44c06acc8166c
+  metadata.gz: 5e90a0b5f874aa36fc69832915335874d23439fb
+  data.tar.gz: 28dc551ce26acab62637f2b55cbd2e8834346806
 SHA512:
-  metadata.gz: 0ecc919ddac29945a2074bce80bababd284b1af65defbcac8f5bcec7dd84372d25fb2a8821ce9abf3293a3182510b49ec1cb30ed730d123e7e0a83929ccb46ad
-  data.tar.gz: dc936ac2a2ccf3a572a41e44290ea725b18b4fa6d90c4223bb04f531321117ef654d28fc896955b0ea398c29b259510e4c510998c177d9d5636b6facd10509eb
+  metadata.gz: 6bff65b47a26f5c836cf5a518697b4de0be7844763aa158391476fd13024a52f41613d7eee1f48f8b29010cb044670b39442a7ccc8d752c207412cbffa159c40
+  data.tar.gz: 65ed641050d70973b41d4b1df672d386aefc6e881c29a1c6abf9e04338cbac3523d7d123917b8e0a5a0545189c2d409dd94ce38d4a27429c12b438fffac8b5aa

data/lib/margrid/components.rb

@@ -21,11 +21,11 @@ module Margrid
     end
 
     def self.load(data)
-      new data[:sort], data[:direction] if data.key? :sort
+      new data["sort"], data["direction"] if data.key? "sort"
     end
 
     def dump
-      {sort: column, direction: direction}
+      {"sort" => column, "direction" => direction}
     end
 
     private
@@ -43,11 +43,11 @@ module Margrid
     end
 
     def self.load(data)
-      new data[:page] if data.key? :page
+      new data["page"] if data.key? "page"
     end
 
     def dump
-      {page: current_page}
+      {"page" => current_page}
     end
   end
 end

data/lib/margrid/grid.rb

@@ -3,9 +3,16 @@ module Margrid
     def initialize(id, relation)
       @id = id
       @relation = relation
+      @registered_components = {sorter: Sorter, paginator: Paginator}
       @components = {}
     end
 
+    def register(comp_sym, comp_class, comp = nil)
+      @registered_components[comp_sym] = comp_class
+      @components[comp_sym] = comp unless comp.nil?
+      self
+    end
+
     # Check wether a component is registered or not.
     def component?(comp_sym)
       @components.key? comp_sym
@@ -28,11 +35,10 @@ module Margrid
     # Load components from a Hash.
     def load(params)
       grid_params = params.fetch("margrid", {}).fetch(@id, {})
-      if sorter = Sorter.load(grid_params)
-        prepend sorter: sorter
-      end
-      if paginator = Paginator.load(grid_params)
-        prepend paginator: paginator
+      @registered_components.each do |comp_sym, comp_class|
+        if comp = comp_class.load(grid_params)
+          prepend comp_sym => comp
+        end
       end
       self
     end
@@ -49,10 +55,9 @@ module Margrid
     # Dump components to a Hash. The key of the Hash is the rack param name.
     def to_query(comps = nil)
       comps ||= @components.values
-      prefix = "margrid[#{@id}]"
       comps.inject({}) do |params, comp|
         comp.dump.each do |k, v|
-          params[prefix + "[#{k}]"] = v
+          params[param_prefix + "[#{k}]"] = v
         end
         params
       end
@@ -66,5 +71,9 @@ module Margrid
         comp.apply(relation)
       end
     end
+
+    def param_prefix
+      @param_prefix ||= "margrid[#{@id}]"
+    end
   end
 end

data/lib/margrid/version.rb

@@ -1,3 +1,3 @@
 module Margrid
-  VERSION = "0.0.1"
+  VERSION = "0.0.3"
 end

data/test/margrid/builder_test.rb

@@ -16,7 +16,7 @@ class BuilderTest < Margrid::TestCase
   end
 
   def test_load_components_from_params
-    grid = @builder.load({"margrid" => {"built" => {page: 4}}})
+    grid = @builder.load({"margrid" => {"built" => {"page" => 4}}})
     assert_equal Margrid.paginator(4), grid.component(:paginator)
   end
 

data/test/margrid/grid_test.rb

@@ -6,8 +6,12 @@ class GridTest < Margrid::TestCase
       relation.do_stuff
     end
 
+    def self.load(params)
+      new params["prefix"]
+    end
+
     def dump
-      {prefix => "state"}
+      {"prefix" => prefix}
     end
   end
 
@@ -16,6 +20,10 @@ class GridTest < Margrid::TestCase
     @grid = Margrid::Grid.new("test", @relation)
   end
 
+  def test_param_prefix
+    assert_equal "margrid[test]", @grid.param_prefix
+  end
+
   def test_prepending_components_overwrites_existing_ones
     @grid.prepend custom: (first = CustomComponent.new)
     @grid.prepend custom: (second = CustomComponent.new)
@@ -53,11 +61,11 @@ class GridTest < Margrid::TestCase
     @grid.prepend first: CustomComponent.new("some")
     @grid.prepend second: CustomComponent.new("more")
 
-    assert_equal({"margrid"=>{"test"=>{"some"=>"state", "more"=>"state"}}}, @grid.dump)
+    assert_equal({"margrid"=>{"test"=>{"prefix"=>"some", "prefix"=>"more"}}}, @grid.dump)
   end
 
   def test_dumping_a_specific_component
-    assert_equal({"margrid"=>{"test"=>{"not_much"=>"state"}}},
+    assert_equal({"margrid"=>{"test"=>{"prefix"=>"not_much"}}},
                  @grid.dump([CustomComponent.new("not_much")]))
   end
 
@@ -65,26 +73,40 @@ class GridTest < Margrid::TestCase
     @grid.prepend first: CustomComponent.new("first")
     @grid.prepend second: CustomComponent.new("second")
 
-    assert_equal({"margrid[test][first]"=>"state", "margrid[test][second]"=>"state"},
+    assert_equal({"margrid[test][prefix]"=>"first", "margrid[test][prefix]"=>"second"},
                  @grid.to_query)
   end
 
   def test_representing_a_component_as_query
-    assert_equal({"margrid[test][stuff]"=>"state"},
+    assert_equal({"margrid[test][prefix]"=>"stuff"},
                  @grid.to_query([CustomComponent.new("stuff")]))
   end
 
   def test_load_components_form_a_hash
-    @grid.load({"margrid" => {"test" => {sort: "name", direction: "asc", page: 3}}})
+    @grid.load({"margrid" => {"test" => {"sort" => "name", "direction" => "asc", "page" => 3}}})
     assert_equal Margrid.sorter("name", "asc"), @grid.component(:sorter)
     assert_equal Margrid.paginator(3), @grid.component(:paginator)
   end
 
   def test_load_and_prepend_overwrite_eachother
     @grid.prepend(paginator: CustomComponent.new("fluffy"))
-    @grid.load({"margrid" => {"test" => {sort: "name", direction: "asc", page: 8}}})
+    @grid.load({"margrid" => {"test" => {"sort" => "name", "direction" => "asc", "page" => 8}}})
     @grid.prepend(sorter: CustomComponent.new("cat"))
     assert_equal CustomComponent.new("cat"), @grid.component(:sorter)
     assert_equal Margrid.paginator(8), @grid.component(:paginator)
   end
+
+  def test_load_with_custom_component
+    assert_equal @grid, @grid.register(:my_comp, CustomComponent)
+    assert_nil @grid.component(:my_comp)
+    @grid.load({"margrid" => {"test" => { "prefix" => "welcome" }}})
+    assert_equal CustomComponent.new("welcome"), @grid.component(:my_comp)
+  end
+
+  def test_register_component_with_default
+    assert_equal @grid, @grid.register(:my_comp, CustomComponent, CustomComponent.new("default"))
+    assert_equal CustomComponent.new("default"), @grid.component(:my_comp)
+    @grid.load({"margrid" => {"test" => { "prefix" => "welcome" }}})
+    assert_equal CustomComponent.new("welcome"), @grid.component(:my_comp)
+  end
 end

data/test/margrid/paginator_test.rb

@@ -10,7 +10,7 @@ class PaginatorTest < Margrid::TestCase
   end
 
   def test_load_from_hash_with_existing_param
-    paginator = Margrid::Paginator.load({page: 23})
+    paginator = Margrid::Paginator.load({"page" => 23})
     assert_equal Margrid.paginator(23), paginator
   end
 
@@ -21,6 +21,6 @@ class PaginatorTest < Margrid::TestCase
 
   def test_dumping_to_a_hash
     paginator = Margrid.paginator(7)
-    assert_equal({page: 7}, paginator.dump)
+    assert_equal({"page" => 7}, paginator.dump)
   end
 end

data/test/margrid/sorter_test.rb

@@ -10,7 +10,7 @@ class SorterTest < Margrid::TestCase
   end
 
   def test_load_from_hash_with_existing_param
-    sorter = Margrid::Sorter.load({sort: "name", direction: "asc"})
+    sorter = Margrid::Sorter.load({"sort" => "name", "direction" => "asc"})
     assert_equal Margrid.sorter("name", "asc"), sorter
   end
 
@@ -21,7 +21,7 @@ class SorterTest < Margrid::TestCase
 
   def test_dumping_to_a_hash
     sorter = Margrid.sorter("author", "desc")
-    assert_equal({sort: "author", direction: "desc"}, sorter.dump)
+    assert_equal({"sort" => "author", "direction" => "desc"}, sorter.dump)
   end
 
   def test_works_with_symbols_and_strings

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: margrid
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.3
 platform: ruby
 authors:
 - Yves Senn
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-08-08 00:00:00.000000000 Z
+date: 2014-08-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler