flannel 0.1.5 → 0.2.1

data/VERSION.yml

@@ -1,5 +1,5 @@
 --- 
-:minor: 1
-:patch: 5
+:minor: 2
+:patch: 1
 :major: 0
 :build: 

data/flannel.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{flannel}
-  s.version = "0.1.5"
+  s.version = "0.2.1"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Jamal Hansen"]
-  s.date = %q{2010-01-10}
+  s.date = %q{2010-01-14}
   s.email = %q{jamal.hansen@gmail.com}
   s.executables = ["quilt-it~", "quilt-it"]
   s.extra_rdoc_files = [
@@ -50,14 +50,17 @@ Gem::Specification.new do |s|
      "features/wiki_links.feature",
      "flannel.gemspec",
      "lib/flannel.rb",
+     "lib/flannel/cache_location_does_not_exist_error.rb",
      "lib/flannel/cutting_board.rb",
      "lib/flannel/feed_parser.rb",
+     "lib/flannel/file_cache.rb",
      "lib/flannel/shears.rb",
      "lib/flannel/square.rb",
      "lib/flannel/stripe.rb",
      "lib/flannel/wrappable.rb",
      "test/cutting_board_test.rb",
      "test/feed_parser_test.rb",
+     "test/file_cache_test.rb",
      "test/flannel_test.rb",
      "test/shears_test.rb",
      "test/square_test.rb",
@@ -72,6 +75,7 @@ Gem::Specification.new do |s|
   s.summary = %q{A soft comfortable worn in markup language for Ruby}
   s.test_files = [
     "test/test_helper.rb",
+     "test/file_cache_test.rb",
      "test/stripe_test.rb",
      "test/cutting_board_test.rb",
      "test/feed_parser_test.rb",

data/lib/flannel.rb

@@ -4,6 +4,7 @@ require 'flannel/square'
 require 'flannel/shears'
 require 'flannel/stripe'
 require 'flannel/feed_parser'
+require 'flannel/file_cache'
 
 module Flannel
   def self.quilt markup, params={}

data/lib/flannel/cache_location_does_not_exist_error.rb

@@ -0,0 +1,4 @@
+module Flannel
+  class Flannel::CacheLocationDoesNotExistError < RuntimeError
+  end
+end

data/lib/flannel/cutting_board.rb

@@ -1,14 +1,12 @@
-#require 'shears'
-
 
 module Flannel
   class CuttingBoard
     def initialize params={}
-      @wiki_link= params[:wiki_link]
+      @params = params
     end
 
     def cut markup
-      shears = Flannel::Shears.new
+      shears = Flannel::Shears.new @params
       squares = shears.cut markup
       squares.map { |square| square.to_h }.join("\n\n")
     end

data/lib/flannel/feed_parser.rb

@@ -3,6 +3,10 @@ require 'open-uri'
 
 module Flannel
   class FeedParser
+    def initialize params={}
+      @cache = params[:cache] if params.has_key?(:cache)
+    end
+    
     def sub_feeds(url)
       url = format_url(url)
       get_news(url)
@@ -15,7 +19,10 @@ module Flannel
     end
     
     def get_document url
-      open(url)
+      doc = @cache.retrieve(url) if @cache
+      doc = open(url) unless doc
+      @cache.save url, doc if @cache
+      doc
     end
     
     def format_item(link, title)
@@ -24,19 +31,16 @@ module Flannel
 
     def get_news url
       item_string = ""
-      #begin
-	doc = Hpricot.XML(get_document(url))
 
-	(doc/"item").each do |item|
-	  link = (item/"link").inner_html
-	  title = (item/"title").inner_html
-	  item_string << format_item(link, title)
-	end
-	
-	item_string
-      #rescue
-      #  "Error retrieving data."
-      #end
+      doc = Hpricot.XML(get_document(url))
+
+      (doc/"item").each do |item|
+	link = (item/"link").inner_html
+	title = (item/"title").inner_html
+	item_string << format_item(link, title)
+      end
+      
+      item_string
     end
   end
 end

data/lib/flannel/file_cache.rb

@@ -0,0 +1,52 @@
+require 'flannel/cache_location_does_not_exist_error'
+require 'digest/md5'
+
+module Flannel
+  class FileCache
+    attr_reader :seconds_till_expiration
+    
+    def initialize cache_location, seconds_till_expiration=3600
+      unless File.exists?(cache_location) && File.directory?(cache_location)
+	raise CacheLocationDoesNotExistError
+      end
+      
+      @cache_location = cache_location
+      @seconds_till_expiration = seconds_till_expiration
+    end
+    
+    def save url, data
+      key = generate_key url
+      File.open(File.join(@cache_location, key), 'w') {|f| f.write(data) }
+    end
+    
+    def retrieve url
+      key = generate_key url
+      file = File.join(@cache_location, key)
+      
+      return nil unless File.exists?(file)
+	    
+      saved_at = File.mtime(file)
+      expires_at = saved_at + @seconds_till_expiration
+      
+      if Time.now >= expires_at
+	File.delete(file)
+	return nil
+      end
+      
+      read file     
+    end
+    
+    private
+      def generate_key url
+	Digest::MD5.hexdigest(url)
+      end
+   
+      def read file
+	data = ''
+	File.open(file, "r") { |f|
+	    data = f.read
+	}
+	data
+      end
+  end
+end

data/lib/flannel/shears.rb

@@ -3,6 +3,10 @@
 
 module Flannel
   class Shears
+    def initialize params={}
+      @params = params
+    end
+    
     def cut markup
       @squares = []
       @square = Flannel::Square.new
@@ -23,7 +27,7 @@ module Flannel
 
     def shift_square
       @squares << @square unless @square.blank?
-      @square = Flannel::Square.new
+      @square = Flannel::Square.new @params
     end
 
     def need_new_square? line

data/lib/flannel/square.rb

@@ -9,11 +9,13 @@ module Flannel
       @tags ={:preformatted => "pre", :feed => "ul", :list => "ul", :header_1 => "h1", :header_2 => "h2", :header_3 => "h3", :header_4 => "h4", :header_5 => "h5", :header_6 => "h6"}
       @stripes = []
       @style = :paragraph
+      @params = params
     end
 
     def << text
       text = text.strip unless @style == :preformatted
-      @stripes << Flannel::Stripe.stitch(text, :style=>@style)
+      @params[:style] = @style
+      @stripes << Flannel::Stripe.stitch(text, @params.dup)
     end
 
     def to_s

data/lib/flannel/stripe.rb

@@ -1,5 +1,3 @@
-#require 'wrappable'
-#require 'feed_parser'
 
 module Flannel
   class Stripe
@@ -12,22 +10,19 @@ module Flannel
 
     def initialize weave="", params={}
       @weave = weave
-      @wiki_link = params[:wiki_link]
-      @style = params[:style]
+      @params = params
     end
     
     def wiki_link topic
-      if @wiki_link
-        @wiki_link.call(permalink topic)
+      if @params[:wiki_link]
+        @params[:wiki_link].call(permalink topic)
       else
         permalink topic[1..-2]
       end
     end
 
     def permalink topic
-      require 'iconv'
-      # thanks to ismasan http://snippets.dzone.com/posts/show/4457
-      (Iconv.new('US-ASCII//TRANSLIT', 'utf-8').iconv topic).gsub(/[^\w\s\-]/,'').gsub(/[^\w]|[\_]/,' ').split.join('-').downcase
+      topic.gsub(%r{[^/\w\s\-]},'').gsub(%r{[^\w/]|[\_]},' ').split.join('-').downcase
     end
 
     def empty?
@@ -36,12 +31,17 @@ module Flannel
 
     def build_wiki_links
       return @weave if preformatted
-      @weave.gsub(/-\w(.*?)\w>/) { |match| %{<a href="#{wiki_link match}">#{match[1..-2]}</a>}}
+      @weave.gsub(/-\w(.*?)\w>/) { |match| %{<a href="#{wiki_link match}">#{format_link_display(match)}</a>}}
+    end
+    
+    def format_link_display text
+      text[1..-2].split("/").last
     end
 
     def to_h
+    
       if feed
-	parser = Flannel::FeedParser.new
+	parser = Flannel::FeedParser.new @params
 	parser.sub_feeds @weave
       else
 	text = build_wiki_links
@@ -50,15 +50,15 @@ module Flannel
     end
 
     def preformatted
-      @style == :preformatted
+      @params[:style] == :preformatted
     end
 
     def list
-      @style == :list
+      @params[:style] == :list
     end
     
     def feed
-      @style == :feed
+      @params[:style] == :feed
     end
 
     def markup text

data/test/feed_parser_test.rb

@@ -2,6 +2,20 @@ require 'test_helper'
 require 'mocha'
 
 class FeedTest < Test::Unit::TestCase
+  context "wiring" do
+    setup do
+      @rubyyot = File.read(File.join(File.dirname(__FILE__), "..", "features", "fixtures", "rubyyot.rss"))
+      @expected_rubyyot = "<ul><li>\n    <a href='http://blog.rubyyot"
+    end
+    
+    should "be set up for feeds" do
+      feed = "http://blog.rubyyot.com/tag/rubyyot/feed/rss"
+      body = Flannel.quilt "& #{feed}"
+
+      assert_equal(@expected_rubyyot, body[0..40])
+    end
+  end
+  
   context "bootstrapping test" do
     setup do
       @devlicious = File.read(File.join(File.dirname(__FILE__), "..", "features", "fixtures", "devlicious.rss"))

data/test/file_cache_test.rb

@@ -0,0 +1,114 @@
+require 'test_helper'
+require 'mocha'
+
+class FileCacheTest < Test::Unit::TestCase
+  context "Creating File cache" do
+    should "require a location" do
+      begin
+	cache = Flannel::FileCache.new
+	assert_fail "should have raised ArgumentError"
+      rescue ArgumentError => e
+	assert true
+      end
+    end
+    
+    should "require a valid location" do
+      begin
+	cache = Flannel::FileCache.new "foo/bar"
+	assert_fail "should have raised Flannel::CacheLocationDoesNotExistError"
+      rescue Flannel::CacheLocationDoesNotExistError => e
+	assert true
+      end
+    end
+  end
+  
+  context "Generating a key" do
+    setup do
+      @cache = Flannel::FileCache.new "tmp"
+    end
+    
+    should "be private" do
+      begin
+	key = @cache.generate_key "http://example.com"
+	assert_fail "generate_key should be private"
+      rescue NoMethodError => e
+	assert true
+      end
+    end
+    
+    should "make MD5 hash" do
+      url = "http://example.com"
+      key = @cache.send :generate_key, url
+      assert_equal(Digest::MD5.hexdigest(url), key)
+    end
+  end
+  
+  context "saving a file" do
+    setup do
+      clear_dir "tmp"
+      @url = "http://example.com"
+      @cache_location = "tmp"
+      @cache = Flannel::FileCache.new @cache_location
+      @key = @cache.send :generate_key, @url
+    end
+    
+    should "save data to a file" do
+      @cache.save @url, "some data"
+      assert File.exists?(File.join(@cache_location, @key)), "cache did not save data"
+    end
+  end
+  
+  context "retrieving data" do
+    setup do
+      clear_dir "tmp"
+      @url = "http://example.com"
+      @cache_location = "tmp"
+      @data = "this is some data"
+      @cache = Flannel::FileCache.new @cache_location
+      @key = @cache.send :generate_key, @url
+    end
+    
+    should "should return the saved data" do
+      @cache.save @url, @data
+      data = @cache.retrieve @url
+      assert_equal @data, data
+    end
+    
+    should "should return nil if there is no data" do 
+      data = @cache.retrieve @url
+      assert_nil data
+    end
+  end
+  
+  context "expiration" do
+    setup do
+      clear_dir "tmp"
+      @url = "http://example.com"
+      @cache_location = "tmp"
+      @data = "this is some data"
+    end
+    
+    should "accept an expiration time" do
+      cache = Flannel::FileCache.new @cache_location, 1
+      assert_equal 1, cache.seconds_till_expiration
+    end
+    
+    should "default expiration to 1 hour" do
+      cache = Flannel::FileCache.new @cache_location
+      assert_equal 3600, cache.seconds_till_expiration
+    end
+    
+    should "miss when content is expired" do 
+      cache = Flannel::FileCache.new @cache_location, 1
+      cache.save @url, @data
+      sleep 1
+      assert_nil(cache.retrieve(@url))
+    end
+    
+    should "hit when content is not expired" do 
+      cache = Flannel::FileCache.new @cache_location, 2
+      cache.save @url, @data
+      assert_equal(@data, cache.retrieve(@url))
+    end
+  end
+end

data/test/square_test.rb

@@ -1,5 +1,4 @@
 require 'test_helper'
-require 'stripe'
 
 class SquareTest < Test::Unit::TestCase
   context "basic behavior" do

data/test/stripe_test.rb

@@ -1,5 +1,5 @@
 require 'test_helper'
-#require 'stripe'
+require 'flannel/stripe'
 
 class StripeTest < Test::Unit::TestCase
   context "basic operations" do
@@ -23,13 +23,12 @@ class StripeTest < Test::Unit::TestCase
   context "building wiki links" do
     setup do
       wiki_link = lambda { |keyword| "http://www.example.com/foo/#{keyword}"}
-      @stripe = Flannel::Stripe.stitch "the -roof is on fire>", :wiki_link =>
-wiki_link
+      @stripe = Flannel::Stripe.stitch "the -roof is on fire>", :wiki_link => wiki_link
     end
 
     should "build wiki links based on a lambda" do
       assert_equal "http://www.example.com/foo/cheese",
-@stripe.wiki_link("cheese")
+@stripe.wiki_link("-cheese>")
     end
 
     should "find and replace wiki link markup" do
@@ -39,13 +38,26 @@ wiki_link
     
     should "permalink topics when making wiki links" do
       assert_equal "http://www.example.com/foo/cheese-tastes-good",
-@stripe.wiki_link("cheese tastes good")
+@stripe.wiki_link("-cheese tastes good>")
     end
     
     should "not be greedy in matching" do
       stripe = Flannel::Stripe.stitch("a -foo> and a -bar>.")
-      assert_equal 'a <a href="foo">foo</a> and a <a href="bar">bar</a>.',
-stripe.build_wiki_links
+      assert_equal 'a <a href="foo">foo</a> and a <a href="bar">bar</a>.', stripe.build_wiki_links
+    end
+  end
+  
+  context "subdirectories" do
+    setup do
+       @stripe = Flannel::Stripe.stitch "I think it -cheese/tastes good>."
+    end
+    
+    should "handle subdirectories" do
+      assert_equal "cheese/tastes-good", @stripe.wiki_link("-cheese/tastes good>")
+    end
+    
+    should "not display directory info" do
+      assert_equal 'I think it <a href="cheese/tastes-good">tastes good</a>.', @stripe.build_wiki_links
     end
   end
 

data/test/test_helper.rb

@@ -1,10 +1,27 @@
 require 'rubygems'
 require 'test/unit'
 require 'shoulda'
+require 'fileutils'
 
 $LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
 $LOAD_PATH.unshift(File.dirname(__FILE__))
 require 'flannel'
 
 class Test::Unit::TestCase
+  def assert_fail message
+    assert false, message
+  end
+  
+  def clear_dir dirname
+    Dir.foreach(dirname) do |f|
+      path = File.join(dirname, f)
+      if f == '.' or f == '..' then 
+	next
+      elsif 
+	File.directory?(path) then FileUtils.rm_rf(path)
+      else 
+	FileUtils.rm( path )
+      end
+    end
+  end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: flannel
 version: !ruby/object:Gem::Version 
-  version: 0.1.5
+  version: 0.2.1
 platform: ruby
 authors: 
 - Jamal Hansen
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-01-10 00:00:00 -06:00
+date: 2010-01-14 00:00:00 -06:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -76,14 +76,17 @@ files:
 - features/wiki_links.feature
 - flannel.gemspec
 - lib/flannel.rb
+- lib/flannel/cache_location_does_not_exist_error.rb
 - lib/flannel/cutting_board.rb
 - lib/flannel/feed_parser.rb
+- lib/flannel/file_cache.rb
 - lib/flannel/shears.rb
 - lib/flannel/square.rb
 - lib/flannel/stripe.rb
 - lib/flannel/wrappable.rb
 - test/cutting_board_test.rb
 - test/feed_parser_test.rb
+- test/file_cache_test.rb
 - test/flannel_test.rb
 - test/shears_test.rb
 - test/square_test.rb
@@ -119,6 +122,7 @@ specification_version: 3
 summary: A soft comfortable worn in markup language for Ruby
 test_files: 
 - test/test_helper.rb
+- test/file_cache_test.rb
 - test/stripe_test.rb
 - test/cutting_board_test.rb
 - test/feed_parser_test.rb