gembase 0.1.0.pre → 0.5.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8dd465d6cc50ca0cd8e22abe6e2492ae48931b9385128e44a22074e32e552d45
-  data.tar.gz: a9cce23e99f98136c983f9d08c4fc0bcf7875b995851ec3fafab2512cf93d228
+  metadata.gz: deb4dbb31cbfe652b4ac768e296bcede2ffdbc19473850786808ec3d34d9a6c6
+  data.tar.gz: af22f113ecff87ed52020d9165db3bb153e72b81477cbe39c700a135afad7e79
 SHA512:
-  metadata.gz: b669c63f19426afc153c6bd1a2a3063df1301afd702e607db83556db62544f5a53378730eff8d2e3b0187ca34401c11ae2f063fae126c7cc55e5ea1dd8fd28ce
-  data.tar.gz: 371b128e7b32b2c422b4bc058c6d26987655ff20940d4fb4edafac630fc07b7a50e0e0d42876c17faecadecf9afd926ce2b5680ce888acd827f520c6c94d23f8
+  metadata.gz: c0322593fc697d8c40458351f9d512bddccce4e127b94a2f2bbfd4fb06c41aded132e9dc3813dd90774d6bd2454da4b660dd1be359b24fa28283c6ca322ae9c0
+  data.tar.gz: ac2893bae265dbe20e69a9f4eaff05010916ec6c5291a37de3cc52cccee30a785ae8ff4b93c8ee38a2ed6d4b6d023b489c19b5fbe23f4adaffa1930b1ac25f82

data/lib/main.rb

@@ -1,24 +1,245 @@
 #!usr/bin/env ruby
-# ScriptHub | Gembase - Ruby DataBase
+# NTBBloodbath | Gembase - Ruby DataBase
 
-require 'fileutils' # Requires fileutils gem
-require 'yaml' # Requires yaml gem
+require 'yaml'
 
-module Gembase # Main DataBase Module
-  def Gembase.create_db(name) # Create_db method
-    raise "name must be an String" until name.is_a?(String) # Error if name isn't an String
-    @name = name # Set instamce variable name as name
-    FileUtils.touch("#{name}.rudb") # Create database file
+# @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
+  #
+  # @example Create a DB called example
+  #   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
 
-  def Gembase.create_category(category) #Create_category method
-    raise "category must be an String" until category.is_a?(String) # Error if category isn't an String
-    # YAML Structure (cat_name) ↓
-    cat_name = {
-      "#{category}": [{}]
+  # @!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
+  #
+  # @example Creating the users category
+  #   create_category("example", "users")
+  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)
+
+    category_name = {
+      "#{category}" => {}
     }
-    File.open("#{@name}.rudb", "r+") do |f| # Open DataBase file
-      f.write(cat_name.to_yaml) # Write changes to DataBase file
+
+    File.open("#{db}.rudb", "a+") do |f|
+      f.write(category_name.to_yaml)
     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
+  #
+  # @example Creating a premium nested category
+  #   nested_category("example", "users", "premium")
+  #
+  # @since 0.5.0
+  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)
+    raise "nested_category must be an String" until nested_category.is_a?(String)
+
+    @database = File.open("#{db}.rudb")
+    @data = YAML.load(@database)
+    @data["#{parent_category}"].store("#{nested_category}", "{}")
+    @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
+  #
+  # @example Add object "bloodbath" with value "premium"
+  #   add_object("example", "users", "bloodbath", "premium")
+  #
+  # @deprecated Use {#create_object-class_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)
+    raise "key must be an String" until key.is_a?(String)
+
+    puts "WARNING | add_object Method is deprecated. Please use create_object Method instead."
+    @database
+    @data
+    @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_object("example", "server", "localhost:8080")
+  #
+  # @example 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("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)
+	raise "key must be an String" until key.is_a?(String)
+    
+    if category.to_s.length == 0
+      @database
+      @data
+      @data.store("#{key}", "#{value}")
+      @save
+    else
+      raise "category must be an String" until category.is_a?(String)
+      if subcategory.to_s.length == 0
+        @database
+        @data
+        @data["#{category}"].store("#{key}", "#{value}")
+        @save
+      else
+        raise "subcategory must be an String" until subcategory.is_a?(String)
+        @database
+        @data
+        @data["#{category}"]["#{subcategory}"].store("#{key}", "#{value}")
+        @save
+      end
+    end
+  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
+  #
+  # @example Deleting object inside a category
+  #   delete_object("example", "users-limit", "users")
+  #
+  # @ example Deleting object inside a subcategory
+  #   delete_object("example", "bloodbath", "users", "premium")
+  #
+  # @example 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.
+  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.
+      @database
+      @data
+      @data.delete("#{key}")
+      File.open("#{db}.rudb", "w+") do |f|
+        f.write(@data.to_yaml)
+      end
+    else
+      if subcategory.to_s.length == 0 # If there's no subcategory argument declared.
+        raise "category must be an String" until category.is_a?(String)
+        @database
+        @data
+        @data["#{category}"].delete("#{key}")
+        File.open("#{db}.rudb", "w+") do |f|
+          f.write(@data.to_yaml)
+        end
+      else
+        raise "subcategory must be an String" until subcategory.is_a?(String)
+        @database
+        @data
+        @data["#{category}"]["#{subcategory}"].delete("#{key}")
+        File.open("#{db}.rudb", "w+") do |f|
+          f.write(@data.to_yaml)
+        end
+      end
+    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
+  #
+  # @example 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_object("example", "users-limit", "10", "users")
+  #
+  # @example Change key bloodbath value from true to false into premium subcategory
+  #   change_object("example", "bloodbath", false, "users", "category")
+  #
+  # @since 0.5.0
+  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)
+
+    if category.to_s.length == 0
+      @database
+      @data
+      @data["#{key}"] = new_value
+      @save
+    else
+      raise "category must be an String" until category.is_a?(String)
+      if subcategory.to_s.length == 0
+        @database
+        @data
+        @data["#{category}"]["#{key}"] = new_value
+        @save
+      else
+        raise "subcategory must be an String" until subcategory.is_a?(String)
+        @database
+        @data
+        @data["#{category}"]["#{subcategory}"]["#{key}"] = new_value
+        @save
+      end
+    end
+  end
+
+  # @!method parse(db)
+  #   Parse the DataBase structure to modify it
+  #   @param db [String] the name of your DataBase file
+  #
+  # @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).
+  def Gembase.parse(db)
+    raise "db must be an String" until db.is_a?(String)
+
+    @database
+    @data
+  end
+
+  # @!method regenerate(db)
+  #   Regenerate the DataBase stucture to YAML structure
+  #   @param db [String] the name of your DataBase file
+  #
+  # @example Regenerating the DB called "example"
+  #   regenerate("example")
+  def Gembase.regenerate(db)
+    raise "db must be an String" until db.is_a?(String)
+
+    @database
+    @data.to_yaml
+  end
 end

metadata

@@ -1,21 +1,19 @@
 --- !ruby/object:Gem::Specification
 name: gembase
 version: !ruby/object:Gem::Version
-  version: 0.1.0.pre
+  version: 0.5.1
 platform: ruby
 authors:
-- MagicNeko15 (NTB Bloodbath)
-- Laauuu
+- NTB Bloodbath
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-11-02 00:00:00.000000000 Z
+date: 2020-02-08 00:00:00.000000000 Z
 dependencies: []
 description: Gembase is a database gem for Ruby. Very powerful, simple and effective
   based on YAML.
 email:
 - bloodbathalchemist@protonmail.com
-- lauywe23@gmail.com
 executables: []
 extensions: []
 extra_rdoc_files: []
@@ -25,7 +23,8 @@ homepage: https://rubygems.org/gems/gembase
 licenses:
 - MIT
 metadata:
-  source_code_uri: https://github.com/MagicNeko15/Gembase
+  source_code_uri: https://github.com/NTBBloodbath/Gembase
+  documentation_uri: https://rubydoc.info/github/NTBBloodbath/Gembase/master/index
 post_install_message: 
 rdoc_options: []
 require_paths:
@@ -34,15 +33,15 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 2.6.0preview2
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">"
+  - - ">="
     - !ruby/object:Gem::Version
-      version: 1.3.1
+      version: '0'
 requirements: []
-rubygems_version: 3.0.6
+rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
-summary: Gembase is a database gem for Ruby.
+summary: Gembase is a database gem based on YAML for Ruby.
 test_files: []