ori 0.1.0

data/ori.gemspec

@@ -0,0 +1,82 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{ori}
+  s.version = "0.1.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Alex Fortuna"]
+  s.date = %q{2011-01-02}
+  s.description = %q{Object-Oriented RI for IRB Console}
+  s.email = %q{alex.r@askit.org}
+  s.extra_rdoc_files = [
+    "README.html",
+    "README.md"
+  ]
+  s.files = [
+    "MIT-LICENSE",
+    "README.html",
+    "README.md",
+    "Rakefile",
+    "VERSION.yml",
+    "lib/misc/method_aliases.rb",
+    "lib/ori.rb",
+    "lib/ori/auto_config.rb",
+    "lib/ori/colorize.rb",
+    "lib/ori/config.rb",
+    "lib/ori/extensions.rb",
+    "lib/ori/extensions/object/ri.rb",
+    "lib/ori/internals.rb",
+    "lib/ori/library.rb",
+    "lib/ori/list_method.rb",
+    "lib/ori/request.rb",
+    "lib/ori/tools.rb",
+    "ori.gemspec",
+    "samples/NOTES",
+    "samples/basic_extension.rb",
+    "samples/basic_inheritance.rb",
+    "samples/self_singletons.rb",
+    "samples/singleton_class_includes_module.rb",
+    "spec/auto_config_spec.rb",
+    "spec/colorize_spec.rb",
+    "spec/inspector_spec.rb",
+    "spec/internals_spec.rb",
+    "spec/list_method_spec.rb",
+    "spec/request_spec.rb",
+    "spec/site/NOTES",
+    "spec/site/library_spec.rb",
+    "spec/site/spec_helper.rb",
+    "spec/spec_helper.rb",
+    "spec/tools_spec.rb"
+  ]
+  s.homepage = %q{http://github.com/dadooda/ori}
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.7}
+  s.summary = %q{Object-Oriented RI for IRB Console}
+  s.test_files = [
+    "spec/auto_config_spec.rb",
+    "spec/colorize_spec.rb",
+    "spec/inspector_spec.rb",
+    "spec/internals_spec.rb",
+    "spec/list_method_spec.rb",
+    "spec/request_spec.rb",
+    "spec/site/library_spec.rb",
+    "spec/site/spec_helper.rb",
+    "spec/spec_helper.rb",
+    "spec/tools_spec.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+    else
+    end
+  else
+  end
+end
+

data/samples/NOTES

@@ -0,0 +1,3 @@
+These are the "official" samples used in tests, references etc.
+
+There's no single naming scheme. Top-level namespace may describe the general situation (`BasicInheritance`) or the particular case (`ModuleExtendsClass`).

data/samples/basic_extension.rb

@@ -0,0 +1,27 @@
+module Sample
+  module BasicExtension
+    module Mo
+      def public_meth
+        true
+      end
+
+      protected
+      def protected_meth
+        true
+      end
+
+      private
+      def private_meth
+        true
+      end
+    end
+
+    class Klass
+      extend Mo
+    end
+
+    module OtherMo
+      extend Mo
+    end
+  end
+end

data/samples/basic_inheritance.rb

@@ -0,0 +1,99 @@
+module Sample
+  module BasicInheritance
+    class Grandpa
+      def grandpa_public
+        true
+      end
+
+      protected
+      def grandpa_protected
+        true
+      end
+
+      private
+      def grandpa_private
+        true
+      end
+
+      class << self
+        def grandpa_public_singleton
+          true
+        end
+
+        protected
+        def grandpa_protected_singleton
+          true
+        end
+
+        private
+        def grandpa_private_singleton
+          true
+        end
+      end
+    end # Grandpa
+
+    class Papa < Grandpa
+      def papa_public
+        true
+      end
+
+      protected
+      def papa_protected
+        true
+      end
+
+      private
+      def papa_private
+        true
+      end
+
+      class << self
+        def papa_public_singleton
+          true
+        end
+
+        protected
+        def papa_protected_singleton
+          true
+        end
+
+        private
+        def papa_private_singleton
+          true
+        end
+      end
+    end # Papa
+
+    class Son < Papa
+      def son_public
+        true
+      end
+
+      protected
+      def son_protected
+        true
+      end
+
+      private
+      def son_private
+        true
+      end
+
+      class << self
+        def son_public_singleton
+          true
+        end
+
+        protected
+        def son_protected_singleton
+          true
+        end
+
+        private
+        def son_private_singleton
+          true
+        end
+      end
+    end # Son
+  end
+end

data/samples/self_singletons.rb

@@ -0,0 +1,36 @@
+module Sample
+  # Singletons declared via <tt>self.</tt> are in fact always public.
+  module SelfSingletons
+    module Mo
+      def self.public_meth
+        true
+      end
+
+      protected
+      def self.protected_meth
+        true
+      end
+
+      private
+      def self.private_meth
+        true
+      end
+    end
+
+    class Klass
+      def self.public_meth
+        true
+      end
+
+      protected
+      def self.protected_meth
+        true
+      end
+
+      private
+      def self.private_meth
+        true
+      end
+    end
+  end
+end

data/samples/singleton_class_includes_module.rb

@@ -0,0 +1,33 @@
+module Sample
+  module SingletonClassIncludesModule
+    module Mo
+      # NOTE: Method names are in context of `Mo`. `Mo` doesn't "know" that they are to become singleton.
+
+      def public_meth
+        true
+      end
+
+      protected
+      def protected_meth
+        true
+      end
+
+      private
+      def private_meth
+        true
+      end
+    end
+
+    class Klass
+      class << self
+        include Mo
+      end
+    end
+
+    module OtherMo
+      class << self
+        include Mo
+      end
+    end
+  end
+end

data/spec/auto_config_spec.rb

@@ -0,0 +1,33 @@
+require File.join(File.dirname(__FILE__), "spec_helper")
+
+describe "::ORI::AutoConfig" do
+  klass = ::ORI::AutoConfig
+
+  it "requires host_os most of the time" do
+    r = klass.new
+    proc {r.has_less?}.should raise_error
+    proc {r.unix?}.should raise_error
+    proc {r.windows?}.should raise_error
+
+    proc {r.color}.should raise_error
+    proc {r.frontend}.should raise_error
+    proc {r.pager}.should raise_error
+    proc {r.shell_escape}.should raise_error
+  end
+
+  it "generally works" do
+    r = klass.new(:host_os => "mswin32")
+    r.has_less?.should == false
+    r.unix?.should == false
+    r.windows?.should == true
+
+    r = klass.new(:host_os => "cygwin")
+    r.has_less?.should == true
+    r.color.should == true
+
+    r = klass.new(:host_os => "linux-gnu")
+    r.has_less?.should == true
+    r.color.should == true
+    r.frontend.should match /ansi/
+  end
+end

data/spec/colorize_spec.rb

@@ -0,0 +1,26 @@
+require File.join(File.dirname(__FILE__), "spec_helper")
+
+describe "::ORI::Tools" do
+  mod = ::ORI::Colorize
+
+  describe ".colorize" do
+    meth = :colorize
+
+    it "generally works" do
+      mod.send(meth, "the quick ", "brown fox").should == "the quick brown fox"
+      mod.send(meth, [:message, :error], "the message", [:reset]).should(match(/the message/) && match(/\e\[0m/))     # NOTE: () and && are to satisfy Ruby 1.8.
+    end
+  end
+
+  describe ".seq" do
+    meth = :seq
+
+    it "generally works" do
+      mod.send(meth, :reset).should == "\e[0m"
+
+      proc do
+        mod.send(meth, :kaka)
+      end.should raise_error ArgumentError
+    end
+  end # .seq
+end

data/spec/inspector_spec.rb

@@ -0,0 +1,75 @@
+require File.join(File.dirname(__FILE__), "spec_helper")
+
+# Rules of method inspection, formulated as spec samples.
+#
+# NOTES:
+# * DO NOT sort arrays to compare them with each other. Instead use array arithmetic.
+# * Try NOT to touch method `methods`. ORI doesn't actually use it.
+# * Test concrete inspectors thoroughly: `public_methods`, `protected_methods`, etc.
+# * Sort from more public to less public: public -- protected -- private.
+
+obj_subjects = [
+	nil,
+	false,
+	5,
+	"kaka",
+	Time.now,
+]
+
+class_subjects = [
+  Array,
+  Fixnum,
+  String,
+]
+
+module_subjects = [
+  Enumerable,
+  Kernel,
+]
+
+cm_subjects = class_subjects + module_subjects
+all_subjects = obj_subjects + cm_subjects
+
+describe "{Class|Module}#instance_methods" do
+	it "does not intersect #private_instance_methods" do
+		(cm_subjects).each do |subj|
+			(subj.instance_methods & subj.private_instance_methods).should == []
+		end
+	end
+
+	it "is fully contained in (#public_instance_methods + #protected_instance_methods)" do
+		(cm_subjects).each do |subj|
+      (subj.instance_methods - (subj.public_instance_methods + subj.protected_instance_methods)).should == []
+		end
+	end
+end
+
+describe "anything#methods" do
+	it "is fully contained in (#public_methods + #protected_methods)" do
+		all_subjects.each do |subj|
+      (subj.methods - (subj.public_methods + subj.protected_methods)).should == []
+		end
+	end
+end
+
+describe "{Class|Module}#singleton_methods" do
+  it "is fully contained in (#public_methods + #protected_methods + #private_methods)" do
+		cm_subjects.each do |subj|
+      (subj.singleton_methods - (subj.public_methods + subj.protected_methods + subj.private_methods)).should == []
+    end
+  end
+end
+
+describe "Module#singleton_methods" do
+  it "is fully containted in #public_methods" do
+    module_subjects.each do |subj|
+      (subj.singleton_methods - subj.public_methods).should == []
+    end
+  end
+
+  it "does not intersect with #protected_methods or #private_methods)" do
+    module_subjects.each do |subj|
+      (subj.singleton_methods & (subj.protected_methods + subj.private_methods)).should == []
+    end
+  end
+end

data/spec/internals_spec.rb

@@ -0,0 +1,219 @@
+require File.join(File.dirname(__FILE__), "spec_helper")
+
+# NOTE: When checking collection against the rule, it's wiser to use `all?`, `any?` and `none?` and ONE `should` at the end. It's about 2 times faster
+#       than calling a `should` at every pass of an `each` loop.
+
+describe "::ORI::Internals" do
+  mod = ::ORI::Internals
+
+  describe ".get_list_methods" do
+    meth = :get_list_methods
+
+    it "maintains uniqueness of output" do
+      list1 = mod.send(meth, :objs => [1])
+      list2 = mod.send(meth, :objs => [1, 1])
+      (list2 - list1).should be_empty
+
+      list1 = mod.send(meth, :objs => [Array])
+      list2 = mod.send(meth, :objs => [Array, Array])
+      (list2 - list1).should be_empty
+
+      list1 = mod.send(meth, :objs => [1])
+      list2 = mod.send(meth, :objs => [1, 2])
+      (list2 - list1).should be_empty
+    end
+
+    it "requires :objs option to be an Array" do
+      proc do
+        mod.send(meth)
+      end.should raise_error ArgumentError
+
+      proc do
+        mod.send(meth, :objs => 5)
+      end.should raise_error ArgumentError
+    end
+
+    it "supports :access option" do
+      proc do
+        mod.send(meth, :objs => [5], :access => 1)
+        mod.send(meth, :objs => [5], :access => "kk")
+      end.should raise_error ArgumentError
+
+      proc do
+        mod.send(meth, :objs => [5], :access => "#")
+        mod.send(meth, :objs => [5], :access => "::")
+        mod.send(meth, :objs => [5], :access => :"#")
+        mod.send(meth, :objs => [5], :access => :"::")
+      end.should_not raise_error
+
+      list_methods = mod.send(meth, :objs => [Time], :access => "::")
+      list_methods.all? {|r| r.access == "::"}.should == true
+
+      list_methods = mod.send(meth, :objs => [Time], :access => "#")
+      list_methods.all? {|r| r.access == "#"}.should == true
+    end
+
+    it "supports `:fullre` option" do
+      list_methods = mod.send(meth, :objs => [Module], :fullre => (re = /Object.*::/))
+      ##re = /kk/   #DEBUG: Fail by hand.
+      list_methods.all? do |r|
+        ##p "r", r
+        r.format(:color => false).match re
+      end.should == true
+    end
+
+    it "supports `:own` option" do
+      inputs = []
+      inputs << 5
+      inputs << []
+      inputs << String
+      inputs << Enumerable
+      inputs << Array
+      inputs << Class
+      inputs << Module
+      inputs << Object
+
+      inputs.each do |obj|
+        list_methods = mod.send(meth, :objs => [obj], :own => true)
+        list_methods.all? do |r|
+          ##p "r", r    # Uncomment if fails.
+          r.own?
+        end.should == true
+      end
+
+      list_methods = mod.send(meth, :objs => inputs, :own => true)
+      list_methods.all? do |r|
+        ##p "r", r    # Uncomment if fails.
+        r.own?
+      end.should == true
+    end
+
+    it "supports `:re` option" do
+      list_methods = mod.send(meth, :objs => [Module], :re => (re = /pub/))
+      ##re = /kk/   #DEBUG: Fail by hand.
+      list_methods.all? do |r|
+        ##p "r", r
+        r.method_name.match re
+      end.should == true
+    end
+
+    it "supports `:visibility` option" do
+      list_methods = mod.send(meth, :objs => [::Sample::BasicInheritance::Son], :all => true, :visibility => :public)
+      list_methods.all? do |r|
+        ##p "r", r
+        r.public?
+      end.should == true
+
+      list_methods = mod.send(meth, :objs => [::Sample::BasicInheritance::Son], :all => true, :visibility => :protected)
+      list_methods.all? do |r|
+        ##p "r", r
+        r.protected?
+      end.should == true
+
+      list_methods = mod.send(meth, :objs => [::Sample::BasicInheritance::Son], :all => true, :visibility => :private)
+      list_methods.all? do |r|
+        ##p "r", r
+        r.private?
+      end.should == true
+    end
+
+    describe "filtering" do
+      it "chops off all methods starting with '_ori_'" do
+        inputs = [5, "", [], String, Enumerable, Array, Class, Module, Object]
+        inputs.each do |obj|
+          list_methods = mod.send(meth, :objs => [obj])
+          list_methods.none? do |r|
+            ##p "r", r    # Uncomment if fails.
+            r.method_name.match /\A_ori_/
+          end.should == true
+        end
+
+        list_methods = mod.send(meth, :objs => inputs)
+        list_methods.none? do |r|
+          ##p "r", r    # Uncomment if fails.
+          r.method_name.match /\A_ori_/
+        end.should == true
+      end
+
+      it "chops off non-public Kernel methods if `obj` is not Kernel" do
+        inputs = [5, "", [], String, Enumerable, Array, Class, Module, Object]
+        inputs.each do |obj|
+          list_methods = mod.send(meth, :objs => [obj])
+          list_methods.none? do |r|
+            ##p "r", r    # Uncomment if fails.
+            r.owner == Kernel and not r.public?
+          end.should == true
+
+          list_methods = mod.send(meth, :objs => inputs)
+          list_methods.none? do |r|
+            ##p "r", r    # Uncomment if fails.
+            r.owner == Kernel and not r.public?
+          end.should == true
+        end
+      end
+
+      it "chops off non-public methods if `obj` is an object" do
+        inputs = [5, "", []]
+        inputs.each do |obj|
+          list_methods = mod.send(meth, :objs => [obj])
+          list_methods.none? do |r|
+            ##p "r", r    # Uncomment if fails.
+            not r.public?
+          end.should == true
+        end
+      end
+
+      it "chops off others' private instance methods if `obj` is a module or a class" do
+        inputs = [String, Enumerable, Array, Class, Module, Object, ::Sample::BasicInheritance::Son]
+        inputs.each do |obj|
+          list_methods = mod.send(meth, :objs => [obj])
+          list_methods.none? do |r|
+            ##p "r", r    # Uncomment if fails.
+            not r.own? and r.private? and r.instance?
+          end.should == true
+        end
+
+        list_methods = mod.send(meth, :objs => inputs)
+        list_methods.none? do |r|
+          ##p "r", r    # Uncomment if fails.
+          not r.own? and r.private? and r.instance?
+        end.should == true
+      end
+
+      it "generally works for modules and classes" do
+        list_methods = mod.send(meth, :objs => [::Sample::BasicInheritance::Son])
+        list_methods.find {|r| r.method_name == "son_public"}.should_not be_nil
+        list_methods.find {|r| r.method_name == "son_protected"}.should_not be_nil
+        list_methods.find {|r| r.method_name == "son_private"}.should_not be_nil
+        list_methods.find {|r| r.method_name == "papa_public"}.should_not be_nil
+        list_methods.find {|r| r.method_name == "papa_protected"}.should_not be_nil
+        list_methods.find {|r| r.method_name == "grandpa_public"}.should_not be_nil
+        list_methods.find {|r| r.method_name == "grandpa_protected"}.should_not be_nil
+        list_methods.find {|r| r.method_name == "papa_private"}.should be_nil
+        list_methods.find {|r| r.method_name == "grandpa_private"}.should be_nil
+
+        list_methods = mod.send(meth, :objs => [::Sample::BasicExtension::Klass])
+        list_methods.find {|r| r.method_name == "public_meth"}.should_not be_nil
+        list_methods.find {|r| r.method_name == "protected_meth"}.should_not be_nil
+        list_methods.find {|r| r.method_name == "private_meth"}.should_not be_nil
+
+        list_methods = mod.send(meth, :objs => [::Sample::BasicExtension::OtherMo])
+        list_methods.find {|r| r.method_name == "public_meth"}.should_not be_nil
+        list_methods.find {|r| r.method_name == "protected_meth"}.should_not be_nil
+        list_methods.find {|r| r.method_name == "private_meth"}.should_not be_nil
+      end
+    end # filtering
+  end # .get_list_methods
+
+  describe ".get_ri_arg_prefix" do
+    meth = :get_ri_arg_prefix
+
+    it "generally works" do
+      mod.send(meth, "kaka").should == nil
+      mod.send(meth, "Object.ri").should == nil
+      mod.send(meth, "  Object.ri   ").should == nil
+      mod.send(meth, "Object.ri //").should == "Object.ri"
+      mod.send(meth, "  Object.ri   :x").should == "  Object.ri"
+    end
+  end
+end