srizzo-irber 0.0.3 → 0.0.4

data/History.txt

@@ -1,3 +1,16 @@
+=== 0.0.4 2009-07-19
+
+* 3 major enhancement:
+  * print an object's api - adds a papi method to print a class public methods (filtering low level methods from Object, Kernel, Module and Class)
+  * make any object print its api - adds a method papi_it to make an object print its class public methods (filtering low level methods from Object, Kernel, Module and Class)
+  * make any object print its src - adds a method psrc_it to make an object print its (generated) source code
+
+* 2 major api changes:
+  * renamed #to_code to #src to make it consistent with its printing equivalent #psrc
+  * renamed #src to #psrc to maintain consistency with other printing methods
+
+
+
 === 0.0.3 2009-07-16
 
 * 1 major enhancement:

data/README.markdown

@@ -0,0 +1,95 @@
+## DESCRIPTION:
+
+Little tools to enhance your irb experience
+
+## INSTALL:
+
+* sudo gem install srizzo-irber
+* add to your ~/.irbrc
+  
+    require 'irber'
+
+
+
+## BASIC USAGE:
+
+
+E.g. a class:
+
+    class A
+      def a
+        "a"
+      end
+    end
+
+
+* generate a class or method's source code on the fly
+
+
+    >> psrc A
+    class A < Object
+      def a()
+      "a"
+      end
+    end
+    => nil
+
+
+
+    >> psrc A, :a
+    def a()
+    "a"
+    end
+    => nil
+
+
+* print its api
+
+    >> papi A
+    A  #  a()
+
+
+* make any object inspect itself
+
+    >> [1,2].puts_it 
+    1
+    2
+
+
+    >> [1,2].pp_it 
+    [1, 2]
+
+
+    >> A.psrc_it
+    class A < Object
+      def a()
+      "a"
+      end
+    end
+  
+  
+    >> A.papi_it
+    A  #  a()
+  
+  
+  
+    
+
+## FEATURES/PROBLEMS:
+
+* generate a class or method source code on the fly (won't work for all classes and methods e.g: native classes)
+* print any object's formatted api (filters Object, Kernel, Module and Class methods)
+* make an object inspect itself
+
+
+## REQUIREMENTS:
+
+* Ruby 1.8.x only
+* ParseTree
+* Ruby2Ruby
+
+
+
+## Copyright
+
+Copyright (c) 2009 Samuel Rizzo. See LICENSE for details.

data/VERSION

@@ -1 +1 @@
-0.0.3
+0.0.4

data/features/get_a_generated_source_code_on_the_fly.feature

@@ -27,11 +27,11 @@ Feature: get a generated source code on the fly
         end
       end
       """
-    And I have required "irber/to_code"
+    And I have required "irber/src"
 
 
   Scenario: get source for a class
-    When I run "A.to_code"
+    When I run "A.src"
     Then I should get the code
       """
       class A < Object
@@ -45,7 +45,7 @@ Feature: get a generated source code on the fly
       """
       
   Scenario: get source for an object
-    When I run "A.new.to_code"
+    When I run "A.new.src"
     Then I should get the code
       """
       class A < Object
@@ -59,7 +59,7 @@ Feature: get a generated source code on the fly
       """
 
   Scenario: get source for a module
-    When I run "M.to_code"
+    When I run "M.src"
     Then I should get the code
       """
       module M
@@ -74,7 +74,7 @@ Feature: get a generated source code on the fly
 
 
   Scenario: get source for a class method
-    When I run "A.to_code :a_class_method"
+    When I run "A.src :a_class_method"
     Then I should get the code
       """
       def a_class_method()
@@ -83,7 +83,7 @@ Feature: get a generated source code on the fly
       """
     
   Scenario: get source for an object method
-    When I run "A.new.to_code :an_instance_method"
+    When I run "A.new.src :an_instance_method"
     Then I should get the code
       """
       def an_instance_method()
@@ -92,10 +92,10 @@ Feature: get a generated source code on the fly
       """
   
   Scenario: try to get an inexisting method
-    When I run "A.new.to_code :an_inexisting_method"
+    When I run "A.new.src :an_inexisting_method"
     Then I should get the error "NameError"
     
   Scenario: try on native code
     Given a native implemented class "String"
-    When I run "String.to_code"
+    When I run "String.src"
     Then I should get the error "ParseError"

data/features/{make_an_object_print_itself.feature → make_any_object_inspect_itself.feature}

@@ -1,4 +1,4 @@
-Feature: make an object print itself
+Feature: make any object inspect itself
   In order to save time going to the beginning of the line
   As a lazy programmer
   I want to print an object appending a method to it
@@ -7,6 +7,9 @@ Feature: make an object print itself
     Given the definition
       """
       class O
+        def a arg
+          "a"
+        end
         def to_s
           "O#to_s"
         end
@@ -15,7 +18,7 @@ Feature: make an object print itself
         end
       end
       """
-    And I have required "irber/printing"
+    And I have required "irber/self_inspect"
     And I have run "@o = O.new"
     
     When I run "@o.puts_it"
@@ -26,4 +29,9 @@ Feature: make an object print itself
     
     When I run "@o.pp_it"
     Then I should get the same stdout as "pp @o"
-    
+    
+    When I run "@o.psrc_it"
+    Then I should get the same stdout as "psrc @o"
+    
+    When I run "@o.papi_it"
+    Then I should get the same stdout as "papi @o"

data/features/print_an_objects_api.feature

@@ -0,0 +1,67 @@
+Feature print an objects api
+  In order to save time looking for documentation
+  As a lazy programmer
+  I want a method that prints the objects api
+
+  Background:
+    Given the definition
+      """
+      class A
+        def an_instance_method
+          "result"
+        end
+        def self.a_class_method
+          "result"
+        end
+      end
+      """
+    And the definition
+      """
+      class C
+        def method_with_args some_arg
+          "result"
+        end
+        def method_with_var_args req_arg, opt_arg1=nil, opt_arg2=nil
+          "result"
+        end
+      end
+      """
+    And I have required "irber/papi"
+
+  
+  Scenario: print api for a class
+    When I run "papi A"
+    Then I should have printed its class method
+      """
+        a_class_method()
+      """
+    And I should have printed its instance method
+      """
+        an_instance_method()
+      """
+
+  Scenario: print api for an object
+    When I run "papi A.new"
+    Then I should have printed its instance method
+      """
+      an_instance_method()
+      """
+  
+  
+  Scenario: print api with method args
+    When I run "papi C"
+    Then I should have printed its instance method
+      """
+        method_with_args(some_arg)
+      """
+    And I should have printed its instance method
+      """
+        method_with_var_args(req_arg, opt_arg1 = nil, opt_arg2 = nil)
+      """
+  
+  Scenario: print api for a native class with method args
+    When I run "papi String"
+    And I should have printed its instance method
+      """
+        between?(arg1, arg2)
+      """

data/features/print_generated_source_code.feature

@@ -17,12 +17,12 @@ Feature: print generated source code
         end
       end
       """
-    And I have required "irber/src"
+    And I have required "irber/psrc"
 
   
   
   Scenario: print source for a class
-    When I run "src A"
+    When I run "psrc A"
     Then I should have the code printed
       """
       class A < Object
@@ -37,7 +37,7 @@ Feature: print generated source code
       """
 
   Scenario: print source for a class
-    When I run "src A, :an_instance_method"
+    When I run "psrc A, :an_instance_method"
     Then I should have the code printed
       """
       def an_instance_method()

data/features/step_definitions/irber_steps.rb

@@ -40,3 +40,12 @@ end
 Then /^I should have the code printed$/ do |code|
   stdout{ @result.call }.should match_code code
 end
+
+
+Then /^I should have printed its class method$/ do |string|
+  stdout{ @result.call }.should include(string.unindented)
+end
+
+Then /^I should have printed its instance method$/ do |string|
+  stdout{ @result.call }.should include(string.unindented)
+end

data/irber.gemspec

@@ -2,39 +2,46 @@
 
 Gem::Specification.new do |s|
   s.name = %q{irber}
-  s.version = "0.0.3"
+  s.version = "0.0.4"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["srizzo"]
-  s.date = %q{2009-07-16}
+  s.date = %q{2009-07-19}
   s.email = %q{rizzolabs@gmail.com}
   s.extra_rdoc_files = [
     "LICENSE",
-     "README.rdoc"
+     "README.markdown"
   ]
   s.files = [
     ".document",
      ".gitignore",
      "History.txt",
      "LICENSE",
-     "README.rdoc",
+     "README.markdown",
      "Rakefile",
      "VERSION",
      "features/get_a_generated_source_code_on_the_fly.feature",
-     "features/make_an_object_print_itself.feature",
+     "features/make_any_object_inspect_itself.feature",
+     "features/print_an_objects_api.feature",
      "features/print_generated_source_code.feature",
      "features/step_definitions/irber_steps.rb",
      "features/support/env.rb",
      "irber.gemspec",
      "lib/irber.rb",
-     "lib/irber/printing.rb",
+     "lib/irber/api.rb",
+     "lib/irber/papi.rb",
+     "lib/irber/psrc.rb",
+     "lib/irber/self_inspect.rb",
+     "lib/irber/signature.rb",
      "lib/irber/src.rb",
-     "lib/irber/to_code.rb",
      "spec/custom_helpers.rb",
      "spec/custom_matchers.rb",
-     "spec/irber/printing_spec.rb",
+     "spec/irber/api_spec.rb",
+     "spec/irber/papi_spec.rb",
+     "spec/irber/psrc_spec.rb",
+     "spec/irber/self_inspect_spec.rb",
+     "spec/irber/signature_spec.rb",
      "spec/irber/src_spec.rb",
-     "spec/irber/to_code_spec.rb",
      "spec/spec_helper.rb"
   ]
   s.has_rdoc = true
@@ -46,9 +53,12 @@ Gem::Specification.new do |s|
   s.test_files = [
     "spec/custom_helpers.rb",
      "spec/custom_matchers.rb",
-     "spec/irber/printing_spec.rb",
+     "spec/irber/api_spec.rb",
+     "spec/irber/papi_spec.rb",
+     "spec/irber/psrc_spec.rb",
+     "spec/irber/self_inspect_spec.rb",
+     "spec/irber/signature_spec.rb",
      "spec/irber/src_spec.rb",
-     "spec/irber/to_code_spec.rb",
      "spec/spec_helper.rb"
   ]
 

data/lib/irber.rb

@@ -1,3 +1,4 @@
-require 'irber/to_code'
 require 'irber/src'
-require 'irber/printing'
+require 'irber/psrc'
+require 'irber/self_inspect'
+require 'irber/papi'

data/lib/irber/api.rb

@@ -0,0 +1,57 @@
+require 'irber/src'
+require 'irber/signature'
+
+
+module Irber
+  module Api
+    module InstanceMethods
+      def api
+
+        all_methods = []
+
+        methods = self.methods
+
+        methods  -= Object.methods
+        methods  -= Module.methods
+        methods  -= Class.methods
+        methods  -= Kernel.methods
+
+        all_methods += methods.collect { |method_name| self.method(method_name) }
+
+        if self.respond_to? :instance_methods
+
+          instance_methods = self.instance_methods
+
+          instance_methods -= Object.instance_methods
+          instance_methods -= Module.instance_methods
+          instance_methods -= Class.instance_methods
+          instance_methods -= Kernel.instance_methods
+
+          all_methods += instance_methods.collect { |method_name| self.instance_method(method_name) }
+
+        end
+
+        all_methods.sort! { |x, y| x.name <=> y.name }
+
+        signatures = all_methods.collect { |method| method.signature }
+        
+        signatures
+      end
+
+    end
+
+    def self.included(receiver)
+      receiver.send :include, InstanceMethods
+    end
+    
+  end
+end
+
+
+
+class Object
+  include Irber::Api
+end
+
+
+