wordpress-wxr 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 3a6e12c55a5574216b7300de4ac2d1e533654527
+  data.tar.gz: 73272e1c15e8bb66364e6f7ccbe0eac645cf6df2
+SHA512:
+  metadata.gz: 4adbbf58d4272d8515858cc824e1e9c30d6d4b0f219e04c531901a08214242f3b460bb2afa3c4124011c82918aa991f3234eed0b2ba8d73d7c71ed45f649ce54
+  data.tar.gz: d98e0f54758da12b6c0eb98cdb92b968777632989cbe3224d68a667afca9014b4fd2a9d1d282805acdcdecbe13d77b43ffee5b81730a818fdab55221bcf0aff8

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,49 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, and in the interest of
+fostering an open and welcoming community, we pledge to respect all people who
+contribute through reporting issues, posting feature requests, updating
+documentation, submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free
+experience for everyone, regardless of level of experience, gender, gender
+identity and expression, sexual orientation, disability, personal appearance,
+body size, race, ethnicity, age, religion, or nationality.
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery
+* Personal attacks
+* Trolling or insulting/derogatory comments
+* Public or private harassment
+* Publishing other's private information, such as physical or electronic
+  addresses, without explicit permission
+* Other unethical or unprofessional conduct
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+By adopting this Code of Conduct, project maintainers commit themselves to
+fairly and consistently applying these principles to every aspect of managing
+this project. Project maintainers who do not follow or enforce the Code of
+Conduct may be permanently removed from the project team.
+
+This code of conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting a project maintainer at rjk@wormbytes.ca. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. Maintainers are
+obligated to maintain confidentiality with regard to the reporter of an
+incident.
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 1.3.0, available at
+[http://contributor-covenant.org/version/1/3/0/][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/3/0/

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in wordpress-xml-parser.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 ePublishing, Inc.
+
+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,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "wordpress/xml/parser"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/wordpress/wxr.rb

@@ -0,0 +1,50 @@
+require 'nokogiri'
+
+require 'wordpress/wxr/attachments'
+require 'wordpress/wxr/authors'
+require 'wordpress/wxr/categories'
+require 'wordpress/wxr/pages'
+require 'wordpress/wxr/posts'
+require 'wordpress/wxr/tags'
+require 'wordpress/wxr/version'
+
+module Wordpress
+  class WXR
+    def self.parse(path_to_xml)
+      file = File.open(path_to_xml)
+      new(::Nokogiri::XML(file.read.delete("\u0004")))
+    end
+
+    attr_reader :document
+    private :document
+
+    def initialize(document)
+      @document = document
+      freeze
+    end
+
+    def attachments
+      Attachments.new(document, self)
+    end
+
+    def authors
+      Authors.new(document, self)
+    end
+
+    def categories
+      Categories.new(document, self)
+    end
+
+    def pages
+      Pages.new(document, self)
+    end
+
+    def posts
+      Posts.new(document, self)
+    end
+
+    def tags
+      Tags.new(document, self)
+    end
+  end
+end

data/lib/wordpress/wxr/attachment.rb

@@ -0,0 +1,12 @@
+require 'wordpress/wxr/item'
+require 'uri'
+
+module Wordpress
+  class WXR
+    class Attachment < Item
+      def url
+        URI(node.xpath('wp:attachment_url').text)
+      end
+    end
+  end
+end

data/lib/wordpress/wxr/attachments.rb

@@ -0,0 +1,31 @@
+require 'wordpress/wxr/attachment'
+
+module Wordpress
+  class WXR
+    class Attachments
+      include Enumerable
+
+      attr_reader :document, :wxr
+      private :document, :wxr
+
+      def initialize(document, wxr)
+        @document = document
+        @wxr = wxr
+      end
+
+      def each
+        return enum_for(:each) unless block_given?
+
+        nodes.each do |node|
+          yield Attachment.new(node, wxr)
+        end
+      end
+
+      private
+
+      def nodes
+        document.xpath("//item[wp:post_type = 'attachment']")
+      end
+    end
+  end
+end

data/lib/wordpress/wxr/author.rb

@@ -0,0 +1,39 @@
+require 'wordpress/wxr/element'
+require 'email_address'
+
+module Wordpress
+  class WXR
+    class Author < Element
+      def id
+        Integer(node.xpath('wp:author_id').text)
+      end
+
+      def login
+        node.xpath('wp:author_login').text
+      end
+
+      def email
+        EmailAddress.new(node.xpath('wp:author_email').text)
+      end
+
+      def display_name
+        node.xpath('wp:author_display_name').text
+      end
+
+      def first_name
+        node.xpath('wp:author_first_name').text
+      end
+
+      def last_name
+        node.xpath('wp:author_last_name').text
+      end
+
+      def ==(other)
+        self.class == other.class &&
+          id == other.id &&
+          login == other.login
+      end
+      alias eql? ==
+    end
+  end
+end

data/lib/wordpress/wxr/authors.rb

@@ -0,0 +1,35 @@
+require 'wordpress/wxr/author'
+
+module Wordpress
+  class WXR
+    class Authors
+      include Enumerable
+
+      attr_reader :document, :wxr
+      private :document, :wxr
+
+      def initialize(document, wxr)
+        @document = document
+        @wxr = wxr
+      end
+
+      def each
+        return enum_for(:each) unless block_given?
+
+        nodes.each do |node|
+          yield Author.new(node, wxr)
+        end
+      end
+
+      def find_by(login:)
+        each.find { |author| author.login == login }
+      end
+
+      private
+
+      def nodes
+        document.xpath('//wp:author')
+      end
+    end
+  end
+end

data/lib/wordpress/wxr/categories.rb

@@ -0,0 +1,35 @@
+require 'wordpress/wxr/category'
+
+module Wordpress
+  class WXR
+    class Categories
+      include Enumerable
+
+      attr_reader :document, :wxr
+      private :document, :wxr
+
+      def initialize(document, wxr)
+        @document = document
+        @wxr = wxr
+      end
+
+      def each
+        return enum_for(:each) unless block_given?
+
+        nodes.each do |node|
+          yield Category.new(node, wxr)
+        end
+      end
+
+      def find_by(nicename:)
+        each.find { |category| category.nicename == nicename }
+      end
+
+      private
+
+      def nodes
+        document.xpath('//wp:category')
+      end
+    end
+  end
+end

data/lib/wordpress/wxr/category.rb

@@ -0,0 +1,29 @@
+require 'wordpress/wxr/element'
+
+module Wordpress
+  class WXR
+    class Category < Element
+      def id
+        Integer(node.xpath('wp:term_id').text)
+      end
+
+      def nicename
+        node.xpath('wp:category_nicename').text
+      end
+
+      def parent
+        wxr.categories.find_by(nicename: node.xpath('wp:category_parent').text)
+      end
+
+      def name
+        node.xpath('wp:cat_name').text
+      end
+
+      def ==(other)
+        self.class == other.class &&
+          id == other.id
+      end
+      alias eql? ==
+    end
+  end
+end

data/lib/wordpress/wxr/comment.rb

@@ -0,0 +1,41 @@
+require 'wordpress/wxr/element'
+require 'email_address'
+require 'uri'
+
+module Wordpress
+  class WXR
+    class Comment < Element
+      def author
+        node.xpath('wp:comment_author').text
+      end
+
+      def email
+        EmailAddress.new(node.xpath('wp:comment_author_email').text)
+      end
+
+      def url
+        URI(node.xpath('wp:comment_author_url').text)
+      end
+
+      def date
+        DateTime.parse(node.xpath('wp:comment_date').text)
+      end
+
+      def content
+        node.xpath('wp:comment_content').text
+      end
+
+      def approved?
+        node.xpath('wp:comment_approved').text.to_i == 1
+      end
+
+      def ==(other)
+        self.class == other.class &&
+          email == other.email &&
+          date == other.date &&
+          content == other.content
+      end
+      alias eql? ==
+    end
+  end
+end

data/lib/wordpress/wxr/element.rb

@@ -0,0 +1,13 @@
+module Wordpress
+  class WXR
+    class Element
+      attr_reader :node, :wxr
+      private :node, :wxr
+
+      def initialize(node, wxr)
+        @node = node
+        @wxr = wxr
+      end
+    end
+  end
+end

data/lib/wordpress/wxr/item.rb

@@ -0,0 +1,110 @@
+require 'wordpress/wxr/element'
+require 'wordpress/wxr/tag'
+require 'wordpress/wxr/category'
+# require 'wordpress/wxr/comments'
+
+require 'date'
+require 'uri'
+
+module Wordpress
+  class WXR
+    class Item < Element
+      def title
+        node.xpath('title').text
+      end
+
+      def link
+        URI(node.xpath('link').text)
+      end
+
+      def creator
+        wxr.authors.find_by(login: node.xpath('dc:creator').text)
+      end
+
+      def guid
+        node.xpath('guid').text
+      end
+
+      def content
+        node.xpath('content:encoded').text
+      end
+
+      def excerpt
+        node.xpath('excerpt:encoded').text
+      end
+
+      def id
+        Integer(node.xpath('wp:post_id').text)
+      end
+
+      def posted_at
+        # Attempt to use the GMT post date since it includes a timezone.
+        # Failing that, use the post_date which will use the current timezone.
+        DateTime.parse(node.xpath('wp:post_date_gmt').text)
+      rescue ArgumentError
+        DateTime.parse node.xpath('wp:post_date').text
+      end
+
+      def comment_status
+        # TODO: `opened` or `closed`
+        node.xpath('wp:comment_status').text
+      end
+
+      def ping_status
+        node.xpath('wp:ping_status').text
+      end
+
+      def name
+        node.xpath('wp:post_name').text
+      end
+
+      def status
+        node.xpath('wp:status').text
+      end
+
+      def tags
+        # xml dump has "post_tag" for wordpress 3.1 and "tag" for 3.0
+        path = if node.xpath("category[@domain='post_tag']").count > 0
+                 "category[@domain='post_tag']"
+               else
+                 "category[@domain='tag']"
+               end
+
+        node.xpath(path).map do |tag_node|
+          wxr.tags.find_by(slug: tag_node['nicename'])
+        end
+      end
+
+      def categories
+        node.xpath("category[@domain='category']").map do |cat|
+          wxr.categories.find_by(nicename: cat['nicename'])
+        end
+      end
+
+      # def comments
+      #   node.xpath('wp:comment').map do |comment_node|
+      #     Comment.new(comment_node)
+      #   end
+      # end
+
+      # TODO: status: publish, draft, pending, private, trash, inherit
+      def draft?
+        status != 'publish'
+      end
+
+      def published?
+        !draft?
+      end
+
+      def sticky?
+        !node.xpath('wp:is_sticky').text.to_i.zero?
+      end
+
+      def ==(other)
+        self.class == other.class &&
+          id == other.id
+      end
+      alias eql? ==
+    end
+  end
+end

data/lib/wordpress/wxr/page.rb

@@ -0,0 +1,8 @@
+require 'wordpress/wxr/item'
+
+module Wordpress
+  class WXR
+    class Page < Item
+    end
+  end
+end

data/lib/wordpress/wxr/pages.rb

@@ -0,0 +1,31 @@
+require 'wordpress/wxr/page'
+
+module Wordpress
+  class WXR
+    class Pages
+      include Enumerable
+
+      attr_reader :document, :wxr
+      private :document, :wxr
+
+      def initialize(document, wxr)
+        @document = document
+        @wxr = wxr
+      end
+
+      def each
+        return enum_for(:each) unless block_given?
+
+        nodes.each do |node|
+          yield Page.new(node, wxr)
+        end
+      end
+
+      private
+
+      def nodes
+        document.xpath("//item[wp:post_type = 'page']")
+      end
+    end
+  end
+end

data/lib/wordpress/wxr/post.rb

@@ -0,0 +1,8 @@
+require 'wordpress/wxr/item'
+
+module Wordpress
+  class WXR
+    class Post < Item
+    end
+  end
+end

data/lib/wordpress/wxr/posts.rb

@@ -0,0 +1,31 @@
+require 'wordpress/wxr/post'
+
+module Wordpress
+  class WXR
+    class Posts
+      include Enumerable
+
+      attr_reader :document, :wxr
+      private :document, :wxr
+
+      def initialize(document, wxr)
+        @document = document
+        @wxr = wxr
+      end
+
+      def each
+        return enum_for(:each) unless block_given?
+
+        nodes.each do |node|
+          yield Post.new(node, wxr)
+        end
+      end
+
+      private
+
+      def nodes
+        document.xpath("//item[wp:post_type = 'post']")
+      end
+    end
+  end
+end

data/lib/wordpress/wxr/tag.rb

@@ -0,0 +1,25 @@
+require 'wordpress/wxr/element'
+
+module Wordpress
+  class WXR
+    class Tag < Element
+      def id
+        Integer(node.xpath('wp:term_id').text)
+      end
+
+      def slug
+        node.xpath('wp:tag_slug').text
+      end
+
+      def name
+        node.xpath('wp:tag_name').text
+      end
+
+      def ==(other)
+        self.class == other.class &&
+          (name == other.name || id == other.id)
+      end
+      alias eql? ==
+    end
+  end
+end

data/lib/wordpress/wxr/tags.rb

@@ -0,0 +1,35 @@
+require 'wordpress/wxr/tag'
+
+module Wordpress
+  class WXR
+    class Tags
+      include Enumerable
+
+      attr_reader :document, :wxr
+      private :document, :wxr
+
+      def initialize(document, wxr)
+        @document = document
+        @wxr = wxr
+      end
+
+      def each
+        return enum_for(:each) unless block_given?
+
+        nodes.each do |node|
+          yield Tag.new(node, wxr)
+        end
+      end
+
+      def find_by(slug:)
+        each.find { |tag| tag.slug == slug }
+      end
+
+      private
+
+      def nodes
+        document.xpath('//wp:tag')
+      end
+    end
+  end
+end

data/lib/wordpress/wxr/version.rb

@@ -0,0 +1,5 @@
+module Wordpress
+  class WXR
+    VERSION = '0.1.0'
+  end
+end

data/wordpress-wxr.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'wordpress/wxr/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'wordpress-wxr'
+  spec.version       = Wordpress::WXR::VERSION
+  spec.authors       = ['ePublishing, inc.']
+  spec.email         = ['development@ePublishing.com']
+
+  spec.summary       = 'Parse a WordPress XML file into separate Ruby objects.'
+  spec.homepage      = 'https://bitbucket.org/epub_dev/wordpress-wxr'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_development_dependency 'bundler', '~> 1.12'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+
+  spec.add_runtime_dependency 'email_address', '~> 0.1.3'
+  spec.add_runtime_dependency 'nokogiri'
+end

metadata

@@ -0,0 +1,141 @@
+--- !ruby/object:Gem::Specification
+name: wordpress-wxr
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- ePublishing, inc.
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-03-13 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: email_address
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.1.3
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.1.3
+- !ruby/object:Gem::Dependency
+  name: nokogiri
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: 
+email:
+- development@ePublishing.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/wordpress/wxr.rb
+- lib/wordpress/wxr/attachment.rb
+- lib/wordpress/wxr/attachments.rb
+- lib/wordpress/wxr/author.rb
+- lib/wordpress/wxr/authors.rb
+- lib/wordpress/wxr/categories.rb
+- lib/wordpress/wxr/category.rb
+- lib/wordpress/wxr/comment.rb
+- lib/wordpress/wxr/element.rb
+- lib/wordpress/wxr/item.rb
+- lib/wordpress/wxr/page.rb
+- lib/wordpress/wxr/pages.rb
+- lib/wordpress/wxr/post.rb
+- lib/wordpress/wxr/posts.rb
+- lib/wordpress/wxr/tag.rb
+- lib/wordpress/wxr/tags.rb
+- lib/wordpress/wxr/version.rb
+- wordpress-wxr.gemspec
+homepage: https://bitbucket.org/epub_dev/wordpress-wxr
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.5
+signing_key: 
+specification_version: 4
+summary: Parse a WordPress XML file into separate Ruby objects.
+test_files: []