ez_table 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 7de5ef863145742e5635667d51d6108f5537570a
+  data.tar.gz: 03f1a79c60610b2fb767d93c534252cd81db53c5
+SHA512:
+  metadata.gz: 9e3943057438cd38b12bea839980fcc814a2f9431fadf521b93d05cf9d3b97898cfa5dcf5debff9bdc47f51481875d9115e461a95380deac984e135ed919e42f
+  data.tar.gz: 94f4d065a51995dcb5d1f0116af5ca0edeed8898b86b91979bc0f246031880519eb14f6712bf526117aa6f6126e5cdc05217b617abafea0299f956fe443f8451

data/.gitignore

@@ -0,0 +1,10 @@
+.bundle/
+log/*.log
+pkg/
+test/dummy/db/*.sqlite3
+test/dummy/db/*.sqlite3-journal
+test/dummy/log/*.log
+test/dummy/tmp/
+test/dummy/.sass-cache
+
+Gemfile.lock

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--format progress

data/Gemfile

@@ -0,0 +1,27 @@
+source "http://ruby.taobao.org"
+
+# Declare your gem's dependencies in easy_table.gemspec.
+# Bundler will treat runtime dependencies like base dependencies, and
+# development dependencies will be added by default to the :development group.
+gemspec
+
+# Declare any dependencies that are still in development here instead of in
+# your gemspec. These might include edge Rails or gems from your path or
+# Git. Remember to move these dependencies to your gemspec before releasing
+# your gem to rubygems.org.
+
+# To use debugger
+# gem 'debugger'
+
+group :test do
+  gem 'nokogiri'
+  gem 'pry'
+  gem 'pry-debugger'
+  gem 'ammeter'
+
+  #gem 'rspec-rails'
+  gem 'rspec'
+  gem 'slim-rails'
+  gem 'capybara'
+  gem 'hashie'
+end

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2013 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.md

@@ -0,0 +1,69 @@
+EasyTable
+===============
+
+This project rocks and uses MIT-LICENSE.
+
+Installation
+===============
+
+```ruby
+  gem 'nie_easy_table',  require: 'easy_table'
+```
+
+Usage
+===============
+
+Run the generator:
+
+```console
+rails g easy_table:install
+```
+
+this will create a initializer file named `easy_table.rb`, which you can
+config some html option for your table
+also `lib/templates/slim/scaffold/index.html.slim` will be created, you
+can modify it to adapt your app
+
+To Start using `easy_table`, you just have to use the easy_table_for helper
+
+```slim
+  = easy_table_for(@users) do |t|
+    - t.td :id
+    - t.td :name,  header: 'user name'
+    - t.action do |user|
+      = link_to "View User", user_path(user)
+```
+
+You can custom the td(column) output with a block,
+
+```slim
+  - t.td(:name) { |user| "Hello #{user.name}"}
+```
+
+You can provide a model_class option for `easy_table_for` helper,
+
+```
+  = easy_table_for(@users , model_class: User)
+```
+
+then the table header will using User.human_attribute_name(attr) for
+output
+
+if the current controller is UsersController, the model_class can be
+omitted.
+
+
+TODO
+===============
+
+  - [x] I18n header
+  - [x] custom header using options
+  - [x] guess model_class from current controller
+  - [x] guess model_class from current controller, with namespace
+  - [x] custom column using block
+  - [ ] custom column using class
+  - [x] add action column
+  - [x] specify multiple columns using :tds
+  - [x] config for action_column
+  - [ ] config options for single column
+

data/Rakefile

@@ -0,0 +1,15 @@
+require 'bundler/gem_tasks'
+
+
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec) do |spec|
+  spec.pattern = 'spec/**/*_spec.rb'
+end
+
+RSpec::Core::RakeTask.new(:rcov) do |spec|
+  spec.pattern = 'spec/**/*_spec.rb'
+  spec.rcov = true
+end
+
+task :spec
+task :default => :spec

data/easy_table.gemspec

@@ -0,0 +1,28 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+# Maintain your gem's version:
+require "easy_table/version"
+
+# Describe your gem and declare its dependencies:
+Gem::Specification.new do |s|
+  s.name          = "ez_table"
+  s.version       = EasyTable::VERSION
+  s.authors       = ["Dianhui Nie"]
+  s.email         = ["niedhui@gmail.com"]
+  s.homepage      = "http://github.com/niedhui/ez_table"
+  s.summary       = "Create Table easily"
+  s.description   = "Create Table easily for Rails app"
+  s.license       = "MIT"
+
+  s.files         = `git ls-files`.split($/)
+  s.executables   = s.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  s.test_files    = s.files.grep(%r{^(test|spec|features)/})
+  s.require_paths = ["lib"]
+
+
+  s.add_dependency "rails", "> 3.0.0"
+
+  s.add_development_dependency "sqlite3"
+end

data/lib/easy_table.rb

@@ -0,0 +1,21 @@
+require 'action_view'
+require 'active_support/core_ext'
+require 'rails/generators'
+module EasyTable
+  autoload :Config,               'easy_table/config'
+  autoload :ActionViewExtension,  'easy_table/action_view_extension'
+  autoload :Builder,              'easy_table/builder'
+  autoload :Base,                 'easy_table/base'
+  autoload :Column,               'easy_table/column'
+  autoload :ActionColumn ,       'easy_table/action_column'
+
+  autoload :Presenter,            'easy_table/presenter'
+
+  def self.config
+    EasyTable::Config
+  end
+end
+
+EZTable = EasyTable
+
+require 'easy_table/engine'

data/lib/easy_table/action_column.rb

@@ -0,0 +1,17 @@
+module EasyTable
+  class ActionColumn < Column
+
+    def header(table, view)
+      ""
+    end
+
+    def th_html
+      Config.action_th_html
+    end
+
+    def td_html
+      Config.action_td_html
+    end
+
+  end
+end

data/lib/easy_table/action_view_extension.rb

@@ -0,0 +1,18 @@
+module EasyTable
+  module ActionViewExtension
+    def easy_table_for(objects, options = {})
+      options[:model_class] ||= guess_model_class
+
+      EasyTable::Builder.build(objects, self, options) do |table|
+        yield table if block_given?
+      end.to_s
+    end
+
+    # TODO: support namespace
+    def guess_model_class
+      controller_name.classify.constantize
+    rescue
+      nil
+    end
+  end
+end

data/lib/easy_table/base.rb

@@ -0,0 +1,48 @@
+module EasyTable
+  class Base
+    attr_reader :columns, :items, :options, :model_class, :action_columns
+    attr_accessor :presenter
+
+    delegate :render, to: :presenter
+
+    # options:
+    #   model_class: the class of the model, used for i18n, using with the human_attribute_name
+    def initialize(items, options = {})
+      @items          = items
+      @options        = options
+      @columns        = []
+      @action_columns = []
+      process_options
+    end
+
+    def tds(*names)
+      names.each { |name| td(name) }
+    end
+
+    # TODO: spec & doc for using option
+    def td(name, options = {}, &block)
+      column_class = options.delete(:using) || Column
+      @columns << column_class.new(name, options, &block)
+    end
+
+    def action(&block)
+      @action_columns << ActionColumn.new("", {}, &block)
+    end
+
+    def all_columns
+      @all_columns ||= (columns + action_columns)
+    end
+
+    def process_options
+      @model_class = options[:model_class] || NilModelClass.instance
+    end
+
+    class NilModelClass
+      include Singleton
+      def human_attribute_name(attribute)
+        attribute.to_s
+      end
+    end
+
+  end
+end

data/lib/easy_table/builder.rb

@@ -0,0 +1,10 @@
+module EasyTable
+  class Builder
+    def self.build(items, view, options = {})
+      table = Base.new(items, options)
+      yield table if block_given?
+      table.presenter = Presenter.new(table, view)
+      table.render
+    end
+  end
+end

data/lib/easy_table/column.rb

@@ -0,0 +1,34 @@
+module EasyTable
+  class Column
+    attr_reader :name, :options, :value_block
+
+    def initialize(name, options = {}, &block)
+      @name, @options, @value_block = name, options, block
+    end
+
+    def header(table, view)
+      if options[:header].present?
+        options[:header]
+      elsif table.model_class
+        table.model_class.human_attribute_name(name)
+      end
+    end
+
+    def th_html
+      options[:th_html] || Config.th_html
+    end
+
+    def td_html
+      options[:td_html] || Config.td_html
+    end
+
+    def value(item, view)
+      if value_block
+        view.capture(item, &value_block)
+      else
+        item.send(name)
+      end
+    end
+
+  end
+end

data/lib/easy_table/config.rb

@@ -0,0 +1,9 @@
+module EasyTable
+  class Config
+    include ActiveSupport::Configurable
+
+    config_accessor :table_html, :tr_html, :th_html, :td_html, :action_th_html, :action_td_html
+
+  end
+
+end

data/lib/easy_table/engine.rb

@@ -0,0 +1,10 @@
+require 'rails/engine'
+module EasyTable
+  class Engine < ::Rails::Engine
+    initializer 'easy_table.initialize' do
+      ActiveSupport.on_load(:action_view) do
+        include EasyTable::ActionViewExtension
+      end
+    end
+  end
+end

data/lib/easy_table/presenter.rb

@@ -0,0 +1,47 @@
+module EasyTable
+  class Presenter
+    attr_reader :view, :table
+    delegate :content_tag, to: :view
+
+    def initialize(table, view)
+      @table, @view = table, view
+    end
+
+    def render
+      content_tag("table", Config.table_html) do
+        trs = "".html_safe
+        trs += render_header
+        trs += render_body
+      end
+    end
+
+    def render_header
+      content_tag("thead") do
+        content_tag("tr") do
+          ths = "".html_safe
+          table.all_columns.each do |column|
+            ths += content_tag("th", column.header(table, view), column.th_html)
+          end
+          ths
+        end
+      end
+    end
+
+    def render_body
+      content_tag("tbody") do
+        tbodys = "".html_safe
+        table.items.each do |item|
+          tbodys += content_tag("tr") do
+            tds = "".html_safe
+            table.all_columns.each do |column|
+              tds += content_tag("td", column.value(item, view), column.td_html)
+            end
+            tds
+          end
+        end
+        tbodys
+      end
+    end
+
+  end
+end

data/lib/easy_table/version.rb

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

data/lib/ez_table.rb

@@ -0,0 +1 @@
+require 'easy_table'

data/lib/generators/easy_table/install_generator.rb

@@ -0,0 +1,16 @@
+module EasyTable
+  module Generators
+    class InstallGenerator < ::Rails::Generators::Base
+      source_root File.expand_path("../../templates", __FILE__)
+      desc "Create a easy_table initializer"
+
+      def copy_initializer
+        template "easy_table.rb", "config/initializers/easy_table.rb"
+      end
+
+      def copy_scaffold_template
+        copy_file "scaffold/index.html.slim", "lib/templates/slim/scaffold/index.html.slim"
+      end
+    end
+  end
+end

data/lib/generators/templates/easy_table.rb

@@ -0,0 +1,5 @@
+EasyTable::Config.configure do |config|
+  config.table_html = { class: 'easy-table table table-bordered' }
+
+  config.action_td_html =  { class: 'action'}
+end

data/lib/generators/templates/scaffold/index.html.slim

@@ -0,0 +1,14 @@
+h1 Listing <%= plural_table_name %>
+
+= easy_table_for <%= plural_table_name %> do |t|
+<% attributes.each do |attribute| -%>
+  - t.td :<%= attribute.name %>
+<% end -%>
+  - t.action do |<%= singular_table_name %>|
+    = link_to 'Show', <%= singular_table_name %>
+    = link_to 'Edit', edit_<%= singular_table_name %>_path(<%= singular_table_name %>)
+    = link_to 'Destroy', <%= singular_table_name %>, :confirm => 'Are you sure?', :method => :delete
+
+br
+
+= link_to 'New <%= human_name %>', new_<%= singular_table_name %>_path

data/lib/tasks/easy_table_tasks.rake

@@ -0,0 +1,4 @@
+# desc "Explaining what the task does"
+# task :easy_table do
+#   # Task goes here
+# end

data/spec/generators/install_generator_spec.rb

@@ -0,0 +1,17 @@
+require 'spec_helper'
+require 'rails/version'
+require 'generators/easy_table/install_generator'
+require 'ammeter/init'
+describe EasyTable::Generators::InstallGenerator do
+
+  before { run_generator }
+
+  it "generate config/initializers/easy_table.rb" do
+    File.read(file('config/initializers/easy_table.rb')).should =~ /EasyTable::Config.configure/
+  end
+
+  it "create index.html.slim on lib" do
+    File.read(file('lib/templates/slim/scaffold/index.html.slim')).should =~ /easy_table_for/
+  end
+
+end

data/spec/lib/action_view_extension_spec.rb

@@ -0,0 +1,14 @@
+require "spec_helper"
+
+module EasyTable
+  describe ActionViewExtension do
+    subject { ActionView::Base.new}
+
+    it { should respond_to :easy_table_for }
+
+    it " can render a table" do
+      subject.easy_table_for([]).should have_tag('table')
+    end
+  end
+
+end

data/spec/lib/base_spec.rb

@@ -0,0 +1,22 @@
+require 'spec_helper'
+module EasyTable
+  describe Base do
+    subject { Base.new([]) }
+
+    context "tds" do
+      before { subject.tds :id, :name, :age}
+
+      it { should have(3).columns}
+
+    end
+
+    context "td" do
+      it "using custom Column class" do
+        IdColumn = Class.new(Column)
+        subject.td :id, using:IdColumn
+        subject.columns.first.should be_kind_of(IdColumn)
+      end
+    end
+
+  end
+end

data/spec/lib/builder_spec.rb

@@ -0,0 +1,74 @@
+require 'spec_helper'
+module EasyTable
+  describe Builder do
+    let(:view) { ActionView::Base.new }
+    let(:users) { [DummyUser.new(1,'jack')]}
+
+    subject do
+      view.easy_table_for(users) do |table|
+        table.td :id
+        table.td :name
+        table.action { |model| view.link_to("View #{model.name}", "")}
+      end
+    end
+
+    context "table header" do
+      it { should have_xpath("//table/thead/tr/th[text()='id']")}
+      it { should have_xpath("//table/thead/tr/th[text()='name']")}
+    end
+
+    context "table body" do
+      it { should have(2).trs}
+      it { should have_xpath("//table/tbody/tr/td[text()='1']")}
+      it { should have_xpath("//table/tbody/tr/td[text()='jack']")}
+    end
+
+    context "table config" do
+      it { should have_tag("table.easy-table")}
+      it { should have_tag("th.action")}
+    end
+
+    context "no config for table" do
+      it "should have no class" do
+        Config.table_html = nil
+        Nokogiri::HTML(subject).at_css('table').attr(:class).should be_blank
+      end
+    end
+
+    context "i18n" do
+
+
+      context "table header" do
+        subject do
+          view.easy_table_for(users, model_class: DummyUser) do |table|
+            table.td :id
+            table.td :name
+          end
+        end
+        it { should have_xpath("//table/thead/tr/th[text()='ID']")}
+        it { should have_xpath("//table/thead/tr/th[text()='名称']")}
+      end
+
+      context " guess model class using controller_name" do
+        before { view.stub(:controller_name).and_return('dummy_users') }
+
+        it { should have_xpath("//table/thead/tr/th[text()='ID']")}
+        it { should have_xpath("//table/thead/tr/th[text()='名称']")}
+
+      end
+    end
+
+    context " custom column using block" do
+      subject do
+        view.easy_table_for(users) do |table|
+          table.td(:name) {|model| "Hi #{model.name}"  }
+        end
+      end
+      it { should have_xpath("//table/tbody/tr/td[text()='Hi jack']")}
+    end
+
+    context " action column" do
+      it { should have_xpath("//table/tbody/tr/td/a[text()='View jack']")}
+    end
+  end
+end

data/spec/lib/column_spec.rb

@@ -0,0 +1,27 @@
+# encoding: utf-8
+require 'spec_helper'
+module EasyTable
+  describe Column do
+    let(:table) { Base.new([]) }
+    context "header" do
+      it "should ok if model_class is not exist" do
+        table = Base.new([])
+        column = Column.new(:name)
+        column.header(table, nil).should == 'name'
+      end
+
+      it "should using human attribute name" do
+        table = Base.new([], model_class: DummyUser)
+        column = Column.new(:name)
+        column.header(table, nil).should == '名称'
+      end
+
+      it "should using options header first" do
+        column = Column.new(:name, header: 'Name')
+        column.header(table, nil).should == 'Name'
+      end
+
+    end
+  end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,35 @@
+require 'easy_table'
+require 'hashie'
+#ENV["RAILS_ENV"] = "test"
+
+#require File.expand_path("../dummy/config/environment.rb",  __FILE__)
+#require 'rspec/rails'
+#require 'capybara/rspec'
+Dir['./spec/support/**/*.rb'].each {|f| require f }
+#Rails.backtrace_cleaner.remove_silencers!
+#Dir[Rails.root.join("spec/support/**/*.rb")].each { |f| require f }
+# This file was generated by the `rspec --init` command. Conventionally, all
+# specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.
+# Require this file using `require "spec_helper"` to ensure that it is only
+# loaded once.
+#
+# See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
+RSpec.configure do |config|
+  config.treat_symbols_as_metadata_keys_with_true_values = true
+  config.run_all_when_everything_filtered = true
+  config.filter_run :focus
+
+  config.before :each do
+    EasyTable::Engine.initializers.each(&:run)
+    EasyTable::Config.configure do |t_config|
+      t_config.table_html = { class: 'easy-table table table-bordered' }
+      t_config.action_th_html = { class: 'action' }
+    end
+  end
+
+  # Run specs in random order to surface order dependencies. If you find an
+  # order dependency and want to debug it, you can fix the order by providing
+  # the seed, which is printed after each run.
+  #     --seed 1234
+  config.order = 'random'
+end

data/spec/support/dummy_models.rb

@@ -0,0 +1,7 @@
+DummyUser = Struct.new(:id, :name) do
+
+  def self.human_attribute_name(attr)
+    {id: 'ID', name: '名称' }[attr]
+  end
+
+end

data/spec/support/matchers.rb

@@ -0,0 +1,17 @@
+require "nokogiri"
+
+
+RSpec::Matchers.define :have_xpath do |xpath|
+  match { |string| !!Nokogiri::HTML(string.to_s).at_xpath(xpath) }
+end
+
+RSpec::Matchers.define :have_tag do |tag|
+  match { |string| !!Nokogiri::HTML(string.to_s).at_css(tag) }
+end
+
+class String
+  def trs
+    Nokogiri::HTML(self).css('tr')
+  end
+end
+

metadata

@@ -0,0 +1,111 @@
+--- !ruby/object:Gem::Specification
+name: ez_table
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Dianhui Nie
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-10-29 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>'
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>'
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Create Table easily for Rails app
+email:
+- niedhui@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- Gemfile
+- Gemfile.lock
+- MIT-LICENSE
+- README.md
+- Rakefile
+- easy_table.gemspec
+- lib/easy_table.rb
+- lib/easy_table/action_column.rb
+- lib/easy_table/action_view_extension.rb
+- lib/easy_table/base.rb
+- lib/easy_table/builder.rb
+- lib/easy_table/column.rb
+- lib/easy_table/config.rb
+- lib/easy_table/engine.rb
+- lib/easy_table/presenter.rb
+- lib/easy_table/version.rb
+- lib/ez_table.rb
+- lib/generators/easy_table/install_generator.rb
+- lib/generators/templates/easy_table.rb
+- lib/generators/templates/scaffold/index.html.slim
+- lib/tasks/easy_table_tasks.rake
+- spec/generators/install_generator_spec.rb
+- spec/lib/action_view_extension_spec.rb
+- spec/lib/base_spec.rb
+- spec/lib/builder_spec.rb
+- spec/lib/column_spec.rb
+- spec/spec_helper.rb
+- spec/support/dummy_models.rb
+- spec/support/matchers.rb
+homepage: http://github.com/niedhui/ez_table
+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.0.2
+signing_key: 
+specification_version: 4
+summary: Create Table easily
+test_files:
+- spec/generators/install_generator_spec.rb
+- spec/lib/action_view_extension_spec.rb
+- spec/lib/base_spec.rb
+- spec/lib/builder_spec.rb
+- spec/lib/column_spec.rb
+- spec/spec_helper.rb
+- spec/support/dummy_models.rb
+- spec/support/matchers.rb