micro_helper 0.5.0
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.
- data/.gitignore +18 -0
- data/Gemfile +4 -0
- data/LICENSE.txt +22 -0
- data/README.md +80 -0
- data/Rakefile +1 -0
- data/lib/micro_helper.rb +96 -0
- data/lib/micro_helper/version.rb +4 -0
- data/micro_helper.gemspec +20 -0
- metadata +69 -0
data/.gitignore
ADDED
data/Gemfile
ADDED
data/LICENSE.txt
ADDED
@@ -0,0 +1,22 @@
|
|
1
|
+
Copyright (c) 2013 Alexandre Coppens
|
2
|
+
|
3
|
+
MIT License
|
4
|
+
|
5
|
+
Permission is hereby granted, free of charge, to any person obtaining
|
6
|
+
a copy of this software and associated documentation files (the
|
7
|
+
"Software"), to deal in the Software without restriction, including
|
8
|
+
without limitation the rights to use, copy, modify, merge, publish,
|
9
|
+
distribute, sublicense, and/or sell copies of the Software, and to
|
10
|
+
permit persons to whom the Software is furnished to do so, subject to
|
11
|
+
the following conditions:
|
12
|
+
|
13
|
+
The above copyright notice and this permission notice shall be
|
14
|
+
included in all copies or substantial portions of the Software.
|
15
|
+
|
16
|
+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
|
17
|
+
EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
|
18
|
+
MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
|
19
|
+
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
|
20
|
+
LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
|
21
|
+
OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
|
22
|
+
WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
|
data/README.md
ADDED
@@ -0,0 +1,80 @@
|
|
1
|
+
# Microformats::Helper
|
2
|
+
|
3
|
+
|
4
|
+
## Description
|
5
|
+
|
6
|
+
Microformats helper that supports nesting.
|
7
|
+
|
8
|
+
Latest stable version is 5.0
|
9
|
+
|
10
|
+
First usable iteration is VERSION 0.2.6
|
11
|
+
|
12
|
+
|
13
|
+
## Installation
|
14
|
+
|
15
|
+
Add this line to your application's Gemfile:
|
16
|
+
|
17
|
+
gem 'micro_helper'
|
18
|
+
|
19
|
+
And then execute:
|
20
|
+
|
21
|
+
$ bundle
|
22
|
+
|
23
|
+
Or install it yourself as:
|
24
|
+
|
25
|
+
$ gem install micro_helper
|
26
|
+
|
27
|
+
## Microformat usage
|
28
|
+
|
29
|
+
microformats(container,props,child)
|
30
|
+
|
31
|
+
or
|
32
|
+
|
33
|
+
generate_microformats(container,props,child) [Depreciated]
|
34
|
+
|
35
|
+
which gives a hidden span with all the microformat content you need
|
36
|
+
|
37
|
+
### parameter examples:
|
38
|
+
|
39
|
+
container = { itemprop: nil, itemtype: "Product" }
|
40
|
+
|
41
|
+
props = {
|
42
|
+
|
43
|
+
name: { value: "Executive Anvil"},
|
44
|
+
brand: { value: "ACME" },
|
45
|
+
category: { content: "Hardware > Tools > Anvils", value: "Anvils"},
|
46
|
+
description: { value: "Sleeker than ACME's Classic Anvil..." }
|
47
|
+
}
|
48
|
+
|
49
|
+
child = generate_microformats(child_container,child_props)
|
50
|
+
|
51
|
+
|
52
|
+
## Usage for open graph
|
53
|
+
|
54
|
+
og_for("type","content")
|
55
|
+
|
56
|
+
which gives
|
57
|
+
|
58
|
+
content_for do
|
59
|
+
<meta property="og:type" content="content">
|
60
|
+
end
|
61
|
+
|
62
|
+
you can also not use content_for:
|
63
|
+
|
64
|
+
og_tag("type","content")
|
65
|
+
|
66
|
+
there is also an optional namespace:
|
67
|
+
|
68
|
+
og_tag("type","content","fb")
|
69
|
+
|
70
|
+
which gives
|
71
|
+
|
72
|
+
<meta property="fb:type" content="content">
|
73
|
+
|
74
|
+
## Contributing
|
75
|
+
|
76
|
+
1. Fork it
|
77
|
+
2. Create your feature branch (`git checkout -b my-new-feature`)
|
78
|
+
3. Commit your changes (`git commit -am 'Add some feature'`)
|
79
|
+
4. Push to the branch (`git push origin my-new-feature`)
|
80
|
+
5. Create new Pull Request
|
data/Rakefile
ADDED
@@ -0,0 +1 @@
|
|
1
|
+
require "bundler/gem_tasks"
|
data/lib/micro_helper.rb
ADDED
@@ -0,0 +1,96 @@
|
|
1
|
+
require "micro_helper/version"
|
2
|
+
|
3
|
+
|
4
|
+
module MicroHelper
|
5
|
+
|
6
|
+
|
7
|
+
|
8
|
+
PROP_TYPE_BASE_URL = "http://data-vocabulary.org/"
|
9
|
+
|
10
|
+
|
11
|
+
def generate_microformats(container,props,childs=nil)
|
12
|
+
|
13
|
+
"#{span_outer(container)}#{parse_props(props)}#{childs}</span>".html_safe
|
14
|
+
end
|
15
|
+
|
16
|
+
|
17
|
+
def microformats(container,props,childs=nil)
|
18
|
+
|
19
|
+
generate_microformats(container,props,childs)
|
20
|
+
end
|
21
|
+
|
22
|
+
|
23
|
+
def og_for(type,value,namespace="og")
|
24
|
+
|
25
|
+
content_for type do
|
26
|
+
|
27
|
+
meta_tag("#{namespace}:#{type}",value)
|
28
|
+
end
|
29
|
+
end
|
30
|
+
|
31
|
+
|
32
|
+
def og_tag(type,value,namespace="og")
|
33
|
+
|
34
|
+
meta_tag("#{namespace}:#{type}",value)
|
35
|
+
end
|
36
|
+
|
37
|
+
|
38
|
+
def meta_tag(property,value)
|
39
|
+
|
40
|
+
"<meta property='#{property}' content='#{value}'>".html_safe
|
41
|
+
end
|
42
|
+
|
43
|
+
|
44
|
+
def type_url(type)
|
45
|
+
|
46
|
+
"#{PROP_TYPE_BASE_URL}#{type}"
|
47
|
+
end
|
48
|
+
|
49
|
+
|
50
|
+
def span_outer(container)
|
51
|
+
|
52
|
+
"<span style='display:none' #{parse_itemprop(container[:itemprop])} #{type_prop(container[:type])}>"
|
53
|
+
end
|
54
|
+
|
55
|
+
|
56
|
+
def parse_itemprop(itemprop)
|
57
|
+
|
58
|
+
"itemprop='#{itemprop}'" if itemprop
|
59
|
+
end
|
60
|
+
|
61
|
+
|
62
|
+
def span(key,content)
|
63
|
+
|
64
|
+
"<span itemprop='#{key.to_s}' #{parse_content(content)}>"
|
65
|
+
end
|
66
|
+
|
67
|
+
|
68
|
+
def parse_content(content)
|
69
|
+
|
70
|
+
"content='#{content}'" if content
|
71
|
+
end
|
72
|
+
|
73
|
+
|
74
|
+
def parse_props(props)
|
75
|
+
|
76
|
+
html=""
|
77
|
+
|
78
|
+
props.each do |key,prop|
|
79
|
+
|
80
|
+
html+="#{span(key,prop[:content])}#{prop[:value]}</span>"
|
81
|
+
end
|
82
|
+
|
83
|
+
return html
|
84
|
+
end
|
85
|
+
|
86
|
+
def type_prop(type)
|
87
|
+
|
88
|
+
"itemscope itemtype='#{type_url(type)}'"
|
89
|
+
end
|
90
|
+
|
91
|
+
end
|
92
|
+
|
93
|
+
ActiveSupport.on_load(:action_view) do
|
94
|
+
|
95
|
+
include MicroHelper
|
96
|
+
end
|
@@ -0,0 +1,20 @@
|
|
1
|
+
# -*- encoding: utf-8 -*-
|
2
|
+
lib = File.expand_path('../lib', __FILE__)
|
3
|
+
$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
|
4
|
+
require 'micro_helper/version'
|
5
|
+
|
6
|
+
Gem::Specification.new do |gem|
|
7
|
+
gem.name = "micro_helper"
|
8
|
+
gem.version = MicroHelper::VERSION
|
9
|
+
gem.authors = ["Alexandre Coppens"]
|
10
|
+
gem.email = ["alexcppns@gmail.com"]
|
11
|
+
gem.description = "Helper for microformats, possibility of nesting."
|
12
|
+
gem.summary = "Helper for microformats, possibility of nesting."
|
13
|
+
gem.homepage = "http://github.com/AlexCppns/micro_helper"
|
14
|
+
gem.add_runtime_dependency "activesupport"
|
15
|
+
# gem.add_runtime_dependency "actionpack"
|
16
|
+
gem.files = `git ls-files`.split($/)
|
17
|
+
gem.executables = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
|
18
|
+
gem.test_files = gem.files.grep(%r{^(test|spec|features)/})
|
19
|
+
gem.require_paths = ["lib"]
|
20
|
+
end
|
metadata
ADDED
@@ -0,0 +1,69 @@
|
|
1
|
+
--- !ruby/object:Gem::Specification
|
2
|
+
name: micro_helper
|
3
|
+
version: !ruby/object:Gem::Version
|
4
|
+
version: 0.5.0
|
5
|
+
prerelease:
|
6
|
+
platform: ruby
|
7
|
+
authors:
|
8
|
+
- Alexandre Coppens
|
9
|
+
autorequire:
|
10
|
+
bindir: bin
|
11
|
+
cert_chain: []
|
12
|
+
date: 2013-04-22 00:00:00.000000000 Z
|
13
|
+
dependencies:
|
14
|
+
- !ruby/object:Gem::Dependency
|
15
|
+
name: activesupport
|
16
|
+
requirement: !ruby/object:Gem::Requirement
|
17
|
+
none: false
|
18
|
+
requirements:
|
19
|
+
- - ! '>='
|
20
|
+
- !ruby/object:Gem::Version
|
21
|
+
version: '0'
|
22
|
+
type: :runtime
|
23
|
+
prerelease: false
|
24
|
+
version_requirements: !ruby/object:Gem::Requirement
|
25
|
+
none: false
|
26
|
+
requirements:
|
27
|
+
- - ! '>='
|
28
|
+
- !ruby/object:Gem::Version
|
29
|
+
version: '0'
|
30
|
+
description: Helper for microformats, possibility of nesting.
|
31
|
+
email:
|
32
|
+
- alexcppns@gmail.com
|
33
|
+
executables: []
|
34
|
+
extensions: []
|
35
|
+
extra_rdoc_files: []
|
36
|
+
files:
|
37
|
+
- .gitignore
|
38
|
+
- Gemfile
|
39
|
+
- LICENSE.txt
|
40
|
+
- README.md
|
41
|
+
- Rakefile
|
42
|
+
- lib/micro_helper.rb
|
43
|
+
- lib/micro_helper/version.rb
|
44
|
+
- micro_helper.gemspec
|
45
|
+
homepage: http://github.com/AlexCppns/micro_helper
|
46
|
+
licenses: []
|
47
|
+
post_install_message:
|
48
|
+
rdoc_options: []
|
49
|
+
require_paths:
|
50
|
+
- lib
|
51
|
+
required_ruby_version: !ruby/object:Gem::Requirement
|
52
|
+
none: false
|
53
|
+
requirements:
|
54
|
+
- - ! '>='
|
55
|
+
- !ruby/object:Gem::Version
|
56
|
+
version: '0'
|
57
|
+
required_rubygems_version: !ruby/object:Gem::Requirement
|
58
|
+
none: false
|
59
|
+
requirements:
|
60
|
+
- - ! '>='
|
61
|
+
- !ruby/object:Gem::Version
|
62
|
+
version: '0'
|
63
|
+
requirements: []
|
64
|
+
rubyforge_project:
|
65
|
+
rubygems_version: 1.8.24
|
66
|
+
signing_key:
|
67
|
+
specification_version: 3
|
68
|
+
summary: Helper for microformats, possibility of nesting.
|
69
|
+
test_files: []
|