Module: ForestLiana::Collection::ClassMethods

Defined in:
lib/forest_liana/collection.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Instance Attribute Details

#active_record_class=(value) ⇒ Object

Sets the attribute active_record_class

Parameters:

  • value —

    the value to set the attribute active_record_class to.



5
6
7
 
# File 'lib/forest_liana/collection.rb', line 5

def active_record_class=(value)
  @active_record_class = value
end

#collection_name ⇒ Object

Returns the value of attribute collection_name.



6
7
8
 
# File 'lib/forest_liana/collection.rb', line 6

def collection_name
  @collection_name
end

#is_read_only ⇒ Object

Returns the value of attribute is_read_only.



7
8
9
 
# File 'lib/forest_liana/collection.rb', line 7

def is_read_only
  @is_read_only
end

#is_searchable ⇒ Object

Returns the value of attribute is_searchable.



8
9
10
 
# File 'lib/forest_liana/collection.rb', line 8

def is_searchable
  @is_searchable
end

Instance Method Details

#action(name, opts = {}) ⇒ Object 



26
27
28
29
30
 
# File 'lib/forest_liana/collection.rb', line 26

def action(name, opts = {})
  opts[:id] = "#{self.collection_name.to_s}.#{name}"
  opts[:name] = name
  model.actions << ForestLiana::Model::Action.new(opts)
end

#belongs_to(name, opts, &block) ⇒ Object 



91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
 
# File 'lib/forest_liana/collection.rb', line 91

def belongs_to(name, opts, &block)
  model.fields << opts.merge({
    field: name,
    :'is-searchable' => false,
    type: 'String'
  })

  define_method(name) { self.data[name] } if smart_collection?

  if serializer_name && ForestLiana::UserSpace.const_defined?(
      serializer_name)
    ForestLiana::UserSpace.const_get(serializer_name).class_eval do
      has_one(name, name: name, include_data: true, &block)
    end
  end
end

#collection(collection_name, opts = {}) ⇒ Object 



10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
 
# File 'lib/forest_liana/collection.rb', line 10

def collection(collection_name, opts = {})
  self.collection_name = find_name(collection_name).to_s
  self.is_read_only = opts[:read_only] || false
  self.is_searchable = opts[:is_searchable] || false

  # NOTICE: Creates dynamically the serializer if it's a Smart Collection.
  if smart_collection? &&
      !ForestLiana::UserSpace.const_defined?(serializer_name)

    ForestLiana.names_overriden[self] = self.collection_name.to_s

    ForestLiana::SerializerFactory.new(is_smart_collection: true)
      .serializer_for(self)
  end
end

#field(name, opts, &block) ⇒ Object 



42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
 
# File 'lib/forest_liana/collection.rb', line 42

def field(name, opts, &block)
  opts[:read_only] = true unless opts.has_key?(:read_only)
  opts[:read_only] = false if opts.has_key?(:set)

  model.fields << opts.merge({
    field: name,
    :'is-read-only' => opts[:read_only],
    :'is-filterable' => !!opts[:is_filterable],
    :'is-sortable' => !!opts[:is_sortable],
    :'is-virtual' => true
  })

  define_method(name) { self.data[name] } if smart_collection?

  if serializer_name && ForestLiana::UserSpace.const_defined?(
      serializer_name)
    ForestLiana::UserSpace.const_get(serializer_name).class_eval do
      compute_value = lambda do |object|
        begin
          object.instance_eval(&block)
        rescue => exception
          FOREST_LOGGER.error "Cannot retrieve the " + name.to_s + " value because of an " \
            "internal error in the getter implementation: " + exception.message
          nil
        end
      end

      attribute(name, &compute_value)
    end
  end
end

#has_many(name, opts, &block) ⇒ Object 



74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
 
# File 'lib/forest_liana/collection.rb', line 74

def has_many(name, opts, &block)
  model.fields << opts.merge({
    field: name,
    :'is-searchable' => false,
    type: ['String']
  })

  define_method(name) { self.data[name] } if smart_collection?

  if serializer_name && ForestLiana::UserSpace.const_defined?(
      serializer_name)
    ForestLiana::UserSpace.const_get(serializer_name).class_eval do
      has_many(name, name: name)
    end
  end
end

#search_fields(fields) ⇒ Object 



38
39
40
 
# File 'lib/forest_liana/collection.rb', line 38

def search_fields(fields)
  model.search_fields = fields
end

#segment(name, opts = {}, &block) ⇒ Object 



32
33
34
35
36
 
# File 'lib/forest_liana/collection.rb', line 32

def segment(name, opts = {}, &block)
  opts[:id] = "#{self.collection_name.to_s}.#{name}"
  opts[:name] = name
  model.segments << ForestLiana::Model::Segment.new(opts, &block)
end