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

blog_helper 0.0.5prerelease → 0.0.5

Files changed (7) hide show

data/LICENSE CHANGED Viewed

@@ -1,6 +1,6 @@
 == BlogHelper
-Copyright (c) 2010 Sven Kräuter
+Copyright (c) 2010 Sven Kräuter sven.kraeuter@gmx.net
  Permission is hereby granted, free of charge, to any person obtaining a copy
  of this software and associated documentation files (the "Software"), to deal

data/README.md ADDED Viewed

@@ -0,0 +1,42 @@
+# BlogHelper
+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.
+## Features
+- tag your posts
+- use seo friendly page titles
+- use the disqus comment counter
+- a workaround for seriuous allowing you to use generic yaml fields
+## Installation
+It's a piece of cake: just use the `gem` tool to get going with the _blog_helper_: `sudo gem install blog_helper`
+If you want to use features that rely on accessing the http requests like the _tag_ feature, you'll need to use the [_toto_prerelease_](http://github.com/5v3n/toto).
+Please follow the instrucions there to do so.
+## Usage
+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.
+For example, to use seo friendly titles, your layout.rhtml should be looking like this:
+    <!doctype html>
+    <html>
+      <head>
+        <% require 'blog_helper'
+           page_title = BlogHelper::generate_title(@path, title, 'yourSitesTitle.com')
+        %>
+    .
+    .
+    .
+        <title><%=  page_title %></title>
+        <link rel="alternate" type="application/atom+xml" title="<%= page_title %> - feed" href="/index.xml" />
+    .
+    .
+    .

data/Rakefile CHANGED Viewed

@@ -12,16 +12,16 @@ require 'rake/testtask'
 spec = Gem::Specification.new do |s|
   s.name = 'blog_helper'
-  s.version = '0.0.5prerelease'
+  s.version = '0.0.5'
   s.has_rdoc = true
-  s.extra_rdoc_files = ['README', 'LICENSE']
+  s.extra_rdoc_files = ['README.md', 'LICENSE']
   s.summary = 'Some handy helpers for serious, toto and the likes...'
   s.description = s.summary
   s.author = 'Sven Kräuter'
   s.email = 'sven.krauter@gmx.net'
-  s.homepage = 'http://5v3n.com'
+  s.homepage = 'http://github.com/5v3n/blog_helper'
   # s.executables = ['your_executable_here']
-  s.files = %w(LICENSE README Rakefile) + Dir.glob("{bin,lib,spec}/**/*")
+  s.files = %w(LICENSE README.md Rakefile) + Dir.glob("{bin,lib,spec}/**/*")
   s.require_path = "lib"
   s.bindir = "bin"
 end
@@ -33,7 +33,7 @@ Rake::GemPackageTask.new(spec) do |p|
 end
 Rake::RDocTask.new do |rdoc|
-  files =['README', 'LICENSE', 'lib/**/*.rb']
+  files =['README.md', 'LICENSE', 'lib/**/*.rb']
   rdoc.rdoc_files.add(files)
   rdoc.main = "README" # page to start on
   rdoc.title = "BlogHelper Docs"

data/lib/blog_helper.rb CHANGED Viewed

@@ -1,31 +1,43 @@
-# Some useful feature for serious, toto and the likes.
-class BlogHelper
-  # create a list of links to tagged articles, default link_format: <a href=/tagged?tag=&+tag+%& >#{tag}</a>
-  def create_tag_link_list(csv_string)
+# 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>
+  def BlogHelper.tag_link_list(csv_string)
     # read csv-string into array
-    tag_list = process_to_array(csv_string)
+    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 process_to_array(csv_string)
-    if csv_string
+  def BlogHelper.csv_to_array(csv_string)
       #split & handle forgotten spaces after the separator. then flatten the multidemnsional array:
-      result = csv_string.split(', ').map{ |e| e.split(',')}.flatten
-    end
+      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 BlogHelper.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
-=begin
-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: <a href="http://example.com/my_article.html#disqus_thread">Comments</a>  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)
-=end
-  def disqus_comment_count_js(disqus_shortname)
+#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">
       var disqus_shortname = '#{disqus_shortname}';

data/lib/serious_blog_helper.rb CHANGED Viewed

@@ -1,8 +1,7 @@
-# To change this template, choose Tools | Templates
-# and open the template in the editor.
+# extension to BlogHelper with special methods for serious
 require 'blog_helper'
-class SeriousBlogHelper < BlogHelper
-  def tags_from_article(article=nil)
+module SeriousBlogHelper
+  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

metadata CHANGED Viewed

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: blog_helper
 version: !ruby/object:Gem::Version
-  hash: -2135978552
-  prerelease: true
+  hash: 21
+  prerelease: false
   segments:
   - 0
   - 0
-  - 5prerelease
-  version: 0.0.5prerelease
+  - 5
+  version: 0.0.5
 platform: ruby
 authors:
 - "Sven Kr\xC3\xA4uter"
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
-date: 2010-07-08 00:00:00 +02:00
+date: 2010-07-11 00:00:00 +02:00
 default_executable:
 dependencies: []
@@ -26,16 +26,16 @@ executables: []
 extensions: []
 extra_rdoc_files:
-- README
+- README.md
 - LICENSE
 files:
 - LICENSE
-- README
+- README.md
 - Rakefile
 - lib/blog_helper.rb
 - lib/serious_blog_helper.rb
 has_rdoc: true
-homepage: http://5v3n.com
+homepage: http://github.com/5v3n/blog_helper
 licenses: []
 post_install_message:
@@ -55,14 +55,12 @@ required_ruby_version: !ruby/object:Gem::Requirement
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
-  - - ">"
+  - - ">="
     - !ruby/object:Gem::Version
-      hash: 25
+      hash: 3
       segments:
-      - 1
-      - 3
-      - 1
-      version: 1.3.1
+      - 0
+      version: "0"
 requirements: []
 rubyforge_project:

data/README DELETED Viewed

@@ -1,9 +0,0 @@
-== BlogHelper
-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.
-=== Features
-TBD...