kijkwijzer 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d46482dd02faba6d2f5422c77e484b64f278b0ad
-  data.tar.gz: 871676e2e0f24d2384c999a30986c700aa6b9e3b
+  metadata.gz: b209b4c4e789335dcd55660460babce377f4dd8f
+  data.tar.gz: c11814b1549ea455d10f4ee15b2c093265e0bb3c
 SHA512:
-  metadata.gz: 012d3b63a93715a25609e1a78bdf240179996369410fff567a83c96a57d6bd5b819f376ce8c37979672df88c89ddf7b527792369a16e365da6e2eda87af1287d
-  data.tar.gz: ecbb6aaa3b138e409dd64ac916a23ca62d8a824e5713109d04a01de593dcb03d519b38c0ddc8ef7c649c8008cf70125582333031609b6af4121fecb7869f4b68
+  metadata.gz: f17b634e82c6c35959fe0ec7119a90b93355833cf19b5d55889965473be69d694f593ddae152f0b5c2c302de3a8e60a7d3d0275db05bf38546bddd23b3db23cb
+  data.tar.gz: 0288bf24e007af2f6d682f0d95c748afd26494ca4d00ae7c1ea79a6087c93f6c3cf35d71686dc013c8008ec13434d85ec7e5282ce91bac82ebff57be0d2eba53

data/lib/kijkwijzer/result.rb

@@ -5,6 +5,9 @@ module Kijkwijzer
     attr_accessor :year
     attr_accessor :ratings
 
+    # Get the ratings for the result
+    #
+    # @return [String] with kijkwijzer-ratings (English-language-labels)
     def ratings
       @ratings.collect do |rating|
         rating = rating.to_s.downcase

data/lib/kijkwijzer/version.rb

@@ -1,3 +1,3 @@
 module Kijkwijzer
-  VERSION = "0.1.0"
+  VERSION = "0.1.1"
 end

data/lib/kijkwijzer/view_helpers.rb

@@ -1,16 +1,31 @@
 module Kijkwijzer
+
+  # ViewHelpers for Rails
   module ViewHelpers
+
+    # Renders the SVG definitions with all Kijkwijzer icons. To be placed somewhere in the top of your body,
+    # for optimal compatibility
+    #
+    # @return String html-string, made html_safe if ActiveSupport is defined.
     def render_kijkwijzer_svg_definitions
       svg_txt = File.open(open(File.join(File.dirname(__FILE__),'..','kijkwijzer.svg'))).read
       svg_txt = svg_txt.html_safe if defined?(ActiveSupport)
       svg_txt
     end
-    def render_kijkwijzers result
-      result_svgs = ""
-      result.ratings.each do |rating|
-        result_svgs+="<div class=\"kijkwijzer icons\"><svg viewBox=\"0 0 100 100\" class=\"icon kijkwijzer_#{rating}\" title=\"#{rating}\" ><use xlink:href=\"#kijkwijzer_base\"></use><use xlink:href=\"#kijkwijzer_#{rating}\"></use></svg></div>"
+
+    # Renders a div block with svg elements that references the definition as defined by #render_kijkwijzer_svg_definitions
+    #
+    # rating_result is an actual Kijkwijzer::Result or an array of ratings similar to the result of Result#ratings
+    # @return String html-string, made html_safe if ActiveSupport is defined.
+    def render_kijkwijzers rating_result
+      result_svgs = "<div class=\"kijkwijzer icons\">"
+      if rating_result.is_a? Kijkwijzer::Result
+        rating_result = rating_result.ratings
       end
-      result_svgs
+      rating_result.each do |rating|
+        result_svgs+="<svg viewBox=\"0 0 100 100\" class=\"icon kijkwijzer_#{rating}\" title=\"#{rating}\"><use xlink:href=\"#kijkwijzer_base\"></use><use xlink:href=\"#kijkwijzer_#{rating}\"></use></svg>"
+      end
+      result_svgs += "</div>"
       result_svgs = result_svgs.html_safe if defined?(ActiveSupport)
       result_svgs
     end

data/lib/kijkwijzer.rb

@@ -13,6 +13,10 @@ module Kijkwijzer
     def get_content(search)
       Nokogiri::HTML(open(search_url(search)))
     end
+
+    # Search the Kijkwijzer database
+    #
+    # @return [Kijkwijzer::Result]
     def search(search, filter={})
       res = get_content(search)
       results = []

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: kijkwijzer
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Maarten Brouwers
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2015-07-20 00:00:00.000000000 Z
+date: 2015-07-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: nokogiri