object_identifier 0.3.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 594dc64f6fbb19ee55894da1b9c1e122d23cea3eec1caf78e13671e8e0472e61
-  data.tar.gz: 3842e0eba2e37555e020c44e679383422ad29f12f2945e3918cdd0e76c5998ff
+  metadata.gz: bbab525606ca826781627ff66be0e57229d14be19e2d19d562f5f73d7b2b7a5d
+  data.tar.gz: b266c154b7c283721b335d752b40705b3ba9000ad46d0ad8689a1f7654249c54
 SHA512:
-  metadata.gz: 195fbb54d47c00305d2b46d640db4629dc75deac68ec70c70679b90ec07cbf482dfe747dc1e6d2ae262bf3c85eb46d03aea312e377b528815635ba86db4ada2c
-  data.tar.gz: bd36eac52299c54da4d2a99ad02d9c8e0a04ba82260b59255183ba734b93460cbb49b3105d6863729be96035e79486e75c5763e3ba661e2d696cbd84d606d9e6
+  metadata.gz: b83e5d96392c489dd19a32d265602161069db563c7bda67a4aa88eb28eca6ea26ffdf3641b52a060482493717c1f652b190b6545547b6ae4cadfa1cee3360451
+  data.tar.gz: 26f3c65910cd39d01e51af199b57f5a8fee3d1ddbe79f67b69552b0abf9c5f9da9752e8947afa0f663aa53e84f0968940cae59d9735a9f5c3745329ad778839d

data/.rubocop.yml

@@ -3,7 +3,8 @@ AllCops:
   DisplayCopNames: true
   DisplayStyleGuide: true
   ExtraDetails: false
-  TargetRubyVersion: 2.5.3
+  TargetRubyVersion: 2.4.0
+  NewCops: enable
 
 Layout/DotPosition:
   EnforcedStyle: trailing
@@ -11,16 +12,16 @@ Layout/DotPosition:
 Layout/EndOfLine:
   EnforcedStyle: lf
 
-Layout/IndentFirstArgument:
+Layout/FirstArgumentIndentation:
   EnforcedStyle: consistent_relative_to_receiver
 
-Layout/IndentFirstArrayElement:
+Layout/FirstArrayElementIndentation:
   EnforcedStyle: consistent
 
-Layout/IndentFirstHashElement:
+Layout/FirstHashElementIndentation:
   EnforcedStyle: consistent
 
-Layout/IndentFirstParameter:
+Layout/FirstParameterIndentation:
   Enabled: false # Revisit if more settings become available.
 
 Layout/MultilineMethodCallBraceLayout:
@@ -59,7 +60,7 @@ Metrics/LineLength:
   Exclude:
     - "object_identifier.gemspec"
 
-Naming/UncommunicativeMethodParamName:
+Naming/MethodParameterName:
   AllowedNames:
     - a
     - b

data/.travis.yml

@@ -4,14 +4,12 @@ env:
 sudo: false
 language: ruby
 rvm:
-  - 2.3.7
-  - 2.4.4
-  - 2.5.3
-  - 2.6.2
-  - ruby-head
+  - 2.4.9
+  - 2.5.8
+  - 2.6.6
 notifications:
   email: false
-before_install: gem install bundler -v 2.0.1
+before_install: gem install bundler -v 2.1.4
 cache: bundler
 before_script:
   - curl -L https://codeclimate.com/downloads/test-reporter/test-reporter-latest-linux-amd64 > ./cc-test-reporter

data/CHANGELOG.md

@@ -1,8 +1,15 @@
+### 0.4.0 - 2020-09-01
+- [#4](https://github.com/pdobb/object_identifier/pull/4) Only show attribute names if identifying more than one attribute.
+- Update development dependencies.
+
+#### BREAKING
+- Drop support for Ruby 2.3.
+
 ### 0.3.0 - 2019-06-27
 - Fix identification of objects that implement `to_a`, such as Struct.
 
 ### 0.2.1 - 2019-02-24
-- Add ability to identify instance vars
+- Add ability to identify instance vars.
 
 ### 0.1.0 - 2018-04-14
 - Revamp gem.

data/Gemfile.lock

@@ -1,77 +1,61 @@
 PATH
   remote: .
   specs:
-    object_identifier (0.3.0)
+    object_identifier (0.4.0)
 
 GEM
   remote: https://rubygems.org/
   specs:
     ansi (1.5.0)
-    ast (2.4.0)
-    axiom-types (0.1.1)
-      descendants_tracker (~> 0.0.4)
-      ice_nine (~> 0.11.0)
-      thread_safe (~> 0.3, >= 0.3.1)
-    builder (3.2.3)
-    byebug (11.0.1)
-    codeclimate-engine-rb (0.4.1)
-      virtus (~> 1.0)
-    coderay (1.1.2)
-    coercible (1.0.0)
-      descendants_tracker (~> 0.0.1)
-    descendants_tracker (0.0.4)
-      thread_safe (~> 0.3, >= 0.3.1)
+    ast (2.4.1)
+    builder (3.2.4)
+    byebug (11.1.3)
+    coderay (1.1.3)
     docile (1.3.2)
-    equalizer (0.0.11)
-    ice_nine (0.11.2)
-    jaro_winkler (1.5.3)
-    json (2.2.0)
     kwalify (0.7.2)
-    method_source (0.9.2)
-    minitest (5.11.3)
-    minitest-reporters (1.3.6)
+    method_source (1.0.0)
+    minitest (5.14.2)
+    minitest-reporters (1.4.2)
       ansi
       builder
       minitest (>= 5.0)
       ruby-progressbar
-    parallel (1.17.0)
-    parser (2.6.3.0)
-      ast (~> 2.4.0)
-    pry (0.12.2)
-      coderay (~> 1.1.0)
-      method_source (~> 0.9.0)
-    pry-byebug (3.7.0)
+    parallel (1.19.2)
+    parser (2.7.1.4)
+      ast (~> 2.4.1)
+    pry (0.13.1)
+      coderay (~> 1.1)
+      method_source (~> 1.0)
+    pry-byebug (3.9.0)
       byebug (~> 11.0)
-      pry (~> 0.10)
+      pry (~> 0.13.0)
     psych (3.1.0)
     rainbow (3.0.0)
-    rake (12.3.2)
-    reek (5.4.0)
-      codeclimate-engine-rb (~> 0.4.0)
+    rake (13.0.1)
+    reek (6.0.1)
       kwalify (~> 0.7.0)
-      parser (>= 2.5.0.0, < 2.7, != 2.5.1.1)
+      parser (>= 2.5.0.0, < 2.8, != 2.5.1.1)
       psych (~> 3.1.0)
       rainbow (>= 2.0, < 4.0)
-    rubocop (0.72.0)
-      jaro_winkler (~> 1.5.1)
+    regexp_parser (1.7.1)
+    rexml (3.2.4)
+    rubocop (0.90.0)
       parallel (~> 1.10)
-      parser (>= 2.6)
+      parser (>= 2.7.1.1)
       rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.7)
+      rexml
+      rubocop-ast (>= 0.3.0, < 1.0)
       ruby-progressbar (~> 1.7)
-      unicode-display_width (>= 1.4.0, < 1.7)
+      unicode-display_width (>= 1.4.0, < 2.0)
+    rubocop-ast (0.3.0)
+      parser (>= 2.7.1.4)
     ruby-progressbar (1.10.1)
-    simplecov (0.16.1)
+    simplecov (0.19.0)
       docile (~> 1.1)
-      json (>= 1.8, < 3)
-      simplecov-html (~> 0.10.0)
-    simplecov-html (0.10.2)
-    thread_safe (0.3.6)
-    unicode-display_width (1.6.0)
-    virtus (1.0.5)
-      axiom-types (~> 0.1)
-      coercible (~> 1.0)
-      descendants_tracker (~> 0.0, >= 0.0.3)
-      equalizer (~> 0.0, >= 0.0.9)
+      simplecov-html (~> 0.11)
+    simplecov-html (0.12.2)
+    unicode-display_width (1.7.0)
 
 PLATFORMS
   ruby
@@ -90,4 +74,4 @@ DEPENDENCIES
   simplecov
 
 BUNDLED WITH
-   2.0.1
+   2.1.4

data/README.md

@@ -40,11 +40,9 @@ Or install it yourself as:
 ## Compatibility
 
 Tested MRI Ruby Versions:
-* 2.2.10
-* 2.3.7
-* 2.4.4
-* 2.5.1
-* edge
+* 2.4.9
+* 2.5.8
+* 2.6.6
 
 
 ## Usage
@@ -54,33 +52,38 @@ Tested MRI Ruby Versions:
 `identify` outputs the `id` of the receiving object by default, if it exists and no other attributes/methods are specified.
 
 ```ruby
-my_movie.identify           # => Movie[id:1]
-my_movie.identify(:rating)  # => Movie[rating:"7/10"]
+my_movie.identify                # => Movie[1]
 ```
 
-Private methods can be identified just the same as public methods.
+`identify` doesn't output labels if only identifying a single attribute/method. It includes labels when two or more attributes/methods are being identified.
 
 ```ruby
-my_movie.identify(:my_private_method)  # => Movie[my_private_method:"Shh"]
+my_movie.identify(:id)           # => Movie[1]
+my_movie.identify(:rating)       # => Movie["7/10"]
+my_movie.identify(:id, :rating)  # => Movie[id:1, rating:"7/10"]
 ```
 
+Private methods can be identified just the same as public methods.
+
+```ruby
+my_movie.identify(:my_private_method)  # => Movie["Shh"]
+```
 
 ### Unknown Attributes/Methods
 
 If the object doesn't respond to a specified attribute/method it is simply ignored:
 
 ```ruby
-my_movie.identify(:gobble_gobble, :rating)  # => Movie[rating:"7/10"]
+my_movie.identify(:id, :rating, :other)  # => Movie[id:1, rating:"7/10"]
 ```
 
 ### Overriding Class Names
 
 ```ruby
-my_delayed_job.identify(klass: "Delayed::Job")  # => Delayed::Job[id:1]
-my_movie.identify(klass: nil)                   # => [id:1]
+my_delayed_job.identify(klass: "Delayed::Job")  # => Delayed::Job[1]
+my_movie.identify(klass: nil)                   # => [1]
 ```
 
-
 ### Identifying Nil
 
 ```ruby
@@ -88,7 +91,6 @@ nil.identify(:id, :name)                 # => [no objects]
 nil.identify(:id, :name, klass: "Nope")  # => [no objects]
 ```
 
-
 ### Collections
 
 Collections of objects are each identified in turn.
@@ -101,7 +103,7 @@ Collections of objects are each identified in turn.
 The number of results that will be identified from a collection can be truncated by specifying the `limit` option.
 
 ```ruby
-[my_movie, my_contact].identify(:id, :name, limit: 1)
+[my_movie, my_user].identify(:id, :name, limit: 1)
 # => Movie[id:1, name:"Pi"], ... (1 more)
 ```
 

data/lib/object_identifier/identifier.rb

@@ -90,9 +90,17 @@ module ObjectIdentifier
     def format_attributes(attributes_hash)
       return if attributes_hash.empty?
 
-      attributes_hash.map { |(key, value)|
-        "#{key}:#{value.inspect_lit}"
-      }.join(", ")
+      attributes_hash.
+        map(&format_attributes_map_block(attributes_hash)).
+        join(", ")
+    end
+
+    def format_attributes_map_block(attributes_hash)
+      if attributes_hash.one?
+        ->(_key, value) { value.inspect_lit }
+      else
+        ->(key, value) { "#{key}:#{value.inspect_lit}" }
+      end
     end
 
     # @return [Hash]

data/lib/object_identifier/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module ObjectIdentifier
-  VERSION = "0.3.0"
+  VERSION = "0.4.0"
 end

data/object_identifier.gemspec

@@ -9,6 +9,7 @@ Gem::Specification.new do |spec|
   spec.version       = ObjectIdentifier::VERSION
   spec.authors       = ["Paul Dobbins", "Evan Sherwood"]
   spec.email         = ["paul.dobbins@icloud.com"]
+  spec.required_ruby_version = ">= 2.4.0"
 
   spec.summary       = "ObjectIdentifier identifies an object by its class name and attributes."
   spec.description   = "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 logging, sending descriptive notification messages, etc."

metadata

@@ -1,15 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: object_identifier
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.4.0
 platform: ruby
 authors:
 - Paul Dobbins
 - Evan Sherwood
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2019-06-27 00:00:00.000000000 Z
+date: 2020-09-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -184,7 +184,7 @@ homepage: https://github.com/pdobb/object_identifier
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -192,15 +192,15 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 2.4.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.4
-signing_key: 
+rubygems_version: 3.1.4
+signing_key:
 specification_version: 4
 summary: ObjectIdentifier identifies an object by its class name and attributes.
 test_files: []