cheveret 1.0.0

data/.document

@@ -0,0 +1,5 @@
+README.rdoc
+lib/**/*.rb
+bin/*
+features/**/*.feature
+LICENSE

data/.gitignore

@@ -0,0 +1,21 @@
+## MAC OS
+.DS_Store
+
+## TEXTMATE
+*.tmproj
+tmtags
+
+## EMACS
+*~
+\#*
+.\#*
+
+## VIM
+*.swp
+
+## PROJECT::GENERAL
+coverage
+rdoc
+pkg
+
+## PROJECT::SPECIFIC

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2010 RateCity
+
+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,112 @@
+Cheveret
+========
+
+A Rails library for generating flexible width HTML tables.
+
+_**Cheveret**: (noun) a small English table of the 18th century, having an oblong top, one or two rows of drawers, and slender legs joined near the bottom by a shelf._
+
+Install
+-------
+
+Cheveret was developed for Rails 2.3.8 and might work with more recent versions. There are no other dependencies aside from Rails itself.
+
+To install using Bundler simply add the following to your `Gemfile` and run a `bundle install`:
+
+    gem 'cheveret', :git => 'git@github.com:ratecity/cheveret.git'
+
+Usage
+-----
+
+Generating HTML tables of data in the views of your Rails application is not very **DRY** even for the simpler of cases. Cheveret allows you to more clearly separate logic and templating and reduce the amount of code in your views.
+
+There are several ways to define the structure of a table using Cheveret, the simplest being via the `tabulatable` method in your `ActiveRecord` models:
+
+    class Book < ActiveRecord::Base
+      tabulatable do |t|
+        t.flexible :title
+        t.column   :author       :width => 200, :flexible => true
+        t.column   :release_date :width => 100, :label=> false
+        t.sortable :amount,
+        t.fixed    :add_to_cart, :width => 120, :display => false
+      end
+
+      ...
+
+    end
+
+An instance of `Cheveret::Table` will then be configured on your model, accessible via `.cheveret`.
+
+### Rendering
+
+You can now render a table in your view by using the `cheveret_table` helper:
+
+    = cheveret_table_for @books
+
+If your view should only display a subset of the defined columns in the table (e.g. not display the _add to cart_ button for non-authenticated users), supply either `:only` or `:exclude`:
+
+    = cheveret_table_for @books, :exclude => :add_to_cart
+
+### Header
+
+By default, Cheveret will attempt to use i18n to look up a sensible label for your column headers using the `cheveret.#{object.human_name}.#{column_name}.label` scope, where `object` is the object in which your columns are defined. If a translation is found at `.desc` in the same scope, it will be used as the HTML `title` attribute of the label element.
+
+The default behaviour can be overridden by way of the `:label` option when defining your columns. Prevent the label from being rendered altogether by specifying `:label => false`.
+
+Lastly, you can completely override the markup for each header cell by using the `cheveret_headers_for` helper and supplying a block:
+
+    = cheveret_headers_for @books do |name, column|
+      - case name
+      - when :add_to_cart
+        = image_tag("add_to_cart.png")
+
+In the above example, the block will be called once for each column in the table and render the results. There are two exceptions to this behaviour:
+
+1. if the return value is `nil`, Cheveret will render standard markup using the columns `:label` setting
+
+2. otherwise, if the return value is `false`, no markup will be rendered
+
+### Body
+
+When rendering the table body, Cheveret assumes it's dealing with `ActiveRecord` model objects (or similar) and that you have _named your columns to match your data_. To get a value for each table cell it will call `object.send(column_name)` to each of your objects.
+
+This is sufficient for a list of simple `ActiveRecord` instances, but what if you need to format values, or you want to list something else? Enter the `cheveret_body_for` helper:
+
+    = cheveret_body_for @books do |name, column, book|
+      - case name
+      - when :amount
+        = number_to_currency(book.amount)
+
+This behaves in the same way as `cheveret_header`, except for the additional 3rd argument passed to the block, which gives access to the data object being rendered.
+
+You could, for example, create a column that is an aggregate of more than one attribute:
+
+    = cheveret_body_for @books do |name, column, book|
+       - case name
+       - when :title
+         = "#{book.title} (#{book.edition})"
+
+Or, if you're using _Sunspot_, list stored search results without hitting the database to get model objects:
+
+    = cheveret_body_for @books do |name, column, book|
+      = book.stored(name)
+
+Note on Patches/Pull Requests
+-----------------------------
+
+* Fork the project.
+* Make your feature addition or bug fix.
+* Add tests for it. This is important so I don't break it in a
+  future version unintentionally.
+* Commit, do not mess with rakefile, version, or history.
+  (if you want to have your own version, that is fine but bump version in a commit by itself I can ignore when I pull)
+* Send me a pull request. Bonus points for topic branches.
+
+Maintainers & Contributors
+--------------------------
+
+* Ben Caldwell - http://github.com/lankz
+
+Copyright
+---------
+
+Copyright (c) 2010 RateCity. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,47 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "cheveret"
+    gem.summary = %Q{Rails library for generating flexible width HTML tables}
+    gem.description = %Q{Generating HTML tables of data in the views of your Rails
+application is not very DRY even for the simpler of cases. Cheveret allows you to more
+clearly separate logic and templating and reduce the amount of code in your views.}
+    gem.email = "aulankz@gmail.com"
+    gem.homepage = "http://github.com/lankz/cheveret"
+    gem.authors = ["Ben Caldwell"]
+    gem.add_development_dependency "rspec", ">= 1.2.9"
+    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: gem install jeweler"
+end
+
+require 'spec/rake/spectask'
+Spec::Rake::SpecTask.new(:spec) do |spec|
+  spec.libs << 'lib' << 'spec'
+  spec.spec_files = FileList['spec/**/*_spec.rb']
+end
+
+Spec::Rake::SpecTask.new(:rcov) do |spec|
+  spec.libs << 'lib' << 'spec'
+  spec.pattern = 'spec/**/*_spec.rb'
+  spec.rcov = true
+end
+
+task :spec => :check_dependencies
+
+task :default => :spec
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "cheveret #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+1.0.0

data/cheveret.gemspec

@@ -0,0 +1,59 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run the gemspec command
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{cheveret}
+  s.version = "1.0.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Ben Caldwell"]
+  s.date = %q{2010-09-17}
+  s.description = %q{Generating HTML tables of data in the views of your Rails
+application is not very DRY even for the simpler of cases. Cheveret allows you to more
+clearly separate logic and templating and reduce the amount of code in your views.}
+  s.email = %q{aulankz@gmail.com}
+  s.extra_rdoc_files = [
+    "LICENSE",
+     "README.md"
+  ]
+  s.files = [
+    ".document",
+     ".gitignore",
+     "LICENSE",
+     "README.md",
+     "Rakefile",
+     "VERSION",
+     "cheveret.gemspec",
+     "init.rb",
+     "lib/cheveret.rb",
+     "rails/init.rb",
+     "spec/cheveret_spec.rb",
+     "spec/spec.opts",
+     "spec/spec_helper.rb"
+  ]
+  s.homepage = %q{http://github.com/lankz/cheveret}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.7}
+  s.summary = %q{Rails library for generating flexible width HTML tables}
+  s.test_files = [
+    "spec/cheveret_spec.rb",
+     "spec/spec_helper.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_development_dependency(%q<rspec>, [">= 1.2.9"])
+    else
+      s.add_dependency(%q<rspec>, [">= 1.2.9"])
+    end
+  else
+    s.add_dependency(%q<rspec>, [">= 1.2.9"])
+  end
+end
+

data/init.rb

@@ -0,0 +1,2 @@
+require 'cheveret'
+ActionView::Base.send :include, Cheveret::Helpers

data/lib/cheveret.rb

@@ -0,0 +1,235 @@
+#--
+# Copyright (c) 2010 RateCity
+#
+# 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.
+#++
+
+require 'forwardable'
+
+module Cheveret
+  class Table
+    attr_accessor :columns
+
+    def initialize()
+      @columns = ::ActiveSupport::OrderedHash.new
+    end
+
+    def columns(*args, &block)
+      return @columns.values unless block_given?
+      instance_eval(&block)
+      # todo: support populating columns from an array
+      # todo: attempt to automatically resolve columns from activerecord etc.
+    end
+
+    def add_column(column_name, config={})
+      @columns[column_name] = Column.new(column_name, config)
+    end
+
+    alias_method :column, :add_column
+
+    def fixed(column_name, config={})
+      add_column(column_name, config.merge({ :flexible => false }))
+    end
+
+    def flexible(column_name, config={})
+      add_column(column_name, config.merge({ :flexible => true }))
+    end
+
+    def hidden(column_name, config={})
+      add_column(column_name, config.merge({ :visible => false }))
+    end
+
+    def remove_column(column_name)
+      # todo: allow columns to be removed, not sure why you'd want to do this. maybe
+      # just set :visible => false instead?
+      raise NotImplementedError
+    end
+
+    def resize!(new_width)
+      return true if new_width == @width
+      @width = new_width
+
+      columns_width = 0
+      flexibles     = []
+
+      self.columns.each do |column|
+        if column.visible?
+          columns_width += column.width
+          flexibles << column.name if column.flexible?
+        end
+      end
+
+      # todo: handle too-many/too-wide columns
+      raise "uh-oh spaghettio-s" if columns_width > new_width
+
+      # todo: fix rounding in with calculation
+      # todo: trim last column that fits into table width if necessary
+      if columns_width < new_width && !flexibles.empty?
+        padding = (new_width - columns_width) / flexibles.length
+        flexibles.each { |name| @columns[name].width += padding }
+      end
+    end
+  end
+
+  class Column
+    extend ::Forwardable
+
+    [ :width, :visible, :flexible, :label, :sortable ].each do |attr|
+      class_eval <<-RUBY_EVAL, __FILE__, __LINE__ + 1
+        def_delegator :@config, :#{attr}, :#{attr}
+        def_delegator :@config, :#{attr}=, :#{attr}=
+      RUBY_EVAL
+    end
+
+    attr_accessor :name
+
+    def initialize(column_name, config={})
+      @name = column_name
+
+      @config = ::ActiveSupport::OrderedOptions.new
+      config.each { |k, v| send("#{k}=", v) if respond_to?(k) }
+    end
+
+    # sets the column to be visible. columns are visible by default. use this when
+    # you've defined hidden columns that should only be displayed on some condition
+    def show
+      self.visible = true
+    end
+
+    # hides the column, prevents it from being rendered in the table
+    # helper for setting :visible => false
+    def hide
+      self.visible = false
+    end
+
+    # returns true for columns that have :visible => true or #show called on them
+    # columns are visible by default
+    def visible?
+      self.visible != false
+    end
+
+    def flexible?
+      self.flexible != false
+    end
+
+    def label
+      case @config.label
+      when nil then @name.to_str.humanize # todo: support i18n for column labels
+      when false then nil
+      else @config.label
+      end
+    end
+
+    def data(object)
+      object.send(self.name) if object.respond_to?(self.name)
+    end
+
+    def width
+      @config.width || 0
+    end
+  end
+
+  module Helpers
+    # renders a table for a collection of objects
+    def table_for(collection, options={}, &block)
+      builder = options.delete(:builder) || ActionView::Base.default_table_builder
+
+      options.merge!({ :collection => collection })
+      builder.render(Table.new, self, options, &block)
+    end
+
+    class TableBuilder
+      extend ::Forwardable
+      def_delegators :@table, :columns
+
+      def self.render(table, template, options={}, &block)
+        # todo: merge container element with :html passed into table_for
+        attrs = { :class => "table",
+                  :style => "width: #{options[:width]}px;" }
+
+        template.content_tag(:div, attrs) do
+          template.capture(self.new(table, template, options), &block)
+        end
+      end
+
+      def initialize(table, template, options={})
+        @table, @template, = table, template
+
+        @width = options.delete(:width)
+        @collection = options.delete(:collection)
+      end
+
+      def header(*args, &block)
+        @table.resize!(@width)
+
+        row = @template.content_tag(:div, :class => "tr") do
+          map_columns(:th) do |column|
+            # todo: prevent output of empty <a> tag for header label
+            output   = nil_capture(column, &block) if block_given?
+            output ||= @template.content_tag(:a, column.label)
+          end
+        end
+
+        @template.content_tag(:div, row, :class => "thead")
+      end
+
+      def body(&block)
+        @table.resize!(@width)
+        alt = false
+
+        rows = @collection.map do |object|
+          object_name = object.class.to_s.split('::').last.underscore || ''
+          klass = [ 'tr', object_name, (alt = !alt) ? nil : 'alt' ].compact
+          @template.content_tag(:div, :class => klass.join(' ')) do
+            map_columns(:td) do |column|
+              output   = nil_capture(column, object, &block) if block_given?
+              output ||= @template.content_tag(:span, column.data(object))
+            end
+          end
+        end
+
+        @template.content_tag(:div, rows.join, :class => "tbody")
+      end
+
+    private
+
+      def map_columns(type, &block) #:nodoc:
+        @table.columns.map do |column|
+          attrs = { :class => [type, column.name].join(' '),
+                    :style => "width: #{column.width}px;" }
+
+          @template.content_tag(:div, attrs) do
+            yield(column)
+          end if column.visible?
+        end
+      end
+
+      def nil_capture(*args, &block) #:nodoc:
+        custom = @template.capture(*args, &block).strip
+        output = custom.empty? ? nil : custom
+      end
+    end
+  end
+
+  ActionView::Base.class_eval do
+    cattr_accessor :default_table_builder
+    self.default_table_builder = ::Cheveret::Helpers::TableBuilder
+  end
+end

data/rails/init.rb

@@ -0,0 +1 @@
+require File.expand_path(File.join(File.dirname(__FILE__), '..', 'init'))

data/spec/cheveret_spec.rb

@@ -0,0 +1,7 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+describe "Cheveret" do
+  it "fails" do
+    fail "hey buddy, you should probably rename this file and start specing for real"
+  end
+end

data/spec/spec.opts

@@ -0,0 +1 @@
+--color

data/spec/spec_helper.rb

@@ -0,0 +1,9 @@
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+require 'cheveret'
+require 'spec'
+require 'spec/autorun'
+
+Spec::Runner.configure do |config|
+  
+end

metadata

@@ -0,0 +1,99 @@
+--- !ruby/object:Gem::Specification 
+name: cheveret
+version: !ruby/object:Gem::Version 
+  hash: 23
+  prerelease: false
+  segments: 
+  - 1
+  - 0
+  - 0
+  version: 1.0.0
+platform: ruby
+authors: 
+- Ben Caldwell
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-09-17 00:00:00 +10:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 13
+        segments: 
+        - 1
+        - 2
+        - 9
+        version: 1.2.9
+  type: :development
+  version_requirements: *id001
+description: |-
+  Generating HTML tables of data in the views of your Rails
+  application is not very DRY even for the simpler of cases. Cheveret allows you to more
+  clearly separate logic and templating and reduce the amount of code in your views.
+email: aulankz@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.md
+files: 
+- .document
+- .gitignore
+- LICENSE
+- README.md
+- Rakefile
+- VERSION
+- cheveret.gemspec
+- init.rb
+- lib/cheveret.rb
+- rails/init.rb
+- spec/cheveret_spec.rb
+- spec/spec.opts
+- spec/spec_helper.rb
+has_rdoc: true
+homepage: http://github.com/lankz/cheveret
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: Rails library for generating flexible width HTML tables
+test_files: 
+- spec/cheveret_spec.rb
+- spec/spec_helper.rb