declarative_grid 0.0.5 → 0.1.0

data/README.md

@@ -8,6 +8,17 @@ DeclarativeGrid is a simple, flexible and extensible datagrid/table generator.
 - Any Enumerable or Enumerator can be source data
 - It is independent from ActiveRecord and other ORMs
 
+## Deprecation
+
+In Version 0.1.0, block-style instantization is formally deprecated, 
+it will be removed on the next release (0.2.0)
+
+    grid = MemberGrid.new { records }
+
+Please pass records as an argument instead
+
+    grid = MemberGrid.new(records)
+
 ## Example
 
 in models/member_grid.rb
@@ -24,6 +35,9 @@ in models/member_grid.rb
       # with builtin render class: DeclarativeGrid::Renderers::Csv
       renderer :csv
       #
+      # with builtin render class: DeclarativeGrid::Renderers::Html
+      renderer :html
+      #
       # with selected columns
       renderer :csv_selected, class: :csv, columns: [:gender, :name]
       #
@@ -39,8 +53,14 @@ in member.rb
 
 example code:
 
-    m = Member.new('Adam Jensen', 'Male', Date.new(1993,3,9))
-    @grid = MemberGrid.new { [m] }
+    members = [
+      Member.new('Adam Jensen', 'Male', Date.new(1993,3,9)),
+      Member.new('Altaïr Ibn-La\'Ahad', 'Male', Date.new(1165,1,11)),
+      Member.new('Ezio Auditore da Firenze', 'Male', Date.new(1459,6,24)),
+      Member.new('Desmond Miles', 'Male', Date.new(1987,3,13))
+    ]
+    
+    @grid = MemberGrid.new(members)
     
     puts "== sample 1 =="
     puts @grid.renderer(:csv).to_string
@@ -58,12 +78,21 @@ result:
     == sample 1 ==
     Name,Birthday,Sex
     Adam Jensen,1993-03-09,Male
+    Altaïr Ibn-La'Ahad,1165-01-11,Male
+    Ezio Auditore da Firenze,1459-06-24,Male
+    Desmond Miles,1987-03-13,Male
     == sample 2 ==
     Sex,Name
     Male,Adam Jensen
+    Male,Altaïr Ibn-La'Ahad
+    Male,Ezio Auditore da Firenze
+    Male,Desmond Miles
     == sample 3 ==
     Sex,Name
     Male,Adam Jensen
+    Male,Altaïr Ibn-La'Ahad
+    Male,Ezio Auditore da Firenze
+    Male,Desmond Miles
 
 ## Installation
 
@@ -81,9 +110,23 @@ Or install it yourself as:
 
 ## Usage
 
-If you want to use it with ActiveRecord, like this:
+If you want to work with ActiveRecord, like this:
+
+    grid = MemberGrid.new(Enumerator.new(Member.where(is_good: true), :find_each))
+
+If you want shorter code:
+
+    grid = MemberGrid.new Member
+
+or
+
+    grid = MemberGrid.new Member.where(is_good: true)
+
+The library will automatically wrap the records with Enumerator, 
+preventing from massive flooding.
 
-    grid = MemberGrid.new { Enumerator.new(Member.where(is_good: true), :find_each) }
+Note that ActiveRecord#all (prior to 4.0) returns an Array 
+instead of ActiveRecord::Relation. Please avoid using it.
 
 ## How to Test
 

data/Rakefile

@@ -10,3 +10,8 @@ desc "Open an irb session preloaded with this library"
 task :console do
   sh "irb -rubygems -I lib -r declarative_grid"
 end
+
+desc "Run sample No.1 for README"
+task :sample1 do
+  sh "ruby -rubygems -I lib -r declarative_grid sample1.rb"
+end

data/declarative_grid.gemspec

@@ -27,5 +27,7 @@ Gem::Specification.new do |gem|
   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"
+  gem.add_development_dependency "activerecord", "~> 3.2.8"
+  gem.add_development_dependency "sqlite3", "~> 1.3.6"
   
 end

data/lib/declarative_grid/base.rb

@@ -10,8 +10,16 @@ module DeclarativeGrid
     #
     # Usage 1: grid = MyGrid.new { MyRecord.all }
     #
-    def initialize
-      self.records = yield
+    def initialize(records = nil)
+      if block_given?
+        STDERR.puts 'WARNING: block-style instantization is deprecated'
+        records = yield
+      end
+      
+      if records.respond_to?(:find_each)
+        records = Enumerator.new records, :find_each
+      end
+      self.records = records
     end
     
     # Renderer by name

data/lib/declarative_grid/version.rb

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

data/sample1.rb

@@ -0,0 +1,43 @@
+#encoding: UTF-8
+class MemberGrid < DeclarativeGrid::Base
+  # Columns
+  #
+  column(:name)
+  column(:birthday) {|r| (r.birthdate) }
+  column(:gender, header: 'Sex')
+  
+  # Renderers
+  #
+  # with builtin render class: DeclarativeGrid::Renderers::Csv
+  renderer :csv
+  #
+  # with builtin render class: DeclarativeGrid::Renderers::Html
+  renderer :html
+  #
+  # with selected columns
+  renderer :csv_selected, class: :csv, columns: [:gender, :name]
+  #
+end
+
+class Member < Struct.new(:name, :gender, :birthdate)
+end
+
+members = [
+  Member.new('Adam Jensen', 'Male', Date.new(1993,3,9)),
+  Member.new('Altaïr Ibn-La\'Ahad', 'Male', Date.new(1165,1,11)),
+  Member.new('Ezio Auditore da Firenze', 'Male', Date.new(1459,6,24)),
+  Member.new('Desmond Miles', 'Male', Date.new(1987,3,13))
+]
+
+grid = MemberGrid.new(members)
+
+puts "== sample 1 =="
+puts grid.renderer(:csv).to_string
+
+puts "== sample 2 =="
+puts grid.renderer(:csv_selected).to_string
+
+puts "== sample 3 =="
+io = StringIO.new
+grid.renderer(:csv_selected).perform(io)
+puts io.string

data/spec/declarative_grid/active_record_spec.rb

@@ -0,0 +1,62 @@
+#encoding: UTF-8
+require 'active_record'
+require "spec_helper"
+
+module DeclarativeGrid
+  describe Base do
+    before do
+      @grid_klass = Class.new Base do
+        column :name
+        column :gender_id
+        
+        renderer :csv
+      end
+      
+      config = { adapter: 'sqlite3', database: ':memory:' }
+      ActiveRecord::Base.establish_connection(config)
+      
+      ActiveRecord::Schema.define do
+        create_table :members do |t|
+          t.string :name
+          t.integer :gender_id
+        end
+      end
+      
+      @record_klass = Class.new ActiveRecord::Base do
+        self.table_name = 'members'
+      end
+      
+      @names = [
+        'Adam Jensen', 'Nathan Drake', 'Lara Croft',
+        "Alta\xC3\xAFr Ibn-La\'Ahad",
+        "Ezio Auditore da Firenze",
+        "Ratonhnhak\xC3\xA9:ton",
+        "Desmond Miles"
+      ]
+      @genders = [
+        1, 1, 2,
+        1,
+        1,
+        1,
+        1
+      ]
+      
+      [@names, @genders].transpose.each do |a|
+        @record_klass.create name: a[0], gender_id: a[1]
+      end
+      
+    end
+    
+    it "can accept ActiveRecord::Base and its subclasses" do
+      base = @grid_klass.new @record_klass
+      base.renderer(:csv).each_record.map(&:name).must_equal @names
+    end
+    
+    it "can accept ActiveRecord::Relation and its mixed-classes" do
+      base = @grid_klass.new @record_klass.where(nil)
+      base.renderer(:csv).each_record.map(&:name).must_equal @names
+    end
+    
+  end
+end
+

data/spec/declarative_grid/base_spec.rb

@@ -19,7 +19,7 @@ module DeclarativeGrid
         @record_class.new n+1, n*2
       end
       
-      @base = @klass.new { @records }
+      @base = @klass.new @records
     end
     
     it "is a kind of #{Model}" do

data/spec/declarative_grid/renderers/csv_spec.rb

@@ -11,7 +11,7 @@ module DeclarativeGrid
         renderer :csv_select, class: :csv, columns: [:name]
       end
       @records = [ @record_klass.new('Adam Jensen', 'Male') ]
-      @grid = @klass.new { @records }
+      @grid = @klass.new @records
     end
     
     it "should make all the renderers be kind of Csv" do

data/spec/declarative_grid/renderers/html_spec.rb

@@ -10,7 +10,7 @@ module DeclarativeGrid
         renderer :html
       end
       @records = [ @record_klass.new('Adam Jensen', 'Male') ]
-      @grid = @klass.new { @records }
+      @grid = @klass.new @records
     end
     
     it "should make all the renderers be kind of Html" do

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: declarative_grid
 version: !ruby/object:Gem::Version
-  version: 0.0.5
+  version: 0.1.0
   prerelease: 
 platform: ruby
 authors:
@@ -123,6 +123,38 @@ dependencies:
     - - ~>
       - !ruby/object:Gem::Version
         version: 1.5.5
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 3.2.8
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 3.2.8
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.3.6
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.3.6
 description: DeclarativeGrid is a gem for rendering grids described in simple DSL
 email:
 - davll.xc@gmail.com
@@ -146,6 +178,8 @@ files:
 - lib/declarative_grid/renderers/csv.rb
 - lib/declarative_grid/renderers/html.rb
 - lib/declarative_grid/version.rb
+- sample1.rb
+- spec/declarative_grid/active_record_spec.rb
 - spec/declarative_grid/base_spec.rb
 - spec/declarative_grid/model/column_spec.rb
 - spec/declarative_grid/model/row_spec.rb
@@ -182,6 +216,7 @@ signing_key:
 specification_version: 3
 summary: A flexible grid renderer
 test_files:
+- spec/declarative_grid/active_record_spec.rb
 - spec/declarative_grid/base_spec.rb
 - spec/declarative_grid/model/column_spec.rb
 - spec/declarative_grid/model/row_spec.rb