module Autoloaded

Eliminates the drudgery of handcrafting a Ruby Core library autoload statement for each Ruby source code file in your project.

@since 0.0.1

Constants

VERSION

The current version of the Autoloaded project.

@since 0.0.1

Public Class Methods

class(&block)

Alias for: module

module() { |autoloader = autoloader| ... } click to toggle source

@!method self.module

Autoloads constants that match files in the source directory.

@yield [Autoloader] accepts options for regulating autoloading

@return [Array of Array] the arguments passed to each +autoload+ statement
                         made

@raise [LocalJumpError] no block is given

@since 1.3

@example Autoloading a namespace
  # lib/my_awesome_gem/db.rb

  module MyAwesomeGem

    Autoloaded.module { }

  end

@example Autoloading with optional specifications
  # lib/my_awesome_gem/db.rb

  module MyAwesomeGem

    class DB

      results = Autoloaded.class do |autoloaded|
        autoloaded.with   :MySQL, :PostgreSQL, [:Access, :SQLServer] => 'MicroSoft'
        autoloaded.except 'SELF-DESTRUCT!'
      end
      STDOUT.puts results.inspect  # See output below.

    end

  end

  # [[:Access,     'my_awesome_gem/db/MicroSoft'  ],
  #  [:SQLServer,  'my_awesome_gem/db/MicroSoft'  ],
  #  [:MySQL,      'my_awesome_gem/db/mysql'      ],
  #  [:Oracle,     'my_awesome_gem/db/oracle'     ],
  #  [:PostgreSQL, 'my_awesome_gem/db/postgre_sql']]

# File lib/autoloaded.rb, line 58
def self.module(&block)
  raise(::LocalJumpError, 'no block given (yield)') unless block

  yield(autoloader = Autoloader.new(block.binding))
  autoloader.autoload!
end

Also aliased as: class

warn(enabling, &block) click to toggle source

Enables or disables warning messages depending on the specified enabling argument.

@param [Object] enabling disables warnings if nil or false

@yield if a block is given, the value of #warn? is reset after the block is

called

@return if a block is given, the result of calling the block @return [Autoloaded] if a block is not given, Autoloaded (Module)

@since 1.3

@see .warn?

# File lib/autoloaded.rb, line 79
def self.warn(enabling, &block)
  result = Warning.enable(enabling, &block)

  block ? result : self
end

warn?() click to toggle source

Indicates whether warning messages are enabled or disabled.

@return [true] if warning messages are enabled @return [false] if warning messages are disabled

@since 1.3

@see .warn

# File lib/autoloaded.rb, line 93
def self.warn?
  Warning.enabled?
end