metasploit-model 0.27.3 → 0.27.4

data/lib/metasploit/model/real_pathname.rb

@@ -1,20 +1,16 @@
 require 'pathname'
 
-module Metasploit
-  module Model
-    # Adds {#real_pathname} to class, which will convert `#real_path` `String` to a `Pathname`.
-    module RealPathname
-      # `#real_path` as a `Pathname`.
-      #
-      # @return [Pathname] unless `#real_path` is `nil`.
-      # @return [nil] if `#real_path` is `nil`.
-      def real_pathname
-        if real_path
-          Pathname.new(real_path)
-        else
-          nil
-        end
-      end
+# Adds {#real_pathname} to class, which will convert `#real_path` `String` to a `Pathname`.
+module Metasploit::Model::RealPathname
+  # `#real_path` as a `Pathname`.
+  #
+  # @return [Pathname] unless `#real_path` is `nil`.
+  # @return [nil] if `#real_path` is `nil`.
+  def real_pathname
+    if real_path
+      Pathname.new(real_path)
+    else
+      nil
     end
   end
-end
+end

data/lib/metasploit/model/realm.rb

@@ -1,5 +1,3 @@
-require 'metasploit/model'
-
 # Namespace for constants used in `Metasploit::Credential::Realm` that need to be accessible without
 # `metasploit-credential`
 module Metasploit::Model::Realm

data/lib/metasploit/model/realm/key.rb

@@ -1,5 +1,3 @@
-require 'metasploit/model/realm'
-
 # Canonical `Metasploit::Credential::Realm#key`s.
 #
 # `Metasploit::Credential::Realm#key` is restricted to values in {ALL}, so new valid values need to be added to this

data/lib/metasploit/model/reference.rb

@@ -1,110 +1,104 @@
-require 'metasploit/model/translation'
-
-module Metasploit
-  module Model
-    # Code shared between `Mdm::Reference` and `Metasploit::Framework::Reference`.
-    module Reference
-      extend ActiveModel::Naming
-      extend ActiveSupport::Concern
-
-      include Metasploit::Model::Translation
-
-      included do
-        include ActiveModel::MassAssignmentSecurity
-        include ActiveModel::Validations
-        include Metasploit::Model::Derivation
-        include Metasploit::Model::Search
-
-        #
-        # Derivations
-        #
-
-        derives :url, :validate => false
-
-        #
-        # Mass Assignment Security
-        #
-
-        attr_accessible :designation
-        attr_accessible :url
-
-        #
-        # Search Attributes
-        #
-
-        search_attribute :designation, :type => :string
-        search_attribute :url, :type => :string
-
-        #
-        # Validations
-        #
-
-        validates :designation,
-                  :presence => {
-                      :if => :authority?
-                  },
-                  :nil => {
-                      :unless => :authority?
-                  }
-        validates :url,
-                  :presence => {
-                      :unless => :authority?
-                  }
-      end
-
-      #
-      # Associations
-      #
-
-      # @!attribute [rw] authority
-      #   The {Metasploit::Model::Authority authority} that assigned {#designation}.
-      #
-      #   @return [Metasploit::Model::Authority, nil]
-
-      # @!attribute [r] module_instances
-      #   {Metasploit::Model::Module::Instance Modules} that exploit this reference or describe a proof-of-concept (PoC)
-      #   code that the module is based on.
-      #
-      #   @return [Array<Metasploit::Model::Module::Instance>]
-
-      #
-      # Attributes
-      #
-
-      # @!attribute [rw] designation
-      #   A designation (usually a string of numbers and dashes) assigned by {#authority}.
-      #
-      #   @return [String, nil]
-
-      # @!attribute [rw] url
-      #   URL to web page with information about referenced exploit.
-      #
-      #   @return [String, nil]
-
-      #
-      # Instance Methods
-      #
-
-      # Returns whether {#authority} is not `nil`.
-      #
-      # @return [true] unless {#authority} is `nil`.
-      # @return [false] if {#authority} is `nil`.
-      def authority?
-        authority.present?
-      end
-
-      # Derives {#url} based how {#authority} routes {#designation designations} to a URL.
-      #
-      # @return [String, nil]
-      def derived_url
-        derived = nil
-
-        if authority and designation.present?
-          derived = authority.designation_url(designation)
-        end
-
-        derived
-      end
+# Code shared between `Mdm::Reference` and `Metasploit::Framework::Reference`.
+module Metasploit::Model::Reference
+  extend ActiveModel::Naming
+  extend ActiveSupport::Concern
+
+  include Metasploit::Model::Translation
+
+  included do
+    include ActiveModel::MassAssignmentSecurity
+    include ActiveModel::Validations
+    include Metasploit::Model::Derivation
+    include Metasploit::Model::Search
+
+    #
+    # Derivations
+    #
+
+    derives :url, :validate => false
+
+    #
+    # Mass Assignment Security
+    #
+
+    attr_accessible :designation
+    attr_accessible :url
+
+    #
+    # Search Attributes
+    #
+
+    search_attribute :designation, :type => :string
+    search_attribute :url, :type => :string
+
+    #
+    # Validations
+    #
+
+    validates :designation,
+              :presence => {
+                  :if => :authority?
+              },
+              :nil => {
+                  :unless => :authority?
+              }
+    validates :url,
+              :presence => {
+                  :unless => :authority?
+              }
+  end
+
+  #
+  # Associations
+  #
+
+  # @!attribute [rw] authority
+  #   The {Metasploit::Model::Authority authority} that assigned {#designation}.
+  #
+  #   @return [Metasploit::Model::Authority, nil]
+
+  # @!attribute [r] module_instances
+  #   {Metasploit::Model::Module::Instance Modules} that exploit this reference or describe a proof-of-concept (PoC)
+  #   code that the module is based on.
+  #
+  #   @return [Array<Metasploit::Model::Module::Instance>]
+
+  #
+  # Attributes
+  #
+
+  # @!attribute [rw] designation
+  #   A designation (usually a string of numbers and dashes) assigned by {#authority}.
+  #
+  #   @return [String, nil]
+
+  # @!attribute [rw] url
+  #   URL to web page with information about referenced exploit.
+  #
+  #   @return [String, nil]
+
+  #
+  # Instance Methods
+  #
+
+  # Returns whether {#authority} is not `nil`.
+  #
+  # @return [true] unless {#authority} is `nil`.
+  # @return [false] if {#authority} is `nil`.
+  def authority?
+    authority.present?
+  end
+
+  # Derives {#url} based how {#authority} routes {#designation designations} to a URL.
+  #
+  # @return [String, nil]
+  def derived_url
+    derived = nil
+
+    if authority and designation.present?
+      derived = authority.designation_url(designation)
     end
+
+    derived
   end
-end
+end

data/lib/metasploit/model/search.rb

@@ -1,106 +1,103 @@
-module Metasploit
-  module Model
-    # DSL to define associations and attributes that can be searched.  Making an association searchable, will expose
-    # the attributes that association's class defined as searchable.
-    #
-    # # Operators
-    #
-    # Search operators define how to search against a given `Class`.
-    #
-    # ## Attributes
-    #
-    # Boolean, `Date`, `Integer`, and `String` attributes can be searched with
-    # {Metasploit::Model::Search::Attribute::ClassMethods#search_attribute search_attribute}.  `Integer` and `String`
-    # attributes can be further restricted to a defined `Set` of values.
-    #
-    #     class Part
-    #       include Metasploit::Model::Search
-    #
-    #       search_attribute :part,
-    #                        :integer
-    #     end
-    #
-    # The above defines the `:part` operator on `Part`.
-    #
-    # ## Custom search operators
-    #
-    # If a search operator does not directly correspond to an attribute or a the attribute needs custom validation, then
-    # a custom {Metasploit::Model::Search::Operator operator class} can be setup as the search operator
-    #
-    #     class Search::Operator::UUID
-    #       def name
-    #         :uuid
-    #       end
-    #     end
-    #
-    #     class Part
-    #       include Metasploit::Model::Search
-    #
-    #       search_with Search::Operator::UUID
-    #     end
-    #
-    # The above defines the `:uuid` operator on `Part`.
-    #
-    # ## Associations
-    #
-    # Search operators registered with
-    # {Metasploit::Model::Search::Attribute::ClassMethods#search_attribute search_attribute} or
-    # {Metasploit::Model::Search::With::ClassMethods#search_with search_with} on an associated `Class` can be searched
-    # with {Metasploit::Model::Search::Association::ClassMethods#search_association}:
-    #
-    #     class Widget
-    #       include Metasploit::Model::Search
-    #
-    #       # declare parts association
-    #
-    #       search_association :parts
-    #     end
-    #
-    # The above will define the `:'parts.number'` and `:'parts.uuid'` operator on `Widget`.
-    #
-    # # Queries
-    #
-    # {include:Metasploit::Model::Search::Query}
-    module Search
-      extend ActiveSupport::Concern
-      extend ActiveSupport::Autoload
-
-      require 'metasploit/model/search/association'
-      require 'metasploit/model/search/attribute'
-      require 'metasploit/model/search/with'
+# DSL to define associations and attributes that can be searched.  Making an association searchable, will expose
+# the attributes that association's class defined as searchable.
+#
+# # Operators
+#
+# Search operators define how to search against a given `Class`.
+#
+# ## Attributes
+#
+# Boolean, `Date`, `Integer`, and `String` attributes can be searched with
+# {Metasploit::Model::Search::Attribute::ClassMethods#search_attribute search_attribute}.  `Integer` and `String`
+# attributes can be further restricted to a defined `Set` of values.
+#
+#     class Part
+#       include Metasploit::Model::Search
+#
+#       search_attribute :part,
+#                        :integer
+#     end
+#
+# The above defines the `:part` operator on `Part`.
+#
+# ## Custom search operators
+#
+# If a search operator does not directly correspond to an attribute or a the attribute needs custom validation, then
+# a custom {Metasploit::Model::Search::Operator operator class} can be setup as the search operator
+#
+#     class Search::Operator::UUID
+#       def name
+#         :uuid
+#       end
+#     end
+#
+#     class Part
+#       include Metasploit::Model::Search
+#
+#       search_with Search::Operator::UUID
+#     end
+#
+# The above defines the `:uuid` operator on `Part`.
+#
+# ## Associations
+#
+# Search operators registered with
+# {Metasploit::Model::Search::Attribute::ClassMethods#search_attribute search_attribute} or
+# {Metasploit::Model::Search::With::ClassMethods#search_with search_with} on an associated `Class` can be searched
+# with {Metasploit::Model::Search::Association::ClassMethods#search_association}:
+#
+#     class Widget
+#       include Metasploit::Model::Search
+#
+#       # declare parts association
+#
+#       search_association :parts
+#     end
+#
+# The above will define the `:'parts.number'` and `:'parts.uuid'` operator on `Widget`.
+#
+# # Queries
+#
+# {include:Metasploit::Model::Search::Query}
+module Metasploit::Model::Search
+  extend ActiveSupport::Autoload
+  extend ActiveSupport::Concern
 
-      include Metasploit::Model::Search::Association
-      include Metasploit::Model::Search::Attribute
-      include Metasploit::Model::Search::With
+  autoload :Association
+  autoload :Attribute
+  autoload :Group
+  autoload :Operation
+  autoload :Operator
+  autoload :Query
+  autoload :Search
+  autoload :With
 
-      autoload :Group
-      autoload :Operation
-      autoload :Operator
+  include Metasploit::Model::Search::Association
+  include Metasploit::Model::Search::Attribute
+  include Metasploit::Model::Search::With
 
-      # Allows operators registered with {Metasploit::Model::Search::Association::ClassMethods#search_association} and
-      # {Metasploit::Model::Search::Attribute::ClassMethods#search_attribute} to be looked up by name.
-      module ClassMethods
-        # Collects all search attributes from search associations and all attributes from this class to show the valid
-        # search operators to search.
-        #
-        # @return [Hash{Symbol => Metasploit::Model::Search::Operator}] Maps
-        #   {Metasploit::Model::Search::Operator::Base#name} to {Metasploit::Model::Search::Operator::Base#name}.
-        def search_operator_by_name
-          unless instance_variable_defined? :@search_operator_by_name
-            @search_operator_by_name = {}
+  # Allows operators registered with {Metasploit::Model::Search::Association::ClassMethods#search_association} and
+  # {Metasploit::Model::Search::Attribute::ClassMethods#search_attribute} to be looked up by name.
+  module ClassMethods
+    # Collects all search attributes from search associations and all attributes from this class to show the valid
+    # search operators to search.
+    #
+    # @return [Hash{Symbol => Metasploit::Model::Search::Operator}] Maps
+    #   {Metasploit::Model::Search::Operator::Base#name} to {Metasploit::Model::Search::Operator::Base#name}.
+    def search_operator_by_name
+      unless instance_variable_defined? :@search_operator_by_name
+        @search_operator_by_name = {}
 
-            search_with_operator_by_name.each_value do |operator|
-              @search_operator_by_name[operator.name] = operator
-            end
-
-            search_association_operators.each do |operator|
-              @search_operator_by_name[operator.name] = operator
-            end
-          end
+        search_with_operator_by_name.each_value do |operator|
+          @search_operator_by_name[operator.name] = operator
+        end
 
-          @search_operator_by_name
+        search_association_operators.each do |operator|
+          @search_operator_by_name[operator.name] = operator
         end
       end
+
+      @search_operator_by_name
     end
   end
-end
+end