metasploit-model 0.28.0 → 0.29.0

data/app/models/metasploit/model/module/ancestor/spec/template.rb

@@ -1,125 +0,0 @@
-# Writes templates for the {#module_ancestor} to disk.
-#
-# @example Update files after changing
-#   module_ancestor = FactoryGirl.build(
-#     :dummy_module_ancestor
-#   )
-#   # factory already wrote template when build returned
-#
-#   # update
-#   module_ancestor.module_type = FactoryGirl.generate :metasploit_model_module_type
-#
-#   # Now the template on disk is different than the module_ancestor, so regenerate the template
-#   Metasploit::Model::Module::Ancestor::Spec::Template.write(module_ancestor: module_ancestor)
-class Metasploit::Model::Module::Ancestor::Spec::Template < Metasploit::Model::Spec::Template
-  extend Metasploit::Model::Spec::Template::Write
-
-  #
-  # CONSTANTS
-  #
-
-  # Default value for {#search_pathnames}.
-  DEFAULT_SEARCH_PATHNAMES = [
-      Pathname.new('module/ancestors')
-  ]
-  # Default value for {#source_relative_name}.
-  DEFAULT_SOURCE_RELATIVE_NAME = 'base'
-
-  #
-  # Attributes
-  #
-
-  # @!attribute [rw] metasploit_module_relative_name
-  #   The name of the Class/Module in the template.  Defaults to
-  #   `FactoryGirl.generate :metasploit_model_module_ancestor_metasploit_module_relative_name`.
-  #
-  #   @return [String]
-  attr_writer :metasploit_module_relative_name
-
-  # @!attribute [rw] module_ancestor
-  #   The module ancestor to write.
-  #
-  #   @return [Metasploit::Model::Module::Ancestor]
-  attr_accessor :module_ancestor
-
-  #
-  # Validations
-  #
-
-  validates :module_ancestor,
-            presence: true
-
-  #
-  # Methods
-  #
-
-  # The pathname where to {#write} to template results.
-  #
-  # @return [Pathname] `Metasploit::Model::Module::Ancestor#real_pathname.
-  # @return [nil] if {#module_ancestor} is `nil`.
-  # @return [nil] if {#module_ancestor #module_ancestor's} `Metasploit::Model::Module::Ancestor#real_pathname` is `nil`
-  #   after derivation.
-  def destination_pathname
-    unless instance_variable_defined? :@destination_pathname
-      @destination_pathname = nil
-
-      if module_ancestor
-        destination_pathname = module_ancestor.real_pathname
-
-        unless destination_pathname
-          # validate to derive real_path and therefore real_pathname
-          module_ancestor.valid?
-
-          destination_pathname = module_ancestor.real_pathname
-        end
-
-        @destination_pathname = destination_pathname
-      end
-    end
-
-    @destination_pathname
-  end
-
-  # Local variables exposed to partials.
-  #
-  # @return [Hash{Symbol => Object}] {#metasploit_module_relative_name} as :metasploit_module_relative_name and
-  #   {#module_ancestor} at :module_ancestor.
-  def locals
-    @locals ||= {
-        metasploit_module_relative_name: metasploit_module_relative_name,
-        module_ancestor: module_ancestor
-    }
-  end
-
-  # Name of the Class/Module declared in the template file.
-  #
-  # @return [String]
-  def metasploit_module_relative_name
-    @metasploit_module_relative_name ||= FactoryGirl.generate :metasploit_model_module_ancestor_metasploit_module_relative_name
-  end
-
-  # Whether to overwrite a pre-existing file.
-  #
-  # @return [Boolean] Defaults to `false` since nothing should write the template before the ancestor.
-  def overwrite
-    unless instance_variable_defined? :@overwrite
-      @overwrite = false
-    end
-
-    @overwrite
-  end
-
-  # Pathnames to search for partials.
-  #
-  # @return [Array<Pathname>]  {DEFAULT_SEARCH_PATHNAMES}
-  def search_pathnames
-    @search_pathnames ||= DEFAULT_SEARCH_PATHNAMES.dup
-  end
-
-  # Name of template under {#search_pathnames} without {EXTENSION}.
-  #
-  # @return [String] Defaults to {DEFAULT_SOURCE_RELATIVE_NAME}.
-  def source_relative_name
-    @source_relative_name ||= DEFAULT_SOURCE_RELATIVE_NAME
-  end
-end

data/app/models/metasploit/model/module/class/spec/template.rb

@@ -1,92 +0,0 @@
-# Writes templates for the {#module_class #module_class's} {Metasploit::Model::Module::Class#ancestors} to disk.
-#
-# @example Update files after changing associations
-#   module_class = FactoryGirl.build(
-#     :dummy_module_class
-#   )
-#   # factory already wrote template when build returned
-#
-#   # update associations
-#   rank = FactoryGirl.generate :dummy_rank
-#   module_class.rank = rank
-#
-#   # Now the template on disk is different than the module_class, so regenerate the template
-#   Metasploit::Model::Module::Class::Spec::Template.write(module_class: module_class)
-class Metasploit::Model::Module::Class::Spec::Template < Metasploit::Model::Base
-  extend Metasploit::Model::Spec::Template::Write
-
-  #
-  # Attributes
-  #
-
-  # @!attribute [rw] module_class
-  #   The {Metasploit::Model::Module::Class} whose {Metasploit::Model::Module::Class#ancestors} need to be templated in
-  #   {#ancestor_templates}.
-  #
-  #   @return [Metasploit::Model::Module::Class]
-  attr_accessor :module_class
-
-  #
-  # Validations
-  #
-
-  validates :module_class,
-            presence: true
-  validate :ancestor_templates_valid
-
-  #
-  # Methods
-  #
-
-  # Template for {#module_class} {Metasploit::Model::Module::Class#ancestors} with the addition of {#module_class} to
-  # the {Metasploit::Model::Spec::Template#locals} and adding 'module/classes' to the front of the
-  # {Metasploit::Model::Spec::Template#search_pathnames}.
-  #
-  # @return [Array<Metasploit::Model::Module::Ancestor::Spec::Template>]
-  # @return [[]] if {#module_class} is `nil`.
-  def ancestor_templates
-    unless instance_variable_defined? :@ancestor_templates
-      if module_class
-        @ancestor_templates = module_class.ancestors.collect { |module_ancestor|
-          Metasploit::Model::Module::Ancestor::Spec::Template.new(
-              module_ancestor: module_ancestor
-          ).tap { |module_ancestor_template|
-            module_ancestor_template.locals[:module_class] = module_class
-            module_ancestor_template.overwrite = true
-
-            module_ancestor_template.search_pathnames.unshift(
-                Pathname.new('module/classes')
-            )
-          }
-        }
-      end
-
-      @ancestor_templates ||= []
-    end
-
-    @ancestor_templates
-  end
-
-  # Writes {#ancestor_templates} to disk.
-  #
-  # @return [void]
-  # @raise (see Metasploit::Model::Spec::Template)
-  def write
-    ancestor_templates.each(&:write)
-  end
-
-  private
-
-  # Validates that all {#ancestor_templates} are valid.
-  #
-  # @return [void]
-  def ancestor_templates_valid
-    # can't use ancestor_templates.all?(&:valid?) as it will short-circuit and want all ancestor_templates to have
-    # validation errors
-    valids = ancestor_templates.map(&:valid?)
-
-    unless valids.all?
-      errors.add(:ancestor_templates, :invalid, value: ancestor_templates)
-    end
-  end
-end

data/app/models/metasploit/model/module/instance/spec/template.rb

@@ -1,97 +0,0 @@
-# Writes templates for the {#module_instance #module_instance's}
-# {Metasploit::Model::Module::Instance#module_class #module_class's} {Metasploit::Model::Module::Class#ancestors} to
-# disk.
-#
-# @example Update files after changing associations
-#   module_instance = FactoryGirl.build(
-#     :dummy_module_instance,
-#     module_architectures_length: 0
-#   )
-#   # factory already wrote template when build returned
-#
-#   # update associations
-#   architecture = FactoryGirl.generate :dummy_architecture
-#   module_instance.module_architectures = FactoryGirl.build_list(
-#     :dummy_module_architecture,
-#     1,
-#     architecture: architecture
-#   )
-#
-#   # Now the template on disk is different than the module_instance, so regenerate the template
-#   Metasploit::Model::Module::Instance::Spec::Template.write(module_instance: module_instance)
-class Metasploit::Model::Module::Instance::Spec::Template < Metasploit::Model::Base
-  extend Metasploit::Model::Spec::Template::Write
-
-  #
-  # Attributes
-  #
-
-  # @!attribute [rw] module_instance
-  #   The {Metasploit::Model::Module::Instance} whose {Metasploit::Model::Module::Instance#module_class} needs to be
-  #   templated in {#class_template}.
-  #
-  #   @return [Metasploit::Model::Module::Instance]
-  attr_accessor :module_instance
-
-  #
-  # Validations
-  #
-
-  validates :class_template,
-            presence: true
-  validates :module_instance,
-            presence: true
-  validate :class_template_valid
-
-  #
-  # Methods
-  #
-
-  # Template for {#module_instance} {Metasploit::Model::Module::Instance#module_class} with the addition of
-  # {#module_instance} to the {Metasploit::Model::Spec::Template#locals} and adding 'module/instances' to the front of
-  # the {Metasploit::Model::Spec::Template#search_pathnames}.
-  #
-  # @return [Metasploit::Model::Module::Class::Spec::Template] if {#module_instance} present.
-  # @return [nil] if {#module_instance} is `nil`.
-  def class_template
-    unless instance_variable_defined? :@class_template
-      if module_instance
-        class_template = Metasploit::Model::Module::Class::Spec::Template.new(
-            module_class: module_instance.module_class
-        )
-        class_template.ancestor_templates.each do |ancestor_template|
-          ancestor_template.locals[:module_instance] = module_instance
-
-          ancestor_template.search_pathnames.unshift(
-              Pathname.new('module/instances')
-          )
-        end
-
-        @class_template = class_template
-      else
-        @class_template = nil
-      end
-    end
-
-    @class_template
-  end
-
-  # @!method write
-  #   Writes {#class_template} to disk.
-  #
-  #   @return [void]
-  #   @raise (see Metasploit::Model::Spec::Template)
-  delegate :write,
-           to: :class_template
-
-  private
-
-  # Validates that {#class_template} is valid when present.
-  #
-  # @return [void]
-  def class_template_valid
-    if class_template && !class_template.valid?
-      errors.add(:class_template, :invalid, value: class_template)
-    end
-  end
-end

data/app/models/metasploit/model/spec/template.rb

@@ -1,277 +0,0 @@
-# Processes {EXTENSION '.rb.erb'} templates to create {Metasploit::Model::Module::Ancestor#contents} that contain the
-# same metadata as the {Metasploit::Model::Module::Ancestor},
-# {Metasploit::Model::Module::Class}, {Metasploit::Model::Module::Instance} and associations for those contents.  This
-# ensures that when the {Metasploit::Model::Module::Ancestor#contents} are loaded in metasploit-framework, the same
-# metadata instances are derived from the contents ensuring idempotency of the contents and metadata parsing loop.
-class Metasploit::Model::Spec::Template < Metasploit::Model::Base
-  extend ActiveSupport::Autoload
-  extend ActiveModel::Callbacks
-
-  include ActiveModel::Validations::Callbacks
-
-  autoload :Write
-
-  #
-  # CONSTANTS
-  #
-
-  # Regular expression to parse file from backtrace line
-  BACKTRACE_FILE_REGEXP = /(?<file>.*):\d+:in .*/
-  # Trim mode for ERB templates so that lines using <%- -%> will be trimmed of new lines
-  EXPLICIT_TRIM_MODE = '-'
-  # File extension for templates.
-  EXTENSION = '.rb.erb'
-
-  #
-  # Attributes
-  #
-
-  # @!attribute [rw] destination_pathname
-  #   The pathname where to {#write} the template results.
-  #
-  #   @return [String]
-  attr_accessor :destination_pathname
-
-  # @!attribute [rw] locals
-  #   Local variables to exposed to partials.
-  #
-  #   @return [Hash{Symbol => Object}]
-  attr_accessor :locals
-
-  # @!attribute [rw] overwrite
-  #   Whether to overwrite a pre-existing file.
-  #
-  #   @return [Boolean]
-  attr_accessor :overwrite
-
-  # @!attribute [rw] search_pathnames
-  #   Pathnames to search for partials.  First item is search first, etc.
-  #
-  #   @return [Array<Pathname>]
-  attr_accessor :search_pathnames
-
-  # @!attribute [rw] source_relative_name
-  #   Name of template under {#search_pathnames} without {EXTENSION} similar to how to refer to partials.
-  #
-  #   @return [String]
-  attr_accessor :source_relative_name
-
-
-  #
-  # Callbacks
-  #
-
-  before_validation :search_real_pathnames
-
-  #
-  # Validations
-  #
-
-  validates :destination_pathname,
-            presence: true
-  validates :overwrite,
-            inclusion: {
-                in: [
-                    false,
-                    true
-                ]
-            }
-  validates :search_pathnames,
-            length: {
-                minimum: 1
-            }
-  validates :source_pathname,
-            presence: true
-
-  #
-  # Methods
-  #
-
-  # Converts the `partial_relative_path` to a real (absolute) pathname that can be passed to {#result} by finding the
-  # corresponding file in the {#search_pathnames}.
-  #
-  # @param partial_relative_path [String] partial path name as used in Rails, so no search_pathname prefix and no '_'
-  #   or file extension in the basename.
-  # @return (see #find_pathname)
-  def partial_pathname(partial_relative_path)
-    partial_relative_pathname = Pathname.new(partial_relative_path)
-    relative_directory = partial_relative_pathname.dirname
-    raw_basename = partial_relative_pathname.basename
-    partial_basename = "_#{raw_basename}#{EXTENSION}"
-    relative_pathname = relative_directory.join(partial_basename)
-
-    find_pathname(relative_pathname)
-  end
-
-  # Renders partial in templates.
-  #
-  # @param partial_relative_path [String] relative path to partial without extension and no leading '_' to match
-  #   Rails convention.
-  # @param options (see #result)
-  # @option (see #result)
-  # @return [String, nil] result of rendering partial.
-  def render(partial_relative_path, options={})
-    pathname = partial_pathname(partial_relative_path)
-    result(pathname, options)
-  end
-
-  # Renders the super template of the current template by searching for the template of the same name under super
-  # {#search_pathnames} (those that have a higher index).
-  #
-  # @return [String, nil] result of rendering super partial.
-  # @raise [IOError] if super template can't be found on super search pathnames.
-  # @raise [RegexpError] if file can't be parsed from backtrace.
-  def render_super
-    super_pathname = nil
-    backtrace = caller
-    match = BACKTRACE_FILE_REGEXP.match(backtrace[0])
-
-    if match
-      real_path = match[:file]
-      current_search_pathname_found = false
-      relative_pathname = nil
-
-      search_pathnames.each do |search_pathname|
-        # find the current index
-        unless current_search_pathname_found
-          if real_path.starts_with?(search_pathname.to_path)
-            current_search_pathname_found = true
-
-            real_pathname = Pathname.new(real_path)
-            relative_pathname = real_pathname.relative_path_from(search_pathname)
-          end
-          # then switch to finding the next (super) index
-        else
-          real_pathname = search_pathname.join(relative_pathname)
-
-          if real_pathname.exist?
-            super_pathname = real_pathname
-            break
-          end
-        end
-      end
-
-      unless super_pathname
-        raise IOError, "Couldn't find super template"
-      end
-    else
-      raise RegexpError, "Can't parse file from backtrace to determine current search path"
-    end
-
-    result(super_pathname)
-  end
-
-  # @note Must be an instance method
-  # @param pathname [Pathname] pathname to template
-  # @param options [Hash{Symbol => Object}]
-  # @option options [Hash{Symbol => Object}] :locals Maps name of locals to their value for this result.  Can override
-  #   {#locals}.
-  def result(pathname, options={})
-    options.assert_valid_keys(:locals)
-
-    if pathname
-      content = pathname.read
-      safe_level = nil
-      template = ERB.new content, safe_level, EXPLICIT_TRIM_MODE
-      template.filename = pathname.to_path
-
-      erb_binding = binding.dup
-      locals = self.locals || {}
-      result_locals = options[:locals] || {}
-      merged_locals = locals.merge(result_locals)
-
-      merged_locals.each do |name, value|
-        erb_binding.eval("#{name} = nil; lambda { |value| #{name} = value }").call(value)
-      end
-
-      # use current binding to allow templates to call {#render} and then use {#method_missing} to allow access to
-      # locals
-      template.result(erb_binding)
-    else
-      ''
-    end
-  end
-
-  class << self
-    # The root of all relative {#search_pathnames}.  By changing {root} you can use your own set of templates.
-    #
-    # @return [Pathname] Defaults to 'spec/support/templates/metasploit/model' under Metasploit::Model.root.
-    def root
-      @@root ||= Metasploit::Model::Engine.root.join('spec', 'support', 'templates', 'metasploit', 'model')
-    end
-
-    # Sets the {root} pathname for all {#search_pathnames}, including those on subclasses.
-    #
-    # @param root [Pathname]
-    # @return [Pathname]
-    def root=(root)
-      @@root = root
-    end
-  end
-
-  # Converts {#source_relative_name} to a real (absolute) pathname.
-  #
-  # @return (see #find_pathname)
-  def source_pathname
-    unless instance_variable_defined? :@source_pathname
-      relative_path = "#{source_relative_name}#{EXTENSION}"
-      @source_pathname = find_pathname(relative_path)
-    end
-
-    @source_pathname
-  end
-
-  # Writes result of template to {#destination_pathname}.
-  #
-  # @return [void]
-  # @raise [Metasploit::Model::Spec::PathnameCollision] if {#overwrite} is false and {#destination_pathname} already
-  #   exists.
-  def write
-    unless overwrite
-      Metasploit::Model::Spec::PathnameCollision.check!(destination_pathname)
-    end
-
-    result = self.result(source_pathname)
-
-    # make directory
-    destination_pathname.parent.mkpath
-
-    destination_pathname.open('wb') do |f|
-      f.write(result)
-    end
-  end
-
-  private
-
-  # Finds relative_path under {#search_pathnames}
-  #
-  # @return [Pathname] if relative_path exists under a search path.
-  # @return [nil] if `relative_path` does not exist under a search path.
-  def find_pathname(relative_path)
-    found_pathname = nil
-
-    search_pathnames.each do |search_pathname|
-      real_pathname = search_pathname.join(relative_path)
-
-      if real_pathname.exist?
-        found_pathname = real_pathname
-        break
-      end
-    end
-
-    found_pathname
-  end
-
-  # Makes sure all {#search_pathnames} are real (absolute).  Relative pathnames are resolved against {root}.
-  #
-  # @return [void]
-  def search_real_pathnames
-    search_pathnames.collect! { |search_pathname|
-      if search_pathname.relative?
-        self.class.root.join(search_pathname)
-      else
-        search_pathname
-      end
-    }
-  end
-end