xml-registry 0.1.11 → 0.1.12

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 0dea5c94aaf1371d724090586238786aed77de6a
+  data.tar.gz: 7889299df94f76b8ec6aaf4aebc9546ad3ca4ea0
+SHA512:
+  metadata.gz: e5c3ce602558bef9a569c9b5217a54ad2c7ec61fcd09cf0ab942fc2b229427aaa16b7928f4c79ed44f2f1d4c2c1101095841cd317d561cc215cc98be14157b6a
+  data.tar.gz: 0907bf7ae071b8960e868a194343cd2bb2a58069a58d40aaa4e0d662f259c7a92f5cbf1f2e2d9a0b89a0cc24585e0d54766622fd71d5c163f7209f802915292a

data/lib/xml-registry.rb

@@ -1,4 +1,4 @@
-#!/usr/bin/ruby
+#!/usr/bin/env ruby
 
 # file: xml-registry.rb
 
@@ -8,20 +8,30 @@ class XMLRegistry
 
   attr_reader :doc
   
-  def initialize()
+  def initialize(template = '<root></root>')
     super()
-    @template = '<root><system/><app/><user/><ip_address/></root>'
+    @template = template
     @doc = Rexle.new(@template)
   end
 
-  def initialise_registry()
-    @doc = Rexle.new(@template)
+  # Creates a new registry document from scratch. Optional param: string XML template
+  # example: initialise_registry('<root><app/></root>')
+  #
+  def initialise_registry(new_template=nil)
+    @doc = Rexle.new(new_template || @template)
   end
 
   alias :reset_registry :initialise_registry
+  alias :initialize_registry :initialise_registry
 
+  # Set the key by passing in the path and the value
+  # example: set_key 'app/gtd/funday', 'friday'
+  #
   def set_key(path, value)
-
+    
+    # if the 1st element doesn't exist create it
+    e = path.split('/',2).first
+    @doc.root.add_element Rexle::Element.new(e) unless @doc.root.element e
     create_path = find_path(path)  
 
     if not create_path.empty? then
@@ -31,34 +41,72 @@ class XMLRegistry
     
     add_value(path, value)  
   end
-
+  
+  # get the key value by passing the path
+  # example: get_key('app/gtd/funday').value #=> 'friday'
+  #
+  # returns the value as a Rexle::Element
+  #
   def get_key(path)
     @doc.root.element path
   end
   
+  # get several keys using a Rexle XPath
+  # example: get_key('//funday') #=> [<funday>tuesday</funday>,<funday>friday</funday>]
+  #
+  # returns an array of 0 or more Rexle elements
+  #
   def get_keys(path)
     @doc.root.xpath path
   end        
 
+  # delete the key at the specified path
+  # example: delete_key 'app/gtd/funday'
+  #
+  #
   def delete_key(path)
     @doc.root.delete path    
   end
 
+  # return the registry as an XML document
+  # example: puts reg.to_xml pretty: true
+  #
   def to_xml(options={})
     @doc.xml options
   end
 
   alias :display_xml :to_xml
 
+  # load a new registry xml document replacing the existing registry
+  #
   def load_xml(s='')      
     @doc = Rexle.new(read(s))          
     self
   end
 
+  # save the registry to the specified file path
+  #
   def save(s)
     File.open(s, 'w'){|f| f.write @doc.xml}
   end
 
+  # import a registry hive from a string in registry format
+  #
+  # example:
+  #
+  #s =<<REG
+#[app/app1]
+#"admin"="jrobertson"
+#"pin-no"="1234"
+#
+#[app/app2]
+#"admin"="dsmith"
+#"pin-no"="4321"
+#REG
+#
+#reg = XMLRegistry.new 
+#reg.import s 
+  #
   def import(s)      
     reg_buffer = read(s)
 
@@ -71,6 +119,10 @@ class XMLRegistry
     end
   end
 
+  # Export the registry to file if the filepath is specified. Regardless, 
+  # the registry will be returned as a string in the registry 
+  # export format.
+  #
   def export(s=nil)
     reg = print_scan(@doc.root).join("\n")
     File.open(s){|f| f.write reg} if s
@@ -132,4 +184,4 @@ class XMLRegistry
     out  
   end
 
-end
+end

metadata

@@ -1,14 +1,13 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: xml-registry
-version: !ruby/object:Gem::Version 
-  prerelease: 
-  version: 0.1.11
+version: !ruby/object:Gem::Version
+  version: 0.1.12
 platform: ruby
-authors: 
+authors:
 - James Robertson
 autorequire: 
 bindir: bin
-cert_chain: 
+cert_chain:
 - |
   -----BEGIN CERTIFICATE-----
   MIIDRDCCAiygAwIBAgIBADANBgkqhkiG9w0BAQUFADBIMRIwEAYDVQQDDAlnZW1t
@@ -30,46 +29,36 @@ cert_chain:
   m8++OvC3wZJ60rgKYqxfVYDFYuaMttCZlmtJeF5LerbwGPPIjGwvIeYDLqBJRuA6
   4KclOqKpfBFvuefX+F9YSO3aO94nnzhV
   -----END CERTIFICATE-----
-
-date: 2013-02-06 00:00:00 Z
+date: 2013-04-08 00:00:00.000000000 Z
 dependencies: []
-
 description: 
 email: 
 executables: []
-
 extensions: []
-
 extra_rdoc_files: []
-
-files: 
+files:
 - lib/xml-registry.rb
 homepage: 
 licenses: []
-
+metadata: {}
 post_install_message: 
 rdoc_options: []
-
-require_paths: 
+require_paths:
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement 
-  none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      version: "0"
-required_rubygems_version: !ruby/object:Gem::Requirement 
-  none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      version: "0"
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
 requirements: []
-
 rubyforge_project: 
-rubygems_version: 1.8.23
+rubygems_version: 2.0.0.rc.2
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: xml-registry
 test_files: []
-