spree_simple_blog 3.0.1

data/README.markdown

@@ -0,0 +1,6 @@
+= Spree Simple Blog
+
+Adds a simple blog to Spree which works much like Toto (http://github.com/cloudhead/toto/), reading text files in /content/articles. Content files consist of
+yaml metadata followed by Markdown content.
+
+By extending FileModel, other types of content can be managed in the same way way.

data/app/controllers/articles_controller.rb

@@ -0,0 +1,30 @@
+class ArticlesController < Spree::BaseController
+  rescue_from  Errno::ENOENT, :with => :render_404
+  
+  def index
+    @per_page = 10
+    @current_page = (params[:page] || 1).to_i
+    @total_pages = (Article.count / @per_page.to_f).ceil
+    @articles = Article.find_articles(:page => @current_page)
+    respond_to do |wants|
+      wants.html {}
+      wants.xml {}
+    end
+  end
+  
+  def archive
+    @articles = Article.find_articles(:year => params[:year], :month => params[:month])
+    render :action => 'index'
+  end
+  
+  def tag
+    @articles = Article.tagged(params[:tag])
+    render :action => 'index'
+  end
+  
+  def show
+    key = "#{params[:year]}-#{params[:month].rjust(2,'0')}-#{params[:day].rjust(2,'0')}-#{params[:permalink]}"
+    @article = Article.find(key)
+  end
+  
+end

data/app/helpers/articles_helper.rb

@@ -0,0 +1,37 @@
+require 'rdiscount'
+
+module ArticlesHelper
+  
+  def html_transform(text)
+    RDiscount.new(text.to_s).to_html.html_safe
+  end
+
+  def format_date(time)
+    time.strftime("%B %d %Y")
+  end
+
+  def format_time(time)
+    time.strftime("%I:%m%p")
+  end
+
+  def link_to_archive(archive_month)
+    text = "#{Date::MONTHNAMES[archive_month.last.to_i]} #{archive_month.first.to_i}"
+    link_to text, blog_articles_archive_url(:year => archive_month.first, :month => archive_month.last.to_s.rjust(2, '0'))
+  end
+
+  def link_to_article(article, options = {})
+    link_to h(article.title), article_url(article), options
+  end
+  
+  def article_url(article)
+    blog_article_url :permalink => article.slug, :year => article.date.year, :month => article.date.month, :day => article.date.day
+  end
+
+  def url_escape(string)
+    string.gsub(/([^ a-zA-Z0-9_.-]+)/n) do
+      '%' + $1.unpack('H2' * $1.size).join('%').upcase
+    end.tr(' ', '+')
+  end
+  
+end
+

data/app/models/article.rb

@@ -0,0 +1,53 @@
+class Article < FileModel
+  
+  def self.find_articles(options = {})
+    options = {
+      :per_page => 10,
+      :page => 1
+    }.merge(options)
+    
+    options[:offset] = (options[:page]-1) * options[:per_page]
+    options[:limit] = options[:per_page]
+
+    if options[:year] and options[:month]
+      options[:match] = %r(\/#{options[:year]}-#{options[:month].to_s.rjust(2,'0')})
+    end
+
+    all(options)
+  end
+
+  def self.recent(number = 5)
+    @@recent ||= all(:limit => number)
+  end
+
+  def self.tagged(tag) 
+    tag_index[tag.strip].to_a.map do |key|
+      Article.find(key)
+    end
+  end
+
+  def self.archive_months
+    @@archive_months ||= files.map{|f| File.basename(f).split('-')[0..1] }.uniq
+  end
+
+  # Store list of articles for each tag in a hash
+  # Fast enough for the small number of articles we're dealing with
+  @@tag_index = {}
+  def self.tag_index
+    return @@tag_index if @@tag_index.present?
+    all.each do |a| 
+     a.tags.split(',').map(&:strip).each do |t| 
+       @@tag_index[t] ||= []
+       @@tag_index[t] = (@@tag_index[t] << a.key).uniq
+      end
+    end
+    @@tag_index
+  end
+  
+  %w(title_tag meta_keywords meta_description).each do |attribute|
+    define_method(attribute) do
+      meta[attribute]
+    end
+  end
+
+end

data/app/models/file_model.rb

@@ -0,0 +1,98 @@
+# Base class for simple models that load their content from text files formatted like Toto's articles
+class FileModel
+  attr_accessor :file, :key, :meta, :body
+  
+  def initialize(file, key, meta, body)
+    @file = file
+    @key = key
+    @meta = meta
+    @body = body  
+  end
+
+  def method_missing(method, *args)
+    if meta.has_key?(method.to_s)
+      meta[method.to_s]
+    else
+      super
+    end
+  end
+
+
+  def self.all(options = {})
+    options = {
+      :offset => 0
+    }.merge(options)
+
+    files = get_filtered_files(options)
+
+    if options[:limit]
+      files = files[options[:offset] .. (options[:offset].to_i + options[:limit].to_i-1)]
+    end
+
+    records = files.to_a.map do |f|
+      from_file(f)
+    end
+
+    records
+  end
+
+  def self.find(key)
+    from_file("#{content_path}/#{key}.txt")
+  end
+  
+  def self.count(options = {})
+    get_filtered_files(options).length
+  end
+  
+  def self.random(options = {})
+    from_file(files[rand(all.size)])
+  end
+
+  def self.files
+    Dir["#{content_path}/*.txt"].sort_by {|f| File.basename(f) }.reverse
+  end
+
+  def index
+    @index ||= self.class.files.index(file)
+  end
+
+  def next
+    return @next if @next.present?
+    if next_file = self.class.files[index + 1]
+      @next = self.class.from_file(next_file)
+    end
+  end
+
+  def previous
+    return @previous if @previous.present?
+    if index > 0 and previous_file = self.class.files[index - 1]
+      @previous = self.class.from_file(previous_file)
+    end
+  end
+
+  def self.from_file(file)
+    meta, body = File.read(file).split(/\n\n/, 2)
+    meta = YAML.load(meta)
+    key = File.basename(file).gsub('.txt','')
+    new(file, key, meta, body)
+  end
+
+  def self.content_path
+    File.expand_path(File.join(Rails.root, "content",  relative_path))
+  end
+
+  def self.relative_path
+    self.name.underscore
+  end
+  
+  private
+  
+    def self.get_filtered_files(options)
+      if options[:match]
+        files.select{|f| f =~ options[:match]}
+      else
+        files
+      end
+    end
+    
+end

data/app/views/articles/_archives.html.erb

@@ -0,0 +1,8 @@
+<div id="archives">
+  <h2>Archives</h2>
+  <ul>
+    <% for archive_month in Article.archive_months %>
+  		<li><%= link_to_archive archive_month %></li>
+		<% end %>
+	</ul>
+</div>

data/app/views/articles/_article.html.erb

@@ -0,0 +1,31 @@
+<div class="post">
+
+  <div class="heading">
+    <h2><%= link_to_article article %></h2>
+    <p>
+      <span class="author">by <strong><%= article.author %></strong></span>
+      &bull;
+      <span class="date"><%= format_date article.date %></span> 
+    </p>
+  </div>
+
+  <div class="entry">
+
+    <%= html_transform article.body %>
+
+  </div>
+  
+  <% if @articles %>
+  <div class="meta">
+    <p class="comments"><a href="<%= article_url article %>#respond" title="Comment on <%= article.title %>">Comments &#187;</a></p>
+    <p class="time">Posted @ <%= format_time article.date %></p>
+    <br class="clear" />
+  </div>
+  <% else %>
+    <% if @article.tags.present? %>
+    <p>Tags: 
+      <%= @article.tags.split(',').map { |tag|  link_to(tag, blog_tag_path(tag), :rel => 'tag')}.join(', ') %>
+    <% end %>
+  <% end %>
+
+</div>

data/app/views/articles/_comment_count_js.html.erb

@@ -0,0 +1,18 @@
+<% if Spree::Config[:disqus_id] %>
+  <% content_for :extra_javascripts do %>
+    <script type="text/javascript">
+    //<![CDATA[
+    (function() {
+    	var links = document.getElementsByTagName('a');
+    	var query = '?';
+    	for(var i = 0; i < links.length; i++) {
+    	if(links[i].href.indexOf('#disqus_thread') >= 0) {
+    		query += 'url' + i + '=' + encodeURIComponent(links[i].href) + '&';
+    	}
+    	}
+    	document.write('<script charset="utf-8" type="text/javascript" src="http://disqus.com/forums/<%= Spree::Config[:disqus_id] %>/get_num_replies.js' + query + '"></' + 'script>');
+    })();
+    //]]>
+    </script>
+  <% end %>
+<% end %>

data/app/views/articles/_recent.html.erb

@@ -0,0 +1,8 @@
+<div id="recent-posts">
+  <h2>Recent Posts</h2>	
+  <ul>
+    <% for article in Article.recent %>
+  		<li><%= link_to_article article %></li>
+		<% end %>
+	</ul>
+</div>

data/app/views/articles/_sidebar.html.erb

@@ -0,0 +1,11 @@
+<% hook :blog_sidebar do %>
+
+  <% if Spree::Config[:blog_feed_url] %>
+    <%= render 'subscribe' %>
+  <% end %>
+
+  <%= render 'recent' %>
+
+  <%= render 'archives' %>
+
+<% end %>

data/app/views/articles/_subscribe.html.erb

@@ -0,0 +1,6 @@
+<div id="subscribe">
+	<h2>Subscribe</h2>
+	<ul>
+		<li><a id="btnRss" href="<%= Spree::Config[:blog_feed_url] %>" title="Subscribe to the Railsdog RSS Feed">Railsdog RSS Feed</a></li>
+	</ul>
+</div>

data/app/views/articles/index.html.erb

@@ -0,0 +1,30 @@
+<% self.title = "Blog" %>
+<% @body_class = 'blog' %>
+
+<% if params[:tag] %>
+	<h2 class="pagetitle">Posts Tagged &lsquo;<%= params[:tag] %>&rsquo;</h2>
+<% elsif params[:year] && params[:month] %>
+	<h2 class="pagetitle">Archive for <%= Date::MONTHNAMES[params[:month].to_i] %>, <%= params[:year].to_i %></h2>
+<% end %>
+
+<%= render :partial => 'article', :collection => @articles %>
+
+<% if @total_pages %>
+<div class="navigation">
+  <% if @total_pages > 1 && @current_page < @total_pages %>
+		<div class="alignleft"><a href="<%= url_for(:overwrite_params => {:page => @current_page + 1}) %>" >&laquo; Older Entries</a></div>
+	<% end %>
+	<% if @current_page > 1 %>
+		<div class="alignright"><a href="<%= url_for(:overwrite_params => {:page => @current_page - 1}) %>" >Newer Entries &raquo;</a></div>
+	<% end %>
+	<br class="clear" />
+</div>
+<% end %>
+	
+<% content_for :sidebar do %>
+
+  <%= render 'sidebar' %>
+
+<% end %>
+
+<br class="clear" />

data/app/views/articles/index.xml.builder

@@ -0,0 +1,20 @@
+xml.instruct!
+xml.feed "xmlns" => "http://www.w3.org/2005/Atom" do
+  xml.title Spree::Config[:blog_feed_title]
+  xml.id Spree::Config[:blog_feed_url]
+  xml.updated @articles.first.date.xmlschema unless @articles.empty?
+  xml.author { xml.name Spree::Config[:blog_feed_author] }
+
+  @articles.each do |article|
+    xml.entry do
+      xml.title article.title
+      xml.link "rel" => "alternate", "href" => article_url(article)
+      xml.id article_url(article)
+      xml.published article.date.xmlschema
+      xml.updated article.date.xmlschema
+      xml.author { xml.name article.author }
+      xml.content("type" => "html") { xml.cdata!(html_transform(article.body)) }
+    end
+  end
+end
+

data/app/views/articles/show.html.erb

@@ -0,0 +1,38 @@
+<% self.title = "Blog - " + @article.title %>
+<% @body_class = 'blog' %>
+
+<div class="navigation">
+  <% if @article.previous %>
+	<div class="alignleft">&laquo; <%= link_to_article @article.previous %></div>
+	<% end %>
+  <% if @article.next %>
+	<div class="alignright"><%= link_to_article @article.next %> &raquo;</div>
+	<% end %>
+	<br class="clear" />
+</div>
+
+<%= render 'article', :article => @article %>
+
+<% if Spree::Config[:disqus_id] %>
+<div id="comments">
+  <a name="respond"></a>
+  <div id="disqus_thread"></div>
+  <script type="text/javascript">
+    var disqus_developer = <%= RAILS_ENV == 'development' ? '1' : '0' %>;
+  </script>
+  <noscript><a href="http://spreecommerce.disqus.com/?url=ref">View the discussion thread.</a></noscript>
+  <a href="http://disqus.com" class="dsq-brlink">blog comments powered by <span class="logo-disqus">Disqus</span></a>
+</div>
+<% end %>
+
+
+
+<% content_for :sidebar do %>
+  <%= render 'sidebar' %>
+<% end %>
+
+<% if Spree::Config[:disqus_id] %>
+  <% content_for :extra_javascripts do %>
+    <script type="text/javascript" src="http://disqus.com/forums/<%= Spree::Config[:disqus_id] %>/embed.js"></script>
+  <% end %>
+<% end %>

data/lib/spree_simple_blog.rb

@@ -0,0 +1,22 @@
+module SimpleBlogExtension
+  class Engine < Rails::Engine
+    
+    def self.activate
+
+      Spree::BaseController.class_eval do
+        helper ArticlesHelper
+      end
+
+      AppConfiguration.class_eval do
+        preference :disqus_id, :default => nil
+        preference :blog_feed_url, :default => '/blog.xml'
+      end
+
+    end
+
+
+    config.autoload_paths += %W(#{config.root}/lib)
+    config.to_prepare &method(:activate).to_proc
+
+  end
+end

data/lib/tasks/blog.rake

@@ -0,0 +1,30 @@
+namespace :blog do
+  
+  task :new => :environment do
+  
+    title = ask('Title: ')
+    slug = title.empty?? nil : title.strip.parameterize.to_s
+
+    article = {'slug' => slug, 'title' => title, 'author' => 'Author', 'tags' => '', 'date' => Date.today}.to_yaml
+    article << "\n"
+    article << "Lorem ipsum dolor sit amet...\n\n"
+
+    path = "#{RAILS_ROOT}/content/articles/#{Time.now.strftime("%Y-%m-%d")}#{'-' + slug if slug}.txt"
+
+    unless File.exist? path
+      File.open(path, "w") do |file|
+        file.write article
+      end
+      puts "an article was created for you at #{path}."
+    else
+      puts "I can't create the article, #{path} already exists."
+    end  
+    
+  end
+  
+end
+
+def ask message
+  print message
+  STDIN.gets.chomp
+end

data/lib/tasks/simple_blog_extension_tasks.rake

@@ -0,0 +1,17 @@
+namespace :spree do
+  namespace :extensions do
+    namespace :simple_blog do
+      desc "Copies public assets of the Simple Blog to the instance public/ directory."
+      task :update => :environment do
+        is_svn_git_or_dir = proc {|path| path =~ /\.svn/ || path =~ /\.git/ || File.directory?(path) }
+        Dir[SimpleBlogExtension.root + "/public/**/*"].reject(&is_svn_git_or_dir).each do |file|
+          path = file.sub(SimpleBlogExtension.root, '')
+          directory = File.dirname(path)
+          puts "Copying #{path}..."
+          mkdir_p RAILS_ROOT + directory
+          cp file, RAILS_ROOT + path
+        end
+      end  
+    end
+  end
+end

metadata

@@ -0,0 +1,117 @@
+--- !ruby/object:Gem::Specification 
+name: spree_simple_blog
+version: !ruby/object:Gem::Version 
+  hash: 5
+  prerelease: false
+  segments: 
+  - 3
+  - 0
+  - 1
+  version: 3.0.1
+platform: ruby
+authors: []
+
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-09-03 00:00:00 -05:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: spree_core
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - "="
+      - !ruby/object:Gem::Version 
+        hash: -1848229955
+        segments: 
+        - 0
+        - 30
+        - 0
+        - beta1
+        version: 0.30.0.beta1
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: rdiscount
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - "="
+      - !ruby/object:Gem::Version 
+        hash: 9
+        segments: 
+        - 1
+        - 5
+        - 5
+        version: 1.5.5
+  type: :runtime
+  version_requirements: *id002
+description: 
+email: 
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- README.markdown
+- lib/spree_simple_blog.rb
+- lib/tasks/blog.rake
+- lib/tasks/simple_blog_extension_tasks.rake
+- app/controllers/articles_controller.rb
+- app/helpers/articles_helper.rb
+- app/models/article.rb
+- app/models/file_model.rb
+- app/views/articles/_archives.html.erb
+- app/views/articles/_article.html.erb
+- app/views/articles/_comment_count_js.html.erb
+- app/views/articles/_recent.html.erb
+- app/views/articles/_sidebar.html.erb
+- app/views/articles/_subscribe.html.erb
+- app/views/articles/index.html.erb
+- app/views/articles/index.xml.builder
+- app/views/articles/show.html.erb
+has_rdoc: true
+homepage: 
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 57
+      segments: 
+      - 1
+      - 8
+      - 7
+      version: 1.8.7
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: 
+- none
+rubyforge_project: 
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: Toto style blogging for Spree
+test_files: []
+