protip 0.11.2 → 0.12.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 8ab7e84f6fd394d2b5cb52c67d1a5db5f245c36a
-  data.tar.gz: 4726d4e87f0453b0c2bd0bc55c2ac52ff23c58e3
+  metadata.gz: c275589cac97c73b2b4405fca77fe0c0c93a94af
+  data.tar.gz: 659c9ec2117a91a5d6e1e0fdff7c0b5ef91e9586
 SHA512:
-  metadata.gz: 4721c4d9f10135735502dccfb105532d4b6b31a74dcda08b1298bb0cc9bec791897c90002997c826cf399fb3953018bfdab5f5e62710834ccf99a21d5a5c458f
-  data.tar.gz: cde835698f8a9feb4eb3743b7c3bfdd5ab2bb0e42d0963cb0ebd1849aa96640d6f2169db6302901ca1a4e4e33c5385ce16ae2e86efb674672dbbb5ff1114aa28
+  metadata.gz: 48c71ba8914797e87a10363fda5c73bc1a02cc5f7a9889f86658251314489808ce733982c3104639f821b24a068708f6fb3df446c855e66e886e9fbd59a5ccb8
+  data.tar.gz: b567785146d15ef596bf19dffebc73f340120112821d7aca826c8f0431162e86a99bdf8429837ac6c772e9a29b0fc21fd9aa4c7d6ab866a24a9df56b3ba05f6a

data/lib/protip/resource.rb

@@ -165,6 +165,9 @@ module Protip
         @message.descriptor.each do |field|
           def_delegator :@wrapper, :"#{field.name}"
           def_delegator :@wrapper, :"#{field.name}="
+          if ::Protip::Wrapper.matchable?(field)
+            def_delegator :@wrapper, :"#{field.name}?"
+          end
         end
 
         # Validate arguments

data/lib/protip/wrapper.rb

@@ -17,10 +17,10 @@ module Protip
       if super
         true
       else
-        if name =~ /=$/
-          message.class.descriptor.any?{|field| :"#{field.name}=" == name.to_sym}
-        else
-          message.class.descriptor.any?{|field| field.name.to_sym == name.to_sym}
+        message.class.descriptor.any? do |field|
+          # getter, setter, and in the scalar enum case, query method
+          regex = /^#{field.name}[=#{self.class.matchable?(field) ? '\\?' : ''}]?$/
+          name.to_s =~ regex
         end
       end
     end
@@ -29,6 +29,9 @@ module Protip
       if (name =~ /=$/ && field = message.class.descriptor.detect{|field| :"#{field.name}=" == name})
         raise ArgumentError unless args.length == 1
         set field, args[0]
+      elsif (name =~ /\?$/ && field = message.class.descriptor.detect{|field| self.class.matchable?(field) && :"#{field.name}?" == name})
+        raise ArgumentError unless args.length == 1
+        matches? field, args[0]
       elsif (field = message.class.descriptor.detect{|field| field.name.to_sym == name})
         raise ArgumentError unless args.length == 0
         get field
@@ -135,6 +138,14 @@ module Protip
         converter == wrapper.converter
     end
 
+    class << self
+      # Semi-private check for whether a field should have an associated query method (e.g. +field_name?+).
+      # @return [Boolean] Whether the field should have an associated query method on wrappers.
+      def matchable?(field)
+        field.type == :enum && field.label != :repeated
+      end
+    end
+
     private
 
     def get(field)
@@ -184,5 +195,18 @@ module Protip
         value
       end
     end
+
+    def matches?(field, value)
+      enum = field.subtype
+      if value.is_a?(Fixnum)
+        sym = enum.lookup_value(value)
+      else
+        sym = value.to_sym
+        sym = nil if (nil == enum.lookup_name(sym))
+      end
+      raise RangeError.new("#{field} has no value #{value}") if nil == sym
+      get(field) == sym
+
+    end
   end
 end

data/test/test_helper.rb

@@ -1,3 +1,5 @@
 require 'minitest/autorun'
 require 'mocha/mini_test'
 require 'webmock/minitest'
+
+require 'minitest/pride'

data/test/unit/protip/resource_test.rb

@@ -9,6 +9,10 @@ module Protip::ResourceTest # Namespace for internal constants
     let :pool do
       pool = Google::Protobuf::DescriptorPool.new
       pool.build do
+        add_enum 'number' do
+          value :ZERO, 0
+          value :ONE, 1
+        end
         add_message 'nested_message' do
           optional :number, :int64, 1
         end
@@ -17,6 +21,8 @@ module Protip::ResourceTest # Namespace for internal constants
           optional :string, :string, 2
           optional :string2, :string, 3
           optional :nested_message, :message, 4, 'nested_message'
+          optional :number, :enum, 5, 'number'
+          repeated :numbers, :enum, 6, 'number'
         end
 
         add_message 'resource_query' do
@@ -124,6 +130,29 @@ module Protip::ResourceTest # Namespace for internal constants
         assert_equal nested_message_class.new(number: 100), resource.message.nested_message, 'object was not converted'
         assert_equal 'intern', resource.nested_message, 'message was not converted'
       end
+
+      describe '(query methods)' do
+        let(:resource) { resource_class.new }
+        it 'defines query methods for the scalar enums on its message' do
+          assert_respond_to resource, :number?
+          assert resource.number?(:ZERO)
+          refute resource.number?(:ONE)
+        end
+
+        it 'does not define query methods for repeated enums' do
+          refute_respond_to resource, :numbers?
+          assert_raises NoMethodError do
+            resource.numbers?(:ZERO)
+          end
+        end
+
+        it 'does not define query methods for non-enum fields' do
+          refute_respond_to resource, :inner?
+          assert_raises NoMethodError do
+            resource.inner?(:ZERO)
+          end
+        end
+      end
     end
 
     # index/find/member/collection actions should all convert more complex Ruby objects to submessages in their

data/test/unit/protip/wrapper_test.rb

@@ -14,6 +14,11 @@ module Protip::WrapperTest # namespace for internal constants
     let :pool do
       pool = Google::Protobuf::DescriptorPool.new
       pool.build do
+        add_enum 'number' do
+          value :ZERO, 0
+          value :ONE, 1
+          value :TWO, 2
+        end
         add_message 'inner_message' do
           optional :value, :int64, 1
           optional :note, :string, 2
@@ -27,6 +32,9 @@ module Protip::WrapperTest # namespace for internal constants
           repeated :strings, :string, 4
 
           optional :inner_blank, :message, 5, 'inner_message'
+
+          optional :number, :enum, 6, 'number'
+          repeated :numbers, :enum, 7, 'number'
         end
       end
       pool
@@ -57,12 +65,32 @@ module Protip::WrapperTest # namespace for internal constants
         assert_respond_to wrapper, :inner
         assert_respond_to wrapper, :inner_blank
       end
+      it 'adds queries for scalar enum fields' do
+        assert_respond_to wrapper, :number?
+      end
+      it 'does not add queries for repeated enum fields' do
+        refute_respond_to wrapper, :numbers?
+      end
+      it 'does not add queries for non-enum fields' do
+        refute_respond_to wrapper, :inner?
+      end
       it 'responds to standard defined methods' do
         assert_respond_to wrapper, :as_json
       end
-      it 'does not add other setters/getters' do
+      it 'does not add other setters/getters/queries' do
         refute_respond_to wrapper, :foo=
         refute_respond_to wrapper, :foo
+        refute_respond_to wrapper, :foo?
+      end
+      it 'does not add methods which partially match message fields' do
+        refute_respond_to wrapper, :xinner
+        refute_respond_to wrapper, :xinner=
+        refute_respond_to wrapper, :xnumber?
+        refute_respond_to wrapper, :innerx
+        refute_respond_to wrapper, :innerx=
+        refute_respond_to wrapper, :'inner=x'
+        refute_respond_to wrapper, :numberx?
+        refute_respond_to wrapper, :'number?x'
       end
     end
 
@@ -256,7 +284,7 @@ module Protip::WrapperTest # namespace for internal constants
         end
 
         it 'contains keys for all fields of the parent message' do
-          assert_equal %i(string strings inner inners inner_blank).sort, wrapper.to_h.keys.sort
+          assert_equal %i(string strings inner inners inner_blank number numbers).sort, wrapper.to_h.keys.sort
         end
         it 'assigns nil for missing nested messages' do
           hash = wrapper.to_h
@@ -344,6 +372,66 @@ module Protip::WrapperTest # namespace for internal constants
         wrapper.inner = inner_message_class.new(value: 50)
         assert_equal inner_message_class.new(value: 50), wrapper.message.inner
       end
+
+      it 'raises an error when setting an enum field to an undefined value' do
+        assert_raises RangeError do
+          wrapper.number = :NAN
+        end
+      end
+    end
+
+    describe '#matches?' do
+      it 'is not defined for non-enum fields' do
+        assert_raises NoMethodError do
+          wrapper.inner?(:test)
+        end
+      end
+
+      it 'is not defined for repeated enum fields' do
+        assert_raises NoMethodError do
+          wrapper.numbers?(:test)
+        end
+      end
+
+      describe 'when given a Fixnum' do
+        before do
+          wrapper.number = :ONE
+        end
+        it 'returns true when the number matches the value' do
+          assert wrapper.number?(1)
+        end
+        it 'returns false when the number does not match the value' do
+          refute wrapper.number?(0)
+        end
+        it 'raises an error when the number is not a valid value for the enum' do
+          assert_raises RangeError do
+            wrapper.number?(3)
+          end
+        end
+      end
+
+      describe 'when given a non-Fixnum' do
+        before do
+          wrapper.number = :TWO
+        end
+        it 'returns true when its symbolized argument matches the value' do
+          m = mock
+          m.expects(:to_sym).returns :TWO
+          assert wrapper.number?(m)
+        end
+        it 'returns false when its symbolized argument does not match the value' do
+          m = mock
+          m.expects(:to_sym).returns :ONE
+          refute wrapper.number?(m)
+        end
+        it 'raises an error when its symbolized argument is not a valid value for the enum' do
+          m = mock
+          m.expects(:to_sym).returns :NAN
+          assert_raises RangeError do
+            wrapper.number?(m)
+          end
+        end
+      end
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: protip
 version: !ruby/object:Gem::Version
-  version: 0.11.2
+  version: 0.12.0
 platform: ruby
 authors:
 - AngelList
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-08-17 00:00:00.000000000 Z
+date: 2015-08-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activemodel