zable 0.0.1

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2010 YOURNAME
+
+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.rdoc

@@ -0,0 +1,8 @@
+= Zable
+
+
+zable @items, Item, :table_class => ["items-table", "shiny-colorful-table"] do
+  column(:name)
+  column(:color)
+  column(:owner_name) { |item| item.owner.name }
+end

data/Rakefile

@@ -0,0 +1,29 @@
+# encoding: UTF-8
+require 'rubygems'
+begin
+  require 'bundler/setup'
+rescue LoadError
+  $stderr.puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+require 'rake'
+require 'rdoc/task'
+
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = false
+end
+
+task :default => :test
+
+Rake::RDocTask.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'Zable'
+  rdoc.options << '--line-numbers' << '--inline-source'
+  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/lib/zable/active_record.rb

@@ -0,0 +1,59 @@
+module Zable
+  module ActiveRecord
+
+    module ClassMethods
+      PAGE_DEFAULTS = { 'num' => 1, 'size' => 2 }
+
+      def scoped_for_sort(params, scoped_object)
+        hash = (params[:sort] || {}).stringify_keys
+        scoped_object = scoped_object.for_sort_params(hash) unless hash.empty?
+        scoped_object
+      end
+
+      def scoped_for_search(params, scoped_object)
+        hash = (params[:search] || {}).stringify_keys
+        scoped_object = scoped_object.for_search_params(hash) unless hash.empty?
+        scoped_object
+      end
+
+      def scoped_for_paginate(params, scoped_object)
+        page = (PAGE_DEFAULTS.merge(params[:page] || {})).stringify_keys
+        scoped_object.paginate :page => page['num'], :per_page => page['size']
+      end
+
+      def populate(params={})
+        obj = scoped_for_sort(params, self)
+        obj = scoped_for_search(params, obj)
+        scoped_for_paginate(params, obj)
+      end
+
+      module Helpers
+        def attribute_columns_only
+          self.column_names.reject { |c|
+            is_foreign_key?(c) || is_rails_column?(c)
+          }
+        end
+
+        protected
+        def is_foreign_key?(column_name)
+          !(self.reflect_on_all_associations(:belongs_to).detect do |e|
+            if (e.options.has_key? :foreign_key)
+              e.options[:foreign_key] == column_name
+            else
+              "#{e.name}_id" == column_name
+            end
+          end.nil?)
+        end
+
+        def is_rails_column?(column_name)
+          %w{id created_at updated_at}.include?(column_name)
+        end
+      end
+    end
+
+  end
+
+end
+
+ActiveRecord::Base.send :extend, Zable::ActiveRecord::ClassMethods
+ActiveRecord::Base.send :extend, Zable::ActiveRecord::ClassMethods::Helpers

data/lib/zable/engine.rb

@@ -0,0 +1,11 @@
+require 'zable'
+require 'rails'
+require 'action_controller'
+
+module Zable
+  class Engine < Rails::Engine
+    initializer "static assets" do |app|
+      app.middleware.use ::ActionDispatch::Static, "#{root}/public"
+    end
+  end
+end

data/lib/zable/hash.rb

@@ -0,0 +1,5 @@
+class Hash
+  def reject_empty_values
+    reject { |k, v| v.respond_to?(:empty?) ? v.empty? : !v }
+  end
+end

data/lib/zable/html.rb

@@ -0,0 +1,154 @@
+module Zable
+  module Html
+
+    ## Table header methods
+    def table_header(klass, columns)
+      content_tag :thead do
+        table_header_row(klass, columns)
+      end
+    end
+
+    def table_header_row(klass, columns)
+      content_tag :tr do
+        table_header_cells(klass, columns)
+      end
+    end
+
+    def table_header_cells(klass, columns)
+      columns.inject("".html_safe) do |str, attr|
+        str << table_header_cell(klass, attr, columns)
+      end
+    end
+
+    def table_header_cell(klass, attr, columns)
+      content_tag :th, :id => header_cell_id(klass, attr) do
+        header_cell_content(attr, columns)
+      end
+    end
+
+    def header_cell_content(attr, columns)
+      str = link_to_if attr[:sort], header_cell_link_text(attr), header_cell_href(attr, columns)
+      str << header_cell_sort_image(attr)
+    end
+
+    def header_cell_id(klass, attr)
+      "#{idify klass.name}-#{idify attr[:name]}".html_safe
+    end
+
+    def current_url
+      "#{controller.request.fullpath.split("?")[0]}"
+    end
+
+    def param(param_type, param_key, attr)
+      "#{param_type}[#{param_key}]=#{attr}"
+    end
+
+    def sort_params(attr)
+      params = []
+      params << param(:sort, "attr", attr[:name])
+      params << param(:sort, "order", attr[:sort_order]) if attr[:sorted?]
+      params.join("&".html_safe)
+    end
+
+    def search_params(params)
+      params.to_a.collect do |param|
+        param(:search, param.first, param.second)
+      end.join("&".html_safe)
+    end
+
+    def sort_arrow_image_file(attr)
+      attr[:sort_order] == :desc ? "common/ascending.gif" : "common/descending.gif"
+    end
+
+    def header_cell_href(attr, columns)
+      search = columns.instance_variable_get :@search_params
+      extra_params = columns.instance_variable_get(:@_extra_params) || {}
+      all_params = [sort_params(attr), search_params(search), extra_params.to_query.html_safe].reject(&:blank?).join("&".html_safe)
+      current_url << "?".html_safe << all_params
+    end
+
+    def header_cell_link_text(attr)
+      (attr[:title] || attr[:name].to_s.titleize).html_safe
+    end
+
+    def header_cell_sort_image(attr)
+      return ''.html_safe unless attr[:sort] && attr[:sorted?]
+      arrow = sort_arrow_image_file(attr)
+      image_tag arrow
+    end
+
+    ## Table body methods
+    def table_body(collection, columns, args)
+      content_tag :tbody do
+        return empty_table_body_row(columns,args) if collection.empty?
+        (table_body_rows(collection, columns) || "".html_safe) + (args[:append] || "".html_safe)
+      end
+    end
+
+    def empty_table_body_row(columns, args)
+      content_tag :tr, :class => 'empty', :id=> "zable-empty-set" do
+        content_tag :td, :colspan => columns.size do
+          (args[:empty_message] || "No items found.").html_safe
+        end
+      end
+    end
+
+    def table_body_rows(collection, columns)
+      collection.inject("".html_safe) do |str, elem|
+        str << table_body_row(elem, columns)
+      end
+    end
+
+    def table_body_row(elem, columns)
+      content_tag :tr, :id => body_row_id(elem), :class => body_row_class do
+        table_body_row_cells(elem, columns)
+      end
+    end
+
+    def table_body_row_cells(elem, columns)
+      columns.inject("".html_safe) do |str, ac|
+        block = ac[:block] if ac.has_key?(:block)
+        str << table_body_row_cell(ac, elem, &block)
+      end
+    end
+
+    def table_body_row_cell(ac, elem)
+      content_tag(:td, :id => body_cell_id(ac, elem)) do
+        if block_given?
+          yield elem
+        else
+          val = elem.send(ac[:name])
+          val.respond_to?(:strftime) ? val.strftime("%m/%d/%Y") : val.to_s
+        end
+      end
+    end
+
+    def body_row_id(elem)
+      "#{idify_class_name(elem)}-#{elem.id}".html_safe
+    end
+
+    def body_cell_id(ac, elem)
+      "#{idify_class_name(elem)}-#{elem.id}-#{idify ac[:name]}".html_safe
+    end
+
+    def body_row_class
+      cycle("odd", "even", name: "zable_cycle")
+    end
+
+    protected
+    def idify_class_name(elem)
+      idify elem.class.name
+    end
+
+    def idify(val)
+      val.to_s.demodulize.underscore.dasherize
+    end
+
+    def tag_args(args)
+      tag_args = {}
+      tag_args[:class] = args[:table_class].join(" ".html_safe) if args[:table_class] and !args[:table_class].empty?
+      tag_args
+    end
+
+  end
+end

data/lib/zable/search.rb

@@ -0,0 +1,53 @@
+module Zable
+  module Search
+    module ActiveRecord
+      module ClassMethods
+        def inherited(subclass)
+          subclass.class_eval do
+            scope :for_search_params, -> search_params { inject_search_scopes(search_params) }
+          end
+          super(subclass)
+        end
+
+        # Allows +Model.for_search_params+ to do equality-based searching for the given +attr_names+.
+        # Date attributes (ending in "_on") will take Ruby-parseable date strings as well as the common
+        # US case "mm/dd/yyyy".
+        #
+        #   searchable :first_name, :last_name, :born_on
+        def searchable(*attr_names)
+          attr_names.each do |attr_name|
+            scope "search_#{attr_name}", -> attr_value do
+              where(attr_name => (attr_name =~ /_on$/ ? parse_date_string(attr_value) : attr_value))
+            end
+          end
+        end
+
+        protected
+
+        def inject_search_scopes(search_params)
+          non_empty_search_params = search_params.try(:reject_empty_values) || {}
+
+          non_empty_search_params.to_a.inject(self) { |result,value|
+            scope_for_search_attribute(result, value)
+          } unless non_empty_search_params.empty?
+        end
+
+        def parse_date_string(str)
+          str =~ /\d\d\/\d\d\/\d{4}/ ? Date.strptime(str, '%m/%d/%Y') : str.to_date
+        end
+        
+        def scope_name_for_attribute(type, attr)
+          "#{type}_#{attr}".to_sym
+        end
+
+        def scope_for_search_attribute(target, tuple)
+          attr = tuple.first
+          target.send scope_name_for_attribute(:search, attr), tuple.second
+        end
+
+      end
+    end
+  end
+end
+
+ActiveRecord::Base.send :extend, Zable::Search::ActiveRecord::ClassMethods

data/lib/zable/sort.rb

@@ -0,0 +1,47 @@
+module Zable
+  module Sort
+
+    module ActiveRecord
+
+      module ClassMethods
+        def inherited(subclass)
+          subclass.class_eval do
+            scope :for_sort_params, -> sort_params { inject_sort_scope(sort_params) }
+          end
+          super(subclass)
+        end
+
+        # Allows +Model.for_sort_params+ to sort for the given +attr_names+ for the common sorting
+        # case (i.e. "attr_name ASC" or "attr_name DESC")
+        #
+        #   sortable :last_name, :created_at
+        def sortable(*attr_names)
+          attr_names.each do |attr_name|
+            scope "sort_#{attr_name}", -> options { order("#{table_name}.#{attr_name} #{options[:order]}") }
+          end
+        end
+
+        protected
+
+        def inject_sort_scope(sort_params)
+          return unless sort_params
+          self.send scope_for_sort_attribute(sort_params), sort_params
+        end
+
+        def scope_name_for_attribute(type, attr)
+          "#{type}_#{attr}".to_sym
+        end
+
+        def scope_for_sort_attribute(sort_params)
+          sort_params.stringify_keys!
+          sort_params['order'] = 'ASC' if sort_params['order'].nil? || sort_params['order'].upcase != "DESC"
+          scope_name_for_attribute(:sort, sort_params['attr'])
+        end
+      end
+
+    end
+
+  end
+end
+
+ActiveRecord::Base.send :extend, Zable::Sort::ActiveRecord::ClassMethods

data/lib/zable/will_paginate.rb

@@ -0,0 +1,19 @@
+require 'will_paginate/view_helpers/link_renderer'
+
+module Zable
+  module WillPaginate
+    class LinkWithParamsRenderer < ::WillPaginate::ViewHelpers::LinkRenderer
+
+      def initialize(params = {})
+        @params = params
+      end
+
+    protected
+
+      def default_url_params
+        super.merge(@params)
+      end
+
+    end
+  end
+end

data/lib/zable/zable_test_helper.rb

@@ -0,0 +1,11 @@
+require 'zable/zable_test_helper'
+
+module ZableTestHelper
+  def self.included(base)
+    ZableHelper.module_eval do
+      def pagination_element(*args)
+        ''.html_safe
+      end
+    end
+  end
+end

data/lib/zable.rb

@@ -0,0 +1,11 @@
+module Zable
+
+  require 'zable/engine'
+  require 'zable/active_record'
+  require 'zable/html'
+  require 'zable/sort'
+  require 'zable/search'
+  require 'zable/hash'
+  require 'zable/will_paginate'
+
+end

metadata

@@ -0,0 +1,72 @@
+--- !ruby/object:Gem::Specification
+name: zable
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Derek Croft
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-04-07 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: will_paginate
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: HTML searching, sorting and pagination made dead simple
+email: 
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/zable/active_record.rb
+- lib/zable/engine.rb
+- lib/zable/hash.rb
+- lib/zable/html.rb
+- lib/zable/search.rb
+- lib/zable/sort.rb
+- lib/zable/will_paginate.rb
+- lib/zable/zable_test_helper.rb
+- lib/zable.rb
+- MIT-LICENSE
+- Rakefile
+- README.rdoc
+homepage: 
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.21
+signing_key: 
+specification_version: 3
+summary: HTML tables
+test_files: []