middleman-vcard 0.9.2 → 0.9.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: accb51fb50ad5aba7e07a47c5d562fc25473208d
-  data.tar.gz: 8de40cf605f39d8f0f5b83b6998415dcacfb9244
+  metadata.gz: 2700232cd047ae2fe262f314fca0a0aaaeb23f97
+  data.tar.gz: 723f3e18df4b22c709180e6b7fb58cebe6e3fd9f
 SHA512:
-  metadata.gz: fe38cfd1a0ded059578e32e09c8dd1db7c6af0e6a4525042af8927fc3a8f1195a179116b2d9d888ce19aec31ab8750fc49581cc8d43354829fcbd820bb82a614
-  data.tar.gz: d969dc8c89f724cf5a859b47460f73190945fee6d1946216781fdc359d827bc49fe4d47cfb51eda608c00fa89a6e0fb4e71056061aab7e85b7fb7915bf433f02
+  metadata.gz: 9ef6a29081308a68e27a5b8a8ae7864106c4d5d7109b79510bf01fe4905851217aa29ce112671eb0e5fe4001d76353258f9a78ca8b4f72d4f4a60311f0bb4de9
+  data.tar.gz: 1ab1de88797271265f37843514e628b916e0928641e406541dce3b560f365a70ceb77e7b43d194c2380b8621e1fd53e2275b6df58565476600f82994702a8566

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    middleman-vcard (0.9.2)
+    middleman-vcard (0.9.3)
       contracts
       middleman-core (>= 3.3.10)
       vpim

data/README.md

@@ -1,25 +1,81 @@
 # Middleman VCard
 
+![Status](http://img.shields.io/badge/status-OK-green.svg)
+
+## Project informations
+
 * [Homepage](https://rubygems.org/gems/middleman-vcard)
 * [Documentation](http://rubydoc.info/gems/middleman-vcard/frames)
 * [Email](mailto:molari.alessandro@gmail.com)
 
 ## Description
 
-Middleman extension to generate a VCard during the `build` phase.
+A Middleman extension to generate VCards and provide useful helpers to work
+with.
 
 ## Usage
 
 Include the `middleman-vcard` gem in your Gemfile:
+
 ```Ruby
 gem 'middleman-vcard'
 ```
 
 Add the following code to your `config.rb` file:
+
 ```Ruby
-activate :vcard
+require "middleman-vcard"
+activate :vcard,
+  name: data.site.vcard.name,
+  emails: [{
+    email:     data.site.vcard.email,
+    preferred: true,
+    location:  "work"
+  }],
+  phones: [{
+    number:     data.site.vcard.phone,
+    preferred:  true,
+    location:   "work",
+    capability: ["voice", "video", "msg"]
+  }],
+  addresses: [{
+    preferred:  true,
+    location:   "work",
+    postalcode: data.site.vcard.postalcode.to_s,
+    locality:   data.site.vcard.city,
+    region:     data.site.vcard.province,
+    country:    data.site.vcard.country
+  }],
+  photo: {
+    path: File.join(root, config.source, config.images_dir, "logo-vcard.jpg"),
+    type: "jpeg"
+  }
 ```
 
+Of course you can organize your data as you want and choose what to include 
+in your data files or directly in your config file.
+
+Also, *you can pass multiple phones, addresses, emails*.
+
+Now the VCard file will be automatically generated :D
+
+### Helpers:
+
+Usually you need to include your VCard in HTML, so there are some helpers
+already defined:
+
+#### `vcard_link`
+
+*Generate a link tag that points to the VCard*.
+
+Details [here](./lib/middleman-vcard/extension.rb#L91).
+
+#### `vcard_path`
+
+*Build the path that points to the VCard file*.
+
+Details [here](./lib/middleman-vcard/extension.rb#L72).
+
 ## Contributors
 
 Many thanks to Luca Molari (LMolr)!!

data/lib/middleman-vcard/extension.rb

@@ -1,31 +1,97 @@
+require "pathname"
+
+
 module Middleman
   module VCard
     ##
-    # A Middleman extension to generate VCards.
+    # A Middleman extension to generate VCards and provide useful helpers to
+    # work with.
     #
     class VCardExtension < Middleman::Extension
 
-      option :name,      nil, "The VCard name" # TODO: It should be required.
+      option :name,      nil, "The VCard name", required: true
       option :emails,    [],  "The VCard emails"
       option :phones,    [],  "The VCard telephones"
       option :addresses, [],  "The VCard addresses"
       option :photo,     nil, "The VCard photo"
 
-      option :destination_path, nil, "Destination path for the generated VCard"
+      option :dst_path, nil, "The destination path for the generated VCard"
 
       def initialize(app, options_hash={}, &block)
         super
 
-        @destination_path = options_hash[:destination_path] ||
-            File.join(app.root, app.config.source, "#{options_hash[:name]}.vcf")
+        @name      = options_hash[:name]
+        @emails    = options_hash[:emails]
+        @phones    = options_hash[:phones]
+        @addresses = options_hash[:addresses]
+        @photo     = options_hash[:photo]
+
+        @dst_path = options_hash[:dst_path]
+
+        source_dir_path = Pathname.new(app.root).join(app.config.source)
+
+        if @dst_path
+          unless @dst_path.start_with?(source_dir_path.to_s)
+            error("Invalid `dst_path`. It's not inside the source folder.")
+          end
+          @vcard_dir_path  = Pathname.new(File.dirname(@dst_path))
+          @vcard_file_name = File.basename(@dst_path)
+        else
+          @vcard_dir_path  = source_dir_path
+          @vcard_file_name = "#{@name}.vcf"
+        end
+
         @vcard_generator  = Middleman::VCard::Generator.new(
-            options_hash[:name], options_hash[:emails],
-            options_hash[:phones], options_hash[:addresses],
-            options_hash[:photo], logger)
+            @name, @emails, @phones, @addresses, @photo, logger)
+
+        # Define some config used later
+        #
+        # NOTE: We want to be consistent with Middleman conventions, so
+        #       `vcard_dir_path` is a `String` because all Middleman paths are
+        #       `String`s.
+        app.config.define_setting :vcard_name,      @name
+        app.config.define_setting :vcard_file_name, @vcard_file_name
+        app.config.define_setting :vcard_dir_path,  @vcard_dir_path.to_s
       end
 
       def after_configuration
-        @vcard_generator.generate(@destination_path)
+        @vcard_generator.generate(@vcard_dir_path.join(@vcard_file_name))
+      end
+
+      helpers do
+
+        ##
+        # Build the path that points to the VCard file.
+        #
+        # @note The generated path is meant to be used in `href`s or similar
+        #       (is relative to the source or build directory). It's not meant
+        #       to be directly used for filesystem access.
+        #
+        # @return The path for the VCard file.
+        #
+        def vcard_path
+          # Find the VCard prefix path, which is relative to the source
+          # directory because that's the root path that will be served and built
+          # by Middleman.
+          prefix = Pathname.new(config.vcard_dir_path).relative_path_from(
+              Pathname.new(root).join(config.source))
+
+          "#{prefix}/#{config.vcard_file_name}"
+        end
+
+        ##
+        # Generate a link tag that points to the VCard.
+        #
+        # @param title [String|nil] The link title.
+        #                           If `nil`, the VCard name will be used.
+        # @param kwargs [Hash] The keyword arguments to be passed into `link_to`
+        #
+        # @return [String] The generated HTML link tag.
+        #
+        def vcard_link(title=nil, **kwargs)
+          link_to(title || config.vcard_name, vcard_path, kwargs)
+        end
+
       end
 
     end

data/lib/middleman-vcard/generator.rb

@@ -118,7 +118,7 @@ module Middleman
 
       def error(msg)
         @logger.error(format_msg(msg))
-        # TODO: Raise error.
+        fail("Middleman VCard generator failed")
       end
 
       def info(msg)

data/lib/middleman-vcard/version.rb

@@ -3,7 +3,7 @@ module Middleman
 
     VERSION_MAJOR = 0
     VERSION_MINOR = 9
-    VERSION_PATCH = 2
+    VERSION_PATCH = 3
 
     VERSION = "#{VERSION_MAJOR}.#{VERSION_MINOR}.#{VERSION_PATCH}"
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: middleman-vcard
 version: !ruby/object:Gem::Version
-  version: 0.9.2
+  version: 0.9.3
 platform: ruby
 authors:
 - Alessandro Molari
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-02-24 00:00:00.000000000 Z
+date: 2015-02-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: middleman-core