margrid 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 83c794d5429839e68bb60d5d011985d7acff150a
+  data.tar.gz: 6f127550111511be4d2526f6dce44c06acc8166c
+SHA512:
+  metadata.gz: 0ecc919ddac29945a2074bce80bababd284b1af65defbcac8f5bcec7dd84372d25fb2a8821ce9abf3293a3182510b49ec1cb30ed730d123e7e0a83929ccb46ad
+  data.tar.gz: dc936ac2a2ccf3a572a41e44290ea725b18b4fa6d90c4223bb04f531321117ef654d28fc896955b0ea398c29b259510e4c510998c177d9d5636b6facd10509eb

data/.gitignore

@@ -0,0 +1,14 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in margrid.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Yves Senn
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,31 @@
+# Margrid
+
+TODO: Write a gem description
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'margrid'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install margrid
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/margrid/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

@@ -0,0 +1,9 @@
+require "bundler/gem_tasks"
+require 'rake/testtask'
+
+Rake::TestTask.new do |t|
+  t.test_files = FileList['test/margrid/*_test.rb']
+  t.verbose = true
+end
+
+task :default => :test

data/lib/margrid/builder.rb

@@ -0,0 +1,46 @@
+module Margrid
+  # Utility class to ease the creation of Margrid::Grid instances.
+  # It can be subclassed to provide more specialized behavior for your applications.
+  #
+  #   class MyBuilder < Margrid::Builder
+  #     def self.articles(id: "articles", relation: Articles.all)
+  #       builder = new Margrid::Grid.new(id, relation)
+  #       builder.sort_by "published_at", "desc"
+  #       builder
+  #     end
+  #   end
+  class Builder
+    attr_reader :grid
+
+    def initialize(grid)
+      @grid = grid
+    end
+
+    # Configure the grid to use pagination.
+    def paginated(current_page: 1)
+      prepend paginator: Margrid::Paginator.new(current_page)
+    end
+
+    # Sort the grid by +column+ in +direction+.
+    # Direction can be +:asc+ or +:desc+
+    def sort_by(column, direction)
+      prepend sorter: Margrid::Sorter.new(column, direction)
+    end
+
+    # Deserialize Margrid components from a hash. This is usually the case
+    # when the state using the query string.
+    #
+    # NOTE: this method should be the last call when chaining Builder methods.
+    # It will return the Margrid::Grid instance and not the builder itself.
+    def load(params)
+      @grid.load(params)
+    end
+
+    def method_missing(sym, *args)
+      if @grid.respond_to?(sym)
+        @grid = @grid.send(sym, *args)
+        self
+      end
+    end
+  end
+end

data/lib/margrid/components.rb

@@ -0,0 +1,53 @@
+module Margrid
+  class Sorter < Struct.new(:column, :direction)
+    def initialize(column, direction)
+      super column.to_s, direction.to_s
+    end
+
+    def apply(relation)
+      relation.reorder(sorting)
+    end
+
+    def inverted
+      self.class.new(column, asc? ? :desc : :asc)
+    end
+
+    def desc?
+      direction == "desc"
+    end
+
+    def asc?
+      !desc?
+    end
+
+    def self.load(data)
+      new data[:sort], data[:direction] if data.key? :sort
+    end
+
+    def dump
+      {sort: column, direction: direction}
+    end
+
+    private
+    def sorting
+      # FIXME: (Rails 4.2) Replace with
+      #   relation.reorder(column => direction)
+      # when order accepts the direction as strings.
+      {column => asc? ? :asc : :desc}
+    end
+  end
+
+  class Paginator < Struct.new(:current_page)
+    def apply(relation)
+      relation.page current_page
+    end
+
+    def self.load(data)
+      new data[:page] if data.key? :page
+    end
+
+    def dump
+      {page: current_page}
+    end
+  end
+end

data/lib/margrid/factory_methods.rb

@@ -0,0 +1,15 @@
+module Margrid
+  module FactoryMethods
+    def grid(*args)
+      Margrid::Grid.new(*args)
+    end
+
+    def sorter(*args)
+      Margrid::Sorter.new(*args)
+    end
+
+    def paginator(*args)
+      Margrid::Paginator.new(*args)
+    end
+  end
+end

data/lib/margrid/grid.rb

@@ -0,0 +1,70 @@
+module Margrid
+  class Grid
+    def initialize(id, relation)
+      @id = id
+      @relation = relation
+      @components = {}
+    end
+
+    # Check wether a component is registered or not.
+    def component?(comp_sym)
+      @components.key? comp_sym
+    end
+
+    # Get the component for a given +comp_sym+.
+    def component(comp_sym)
+      @components[comp_sym]
+    end
+
+    # Attach components to the grid. This method can be called multiple times.
+    # Prepending a component will overwrite existing components.
+    #
+    # +comp_hash+ uses a +comp_sym+ as key and a component instance as value.
+    def prepend(comp_hash)
+      @components.update comp_hash
+      self
+    end
+
+    # 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
+      end
+      self
+    end
+
+    # Dump components to a nested Hash.
+    def dump(comps = nil)
+      comps ||= @components.values
+      grid_params = comps.inject({}) do |params, comp|
+        params.merge(comp.dump)
+      end
+      {"margrid" => {@id => grid_params}}
+    end
+
+    # 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
+        end
+        params
+      end
+    end
+
+    # Rows to display in the grid. This will apply every registered component
+    # to the +ActiveRecord::Relation+ passed upon grid initialization.
+    # This method returns a new +ActiveRecord::Relation+ representing the grid rows.
+    def rows
+      @rows ||= @components.values.inject(@relation) do |relation, comp|
+        comp.apply(relation)
+      end
+    end
+  end
+end

data/lib/margrid/version.rb

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

data/lib/margrid.rb

@@ -0,0 +1,8 @@
+require "margrid/components"
+require "margrid/grid"
+require "margrid/builder"
+require "margrid/factory_methods"
+
+module Margrid
+  extend FactoryMethods
+end

data/margrid.gemspec

@@ -0,0 +1,24 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'margrid/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "margrid"
+  spec.version       = Margrid::VERSION
+  spec.authors       = ["Yves Senn", "Jonas Baumann"]
+  spec.email         = ["yves.senn@gmail.com"]
+  spec.summary       = %q{Grid library to build paginated and sortable tables.}
+  spec.description   = %q{Margrid makes it easy to add sortable and paginated tables to your web pages. Since state is passed through the query string, browser bookmarks can be used to save different views.}
+  spec.homepage      = "https://www.github.com/4teamwork/margrid"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.6"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "minitest", "~> 5.4"
+end

data/test/margrid/builder_test.rb

@@ -0,0 +1,27 @@
+require_relative "../test_helper"
+
+class BuilderTest < Margrid::TestCase
+  def setup
+    @builder = Margrid::Builder.new(Margrid.grid("built", Minitest::Mock.new))
+  end
+
+  def test_add_paginator_to_grid
+    grid = @builder.paginated.grid
+    assert_equal Margrid.paginator(1), grid.component(:paginator)
+  end
+
+  def test_add_default_sort_to_grid
+    grid = @builder.sort_by("size", "desc").grid
+    assert_equal Margrid.sorter("size", "desc"), grid.component(:sorter)
+  end
+
+  def test_load_components_from_params
+    grid = @builder.load({"margrid" => {"built" => {page: 4}}})
+    assert_equal Margrid.paginator(4), grid.component(:paginator)
+  end
+
+  def test_use_grid_methods_on_builder
+    grid = @builder.prepend(custom: "CUSTOM COMPONENT").grid
+    assert_equal "CUSTOM COMPONENT", grid.component(:custom)
+  end
+end

data/test/margrid/grid_test.rb

@@ -0,0 +1,90 @@
+require_relative "../test_helper"
+
+class GridTest < Margrid::TestCase
+  class CustomComponent < Struct.new(:prefix)
+    def apply(relation)
+      relation.do_stuff
+    end
+
+    def dump
+      {prefix => "state"}
+    end
+  end
+
+  def setup
+    @relation = Minitest::Mock.new
+    @grid = Margrid::Grid.new("test", @relation)
+  end
+
+  def test_prepending_components_overwrites_existing_ones
+    @grid.prepend custom: (first = CustomComponent.new)
+    @grid.prepend custom: (second = CustomComponent.new)
+
+    assert_equal second, @grid.component(:custom)
+  end
+
+  def test_rows_applies_every_component_to_the_relation
+    @grid.prepend custom: CustomComponent.new
+
+    @relation.expect :do_stuff, "APPLIED RELATION", []
+    assert_equal "APPLIED RELATION", @grid.rows
+  end
+
+  def test_knows_registered_components
+    @grid.prepend first: CustomComponent.new
+    @grid.prepend second: CustomComponent.new
+
+    assert @grid.component?(:first)
+    assert @grid.component?(:second)
+    refute @grid.component?(:third)
+  end
+
+  def test_access_registerd_components
+    @grid.prepend first: (first_comp = CustomComponent.new)
+
+    assert_equal first_comp, @grid.component(:first)
+  end
+
+  def test_access_non_registerd_components
+    assert_equal nil, @grid.component(:does_not_exist)
+  end
+
+  def test_dumping_a_grid_dumps_every_component
+    @grid.prepend first: CustomComponent.new("some")
+    @grid.prepend second: CustomComponent.new("more")
+
+    assert_equal({"margrid"=>{"test"=>{"some"=>"state", "more"=>"state"}}}, @grid.dump)
+  end
+
+  def test_dumping_a_specific_component
+    assert_equal({"margrid"=>{"test"=>{"not_much"=>"state"}}},
+                 @grid.dump([CustomComponent.new("not_much")]))
+  end
+
+  def test_represent_the_grid_as_a_query
+    @grid.prepend first: CustomComponent.new("first")
+    @grid.prepend second: CustomComponent.new("second")
+
+    assert_equal({"margrid[test][first]"=>"state", "margrid[test][second]"=>"state"},
+                 @grid.to_query)
+  end
+
+  def test_representing_a_component_as_query
+    assert_equal({"margrid[test][stuff]"=>"state"},
+                 @grid.to_query([CustomComponent.new("stuff")]))
+  end
+
+  def test_load_components_form_a_hash
+    @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.prepend(sorter: CustomComponent.new("cat"))
+    assert_equal CustomComponent.new("cat"), @grid.component(:sorter)
+    assert_equal Margrid.paginator(8), @grid.component(:paginator)
+  end
+end

data/test/margrid/paginator_test.rb

@@ -0,0 +1,26 @@
+require_relative "../test_helper"
+
+class PaginatorTest < Margrid::TestCase
+  def test_applying_a_paginator_delegates_to_page
+    relation = Minitest::Mock.new
+    paginator = Margrid.paginator(11)
+
+    relation.expect :page, "PAGINATED", [11]
+    assert_equal "PAGINATED", paginator.apply(relation)
+  end
+
+  def test_load_from_hash_with_existing_param
+    paginator = Margrid::Paginator.load({page: 23})
+    assert_equal Margrid.paginator(23), paginator
+  end
+
+  def test_load_from_hash_without_existing_param
+    paginator = Margrid::Paginator.load({})
+    assert_equal nil, paginator
+  end
+
+  def test_dumping_to_a_hash
+    paginator = Margrid.paginator(7)
+    assert_equal({page: 7}, paginator.dump)
+  end
+end

data/test/margrid/sorter_test.rb

@@ -0,0 +1,35 @@
+require_relative "../test_helper"
+
+class SorterTest < Margrid::TestCase
+  def test_applying_a_sorter_delegates_to_reorder
+    relation = Minitest::Mock.new
+    sorter = Margrid.sorter("age", "desc")
+
+    relation.expect :reorder, "SORTED", ["age" => :desc]
+    assert_equal "SORTED", sorter.apply(relation)
+  end
+
+  def test_load_from_hash_with_existing_param
+    sorter = Margrid::Sorter.load({sort: "name", direction: "asc"})
+    assert_equal Margrid.sorter("name", "asc"), sorter
+  end
+
+  def test_load_from_hash_without_existing_param
+    sorter = Margrid::Sorter.load({})
+    assert_equal nil, sorter
+  end
+
+  def test_dumping_to_a_hash
+    sorter = Margrid.sorter("author", "desc")
+    assert_equal({sort: "author", direction: "desc"}, sorter.dump)
+  end
+
+  def test_works_with_symbols_and_strings
+    assert_equal Margrid.sorter(:name, :desc), Margrid.sorter("name", "desc")
+  end
+
+  def test_inverting_flips_direction
+    assert Margrid.sorter("name", "asc").inverted.desc?
+    assert Margrid.sorter("name", "desc").inverted.asc?
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,9 @@
+require 'minitest/autorun'
+require 'minitest/pride'
+require 'minitest/mock'
+
+$: << File.expand_path('../../lib', __FILE__)
+require "margrid"
+
+class Margrid::TestCase < MiniTest::Unit::TestCase
+end

metadata

@@ -0,0 +1,111 @@
+--- !ruby/object:Gem::Specification
+name: margrid
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Yves Senn
+- Jonas Baumann
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-08-08 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '5.4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '5.4'
+description: Margrid makes it easy to add sortable and paginated tables to your web
+  pages. Since state is passed through the query string, browser bookmarks can be
+  used to save different views.
+email:
+- yves.senn@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/margrid.rb
+- lib/margrid/builder.rb
+- lib/margrid/components.rb
+- lib/margrid/factory_methods.rb
+- lib/margrid/grid.rb
+- lib/margrid/version.rb
+- margrid.gemspec
+- test/margrid/builder_test.rb
+- test/margrid/grid_test.rb
+- test/margrid/paginator_test.rb
+- test/margrid/sorter_test.rb
+- test/test_helper.rb
+homepage: https://www.github.com/4teamwork/margrid
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.1.11
+signing_key: 
+specification_version: 4
+summary: Grid library to build paginated and sortable tables.
+test_files:
+- test/margrid/builder_test.rb
+- test/margrid/grid_test.rb
+- test/margrid/paginator_test.rb
+- test/margrid/sorter_test.rb
+- test/test_helper.rb