item 0.0.5 → 0.0.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 896e577ff1509ed63b85717b0629b16d202253b7
-  data.tar.gz: 805b031c703dfedf62692c3442c06ec7e6df594e
+  metadata.gz: 9f3aa76ac0d54caa805e09ca62f66a0900ea0e3e
+  data.tar.gz: 518a7394a3de2cdee49a06f91fcb1d17a0edafad
 SHA512:
-  metadata.gz: ca45cbaf092ec7d9a830e604e06022c0393e28d19b613c73d2990f9fae28537c9ba4393ca8960de1da872fd59044f8fc04f03fbdf174bbeed8f0cf1c9f30c038
-  data.tar.gz: d57f6be3192403b90e1be271757e808682c0ce43696bb485f69adee389eee82915aff96a65513194d7a6d8943b2ebc68f18730942c05fded31769dae42d3eb90
+  metadata.gz: 5acabdac052a0d9cf352f55dfdd52c3de58ed4f81761160f0dd06cf57efd639ad77fc8161da4ab17951013559c8a20df99d2516405cf8515b38c75c54fdc2d69
+  data.tar.gz: cf65dca0846db6c9495fcda72632a7208f770c4bd7662ec35a620fd97bbb88ad5ac5696208a9b00b8cdf474e53d2ed291084807245f29ab4214a7bdc95831388

data/CHANGELOG.md

@@ -1,5 +1,9 @@
 # Changelog
 
+### 0.0.6
+
+* Add `:if` and `:unless` options to the `prop` helper do disable rendering of microdata
+
 ### 0.0.5
 
 * Set itemscope attribute explicitly for backwards Rails compatibility

data/README.md

@@ -112,6 +112,16 @@ This will generate the following HTML:
 </div>
 ```
 
+##### Disabling rendering on scoped properties
+
+Sometimes you need to disable rendering on entire `prop` blocks. You can do this by passing `:if` and `:unless` options.
+This will render the content, but without microdata for both the `prop` block itself and all `prop`s inside it:
+
+```erb
+<%= prop :review_rating, type: :rating, if: @product.rating? do %>
+  ...
+<% end %>
+```
 
 #### Meta properties
 
@@ -135,6 +145,12 @@ To define a link to an enumeration member, e.g. [ItemAvailability](http://schema
 <%= prop :availability, :in_stock %>
 ```
 
+You can also do this by passing symbols as hash values:
+
+```erb
+<%= prop availability: :in_stock %>
+```
+
 This will generate the following HTML:
 
 ```html
@@ -182,6 +198,27 @@ The following is based on the [Product example](http://schema.org/Product) on [S
 <% end %>
 ```
 
+## Tools for validating microdata
+
+There are various tools you can use for validating your microdata.
+I recommend using these (especially Google's) before releasing to production, so you are sure that the microdata you implemented works as expected.
+
+#### Google Structured Data Testing Tool
+
+[Google's Structured Data Testing Tool](http://www.google.com/webmasters/tools/richsnippets) is the tool I recommend using for making sure your microdata will validate.
+If your microdata validates here, it will validate on Google SERPs.
+
+You can enter a URL or copy/paste HTML to validate. This means that you can test your development code, too.
+
+#### Bing Markup Validator
+
+[Bing's Markup Validator](http://www.bing.com/webmaster/diagnostics/markup/validator) appears to be easier to read, but it is not as strict as Google's tool.
+
+#### Mida
+
+[Mida](https://github.com/LawrenceWoodman/mida) is a great tool for validating your code locally as you implement new microdata.
+It runs locally via the command line and takes a URL to validate, so you can validate code on your local development server.
+
 ## Contributing
 
 Changes and improvements are to Item are very welcome and greatly appreciated.

data/lib/item/version.rb

@@ -1,3 +1,3 @@
 module Item
-  VERSION = "0.0.5"
+  VERSION = "0.0.6"
 end

data/lib/item/view_helpers.rb

@@ -7,33 +7,47 @@ module Item
     end
 
     def prop(key, value = nil, options = {}, &block)
+      @_item_enabled = true unless defined?(@_item_enabled)
+
       if key.is_a?(Hash)
         key.map do |key, value|
           if value.is_a?(Symbol)
-            link_prop(key, value)
+            link_prop(key, value) if @_item_enabled
           else
-            meta_prop(key, value)
+            meta_prop(key, value) if @_item_enabled
           end
-        end.join("\n").html_safe
+        end.compact.join("\n").html_safe
       elsif value.is_a?(Symbol)
-        link_prop(key, value)
+        link_prop(key, value) if @_item_enabled
       else
         options, value = value, nil if value.is_a?(Hash)
         itemprop = Util.itemprop(key)
 
-        if block
+        @_item_enabled_old = @_item_enabled
+        @_item_enabled = @_item_enabled_old && options.fetch(:if, !options.fetch(:unless, false))
+        
+        options.delete(:if)
+        options.delete(:unless)
+
+        content = if block
           tag = options.delete(:tag) || :div
           itemtype = Util.itemtype(options.delete(:type) || key)
-          tag_options = { itemprop: itemprop, itemscope: "itemscope", itemtype: itemtype }.merge(options)
-          content_tag(tag, tag_options, &block)
+          options = { itemprop: itemprop, itemscope: "itemscope", itemtype: itemtype }.merge(options) if @_item_enabled
+          content_tag(tag, options, &block)
         else
           tag = options.delete(:tag) || :span
-          tag_options = { itemprop: itemprop }.merge(options)
-          content_tag(tag, value, tag_options)
+          options = { itemprop: itemprop }.merge(options) if @_item_enabled
+          content_tag(tag, value, options)
         end
+
+        @_item_enabled = @_item_enabled_old
+
+        content
       end
     end
 
+    private
+
     def link_prop(key, value)
       tag(:link, itemprop: Util.itemprop(key), href: Util.href(value))
     end

data/test/view_helpers_test.rb

@@ -78,10 +78,62 @@ class ViewHelpersTest < ActionView::TestCase
 
   test "combined" do
     content = scope :product do
-      concat prop(:title, "My Title")
+      prop(:title, "My Title")
     end
 
     assert_equal %{<div itemscope="itemscope" itemtype="http://schema.org/Product"><span itemprop="title">My Title</span></div>},
                  content
   end
+
+  test "prop with trueish if" do
+    content = scope :product do
+      prop :offers, type: :offer, tag: :custom1, class: "offers-container", if: "trueish" do
+        [prop(:price, 123.5, tag: :custom2, class: "price-container"),
+         prop(availability: :in_stock, price_currency: "DKK"),
+         prop(:other_key, :other_value)].join.html_safe
+      end
+    end
+
+    assert_equal %{<div itemscope="itemscope" itemtype="http://schema.org/Product"><custom1 class="offers-container" itemprop="offers" itemscope="itemscope" itemtype="http://schema.org/Offer"><custom2 class="price-container" itemprop="price">123.5</custom2><link href="http://schema.org/InStock" itemprop="availability" />\n<meta content="DKK" itemprop="priceCurrency" /><link href="http://schema.org/OtherValue" itemprop="otherKey" /></custom1></div>},
+                 content
+  end
+
+  test "prop with falsey if" do
+    content = scope :product do
+      prop :offers, type: :offer, tag: :custom1, class: "offers-container", if: nil do
+        [prop(:price, 123.5, tag: :custom2, class: "price-container"),
+         prop(availability: :in_stock, price_currency: "DKK"),
+         prop(:other_key, :other_value)].join.html_safe
+      end
+    end
+
+    assert_equal %{<div itemscope="itemscope" itemtype="http://schema.org/Product"><custom1 class="offers-container"><custom2 class="price-container">123.5</custom2></custom1></div>},
+                 content
+  end
+
+  test "prop with falsey unless" do
+    content = scope :product do
+      prop :offers, type: :offer, tag: :custom1, class: "offers-container", unless: nil do
+        [prop(:price, 123.5, tag: :custom2, class: "price-container"),
+         prop(availability: :in_stock, price_currency: "DKK"),
+         prop(:other_key, :other_value)].join.html_safe
+      end
+    end
+
+    assert_equal %{<div itemscope="itemscope" itemtype="http://schema.org/Product"><custom1 class="offers-container" itemprop="offers" itemscope="itemscope" itemtype="http://schema.org/Offer"><custom2 class="price-container" itemprop="price">123.5</custom2><link href="http://schema.org/InStock" itemprop="availability" />\n<meta content="DKK" itemprop="priceCurrency" /><link href="http://schema.org/OtherValue" itemprop="otherKey" /></custom1></div>},
+                 content
+  end
+
+  test "prop with trueish unless" do
+    content = scope :product do
+      prop :offers, type: :offer, tag: :custom1, class: "offers-container", unless: "trueish" do
+        [prop(:price, 123.5, tag: :custom2, class: "price-container"),
+         prop(availability: :in_stock, price_currency: "DKK"),
+         prop(:other_key, :other_value)].join.html_safe
+      end
+    end
+
+    assert_equal %{<div itemscope="itemscope" itemtype="http://schema.org/Product"><custom1 class="offers-container"><custom2 class="price-container">123.5</custom2></custom1></div>},
+                 content
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: item
 version: !ruby/object:Gem::Version
-  version: 0.0.5
+  version: 0.0.6
 platform: ruby
 authors:
 - Lasse Bunk
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-07-27 00:00:00.000000000 Z
+date: 2014-07-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails