constree 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: fd2b780d56b1776a610fc399ffbbc161843146f3
+  data.tar.gz: dae4b75255c0105ab09a46b39286a862f5766dcb
+SHA512:
+  metadata.gz: bc5445f233c122acbb4db2ca7123adcd3d9825245a7010f4f4f065f39766b28cc45b5f340c03c5eac936572a61d2252cfb825fa36296821ba8cec56b6a882b07
+  data.tar.gz: db1d5c3861311b7a473b2ce528d67bb8293d9af9eb554b943e7ce6a37b0277d39109c78e706aa5764b1e223790eb4ddde009f76577875f9bc76e24193dd7d119

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.swp
+*.gem

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.2.2
+before_install: gem install bundler -v 1.13.6

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at block24block@gmail.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in constree.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 ken
+
+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.md

@@ -0,0 +1,42 @@
+# Constree
+
+Recursively show the structure of constants in a module
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'constree'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install constree
+
+## Example: constants in Minitest::Spec
+
+```ruby
+2.2.2 :001 > require 'constree/module'
+ => true
+2.2.2 :002 > require 'minitest/spec'
+ => true
+2.2.2 :003 > Minitest::Spec.constreep
+Minitest::Spec (Class)
+DSL (Module)
+ TYPES (Array)
+ InstanceMethods (Module)
+TYPES  Minitest::Spec::DSL::TYPES
+PASSTHROUGH_EXCEPTIONS (Array)
+TEARDOWN_METHODS (Array)
+LifecycleHooks (Module)
+UNDEFINED (Object)
+E (String)
+SIGNALS (Hash)
+ => nil
+```
+

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList['test/**/*_test.rb']
+end
+
+task :default => :test

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "constree"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/constree.gemspec

@@ -0,0 +1,26 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'constree/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "constree"
+  spec.version       = Constree::VERSION
+  spec.authors       = ["ken"]
+  spec.email         = ["block24block@gmail.com"]
+
+  spec.summary       = %q{recursively show the structure of constants in a module}
+  spec.homepage      = "https://github.com/turnon/constree"
+  spec.license       = "MIT"
+
+  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_development_dependency "bundler", "~> 1.13"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "minitest", "~> 5.0"
+end

data/lib/constree.rb

@@ -0,0 +1,32 @@
+require 'constree/version'
+require 'constree/node'
+
+module Constree
+
+  class << self
+
+    def list node, seen=[]
+      node = Node.new node unless node.is_a? Node
+      seen << node if seen.empty?
+
+      node.sub_nodes.each do |sub_n|
+        seen << sub_n
+        list(sub_n, seen) if sub_n.not_yet? seen
+      end
+
+      seen
+    end
+
+    def of mod
+      list(mod).
+        map(&:level).
+        join("\n")
+    end
+
+    def p mod
+      puts of mod
+    end
+
+  end
+
+end

data/lib/constree/module.rb

@@ -0,0 +1,11 @@
+require 'constree'
+
+class Module
+  def constree
+    ::Constree.of self
+  end
+
+  def constreep
+    ::Constree.p self
+  end
+end

data/lib/constree/node.rb

@@ -0,0 +1,79 @@
+module Constree
+  Node = Struct.new :constant, :name, :parent, :is_last do
+
+    attr_accessor :ref
+
+    def sub_nodes
+      return [] unless constant.is_a? Module
+      names = constant.constants
+      names.reduce([]) do |nodes, name|
+        nodes << Node.new(constant.const_get(name), name, self, nodes.count == names.count - 1)
+      end
+    end
+
+    def ancestors
+      return [] unless parent
+      p, anc = parent, []
+      while p
+        anc.unshift p
+        p = p.parent
+      end
+      anc
+    end
+
+    def last?
+      is_last ? true : false
+    end
+
+    def top?
+      parent ? false : true
+    end
+
+    def branch
+      return '' unless parent
+      last? ? '└─' : '├─'
+    end
+
+    def indent
+      ancestors.map do |a|
+        if a.top?
+          ''
+        else
+          a.last? ? ' ' : '│ '
+        end
+      end.join
+    end
+
+    def level
+      indent + branch + display_name + ' ' + type
+    end
+
+    def display_name
+      (name || constant.name).to_s
+    end
+
+    def full_name
+      top? ? constant.name : "#{parent.full_name}::#{name}"
+    end
+
+    def == other
+      return false unless other.is_a? Node
+      constant == other.constant
+    end
+
+    def type
+      ref ? "→ #{ref.full_name}" : "(#{constant.class.to_s})"
+    end
+
+    def not_yet? seen
+      i = seen.find_index self
+      if i == seen.count - 1
+       true
+      else
+        self.ref = seen[i]
+        false
+      end
+    end
+
+  end
+end

data/lib/constree/version.rb

@@ -0,0 +1,3 @@
+module Constree
+  VERSION = "0.1.0"
+end

metadata

@@ -0,0 +1,100 @@
+--- !ruby/object:Gem::Specification
+name: constree
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- ken
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-01-21 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.13'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.13'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+description: 
+email:
+- block24block@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- constree.gemspec
+- lib/constree.rb
+- lib/constree/module.rb
+- lib/constree/node.rb
+- lib/constree/version.rb
+homepage: https://github.com/turnon/constree
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.8
+signing_key: 
+specification_version: 4
+summary: recursively show the structure of constants in a module
+test_files: []