gembase 0.5.2 → 0.5.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6162f13c419f3668dc222f1c140e4b0d77c92b2510209f9b367c36f5479bf3dc
-  data.tar.gz: a2f94a615514edd090ec5a636ca8d896ebfe8cb7ec7ae0875545857be9fe257b
+  metadata.gz: 4b2075c49a96fb7cfb47f1b1dcc0ce4990426d34899dbe5a6fb4e26bb3d89624
+  data.tar.gz: 7fe0747e86e9a39a03ad3aaf437ff26eeccac21fbbb5965759bc5caa2f54c6ea
 SHA512:
-  metadata.gz: 97f1064ed4aebc48e195e791c6e790b97c8b211997cc4efc573fd3af8705bdf4e7925dbfcccba997b7df1b3c008f95d863fdb69f541e843abfa5ab8f4ff31362
-  data.tar.gz: '080daf2ba39dddde40fc0f2faa6c109e594fa720e008c677871efa0ad2565b28b73f9cc8440d25890dd866b8e045b3d41720df16ebec959340c60b50c5a524d5'
+  metadata.gz: d318c786331cbfa72a0126dad32ae42197a62358ed1caaeee2ea7351ce41df3df366831f3ad67f7b5a2c45b2da05df8b0c94534875fa7b83ea56fda76892de52
+  data.tar.gz: e664207015a063c5d81c4721baf506e5ed737ebd579ab5baa8470f97dc7d9d112d7492ad8b8961c8df16b85b444fd6288fff5bf7ad07848bba16eadfbc2a80db

data/lib/main.rb

@@ -2,28 +2,25 @@
 # NTBBloodbath | Gembase - Ruby DataBase
 
 require 'yaml'
+require 'fileutils'
 
 # @author NTBBloodbath
 module Gembase
 
-  # @!method create_db(name) {https://asciinema.org/a/l8CbUREGwZScWN2XJXv2lsTHt}
-  #   Create a new DataBase file with the given name
-  #   @param name [String] the name for your DataBase file
+  # Create a new DataBase file with the given name.
+  # name must be an String.
   #
-  # @example Create a DB called example
-  #   create_db("example") #=> "example.rudb"
+  # create_db("example") #=> "example.rudb"
   def Gembase.create_db(name)
     raise "name must be an String" until name.is_a?(String)
     FileUtils.touch("#{name}.rudb")
   end
 
-  # @!method create_category(db, category) {https://asciinema.org/a/Chz5eeUJdjFl8I07Lq4hY4X8y}
-  #   Create a new Category inside our DataBase
-  #   @param db [String] the name of your DataBase file
-  #   @param category [String] the name of your category
+  # Create a new Category inside our DataBase
+  # db must be an String.
+  # category must be an String.
   #
-  # @example Creating the users category
-  #   create_category("example", "users")
+  # create_category("example", "foo")
   def Gembase.create_category(db, category)
     raise "db must be an String" until db.is_a?(String)
     raise "category must be an String" until category.is_a?(String)
@@ -37,16 +34,12 @@ module Gembase
     end
   end
 
-  # @!method nested_category(db, parent_category, nested_category)
-  #   Create a new nested category
-  #   @param db [String] the nme of your DataBase file
-  #   @param parent_category [String] the name of your parent category
-  #   @param nested_category [String] the name of the nested category
+  # Create a new nested category
+  # db must be an String.
+  # parent_category must be an String.
+  # nested_category must be an String.
   #
-  # @example Creating a premium nested category
-  #   nested_category("example", "users", "premium")
-  #
-  # @since 0.5.0
+  # nested_category("example", "foo", "bar")
   def Gembase.nested_category(db, parent_category, nested_category)
     raise "db must be an String" until db.is_a?(String)
     raise "parent_category must be an String" until parent_category.is_a?(String)
@@ -58,17 +51,15 @@ module Gembase
     @save = File.write(@database, @data.to_yaml)
   end
 
-  # @!method add_object(db, category, key, value)
-  #   Create an object inside a category
-  #   @param db [String] the name of your DataBase file
-  #   @param category [String] the name of your category
-  #   @param key [String] the key name of your object
-  #   @param value [String, Integer, Boolean] the value of your key
+  # Create an object inside a category
+  # db must be an String.
+  # category must be an String.
+  # key must be an String.
+  # value can be String, Integer or Boolean.
   #
-  # @example Add object "bloodbath" with value "premium"
-  #   add_object("example", "users", "bloodbath", "premium")
+  # add_object("example", "users", "bloodbath", "premium")
   #
-  # @deprecated Use {#create_object-class_method} instead.
+  # [DEPRECATED] Use create_object Method instead.
   def Gembase.add_object(db, category, key, value)
     raise "db must be an String" until db.is_a?(String)
     raise "category must be an String" until category.is_a?(String)
@@ -80,21 +71,20 @@ module Gembase
     @data["#{category}"].store("#{key}", "#{value}")
   end
   
-  # @!method create_object(db, key, value, category=nil, subcategory=nil)
-  #   Create an object outside a category
-  #   @param db [String] the name of your DataBase file
-  #   @param key [String] the key name of your object
-  #   @param value [String, Integer, Boolean] the value of your key
-  #   @param category [String] the name of your category
-  #   @param subcategory [String] the name of your subcategory
-  #
-  # @example Create object "server" with value "localhost:8080". Without categories.
+  # Create an object outside a category
+  # db must be an String.
+  # key must be an String.
+  # value can be String, Integer or Boolean.
+  # category must be an String.
+  # subcategory must be an String.
+  #
+  # Create object "server" with value "localhost:8080". Without categories.
   #   create_object("example", "server", "localhost:8080")
   #
-  # @example Create object "users-limit" with value 5 in "users" category.
+  # Create object "users-limit" with value 5 in "users" category.
   #   create_object("example", "users-limit", 5, "users")
   #
-  # @example Create object "bloodbath" with value true in "premium" subcategory.
+  # Create object "bloodbath" with value true in "premium" subcategory.
   #   create_object("example", "bloodbath", true, "users", "premium")
   def Gembase.create_object(db, key, value, category=nil, subcategory=nil)
 	raise "db must be an String" until db.is_a?(String)
@@ -123,27 +113,27 @@ module Gembase
   end
 
   # @!method delete_object(db, key, category=nil, subcategory=nil)
-  #   Delete an object inside/outside a category.
-  #   @param db [String] the name of your DataBase file
-  #   @param key [String] the key name of your object
-  #   @param category [String] the name of your category
-  #   @param subcategory [String] the name of your subcategory
+  #   Delete an object inside/outside a category and subcategory.
+  # db must be an String.
+  # key must be an String.
+  # category must be an String.
+  # subcategory must be an String.
   #
-  # @example Deleting object inside a category
+  # Deleting object inside a category
   #   delete_object("example", "users-limit", "users")
   #
-  # @ example Deleting object inside a subcategory
+  # Deleting object inside a subcategory
   #   delete_object("example", "bloodbath", "users", "premium")
   #
-  # @example Deleting object outside a category
+  # Deleting object outside a category
   #   delete_object("example", "server")
   #
-  # @note Category is an optional parameter. Use this only when you want to delete an object inside a category.
+  # Note: Category and subcategory are an optional parameters. Use them only when you want to delete an object inside a category or subcategory.
   def Gembase.delete_object(db, key, category=nil, subcategory=nil)
     raise "db must be an String" until db.is_a?(String)
     raise "key must be an String" until key.is_a?(String)
 
-    if category.to_s.length == 0 # If there's no category argument declared.
+    if category.to_s.length == 0
       @database
       @data
       @data.delete("#{key}")
@@ -151,7 +141,7 @@ module Gembase
         f.write(@data.to_yaml)
       end
     else
-      if subcategory.to_s.length == 0 # If there's no subcategory argument declared.
+      if subcategory.to_s.length == 0
         raise "category must be an String" until category.is_a?(String)
         @database
         @data
@@ -171,24 +161,23 @@ module Gembase
     end
   end
 
-  # @!method change_object(db, key, new_value, category=nil, subcategory=nil)
-  #   Change the value of an existing object
-  #   @param db [String] the name of your DataBase file
-  #   @param key [String] the key name of your object
-  #   @param new_value [String,Integer, Boolean] the new value of your key
-  #   @param category [String] the name of your category
-  #   @param  subcategory [String] the name of your subcategory
+  # Change the value of an existing object
+  # db must be an String.
+  # key must be an String.
+  # new_value can be String, Integer or Boolean.
+  # category must be an String.
+  # subcategory must be an String.
   #
-  # @example Change key server value from localhost:8080 to example_host.com outside categories
+  # Change key server value from localhost:8080 to example_host.com outside categories
   #   change_object("example", "server", "example_host.com")
   # 
-  # @example Change key users-limit value from 5 to 10 into users category
+  # Change key users-limit value from 5 to 10 into users category
   #   change_object("example", "users-limit", "10", "users")
   #
-  # @example Change key bloodbath value from true to false into premium subcategory
+  # Change key bloodbath value from true to false into premium subcategory
   #   change_object("example", "bloodbath", false, "users", "category")
   #
-  # @since 0.5.0
+  # Note: Category and subcategory are an optional parameters. Use them only when you want to modify an object inside a category or subcategory.
   def Gembase.change_object(db, key, new_value, category=nil, subcategory=nil)
     raise "db must be an String" until db.is_a?(String)
     raise "key must be an String" until key.is_a?(String)
@@ -215,14 +204,13 @@ module Gembase
     end
   end
 
-  # @!method parse(db)
-  #   Parse the DataBase structure to modify it
-  #   @param db [String] the name of your DataBase file
+  # Parse the Database structure to modify it
+  # db must be an String.
   #
-  # @example Parsing the DB called "example"
+  # Parsing the DB called "example"
   #   parse("example")
   #
-  # @note You can use these two methods (parse and generate) instead of YAML vanilla methods (load and to_yaml).
+  # Note: You can use these two methods (parse and generate) instead of YAML vanilla methods (load and to_yaml).
   def Gembase.parse(db)
     raise "db must be an String" until db.is_a?(String)
 
@@ -230,11 +218,10 @@ module Gembase
     @data
   end
 
-  # @!method regenerate(db)
-  #   Regenerate the DataBase stucture to YAML structure
-  #   @param db [String] the name of your DataBase file
+  # Regenerate the Database stucture to YAML structure
+  # db must be an String.
   #
-  # @example Regenerating the DB called "example"
+  # Regenerating the DB called "example"
   #   regenerate("example")
   def Gembase.regenerate(db)
     raise "db must be an String" until db.is_a?(String)

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: gembase
 version: !ruby/object:Gem::Version
-  version: 0.5.2
+  version: 0.5.3
 platform: ruby
 authors:
 - NTB Bloodbath