RubyGems - bao-karakuri - Versions diffs - 0.1.2 - Mend

bao-karakuri 0.1.2

Files changed (6) hide show

data/LICENSE ADDED Viewed

@@ -0,0 +1,22 @@
+== Karakuri
+Copyright (c) 2010 Sven Kraeuter mail@5v3n.com
+ Permission is hereby granted, free of charge, to any person obtaining a copy
+ of this software and associated documentation files (the "Software"), to deal
+ in the Software without restriction, including without limitation the rights
+ to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ copies of the Software, and to permit persons to whom the Software is
+ furnished to do so, subject to the following conditions:
+ The above copyright notice and this permission notice shall be included in
+ all copies or substantial portions of the Software.
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+ THE SOFTWARE.

data/README.md ADDED Viewed

@@ -0,0 +1,131 @@
+# Karakuri
+Having a closer look at ruby based blogging platforms like [serious](http://github.com/colszowka/serious) and [toto](http://cloudhead.io/toto), I missed some functionality.
+This a a collection of tools usable in both platforms. The project was formerly known as blog_helper, but Karakuri is a far more suitable name & will be used from now on.
+## Features
+- tag your posts
+- use seo friendly page titles
+- use the disqus comment counter
+- a workaround for serious allowing you to use generic yaml fields
+## Installation
+It's a piece of cake: just install the gem. Simply add `gem 'karakuri'` to your Gemfile or use `sudo gem install karakuri` to get going.
+For a default karakuri powered toto template, check out [dorothy's sister karathy](https://github.com/5v3n/karathy).
+## Usage
+Piece of cake, again: all you have to do is use `<% require 'karakuri'%>` 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:
+    <!doctype html>
+    <html>
+      <head>
+        <% require 'karakuri'
+           page_title = Karakuri::seo_friendly_title(@path, title, 'yourSitesTitle.com')
+        %>
+        <title><%=  page_title %></title>
+        <link rel="alternate" type="application/atom+xml" title="<%= page_title %> - feed" href="/index.xml" />
+    .
+    .
+    .
+### 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 'karakuri' %>
+      <% 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">
+                <%= Karakuri::tag_link_list(article[:tags])  %>
+            </span><% 10.times { %>&nbsp;<%}%>
+    .
+    .
+    .
+And again: piece of cake ;-). 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:
+    <%
+     require 'karakuri'
+     desired_tag = Karakuri::desired_tag(env["QUERY_STRING"])
+    %>
+    <h1>Posts filed under '<%= desired_tag %>': </h1>
+    <ul>
+    <% Karakuri::desired_articles(@articles, desired_tag).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!
+### Tag Cloud
+Example usage:
+    <ul>
+        <li class="nav-header">Tags</li>
+        <%  Karakuri::tag_cloud(@articles).each do |tag, freq| %>
+            <% size = (10 * freq) %>
+            <li style="font-size:<%= size %>px"><%= tag %></li>
+        <% end %>
+    </ul>
+### short url (via bit.ly)
+To use a bit.ly shortened URL, just call the followin function inside a .rhtml file:
+    <%= Karakuri::short_url_bitly(<url>, <bit.ly login name>, <bit.ly api key>) %>
+### disqus comment counter
+Basically just adds the necessary java script to enable the disqus comment counter. For best performance, place it near the end of the page:
+        <%= Karakuri::disqus_comment_count_js(@config[:disqus]) %>
+      </body>
+    </html>
+Mind the usage of `@config[:disqus]`, this enables configuration via `config.ru`.
+To access the comment count, use `#disqus_thread` at the end of the permalink to the post & it will be replaced with the disqus comment count:
+    <a href="<%= article.path %>#disqus_thread">&nbsp;</a>
+Will result in the number of comments of the article the permalink posts to.
+### serious custom yaml field reader
+I hacked serious' custom yaml field access (quite dirty hack) - but please refer to the source & ri for that, I don't use serious anymore.

data/Rakefile ADDED Viewed

@@ -0,0 +1,46 @@
+#
+# To change this template, choose Tools | Templates
+# and open the template in the editor.
+require 'rubygems'
+require 'rake'
+require 'rake/clean'
+require 'rake/gempackagetask'
+require 'rake/rdoctask'
+require 'rake/testtask'
+spec = Gem::Specification.new do |s|
+  s.name = 'bao-karakuri'
+  s.version = '0.1.2'
+  s.has_rdoc = true
+  s.extra_rdoc_files = ['README.md', 'LICENSE']
+  s.summary = 'Fork of 5v3n/karakuri - Some handy helpers for toto and the likes...'
+  s.description = s.summary
+  s.author = 'Bao Pham'
+  s.email = 'gbaopham@gmail.com'
+  s.homepage = 'http://github.com/baopham/karakuri'
+  # s.executables = ['your_executable_here']
+  s.files = %w(LICENSE README.md Rakefile) + Dir.glob("{bin,lib,spec}/**/*")
+  s.require_path = "lib"
+  s.bindir = "bin"
+end
+Rake::GemPackageTask.new(spec) do |p|
+  p.gem_spec = spec
+  p.need_tar = true
+  p.need_zip = true
+end
+Rake::RDocTask.new do |rdoc|
+  files =['README.md', 'LICENSE', 'lib/**/*.rb']
+  rdoc.rdoc_files.add(files)
+  rdoc.main = "README.md" # page to start on
+  rdoc.title = "Karakuri Docs"
+  rdoc.rdoc_dir = 'doc/rdoc' # rdoc output folder
+  rdoc.options << '--line-numbers'
+end
+Rake::TestTask.new do |t|
+  t.test_files = FileList['test/**/*.rb']
+end

data/lib/karakuri.rb ADDED Viewed

@@ -0,0 +1,131 @@
+require 'cgi'
+require 'net/http'
+require 'uri'
+#
+# Some useful feature for toto and the likes. Basically, any ruby based blog or site.
+#
+module Karakuri
+  #
+  # 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>
+  #
+  def Karakuri.tag_link_list(csv_string)
+    # read csv-string into array
+    tag_list = csv_to_array(csv_string)
+    if tag_list
+      tag_string = ""
+      #TODO pass a format via parameter
+      tag_list.each { |tag| tag_string << %&<a href="/tagged?tag=#{tag}" alt="articles concerning #{tag}" >#{tag}</a> & }
+    end
+    tag_string
+  end
+  #
+  # processes a csv-string into an array
+  #
+  def Karakuri.csv_to_array(csv_string)
+      #split & handle forgotten spaces after the separator. then flatten the multidemnsional array:
+      csv_string.split(', ').map{ |e| e.split(',')}.flatten if csv_string
+  end
+  #
+  # pass the path (@path for a toto blog) & the desired SEO ending, e.g. the name of your blog.
+  # example for toto: <code>seo_friendly_title(@path, title, "mysite.com") will produce 'subpage | mysite.com' as seo friendly page title.</code>
+  #
+  def Karakuri.seo_friendly_title(path, title, seo_ending)
+    #TODO use custom title separator...
+       if path == 'index'
+        page_title = seo_ending
+       elsif path.split('/').compact.length == 4
+        page_title = title << " | #{seo_ending}"
+       else
+        page_title = path.capitalize.gsub(/[-]/, ' ') << " | #{seo_ending}"
+      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)
+  #
+  def Karakuri.disqus_comment_count_js(disqus_shortname)
+    %&
+      <script type="text/javascript">
+      var disqus_shortname = '#{disqus_shortname}';
+      (function () {
+        var s = document.createElement('script'); s.async = true;
+        s.src = 'http://disqus.com/forums/#{disqus_shortname}/count.js';
+        (document.getElementsByTagName('HEAD')[0] || document.getElementsByTagName('BODY')[0]).appendChild(s);
+      }());
+      </script>
+    & if disqus_shortname
+  end
+  #
+  # Retrieve bit.ly shortened url
+  #
+  def Karakuri.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}
+      begin
+        Net::HTTP::get(URI.parse(rest_call)) # handle http errors (esp. timeouts!)
+      rescue URI::InvalidURIError
+        raise URI::InvalidURIError
+      rescue
+        url#in the case of a web service or HTTP error, we'll just ignore it & return the long url
+      end
+    else
+      url #fallback: return long url if no proper login has been provided. TODO: check if a call w/o login is possible
+    end
+  end
+  #desired articles matching a corresponding tag
+  def Karakuri.desired_articles(articles, tag)
+    if(articles && tag)
+      articles.select do |a|
+        tags = Karakuri::csv_to_array(a[:tags])
+        tags.include?(tag) if tags
+      end
+    end
+  end
+  # extract desired tag from <code>env["QUERY_STRING"]</code> or an equally formed expression, e.g. tag=desired_tag
+  def Karakuri.desired_tag(query_string)
+    if query_string
+      start = query_string.index("tag=")
+      if start
+        start = start + 3
+        stop = query_string.index("&")
+        stop = 0 unless stop
+        desired_tag = query_string[start+1..stop-1]
+        desired_tag = CGI::unescape(desired_tag)
+      else
+        '' #fallback: return empty string to prevent nil errors
+      end
+    end
+  end
+  #
+  # Tag cloud, return a hash of tags and their frequency
+  #
+  def Karakuri.tag_cloud(articles)
+    tag_cloud = {}
+    if(articles)
+      articles.select do |a|
+        tags = csv_to_array(a[:tags])
+        if tags
+            tags.each { |tag|
+                tag_string = %&<a href="/tagged?tag=#{tag}" alt="articles concerning #{tag}" >#{tag}</a>&
+                if tag_cloud.has_key? tag_string
+                    tag_cloud[tag_string] += 1
+                else
+                    tag_cloud[tag_string] = 1
+                end
+            }
+        end
+      end
+    end
+    tag_cloud
+  end
+end

data/lib/serious_blog_helper.rb ADDED Viewed

@@ -0,0 +1,13 @@
+# extension to Karakuri with special methods for serious
+require 'karakuri'
+module SeriousBlogHelper
+  #extract tags from article
+  def SeriousBlogHelper.tags_from_article(article=nil)
+    tags_marker = %&tags"=>&
+    if article && article.inspect.index(tags_marker)
+      tags_start_index=article.inspect.index(tags_marker) + tags_marker.length
+      tags_end_index = article.inspect.index("\"," ,tags_start_index)
+      tags = article.inspect[tags_start_index+1..tags_end_index-1]
+    end
+  end
+end

metadata ADDED Viewed

@@ -0,0 +1,67 @@
+--- !ruby/object:Gem::Specification
+name: bao-karakuri
+version: !ruby/object:Gem::Version
+  prerelease: false
+  segments:
+  - 0
+  - 1
+  - 2
+  version: 0.1.2
+platform: ruby
+authors:
+- Bao Pham
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2012-03-22 00:00:00 -07:00
+default_executable:
+dependencies: []
+description: Fork of 5v3n/karakuri - Some handy helpers for toto and the likes...
+email: gbaopham@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files:
+- README.md
+- LICENSE
+files:
+- LICENSE
+- README.md
+- Rakefile
+- lib/karakuri.rb
+- lib/serious_blog_helper.rb
+has_rdoc: true
+homepage: http://github.com/baopham/karakuri
+licenses: []
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      segments:
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      segments:
+      - 0
+      version: "0"
+requirements: []
+rubyforge_project:
+rubygems_version: 1.3.6
+signing_key:
+specification_version: 3
+summary: Fork of 5v3n/karakuri - Some handy helpers for toto and the likes...
+test_files: []