rmvc 3.2.2 → 3.2.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 9d4e4bceef13fca18437aa0b18de3457c56a80ab
-  data.tar.gz: 4f80cc89a312d1723be2edf45ef9a8d82a3bf25a
+  metadata.gz: 5b9a00c8b673dc9d20c8b70a9eb930333680065d
+  data.tar.gz: aa7ca06e4233ba40712f5044ddac6d81689c5a6d
 SHA512:
-  metadata.gz: 9d7abc41f45e121812b893504649c43d818cfd58f55a685940adfe4ad665322e6a72cb6cdf86614f2c490021c4c513fad662e56725a75d29d84df01ecab7edd8
-  data.tar.gz: 8c8719877384d8c7666a9879e21d5efbaac6552c3eb25f7e1473583855b917c11ab4531e6a3e3d5b2f9b90c73847db2dfe093d6f4196610a7a3cb2b56c20c962
+  metadata.gz: 4ac91805f0be4f05220af223e5a11d6b254e028b236aac62c7457de8e6198abbb7275e0e09c68037563e621602531a40b4984cd2c3cfeb5a1e90b5098cfd9aed
+  data.tar.gz: 9aadac152c713ca89d92246a75457227240595e5f3570a884524541d265b6f3d82d70a80eadd974d1ec99d983c534c2299e0ccc14a417a72e3965907b5ce39f6

data/lib/rmvc/migrations.rb

@@ -1,17 +1,29 @@
 #!/usr/bin/env ruby
 require 'colorize'
 require 'sqlite3'
+
+# We're in the RMVC module.
 module RMVC
-# Migration: an object to assist database creation
+
+  # Class: Migration
+  # Contains a RMVC migration
   class Migration
-    # Init (create or open database)
+
+    # @dbr: resource referencing to the database connection
     attr_accessor :dbr
+
+    # Method: constructor
+    # Arguments: database (string) - name of the migration's database
+    # Starts the @dbr connection, creates it if the file doesn't exist
     def initialize(database)
+
       if File.exists?("./db/" + database + ".db")
         puts "database #{database} already exists. opening...".green
         @dbr = SQLite3::Database.open("./db/" + database + ".db")
+
       else
         puts "database #{database} not found. creating database...".yellow
+
         begin
           @dbr = SQLite3::Database.new("./db/" + database + ".db")
           puts "database #{database} successfully created.".green
@@ -19,14 +31,17 @@ module RMVC
           puts "couldn't create database. aborting...".red
           exit
         end
+
       end
     end
 
-    # create table
+    # Method: create_table
+    # Arguments: table (string)
+    # Creates a table in the database
     def create_table(table)
       puts "attempting to create table #{table}..."
       begin
-        tt = @dbr.prepare("CREATE TABLE #{table}(id int auto_increment);")
+        tt = @dbr.prepare("CREATE TABLE #{table}(id INTEGER PRIMARY KEY);")
         ee = tt.execute
         puts "table created correctly.".green
       rescue
@@ -35,7 +50,9 @@ module RMVC
       end
     end
 
-    # drop a table
+    # Method: drop_table
+    # Arguments: table (string)
+    # Removes a table of the database
     def drop_table(table)
       puts "attempting to drop table #{table}..."
       begin
@@ -47,7 +64,10 @@ module RMVC
       end
     end
     
-    # add column
+    # Method: add_column
+    # Arguments: table(string) - table name
+    #            cname(string) - name of the column
+    #            type(:text, :num, string) - type of the column
     def add_column(table, cname, type)
       if type.to_s == "text"
         puts "attempting to create text column #{cname} at #{table}..."
@@ -59,6 +79,7 @@ module RMVC
           puts "error while adding column #{cname} to #{table}".red
           exit
         end
+
       elsif type.to_s == "num"
         puts "attempting to create numerical column #{cname} at #{table}..."
         begin
@@ -69,6 +90,7 @@ module RMVC
           puts "error while adding column #{cname} to #{table}".red
           exit
         end
+
       else
         puts "attempting to create custom (#{type.to_s}) column #{cname} at #{table}..."
         begin
@@ -82,8 +104,10 @@ module RMVC
       end
     end 
 
-    # Insert values into table WHERE columns = ["column1", "column2"]
-    # AND values = ["value1", "value2"]
+    # Method: insert
+    # Arguments: table(string) - table name
+    #            columns([string, ]) - columns where data will be inserted
+    #            values([string|int|other, ]) - values to be inserted 
     def insert(table, columns, values)
       puts "attempting to insert values into #{table}..."
         begin

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rmvc
 version: !ruby/object:Gem::Version
-  version: 3.2.2
+  version: 3.2.3
 platform: ruby
 authors:
 - unrar
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-08-14 00:00:00.000000000 Z
+date: 2015-08-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: colorize