Skip to content

Commit b9dfa71

Browse files
committed
Column accessors doc
1 parent ebbc385 commit b9dfa71

File tree

1 file changed

+21
-8
lines changed

1 file changed

+21
-8
lines changed

lib/datagrid/columns/column.rb

+21-8
Original file line numberDiff line numberDiff line change
@@ -8,38 +8,52 @@ class Column
88
class ResponseFormat
99
attr_accessor :data_block, :html_block
1010

11+
# @!visibility private
1112
def initialize
1213
yield(self)
1314
end
1415

16+
# @!visibility private
1517
def data(&block)
1618
self.data_block = block
1719
end
1820

21+
# @!visibility private
1922
def html(&block)
2023
self.html_block = block
2124
end
2225

26+
# @!visibility private
2327
def call_data
2428
data_block.call
2529
end
2630

31+
# @!visibility private
2732
def to_s
2833
call_data.to_s
2934
end
3035

36+
# @!visibility private
3137
def call_html(context)
3238
context.instance_eval(&html_block)
3339
end
3440
end
3541

36-
attr_accessor :grid_class, :options, :data_block, :name, :html_block, :query
42+
# @attribute [r] grid_class
43+
# @return [Class] grid class where column is defined
44+
# @attribute [r] name
45+
# @return [Symbol] column name
46+
# @attribute [r] options
47+
# @return [Hash<Symbol, Object>] column options
48+
attr_reader :grid_class, :name, :query, :options, :data_block, :html_block
3749

3850
# @!visibility private
3951
def initialize(grid_class, name, query, options = {}, &block)
40-
self.grid_class = grid_class
41-
self.name = name.to_sym
42-
self.options = options
52+
@grid_class = grid_class
53+
@name = name.to_sym
54+
@query = query
55+
@options = options
56+
4357
if options[:class]
4458
Datagrid::Utils.warn_once(
4559
"column[class] option is deprecated. Use {tag_options: {class: ...}} instead.",
@@ -50,13 +64,12 @@ def initialize(grid_class, name, query, options = {}, &block)
5064
}
5165
end
5266
if options[:html] == true
53-
self.html_block = block
67+
@html_block = block
5468
else
55-
self.data_block = block
69+
@data_block = block
5670

57-
self.html_block = options[:html] if options[:html].is_a? Proc
71+
@html_block = options[:html] if options[:html].is_a? Proc
5872
end
59-
self.query = query
6073
end
6174

6275
# @deprecated Use {Datagrid::Columns#data_value} instead

0 commit comments

Comments
 (0)