wp_conversion 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 327b7f9634c689d1232a2e0594c26c5e9c949f68
+  data.tar.gz: 6dd964531a5d61b3aa8ac3fe7fde947fa72a7ddb
+SHA512:
+  metadata.gz: 7ddb96ef601a3c71f4a6efbcc6162be44a2089852d588c5c601786dca2dc252e01471a9b95b28e046e27be51e84723d97c4cfe4d0238dbb964c51ffaf77eaa9b
+  data.tar.gz: 5dc68ed4eaf4a5bebe5eec78038c55a7a8d03ecd08333002d447b12284ead759c47e0f6becf6cd929aa64e357e2a0ddbda541f04996365147cacccba56340a9b

data/.gitignore

@@ -0,0 +1,5 @@
+.DS_Store
+results.html
+pkg
+html
+tmp/

data/.rspec

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

data/Gemfile

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

data/Gemfile.lock

@@ -0,0 +1,117 @@
+PATH
+  remote: .
+  specs:
+    wp_conversion (0.1.0)
+      activesupport
+      html_massage
+      methadone (~> 1.3.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activesupport (4.0.0)
+      i18n (~> 0.6, >= 0.6.4)
+      minitest (~> 4.2)
+      multi_json (~> 1.3)
+      thread_safe (~> 0.1)
+      tzinfo (~> 0.3.37)
+    aruba (0.5.3)
+      childprocess (>= 0.3.6)
+      cucumber (>= 1.1.1)
+      rspec-expectations (>= 2.7.0)
+    atomic (1.1.10)
+    builder (3.2.2)
+    childprocess (0.3.9)
+      ffi (~> 1.0, >= 1.0.11)
+    coderay (1.0.9)
+    cucumber (1.3.5)
+      builder (>= 2.1.2)
+      diff-lcs (>= 1.1.3)
+      gherkin (~> 2.12.0)
+      multi_json (~> 1.7.5)
+      multi_test (>= 0.0.2)
+    diff-lcs (1.2.4)
+    ffi (1.9.0)
+    formatador (0.2.4)
+    gherkin (2.12.0)
+      multi_json (~> 1.3)
+    guard (1.8.1)
+      formatador (>= 0.2.4)
+      listen (>= 1.0.0)
+      lumberjack (>= 1.0.2)
+      pry (>= 0.9.10)
+      thor (>= 0.14.6)
+    guard-cucumber (1.4.0)
+      cucumber (>= 1.2.0)
+      guard (>= 1.1.0)
+    guard-rspec (3.0.2)
+      guard (>= 1.8)
+      rspec (~> 2.13)
+    html_massage (0.2.1)
+      nokogiri (>= 1.4)
+      rest-client (>= 1.6)
+      reverse_markdown (>= 0.4)
+      sanitize (>= 2.0)
+      thor
+    i18n (0.6.4)
+    json (1.8.0)
+    listen (1.2.2)
+      rb-fsevent (>= 0.9.3)
+      rb-inotify (>= 0.9)
+      rb-kqueue (>= 0.2)
+    lumberjack (1.0.4)
+    methadone (1.3.0)
+      bundler
+    method_source (0.8.2)
+    mime-types (1.23)
+    mini_portile (0.5.1)
+    minitest (4.7.5)
+    multi_json (1.7.7)
+    multi_test (0.0.2)
+    nokogiri (1.6.0)
+      mini_portile (~> 0.5.0)
+    pry (0.9.12.2)
+      coderay (~> 1.0.5)
+      method_source (~> 0.8)
+      slop (~> 3.4)
+    rake (10.1.0)
+    rb-fsevent (0.9.3)
+    rb-inotify (0.9.0)
+      ffi (>= 0.5.0)
+    rb-kqueue (0.2.0)
+      ffi (>= 0.5.0)
+    rdoc (4.0.1)
+      json (~> 1.4)
+    rest-client (1.6.7)
+      mime-types (>= 1.16)
+    reverse_markdown (0.4.4)
+      nokogiri
+    rspec (2.14.1)
+      rspec-core (~> 2.14.0)
+      rspec-expectations (~> 2.14.0)
+      rspec-mocks (~> 2.14.0)
+    rspec-core (2.14.4)
+    rspec-expectations (2.14.0)
+      diff-lcs (>= 1.1.3, < 2.0)
+    rspec-mocks (2.14.1)
+    sanitize (2.0.6)
+      nokogiri (>= 1.4.4)
+    slop (3.4.6)
+    thor (0.18.1)
+    thread_safe (0.1.2)
+      atomic
+    tzinfo (0.3.37)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  aruba
+  bundler (~> 1.3)
+  guard
+  guard-cucumber
+  guard-rspec
+  rake
+  rdoc
+  rspec
+  wp_conversion!

data/Guardfile

@@ -0,0 +1,16 @@
+# Guardfile for wp_conversion gem
+
+# More info at https://github.com/guard/guard#readme
+
+guard 'cucumber', cli: '-c --format pretty --strict' do
+  watch(%r{^features/.+\.feature$})
+  watch(%r{^features/support/.+$})          { 'features' }
+  watch(%r{^features/step_definitions/(.+)_steps\.rb$}) { |m| Dir[File.join("**/#{m[1]}.feature")][0] || 'features' }
+end
+
+guard :rspec, cli: '-c --format documentation' do
+  watch(%r{^spec/.+_spec\.rb$})
+  watch(%r{^lib/(.+)\.rb$})     { |m| "spec/#{m[1]}_spec.rb" }
+  watch('spec/spec_helper.rb')  { "spec" }
+end
+

data/LICENSE.txt

@@ -0,0 +1,7 @@
+Copyright (c) 2013 YOUR NAME 
+
+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/README.md

@@ -0,0 +1,39 @@
+# WpConversion
+
+Convert a Wordpress XML export into pages suitable for a jekyll site
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'wp_conversion'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install wp_conversion
+
+## Usage
+
+    $ wp_conversion WPExport.xml
+
+This will create 3 directories: `posts`, `pages`, and `attachments`
+that will contain markdown files reflecting the items in the wordpress
+export. The posts and pages will be converted such that a site can be
+generated via jekyll.
+
+* Posts have the YYYY-MM-DD-title.markdown format.
+* Pages just have title.markdown.
+* Files will have the appropriate YAML header for jekyll processing.
+* Attachments will be YAML files with the link to the attachment.
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,66 @@
+def dump_load_path
+  puts $LOAD_PATH.join("\n")
+  found = nil
+  $LOAD_PATH.each do |path|
+    if File.exists?(File.join(path,"rspec"))
+      puts "Found rspec in #{path}"
+      if File.exists?(File.join(path,"rspec","core"))
+        puts "Found core"
+        if File.exists?(File.join(path,"rspec","core","rake_task"))
+          puts "Found rake_task"
+          found = path
+        else
+          puts "!! no rake_task"
+        end
+      else
+        puts "!!! no core"
+      end
+    end
+  end
+  if found.nil?
+    puts "Didn't find rspec/core/rake_task anywhere"
+  else
+    puts "Found in #{path}"
+  end
+end
+require 'bundler'
+require 'rake/clean'
+
+begin
+require 'rspec/core/rake_task'
+rescue LoadError
+dump_load_path
+raise
+end
+
+require 'cucumber'
+require 'cucumber/rake/task'
+gem 'rdoc' # we need the installed RDoc gem, not the system one
+require 'rdoc/task'
+
+include Rake::DSL
+
+Bundler::GemHelper.install_tasks
+
+
+RSpec::Core::RakeTask.new do |t|
+  # Put spec opts in a file named .rspec in root
+end
+
+
+CUKE_RESULTS = 'results.html'
+CLEAN << CUKE_RESULTS
+Cucumber::Rake::Task.new(:features) do |t|
+  t.cucumber_opts = "features --format html -o #{CUKE_RESULTS} --format pretty --no-source -x"
+  t.fork = false
+end
+
+Rake::RDocTask.new do |rd|
+  
+  rd.main = "README.rdoc"
+  
+  rd.rdoc_files.include("README.rdoc","lib/**/*.rb","bin/**/*")
+end
+
+task :default => [:spec,:features]
+

data/bin/wp_conversion

@@ -0,0 +1,63 @@
+#!/usr/bin/env ruby
+
+require 'optparse'
+require 'methadone'
+require 'wp_conversion'
+
+class App
+  include Methadone::Main
+  include Methadone::CLILogging
+  include WpConversion
+
+  main do |wp_xml|
+    begin
+
+      logger.level=Logger::WARN
+      logger.level=Logger::INFO if options[:verbose]
+      logger.error_level=Logger::DEBUG if options[:debug]
+      debug "options: #{options}"
+      debug "wp_xml:  #{wp_xml}"
+      
+      info "Reading #{wp_xml}"
+      items = WpConversion.xml_to_hash(File.read(wp_xml))['rss']['channel']['item']
+      info "#{items.size} items to save"
+
+      items.each do |item|
+        info "Saving item #{item['title']} as #{item['post_type']}"
+        if options[:yaml]
+          info "Saving as yaml"
+          WpConversion.save_an_item(item,:yaml)
+        end
+        info "Converting to markdown"
+        WpConversion.save_an_item(item,:markdown)
+      end
+
+    rescue Exception => e
+      error "#{e} (#{e.class})"
+      debug "Backtrace: \n" + e.backtrace.join("\n")
+    end
+    
+    
+  end
+
+  description "Convert Wordpress xml export to markdown files suitable for jekyll site"
+
+  # on("--flag VAL","Some flag")
+  # options[flag] will contain VAL
+  
+  # on("--[no-]switch","Some switch")
+  on("--verbose","Make wp_conversion chatty")
+  on("--debug",  "Turn on debug mode")
+  on("--yaml",   "Save items as yaml files as well")
+
+  arg :wp_xml, "Wordpress xml export file."
+
+  # Make an argument optional
+  # arg :optional_arg, :optional
+
+  version WpConversion::VERSION
+
+  # use_log_level_option
+
+  go!
+end

data/features/convert.feature

@@ -0,0 +1,50 @@
+Feature: convert a wordpress export to markdown
+  In order to convert a wordpress export to markdown
+  I will need run the conversion script
+
+  Background:
+    Given a test export xml file
+
+  Scenario: run the conversion script
+    When I successfully run "wp_conversion" with the test file
+    Then the exit status should be 0
+    And the output should match /^$/
+    And the following directories should exist:
+      |pages|
+      |posts|
+      |attachments|
+    And the following files should exist:
+      | posts/2010-05-03-introduction.markdown                                                    |
+      | posts/2010-05-03-thematic.markdown                                                        |
+      | posts/2010-05-28-a-problem-with-partial-lines.markdown                                    |
+      | posts/2010-05-28-buddymatic.markdown                                                      |
+      | posts/2010-05-29-another-problem-cant-set-background-colour-on-menu-bounding-box.markdown |
+      | posts/2013-07-06-this-site-is-going-away.markdown                                         |
+      | pages/a-haiku.markdown                                                                    |
+      | pages/a-little-child.markdown                                                             |
+      | pages/a-new-poem.markdown                                                                 |
+      | pages/and-you-learn.markdown                                                              |
+      | pages/be-careful-what-you-say-the-power-of-words.markdown                                 |
+
+  Scenario: save the items as yaml files
+    When I successfully run "wp_conversion" with the "yaml" switch and the test file
+    Then the exit status should be 0
+    And the output should match /^$/
+    And the following directories should exist:
+      |pages|
+      |posts|
+      |attachments|
+    And the following files should exist:
+      | posts/2010-05-03-introduction.yaml                                                    |
+      | posts/2010-05-03-thematic.yaml                                                        |
+      | posts/2010-05-28-a-problem-with-partial-lines.yaml                                    |
+      | posts/2010-05-28-buddymatic.yaml                                                      |
+      | posts/2010-05-29-another-problem-cant-set-background-colour-on-menu-bounding-box.yaml |
+      | posts/2013-07-06-this-site-is-going-away.yaml                                         |
+      | pages/a-haiku.yaml                                                                    |
+      | pages/a-little-child.yaml                                                             |
+      | pages/a-new-poem.yaml                                                                 |
+      | pages/and-you-learn.yaml                                                              |
+      | pages/be-careful-what-you-say-the-power-of-words.yaml                                 |
+
+    

data/features/step_definitions/convert_steps.rb

@@ -0,0 +1,8 @@
+Given(/^a test export xml file$/) do
+  $test_xml_file = File.join(File.expand_path("../../support",__FILE__),'test_data','test.xml')
+  File.exist?($test_xml_file)
+end
+
+When(/^I successfully run "(.*?)" with(?: the "(.*?)" switch and)? the test file$/) do |arg1, switch|
+  step("I successfully run `#{arg1} --#{switch} #{$test_xml_file}`")
+end

data/features/step_definitions/testing_fep.rb

@@ -0,0 +1 @@
+puts File.join(File.expand_path("../../support",__FILE__),'test_data','test.xml')

data/features/step_definitions/wp_conversion_steps.rb

@@ -0,0 +1 @@
+# Put your step definitions here

data/features/support/env.rb

@@ -0,0 +1,16 @@
+require 'aruba/cucumber'
+require 'methadone/cucumber'
+
+ENV['PATH'] = "#{File.expand_path(File.dirname(__FILE__) + '/../../bin')}#{File::PATH_SEPARATOR}#{ENV['PATH']}"
+LIB_DIR = File.join(File.expand_path(File.dirname(__FILE__)),'..','..','lib')
+
+Before do
+  # Using "announce" causes massive warnings on 1.9.2
+  @puts = true
+  @original_rubylib = ENV['RUBYLIB']
+  ENV['RUBYLIB'] = LIB_DIR + File::PATH_SEPARATOR + ENV['RUBYLIB'].to_s
+end
+
+After do
+  ENV['RUBYLIB'] = @original_rubylib
+end