active-fedora 6.6.1 → 6.7.0.rc1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 95bf10c81395906f26c70a425466ec9e544f2e15
-  data.tar.gz: b18abff4428238811124584add40c90b6b58a1dd
+  metadata.gz: 73293480bda74204d6fd5e1424101a3fb167b77e
+  data.tar.gz: ee53d98f31f3221263e3bfb4d97b09b5b53bfc1c
 SHA512:
-  metadata.gz: 5a2087217930bad433c30938c82bcc7416c66cc7552796466bf24c29e6e67cd099419b7e76914a09e66ae147b7c2b8bafa5178c1927e8f74311d283c21031a7d
-  data.tar.gz: 50d38ecf44e8959f978dab853f39d784a2f9d2168d0f6015e7a17e63b8c34a3f17a482064fdc1314a9af8b8b1eb4b0aa084555a3b4ba23a9ed053c9007a1daee
+  metadata.gz: 9cc9cf2c01d35ae188f39f646da5c9459d3986a68d078ba2c5cda24e0a75a937c6c22e0fb19ad87ab2fe6c0c1c58536d7721346c1d7cf4b0ec949fa05c08e13f
+  data.tar.gz: a7edd16e6d84e76f25e31b8bfae4c2326fd87ad717e9d5e2af5b43f775ad7f741de63999484837739ba4c08d0a823228147bda9a65ab42154ddae5411b3dafdd

data/lib/active_fedora/attributes.rb

@@ -10,6 +10,11 @@ module ActiveFedora
 
     included do
       include Serializers
+      after_save :clear_changed_attributes
+      def clear_changed_attributes
+        @previously_changed = changes
+        @changed_attributes.clear
+      end
     end
 
     def attributes=(properties)
@@ -17,8 +22,161 @@ module ActiveFedora
         respond_to?(:"#{k}=") ? send(:"#{k}=", v) : raise(UnknownAttributeError, "unknown attribute: #{k}")
       end
     end
+
+    # Calling inspect may trigger a bunch of loads, but it's mainly for debugging, so no worries.
+    def inspect
+      values = self.class.defined_attributes.keys.map {|r| "#{r}:#{send(r).inspect}"}
+      "#<#{self.class} pid:\"#{pretty_pid}\", #{values.join(', ')}>"
+    end
+
+    def [](key)
+      array_reader(key)
+    end
+
+    def []=(key, value)
+      array_setter(key, value)
+    end
+
+
+    private
+    def array_reader(field, *args)
+      raise UnknownAttributeError, "#{self.class} does not have an attribute `#{field}'" unless self.class.defined_attributes.key?(field)
+      if args.present?
+        instance_exec(*args, &self.class.defined_attributes[field][:reader])
+      else
+        instance_exec &self.class.defined_attributes[field][:reader]
+      end
+    end
+
+    def array_setter(field, args)
+      raise UnknownAttributeError, "#{self.class} does not have an attribute `#{field}'" unless self.class.defined_attributes.key?(field)
+      instance_exec(args, &self.class.defined_attributes[field][:setter])
+    end
+
+    # @return [Boolean] true if there is an reader method and it returns a
+    # value different from the new_value.
+    def value_has_changed?(field, new_value)
+      begin
+        new_value != array_reader(field)
+      rescue NoMethodError
+        false
+      end
+    end
+
+    def mark_as_changed(field)
+      self.send("#{field}_will_change!")
+    end
+
+
+
+    module ClassMethods
+      def defined_attributes
+        @defined_attributes ||= {}.with_indifferent_access
+        return @defined_attributes unless superclass.respond_to?(:defined_attributes) and value = superclass.defined_attributes
+        @defined_attributes = value.dup if @defined_attributes.empty?
+        @defined_attributes
+      end
+
+      def defined_attributes= val
+        @defined_attributes = val
+      end
+
+      def has_attributes(*fields)
+        options = fields.pop
+        datastream = options.delete(:datastream)
+        define_attribute_methods fields
+        fields.each do |f|
+          create_attribute_reader(f, datastream, options)
+          create_attribute_setter(f, datastream, options)
+        end
+      end
+
+      # Reveal if the attribute has been declared unique
+      # @param [Symbol] field the field to query
+      # @return [Boolean]
+      def unique?(field)
+        !multiple?(field)
+      end
+
+      # Reveal if the attribute is multivalued
+      # @param [Symbol] field the field to query
+      # @return [Boolean]
+      def multiple?(field)
+        defined_attributes[field][:multiple]
+      end
+
+
+
+      private
+      def create_attribute_reader(field, dsid, args)
+        self.defined_attributes[field] ||= {}
+        self.defined_attributes[field][:reader] = lambda do |*opts|
+          ds = self.send(dsid)
+          if ds.kind_of?(ActiveFedora::RDFDatastream)
+            ds.send(field)
+          else
+            terminology = args[:at] || [field]
+            if terminology.length == 1 && opts.present?
+              ds.send(terminology.first, *opts)
+            else
+              ds.send(:term_values, *terminology)
+            end
+          end
+        end
+
+        if !args[:multiple].nil?
+          self.defined_attributes[field][:multiple] = args[:multiple]
+        elsif !args[:unique].nil?
+          i = 0 
+          begin 
+            match = /in `(delegate.*)'/.match(caller[i])
+            i+=1
+          end while match.nil?
+
+          prev_method = match.captures.first
+          Deprecation.warn Attributes, "The :unique option for `#{prev_method}' is deprecated. Use :multiple instead. :unique will be removed in ActiveFedora 7", caller(i+1)
+          self.defined_attributes[field][:multiple] = !args[:unique]
+        else 
+          i = 0 
+          begin 
+            match = /in `(delegate.*)'/.match(caller[i])
+            i+=1
+          end while match.nil?
+
+          prev_method = match.captures.first
+          Deprecation.warn Attributes, "You have not explicitly set the :multiple option on `#{prev_method}'. The default value will switch from true to false in ActiveFedora 7, so if you want to future-proof this application set `multiple: true'", caller(i+ 1)
+          self.defined_attributes[field][:multiple] = true # this should be false for ActiveFedora 7
+        end
+
+        define_method field do |*opts|
+          val = array_reader(field, *opts)
+          self.class.multiple?(field) ? val : val.first
+        end
+      end
+
+
+      def create_attribute_setter(field, dsid, args)
+        self.defined_attributes[field] ||= {}
+        self.defined_attributes[field][:setter] = lambda do |v|
+          ds = self.send(dsid)
+          mark_as_changed(field) if value_has_changed?(field, v)
+          if ds.kind_of?(ActiveFedora::RDFDatastream)
+            ds.send("#{field}=", v)
+          else
+            terminology = args[:at] || [field]
+            ds.send(:update_indexed_attributes, {terminology => v})
+          end
+        end
+        define_method "#{field}=".to_sym do |v|
+          self[field]=v
+        end
+      end
+
+    end
     
 
+    public
+
     # A convenience method  for updating indexed attributes.  The passed in hash
     # must look like this : 
     #   {{:name=>{"0"=>"a","1"=>"b"}}

data/lib/active_fedora/base.rb

@@ -345,7 +345,6 @@ module ActiveFedora
   end
 
   Base.class_eval do
-    include Attributes
     include ActiveFedora::Persistence
     extend ActiveSupport::DescendantsTracker
     extend Model
@@ -354,6 +353,7 @@ module ActiveFedora
     include ActiveModel::Conversion
     include Validations
     include Callbacks
+    include Attributes
     include Datastreams
     extend ActiveModel::Naming
     include Delegating

data/lib/active_fedora/delegating.rb

@@ -2,71 +2,7 @@ module ActiveFedora
   module Delegating
     extend ActiveSupport::Concern
     extend Deprecation
-
-    included do
-      after_save :clear_changed_attributes
-      def clear_changed_attributes
-        @previously_changed = changes
-        @changed_attributes.clear
-      end
-    end
-
-    # Calling inspect may trigger a bunch of loads, but it's mainly for debugging, so no worries.
-    def inspect
-      values = self.class.delegates.keys.map {|r| "#{r}:#{send(r).inspect}"}
-      "#<#{self.class} pid:\"#{pretty_pid}\", #{values.join(', ')}>"
-    end
-
-    def [](key)
-      array_reader(key)
-    end
-
-    def []=(key, value)
-      array_setter(key, value)
-    end
-
-
-    private
-    def array_reader(field, *args)
-      raise UnknownAttributeError, "#{self.class} does not have an attribute `#{field}'" unless self.class.delegates.key?(field)
-      if args.present?
-        instance_exec(*args, &self.class.delegates[field][:reader])
-      else
-        instance_exec &self.class.delegates[field][:reader]
-      end
-    end
-
-    def array_setter(field, args)
-      raise UnknownAttributeError, "#{self.class} does not have an attribute `#{field}'" unless self.class.delegates.key?(field)
-      instance_exec(args, &self.class.delegates[field][:setter])
-    end
-
-    # @return [Boolean] true if there is an reader method and it returns a
-    # value different from the new_value.
-    def value_has_changed?(field, new_value)
-      begin
-        new_value != array_reader(field)
-      rescue NoMethodError
-        false
-      end
-    end
-
-    def mark_as_changed(field)
-      self.send("#{field}_will_change!")
-    end
-
-
     module ClassMethods
-      def delegates
-        @local_delegates ||= {}.with_indifferent_access
-        return @local_delegates unless superclass.respond_to?(:delegates) and value = superclass.delegates
-        @local_delegates = value.dup if @local_delegates.empty?
-        @local_delegates
-      end
-
-      def delegates= val
-        @local_delegates = val
-      end
       # Provides a delegate class method to expose methods in metadata streams
       # as member of the base object. Pass the target datastream via the
       # <tt>:to</tt> argument. If you want to return a multivalue result, (e.g. array
@@ -86,6 +22,11 @@ module ActiveFedora
       #   foo.field1                 # => "My Value"
       #   foo.field2                 # => [""]
       #   foo.field3                 # => NoMethodError: undefined method `field3' for #<Foo:0x1af30c>
+      #
+      #   The optional <tt>:default</tt> forces this method to have the behavior defined by ActiveSupport
+      #   until this method has a chance to be removed
+      #
+      #     delegate :method1, to: 'descMetadata', default: true
 
       def delegate(*methods)
         fields = methods.dup
@@ -93,10 +34,10 @@ module ActiveFedora
         unless options.is_a?(Hash) && to = options[:to]
           raise ArgumentError, "Target is required"
         end
-        if ds_specs.has_key? to.to_s 
-          define_attribute_method fields.first
-          create_delegate_reader(fields.first, options)
-          create_delegate_setter(fields.first, options)
+        if ds_specs.has_key?(to.to_s) && !options[:default]
+          Deprecation.warn(Delegating, "delegate is deprecated and will be removed in ActiveFedora 7.0. use has_attributes instead", caller(1))
+          datastream = options.delete(:to)
+          has_attributes fields.first, options.merge!({:datastream=>datastream})
         else
           super(*methods)
         end
@@ -122,91 +63,8 @@ module ActiveFedora
       #   foo.field3                 # => NoMethodError: undefined method `field3' for #<Foo:0x1af30c>
 
       def delegate_to(datastream,fields,args={})
-        define_attribute_methods fields
-        fields.each do |f|
-          args.merge!({:to=>datastream})
-          create_delegate_reader(f, args)
-          create_delegate_setter(f, args)
-        end
-      end
-
-      # Reveal if the delegated field is unique or not
-      # @param [Symbol] field the field to query
-      # @return [Boolean]
-      def unique?(field)
-        !multiple?(field)
-      end
-
-      # Reveal if the delegated field is multivalued or not
-      # @param [Symbol] field the field to query
-      # @return [Boolean]
-      def multiple?(field)
-        delegates[field][:multiple]
-      end
-
-      private
-      def create_delegate_reader(field, args)
-        self.delegates[field] ||= {}
-        self.delegates[field][:reader] = lambda do |*opts|
-          ds = self.send(args[:to])
-          if ds.kind_of?(ActiveFedora::RDFDatastream)
-            ds.send(field)
-          else
-            terminology = args[:at] || [field]
-            if terminology.length == 1 && opts.present?
-              ds.send(terminology.first, *opts)
-            else
-              ds.send(:term_values, *terminology)
-            end
-          end
-        end
-
-        if !args[:multiple].nil?
-          self.delegates[field][:multiple] = args[:multiple]
-        elsif !args[:unique].nil?
-          i = 0 
-          begin 
-            match = /in `(delegate.*)'/.match(caller[i])
-            i+=1
-          end while match.nil?
-
-          prev_method = match.captures.first
-          Deprecation.warn Delegating, "The :unique option for `#{prev_method}' is deprecated. Use :multiple instead. :unique will be removed in ActiveFedora 7", caller(i+1)
-          self.delegates[field][:multiple] = !args[:unique]
-        else 
-          i = 0 
-          begin 
-            match = /in `(delegate.*)'/.match(caller[i])
-            i+=1
-          end while match.nil?
-
-          prev_method = match.captures.first
-          Deprecation.warn Delegating, "You have not explicitly set the :multiple option on `#{prev_method}'. The default value will switch from true to false in ActiveFedora 7, so if you want to future-proof this application set `multiple: true'", caller(i+ 1)
-          self.delegates[field][:multiple] = true # this should be false for ActiveFedora 7
-        end
-
-        define_method field do |*opts|
-          val = array_reader(field, *opts)
-          self.class.multiple?(field) ? val : val.first
-        end
-      end
-
-
-      def create_delegate_setter(field, args)
-        self.delegates[field] ||= {}
-        self.delegates[field][:setter] = lambda do |v|
-          ds = self.send(args[:to])
-          mark_as_changed(field) if value_has_changed?(field, v)
-          if ds.kind_of?(ActiveFedora::RDFDatastream)
-            ds.send("#{field}=", v)
-          else
-            terminology = args[:at] || [field]
-            ds.send(:update_indexed_attributes, {terminology => v})
-          end
-        end
-        define_method "#{field}=".to_sym do |v|
-          self[field]=v
-        end
+        Deprecation.warn(Delegating, "delegate_to is deprecated and will be removed in ActiveFedora 7.0. use has_attributes instead", caller(1))
+        has_attributes *fields, args.merge!({:datastream=>datastream})
       end
 
     end

data/lib/active_fedora/querying.rb

@@ -145,7 +145,7 @@ module ActiveFedora
     def condition_to_clauses(key, value)
       unless value.nil?
         # if the key is a property name, turn it into a solr field
-        if self.delegates.key?(key)
+        if self.defined_attributes.key?(key)
           # TODO Check to see if `key' is a possible solr field for this class, if it isn't try :searchable instead
           key = ActiveFedora::SolrService.solr_name(key, :stored_searchable, type: :string)
         end

data/lib/active_fedora/version.rb

@@ -1,3 +1,3 @@
 module ActiveFedora
-  VERSION = "6.6.1"
+  VERSION = "6.7.0.rc1"
 end

data/spec/integration/attributes_spec.rb

@@ -0,0 +1,33 @@
+require 'spec_helper'
+
+describe "delegating attributes" do
+  before :all do
+    class TitledObject < ActiveFedora::Base
+      has_metadata 'foo', type: ActiveFedora::SimpleDatastream do |m|
+        m.field "title", :string
+      end
+      has_attributes :title, datastream: 'foo', multiple: false
+    end
+  end
+  after :all do
+    Object.send(:remove_const, :TitledObject)
+  end
+
+  describe "save" do
+    subject do
+      obj = TitledObject.create 
+      obj.title = "Hydra for Dummies"
+      obj.save
+      obj
+    end
+    it "should keep a list of changes after a successful save" do
+      subject.previous_changes.should_not be_empty
+      subject.previous_changes.keys.should include("title")
+    end
+    it "should clean out changes" do
+      subject.title_changed?.should be_false
+      subject.changes.should be_empty
+    end
+  end
+end
+

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: active-fedora
 version: !ruby/object:Gem::Version
-  version: 6.6.1
+  version: 6.7.0.rc1
 platform: ruby
 authors:
 - Matt Zumwalt
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-10-23 00:00:00.000000000 Z
+date: 2013-10-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rsolr
@@ -413,6 +413,7 @@ files:
 - spec/fixtures/sharded_fedora.yml
 - spec/fixtures/solr_rdf_descMetadata.nt
 - spec/integration/associations_spec.rb
+- spec/integration/attributes_spec.rb
 - spec/integration/auditable_spec.rb
 - spec/integration/base_spec.rb
 - spec/integration/bug_spec.rb
@@ -550,9 +551,9 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: 1.9.3
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - '>'
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.3.1
 requirements: []
 rubyforge_project: 
 rubygems_version: 2.0.3
@@ -578,6 +579,7 @@ test_files:
 - spec/fixtures/sharded_fedora.yml
 - spec/fixtures/solr_rdf_descMetadata.nt
 - spec/integration/associations_spec.rb
+- spec/integration/attributes_spec.rb
 - spec/integration/auditable_spec.rb
 - spec/integration/base_spec.rb
 - spec/integration/bug_spec.rb