middleman-vcard 0.9.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +7 -0
- data/.document +3 -0
- data/.gitignore +26 -0
- data/.rspec +1 -0
- data/.ruby-version +1 -0
- data/.yardopts +1 -0
- data/ChangeLog.md +0 -0
- data/Gemfile +4 -0
- data/Gemfile.lock +109 -0
- data/LICENSE +201 -0
- data/README.md +35 -0
- data/Rakefile +27 -0
- data/lib/middleman-vcard.rb +25 -0
- data/lib/middleman-vcard/extension.rb +39 -0
- data/lib/middleman-vcard/generator.rb +134 -0
- data/lib/middleman-vcard/version.rb +11 -0
- data/lib/middleman_extension.rb +1 -0
- data/middleman-vcard.gemspec +37 -0
- data/spec/middleman-vcard_version_spec.rb +37 -0
- data/spec/spec_helper.rb +28 -0
- metadata +193 -0
checksums.yaml
ADDED
@@ -0,0 +1,7 @@
|
|
1
|
+
---
|
2
|
+
SHA1:
|
3
|
+
metadata.gz: fc7697ce00e6cbac0a1f6beafaadecf972f5eec9
|
4
|
+
data.tar.gz: 073847a414dd74c55d7085764c0b6b957c52db6b
|
5
|
+
SHA512:
|
6
|
+
metadata.gz: 5781e872e1e265531859571b8f6a200733f4fc572f9a858b7931f0d170179213b3f9d48e562bf0b9f54f92c2504b1ddb0a0559b97f72cde8e5c89626a2d67bad
|
7
|
+
data.tar.gz: 10f4a700e661e67f1e795c635934d7bd76a8151dcb1a7482989514743b784481d80da834ae9542aaaf4f2c27d6b09b508e7c4912b3dc05671656457fbf9f8b15
|
data/.document
ADDED
data/.gitignore
ADDED
@@ -0,0 +1,26 @@
|
|
1
|
+
# {{{ Ignores for generated/temporary files
|
2
|
+
|
3
|
+
# Generated documentation
|
4
|
+
doc/
|
5
|
+
|
6
|
+
# Log & temporary files
|
7
|
+
log/
|
8
|
+
tmp/
|
9
|
+
|
10
|
+
# Gems
|
11
|
+
pkg/
|
12
|
+
vendor/cache/*.gem
|
13
|
+
|
14
|
+
# }}}
|
15
|
+
|
16
|
+
# {{{ Ignores for tools
|
17
|
+
|
18
|
+
# IntelliJ IDEA project files
|
19
|
+
.idea/
|
20
|
+
*.iml
|
21
|
+
|
22
|
+
# SublimeText project files
|
23
|
+
*.sublime-project
|
24
|
+
*.sublime-workspace
|
25
|
+
|
26
|
+
# }}}
|
data/.rspec
ADDED
@@ -0,0 +1 @@
|
|
1
|
+
--colour --format documentation
|
data/.ruby-version
ADDED
@@ -0,0 +1 @@
|
|
1
|
+
2.1.3
|
data/.yardopts
ADDED
@@ -0,0 +1 @@
|
|
1
|
+
--markup markdown --title "Middleman VCard docs" --protected
|
data/ChangeLog.md
ADDED
File without changes
|
data/Gemfile
ADDED
data/Gemfile.lock
ADDED
@@ -0,0 +1,109 @@
|
|
1
|
+
PATH
|
2
|
+
remote: .
|
3
|
+
specs:
|
4
|
+
middleman-vcard (0.9.0)
|
5
|
+
contracts
|
6
|
+
middleman-core (>= 3.3.10)
|
7
|
+
vpim
|
8
|
+
|
9
|
+
GEM
|
10
|
+
remote: https://rubygems.org/
|
11
|
+
specs:
|
12
|
+
activesupport (4.1.9)
|
13
|
+
i18n (~> 0.6, >= 0.6.9)
|
14
|
+
json (~> 1.7, >= 1.7.7)
|
15
|
+
minitest (~> 5.1)
|
16
|
+
thread_safe (~> 0.1)
|
17
|
+
tzinfo (~> 1.1)
|
18
|
+
byebug (3.5.1)
|
19
|
+
columnize (~> 0.8)
|
20
|
+
debugger-linecache (~> 1.2)
|
21
|
+
slop (~> 3.6)
|
22
|
+
celluloid (0.16.0)
|
23
|
+
timers (~> 4.0.0)
|
24
|
+
coderay (1.1.0)
|
25
|
+
columnize (0.9.0)
|
26
|
+
contracts (0.7)
|
27
|
+
debugger-linecache (1.2.0)
|
28
|
+
diff-lcs (1.2.5)
|
29
|
+
erubis (2.7.0)
|
30
|
+
ffi (1.9.6)
|
31
|
+
hitimes (1.2.2)
|
32
|
+
hooks (0.4.0)
|
33
|
+
uber (~> 0.0.4)
|
34
|
+
i18n (0.7.0)
|
35
|
+
json (1.8.2)
|
36
|
+
listen (2.8.5)
|
37
|
+
celluloid (>= 0.15.2)
|
38
|
+
rb-fsevent (>= 0.9.3)
|
39
|
+
rb-inotify (>= 0.9)
|
40
|
+
method_source (0.8.2)
|
41
|
+
middleman-core (3.3.10)
|
42
|
+
activesupport (~> 4.1.0)
|
43
|
+
bundler (~> 1.1)
|
44
|
+
erubis
|
45
|
+
hooks (~> 0.3)
|
46
|
+
i18n (~> 0.7.0)
|
47
|
+
listen (>= 2.7.9, < 3.0)
|
48
|
+
padrino-helpers (~> 0.12.3)
|
49
|
+
rack (>= 1.4.5, < 2.0)
|
50
|
+
rack-test (~> 0.6.2)
|
51
|
+
thor (>= 0.15.2, < 2.0)
|
52
|
+
tilt (~> 1.4.1, < 2.0)
|
53
|
+
minitest (5.5.1)
|
54
|
+
padrino-helpers (0.12.4)
|
55
|
+
i18n (~> 0.6, >= 0.6.7)
|
56
|
+
padrino-support (= 0.12.4)
|
57
|
+
tilt (~> 1.4.1)
|
58
|
+
padrino-support (0.12.4)
|
59
|
+
activesupport (>= 3.1)
|
60
|
+
pry (0.10.1)
|
61
|
+
coderay (~> 1.1.0)
|
62
|
+
method_source (~> 0.8.1)
|
63
|
+
slop (~> 3.4)
|
64
|
+
pry-byebug (3.0.1)
|
65
|
+
byebug (~> 3.4)
|
66
|
+
pry (~> 0.10)
|
67
|
+
rack (1.6.0)
|
68
|
+
rack-test (0.6.3)
|
69
|
+
rack (>= 1.0)
|
70
|
+
rake (10.4.2)
|
71
|
+
rb-fsevent (0.9.4)
|
72
|
+
rb-inotify (0.9.5)
|
73
|
+
ffi (>= 0.5.0)
|
74
|
+
rspec (3.2.0)
|
75
|
+
rspec-core (~> 3.2.0)
|
76
|
+
rspec-expectations (~> 3.2.0)
|
77
|
+
rspec-mocks (~> 3.2.0)
|
78
|
+
rspec-core (3.2.1)
|
79
|
+
rspec-support (~> 3.2.0)
|
80
|
+
rspec-expectations (3.2.0)
|
81
|
+
diff-lcs (>= 1.2.0, < 2.0)
|
82
|
+
rspec-support (~> 3.2.0)
|
83
|
+
rspec-mocks (3.2.1)
|
84
|
+
diff-lcs (>= 1.2.0, < 2.0)
|
85
|
+
rspec-support (~> 3.2.0)
|
86
|
+
rspec-support (3.2.2)
|
87
|
+
slop (3.6.0)
|
88
|
+
thor (0.19.1)
|
89
|
+
thread_safe (0.3.4)
|
90
|
+
tilt (1.4.1)
|
91
|
+
timers (4.0.1)
|
92
|
+
hitimes
|
93
|
+
tzinfo (1.2.2)
|
94
|
+
thread_safe (~> 0.1)
|
95
|
+
uber (0.0.13)
|
96
|
+
vpim (13.11.11)
|
97
|
+
yard (0.8.7.6)
|
98
|
+
|
99
|
+
PLATFORMS
|
100
|
+
ruby
|
101
|
+
|
102
|
+
DEPENDENCIES
|
103
|
+
bundler
|
104
|
+
middleman-vcard!
|
105
|
+
pry
|
106
|
+
pry-byebug
|
107
|
+
rake
|
108
|
+
rspec
|
109
|
+
yard
|
data/LICENSE
ADDED
@@ -0,0 +1,201 @@
|
|
1
|
+
Apache License
|
2
|
+
Version 2.0, January 2004
|
3
|
+
http://www.apache.org/licenses/
|
4
|
+
|
5
|
+
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
|
6
|
+
|
7
|
+
1. Definitions.
|
8
|
+
|
9
|
+
"License" shall mean the terms and conditions for use, reproduction,
|
10
|
+
and distribution as defined by Sections 1 through 9 of this document.
|
11
|
+
|
12
|
+
"Licensor" shall mean the copyright owner or entity authorized by
|
13
|
+
the copyright owner that is granting the License.
|
14
|
+
|
15
|
+
"Legal Entity" shall mean the union of the acting entity and all
|
16
|
+
other entities that control, are controlled by, or are under common
|
17
|
+
control with that entity. For the purposes of this definition,
|
18
|
+
"control" means (i) the power, direct or indirect, to cause the
|
19
|
+
direction or management of such entity, whether by contract or
|
20
|
+
otherwise, or (ii) ownership of fifty percent (50%) or more of the
|
21
|
+
outstanding shares, or (iii) beneficial ownership of such entity.
|
22
|
+
|
23
|
+
"You" (or "Your") shall mean an individual or Legal Entity
|
24
|
+
exercising permissions granted by this License.
|
25
|
+
|
26
|
+
"Source" form shall mean the preferred form for making modifications,
|
27
|
+
including but not limited to software source code, documentation
|
28
|
+
source, and configuration files.
|
29
|
+
|
30
|
+
"Object" form shall mean any form resulting from mechanical
|
31
|
+
transformation or translation of a Source form, including but
|
32
|
+
not limited to compiled object code, generated documentation,
|
33
|
+
and conversions to other media types.
|
34
|
+
|
35
|
+
"Work" shall mean the work of authorship, whether in Source or
|
36
|
+
Object form, made available under the License, as indicated by a
|
37
|
+
copyright notice that is included in or attached to the work
|
38
|
+
(an example is provided in the Appendix below).
|
39
|
+
|
40
|
+
"Derivative Works" shall mean any work, whether in Source or Object
|
41
|
+
form, that is based on (or derived from) the Work and for which the
|
42
|
+
editorial revisions, annotations, elaborations, or other modifications
|
43
|
+
represent, as a whole, an original work of authorship. For the purposes
|
44
|
+
of this License, Derivative Works shall not include works that remain
|
45
|
+
separable from, or merely link (or bind by name) to the interfaces of,
|
46
|
+
the Work and Derivative Works thereof.
|
47
|
+
|
48
|
+
"Contribution" shall mean any work of authorship, including
|
49
|
+
the original version of the Work and any modifications or additions
|
50
|
+
to that Work or Derivative Works thereof, that is intentionally
|
51
|
+
submitted to Licensor for inclusion in the Work by the copyright owner
|
52
|
+
or by an individual or Legal Entity authorized to submit on behalf of
|
53
|
+
the copyright owner. For the purposes of this definition, "submitted"
|
54
|
+
means any form of electronic, verbal, or written communication sent
|
55
|
+
to the Licensor or its representatives, including but not limited to
|
56
|
+
communication on electronic mailing lists, source code control systems,
|
57
|
+
and issue tracking systems that are managed by, or on behalf of, the
|
58
|
+
Licensor for the purpose of discussing and improving the Work, but
|
59
|
+
excluding communication that is conspicuously marked or otherwise
|
60
|
+
designated in writing by the copyright owner as "Not a Contribution."
|
61
|
+
|
62
|
+
"Contributor" shall mean Licensor and any individual or Legal Entity
|
63
|
+
on behalf of whom a Contribution has been received by Licensor and
|
64
|
+
subsequently incorporated within the Work.
|
65
|
+
|
66
|
+
2. Grant of Copyright License. Subject to the terms and conditions of
|
67
|
+
this License, each Contributor hereby grants to You a perpetual,
|
68
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
69
|
+
copyright license to reproduce, prepare Derivative Works of,
|
70
|
+
publicly display, publicly perform, sublicense, and distribute the
|
71
|
+
Work and such Derivative Works in Source or Object form.
|
72
|
+
|
73
|
+
3. Grant of Patent License. Subject to the terms and conditions of
|
74
|
+
this License, each Contributor hereby grants to You a perpetual,
|
75
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
76
|
+
(except as stated in this section) patent license to make, have made,
|
77
|
+
use, offer to sell, sell, import, and otherwise transfer the Work,
|
78
|
+
where such license applies only to those patent claims licensable
|
79
|
+
by such Contributor that are necessarily infringed by their
|
80
|
+
Contribution(s) alone or by combination of their Contribution(s)
|
81
|
+
with the Work to which such Contribution(s) was submitted. If You
|
82
|
+
institute patent litigation against any entity (including a
|
83
|
+
cross-claim or counterclaim in a lawsuit) alleging that the Work
|
84
|
+
or a Contribution incorporated within the Work constitutes direct
|
85
|
+
or contributory patent infringement, then any patent licenses
|
86
|
+
granted to You under this License for that Work shall terminate
|
87
|
+
as of the date such litigation is filed.
|
88
|
+
|
89
|
+
4. Redistribution. You may reproduce and distribute copies of the
|
90
|
+
Work or Derivative Works thereof in any medium, with or without
|
91
|
+
modifications, and in Source or Object form, provided that You
|
92
|
+
meet the following conditions:
|
93
|
+
|
94
|
+
(a) You must give any other recipients of the Work or
|
95
|
+
Derivative Works a copy of this License; and
|
96
|
+
|
97
|
+
(b) You must cause any modified files to carry prominent notices
|
98
|
+
stating that You changed the files; and
|
99
|
+
|
100
|
+
(c) You must retain, in the Source form of any Derivative Works
|
101
|
+
that You distribute, all copyright, patent, trademark, and
|
102
|
+
attribution notices from the Source form of the Work,
|
103
|
+
excluding those notices that do not pertain to any part of
|
104
|
+
the Derivative Works; and
|
105
|
+
|
106
|
+
(d) If the Work includes a "NOTICE" text file as part of its
|
107
|
+
distribution, then any Derivative Works that You distribute must
|
108
|
+
include a readable copy of the attribution notices contained
|
109
|
+
within such NOTICE file, excluding those notices that do not
|
110
|
+
pertain to any part of the Derivative Works, in at least one
|
111
|
+
of the following places: within a NOTICE text file distributed
|
112
|
+
as part of the Derivative Works; within the Source form or
|
113
|
+
documentation, if provided along with the Derivative Works; or,
|
114
|
+
within a display generated by the Derivative Works, if and
|
115
|
+
wherever such third-party notices normally appear. The contents
|
116
|
+
of the NOTICE file are for informational purposes only and
|
117
|
+
do not modify the License. You may add Your own attribution
|
118
|
+
notices within Derivative Works that You distribute, alongside
|
119
|
+
or as an addendum to the NOTICE text from the Work, provided
|
120
|
+
that such additional attribution notices cannot be construed
|
121
|
+
as modifying the License.
|
122
|
+
|
123
|
+
You may add Your own copyright statement to Your modifications and
|
124
|
+
may provide additional or different license terms and conditions
|
125
|
+
for use, reproduction, or distribution of Your modifications, or
|
126
|
+
for any such Derivative Works as a whole, provided Your use,
|
127
|
+
reproduction, and distribution of the Work otherwise complies with
|
128
|
+
the conditions stated in this License.
|
129
|
+
|
130
|
+
5. Submission of Contributions. Unless You explicitly state otherwise,
|
131
|
+
any Contribution intentionally submitted for inclusion in the Work
|
132
|
+
by You to the Licensor shall be under the terms and conditions of
|
133
|
+
this License, without any additional terms or conditions.
|
134
|
+
Notwithstanding the above, nothing herein shall supersede or modify
|
135
|
+
the terms of any separate license agreement you may have executed
|
136
|
+
with Licensor regarding such Contributions.
|
137
|
+
|
138
|
+
6. Trademarks. This License does not grant permission to use the trade
|
139
|
+
names, trademarks, service marks, or product names of the Licensor,
|
140
|
+
except as required for reasonable and customary use in describing the
|
141
|
+
origin of the Work and reproducing the content of the NOTICE file.
|
142
|
+
|
143
|
+
7. Disclaimer of Warranty. Unless required by applicable law or
|
144
|
+
agreed to in writing, Licensor provides the Work (and each
|
145
|
+
Contributor provides its Contributions) on an "AS IS" BASIS,
|
146
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
|
147
|
+
implied, including, without limitation, any warranties or conditions
|
148
|
+
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
|
149
|
+
PARTICULAR PURPOSE. You are solely responsible for determining the
|
150
|
+
appropriateness of using or redistributing the Work and assume any
|
151
|
+
risks associated with Your exercise of permissions under this License.
|
152
|
+
|
153
|
+
8. Limitation of Liability. In no event and under no legal theory,
|
154
|
+
whether in tort (including negligence), contract, or otherwise,
|
155
|
+
unless required by applicable law (such as deliberate and grossly
|
156
|
+
negligent acts) or agreed to in writing, shall any Contributor be
|
157
|
+
liable to You for damages, including any direct, indirect, special,
|
158
|
+
incidental, or consequential damages of any character arising as a
|
159
|
+
result of this License or out of the use or inability to use the
|
160
|
+
Work (including but not limited to damages for loss of goodwill,
|
161
|
+
work stoppage, computer failure or malfunction, or any and all
|
162
|
+
other commercial damages or losses), even if such Contributor
|
163
|
+
has been advised of the possibility of such damages.
|
164
|
+
|
165
|
+
9. Accepting Warranty or Additional Liability. While redistributing
|
166
|
+
the Work or Derivative Works thereof, You may choose to offer,
|
167
|
+
and charge a fee for, acceptance of support, warranty, indemnity,
|
168
|
+
or other liability obligations and/or rights consistent with this
|
169
|
+
License. However, in accepting such obligations, You may act only
|
170
|
+
on Your own behalf and on Your sole responsibility, not on behalf
|
171
|
+
of any other Contributor, and only if You agree to indemnify,
|
172
|
+
defend, and hold each Contributor harmless for any liability
|
173
|
+
incurred by, or claims asserted against, such Contributor by reason
|
174
|
+
of your accepting any such warranty or additional liability.
|
175
|
+
|
176
|
+
END OF TERMS AND CONDITIONS
|
177
|
+
|
178
|
+
APPENDIX: How to apply the Apache License to your work.
|
179
|
+
|
180
|
+
To apply the Apache License to your work, attach the following
|
181
|
+
boilerplate notice, with the fields enclosed by brackets "{}"
|
182
|
+
replaced with your own identifying information. (Don't include
|
183
|
+
the brackets!) The text should be enclosed in the appropriate
|
184
|
+
comment syntax for the file format. We also recommend that a
|
185
|
+
file or class name and description of purpose be included on the
|
186
|
+
same "printed page" as the copyright notice for easier
|
187
|
+
identification within third-party archives.
|
188
|
+
|
189
|
+
Copyright 2014 Alessandro Molari
|
190
|
+
|
191
|
+
Licensed under the Apache License, Version 2.0 (the "License");
|
192
|
+
you may not use this file except in compliance with the License.
|
193
|
+
You may obtain a copy of the License at
|
194
|
+
|
195
|
+
http://www.apache.org/licenses/LICENSE-2.0
|
196
|
+
|
197
|
+
Unless required by applicable law or agreed to in writing, software
|
198
|
+
distributed under the License is distributed on an "AS IS" BASIS,
|
199
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
200
|
+
See the License for the specific language governing permissions and
|
201
|
+
limitations under the License.
|
data/README.md
ADDED
@@ -0,0 +1,35 @@
|
|
1
|
+
# Middleman VCard
|
2
|
+
|
3
|
+
* [Homepage](https://rubygems.org/gems/middleman-vcard)
|
4
|
+
* [Documentation](http://rubydoc.info/gems/middleman-vcard/frames)
|
5
|
+
* [Email](mailto:molari.alessandro@gmail.com)
|
6
|
+
|
7
|
+
## Description
|
8
|
+
|
9
|
+
Middleman extension to generate a VCard during the `build` phase.
|
10
|
+
|
11
|
+
## Usage
|
12
|
+
|
13
|
+
Include the `middleman-vcard` gem in your Gemfile:
|
14
|
+
```Ruby
|
15
|
+
gem 'middleman-vcard'
|
16
|
+
```
|
17
|
+
|
18
|
+
Add the following code to your `config.rb` file:
|
19
|
+
```Ruby
|
20
|
+
activate :vcard
|
21
|
+
```
|
22
|
+
|
23
|
+
## Contributors
|
24
|
+
|
25
|
+
Many thanks to Luca Molari (LMolr)!!
|
26
|
+
|
27
|
+
## Install
|
28
|
+
|
29
|
+
$ gem install middleman-vcard
|
30
|
+
|
31
|
+
## Copyright
|
32
|
+
|
33
|
+
Copyright (c) 2015 Alessandro Molari
|
34
|
+
|
35
|
+
See {file:LICENSE} for details.
|
data/Rakefile
ADDED
@@ -0,0 +1,27 @@
|
|
1
|
+
# encoding: utf-8
|
2
|
+
|
3
|
+
# Prepare environment for requiring gems.
|
4
|
+
require "rubygems"
|
5
|
+
require "bundler/setup"
|
6
|
+
|
7
|
+
# Require third-party tasks.
|
8
|
+
require "bundler/gem_tasks"
|
9
|
+
require "rake"
|
10
|
+
require "rake/clean"
|
11
|
+
require "rspec/core/rake_task"
|
12
|
+
require "yard"
|
13
|
+
|
14
|
+
# Require the project main module.
|
15
|
+
require "middleman-vcard"
|
16
|
+
|
17
|
+
|
18
|
+
RSpec::Core::RakeTask.new
|
19
|
+
|
20
|
+
YARD::Rake::YardocTask.new
|
21
|
+
|
22
|
+
desc "open a console preloaded with middleman-vcard"
|
23
|
+
task :console do
|
24
|
+
sh "pry --gem", verbose: false
|
25
|
+
end
|
26
|
+
|
27
|
+
task default: [:spec]
|
@@ -0,0 +1,25 @@
|
|
1
|
+
# Require - Core {{{
|
2
|
+
|
3
|
+
require "logger"
|
4
|
+
|
5
|
+
# }}}
|
6
|
+
|
7
|
+
# Require - External {{{
|
8
|
+
|
9
|
+
require "contracts"
|
10
|
+
require "vpim/vcard"
|
11
|
+
require "middleman-core"
|
12
|
+
|
13
|
+
# }}}
|
14
|
+
|
15
|
+
# Require - Project {{{
|
16
|
+
|
17
|
+
require "middleman-vcard/version"
|
18
|
+
require "middleman-vcard/generator"
|
19
|
+
|
20
|
+
Middleman::Extensions.register(:vcard) do
|
21
|
+
require "middleman-vcard/extension"
|
22
|
+
Middleman::VCard::VCardExtension
|
23
|
+
end
|
24
|
+
|
25
|
+
# }}}
|
@@ -0,0 +1,39 @@
|
|
1
|
+
require "middleman-core"
|
2
|
+
require "middleman-vcard/generator"
|
3
|
+
|
4
|
+
|
5
|
+
module Middleman
|
6
|
+
module VCard
|
7
|
+
##
|
8
|
+
# A Middleman extension to generate VCards.
|
9
|
+
#
|
10
|
+
class VCardExtension < Middleman::Extension
|
11
|
+
|
12
|
+
option :name, nil, "The VCard name" # TODO: It should be required.
|
13
|
+
option :emails, [], "The VCard emails"
|
14
|
+
option :phones, [], "The VCard telephones"
|
15
|
+
option :addresses, [], "The VCard addresses"
|
16
|
+
option :photo, nil, "The VCard photo"
|
17
|
+
|
18
|
+
option :destination_path, nil, "Destination path for the generated VCard"
|
19
|
+
|
20
|
+
def initialize(app, options_hash={}, &block)
|
21
|
+
super
|
22
|
+
|
23
|
+
@destination_path = options_hash[:destination_path] ||
|
24
|
+
File.join(app.root, app.config.source, "#{options_hash[:name]}.vcf")
|
25
|
+
@vcard_generator = ::Generator.new(options_hash[:name],
|
26
|
+
options_hash[:emails],
|
27
|
+
options_hash[:phones],
|
28
|
+
options_hash[:addresses],
|
29
|
+
options_hash[:photo],
|
30
|
+
logger)
|
31
|
+
end
|
32
|
+
|
33
|
+
def after_configuration
|
34
|
+
@vcard_generator.generate(@destination_path)
|
35
|
+
end
|
36
|
+
|
37
|
+
end
|
38
|
+
end
|
39
|
+
end
|
@@ -0,0 +1,134 @@
|
|
1
|
+
module Middleman
|
2
|
+
module VCard
|
3
|
+
class Generator
|
4
|
+
|
5
|
+
include Contracts
|
6
|
+
|
7
|
+
Contract( # {{{
|
8
|
+
# 1: name
|
9
|
+
String,
|
10
|
+
# 2: emails
|
11
|
+
ArrayOf[{
|
12
|
+
email: String,
|
13
|
+
preferred: Or[Bool, nil],
|
14
|
+
location: Or[String, nil]
|
15
|
+
}],
|
16
|
+
# 3: phones
|
17
|
+
ArrayOf[{
|
18
|
+
number: String,
|
19
|
+
preferred: Or[Bool, nil],
|
20
|
+
location: Or[String, nil],
|
21
|
+
capability: Or[ArrayOf[String], nil]
|
22
|
+
}],
|
23
|
+
# 4: addresses
|
24
|
+
ArrayOf[{
|
25
|
+
preferred: Or[Bool, nil],
|
26
|
+
location: Or[String, nil],
|
27
|
+
street: Or[String, nil],
|
28
|
+
postalcode: Or[String, nil],
|
29
|
+
locality: Or[String, nil],
|
30
|
+
region: Or[String, nil],
|
31
|
+
country: Or[String, nil]
|
32
|
+
}],
|
33
|
+
# 5: photo
|
34
|
+
Or[{
|
35
|
+
path: String,
|
36
|
+
type: String
|
37
|
+
}, nil],
|
38
|
+
# 6: logger
|
39
|
+
Or[Logger, nil] => Any
|
40
|
+
) # }}}
|
41
|
+
##
|
42
|
+
# Create a new VCard generator.
|
43
|
+
#
|
44
|
+
def initialize(name, # 1
|
45
|
+
emails=[], # 2
|
46
|
+
phones=[], # 3
|
47
|
+
addresses=[], # 4
|
48
|
+
photo=nil, # 5
|
49
|
+
logger=nil) # 6
|
50
|
+
|
51
|
+
@logger = logger || Logger.new($stdout)
|
52
|
+
|
53
|
+
@card = Vpim::Vcard::Maker.make2 do |maker|
|
54
|
+
|
55
|
+
maker.add_name do |n|
|
56
|
+
n.given = name
|
57
|
+
end
|
58
|
+
|
59
|
+
emails.each do |email|
|
60
|
+
maker.add_email(email[:email]) do |e|
|
61
|
+
e.preferred = email[:preferred] || false
|
62
|
+
e.location = email[:location] if email[:location]
|
63
|
+
end
|
64
|
+
end
|
65
|
+
|
66
|
+
phones.each do |phone|
|
67
|
+
maker.add_tel(phone[:number]) do |t|
|
68
|
+
t.preferred = phone[:preferred] || false
|
69
|
+
t.location = phone[:location] if phone[:location]
|
70
|
+
t.capability = phone[:capability] if phone[:capability]
|
71
|
+
end
|
72
|
+
end
|
73
|
+
|
74
|
+
addresses.each do |address|
|
75
|
+
maker.add_addr do |a|
|
76
|
+
a.preferred = address[:preferred] || false
|
77
|
+
a.location = address[:location] if address[:location]
|
78
|
+
a.street = address[:street] if address[:street]
|
79
|
+
a.postalcode = address[:postalcode] if address[:postalcode]
|
80
|
+
a.locality = address[:locality] if address[:locality]
|
81
|
+
a.region = address[:region] if address[:region]
|
82
|
+
a.country = address[:country] if address[:country]
|
83
|
+
end
|
84
|
+
end
|
85
|
+
|
86
|
+
if photo
|
87
|
+
# Normalize `photo[:path]`.
|
88
|
+
photo[:path] = File.expand_path(photo[:path])
|
89
|
+
# Check correctness of `photo[:path]`.
|
90
|
+
unless File.file?(photo[:path])
|
91
|
+
error("Invalid photo path: `#{photo[:path]}`.")
|
92
|
+
end
|
93
|
+
# Add photo informations to the VCard `maker`.
|
94
|
+
maker.add_photo do |p|
|
95
|
+
p.image = File.read(photo[:path])
|
96
|
+
p.type = photo[:type]
|
97
|
+
end
|
98
|
+
end
|
99
|
+
|
100
|
+
end
|
101
|
+
end # }}}
|
102
|
+
|
103
|
+
Contract String => Any
|
104
|
+
##
|
105
|
+
# Generate the VCard, storing the result in `destination_path`.
|
106
|
+
#
|
107
|
+
def generate(destination_path)
|
108
|
+
begin
|
109
|
+
File.open(destination_path, "w") { |file| file.write(@card) }
|
110
|
+
rescue StandardError => err
|
111
|
+
error(err.msg)
|
112
|
+
else
|
113
|
+
info("Successfully generated VCard to `#{destination_path}`.")
|
114
|
+
end
|
115
|
+
end
|
116
|
+
|
117
|
+
protected
|
118
|
+
|
119
|
+
def error(msg)
|
120
|
+
@logger.error(format_msg(msg))
|
121
|
+
# TODO: Raise error.
|
122
|
+
end
|
123
|
+
|
124
|
+
def info(msg)
|
125
|
+
@logger.info(format_msg(msg))
|
126
|
+
end
|
127
|
+
|
128
|
+
def format_msg(msg)
|
129
|
+
"[VCard] #{msg}"
|
130
|
+
end
|
131
|
+
|
132
|
+
end
|
133
|
+
end
|
134
|
+
end
|
@@ -0,0 +1 @@
|
|
1
|
+
require "middleman-vcard"
|
@@ -0,0 +1,37 @@
|
|
1
|
+
# -*- encoding: utf-8 -*-
|
2
|
+
|
3
|
+
$:.push File.expand_path("../lib", __FILE__)
|
4
|
+
require "middleman-vcard/version"
|
5
|
+
|
6
|
+
|
7
|
+
Gem::Specification.new do |gem|
|
8
|
+
gem.name = "middleman-vcard"
|
9
|
+
gem.version = Middleman::VCard::VERSION
|
10
|
+
gem.summary = %q{Middleman extension to generate VCards}
|
11
|
+
gem.description = %q{
|
12
|
+
A Middleman extension to automatically generate VCards based on provided
|
13
|
+
configurations.
|
14
|
+
This is particularly useful in contacts pages to create a vcard button.
|
15
|
+
}
|
16
|
+
gem.license = "Apache License Version 2.0"
|
17
|
+
gem.authors = ["Alessandro Molari"]
|
18
|
+
gem.email = "molari.alessandro@gmail.com"
|
19
|
+
gem.homepage = "https://rubygems.org/gems/middleman-vcard"
|
20
|
+
|
21
|
+
gem.files = `git ls-files`.split($/)
|
22
|
+
gem.executables = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
|
23
|
+
gem.test_files = gem.files.grep(%r{^spec/})
|
24
|
+
gem.require_paths = ["lib"]
|
25
|
+
|
26
|
+
gem.add_dependency("middleman-core", [">= 3.3.10"])
|
27
|
+
gem.add_dependency("vpim")
|
28
|
+
gem.add_dependency("contracts")
|
29
|
+
|
30
|
+
gem.add_development_dependency("bundler")
|
31
|
+
gem.add_development_dependency("rake")
|
32
|
+
gem.add_development_dependency("yard")
|
33
|
+
gem.add_development_dependency("rspec")
|
34
|
+
gem.add_development_dependency("pry")
|
35
|
+
gem.add_development_dependency("pry-byebug")
|
36
|
+
|
37
|
+
end
|
@@ -0,0 +1,37 @@
|
|
1
|
+
require 'spec_helper'
|
2
|
+
require 'middleman-vcard'
|
3
|
+
|
4
|
+
|
5
|
+
describe 'Middleman::VCard::VERSION' do
|
6
|
+
|
7
|
+
it 'should have a semver compliant format' do
|
8
|
+
version = Middleman::VCard::VERSION
|
9
|
+
expect(version).to_not be_empty
|
10
|
+
expect(version).to match(/[0-9]+\.[0-9]+\.[0-9]+/)
|
11
|
+
end
|
12
|
+
|
13
|
+
end
|
14
|
+
|
15
|
+
describe 'Middleman::VCard::VERSION_MAJOR' do
|
16
|
+
|
17
|
+
it 'should be positive' do
|
18
|
+
expect(Middleman::VCard::VERSION_MAJOR).to be >= 0
|
19
|
+
end
|
20
|
+
|
21
|
+
end
|
22
|
+
|
23
|
+
describe 'Middleman::VCard::VERSION_MINOR' do
|
24
|
+
|
25
|
+
it 'should be positive' do
|
26
|
+
expect(Middleman::VCard::VERSION_MINOR).to be >= 0
|
27
|
+
end
|
28
|
+
|
29
|
+
end
|
30
|
+
|
31
|
+
describe 'Middleman::VCard::VERSION_PATCH' do
|
32
|
+
|
33
|
+
it 'should be positive' do
|
34
|
+
expect(Middleman::VCard::VERSION_PATCH).to be >= 0
|
35
|
+
end
|
36
|
+
|
37
|
+
end
|
data/spec/spec_helper.rb
ADDED
@@ -0,0 +1,28 @@
|
|
1
|
+
require 'rspec'
|
2
|
+
require 'pry-byebug'
|
3
|
+
|
4
|
+
require 'middleman-vcard'
|
5
|
+
|
6
|
+
|
7
|
+
module Middleman
|
8
|
+
module VCard
|
9
|
+
module Helpers
|
10
|
+
|
11
|
+
def wait_for
|
12
|
+
unless block_given?
|
13
|
+
raise 'a block must be given!'
|
14
|
+
end
|
15
|
+
|
16
|
+
# Another possible implementation can use sleep instead of spin-locking..
|
17
|
+
# In practice, in tests, this is way more efficient than sleeping o_O
|
18
|
+
loop { break if yield }
|
19
|
+
end
|
20
|
+
|
21
|
+
end
|
22
|
+
end
|
23
|
+
end
|
24
|
+
|
25
|
+
|
26
|
+
RSpec.configure do |config|
|
27
|
+
config.include Middleman::VCard::Helpers
|
28
|
+
end
|
metadata
ADDED
@@ -0,0 +1,193 @@
|
|
1
|
+
--- !ruby/object:Gem::Specification
|
2
|
+
name: middleman-vcard
|
3
|
+
version: !ruby/object:Gem::Version
|
4
|
+
version: 0.9.0
|
5
|
+
platform: ruby
|
6
|
+
authors:
|
7
|
+
- Alessandro Molari
|
8
|
+
autorequire:
|
9
|
+
bindir: bin
|
10
|
+
cert_chain: []
|
11
|
+
date: 2015-02-24 00:00:00.000000000 Z
|
12
|
+
dependencies:
|
13
|
+
- !ruby/object:Gem::Dependency
|
14
|
+
name: middleman-core
|
15
|
+
requirement: !ruby/object:Gem::Requirement
|
16
|
+
requirements:
|
17
|
+
- - ">="
|
18
|
+
- !ruby/object:Gem::Version
|
19
|
+
version: 3.3.10
|
20
|
+
type: :runtime
|
21
|
+
prerelease: false
|
22
|
+
version_requirements: !ruby/object:Gem::Requirement
|
23
|
+
requirements:
|
24
|
+
- - ">="
|
25
|
+
- !ruby/object:Gem::Version
|
26
|
+
version: 3.3.10
|
27
|
+
- !ruby/object:Gem::Dependency
|
28
|
+
name: vpim
|
29
|
+
requirement: !ruby/object:Gem::Requirement
|
30
|
+
requirements:
|
31
|
+
- - ">="
|
32
|
+
- !ruby/object:Gem::Version
|
33
|
+
version: '0'
|
34
|
+
type: :runtime
|
35
|
+
prerelease: false
|
36
|
+
version_requirements: !ruby/object:Gem::Requirement
|
37
|
+
requirements:
|
38
|
+
- - ">="
|
39
|
+
- !ruby/object:Gem::Version
|
40
|
+
version: '0'
|
41
|
+
- !ruby/object:Gem::Dependency
|
42
|
+
name: contracts
|
43
|
+
requirement: !ruby/object:Gem::Requirement
|
44
|
+
requirements:
|
45
|
+
- - ">="
|
46
|
+
- !ruby/object:Gem::Version
|
47
|
+
version: '0'
|
48
|
+
type: :runtime
|
49
|
+
prerelease: false
|
50
|
+
version_requirements: !ruby/object:Gem::Requirement
|
51
|
+
requirements:
|
52
|
+
- - ">="
|
53
|
+
- !ruby/object:Gem::Version
|
54
|
+
version: '0'
|
55
|
+
- !ruby/object:Gem::Dependency
|
56
|
+
name: bundler
|
57
|
+
requirement: !ruby/object:Gem::Requirement
|
58
|
+
requirements:
|
59
|
+
- - ">="
|
60
|
+
- !ruby/object:Gem::Version
|
61
|
+
version: '0'
|
62
|
+
type: :development
|
63
|
+
prerelease: false
|
64
|
+
version_requirements: !ruby/object:Gem::Requirement
|
65
|
+
requirements:
|
66
|
+
- - ">="
|
67
|
+
- !ruby/object:Gem::Version
|
68
|
+
version: '0'
|
69
|
+
- !ruby/object:Gem::Dependency
|
70
|
+
name: rake
|
71
|
+
requirement: !ruby/object:Gem::Requirement
|
72
|
+
requirements:
|
73
|
+
- - ">="
|
74
|
+
- !ruby/object:Gem::Version
|
75
|
+
version: '0'
|
76
|
+
type: :development
|
77
|
+
prerelease: false
|
78
|
+
version_requirements: !ruby/object:Gem::Requirement
|
79
|
+
requirements:
|
80
|
+
- - ">="
|
81
|
+
- !ruby/object:Gem::Version
|
82
|
+
version: '0'
|
83
|
+
- !ruby/object:Gem::Dependency
|
84
|
+
name: yard
|
85
|
+
requirement: !ruby/object:Gem::Requirement
|
86
|
+
requirements:
|
87
|
+
- - ">="
|
88
|
+
- !ruby/object:Gem::Version
|
89
|
+
version: '0'
|
90
|
+
type: :development
|
91
|
+
prerelease: false
|
92
|
+
version_requirements: !ruby/object:Gem::Requirement
|
93
|
+
requirements:
|
94
|
+
- - ">="
|
95
|
+
- !ruby/object:Gem::Version
|
96
|
+
version: '0'
|
97
|
+
- !ruby/object:Gem::Dependency
|
98
|
+
name: rspec
|
99
|
+
requirement: !ruby/object:Gem::Requirement
|
100
|
+
requirements:
|
101
|
+
- - ">="
|
102
|
+
- !ruby/object:Gem::Version
|
103
|
+
version: '0'
|
104
|
+
type: :development
|
105
|
+
prerelease: false
|
106
|
+
version_requirements: !ruby/object:Gem::Requirement
|
107
|
+
requirements:
|
108
|
+
- - ">="
|
109
|
+
- !ruby/object:Gem::Version
|
110
|
+
version: '0'
|
111
|
+
- !ruby/object:Gem::Dependency
|
112
|
+
name: pry
|
113
|
+
requirement: !ruby/object:Gem::Requirement
|
114
|
+
requirements:
|
115
|
+
- - ">="
|
116
|
+
- !ruby/object:Gem::Version
|
117
|
+
version: '0'
|
118
|
+
type: :development
|
119
|
+
prerelease: false
|
120
|
+
version_requirements: !ruby/object:Gem::Requirement
|
121
|
+
requirements:
|
122
|
+
- - ">="
|
123
|
+
- !ruby/object:Gem::Version
|
124
|
+
version: '0'
|
125
|
+
- !ruby/object:Gem::Dependency
|
126
|
+
name: pry-byebug
|
127
|
+
requirement: !ruby/object:Gem::Requirement
|
128
|
+
requirements:
|
129
|
+
- - ">="
|
130
|
+
- !ruby/object:Gem::Version
|
131
|
+
version: '0'
|
132
|
+
type: :development
|
133
|
+
prerelease: false
|
134
|
+
version_requirements: !ruby/object:Gem::Requirement
|
135
|
+
requirements:
|
136
|
+
- - ">="
|
137
|
+
- !ruby/object:Gem::Version
|
138
|
+
version: '0'
|
139
|
+
description: "\n A Middleman extension to automatically generate VCards based on
|
140
|
+
provided\n configurations.\n This is particularly useful in contacts pages
|
141
|
+
to create a vcard button.\n "
|
142
|
+
email: molari.alessandro@gmail.com
|
143
|
+
executables: []
|
144
|
+
extensions: []
|
145
|
+
extra_rdoc_files: []
|
146
|
+
files:
|
147
|
+
- ".document"
|
148
|
+
- ".gitignore"
|
149
|
+
- ".rspec"
|
150
|
+
- ".ruby-version"
|
151
|
+
- ".yardopts"
|
152
|
+
- ChangeLog.md
|
153
|
+
- Gemfile
|
154
|
+
- Gemfile.lock
|
155
|
+
- LICENSE
|
156
|
+
- README.md
|
157
|
+
- Rakefile
|
158
|
+
- lib/middleman-vcard.rb
|
159
|
+
- lib/middleman-vcard/extension.rb
|
160
|
+
- lib/middleman-vcard/generator.rb
|
161
|
+
- lib/middleman-vcard/version.rb
|
162
|
+
- lib/middleman_extension.rb
|
163
|
+
- middleman-vcard.gemspec
|
164
|
+
- spec/middleman-vcard_version_spec.rb
|
165
|
+
- spec/spec_helper.rb
|
166
|
+
homepage: https://rubygems.org/gems/middleman-vcard
|
167
|
+
licenses:
|
168
|
+
- Apache License Version 2.0
|
169
|
+
metadata: {}
|
170
|
+
post_install_message:
|
171
|
+
rdoc_options: []
|
172
|
+
require_paths:
|
173
|
+
- lib
|
174
|
+
required_ruby_version: !ruby/object:Gem::Requirement
|
175
|
+
requirements:
|
176
|
+
- - ">="
|
177
|
+
- !ruby/object:Gem::Version
|
178
|
+
version: '0'
|
179
|
+
required_rubygems_version: !ruby/object:Gem::Requirement
|
180
|
+
requirements:
|
181
|
+
- - ">="
|
182
|
+
- !ruby/object:Gem::Version
|
183
|
+
version: '0'
|
184
|
+
requirements: []
|
185
|
+
rubyforge_project:
|
186
|
+
rubygems_version: 2.2.2
|
187
|
+
signing_key:
|
188
|
+
specification_version: 4
|
189
|
+
summary: Middleman extension to generate VCards
|
190
|
+
test_files:
|
191
|
+
- spec/middleman-vcard_version_spec.rb
|
192
|
+
- spec/spec_helper.rb
|
193
|
+
has_rdoc:
|