fap 0.0.1

data/History.txt

@@ -0,0 +1,4 @@
+=== 0.0.1 2010-03-30
+
+* 1 major enhancement:
+  * Initial release, yay.

data/Manifest.txt

@@ -0,0 +1,22 @@
+History.txt
+Manifest.txt
+README.rdoc
+Rakefile
+lib/fap.rb
+lib/fap/relation.rb
+lib/fap/support
+lib/fap/support/class.rb
+lib/fap/fap.rb
+lib/fap/mixins
+lib/fap/mixins/properties.rb
+lib/fap/mixins/relations.rb
+lib/fap/mixins.rb
+lib/fap/collection.rb
+lib/fap/property.rb
+script/console
+script/destroy
+script/generate
+spec/fap_spec.rb
+spec/spec.opts
+spec/spec_helper.rb
+tasks/rspec.rake

data/README.rdoc

@@ -0,0 +1,74 @@
+= fap
+
+* http://github.com/oz/fap
+
+== DESCRIPTION:
+
+FAP is a ruby gem build on top of the excellent Nokogiri, to turn boring XML,
+or HTML documents into yummy ruby objects.  Right now, it only support
+using Nokogiri's XPath selectors, and simple "relations" between a document
+nodes, though this will hopefully get better.
+
+FAP's ideas are loosely connected to tools built by some adventurous fellas at
+AF83, who still do PHP things to their brains.  Some credits should go to them,
+and to the horrid weather that kept me locked inside last week-end.
+
+And yes, I know it's a stupid name.  But I'm sure you can come up with a decent
+acronym. :)
+
+== SYNOPSIS:
+
+    class Atom < FAP::FAP
+      string :title,   :xpath => '//feed/title'
+      uri    :url,     :xpath => '//feed/link[@rel="self"]', :get => :href
+      date   :updated, :xpath => '//feed/updated'
+
+      has_many :articles, :class => 'Article', :xpath => '//feed/entry'
+    end
+
+    class Article < FAP::FAP
+      string :title # It is assumed here, that you want a string mapped on a <title> element
+      uri    :url, :xpath => 'link[@rel="alternate"]', :get => :href    # Fetch the :href attribute
+      string :content
+      date   :updated_at, :xpath => 'updated'
+
+      belongs_to :atom, :class => 'Atom'
+    end
+
+    atom = Atom.new open("http://search.twitter.com/search.atom?q=ruby")
+    atom.articles.each do |article|
+      puts "#{article.title}: #{article.url}"
+    end
+
+== REQUIREMENTS:
+
+* nokogiri
+
+== INSTALL:
+
+* gem install fap
+
+== LICENSE:
+
+(The MIT License)
+
+Copyright (c) 2010 Arnaud Berthomier
+
+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/Rakefile

@@ -0,0 +1,16 @@
+require 'rubygems'
+gem 'hoe', '>= 2.1.0'
+require 'hoe'
+require 'fileutils'
+require './lib/fap'
+
+Hoe.plugin :newgem
+$hoe = Hoe.spec 'fap' do
+  self.developer 'Arnaud Berthomier', 'oz@cyprio.net'
+  self.rubyforge_name       = self.name # TODO this is default value
+  # self.extra_deps         = [['activesupport','>= 2.0.2']]
+
+end
+
+require 'newgem/tasks'
+Dir['tasks/**/*.rake'].each { |t| load t }

data/lib/fap.rb

@@ -0,0 +1,32 @@
+$:.unshift(File.dirname(__FILE__)) unless
+  $:.include?(File.dirname(__FILE__)) || $:.include?(File.expand_path(File.dirname(__FILE__)))
+
+require 'nokogiri'
+
+module FAP
+  VERSION = '0.0.1'
+
+  autoload :FAP,        'fap/fap'
+  autoload :Property,   'fap/property'
+  autoload :Relation,   'fap/relation'
+  autoload :Mixins,     'fap/mixins'
+  autoload :Collection, 'fap/collection'
+
+  # extracted from Extlib
+  #
+  # Constantize tries to find a declared constant with the name specified
+  # in the string. It raises a NameError when the name is not in CamelCase
+  # or is not initialized.
+  #
+  # @example
+  # "Module".constantize #=> Module
+  # "Class".constantize #=> Class
+  def self.constantize(camel_cased_word)
+    unless /\A(?:::)?([A-Z]\w*(?:::[A-Z]\w*)*)\z/ =~ camel_cased_word
+      raise NameError, "#{camel_cased_word.inspect} is not a valid constant name!"
+    end
+    Object.module_eval "::#{$1}", __FILE__, __LINE__
+  end
+end
+
+# *fap* *fap* *fap*

data/lib/fap/collection.rb

@@ -0,0 +1,29 @@
+module FAP
+  class Collection
+    include Enumerable
+
+    def initialize relation, node
+      @nodes = []
+      @fetched = false
+      @node = node
+      @relation = relation
+      @klass = ::FAP.constantize relation.klass
+    end
+
+    def each
+      fetch_nodes unless @fetched
+      @nodes.map do |node|
+        obj = @klass.new nil
+        obj.from_relation @relation, node
+        yield obj
+      end
+    end
+
+    private
+
+      def fetch_nodes
+        @nodes = @node.xpath @relation.xpath
+        @fetched = true
+      end
+  end
+end

data/lib/fap/fap.rb

@@ -0,0 +1,41 @@
+#!/usr/bin/env ruby
+
+module FAP
+  class FAP
+
+    def self.inherited subclass
+      subclass.send :include, ::FAP::Mixins::Properties
+      subclass.send :include, ::FAP::Mixins::Relations
+      subclass.class_eval <<-EOS, __FILE__, __LINE__ + 1
+        def self.inherited subclass
+          super
+          subclass.properties = self.properties.dup
+          subclass.relations  = self.relations.dup
+        end
+      EOS
+    end
+
+    def initialize stream, opts={}
+      data = stream.respond_to?(:read) ? stream.read : stream.to_s
+      @_node = Nokogiri data
+      @_cache = {}
+    end
+
+    ##
+    # Build object starting from a relation's node
+    #
+    # @see FAP::Collection
+    # @param [FAP::Relation] Object relation
+    # @param [Nokogiri::XML::Element] starting node
+    # @retun [FAP::FAP]
+    def from_relation relation, node
+      relation.from.class
+      owners = self.relations.select { |rel| rel.type == :belongs_to && rel.klass == relation.from.class.to_s }
+      @_cache ||= {}
+      @_cache[owners.first.name] = relation.from if owners.size == 1
+      @_node = node
+      self
+    end
+
+  end
+end

data/lib/fap/mixins.rb

@@ -0,0 +1,6 @@
+module FAP
+  module Mixins
+    autoload :Properties, 'fap/mixins/properties'
+    autoload :Relations,  'fap/mixins/relations'
+  end
+end

data/lib/fap/mixins/properties.rb

@@ -0,0 +1,77 @@
+# For extlib_inheritable_accessor
+require File.join File.dirname(__FILE__), '..', 'support', 'class'
+
+module FAP
+  module Mixins
+    module Properties
+
+      def self.included base
+        base.class_eval <<-EOS, __FILE__, __LINE__ + 1
+          extlib_inheritable_accessor(:properties) unless self.respond_to?(:properties)
+          self.properties ||= []
+        EOS
+        base.extend ClassMethods
+      end
+
+      def _search_property name
+        property = properties.select { |prop| prop.name == name }.first
+        node = @_node.at_xpath property.xpath
+        raise StandardError, "Could not find #{self.class}.#{name} (#{property.xpath}) in stream." unless node
+        property.cast node
+      end
+
+      module ClassMethods
+
+        ##
+        # Define a new property.
+        #
+        #   property :foo, "String", :some => "options"
+        #   property :foo
+        #   property :foo, :some => "options"
+        #
+        # @param [Symbol] property name
+        # @param [Array]  splat args
+        def property name, *args
+          opts = {}
+          opts.merge!(:type => args.shift) if args[0].class == String
+          opts.merge!(*args) unless args.empty?
+          property = ::FAP::Property.new name, opts
+          self.properties << property
+          define_property_getter property
+        end
+
+        def string name, *args
+          property name, *args
+        end
+
+        def number name, *args
+          property name, 'Fixnum', *args
+        end
+        alias :integer :number
+
+        def date name, *args
+          property name, 'DateTime', *args
+        end
+        alias :time :date
+
+        def uri name, *args
+          property name, 'URI', *args
+        end
+
+        protected
+
+          def define_property_getter property
+            class_eval <<-EOS, __FILE__, __LINE__ + 1
+              def #{property.name}
+                if @_cache[:#{property.name}]
+                  @_cache[:#{property.name}]
+                else
+                  @_cache[:#{property.name}] = _search_property :#{property.name}
+                end
+              end
+            EOS
+          end
+      end
+    end
+  end
+end

data/lib/fap/mixins/relations.rb

@@ -0,0 +1,85 @@
+# For extlib_inheritable_accessor
+require File.join File.dirname(__FILE__), '..', 'support', 'class'
+
+module FAP
+  module Mixins
+    module Relations
+
+      def self.included base
+        base.class_eval <<-EOS, __FILE__, __LINE__ + 1
+          extlib_inheritable_accessor(:relations) unless self.respond_to?(:relations)
+          self.relations ||= []
+        EOS
+        base.extend ClassMethods
+      end
+
+      ##
+      # Load a relation by its nane
+      #
+      # @return [FAP::Collection] for "has_many" relations
+      # @return [FAP::FAP]        "father" object for "belongs_to" relations
+      def _load_relation name
+        relation = self.relations.select { |rel| rel.name == name }.first
+        if relation.type == :has_many
+          _load_has_many relation
+        elsif relation.type == :belongs_to
+          _load_belongs_to relation
+        else
+          raise "Unkown relation type"
+        end
+      end
+
+      def _load_has_many relation
+        relation.from = self
+        ::FAP::Collection.new relation, @_node
+      end
+
+      def _load_belongs_to relation
+        nil
+      end
+
+      module ClassMethods
+
+        ##
+        # Define a "many" relation
+        #
+        def has_many name, opts={}
+          opts.merge! :type => :has_many, :from => self
+          relation = ::FAP::Relation.new name, opts
+          self.relations << relation
+          define_relation_getter relation
+        end
+
+        ##
+        # Define a "belongs to" relation
+        #
+        def belongs_to name, opts={}
+          opts.merge! :type => :belongs_to, :from => self
+          relation = ::FAP::Relation.new name, opts
+          self.relations << relation
+          define_relation_getter relation
+        end
+
+        protected
+ 
+          ##
+          # Add getter for a relation.
+          #
+          # @param [FAP::Relation]
+          # @return TBD
+          def define_relation_getter relation
+            class_eval <<-EOS, __FILE__, __LINE__ + 1
+              def #{relation.name}
+                if @_cache[:#{relation.name}]
+                  @_cache[:#{relation.name}]
+                else
+                  @_cache[:#{relation.name}] = _load_relation :#{relation.name}
+                end
+              end
+            EOS
+          end
+      end
+
+    end
+  end
+end

data/lib/fap/property.rb

@@ -0,0 +1,33 @@
+module FAP
+  class Property
+    attr_reader :name, :type, :xpath, :attribute
+
+    def initialize name, opt={}
+      @name      = name
+      @type      = opt[:type]  || 'String'
+      @xpath     = opt[:xpath] || name.to_s
+      @attribute = opt[:get]   || nil
+    end
+
+    ##
+    # Cast a Nokogiri node value to @type
+    # @param [Nokogiri::XML::Element] a node
+    # @return value of type @type
+    def cast node
+      raise "Invalid XML node" if node.nil?
+      what = @attribute ? node[@attribute.to_s] : node.text
+      case @type
+      when 'Fixnum'
+        what.to_i 10
+      when 'DateTime'
+        DateTime.parse what
+      when 'URI'
+        URI.parse what
+      when 'String'
+        what.to_s
+      else
+        ::FAP.constantize(@type).new(what)
+      end
+    end
+  end
+end

data/lib/fap/relation.rb

@@ -0,0 +1,15 @@
+module FAP
+  class Relation
+    attr_reader :name, :type, :xpath, :klass
+    attr_accessor :from
+
+    def initialize name, opt={}
+      @name  = name
+      @type  = opt[:type]
+      @xpath = opt[:xpath] || name
+      @klass = opt[:class] || nil
+      @from  = opt[:from]  || nil
+    end
+
+  end
+end

data/lib/fap/support/class.rb

@@ -0,0 +1,157 @@
+# Copyright (c) 2006-2009 David Heinemeier Hansson
+#  
+# 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.
+#
+# Extracted From
+# http://github.com/rails/rails/commit/971e2438d98326c994ec6d3ef8e37b7e868ed6e2
+
+# Extends the class object with class and instance accessors for class attributes,
+# just like the native attr* accessors for instance attributes.
+#
+#  class Person
+#    cattr_accessor :hair_colors
+#  end
+#
+#  Person.hair_colors = [:brown, :black, :blonde, :red]
+class Class
+  def cattr_reader(*syms)
+    syms.flatten.each do |sym|
+      next if sym.is_a?(Hash)
+      class_eval(<<-EOS, __FILE__, __LINE__ + 1)
+        unless defined? @@#{sym}  # unless defined? @@hair_colors
+          @@#{sym} = nil          #   @@hair_colors = nil
+        end                       # end
+                                  #
+        def self.#{sym}           # def self.hair_colors
+          @@#{sym}                #   @@hair_colors
+        end                       # end
+                                  #
+        def #{sym}                # def hair_colors
+          @@#{sym}                #   @@hair_colors
+        end                       # end
+      EOS
+    end
+  end unless Class.respond_to?(:cattr_reader)
+
+  def cattr_writer(*syms)
+    options = syms.extract_options!
+    syms.flatten.each do |sym|
+      class_eval(<<-EOS, __FILE__, __LINE__ + 1)
+        unless defined? @@#{sym}                       # unless defined? @@hair_colors
+          @@#{sym} = nil                               #   @@hair_colors = nil
+        end                                            # end
+                                                       #
+        def self.#{sym}=(obj)                          # def self.hair_colors=(obj)
+          @@#{sym} = obj                               #   @@hair_colors = obj
+        end                                            # end
+                                                       #
+        #{"                                            #
+        def #{sym}=(obj)                               # def hair_colors=(obj)
+          @@#{sym} = obj                               #   @@hair_colors = obj
+        end                                            # end
+        " unless options[:instance_writer] == false }  # # instance writer above is generated unless options[:instance_writer] == false
+      EOS
+    end
+  end unless Class.respond_to?(:cattr_writer)
+
+  def cattr_accessor(*syms)
+    cattr_reader(*syms)
+    cattr_writer(*syms)
+  end unless Class.respond_to?(:cattr_accessor)
+  
+  # Defines class-level inheritable attribute reader. Attributes are available to subclasses,
+  # each subclass has a copy of parent's attribute.
+  #
+  # @param *syms<Array[#to_s]> Array of attributes to define inheritable reader for.
+  # @return <Array[#to_s]> Array of attributes converted into inheritable_readers.
+  #
+  # @api public
+  #
+  # @todo Do we want to block instance_reader via :instance_reader => false
+  # @todo It would be preferable that we do something with a Hash passed in
+  #   (error out or do the same as other methods above) instead of silently
+  #   moving on). In particular, this makes the return value of this function
+  #   less useful.
+  def extlib_inheritable_reader(*ivars)
+    instance_reader = ivars.pop[:reader] if ivars.last.is_a?(Hash)
+
+    ivars.each do |ivar|
+      self.class_eval <<-RUBY, __FILE__, __LINE__ + 1
+        def self.#{ivar}
+          return @#{ivar} if self.object_id == #{self.object_id} || defined?(@#{ivar})
+          ivar = superclass.#{ivar}
+          return nil if ivar.nil? && !#{self}.instance_variable_defined?("@#{ivar}")
+          @#{ivar} = ivar && !ivar.is_a?(Module) && !ivar.is_a?(Numeric) && !ivar.is_a?(TrueClass) && !ivar.is_a?(FalseClass) ? ivar.dup : ivar
+        end
+      RUBY
+      unless instance_reader == false
+        self.class_eval <<-RUBY, __FILE__, __LINE__ + 1
+          def #{ivar}
+            self.class.#{ivar}
+          end
+        RUBY
+      end
+    end
+  end unless Class.respond_to?(:extlib_inheritable_reader)
+
+  # Defines class-level inheritable attribute writer. Attributes are available to subclasses,
+  # each subclass has a copy of parent's attribute.
+  #
+  # @param *syms<Array[*#to_s, Hash{:instance_writer => Boolean}]> Array of attributes to
+  #   define inheritable writer for.
+  # @option syms :instance_writer<Boolean> if true, instance-level inheritable attribute writer is defined.
+  # @return <Array[#to_s]> An Array of the attributes that were made into inheritable writers.
+  #
+  # @api public
+  #
+  # @todo We need a style for class_eval <<-HEREDOC. I'd like to make it
+  #   class_eval(<<-RUBY, __FILE__, __LINE__), but we should codify it somewhere.
+  def extlib_inheritable_writer(*ivars)
+    instance_writer = ivars.pop[:writer] if ivars.last.is_a?(Hash)
+    ivars.each do |ivar|
+      self.class_eval <<-RUBY, __FILE__, __LINE__ + 1
+        def self.#{ivar}=(obj)
+          @#{ivar} = obj
+        end
+      RUBY
+      unless instance_writer == false
+        self.class_eval <<-RUBY, __FILE__, __LINE__ + 1
+          def #{ivar}=(obj) self.class.#{ivar} = obj end
+        RUBY
+      end
+
+      self.send("#{ivar}=", yield) if block_given?
+    end
+  end unless Class.respond_to?(:extlib_inheritable_writer)
+
+  # Defines class-level inheritable attribute accessor. Attributes are available to subclasses,
+  # each subclass has a copy of parent's attribute.
+  #
+  # @param *syms<Array[*#to_s, Hash{:instance_writer => Boolean}]> Array of attributes to
+  #   define inheritable accessor for.
+  # @option syms :instance_writer<Boolean> if true, instance-level inheritable attribute writer is defined.
+  # @return <Array[#to_s]> An Array of attributes turned into inheritable accessors.
+  #
+  # @api public
+  def extlib_inheritable_accessor(*syms, &block)
+    extlib_inheritable_reader(*syms)
+    extlib_inheritable_writer(*syms, &block)
+  end unless Class.respond_to?(:extlib_inheritable_accessor)
+end

data/script/console

@@ -0,0 +1,11 @@
+#!/usr/bin/env ruby
+# File: script/console
+irb = RUBY_PLATFORM =~ /(:?mswin|mingw)/ ? 'irb.bat' : 'irb'
+
+libs =  " -r irb/completion"
+libs << " -r rubygems" unless ENV['NO_RUBYGEMS']
+# Perhaps use a console_lib to store any extra methods I may want available in the cosole
+# libs << " -r #{File.dirname(__FILE__) + '/../lib/console_lib/console_logger.rb'}"
+libs <<  " -r #{File.dirname(__FILE__) + '/../lib/fap.rb'}"
+puts "Loading fap gem"
+exec "#{irb} #{libs} --simple-prompt"

data/script/destroy

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+APP_ROOT = File.expand_path(File.join(File.dirname(__FILE__), '..'))
+
+begin
+  require 'rubigen'
+rescue LoadError
+  require 'rubygems'
+  require 'rubigen'
+end
+require 'rubigen/scripts/destroy'
+
+ARGV.shift if ['--help', '-h'].include?(ARGV[0])
+RubiGen::Base.use_component_sources! [:rubygems, :newgem, :newgem_theme, :test_unit]
+RubiGen::Scripts::Destroy.new.run(ARGV)

data/script/generate

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+APP_ROOT = File.expand_path(File.join(File.dirname(__FILE__), '..'))
+
+begin
+  require 'rubigen'
+rescue LoadError
+  require 'rubygems'
+  require 'rubigen'
+end
+require 'rubigen/scripts/generate'
+
+ARGV.shift if ['--help', '-h'].include?(ARGV[0])
+RubiGen::Base.use_component_sources! [:rubygems, :newgem, :newgem_theme, :test_unit]
+RubiGen::Scripts::Generate.new.run(ARGV)

data/spec/fap_spec.rb

@@ -0,0 +1,157 @@
+require File.dirname(__FILE__) + '/spec_helper.rb'
+
+describe "a very light FAP" do
+  before :all do
+    class Foo < FAP::FAP ; end
+  end
+  
+  it "should define #properties #accessor" do
+    Foo.properties.should be_an_instance_of(Array)
+    Foo.properties.should be_empty
+  end
+
+  it "should define #relations read accessor" do
+    Foo.relations.should be_an_instance_of(Array)
+    Foo.relations.should be_empty
+  end
+end
+
+describe "a very light FAP with properties" do
+  before :all do
+    class Foo < FAP::FAP
+      property :str_name
+      property :str_prop, 'String'
+      property :xpath_prop, 'Fixnum', :xpath => '//foobar'
+    end
+  end
+
+  it "should have 3 properties" do
+    Foo.properties.should have(3).items
+  end
+
+  it "should have 2 'String' properties" do
+    props = Foo.properties.select { |prop| prop.name != :xpath_prop }
+    props.each do |prop|
+      prop.type.should == 'String'
+    end
+  end
+
+  it "should have 1 'Fixnum' property" do
+    props = Foo.properties.select { |prop| prop.name == :xpath_prop }
+    props.each do |prop|
+      prop.type.should == 'Fixnum'
+    end
+  end
+
+  it "should define a property's xpath with the :xpath option" do
+    props = Foo.properties.select { |prop| prop.name == :xpath_prop }
+    props.each do |prop|
+      prop.xpath.should == '//foobar'
+    end
+  end
+
+  it "should define property accessors" do
+    x = Foo.new nil
+    x.should respond_to(:str_name)
+    x.should respond_to(:str_prop)
+    x.should respond_to(:xpath_prop)
+  end
+end
+
+describe "a FAP with some relations" do
+  before :all do
+    class Foo < FAP::FAP
+      has_many :bars, :class => 'Bar', :xpath => '//foo/bars'
+    end
+
+    class Bar < FAP::FAP
+      belongs_to :foo, :class => 'Foo'
+    end
+  end
+
+  it "should define some relations" do
+    Foo.relations.should have(1).item
+    Bar.relations.should have(1).item
+  end
+
+  it "should define has_many relations" do
+    x = Foo.new nil
+    x.should respond_to(:bars)
+    x.bars.should be_an_instance_of(FAP::Collection)
+  end
+
+  it "should define belongs_to relations" do
+    x = Bar.new nil
+    x.should respond_to(:foo)
+    x.foo.should be_an_instance_of(NilClass)
+  end
+end
+
+describe "a simple FAP to read a stream" do
+  before :all do
+    class Foo < FAP::FAP ; end
+  end
+
+  it "should load a File object" do
+    foo = Foo.new open('spec/fixtures/twitter-search.atom')
+  end
+end
+
+describe "a simple FAP to parse an atom feed" do
+  before :all do
+    # Define a simple Atom parser for twitter searches.
+    class Atom < FAP::FAP
+      string :title,   :xpath => '//feed/title'
+      uri    :url,     :xpath => '//feed/link[@rel="self"]', :get => :href
+      date   :updated, :xpath => '//feed/updated'
+
+      has_many :articles, :class => 'Article', :xpath => '//feed/entry'
+    end
+
+    class Article < FAP::FAP
+      string :title
+      uri    :url, :xpath => 'link[@rel="alternate"]', :get => :href
+      string :content
+      date   :updated_at, :xpath => 'updated'
+
+      belongs_to :atom, :class => 'Atom'
+    end
+  end
+
+  before :each do
+    @atom = Atom.new open('spec/fixtures/twitter-search.atom')
+  end
+
+  it "should find a title" do
+    @atom.title.should == "ruby - Twitter Search"
+  end
+
+  it "should find a URI" do
+    @atom.url.should be_an_instance_of(URI::HTTP)
+  end
+
+  it "should find a date" do
+    @atom.updated.should be_an_instance_of(DateTime)
+  end
+
+  it "should define a collection of :articles" do
+    @atom.articles.should be_an_instance_of(FAP::Collection)
+    @atom.articles.should respond_to(:each)
+  end
+
+  it "should map relations to their required class" do
+    @atom.articles.first.should be_an_instance_of(Article)
+  end
+
+  it "should map relations to their required class instances" do
+    @atom.articles.first.title.should be_an_instance_of(String)
+    @atom.articles.first.url.should be_an_instance_of(URI::HTTP)
+    @atom.articles.first.content.should be_an_instance_of(String)
+    @atom.articles.first.updated_at.should be_an_instance_of(DateTime)
+    @atom.articles.first.atom.should be_an_instance_of(Atom)
+  end
+
+  it "should preserve relations' objects" do
+    @atom.articles.first.atom.object_id.should == @atom.object_id
+  end
+end

data/spec/spec.opts

@@ -0,0 +1 @@
+--colour

data/spec/spec_helper.rb

@@ -0,0 +1,11 @@
+begin
+  require 'rubygems' unless ENV['NO_RUBYGEMS']
+  require 'spec'
+rescue LoadError
+  require 'rubygems' unless ENV['NO_RUBYGEMS']
+  gem 'rspec'
+  require 'spec'
+end
+
+$:.unshift(File.dirname(__FILE__) + '/../lib')
+require 'fap'

data/tasks/rspec.rake

@@ -0,0 +1,21 @@
+begin
+  require 'spec'
+rescue LoadError
+  require 'rubygems' unless ENV['NO_RUBYGEMS']
+  require 'spec'
+end
+begin
+  require 'spec/rake/spectask'
+rescue LoadError
+  puts <<-EOS
+To use rspec for testing you must install rspec gem:
+    gem install rspec
+EOS
+  exit(0)
+end
+
+desc "Run the specs under spec/models"
+Spec::Rake::SpecTask.new do |t|
+  t.spec_opts = ['--options', "spec/spec.opts"]
+  t.spec_files = FileList['spec/**/*_spec.rb']
+end

metadata

@@ -0,0 +1,107 @@
+--- !ruby/object:Gem::Specification 
+name: fap
+version: !ruby/object:Gem::Version 
+  version: 0.0.1
+platform: ruby
+authors: 
+- Arnaud Berthomier
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-03-31 00:00:00 +02:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rubyforge
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 2.0.4
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: hoe
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 2.6.0
+    version: 
+description: |-
+  FAP is a ruby gem build on top of the excellent Nokogiri, to turn boring XML,
+  or HTML documents into yummy ruby objects.  Right now, it only support
+  using Nokogiri's XPath selectors, and simple "relations" between a document
+  nodes, though this will hopefully get better.
+  
+  FAP's ideas are loosely connected to tools built by some adventurous fellas at
+  AF83, who still do PHP things to their brains.  Some credits should go to them,
+  and to the horrid weather that kept me locked inside last week-end.
+  
+  And yes, I know it's a stupid name.  But I'm sure you can come up with a decent
+  acronym. :)
+email: 
+- oz@cyprio.net
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- History.txt
+- Manifest.txt
+files: 
+- History.txt
+- Manifest.txt
+- README.rdoc
+- Rakefile
+- lib/fap.rb
+- lib/fap/relation.rb
+- lib/fap/support/class.rb
+- lib/fap/fap.rb
+- lib/fap/mixins/properties.rb
+- lib/fap/mixins/relations.rb
+- lib/fap/mixins.rb
+- lib/fap/collection.rb
+- lib/fap/property.rb
+- script/console
+- script/destroy
+- script/generate
+- spec/fap_spec.rb
+- spec/spec.opts
+- spec/spec_helper.rb
+- tasks/rspec.rake
+has_rdoc: true
+homepage: http://github.com/oz/fap
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --main
+- README.rdoc
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: fap
+rubygems_version: 1.3.5
+signing_key: 
+specification_version: 3
+summary: FAP is a ruby gem build on top of the excellent Nokogiri, to turn boring XML, or HTML documents into yummy ruby objects
+test_files: []
+