middleman-vcard 0.9.4 → 0.9.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b3553d5c6bf1a2ded3217b153123c099a47135cf
-  data.tar.gz: 9369d6e35c79e36cea3b52b1918a7c6a8493e4ff
+  metadata.gz: 016ad9675883061008940aaa133aabf3f67daf3e
+  data.tar.gz: 1e468b390d3f02a810360eee0f50b54ca829902e
 SHA512:
-  metadata.gz: 5cb3729448e003ed92500a59b6369e39d4fd4614dd5dbb8c6fa02b64d78688bfa29561583d9e2b57f032fa20cafdfe38ed59e10cc0a03c124d4031ef281b3eae
-  data.tar.gz: e427776f03d9d5461247b99ca41ea5e99cd53eba204c983c7b640780ed78fd9bcec92a8b40189ac45069fd109ab0c9afb14784f4dd0cbd5fcaf7f1cf3f8b140e
+  metadata.gz: 2cbdb63e07c186b29f6a3df992401b0247d10632584e75fd5b3cb91e5111cdf65ffd8ad562343cfa3a4bbaeeec89da8aba65027699ab45449b47d1d239d31d26
+  data.tar.gz: f6dc531c0cc9dd29280616dcc18bed5e41ce60c78d5b9cbec7ad79a0f30211fb1d15e2787ffd86085027aa970f93787a5f0d084dc2235f0eeeb487b0adda7cee

data/ChangeLog.md

@@ -1,5 +1,10 @@
 # ChangeLog
 
+## 0.9.5 (Feb 25, 2015)
+
+* Code smells.
+* Better documentation.
+
 ## 0.9.4 (Feb 25, 2015)
 
 * Code smells.

data/Gemfile.lock

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

data/README.md

@@ -7,8 +7,8 @@
 
 ## Project informations
 
-* [Homepage](https://rubygems.org/gems/middleman-vcard)
 * [Documentation](http://rubydoc.info/gems/middleman-vcard/frames)
+* [RubyGems Homepage](https://rubygems.org/gems/middleman-vcard)
 * [Email](mailto:molari.alessandro@gmail.com)
 
 ## Description

data/Rakefile

@@ -15,8 +15,10 @@ require "yard"
 require "middleman-vcard"
 
 
+# Include RSpec tasks.
 RSpec::Core::RakeTask.new
 
+# Include YARD tasks.
 YARD::Rake::YardocTask.new
 
 desc "Open a console preloaded with middleman-vcard."
@@ -24,4 +26,5 @@ task :console do
   sh "pry --gem", verbose: false
 end
 
+# The default task.
 task default: [:spec]

data/lib/middleman-vcard/extension.rb

@@ -17,6 +17,9 @@ module Middleman
 
       option :dst_path, nil, "The destination path for the generated VCard"
 
+      ##
+      # Create the VCardExtension.
+      #
       def initialize(app, options_hash={}, &block)
         super
 
@@ -54,6 +57,10 @@ module Middleman
         app.config.define_setting :vcard_dir_path,  @vcard_dir_path.to_s
       end
 
+      ##
+      # After Middleman has been configured (i.e. build, console, server, etc..)
+      # generate the VCard.
+      #
       def after_configuration
         @vcard_generator.generate(@vcard_dir_path.join(@vcard_file_name))
       end

data/lib/middleman-vcard/generator.rb

@@ -116,15 +116,32 @@ module Middleman
 
       protected
 
+      ##
+      # Log the provided error message and raise an error.
+      #
+      # @param msg [String] The error message.
+      #
       def error(msg)
         @logger.error(format_msg(msg))
         fail("Middleman VCard generator failed")
       end
 
+      ##
+      # Log the provided informative message.
+      #
+      # @param msg [String] The informative message.
+      #
       def info(msg)
         @logger.info(format_msg(msg))
       end
 
+      ##
+      # Format the provided message.
+      #
+      # @param msg [String] The message to be formatted.
+      #
+      # @return The formatted message.
+      #
       def format_msg(msg)
         "[VCard] #{msg}"
       end

data/lib/middleman-vcard/version.rb

@@ -1,10 +1,24 @@
 module Middleman
   module VCard
 
+    ##
+    # The current major version.
+    #
     VERSION_MAJOR = 0
+
+    ##
+    # The current minor version.
+    #
     VERSION_MINOR = 9
-    VERSION_PATCH = 4
 
+    ##
+    # The current patch version.
+    #
+    VERSION_PATCH = 5
+
+    ##
+    # The version string, following the semvers conventions.
+    #
     VERSION = "#{VERSION_MAJOR}.#{VERSION_MINOR}.#{VERSION_PATCH}"
 
   end

data/lib/middleman-vcard.rb

@@ -20,6 +20,8 @@ require "middleman-core"
 require "middleman-vcard/version"
 require "middleman-vcard/generator"
 
+# Register the extension with name: `:vcard` and lazily require the related
+# module (the module containing the Middleman extension).
 Middleman::Extensions.register(:vcard) do
   require "middleman-vcard/extension"
   Middleman::VCard::VCardExtension

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: middleman-vcard
 version: !ruby/object:Gem::Version
-  version: 0.9.4
+  version: 0.9.5
 platform: ruby
 authors:
 - Alessandro Molari