feedtools-cache-yaml 0.0.2

data/History.txt

@@ -0,0 +1,4 @@
++++ 0.0.2 2007-05-06
+
++ 1 major enhancement:
+  + Initial release

data/INSTALL.txt

@@ -0,0 +1,15 @@
+INSTALLATION for FeedTools::Cache::YAML
+==============================
+
+Requirements:
+ - Ruby version 1.8.x
+ - FeedTools version 0.2.2 or later
+
+Installation:
+ $ ruby setup.rb config
+ $ ruby setup.rb setup
+ # ruby setup.rb install
+
+ or 
+
+ # gem install feedtools-cache-yaml

data/Manifest.txt

@@ -0,0 +1,13 @@
+History.txt
+INSTALL.txt
+Manifest.txt
+README.txt
+Rakefile
+TODO
+TUTORIAL.txt
+lib/feedtools-cache-yaml.rb
+lib/feedtools/cache/yaml.rb
+lib/feedtools/cache/yaml/version.rb
+setup.rb
+test/test_feedtools-cache-yaml.rb
+test/test_helper.rb

data/README.txt

@@ -0,0 +1,19 @@
+README for FeedTools::Cache::YAML
+==============================
+
+What is:
+  FeedTools::Cache::YAML provides YAML file cache capability for FeedTools.
+
+Requirements:
+ - ruby-1.8.x: http://www.ruby-lang.org/
+ - FeedTools: http://rubyforge.org/projects/feedtools/
+   - 0.2.2 or later
+
+Installation:
+ see INSTALL.*
+
+Documentations:
+ see rdoc
+
+License:
+ Ruby's

data/Rakefile

@@ -0,0 +1,84 @@
+require 'rubygems'
+require 'rake'
+require 'rake/clean'
+require 'rake/testtask'
+require 'rake/packagetask'
+require 'rake/gempackagetask'
+require 'rake/rdoctask'
+require 'rake/contrib/rubyforgepublisher'
+require 'fileutils'
+require 'hoe'
+include FileUtils
+require File.join(File.dirname(__FILE__), 'lib', 'feedtools', 'cache', 'yaml', 'version')
+
+AUTHOR = 'date'
+EMAIL = "itacchi@gmail.com"
+DESCRIPTION = "YAML cache plugin for FeedTools"
+GEM_NAME = 'feedtools-cache-yaml'
+RUBYFORGE_PROJECT = 'feedtools-cache'
+HOMEPATH = "http://#{RUBYFORGE_PROJECT}.rubyforge.org"
+DOWNLOAD_PATH = "http://rubyforge.org/projects/#{RUBYFORGE_PROJECT}"
+
+NAME = "FeedTools::Cache::YAML"
+REV = File.read(".svn/entries")[/committed-rev="(d+)"/, 1] rescue nil
+VERS = FeedTools::Cache::YAML::VERSION::STRING + (REV ? ".#{REV}" : "")
+CLEAN.include ['**/.*.sw?', '*.gem', '.config', '**/.DS_Store']
+RDOC_OPTS = ['--quiet', '--title', 'FeedTools::Cache::YAML documentation',
+    "--opname", "index.html",
+    "--line-numbers", 
+    "--main", "README",
+    "--inline-source"]
+
+class Hoe
+  def extra_deps 
+    @extra_deps.reject { |x| Array(x).first == 'hoe' } 
+  end 
+end
+
+hoe = Hoe.new(GEM_NAME, VERS) do |p|
+  p.author = AUTHOR 
+  p.description = DESCRIPTION
+  p.email = EMAIL
+  p.summary = DESCRIPTION
+  p.url = HOMEPATH
+  p.rubyforge_name = RUBYFORGE_PROJECT if RUBYFORGE_PROJECT
+  p.test_globs = ["test/**/test_*.rb"]
+  p.clean_globs = CLEAN
+  
+  p.changes = p.paragraphs_of("History.txt", 0..1).join("\n\n")
+  p.extra_deps = [ ['feedtools', '>= 0.2.2'] ]
+end
+
+
+desc 'Generate website files'
+task :website_generate do
+  Dir['website/**/*.txt'].each do |txt|
+    sh %{ ruby scripts/txt2html #{txt} > #{txt.gsub(/txt$/,'html')} }
+  end
+end
+
+desc 'Upload website files to rubyforge'
+task :website_upload do
+  config = YAML.load(File.read(File.expand_path("~/.rubyforge/user-config.yml")))
+  host = "#{config["username"]}@rubyforge.org"
+  remote_dir = "/var/www/gforge-projects/#{RUBYFORGE_PROJECT}/"
+  local_dir = 'website'
+  sh %{rsync -av #{local_dir}/ #{host}:#{remote_dir}}
+end
+
+desc 'Generate and upload website files'
+task :website => [:website_generate, :website_upload]
+
+desc 'Release the website and new gem version'
+task :deploy => [:check_version, :website, :release]
+
+task :check_version do
+  unless ENV['VERSION']
+    puts 'Must pass a VERSION=x.y.z release version'
+    exit
+  end
+  unless ENV['VERSION'] == VERS
+    puts "Please update your version.rb to match the release version, currently #{VERS}"
+    exit
+  end
+end

data/TODO

@@ -0,0 +1,5 @@
+* tests
+* implement some methods
+* refact code
+* examples
+* find_by_id and id generation

data/TUTORIAL.txt

@@ -0,0 +1,28 @@
+TUTORIAL for FeedTools::Cache::YAML
+==============================
+
+ 1. install ruby
+ At first, you install Ruby the Object-Oriented Scripting Language.
+ Go http://www.ruby-lang.org/en/.
+
+ 2. install feedtools
+ Just type `gem install feedtools'.
+
+ 3. install FeedTools::Cache::YAML
+ See INSTALL.txt
+
+ 4. write code
+ require 'feedtools'
+ require 'feedtools-cache-yaml'
+ # or if you manually installed , require 'feedtools/cache/yaml'
+
+ # set cache configuration
+ FeedTools.configurations[:feed_cache] = FeedTools::Cache::YAML
+
+ # fetch from the web
+ feed = FeedTools::Feed.open('http://dontstopmusic.no-ip.org/diary/index.rdf')
+ p feed.live? #=> true
+
+ # use the cache
+ feed = FeedTools::Feed.open('http://dontstopmusic.no-ip.org/diary/index.rdf')
+ p feed.live? #=> false

data/lib/feedtools-cache-yaml.rb

@@ -0,0 +1 @@
+Dir[File.join(File.dirname(__FILE__), 'feedtools/**/*.rb')].sort.each { |lib| require lib }

data/lib/feedtools/cache/yaml.rb

@@ -0,0 +1,303 @@
+require 'yaml'
+require 'etc'
+require 'digest/sha1'
+require 'fileutils'
+
+module FeedTools
+  module Cache #:nodoc:
+    class YAML
+    end
+  end
+end
+
+class FeedTools::Cache::YAML
+  # helper class
+  class StorePath #:nodoc:
+    def initialize(type, key, base_store_path = nil)
+      base_store_path ||= defalut_base_store_path
+      @path = File.join(base_store_path, type, hash_path(key))
+    end
+    attr_reader :path
+
+    def to_s
+      @path.to_s
+    end
+
+    private
+    def defalut_base_store_path
+      ENV['FEEDTOOLS_CACHE_YAML_PATH'] ||
+      File.join(Etc.getpwuid.dir, '.feedtools', 'cache', 'yaml')
+    end
+
+    def hash_path(key)
+      first_level = key[0].chr
+      second_level = key[0..1]
+      third_level = key[0..2]
+      File.join(first_level, second_level, third_level, key)
+    end
+  end
+
+  class IDStorePath < StorePath #:nodoc:
+    def initialize(key, base_store_path = nil)
+      super('id', key, base_store_path)
+    end
+  end
+
+  class URLStorePath < StorePath #:nodoc:
+    def initialize(key, base_store_path = nil)
+      super('url', key, base_store_path)
+    end
+  end
+
+  class NullLogger #:nodoc:
+    def method_missing(message, *args)
+    end
+  end
+end
+
+# Caching plugin for FeedTools. Cache feched feed as yaml file.
+#
+# === usage
+# Simple to use, require library and set configuration.
+#   require 'feedtools-cache-yaml'
+#     or installed by manual
+#   require 'feedtools/cache/yaml'
+#
+#   FeedTools.configurations[:feed_cache] = FeedTools::Cache::YAML
+#
+# === configuration
+# You can change cache store path. 
+# The priority order is the following.
+# 1. path attribute of FeedTools::Cache::YAML
+# 2. FEEDTOOLS_CACHE_YAML_PATH environment variable
+# 3. default ~/.feedtools/cache/yaml
+class FeedTools::Cache::YAML
+  # Required by FeedTools.
+  ATTRIBUTES = %w(
+    id href title link
+    feed_data feed_data_type
+    http_headers last_retrieved
+  )
+
+  @@path = nil
+
+  # Required by FeedTools.
+  # Find a cached feed by its key.
+  # === Parameters
+  # [id] <code>String</code>: primary key.
+  #
+  # === Returns
+  # [cached feed] <code>FeedTools::Cache::YAML</code>: cached feed. If not found,  returns <code>nil</code>.
+  def self.find_by_id(id)
+    create_from_yaml_cache(path_by_id(id))
+  end
+
+  # Required by FeedTools.
+  # Find a cached feed by its url.
+  # === Parameters
+  # [url] <code>String</code>: feed url.
+  #
+  # === Returns
+  # [cached feed] <code>FeedTools::Cache::YAML</code>: cached feed. If not found,  returns <code>nil</code>.
+  def self.find_by_href(url)
+    create_from_yaml_cache(path_by_url(url))
+  end
+
+  # Required by FeedTools.
+  # TODO: implement this.
+  def self.initialize_cache
+    # nothing
+  end
+
+  # Required by FeedTools.
+  # TODO: implement this.
+  #
+  # === Returns
+  # Currently always true.
+  def self.connected?
+    true
+  end
+
+  # Required by FeedTools.
+  # TODO: implement this.
+  #
+  # === Returns
+  # Currently always true.
+  def self.set_up_correctly?
+    true
+  end
+
+  # Configured cache store path
+  #
+  # === Returns
+  # [path] <code>String</code> : cache store path you configured. Use FEEDTOOLS_CACHE_YAML_PATH environment variable or default if <code>nil</code>.
+  def self.path
+    @@path
+  end
+
+  # Set cache store path
+  #
+  # === Parameters
+  # [path] <code>String</code> : set cache store path. You can override default path.
+  def self.path=(path)
+    @@path = path
+  end
+
+  # Create a FeedTools::Cache::YAML instance object.
+  #
+  # === Returns
+  # [cached feed] <code>FeedTools::Cache::YAML</code> : cached feed.
+  def initialize
+    @yaml = {}
+    @new_record = true
+    @logger = NullLogger.new
+  end
+  # debug logger. Set logger object if use need. Logger output messages when log level is DEBUG.
+  attr_accessor :logger
+
+  # Required by FeedTools.
+  # 
+  # Returns whether it is a new object.
+  #
+  # === Returns
+  # [boolean] <code>true/false</code> : returns <code>true</code> if the instance has not been saved yet. Returns false if the instance loaded from cache.
+  def new_record?
+    @new_record
+  end
+
+  # Required by FeedTools.
+  #
+  # Primary key.
+  #
+  # === Returns
+  # [id] <code>String</code> : primary key.
+  def id
+    @yaml['id']
+  end
+
+  # Required by FeedTools.
+  #
+  # Set primary key.
+  #
+  # === Parameters
+  # [id] <code>String</code> : primary key.
+  def id=(id)
+    @yaml['id'] = id
+  end
+
+  # Required by FeedTools.
+  #
+  # Save new or update instance.
+  def save
+    unless id
+      save_new_cache
+    else
+      update_cache
+    end
+  end
+
+  # Load data from yaml file.
+  #
+  # === Parameters
+  # [path] <code>String</code> : yaml file path.
+  def load_cache(path)
+    begin
+      @yaml = YAML.load_file(path)
+      @new_record = false
+      debug "load cache: #{path}"
+      self
+    rescue
+      nil
+    end
+  end
+
+  def method_missing(message, *args) #:nodoc:
+    begin
+      if matched = /^(.*)=$/.match(message.to_s)
+        set_attribute(matched[1], args.first)
+      else
+        get_attribute(message.to_s)
+      end
+    rescue NameError
+      raise NoMethodError, "undefined method `#{message}' for #{self.to_s}"
+    end
+  end
+
+  private
+  def self.create_from_yaml_cache(path)
+    self.new.load_cache(path)
+  end
+
+  def self.path_by_id(id)
+    IDStorePath.new(id, @@path).path
+  end
+
+  def self.path_by_url(url)
+    partical_cache_path = url_to_partical_cache_path(url)
+    URLStorePath.new(partical_cache_path, @@path).path
+  end
+
+  def self.url_to_partical_cache_path(url)
+    uri = URI.parse(url).normalize
+    url = uri.host
+    url += ":#{uri.port}" unless uri.port == 80
+    url += uri.request_uri
+  end
+
+  def path_by_id
+    self.class.path_by_id(id)
+  end
+
+  def path_by_url
+    self.class.path_by_url(href)
+  end
+
+  def save_new_cache
+    debug "save new cache: #{href}"
+    self.id = generate_id
+    write_cache(path_by_url)
+    FileUtils.mkdir_p(File.dirname(path_by_id))
+    FileUtils.symlink(path_by_url, path_by_id)
+  end
+
+  def update_cache
+    debug "update cache: #{href}"
+    write_cache(path_by_url)
+  end
+
+  def write_cache(file_name)
+    debug "  write cache: #{file_name}" 
+    FileUtils.mkdir_p(File.dirname(file_name))
+    File.open(file_name, 'w') do |f|
+      f.print @yaml.to_yaml
+    end
+  end
+
+  def generate_id
+    Digest::SHA1.hexdigest('%0x' % object_id + Time.now.to_i.to_s)
+  end
+
+  def get_attribute(attribute)
+    if ATTRIBUTES.include?(attribute)
+      @yaml[attribute]
+    else
+      raise NameError
+    end
+  end
+
+  def set_attribute(attribute, value)
+    if ATTRIBUTES.include?(attribute)
+      @yaml[attribute] = value
+    else
+      raise NameError
+    end
+  end
+
+  def debug(message)
+    message = "[#{self.class}] #{message}"
+    if $DEBUG
+      STDERR.puts message
+      @logger.debug message
+    end
+  end
+end