Module: JsDuck::Util::Singleton

Included in:
BatchProcessor, Doc::Subproperties, Js::Class, Js::Event, Js::ExtPatterns, Js::Fires, Js::Method, Js::MethodCalls, Js::Property, Js::Returns, Logger, Render::Subproperties, Json, MD5, Stdout
Defined in:
lib/jsduck/util/singleton.rb

Overview

A more convenient Singleton implementation.

With the standard ruby Singleton you need to call the methods of your singleton instance as follows:

MyClass.instance.my_method()

But with JsDuck::Util::Singleton you can skip the .instance. part:

MyClass.my_method()

This also conveniently hides from the calling code the fact that a class is implemented as Singleton - it could just as well only have static methods.

Class Method Summary collapse

Class Method Details

.included(base) ⇒ Object 



22
23
24
25
26
27
28
29
30
31
 
# File 'lib/jsduck/util/singleton.rb', line 22

def self.included(base)
  base.class_eval do
    include ::Singleton

    # Redirect calls from MyClass.method to MyClass.instance.method
    def self.method_missing(meth, *args, &block)
      self.instance.send(meth, *args, &block)
    end
  end
end