miga-base 0.2.0.6 → 0.2.0.7

data/lib/miga/metadata.rb

@@ -1,74 +1,118 @@
-#
 # @package MiGA
-# @author Luis M. Rodriguez-R <lmrodriguezr at gmail dot com>
-# @license artistic license 2.0
-# @update Jul-06-2015
-#
+# @license Artistic-2.0
 
-module MiGA
-   class Metadata
-      # Class
-      def self.exist?(path) File.size? path end
-      def self.load path
-	 return nil unless Metadata.exist? path
-	 Metadata.new path
-      end
-      # Instance
-      attr_reader :path, :data
-      def initialize(path, defaults={})
-	 @path = File.absolute_path(path)
-	 @data = {}
-	 defaults.each_pair{ |k,v| self[k]=v }
-	 self.create unless File.size? self.path
-	 self.load
-      end
-      def create
-         @data[:created] = Time.now.to_s
-	 self.save
-      end
-      def save
-	 MiGA.DEBUG "Metadata.save #{self.path}"
-         self.data[:updated] = Time.now.to_s
-	 json = JSON.pretty_generate(self.data)
-	 sleeper = 0.0
-	 while File.exist? self.path + ".lock"
-	    sleeper += 0.1 if sleeper <= 10.0
-	    sleep(sleeper.to_i)
-	 end
-	 FileUtils.touch self.path + ".lock"
-	 ofh = File.open(self.path + ".tmp", "w")
-	 ofh.puts json
-	 ofh.close
-	 raise "Lock-racing detected for #{self.path}." unless File.exist? self.path + ".tmp" and File.exist? self.path + ".lock"
-	 File.rename self.path + ".tmp", self.path
-	 File.unlink self.path + ".lock"
-      end
-      def load
-	 sleeper = 0.0
-	 while File.exist? self.path + ".lock"
-	    sleeper += 0.1 if sleeper <= 10.0
-	    sleep(sleeper.to_i)
-	 end
-	 # :symbolize_names does not play nicely with :create_additions
-	 tmp = JSON.parse File.read(self.path), {:symbolize_names=>false, :create_additions=>true}
-	 @data = {}
-	 tmp.each_pair{ |k,v| self[k] = v }
-      end
-      def remove!
-	 MiGA.DEBUG "Metadata.remove! #{self.path}"
-	 File.unlink self.path
-      end
-      def [](k) self.data[k.to_sym] end
-      def []=(k,v)
-	 k = k.to_sym
-	 # Protect the special field :name
-	 v=v.miga_name if k==:name
-	 # Symbolize the special field :type
-	 v=v.to_sym if k==:type
-	 # Register and return
-	 self.data[k]=v
-      end
-      def each(&blk) self.data.each{ |k,v| blk.call(k,v) } ; end
-   end
-end
+##
+# Metadata associated to objects like MiGA::Project, MiGA::Dataset, and
+# MiGA::Result.
+class MiGA::Metadata < MiGA::MiGA
+  # Class-level
+
+  ##
+  # Does the metadata described in +path+ already exist?
+  def self.exist?(path) File.size? path end
+
+  ##
+  # Load the metadata described in +path+ and return MiGA::Metadata if it
+  # exists, or nil otherwise.
+  def self.load(path)
+    return nil unless Metadata.exist? path
+    MiGA::Metadata.new(path)
+  end
+
+  # Instance-level
+
+  ##
+  # Path to the JSON file describing the metadata.
+  attr_reader :path
+  
+  ##
+  # Parsed data as a Hash.
+  attr_reader :data
+
+  ##
+  # Initiate a MiGA::Metadata object with description in +path+. It will create
+  # it if it doesn't exist.
+  def initialize(path, defaults={})
+    @path = File.absolute_path(path)
+    @data = {}
+    defaults.each_pair{ |k,v| self[k]=v }
+    self.create unless File.size? self.path
+    self.load
+  end
+
+  ##
+  # Reset :created field and save the current data.
+  def create
+    @data[:created] = Time.now.to_s
+    self.save
+  end
+
+  ##
+  # Save the metadata into #path.
+  def save
+    MiGA.DEBUG "Metadata.save #{path}"
+    @data[:updated] = Time.now.to_s
+    json = JSON.pretty_generate(data)
+    sleeper = 0.0
+    while File.exist?(lock_file)
+      sleeper += 0.1 if sleeper <= 10.0
+      sleep(sleeper.to_i)
+    end
+    FileUtils.touch lock_file
+    ofh = File.open(path + ".tmp", "w")
+    ofh.puts json
+    ofh.close
+    raise "Lock-racing detected for #{path}." unless
+      File.exist?(path + ".tmp") and File.exist?(lock_file)
+    File.rename(path + ".tmp", path)
+    File.unlink(lock_file)
+  end
 
+  ##
+  # (Re-)load metadata stored in #path.
+  def load
+    sleeper = 0.0
+    while File.exist? lock_file
+      sleeper += 0.1 if sleeper <= 10.0
+      sleep(sleeper.to_i)
+    end
+    # :symbolize_names does not play nicely with :create_additions
+    tmp = JSON.parse(File.read(path),
+      {:symbolize_names=>false, :create_additions=>true})
+    @data = {}
+    tmp.each_pair{ |k,v| self[k] = v }
+  end
+
+  ##
+  # Delete file at #path.
+  def remove!
+    MiGA.DEBUG "Metadata.remove! #{self.path}"
+    File.unlink(self.path)
+    nil
+  end
+
+  ##
+  # Lock file for the metadata.
+  def lock_file ; path + ".lock" ; end
+
+  ##
+  # Return the value of +k+ in #data.
+  def [](k) data[k.to_sym] end
+
+  ##
+  # Set the value of +k+ to +v+.
+  def []=(k,v)
+    k = k.to_sym
+    # Protect the special field :name
+    v=v.miga_name if k==:name
+    # Symbolize the special field :type
+    v=v.to_sym if k==:type
+    # Register and return
+    @data[k]=v
+  end
+
+  ##
+  # Iterate +blk+ for each data with 2 arguments key and value.
+  def each(&blk) data.each{ |k,v| blk.call(k,v) } ; end
+
+end