usefuldb 0.0.6 → 0.0.7

data/CHANGELOG

@@ -1,5 +1,10 @@
 usefuldb gem CHANGELOG
 
+## Version 0.0.7
+- Updated layout of the yaml database file to include description field for each entry
+- Updated layout of the yaml database file to include a version field
+- Updated system to allow automatic upgrading of older databases to the new structure
+
 ## Version 0.0.6
 - Added UsefulDB::UsefulUtils.array_to_s to convert an array into a string identical to Ruby 1.9.1 +'s Array#to_s
 - Removed colour output so as to display correctly on Windows hosts through JRuby

data/README

@@ -1,4 +1,4 @@
-## Readme - v0.0.5
+## Readme - v0.0.6
 
 ### Install
 To run the unit tests use the following rake target

data/lib/usefuldb/gui.rb

@@ -20,7 +20,8 @@ module UsefulDB
           msg = ''
           msg += "- Tags: " + UsefulDB::UsefulUtils.array_to_s(i["tag"]) + "\n"
           puts msg
-          puts "- Value: " + i["value"] + "\n\n##\n" 
+          puts "- Value: " + i["value"]
+          puts "- Description: " + i["description"] + "\n\n##\n" 
         end
       end
       
@@ -46,40 +47,35 @@ module UsefulDB
        
       def add(opts)
         UsefulDB.dbLoad
-        if opts[:v] then puts "in verbose mode\n"; end
         
-        puts "Please enter the comma separated search tags like the following:"
-        if opts[:v] then puts "eg:\nterm1, term2, term3\n\n"; end
+        if opts[:v]
+          puts "in verbose mode\n"
+          puts "Please enter the comma separated search tags like the following:"
+          puts "eg:\nterm1, term2, term3\n\n"
+        else
+          puts "Please enter the comma separated search tags like the following:"
+        end
         
         begin
           tags = ((STDIN.gets).strip).split(', ')
-          puts "The following was captured: " + UsefulDB::UsefulUtils.array_to_s(tags)
-          puts "Is this correct? y/n"
+                    
+          puts "Please enter the value you wish to store for this database entry:"
+          value = (STDIN.gets).strip
           
-          input = (STDIN.gets).strip
-          if input == "y"
-            puts "Please enter the value you wish to store for this database entry:"
-            value = (STDIN.gets).strip
-            
-            puts "The following was captured: " + value
-            puts "Is this correct? y/n"
-            input = (STDIN.gets).strip
-            if input == "y"
-              entry = {"tag" => tags, "value" => value}
-              
-              if opts[:v] then puts "Storing the following in the database:\n" + entry.to_s; end
-              
-              UsefulDB.add(entry, {})
-              UsefulDB.dbSave
-              
-            else
-              puts "Exiting"
-              exit
-            end
-          else
-            puts "Exiting"
-            exit
+          puts "Please enter a description for this entry: "
+          description = (STDIN.gets).strip
+          
+          entry = {"tag" => tags, "value" => value, "description" => description}
+          
+          if opts[:v]
+            puts "Storing the following in the database:\n" 
+            puts "Search tags: " + UsefulDB::UsefulUtils.array_to_s(tags)
+            puts "Entry Value: " + value
+            puts "Description: " + description
           end
+              
+          UsefulDB.add(entry, {})
+          UsefulDB.dbSave
           
         rescue Exception => e
           puts e.message

data/lib/usefuldb/settings.rb

@@ -7,21 +7,61 @@ module UsefulDB
   
       attr_accessor :data
       
+      # Loads the database from disk
       def load(path)
-        @data = begin
-          YAML.load(File.open(path))
+        begin
+          @data = YAML.load(File.open(path))
+          
+          if @data.class == Array
+            puts "Assuming currently installed DB version < 0.0.7 running autoConvert"
+            autoConvert()
+            save(@data, path)
+          elsif @data["version"] != UsefulDB::Version.to_s
+            puts "The database version is lower than the latest version running autoUpgrade"
+            autoUpgrade()
+            save(@data, path)
+          else
+            #puts "Database version is current"
+          end
+          
+          
+          # Debug
+          #puts @data.inspect
+          
         rescue ArgumentError => e
           exit("Could not parse YAML: #{e.message}")
         end  
       end
       
+      
+      # Saves the database to disk
       def save(newData, path)
         @data = newData
         f = File.open(path, "w")
         f.write(@data.to_yaml)
         f.close
       end
-  
+      
+      
+      # Converts from db versions < 0.0.6 to the structure introduced in version 0.0.7
+      def autoConvert()
+        puts "autoConvert Method executing"
+        convertedDB = {"version" => UsefulDB::Version.to_s, "db" => @data}
+        
+        convertedDB["db"].each do |element|
+          element["description"] = "nil"
+        end
+        
+        @data = convertedDB
+      end
+      
+      
+      # Convert the db from versions lower than the latest version of usefuldb to the latest version
+      def autoUpgrade()
+        puts "autoUpgrade Method executing"
+        @data["version"] = UsefulDB::Version.to_s
+      end
+      
     end
   end
 

data/lib/usefuldb/utilities.rb

@@ -42,25 +42,25 @@ module UsefulDB
       
       # Return the number of elements in the database.
       def count()
-        if @data.count == 0
+        if @data["db"].count == 0
           raise EmptyDB, "The DB is currently empty."
         else
-          return @data.count
+          return @data["db"].count
         end
       end
       
       
       # Add an element to the database
       def add(hash, opts)
-        if @data.include?(hash) then raise EntryInDB, "Entry already in the DB"; else @data << hash; end    
+        if @data["db"].include?(hash) then raise EntryInDB, "Entry already in the DB"; else @data["db"] << hash; end    
       end
   
       
       # Remove an element from the database
       def remove(key, opts)
-        if @data.count == 0
+        if @data["db"].count == 0
           raise EmptyDB, "You cannot call the remove function on an empty Database!"
-        elsif @data.count <= key || key < 0
+        elsif @data["db"].count <= key || key < 0
           raise KeyOutOfBounds, "Key is out of bounds and therefore does not exist in the DB"
         else
           @data.delete_at(key) 
@@ -86,10 +86,11 @@ module UsefulDB
       def search(tag)
         msg = "Searching the database for tag: " + tag + "\n"
         
-        @data.each do |db|
+        @data["db"].each do |db|
           if db["tag"].include?(tag)
             msg += "- Tags: " + array_to_s(db["tag"]) + "\n"
-            msg += "- Value: " + db["value"] + "\n##\n"
+            msg += "- Value: " + db["value"] + "\n"
+            msg += "- Description: " + db["description"] +"\n##\n"
           end
         end
         return msg
@@ -98,7 +99,7 @@ module UsefulDB
       
       # List out all elements in the DB
       def list
-        return @data
+        return @data["db"]
       end
 
 

data/lib/usefuldb/version.rb

@@ -7,7 +7,7 @@ module UsefulDB
       
       MAJOR = 0 unless defined? MAJOR
       MINOR = 0 unless defined? MINOR
-      PATCH = 6 unless defined? PATCH
+      PATCH = 7 unless defined? PATCH
 
       def to_s
         [MAJOR, MINOR, PATCH].compact.join('.')

data/resources/db.yaml

@@ -1,13 +1,42 @@
 ---
-- tag:
-  - install
-  - rubygems
-  - website
-  - usefuldb
-  value: http://rubygems.org/usefuldb
-- tag:
-  - search
-  - find
-  - website
-  - google
-  value: http://www.google.com
+version: 0.0.7
+db:
+  - tag:
+    - install
+    - rubygems
+    - website
+    - usefuldb
+    value: http://rubygems.org/usefuldb
+    description: Website URL for the usefuldb gem
+  - tag:
+    - search
+    - find
+    - website
+    - google
+    value: http://www.google.com
+    description: Google a major search engine
+  - tag:
+    - git
+    - add
+    value: git add <path>
+    description: Requesting git add files to the current git branch
+  - tag:
+    - git
+    - commit
+    value: git commit -m 'commit message'
+    description: Committing the files along with a commit message to the current git branch
+  - tag:
+    - git
+    - push
+    value: git push origin <branch>
+    description: Requesting git upload the commited changes to the remote branch
+  - tag:
+    - git
+    - merge
+    value: git merge --no-ff <branch>
+    description: Command to merge the specified branch into the current branch
+  - tag:
+    - git
+    - checkout
+    value: git checkout <branch>
+    description: Checkout the specified branch

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: usefuldb
 version: !ruby/object:Gem::Version
-  version: 0.0.6
+  version: 0.0.7
   prerelease: 
 platform: ruby
 authors: