metasploit-model 0.27.3 → 0.27.4

data/lib/metasploit/model/spec.rb

@@ -1,147 +1,144 @@
 require 'rspec/core/shared_example_group'
 
-module Metasploit
-  module Model
-    # Helper methods for running specs for metasploit-model.
-    module Spec
-      require 'metasploit/model/spec/temporary_pathname'
-
-      extend ActiveSupport::Autoload
-      extend Metasploit::Model::Spec::TemporaryPathname
-      # without this, Module.shared_examples_for will be used and RSpec will count shared_examples created with
-      # {shared_examples_for} to not be declared at the top-level.
-      extend RSpec::Core::SharedExampleGroup::TopLevelDSL
-
-      autoload :Error
-      autoload :I18nExceptionHandler
-      autoload :PathnameCollision
-
-      # Defines a shared examples for a `Module` under the {Metasploit::Model} namespace.  This `Module` is assumed to
-      # be a mixin that can be mixed into an ActiveModel in metasploit-framework or an ActiveRecord in
-      # metasploit_data_models.  Shared examples declared using this method get access to boiler plate methods used
-      # for all the {Metasploit::Model} mixin `Modules`:
+# Helper methods for running specs for metasploit-model.
+module Metasploit::Model::Spec
+  extend ActiveSupport::Autoload
+
+  autoload :Error
+  autoload :I18nExceptionHandler
+  autoload :PathnameCollision
+  autoload :Template
+  autoload :TemporaryPathname
+
+  extend Metasploit::Model::Spec::TemporaryPathname
+  # without this, Module.shared_examples_for will be used and RSpec will count shared_examples created with
+  # {shared_examples_for} to not be declared at the top-level.
+  extend RSpec::Core::SharedExampleGroup::TopLevelDSL
+
+  # Defines a shared examples for a `Module` under the {Metasploit::Model} namespace.  This `Module` is assumed to
+  # be a mixin that can be mixed into an ActiveModel in metasploit-framework or an ActiveRecord in
+  # metasploit_data_models.  Shared examples declared using this method get access to boiler plate methods used
+  # for all the {Metasploit::Model} mixin `Modules`:
+  #
+  #   * <relative_variable_name>_class
+  #   * <relative_variable_name>_factory
+  #   * factory_namespace
+  #   * relative_variable_name
+  #   * #<relative_variable_name>_class
+  #   * #<relative_variable_name>_factory
+  #
+  # @example boiler plate methods for Module::Ancestor
+  #   # defined shared example's name will be 'Metasploit::Model::Module::Ancestor', but you only need to give the
+  #   # name relative to 'Metasploit::Model'.
+  #   Metasploit::Model::Spec.shared_examples_for 'Module::Ancestor' do
+  #     module_ancestor_class # '<namespace_name>::Module::Ancestor'
+  #     module_ancestor_factory # '<factory_namespace>_module_ancestor'
+  #     factory_namespace # namespace_name converted to underscore with / replaced by _
+  #     relative_variable_name # 'module_ancestor'
+  #
+  #     let(:base_class) do # automatically defined for you
+  #       module_ancestor_class # same as class method module_ancestor_class
+  #     end
+  #
+  #     context 'factories' do # have to define this yourself since not all mixins use factories.
+  #       context module_ancestor_factory do # using class method
+  #         subject(module_ancestor_factory) do # using class method
+  #           FactoryGirl.build(module_ancestor_factory) # using instance method
+  #         end
+  #       end
+  #     end
+  #   end
+  #
+  # @example Using shared example
+  #   describe Metasploit::Model::Module::Ancestor do
+  #     it_should_behave_like 'Metasploit::Model::Module::Ancestor',
+  #                           namespace_name: 'Dummy'
+  #   end
+  #
+  # @param relative_name [String] name relative to 'Metasploit::Model' prefix.  For example, to declare
+  #   'Metasploit::Model::Module::Ancestor' shared example, `relative_name` would be just 'Module::Ancestor'.
+  # @yield Body of shared examples.
+  # @yieldreturn [void]
+  # @return [void]
+  def self.shared_examples_for(relative_name, &block)
+    fully_qualified_name = "Metasploit::Model::#{relative_name}"
+
+    relative_variable_name = relative_name.underscore.gsub('/', '_')
+    class_method_name = "#{relative_variable_name}_class"
+    factory_method_name = "#{relative_variable_name}_factory"
+
+    # capture block to pass to super so that source_location can be overridden to be block's source_location so that
+    # errors are reported correctly from RSpec.
+    wrapper = ->(options={}) {
+      options.assert_valid_keys(:namespace_name)
+      namespace_name = options.fetch(:namespace_name)
+
+      class_name = "#{namespace_name}::#{relative_name}"
+
       #
-      #   * <relative_variable_name>_class
-      #   * <relative_variable_name>_factory
-      #   * factory_namespace
-      #   * relative_variable_name
-      #   * #<relative_variable_name>_class
-      #   * #<relative_variable_name>_factory
+      # Singleton methods to emulate local variable used to define examples and lets
       #
-      # @example boiler plate methods for Module::Ancestor
-      #   # defined shared example's name will be 'Metasploit::Model::Module::Ancestor', but you only need to give the
-      #   # name relative to 'Metasploit::Model'.
-      #   Metasploit::Model::Spec.shared_examples_for 'Module::Ancestor' do
-      #     module_ancestor_class # '<namespace_name>::Module::Ancestor'
-      #     module_ancestor_factory # '<factory_namespace>_module_ancestor'
-      #     factory_namespace # namespace_name converted to underscore with / replaced by _
-      #     relative_variable_name # 'module_ancestor'
+
+      define_singleton_method(class_method_name) do
+        class_name.constantize
+      end
+
+      define_singleton_method(factory_method_name) do
+        "#{factory_namespace}_#{relative_variable_name}"
+      end
+
+      define_singleton_method(:factory_namespace) do
+        namespace_name.underscore.gsub('/', '_')
+      end
+
+      define_singleton_method(:namespace_name) do
+        namespace_name
+      end
+
+      define_singleton_method(:relative_variable_name) do
+        relative_variable_name
+      end
+
       #
-      #     let(:base_class) do # automatically defined for you
-      #       module_ancestor_class # same as class method module_ancestor_class
-      #     end
+      # Defines to emulate local variable used inside lets
       #
-      #     context 'factories' do # have to define this yourself since not all mixins use factories.
-      #       context module_ancestor_factory do # using class method
-      #         subject(module_ancestor_factory) do # using class method
-      #           FactoryGirl.build(module_ancestor_factory) # using instance method
-      #         end
-      #       end
-      #     end
-      #   end
+
+      define_method(class_method_name) do
+        self.class.send(class_method_name)
+      end
+
+      define_method(factory_method_name) do
+        self.class.send(factory_method_name)
+      end
+
       #
-      # @example Using shared example
-      #   describe Metasploit::Model::Module::Ancestor do
-      #     it_should_behave_like 'Metasploit::Model::Module::Ancestor',
-      #                           namespace_name: 'Dummy'
-      #   end
+      # Default subject uses factory
       #
-      # @param relative_name [String] name relative to 'Metasploit::Model' prefix.  For example, to declare
-      #   'Metasploit::Model::Module::Ancestor' shared example, `relative_name` would be just 'Module::Ancestor'.
-      # @yield Body of shared examples.
-      # @yieldreturn [void]
-      # @return [void]
-      def self.shared_examples_for(relative_name, &block)
-        fully_qualified_name = "Metasploit::Model::#{relative_name}"
-
-        relative_variable_name = relative_name.underscore.gsub('/', '_')
-        class_method_name = "#{relative_variable_name}_class"
-        factory_method_name = "#{relative_variable_name}_factory"
-
-        # capture block to pass to super so that source_location can be overridden to be block's source_location so that
-        # errors are reported correctly from RSpec.
-        wrapper = ->(options={}) {
-          options.assert_valid_keys(:namespace_name)
-          namespace_name = options.fetch(:namespace_name)
-
-          class_name = "#{namespace_name}::#{relative_name}"
-
-          #
-          # Singleton methods to emulate local variable used to define examples and lets
-          #
-
-          define_singleton_method(class_method_name) do
-            class_name.constantize
-          end
-
-          define_singleton_method(factory_method_name) do
-            "#{factory_namespace}_#{relative_variable_name}"
-          end
-
-          define_singleton_method(:factory_namespace) do
-            namespace_name.underscore.gsub('/', '_')
-          end
-
-          define_singleton_method(:namespace_name) do
-            namespace_name
-          end
-
-          define_singleton_method(:relative_variable_name) do
-            relative_variable_name
-          end
-
-          #
-          # Defines to emulate local variable used inside lets
-          #
-
-          define_method(class_method_name) do
-            self.class.send(class_method_name)
-          end
-
-          define_method(factory_method_name) do
-            self.class.send(factory_method_name)
-          end
-
-          #
-          # Default subject uses factory
-          #
-
-          subject(relative_variable_name) do
-            FactoryGirl.build(send(factory_method_name))
-          end
-
-          #
-          # lets
-          #
-
-          let(:base_class) do
-            self.class.send(class_method_name)
-          end
-
-          it_should_behave_like 'Metasploit::Model::Translation',
-                                metasploit_model_ancestor: fully_qualified_name.constantize
-
-          module_eval(&block)
-        }
-
-        # Delegate source_location so that RSpec will report block's source_location as the declaration location of
-        # the shared location instead of this method.
-        wrapper.define_singleton_method(:source_location) do
-          block.source_location
-        end
-
-        super(fully_qualified_name, &wrapper)
+
+      subject(relative_variable_name) do
+        FactoryGirl.build(send(factory_method_name))
       end
+
+      #
+      # lets
+      #
+
+      let(:base_class) do
+        self.class.send(class_method_name)
+      end
+
+      it_should_behave_like 'Metasploit::Model::Translation',
+                            metasploit_model_ancestor: fully_qualified_name.constantize
+
+      module_eval(&block)
+    }
+
+    # Delegate source_location so that RSpec will report block's source_location as the declaration location of
+    # the shared location instead of this method.
+    wrapper.define_singleton_method(:source_location) do
+      block.source_location
     end
+
+    super(fully_qualified_name, &wrapper)
   end
-end
+end

data/lib/metasploit/model/spec/error.rb

@@ -1,9 +1,3 @@
-module Metasploit
-  module Model
-    module Spec
-      # Error raised by Metasploit::Model::Spec methods.
-      class Error < StandardError
-      end
-    end
-  end
-end
+# Error raised by Metasploit::Model::Spec methods.
+class Metasploit::Model::Spec::Error < StandardError
+end

data/lib/metasploit/model/spec/i18n_exception_handler.rb

@@ -1,5 +1,3 @@
-require 'metasploit/model/spec'
-
 # Raises all I18n errors as exceptions so that missing translations (or other errors) with en.yml are caught by the
 # specs.
 #

data/lib/metasploit/model/spec/pathname_collision.rb

@@ -1,30 +1,22 @@
-require 'metasploit/model/spec/error'
-
-module Metasploit
-  module Model
-    module Spec
-      # Error raised if a Pathname already exists on disk when one of the real_paths for metasploit-models factories
-      # is generated or derived, which would indicate that a prior spec did not clean up properly.
-      class PathnameCollision < Metasploit::Model::Spec::Error
-        # Checks if there is a pathname collision.
-        #
-        # @param (see #initialize)
-        # @return [void]
-        # @raise [Metasploit::Model::Spec::PathnameCollision] if `pathname.exist?` is `true`.
-        def self.check!(pathname)
-          if pathname.exist?
-            raise new(pathname)
-          end
-        end
+# Error raised if a Pathname already exists on disk when one of the real_paths for metasploit-models factories
+# is generated or derived, which would indicate that a prior spec did not clean up properly.
+class Metasploit::Model::Spec::PathnameCollision < Metasploit::Model::Spec::Error
+  # Checks if there is a pathname collision.
+  #
+  # @param (see #initialize)
+  # @return [void]
+  # @raise [Metasploit::Model::Spec::PathnameCollision] if `pathname.exist?` is `true`.
+  def self.check!(pathname)
+    if pathname.exist?
+      raise new(pathname)
+    end
+  end
 
-        # @param pathname [Pathname] Pathname that already exists on disk
-        def initialize(pathname)
-          super(
-              "#{pathname} already exists.  " \
+  # @param pathname [Pathname] Pathname that already exists on disk
+  def initialize(pathname)
+    super(
+        "#{pathname} already exists.  " \
               "Metasploit::Model::Spec.remove_temporary_pathname was not called after the previous spec."
-          )
-        end
-      end
-    end
+    )
   end
-end
+end

data/lib/metasploit/model/spec/template/write.rb

@@ -1,5 +1,3 @@
-require 'metasploit/model/spec/template'
-
 # Extend to add a class method to create a new template and write it only if valid.
 #
 # @example extend and write

data/lib/metasploit/model/spec/temporary_pathname.rb

@@ -1,62 +1,53 @@
-# to ensure Metasploit::Model::Spec::Error is setup for autoloading
-require 'metasploit/model/spec'
-
-module Metasploit
-  module Model
-    module Spec
-      # @example Temporary pathname creation and removal
-      #
-      #   # spec/spec_helper.rb
-      #   RSpec.config do |config|
-      #     config.before(:suite) do
-      #       Metasploit::Model::Spec.temporary_pathname = MyApp.root.join('spec', 'tmp')
-      #       # Clean up any left over files from a previously aborted suite
-      #       Metasploit::Model::Spec.remove_temporary_pathname
-      #     end
-      #
-      #     config.after(:each) do
-      #       Metasploit::Model::Spec.remove_temporary_pathname
-      #     end
-      #   end
-      module TemporaryPathname
-        # Removes {#temporary_pathname} from disk if it's been set and exists on disk.
-        #
-        # @return [void]
-        def remove_temporary_pathname
-          begin
-            removal_pathname = temporary_pathname
-          rescue Metasploit::Model::Spec::Error
-            removal_pathname = nil
-          end
+# @example Temporary pathname creation and removal
+#
+#   # spec/spec_helper.rb
+#   RSpec.config do |config|
+#     config.before(:suite) do
+#       Metasploit::Model::Spec.temporary_pathname = MyApp.root.join('spec', 'tmp')
+#       # Clean up any left over files from a previously aborted suite
+#       Metasploit::Model::Spec.remove_temporary_pathname
+#     end
+#
+#     config.after(:each) do
+#       Metasploit::Model::Spec.remove_temporary_pathname
+#     end
+#   end
+module Metasploit::Model::Spec::TemporaryPathname
+  # Removes {#temporary_pathname} from disk if it's been set and exists on disk.
+  #
+  # @return [void]
+  def remove_temporary_pathname
+    begin
+      removal_pathname = temporary_pathname
+    rescue Metasploit::Model::Spec::Error
+      removal_pathname = nil
+    end
 
-          if removal_pathname and removal_pathname.exist?
-            removal_pathname.rmtree
-          end
-        end
+    if removal_pathname and removal_pathname.exist?
+      removal_pathname.rmtree
+    end
+  end
 
-        # Pathname to hold temporary files for metasploit-model factories and sequence.  The directory must be be
-        # safely writable and removable for specs that need to use the file system.
-        #
-        # @return [Pathname]
-        # @raise [Metasploit::Model::Spec::Error] if {#temporary_pathname} is not set prior to calling this method.
-        def temporary_pathname
-          unless instance_variable_defined?(:@temporary_pathname)
-            raise Metasploit::Model::Spec::Error, 'Metasploit::Model::Spec.temporary_pathname not set prior to use'
-          end
+  # Pathname to hold temporary files for metasploit-model factories and sequence.  The directory must be be
+  # safely writable and removable for specs that need to use the file system.
+  #
+  # @return [Pathname]
+  # @raise [Metasploit::Model::Spec::Error] if {#temporary_pathname} is not set prior to calling this method.
+  def temporary_pathname
+    unless instance_variable_defined?(:@temporary_pathname)
+      raise Metasploit::Model::Spec::Error, 'Metasploit::Model::Spec.temporary_pathname not set prior to use'
+    end
 
-          @temporary_pathname
-        end
+    @temporary_pathname
+  end
 
-        # Sets the pathname to use for temporary directories and files used in metasploit_data_models factories and
-        # sequences.
-        #
-        # @param pathname [Pathname] path to a directory.  It does not need to exist, but need to be in a writable parent
-        #   directory so it can be removed by {#remove_temporary_pathname}.
-        # @return [Pathname] `pathname`
-        def temporary_pathname=(pathname)
-          @temporary_pathname = pathname
-        end
-      end
-    end
+  # Sets the pathname to use for temporary directories and files used in metasploit_data_models factories and
+  # sequences.
+  #
+  # @param pathname [Pathname] path to a directory.  It does not need to exist, but need to be in a writable parent
+  #   directory so it can be removed by {#remove_temporary_pathname}.
+  # @return [Pathname] `pathname`
+  def temporary_pathname=(pathname)
+    @temporary_pathname = pathname
   end
 end