watir_pump 0.4.7 → 0.4.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c9ac45f1057344a09c7d15e228a5342a9706ce72bdc2ccfc29803fef63ab050d
-  data.tar.gz: 04a6ec0412739ea76326266a65d2fae07a3490beb2303ef904bac47b74df7c4b
+  metadata.gz: 46afc438adf0692f8cf253804f031984e6d4d068067168a81c964a3b8291387e
+  data.tar.gz: f965db8f63df648b50c7a731d7a4c3300187f93fe6f84f68625d4801421d2240
 SHA512:
-  metadata.gz: b0a53a55fe324275357fdf8ea9db127404b5c73f78fe57da026a76b9b7dd7c01a7f9e34a012da7d18339f0e3aff606df9a1966e8cbee6d01578b1c2432b82677
-  data.tar.gz: 5fef97f83fa2ca0a4219b8dff4839bcdf633821b63d00f51937a1097fd0d7de4c776694bb55c141c2707409c5c3ededc0d67b7b7f68d705c507e3d28ef103459
+  metadata.gz: 3e17dc240658a4ac2da38fdbcacbfaba31a5401703d65a14d658c292c28ee09df4765955206c47c234fb3c5743c1415e5e90c7bb80412c2e242cd33bbe15e010
+  data.tar.gz: 6ba704ad7c61a2316e128fb3be63c96c49f0531760a34b201c96c796749cf973e6fe8c70531c59f3c66b69d7c14580a8aaf9190d67f852f23a592252deed0a52

data/README.md

@@ -917,6 +917,33 @@ There's a few methods that components forward directly to its root:
 
 Thanks to this one can write just `comp.present?` instead of `comp.root.present?`.
 
+### Customized `inspect` method
+
+This features is especially useful when using WatirPump with testing frameworks like `rspec`.
+
+Consider the following example:
+
+```ruby
+class MyComponent < WatirPump::Component
+  span_reader :name, id: 'name'
+  span_reader :surname, id: 'surname'
+  span_reader :age, id: 'age'
+  inspect_properties [:name, :surname, :age]
+end
+
+class HomePage < WatirPump::Page
+  component :details, MyComponent
+end
+
+MyPage.open do
+  expect(details).to have_attributes(name: 'John', surname: 'Smith')
+end
+```
+
+In case of expectation (here: `have_attributes`) not matched `rspec` will display the `expected` and `got` values.
+Without the usage of `inspect_properties` the default implementation of `inspect` would be used, and it's not
+very useful for test debugging since it's too verbose. Use `inspect_properties` to have your `rspec` logs easy to work with.
+
 ## Region aka anonymous component
 
 If certain HTML section appears only on one page (thus there's no point in creating another `Component` class)

data/lib/watir_pump/component.rb

@@ -329,6 +329,24 @@ module WatirPump
           end
         end
       end
+
+      # Define the customized `inspect` method
+      # that will return the desired properties
+      # Useful especially when working with testing frameworks that
+      # inspect the object under test in case of expectations not being met
+      #
+      # @param [Symbol] properties (methods) to be included in the result
+      #
+      # @return Hash
+      def inspect_properties(properties)
+        define_method :inspect do
+          ret = {}
+          properties.each do |p|
+            ret[p] = public_send(p)
+          end
+          ret
+        end
+      end
     end # << self
 
     # Invoked implicity by WatirPump framework.
@@ -412,6 +430,15 @@ module WatirPump
       end
     end
 
+    # Customized Ruby's object inspection method
+    #
+    # @return String
+    def inspect
+      # rubocop:disable Metrics/LineLength
+      "<#{self.class.name} parent: #{parent.class.name} methods: #{public_methods(false).join(', ')}>"
+      # rubocop:enable Metrics/LineLength
+    end
+
     private
 
     def form_field_writers

data/lib/watir_pump/component_collection.rb

@@ -10,7 +10,7 @@ module WatirPump
     include Constants
 
     delegate Enumerable.instance_methods(false) => :@arr
-    delegate %i[[] empty? each] => :@arr
+    delegate %i[[] empty? each inspect last] => :@arr
 
     def initialize(arr)
       @arr = arr

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: watir_pump
 version: !ruby/object:Gem::Version
-  version: 0.4.7
+  version: 0.4.8
 platform: ruby
 authors:
 - Bartek Wilczek
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-11-26 00:00:00.000000000 Z
+date: 2019-01-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport