defined 0.0.1 → 0.0.2

data/README.rdoc

@@ -2,6 +2,8 @@
 
 Calls <tt>Module#defined</tt> after a class or module has been defined or redefined
 
+<b>Note</b>: relies on <tt>{Kernel#set_trace_func}[http://www.ruby-doc.org/core/classes/Kernel.html#M001430]</tt>
+
 
 == Installation
 
@@ -10,6 +12,8 @@ Calls <tt>Module#defined</tt> after a class or module has been defined or redefi
 
 == Usage
 
+  Defined.enable!
+
   class User
     def self.defined(file, line, method)
       puts "  defined by #{file}:#{line} with #{method}"

data/Rakefile

@@ -2,17 +2,17 @@ require 'rake'
 require 'rake/testtask'
 require 'rake/rdoctask'
 
-desc 'Default: run unit tests.'
+desc 'Default: run unit tests'
 task :default => :test
 
-desc 'Test the defined gem.'
+desc 'Test the defined gem'
 Rake::TestTask.new(:test) do |t|
   t.libs += ['lib', 'test']
   t.pattern = 'test/**/*_test.rb'
   t.verbose = true
 end
 
-desc 'Generate documentation for the defined gem.'
+desc 'Generate documentation for the defined gem'
 Rake::RDocTask.new(:rdoc) do |rdoc|
   rdoc.rdoc_dir = 'rdoc'
   rdoc.title    = 'defined'

data/lib/defined.rb

@@ -3,8 +3,18 @@ module Defined
   autoload :Version, 'defined/version'
 
   class << self
-    def included(mod) # :nodoc:
+    def disable!
+      set_trace_func nil
+      @enabled = false
+    end
+
+    def enable!
       set_trace_func method(:trace_function).to_proc
+      @enabled = true
+    end
+
+    def enabled?
+      @enabled ||= false
     end
 
     # An array of classes and modules that are currently being defined
@@ -45,6 +55,4 @@ module Defined
         end
       end
   end
-end
-
-Module.send(:include, Defined)
+end

data/lib/defined/version.rb

@@ -3,14 +3,14 @@ module Defined
   module Version
     MAJOR = 0
     MINOR = 0
-    PATCH = 1
+    PATCH = 2
 
     # Returns a version string by joining <tt>MAJOR</tt>, <tt>MINOR</tt>, and <tt>PATCH</tt> with <tt>'.'</tt>
     #
     # Example
     #
-    #   Version.string # '1.0.2'
-    def self.string
+    #   Version.to_s # '1.0.2'
+    def self.to_s
       [MAJOR, MINOR, PATCH].join('.')
     end
   end

data/test/defined_test.rb

@@ -17,6 +17,14 @@ class DefinedTest < Test::Unit::TestCase
     extend TestMethods
   end
 
+  def test_enabled_toggle
+    assert Defined.enabled?
+    Defined.disable!
+    assert !Defined.enabled?
+    Defined.enable!
+    assert Defined.enabled?
+  end
+
   def test_should_match_definition_start_with_keyword
     assert Defined.send(:definition_start?, 'class', false, false)
   end

data/test/test_helper.rb

@@ -2,4 +2,6 @@ require 'test/unit'
 
 $:.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
 $:.unshift(File.dirname(__FILE__))
-require 'defined'
+require 'defined'
+
+Defined.enable!

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: defined
 version: !ruby/object:Gem::Version 
-  hash: 29
+  hash: 27
   prerelease: 
   segments: 
   - 0
   - 0
-  - 1
-  version: 0.0.1
+  - 2
+  version: 0.0.2
 platform: ruby
 authors: 
 - Sean Huber
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-03-07 00:00:00 -08:00
+date: 2011-05-04 00:00:00 -07:00
 default_executable: 
 dependencies: []
 
@@ -40,11 +40,8 @@ homepage: http://github.com/shuber/defined
 licenses: []
 
 post_install_message: 
-rdoc_options: 
-- --line-numbers
-- --inline-source
-- --main
-- README.rdoc
+rdoc_options: []
+
 require_paths: 
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement 
@@ -68,7 +65,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: 
-rubygems_version: 1.5.0
+rubygems_version: 1.6.2
 signing_key: 
 specification_version: 3
 summary: Calls Module#defined whenever a class or module is (re)defined