ronin 1.0.0.pre4 → 1.0.0.rc1

data/lib/ronin/database/migrations/migration.rb

@@ -24,6 +24,9 @@ require 'dm-migrations/migration'
 module Ronin
   module Database
     module Migrations
+      #
+      # Represents a Database Migration.
+      #
       class Migration < DataMapper::Migration
 
         # The dependencies of the migration

data/lib/ronin/database/migrations/migrations.rb

@@ -142,7 +142,7 @@ module Ronin
       #   The database was successfully migrated up.
       #
       # @raise [UnknownMigration]
-      #   A migration had a dependencey on an unknown migration.
+      #   A migration had a dependency on an unknown migration.
       #
       # @since 1.0.1
       #
@@ -167,7 +167,7 @@ module Ronin
       #   The database was successfully migrated down.
       #
       # @raise [UnknownMigration]
-      #   A migration had a dependencey on an unknown migration.
+      #   A migration had a dependency on an unknown migration.
       #
       # @since 1.0.1
       #

data/lib/ronin/email_address.rb

@@ -24,6 +24,9 @@ require 'ronin/model'
 require 'dm-timestamps'
 
 module Ronin
+  #
+  # Represents email addresses that can be stored in the {Database}.
+  #
   class EmailAddress
 
     include Model

data/lib/ronin/engine/buildable.rb

@@ -22,6 +22,9 @@ require 'ronin/engine/verifiable'
 
 module Ronin
   module Engine
+    #
+    # Adds building methods to an {Engine}.
+    #
     module Buildable
       include Verifiable
 

data/lib/ronin/engine/class_methods.rb

@@ -19,6 +19,9 @@
 
 module Ronin
   module Engine
+    #
+    # Class methods for an {Engine}.
+    #
     module ClassMethods
       #
       # Finds and loads all matching Ronin Engines.

data/lib/ronin/engine/deployable.rb

@@ -22,6 +22,9 @@ require 'ronin/engine/verifiable'
 
 module Ronin
   module Engine
+    #
+    # Adds deployment methods to an {Engine}.
+    #
     module Deployable
       include Verifiable
 

data/lib/ronin/engine/engine.rb

@@ -34,6 +34,20 @@ module Ronin
   module Engine
     include UI::Output::Helpers
 
+    #
+    # Adds the following to the Class.
+    #
+    # * {Engine::InstanceMethods}
+    # * {Model}
+    # * {Model::HasName}
+    # * {Model::HasDescription}
+    # * {Model::HasVersion}
+    # * {Model::HasLicense}
+    # * {Model::HasAuthors}
+    # * {Model::Cacheable}
+    # * [Parameters](http://rubydoc.info/gems/parameters)
+    # * {ClassMethods}
+    #
     def self.included(base)
       base.send :include, Engine::InstanceMethods,
                           Model,

data/lib/ronin/engine/instance_methods.rb

@@ -19,6 +19,9 @@
 
 module Ronin
   module Engine
+    #
+    # Instance methods for an {Engine}.
+    #
     module InstanceMethods
       #
       # Initializes the Ronin Engine.

data/lib/ronin/engine/verifiable.rb

@@ -21,6 +21,9 @@ require 'ronin/engine/exceptions/verification_failed'
 
 module Ronin
   module Engine
+    #
+    # Adds verification methods to an {Engine}.
+    #
     module Verifiable
       #
       # Initializes the verifiable engine.

data/lib/ronin/environment.rb

@@ -17,6 +17,9 @@
 # along with Ronin.  If not, see <http://www.gnu.org/licenses/>.
 #
 
+#
+# Loads all extensions to core Ruby classes.
+#
 require 'ronin/ronin'
 require 'ronin/extensions'
 require 'ronin/formatting/extensions'
@@ -26,5 +29,8 @@ require 'ronin/ui/output/helpers'
 
 require 'chars/extensions'
 
+#
+# Includes the Ronin namespace and output helper methods.
+#
 include Ronin
 include Ronin::UI::Output::Helpers

data/lib/ronin/host_name.rb

@@ -26,6 +26,9 @@ require 'ronin/model'
 require 'resolv'
 
 module Ronin
+  #
+  # Represents host names that can be stored in the {Database}.
+  #
   class HostName < Address
 
     # The IP Address associations

data/lib/ronin/host_name_ip_address.rb

@@ -24,6 +24,9 @@ require 'ronin/model'
 require 'dm-timestamps'
 
 module Ronin
+  #
+  # Associates a {HostName} with an {IPAddress}.
+  #
   class HostNameIPAddress
 
     include Model

data/lib/ronin/ip_address.rb

@@ -28,6 +28,9 @@ require 'ipaddr'
 require 'resolv'
 
 module Ronin
+  #
+  # Represents IP addresses that can be stored in the {Database}.
+  #
   class IPAddress < Address
 
     # The IP Address

data/lib/ronin/ip_address_mac_address.rb

@@ -24,6 +24,9 @@ require 'ronin/model'
 require 'dm-timestamps'
 
 module Ronin
+  #
+  # Associates an {IPAddress} with a {MACAddress}.
+  #
   class IPAddressMACAddress
 
     include Model

data/lib/ronin/license.rb

@@ -111,7 +111,7 @@ module Ronin
               :description => 'GNU Lesser General Public License v3.0',
               :url => 'http://www.gnu.org/licenses/lgpl-3.0.txt'
 
-    # The MIT "as-is" Licence
+    # The MIT "as-is" License
     predefine :mit,
               :name => 'MIT',
               :description => 'The MIT Licence',

data/lib/ronin/mac_address.rb

@@ -22,6 +22,9 @@ require 'ronin/ip_address_mac_address'
 require 'ronin/model'
 
 module Ronin
+  #
+  # Represents MAC addresses that can be stored in the {Database}.
+  #
   class MACAddress < Address
 
     # The IP Addresses the MAC Address hosts

data/lib/ronin/model/cacheable/cacheable.rb

@@ -203,7 +203,7 @@ module Ronin
 
       #
       # Loads the code from the cached file for the object, and instance
-      # evals it into the object.
+      # evaluates it into the object.
       #
       # @return [Boolean]
       #   Indicates the original code was successfully loaded.

data/lib/ronin/model/class_methods.rb

@@ -21,6 +21,9 @@ require 'ronin/support/inflector'
 
 module Ronin
   module Model
+    #
+    # Class methods that are added when {Model} is included into a class.
+    #
     module ClassMethods
       #
       # The default name to use when defining relationships with the

data/lib/ronin/model/has_authors/class_methods.rb

@@ -20,6 +20,10 @@
 module Ronin
   module Model
     module HasAuthors
+      #
+      # Class methods that are added when {HasAuthors} is included into a
+      # model.
+      #
       module ClassMethods
         #
         # Finds all resources associated with a given author.

data/lib/ronin/model/has_authors/has_authors.rb

@@ -24,22 +24,26 @@ require 'ronin/author'
 module Ronin
   module Model
     #
-    # Adds an `authors` relation between a model and the `Ronin::Author`
-    # model.
+    # Adds an `authors` relationship between a model and the {Author} model.
     #
     module HasAuthors
+      #
+      # Adds the `authors` relationship and {ClassMethods} to the model.
+      #
+      # @param [Class] base
+      #   The model.
+      #
       def self.included(base)
         base.send :include, Model
         base.send :extend, ClassMethods
 
         base.module_eval do
           # The authors associated with the model.
-          has 0..n, :authors, :through => DataMapper::Resource,
-                              :model => 'Ronin::Author'
+          has 0..n, :authors, Ronin::Author, :through => DataMapper::Resource
 
           Ronin::Author.has 0..n, self.relationship_name,
                                   :through => DataMapper::Resource,
-                                  :model => self.name
+                                  :model => self
         end
       end
 

data/lib/ronin/model/has_description/class_methods.rb

@@ -20,6 +20,10 @@
 module Ronin
   module Model
     module HasDescription
+      #
+      # Class methods that are added when {HasDescription} is included into
+      # a model.
+      #
       module ClassMethods
         #
         # Finds models with descriptions containing a given fragment of

data/lib/ronin/model/has_description/has_description.rb

@@ -27,6 +27,12 @@ module Ronin
     # Adds a `description` property to a model.
     #
     module HasDescription
+      #
+      # Adds the `description` property and {ClassMethods} to the model.
+      #
+      # @param [Class] base
+      #   The model.
+      #
       def self.included(base)
         base.send :include, Model
         base.send :extend, ClassMethods

data/lib/ronin/model/has_license/class_methods.rb

@@ -20,6 +20,10 @@
 module Ronin
   module Model
     module HasLicense
+      #
+      # Class methods that are added when {HasLicense} is included into a
+      # model.
+      #
       module ClassMethods
         #
         # Finds all models associated with a given license.

data/lib/ronin/model/has_license/has_license.rb

@@ -24,21 +24,25 @@ require 'ronin/license'
 module Ronin
   module Model
     #
-    # Adds a `license` relation between a model and the {License} model.
+    # Adds a `license` relationship between a model and the {License} model.
     #
     module HasLicense
+      #
+      # Adds the `license` relationship and {ClassMethods} to the model.
+      #
+      # @param [Class] base
+      #   The model.
+      #
       def self.included(base)
         base.send :include, Model
         base.send :extend, ClassMethods
 
         base.module_eval do
           # The license
-          belongs_to :license, :required => false,
-                               :model => 'Ronin::License'
+          belongs_to :license, Ronin::License, :required => false
 
+          Ronin::License.has 0..n, self.relationship_name, :model => self
         end
-
-        License.has License.n, base.relationship_name, :model => base.name
       end
 
       #

data/lib/ronin/model/has_name/class_methods.rb

@@ -20,6 +20,10 @@
 module Ronin
   module Model
     module HasName
+      #
+      # Class methods that are added when {HasName} is included into a
+      # model.
+      #
       module ClassMethods
         #
         # Finds models with names containing a given fragment of text.

data/lib/ronin/model/has_name/has_name.rb

@@ -26,6 +26,12 @@ module Ronin
     # Adds a `name` property to a model.
     #
     module HasName
+      #
+      # Adds the `name` property and {ClassMethods} to the model.
+      #
+      # @param [Class] base
+      #   The model.
+      #
       def self.included(base)
         base.send :include, Model
         base.send :extend, ClassMethods

data/lib/ronin/model/has_title/class_methods.rb

@@ -20,6 +20,10 @@
 module Ronin
   module Model
     module HasTitle
+      #
+      # Class methods that are added when {HasTitle} are included into a
+      # model.
+      #
       module ClassMethods
         #
         # Finds models with titles containing a given fragment of text.

data/lib/ronin/model/has_title/has_title.rb

@@ -26,6 +26,12 @@ module Ronin
     # Adds a `title` property to a model.
     #
     module HasTitle
+      #
+      # Adds the `title` property and {ClassMethods} to the model.
+      #
+      # @param [Class] base
+      #   The model.
+      #
       def self.included(base)
         base.send :include, Model
         base.send :extend, ClassMethods

data/lib/ronin/model/has_unique_name.rb

@@ -25,6 +25,13 @@ module Ronin
     # Adds a unique `name` property to a model.
     #
     module HasUniqueName
+      #
+      # Adds the unique `name` property and {HasName::ClassMethods} to the
+      # model.
+      #
+      # @param [Class] base
+      #   The model.
+      #
       def self.included(base)
         base.send :include, Model
         base.send :extend, HasName::ClassMethods

data/lib/ronin/model/has_version/class_methods.rb

@@ -20,6 +20,10 @@
 module Ronin
   module Model
     module HasVersion
+      #
+      # Class methods that are added when {HasVersion} is included into a
+      # model.
+      #
       module ClassMethods
         #
         # Finds all models with a specific version.

data/lib/ronin/model/has_version/has_version.rb

@@ -26,6 +26,12 @@ module Ronin
     # Adds a `version` property to a model.
     #
     module HasVersion
+      #
+      # Adds the `version` property and {ClassMethods} to the model.
+      #
+      # @param [Class] base
+      #   The model.
+      #
       def self.included(base)
         base.send :include, Model
         base.send :extend, ClassMethods

data/lib/ronin/model/model.rb

@@ -36,6 +36,13 @@ module Ronin
   module Model
     include Model::Types
 
+    #
+    # Sets up a class as a DataMapper model that can be used with the
+    # {Database}. Also adds {ClassMethods} to the new model.
+    #
+    # @param [Class] base
+    #   The class that will be setup as a DataMapper model.
+    #
     def self.included(base)
       unless base.ancestors.include?(DataMapper::Resource)
         base.send :include, DataMapper::Resource