document_builder 0.1.2 → 0.2.0

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    ZWNiNzZjNjY4MzVhMmNiNTZmOGRhMWEyODE4ZWZkZjM1MGVkYWZjZQ==
+    ZGFkOWQ4NTM0NDI2ZTFiZDk0ZjczODgwYWQ2OWI4YmI4N2FjZDM0Mg==
   data.tar.gz: !binary |-
-    Yjk4MTRiZjdjOTk1ZDQ5YjJjMTA3NzUyM2UyZmNjYmQyYTRkMWRkYg==
+    NjkyNGU1MmIwMDZkYTZiZWJhNjg2Njg3MTMxNWVkY2QzOTFiODcxNw==
 SHA512:
   metadata.gz: !binary |-
-    ZDg0NjMwZjU4ZWYzMThhOTRmMzQ1MmMyODc4MTQ5YTQwMTJkMGI5MmQyNjQy
-    MmNlNTk1ZTI5N2EzOWEzZWZjOTc0Yjk2YWRkYTg0YjlkODQ4NzM4NjMzMDRi
-    NTU4MTU1YzRjN2Q3ZjcxYjBmYTUxMTU5MDU2ZDFkN2E4ZTkwOGU=
+    NzRkNzY1YTIyZjg1MzQ3NGVmY2ZjMzEyNjFhYmRlNmFlMjU0YWJmZThlYWRk
+    YmQ4ZTJiMTgwZDhmYzQ1ODJhMjgzZWJmZjg2ODhkNDM3YzU1ZDMzNWI2M2Nh
+    ZjNjMjFiY2IwOWYxNzkxMjgyN2VkNmM3ZTYzNzU4Mzk0ODIyMzc=
   data.tar.gz: !binary |-
-    NWJlMjNhYjEwZTdmMTUyYmU4Y2I2N2U1NzAyZTRmNGQ2ZjBlYzVmYjA1MGZm
-    ZmRmNjkwYWYzYTllYTgxYWFiOTI5ZTljYzBkZjMwNTY5NTJjYmFkNWIwOTg1
-    OTdkMGZmMGQ2Zjc1MGI4MWE0YjlhN2E1ZGMzN2E0MTk0MTIwNWE=
+    N2Y5MGE1M2IzZTQ5ZjdjMWRjMDIyMzU3MThlNTkxOTIzZDAzNzM1NmY1MzM5
+    MmVkMzE3YTVhYzI1ZDAxNjU2MmVmMTlkYmEzMTcxYzI2MWIwMjY0OWQ4Yjhm
+    NDkyODdmNzMyNGFiNGE2NjI2ZjdmZDZhZGY5M2JiMTE3MWY0ZWE=

data/README.md

@@ -27,97 +27,53 @@ Or install it yourself as:
 following example
 
 ```ruby
-module Document
-  class Category
-    include DocumentBuilder::Model
-    xpath 'category'
-    attribute :domain, 'domain', DocumentBuilder::ElementAttribute
-    attribute :nicename, 'nicename', DocumentBuilder::ElementAttribute
-    attribute :body, nil, DocumentBuilder::ChildAttribute
-  end
-
-  class Postmeta
-    include DocumentBuilder::Model
-    xpath 'postmeta'
-    attribute :key, "wp:meta_key"
-    attribute :value, "wp:meta_value", DocumentBuilder::IntegerAttribute
-  end
-
-  class PostmetaCollection
-    include DocumentBuilder::Collection
-    xpath "item"
-    collection :postmeta, "//wp:postmeta", Postmeta
-  end
-
-  class Post
-    include DocumentBuilder::Model
-    xpath "item"
-    attribute :title
-    attribute :link
-    attribute :pub_date, "pubDate", DocumentBuilder::TimeAttribute
-    attribute :creator, "dc:creator"
-    attribute :content, "content:encoded"
-    attribute :excerpt, "excerpt:encoded"
-    attribute :id, "wp:post_id", DocumentBuilder::IntegerAttribute
-    attribute :published_at, 'wp:post_date_gmt', DocumentBuilder::TimeAttribute
-    attribute :comment_status, "wp:comment_status"
-    attribute :ping_status, "wp:ping_status"
-    attribute :name, 'wp:post_name'
-    attribute :status, "wp:status"
-    attribute :parent, "wp:post_parent", DocumentBuilder::IntegerAttribute
-    attribute :menu_order, "wp:menu_order", DocumentBuilder::IntegerAttribute
-    attribute :type, "wp:post_type"
-    attribute :is_sticky, "wp:is_sticky", DocumentBuilder::IntegerAttribute
-    attribute :category, "category", Category
-    attribute :postmetas, 'item', PostmetaCollection
-  end
+class ListItem
+  include DocumentBuilder::Model
+  property :name, type: TextProperty
 end
 
-### Using Model Objects
+class SomeDocument
+  include DocumentBuilder::Model
+  root "//root"
+  collection :collection, selector: "//collection//inner-list-item", type: ListItem
+  collection :outer_collection, selector: "outer-list-item", type: ListItem
+  property :property, selector: "//property", type: TextProperty
+end
 ```
 
 ```ruby
-# Read an xml file
-url = "https://raw.githubusercontent.com/bullfight/wrxer/master/spec/fixtures/wrx.xml"
-uri = URI.parse(url)
-
-uri.open do |file|
-  document = Nokogiri::XML(file.read).xpath('//channel').at_xpath('item')}
-end
-
-post = Document::Post.call(document)
-
-=> #<Wrxer::Post:0x3fd4799693ac> Attributes: {
-  "title": "Welcome To Wrxer News.",
-  "link": "https://wrxernews.wordpress.com/2007/11/17/welcome-to-wrxer-news/",
-  "pub_date": "2007-11-17 21:30:51 +0000",
-  "creator": "wrxernews",
-  "content": "Welcome to <strong>Wrxer News</strong> - The most up-to-date and reliable source for Wrxer news.",
-  "excerpt": "Excerpt Text",
-  "id": 3,
-  "published_at": "2007-11-17 21:30:51 -0800",
-  "comment_status": "open",
-  "ping_status": "open",
-  "name": "welcome-to-wrxer-news",
-  "status": "publish",
-  "parent": 0,
-  "menu_order": 0,
-  "type": "post",
-  "is_sticky": 0,
-  "category": {
-    "domain": "category",
-    "nicename": "wrxer-news",
-    "body": "Wrxer News"
-  },
-  "postmetas": {
-    "data": "#<Enumerator::Lazy:0x007fa8f315a970>"
-  },
-  "comments": {
-    "data": "#<Enumerator::Lazy:0x007fa8f315a3f8>"
-  }
+require 'document_builder'
+require 'nokogiri'
+
+DOCUMENT = <<-XML
+  <root>
+    <collection>
+      <inner-list-item>Inner Item 1</inner-list-item>
+      <inner-list-item>Inner Item 2</inner-list-item>
+    </collection>
+    <outer-list-item>Outer Item 1</outer-list-item>
+    <outer-list-item>Outer Item 2</outer-list-item>
+    <property>Some Property</property>
+  </root>
+XML
+
+document = Nokogiri::XML(DOCUMENT)
+some_document = SomeDocument.new(document)
+
+=> #<SomeDocument:0x3fd4799693ac> Attributes: {
+  "collection": [
+    { "name": "Inner Item 1" },
+    { "name": "Inner Item 2" }
+  ],
+  "outer_collection": [
+    { "name": "Outer Item 1" },
+    { "name": "Outer Item 2" }
+  ],
+  "property": "Some Property"
 }
-post.title
-=> "Welcome To Wrxer News."
+
+some_document.property
+=> "Some Property"
 ```
 
 ## Contributing

data/lib/document_builder.rb

@@ -4,9 +4,10 @@ require 'active_support/time'
 require 'json'
 
 require 'document_builder/coercion'
-require 'document_builder/attribute'
-require 'document_builder/model'
+require 'document_builder/property'
 require 'document_builder/collection'
+require 'document_builder/tag'
+require 'document_builder/model'
 
 module DocumentBuilder
 end

data/lib/document_builder/coercion.rb

@@ -1,16 +1,7 @@
 module DocumentBuilder
   module Coercion
     module ClassMethods
-      def xpath(value)
-        @xpath = value
-      end
-
-      def call(document, params = {})
-        root = @xpath || params[:xpath]
-        unless document.name == root
-          document = document.at_xpath(root)
-        end
-
+      def call(document)
         document.nil? ? nil : self.coerce(document)
       end
 
@@ -22,59 +13,35 @@ module DocumentBuilder
     def self.included(base)
       base.extend(ClassMethods)
     end
-  end
-
-  class TextAttribute
-    include Coercion
-    def self.coerce(document)
-      document.text
-    end
-  end
-
-  class IntegerAttribute
-    include Coercion
-    def self.coerce(document)
-      Integer(document.text)
-    end
-  end
-
-  class TimeAttribute
-    include Coercion
-    def self.coerce(document)
-      Time.parse(document.text)
-    end
-  end
 
-  class UtcTimeAttribute
-    include Coercion
-    def self.coerce(document)
-      Time.use_zone("UTC") do
-        Time.zone.parse(document.text)
+    class TextProperty
+      include Coercion
+      def self.coerce(document)
+        document.text
       end
     end
-  end
-
-  class ElementAttribute
-    include Coercion
-    def self.call(document, params = {})
-      element = document.attributes[params[:xpath].to_s]
-      element.nil? ? nil : self.coerce(element)
-    end
 
-    def self.coerce(document)
-      document.value
+    class IntegerProperty
+      include Coercion
+      def self.coerce(document)
+        Integer(document.text)
+      end
     end
-  end
 
-  class ChildAttribute
-    include Coercion
-    def self.call(document, params = {})
-      child = document.children
-      child.empty? ? nil : self.coerce(child)
+    class TimeProperty
+      include Coercion
+      def self.coerce(document)
+        Time.parse(document.text)
+      end
     end
 
-    def self.coerce(document)
-      document.text
+    class UtcTimeProperty
+      include Coercion
+      def self.coerce(document)
+        Time.use_zone("UTC") do
+          Time.zone.parse(document.text)
+        end
+      end
     end
   end
 end

data/lib/document_builder/collection.rb

@@ -1,55 +1,40 @@
 module DocumentBuilder
-  module Collection
-    module ClassMethods
-      def call(document, params = {})
-        root = @xpath || params[:xpath]
-        unless document.name == root
-          document = document.xpath(root)
-        end
-
-        document.nil? ? nil : self.coerce(document)
-      end
-
-      def collection(value, xpath, parser)
-        @collection = Attribute.new(value, xpath, parser)
-      end
-
-      def inherited(subclass)
-        subclass.instance_variable_set(:@collection, @collection)
-        super
-      end
+  class Collection
+    include Enumerable
+    attr_reader :name, :selector, :type, :node
+
+    def initialize(name, selector:, type:)
+      @name = name
+      @selector = selector
+      @type = type
     end
 
-    def self.included(base)
-      base.extend(ClassMethods)
-      base.class_eval do
-        include Model
-        include Enumerable
-      end
-    end
-
-    def collection
-      self.class.instance_variable_get(:@collection)
+    def call(document)
+      return nil if document.nil?
+      @node = document.xpath(selector)
+      self
     end
 
-    def each(&block)
-      document.xpath(collection.xpath).each do |item|
-        block.call(
-          collection.call(item)
-        )
+    def each
+      @node.each do |element|
+        yield type.new(element)
       end
     end
 
-    def data
-      lazy
+    def to_s(*args)
+      JSON.pretty_generate(to_hash)
     end
 
     def inspect
-      "#<#{self.class}:0x#{self.object_id.to_s(16)}> { data: #{data} } }"
+      "#<#{self.class}:0x#{self.object_id.to_s(16)}> Attributes: " + JSON.pretty_generate(to_hash)
+    end
+
+    def to_json(*args)
+      JSON.generate(to_hash)
     end
 
     def to_hash
-      { data: data }
+      entries.map(&:to_hash)
     end
   end
 end

data/lib/document_builder/model.rb

@@ -1,23 +1,42 @@
 module DocumentBuilder
   module Model
     module ClassMethods
-      def attribute(name, xpath = nil, coercion = TextAttribute)
-        @attributes ||= []
-        @attributes << Attribute.new(name, xpath || name.to_s, coercion)
+      def add_attribute(name, attribute)
+        @attributes ||= {}
+        @attributes[name.to_sym] = attribute
+      end
+
+      def property(name, selector: nil, type: nil)
+        add_attribute name, Property.new(name, selector: selector, type: type)
+      end
+
+      def tag(name, selector: nil, type: nil)
+        add_attribute name, Tag.new(name, selector: selector, type: type)
+      end
+
+      def collection(name, selector: nil, type: nil)
+        add_attribute name, Collection.new(name, selector: selector, type: type)
+      end
+
+      def root(selector)
+        @root = selector
       end
 
       def inherited(subclass)
         subclass.instance_variable_set(:@attributes, @attributes)
+        subclass.instance_variable_set(:@root, @root)
         super
       end
+
+      def call(document)
+        self.new(document)
+      end
     end
 
     def self.included(base)
       base.extend(ClassMethods)
       base.class_eval do
         include Coercion
-
-        attr_reader :document
       end
     end
 
@@ -25,16 +44,40 @@ module DocumentBuilder
       @document = document
     end
 
+    def document
+      if root && @document.name != root
+        @document.at_xpath(root)
+      else
+        @document
+      end
+    end
+
+    def root
+      self.class.instance_variable_get(:@root)
+    end
+
     def attributes
       self.class.instance_variable_get(:@attributes)
     end
 
+    def get_attribute(name)
+      if respond_to?(name)
+        public_send(name)
+      else
+        attributes[name].call(document)
+      end
+    end
+
+    def add_attribute(name, attribute)
+      self.class.add_attribute(name, attribute)
+    end
+
     def [](key)
-      attributes.select { |item| item.name == key.to_sym}.first.call(document)
+      get_attribute(key)
     end
 
     def method_missing(name, *args)
-      attributes.select { |item| item.name == name }.first.call(document)
+      get_attribute(name)
     rescue NoMethodError => e
       raise NoMethodError.new("undefined method '#{name}' for #{self.class}")
     end
@@ -53,8 +96,8 @@ module DocumentBuilder
 
     def to_hash
       attributes.inject({}) do |acc, (key, value)|
-        value = key.call(document)
-        acc[key.name] = value.respond_to?(:to_hash) ? value.to_hash : value
+        obj = get_attribute(key)
+        acc[key] = obj.respond_to?(:to_hash) ? obj.to_hash : obj
         acc
       end
     end

data/lib/document_builder/property.rb

@@ -0,0 +1,23 @@
+module DocumentBuilder
+  class Property
+    attr_reader :name, :selector, :type, :node
+
+    def initialize(name, type: nil, selector: nil)
+      @name = name
+      @selector = selector
+      @type = type || Coercion::TextProperty
+    end
+
+    def call(document)
+      return nil if document.nil?
+
+      if selector.nil? || document.name == selector
+        @node = document
+      else
+        @node =  document.at_xpath(selector)
+      end
+
+      type.call(@node)
+    end
+  end
+end

data/lib/document_builder/tag.rb

@@ -0,0 +1,18 @@
+module DocumentBuilder
+  class Tag
+    attr_reader :name, :selector, :type, :node
+
+    def initialize(name, type: nil, selector: nil)
+      @name = name
+      @selector = selector
+      @type = type || Coercion::TextProperty
+    end
+
+    def call(document)
+      return nil if document.nil?
+
+      @node = selector.nil? ? document : document.attributes[selector]
+      type.call(@node)
+    end
+  end
+end

data/lib/document_builder/version.rb

@@ -1,3 +1,3 @@
 module DocumentBuilder
-  VERSION = "0.1.2"
+  VERSION = "0.2.0"
 end

data/spec/document_builder/model_spec.rb

@@ -0,0 +1,53 @@
+require 'spec_helper'
+require 'nokogiri'
+
+RSpec.describe DocumentBuilder::Model do
+  DOCUMENT = <<-XML
+    <root>
+      <collection>
+        <inner-list-item>Inner Item 1</inner-list-item>
+        <inner-list-item>Inner Item 2</inner-list-item>
+      </collection>
+      <outer-list-item>Outer Item 1</outer-list-item>
+      <outer-list-item>Outer Item 2</outer-list-item>
+      <property>Some Property</property>
+    </root>
+  XML
+
+  let(:document) { Nokogiri::XML(DOCUMENT) }
+
+  class ListItem
+    include DocumentBuilder::Model
+    property :name, type: TextProperty
+  end
+
+  class SomeDocument
+    include DocumentBuilder::Model
+    root "//root"
+    collection :collection, selector: "//collection//inner-list-item", type: ListItem
+    collection :outer_collection, selector: "outer-list-item", type: ListItem
+    property :property, selector: "//property", type: TextProperty
+  end
+
+  subject { SomeDocument.new(document) }
+
+  it 'returns the root' do
+    expect(subject.root).to eq "//root"
+  end
+
+  it 'returns an innner collection' do
+    expect(subject.collection).to be_a DocumentBuilder::Collection
+    expect(subject.collection.first).to be_a ListItem
+    expect(subject.collection.first.name).to eq "Inner Item 1"
+  end
+
+  it 'returns an outer collection' do
+    expect(subject.outer_collection).to be_a DocumentBuilder::Collection
+    expect(subject.outer_collection.first).to be_a ListItem
+    expect(subject.outer_collection.first.name).to eq "Outer Item 1"
+  end
+
+  it 'returns a property' do
+    expect(subject.property).to eq "Some Property"
+  end
+end

data/spec/fixtures/document.rb

@@ -1,46 +1,38 @@
 module Document
   class Category
     include DocumentBuilder::Model
-    xpath 'category'
-    attribute :domain, 'domain', DocumentBuilder::ElementAttribute
-    attribute :nicename, 'nicename', DocumentBuilder::ElementAttribute
-    attribute :body, nil, DocumentBuilder::ChildAttribute
+    tag :domain, selector: 'domain'
+    tag :nicename, selector: 'nicename'
+    property :body, selector: 'category'
   end
 
   class Postmeta
     include DocumentBuilder::Model
-    xpath 'postmeta'
-    attribute :key, "wp:meta_key"
-    attribute :value, "wp:meta_value", DocumentBuilder::IntegerAttribute
-  end
-
-  class PostmetaCollection
-    include DocumentBuilder::Collection
-    xpath "item"
-    collection :postmeta, "//wp:postmeta", Postmeta
+    property :key, selector: "wp:meta_key"
+    property :value, selector: "wp:meta_value", type: IntegerProperty
   end
 
   class Post
     include DocumentBuilder::Model
-    xpath "item"
-    attribute :title
-    attribute :link
-    attribute :pub_date, "pubDate", DocumentBuilder::UtcTimeAttribute
-    attribute :creator, "dc:creator"
-    attribute :content, "content:encoded"
-    attribute :excerpt, "excerpt:encoded"
-    attribute :id, "wp:post_id", DocumentBuilder::IntegerAttribute
-    attribute :post_date, 'wp:post_date', DocumentBuilder::TimeAttribute
-    attribute :post_date_gmt, 'wp:post_date_gmt', DocumentBuilder::UtcTimeAttribute
-    attribute :comment_status, "wp:comment_status"
-    attribute :ping_status, "wp:ping_status"
-    attribute :name, 'wp:post_name'
-    attribute :status, "wp:status"
-    attribute :parent, "wp:post_parent", DocumentBuilder::IntegerAttribute
-    attribute :menu_order, "wp:menu_order", DocumentBuilder::IntegerAttribute
-    attribute :type, "wp:post_type"
-    attribute :is_sticky, "wp:is_sticky", DocumentBuilder::IntegerAttribute
-    attribute :category, "category", Category
-    attribute :postmetas, 'item', PostmetaCollection
+    root "//item"
+    property :title, selector: "title"
+    property :link, selector: "link"
+    property :pub_date, selector: "pubDate", type: UtcTimeProperty
+    property :creator, selector: "dc:creator"
+    property :content, selector: "content:encoded"
+    property :excerpt, selector: "excerpt:encoded"
+    property :id, selector: "wp:post_id", type: IntegerProperty
+    property :post_date, selector: 'wp:post_date', type: TimeProperty
+    property :post_date_gmt, selector: 'wp:post_date_gmt', type: UtcTimeProperty
+    property :comment_status, selector: "wp:comment_status"
+    property :ping_status, selector: "wp:ping_status"
+    property :name, selector: 'wp:post_name'
+    property :status, selector: "wp:status"
+    property :parent, selector: "wp:post_parent", type: IntegerProperty
+    property :menu_order, selector: "wp:menu_order", type: IntegerProperty
+    property :type, selector: "wp:post_type"
+    property :is_sticky, selector: "wp:is_sticky", type: IntegerProperty
+    property :category, selector: "//category", type: Category
+    collection :postmetas, selector: '//wp:postmeta', type: Postmeta
   end
 end

data/spec/integration_spec.rb

@@ -45,6 +45,8 @@ describe Document::Post do
 
     it 'has a category' do
       expect(subject.category).to be_a Document::Category
+      expect(subject.category.domain).to eq "category"
+      expect(subject.category.body).to eq "Wrxer News"
     end
 
     it 'has is_sticky' do
@@ -53,6 +55,7 @@ describe Document::Post do
 
     it 'has postmetas' do
       expect(subject.postmetas.first).to be_a Document::Postmeta
+      expect(subject.postmetas.first.key).to_not eq nil
     end
 
     it 'does not have a not foo' do
@@ -61,7 +64,7 @@ describe Document::Post do
     end
   end
 
-  context "nil attribute case" do
+  context "nil property case" do
     let(:filename) { fixture('missing_fields.xml') }
     let(:document) { Nokogiri::XML(filename.read).xpath('//channel').at_xpath('item')}
     subject { described_class.call(document) }
@@ -85,7 +88,7 @@ describe Document::Post do
     subject { described_class.new(document) }
 
     it 'returns nil for category' do
-      expect(subject.category).to eq nil
+      expect(subject.category).to be_a Document::Category
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: document_builder
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.2.0
 platform: ruby
 authors:
 - Patrick Schmitz
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-04-09 00:00:00.000000000 Z
+date: 2015-09-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -111,11 +111,13 @@ files:
 - Rakefile
 - document_builder.gemspec
 - lib/document_builder.rb
-- lib/document_builder/attribute.rb
 - lib/document_builder/coercion.rb
 - lib/document_builder/collection.rb
 - lib/document_builder/model.rb
+- lib/document_builder/property.rb
+- lib/document_builder/tag.rb
 - lib/document_builder/version.rb
+- spec/document_builder/model_spec.rb
 - spec/document_builder_spec.rb
 - spec/fixtures/document.rb
 - spec/fixtures/missing_fields.xml
@@ -147,6 +149,7 @@ signing_key:
 specification_version: 4
 summary: A document builder for nokogiri documents.
 test_files:
+- spec/document_builder/model_spec.rb
 - spec/document_builder_spec.rb
 - spec/fixtures/document.rb
 - spec/fixtures/missing_fields.xml

data/lib/document_builder/attribute.rb

@@ -1,7 +0,0 @@
-module DocumentBuilder
-  class Attribute < Struct.new(:name, :xpath, :coercion)
-    def call(document, params = {})
-      coercion.call(document, { xpath: xpath })
-    end
-  end
-end