object_identifier 0.0.6 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 89be2d486507ddbd5182f7fb39bcfcd9afaa6a18
-  data.tar.gz: 9b6da56732eb50db9e65ae9f70364d4a64173650
+SHA256:
+  metadata.gz: 15ea208b08827813706ca4351a58709ec064d4ba9ad365084c6ef954daf40148
+  data.tar.gz: 9044d50b67314cd0a7da45d27874acf807fc13829fd0ef5f10eb5d1a0a3f23c6
 SHA512:
-  metadata.gz: f6649983366ea699aa1f1ae45645b22cb3304a3f8f6a561f73e15a330a73222b084cc664f2cbb43790e6d0fd09b36b93eeaebb843a0a966f60d6ec717c208cca
-  data.tar.gz: 8f250fed936c1c3f2f22473832af284c389f5ce013a0de36203739df57200e779b04d2cdd8bceed85606faa8963e705e6b8c32f969ec6d85c9d9336eac2cf79a
+  metadata.gz: 79481c060a1469918bf2e4e9ebcc99f469132ded28794b1ef5cb6944e3a39159052db3a87a323f605e786efeb71ae10fafa2c6f37ea286517d6a595536d74597
+  data.tar.gz: 20e1a1255476b06f0f5a9804daec02703b7c7d913f401b38fd6d632df7327df74c74ba784e380881d2b6938a10bc51d73104f1ebe16cd5a1e043503d0e703f65

data/.gitignore

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

data/.travis.yml

@@ -0,0 +1,21 @@
+env:
+  global:
+    - CC_TEST_REPORTER_ID=3b57e55dcd3cc40ee073715e7d75fa80ab7b7687cb8a420eac500d27b5cb28db
+sudo: false
+language: ruby
+rvm:
+  - 2.2.10
+  - 2.3.7
+  - 2.4.4
+  - 2.5.1
+  - ruby-head
+notifications:
+  email: false
+before_install: gem install bundler -v 1.16.1
+cache: bundler
+before_script:
+  - curl -L https://codeclimate.com/downloads/test-reporter/test-reporter-latest-linux-amd64 > ./cc-test-reporter
+  - chmod +x ./cc-test-reporter
+  - ./cc-test-reporter before-build
+after_script:
+  - ./cc-test-reporter after-build --exit-code $TRAVIS_TEST_RESULT

data/CHANGELOG.md

@@ -0,0 +1,10 @@
+### 0.1.0 - 2018-04-14
+
+* Revamp gem
+* Update gem dependencies
+* Now returns "[no objects]" even if given a :klass option
+
+
+### 0.0.6 - 2016-02-06
+
+* Fix: identify method now supports private & protected methods

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 object_identifier.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,51 @@
+PATH
+  remote: .
+  specs:
+    object_identifier (0.1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    ansi (1.5.0)
+    builder (3.2.3)
+    byebug (10.0.2)
+    coderay (1.1.2)
+    docile (1.3.0)
+    json (2.1.0)
+    method_source (0.9.0)
+    minitest (5.4.1)
+    minitest-reporters (1.2.0)
+      ansi
+      builder
+      minitest (>= 5.0)
+      ruby-progressbar
+    pry (0.11.3)
+      coderay (~> 1.1.0)
+      method_source (~> 0.9.0)
+    pry-byebug (3.6.0)
+      byebug (~> 10.0)
+      pry (~> 0.10)
+    rake (10.3.2)
+    ruby-progressbar (1.9.0)
+    simplecov (0.16.1)
+      docile (~> 1.1)
+      json (>= 1.8, < 3)
+      simplecov-html (~> 0.10.0)
+    simplecov-html (0.10.2)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.16)
+  byebug (~> 10.0)
+  minitest (~> 5.0)
+  minitest-reporters (~> 1.2)
+  object_identifier!
+  pry (~> 0.11)
+  pry-byebug (~> 3.6)
+  rake (~> 10.0)
+  simplecov (~> 0.16)
+
+BUNDLED WITH
+   1.16.1

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 Paul Dobbins
+
+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

@@ -1,8 +1,11 @@
 # Object Identifier
 
 [![Gem Version](https://badge.fury.io/rb/object_identifier.png)](http://badge.fury.io/rb/object_identifier)
+[![Build Status](https://travis-ci.org/pdobb/object_identifier.svg?branch=master)](https://travis-ci.org/pdobb/object_identifier)
+[![Test Coverage](https://api.codeclimate.com/v1/badges/0b737a72d16ec755c1ff/test_coverage)](https://codeclimate.com/github/pdobb/object_identifier/test_coverage)
+[![Maintainability](https://api.codeclimate.com/v1/badges/0b737a72d16ec755c1ff/maintainability)](https://codeclimate.com/github/pdobb/object_identifier/maintainability)
 
-Object Identifier allows quick, easy, and uniform identification of an object by inspecting its class name and outputting any desirable attributes/methods. This is great for quickly logging, sending more descriptive notifications, or any other purpose.
+Object Identifier allows quick, easy, and uniform identification of an object by inspecting its class name and outputting any desirable attributes/methods. It is great for quickly logging, sending descriptive notification messages, etc.
 
 For example:
 
@@ -17,117 +20,148 @@ Which is the same as:
 ```
 
 
-## Compatibility
-
-* Ruby: MRI 1.9.3+
-* Ruby: MRI 2+
-* Rails: 3+
-
-
 ## Installation
 
 Add this line to your application's Gemfile:
 
 ```ruby
-gem 'object_identifier'
+gem "object_identifier"
 ```
 
 And then execute:
 
-```ruby
-bundle
-```
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install object_identifier
+
+
+## Compatibility
+
+Tested MRI Ruby Versions:
+* 2.2.10
+* 2.3.7
+* 2.4.4
+* 2.5.1
+* edge
 
 
 ## Usage
 
 ### Defaults
 
-Outputs the `id` attribute by default, if possible and if no other attributes
-are given:
+`identify` outputs the `id` of the receiving object by default, if it exists and no other attributes/methods are specified.
 
 ```ruby
-some_object.identify  # => Movie[id:1]
+my_movie.identify           # => Movie[id:1]
+my_movie.identify(:rating)  # => Movie[rating:"7/10"]
 ```
 
-Also works with methods:
+Private methods can be identified just the same as public methods.
 
 ```ruby
-some_object.identify(:get_rating)  # => Movie[get_rating:"7/10"]
+my_movie.identify(:my_private_method)  # => Movie[my_private_method:"Shh"]
 ```
 
+
 ### Unknown Attributes/Methods
 
-If the object doesn't respond to a specified attribute/method it is simply
-ignored:
+If the object doesn't respond to a specified attribute/method it is simply ignored:
 
 ```ruby
-some_object.identify(:gobble_gobble, :id)  # => Movie[id:1]
+my_movie.identify(:gobble_gobble, :rating)  # => Movie[rating:"7/10"]
 ```
 
-### Collections
+### Overriding Class Names
+
+```ruby
+my_delayed_job.identify(klass: "Delayed::Job")  # => Delayed::Job[id:1]
+my_movie.identify(klass: nil)                   # => [id:1]
+```
 
-Works great with collections:
+
+### Identifying Nil
 
 ```ruby
-[some_object, some_other_object].identify(:id, :name)
-  # => Movie[id:1, name:"Pi"], Contact[id:23, name:"Bob"]
+nil.identify(:id, :name)                 # => [no objects]
+nil.identify(:id, :name, klass: "Nope")  # => [no objects]
 ```
 
-Also allows limiting of results:
+
+### Collections
+
+Collections of objects are each identified in turn.
 
 ```ruby
-[some_object, some_other_object].identify(:id, :name, limit: 1)
-  # => Movie[id:1, name:"Pi"], ... (1 more)
+[my_movie, my_user].identify(:id, :name)
+# => Movie[id:1, name:"Pi"], User[id:1, name:"Bob"]
 ```
 
-### Overriding the Class Name
+The number of results that will be identified from a collection can be truncated by specifying the `limit` option.
 
 ```ruby
-some_object.identify(klass: "MyMovie")       # => MyMovie[id:1]
-some_object.identify(klass: nil)             # => [id:1]
-delayed_job.identify(klass: "Delayed::Job")  # => Delayed::Job[id:1]
+[my_movie, my_contact].identify(:id, :name, limit: 1)
+# => Movie[id:1, name:"Pi"], ... (1 more)
 ```
 
-### Nils and Empty Collections
+
+### Empty Collections
 
 ```ruby
-nil.identify(:id, :name)  # => [no objects]
-[].identify               # => [no objects]
+[].identify  # => [no objects]
+{}.identify  # => [no objects]
 ```
 
 
 ## Custom Object Identifiers
 
-Internally, Object Identifier relies on a method named `inspect_lit` to return a "literally-inspected" string representation of all objects being identified. For example:
+Internally, Object Identifier calls `inspect_lit` to return a "literally-inspected" string representation of an object. This works because Object, itself, is monkey-patched to define `inspect_lit` which just returns `inspect`. This is sufficient for most objects, but some objects will benefit from defining special output from `inspect_lit`.
+
+Object Identifier defines `inspect_lit` on three other core objects: String, Symbol, and BigDecimal.
 
 ```ruby
-:a_symbol.respond_to?(:inspect_lit) # => true
-:a_symbol.inspect_lit               # => ":\"a_symbol\""
-"a_string".inspect_lit              # => "\"a_string\""
-BigDecimal(1.99, 3).inspect_lit     # => "<BD:1.99>"
+"a_string".inspect_lit           # => "\"a_string\""
+:a_symbol.inspect_lit            # => ":\"a_symbol\""
+BigDecimal(1.99, 3).inspect_lit  # => "<BD:1.99>"
 ```
 
-Therefore, if you'd like to represent a custom object in a special way for object identification, just define the to-string conversion within the `inspect_lit` method.
-
+To identify an object in a special way, just define `inspect_lit` to return a custom String.
 
 ```ruby
-class MyVal
+class MyValueObject
   def initialize(val)
     @val = val
   end
 
   def inspect_lit
-    "<MOO:#{@val}>"
+    "#{@val} Meters"
   end
 end
 
-OpenStruct.new(my_val: MyVal.new(42)).identify(:my_val)
-# => "OpenStruct[my_val:<MOO:42>]"
+my_value_object = MyValueObject.new(42)
+OpenStruct.new(my_value: my_value_object).identify(:my_value)
+# => "OpenStruct[my_value:42 Meters]"
 ```
 
 
-## Authors
+## Supporting Gems
+
+ObjectIdentifier works great with the [ObjectInspector](https://github.com/pdobb/object_inspector) gem.
+
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/pdobb/object_identifier.
+
+
+## License
 
-- Paul Dobbins
-- Evan Sherwood
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -1,32 +1,10 @@
-begin
-  require 'bundler/setup'
-rescue LoadError
-  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
-end
-
-require 'rdoc/task'
-
-RDoc::Task.new(:rdoc) do |rdoc|
-  rdoc.rdoc_dir = 'rdoc'
-  rdoc.title    = 'ObjectIdentifier'
-  rdoc.options << '--line-numbers'
-  rdoc.rdoc_files.include('README.rdoc')
-  rdoc.rdoc_files.include('lib/**/*.rb')
-end
-
-
-
-
-Bundler::GemHelper.install_tasks
-
-require 'rake/testtask'
+require "bundler/gem_tasks"
+require "rake/testtask"
 
 Rake::TestTask.new(:test) do |t|
-  t.libs << 'lib'
-  t.libs << 'test'
-  t.pattern = 'test/**/*_test.rb'
-  t.verbose = false
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList["test/**/*_test.rb"]
 end
 
-
-task default: :test
+task :default => :test

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "object_identifier"
+
+# 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(__FILE__)

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/lib/object_identifier/core_ext/big_decimal.rb

@@ -1,11 +1,13 @@
+require "bigdecimal"
+
 class BigDecimal
   # Formats this BigDecimal as an object-type-revealing String.
   #
   # @return [String] a String representation of this BigDecimal object
   #
   # @example
-  #   BigDecimal.new(1).inspect_lit         # => "<BD:1.0>"
-  #   BigDecimal.new(99.999, 5).inspect_lit # => "<BD:99.999>"
+  #   BigDecimal.new(1).inspect_lit          # => "<BD:1.0>"
+  #   BigDecimal.new(99.999, 5).inspect_lit  # => "<BD:99.999>"
   def inspect_lit
     "<BD:#{self}>"
   end

data/lib/object_identifier/core_ext/object.rb

@@ -1,9 +1,8 @@
 class Object
   # Standard #inspect for any object that doesn't override this method. This
-  # method is meant to make an object's type inherently obvious when used in
-  # logging methods, etc.
+  # method is meant to make an object's type inherently obvious inspected.
   #
-  # @return [String] a string representation of this object
+  # @return [String] a String-literal representation of this object
   def inspect_lit
     inspect
   end
@@ -20,23 +19,23 @@ class Object
   #   @param [Hash] options the options for building a customized
   #     self-identifier
   #   @option options [String, nil] :klass object class name override
-  #   @option options [Fixnum] :limit maximum number of objects to display from
+  #   @option options [Integer] :limit maximum number of objects to display from
   #     a collection
   #
-  # @return [String] a self-identifying string like `Class[id:1, name:'temp']`
+  # @return [String] a self-identifying string
   #
   # @example
   #   OpenStruct.new(a: 1, b: '2', c: :"3").identify(:a, :b, :c)
   #   # => "OpenStruct[a:1, b:\"2\", c::\"3\"]"
   #
-  #   1.identify(:to_s) # => "Fixnum[to_s:\"1\"]"
+  #   1.identify(:to_s) # => "Integer[to_s:\"1\"]"
   #   nil.identify      # => "[no objects]"
   #
   #   %w(1 2 3).identify(:to_i, :to_f)
   #   # => "String[to_i:1, to_f:1.0], String[to_i:2, to_f:2.0], String[to_i:3, to_f:3.0]"
   #
   #   (1..10).to_a.identify(:to_f, limit: 2)
-  #   # => "Fixnum[to_f:1.0], Fixnum[to_f:2.0], ... (8 more)"
+  #   # => "Integer[to_f:1.0], Integer[to_f:2.0], ... (8 more)"
   def identify(*args)
     ObjectIdentifier::Identifier.identify(self, *args)
   end

data/lib/object_identifier/core_ext/string.rb

@@ -1,13 +1,13 @@
 class String
-  # Formats this string to look like a string literal so that object type will
-  # be inherently obvious when used in logging methods, etc.
+  # Formats self to look like a String literal so that object type will be
+  # inherently obvious when inspected.
   #
-  # @return [String] a string literal representation of this object
+  # @return [String] a String-literal representation of this object
   #
   # @example
-  #   "test".inspect_lit # => "\"test\"" (or '"test"')
-  #   "1".inspect_lit    # => "\"1\"" (or '"1"')
-  #   "12.3".inspect_lit # => "\"12.3\"" (or '"12.3"')
+  #   "test".inspect_lit  # => "\"test\"" (i.e. '"test"')
+  #   "1".inspect_lit     # => "\"1\""    (i.e. '"1"')
+  #   "12.3".inspect_lit  # => "\"12.3\"" (i.e. '"12.3"')
   def inspect_lit
     %("#{to_s}")
   end

data/lib/object_identifier/core_ext/symbol.rb

@@ -5,8 +5,8 @@ class Symbol
   # @return [String] a symbol literal representation of this object
   #
   # @example
-  #   :test.inspect_lit     # => ":\"test\"" (or ':"test"')
-  #   :"ta-da!".inspect_lit # => ":\"ta-da!\"" (or ':"ta-da!"')
+  #   :test.inspect_lit      # => ":\"test\"" (or ':"test"')
+  #   :"ta-da!".inspect_lit  # => ":\"ta-da!\"" (or ':"ta-da!"')
   def inspect_lit
     %(:"#{to_s}")
   end