compostr 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a068dc7a5fb8ac1f42f3e552896ad405de2e562a
-  data.tar.gz: 33a1dd0da6a37e6f75d4d9ac5ccb25a4dda5d672
+  metadata.gz: 31dc61ca4c978bbdc7ac6241dd34923dd42cd3c4
+  data.tar.gz: 32990bd5afbe8572a18fee1da267047d8bb380eb
 SHA512:
-  metadata.gz: b17bb4f85195d2de339720f215e78d024da24ddc4cdedcbe9b698afd811f6805d2394987e5e8f28d4bec10bbe048bad34b0ab75cc05ea7a35abc5332c66c122d
-  data.tar.gz: 9aeca1916373fa9d1df46535e50ecbe99a60eeb8dfc5b170551d8cc6ab3e6f0ef7798bcc75069fde194f6c390a222014a2f3354d3a83f565e1eee7a1657f81eb
+  metadata.gz: 2b6a2023871a90cb57a6a18a905b8cf4d401b65bb7885fb7583d147550d93a40c1491fa05e746fc37412338cfbd274f0937f2dec66c6c85433fd1e548819ade1
+  data.tar.gz: d7931358749cda25caadef2a5aae4ce12b81c327eb71dc3661d3c8ebe1da7e254970b8d5fbfcad5ec6e1476f76cdbee33c2b0e614ac7c53bc53715d335c7da17

data/README.md

@@ -10,7 +10,7 @@ Compostr is a somewhat weirdly engineered wrapper to decorate ruby classes such
 
 It would be fun to discuss on `Compostr`s development history and design decisions, but unfortunately that is out of scope for the time being.
 
-Licensed under the GPLv3+, Copyright 2016, 2017 Felix Wolfsteller.
+Licensed under the GPLv3+, Copyright 2016, 2017, 2018 Felix Wolfsteller.
 
 ## Installation
 
@@ -35,6 +35,8 @@ Or install it yourself as:
 Define a CPT class like this (you still need Wordpress PHP code!):
 
 ```ruby
+require 'compostr'
+
 class ProgrammingLanguage < Compostr::CustomPostType
   wp_post_type 'programming_language' # `post_type` as known by WP
   wp_custom_field_single 'awesomeness' # 'meta' field in WP, just one value is queried and set
@@ -44,7 +46,20 @@ end
 
 Now `ProgrammingLanguage`s can be queried and posted to your Wordpress installation.  Instances of this class will automatically respond to `content`, `id`, `title` and `featured_image_id` (corresponding to the Wordpress `post_content`, `id`, `post_title` and `featured_image_id`).
 
-Compostr comes prepared with `UUID` information of CPT instances, to e.g. distinctlive identify entities across different WP instances where entities might have different `post_id`s..
+```ruby
+require 'compostr'
+
+fooby = ProgrammingLanguage.new title:         'Fooby',
+                                content:       'Easy to learn language',
+                                awesomeness:   '3',
+                                further_links: ['foo://by', 'foo://byebye']
+# Reading this I agree the API is awkward
+Compostr::Syncer.new(nil).merge_push fooby, nil
+```
+
+Compostr comes prepared with `UUID` information of CPT instances, to e.g. distinctively identify entities across different WP instances where entities might have different `post_id`s.
+
+There are some tests implemented, which illustrate further usage.
 
 ### Configuration
 
@@ -61,15 +76,15 @@ Global configuration is given in `compostr.conf`, where connection information t
 
 Although logging should not be a main Compostr concern, it was helpful to include some handy helpers.
 
-Use Compostr::logger if you want to feed Compostrs logs into your main applications log or redirect them somewhere.
+Use `Compostr::logger` if you want to feed Compostrs logs into your main applications log or redirect them somewhere.
 
 To mixin `info`, `warn` and other logging functions into your class/module do an `include Compostr::Logging`.
 
-To make Compostr-logs use your logger, set it like this: `Compostr::logger = <mylogger`.
+To make Compostr-logs use your logger, set it like this: `Compostr::logger = mylogger`.
 
 ### EntityCache
 
-Until you provide some Wordpress PHP code to query custom post types via their Custom (meta) Fields, to query and work with CPTs, all data will be read into memory using `Compostr::EntityCache`.
+Until you provide some Wordpress PHP code to query custom post types via their Custom ("meta") Fields, to query and work with CPTs, all data will be read into memory using `Compostr::EntityCache`.
 
 ### Syncer
 
@@ -89,6 +104,6 @@ To install this gem onto your local machine, run `bundle exec rake install`. To
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/ecovillage/compostr. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+Bug reports and pull requests are welcome on GitHub at https://github.com/ecovillage/compostr. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](https://contributor-covenant.org) code of conduct.
 
 That said, just drop me a line.

data/compostr.gemspec

@@ -10,7 +10,7 @@ Gem::Specification.new do |spec|
   spec.email         = ["felix.wolfsteller@gmail.com"]
 
   spec.summary       = %q{Ease interaction with Custom Post Types of a Wordpress installation.}
-  spec.description   = %q{One way to ask a wordpress installation about specific custom post type instances and tell it about them.}
+  spec.description   = %q{Compostr provides one way to ask a wordpress installation about specific custom post type instances and tell it about them.}
   spec.homepage      = 'https://github.com/ecovillage/compostr'
   spec.licenses      = ['GPL-3.0+']
 

data/lib/compostr/custom_field_value.rb

@@ -33,4 +33,11 @@ module Compostr
     def key; nil; end
     def value; nil; end
   end
+
+  # Shortcut to mark fields for deletion.
+  class DeleteCustomFieldValue < CustomFieldValue
+    def initialize(id)
+      super(id, nil, nil)
+    end
+  end
 end

data/lib/compostr/custom_post_type.rb

@@ -4,7 +4,8 @@ module Compostr
   #
   # Besides the post_id, title, content and featured_image (id) that
   # define a post, the CustomPostType likely will own custom field
-  # values.  These are specified with wp_custom_field_single and wp_custom_field_multi (depending on their type).
+  # values.  These are specified with wp_custom_field_single and
+  # wp_custom_field_multi (depending on their type).
   #
   # To loop over the fields, use @fields and @multi_fields.
   class CustomPostType
@@ -116,9 +117,9 @@ module Compostr
           # strip ?
           @title = v
         elsif k == :content
-          @content = v
+          self.content= v
         elsif k == :post_id
-          @post_id = v
+          self.post_id= v
         elsif k == :featured_image_id
           @featured_image_id = v
         # Better: has_custom_field?
@@ -354,7 +355,7 @@ module Compostr
       end
       # Multi-Fields exclusive to the other.
       (other_cpt_object.multi_fields.keys - @multi_fields.keys).each do |f|
-        diff_fields[f] = [nil, other_cpt_object.multi_fields[f].value]
+        diff_fields[f] = [nil, other_cpt_object.multi_fields[f].map(&:value)]
       end
       # Mutual Multi-fields
       (@multi_fields.keys | other_cpt_object.multi_fields.keys).each do |f|

data/lib/compostr/entity_cache.rb

@@ -1,4 +1,10 @@
 module Compostr
+  # An EntityCache stores a wordpress response to the query of
+  # a Custom Post Type.  All is done in memory, which is pretty nasty.
+  # The EntityCache creates two indexes (on name and uuid attribute/custom
+  # field) which are created on-the fly when accessed.
+  # Contrary to what its name suggests, the EntityCache does not store
+  # instances of the given CustomPostType subclass, but the wordpress response.
   class EntityCache
     attr_accessor :cpt_class, :name_id_map, :uuid_id_map
     attr_accessor :full_data
@@ -85,8 +91,11 @@ module Compostr
     private
 
     def get_all_posts
-      Compostr::wp.getPosts blog_id: 0,
+      Compostr::logger.debug "Get all #{@cpt_class.post_type} posts"
+      all_posts = Compostr::wp.getPosts blog_id: 0,
         filter: { post_type: @cpt_class.post_type, number: 100_000 }
+      Compostr::logger.debug "Got all #{all_posts.count} #{@cpt_class.post_type} posts"
+      return all_posts
     end
 
     def uuid_pid_map

data/lib/compostr/image_uploader.rb

@@ -7,7 +7,7 @@ module Compostr
 
     def initialize image_store, media_cache
       if !image_store
-        Compostr.logger.warn "ImageUploader will not uploading anything (no image store specified)."
+        Compostr.logger.warn "ImageUploader will not upload anything (no image store specified)."
       end
       @image_store = image_store
       @media_cache = media_cache

data/lib/compostr/syncer.rb

@@ -7,11 +7,13 @@ module Compostr
     attr_accessor :image_uploader
     attr_accessor :synced_uuids
     attr_accessor :updated_uuids
+    attr_accessor :force
 
-    def initialize image_uploader
+    def initialize image_uploader, force=false
       @image_uploader = image_uploader
       @synced_uuids   = []
       @updated_uuids  = []
+      @force          = force
     end
 
     # Updates or creates Custom Post Types Posts.

data/lib/compostr/version.rb

@@ -1,3 +1,3 @@
 module Compostr
-  VERSION = "0.1.0"
+  VERSION = "0.1.1".freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: compostr
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Felix Wolfsteller
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-06-01 00:00:00.000000000 Z
+date: 2018-01-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rubypress
@@ -108,8 +108,8 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description: One way to ask a wordpress installation about specific custom post type
-  instances and tell it about them.
+description: Compostr provides one way to ask a wordpress installation about specific
+  custom post type instances and tell it about them.
 email:
 - felix.wolfsteller@gmail.com
 executables: []
@@ -159,7 +159,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.1
+rubygems_version: 2.6.12
 signing_key: 
 specification_version: 4
 summary: Ease interaction with Custom Post Types of a Wordpress installation.