srizzo-irber 0.0.2

data/.document

@@ -0,0 +1,5 @@
+README.rdoc
+lib/**/*.rb
+bin/*
+features/**/*.feature
+LICENSE

data/.gitignore

@@ -0,0 +1,5 @@
+*.sw?
+.DS_Store
+coverage
+rdoc
+pkg

data/History.txt

@@ -0,0 +1,10 @@
+=== 0.0.2 2009-07-16
+
+* 1 major enhancement:
+  * printing - adds puts_it, pp_it and p_it methods to make an object print itself
+
+
+=== 0.0.1 2009-07-15
+
+* 1 major enhancement:
+  * to_code - adds a to_code method to generate a class or method code on the fly

data/LICENSE

@@ -0,0 +1,22 @@
+(The MIT License)
+
+Copyright (c) 2009 Samuel Rizzo
+
+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,70 @@
+== DESCRIPTION:
+
+Little tools to enhance your irb experience
+
+== INSTALL:
+
+* sudo gem install srizzo-irber
+* add to your ~/.irbrc
+  
+    require 'irber'
+
+
+
+== BASIC USAGE:
+
+* generate a class or method source code on the fly
+
+Given a class:
+
+  class A
+    def a
+      "a"
+    end
+  end
+
+
+Generate source code on the fly:
+
+  >> puts A.to_code
+  class A < Object
+    def a()
+    "a"
+    end
+  end
+  => nil
+  >> puts A.to_code :a
+  def a()
+  "a"
+  end
+  => nil
+
+
+* make an object print itself
+
+  >> [1,2].puts_it 
+  1
+  2
+  
+  >> [1,2].pp_it 
+  [1, 2]
+
+
+
+
+== FEATURES/PROBLEMS:
+
+* generate a class or method source code on the fly
+* limitation: won't work for all classes and methods (e.g: native classes)
+
+
+== REQUIREMENTS:
+
+* ParseTree
+* Ruby2Ruby
+
+
+
+== Copyright
+
+Copyright (c) 2009 Samuel Rizzo. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,61 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "irber"
+    gem.summary = %Q{Little tools to enhance your irb experience}
+    gem.email = "rizzolabs@gmail.com"
+    gem.homepage = "http://github.com/srizzo/irber"
+    gem.authors = ["srizzo"]
+    
+    gem.add_runtime_dependency 'ParseTree', '>= 3.0.4'
+    gem.add_runtime_dependency 'ruby2ruby', '>= 1.2.3'
+
+
+    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
+  end
+
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: sudo gem install jeweler"
+end
+
+require 'spec/rake/spectask'
+Spec::Rake::SpecTask.new(:spec) do |spec|
+  spec.libs << 'lib' << 'spec'
+  spec.spec_files = FileList['spec/**/*_spec.rb']
+end
+
+Spec::Rake::SpecTask.new(:rcov) do |spec|
+  spec.libs << 'lib' << 'spec'
+  spec.pattern = 'spec/**/*_spec.rb'
+  spec.rcov = true
+end
+
+begin
+  require 'cucumber/rake/task'
+  Cucumber::Rake::Task.new(:features)
+rescue LoadError
+  task :features do
+    abort "Cucumber is not available. In order to run features, you must: sudo gem install cucumber"
+  end
+end
+
+task :default => :spec
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  if File.exist?('VERSION.yml')
+    config = YAML.load(File.read('VERSION.yml'))
+    version = "#{config[:major]}.#{config[:minor]}.#{config[:patch]}"
+  else
+    version = ""
+  end
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "irber #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+

data/VERSION

@@ -0,0 +1 @@
+0.0.2

data/features/get_a_generated_source_code_on_the_fly.feature

@@ -0,0 +1,151 @@
+Feature: get a generated source code on the fly
+  In order to save time looking for source code
+  As a lazy programmer
+  I want to get a generated source code on the fly
+
+  Scenario: from a class
+    Given the definition
+      """
+      class A
+        def an_instance_method
+          "result"
+        end
+        def self.a_class_method
+          "result"
+        end
+      end
+      """
+    And I have required "irber/to_code"
+    When I run "A.to_code"
+    Then I should get the code
+      """
+      class A < Object
+        def an_instance_method()
+          \"result\"
+        end
+        def self.a_class_method()
+          \"result\"
+        end
+      end
+      """
+      
+  Scenario: from an object
+    Given the definition
+      """
+      class A
+        def an_instance_method
+          "result"
+        end
+        def self.a_class_method
+          "result"
+        end
+      end
+      """
+    And I have required "irber/to_code"
+    When I run "A.new.to_code"
+    Then I should get the code
+      """
+      class A < Object
+        def an_instance_method()
+          \"result\"
+        end
+        def self.a_class_method()
+          \"result\"
+        end
+      end
+      """
+
+  Scenario: from a module
+    Given the definition
+      """
+      module M
+        def a_method
+          "result"
+        end
+        def self.a_module_method
+          "result"
+        end
+      end
+      """
+    And I have required "irber/to_code"
+    When I run "M.to_code"
+    Then I should get the code
+      """
+      module M
+        def a_method()
+          "result"
+        end
+        def self.a_module_method()
+          "result"
+        end
+      end
+      """
+
+
+  Scenario: from a class method
+    Given the definition
+      """
+      class A
+        def an_instance_method
+          "result"
+        end
+        def self.a_class_method
+          "result"
+        end
+      end
+      """
+    And I have required "irber/to_code"
+    When I run "A.to_code :a_class_method"
+    Then I should get the code
+      """
+      def a_class_method()
+        "result"
+      end
+      """
+    
+  Scenario: from an object method
+    Given the definition
+      """
+      class A
+        def an_instance_method
+          "result"
+        end
+        def self.a_class_method
+          "result"
+        end
+      end
+      """
+    And I have required "irber/to_code"
+    When I run "A.new.to_code :an_instance_method"
+    Then I should get the code
+      """
+      def an_instance_method()
+        "result"
+      end
+      """
+  
+  Scenario: try to get an inexisting method
+    Given the definition
+      """
+      class A
+        def an_instance_method
+          "result"
+        end
+        def self.a_class_method
+          "result"
+        end
+      end
+      """
+    And I have required "irber/to_code"
+    When I run "A.new.to_code :an_inexisting_method"
+    Then I should get the error "NameError"
+    
+  Scenario: try on native code
+    Given a native implemented class "String"
+    And I have required "irber/to_code"
+    When I run "String.to_code"
+    Then I should get the error "ParseError"
+  
+  
+  
+  

data/features/make_an_object_print_itself.feature

@@ -0,0 +1,29 @@
+Feature: make an object print 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
+
+  Scenario: make an object print itself
+    Given the definition
+      """
+      class O
+        def to_s
+          "O#to_s"
+        end
+        def inspect
+          "O#inspect"
+        end
+      end
+      """
+    And I have required "irber/printing"
+    And I have run "@o = O.new"
+    
+    When I run "@o.puts_it"
+    Then I should get the same stdout as "puts @o"
+    
+    When I run "@o.p_it"
+    Then I should get the same stdout as "p @o"
+    
+    When I run "@o.pp_it"
+    Then I should get the same stdout as "pp @o"
+    

data/features/step_definitions/irber_steps.rb

@@ -0,0 +1,37 @@
+Given /^the definition$/ do |code|
+  eval code
+end
+
+Given /^I have required "(.*)"$/ do |dependency|
+  require dependency
+end
+
+
+Given /^a native implemented class "([^\"]*)"$/ do |klass|
+  #do nothing
+end
+
+Given /^I have run "([^\"]*)"$/ do |code|
+  eval(code)
+end
+
+
+When /^I run "([^\"]*)"$/ do |code|
+  @result = lambda{ eval(code) }
+end
+
+Then /^I should get the code$/ do |code|
+  @result.call.should match_code(code)
+end
+
+
+Then /^I should get the error "([^\"]*)"$/ do |error|
+  @result.should raise_error(
+    Object.module_eval("::#{error}", __FILE__, __LINE__)
+  )
+end
+
+
+Then /^I should get the same stdout as "([^\"]*)"$/ do |code|
+  stdout{ @result.call }.should == stdout{ eval(code) }
+end

data/features/support/env.rb

@@ -0,0 +1,9 @@
+$LOAD_PATH.unshift(File.dirname(__FILE__) + '/../../lib')
+require 'irber'
+
+require 'spec/expectations'
+
+
+require File.join(File.dirname(__FILE__), '../../spec/custom_helpers')
+require File.join(File.dirname(__FILE__), '../../spec/custom_matchers')
+

data/irber.gemspec

@@ -0,0 +1,66 @@
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{irber}
+  s.version = "0.0.2"
+
+  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.email = %q{rizzolabs@gmail.com}
+  s.extra_rdoc_files = [
+    "LICENSE",
+     "README.rdoc"
+  ]
+  s.files = [
+    ".document",
+     ".gitignore",
+     "History.txt",
+     "LICENSE",
+     "README.rdoc",
+     "Rakefile",
+     "VERSION",
+     "features/get_a_generated_source_code_on_the_fly.feature",
+     "features/make_an_object_print_itself.feature",
+     "features/step_definitions/irber_steps.rb",
+     "features/support/env.rb",
+     "irber.gemspec",
+     "lib/irber.rb",
+     "lib/irber/printing.rb",
+     "lib/irber/to_code.rb",
+     "spec/custom_helpers.rb",
+     "spec/custom_matchers.rb",
+     "spec/irber/printing_spec.rb",
+     "spec/irber/to_code_spec.rb",
+     "spec/spec_helper.rb"
+  ]
+  s.has_rdoc = true
+  s.homepage = %q{http://github.com/srizzo/irber}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.2}
+  s.summary = %q{Little tools to enhance your irb experience}
+  s.test_files = [
+    "spec/custom_helpers.rb",
+     "spec/custom_matchers.rb",
+     "spec/irber/printing_spec.rb",
+     "spec/irber/to_code_spec.rb",
+     "spec/spec_helper.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<ParseTree>, [">= 3.0.4"])
+      s.add_runtime_dependency(%q<ruby2ruby>, [">= 1.2.3"])
+    else
+      s.add_dependency(%q<ParseTree>, [">= 3.0.4"])
+      s.add_dependency(%q<ruby2ruby>, [">= 1.2.3"])
+    end
+  else
+    s.add_dependency(%q<ParseTree>, [">= 3.0.4"])
+    s.add_dependency(%q<ruby2ruby>, [">= 1.2.3"])
+  end
+end

data/lib/irber/printing.rb

@@ -0,0 +1,30 @@
+require 'pp'
+
+
+module Irber
+  module Printing
+    
+    module InstanceMethods
+      def puts_it
+        puts self
+      end
+      def p_it
+        p self
+      end
+      def pp_it
+        pp self
+      end
+    end
+
+    def self.included(receiver)
+      receiver.send :include, InstanceMethods
+    end    
+    
+  end
+end
+
+
+class Object
+  include Irber::Printing
+end
+

data/lib/irber/to_code.rb

@@ -0,0 +1,48 @@
+require 'parse_tree'
+require 'ruby2ruby'
+
+module Irber
+  module ToCode
+    
+    class ParseError < StandardError; end
+    
+    module InstanceMethods
+      def to_code method = nil
+    
+        if method
+          
+          if (the_method = self.method(method) rescue nil)
+            receiver = the_method.owner
+          elsif (the_method = self.instance_method(method) if self.respond_to? :instance_method)
+            receiver = the_method.owner
+          else
+            throw NameError.new "couldn't find method `#{method}' for `#{self}'  "
+          end
+        
+          Ruby2Ruby.new.process(ParseTree.translate(receiver, method)) rescue raise ParseError.new("couldn't parse method")
+          
+        else
+          if self.class == Class || self.class == Module
+            receiver = self
+          else
+            receiver = self.class
+          end
+
+          Ruby2Ruby.new.process(ParseTree.translate(receiver)) rescue raise ParseError.new("couldn't parse class")
+
+        end
+        
+      end
+    end
+
+    def self.included(receiver)
+      receiver.send :include, InstanceMethods
+    end
+  end
+  
+end
+
+
+class Object
+  include Irber::ToCode
+end

data/lib/irber.rb

@@ -0,0 +1,2 @@
+require 'irber/to_code'
+require 'irber/printing'

data/spec/custom_helpers.rb

@@ -0,0 +1,13 @@
+def stdout &block
+  captured_io = StringIO.new
+  old_out = $stdout
+  
+  $stdout = captured_io
+  
+  block.call
+  
+  $stdout = old_out
+  
+  captured_io.rewind
+  captured_io.read
+end

data/spec/custom_matchers.rb

@@ -0,0 +1,6 @@
+
+Spec::Matchers.define :match_code do |code|
+  match do |matcher|
+    matcher.strip.gsub(" ", "").gsub("\n\n", "\n") == code.strip.gsub(" ", "").gsub("\n\n", "\n")
+  end
+end

data/spec/irber/printing_spec.rb

@@ -0,0 +1,52 @@
+require File.dirname(__FILE__) + '/../spec_helper'
+
+require "irber/printing"
+
+class O
+  def to_s
+    "O#to_s"
+  end
+  def inspect
+    "O#inspect"
+  end
+end
+
+
+describe Irber::Printing do
+
+  before(:each) do
+    @a = O.new
+  end
+
+  describe "#puts_it" do
+    it "should be available on all objects" do
+      Object.new.should respond_to(:puts_it)
+    end
+
+    it "should puts itself" do
+      stdout{ @a.puts_it }.should == stdout{ puts @a }
+    end
+  end
+
+  describe "#p_it" do
+    it "should be available on all objects" do
+      Object.new.should respond_to(:p_it)
+    end
+
+    it "should puts itself" do
+      stdout{ @a.p_it }.should == stdout{ p @a }
+    end
+  end
+
+  describe "#pp_it" do
+    it "should be available on all objects" do
+      Object.new.should respond_to(:pp_it)
+    end
+
+    it "should puts itself" do
+      stdout{ @a.pp_it }.should == stdout{ pp @a }
+    end
+  end
+
+
+end

data/spec/irber/to_code_spec.rb

@@ -0,0 +1,141 @@
+require File.dirname(__FILE__) + '/../spec_helper'
+
+require "irber/to_code"
+
+class A
+  def an_instance_method
+    "result"
+  end
+  def self.a_class_method
+    "result"
+  end
+end
+
+module M
+  def a_method
+    "result"
+  end
+  def self.a_module_method
+    "result"
+  end
+end
+
+
+describe Irber::ToCode do
+  
+  describe "on classes" do
+    it "should be available on all classes" do
+      A.should respond_to(:to_code)
+    end
+
+    it "should generate its source code" do
+      A.to_code.should match_code "
+        class A < Object
+          def an_instance_method()
+            \"result\"
+          end
+          def self.a_class_method()
+            \"result\"
+          end
+        end
+      "
+    end
+  end
+  
+  describe "on objects" do
+    it "should be available on all objects" do
+      A.new.should respond_to(:to_code)
+    end
+
+    it "should generate its source code" do
+      A.new.to_code.should match_code "
+        class A < Object
+          def an_instance_method()
+            \"result\"
+          end
+          def self.a_class_method()
+            \"result\"
+          end
+        end
+      "
+    end
+    
+  end
+
+  describe "on modules" do
+    it "should generat its source code" do
+      M.to_code.should match_code "
+        module M
+          def a_method()
+            \"result\"
+          end
+          def self.a_module_method()
+            \"result\"
+          end
+        end
+      "
+    end
+  end
+
+  describe "on class methods" do
+    it "should generate a class instance method source code " do
+      A.to_code(:an_instance_method).should match_code "
+        def an_instance_method()
+          \"result\"
+        end
+      "
+    end
+    
+    it "should generate a class method source code " do
+      A.to_code(:a_class_method).should match_code "
+        def a_class_method()
+          \"result\"
+        end
+      "
+    end
+  end
+  
+  
+  describe "on object methods" do
+    it "should generate an object method source code" do
+      A.new.to_code(:an_instance_method).should match_code "
+        def an_instance_method()
+          \"result\"
+        end
+      "
+    end
+  end
+
+  describe "on module methods" do
+    it "should generate a module method source code" do
+      M.to_code(:a_method).should match_code "
+        def a_method()
+          \"result\"
+        end
+      "
+    end
+  end
+  
+  
+  describe "on inexisting methods" do
+    it "should raise NameError" do
+      lambda{ A.new.to_code(:an_inexisting_method) }.should raise_error(NameError)
+    end
+  end
+  
+  
+  describe "on native classes" do
+    it "should raise ParseError" do
+      lambda{ String.to_code }.should raise_error(ParseError)
+    end
+  end
+  
+  describe "on native methods" do
+    it "should raise ParseError" do
+      lambda{ "".to_code :to_s }.should raise_error(ParseError)
+    end
+  end
+  
+
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,19 @@
+require 'rubygems'
+
+require 'spec'
+
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+require 'irber'
+
+Spec::Runner.configure do |config|
+  
+end
+
+
+
+require File.join(File.dirname(__FILE__), 'custom_helpers')
+require File.join(File.dirname(__FILE__), 'custom_matchers')
+
+
+

metadata

@@ -0,0 +1,96 @@
+--- !ruby/object:Gem::Specification 
+name: srizzo-irber
+version: !ruby/object:Gem::Version 
+  version: 0.0.2
+platform: ruby
+authors: 
+- srizzo
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-07-16 00:00:00 -07:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: ParseTree
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 3.0.4
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: ruby2ruby
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 1.2.3
+    version: 
+description: 
+email: rizzolabs@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.rdoc
+files: 
+- .document
+- .gitignore
+- History.txt
+- LICENSE
+- README.rdoc
+- Rakefile
+- VERSION
+- features/get_a_generated_source_code_on_the_fly.feature
+- features/make_an_object_print_itself.feature
+- features/step_definitions/irber_steps.rb
+- features/support/env.rb
+- irber.gemspec
+- lib/irber.rb
+- lib/irber/printing.rb
+- lib/irber/to_code.rb
+- spec/custom_helpers.rb
+- spec/custom_matchers.rb
+- spec/irber/printing_spec.rb
+- spec/irber/to_code_spec.rb
+- spec/spec_helper.rb
+has_rdoc: true
+homepage: http://github.com/srizzo/irber
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.2.0
+signing_key: 
+specification_version: 3
+summary: Little tools to enhance your irb experience
+test_files: 
+- spec/custom_helpers.rb
+- spec/custom_matchers.rb
+- spec/irber/printing_spec.rb
+- spec/irber/to_code_spec.rb
+- spec/spec_helper.rb