Merge pull request #278 from korczis/rest-merge

Override #inspect

Author: fluke777

lib/gooddata.rb

@@ -1,5 +1,8 @@
 # encoding: UTF-8
 
+require 'pmap'
+$pmap_default_thread_count = 20 # rubocop:disable GlobalVars
+
 # GoodData Module
 module GoodData
 end

lib/gooddata/mixins/inspector.rb

@@ -0,0 +1,49 @@
+# encoding: UTF-8
+
+# See https://gist.github.com/ubermajestix/3644301
+
+module GoodData
+  module Mixin
+    # When an RSpec test like this fails,
+    #
+    #   @my_array.should == [@some_model, @some_model2]
+    #
+    # RSpec will call inspect on each of the objects to "help" you figure out
+    # what went wrong. Well, inspect will usually dump a TON OF SHIT and make trying
+    # to figure out why `@my_array` is not made up of `@some_model` and `@some_model2`.
+    #
+    # This little module and technique helps get around that. It will redefine `inspect`
+    # if you include it in your model object.
+    #
+    # You can define a whitelist of methods that inspect will dump.
+    # It will always provide `object_id` at a minimum.
+    #
+    # To use it, drop it in spec/support/inspector.rb and class_eval the models to
+    # override `inspect`.
+    module Inspector
+      def inspect
+        string = "#<#{self.class.name}:#{object_id} "
+        fields = self.class.inspector_fields.map { |field| "#{field}: #{send(field)}" }
+        string << fields.join(', ') << '>'
+      end
+
+      def self.inspected
+        @inspected ||= []
+      end
+
+      def self.included(source)
+        # $stdout.puts "Overriding inspect on #{source}"
+        inspected << source
+        source.class_eval do
+          def self.inspector(*fields)
+            @inspector_fields = *fields
+          end
+
+          def self.inspector_fields
+            @inspector_fields ||= []
+          end
+        end
+      end
+    end
+  end
+end

lib/gooddata/models/process.rb

@@ -208,6 +208,7 @@ def links
     def link
       links['self']
     end
+
     alias_method :uri, :link
 
     def obj_id

lib/gooddata/models/project.rb

@@ -3,13 +3,16 @@
 require 'csv'
 require 'zip'
 require 'fileutils'
+require 'multi_json'
 require 'pmap'
 require 'zip'
 
 require_relative '../exceptions/no_project_error'
 
-require_relative '../mixins/rest_resource'
 require_relative '../rest/resource'
+require_relative '../mixins/author'
+require_relative '../mixins/contributor'
+require_relative '../mixins/rest_resource'
 
 require_relative 'process'
 require_relative 'project_role'

lib/gooddata/rest/client.rb

@@ -7,6 +7,8 @@
 require_relative 'connections/connections'
 require_relative 'object_factory'
 
+require_relative '../mixins/inspector'
+
 module GoodData
   module Rest
     # User's interface to GoodData Platform.
@@ -34,6 +36,9 @@ class Client
       # TODO: Decide if we need provide direct access to factory
       attr_reader :factory
 
+      include Mixin::Inspector
+      inspector :object_id
+
       #################################
       # Class methods
       #################################