declarative_grid 0.0.1 → 0.0.5

data/README.md

@@ -24,9 +24,6 @@ in models/member_grid.rb
       # with builtin render class: DeclarativeGrid::Renderers::Csv
       renderer :csv
       #
-      # with builtin render class: DeclarativeGrid::Renderers::HtmlTable
-      renderer :html_table
-      #
       # with selected columns
       renderer :csv_selected, class: :csv, columns: [:gender, :name]
       #
@@ -46,10 +43,15 @@ example code:
     @grid = MemberGrid.new { [m] }
     
     puts "== sample 1 =="
-    @grid.renderer(:csv).each_data {|s| puts s }
+    puts @grid.renderer(:csv).to_string
     
     puts "== sample 2 =="
-    @grid.renderer(:csv_selected).each_data {|s| puts s }
+    puts @grid.renderer(:csv_selected).to_string
+    
+    puts "== sample 3 =="
+    io = StringIO.new
+    @grid.renderer(:csv_selected).perform(io)
+    puts io.string
 
 result:
 
@@ -59,7 +61,9 @@ result:
     == sample 2 ==
     Sex,Name
     Male,Adam Jensen
-
+    == sample 3 ==
+    Sex,Name
+    Male,Adam Jensen
 
 ## Installation
 
@@ -77,6 +81,10 @@ Or install it yourself as:
 
 ## Usage
 
+If you want to use it with ActiveRecord, like this:
+
+    grid = MemberGrid.new { Enumerator.new(Member.where(is_good: true), :find_each) }
+
 ## How to Test
 
     $ rake spec

data/declarative_grid.gemspec

@@ -26,5 +26,6 @@ Gem::Specification.new do |gem|
   gem.add_development_dependency "minitest", "~> 4.1.0"
   gem.add_development_dependency "mocha", "~> 0.12.7"
   gem.add_development_dependency "factory_girl", "~> 4.1.0"
+  gem.add_development_dependency "nokogiri", "~> 1.5.5"
   
 end

data/lib/declarative_grid/base.rb

@@ -1,25 +1,7 @@
 module DeclarativeGrid
   class Base
-    extend Model::GridClass
-    
-    # Renderer Classes
-    def self.renderer_classes
-      @renderer_classes ||= {}
-    end
-    
-    # Define a renderer
-    def self.renderer(name, options = {})
-      klass = Class.new begin
-        case k = options.delete(:class)
-        when Class then k
-        when String then k.camelize.constantize
-        else "declarative_grid/renderers/#{k || name}".camelize.constantize
-        end
-      end
-      klass.grid_class = self
-      klass.options.merge! options
-      self.renderer_classes[name] = klass
-    end
+    extend Model
+    extend Renderers
     
     # Attributes
     attr_accessor :records

data/lib/declarative_grid/model/column.rb

@@ -1,6 +1,7 @@
 module DeclarativeGrid
   module Model
     class Column
+      
       # Attributes
       attr_accessor :options, :block, :name
       

data/lib/declarative_grid/model.rb

@@ -1,7 +1,28 @@
+require_relative 'model/column'
+require_relative 'model/row'
+
 module DeclarativeGrid::Model
-  extend ActiveSupport::Autoload
   
-  autoload :Column
-  autoload :Row
-  autoload :GridClass
+  def row
+    @row ||= Row.new
+  end
+  
+  # Define a column
+  # REFERENCE: Model::Row#define_column
+  def column(name, options = {}, &block)
+    self.row.define_column(name, options, &block)
+  end
+  
+  # Return the columns
+  # REFERENCE: Model::Row#columns
+  def columns(*args)
+    self.row.columns(*args)
+  end
+  
+  # override Class.inherited
+  def inherited(subclass)
+    super(subclass)
+    subclass.instance_variable_set :@row, self.row.dup
+  end
+  
 end

data/lib/declarative_grid/renderers/abstract_renderer.rb

@@ -69,24 +69,24 @@ module DeclarativeGrid
         self.class.inspect
       end
       
-      # Rendered Object as an Enumerator
-      def each_data(&block)
-        block ? each_data_string(&block) : Enumerator.new(self, :each_data)
-      end
-      
-      protected
-      
-      # Render data to the block
-      def each_data_string
+      # Render data to the stream
+      def perform(io)
         #
-        # yield string1
-        # yield string2
-        # yield string3
+        # io.write string1
+        # io.puts string2
         # ...
         #
         raise NotImplementedError
       end
       
+      # Render to string
+      def to_string
+        io = StringIO.new
+        self.perform(io)
+        io.close
+        io.string
+      end
+      
       private
       
       # Return row (array of data) of a given record

data/lib/declarative_grid/renderers/csv.rb

@@ -3,13 +3,10 @@ module DeclarativeGrid
     class Csv < AbstractRenderer
       require 'csv'
       
-      protected
-      
-      def each_data_string
-        yield CSV.generate_line(headers)
-        each_row do |row|
-          yield CSV.generate_line(row)
-        end
+      def perform(io)
+        csv = CSV.new(io, headers: true, write_headers: true)
+        csv << self.headers
+        self.each_row {|row| csv << row }
       end
       
     end

data/lib/declarative_grid/renderers/html.rb

@@ -0,0 +1,52 @@
+module DeclarativeGrid
+  module Renderers
+    class Html < AbstractRenderer
+      
+      def util
+        ERB::Util
+      end
+      delegate :html_escape, to: :util
+      
+      def perform(io)
+        table {|s| io.puts(s) }
+      end
+      
+      def to_string
+        super.html_safe
+      end
+      
+      private
+      
+      def table
+        yield '<table>'
+        
+        if cap = self.options[:catpion]
+          yield "<caption>#{html_escape(cap)}</caption>"
+        end
+        
+        thead {|s| yield s }
+        tbody {|s| yield s }
+        
+        yield '</table>'
+      end
+      
+      def thead
+        yield '<thead>'
+        yield '<tr>'
+        self.headers.each {|h| yield "<th>#{html_escape(h)}</th>" }
+        yield '</tr>'
+        yield '</thead>'
+      end
+      
+      def tbody
+        yield '<tbody>'
+        self.each_row{ |row|
+          row_html = row.each.map{|d| "<td>#{html_escape(d)}</td>" }.join
+          yield "<tr>#{row_html}</tr>"
+        }
+        yield '</tbody>'
+      end
+      
+    end
+  end
+end

data/lib/declarative_grid/renderers.rb

@@ -1,9 +1,26 @@
 module DeclarativeGrid::Renderers
-  extend ActiveSupport::Autoload
   
-  autoload :AbstractRenderer
+  # Renderer Classes
+  def renderer_classes
+    @renderer_classes ||= {}
+  end
   
-  autoload :Csv
-  autoload :HtmlTable
+  # Define a renderer
+  def renderer(name, options = {})
+    klass = Class.new begin
+      case k = options.delete(:class)
+      when Class then k
+      when String then k.camelize.constantize
+      else "declarative_grid/renderers/#{k || name}".camelize.constantize
+      end
+    end
+    klass.grid_class = self
+    klass.options.merge! options
+    self.renderer_classes[name] = klass
+  end
   
 end
+
+require_relative 'renderers/abstract_renderer'
+require_relative 'renderers/csv'
+require_relative 'renderers/html'

data/lib/declarative_grid/version.rb

@@ -1,3 +1,3 @@
 module DeclarativeGrid
-  VERSION = "0.0.1"
+  VERSION = "0.0.5"
 end

data/lib/declarative_grid.rb

@@ -1,25 +1,14 @@
 require "active_support/core_ext"
-require "active_support/concern"
-require "active_support/dependencies"
 require "backports"
 
 require "declarative_grid/version"
+require 'declarative_grid/model'
+require 'declarative_grid/renderers'
+require 'declarative_grid/base'
+
+require "stringio"
 
 module DeclarativeGrid
-  extend ActiveSupport::Autoload
-  
-  autoload :Configuration
-  autoload :Base
-  autoload :Model
-  autoload :Renderers
-  
-  def self.config
-    @config ||= Configuration.new
-  end
-  
-  def self.reset_config
-    @config = nil
-  end
   
   class DefinitionError < StandardError
   end
@@ -27,7 +16,4 @@ module DeclarativeGrid
   class RendererError < StandardError
   end
   
-  class ConfigurationError < StandardError
-  end
-  
 end

data/spec/declarative_grid/base_spec.rb

@@ -8,8 +8,7 @@ module DeclarativeGrid
         column :two
         
         renderer :csv
-        renderer :html_table
-        renderer :html_table_1, class: :html_table
+        renderer :csv_0, class: :csv
         renderer :csv_1, class: 'DeclarativeGrid::Renderers::Csv'
         renderer :csv_2, class: Renderers::Csv
         renderer :csv_3, class: :csv, columns: [ :two, :two, :two ]
@@ -23,8 +22,12 @@ module DeclarativeGrid
       @base = @klass.new { @records }
     end
     
-    it "is a Class of #{Model::GridClass}" do
-      @base.class.must_be_kind_of Model::GridClass
+    it "is a kind of #{Model}" do
+      @base.class.must_be_kind_of Model
+    end
+    
+    it "is a kind of #{Renderers}" do
+      @base.class.must_be_kind_of Renderers
     end
     
     it "has a collection of records" do
@@ -36,14 +39,9 @@ module DeclarativeGrid
       renderer.must_be_kind_of Renderers::Csv
     end
     
-    it "has a renderer named :html_table" do
-      renderer = @base.renderer(:html_table)
-      renderer.must_be_kind_of Renderers::HtmlTable
-    end
-    
-    it "has a renderer named :html_table_1" do
-      renderer = @base.renderer(:html_table_1)
-      renderer.must_be_kind_of Renderers::HtmlTable
+    it "has a renderer named :csv_0" do
+      renderer = @base.renderer(:csv_0)
+      renderer.must_be_kind_of Renderers::Csv
       renderer.options.wont_include :class
     end
     

data/spec/declarative_grid/{model/grid_class_spec.rb → model_spec.rb}

@@ -1,11 +1,11 @@
 require "spec_helper"
 
 module DeclarativeGrid
-  describe Model::GridClass do
+  describe Model do
     
     before do
       @klass = Class.new Object do
-        extend Model::GridClass
+        extend Model
         column :name
         column :kind
       end

data/spec/declarative_grid/renderers/abstract_renderer_spec.rb

@@ -4,7 +4,7 @@ module DeclarativeGrid
   describe Renderers::AbstractRenderer do
     before do
       @klass = Class.new Object do
-        extend Model::GridClass
+        extend Model
         column :one
         column :two
       end
@@ -74,25 +74,31 @@ module DeclarativeGrid
       @renderer.options[:columns].must_equal [:two]
     end
     
-    it "has a not implemented method :each_data_string" do
+    it "has a not implemented method :perform" do
       proc {
-        @renderer.send(:each_data_string)
+        @renderer.send(:perform, StringIO.new)
       }.must_raise NotImplementedError
     end
     
-    it "has a method :each_data" do
-      @renderer.expects(:each_data_string)
-      @renderer.each_data.must_be_kind_of Enumerator
-      @renderer.each_data {|s| s }
+    it "has a method :to_string to render to a string" do
+      @renderer.expects(:perform)
+      s = @renderer.to_string
+      s.must_be_kind_of String
     end
     
-    it "call each_data to return the string" do
-      def @renderer.each_data_string
-        yield "test"
-        yield "test2"
-        yield "test3"
+    it "call perform to render something" do
+      def @renderer.perform(io)
+        io.write "test"
+        io.write "test2"
+        io.write "test3"
       end
-      @renderer.each_data.to_a.must_equal ["test", "test2", "test3"]
+      begin
+        io = StringIO.new
+        @renderer.perform(io)
+        io.close
+        io.string.must_equal %w(test test2 test3).join
+      end
+      @renderer.to_string.must_equal %w(test test2 test3).join
     end
     
   end

data/spec/declarative_grid/renderers/csv_spec.rb

@@ -0,0 +1,37 @@
+module DeclarativeGrid
+  describe Renderers::Csv do
+    before do
+      @record_klass = Struct.new :name, :gender
+      @klass = Class.new Base do
+        column :name
+        column :gender
+        renderer :csv
+        renderer :csv1, class: :csv
+        renderer :csv2, class: Renderers::Csv
+        renderer :csv_select, class: :csv, columns: [:name]
+      end
+      @records = [ @record_klass.new('Adam Jensen', 'Male') ]
+      @grid = @klass.new { @records }
+    end
+    
+    it "should make all the renderers be kind of Csv" do
+      @grid.renderer(:csv).must_be_kind_of Renderers::Csv
+      @grid.renderer(:csv1).must_be_kind_of Renderers::Csv
+      @grid.renderer(:csv2).must_be_kind_of Renderers::Csv
+      @grid.renderer(:csv_select).must_be_kind_of Renderers::Csv
+    end
+    
+    it "should produce csv strings" do
+      expected = [ "Name,Gender\n", "Adam Jensen,Male\n" ].join
+      [ :csv, :csv1, :csv2 ].each do |renderer_name|
+        @grid.renderer(renderer_name).to_string.must_equal expected
+      end
+      
+      expected = [ "Name\n", "Adam Jensen\n" ].join
+      begin
+        @grid.renderer(:csv_select).to_string.must_equal expected
+      end
+    end
+    
+  end
+end

data/spec/declarative_grid/renderers/html_spec.rb

@@ -0,0 +1,47 @@
+require "nokogiri"
+
+module DeclarativeGrid
+  describe Renderers::Html do
+    before do
+      @record_klass = Struct.new :name, :gender
+      @klass = Class.new Base do
+        column :name
+        column :gender
+        renderer :html
+      end
+      @records = [ @record_klass.new('Adam Jensen', 'Male') ]
+      @grid = @klass.new { @records }
+    end
+    
+    it "should make all the renderers be kind of Html" do
+      @grid.renderer(:html).must_be_kind_of Renderers::Html
+    end
+    
+    it "should produce a HTML-safe string" do
+      @grid.renderer(:html).to_string.html_safe?.must_equal true
+    end
+    
+    it "should produce a valid HTML text" do
+      doc = Nokogiri::HTML <<-HTML
+<!DOCTYPE html>
+<html>
+<head>
+  <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
+</head>
+<body>
+  #{ERB::Util.html_escape @grid.renderer(:html).to_string}
+</body>
+</html>
+      HTML
+      
+      doc.css('table').wont_be_empty
+      doc.css('table thead').wont_be_empty
+      doc.css('table tbody').wont_be_empty
+      doc.css('table thead tr th').map(&:content).must_equal ['Name', 'Gender']
+      doc.css('table tbody tr td').map(&:content).must_equal [
+        'Adam Jensen', 'Male'
+      ]
+    end
+    
+  end
+end

data/spec/declarative_grid_spec.rb

@@ -2,14 +2,4 @@ require 'spec_helper'
 
 describe DeclarativeGrid do
   
-  it "has configuration object" do
-    DeclarativeGrid.config.must_be_kind_of DeclarativeGrid::Configuration
-  end
-  
-  it "can reset configuration" do
-    config = DeclarativeGrid.config
-    DeclarativeGrid.reset_config
-    DeclarativeGrid.config.wont_equal config
-  end
-  
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: declarative_grid
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.5
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-10-29 00:00:00.000000000 Z
+date: 2012-11-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -107,6 +107,22 @@ dependencies:
     - - ~>
       - !ruby/object:Gem::Version
         version: 4.1.0
+- !ruby/object:Gem::Dependency
+  name: nokogiri
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.5.5
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.5.5
 description: DeclarativeGrid is a gem for rendering grids described in simple DSL
 email:
 - davll.xc@gmail.com
@@ -122,21 +138,22 @@ files:
 - declarative_grid.gemspec
 - lib/declarative_grid.rb
 - lib/declarative_grid/base.rb
-- lib/declarative_grid/configuration.rb
 - lib/declarative_grid/model.rb
 - lib/declarative_grid/model/column.rb
-- lib/declarative_grid/model/grid_class.rb
 - lib/declarative_grid/model/row.rb
 - lib/declarative_grid/renderers.rb
 - lib/declarative_grid/renderers/abstract_renderer.rb
 - lib/declarative_grid/renderers/csv.rb
-- lib/declarative_grid/renderers/html_table.rb
+- lib/declarative_grid/renderers/html.rb
 - lib/declarative_grid/version.rb
 - spec/declarative_grid/base_spec.rb
 - spec/declarative_grid/model/column_spec.rb
-- spec/declarative_grid/model/grid_class_spec.rb
 - spec/declarative_grid/model/row_spec.rb
+- spec/declarative_grid/model_spec.rb
 - spec/declarative_grid/renderers/abstract_renderer_spec.rb
+- spec/declarative_grid/renderers/csv_spec.rb
+- spec/declarative_grid/renderers/html_spec.rb
+- spec/declarative_grid/renderers_spec.rb
 - spec/declarative_grid_spec.rb
 - spec/factories/models.rb
 - spec/spec_helper.rb
@@ -167,9 +184,12 @@ summary: A flexible grid renderer
 test_files:
 - spec/declarative_grid/base_spec.rb
 - spec/declarative_grid/model/column_spec.rb
-- spec/declarative_grid/model/grid_class_spec.rb
 - spec/declarative_grid/model/row_spec.rb
+- spec/declarative_grid/model_spec.rb
 - spec/declarative_grid/renderers/abstract_renderer_spec.rb
+- spec/declarative_grid/renderers/csv_spec.rb
+- spec/declarative_grid/renderers/html_spec.rb
+- spec/declarative_grid/renderers_spec.rb
 - spec/declarative_grid_spec.rb
 - spec/factories/models.rb
 - spec/spec_helper.rb

data/lib/declarative_grid/configuration.rb

@@ -1,6 +0,0 @@
-class DeclarativeGrid::Configuration
-  
-  def initialize
-  end
-  
-end

data/lib/declarative_grid/model/grid_class.rb

@@ -1,29 +0,0 @@
-module DeclarativeGrid
-  module Model
-    module GridClass
-      
-      def row
-        @row ||= Model::Row.new
-      end
-        
-      # Define a column
-      # REFERENCE: Model::Row#define_column
-      def column(name, options = {}, &block)
-        self.row.define_column(name, options, &block)
-      end
-      
-      # Return the columns
-      # REFERENCE: Model::Row#columns
-      def columns(*args)
-        self.row.columns(*args)
-      end
-      
-      # override Class.inherited
-      def inherited(subclass)
-        super(subclass)
-        subclass.instance_variable_set :@row, self.row.dup
-      end
-      
-    end
-  end
-end

data/lib/declarative_grid/renderers/html_table.rb

@@ -1,38 +0,0 @@
-module DeclarativeGrid
-  module Renderers
-    class HtmlTable < AbstractRenderer
-      
-      def utils
-        ERB::Util
-      end
-      delegate :html_escape, to: :utils
-      
-      protected
-      
-      def each_data_string
-        yield "<table>"
-        
-        if options[:caption]
-          yield "<caption>#{html_escape(options[:caption])}</caption>"
-        end
-        
-        yield "<thead><tr>"
-        headers.each do |n|
-          yield "<th>#{html_escape(n)}</th>"
-        end
-        yield "</tr></thead>"
-        
-        yield "<tbody>"
-        each_row do |r|
-          yield "<tr>"
-          r.each {|n| yield "<td>#{html_escape(n)}</td>" }
-          yield "</tr>"
-        end
-        yield "</tbody>"
-        
-        yield "</table>"
-      end
-      
-    end
-  end
-end