ascii_press 0.3.0 → 0.5.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 37d6a2018a0f90579ba668606675a3c56476e234
-  data.tar.gz: ecb49c8631633d9486776fa24fa0740b95503e64
+  metadata.gz: e8f78af8f04afac24ade0bd60bc336fc12d22408
+  data.tar.gz: 967d7ec8a7a89913f0b18abd59272089c6beea94
 SHA512:
-  metadata.gz: 0de878a7dabb9d416bad0672f746f2e53f622c2367c0ec85dd379b2981b64ea5e38e6c25bb70896f9edbe393ab5d2ccdbb1d779e6d0b395f5df816c3b14835de
-  data.tar.gz: fe030d7a0600125fa28adb2ba4529eb971026c4a58ee685354542b9f8dcdaf0e9feaefc85c55d03380569ed9ddaa556a3db4ed2e6334b21fc8aa640a7be4e924
+  metadata.gz: 76597f4f7881a111821d526f0a84cc08106ac1824d13852b12098445f7f0856f2175bfcd1d2dad02fe91b4aa71ec87ddba82e6810d356ca6ab1bfa865111708e
+  data.tar.gz: c9218ef67f48ce921db46d839f631bccceb55002ab302125bb085e6bcbac1dbead9c6eeb4bbf259e6e33fcb26337cafab27633bd63097d2d3f08c592336d591c

data/README.md

@@ -28,36 +28,21 @@ 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
+renderer = AsciiPress::Renderer.new(tags_proc: -> (rendering) { rendering.tags + ['tag-for-all'] },
+                                    asciidoc_options: {attributes: 'allow-uri-read'})
+
+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
-
-After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+adoc_file_paths = `find . -name "*.adoc"`.split(/[\n\r]+/)
+syncer.sync(adoc_file_paths)
+```
 
-To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+See the [API documentation](http://www.rubydoc.info/github/cheerfulstoic/ascii_press/master) for more details on arguments and options
 
 ## Contributing
 

data/lib/ascii_press.rb

@@ -9,29 +9,47 @@ require 'json'
 require 'active_support/core_ext/enumerable'
 
 module AsciiPress
+  # For setting the default logger
   def self.logger=(new_logger)
     @logger = new_logger
   end
 
+  # A default STDOUT logger
   def self.logger
     @logger || Logger.new(STDOUT)
   end
 
   class Renderer
     class Rendering
-      attr_reader :html, :doc, :data
+      # @return [String] The HTML resulting from the asciidoc
+      attr_reader :html
+
+      # @return [Asciidoctor::Document] The document from the +asciidoctor+ gem
+      attr_reader :doc
+
+      # @return [Hash] The adoc file's attributes standardized with symbol keys and string values
+      attr_reader :data
+
+      # @return [Array <String>] The tags which will be set in +WordPress+
       attr_accessor :tags
 
+      # @return [String] The title that will be used
+      attr_accessor :title
+
+      # Create a new {Rendering} object (intended to be used by Syncers like {WordPressSyncer})
       def initialize(html, doc, data)
         @html = html
         @doc = doc
         @data = data
+        @title = doc.doctitle
       end
 
+      # @!visibility private
       def attribute_value(name, default = nil)
         doc.attributes[name.to_s] || default
       end
 
+      # @!visibility private
       def list_attribute_value(name, default = [])
         value = attribute_value(name, :VALUE_DOES_NOT_EXIST)
         if value == :VALUE_DOES_NOT_EXIST
@@ -41,15 +59,23 @@ module AsciiPress
         end
       end
 
+      # @!visibility private
       def attribute_exists?(name)
         doc.attributes.key?(name.to_s)
       end
     end
 
-    def initialize(options = {})
+    # @param options [Hash]
+    # @option options [Hash] :asciidoc_options Passed directly to the +Asciidoctor.load+ method.  See the {http://asciidoctor.org/rdoc/Asciidoctor.html AsciiDoctor documentation}
+    # @option options [Proc] :before_convertion Proc which is given the asciidoctor text.  Whatever is returned is passed to +Asciidoctor.load+.  See the {http://asciidoctor.org/rdoc/Asciidoctor.html AsciiDoctor documentation}
+    # @option options [Proc] :after_conversion Proc which is given the html text after the Asciidoctor conversion.  Whatever is returned will be uploaded to WordPress
+    # @option options [Proc] :rendering_proc Proc which is given the {Rendering} object (see below).  Changes made be made to the rendering in-place
+    #
+    def initialize(options = {asciidoc_options: {}})
       @options = options
     end
 
+    # @!visibility private
     def render(adoc_file_path)
       doc = nil
       errors = capture_stderr do
@@ -79,12 +105,13 @@ module AsciiPress
         rendering.tags << 'public' if rendering.attribute_exists?(:public)
         rendering.tags << 'private' if rendering.attribute_exists?(:private)
 
-        if @options[:extra_tags_proc]
-          rendering.tags.concat @options[:extra_tags_proc].call(rendering)
+        if @options[:rendering_proc]
+          rendering.tags = @options[:rendering_proc].call(rendering)
         end
       end
     end
 
+    private
     def capture_stderr
       real_stderr, $stderr = $stderr, StringIO.new
       yield
@@ -95,9 +122,21 @@ module AsciiPress
   end
 
   class WordPressSyncer
-    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)
+    # Creates a synchronizer object which can be used to synchronize a set of asciidoc files to WordPress posts
+    # @param hostname [String] Hostname for WordPress blog
+    # @param username [String] Wordpress username
+    # @param password [String] Wordpress password
+    # @param post_type [String] Wordpress post type to synchronize posts with
+    # @param renderer [Renderer] Renderer object which will be used to process asciidoctor files
+    # @param options [Hash]
+    # @option options [Logger] :logger Logger to be used for informational output.  Defaults to {AsciiPress.logger}
+    # @option options [Proc] :filter_proc Proc which is given an +AsciiDoctor::Document+ object and returns +true+ or +false+ to decide if a document should be synchronized
+    # @option options [Boolean] :delete_not_found Should posts on the WordPress server which don't match any documents locally get deleted?
+    # @option options [Boolean] :generate_tags Should asciidoctor tags be synchronized to WordPress? (defaults to +false+)
+    # @option options [String] :post_status The status to assign to posts when they are synchronized.  Defaults to +'draft'+.  See the {https://github.com/zachfeldman/rubypress rubypress} documentation
+    def initialize(hostname, username, password, post_type, renderer, options = {})
+      @hostname = hostname
+      @wp_client = Rubypress::Client.new(host: @hostname, username: username, password: password)
       @post_type = post_type
       @logger = options[:logger] || AsciiPress.logger
       @renderer = renderer || Renderer.new
@@ -111,6 +150,8 @@ module AsciiPress
       log :info, "Got #{@all_pages_by_post_name.size} pages from the database"
     end
 
+    # @param adoc_file_path [Array <String>] Paths of the asciidoctor files to synchronize
+    # @param custom_fields [Hash] Custom fields for WordPress.
     def sync(adoc_file_paths, custom_fields = {})
       synced_post_names = []
 
@@ -124,12 +165,14 @@ module AsciiPress
 
           log :info, "Deleting missing post_name: #{post_name_to_delete} (post ##{post_id})"
 
-          send_message(:deletePost, blog_id: @blog_id, post_id: post_id)
+          send_message(:deletePost, blog_id: @hostname, post_id: post_id)
         end
 
       end
     end
 
+    private
+
     def sync_file_path(adoc_file_path, custom_fields = {})
       rendering = @renderer.render(adoc_file_path)
 
@@ -140,7 +183,7 @@ module AsciiPress
         return
       end
 
-      title = rendering.doc.doctitle
+      title = rendering.title
       html = rendering.html
 
       log :info, "Syncing to WordPress: #{title} (slug: #{slug})"
@@ -150,7 +193,7 @@ module AsciiPress
       custom_fields_array = custom_fields.merge('adoc_attributes' => rendering.doc.attributes.to_json).map {|k, v| {key: k, value: v} }
       content = {
                   post_type:     @post_type,
-                  post_date:     Time.now - 60*60*24*30,
+                  post_date:     Time.now - 60*60*24,
                   post_content:  html,
                   post_title:    title,
                   post_name:     slug,
@@ -170,21 +213,18 @@ module AsciiPress
 
         post_id = page['post_id'].to_i
 
-        log :info, "Editing Post ##{post_id} on _#{@blog_id}_ custom-field #{content[:custom_fields].inspect}"
+        log :info, "Editing Post ##{post_id} on _#{@hostname}_ custom-field #{content[:custom_fields].inspect}"
 
-        send_message(:editPost, blog_id: @blog_id, post_id: post_id, content: content)
+        send_message(:editPost, blog_id: @hostname, post_id: post_id, content: content)
       else
-        log :info, "Making a new post for '#{title}' on _#{@blog_id}_"
+        log :info, "Making a new post for '#{title}' on _#{@hostname}_"
 
-        send_message(:newPost, blog_id: @blog_id, content: content)
+        send_message(:newPost, blog_id: @hostname, content: content)
       end
 
       slug
     end
 
-
-    private
-
     def new_content_same_as_page?(content, page)
       main_keys_different = %i(post_content post_title post_name post_status).any? do |key|
         content[key] != page[key.to_s]

data/lib/ascii_press/version.rb

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

metadata

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