item 0.0.3 → 0.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 6636b67af901b2fb8d53f9b5e07ee473847c986f
-  data.tar.gz: 1fb525437828700232569ffd3669dc6598c91b4e
+  metadata.gz: f659a6a1b8a33fbe1c3b78fb764927699ce50dd1
+  data.tar.gz: d1f938c0a4a94e67044e6ffb0a48846f91c2b992
 SHA512:
-  metadata.gz: 51c6516bc919592aa92f3788452d434f845da401967c1bc63ca13c330cdea911ea60a18b1d79f233350419d2e080fb282e43f933ce5e6993b4e4cca3be5c3774
-  data.tar.gz: 02de298d3b9174019921fe610f448221cad268333c81f09879cd0c635872f6423deea25bd9b270957adb1f4167efc14afdbb2846111e9d458440fde47ec32eb5
+  metadata.gz: f9e50b82f80724ae893663fb0616522c28ed326d8cd37f774f313c43c7a2de8fda7305ff5b07b3eb669b0acb3404da9f166af45a9e439b8cde999c0bda4ca4a0
+  data.tar.gz: 0105194be5e2f59c2913d4f83f14157545ab22331413a69e717d4bd10a715760f7cd349613353d751e69e803dab205637ab493fb482245be46ae94dcb1eb888e

data/CHANGELOG.md

@@ -1,5 +1,10 @@
 # Changelog
 
+### 0.0.4
+
+* Support passing options to `scope` and `prop`, like `:tag` and `:class`
+* Support adding link props via hash
+
 ### 0.0.3
 
 * Don't use `capture` in view helpers

data/README.md

@@ -11,7 +11,6 @@ This can help attract visitors to your site:
 
 **The problem with Microdata:** Normally, implementing these Microdata can make your views quite messy because you have a lot of "extra" content other than your regular view content.
 
-
 **Item:** Item solves the problem by adding two helpers, `scope` and `prop`, that you can use in your views.
 This makes it easy to add microdata scopes and properties without cluttering the view. Item is made to maximize ease of writing (and joy, of course – it *is* Ruby), while minimizing the code needed to add microdata to your views.
 
@@ -36,13 +35,11 @@ $ bundle
 To define an `itemscope`:
 
 ```erb
-<% scope :product do %>
+<%= scope :product do %>
   ...
 <% end %>
 ```
 
-You don't need `<%=` before scopes, because we see it as just a definition, and not something that is inserted into the view, even though this is done behind the scenes.
-
 The above will generate the following HTML:
 
 ```html
@@ -51,6 +48,14 @@ The above will generate the following HTML:
 </div>
 ```
 
+If you need the scope to be another tag than `<div>` or e.g. need to set a class, you can do it like this:
+
+```erb
+<%= scope :product, tag: :span, class: "a-class" do %>
+  ...
+<% end %>
+```
+
 ### Properties
 
 To define an `itemprop` span:
@@ -65,18 +70,22 @@ This will generate the following HTML:
 <span itemprop="name">My Product Name</span>
 ```
 
+If you need the property to be another tag than span `<span>` or e.g. need to set a class, you can do it like this:
+
+```erb
+<%= prop :name, "My Product Name", tag: :div, class: "a-class" %>
+```
+
 #### Scoped properties
 
 To define a property that is also a scope:
 
 ```erb
-<% prop :review do %>
+<%= prop :review do %>
   <%= prop :name, "Pete Anderson" %>
 <% end %>
 ```
 
-You don't need `<%=` before scoped properties, because we see this as a definition of a scope. The HTML is inserted automatically.
-
 The above will generate the following HTML:
 
 ```html
@@ -90,7 +99,7 @@ The above will generate the following HTML:
 Sometimes you need to define a type on scoped properties when this cannot be inferred from the property name. To set a type:
 
 ```erb
-<% prop :review_rating, type: :review do %>
+<%= prop :review_rating, type: :rating do %>
   ...
 <% end %>
 ```
@@ -141,12 +150,12 @@ The following is based on the [Product example](http://schema.org/Product) on [S
   <%= itemprop :name, "Kenmore White 17\" Microwave" %>
   <%= image_tag "kenmore-microwave-17in.jpg" %>
 
-  <% prop :aggregate_rating do %>
+  <%= prop :aggregate_rating do %>
     Rated <%= prop :rating_value, 3.5 %>/5
     based on <%= prop :review_count, 11 %> custom reviews
   <% end %>
 
-  <% prop :offers, type: :offer do %>
+  <%= prop :offers, type: :offer do %>
     <%= prop :price, "$55.00" %>
     <%= prop :availability, :in_stock %>
     In Stock
@@ -158,12 +167,12 @@ The following is based on the [Product example](http://schema.org/Product) on [S
     Add-A-Minute and Child Lock." %>
 
   Customer reviews:
-  <% prop :review do %>
+  <%= prop :review do %>
     <%= prop :name, "Not a happy camper" %> -
     by <%= prop :author, "Ellie" %>,
     <%= prop date_published: "2011-04-01" %>
     April 1, 2011
-    <% prop :review_rating, type: :rating do %>
+    <%= prop :review_rating, type: :rating do %>
       <%= prop worst_rating: 1 %>
       <%= prop :rating_value, 1 %> /
       <%= prop :best_rating, 5 %> stars

data/lib/item/version.rb

@@ -1,3 +1,3 @@
 module Item
-  VERSION = "0.0.3"
+  VERSION = "0.0.4"
 end

data/lib/item/view_helpers.rb

@@ -1,27 +1,47 @@
 module Item
   module ViewHelpers
     def scope(key, options = {}, &block)
-      content_tag(:div, itemscope: "itemscope", itemtype: Util.itemtype(key), &block)
+      tag = options.delete(:tag) || :div
+      tag_options = { itemscope: true, itemtype: Util.itemtype(key) }.merge(options)
+      content_tag(tag, tag_options, &block)
     end
 
     def prop(key, value = nil, options = {}, &block)
       if key.is_a?(Hash)
-        key.map { |key, value| tag(:meta, itemprop: Util.itemprop(key), content: value) }.join("\n").html_safe
+        key.map do |key, value|
+          if value.is_a?(Symbol)
+            link_prop(key, value)
+          else
+            meta_prop(key, value)
+          end
+        end.join("\n").html_safe
       elsif value.is_a?(Symbol)
-        tag(:link, itemprop: Util.itemprop(key), href: Util.href(value))
+        link_prop(key, value)
       else
         options, value = value, nil if value.is_a?(Hash)
         itemprop = Util.itemprop(key)
 
         if block
-          itemtype = Util.itemtype(options[:type].presence || key)
-          content_tag(:div, itemprop: itemprop, itemscope: "itemscope", itemtype: itemtype, &block)
+          tag = options.delete(:tag) || :div
+          itemtype = Util.itemtype(options.delete(:type) || key)
+          tag_options = { itemprop: itemprop, itemscope: true, itemtype: itemtype }.merge(options)
+          content_tag(tag, tag_options, &block)
         else
-          content_tag(:span, value, itemprop: itemprop)
+          tag = options.delete(:tag) || :span
+          tag_options = { itemprop: itemprop }.merge(options)
+          content_tag(tag, value, tag_options)
         end
       end
     end
 
+    def link_prop(key, value)
+      tag(:link, itemprop: Util.itemprop(key), href: Util.href(value))
+    end
+
+    def meta_prop(key, value)
+      tag(:meta, itemprop: Util.itemprop(key), content: value)
+    end
+
     module Util
       class << self
         def itemtype(name)

data/test/view_helpers_test.rb

@@ -12,6 +12,15 @@ class ViewHelpersTest < ActionView::TestCase
                  content
   end
 
+  test "scope options" do
+    content = scope :aggregate_rating, tag: :something, class: "some-class" do
+      "content"
+    end
+
+    assert_equal %{<something class="some-class" itemscope="itemscope" itemtype="http://schema.org/AggregateRating">content</something>},
+                 content
+  end
+
   test "prop" do
     content = prop(:aggregate_rating, "content")
 
@@ -19,6 +28,13 @@ class ViewHelpersTest < ActionView::TestCase
                  content
   end
 
+  test "prop options" do
+    content = prop(:aggregate_rating, "content", tag: :something, class: "some-class")
+
+    assert_equal %{<something class="some-class" itemprop="aggregateRating">content</something>},
+                 content
+  end
+
   test "hidden prop" do
     content = prop(aggregate_rating: "Rating content", title: "Title content")
 
@@ -42,6 +58,15 @@ class ViewHelpersTest < ActionView::TestCase
                  content
   end
 
+  test "prop block with options" do
+    content = prop :aggregate_rating, tag: :something, class: "some-class" do
+      "content"
+    end
+
+    assert_equal %{<something class="some-class" itemprop="aggregateRating" itemscope="itemscope" itemtype="http://schema.org/AggregateRating">content</something>},
+                 content
+  end
+
   test "prop block with type" do
     content = prop :aggregate_rating, type: :other_type do
       "content"

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: item
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.0.4
 platform: ruby
 authors:
 - Lasse Bunk