muffins 0.0.5 → 0.0.6

data/.rvmrc

@@ -0,0 +1 @@
+rvm use --create 1.9.2@muffins

data/README.md

@@ -1,6 +1,8 @@
 Muffins
 ========
 
+[![travis](https://secure.travis-ci.org/rclosner/muffins.png)](http://travis-ci.org/rclosner/muffins)
+
 A Nokogiri-based Object to XML/HTML mapping library.
 
 Installation
@@ -38,44 +40,35 @@ Examples
 
 Primary class:
 
+```ruby
     class Book
 
       include Muffins
 
-      base_path 'book'
+      path 'book'
 
-      map :asin
+      map :asin, String
 
       within :item_attributes do |attributes|
-        attributes.map :title
-        attributes.map :author
-        attributes.map :ean, :to => 'EAN'
-        attributes.map :release_date, :type => Date
+        attributes.map :title, String
+        attributes.map :author, String, :collection => true
+        attributes.map :ean, String, :to => 'EAN'
+        attributes.map :release_date, Date
       end
 
-      map :editorial_review, :within => :reviews
-
-      map :similar_products, :to => 'SimilarProducts', :type => Product
-
-    end
-
-Associated class:
-
-    class Product
-
-      include Muffins
-
-      base_path 'similar_product'
-
-      map :title
-      map :ean, :to => 'EAN'
+      map :editorial_review, String, :within => :reviews
 
     end
+```
 
 ##Usage
 
+```ruby
     Book.parse(xml)
+```
 
 returns:
 
+```ruby
     [#<Book:0x233ebe8 @asin='1400079985', @title="War and Peace (Vintage Classics)", @author="Leo Tolstoy", @ean="9781400079988", @release_date=Tue, 02 Dec 2008, @editorial_review='ZOMG.', :similar_products=[#<Product:0x234ebe9 @title='Anna Karenina', @ean='9780143035008'>]>]
+```

data/Rakefile

@@ -1 +1 @@
-require 'bundler/gem_tasks'
+require "bundler/gem_tasks"

data/lib/muffins.rb

@@ -1,44 +1,22 @@
-require "muffins/mapping"
-require "muffins/mapping_decorator"
-require "muffins/version"
+require 'nokogiri'
+require 'virtus'
 
 module Muffins
 
+  # @api private
   def self.included(base)
+    base.send(:include, Virtus)
+    base.extend(Virtus::Options)
+    base.accept_options(:path)
     base.extend(ClassMethods)
   end
 
-  module ClassMethods
-
-    def base_path(bp = nil)
-      @base_path = bp if bp
-      @base_path
-    end
-
-    def parse(document, options = {})
-      document.css(base_path).collect do |node|
-        (new).tap do |object|
-
-          mappings.each do |mapping|
-            object.send("#{mapping.name}=", mapping.map(node))
-          end
-
-        end
-      end
-    end
-
-    def within(path, &block)
-      yield MappingDecorator.new(path, self)
-    end
+  private_class_method :included
 
-    def map(symbol, options = {})
-      attr_accessor symbol unless new.respond_to?(symbol)
-
-      mappings << Mapping.new(symbol, options)
-    end
-
-    def mappings
-      @mappings ||= []
-    end
-  end
 end
+
+require "muffins/version"
+require "muffins/class_methods"
+require "muffins/mapping"
+require "muffins/mapping_parent"
+require "muffins/document"

data/lib/muffins/class_methods.rb

@@ -0,0 +1,60 @@
+module Muffins
+  module ClassMethods
+
+    # @api public
+    def map(name, type, options = {})
+      options[:name] = name
+      options[:type] = type
+
+      mapping = Mapping.new(options)
+
+      add_mapping(mapping)
+      add_attribute(name, type)
+
+      self
+    end
+
+    # @api public
+    def within(path, &block)
+      Muffins::MappingParent.new(:path => path, :klass => self.class).tap { |parent| yield parent }
+    end
+
+    # @api public
+    def parse(doc, options = {})
+      document = Muffins::Document.new(:body => doc)
+
+      if options[:single]
+        new_from_node(document.first(path))
+      else
+        document.map(path) { |node| new_from_node(node) }
+      end
+    end
+
+    private
+
+    # @api private
+    def mappings
+      @mappins ||= []
+    end
+
+    # @api private
+    def add_mapping(mapping)
+      mappings << mapping
+    end
+
+    # @api private
+    def add_attribute(name, type)
+      attribute(name, type)
+    end
+
+    # @api private
+    def new_from_node(node)
+      new.tap do |obj|
+        mappings.each do |mapping|
+          obj.send("#{mapping.name}=", mapping.parse(node))
+        end
+      end
+    end
+
+  end
+end

data/lib/muffins/document.rb

@@ -0,0 +1,38 @@
+module Muffins
+  class Document
+
+    include Virtus
+
+    attribute :body, Class, :reader => :protected
+
+    # @api public
+    def first(path)
+      node = body.at_css(path)
+      node.text if node
+    end
+
+    # @api public
+    def all(path)
+      nodes = body.css(path)
+      nodes.map(&:text)
+    end
+
+    # @api public
+    def map(path, &block)
+      all(path).map { |node| yield node }
+    end
+
+    # @api public
+    def each(path, &block)
+      all(path).each { |node| yield node }
+    end
+
+    protected
+
+    # @api private
+    def body=(body)
+      @body = Nokogiri::HTML(body)
+    end
+
+  end
+end

data/lib/muffins/mapping.rb

@@ -1,79 +1,44 @@
-class Boolean; end;
-
 module Muffins
   class Mapping
 
-    PRIMITIVE_TYPES = %w(String Float Time Date DateTime Integer Boolean)
+    include Virtus
 
-    attr_reader :name, :options
+    attribute :name,       Symbol
+    attribute :type,       Class
+    attribute :to,         String
+    attribute :within,     String
+    attribute :collection, Boolean
 
-    def initialize(name, options = {})
-      @name    = name
-      @options = options
-    end
+    # @api public
+    def parse(doc)
+      document = Muffins::Document.new(:body => doc)
 
-    def map(document)
       if collection?
-        ([]).tap do |items|
-          document.css(path).each do |node|
-            items << typecast(node)
-          end
-        end
+        document.map(absolute_path) { |node| coerce(node) }
       else
-        typecast document.at_css(path)
+        coerce(document.first(absolute_path))
       end
     end
 
-    def path
-      path = options[:to].present? ? options[:to] : name
-
-      unless options[:within].blank?
-        path = "#{options[:within]} > #{path}"
-      end
-
-      @path ||= path
+    # @api public
+    def coerce(value)
+      Virtus::Coercion[value.class].send(coercion_method, value)
     end
 
-    def constant
-      @constant ||= "#{options[:type]}"
+    # @api public
+    def coercion_method
+      Virtus::Attribute.determine_type(type).coercion_method
     end
 
-    def collection?
-      !!options[:collection]
+    # @api public
+    def absolute_path
+      within ? [ within, relative_path ].compact.join(" > ") : relative_path
     end
 
-    def primitive?
-      PRIMITIVE_TYPES.include?(constant)
+    # @api public
+    def relative_path
+      to || name
     end
 
-    def typecast(node)
-      value = node.try(:text)
-
-      return value if value.blank? || constant.blank?
-
-      if primitive?
-        case constant
-        when 'String'
-          value.to_s
-        when 'Float'
-          value[/[-+]?[0-9]*\.?[0-9]+/].to_f
-        when 'Integer'
-          value[/[\d]+/].to_i
-        when 'Time'
-          Time.parse(value) rescue Time.at(value.to_i)
-        when 'Date'
-          Date.parse(value)
-        when 'DateTime'
-          DateTime.parse(value)
-        when 'Boolean'
-          ['true', 't', '1'].include?(value.to_s.downcase)
-        else
-          value
-        end
-
-      else
-        constant.constantize.parse(node)
-      end
-    end
   end
-end
+end

data/lib/muffins/mapping_parent.rb

@@ -0,0 +1,27 @@
+module Muffins
+  class MappingParent
+
+    include Virtus
+
+    attribute :path,  String
+    attribute :klass, Object
+
+    # @api public
+    def map(name, type, options = {})
+      set_options(options).tap do |options|
+        klass.map(name, type, options)
+      end
+
+      self
+    end
+
+    private
+
+    # @api private
+    def set_options(options)
+      options[:within] = [ path, options[:within] ].compact.join(" > ")
+      options
+    end
+
+  end
+end

data/lib/muffins/version.rb

@@ -1,3 +1,3 @@
 module Muffins
-  VERSION = "0.0.5"
+  VERSION = "0.0.6"
 end

data/muffins.gemspec

@@ -6,31 +6,29 @@ Gem::Specification.new do |s|
   s.name        = "muffins"
   s.version     = Muffins::VERSION
   s.authors     = ["Ryan Closner"]
-  s.email       = ["ryan.closner@gmail.com"]
-  s.homepage    = "https://rubygems.org/gems/muffins"
-  s.summary     = %q{An Object to XML/HTML mapping library using Nokogiri}
-  s.description = %q{An Object to XML/HTML mapping library using Nokogiri}
+  s.email       = ["ryan@ryanclosner.com"]
+  s.homepage    = "http://rubygems.org/gems/muffins"
+  s.summary     = %q{An Object to XML/HTML mapping library.}
+  s.description = %q{An Object to XML/HTML mapping library using Virtus and Nokogiri}
 
   s.rubyforge_project = "muffins"
 
-  {
-    'activesupport'       => '>= 2.3.10',    
-    'nokogiri'            => '~> 1.4'
-  }.each do |lib, version|
-    s.add_runtime_dependency lib, version
-  end
+  runtime_dependencies = {
+    'nokogiri'  => '~> 1.5.0',
+    'virtus'    => '~> 0.0.9'
+  }
 
+  runtime_dependencies.each {|lib, version| s.add_runtime_dependency(lib, version) }
 
-  {
-    'bundler'             => '~> 1.0',
-    'cucumber'            => '~> 0.10',
-    'rspec'               => '~> 2.6',
-  }.each do |lib, version|
-    s.add_development_dependency lib, version
-  end
+  development_dependencies = {
+    'rspec'  => '~> 2.7.0'
+  }
+
+  development_dependencies.each {|lib, version| s.add_development_dependency(lib, version) }
 
   s.files         = `git ls-files`.split("\n")
   s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
   s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
   s.require_paths = ["lib"]
+
 end

data/spec/fixtures/books.html

@@ -0,0 +1,23 @@
+<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01//EN"
+   "http://www.w3.org/TR/html4/strict.dtd">
+
+<html lang="en">
+<head>
+  <meta http-equiv="Content-Type" content="text/html; charset=utf-8">
+</head>
+<body>
+  <div id="books">
+
+    <div class="book">
+      <span class="isbn">1400079985</span>
+      <span class="title">War and Peace (Vintage Classics)</span>
+    </div>
+
+    <div class="book">
+      <span class="isbn">1143035008</span>
+      <span class="title">Anna Karenina (Oprah's Book Club)</span>
+    </div>
+
+  </div>
+</body>
+</html>

data/spec/fixtures/books.xml

@@ -0,0 +1,11 @@
+<?xml version=\"1.0\" encoding=\"UTF-8\"?>
+<books>
+  <book>
+    <isbn>1400079985</isbn>
+    <title>War and Peace (Vintage Classics)</title>
+  </book>
+  <book>
+    <isbn>1143035008</isbn>
+    <title>Anna Karenina (Oprah's Book Club)</title>
+  </book>
+</books>