React.is_valid_element -> React.is_valid_element?

Author: zetachang

CHANGELOG.md

@@ -26,6 +26,7 @@ Whitespace conventions:
 
 ### Deprecated
 
+- `React.is_valid_element` is deprecated in favor of `React.is_valid_element?`.
 - `expect(component).to render('<div />')` is now deprecated in favor of `expect(component).to render_static_html('<div />')`, which is much clearer.
 
 ### Fixed

lib/react/test/utils.rb

@@ -4,12 +4,12 @@ class Utils
       `var ReactTestUtils = React.addons.TestUtils`
 
       def self.render_into_document(element, options = {})
-        raise "You should pass a valid React::Element" unless React.is_valid_element(element)
+        raise "You should pass a valid React::Element" unless React.is_valid_element?(element)
         native_instance = `ReactTestUtils.renderIntoDocument(#{element.to_n})`
 
         if `#{native_instance}._getOpalInstance !== undefined`
           `#{native_instance}._getOpalInstance()`
-        elsif `ReactTestUtils.isDOMComponent(#{native_instance}) && React.findDOMNode !== undefined` 
+        elsif `ReactTestUtils.isDOMComponent(#{native_instance}) && React.findDOMNode !== undefined`
           `React.findDOMNode(#{native_instance})`
         else
           native_instance

lib/react/top_level.rb

@@ -69,6 +69,11 @@ def self.render(element, container)
   end
 
   def self.is_valid_element(element)
+    %x{ console.error("Warning: `is_valid_element` is deprecated in favor of `is_valid_element?`."); }
+    element.kind_of?(React::Element) && `React.isValidElement(#{element.to_n})`
+  end
+
+  def self.is_valid_element?(element)
     element.kind_of?(React::Element) && `React.isValidElement(#{element.to_n})`
   end
 

spec/react/react_spec.rb

@@ -6,36 +6,36 @@
     React::API.clear_component_class_cache
   end
 
-  describe "is_valid_element" do
+  describe "is_valid_element?" do
     it "should return true if passed a valid element" do
       element = React::Element.new(`React.createElement('div')`)
-      expect(React.is_valid_element(element)).to eq(true)
+      expect(React.is_valid_element?(element)).to eq(true)
     end
 
     it "should return false is passed a non React element" do
       element = React::Element.new(`{}`)
-      expect(React.is_valid_element(element)).to eq(false)
+      expect(React.is_valid_element?(element)).to eq(false)
     end
   end
 
   describe "create_element" do
     it "should create a valid element with only tag" do
       element = React.create_element('div')
-      expect(React.is_valid_element(element)).to eq(true)
+      expect(React.is_valid_element?(element)).to eq(true)
     end
 
     context "with block" do
       it "should create a valid element with text as only child when block yield String" do
         element = React.create_element('div') { "lorem ipsum" }
-        expect(React.is_valid_element(element)).to eq(true)
+        expect(React.is_valid_element?(element)).to eq(true)
         expect(element.props.children).to eq("lorem ipsum")
       end
 
       it "should create a valid element with children as array when block yield Array of element" do
         element = React.create_element('div') do
           [React.create_element('span'), React.create_element('span'), React.create_element('span')]
         end
-        expect(React.is_valid_element(element)).to eq(true)
+        expect(React.is_valid_element?(element)).to eq(true)
         expect(element.props.children.length).to eq(3)
       end
 
@@ -75,7 +75,7 @@ def render
 
       it "should create a valid element provided class defined `render`" do
         element = React.create_element(Foo)
-        expect(React.is_valid_element(element)).to eq(true)
+        expect(React.is_valid_element?(element)).to eq(true)
       end
 
       it "should allow creating with properties" do