active-fedora 9.0.8 → 9.1.0.rc1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA256:
-  metadata.gz: ebf611de1fa3721bc0d53f15e6210ced8509072da4f1406f818e2f14c5f11be2
-  data.tar.gz: 1f6729e4bce4f1b03ba5ba2864c4dbe84ae454932221de98fe4357b8e80e69e4
+SHA1:
+  metadata.gz: 1867e34e4a11cea022a7d127a3c4342b9b79d8e2
+  data.tar.gz: ba76e2cab3c5a808d2a7962cd5abd3fa6c1c5a1d
 SHA512:
-  metadata.gz: f5ba1bc7bcb326f435f1ed88cad1e1a7b68c04b122472379430bf320a634e67e3da72c13c424dda5ba1f9d2673aec820a74d9b7adffb60bd9c23498f89ed7b52
-  data.tar.gz: 2e06a0593ec85862f1995277e7a530f05bff3f31e30ed80a4719c04beb8807c28060ec275fa2d833c118b83ad22fb812c5a07d848823bbfc9d90bb8693683fd9
+  metadata.gz: 0b3caee0805b7b284a6894641cd57e1e409ada72da6ec11e718d4290b20b03ab1715accca3c08355bf49202ae69598e2b78e1cc7821f3437b8d138f29be05516
+  data.tar.gz: 1b3fa97271e54470676c3f896b5cd343a17e68690cb72125ec5047100f8d659933ca34a5fca34a34d7ce736b4962b9bbf66d41e84f9486bbb7af38accfce229f

data/History.txt

@@ -1,60 +1,3 @@
-v9.0.8
-
-  2015-04-15: Revert "Move the indexing logic to the model. Fixes #736"
-  [Justin Coyne] (cabb9057)
-
-  2015-04-15: Fix deleting from a HABTM when the inverse_of is a
-  has_many. Fixes #763 [Justin Coyne] (b1e67fb1)
-
-  2015-04-15: Remove a spec that is a duplicate of
-  integration/collection_association_spec.rb:92 [Justin Coyne]
-  (bdafd50d)
-
-  2015-04-15: Leverage the code in AssociationRelation to find the
-  inverse. Fixes #760 [Justin Coyne] (c764ea70)
-
-  2015-04-15: Make #translate_id_to_uri/uri_to_id reliable. [Trey
-  Terrell] (80a4e3fd)
-
-  2015-04-15: Find best model match in case of inheritance [Stuart
-  Kenny] (481a9cd4)
-
-  2015-04-15: Requires 'deprecation' for ActiveFedora::File [Andrew
-  Myers] (14be5cf6)
-
-  2015-04-07: The indexing hints should be inheritable [Justin Coyne]
-  (c8d41b91)
-
-v9.0.7
-  2015-04-06: Only set/save the inverse on a HABTM if the inverse is also HABTM
-  previously we were getting: [Justin Coyne]
-
-  2015-04-06: Derive a foreign_key ending with `_ids` if the inverse is a
-  collection [Justin Coyne]
-
-  2015-04-06: Find inverse relations when class_names have modules [Justin Coyne]
-
-  2015-04-06: Raise an error when the inverse relationship can not be found.
-  Previously a "SystemStackError: Stack too deep" was encountered in this
-  situation [Justin Coyne]
-
-  2015-04-02: Add a mechanism to set rdf_label on the ActiveTriple resource
-  [Justin Coyne]
-
-  2015-04-03: Refactor has_and_belongs_to_many_associations_spec [Justin Coyne]
-
-  2015-04-03: Remove unused sample classes [Justin Coyne]
-
-  2015-04-02: Sort versions as dates not as strings [Justin Coyne]
-
-  2015-04-01: Prevents an object from being loaded to the incorrect class. For
-  example, when loading a batch object it should be loaded into a Batch (and not a
-  File for example.) [Justin Coyne]
-
-  2015-03-27: Move the indexing logic to the model. Fixes #736 You should now add
-  indexing hints to has_attributes by passing a block similar to how you do it
-  with rdf properties. e.g.: [Justin Coyne]
-
 v9.0.6
   2015-03-26: Setting type should not wipe out properties. Fixes #737 [Justin Coyne]
 

data/README.md

@@ -23,21 +23,24 @@ Installation
 
 The gem is hosted on rubygems.
 
-    gem install active-fedora
+```bash
+gem install active-fedora
+```
 
 Getting Started
 ---------------
 
 The [Dive into Hydra](https://github.com/projecthydra/hydra/wiki/Dive-into-Hydra)
-gives you a brief tour through ActiveFedora’s features on the command
-line.
+gives you a brief tour through ActiveFedora’s features on the command line.
 
 Generators
 ----------
 
 You can generate a model inheriting from ActiveFedora::Base.
 
-    rails generate active_fedora:model Book
+```bash
+rails generate active_fedora:model Book
+```
 
 Testing (this Gem)
 ------------------
@@ -46,25 +49,30 @@ In order to run the RSpec tests, you need to have a copy of the
 ActiveFedora source code, and then run bundle install in the source
 directory. Testing requires hydra-jetty, which contains version for
 Fedora and Solr. Setting up and maintaining hydra-jetty for the purposes
-of testing this gem is all accomplished via
+of testing this gem is all accomplished via:
 
-    git clone https://github.com/projecthydra/active_fedora.git
-    cd /wherever/active_fedora/is
-    bundle install
+```bash
+git clone https://github.com/projecthydra/active_fedora.git
+cd active_fedora   # or whatever directory your clone is in
+bundle install
+```
 
 ### Using the continuous integration server
 
 You can test ActiveFedora using the same process as our continuous
-integration server. To do that, unzip a copy\
-of hydra-jetty first. This includes copies of Fedora and Solr which are
+integration server. To do that, unzip a copy of hydra-jetty first. This includes copies of Fedora and Solr which are
 used during the testing process.
 
-      rake jetty:unzip 
+```bash
+rake jetty:unzip 
+```
 
 Once hydra-jetty is unzipped, the ci rake task will spin up jetty,
 import the fixtures, and run the tests for you.
 
-      rake active_fedora:ci
+```bash
+rake active_fedora:ci
+```
 
 ### Testing Manually
 
@@ -73,30 +81,36 @@ If you want to run the tests manually, follow these instructions.
 You need to have a copy of hydra-jetty running. To do this, download a
 working copy of
 [hydra-jetty](https://github.com/projecthydra/hydra-jetty), cd into its
-root and run
+root and run:
 
-    java -jar start.jar
+```bash
+java -jar start.jar
+```
 
-Now you’re ready to run the tests. In the directory where active\_fedora
-is installed, run
+Now you’re ready to run the tests. In the directory where active_fedora
+is installed, run:
 
-      rake spec
+```bash
+rake spec
+```
 
 Predicate Mappings
 ------------------
 
 ActiveFedora versions 2.2.1 and higher provides specialized control over
 the predicate mappings used by SemanticNode. In order to provide your
-own mappings, \
-you must supply a predicate\_mappings.yml in the same format as the
-config/predicate\_mappings.yml file shipped with the ActiveFedora gem.
-Place the file in the same directory\
-as your fedora.yml file and use the current method of initializing
+own mappings,
+you must supply a `predicate_mappings.yml` in the same format as the
+`config/predicate_mappings.yml` file shipped with the ActiveFedora gem.
+Place the file in the same directory
+as your `fedora.yml` file and use the current method of initializing
 ActiveFedora:
 
-    ActiveFedora.init("/path/to/my/config/fedora.yml")
+```ruby
+ActiveFedora.init("/path/to/my/config/fedora.yml")
+```
 
-If no predicate\_mappings.yml file is found, ActiveFedora will use the
+If no `predicate_mappings.yml` file is found, ActiveFedora will use the
 default mappings.
 
 Acknowledgements

data/active-fedora.gemspec

@@ -22,7 +22,7 @@ Gem::Specification.new do |s|
   s.add_dependency "rdf-rdfxml", '~> 1.1.0'
   s.add_dependency "linkeddata"
   s.add_dependency "deprecation"
-  s.add_dependency "ldp", '~> 0.2.1'
+  s.add_dependency "ldp", '~> 0.3.0'
   s.add_dependency "rdf-ldp"
 
   s.add_development_dependency "rdoc"

data/lib/active_fedora.rb

@@ -49,6 +49,7 @@ module ActiveFedora #:nodoc:
     autoload :CachingConnection
     autoload :Callbacks
     autoload :ChangeSet
+    autoload :CleanConnection
     autoload :Config
     autoload :Core
     autoload_under 'core' do

data/lib/active_fedora/associations.rb

@@ -86,7 +86,7 @@ module ActiveFedora
       # Note that this method doesn't actually execute the block, but stores it, to be executed
       # by any the implementation of the datastream(specified as :class_name)
       #
-      # @param [String] :name the handle to refer to this child as
+      # @param [String] name the handle to refer to this child as
       # @param [Hash] options
       # @option options [Class] :class_name The class that will represent this child, should extend ``ActiveFedora::File''
       # @option options [String] :url

data/lib/active_fedora/attached_files.rb

@@ -86,7 +86,7 @@ module ActiveFedora
     # Attach the given stream/string to object
     #
     # @param [IO, String] file the file to add
-    # @param [Hash] opts options: :dsid, :prefix, :mime_type
+    # @param [Hash] args options: :dsid, :prefix, :mime_type
     # @option opts [String] :path The file path
     # @option opts [String] :prefix The path prefix (for auto-generated path)
     # @option opts [String] :mime_type The Mime-Type of the file

data/lib/active_fedora/attributes.rb

@@ -1,7 +1,10 @@
 require 'active_model/forbidden_attributes_protection'
+require 'deprecation'
 module ActiveFedora
   module Attributes
     extend ActiveSupport::Concern
+    extend Deprecation
+    self.deprecation_horizon = 'ActiveFedora 10.0'
     include ActiveModel::Dirty
     include ActiveModel::ForbiddenAttributesProtection
 
@@ -144,15 +147,9 @@ module ActiveFedora
         @delegated_attributes = val
       end
 
-      def has_attributes(*fields)
-        options = fields.pop
-        datastream = options.delete(:datastream).to_s
-        raise ArgumentError, "You must provide a datastream to has_attributes" if datastream.blank?
-        define_attribute_methods fields
-        fields.each do |f|
-          create_attribute_reader(f, datastream, options)
-          create_attribute_setter(f, datastream, options)
-        end
+      def has_attributes(*fields, &block)
+        Deprecation.warn(Attributes, "has_attributes is deprecated and will be removed in ActiveFedora 10.0. Use property instead")
+        define_delegated_accessor(*fields, &block)
       end
 
       # Reveal if the attribute has been declared unique
@@ -171,15 +168,44 @@ module ActiveFedora
       end
 
       def property name, properties={}, &block
+        if properties.key?(:predicate)
+          define_active_triple_accessor(name, properties, &block)
+        elsif properties.key?(:datastream)
+          define_delegated_accessor(name, properties.merge(multiple: true), &block)
+        else
+          raise "You must provide `:datastream' or `:predicate' options to property"
+        end
+      end
+
+      private
+
+      def define_active_triple_accessor(name, properties, &block)
         warn_duplicate_predicates name, properties
         properties = { multiple: true }.merge(properties)
         find_or_create_defined_attribute(name, nil, properties)
         raise ArgumentError, "#{name} is a keyword and not an acceptable property name." if protected_property_name? name
         reflection = ActiveFedora::Attributes::PropertyBuilder.build(self, name, properties, &block)
         ActiveTriples::Reflection.add_reflection self, name, reflection
+
+        add_attribute_indexing_config(name, &block) if block_given?
       end
 
-      private
+      def define_delegated_accessor(*fields, &block)
+        options = fields.pop
+        datastream = options.delete(:datastream).to_s
+        raise ArgumentError, "You must provide a datastream to has_attributes" if datastream.blank?
+        define_attribute_methods fields
+        fields.each do |f|
+          create_attribute_reader(f, datastream, options)
+          create_attribute_setter(f, datastream, options)
+          add_attribute_indexing_config(f, &block) if block_given?
+        end
+      end
+
+      def add_attribute_indexing_config(name, &block)
+        # TODO the hash can be initalized to return on of these
+        index_config[name] ||= ActiveFedora::Indexing::Map::IndexObject.new &block
+      end
 
       def warn_duplicate_predicates new_name, new_properties
         new_predicate = new_properties[:predicate]

data/lib/active_fedora/attributes/property_builder.rb

@@ -54,6 +54,7 @@ module ActiveFedora::Attributes
     end
 
     def build(&block)
+      #TODO remove this block stuff
       NodeConfig.new(name, options[:predicate], options.except(:predicate)) do |config|
         config.with_index(&block) if block_given?
       end

data/lib/active_fedora/clean_connection.rb

@@ -0,0 +1,40 @@
+module ActiveFedora
+  class CleanConnection < SimpleDelegator
+    def get(*args)
+      result = __getobj__.get(*args) do |req|
+        prefer_headers = Ldp::PreferHeaders.new(req.headers["Prefer"])
+        prefer_headers.omit = prefer_headers.omit | omit_uris
+        req.headers["Prefer"] = prefer_headers.to_s
+      end
+      CleanResult.new(result)
+    end
+
+    private
+
+    def omit_uris
+      [
+        RDF::Fcrepo4.ServerManaged,
+        RDF::Ldp.PreferContainment,
+        RDF::Ldp.PreferEmptyContainer,
+        RDF::Ldp.PreferMembership
+      ]
+    end
+
+    class CleanResult < SimpleDelegator
+      def graph
+        @graph ||= clean_graph
+      end
+
+      private
+
+      def clean_graph
+        __getobj__.graph.delete(has_model_query)
+        __getobj__.graph
+      end
+
+      def has_model_query
+        [nil, ActiveFedora::RDF::Fcrepo::Model.hasModel, nil]
+      end
+    end
+  end
+end

data/lib/active_fedora/fedora.rb

@@ -25,6 +25,10 @@ module ActiveFedora
       @connection ||= CachingConnection.new(authorized_connection)
     end
 
+    def clean_connection
+      @clean_connection ||= CleanConnection.new(connection)
+    end
+
     def ldp_resource_service
       @service ||= LdpResourceService.new(connection)
     end

data/lib/active_fedora/file.rb

@@ -14,8 +14,8 @@ module ActiveFedora
     define_model_callbacks :save, :create, :destroy
     define_model_callbacks :initialize, only: :after
 
-    # @param parent_or_url [ActiveFedora::Base, String, Hash, NilClass] the parent resource or the URI of this resource
-    # @param path_name [String] the path partial relative to the resource
+    # @param parent_or_url_or_hash [ActiveFedora::Base, String, Hash, NilClass] the parent resource or the URI of this resource
+    # @param path [String] the path partial relative to the resource
     # @param options [Hash]
     def initialize(parent_or_url_or_hash = nil, path=nil, options={})
       case parent_or_url_or_hash
@@ -284,20 +284,20 @@ module ActiveFedora
 
     module Streaming
       # @param range [String] the Range HTTP header
-      # @returns [Stream] an object that responds to each
+      # @return [Stream] an object that responds to each
       def stream(range = nil)
         uri = URI.parse(self.uri)
         FileBody.new(uri, headers(range, authorization_key))
       end
 
-      # @returns current authorization token from Ldp::Client
+      # @return [String] current authorization token from Ldp::Client
       def authorization_key
         self.ldp_source.client.http.headers.fetch("Authorization", nil)
       end
 
       # @param range [String] from #stream
       # @param key [String] from #authorization_key
-      # @returns [Hash]
+      # @return [Hash]
       def headers(range, key, result = Hash.new)
         result["Range"] = range if range
         result["Authorization"] = key if key

data/lib/active_fedora/indexing.rb

@@ -1,6 +1,11 @@
 module ActiveFedora
   module Indexing
     extend ActiveSupport::Concern
+    extend ActiveSupport::Autoload
+
+    eager_autoload do
+      autoload :Map
+    end
 
     # Return a Hash representation of this object where keys in the hash are appropriate Solr field names.
     # @param [Hash] solr_doc (optional) Hash to insert the fields into
@@ -51,6 +56,15 @@ module ActiveFedora
 
     module ClassMethods
 
+      # @return ActiveFedora::Indexing::Map
+      def index_config
+        @index_config ||= if superclass.respond_to?(:index_config)
+            superclass.index_config.deep_dup
+          else
+            ActiveFedora::Indexing::Map.new
+          end
+      end
+
       def indexer
         IndexingService
       end

data/lib/active_fedora/indexing/map.rb

@@ -0,0 +1,46 @@
+require 'forwardable'
+module ActiveFedora::Indexing
+  # This is a description of how properties should map to indexing strategies
+  #  e.g. 'creator_name' => <IndexObject behaviors=[:stored_searchable, :facetable]>
+  class Map
+    extend Forwardable
+    def_delegators :@hash, :[], :[]=, :each, :keys
+
+    def initialize(hash = {})
+      @hash = hash
+    end
+
+    def dup
+      self.class.new(@hash.deep_dup)
+    end
+
+    # this enables a cleaner API for solr integration
+    class IndexObject
+      attr_accessor :data_type, :behaviors
+
+      def initialize(&block)
+        @behaviors = []
+        @data_type = :string
+        yield self if block_given?
+      end
+
+      def as(*args)
+        @behaviors = args
+      end
+
+      def type(sym)
+        @data_type = sym
+      end
+
+      def dup
+        self.class.new do |idx|
+          idx.behaviors = @behaviors.dup
+        end
+      end
+
+      def defaults
+        :noop
+      end
+    end
+  end
+end