object_tree 0.0.10 → 1.0.0

checksums.yaml

@@ -1,15 +1,7 @@
 ---
-!binary "U0hBMQ==":
-  metadata.gz: !binary |-
-    YjgzOWY2MGI0ZmUzMmIwZTZmYWI1NzZiODg0MmYxZjRlNjMzMWNmNQ==
-  data.tar.gz: !binary |-
-    Zjg2ZDcwYWJiOTFkZGM0MjVlODc3YjM2NTY1OTBjZGI0YWQ5Y2M4YQ==
-!binary "U0hBNTEy":
-  metadata.gz: !binary |-
-    ZjBhYWEwYjgyYjQyNTNhMGIzZWExMmMyOGQ4NDQxYmUwN2EzOTZjZGMzNjk4
-    OGE2ZTIzN2MxMjJiYzliYzE0MTA5MzMyYWQwMGJlMDgwYzNmOGRmYTdlMzdm
-    NDZkMTliZjIyMmUzMWY5MjU0MDMwOWVjNGJhMjQ3NzA4MTFmZDA=
-  data.tar.gz: !binary |-
-    MmEwNjQ1ODg0MTVhYzhjNDUyODJhM2Q4ZmI1ZWE4MTI1YTkwYzMwNzM0NzM0
-    Y2VlMTE2MGMzZGQ4YmExZDA3MzBiODgzNTkzZDZjYTcxOTBjZjk1MGZjYjAz
-    MDVlMjlmYzc3YTBjNDNiNTRmM2VhNTAzMzk4YTBiOTNhMjlkMmI=
+SHA1:
+  metadata.gz: eda02ea8be3269346e579f37b180697ed821b74f
+  data.tar.gz: e926a68e49f4e365215057b9f78ecae18dceb572
+SHA512:
+  metadata.gz: b1413d955e7103a77375561949d0845f8a8c229c8a2217dafd32bec46d4e4a3d01c95dcae2d7b52c71a7700a3d2642722b30664807cc70c92caade5baa1d1d67
+  data.tar.gz: 1a23847e73c637de71eba4231b4e87f2636e360baf91bc840a44acd6d43a3fbf4d829041d5390bccd9a6cff8ff135790f24d186bf90144facac3380a6ea4d908

data/.gitignore

@@ -16,8 +16,8 @@ test/tmp
 test/version_tmp
 tmp
 
-**/*.swp
-*.swp
-**/*~
-*.*~
-*~
+# RubyMine
+.idea
+
+# bundler
+/vendor/bundle

data/.rspec

@@ -0,0 +1,3 @@
+--color
+--require spec_helper
+--format documentation

data/.travis.yml

@@ -0,0 +1,9 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.0.0
+  - 2.1
+  - 2.2
+  - 2.3.0
+  - 2.4.0
+before_install: gem install bundler -v 1.14.3

data/README.md

@@ -1,18 +1,17 @@
 # ObjectTree
 
-Rubyのオブジェクト関係をtreeっぽく表示
-1.8の対応はまだ出来ていません。
+[![Build Status](https://travis-ci.org/siman-man/object_tree.svg?branch=master)](https://travis-ci.org/siman-man/object_tree)
 
-## Installation
+ObjectTree is like tree command for Ruby ancestors.
 
-Or install it yourself as:
 
-    $ gem install object_tree
-    
-Add this line to your application's Gemfile:
+## Installation
 
-    gem 'object_tree'
+```
+$ gem install object_tree
+```
 
+    
 ## Usage
 
 ``` ruby
@@ -24,21 +23,22 @@ end
 class B < A
 end
 
-class C < A
+class C < B
 end
 
-tree = ObjectTree::Tree.create(A)
-tree.draw
+puts ObjectTree.create(A)
 ```
 
+output
+
 ```zsh
-<C>A
-├──── <C>C
-└──── <C>B
+<C> A
+└───── <C> B
+        └───── <C> C
 ```
 
-こんな感じでtreeっぽく出力してくれる。
 
+more complex pattern
 
 ```ruby
 require 'object_tree'
@@ -60,19 +60,24 @@ class C < A
   include E
 end
 
-tree = ObjectTree::Tree.create(A, true)
-tree.draw
-```
+class F < B
+  include E
+end
 
-```zsh
-<M>D
-└──── <C>A
-       ├──── <M>E
-       │      └──── <C>C
-       └──── <C>B
+puts ObjectTree.create(D)
 ```
 
-第二引数をtrueにするとmoduleも表示してくれる。
+output
+
+```
+<M> D
+└───── <C> A
+        ├───── <C> B
+        │       └───── <M> E
+        │               └───── <C> F
+        └───── <M> E
+                └───── <C> C
+```
 
 
 ## Contributing

data/Rakefile

@@ -1 +1,6 @@
-require "bundler/gem_tasks"
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/lib/object_tree/version.rb

@@ -1,3 +1,3 @@
-module ObjectTree
-  VERSION = "0.0.10"
+class ObjectTree
+  VERSION = "1.0.0"
 end

data/lib/object_tree.rb

@@ -1,145 +1,59 @@
-# encoding: utf-8
-require "object_tree/version"
+require 'colorize'
 
-class Module
-  def prepended_modules
-    ancestors = self.ancestors
-    ancestors[0..ancestors.find_index(self)] - [self]
-  end
-end
-
-module ObjectTree
-  class Tree
-    attr_reader :tree
-    SPACE_SIZE = 6
+class ObjectTree
+  SPACE_SIZE = 8
+  T_LINE = '├─────'
+  I_LINE = '│'
+  L_LINE = '└─────'
 
-    # 31: red, 32: green, 33: yellow, 34: blue, 35: pink, 36: aqua, 37: gray
-    MCOLOR = 31
-    CCOLOR = 32
-
-    def initialize(klass, mflag = false)
-      @tree = Hash.new{|h, k| h[k] = [] }
-      @mflag = mflag
-      @root_class = klass
+  def self.create(klass)
+    new(klass)
+  end
 
-      if RUBY_VERSION >= "1.9" && klass == BasicObject
-        klass = Object
-        @tree[BasicObject] << Object
-      end
+  def initialize(klass)
+    @queue = []
+    parse(klass)
+  end
 
-      create_object_tree(object_list(klass))
-    end
+  def to_s
+    @queue.join
+  end
 
-    class << self
-      alias :create :new
+  def output_node(klass)
+    if klass.instance_of?(Class)
+      "<#{?C.colorize(:green)}> #{klass}\n"
+    else
+      "<#{?M.colorize(:red)}> #{klass}\n"
     end
+  end
 
-    def singleton(klass)
-      class << klass; self end
-    end
+  def get_line(end_line: nil, space: '')
+    end_line ? "#{space}#{L_LINE} " : "#{space}#{T_LINE} "
+  end
 
-    def object_list(klass)
-      ObjectSpace.each_object(singleton(klass)) do |subclass| 
-        if klass != subclass
-          @tree[klass] << subclass
-          object_list(subclass) unless @tree.has_key?(subclass)
-        end
-      end
+  def get_space(end_line: nil)
+    end_line ? ' ' * SPACE_SIZE : I_LINE + ' ' * (SPACE_SIZE-1)
+  end
 
-      @tree
-    end
+  def parse(klass, space = '', path: [])
+    path << klass
+    modules = get_modules(klass, path.reverse)
+    @queue << output_node(klass)
 
-    def create_object_tree(tree)
-      tree.each do |klass1, subclasses1|
-        tree.each do |klass2, subclasses2|
-          if klass1 > klass2
-            tree[klass1] -= (subclasses2 - [klass2])
-          end
-        end
-      end
+    until modules.empty?
+      sub = modules.shift
 
-      tree
+      @queue << get_line(end_line: modules.empty?, space: space)
+      parse(sub, space + get_space(end_line: modules.empty?), path: path.dup)
     end
+  end
 
-    def draw
-      if @tree.size.zero? 
-        puts "\e[#{CCOLOR}m<C>\e[m#{@root_class}"
-      else
-        @last_check = []
-        draw_tree({ @root_class => @tree[@root_class] }, 0)
-      end
-    end
-
-    def draw_tree(tree, nest, root = true, last = false)
-
-      @last_check[nest-1] = last if nest > 0
-
-      tree.each do |klass, subclasses|
-        if ( @mflag && klass.kind_of?(Class) && !klass.superclass.nil? )
-          module_list = klass.ancestors[0..klass.ancestors.find_index(klass.superclass)-1].reverse - [klass, klass.superclass] - klass.prepended_modules
-
-          module_list.each_with_index do |m, add|
-            puts "\e[#{MCOLOR}m<M>\e[m#{m.inspect}"
-            @last_check[nest] = true
-
-            nest.times do |column_number|
-              print ((@last_check[column_number])? " " : "│") + " " * SPACE_SIZE
-            end
-            print "└──── "
-            nest += 1
-          end
-        end
-
-        puts ( klass.kind_of?(Class) )? "\e[#{CCOLOR}m<C>\e[m#{klass.inspect}" : "\e[#{MCOLOR}m<M>\e[m#{klass.inspect}"
-
-        subclasses.each do |sub|
-          @last_check[nest] = true if sub == subclasses.last
-
-          nest.times do |column_number|
-            print ((@last_check[column_number])? " " : "│") + " " * SPACE_SIZE
-          end
-
-          if @tree.has_key?(sub)
-            print ( sub == subclasses.last )? "└──── " : "├──── "
-            if sub == subclasses.last
-              draw_tree({ sub => @tree[sub]}, nest + 1, false, true)
-            else
-              draw_tree({ sub => @tree[sub]}, nest + 1, false, false)
-            end
-          else
-            print "#{( sub == subclasses.last )? '└──── ' : '├──── '}"
-            nest_count = 0
-            if( @mflag && sub.kind_of?(Class) ) 
-              module_list = sub.ancestors[0..sub.ancestors.find_index(klass)-1].reverse - ([sub, klass] + sub.prepended_modules)
-              @last_check[nest] = ( sub == subclasses.last )? true : false
-
-              module_list.each_with_index do |m, add|
-                puts "\e[#{MCOLOR}m<M>\e[m#{m.inspect}"
-                @last_check[nest+add+1] = true
-
-                (nest+add+1).times do |column_number|
-                  print ((@last_check[column_number])? " " : "│") + " " * SPACE_SIZE
-                end
-                print "└──── "
-                nest_count += 1
-              end
-            end
-            puts ( sub.kind_of?(Class) )? "\e[#{CCOLOR}m<C>\e[m#{sub.inspect}" : "\e[#{MCOLOR}m<M>\e[m#{sub.inspect}"
-
-            if ( @mflag && sub.kind_of?(Class) )
-              prepended_modules = sub.prepended_modules
-
-              prepended_modules.each_with_index do |m, add|
-                (nest+nest_count+add+1).times do |column_number|
-                  print ((@last_check[column_number])? " " : "│") + " " * SPACE_SIZE
-                end
-                puts "└──── \e[#{MCOLOR}m<M>\e[m#{m.inspect}"
-                @last_check[nest+add+1] = true
-              end
-            end
-          end
-        end
+  def get_modules(klass, path)
+    ObjectSpace.each_object(Module).map do |k|
+      l = k.ancestors
+      if l.each_cons(path.size).include?(path)
+        (l[l.index(k)..l.index(klass)] - path).last
       end
-    end
+    end.compact.uniq
   end
 end

data/object_tree.gemspec

@@ -8,16 +8,20 @@ Gem::Specification.new do |spec|
   spec.version       = ObjectTree::VERSION
   spec.authors       = ["siman-man"]
   spec.email         = ["k128585@ie.u-ryukyu.ac.jp"]
-  spec.description   = "this is ruby object tree show like tree commnad!"
-  spec.summary       = "tree command like show object hierarchy"
+  spec.description   = "like tree command for Ruby ancestors."
+  spec.summary       = "like tree command for Ruby ancestors."
   spec.homepage      = "https://github.com/siman-man/object_tree"
   spec.license       = "MIT"
+  spec.required_ruby_version = '>= 2.0.0'
 
   spec.files         = `git ls-files`.split($/)
   spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ["lib"]
 
-  spec.add_development_dependency "bundler", "~> 1.3"
-  spec.add_development_dependency "rake"
+  spec.add_dependency 'colorize'
+
+  spec.add_development_dependency "bundler", "~> 1.14"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
 end

data/spec/fixtures/example.rb

@@ -0,0 +1,72 @@
+module Case1
+  class A
+  end
+
+  class B < A
+  end
+
+  class C < B
+  end
+end
+
+module Case2
+  module A
+  end
+
+  class B
+    include A
+  end
+end
+
+module Case3
+  class A
+  end
+
+  class B < A
+  end
+
+  class C < A
+  end
+end
+
+module Case4
+  module D
+  end
+
+  module E
+  end
+
+  class A
+    include D
+  end
+
+  class B < A
+  end
+
+  class C < A
+    include E
+  end
+end
+
+module Case5
+  module D
+  end
+
+  module E
+  end
+
+  class A
+    include D
+  end
+
+  class B < A
+  end
+
+  class C < A
+    include E
+  end
+
+  class F < B
+    include E
+  end
+end

data/spec/object_tree_spec.rb

@@ -0,0 +1,60 @@
+require 'fixtures/example'
+
+describe ObjectTree do
+  describe 'examples' do
+    it 'test case 1' do
+      expect =<<-EXPECT
+<C> Case1::A
+└───── <C> Case1::B
+        └───── <C> Case1::C
+      EXPECT
+
+      expect(ObjectTree.create(Case1::A).to_s.uncolorize).to eq(expect)
+    end
+
+    it 'test case 2' do
+      expect =<<-EXPECT
+<M> Case2::A
+└───── <C> Case2::B
+      EXPECT
+
+      expect(ObjectTree.create(Case2::A).to_s.uncolorize).to eq(expect)
+    end
+
+    it 'test case 3' do
+      expect =<<-EXPECT
+<C> Case3::A
+├───── <C> Case3::C
+└───── <C> Case3::B
+      EXPECT
+
+      expect(ObjectTree.create(Case3::A).to_s.uncolorize).to eq(expect)
+    end
+
+    it 'test case 4' do
+      expect =<<-EXPECT
+<M> Case4::D
+└───── <C> Case4::A
+        ├───── <M> Case4::E
+        │       └───── <C> Case4::C
+        └───── <C> Case4::B
+      EXPECT
+
+      expect(ObjectTree.create(Case4::D).to_s.uncolorize).to eq(expect)
+    end
+
+    it 'test case 5' do
+      expect =<<-EXPECT
+<M> Case5::D
+└───── <C> Case5::A
+        ├───── <C> Case5::B
+        │       └───── <M> Case5::E
+        │               └───── <C> Case5::F
+        └───── <M> Case5::E
+                └───── <C> Case5::C
+      EXPECT
+
+      expect(ObjectTree.create(Case5::D).to_s.uncolorize).to eq(expect)
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,106 @@
+# This file was generated by the `rspec --init` command. Conventionally, all
+# specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.
+# The generated `.rspec` file contains `--require spec_helper` which will cause
+# this file to always be loaded, without a need to explicitly require it in any
+# files.
+#
+# Given that it is always loaded, you are encouraged to keep this file as
+# light-weight as possible. Requiring heavyweight dependencies from this file
+# will add to the boot time of your test suite on EVERY test run, even for an
+# individual file that may not need all of that loaded. Instead, consider making
+# a separate helper file that requires the additional dependencies and performs
+# the additional setup, and require it from the spec files that actually need
+# it.
+#
+# The `.rspec` file also contains a few flags that are not defaults but that
+# users commonly want.
+#
+# See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
+
+require 'object_tree'
+
+RSpec.configure do |config|
+  # rspec-expectations config goes here. You can use an alternate
+  # assertion/expectation library such as wrong or the stdlib/minitest
+  # assertions if you prefer.
+  config.expect_with :rspec do |expectations|
+    # This option will default to `true` in RSpec 4. It makes the `description`
+    # and `failure_message` of custom matchers include text for helper methods
+    # defined using `chain`, e.g.:
+    #     be_bigger_than(2).and_smaller_than(4).description
+    #     # => "be bigger than 2 and smaller than 4"
+    # ...rather than:
+    #     # => "be bigger than 2"
+    expectations.include_chain_clauses_in_custom_matcher_descriptions = true
+  end
+
+  # rspec-mocks config goes here. You can use an alternate test double
+  # library (such as bogus or mocha) by changing the `mock_with` option here.
+  config.mock_with :rspec do |mocks|
+    # Prevents you from mocking or stubbing a method that does not exist on
+    # a real object. This is generally recommended, and will default to
+    # `true` in RSpec 4.
+    mocks.verify_partial_doubles = true
+  end
+
+  # This option will default to `:apply_to_host_groups` in RSpec 4 (and will
+  # have no way to turn it off -- the option exists only for backwards
+  # compatibility in RSpec 3). It causes shared context metadata to be
+  # inherited by the metadata hash of host groups and examples, rather than
+  # triggering implicit auto-inclusion in groups with matching metadata.
+  config.shared_context_metadata_behavior = :apply_to_host_groups
+
+# The settings below are suggested to provide a good initial experience
+# with RSpec, but feel free to customize to your heart's content.
+=begin
+  # This allows you to limit a spec run to individual examples or groups
+  # you care about by tagging them with `:focus` metadata. When nothing
+  # is tagged with `:focus`, all examples get run. RSpec also provides
+  # aliases for `it`, `describe`, and `context` that include `:focus`
+  # metadata: `fit`, `fdescribe` and `fcontext`, respectively.
+  config.filter_run_when_matching :focus
+
+  # Allows RSpec to persist some state between runs in order to support
+  # the `--only-failures` and `--next-failure` CLI options. We recommend
+  # you configure your source control system to ignore this file.
+  config.example_status_persistence_file_path = "spec/examples.txt"
+
+  # Limits the available syntax to the non-monkey patched syntax that is
+  # recommended. For more details, see:
+  #   - http://rspec.info/blog/2012/06/rspecs-new-expectation-syntax/
+  #   - http://www.teaisaweso.me/blog/2013/05/27/rspecs-new-message-expectation-syntax/
+  #   - http://rspec.info/blog/2014/05/notable-changes-in-rspec-3/#zero-monkey-patching-mode
+  config.disable_monkey_patching!
+
+  # This setting enables warnings. It's recommended, but in some cases may
+  # be too noisy due to issues in dependencies.
+  config.warnings = true
+
+  # Many RSpec users commonly either run the entire suite or an individual
+  # file, and it's useful to allow more verbose output when running an
+  # individual spec file.
+  if config.files_to_run.one?
+    # Use the documentation formatter for detailed output,
+    # unless a formatter has already been configured
+    # (e.g. via a command-line flag).
+    config.default_formatter = 'doc'
+  end
+
+  # Print the 10 slowest examples and example groups at the
+  # end of the spec run, to help surface which specs are running
+  # particularly slow.
+  config.profile_examples = 10
+
+  # Run specs in random order to surface order dependencies. If you find an
+  # order dependency and want to debug it, you can fix the order by providing
+  # the seed, which is printed after each run.
+  #     --seed 1234
+  config.order = :random
+
+  # Seed global randomization in this process using the `--seed` CLI option.
+  # Setting this allows you to use `--seed` to deterministically reproduce
+  # test failures related to randomization by passing the same `--seed` value
+  # as the one that triggered the failure.
+  Kernel.srand config.seed
+=end
+end

metadata

@@ -1,60 +1,91 @@
 --- !ruby/object:Gem::Specification
 name: object_tree
 version: !ruby/object:Gem::Version
-  version: 0.0.10
+  version: 1.0.0
 platform: ruby
 authors:
 - siman-man
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-09-20 00:00:00.000000000 Z
+date: 2017-02-28 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: colorize
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.3'
+        version: '1.14'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.3'
+        version: '1.14'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '10.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
-description: this is ruby object tree show like tree commnad!
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: like tree command for Ruby ancestors.
 email:
 - k128585@ie.u-ryukyu.ac.jp
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- .gitignore
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
 - Gemfile
 - LICENSE.txt
 - README.md
 - Rakefile
-- example/sample.rb
-- example/sample2.rb
 - lib/object_tree.rb
 - lib/object_tree/version.rb
 - object_tree.gemspec
+- spec/fixtures/example.rb
+- spec/object_tree_spec.rb
+- spec/spec_helper.rb
 homepage: https://github.com/siman-man/object_tree
 licenses:
 - MIT
@@ -65,18 +96,21 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 2.0.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.0.3
+rubygems_version: 2.6.10
 signing_key: 
 specification_version: 4
-summary: tree command like show object hierarchy
-test_files: []
+summary: like tree command for Ruby ancestors.
+test_files:
+- spec/fixtures/example.rb
+- spec/object_tree_spec.rb
+- spec/spec_helper.rb

data/example/sample.rb

@@ -1,13 +0,0 @@
-require 'object_tree'
-
-class A
-end
-
-class B < A
-end
-
-class C < A
-end
-
-tree = ObjectTree::Tree.create(A, true)
-tree.draw

data/example/sample2.rb

@@ -1,21 +0,0 @@
-require 'object_tree'
-
-module D
-end
-
-module E
-end
-
-class A
-  include D
-end
-
-class B < A
-end
-
-class C < A
-  include E
-end
-
-tree = ObjectTree::Tree.create(A, true)
-tree.draw