object_tree 1.0.0 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: eda02ea8be3269346e579f37b180697ed821b74f
-  data.tar.gz: e926a68e49f4e365215057b9f78ecae18dceb572
+  metadata.gz: b30cc4942aec265a2dfbf49c18e230832ad33219
+  data.tar.gz: 178887b73d9d696305a3cc599a5d6ee37acb234a
 SHA512:
-  metadata.gz: b1413d955e7103a77375561949d0845f8a8c229c8a2217dafd32bec46d4e4a3d01c95dcae2d7b52c71a7700a3d2642722b30664807cc70c92caade5baa1d1d67
-  data.tar.gz: 1a23847e73c637de71eba4231b4e87f2636e360baf91bc840a44acd6d43a3fbf4d829041d5390bccd9a6cff8ff135790f24d186bf90144facac3380a6ea4d908
+  metadata.gz: b6974ad0855668d3fe755933e8f3db0fa246fab21898d63bb59cc216ea40d4c385cbd78f341e8ea6e06a9ff66540a70be1ad5704cc060198daf7916ddcaa0e34
+  data.tar.gz: df92457817a93efa8b98437b87d9017e49df00c4533feefdbc12a91ea45b8e4d10a59a30df1016e7dd56dfd0820691fe60d0295c8ee72ba4147522f61611f472

data/README.md

@@ -79,6 +79,35 @@ output
                 └───── <C> C
 ```
 
+can use from terminal by using `rotree` command.
+
+```
+$ rotree Numeric                                                                                                                                       [master]
+```
+
+Ruby 2.3.3
+
+```
+<C> Numeric
+├───── <C> Complex
+├───── <C> Float
+├───── <C> Integer
+│       ├───── <C> Bignum
+│       └───── <C> Fixnum
+└───── <C> Rational
+```
+
+Ruby 2.4.0
+
+```
+<C> Numeric
+├───── <C> Complex
+├───── <C> Float
+├───── <C> Integer
+└───── <C> Rational
+```
+
+you can see unify Fixnum and Bignum into Integer from ruby 2.4.0
 
 ## Contributing
 

data/exe/rotree

@@ -0,0 +1,26 @@
+#!/usr/bin/env ruby
+
+require 'object_tree'
+require 'optparse'
+
+options = { exclude: [], library: [] }
+
+opt_parse = OptionParser.new do |opt|
+  opt.banner = 'Usage: rotree [options] klass'
+  opt.on('-c', '--[no-]color', 'color option [default true]') { |c| options[:color] = c }
+  opt.on('-e `klass`', '--exclude', 'Exclude the given class/module name from object_tree.') { |klass| options[:exclude] << klass }
+  opt.on('-r `library`', 'require the library before executing ObjectTree.create(klass)') { |name| options[:library] << name }
+  opt.on('-s `space size`', '--size', 'set indent space size [default 8]') { |s| options[:space_size] = s.to_i }
+  opt.parse!(ARGV)
+end
+
+options[:library].each {|r| eval("require '#{r}'") }
+
+ObjectTree::OPTIONS.merge!(options)
+
+if ARGV.first.nil?
+  puts opt_parse
+else
+  klass = Object.const_get(ARGV.first.to_sym)
+  puts ObjectTree.create(klass)
+end

data/lib/object_tree.rb

@@ -1,6 +1,9 @@
 require 'colorize'
 
 class ObjectTree
+  attr_reader :tree
+
+  OPTIONS = { color: true, exclude: [], space_size: 8 }
   SPACE_SIZE = 8
   T_LINE = '├─────'
   I_LINE = '│'
@@ -11,12 +14,13 @@ class ObjectTree
   end
 
   def initialize(klass)
+    @tree = Hash.new {|h,k| h[k] = [] }
     @queue = []
     parse(klass)
   end
 
   def to_s
-    @queue.join
+    OPTIONS[:color] ? @queue.join : @queue.join.uncolorize
   end
 
   def output_node(klass)
@@ -32,7 +36,7 @@ class ObjectTree
   end
 
   def get_space(end_line: nil)
-    end_line ? ' ' * SPACE_SIZE : I_LINE + ' ' * (SPACE_SIZE-1)
+    end_line ? ' ' * OPTIONS[:space_size] : I_LINE + ' ' * (OPTIONS[:space_size]-1)
   end
 
   def parse(klass, space = '', path: [])
@@ -40,9 +44,9 @@ class ObjectTree
     modules = get_modules(klass, path.reverse)
     @queue << output_node(klass)
 
-    until modules.empty?
-      sub = modules.shift
-
+    while sub = modules.shift
+      next if OPTIONS[:exclude].include?(sub.to_s)
+      @tree[path.join('/')] << sub.to_s
       @queue << get_line(end_line: modules.empty?, space: space)
       parse(sub, space + get_space(end_line: modules.empty?), path: path.dup)
     end
@@ -54,6 +58,6 @@ class ObjectTree
       if l.each_cons(path.size).include?(path)
         (l[l.index(k)..l.index(klass)] - path).last
       end
-    end.compact.uniq
+    end.compact.uniq.sort_by(&:to_s)
   end
 end

data/lib/object_tree/version.rb

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

data/object_tree.gemspec

@@ -1,6 +1,7 @@
 # coding: utf-8
 lib = File.expand_path('../lib', __FILE__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
 require 'object_tree/version'
 
 Gem::Specification.new do |spec|
@@ -8,15 +9,19 @@ Gem::Specification.new do |spec|
   spec.version       = ObjectTree::VERSION
   spec.authors       = ["siman-man"]
   spec.email         = ["k128585@ie.u-ryukyu.ac.jp"]
+
   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.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
 
   spec.add_dependency 'colorize'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: object_tree
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.0
 platform: ruby
 authors:
 - siman-man
 autorequire: 
-bindir: bin
+bindir: exe
 cert_chain: []
-date: 2017-02-28 00:00:00.000000000 Z
+date: 2017-03-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: colorize
@@ -69,7 +69,8 @@ dependencies:
 description: like tree command for Ruby ancestors.
 email:
 - k128585@ie.u-ryukyu.ac.jp
-executables: []
+executables:
+- rotree
 extensions: []
 extra_rdoc_files: []
 files:
@@ -80,12 +81,10 @@ files:
 - LICENSE.txt
 - README.md
 - Rakefile
+- exe/rotree
 - 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
@@ -110,7 +109,4 @@ rubygems_version: 2.6.10
 signing_key: 
 specification_version: 4
 summary: like tree command for Ruby ancestors.
-test_files:
-- spec/fixtures/example.rb
-- spec/object_tree_spec.rb
-- spec/spec_helper.rb
+test_files: []

data/spec/fixtures/example.rb

@@ -1,72 +0,0 @@
-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

@@ -1,60 +0,0 @@
-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

@@ -1,106 +0,0 @@
-# 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