metasploit-model 0.24.1.pre.semantic.pre.versioning.pre.2.pre.0

checksums.yaml

@@ -0,0 +1,15 @@
+---
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    ODQwZWQ0ZmRkMTUyNzU3N2MxZDlhZmQ5Y2ViMjc3MGY1ZGZlZDE0Yg==
+  data.tar.gz: !binary |-
+    NDdkOWQ5OTQzYzQxZTUyMmQ5NzU1OTc5Y2U4YTZjMzg2NDBkOTc3Nw==
+SHA512:
+  metadata.gz: !binary |-
+    ZTkwZWVlZDIwMTE0MjRiM2JhZmJlM2Q4OTgzMmI1MzM5ZDMxOWE4MjFlNTE0
+    NjZjZGQ5ZTNjNjM2OWI2NmY4MTVhZGZmMDNjZjJmM2NhYWZlNzU2NmU1MGI1
+    ZmI0M2UwMzFmNzNhOWU4NTg2ZjZkZDdhNThlY2M5Y2VkYjAwZjY=
+  data.tar.gz: !binary |-
+    MWIyZmM2MjRjNmE0NGFjYzcwNTM4MTUzZTFkYWUzYjQ3MmE3ZGEyNGNjNWRk
+    ZDk3NjkxMmE5Y2RiZmJlNTcwMDhkMWRkOThiNDg0MGJkNzhjNDEyYjJhZDZl
+    ZmY1ZjRlMzllYzNjZTU3N2VlYWE2ZTM2YjVhOWE5MjU5YzRlYjc=

data/.coveralls.yml

@@ -0,0 +1 @@
+service_name: travis-ci

data/.gitignore

@@ -0,0 +1,27 @@
+# bundler configuration
+.bundle
+# Mac OS X folder attributes
+.DS_Store
+# built gems
+*.gem
+# Rubymine project configuration
+.idea
+# logs
+*.log
+# Don't check in new rvm version and gemset files
+.ruby-gemset
+.ruby-version
+# Don't check in rvmrc since this is a gem
+.rvmrc
+# YARD database
+.yardoc
+# coverage report directory for simplecov/Rubymine
+coverage
+# generated yardocs
+doc
+# Installed gem versions.  Not stored for the same reasons as .rvmrc
+Gemfile.lock
+# Packaging directory for builds
+pkg/*
+# Database configuration (with passwords) for specs
+spec/dummy/config/database.yml

data/.rspec

@@ -0,0 +1,4 @@
+--backtrace
+--colour
+--drb
+--format nested

data/.simplecov

@@ -0,0 +1,38 @@
+# RM_INFO is set when using Rubymine.  In Rubymine, starting SimpleCov is
+# controlled by running with coverage, so don't explicitly start coverage (and
+# therefore generate a report) when in Rubymine.  This _will_ generate a report
+# whenever `rake spec` is run.
+unless ENV['RM_INFO']
+	SimpleCov.start
+end
+
+SimpleCov.configure do
+  load_adapter('rails')
+
+  # ignore this file
+	add_filter '.simplecov'
+
+	#
+	# Changed Files in Git Group
+	# @see http://fredwu.me/post/35625566267/simplecov-test-coverage-for-changed-files-only
+	#
+
+	untracked = `git ls-files --exclude-standard --others`
+	unstaged = `git diff --name-only`
+	staged = `git diff --name-only --cached`
+	all = untracked + unstaged + staged
+	changed_filenames = all.split("\n")
+
+	add_group 'Changed' do |source_file|
+		changed_filenames.detect { |changed_filename|
+			source_file.filename.end_with?(changed_filename)
+		}
+	end
+
+	#
+	# Specs are reported on to ensure that all examples are being run and all
+	# lets, befores, afters, etc are being used.
+	#
+
+	add_group 'Specs', 'spec'
+end

data/.travis.yml

@@ -0,0 +1,6 @@
+language: ruby
+rvm:
+  - '1.9.3'
+  - '2.0'
+  - '2.1'
+  - 'jruby-19mode'

data/.yardopts

@@ -0,0 +1,5 @@
+--markup markdown
+--private
+--protected
+{app,lib}/**/*.rb
+db/migrate/*.rb

data/Gemfile

@@ -0,0 +1,43 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in metasploit-model.gemspec
+gemspec
+
+# used by dummy application
+group :development, :test do
+  # supplies factories for producing model instance for specs
+  # Version 4.1.0 or newer is needed to support generate calls without the 'FactoryGirl.' in factory definitions syntax.
+  gem 'factory_girl', '>= 4.1.0'
+  # auto-load factories from spec/factories
+  gem 'factory_girl_rails'
+end
+
+group :test do
+  # rails is not used because activerecord should not be included, but rails would normally coordinate the versions
+  # between its dependencies, which is now handled by this constraint.
+  rails_version_constraint = [
+      '>= 3.2.0',
+      '< 4.0.0'
+  ]
+
+  # Dummy app uses actionpack for ActionController, but not rails since it doesn't use activerecord.
+  gem 'actionpack', *rails_version_constraint
+  # Uploads simplecov reports to coveralls.io
+  gem 'coveralls', require: false
+  # Engine tasks are loaded using railtie
+  gem 'railties', *rails_version_constraint
+  gem 'rspec'
+  # need rspec-core >= 2.14.0 because 2.14.0 introduced RSpec::Core::SharedExampleGroup::TopLevel
+  gem 'rspec-core', '>= 2.14.0', '< 3.0.0'
+  # need rspec-rails >= 2.12.0 as 2.12.0 adds support for redefining named subject in nested context that uses the
+  # named subject from the outer context without causing a stack overflow.
+  gem 'rspec-rails', '>= 2.12.0'
+  # In a full rails project, factory_girl_rails would be in both the :development, and :test group, but since we only
+  # want rails in :test, factory_girl_rails must also only be in :test.
+  # add matchers from shoulda, such as validates_presence_of, which are useful for testing validations
+  gem 'shoulda-matchers'
+  # code coverage of tests
+  gem 'simplecov', :require => false
+  # defines time zones for activesupport.  Must be explicit since it is normally implicit with activerecord
+  gem 'tzinfo'
+end

data/LICENSE

@@ -0,0 +1,27 @@
+Copyright (C) 2012-2013, Rapid7, Inc.
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without modification,
+are permitted provided that the following conditions are met:
+
+    * Redistributions of source code must retain the above copyright notice,
+	  this list of conditions and the following disclaimer.
+
+    * Redistributions in binary form must reproduce the above copyright notice,
+	  this list of conditions and the following disclaimer in the documentation
+	  and/or other materials provided with the distribution.
+
+    * Neither the name of Rapid7 LLC nor the names of its contributors
+	  may be used to endorse or promote products derived from this software
+	  without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
+ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
+WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
+ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
+(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
+LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
+ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
+SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

data/README.md

@@ -0,0 +1,33 @@
+# Metasploit::Model [![Build Status](https://travis-ci.org/rapid7/metasploit-model.png?branch=feature/exploit)](https://travis-ci.org/rapid7/metasploit-model)[![Coverage Status](https://coveralls.io/repos/rapid7/metasploit-model/badge.png?branch=feature%2Fexploit)](https://coveralls.io/r/rapid7/metasploit-model?branch=feature%2Fexploit)
+
+## Versioning
+
+`Metasploit::Model` is versioned using [semantic versioning 2.0](http://semver.org/spec/v2.0.0.html).  Each branch
+should set `Metasploit::Model::Version::PRERELEASE` to the branch name, while master should have no `PRERELEASE`
+and the `PRERELEASE` section of `Metasploit::Model::VERSION` does not exist.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'metasploit-model'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install metasploit-model
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,52 @@
+#!/usr/bin/env rake
+begin
+	require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+print_without = false
+APP_RAKEFILE = File.expand_path('../spec/dummy/Rakefile', __FILE__)
+
+begin
+  load 'rails/tasks/engine.rake'
+rescue LoadError
+  puts "railties not in bundle, so can't load engine tasks."
+  print_without = true
+end
+
+Bundler::GemHelper.install_tasks
+
+#
+# load rake files like a normal rails app
+# @see http://viget.com/extend/rails-engine-testing-with-rspec-capybara-and-factorygirl
+#
+
+pathname = Pathname.new(__FILE__)
+root = pathname.parent
+rakefile_glob = root.join('lib', 'tasks', '**', '*.rake').to_path
+
+Dir.glob(rakefile_glob) do |rakefile|
+  load rakefile
+end
+
+begin
+  require 'rspec/core'
+rescue LoadError
+  puts "rspec not in bundle, so can't set up spec tasks.  " \
+       "To run specs ensure to install the development and test groups."
+  print_without = true
+else
+  require 'rspec/core/rake_task'
+
+  # @see http://viget.com/extend/rails-engine-testing-with-rspec-capybara-and-factorygirl
+  RSpec::Core::RakeTask.new(:spec)
+
+  task :default => :spec
+end
+
+if print_without
+  puts "Bundle currently installed '--without #{Bundler.settings.without.join(' ')}'."
+  puts "To clear the without option do `bundle install --without ''` (the --without flag with an empty string) or " \
+       "`rm -rf .bundle` to remove the .bundle/config manually and then `bundle install`"
+end

data/app/models/metasploit/model/association/reflection.rb

@@ -0,0 +1,46 @@
+# Reflection of the call to {Metasploit::Model::Association::ClassMethods#association}.
+class Metasploit::Model::Association::Reflection < Metasploit::Model::Base
+  #
+  # Attributes
+  #
+
+  # @!attribute [rw] class_name
+  #   The name {#klass}.  The name of {#klass} is given instead of {#klass} directly when initializing this
+  #   reflection to prevent circular references with autoloading or ActiveSupport::Dependencies loading.
+  #
+  #   @return [String] Fully-qualified name of class in this association
+  attr_accessor :class_name
+
+  # @!attribute [rw] model
+  #   The model on which this association was declared.  The equivalent for ActiveRecord association reflections
+  #   would be #active_record.
+  #
+  #   @return [Class]
+  attr_accessor :model
+
+  # @!attribute [rw] name
+  #   The name of this association.
+  #
+  #   @return [String]
+  attr_accessor :name
+
+  #
+  # Validations
+  #
+
+  validates :model, :presence => true
+  validates :name, :presence => true
+  validates :class_name, :presence => true
+
+  #
+  # Methods
+  #
+
+  # Class with name {#class_name}.
+  #
+  # @return []
+  # @raise [NameError] if {#class_name} cannot be constantized
+  def klass
+    class_name.constantize
+  end
+end

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

@@ -0,0 +1,125 @@
+# 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

@@ -0,0 +1,92 @@
+# 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