explore_rb 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: e789a5bea07085d3d886cdc7bad1ef239e077032
+  data.tar.gz: bbf83d6df5a2867654cb299f47227b2d60d8b0ad
+SHA512:
+  metadata.gz: 8be37b2381362b8a395cce21984c59b4143e92224931675035b1070f5762891f3f37f75650b8e8c76aa9e2712eb635839608e845ce3c4182fb970514533b2fdb
+  data.tar.gz: 59a5ab6e3fd7a7341896251186209b0b91c50c3300f0973a8d6620f6f13c03485ac1b7a41f0f3848d01c114c4bfbf3d710887607815a8c9daa358fcafc025707

data/.gitignore

@@ -0,0 +1,18 @@
+*.swp
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Mike Williamson
+
+MIT License
+
+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,107 @@
+# ExploreRb
+
+This is a gem that aims to add a little "discoverability" to IRB. It does this
+by adding methods for showing classes, objects and so on in hopes that this
+will create a few teachable moments and enable beginners to explore the
+mysterious world that IRB represents.
+
+## Installation
+
+Install at the command line:
+
+    $ gem install explore_rb
+
+## Usage
+
+    $ irb
+    $ require 'explore_rb'
+
+### Listing Classes
+
+List the classes that are currently defined by typing:
+
+    $ classes
+
+### Listing Objects
+
+A hash containing the class and the number of objects that exist in memory is returned by typing:
+
+    $ objects
+
+### Retrieving Objects
+
+To retrieve all of the objects of a given type use 'get_objects':
+
+    $ class Book; end
+    $ Book.new
+    $ get_objects(Book)
+    $ => [<#Book>]
+
+### Listing installed gems
+
+As you might expect, list gems with:
+
+    $ gems
+
+### Listing Symbols
+
+You can get an array of all existing symbols with:
+
+    $ symbols
+
+### Visualizing code execution
+
+An SVG file showing the various function calls will be written to the desktop
+when 'draw_this' is called with a block.  This functionality is provided by the
+Traceur gem. Usage looks like this:
+
+    $ draw_this do
+    $   # some code that has some method calls
+    $ end
+
+Be conservative with what you put inside that block. Its really easy to end up
+with an SVG file that is so big that no application can open it.  The lines and
+fonts are as small as possible since there can be a tonne of stuff written in
+there.  Consequently Inkscape is probably the best choice to view the files
+because you can zoom in lots.
+
+### Listing variables
+
+The greeting message displayed when this library is required mentions
+'local_variables'. This is an existing Ruby method, and not one supplied by
+this library but it was worth pointing out since fits in with what this library
+is trying to accomplish.
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request
+
+## License
+
+(The MIT License)
+
+Copyright (c) 2013 Mike Williamson
+
+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/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/explore_rb.gemspec

@@ -0,0 +1,20 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'explore_rb/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = "explore_rb"
+  gem.version       = ExploreRb::VERSION
+  gem.authors       = ["Mike Williamson"]
+  gem.email         = ["blessedbyvirtuosity@gmail.com"]
+  gem.description   = "This gem extends the main object with helper methods to help beginners explore the Ruby environment when using IRB."
+  gem.summary       = "Helper methods for exploring Ruby via IRB"
+  gem.homepage      = ""
+
+  gem.files         = `git ls-files`.split($/)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.require_paths = ["lib"]
+  gem.add_dependency "traceur"
+end

data/lib/explore_rb/version.rb

@@ -0,0 +1,3 @@
+module ExploreRb
+  VERSION = "0.0.1"
+end

data/lib/explore_rb.rb

@@ -0,0 +1,57 @@
+require 'traceur'
+require "explore_rb/version"
+
+module ExploreRb
+
+  include GC
+
+  def self.extended base
+    puts "Use the following commands to look around:"
+    puts "classes, objects, get_objects, symbols, local_variables, gems, draw_this, help"
+  end
+
+  def classes
+    (Object.constants - [:RUBY_COPYRIGHT, :RUBY_DESCRIPTION, :RUBY_ENGINE, :RUBY_PATCHLEVEL, :RUBY_PLATFORM, :RUBY_RELEASE_DATE, :RUBY_REVISION, :RUBY_VERSION, :CROSS_COMPILING ]).sort
+  end
+
+  def objects
+    objects = Hash.new {0}
+    ObjectSpace.each_object{|obj| objects[obj.class] += 1 }
+    objects
+  end
+
+  def get_objects klass
+    requested_klass = []
+    ObjectSpace.each_object{|o| requested_klass << ObjectSpace._id2ref(o.object_id) if o.class == klass}
+    requested_klass
+  end
+
+  def symbols
+    Symbol.all_symbols
+  end
+
+  def gems
+    gems = {}
+    Gem::Specification.each{|s| gems[s.name]= s.gem_dir.gsub(ENV['HOME'], "~") }
+    gems
+  end
+
+  def draw_this &block
+    path = "#{ENV['HOME']}/Desktop"
+    Traceur.watch_paths('.+', path, &block)
+    puts "File saved in #{path}."
+  end
+
+  def collect_garbage
+    GC.stress = true # enable hyperactive garbage collection
+    garbage_collect
+    GC.stress = false
+    #puts "Dumped #{GC.stat[:total_freed_object]} objects from memory"
+    GC.stat
+  end
+
+
+end
+
+# add exploreRb methods to the main object
+self.extend ExploreRb

metadata

@@ -0,0 +1,66 @@
+--- !ruby/object:Gem::Specification
+name: explore_rb
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Mike Williamson
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-03-23 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: traceur
+  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'
+description: This gem extends the main object with helper methods to help beginners
+  explore the Ruby environment when using IRB.
+email:
+- blessedbyvirtuosity@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- explore_rb.gemspec
+- lib/explore_rb.rb
+- lib/explore_rb/version.rb
+homepage: ''
+licenses: []
+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.0.0
+signing_key: 
+specification_version: 4
+summary: Helper methods for exploring Ruby via IRB
+test_files: []