metasploit-concern 0.0.2

checksums.yaml

@@ -0,0 +1,15 @@
+---
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    MDM5ZDczNDk1NzkwNTYzMTMzZGZlMTNlMmY3NzJjNDExMDMyNDg1Zg==
+  data.tar.gz: !binary |-
+    ODI3MTBjNzAxNDdhNWY3ZTliYjVmMjFjN2NmNWU0MTM5NTY5Mjc2OA==
+SHA512:
+  metadata.gz: !binary |-
+    MDBiMzliNWFlYzk5OWZjOGExMjc4MDYxZjQyMzJlNjRlYzIxNjJiNWFkM2Y3
+    N2ViNjYxY2MyZmM3MzUxMGY5YTg2NmE5YmJmNTkxZTU3MGY5Mzk3YmNhMjZk
+    NTk4YmMyODYwYTI1YTk0MWI2MDRmNjc4NTVkMTRlMjE3ZWI0NTQ=
+  data.tar.gz: !binary |-
+    ODM0MGY3YTZiMTNkOTYwYTg5NWRjMDIxN2JlZDA2ZDllYTVmN2E2Y2ZkZDEy
+    OGU3MDQyZWEyZmY5ZWFlZDcxM2ZlODg0Zjg4MGVkNmU2YjM4ZjUwYjc3YWY4
+    YThlYzE0Mjg5MGYyMmE4ZjlmYTZjNDAyMGJkMWI5ZTIxYWU4NmY=

data/LICENSE

@@ -0,0 +1,30 @@
+```
+Copyright (c) 2013 Rapid7, Inc.
+
+License: BSD-3-clause
+
+ 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,7 @@
+# Metasploit::Concern [![Build Status](https://travis-ci.org/rapid7/metasploit-concern.png)](https://travis-ci.org/rapid7/metasploit-concern)[![Code Climate](https://codeclimate.com/github/rapid7/metasploit-concern.png)](https://codeclimate.com/github/rapid7/metasploit-concern)[![Coverage Status](https://coveralls.io/repos/rapid7/metasploit-concern/badge.png)](https://coveralls.io/r/rapid7/metasploit-concern)[![Dependency Status](https://gemnasium.com/rapid7/metasploit-concern.png)](https://gemnasium.com/rapid7/metasploit-concern)[![Gem Version](https://badge.fury.io/rb/metasploit-concern.png)](http://badge.fury.io/rb/metasploit-concern)
+
+## Versioning
+
+`Metasploit::Concern` is versioned using [semantic versioning 2.0](http://semver.org/spec/v2.0.0.html).  Each branch
+should set `Metasploit::Concern::Version::PRERELEASE` to the branch name, while master should have no `PRERELEASE`
+and the `PRERELEASE` section of `Metasploit::Concern::VERSION` does not exist.

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/concern/loader.rb

@@ -0,0 +1,129 @@
+# Loads ActiveSupport::Concerns (or anything that can be passed to `include` really) under {#root}
+class Metasploit::Concern::Loader
+  include ActiveModel::Validations
+
+  #
+  # Attributes
+  #
+
+  # @!attributes [rw] root
+  #   Pathname under which to find concerns.
+  #
+  #   @return [Pathname]
+  attr_accessor :root
+
+  #
+  # Validations
+  #
+
+  validates :root,
+            presence: true
+
+  #
+  # Methods
+  #
+
+  # Yields each constant under `parent_pathname`.
+  #
+  # @param parent_pathname [Pathname]
+  # @yield [constant]
+  # @yieldparam constant [Module] constant declared under `parent_pathname`.
+  # @yieldreturn [void]
+  # @return [void]
+  def each_pathname_constant(parent_pathname)
+    parent_pathname.each_child do |child_pathname|
+      constant = constantize_pathname(child_pathname)
+
+      if constant
+        yield constant
+      end
+    end
+  end
+
+  # Glob pattern for concerns.
+  #
+  # @return [Pathname]
+  def glob
+    root.join('**', '*.rb')
+  end
+
+  # @param attributes [Hash{Symbol => String,nil}]
+  def initialize(attributes={})
+    attributes.each do |attribute, value|
+      public_send("#{attribute}=", value)
+    end
+  end
+
+  # Set of Pathnames for `Module`s that will have concerns included.
+  #
+  # @return [Set<Pathname>]
+  def module_pathname_set
+    concern_paths = Dir.glob(glob)
+
+    concern_paths.each_with_object(Set.new) { |concern_path, module_pathname_set|
+      concern_pathname = Pathname.new(concern_path)
+      module_pathname = concern_pathname.parent
+
+      module_pathname_set.add module_pathname
+    }
+  end
+
+  # Registers load hooks with `ActiveSupport.on_load`.
+  #
+  # @return [void]
+  def register
+    module_pathname_set.each do |module_pathname|
+      relative_module_pathname = module_pathname.relative_path_from(root)
+      relative_module_path = relative_module_pathname.to_path
+      underscored_module_name = relative_module_path.gsub(File::SEPARATOR, '_')
+      on_load_name = underscored_module_name.to_sym
+
+      # on_load block is instance_evaled, so need to capture self
+      loader = self
+
+      ActiveSupport.on_load(on_load_name) do
+        loader.each_pathname_constant(module_pathname) do |concern|
+          include concern
+        end
+
+        if defined?(Rails) && Rails.env.development?
+          unloadable
+        end
+      end
+    end
+  end
+
+  private
+
+  # Converts `descendant_pathname`, which should be under {#root}, into a constant.
+  #
+  # @param descendant_pathname [Pathname] a Pathname under {#root}.
+  # @return [Object] if {#pathname_to_constant_name} returns a constant name
+  # @return [nil] otherwise
+  def constantize_pathname(descendant_pathname)
+    constant_name = pathname_to_constant_name(descendant_pathname)
+
+    constant = nil
+
+    if constant_name
+      constant = constant_name.constantize
+    end
+
+    constant
+  end
+
+  # Converts `descendant_pathname`, which should be under {#root}, into a constant name.
+  #
+  # @param descendant_pathname [Pathname] a Pathname under {#root}.
+  def pathname_to_constant_name(descendant_pathname)
+    extension_name = descendant_pathname.extname
+    constant_name = nil
+
+    if extension_name == '.rb'
+      constant_pathname = descendant_pathname.relative_path_from(root)
+      constant_name = constant_pathname.to_s.gsub(/.rb$/, '').camelize
+    end
+
+    constant_name
+  end
+end

data/config/initializers/load_concerns.rb

@@ -0,0 +1,23 @@
+application = Rails.application
+engines = application.railties.engines
+
+# application is an engine
+engines = [application, *engines]
+
+engines.each do |engine|
+  concerns_path = engine.paths['app/concerns']
+
+  if concerns_path
+    concerns_directories = concerns_path.existent_directories
+  else
+    # app/concerns is not set, so just derive it from root.  Cannot derive from app because it will glob app/models too
+    concerns_directories = [engine.root.join('app', 'concerns').to_path]
+  end
+
+  concerns_directories.each do |concerns_directory|
+    concerns_pathname = Pathname.new(concerns_directory)
+    loader = Metasploit::Concern::Loader.new(root: concerns_pathname)
+    loader.register
+  end
+end
+

data/lib/metasploit/concern.rb

@@ -0,0 +1,73 @@
+# Only include the Rails engine when using Rails.  This is for compatibility with metasploit-framework.
+if defined? Rails
+  require 'metasploit/concern/engine'
+end
+
+# Shared namespace for metasploit gems; used in {https://github.com/rapid7/metasploit-concern metasploit-concern},
+# {https://github.com/rapid7/metasploit-framework metasploit-framework}, and
+# {https://github.com/rapid7/metasploit-model metasploit-model}
+module Metasploit
+  # Automates the inclusion of concerns into classes and models from other `Rail::Engine`s by use of an app/concerns
+  # directory in the `Rails::Engine` that declares the concerns.
+  #
+  # The `Class` or `Module` must support the use of concerns by calling ActiveSupport.run_load_hooks with a symbol equal
+  # to the underscore of its name with any '/' replaced with underscores also.
+  #
+  # @example engine_that_supports_concerns/app/models/model_that_supports_concerns.rb
+  #   class EngineThatSupportsConcerns::ModelThatSupportsConcerns
+  #     # declared as last statement in body so that concerns can redefine everything in class
+  #     ActiveSupport.run_load_hooks(:engine_that_supports_concerns_model_that_supports_concerns, self)
+  #   end
+  #
+  # To include concerns from a Rails::Application add 'app/concerns' to paths and then declare concerns under
+  # app/concerns.
+  #
+  # @example config/application.rb
+  #   config.paths.add 'app/concerns', autoload: true
+  #
+  # @example Concern declared in application
+  #   # app/concerns/engine_that_supports_concerns/model_that_supports_concerns/concern_from_application.rb
+  #   module EngineThatSupportsConcerns::ModelThatSupportsConcerns::ConcernFromApplication
+  #     extend ActiveSupport::Concern
+  #
+  #     included do
+  #       # run with self equal to EngineThatSupportsConcerns::ModelThatSupportsConcerns, but at the end of the class
+  #       # definition, instead of at the beginning as would be the case with
+  #       #   class EngineThatSupportsConcerns::ModelThatSupportsConcerns
+  #       #     include EngineThatSupportsConcerns::ModelThatSupportsConcerns::ModelThatSupportsConcerns
+  #       #
+  #       #     # body
+  #       #   end
+  #     end
+  #   end
+  #
+  # To include concerns from a Rails::Engine add 'app/concerns' to the paths and then declare concerns under
+  # app/concerns.
+  #
+  # @example Rails::Engine configuration for app/concerns
+  #   # engine_defining_concerns/lib/engine_defining_concerns/engine.rb
+  #   module EngineDefiningConcerns
+  #     class Engine < Rails::Engine
+  #       config.paths.add 'app/concerns', autoload: true
+  #     end
+  #   end
+  #
+  # @example Concern declared in Rails::Engine
+  #   # engine_defining_concerns/app/concerns
+  #   module EngineThatSupportsConcerns::ModelThatSupportsConcerns::ConcernFromEngine
+  #     extend ActiveSupport::Concern
+  #
+  #     included do
+  #       # run with self equal to EngineThatSupportsConcerns::ModelThatSupportsConcerns, but at the end of the class
+  #       # definition, instead of at the beginning as would be the case with
+  #       #   class EngineThatSupportsConcerns::ModelThatSupportsConcerns
+  #       #     include EngineThatSupportsConcerns::ModelThatSupportsConcerns::ModelThatSupportsConcerns
+  #       #
+  #       #     # body
+  #       #   end
+  #     end
+  #   end
+  module Concern
+
+  end
+end

data/lib/metasploit/concern/engine.rb

@@ -0,0 +1,20 @@
+begin
+  require 'rails'
+rescue LoadError => error
+  warn "rails could not be loaded, so Metasploit::Concern::Engine will not be defined: #{error}"
+else
+  module Metasploit
+    module Concern
+      class Engine < ::Rails::Engine
+        # @see http://viget.com/extend/rails-engine-testing-with-rspec-capybara-and-factorygirl
+        config.generators do |g|
+          g.assets false
+          g.helper false
+          g.test_framework :rspec, fixture: false
+        end
+
+        isolate_namespace Metasploit::Concern
+      end
+    end
+  end
+end

data/lib/metasploit/concern/version.rb

@@ -0,0 +1,31 @@
+module Metasploit
+  module Concern
+    # Holds components of {VERSION} as defined by {http://semver.org/spec/v2.0.0.html semantic versioning v2.0.0}.
+    module Version
+      # The major version number.
+      MAJOR = 0
+      # The minor version number, scoped to the {MAJOR} version number.
+      MINOR = 0
+      # The patch number, scoped to the {MINOR} version number.
+      PATCH = 2
+
+      # The full version string, including the {MAJOR}, {MINOR}, {PATCH}, and optionally, the `PRERELEASE` in the
+      # {http://semver.org/spec/v2.0.0.html semantic versioning v2.0.0} format.
+      #
+      # @return [String] '{MAJOR}.{MINOR}.{PATCH}' on master.  '{MAJOR}.{MINOR}.{PATCH}-<PRERELEASE>' on any branch
+      #   other than master.
+      def self.full
+        version = "#{MAJOR}.#{MINOR}.#{PATCH}"
+
+        if defined? PRERELEASE
+          version = "#{version}-#{PRERELEASE}"
+        end
+
+        version
+      end
+    end
+
+    # @see Version.full
+    VERSION = Version.full
+  end
+end

data/lib/tasks/yard.rake

@@ -0,0 +1,30 @@
+# @note All options not specific to any given rake task should go in the .yardopts file so they are available to both
+#   the below rake tasks and when invoking `yard` from the command line
+
+if defined? YARD
+  namespace :yard do
+    YARD::Rake::YardocTask.new(:doc) do |t|
+      # --no-stats here as 'stats' task called after will print fuller stats
+      t.options = ['--no-stats']
+
+      t.after = Proc.new {
+        Rake::Task['yard:stats'].execute
+      }
+    end
+
+    desc "Shows stats for YARD Documentation including listing undocumented modules, classes, constants, and methods"
+    task :stats => :environment do
+      stats = YARD::CLI::Stats.new
+      stats.run('--compact', '--list-undoc')
+    end
+  end
+
+  # @todo Figure out how to just clone description from yard:doc
+  desc "Generate YARD documentation"
+  # allow calling namespace to as a task that goes to default task for namespace
+  task :yard => ['yard:doc']
+
+  task :default => :yard
+else
+  puts 'YARD not defined, so yard tasks cannot be setup.'
+end

metadata

@@ -0,0 +1,76 @@
+--- !ruby/object:Gem::Specification
+name: metasploit-concern
+version: !ruby/object:Gem::Version
+  version: 0.0.2
+platform: ruby
+authors:
+- Luke Imhoff
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-04-16 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.0'
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.0'
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+description: Automatically includes Modules from app/concerns/<module_with_concerns>/<concern>.rb
+  into <module_with_concerns> to ease monkey-patching associations and validations
+  on ActiveRecord::Base descendents from other gems when layering schemas.
+email:
+- luke_imhoff@rapid7.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- README.md
+- Rakefile
+- app/models/metasploit/concern/loader.rb
+- config/initializers/load_concerns.rb
+- lib/metasploit/concern.rb
+- lib/metasploit/concern/engine.rb
+- lib/metasploit/concern/version.rb
+- lib/tasks/yard.rake
+homepage: https://github.com/rapid7/metasploit-concern
+licenses:
+- BSD-3-clause
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: Automatically include Modules from app/concerns
+test_files: []
+has_rdoc: