RubyGems - item - Versions diffs - 0.0.1 - Mend

item 0.0.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (57) hide show

checksums.yaml +7 -0
data/.gitignore +22 -0
data/Gemfile +4 -0
data/LICENSE.txt +22 -0
data/README.html +218 -0
data/README.md +186 -0
data/Rakefile +11 -0
data/item.gemspec +25 -0
data/lib/item.rb +8 -0
data/lib/item/version.rb +3 -0
data/lib/item/view_helpers.rb +46 -0
data/test/.travis.yml +7 -0
data/test/dummy/README.rdoc +28 -0
data/test/dummy/Rakefile +6 -0
data/test/dummy/app/assets/images/.keep +0 -0
data/test/dummy/app/assets/javascripts/application.js +13 -0
data/test/dummy/app/assets/stylesheets/application.css +15 -0
data/test/dummy/app/controllers/application_controller.rb +5 -0
data/test/dummy/app/controllers/concerns/.keep +0 -0
data/test/dummy/app/helpers/application_helper.rb +2 -0
data/test/dummy/app/mailers/.keep +0 -0
data/test/dummy/app/models/.keep +0 -0
data/test/dummy/app/models/concerns/.keep +0 -0
data/test/dummy/app/views/layouts/application.html.erb +14 -0
data/test/dummy/bin/bundle +3 -0
data/test/dummy/bin/rails +4 -0
data/test/dummy/bin/rake +4 -0
data/test/dummy/config.ru +4 -0
data/test/dummy/config/application.rb +23 -0
data/test/dummy/config/boot.rb +5 -0
data/test/dummy/config/database.yml +25 -0
data/test/dummy/config/environment.rb +5 -0
data/test/dummy/config/environments/development.rb +37 -0
data/test/dummy/config/environments/production.rb +82 -0
data/test/dummy/config/environments/test.rb +39 -0
data/test/dummy/config/initializers/assets.rb +8 -0
data/test/dummy/config/initializers/backtrace_silencers.rb +7 -0
data/test/dummy/config/initializers/cookies_serializer.rb +3 -0
data/test/dummy/config/initializers/filter_parameter_logging.rb +4 -0
data/test/dummy/config/initializers/inflections.rb +16 -0
data/test/dummy/config/initializers/mime_types.rb +4 -0
data/test/dummy/config/initializers/session_store.rb +3 -0
data/test/dummy/config/initializers/wrap_parameters.rb +14 -0
data/test/dummy/config/locales/en.yml +23 -0
data/test/dummy/config/routes.rb +56 -0
data/test/dummy/config/secrets.yml +22 -0
data/test/dummy/db/test.sqlite3 +0 -0
data/test/dummy/lib/assets/.keep +0 -0
data/test/dummy/log/.keep +0 -0
data/test/dummy/log/test.log +10 -0
data/test/dummy/public/404.html +67 -0
data/test/dummy/public/422.html +67 -0
data/test/dummy/public/500.html +66 -0
data/test/dummy/public/favicon.ico +0 -0
data/test/test_helper.rb +15 -0
data/test/view_helpers_test.rb +66 -0
metadata +201 -0

checksums.yaml ADDED

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: d319183537bdd771b4e31638aab0dd4773b21816
+  data.tar.gz: 7f9f8942e45fbb913111f852dd6b784a9eeae2fa
+SHA512:
+  metadata.gz: 52eac981f4ff837a29b74d3cece7a1b0aa2d973ac99ea82751b2e5e05591891573dd20482bdf560873c9c700e638c777475528e1c4693681b2e04624799b34fb
+  data.tar.gz: 7abdc20e71d00312d24cdc564a028e6d89e14e3ead1784094e4e3cfc4c4bb20beeea217534ea198d08e4b916ba1fa52943fe08ae3ec9a88a957aebb233642b7e

data/.gitignore ADDED

@@ -0,0 +1,22 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/Gemfile ADDED

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+# Specify your gem's dependencies in item.gemspec
+gemspec

data/LICENSE.txt ADDED

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Lasse Bunk
+MIT License
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.html ADDED

@@ -0,0 +1,218 @@
+<!DOCTYPE html><html><head><meta charset="utf-8"><style>html { font-size: 100%; overflow-y: scroll; -webkit-text-size-adjust: 100%; -ms-text-size-adjust: 100%; }
+body{
+  color:#444;
+  font-family:Georgia, Palatino, 'Palatino Linotype', Times, 'Times New Roman',
+              "Hiragino Sans GB", "STXihei", "微软雅黑", serif;
+  font-size:12px;
+  line-height:1.5em;
+  background:#fefefe;
+  width: 45em;
+  margin: 10px auto;
+  padding: 1em;
+  outline: 1300px solid #FAFAFA;
+}
+a{ color: #0645ad; text-decoration:none;}
+a:visited{ color: #0b0080; }
+a:hover{ color: #06e; }
+a:active{ color:#faa700; }
+a:focus{ outline: thin dotted; }
+a:hover, a:active{ outline: 0; }
+span.backtick {
+  border:1px solid #EAEAEA;
+  border-radius:3px;
+  background:#F8F8F8;
+  padding:0 3px 0 3px;
+}
+::-moz-selection{background:rgba(255,255,0,0.3);color:#000}
+::selection{background:rgba(255,255,0,0.3);color:#000}
+a::-moz-selection{background:rgba(255,255,0,0.3);color:#0645ad}
+a::selection{background:rgba(255,255,0,0.3);color:#0645ad}
+p{
+margin:1em 0;
+}
+img{
+max-width:100%;
+}
+h1,h2,h3,h4,h5,h6{
+font-weight:normal;
+color:#111;
+line-height:1em;
+}
+h4,h5,h6{ font-weight: bold; }
+h1{ font-size:2.5em; }
+h2{ font-size:2em; border-bottom:1px solid silver; padding-bottom: 5px; }
+h3{ font-size:1.5em; }
+h4{ font-size:1.2em; }
+h5{ font-size:1em; }
+h6{ font-size:0.9em; }
+blockquote{
+color:#666666;
+margin:0;
+padding-left: 3em;
+border-left: 0.5em #EEE solid;
+}
+hr { display: block; height: 2px; border: 0; border-top: 1px solid #aaa;border-bottom: 1px solid #eee; margin: 1em 0; padding: 0; }
+pre , code, kbd, samp {
+  color: #000;
+  font-family: monospace;
+  font-size: 0.88em;
+  border-radius:3px;
+  background-color: #F8F8F8;
+  border: 1px solid #CCC;
+}
+pre { white-space: pre; white-space: pre-wrap; word-wrap: break-word; padding: 5px 12px;}
+pre code { border: 0px !important; padding: 0;}
+code { padding: 0 3px 0 3px; }
+b, strong { font-weight: bold; }
+dfn { font-style: italic; }
+ins { background: #ff9; color: #000; text-decoration: none; }
+mark { background: #ff0; color: #000; font-style: italic; font-weight: bold; }
+sub, sup { font-size: 75%; line-height: 0; position: relative; vertical-align: baseline; }
+sup { top: -0.5em; }
+sub { bottom: -0.25em; }
+ul, ol { margin: 1em 0; padding: 0 0 0 2em; }
+li p:last-child { margin:0 }
+dd { margin: 0 0 0 2em; }
+img { border: 0; -ms-interpolation-mode: bicubic; vertical-align: middle; }
+table { border-collapse: collapse; border-spacing: 0; }
+td { vertical-align: top; }
+@media only screen and (min-width: 480px) {
+body{font-size:14px;}
+}
+@media only screen and (min-width: 768px) {
+body{font-size:16px;}
+}
+@media print {
+  * { background: transparent !important; color: black !important; filter:none !important; -ms-filter: none !important; }
+  body{font-size:12pt; max-width:100%; outline:none;}
+  a, a:visited { text-decoration: underline; }
+  hr { height: 1px; border:0; border-bottom:1px solid black; }
+  a[href]:after { content: " (" attr(href) ")"; }
+  abbr[title]:after { content: " (" attr(title) ")"; }
+  .ir a:after, a[href^="javascript:"]:after, a[href^="#"]:after { content: ""; }
+  pre, blockquote { border: 1px solid #999; padding-right: 1em; page-break-inside: avoid; }
+  tr, img { page-break-inside: avoid; }
+  img { max-width: 100% !important; }
+  @page :left { margin: 15mm 20mm 15mm 10mm; }
+  @page :right { margin: 15mm 10mm 15mm 20mm; }
+  p, h2, h3 { orphans: 3; widows: 3; }
+  h2, h3 { page-break-after: avoid; }
+}
+</style><title>README</title></head><body><p><a href="http://travis-ci.org/lassebunk/item"><img alt="Build Status" src="https://secure.travis-ci.org/lassebunk/item.png" /></a></p>
+<h1 id="item">Item</h1>
+<p>Item is a Ruby on Rails plugin for implementing semantic markup (microdata) without messing up the view code.</p>
+<p>See <a href="http://schema.org/docs/schemas.html">Schema.org</a> for valid microdata.</p>
+<h2 id="installation">Installation</h2>
+<p>Add this line to your application's <em>Gemfile</em>:</p>
+<pre><code class="ruby">gem 'item'
+</code></pre>
+<p>Then run:</p>
+<pre><code class="bash">$ bundle
+</code></pre>
+<h2 id="usage">Usage</h2>
+<h3 id="scopes">Scopes</h3>
+<p>To define an <code>itemscope</code>:</p>
+<pre><code class="erb">&lt;% scope :product do %&gt;
+  ...
+&lt;% end %&gt;
+</code></pre>
+<p>This will generate the following HTML:</p>
+<pre><code class="html">&lt;div itemscope itemtype=&quot;http://schema.org/Product&quot;&gt;
+  ...
+&lt;/div&gt;
+</code></pre>
+<h3 id="properties">Properties</h3>
+<p>To define an <code>itemprop</code> span:</p>
+<pre><code class="erb">&lt;%= prop :name, &quot;My Product Name&quot; %&gt;
+</code></pre>
+<p>This will generate the following HTML:</p>
+<pre><code class="html">&lt;span itemprop=&quot;name&quot;&gt;My Product Name&lt;/span&gt;
+</code></pre>
+<h4 id="hidden-meta-properties">Hidden meta properties</h4>
+<p>To define hidden <code>itemprop</code>s via <code>&lt;meta&gt;</code> tags, pass a hash to the <code>prop</code> helper:</p>
+<pre><code class="erb">&lt;%= prop date_published: Date.today %&gt;
+</code></pre>
+<p>This will generate the following HTML:</p>
+<pre><code class="html">&lt;meta itemprop=&quot;datePublished&quot; content=&quot;2014-07-26&quot; /&gt;
+</code></pre>
+<h4 id="link-values">Link values</h4>
+<p>To define a link to an enumeration member, e.g. <a href="">ItemAvailability</a></p>
+<h2 id="example">Example</h2>
+<p>The following is the Product <a href="http://schema.org/Product">example</a> on <a href="http://schema.org">Schema.org</a> rewritten with Item. In your view:</p>
+<pre><code class="erb">&lt;% scope :product do %&gt;
+  &lt;%= itemprop :name, &quot;Kenmore White 17\&quot; Microwave&quot; %&gt;
+  &lt;%= image_tag &quot;kenmore-microwave-17in.jpg&quot; %&gt;
+  &lt;% prop :aggregate_rating do %&gt;
+    Rated &lt;%= prop :rating_value, 3.5 %&gt;/5
+    based on &lt;%= prop :review_count, 11 %&gt; custom reviews
+  &lt;% end %&gt;
+  &lt;% prop :offers, type: :offer do %&gt;
+    &lt;%= prop :price, &quot;$55.00&quot; %&gt;
+    &lt;%= prop :availability, :in_stock %&gt;
+    In Stock
+  &lt;% end %&gt;
+  Product description:
+  &lt;%= prop :description, &quot;0.7 cubic feet countertop microwave.
+    Has six preset cooking categories and convenience features like
+    Add-A-Minute and Child Lock.&quot; %&gt;
+  Customer reviews:
+  &lt;% prop :review do %&gt;
+    &lt;%= prop :name, &quot;Not a happy camper&quot; %&gt; -
+    by &lt;%= prop :author, &quot;Ellie&quot; %&gt;,
+    &lt;%= prop date_published: &quot;2011-04-01&quot; %&gt;
+    April 1, 2011
+    &lt;% prop :review_rating, type: :rating do %&gt;
+      &lt;%= prop worst_rating: 1 %&gt;
+      &lt;%= prop :rating_value, 1 %&gt; /
+      &lt;%= prop :best_rating, 5 %&gt; stars
+      &lt;%= prop :description, &quot;The lamp burned out and now I have to replace it.&quot; %&gt;
+    &lt;% end %&gt;
+  &lt;% end %&gt;
+&lt;% end %&gt;
+</code></pre>
+<h2 id="contributing">Contributing</h2>
+<p>Changes and improvements are to Item are very welcome and greatly appreciated.</p>
+<ol>
+<li>Fork the project</li>
+<li>Create your feature branch (<code>git checkout -b my-new-feature</code>)</li>
+<li>Add your changes, including tests so we don't break it unintentionally.</li>
+<li>Run <code>rake</code> to make sure the tests pass</li>
+<li>Commit your changes (<code>git commit -am 'Add feature'</code>)</li>
+<li>Push to the branch (<code>git push origin my-new-feature</code>)</li>
+<li>Create a new pull request</li>
+</ol></body></html>

data/README.md ADDED

@@ -0,0 +1,186 @@
+[![Build Status](https://secure.travis-ci.org/lassebunk/item.png)](http://travis-ci.org/lassebunk/item)
+# Item
+Item is a Ruby on Rails plugin for adding semantic markup (microdata) to your views without cluttering the code.
+**What is Microdata?** [Microdata](http://schema.org) helps search engines show additional information about your content, for example product reviews.
+This can help attract visitors to your site:
+![Microdata in SERPs](http://i.imgur.com/bCi0GHF.png)
+**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.
+## Installation
+Add this line to your application's *Gemfile*:
+```ruby
+gem 'item'
+```
+Then run:
+```bash
+$ bundle
+```
+## Usage
+### Scopes
+To define an `itemscope`:
+```erb
+<% 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
+<div itemscope itemtype="http://schema.org/Product">
+  ...
+</div>
+```
+### Properties
+To define an `itemprop` span:
+```erb
+<%= prop :name, "My Product Name" %>
+```
+This will generate the following HTML:
+```html
+<span itemprop="name">My Product Name</span>
+```
+#### Scoped properties
+To define a property that is also a scope:
+```erb
+<% 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
+<div itemprop="review" itemscope itemtype="http://schema.org/Review">
+  <span itemprop="name">Pete Anderson</span>
+</div>
+```
+##### Defining types on scoped properties
+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 %>
+  ...
+<% end %>
+```
+This will generate the following HTML:
+```html
+<div itemprop="reviewRating" itemscope itemtype="http://schema.org/Review">
+  ...
+</div>
+```
+#### Meta properties
+To define hidden `itemprop`s via `<meta>` tags, pass a hash to the `prop` helper:
+```erb
+<%= prop date_published: Date.today %>
+```
+This will generate the following HTML:
+```html
+<meta itemprop="datePublished" content="2014-07-26" />
+```
+#### Link properties
+To define a link to an enumeration member, e.g. [ItemAvailability](http://schema.org/ItemAvailability):
+```erb
+<%= prop :availability, :in_stock %>
+```
+This will generate the following HTML:
+```html
+<link itemprop="availability" href="http://schema.org/InStock" />
+```
+## Example
+The following is based on the [Product example](http://schema.org/Product) on [Schema.org](http://schema.org), rewritten with the Item gem. In your view:
+```erb
+<% scope :product do %>
+  <%= itemprop :name, "Kenmore White 17\" Microwave" %>
+  <%= image_tag "kenmore-microwave-17in.jpg" %>
+  <% 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 :price, "$55.00" %>
+    <%= prop :availability, :in_stock %>
+    In Stock
+  <% end %>
+  Product description:
+  <%= prop :description, "0.7 cubic feet countertop microwave.
+    Has six preset cooking categories and convenience features like
+    Add-A-Minute and Child Lock." %>
+  Customer reviews:
+  <% 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 worst_rating: 1 %>
+      <%= prop :rating_value, 1 %> /
+      <%= prop :best_rating, 5 %> stars
+      <%= prop :description, "The lamp burned out and now I have to replace it." %>
+    <% end %>
+  <% end %>
+<% end %>
+```
+## Contributing
+Changes and improvements are to Item are very welcome and greatly appreciated.
+1. Fork the project
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Add your changes, including tests so we don't break it unintentionally.
+4. Run `rake` to make sure the tests pass
+5. Commit your changes (`git commit -am 'Add feature'`)
+6. Push to the branch (`git push origin my-new-feature`)
+7. Create a new pull request