ronin 1.1.0 → 1.2.0

data/lib/ronin/model/has_description.rb

@@ -17,5 +17,57 @@
 # along with Ronin.  If not, see <http://www.gnu.org/licenses/>.
 #
 
-require 'ronin/model/has_description/class_methods'
-require 'ronin/model/has_description/has_description'
+require 'ronin/model/types/description'
+require 'ronin/model'
+
+module Ronin
+  module Model
+    #
+    # Adds a `description` property to a model.
+    #
+    module HasDescription
+      #
+      # Adds the `description` property and {ClassMethods} to the model.
+      #
+      # @param [Class] base
+      #   The model.
+      #
+      # @api semipublic
+      #
+      def self.included(base)
+        base.send :include, Model
+        base.send :extend, ClassMethods
+
+        base.module_eval do
+          # The description of the model
+          property :description, Model::Types::Description
+        end
+      end
+
+      #
+      # Class methods that are added when {HasDescription} is included into
+      # a model.
+      #
+      module ClassMethods
+        #
+        # Finds models with descriptions containing a given fragment of
+        # text.
+        #
+        # @param [String] fragment
+        #   The fragment of text to match descriptions with.
+        #
+        # @return [Array<Model>]
+        #   The found models.
+        #
+        # @example
+        #   Exploit.describing 'bypass'
+        #
+        # @api public
+        #
+        def describing(fragment)
+          all(:description.like => "%#{fragment}%")
+        end
+      end
+    end
+  end
+end

data/lib/ronin/model/has_license.rb

@@ -17,5 +17,104 @@
 # along with Ronin.  If not, see <http://www.gnu.org/licenses/>.
 #
 
-require 'ronin/model/has_license/class_methods'
-require 'ronin/model/has_license/has_license'
+require 'ronin/model'
+require 'ronin/license'
+
+module Ronin
+  module 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.
+      #
+      # @api semipublic
+      #
+      def self.included(base)
+        base.send :include, Model, InstanceMethods
+        base.send :extend, ClassMethods
+
+        base.module_eval do
+          # The license
+          belongs_to :license, Ronin::License, :required => false
+
+          Ronin::License.has 0..n, self.relationship_name, :model => self
+        end
+      end
+
+      #
+      # Class methods that are added when {HasLicense} is included into a
+      # model.
+      #
+      module ClassMethods
+        #
+        # Finds all models associated with a given license.
+        #
+        # @param [License, Symbol, #to_s] license
+        #   The license which models are associated with.
+        #
+        # @return [Array<Model>]
+        #   The models associated with a given license.
+        #
+        # @example Query using a predefined {License} resource.
+        #   LicensedModel.licensed_under(License.mit)
+        #   # => [#<Ronin::LicensedModel: ...>, ...]
+        #
+        # @example Query using the name of a predefined {License}.
+        #   LicensedModel.licensed_under(:cc_by_nc)
+        #   # => [#<Ronin::LicensedModel: ...>, ...]
+        #
+        # @example Query using the name of a {License}.
+        #   LicensedModel.licensed_under('GPL-2')
+        #   # => [#<Ronin::LicensedModel: ...>, ...]
+        #
+        # @since 1.0.0
+        #
+        # @api public
+        #
+        def licensed_under(license)
+          conditions = case license
+                       when License
+                         {:license => license}
+                       when Symbol
+                         {:license => License.predefined_resource(license)}
+                       else
+                         {'license.name' => license.to_s}
+                       end
+
+          all(conditions)
+        end
+      end
+
+      #
+      # Instance methods that are added when {HasLicense} is included into a
+      # model.
+      #
+      module InstanceMethods
+        #
+        # Sets the license of the model.
+        #
+        # @param [Symbol, String] name
+        #   The name of the license to use.
+        #
+        # @return [License]
+        #   The new license of the model.
+        #
+        # @example
+        #   license! :mit
+        #
+        # @since 1.0.0
+        #
+        # @api public
+        #
+        def license!(name)
+          self.license = Ronin::License.predefined_resource(name)
+        end
+      end
+    end
+  end
+end

data/lib/ronin/model/has_name.rb

@@ -17,5 +17,75 @@
 # along with Ronin.  If not, see <http://www.gnu.org/licenses/>.
 #
 
-require 'ronin/model/has_name/class_methods'
-require 'ronin/model/has_name/has_name'
+require 'ronin/model'
+
+module Ronin
+  module Model
+    #
+    # Adds a `name` property to a model.
+    #
+    module HasName
+      #
+      # Adds the `name` property and {ClassMethods} to the model.
+      #
+      # @param [Class] base
+      #   The model.
+      #
+      # @api semipublic
+      #
+      def self.included(base)
+        base.send :include, Model, InstanceMethods
+        base.send :extend, ClassMethods
+
+        base.module_eval do
+          # The name of the model
+          property :name, String, :required => true, :index => true
+        end
+      end
+
+      #
+      # Class methods that are added when {HasName} is included into a
+      # model.
+      #
+      module ClassMethods
+        #
+        # Finds models with names containing a given fragment of text.
+        #
+        # @param [String] fragment
+        #   The fragment of text to search for within the names of models.
+        #
+        # @return [Array<Model>]
+        #   The found models.
+        #
+        # @example
+        #   Exploit.named 'ProFTP'
+        #
+        # @api public
+        #
+        def named(fragment)
+          all(:name.like => "%#{fragment}%")
+        end
+      end
+
+      #
+      # Instance methods that are added when {HasName} is included into a
+      # model.
+      #
+      module InstanceMethods
+        #
+        # Converts the named resource into a String.
+        #
+        # @return [String]
+        #   The name of the resource.
+        #
+        # @since 1.0.0
+        #
+        # @api public
+        #
+        def to_s
+          self.name.to_s
+        end
+      end
+    end
+  end
+end

data/lib/ronin/model/has_title.rb

@@ -17,5 +17,55 @@
 # along with Ronin.  If not, see <http://www.gnu.org/licenses/>.
 #
 
-require 'ronin/model/has_title/class_methods'
-require 'ronin/model/has_title/has_title'
+require 'ronin/model'
+
+module Ronin
+  module Model
+    #
+    # Adds a `title` property to a model.
+    #
+    module HasTitle
+      #
+      # Adds the `title` property and {ClassMethods} to the model.
+      #
+      # @param [Class] base
+      #   The model.
+      #
+      # @api semipublic
+      #
+      def self.included(base)
+        base.send :include, Model
+        base.send :extend, ClassMethods
+
+        base.module_eval do
+          # The title of the model
+          property :title, String
+        end
+      end
+
+      #
+      # Class methods that are added when {HasTitle} are included into a
+      # model.
+      #
+      module ClassMethods
+        #
+        # Finds models with titles containing a given fragment of text.
+        #
+        # @param [String] fragment
+        #   The fragment of text to match titles with.
+        #
+        # @return [Array<Model>]
+        #   The found models.
+        #
+        # @example
+        #   Vuln.titled 'bypass'
+        #
+        # @api public
+        #
+        def titled(fragment)
+          all(:title.like => "%#{fragment}%")
+        end
+      end
+    end
+  end
+end

data/lib/ronin/model/has_unique_name.rb

@@ -17,5 +17,96 @@
 # along with Ronin.  If not, see <http://www.gnu.org/licenses/>.
 #
 
-require 'ronin/model/has_unique_name/class_methods'
-require 'ronin/model/has_unique_name/has_unique_name'
+require 'ronin/model/has_name'
+
+module Ronin
+  module Model
+    #
+    # 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.
+      #
+      # @api semipublic
+      #
+      def self.included(base)
+        base.send :include, Model,
+                            InstanceMethods
+
+        base.send :extend,  HasName::ClassMethods,
+                            HasUniqueName::ClassMethods
+
+        base.module_eval do
+          # The name of the model
+          property :name, String, :required => true, :unique => true
+        end
+      end
+
+      #
+      # Class methods that will be added when {HasUniqueName} is included.
+      #
+      module ClassMethods
+        #
+        # Searches for models with the unique name.
+        #
+        # @param [String, Symbol, Integer] key
+        #   The unique name or index to search for.
+        #
+        # @return [Model, nil]
+        #   The matching model.
+        #
+        # @since 1.0.0
+        #   
+        # @api public
+        #
+        def [](key)
+          case key
+          when String, Symbol
+            first(:name => key.to_s)
+          else
+            super(key)
+          end
+        end
+      end
+
+      #
+      # Instance methods that will be added when {HasUniqueName} is
+      # included.
+      #
+      module InstanceMethods
+        #
+        # Converts the named resource into a String.
+        #
+        # @return [String]
+        #   The name of the resource.
+        #
+        # @since 1.0.0
+        #
+        # @api public
+        #
+        def to_s
+          self.name.to_s
+        end
+
+        #
+        # Inspects the resource with the unique name.
+        #
+        # @return [String]
+        #   The inspected resource.
+        #
+        # @since 1.0.0
+        #
+        # @api public
+        #
+        def inspect
+          "#<#{self.class}: #{self.name}>"
+        end
+      end
+    end
+  end
+end

data/lib/ronin/model/has_version.rb

@@ -17,5 +17,61 @@
 # along with Ronin.  If not, see <http://www.gnu.org/licenses/>.
 #
 
-require 'ronin/model/has_version/class_methods'
-require 'ronin/model/has_version/has_version'
+require 'ronin/model'
+
+module Ronin
+  module Model
+    #
+    # Adds a `version` property to a model.
+    #
+    module HasVersion
+      #
+      # Adds the `version` property and {ClassMethods} to the model.
+      #
+      # @param [Class] base
+      #   The model.
+      #
+      # @api semipublic
+      #
+      def self.included(base)
+        base.send :include, Model
+        base.send :extend, ClassMethods
+
+        base.module_eval do
+          # The version of the model
+          property :version, String, :default => '0.1', :index => true
+        end
+      end
+
+      #
+      # Class methods that are added when {HasVersion} is included into a
+      # model.
+      #
+      module ClassMethods
+        #
+        # Finds all models with a specific version.
+        #
+        # @param [String] version
+        #   The specific version to search for.
+        #
+        # @return [Array]
+        #   The models with the specific version.
+        #
+        # @api public
+        #
+        def revision(version)
+          all(:version => version.to_s)
+        end
+
+        #
+        # Finds latest version of the model.
+        #
+        # @api public
+        #
+        def latest
+          first(:order => [:version.desc])
+        end
+      end
+    end
+  end
+end