metasploit-model 0.27.3 → 0.27.4

data/lib/metasploit/model/search/group.rb

@@ -1,6 +1,9 @@
-require 'metasploit/model/search'
-
 # Namespace for search groups, such as {Metasploit::Model::Search::Group::Intersection intersections} or
 # {Metasploit::Model::Search::Group::Union unions}.
 module Metasploit::Model::Search::Group
+  extend ActiveSupport::Autoload
+
+  autoload :Base
+  autoload :Intersection
+  autoload :Union
 end

data/lib/metasploit/model/search/operation.rb

@@ -1,35 +1,38 @@
-module Metasploit
-  module Model
-    module Search
-      # Namespace for search operations.  {parse} acts as a factory to parse a `String` and return a type-specific
-      # operation.
-      module Operation
-        extend ActiveSupport::Autoload
+# Namespace for search operations.  {parse} acts as a factory to parse a `String` and return a type-specific
+# operation.
+module Metasploit::Model::Search::Operation
+  extend ActiveSupport::Autoload
 
-        autoload :Group
+  autoload :Association
+  autoload :Base
+  autoload :Boolean
+  autoload :Date
+  autoload :Group
+  autoload :Integer
+  autoload :Null
+  autoload :Set
+  autoload :String
+  autoload :Value
 
-        # @param options [Hash{Symbol => Object}]
-        # @option options [Metasploit::Module::Search::Query] :query The query that the parsed operation is a part.
-        # @option options [String] :formatted_operation A '<operator>:<value>' string.
-        # @return [Metasploit::Model::Search::Operation::Base, Array<Metasploit::Model::Search::Operation::Base>]
-        #   operation(s) parsed from the formatted operation.
-        # @raise [KeyError] unless :formatted_operation is given.
-        # @raise [KeyError] unless :query is given.
-        def self.parse(options={})
-          formatted_operation = options.fetch(:formatted_operation)
-          query = options.fetch(:query)
+  # @param options [Hash{Symbol => Object}]
+  # @option options [Metasploit::Module::Search::Query] :query The query that the parsed operation is a part.
+  # @option options [String] :formatted_operation A '<operator>:<value>' string.
+  # @return [Metasploit::Model::Search::Operation::Base, Array<Metasploit::Model::Search::Operation::Base>]
+  #   operation(s) parsed from the formatted operation.
+  # @raise [KeyError] unless :formatted_operation is given.
+  # @raise [KeyError] unless :query is given.
+  def self.parse(options={})
+    formatted_operation = options.fetch(:formatted_operation)
+    query = options.fetch(:query)
 
-          formatted_operator, formatted_value = formatted_operation.split(':', 2)
-          operator = query.parse_operator(formatted_operator)
+    formatted_operator, formatted_value = formatted_operation.split(':', 2)
+    operator = query.parse_operator(formatted_operator)
 
-          # formatted_value will be nil if formatted_operation did not contain a ':', it should be treated the same
-          # as nothing after the ':'.
-          formatted_value ||= ''
-          operation_or_operations = operator.operate_on(formatted_value)
+    # formatted_value will be nil if formatted_operation did not contain a ':', it should be treated the same
+    # as nothing after the ':'.
+    formatted_value ||= ''
+    operation_or_operations = operator.operate_on(formatted_value)
 
-          operation_or_operations
-        end
-      end
-    end
+    operation_or_operations
   end
-end
+end

data/lib/metasploit/model/search/operation/group.rb

@@ -1,5 +1,8 @@
-require 'metasploit/model/search/operation'
-
 # Namespace for operations that form groups directly from single operator.
 module Metasploit::Model::Search::Operation::Group
+  extend ActiveSupport::Autoload
+
+  autoload :Base
+  autoload :Intersection
+  autoload :Union
 end

data/lib/metasploit/model/search/operation/value.rb

@@ -0,0 +1,7 @@
+# Namespace for `Module`s that define operation `#value` methods.
+module Metasploit::Model::Search::Operation::Value
+  extend ActiveSupport::Autoload
+
+  autoload :Integer
+  autoload :String
+end

data/lib/metasploit/model/search/operation/{integer/value.rb → value/integer.rb}

@@ -1,5 +1,5 @@
 # Concerns type casting of a raw value to an `Integer`.
-module Metasploit::Model::Search::Operation::Integer::Value
+module Metasploit::Model::Search::Operation::Value::Integer
   #
   # Attributes
   #

data/lib/metasploit/model/search/operation/{string/value.rb → value/string.rb}

@@ -1,5 +1,5 @@
 # Concerns type casting of a raw value to a `String`.
-module Metasploit::Model::Search::Operation::String::Value
+module Metasploit::Model::Search::Operation::Value::String
   #
   # Methods
   #

data/lib/metasploit/model/search/operator.rb

@@ -1,66 +1,66 @@
-module Metasploit
-  module Model
-    module Search
-      # # Declaring operator classes
-      #
-      # ## Interface
-      #
-      # Operators do not need to subclass any specific superclass, but they are expected to define certain methods.
-      #
-      #     class MyOperator
-      #       #
-      #       # Instance Methods
-      #       #
-      #
-      #       # @param klass [Class] The klass on which `search_with` was called.
-      #       def initialize(attributes={})
-      #         # ...
-      #       end
-      #
-      #       # Description of what this operator searches for.
-      #       #
-      #       # @return [String]
-      #       def help
-      #         # ...
-      #       end
-      #
-      #       # Name of this operator.  The name of the operator is matched to the string before the ':' in a formatted
-      #       # operation.
-      #       #
-      #       # @return [Symbol]
-      #       def name
-      #         # ...
-      #       end
-      #
-      #       # Creates a one or more operations based on `formatted_value`.
-      #       #
-      #       # @return [#operator, Array<#operator>] Operation with this operator as the operation's `operator`.
-      #       def operate_on(formatted_value)
-      #         # ...
-      #       end
-      #     end
-      #
-      # ## Help
-      #
-      # Instead of having define your own `#help` method for your operator `Class`, you can `include`
-      # {Metasploit::Model::Search::Operator::Help}.
-      #
-      # {include:Metasploit::Model::Search::Operator::Help}
-      #
-      # ## {Metasploit::Model::Search::Operator::Base}
-      #
-      # {include:Metasploit::Model::Search::Operator::Base}
-      #
-      # ## {Metasploit::Model::Search::Operator::Single}
-      #
-      # {include:Metasploit::Model::Search::Operator::Single}
-      module Operator
-        extend ActiveSupport::Autoload
+# # Declaring operator classes
+#
+# ## Interface
+#
+# Operators do not need to subclass any specific superclass, but they are expected to define certain methods.
+#
+#     class MyOperator
+#       #
+#       # Instance Methods
+#       #
+#
+#       # @param klass [Class] The klass on which `search_with` was called.
+#       def initialize(attributes={})
+#         # ...
+#       end
+#
+#       # Description of what this operator searches for.
+#       #
+#       # @return [String]
+#       def help
+#         # ...
+#       end
+#
+#       # Name of this operator.  The name of the operator is matched to the string before the ':' in a formatted
+#       # operation.
+#       #
+#       # @return [Symbol]
+#       def name
+#         # ...
+#       end
+#
+#       # Creates a one or more operations based on `formatted_value`.
+#       #
+#       # @return [#operator, Array<#operator>] Operation with this operator as the operation's `operator`.
+#       def operate_on(formatted_value)
+#         # ...
+#       end
+#     end
+#
+# ## Help
+#
+# Instead of having define your own `#help` method for your operator `Class`, you can `include`
+# {Metasploit::Model::Search::Operator::Help}.
+#
+# {include:Metasploit::Model::Search::Operator::Help}
+#
+# ## {Metasploit::Model::Search::Operator::Base}
+#
+# {include:Metasploit::Model::Search::Operator::Base}
+#
+# ## {Metasploit::Model::Search::Operator::Single}
+#
+# {include:Metasploit::Model::Search::Operator::Single}
+module Metasploit::Model::Search::Operator
+  extend ActiveSupport::Autoload
 
-        autoload :Deprecated
-        autoload :Group
-        autoload :Help
-      end
-    end
-  end
-end
+  autoload :Association
+  autoload :Attribute
+  autoload :Base
+  autoload :Delegation
+  autoload :Deprecated
+  autoload :Group
+  autoload :Help
+  autoload :Null
+  autoload :Single
+end

data/lib/metasploit/model/search/operator/deprecated.rb

@@ -1,6 +1,12 @@
-require 'metasploit/model/search/operator'
-
 # Namespace for search operators that mimic behavior of the msfconsole search operators prior to the search operator
 # generalization introduced by {Metasploit::Model::Search}.
 module Metasploit::Model::Search::Operator::Deprecated
+  extend ActiveSupport::Autoload
+
+  autoload :App
+  autoload :Author
+  autoload :Authority
+  autoload :Platform
+  autoload :Ref
+  autoload :Text
 end

data/lib/metasploit/model/search/operator/group.rb

@@ -1,5 +1,8 @@
-require 'metasploit/model/search/operator'
-
 # Namespace for operators that produce group operations.
 module Metasploit::Model::Search::Operator::Group
+  extend ActiveSupport::Autoload
+
+  autoload :Base
+  autoload :Intersection
+  autoload :Union
 end

data/lib/metasploit/model/search/operator/help.rb

@@ -1,85 +1,77 @@
-module Metasploit
-  module Model
-    module Search
-      module Operator
-        # This allows the help to be looked up using `I18n`, and for the
-        # help to be customized based on the following criteria:
-        #
-        # `klass` on which the operator is declared, including any `Module#ancestors` and the operator `name`
-        #
-        #     # config/locales/<lang>.yml
-        #     <lang>:
-        #       <klass.i18n_scope>:
-        #         ancestors:
-        #           <klass_ancestor.model_name.i18n_key>:
-        #             search:
-        #               operator:
-        #                 names:
-        #                   <name>:
-        #                     help: "Help for searching <name> on <klass>"
-        #
-        # `class` of the operator, including any `Module#ancestors` and the operator `name`
-        #
-        #     # config/locales/<lang>.yml
-        #     <lang>:
-        #       <operator.class.i18n_scope>:
-        #         search:
-        #           operator:
-        #             ancestors:
-        #               <operator_class_ancestor.model_name.i18n_key>:
-        #                 <name>:
-        #                   help: "Help for searching <name> using <operator.class>"
-        #
-        # `class` of the operator, including any `Module#ancestors` without the operator `name`
-        #
-        #     # config/locales/<lang>.yml
-        #     <lang>:
-        #       <operator.class.i18n_scope>:
-        #         search:
-        #           operator:
-        #             ancestors:
-        #               <operator_class_ancestor.model_name.i18n_key>:
-        #                 help: "Help for searching using <operator.class>"
-        #
-        module Help
-          # @note This uses I18n.translate along with {Metasploit::Model::Translation#search_i18n_scope},
-          #   the value is not cached to support changing the I18n.locale and getting the correct help message for that
-          #   locale.
-          #
-          # The help for this operator.
-          #
-          # @see https://github.com/rails/rails/blob/6c2810b8ed692004dca43e554982cdfdb8517b80/activemodel/lib/active_model/errors.rb#L408-L435
-          def help
-            defaults = []
-            klass_i18n_scope = klass.i18n_scope
+# This allows the help to be looked up using `I18n`, and for the
+# help to be customized based on the following criteria:
+#
+# `klass` on which the operator is declared, including any `Module#ancestors` and the operator `name`
+#
+#     # config/locales/<lang>.yml
+#     <lang>:
+#       <klass.i18n_scope>:
+#         ancestors:
+#           <klass_ancestor.model_name.i18n_key>:
+#             search:
+#               operator:
+#                 names:
+#                   <name>:
+#                     help: "Help for searching <name> on <klass>"
+#
+# `class` of the operator, including any `Module#ancestors` and the operator `name`
+#
+#     # config/locales/<lang>.yml
+#     <lang>:
+#       <operator.class.i18n_scope>:
+#         search:
+#           operator:
+#             ancestors:
+#               <operator_class_ancestor.model_name.i18n_key>:
+#                 <name>:
+#                   help: "Help for searching <name> using <operator.class>"
+#
+# `class` of the operator, including any `Module#ancestors` without the operator `name`
+#
+#     # config/locales/<lang>.yml
+#     <lang>:
+#       <operator.class.i18n_scope>:
+#         search:
+#           operator:
+#             ancestors:
+#               <operator_class_ancestor.model_name.i18n_key>:
+#                 help: "Help for searching using <operator.class>"
+#
+module Metasploit::Model::Search::Operator::Help
+  # @note This uses I18n.translate along with {Metasploit::Model::Translation#search_i18n_scope},
+  #   the value is not cached to support changing the I18n.locale and getting the correct help message for that
+  #   locale.
+  #
+  # The help for this operator.
+  #
+  # @see https://github.com/rails/rails/blob/6c2810b8ed692004dca43e554982cdfdb8517b80/activemodel/lib/active_model/errors.rb#L408-L435
+  def help
+    defaults = []
+    klass_i18n_scope = klass.i18n_scope
 
-            klass.lookup_ancestors.each do |ancestor|
-              # a specific operator for a given Class#ancestors member
-              defaults << :"#{klass_i18n_scope}.ancestors.#{ancestor.model_name.i18n_key}.search.operator.names.#{name}.help"
-            end
+    klass.lookup_ancestors.each do |ancestor|
+      # a specific operator for a given Class#ancestors member
+      defaults << :"#{klass_i18n_scope}.ancestors.#{ancestor.model_name.i18n_key}.search.operator.names.#{name}.help"
+    end
 
-            operator_class = self.class
-            operator_i18n_scope = operator_class.i18n_scope
+    operator_class = self.class
+    operator_i18n_scope = operator_class.i18n_scope
 
-            operator_class.lookup_ancestors.each do |ancestor|
-              # a specific name for a given operator
-              defaults << :"#{operator_i18n_scope}.search.operator.ancestors.#{ancestor.model_name.i18n_key}.names.#{name}.help"
-              # a specific operator class
-              defaults << :"#{operator_i18n_scope}.search.operator.ancestors.#{ancestor.model_name.i18n_key}.help"
-            end
+    operator_class.lookup_ancestors.each do |ancestor|
+      # a specific name for a given operator
+      defaults << :"#{operator_i18n_scope}.search.operator.ancestors.#{ancestor.model_name.i18n_key}.names.#{name}.help"
+      # a specific operator class
+      defaults << :"#{operator_i18n_scope}.search.operator.ancestors.#{ancestor.model_name.i18n_key}.help"
+    end
 
-            # use first default as key because it is most specific default, that is closest to klass.
-            key = defaults.shift
-            options = {
-                default: defaults,
-                model: klass.model_name.human,
-                name: name
-            }
+    # use first default as key because it is most specific default, that is closest to klass.
+    key = defaults.shift
+    options = {
+        default: defaults,
+        model: klass.model_name.human,
+        name: name
+    }
 
-            ::I18n.translate(key, options)
-          end
-        end
-      end
-    end
+    ::I18n.translate(key, options)
   end
-end
+end

data/lib/metasploit/model/search/with.rb

@@ -1,83 +1,77 @@
-module Metasploit
-  module Model
-    module Search
-      # Generalizes {Metasploit::Model::Search::Attribute operators from attributes} to anything directly registered as
-      # an operator on a class.
-      #
-      # {include:Metasploit::Model::Search::Operator}
-      #
-      # # Testing
-      #
-      # {ClassMethods#search_with} calls can be tested with the 'search_with' shared example.  First, ensure
-      # the shared examples from `metasploit-model` are required in your `spec_helper.rb`:
-      #
-      #     # spec/spec_helper.rb
-      #     support_glob = Metasploit::Model::Engine.root.join('spec', 'support', '**', '*.rb')
-      #
-      #     Dir.glob(support_glob) do |path|
-      #       require path
-      #     end
-      #
-      # In the spec fo the `Class` that called `search_with`, use the 'search_with' shared example by passing the
-      # arguments passed to {ClassMethods#search_attribute}.
-      #
-      #     # app/models/my_class.rb
-      #     class MyClass
-      #       include Metasploit::Model::Search
-      #
-      #       #
-      #       # Search
-      #       #
-      #
-      #       search_with MyOperatorClass,
-      #                   foo: :bar
-      #     end
-      #
-      #     # spec/app/models/my_class_spec.rb
-      #     require 'spec_helper'
-      #
-      #     describe MyClass do
-      #       context 'search' do
-      #         context 'attributes' do
-      #           it_should_behave_like 'search_with',
-      #                                 MyOperatorClass,
-      #                                 foo: :bar
-      #         end
-      #       end
-      #     end
-      module With
-        extend ActiveSupport::Concern
+# Generalizes {Metasploit::Model::Search::Attribute operators from attributes} to anything directly registered as
+# an operator on a class.
+#
+# {include:Metasploit::Model::Search::Operator}
+#
+# # Testing
+#
+# {ClassMethods#search_with} calls can be tested with the 'search_with' shared example.  First, ensure
+# the shared examples from `metasploit-model` are required in your `spec_helper.rb`:
+#
+#     # spec/spec_helper.rb
+#     support_glob = Metasploit::Model::Engine.root.join('spec', 'support', '**', '*.rb')
+#
+#     Dir.glob(support_glob) do |path|
+#       require path
+#     end
+#
+# In the spec fo the `Class` that called `search_with`, use the 'search_with' shared example by passing the
+# arguments passed to {ClassMethods#search_attribute}.
+#
+#     # app/models/my_class.rb
+#     class MyClass
+#       include Metasploit::Model::Search
+#
+#       #
+#       # Search
+#       #
+#
+#       search_with MyOperatorClass,
+#                   foo: :bar
+#     end
+#
+#     # spec/app/models/my_class_spec.rb
+#     require 'spec_helper'
+#
+#     describe MyClass do
+#       context 'search' do
+#         context 'attributes' do
+#           it_should_behave_like 'search_with',
+#                                 MyOperatorClass,
+#                                 foo: :bar
+#         end
+#       end
+#     end
+module Metasploit::Model::Search::With
+  extend ActiveSupport::Concern
 
-        # Defines `search_with` DSL, which is a lower-level way than search_attribute to add operators.  `search_with`
-        # allows instance of arbitrary operator_classes to be registered in {#search_with_operator_by_name}.
-        module ClassMethods
-          # Declares that this class should be search with an instance of the given `operator_class`.
-          #
-          # @param operator_class [Class<Metasploit::Model::Search::Operator::Base>] a class to initialize.
-          # @param options [Hash] Options passed to `operator_class.new` along with `{:klass => self}`, so that the
-          #   `operator_class` instance knows it was registered as search this class.
-          # @return [Metasploit::Model::Search::Operator::Base]
-          # @raise (see Metasploit::Model::Base#invalid!)
-          def search_with(operator_class, options={})
-            merged_operations = options.merge(
-                :klass => self
-            )
-            operator = operator_class.new(merged_operations)
-            operator.valid!
+  # Defines `search_with` DSL, which is a lower-level way than search_attribute to add operators.  `search_with`
+  # allows instance of arbitrary operator_classes to be registered in {#search_with_operator_by_name}.
+  module ClassMethods
+    # Declares that this class should be search with an instance of the given `operator_class`.
+    #
+    # @param operator_class [Class<Metasploit::Model::Search::Operator::Base>] a class to initialize.
+    # @param options [Hash] Options passed to `operator_class.new` along with `{:klass => self}`, so that the
+    #   `operator_class` instance knows it was registered as search this class.
+    # @return [Metasploit::Model::Search::Operator::Base]
+    # @raise (see Metasploit::Model::Base#invalid!)
+    def search_with(operator_class, options={})
+      merged_operations = options.merge(
+          :klass => self
+      )
+      operator = operator_class.new(merged_operations)
+      operator.valid!
 
-            search_with_operator_by_name[operator.name] = operator
-          end
+      search_with_operator_by_name[operator.name] = operator
+    end
 
-          # Operators registered with {#search_with}.
-          #
-          # @return [Hash{Symbol => Metasploit::Model::Search::Operator::Base}] Maps
-          #   {Metasploit::Model::Search::Operator::Base#name} keys to {Metasploit::Model::Search::Operator::Base#name}
-          #   values.
-          def search_with_operator_by_name
-            @search_with_operator_by_name ||= {}
-          end
-        end
-      end
+    # Operators registered with {#search_with}.
+    #
+    # @return [Hash{Symbol => Metasploit::Model::Search::Operator::Base}] Maps
+    #   {Metasploit::Model::Search::Operator::Base#name} keys to {Metasploit::Model::Search::Operator::Base#name}
+    #   values.
+    def search_with_operator_by_name
+      @search_with_operator_by_name ||= {}
     end
   end
-end
+end