couchpillow 0.4.6 → 0.4.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c8a125e7eabce1a8d19853040151e38791c57d07
-  data.tar.gz: ec143b133ab55a2ec34ec2fd7b4f3c9b84831fad
+  metadata.gz: e78819a058a79be4256e3a0aeaf532ef3e679877
+  data.tar.gz: af259c1e79e2956b8e6e1095108077469fd08038
 SHA512:
-  metadata.gz: 0d3ce4a39378e5fbe15e642bcee30e97a03506316741c6ee5e3a242398a3b249e79f2ee6e88d08279bb57aabd3f07968f3c1430930921cf8b310efc42f8b4d5c
-  data.tar.gz: ddf7c4cc0c9ade106a817bd89d3557248933e167c8faadf3db1fd6855d911accbca5bbea68866c0633c449381099161e7082b79401c1d0485159b8f161632a42
+  metadata.gz: 7a58b3d6500fe3030149da45066d8bad48a60eb26db5d61d3c2918955b3a8b467b1275418c99ab24f7b4fcaf40cdde17fe5fc8b44b98a8708d750d770b1116d1
+  data.tar.gz: fbe8479ae3d03415816f4df902682943ae994a500566ba15f365f7e5c7ea5a9a04855e75d55b9ccdb9259fd9f84f6cc0620d0fd06df5a822956b07790707ea91

data/README.markdown

@@ -75,29 +75,38 @@ Specifying custom id:
 The following are directives that can be used to trigger specific behaviors
 at the Document level.
 
-* `type(T)`
+* `type T`
 
   Set the type of the Document.
 
-* `type_prefix(true|false)`
+* `type_prefix true|false`
 
   Default to `true`. If set to false, it removes prefixing document id with
   the document type. Leaving this to true is the recommended behavior to avoid
   id conflicts between different types of documents, especially when custom
   ids are being used.
 
-* `attribute(name, &block)`
+* `attribute name, &block`
 
   Declares an attribute for this Document. You can specify additional
   directives for each attribute. See Attributes section.
 
-* `db(connection)`
+* `db connection`
 
   Sets the database connections. If set once, it will set that connection as
   the primary connection.  Any subsequent calls to this directive will set
   those connections as secondary connections.  See Multiple DB Connections
   section.
 
+* `rename`
+
+  Rename keys.  See Migration section.
+
+* `migrate`
+
+  Migrate the value of a key. This gets triggered when Document is initialized.
+  See Migration section.
+
 
 
 ### Attributes
@@ -224,7 +233,7 @@ Using `rename` to rename keys. Useful to maintain document integrity
 after a migration.
 
     class User < CouchPillow::Document
-      rename :username, :nickname
+      rename :username => :nickname
       attribute :nickname
     end
     u = User.new( { :username => 'jdoe' } )
@@ -235,6 +244,22 @@ that queries each document in the database and updates them, or you can
 simply use this inside your application code, so it only migrates the document
 as it reads them.
 
+You can also migrate the values. The `migrate` directive is trigger when
+Document is initialized, but after the `rename`.
+This is useful if you have Documents whose values are in the old format
+and you want to convert them.
+
+    class User < CouchPillow::Document
+      rename :nickname => :nicknames
+
+      attribute :nicknames
+
+      migrate :nicknames do |v|
+        v.class == String ? [v] : v
+      end
+    end
+    u = User.new( { :nickname => 'jdoe' } )
+    u.nicknames # ['jdoe']
 
 
 ## Design Docs and Views

data/couchpillow.gemspec

@@ -16,7 +16,6 @@ Gem::Specification.new do |s|
 
   s.required_ruby_version = '~> 2.0'
 
-  s.add_runtime_dependency 'celluloid', '~> 0.16'
   s.add_runtime_dependency 'couchbase', '~> 1.3'
 
   s.add_development_dependency 'minitest',  '~> 5.3'

data/lib/couchpillow.rb

@@ -15,10 +15,14 @@ module CouchPillow
 
 end
 
+require 'couchpillow/helper'
+
 require 'couchpillow/directives/type'
 require 'couchpillow/directives/type_prefix'
 require 'couchpillow/directives/attribute'
 require 'couchpillow/directives/multi_db'
+require 'couchpillow/directives/rename'
+require 'couchpillow/directives/migrate'
 
 require 'couchpillow/errors'
 require 'couchpillow/boolean'

data/lib/couchpillow/directives/migrate.rb

@@ -0,0 +1,18 @@
+module CouchPillow
+
+  module MigrateDirective
+
+
+    # Migrate the value of a key
+    #
+    def migrate key, &block
+      migrate_keys[key] = block
+    end
+
+
+    def migrate_keys
+      @migrate_keys ||= {}
+    end
+
+  end
+end

data/lib/couchpillow/directives/multi_db.rb

@@ -1,7 +1,3 @@
-require 'celluloid/autostart'
-
-Celluloid.logger = nil
-
 module CouchPillow
 
   module MultiDBDirective
@@ -38,7 +34,7 @@ module CouchPillow
 
     def _write_to_secondary_dbs &block
       unless _secondary_dbs.empty?
-        _futures << Celluloid::Future.new do
+        _threads << Thread.new do
           _secondary_dbs.each do |db|
             block.call(db)
           end
@@ -47,8 +43,8 @@ module CouchPillow
     end
 
 
-    def _futures
-      @futures ||= []
+    def _threads
+      @threads ||= []
     end
 
 
@@ -57,8 +53,8 @@ module CouchPillow
     #
     def wait
       result = []
-      until _futures.empty?
-        f = _futures.shift
+      until _threads.empty?
+        f = _threads.shift
         result << f.value
       end
 

data/lib/couchpillow/directives/rename.rb

@@ -0,0 +1,26 @@
+module CouchPillow
+
+  module RenameDirective
+
+    RESERVED_KEYS = %i[_id _type _created_at _updated_at]
+
+    # Rename keys from one to another
+    #
+    def rename map
+      map.each do |k, v|
+        raise ArgumentError, "Cannot rename reserved keys" if
+          RESERVED_KEYS.include?(k) || RESERVED_KEYS.include?(v)
+      end
+
+      smap = CouchPillow.symbolize(map)
+
+      rename_keys.merge!(smap)
+    end
+
+
+    def rename_keys
+      @rename_keys ||= {}
+    end
+
+  end
+end

data/lib/couchpillow/document.rb

@@ -6,10 +6,11 @@ module CouchPillow
     extend TypePrefixDirective
     extend AttributeDirective
     extend MultiDBDirective
+    extend RenameDirective
+    extend MigrateDirective
 
     attr_accessor :id
 
-    RESERVED_KEYS = %i[_id _type _created_at _updated_at]
 
     EVENTS = [ :cas_conflict ].freeze
 
@@ -44,7 +45,7 @@ module CouchPillow
                    id = SecureRandom.hex,
                    cas = nil
 
-      @data = self.class.symbolize(hash)
+      @data = CouchPillow.symbolize(hash)
       @original = Marshal.load(Marshal.dump(@data))
 
       @id = self.class._is_type_prefixed? ? self.class._sanitize_id(id) : id
@@ -58,6 +59,7 @@ module CouchPillow
       rename!
       whitelist!
       assign_defaults!
+      migrate!
       auto_convert!
     end
 
@@ -137,6 +139,17 @@ module CouchPillow
     end
 
 
+    # Run the migration directive
+    #
+    def migrate!
+      self.class.migrate_keys.each do |k, pr|
+        if @data.has_key? k
+          @data[k] = pr.call @data[k]
+        end
+      end
+    end
+
+
     # Updates the attributes in the document.
     # Existing attributes will be overwritten and new ones will be added.
     # Any other existing attributes that are not present in the hash will be ignored.
@@ -257,17 +270,6 @@ module CouchPillow
     end
 
 
-    # Rename an existing key to a new key. This is invoked right after
-    # initialize.
-    #
-    def self.rename from, to
-      raise ArgumentError, "Cannot rename reserved keys" if
-        RESERVED_KEYS.include?(from) || RESERVED_KEYS.include?(to)
-
-      rename_keys << [from.to_s.to_sym, to.to_s.to_sym]
-    end
-
-
     # Registers a listener on a specific event.
     # See {EVENTS} constant for a list of accepted events.
     #
@@ -311,7 +313,7 @@ module CouchPillow
         raise CASError, "There is a CAS conflict, but no :cas_conflict handler has been defined. See 'on' directive." unless self.class.event_listeners[:cas_conflict]
 
         # resolve conflict
-        other_doc = self.class.symbolize(other_doc)
+        other_doc = CouchPillow.symbolize(other_doc)
         @data = self.class.event_listeners[:cas_conflict].call(@original, other_doc, _to_save)
         @cas = newcas
 
@@ -346,22 +348,9 @@ module CouchPillow
     end
 
 
-    def self.rename_keys
-      @rename_keys ||= []
-    end
-
-
     def self.event_listeners
       @event_listeners ||= {}
     end
 
-
-    def self.symbolize hash
-      hash.inject({}) do |memo,(k,v)|
-        memo[k.to_sym] = v
-        memo
-      end
-    end
-
   end
 end

data/lib/couchpillow/helper.rb

@@ -0,0 +1,10 @@
+module CouchPillow
+
+  def self.symbolize hash
+    hash.inject({}) do |memo,(k,v)|
+      memo[k.to_sym] = v
+      memo
+    end
+  end
+
+end

data/lib/couchpillow/version.rb

@@ -1,5 +1,5 @@
 module CouchPillow
   GEM_NAME = "couchpillow"
   NAME = "CouchPillow"
-  VERSION = "0.4.6"
+  VERSION = "0.4.7"
 end

data/test/test_document.rb

@@ -155,7 +155,7 @@ class TestDocument < Minitest::Test
       attribute(:bar)
       attribute(:other)
 
-      rename :foo, :bar
+      rename :foo => :bar
     end.new( { :foo => 123, :other => 'abc' } )
     assert_equal 123, d[:bar]
     assert_equal 123, d.bar
@@ -165,28 +165,44 @@ class TestDocument < Minitest::Test
   end
 
 
+  def test_rename_keys_multiple
+    d = Class.new(Document) do
+      attribute(:bar)
+      attribute(:other)
+
+      rename :foo => :bar, :dump => :other
+    end.new( { :foo => 123, :dump => 'abc' } )
+    assert_equal 123, d[:bar]
+    assert_equal 123, d.bar
+    assert_equal nil, d[:foo]
+    refute d.respond_to?(:foo)
+    refute d.respond_to?(:dump)
+    assert_equal 'abc', d.other
+  end
+
+
   def test_rename_keys_reserved_keys
     assert_raises ArgumentError do
       d = Class.new(Document) do
-        rename :_id, :bad
+        rename :_id => :bad
       end.new
     end
 
     assert_raises ArgumentError do
       d = Class.new(Document) do
-        rename :_type, :err
+        rename :_type => :err
       end.new
     end
 
     assert_raises ArgumentError do
       d = Class.new(Document) do
-        rename :_created_at, :err
+        rename :_created_at => :err
       end.new
     end
 
     assert_raises ArgumentError do
       d = Class.new(Document) do
-        rename :bla, :_updated_at
+        rename :bla => :_updated_at
       end.new
     end
   end
@@ -660,4 +676,34 @@ class TestDocument < Minitest::Test
   end
 
 
+  def test_migrate
+    klass = Class.new(Document) do
+      type 'test'
+
+      attribute :foo do
+        type String
+      end
+
+      migrate :foo do |v|
+        if v.class == Hash
+          "omg"
+        elsif v.class == Array
+          123
+        else
+          "yes"
+        end
+      end
+    end
+
+    d = klass.new( foo: "Hello" )
+    assert_equal "yes", d.foo
+
+    d = klass.new( foo: { :complex => "data" } )
+    assert_equal "omg", d.foo
+
+    d = klass.new( foo: ["some", "array"] )
+    assert_equal 123, d.foo
+  end
+
+
 end

metadata

@@ -1,29 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: couchpillow
 version: !ruby/object:Gem::Version
-  version: 0.4.6
+  version: 0.4.7
 platform: ruby
 authors:
 - Albert Tedja
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-03-25 00:00:00.000000000 Z
+date: 2015-04-06 00:00:00.000000000 Z
 dependencies:
-- !ruby/object:Gem::Dependency
-  name: celluloid
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.16'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.16'
 - !ruby/object:Gem::Dependency
   name: couchbase
   requirement: !ruby/object:Gem::Requirement
@@ -94,11 +80,14 @@ files:
 - lib/couchpillow.rb
 - lib/couchpillow/boolean.rb
 - lib/couchpillow/directives/attribute.rb
+- lib/couchpillow/directives/migrate.rb
 - lib/couchpillow/directives/multi_db.rb
+- lib/couchpillow/directives/rename.rb
 - lib/couchpillow/directives/type.rb
 - lib/couchpillow/directives/type_prefix.rb
 - lib/couchpillow/document.rb
 - lib/couchpillow/errors.rb
+- lib/couchpillow/helper.rb
 - lib/couchpillow/version.rb
 - test/helper.rb
 - test/test_attribute.rb