Class: ActiveTriples::PropertyBuilder

Inherits:
Object
  • Object
show all
Defined in:
lib/active_triples/property_builder.rb

Overview

A builder for property ‘NodeConfig`s

Examples:

PropertyBuilder.build(:creator, predicate: RDF::Vocab::DC.creator)

See Also:

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(name, options, &block) ⇒ PropertyBuilder

Returns a new instance of PropertyBuilder.

Parameters:

  • name —
  • options — 


21
22
23
24
 
# File 'lib/active_triples/property_builder.rb', line 21

def initialize(name, options, &block)
  @name = name
  @options = options
end

Instance Attribute Details

#name ⇒ Object (readonly)

Returns:



16
17
18
 
# File 'lib/active_triples/property_builder.rb', line 16

def name
  @name
end

#options ⇒ Object (readonly)

Returns the value of attribute options.



16
 
# File 'lib/active_triples/property_builder.rb', line 16

attr_reader :name, :options

Class Method Details

.build(model, name, options, &block) ⇒ Object 



52
53
54
55
56
57
 
# File 'lib/active_triples/property_builder.rb', line 52

def self.build(model, name, options, &block)
  builder = create_builder name, options, &block
  reflection = builder.build(&block)
  define_accessors model, reflection, options
  reflection
end

.create_builder(name, options) {|index_object| ... } ⇒ PropertyBuilder

Parameters:

  • name (Symbol)
  • options (Hash<Symbol>)

Options Hash (options):

  • :predicate (RDF::URI)
  • :class_name (String, Class)
  • :cast (Boolean)

Yields:

  • yields to block configuring index behaviors

Yield Parameters:

Returns:

Raises:

  • (ArgumentError) —

    if name is not a symbol and/or :predicate can’t be coerced into a URI

See Also:



41
42
43
44
45
46
47
48
49
50
 
# File 'lib/active_triples/property_builder.rb', line 41

def self.create_builder(name, options, &block)
  raise ArgumentError, "property names must be a Symbol" unless
    name.kind_of?(Symbol)

  options[:predicate] = RDF::URI.intern(options[:predicate])
  raise ArgumentError, "must provide an RDF::URI to :predicate" unless
    options[:predicate].valid?

  new(name, options, &block)
end

.define_accessors(model, reflection, options = {}) ⇒ Object 



59
60
61
62
63
64
65
 
# File 'lib/active_triples/property_builder.rb', line 59

def self.define_accessors(model, reflection, options={})
  mixin = model.generated_property_methods
  name = reflection.term
  define_readers(mixin, name)
  define_id_reader(model, name) unless options[:cast] == false
  define_writers(mixin, name)
end

.define_id_reader(mixin, name) ⇒ Object 



75
76
77
78
79
80
81
 
# File 'lib/active_triples/property_builder.rb', line 75

def self.define_id_reader(mixin, name)
  mixin.class_eval <<-CODE, __FILE__, __LINE__ + 1
    def #{name}_ids(*)
      get_values(:#{name}, cast: false)
    end
  CODE
end

.define_readers(mixin, name) ⇒ Object 



67
68
69
70
71
72
73
 
# File 'lib/active_triples/property_builder.rb', line 67

def self.define_readers(mixin, name)
  mixin.class_eval <<-CODE, __FILE__, __LINE__ + 1
    def #{name}(*args)
      get_values(:#{name}, *args)
    end
  CODE
end

.define_writers(mixin, name) ⇒ Object 



83
84
85
86
87
88
89
 
# File 'lib/active_triples/property_builder.rb', line 83

def self.define_writers(mixin, name)
  mixin.class_eval <<-CODE, __FILE__, __LINE__ + 1
    def #{name}=(value)
      set_value(:#{name}, value)
    end
  CODE
end

Instance Method Details

#build {|index_object| ... } ⇒ NodeConfig

Returns a new property node config.

Yields:

  • yields to block configuring index behaviors

Yield Parameters:

Returns:



96
97
98
99
100
101
102
 
# File 'lib/active_triples/property_builder.rb', line 96

def build(&block)
  NodeConfig.new(name,
                 options[:predicate],
                 options.except(:predicate)) do |config|
    config.with_index(&block) if block_given?
  end
end