Arrow::Config::YamlLoader

A loader used by Arrow::Config to load configuration files written in YAML.

Constants

SVNRev: SVN Revision
SVNId: SVN Id

Public Instance Methods

is_newer?( file, time ) click to toggle source

Return true if the specified file is newer than the given time.

    # File /Users/ged/source/ruby/Arrow/lib/arrow/config-loaders/yaml.rb, line 77
77:     def is_newer?( file, time )
78:         return false unless File.exists?( file )
79:         st = File.stat( file )
80:         self.log.debug "File mtime is: %s, comparison time is: %s" %
81:             [ st.mtime, time ]
82:         return st.mtime > time
83:     end

load( filename ) click to toggle source

Load and return configuration values from the YAML file specified.

    # File /Users/ged/source/ruby/Arrow/lib/arrow/config-loaders/yaml.rb, line 60
60:     def load( filename )
61:         self.log.info "Loading YAML-format configuration from '%s'" % filename
62:         return YAML.load_file( filename )
63:     end

save( confighash, filename ) click to toggle source

Save configuration values to the YAML file specified.

    # File /Users/ged/source/ruby/Arrow/lib/arrow/config-loaders/yaml.rb, line 67
67:     def save( confighash, filename )
68:         self.log.info "Saving YAML-format configuration to '%s'" % filename
69:         File.open( filename, File::WRONLY|File::CREAT|File::TRUNC ) {|ofh|
70:             ofh.print( confighash.to_yaml )
71:         }
72:     end

secsequence

--- SEC00030

seccomment

--- ""

method_list

--- 
- methods: 
  - visibility: public
    aref: M000042
    name: is_newer?
    sourcecode: "    <span class=\"ruby-comment cmt\"># File /Users/ged/source/ruby/Arrow/lib/arrow/config-loaders/yaml.rb, line 77</span>\n\
      77:     <span class=\"ruby-keyword kw\">def</span> <span class=\"ruby-identifier\">is_newer?</span>( <span class=\"ruby-identifier\">file</span>, <span class=\"ruby-identifier\">time</span> )\n\
      78:         <span class=\"ruby-keyword kw\">return</span> <span class=\"ruby-keyword kw\">false</span> <span class=\"ruby-keyword kw\">unless</span> <span class=\"ruby-constant\">File</span>.<span class=\"ruby-identifier\">exists?</span>( <span class=\"ruby-identifier\">file</span> )\n\
      79:         <span class=\"ruby-identifier\">st</span> = <span class=\"ruby-constant\">File</span>.<span class=\"ruby-identifier\">stat</span>( <span class=\"ruby-identifier\">file</span> )\n\
      80:         <span class=\"ruby-keyword kw\">self</span>.<span class=\"ruby-identifier\">log</span>.<span class=\"ruby-identifier\">debug</span> <span class=\"ruby-value str\">&quot;File mtime is: %s, comparison time is: %s&quot;</span> <span class=\"ruby-operator\">%</span>\n\
      81:             [ <span class=\"ruby-identifier\">st</span>.<span class=\"ruby-identifier\">mtime</span>, <span class=\"ruby-identifier\">time</span> ]\n\
      82:         <span class=\"ruby-keyword kw\">return</span> <span class=\"ruby-identifier\">st</span>.<span class=\"ruby-identifier\">mtime</span> <span class=\"ruby-operator\">&gt;</span> <span class=\"ruby-identifier\">time</span>\n\
      83:     <span class=\"ruby-keyword kw\">end</span>"
    m_desc: |-
      <p>
      Return <tt>true</tt> if the specified <tt>file</tt> is newer than the given
      <tt>time</tt>.
      </p>
    params: ( file, time )
  - visibility: public
    aref: M000040
    name: load
    sourcecode: "    <span class=\"ruby-comment cmt\"># File /Users/ged/source/ruby/Arrow/lib/arrow/config-loaders/yaml.rb, line 60</span>\n\
      60:     <span class=\"ruby-keyword kw\">def</span> <span class=\"ruby-identifier\">load</span>( <span class=\"ruby-identifier\">filename</span> )\n\
      61:         <span class=\"ruby-keyword kw\">self</span>.<span class=\"ruby-identifier\">log</span>.<span class=\"ruby-identifier\">info</span> <span class=\"ruby-value str\">&quot;Loading YAML-format configuration from '%s'&quot;</span> <span class=\"ruby-operator\">%</span> <span class=\"ruby-identifier\">filename</span>\n\
      62:         <span class=\"ruby-keyword kw\">return</span> <span class=\"ruby-constant\">YAML</span>.<span class=\"ruby-identifier\">load_file</span>( <span class=\"ruby-identifier\">filename</span> )\n\
      63:     <span class=\"ruby-keyword kw\">end</span>"
    m_desc: |-
      <p>
      Load and return configuration values from the YAML <tt>file</tt> specified.
      </p>
    params: ( filename )
  - visibility: public
    aref: M000041
    name: save
    sourcecode: "    <span class=\"ruby-comment cmt\"># File /Users/ged/source/ruby/Arrow/lib/arrow/config-loaders/yaml.rb, line 67</span>\n\
      67:     <span class=\"ruby-keyword kw\">def</span> <span class=\"ruby-identifier\">save</span>( <span class=\"ruby-identifier\">confighash</span>, <span class=\"ruby-identifier\">filename</span> )\n\
      68:         <span class=\"ruby-keyword kw\">self</span>.<span class=\"ruby-identifier\">log</span>.<span class=\"ruby-identifier\">info</span> <span class=\"ruby-value str\">&quot;Saving YAML-format configuration to '%s'&quot;</span> <span class=\"ruby-operator\">%</span> <span class=\"ruby-identifier\">filename</span>\n\
      69:         <span class=\"ruby-constant\">File</span>.<span class=\"ruby-identifier\">open</span>( <span class=\"ruby-identifier\">filename</span>, <span class=\"ruby-constant\">File</span><span class=\"ruby-operator\">::</span><span class=\"ruby-constant\">WRONLY</span><span class=\"ruby-operator\">|</span><span class=\"ruby-constant\">File</span><span class=\"ruby-operator\">::</span><span class=\"ruby-constant\">CREAT</span><span class=\"ruby-operator\">|</span><span class=\"ruby-constant\">File</span><span class=\"ruby-operator\">::</span><span class=\"ruby-constant\">TRUNC</span> ) {<span class=\"ruby-operator\">|</span><span class=\"ruby-identifier\">ofh</span><span class=\"ruby-operator\">|</span>\n\
      70:             <span class=\"ruby-identifier\">ofh</span>.<span class=\"ruby-identifier\">print</span>( <span class=\"ruby-identifier\">confighash</span>.<span class=\"ruby-identifier\">to_yaml</span> )\n\
      71:         }\n\
      72:     <span class=\"ruby-keyword kw\">end</span>"
    m_desc: |-
      <p>
      Save configuration values to the YAML <tt>file</tt> specified.
      </p>
    params: ( confighash, filename )
  category: Instance
  type: Public

sectitle

---

constants

--- 
- name: SVNRev
  desc: |+
    
    SVN Revision
    
  value: "%q$Rev: 437 $"
- name: SVNId
  desc: |+
    
    SVN Id
    
  value: "%q$Id: yaml.rb 437 2008-03-28 00:49:20Z deveiant $"

In Files

Subversion Info

Parent

Methods

Class Index