interesting_methods 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a276376aa8fa9a85470d70a7629afd7d6cdb5bd69739bd043ef26f20e63428dc
-  data.tar.gz: 7e0d85b0a6bdca6f9bf298678d8611969a0eaf2f3febbb0f3f9fab0e9727bd25
+  metadata.gz: 0ea34469eb43623c36642744a20b4f9798074336ac7c527da441cad58ad52d3a
+  data.tar.gz: cf66703970fd23799cf0415e21acfbb57a65502f4ef8df9498017e39a1115f22
 SHA512:
-  metadata.gz: 8a3b10d2a7f88e57e522f76776ce4cfbbd9682122c5cfb6c5fdf13202b98a8e501f997cf82e2c4503a72110f49bbdb250814b7ac35a8442b5bce252bcfc3510e
-  data.tar.gz: 00b4e5539f053b00540242ede88e24c2be7926c271c613e39ed4c7f7e3bfe54d5b1b09a0b50a1d8738f2ddeed44d4c0c5b04e08a554deff38906595314c43827
+  metadata.gz: f66807577417a46290ebd23c5352be8c90831260e1eebf19372b1689306a56f03991c752df5f964df3b6748e808b7d7e94a1e3a8701d19a5ce0e7ebb960a6911
+  data.tar.gz: 95bd4f05924c9b4ed1f8e5d8a55b0a21bfecfe73c82129c57f9f670387d2d0a37335074ff29c0d2f4fe4386f04fb9212674700c1712c23ed15a17666938c4ff9

data/.gitignore

@@ -0,0 +1,8 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in interesting_methods.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,60 @@
+PATH
+  remote: .
+  specs:
+    interesting_methods (0.1.1)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    coderay (1.1.2)
+    ffi (1.9.23)
+    formatador (0.2.5)
+    guard (2.14.2)
+      formatador (>= 0.2.4)
+      listen (>= 2.7, < 4.0)
+      lumberjack (>= 1.0.12, < 2.0)
+      nenv (~> 0.1)
+      notiffany (~> 0.0)
+      pry (>= 0.9.12)
+      shellany (~> 0.0)
+      thor (>= 0.18.1)
+    guard-compat (1.2.1)
+    guard-minitest (2.4.6)
+      guard-compat (~> 1.2)
+      minitest (>= 3.0)
+    listen (3.1.5)
+      rb-fsevent (~> 0.9, >= 0.9.4)
+      rb-inotify (~> 0.9, >= 0.9.7)
+      ruby_dep (~> 1.2)
+    lumberjack (1.0.12)
+    method_source (0.9.0)
+    minitest (5.11.3)
+    nenv (0.3.0)
+    notiffany (0.1.1)
+      nenv (~> 0.1)
+      shellany (~> 0.0)
+    pry (0.11.3)
+      coderay (~> 1.1.0)
+      method_source (~> 0.9.0)
+    rake (10.5.0)
+    rb-fsevent (0.10.3)
+    rb-inotify (0.9.10)
+      ffi (>= 0.5.0, < 2)
+    ruby_dep (1.5.0)
+    shellany (0.0.1)
+    thor (0.20.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.16)
+  guard (~> 2.14)
+  guard-minitest (~> 2.4)
+  interesting_methods!
+  minitest (~> 5.0)
+  pry (~> 0.11)
+  rake (~> 10.0)
+
+BUNDLED WITH
+   1.16.1

data/Guardfile

@@ -0,0 +1,3 @@
+guard :minitest do
+  watch(/test|lib/) { 'test' }
+end

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 Sean Lerner
+
+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,93 @@
+# Interesting Methods
+
+This gem lets you add `.im` to any object in ruby to see the interesting methods.
+
+`.im` stands for 'Interesting Methods'.
+
+Without this Gem, to find out an Object's methods, you might try this:
+
+```ruby
+MyClass.methods
+my_instance.methods
+```
+
+Each of those would show you all of the objects method's, including all those it's inherited, which may be too much to wade through to find what you're after.
+
+---
+
+In order to see just the interesting methods, you might try one of these instead:
+
+```ruby
+MyClass.methods - Object.methods
+my_instance.methods - Object.methods
+MyClass.singleton_methods(false)
+my_instance.instance_methods(false)
+MyModule.singleton_methods
+MyModule.instance_methods
+```
+
+These will show you the more useful methods on that object.
+
+---
+
+This Gem wraps the above techniques into a simple `.im` that you can call on any object (class, instance, module) and it will show the appropriate interesting methods:
+
+```
+MyClass.im
+my_instance.im
+MyModule.im
+```
+
+## Installation
+
+Create irb and pry rc files if they don't already exist:
+
+```shell
+touch ~/.irbrc
+touch ~/.pryrc
+```
+
+Edit those files and add the following code:
+
+```ruby
+# This will install interesting_methods if it's not yet installed
+unless Gem::Specification.find_all_by_name('interesting_methods').any?
+  system('gem install interesting_methods')
+end
+
+require 'interesting_methods'
+```
+
+The first time you go into `irb` or `pry`, the gem will be installed. 
+
+## Usage
+
+Load up either `irb` or `pry` from your command line.
+Add `.im` to any object to see its interesting methods.
+
+## Caveat
+
+This gem is not meant to be used in production as it monkey patches Ruby's core `Object` class.
+
+## Development
+
+After checking out this repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests.
+
+You can run `guard` for a continuous test runner.
+
+You can run `bin/console` for an interactive prompt that will allow you to experiment.
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/seanlerner/interesting_methods.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Credit
+
+Having `interesting_methods` available in your repl is something ruby programmers have been doing for a while. I think I first came across it years ago in a stackoverflow post. Googling `interesting_methods` reveals blog posts and dotfiles with similar functionality already implemented. AFAIK this is the first time its been packaged up in a gem.
+
+Sean Lerner<br>
+https://smallcity.ca

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,13 @@
+#!/usr/bin/env ruby
+
+require 'bundler/setup'
+require 'interesting_methods'
+require 'pry'
+
+require_relative '../test/test_objects/animal'
+require_relative '../test/test_objects/colours'
+require_relative '../test/test_objects/pig'
+require_relative '../test/test_objects/pig_with_colours_extended'
+require_relative '../test/test_objects/pig_with_colours_included'
+
+Pry.start

data/bin/setup

@@ -0,0 +1,6 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install

data/interesting_methods.gemspec

@@ -0,0 +1,23 @@
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+require 'interesting_methods/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'interesting_methods'
+  spec.version       = InterestingMethods::VERSION
+  spec.authors       = ['Sean Lerner']
+  spec.email         = ['sean@@smallcity.ca']
+  spec.summary       = 'See relevant methods in your repl by adding .im to any object'
+  spec.homepage      = 'https://github.com/seanlerner/interesting_methods'
+  spec.license       = 'MIT'
+  spec.files         = `git ls-files`.split.reject { |f| f.match('test') }
+  spec.require_paths = ['lib']
+
+  spec.add_development_dependency 'bundler',        '~> 1.16'
+  spec.add_development_dependency 'guard',          '~> 2.14'
+  spec.add_development_dependency 'guard-minitest', '~> 2.4'
+  spec.add_development_dependency 'minitest',       '~> 5.0'
+  spec.add_development_dependency 'pry',            '~> 0.11'
+  spec.add_development_dependency 'rake',           '~> 10.0'
+end

data/lib/interesting_methods.rb

@@ -0,0 +1,19 @@
+class Object
+
+  def im
+    interesting_methods
+  end
+
+  def interesting_methods
+    if self.class == Module
+      (singleton_methods + instance_methods).sort
+    else
+      (public_methods - Object.methods).sort
+    end
+  end
+
+  def self.interesting_methods
+    (public_methods - Object.methods).sort
+  end
+
+end

data/lib/interesting_methods/version.rb

@@ -0,0 +1,3 @@
+module InterestingMethods
+  VERSION = '0.1.1'
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: interesting_methods
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Sean Lerner
@@ -100,7 +100,19 @@ email:
 executables: []
 extensions: []
 extra_rdoc_files: []
-files: []
+files:
+- ".gitignore"
+- Gemfile
+- Gemfile.lock
+- Guardfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- interesting_methods.gemspec
+- lib/interesting_methods.rb
+- lib/interesting_methods/version.rb
 homepage: https://github.com/seanlerner/interesting_methods
 licenses:
 - MIT