ascii_press 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: dffcb104898a26201bd65d8ee065e16b277d7c9e
-  data.tar.gz: bcef3472d8592080fffa9f3508311dc841fb2e40
+  metadata.gz: 37d6a2018a0f90579ba668606675a3c56476e234
+  data.tar.gz: ecb49c8631633d9486776fa24fa0740b95503e64
 SHA512:
-  metadata.gz: 75673e806f48540665343e9ce1db0e5bf283ed4d94656f4af9ecade5e5f3d1f3222819d7d3e914e2a40aa1a5417a9e69d3f31cabfaf7b444800936cb189ff750
-  data.tar.gz: e7da91e2342a3124cf930015accaa915c507c5e20996a769b0ab7cc5b75c3af78bfa97a177af801bed21b95aa03bb186aa9035504a2acad17d58086a81d74b8a
+  metadata.gz: 0de878a7dabb9d416bad0672f746f2e53f622c2367c0ec85dd379b2981b64ea5e38e6c25bb70896f9edbe393ab5d2ccdbb1d779e6d0b395f5df816c3b14835de
+  data.tar.gz: fe030d7a0600125fa28adb2ba4529eb971026c4a58ee685354542b9f8dcdaf0e9feaefc85c55d03380569ed9ddaa556a3db4ed2e6334b21fc8aa640a7be4e924

data/README.md

@@ -1,8 +1,6 @@
 # AsciiPress
 
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/ascii_press`. To experiment with that code, run `bin/console` for an interactive prompt.
-
-TODO: Delete this and the text above, and describe your gem
+AsciiPress is a gem which is designed to make it easy to publish a set of [asciidoc](http://asciidoctor.org/) files to a specific `post_type` in a WordPress site.  You can see an example in action in the [`render.rb` file](https://github.com/neo4j-contrib/developer-resources/blob/gh-pages/render.rb) to generate the Neo4j developer website.
 
 ## Installation
 
@@ -22,7 +20,38 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+The main API to synchronize documents with WordPress in the `WordPressSyncer`.  To create a new `WordPressSyncer` you need to provide a hostname, username, password, and a `AsciiPress::Renderer` object.  The following is an example:
+
+```ruby
+WP_HOSTNAME = 'fakepress.com'
+WP_USERNAME = 'fake'
+WP_PASSWORD = 'pass'
+WP_POST_TYPE = 'faq'
+
+# Available keys for options are:
+# `:asciidoc_options`: Passed directly to the `Asciidoctor.load` method
+# `:before_convertion`: Proc which is given the asciidoctor text.  Whatever is returned is passed to `Asciidoctor.load`
+# `:after_conversion`: Proc which is given the html text after the Asciidoctor conversion.  Whatever is returned will be uploaded to WordPress
+# `:extra_tags_proc`: Proc which is given the `AsciiPress::Renderer::Rendering` object (see below).  Whatever is returned will be used as the WordPress Post's tags
+renderer = AsciiPress::Renderer.new(extra_tags_proc: -> (rendering) { ['tag-for-all'] }, asciidoc_options: {attributes: 'allow-uri-read'})
+
+wp_syncer = AsciiPress::WordPressSyncer.new(WP_HOSTNAME, WP_USERNAME, WP_PASSWORD, renderer, WP_POST_TYPE
+                                         post_type: ENV['BLOG_POST_TYPE'],
+                                         logger: LOGGER,
+                                         delete_not_found: delete_not_found,
+                                         generate_tags: true,
+                                         filter_proc: filter_proc)
+```
+
+### `AsciiPress::Renderer::Rendering`
+
+Provides the following methods:
+
+ * `html` The HTML resulting from the asciidoc
+ * `doc` The `Asciidoctor::Document` object from the `asciidoctor` gem
+ * `data` The adoc file's attributes standardized with symbol keys and string values
+ * `tags` The tags which will be set in `WordPress`
+
 
 ## Development
 

data/lib/ascii_press.rb

@@ -58,7 +58,7 @@ module AsciiPress
         if before_convertion = @options[:before_convertion]
           document_text = before_convertion.call(document_text)
         end
-        doc = Asciidoctor.load(document_text, @options.merge(base_dir: base_dir))
+        doc = Asciidoctor.load(document_text, @options[:asciidoc_options].merge(base_dir: base_dir))
       end
       puts errors.split(/[\n\r]+/).reject {|line| line.match(/out of sequence/) }.join("\n")
 
@@ -95,10 +95,10 @@ module AsciiPress
   end
 
   class WordPressSyncer
-    def initialize(blog_id, username, password, renderer, options = {})
+    def initialize(blog_id, username, password, post_type, renderer, options = {})
       @blog_id = blog_id
       @wp_client = Rubypress::Client.new(host: @blog_id, username: username, password: password)
-      @post_type = options[:post_type] || 'faq'
+      @post_type = post_type
       @logger = options[:logger] || AsciiPress.logger
       @renderer = renderer || Renderer.new
       @filter_proc = options[:filter_proc] || Proc.new { true }
@@ -215,10 +215,12 @@ module AsciiPress
   }
 
   def self.slug_valid?(slug, rules = DEFAULT_SLUG_RULES)
-    rules.values.all? {|rule| rule.call(slug) }
+    slug && rules.values.all? {|rule| rule.call(slug) }
   end
 
   def self.violated_slug_rules(slug, rules = DEFAULT_SLUG_RULES)
+    return ['No slug'] if slug.nil?
+
     rules.reject do |desc, rule|
       rule.call(slug)
     end.map(&:first)
@@ -239,7 +241,7 @@ module AsciiPress
       require 'colorize'
       data.each do |path, slug, violations|
         puts 'WARNING!!'.red
-        puts "The document #{path.blue} has the #{slug.blue} which in invalid because:"
+        puts "The document #{path.light_blue} has the slug #{slug.inspect.light_blue} which in invalid because:"
         violations.each do |violation|
           puts "  - #{violation.yellow}"
         end

data/lib/ascii_press/version.rb

@@ -1,3 +1,3 @@
 module AsciiPress
-  VERSION = "0.2.0"
+  VERSION = "0.3.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ascii_press
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Brian Underwood
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-05-09 00:00:00.000000000 Z
+date: 2016-05-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rubypress