RubyGems - blog_helper - Versions diffs - 0.0.5 → 0.0.8 - Mend

blog_helper 0.0.5 → 0.0.8

Files changed (4) hide show

data/README.md CHANGED Viewed

@@ -9,7 +9,7 @@ This a a collection of tools usable in both platforms.
 - tag your posts
 - use seo friendly page titles
 - use the disqus comment counter
-- a workaround for seriuous allowing you to use generic yaml fields
+- a workaround for serious allowing you to use generic yaml fields
 ## Installation
@@ -23,6 +23,7 @@ Please follow the instrucions there to do so.
 Piece of cake, again: all you have to do is use `<% require 'blog_helper'%>` in your .rhtml or .erb file and call the corresponding methods.
+### SEO friendly titles
 For example, to use seo friendly titles, your layout.rhtml should be looking like this:
@@ -30,7 +31,7 @@ For example, to use seo friendly titles, your layout.rhtml should be looking lik
     <html>
       <head>
         <% require 'blog_helper'
-           page_title = BlogHelper::generate_title(@path, title, 'yourSitesTitle.com')
+           page_title = BlogHelper::seo_friendly_title(@path, title, 'yourSitesTitle.com')
         %>
     .
     .
@@ -40,3 +41,86 @@ For example, to use seo friendly titles, your layout.rhtml should be looking lik
     .
     .
     .
+### Tags
+Adding the tagging feature requires the _toto_prerelease_ as mentioned above, since we need the http request to apply our little hack.
+To add a list of tags to your article, just use a custom yaml attribute:
+    title: The Wonderful Wizard of Oz
+    author: Lyman Frank Baum
+    date: 1900/05/17
+    tags: hacks, love, rock 'n' roll
+    Dorothy lived in the midst of the great Kansas prairies, with Uncle Henry,
+    who was a farmer, and Aunt Em, who was the farmer's wife.
+Next, you need a place to show the tag links, for example the index.rhtml:
+    <section id="articles">
+      <% require 'blog_helper' %>
+      <% for article in articles[0...10] %>
+        <article class="post">
+          <header>
+            <h1><a href="<%= article.path %>"><%= article.title %></a></h1>
+            <span class="descr"><%= article.date %></span><% 10.times { %>&nbsp;<%}%>
+            <span class="tags">
+                <%= BlogHelper::tag_link_list(article[:tags])  %>
+            </span><% 10.times { %>&nbsp;<%}%>
+    .
+    .
+    .
+And again: piece of caked ;-). Now all we need to add is a page that displays articles belonging to a ceratin tag:
+Create a page called `tagged.rhtml` in your `templates/pages` directory that looks like this:
+    <%#
+    # search given tags...
+    %>
+    <%
+     require 'cgi'
+     require 'blog_helper'
+     desired_tag = env["QUERY_STRING"]
+       if desired_tag
+         start = desired_tag.index("=")
+         stop = desired_tag.index("&")
+         stop = 0 unless stop
+         desired_tag = desired_tag[start+1..stop-1]
+         desired_tag = CGI::unescape(desired_tag)
+       end
+    %>
+    <h1>Posts filed under '<%= desired_tag %>': </h1>
+    <ul>
+    <% @articles.select do |a|
+      tags = BlogHelper::csv_to_array(a[:tags])
+      tags.include?(desired_tag) if tags
+    end.each do |article| %>
+      <li>
+        <span class="descr"><a href="<%= article.path %>" alt="<%= article.title %>"><%= article.title %></a><br/></span>
+      </li>
+    <% end %>
+    </ul>
+    <br/>
+Now, you did most likely implement a tag listing on your toto blog. Congrats!
+BTW: part of my to dos is encapsulating the tag parsing process so you won't have to fiddle around with too much ruby code here...
+### shor url (via bit.ly)
+    short_url = BlogHelper::short_url_bitly(<url>, <bit.ly login nam>, <bit.ly api key>)
+### disqus comment counter
+TBD... I have to refer to the source & ri for now.
+### serious custom yaml field reader
+TBD... I have to refer to the source & ri for now.

data/Rakefile CHANGED Viewed

@@ -12,7 +12,7 @@ require 'rake/testtask'
 spec = Gem::Specification.new do |s|
   s.name = 'blog_helper'
-  s.version = '0.0.5'
+  s.version = '0.0.8'
   s.has_rdoc = true
   s.extra_rdoc_files = ['README.md', 'LICENSE']
   s.summary = 'Some handy helpers for serious, toto and the likes...'

data/lib/blog_helper.rb CHANGED Viewed

@@ -1,3 +1,8 @@
+require 'cgi'
+require 'net/http'
+require 'uri'
 # Some useful feature for serious, toto and the likes. Basically, any ruby based blog or site.
 module BlogHelper
   # create a list of links to tagged articles, default link_format: <code>%&amp;&lt;a href=&quot;/tagged?tag=#{tag}&quot; alt=&quot;articles concerning #{tag}&quot; &gt;#{tag}&lt;/a&gt; &amp;</code>
@@ -29,14 +34,13 @@ module BlogHelper
       end
       page_title
   end
-#Generates javascript to include to the bottom of your index page.
-#Appending '#disqus_thread' to the end of permalinks will replace the text of these links with the comment count.
-#
-#For example, you may have a link with this HTML: <code>&lt;a href=&quot;http://example.com/my_article.html#disqus_thread&quot;&gt;Comments&lt;/a&gt; </code>  The comment count code will replace the text "Comments" with the number of comments on the page
-#
-#(see http://disqus.com/comments/universal/ for details)
-#
+  #Generates javascript to include to the bottom of your index page.
+  #Appending '#disqus_thread' to the end of permalinks will replace the text of these links with the comment count.
+  #
+  #For example, you may have a link with this HTML: <code>&lt;a href=&quot;http://example.com/my_article.html#disqus_thread&quot;&gt;Comments&lt;/a&gt; </code>  The comment count code will replace the text "Comments" with the number of comments on the page
+  #
+  #(see http://disqus.com/comments/universal/ for details)
+  #
   def BlogHelper.disqus_comment_count_js(disqus_shortname)
     %&
       <script type="text/javascript">
@@ -50,4 +54,13 @@ module BlogHelper
     & if disqus_shortname
   end
+  # Retrieve bit.ly shortened url
+  def BlogHelper.short_url_bitly(url, login, api_key)
+    if api_key != "" && login != ""
+      rest_call=%{http://api.bit.ly/v3/shorten?login=#{login}&apikey=#{api_key}&longUrl=#{url}&format=txt}
+      Net::HTTP::get(URI.parse(rest_call))
+    else
+      url #fallback: return url to shorten - or nil if it isn't set
+    end
+  end
 end

metadata CHANGED Viewed

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: blog_helper
 version: !ruby/object:Gem::Version
-  hash: 21
+  hash: 15
   prerelease: false
   segments:
   - 0
   - 0
-  - 5
-  version: 0.0.5
+  - 8
+  version: 0.0.8
 platform: ruby
 authors:
 - "Sven Kr\xC3\xA4uter"
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
-date: 2010-07-11 00:00:00 +02:00
+date: 2010-07-16 00:00:00 +02:00
 default_executable:
 dependencies: []