inspector_gadget 0.0.2 → 0.1.0

data/lib/inspector_gadget.rb

@@ -1,37 +1,51 @@
 module InspectorGadget
+
   def self.included(base)
-    base.class_eval do
+    # log all instance methods
+    Brain.log_all_instance_method_calls(base)
+
+    # log all class methods
+    singleton_class = class << base; self; end
+    Brain.log_all_instance_method_calls(singleton_class)
+  end
+
+  module Brain
+    # obj either a class (instance methods) or a class singleton (class methods)
+    def self.log_all_instance_method_calls(obj)
       # setting up alias_method_chain
-      (instance_methods - Object.methods).each do |method_name|
-        method_name = method_name.to_s # convert symbol to string
-        if ['?', '='].include?(method_name[-1])
-          special_character = method_name[-1]
-          bare_method_name = method_name[0..-2] # get rid of trailing "=" or "?"
-          method_with_logging_name = bare_method_name + '_with_logging' + special_character
-          method_without_logging_name = bare_method_name + '_without_logging' + special_character
-        else
-          method_with_logging_name = method_name + '_with_logging'
-          method_without_logging_name = method_name + '_without_logging'
-        end
-        define_method(method_with_logging_name) do |*args|
-          args_to_log = args.dup
-          filter_args(method_name, args_to_log)
-          Rails.logger.info "#{self.class.name} LOG: method name: #{method_name}, args: #{args_to_log.inspect}"
-          result = send(method_without_logging_name, *args)
-          result_to_log = result.dup rescue result
-          filter_result(method_name, result_to_log)
-          Rails.logger.info "#{self.class.name} LOG: method name: #{method_name}, args: #{args_to_log.inspect} returned #{result_to_log.inspect}"
-          result
-        end
+      obj.class_eval do
+        (instance_methods - Object.methods).each do |method_name|
+          method_name = method_name.to_s # convert symbol to string
+          aliased_target, punctuation = method_name.to_s.sub(/([?!=])$/, ''), $1
+          method_with_logging_name, method_without_logging_name = "#{aliased_target}_with_logging#{punctuation}", "#{aliased_target}_without_logging#{punctuation}"
 
-        alias_method_chain method_name, :logging
+          define_method(method_with_logging_name) do |*args, &block|
+            args_to_log = args.dup
+            filter_args_in_log(method_name, args_to_log)
+            if self.is_a?(Class)
+              method_type = 'class'
+              class_name = self.name
+            else
+              method_type = 'instance'
+              class_name = self.class.name
+            end
+            Rails.logger.info("#{class_name} LOG: #{method_type} method name: #{method_name}, args: #{args_to_log.inspect}")
+            result = send(method_without_logging_name, *args, &block)
+            result_to_log = result.dup rescue result
+            filter_result_in_log(method_name, result_to_log)
+            Rails.logger.info("#{class_name} LOG: #{method_type} method name: #{method_name}, args: #{args_to_log.inspect} returned #{result_to_log.inspect}")
+            result
+          end
 
-        # override this method to hide passwords etc
-        def filter_args(method_name, args)
-        end
+          alias_method_chain method_name, :logging
+
+          # override this method to hide passwords etc
+          def filter_args_in_log(method_name, args)
+          end
 
-        # override this method to hide passwords etc
-        def filter_result(method_name, result)
+          # override this method to hide passwords etc
+          def filter_result_in_log(method_name, result)
+          end
         end
       end
     end

data/lib/inspector_gadget/version.rb

@@ -1,3 +1,3 @@
 module InspectorGadget
-  VERSION = "0.0.2"
+  VERSION = "0.1.0"
 end

data/spec/inspector_gadget_spec.rb

@@ -0,0 +1,83 @@
+require 'active_support/all'
+require './lib/inspector_gadget.rb'
+
+describe InspectorGadget do
+  before :all do
+    module Rails;end
+
+    def Rails.logger
+      @logger ||= Object.new
+    end unless Rails.respond_to?(:logger)
+
+    class Test
+      def test_instance_method
+        'instance_method'
+      end
+
+      def self.test_class_method
+        'class_method'
+      end
+
+      def test_instance_method_with_arg(arg)
+        arg
+      end
+
+      def self.test_class_method_with_arg(arg)
+        arg
+      end
+
+      def test_instance_method_with_block(&block)
+        block.call
+      end
+
+      def self.test_class_method_with_block(&block)
+        block.call
+      end
+
+      include InspectorGadget
+    end
+
+  end
+
+  it 'should log instance methods' do
+    Rails.logger.should_receive(:info).with('Test LOG: instance method name: test_instance_method, args: []')
+    Rails.logger.should_receive(:info).with('Test LOG: instance method name: test_instance_method, args: [] returned "instance_method"')
+    Test.new.test_instance_method.should == 'instance_method'
+  end
+
+  it 'should log class methods' do
+    Rails.logger.should_receive(:info).with('Test LOG: class method name: test_class_method, args: []')
+    Rails.logger.should_receive(:info).with('Test LOG: class method name: test_class_method, args: [] returned "class_method"')
+    Test.test_class_method.should == 'class_method'
+  end
+
+  it 'should log instance methods with args' do
+    Rails.logger.should_receive(:info).with('Test LOG: instance method name: test_instance_method_with_arg, args: ["foo"]')
+    Rails.logger.should_receive(:info).with('Test LOG: instance method name: test_instance_method_with_arg, args: ["foo"] returned "foo"')
+    Test.new.test_instance_method_with_arg('foo').should == 'foo'
+  end
+
+  it 'should log class methods with args' do
+    Rails.logger.should_receive(:info).with('Test LOG: class method name: test_class_method_with_arg, args: ["foo"]')
+    Rails.logger.should_receive(:info).with('Test LOG: class method name: test_class_method_with_arg, args: ["foo"] returned "foo"')
+    Test.test_class_method_with_arg('foo').should == 'foo'
+  end
+
+  it 'should log instance methods with block' do
+    Rails.logger.should_receive(:info).with('Test LOG: instance method name: test_instance_method_with_block, args: []')
+    Rails.logger.should_receive(:info).with('Test LOG: instance method name: test_instance_method_with_block, args: [] returned 2')
+    Test.new.test_instance_method_with_block do
+      1 + 1
+    end.should == 2
+  end
+
+  it 'should log class methods with block' do
+    Rails.logger.should_receive(:info).with('Test LOG: class method name: test_class_method_with_block, args: []')
+    Rails.logger.should_receive(:info).with('Test LOG: class method name: test_class_method_with_block, args: [] returned 2')
+    Test.test_class_method_with_block do
+      1 + 1
+    end.should == 2
+  end
+
+end
+

metadata

@@ -1,90 +1,64 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: inspector_gadget
-version: !ruby/object:Gem::Version 
-  hash: 27
-  prerelease: false
-  segments: 
-  - 0
-  - 0
-  - 2
-  version: 0.0.2
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+  prerelease: 
 platform: ruby
-authors: 
+authors:
 - mdobrota@tribune.com
 autorequire: 
 bindir: bin
 cert_chain: []
-
-date: 2012-10-29 00:00:00 -05:00
-default_executable: 
-dependencies: 
-- !ruby/object:Gem::Dependency 
+date: 2012-10-30 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
   name: bundler
-  prerelease: false
-  requirement: &id001 !ruby/object:Gem::Requirement 
+  requirement: &2153917080 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 23
-        segments: 
-        - 1
-        - 0
-        - 0
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
         version: 1.0.0
   type: :development
-  version_requirements: *id001
+  prerelease: false
+  version_requirements: *2153917080
 description: Inspect any object's methods
-email: 
+email:
 - mdobrota@tribune.com
 executables: []
-
 extensions: []
-
 extra_rdoc_files: []
-
-files: 
+files:
 - .gitignore
 - Gemfile
 - Rakefile
 - inspector_gadget.gemspec
 - lib/inspector_gadget.rb
 - lib/inspector_gadget/version.rb
-has_rdoc: true
+- spec/.inspector_gadget_spec.rb.swp
+- spec/inspector_gadget_spec.rb
 homepage: http://rubygems.org/gems/inspector_gadget
 licenses: []
-
 post_install_message: 
 rdoc_options: []
-
-require_paths: 
+require_paths:
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement 
+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 
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      hash: 23
-      segments: 
-      - 1
-      - 3
-      - 6
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
       version: 1.3.6
 requirements: []
-
 rubyforge_project: inspector_gadget
-rubygems_version: 1.3.7
+rubygems_version: 1.8.10
 signing_key: 
 specification_version: 3
 summary: Inspect any object's methods by including the module
 test_files: []
-