define_columns 0.1.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) 2009 Wong Liang Zan
+
+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,67 @@
+= define_columns
+
+Define Columns allows you to manipulate the content columns of your ActiveRecord model. 
+
+== Features
+
+* Add virtual attributes as columns
+* Hiding existing content columns
+* Changes the output of the column
+
+== Benefits 
+
+* Allows you to place your logic in the model instead of the view.
+* Does not assume your table markup. You have full flexibility to change things
+* No need to hand write the table columns for virtual attributes
+
+== Installation
+
+   $ gem install define_columns
+
+== Usage
+
+   # Person has content_columns [ "name", "address", "gender", "hobbies" ]
+   # Note that the names must be an exact match
+   class Person < ActiveRecord::Base
+     define_columns do |columns|
+       columns.hide %w(name)			# takes in an array of column names
+       columns.add %w(favourite_color) 		# can add virtual attributes as columns
+       columns.show(:gender) do |gender|	# returns "-Male-" for column.show(person)
+         "-#{gender}-"       			     
+       end
+     end  
+
+     def favourite_color
+       red
+     end  
+   end
+
+   # Person.table_columns returns [ "address", "gender", "hobbies", "favourite_color" ]
+
+   # In your view(in haml)
+    %table
+      %thead
+        %tr
+          - Person.table_columns.each do |column|
+            %th= column.header
+
+      - @persons.each do |person|
+        %tbody
+	  - Person.table_columns.each do |column|  
+            %td= column.show(person)
+
+== To Note
+
+The show block takes in an argument and a block. 
+
+  columns.show(:gender) do |gender|	
+    "-#{gender}-"       			     
+  end
+  
+The argument :gender must match the column name. The block parameter 'gender' is equivalent to the result of @person.gender. 
+
+Not having a show block renders @person.gender
+                
+== Copyright
+
+Copyright (c) 2010 Wong Liang Zan. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,45 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "define_columns"
+    gem.summary = %Q{Customizable content columns for Rails}
+    gem.description = %Q{define_columns allows you to add, hide, customize the output of your columns}
+    gem.email = "zan@liangzan.net"
+    gem.homepage = "http://github.com/liangzan/define_columns"
+    gem.authors = ["Wong Liang Zan"]
+    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 = "define_columns #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.1.0

data/lib/define_columns.rb

@@ -0,0 +1,27 @@
+require 'define_columns/table_column'
+require 'define_columns/table_columns'
+
+module DefineColumns
+
+  def self.included(klass)
+    klass.class_eval do
+      extend DefineColumns::ClassMethods
+    end
+  end
+
+  module ClassMethods
+
+    def table_columns
+      @table_cols.columns
+    end
+
+    def define_columns
+      @table_cols = TableColumns.new(self.content_columns.map(&:name))
+      yield @table_cols
+    end
+
+  end
+
+end
+
+ActiveRecord::Base.class_eval { include DefineColumns }

data/lib/define_columns/table_column.rb

@@ -0,0 +1,28 @@
+class TableColumn
+
+  attr_accessor :name
+
+  def initialize(name)
+    @name = name
+  end
+
+  def header
+    @name.humanize
+  end
+
+  def show(subject)
+    if defined?(@proc)
+      @proc.call subject.send(@name.to_sym)
+    else
+      subject.send @name.to_sym
+    end
+
+  end
+
+  def apply(&blk)
+    @proc = blk
+  end
+
+end
+
+

data/lib/define_columns/table_columns.rb

@@ -0,0 +1,23 @@
+class TableColumns
+
+  attr_accessor :columns
+
+  def initialize(cols)
+    @columns = cols.map { |c| TableColumn.new(c) }
+  end
+
+  def add(cols)
+    new_cols = cols.map { |c| TableColumn.new(c) }
+    @columns = @columns + new_cols
+  end
+
+  def hide(cols)
+    @columns = @columns.reject { |col| cols.include?(col.name) }
+  end
+
+  def show(col, &blk)
+    index = @columns.map(&:name).index(col.to_s)
+    @columns[index].apply(&blk)
+  end
+
+end

data/spec/define_columns_spec.rb

@@ -0,0 +1,75 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+describe "DefineColumns" do
+
+  before(:each) do
+    @original_content_cols = [ mock_active_record("house"), mock_active_record("car"), mock_active_record("room"), mock_active_record("television") ]
+    MockModel.stubs(:content_columns).returns(@original_content_cols)
+  end
+
+  def mock_active_record(name)
+    mock_active_record = mock()
+    mock_active_record.stubs(:name).returns(name)
+    mock_active_record
+  end
+
+  it "should hide the defined content columns" do
+    MockModel.class_eval do
+      define_columns do |columns|
+        columns.hide %w(house)
+      end
+    end
+
+    MockModel.table_columns.map(&:name).include?("house").should == false
+  end
+
+  it "should add the defined content columns" do
+    MockModel.class_eval do
+      define_columns do |columns|
+        columns.add %w(lamp)
+      end
+    end
+
+    MockModel.table_columns.map(&:name).include?("lamp").should == true
+  end
+
+  it "should customize the output of the defined content columns" do
+    MockModel.class_eval do
+      def road
+        %\Robinson Road\
+      end
+
+      define_columns do |columns|
+        columns.add %w(road)
+        columns.show(:road) do |road|
+          %\-#{road}-\
+        end
+      end
+    end
+
+    MockModel.table_columns.each do |col|
+      if col.name.eql?("road")
+        col.show(MockModel.new).should == %\-Robinson Road-\
+      end
+    end
+  end
+
+  it "should show the column name in a humanized manner" do
+    MockModel.class_eval do
+      def traffic_jam
+        %\Traffic Jam\
+      end
+
+      define_columns do |columns|
+        columns.add %w(traffic_jam)
+      end
+    end
+
+    MockModel.table_columns.each do |col|
+      if col.name.eql?("traffic_jam")
+        col.header.should == %\Traffic jam\
+      end
+    end
+  end
+
+end

data/spec/spec.opts

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

data/spec/spec_helper.rb

@@ -0,0 +1,17 @@
+require 'spec'
+require 'spec/autorun'
+require 'rubygems'
+require 'mocha'
+require 'active_support'
+require 'active_record'
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+require 'define_columns'
+
+Spec::Runner.configure do |config|
+
+end
+
+class MockModel
+  include DefineColumns
+end

metadata

@@ -0,0 +1,77 @@
+--- !ruby/object:Gem::Specification 
+name: define_columns
+version: !ruby/object:Gem::Version 
+  version: 0.1.0
+platform: ruby
+authors: 
+- Wong Liang Zan
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-01-30 00:00:00 +08:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 1.2.9
+    version: 
+description: define_columns allows you to add, hide, customize the output of your columns
+email: zan@liangzan.net
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.rdoc
+files: 
+- .document
+- .gitignore
+- LICENSE
+- README.rdoc
+- Rakefile
+- VERSION
+- lib/define_columns.rb
+- lib/define_columns/table_column.rb
+- lib/define_columns/table_columns.rb
+- spec/define_columns_spec.rb
+- spec/spec.opts
+- spec/spec_helper.rb
+has_rdoc: true
+homepage: http://github.com/liangzan/define_columns
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.5
+signing_key: 
+specification_version: 3
+summary: Customizable content columns for Rails
+test_files: 
+- spec/define_columns_spec.rb
+- spec/spec_helper.rb