pupa 0.0.10 → 0.0.11

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 1e1915f53def27a04384e080b43b7eaa1c024398
-  data.tar.gz: 75b0c4e987b976448a816b3b36be99942c393ddd
+  metadata.gz: 88acbf7d013691871dbdaf6390f551625f6d5c4d
+  data.tar.gz: 5e52a9789851411377f3403196560648767fddcb
 SHA512:
-  metadata.gz: 5800302c7e32286138dc9f64b8dc06cd13c07cb4cfc5478d572b8fdc10c04483d595c7f48ceddb82efe4330ce280dc3b58467be50db3fa264e1429a24b3b7e0f
-  data.tar.gz: 6cf10d376b218ce4190b4b08da3dbaa1f3fddf87763623f23368eccdccc1a305d611bb3eb8a0de37c55af961eca5ef0a88f9d613bdc08b9e59139c5fc5194b30
+  metadata.gz: b3f55a952c0cba3c80ed2dda6492144faf0b67b92583a847f08d301d8dba83a0acd22240ff856ef2a78d76f29984743482acfef5c49c4d3384afacf17d498dcf
+  data.tar.gz: afc4bdfad6dcd3702d79f5cdbebfecde163305ef8dd3cea6ac02332d8284584accf26fc5de5918e0a095de4438c554615619a87af590eac40fc5712d64d511f9

data/lib/pupa/models/concerns/contactable.rb

@@ -18,7 +18,7 @@ module Pupa
       #
       # @param [Array] contact_details a list of contact details
       def contact_details=(contact_details)
-        @contact_details = ContactDetailList.new(contact_details)
+        @contact_details = ContactDetailList.new(symbolize_keys(contact_details))
       end
 
       # Adds a contact detail.
@@ -31,7 +31,7 @@ module Pupa
         if note
           data[:note] = note
         end
-        if type && value
+        if type.present? && value.present?
           @contact_details << data
         end
       end

data/lib/pupa/models/concerns/identifiable.rb

@@ -18,7 +18,7 @@ module Pupa
       #
       # @param [Array] identifiers a list of identifiers
       def identifiers=(identifiers)
-        @identifiers = IdentifierList.new(identifiers)
+        @identifiers = IdentifierList.new(symbolize_keys(identifiers))
       end
 
       # Adds an issued identifier.
@@ -30,7 +30,7 @@ module Pupa
         if scheme
           data[:scheme] = scheme
         end
-        if identifier
+        if identifier.present?
           @identifiers << data
         end
       end

data/lib/pupa/models/concerns/linkable.rb

@@ -5,7 +5,7 @@ module Pupa
       extend ActiveSupport::Concern
 
       included do
-        attr_accessor :links
+        attr_reader :links
         dump :links
       end
 
@@ -14,6 +14,13 @@ module Pupa
         super
       end
 
+      # Sets the links.
+      #
+      # @param [Array] links a list of links
+      def links=(links)
+        @links = symbolize_keys(links)
+      end
+
       # Adds a URL.
       #
       # @param [String] url a URL
@@ -23,7 +30,7 @@ module Pupa
         if note
           data[:note] = note
         end
-        if url
+        if url.present?
           @links << data
         end
       end

data/lib/pupa/models/concerns/nameable.rb

@@ -5,7 +5,7 @@ module Pupa
       extend ActiveSupport::Concern
 
       included do
-        attr_accessor :other_names
+        attr_reader :other_names
         dump :other_names
       end
 
@@ -14,6 +14,13 @@ module Pupa
         super
       end
 
+      # Sets the other names.
+      #
+      # @param [Array] other_names a list of other names
+      def other_names=(other_names)
+        @other_names = symbolize_keys(other_names)
+      end
+
       # Adds an alternate or former name.
       #
       # @param [String] name an alternate or former name
@@ -31,7 +38,7 @@ module Pupa
         if note
           data[:note] = note
         end
-        if name
+        if name.present?
           @other_names << data
         end
       end

data/lib/pupa/models/concerns/sourceable.rb

@@ -5,7 +5,7 @@ module Pupa
       extend ActiveSupport::Concern
 
       included do
-        attr_accessor :sources
+        attr_reader :sources
         dump :sources
       end
 
@@ -14,6 +14,13 @@ module Pupa
         super
       end
 
+      # Sets the sources.
+      #
+      # @param [Array] sources a list of sources
+      def sources=(sources)
+        @sources = symbolize_keys(sources)
+      end
+
       # Adds a source to the object.
       #
       # @param [String] url a URL
@@ -23,7 +30,7 @@ module Pupa
         if note
           data[:note] = note
         end
-        if url
+        if url.present?
           @sources << data
         end
       end

data/lib/pupa/models/concerns/timestamps.rb

@@ -15,6 +15,8 @@ module Pupa
         end
 
         set_callback(:save, :before) do |object|
+          # The object may not set created_at.
+          object.created_at = object.document['created_at'] if object.document
           object.updated_at = Time.now.utc
         end
       end

data/lib/pupa/models/model.rb

@@ -28,8 +28,15 @@ module Pupa
       self.foreign_keys = Set.new
       self.foreign_objects = Set.new
 
+      # @return [String] The object's unique identifier.
       attr_reader :_id
-      attr_accessor :_type, :extras
+      # @return [Hash] The object's non-schema properties.
+      attr_reader :extras
+      # @return [String] The underscored, lowercase form of the object's class.
+      attr_accessor :_type
+      # @return [Moped::BSON::Document,nil] The object's matching document in
+      #   the database. Set before persisting the object to the database.
+      attr_accessor :document
 
       dump :_id, :_type, :extras
     end
@@ -124,6 +131,13 @@ module Pupa
       @_id = id.to_s # in case of Moped::BSON::ObjectId
     end
 
+    # Sets the extras.
+    #
+    # @param [Array] extras a list of extras
+    def extras=(extras)
+      @extras = symbolize_keys(extras)
+    end
+
     # Adds a key-value pair to the object.
     #
     # @param [Symbol] key a key
@@ -159,8 +173,8 @@ module Pupa
 
     # Returns the object as a hash.
     #
-    # @param [Boolean] persist whether the object is being persisted, validated
-    #   or used as a MongoDB selecto, in which case foreign objects (i.e. hints)
+    # @param [Boolean] persist whether the object is being persisted, validated,
+    #   or used as a MongoDB selector, in which case foreign objects (i.e. hints)
     #   are excluded
     # @return [Hash] the object as a hash
     def to_h(persist: false)
@@ -189,21 +203,29 @@ module Pupa
 
   private
 
-    def stringify_keys(object)
+    def transform_keys(object, meth)
       case object
       when Hash
         {}.tap do |hash|
           object.each do |key,value|
-            hash[key.to_s] = stringify_keys(value)
+            hash[key.send(meth)] = transform_keys(value, meth)
           end
         end
       when Array
         object.map do |value|
-          stringify_keys(value)
+          transform_keys(value, meth)
         end
       else
         object
       end
     end
+
+    def symbolize_keys(object)
+      transform_keys(object, :to_sym)
+    end
+
+    def stringify_keys(object)
+      transform_keys(object, :to_s)
+    end
   end
 end

data/lib/pupa/processor/helper.rb

@@ -8,7 +8,9 @@ module Pupa
       # @param [String] a string
       # @return [String] a clean string
       def clean(string)
-        string.gsub(/[[:space:]]/, ' ').squeeze(' ').strip
+        if string
+          string.gsub(/[[:space:]]/, ' ').squeeze(' ').strip
+        end
       end
     end
   end

data/lib/pupa/processor/persistence.rb

@@ -28,7 +28,7 @@ module Pupa
         end
       end
 
-      # Saves an object to MongoDB.
+      # Inserts or replaces a document in MongoDB.
       #
       # @return [Array] whether the object was inserted and the object's database ID
       # @raises [Pupa::Errors::TooManyMatches] if multiple documents would be updated
@@ -37,19 +37,23 @@ module Pupa
         query = collection.find(selector)
 
         # Run query before callbacks to avoid e.g. timestamps in the selector.
-        @object.run_callbacks(:save) do
-          case query.count
-          when 0
+        case query.count
+        when 0
+          @object.run_callbacks(:save) do
             @object.run_callbacks(:create) do
               collection.insert(@object.to_h(persist: true))
               [true, @object._id.to_s]
             end
-          when 1
-            query.update(@object.to_h(persist: true))
-            [false, query.first['_id'].to_s]
-          else
-            raise Errors::TooManyMatches, "selector matches multiple documents during save: #{collection_name} #{MultiJson.dump(selector)}"
           end
+        when 1
+          # Make the document available to the callbacks.
+          @object.document = query.first
+          @object.run_callbacks(:save) do
+            query.update(@object.to_h(persist: true).except(:_id))
+            [false, @object.document['_id'].to_s]
+          end
+        else
+          raise Errors::TooManyMatches, "selector matches multiple documents during save: #{collection_name} #{MultiJson.dump(selector)}"
         end
       end
 

data/lib/pupa/runner.rb

@@ -201,9 +201,11 @@ module Pupa
         end
       end
 
-      report[:end] = Time.now.utc
-      report[:time] = report[:end] - report[:start]
-      puts MultiJson.dump(report)
+      if %w(DEBUG INFO).include?(options.level)
+        report[:end] = Time.now.utc
+        report[:time] = report[:end] - report[:start]
+        puts MultiJson.dump(report)
+      end
     end
   end
 end

data/lib/pupa/version.rb

@@ -1,3 +1,3 @@
 module Pupa
-  VERSION = "0.0.10"
+  VERSION = "0.0.11"
 end

data/spec/models/concerns/contactable_spec.rb

@@ -29,6 +29,11 @@ describe Pupa::Concerns::Contactable do
       object.contact_details = [{type: 'email', value: 'ceo@example.com', note: 'work'}]
       object.contact_details.should be_a(Pupa::ContactDetailList)
     end
+
+    it 'should symbolize keys' do
+      object.contact_details = [{'type' => 'email', 'value' => 'ceo@example.com', 'note' => 'work'}]
+      object.contact_details.should == [{type: 'email', value: 'ceo@example.com', note: 'work'}]
+    end
   end
 
   describe '#add_contact_detail' do
@@ -38,12 +43,14 @@ describe Pupa::Concerns::Contactable do
     end
 
     it 'should not add a contact detail without a type' do
-      object.add_contact_detail('email', nil)
+      object.add_contact_detail(nil, 'ceo@example.com')
+      object.add_contact_detail('', 'ceo@example.com')
       object.contact_details.blank?.should == true
     end
 
     it 'should not add a contact detail without a value' do
-      object.add_contact_detail(nil, 'ceo@example.com')
+      object.add_contact_detail('email', nil)
+      object.add_contact_detail('email', '')
       object.contact_details.blank?.should == true
     end
   end

data/spec/models/concerns/identifiable_spec.rb

@@ -29,6 +29,11 @@ describe Pupa::Concerns::Identifiable do
       object.identifiers = [{identifier: '123456789', scheme: 'DUNS'}]
       object.identifiers.should be_a(Pupa::IdentifierList)
     end
+
+    it 'should symbolize keys' do
+      object.identifiers = [{'identifier' => '123456789', 'scheme' => 'DUNS'}]
+      object.identifiers.should == [{identifier: '123456789', scheme: 'DUNS'}]
+    end
   end
 
   describe '#add_identifier' do
@@ -39,6 +44,7 @@ describe Pupa::Concerns::Identifiable do
 
     it 'should not add an identifier without an identifier' do
       object.add_identifier(nil)
+      object.add_identifier('')
       object.identifiers.blank?.should == true
     end
   end

data/spec/models/concerns/linkable_spec.rb

@@ -12,6 +12,13 @@ describe Pupa::Concerns::Linkable do
     klass.new
   end
 
+  describe '#links' do
+    it 'should symbolize keys' do
+      object.links = [{'url' => 'http://example.com', 'note' => 'homepage'}]
+      object.links.should == [{url: 'http://example.com', note: 'homepage'}]
+    end
+  end
+
   describe '#add_link' do
     it 'should add a link' do
       object.add_link('http://example.com', note: 'homepage')
@@ -20,6 +27,7 @@ describe Pupa::Concerns::Linkable do
 
     it 'should not add a link without a url' do
       object.add_link(nil)
+      object.add_link('')
       object.links.blank?.should == true
     end
   end

data/spec/models/concerns/nameable_spec.rb

@@ -12,6 +12,13 @@ describe Pupa::Concerns::Nameable do
     klass.new
   end
 
+  describe '#other_names' do
+    it 'should symbolize keys' do
+      object.other_names = [{'name' => 'Mr. Ziggy Q. Public, Esq.', 'start_date' => '1920-01', 'end_date' => '1949-12-31', 'note' => 'Birth name'}]
+      object.other_names.should == [{name: 'Mr. Ziggy Q. Public, Esq.', start_date: '1920-01', end_date: '1949-12-31', note: 'Birth name'}]
+    end
+  end
+
   describe '#add_name' do
     it 'should add a name' do
       object.add_name('Mr. Ziggy Q. Public, Esq.', start_date: '1920-01', end_date: '1949-12-31', note: 'Birth name')
@@ -20,6 +27,7 @@ describe Pupa::Concerns::Nameable do
 
     it 'should not add a name without a name' do
       object.add_name(nil)
+      object.add_name('')
       object.other_names.blank?.should == true
     end
   end

data/spec/models/concerns/sourceable_spec.rb

@@ -12,6 +12,13 @@ describe Pupa::Concerns::Sourceable do
     klass.new
   end
 
+  describe '#sources' do
+    it 'should symbolize keys' do
+      object.sources = [{'url' => 'http://example.com', 'note' => 'homepage'}]
+      object.sources.should == [{url: 'http://example.com', note: 'homepage'}]
+    end
+  end
+
   describe '#add_source' do
     it 'should add a source' do
       object.add_source('http://example.com', note: 'homepage')
@@ -20,6 +27,7 @@ describe Pupa::Concerns::Sourceable do
 
     it 'should not add a source without a url' do
       object.add_source(nil)
+      object.add_source('')
       object.sources.blank?.should == true
     end
   end

data/spec/models/{base_spec.rb → model_spec.rb}

@@ -151,6 +151,13 @@ describe Pupa::Model do
     end
   end
 
+  describe '#links' do
+    it 'should symbolize keys' do
+      object.extras = {'age' => 10}
+      object.extras.should == {age: 10}
+    end
+  end
+
   describe '#add_extra' do
     it 'should add an extra property' do
       object.add_extra(:age, 10)

data/spec/processor/persistence_spec.rb

@@ -5,7 +5,7 @@ describe Pupa::Processor::Persistence do
     Pupa.session = Moped::Session.new(['localhost:27017'], database: 'pupa_test')
     Pupa.session.collections.each(&:drop)
 
-    Pupa::Processor::Persistence.new(Pupa::Person.new(_id: 'existing', name: 'existing')).save
+    Pupa::Processor::Persistence.new(Pupa::Person.new(_id: 'existing', name: 'existing', email: 'existing@example.com')).save
 
     Pupa.session[:people].insert(_type: 'pupa/person', name: 'non-unique')
     Pupa.session[:people].insert(_type: 'pupa/person', name: 'non-unique')
@@ -27,11 +27,13 @@ describe Pupa::Processor::Persistence do
 
   describe '#save' do
     it 'should insert a document if no matches' do
-      Pupa::Processor::Persistence.new(Pupa::Person.new(_id: 'new', name: 'new')).save.should == [true, 'new']
+      Pupa::Processor::Persistence.new(Pupa::Person.new(_id: 'new', name: 'new', email: 'new@example.com')).save.should == [true, 'new']
+      Pupa::Processor::Persistence.find(_type: 'pupa/person', name: 'new')['email'].should == 'new@example.com'
     end
 
     it 'should update a document if one match' do
-      Pupa::Processor::Persistence.new(Pupa::Person.new(_id: 'changed', name: 'existing')).save.should == [false, 'existing']
+      Pupa::Processor::Persistence.new(Pupa::Person.new(_id: 'changed', name: 'existing', email: 'changed@example.com')).save.should == [false, 'existing']
+      Pupa::Processor::Persistence.find(_type: 'pupa/person', name: 'existing')['email'].should == 'changed@example.com'
     end
 
     it 'should raise an error if many matches' do

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: pupa
 version: !ruby/object:Gem::Version
-  version: 0.0.10
+  version: 0.0.11
 platform: ruby
 authors:
 - Open North
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-10-06 00:00:00.000000000 Z
+date: 2013-10-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -316,7 +316,6 @@ files:
 - spec/fixtures/baz.json
 - spec/fixtures/foo.json
 - spec/logger_spec.rb
-- spec/models/base_spec.rb
 - spec/models/concerns/contactable_spec.rb
 - spec/models/concerns/identifiable_spec.rb
 - spec/models/concerns/linkable_spec.rb
@@ -326,6 +325,7 @@ files:
 - spec/models/contact_detail_list_spec.rb
 - spec/models/identifier_list_spec.rb
 - spec/models/membership_spec.rb
+- spec/models/model_spec.rb
 - spec/models/organization_spec.rb
 - spec/models/person_spec.rb
 - spec/models/post_spec.rb
@@ -378,7 +378,6 @@ test_files:
 - spec/fixtures/baz.json
 - spec/fixtures/foo.json
 - spec/logger_spec.rb
-- spec/models/base_spec.rb
 - spec/models/concerns/contactable_spec.rb
 - spec/models/concerns/identifiable_spec.rb
 - spec/models/concerns/linkable_spec.rb
@@ -388,6 +387,7 @@ test_files:
 - spec/models/contact_detail_list_spec.rb
 - spec/models/identifier_list_spec.rb
 - spec/models/membership_spec.rb
+- spec/models/model_spec.rb
 - spec/models/organization_spec.rb
 - spec/models/person_spec.rb
 - spec/models/post_spec.rb