Class: LanGrove::Plugin::YamlFile

Inherits:
Persistor show all
Defined in:
lib/langrove/plugin/yaml_file.rb

Instance Attribute Summary

Attributes inherited from Base

#logger

Instance Method Summary collapse

Methods inherited from Persistor

#fetch_all, #fetch_all_handler, #fetch_handler, #gen_key, #initialize, #next_seq, #store_handler, #transform, type

Methods inherited from DataSource

type

Methods inherited from Base

#config_exception, #initialize, #type

Constructor Details

This class inherits a constructor from LanGrove::Plugin::Persistor

Instance Method Details

#all_capsules(&block) ⇒ Object 



33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
 
# File 'lib/langrove/plugin/yaml_file.rb', line 33

def all_capsules( &block )
  
  directory = "#{@basedir}/#{@database}/#{@table}"
  
  Dir.glob( "#{directory}/*" ) do |file|
    
    begin
      
      yield File.basename( file ),
        YAML.load_file( file ) if block
        
    rescue Exception => e
      
      #
      # Intercept to log
      #
      @logger.error( 

        "ERROR: #{self.class} could not load from file:#{file} #{e.to_s}"

      )
      
      #
      # Re-Raise - Stall want to bring down the Daemon
      #
      raise e
      
    end
    
  end
  
end

#fetch(handler) ⇒ Object 



67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
 
# File 'lib/langrove/plugin/yaml_file.rb', line 67

def fetch( handler )
  
  filename = nil
  
  begin
    
    #
    # Key is generated from pending_capsule
    # unless key already exists.
    #      
    gen_key( handler ) if handler.key.nil?

    filename = handler.key['key'][:filename]

  rescue Exception => e
  
    #
    #  ""Awkward...""
    # 
    #  Cannot fetch. (Have no key)
    # 
    #  Don't want to bring down the house on this.
    #  There may only be one anomilous capsule.
    # 
    #  
    Unimplemented.notify( @logger, "alert? here", [:metrix, :alerter] )
  
  
    @logger.error( 
    
  "Malformed data. #{self.class}.fetch() cannot assemble key. Exception: #{e}, Handler: #{handler.inspect}"

    )
    
  end
  
  begin
    
    file = "#{@basedir}/#{@database}/#{@table}/#{filename}"
    
    unless File.file?( file )
      
      #
      # File is not there. Assume new.
      #
      unless @allow_learn.nil? 
      
        handler.capsule.merge!( {} )
        
        @logger.warn( "#{self.class} assumed NEW capsule for #{file}" )
        
        return true
        
      else 
        
        @logger.error "ERROR: Ignored #{@table}._id: #{id}. Enable :allow_learn:"
        
        return false
        
      end
      
    end
    
    data = YAML.load_file( file )
    
    handler.capsule.merge!( data )
    
    return true
    
  rescue Exception => e 
    
    #
    # There are two distinctly different patterns that may be at 
    # play here.
    # 
    # the 'Discoverer' 
    # 
    # - When attempting to fetch() from persistance and it fails
    #   for whatever reason, the Discoverer is allowed to create
    #   a new capsule.
    # 
    #   This new capsule will become the persisted entity.
    # 
    # 
    # the 'Predefined'
    # 
    # - When fetch() fails, the handler should NOT be allowed to
    #   ignore the problem, a NAK should be sent to the connecting
    #   client and an alert should be enqueued, 
    #   
    #   Likely the database storing the persistend capsule is
    #   down... 
    # 
    #   Clients should not be able to inform with further data 
    #   untill the situation is corrected.
    # 
    #
    # This choice should be configurable
    # 
    Unimplemented.notify( @logger, "configurable required: allow_create", [:configable] )
    
    @logger.error( 
    
      "#{self.class}.fetch() failed. Exception: #{e}, Handler: #{handler.inspect}"

    )
    
    return false
    
  end
  
end

#store(handler) ⇒ Object 



181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
 
# File 'lib/langrove/plugin/yaml_file.rb', line 181

def store( handler )

  filename = nil

  begin
    
    data_hash = handler.capsule
    
    gen_key( handler ) if handler.key.nil?

    filename = handler.key['key'][:filename]
    
  rescue Exception => e
    
    #
    # ""Awkward...""
    #
    # Field in data that was supposed to house the
    # id value (to become the file name),
    # 
    # Is empty or missing...
    # 
    
    #
    # Almost Ignore... 
    # 
    Unimplemented.notify( @logger, "alert? here", [:metrix, :alerter] )
    
    @logger.error( 
    
  "Malformed data. #{self.class}.store() cannot assemble key. Exception: #{e}, Handler: #{handler.inspect}"

    )
    
    return false
    
  end
  
  begin
    
    file = "#{@basedir}/#{@database}/#{@table}/#{filename}"
    
    File.open( file, 'w' ) do |f|
      
      YAML::dump( data_hash, f )
      
    end
   
    @logger.debug( 
    
      "Wrote to file: #{file}"
      
    )
    
    return true
  
  rescue Exception => e
    
    
    #
    # Pending alerter
    #
    Unimplemented.notify( @logger, "alert here", [:metrix, :alerter] )
    
    @logger.error( 
    
      "#{self.class} failing to file: #{filename}: #{e}" 
      
    )
    
    return false
    
  end

end

#validate_config ⇒ Object 



8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
 
# File 'lib/langrove/plugin/yaml_file.rb', line 8

def validate_config

  super
  
  config_exception(
  
    "#{self.class} requires :key:filename: defined" 
  
  ) if @key[:filename].nil? or @key[:filename] == ''
  
  @basedir = @config[:basedir]
  
  config_exception(
  
    "#{self.class} requires :basedir: defined" 
  
  ) if ( 
  
    @basedir.nil? or @basedir == ''
  
  )
  
end