defined 0.0.0

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2011 Sean Huber - shuber@huberry.com
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.rdoc

@@ -0,0 +1,53 @@
+= defined
+
+Calls <tt>Module#defined</tt> after a class or module has been defined or redefined
+
+
+== Installation
+
+  gem install defined
+
+
+== Usage
+
+  class User
+    def self.defined(file, line, method)
+      puts "  defined by #{file}:#{line} with #{method}"
+    end
+
+    puts 'in original class definition'
+  end
+
+  User.class_eval do
+    puts 'in class_eval'
+  end
+
+  class User
+    puts 'in class definition again'
+  end
+
+  Class.new(User) do
+    puts 'in Class.new'
+  end
+
+=== Outputs
+
+  in original class definition
+    defined by /tmp/untitled.rb:1 with class
+  in class_eval
+    defined by /tmp/untitled.rb:9 with class_eval
+  in class definition again
+    defined by /tmp/untitled.rb:13 with class
+  in Class.new
+    defined by /tmp/untitled.rb:17 with initialize
+
+==== Note the <tt>method</tt> in the last example is <tt>initialize</tt> NOT <tt>new</tt>
+
+
+== Patches and pull requests
+
+* Fork the project.
+* Make your feature addition or bug fix.
+* Add tests for it. This is important so I don't break it in a future version unintentionally.
+* Commit, do not mess with Rakefile, version, or history. (if you want to have your own version, that is fine but bump version in a commit by itself I can ignore when I pull)
+* Send me a pull request. Bonus points for topic branches.

data/lib/defined.rb

@@ -0,0 +1,50 @@
+# Calls <tt>Module#defined(file, line, method)</tt> after a class or module has been defined or redefined
+module Defined
+  autoload :Version, 'defined/version'
+
+  class << self
+    def included(mod) # :nodoc:
+      set_trace_func method(:trace_function).to_proc
+    end
+
+    # An array of classes and modules that are currently being defined
+    def definitions
+      @definitions ||= []
+    end
+
+    protected
+
+      def definition?(event, method, klass, keyword_event, method_event)
+        event == keyword_event || (event == method_event && definition_method?(method, klass))
+      end
+
+      # Checks if the event is the end of a class or module definition
+      def definition_end?(event, method, klass)
+        !definitions.empty? && definition?(event, method, klass, 'end', 'c-return')
+      end
+
+      # Checks if the event is a call to <tt>Module.new</tt>, <tt>Class.new</tt>, or <tt>/(class|instance|module)_(eval|exec)/</tt>
+      def definition_method?(method, klass)
+        (method == :initialize && klass.is_a?(Module)) || method.to_s =~ /^(class|instance|module)_(eval|exec)$/
+      end
+
+      # Checks if the event is the start of a class or module definition
+      def definition_start?(event, method, klass)
+        definition?(event, method, klass, 'class', 'c-call')
+      end
+
+      # Checks if the event is the end of a class or module definition, and if so
+      # it calls <tt>Module#defined(file, line, method)</tt> if implemented
+      def trace_function(event, file, line, method, binding, klass)
+        if definition_start?(event, method, klass)
+          definitions << binding.eval('self')
+        elsif definition_end?(event, method, klass)
+          object = definitions.pop
+          method ||= object.class.name.downcase.to_sym
+          object.defined(file, line, method) if object.respond_to?(:defined)
+        end
+      end
+  end
+end
+
+Module.send(:include, Defined)

data/lib/defined/version.rb

@@ -0,0 +1,17 @@
+module Defined
+  # Contains information about this gem's version
+  module Version
+    MAJOR = 0
+    MINOR = 0
+    PATCH = 0
+
+    # 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
+      [MAJOR, MINOR, PATCH].join('.')
+    end
+  end
+end

data/test/defined_test.rb

@@ -0,0 +1,122 @@
+require 'test_helper'
+
+class DefinedTest < Test::Unit::TestCase
+  module TestMethods
+    attr_reader :file, :line, :method, :called
+
+    def defined(file, line, method)
+      @file, @line, @method, @called = file, line, method, true
+    end
+  end
+
+  module Mock
+    extend TestMethods
+  end
+
+  class Dummy
+    extend TestMethods
+  end
+
+  def test_should_match_definition_start_with_keyword
+    assert Defined.send(:definition_start?, 'class', false, false)
+  end
+
+  def test_should_not_match_definition_start_with_wrong_keyword
+    assert !Defined.send(:definition_start?, 'wrong_keyword', :class_eval, false)
+  end
+
+  def test_should_match_definition_start_with_method
+    assert Defined.send(:definition_start?, 'c-call', :class_eval, false)
+  end
+
+  def test_should_not_match_definition_start_with_normal_method
+    assert !Defined.send(:definition_start?, 'c-call', :normal_method, false)
+  end
+
+  def test_should_match_definition_start_with_initialize
+    assert Defined.send(:definition_start?, 'c-call', :initialize, Module.new)
+  end
+
+  def test_should_not_match_definition_start_with_initialize_if_not_called_on_module_or_class
+    assert Defined.send(:definition_start?, 'c-call', :initialize, Dummy)
+  end
+
+  def test_should_match_definition_end_with_keyword
+    with_dummy_definition do
+      assert Defined.send(:definition_end?, 'end', false, false)
+    end
+  end
+
+  def test_should_not_match_definition_end_with_wrong_keyword
+    with_dummy_definition do
+      assert !Defined.send(:definition_end?, 'wrong_keyword', :class_eval, false)
+    end
+  end
+
+  def test_should_match_definition_end_with_method
+    with_dummy_definition do
+      assert Defined.send(:definition_end?, 'c-return', :class_eval, false)
+    end
+  end
+
+  def test_should_not_match_definition_end_with_normal_method
+    with_dummy_definition do
+      assert !Defined.send(:definition_end?, 'c-return', :normal_method, false)
+    end
+  end
+
+  def test_should_match_definition_end_with_initialize
+    with_dummy_definition do
+      assert Defined.send(:definition_end?, 'c-return', :initialize, Module.new)
+    end
+  end
+
+  def test_should_not_match_definition_end_with_initialize_if_not_called_on_module_or_class
+    with_dummy_definition do
+      assert Defined.send(:definition_end?, 'c-return', :initialize, Dummy)
+    end
+  end
+
+  def test_should_not_match_end_without_start
+    assert !Defined.send(:definition_end?, 'end', false, false)
+  end
+
+  def test_method_should_be_class_or_module_when_defined_with_keywords
+    assert_equal :module, Mock.method
+    assert_equal :class, Dummy.method
+  end
+
+  def test_should_not_call_defined_unless_implemented
+    mod = Module.new
+    assert !mod.respond_to?(:defined)
+  end
+
+  def test_should_call_defined_when_module_is_defined
+    assert Mock.called
+  end
+
+  def test_should_call_defined_when_module_is_defined_with_new
+    mod = Module.new { extend TestMethods }
+    assert mod.called
+    assert_equal :initialize, mod.method
+  end
+
+  %w(class instance module).each do |prefix|
+    %w(eval exec).each do |suffix|
+      method_name = [prefix, suffix].join('_').to_sym
+      define_method "test_should_call_defined_when_module_is_defined_with_#{method_name}" do
+        Mock.send(method_name) { @called = false }
+        assert Mock.called
+        assert_equal method_name, Mock.method
+      end
+    end
+  end
+
+  protected
+
+    def with_dummy_definition
+      Defined.definitions << Dummy
+      yield
+      Defined.definitions.pop
+    end
+end

data/test/test_helper.rb

@@ -0,0 +1,5 @@
+require 'test/unit'
+
+$:.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$:.unshift(File.dirname(__FILE__))
+require 'defined'

metadata

@@ -0,0 +1,76 @@
+--- !ruby/object:Gem::Specification 
+name: defined
+version: !ruby/object:Gem::Version 
+  hash: 31
+  prerelease: 
+  segments: 
+  - 0
+  - 0
+  - 0
+  version: 0.0.0
+platform: ruby
+authors: 
+- Sean Huber
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-02-23 00:00:00 -08:00
+default_executable: 
+dependencies: []
+
+description: Calls Module#defined whenever a class or module is defined or redefined
+email: shuber@huberry.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- lib/defined/version.rb
+- lib/defined.rb
+- MIT-LICENSE
+- README.rdoc
+- test/defined_test.rb
+- test/test_helper.rb
+has_rdoc: true
+homepage: http://github.com/shuber/defined
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --line-numbers
+- --inline-source
+- --main
+- README.rdoc
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.5.0
+signing_key: 
+specification_version: 3
+summary: Calls Module#defined whenever a class or module is (re)defined
+test_files: 
+- test/defined_test.rb
+- test/test_helper.rb