sinatra-monk 0.0.8 → 0.0.9

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: adb6107dab9b741150f7b27cdd1d117747384816
-  data.tar.gz: 827bd3d7689803a6df5e1a0509ddc161b387712d
+  metadata.gz: a53615c0d27d013975e9c0fed1378d3f9a3bc5c2
+  data.tar.gz: 3f6bcadaf0cb1471dea96280a792daac7733bb67
 SHA512:
-  metadata.gz: 0fb87d0466fcffb17d5048e9c65bed64e0e8129cce80573a3e8c229d53328b7b2c25b3ebbd244eb3503b4ab9e729a6e520374f705e03ce388ca417f82559a2dc
-  data.tar.gz: 9e8584f65f88d31da5ad0794954c57222a5baa91f3d7e6002d1712d7d218cd98e9f475e3a78c4947cabbeee8000f862ca5bbadaa59b48c651cb746473977f025
+  metadata.gz: 563438d4304e56b7a4095e2c545ee670a418062575820b00f47d5409feeb73c127c9082a8a6ca5b7373baf6cdd6626097f110eed81a8482834a24e03835513f9
+  data.tar.gz: 1becfb4d9d65ee3d7e3a73d890c7be50d8696b17df3b48e506eac5142c329031a188a615e385e462d6aa4e0316ded74f4a852b41359f9a42a304f6177846501e

data/lib/sinatra-monk.rb

@@ -24,4 +24,4 @@
 ##
 
 require 'sinatra-monk/base'
-require 'sinatra-monk/2.0' if RUBY_VERSION.chr == '2'
+require 'sinatra-monk/2.0' if RUBY_VERSION.chr == '2'

data/lib/sinatra-monk/2.0.rb

@@ -29,29 +29,68 @@ require 'sinatra-monk/base'
 
 module Sinatra
   module Monk
+    # Provides a base class for Mongo database management. This is the simplest way
+    # to connect to Mongo with Monk. It is intented to keep Sinatra's philosofy of
+    # keeping it as simple as possible for use.
     class MBase
-      # monk base class args are fully optional
+      # Aliased initialize method, made to add Ruby 2.0 version.
       alias _ol_initialize initialize
+
+      # (Ruby 2.x) Setup the Monk with the data that was sent.
+      # Autoconnect if :connect flag is true.
+      # @param user [String] the database username,
+      # @param pass [String] the password of the previous database user,
+      # @param database [String] the name of the database,
+      # @param host [String] the host of the database,
+      # @param port [Fixnum] the port to connect to the database,
+      # @param opts [Hash] monk options (set :conect to autoconnect the Monk)
       def initialize(user:'', pass:'', database:'local', host:'localhost',
                      port:27017, opts:{:connect => false})
         _ol_initialize(user, pass, database, host, port, opts)
       end
     end
 
-    class HBase
-      # monk base class args are fully optional
+    # A type of Monk that acts like a Hash, it was made to look very native.
+    # It still need some improvement.
+    class MHash
+      # Aliased initialize method, made to add Ruby 2.0 version.
       alias _ol_initialize initialize
+      # (Ruby 2.x) Differently from MBase, MHash enforce autoconnect.
+      # @param name [String] name of the used/created collection,
+      # @param user [String] the database username,
+      # @param pass [String] the password of the previous database user,
+      # @param database [String] the name of the database,
+      # @param host [String] the host of the database,
+      # @param port [Fixnum] the port to connect to the database,
+      # @param opts [Hash] monk options (set :conect to autoconnect the Monk)
       def initialize(name:'monk', user:'', pass:'', database:'local', host:'localhost',
                      port:27017, opts:{:connect => false})
         _ol_initialize(name, user, pass, database, host, port, opts)
       end
     end
 
+    # (Ruby 2.x) A helper that create a MBase instance.
+    # @param user [String] the database username,
+    # @param pass [String] the password of the previous database user,
+    # @param database [String] the name of the database,
+    # @param host [String] the host of the database,
+    # @param port [Fixnum] the port to connect to the database,
+    # @param opts [Hash] monk options (set :conect to autoconnect the Monk)
+    # @return [MBase] the Monk instance.
     def monk(user:'', pass:'', database:'local', host:'localhost',
              port:27017, opts:{:connect => false})
       return MBase.new(user, pass, database, host, port, opts)
     end
 
+    # (Ruby 2.x) A helper that create a MHash instance.
+    # @param name [String] name of the used/created collection,
+    # @param user [String] the database username,
+    # @param pass [String] the password of the previous database user,
+    # @param database [String] the name of the database,
+    # @param host [String] the host of the database,
+    # @param port [Fixnum] the port to connect to the database,
+    # @param opts [Hash] monk options (set :save to autosave after each change)
+    # @return [MHash] the Monk instance.
     def hmonk(name:'monk', user:'', pass:'', database:'local', host:'localhost',
               port:27017, opts:{:connect => false})
       return MHash.new(name, user, pass, database, host, port, opts)

data/lib/sinatra-monk/base.rb

@@ -22,5 +22,6 @@
 # a standard way to require monk cross compatible
 # monk (between 2x and 19x series)
 ##
+
 require 'sinatra-monk/monk'
-require 'sinatra-monk/helpers'
+require 'sinatra-monk/helpers'

data/lib/sinatra-monk/helpers.rb

@@ -28,11 +28,28 @@ require 'sinatra/base'
 
 module Sinatra
   module Monk
+    # (Any Ruby) A helper that create a MBase instance.
+    # @param user [String] the database username,
+    # @param pass [String] the password of the previous database user,
+    # @param database [String] the name of the database,
+    # @param host [String] the host of the database,
+    # @param port [Fixnum] the port to connect to the database,
+    # @param opts [Hash] monk options (set :conect to autoconnect the Monk)
+    # @return [MBase] the Monk instance.
     def monk user = '', pass = '', database = 'local', host = 'localhost',
              port = 27017, opts = {:connect => false}
       return MBase.new(user, pass, database, host, port, opts)
     end
 
+    # (Any Ruby) A helper that create a MHash instance.
+    # @param name [String] name of the used/created collection,
+    # @param user [String] the database username,
+    # @param pass [String] the password of the previous database user,
+    # @param database [String] the name of the database,
+    # @param host [String] the host of the database,
+    # @param port [Fixnum] the port to connect to the database,
+    # @param opts [Hash] monk options (set :save to autosave after each change)
+    # @return [MHash] the Monk instance.
     def hmonk name = 'monk', user = '', pass = '', database = 'local',
               host = 'localhost', port = 27017, opts = {:save => true}
       return MHash.new(name, user, pass, database, host, port, opts)

data/lib/sinatra-monk/monk.rb

@@ -27,12 +27,19 @@ require 'mongo'
 
 module Sinatra
   module Monk
-    # Base provides a base class for mongo database management it is the simplest way
-    # to connect to it. It is intented to keep sinatra's philosofy of keeping it simple
+    # Provides a base class for Mongo database management. This is the simplest way
+    # to connect to Mongo with Monk. It is intented to keep Sinatra's philosofy of
+    # keeping it as simple as possible for use.
     class MBase
       attr_reader :client, :database, :username, :password
 
-      # monk base class args are fully optional
+      # (Any Ruby) Setup the Monk with the data that was sent. Autoconnect if :connect flag is true.
+      # @param user [String] the database username,
+      # @param pass [String] the password of the previous database user,
+      # @param database [String] the name of the database,
+      # @param host [String] the host of the database,
+      # @param port [Fixnum] the port to connect to the database,
+      # @param opts [Hash] monk options (set :conect to autoconnect the Monk)
       def initialize user = '', pass = '', database = 'local', host = 'localhost',
                      port = 27017, opts = {:connect => false}
         # these data can't just be changed runtime
@@ -48,14 +55,20 @@ module Sinatra
         connect if opts[:connect]
       end
 
+      # Closes the connection with the server, you MAY NOT TRY to alter the collection while
+      # in that state.
       def close
         @client.close
       end
 
+      # Returns the Monk connection state.
       def connected?
         return @client.connected?
       end
 
+      # Conects the Monk to Mongo.
+      # @param user [String] the database username,
+      # @param pass [String] the password of the previous database user.
       def connect user = @username, pass = @password
         return true if connected?
         @client.connect
@@ -65,28 +78,32 @@ module Sinatra
       end
     end
 
-    # Monk::Hash is a Monk that acts like a Hash, it
-    # was made to look very native.
+    # A type of Monk that acts like a Hash, it was made to look very native.
+    # It still need some improvement.
     class MHash < MBase
       attr_reader :local, :name, :collection
       attr_accessor :sync
 
-      class InexistentKey < StandardError
-      end
-
-      # force to connect
+      # (Any Ruby) Differently from MBase, MHash enforce autoconnect.
+      # @param name [String] name of the used/created collection,
+      # @param user [String] the database username,
+      # @param pass [String] the password of the previous database user,
+      # @param database [String] the name of the database,
+      # @param host [String] the host of the database,
+      # @param port [Fixnum] the port to connect to the database,
+      # @param opts [Hash] monk options (set :conect to autoconnect the Monk)
       def initialize name = 'monk', user = '', pass = '', database = 'local',
-        host = 'localhost', port = 27017, opts = {:save => true}
+        host = 'localhost', port = 27017, opts = {:sync => true}
         # forced premature connection (option override)
         opts[:connect]= true
 
         # HashMonk special data
-        @name        = name         # collection name
-        @sync        = opts[:save]  # autosave collection
-        @local       = Hash.new     # local information
+        @name         = name         # collection name
+        @sync         = opts[:sync]  # autosave collection
+        @local        = Hash.new     # local information
 
         # need update flag (writes local data to db)
-        @need_sync   = false
+        @need_sync    = false
 
         # build our monk
         super host, port, user, pass, opts
@@ -94,40 +111,7 @@ module Sinatra
         install if connect
       end
 
-      # install the collection in the database
-      # (may not install if already exists)
-      private
-      def install
-        if @database.collection_names.include? @name
-          # setup for use existent collection
-          @collection = @database[@name].find_one({'name'=>@name})
-        else
-          # install collection
-          @database.create_collection @name
-          @database[@name].insert([{'name' => @name,
-                                           'content' => {}}])
-          @collection = @database[@name].find_one({'name'=>@name})
-          need_sync!
-        end
-      end
-
-      def connect user = @username, pass = @password
-        return true if connected?
-        @client.connect
-        @username  = user
-        @password  = pass
-        return @database.authenticate @username, @password
-      end
-
-      # setup for sync
-      def need_sync!
-        @need_sync = true
-        sync if @sync # autosync
-      end
-
-      public
-      # save data, may be called automagically
-      # if autosave mode is on
+      # Sync the local collection with the remote one.
       def sync
         if @need_sync
           @database[@name].save(@collection)
@@ -137,19 +121,24 @@ module Sinatra
         return false
       end
 
-      # return true if db need to sync
+      # Returns true if collection need synchronization.
       def need_sync?
         return @need_sync
       end
 
+      # Returns true if collection has a key.
+      # @param key [String] the key.
       def include?(key)
         return @collection['content'].has_key? key
       end
 
+      # Returns the collection inspect data.
       def inspect
         return @collection['content'].inspect
       end
 
+      # Delete a key from the collection.
+      # @param key [String] the key.
       def delete(key)
         raise TypeError, "#{key} can't be coerced into String" unless key.is_a? String
         if @collection['content'].has_key? key
@@ -160,17 +149,44 @@ module Sinatra
         return false
       end
 
+      # Gives read access to a key in the collection.
+      # @param key [String] the key.
       def [](key)
         raise TypeError, "#{key} can't be coerced into String" unless key.is_a? String
         return @collection['content'][key] if @collection['content'].has_key? key
         raise InexistentKey, "Field #{key} not found."
       end
 
+      # Gives write access to a key in the collection.
+      # @param key [String] the key.
       def []=(key, value)
         raise TypeError, "#{key} can't be coerced into String" unless key.is_a? String
         @collection['content'][key] = value
         need_sync!
       end
+
+      private
+      # Install the collection in the database (may not install if already exists,
+      # in that case it just uses it).
+      def install
+        if @database.collection_names.include? @name
+          # setup for use existent collection
+          @collection = @database[@name].find_one({'name'=>@name})
+        else
+          # install collection
+          @database.create_collection @name
+          @database[@name].insert([{'name' => @name,
+                                           'content' => {}}])
+          @collection = @database[@name].find_one({'name'=>@name})
+          need_sync!
+        end
+      end
+
+      # Raises a sync flag, if autosync mode is on, it just sync the database.
+      def need_sync!
+        @need_sync = true
+        sync if @sync # autosync
+      end
     end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: sinatra-monk
 version: !ruby/object:Gem::Version
-  version: 0.0.8
+  version: 0.0.9
 platform: ruby
 authors:
 - Christian Ferraz Lemos de Sousa