active-fedora 2.3.3 → 2.3.4

data/.gitignore

@@ -12,6 +12,7 @@ tmtags
 
 ## VIM
 *.swp
+*.swo
 
 ##SVN
 .svn

data/CONSOLE_GETTING_STARTED.textile

@@ -305,7 +305,7 @@ ActiveFedora::Base.find(:all)
 SpecialThing.find(:all)
 </pre>
 
-Note that the results from these two searches do not overlap.  Base.find will only return objects that have been saved with active_fedora_model_field set to "info:fedora/afmodel:Base".  If you open an object as an instance of a different model and save it as that model, it will overwrite the active_fedora_model_field.  This is, of course, no good.  That's why the method will be rewritten in "Version 1.1":/versions/show/7.  In the meantime, you could search directly against Solr with queries like this:
+You can also query solr directly like so:
 
 <pre>
 solr_result = ActiveFedora::SolrService.instance.conn.query('has_model_s:info\:fedora/afmodel\:SpecialThing')
@@ -366,5 +366,5 @@ Notice that properties and DC have been loaded as ActiveFedora::Datastream, RELS
 
 h2.  Where to Find More Information
 
-You can examine the files in lib/active_fedora/samples to learn more about how to define ActiveFedora models and OM-based datastreams.  We also suggest you read about "OM-based NokogiriDatastreams":https://github.com/mediashelf/active_fedora/blob/master/NOKOGIRI_DATASTREAMS.textile to learn about manipulating XML contained in datastreams.
+You can examine the files in lib/active_fedora/samples to learn more about how to define ActiveFedora models and OM-based datastreams.  We also suggest you read about "OM-based NokogiriDatastreams":http://hudson.projecthydra.org/job/active_fedora/Documentation/file.NOKOGIRI_DATASTREAMS.html to learn about manipulating XML contained in datastreams.
 

data/Gemfile

@@ -1,17 +1,5 @@
 source "http://rubygems.org"
 
-group :development, :test do
-  gem "jeweler"
-  gem "rspec", "<2.0.0"
-  gem "mocha", ">= 0.9.8"
-  gem "ruby-debug"
-  gem "jettywrapper"
-  gem "rcov"
-  gem "yard"
-  gem "RedCloth"
-  gem "solrizer-fedora"
-end
-
-# Bundler will rely on active-fedora.gemspec (which is generated by Jeweler section of Rakefile) for runtime dependency information.
+# Bundler will rely on active-fedora.gemspec for dependency information.
 
 gemspec

data/Gemfile.lock

@@ -1,13 +1,13 @@
 PATH
   remote: .
   specs:
-    active-fedora (2.3.2)
+    active-fedora (2.3.4)
       activeresource
       equivalent-xml
       facets
       mediashelf-loggable
       mime-types (>= 1.16)
-      multipart-post
+      multipart-post (= 1.1.2)
       nokogiri
       om (>= 1.0)
       solr-ruby (>= 0.0.6)
@@ -18,33 +18,33 @@ GEM
   remote: http://rubygems.org/
   specs:
     RedCloth (4.2.7)
-    activeresource (2.3.12)
-      activesupport (= 2.3.12)
-    activesupport (2.3.12)
+    activeresource (2.3.14)
+      activesupport (= 2.3.14)
+    activesupport (2.3.14)
     builder (3.0.0)
-    columnize (0.3.2)
-    daemons (1.1.3)
+    columnize (0.3.4)
+    daemons (1.1.4)
     equivalent-xml (0.2.7)
       nokogiri (>= 1.4.3)
     facets (2.9.1)
-    git (1.2.5)
-    jettywrapper (0.0.3)
-    jeweler (1.6.0)
-      bundler (~> 1.0.0)
-      git (>= 1.2.5)
-      rake
-    linecache (0.43)
-    mediashelf-loggable (0.4.2)
+    fastercsv (1.5.4)
+    jettywrapper (0.0.10)
+      logger
+      mediashelf-loggable
+    linecache (0.46)
+      rbx-require-relative (> 0.0.4)
+    logger (1.2.8)
+    mediashelf-loggable (0.4.7)
     mime-types (1.16)
     mocha (0.9.12)
     multipart-post (1.1.2)
-    nokogiri (1.4.4)
-    om (1.2.4)
+    nokogiri (1.5.0)
+    om (1.3.0)
       nokogiri (>= 1.4.2)
-      om
-    rake (0.8.7)
-    rcov (0.9.9)
-    rsolr (1.0.0)
+    rake (0.9.2)
+    rbx-require-relative (0.0.5)
+    rcov (0.9.10)
+    rsolr (1.0.2)
       builder (>= 2.1.2)
     rspec (1.3.2)
     ruby-debug (0.10.4)
@@ -53,24 +53,22 @@ GEM
     ruby-debug-base (0.10.4)
       linecache (>= 0.3)
     solr-ruby (0.0.8)
-    solrizer (1.0.4)
+    solrizer (1.1.0)
       daemons
       mediashelf-loggable
-      mediashelf-loggable
-      nokogiri
       nokogiri
-      nokogiri
-      om
       om (>= 1.0.0)
       stomp
       xml-simple
-    solrizer-fedora (1.0.2)
-      active-fedora (>= 2.0.0)
+    solrizer-fedora (1.1.0)
+      active-fedora (>= 2.3.0)
+      fastercsv
       rsolr
+      solr-ruby (>= 0.0.6)
       solrizer (>= 1.0.0)
-    stomp (1.1.8)
-    xml-simple (1.0.15)
-    yard (0.6.8)
+    stomp (1.1.9)
+    xml-simple (1.1.0)
+    yard (0.7.2)
 
 PLATFORMS
   ruby
@@ -79,11 +77,10 @@ DEPENDENCIES
   RedCloth
   active-fedora!
   jettywrapper
-  jeweler
   mocha (>= 0.9.8)
+  rake
   rcov
   rspec (< 2.0.0)
   ruby-debug
-  solrizer
   solrizer-fedora
   yard

data/History.txt

@@ -1,3 +1,7 @@
+2.3.4
+moved dirty assignment to NokogiriDatastream#update_values; added test (Benjamin Armintor)
+Fixed HYDRA-590
+
 2.1.0
 
 HYDRUS-151: Base.update_datastream_attributes now relies on update_indexed_attributes instead of update_attributes.  This makes it easier to support non-javascript forms (and makes update_datastream_attributes worth using).
@@ -176,4 +180,4 @@ Changelog:
 * Feature #284: solr document id should by a config option instead of hard coded as "id"
 * Feature #307: ActiveFedora::Base should provide a label setter.
 * Feature #314: Relationship finder should provide a "response_format" option, default to format of "objects"
-* Feature #327: Option to turn off solr updates (assume that something else will update Solr for you)
+* Feature #327: Option to turn off solr updates (assume that something else will update Solr for you)

data/NOKOGIRI_DATASTREAMS.textile

@@ -18,7 +18,7 @@ terminology = doc.class.terminology # The terminology is attached to the Documen
 
 h2. Setup
 
-This tutorial assumes that you've run script/console from the root of ActiveFedora and have imported the hydrangea:fixture_mods_article1 object.  If you haven't done that, see "CONSOLE_GETTING_STARTED":https://github.com/mediashelf/active_fedora/blob/master/CONSOLE_GETTING_STARTED.textile for instructions.
+This tutorial assumes that you've run script/console from the root of ActiveFedora and have imported the hydrangea:fixture_mods_article1 object.  If you haven't done that, see "CONSOLE_GETTING_STARTED":http://hudson.projecthydra.org/job/active_fedora/Documentation/file.CONSOLE_GETTING_STARTED.html for instructions.
 
 The model definition we're using in this tutorial is {SpecialThing} ( "see the code":https://github.com/mediashelf/active_fedora/blob/master/lib/active_fedora/samples/special_thing.rb )
 

data/README.textile

@@ -5,7 +5,6 @@ RubyFedora and ActiveFedora provide a set of Ruby gems for creating and managing
 h2. Getting Help
 
 * Project Homepage: "http://yourmediashelf.com/activefedora":http://yourmediashelf.com/activefedora
-* Further documentation is available at "http://projects.mediashelf.us/projects/active-fedora":http://projects.mediashelf.us/projects/active-fedora
 * Community Discussions & Mailing List are located at "http://groups.google.com/group/active-fedora":http://groups.google.com/group/active-fedora
 
 h2. Installation
@@ -16,7 +15,7 @@ The gem is hosted on gemcutter.
 
 h2. Getting Started
 
-The "ActiveFedora Console Tour":https://github.com/mediashelf/active_fedora/blob/master/CONSOLE_GETTING_STARTED.textile  gives you a brief tour through ActiveFedora's features on the command line.
+The "ActiveFedora Console Tour":http://hudson.projecthydra.org/job/active_fedora/Documentation/file.CONSOLE_GETTING_STARTED.html  gives you a brief tour through ActiveFedora's features on the command line.
 
 h2. Testing (this Gem)
 

data/active-fedora.gemspec

@@ -18,7 +18,7 @@ Gem::Specification.new do |s|
   s.add_dependency('solr-ruby', '>= 0.0.6')
   s.add_dependency('xml-simple', '>= 1.0.12')
   s.add_dependency('mime-types', '>= 1.16')
-  s.add_dependency('multipart-post')
+  s.add_dependency('multipart-post', "1.1.2")
   s.add_dependency('nokogiri')
   s.add_dependency('om', '>= 1.0')
   s.add_dependency('solrizer', '>1.0.0')
@@ -27,12 +27,15 @@ Gem::Specification.new do |s|
   s.add_dependency("equivalent-xml")
   s.add_dependency("facets")
   s.add_development_dependency("yard")
-  s.add_development_dependency("RedCloth")
+  s.add_development_dependency("RedCloth") # for RDoc formatting
+  s.add_development_dependency("rake")
   s.add_development_dependency("rcov")
-  s.add_development_dependency("solrizer")
-  s.add_development_dependency("solrizer-fedora")
+  s.add_development_dependency("solrizer-fedora") # used by the fixtures rake tasks
   s.add_development_dependency("jettywrapper")
-
+  s.add_development_dependency("rspec", "<2.0.0")
+  s.add_development_dependency("mocha", ">= 0.9.8")
+  s.add_development_dependency("ruby-debug")  
+  
   s.files         = `git ls-files`.split("\n")
   s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
   s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }

data/config/fedora.yml

@@ -1,16 +1,7 @@
 development:
-  fedora:
-    url: http://fedoraAdmin:fedoraAdmin@127.0.0.1:8983/fedora
-  solr:
-    url: http://127.0.0.1:8983/solr/development
+  url: http://fedoraAdmin:fedoraAdmin@127.0.0.1:8983/fedora
 test:
-  fedora:
-    url: http://fedoraAdmin:fedoraAdmin@127.0.0.1:8983/fedora
-  solr:
-    url: http://127.0.0.1:8983/solr/test
+  url: http://fedoraAdmin:fedoraAdmin@127.0.0.1:8983/fedora
 production:
-  fedora:
-    url: http://fedoraAdmin:fedoraAdmin@127.0.0.1:8080/fedora
-  solr:
-    url: http://127.0.0.1:8080/solr
+  url: http://fedoraAdmin:fedoraAdmin@127.0.0.1:8080/fedora
     

data/lib/active_fedora.rb

@@ -1,4 +1,7 @@
 require 'rubygems'
+require "bundler/setup"
+Bundler.require(:default)
+
 gem 'solr-ruby'
 require "loggable"
 
@@ -32,64 +35,204 @@ module ActiveFedora #:nodoc:
   include Loggable
   
   class << self
-    attr_accessor :solr_config, :fedora_config, :config_env
+    attr_accessor :solr_config, :fedora_config, :config_env, :fedora_config_path, :solr_config_path
+    attr_reader :config_options
   end
   
   # The configuration hash that gets used by RSolr.connect
   @solr_config ||= {}
   @fedora_config ||= {}
 
-  # Initializes ActiveFedora's connection to Fedora and Solr based on the info in fedora.yml
+  # Initializes ActiveFedora's connection to Fedora and Solr based on the info in fedora.yml and solr.yml
+  # NOTE: this deprecates the use of a solr url in the fedora.yml
+  #
+  # 
   # If Rails.env is set, it will use that environment.  Defaults to "development".
-  # @param [String] config_path (optional) the path to fedora.yml
-  #   If config_path is not provided and Rails.root is set, it will look in RAILS_ENV/config/fedora.yml.  Otherwise, it will look in your config/fedora.yml.  Failing that, it will use localhost urls.
-  def self.init( config_path=nil )
-    
-    if defined?(Rails.env)
-      @config_env = Rails.env
-    elsif defined?(ENV['environment'])
-      @config_env = ENV['environment']
-    else 
-      @config_env = 'development'
-      logger.warn("No environment setting found: Using the default development environment.")
+  # @param [Hash] options (optional) a list of options for the configuration of active_fedora
+  # @option options [String] :environment The environment within which to run
+  # @option options [String] :fedora_config_path The full path to the fedora.yml config file.
+  # @option options [String] :solr_config_path The full path to the solr.yml config file.
+  # 
+  # If :environment is not set, order of preference is 
+  # 1. Rails.env
+  # 2. ENV['environment']
+  # 3. RAILS_ENV
+  #
+  # If :fedora_config_path is not set, it will look in 
+  # 1. +Rails.root+/config
+  # 2. +current working directory+/config
+  # 3. (default) the fedora.yml shipped with gem
+  #
+  # If :solr_config_path is not set, it will 
+  # 1. look in config_options[:fedora_config_path].  If it finds a solr.yml there, it will use it.
+  # 2. If it does not find a solr.yml and the fedora.yml contains a solr url, it will raise an configuration error 
+  # 3. If it does not find a solr.yml and the fedora.yml does not contain a solr url, it will look in: +Rails.root+/config, +current working directory+/config, then the solr.yml shipped with gem
+  def self.init( options={} )
+    logger.level = Logger::ERROR
+    # Make config_options into a Hash if nil is passed in as the value
+    options = {} if options.nil?
+
+    # For backwards compatibility, handle cases where config_path (a String) is passed in as the argument rather than a config_options hash
+    # In all other cases, set config_path to config_options[:config_path], which is ok if it's nil
+    if options.is_a? String
+      logger.warn "DEPRECATION WARNING: Calling ActiveFedora.init with a path as an argument is deprecated.  Use ActiveFedora.init(:config_path=>#{options})"
+      @config_options = {:fedora_config_path=>options}
+    else
+      @config_options = options
     end
-        
-    if config_path.nil? 
-      if defined?(Rails.root)
-        config_path = "#{Rails.root}/config/fedora.yml"
+
+    @config_env = environment
+    @fedora_config_path = get_config_path(:fedora)
+    load_config(:fedora)
+
+    @solr_config_path = get_config_path(:solr)
+    load_config(:solr)
+
+    register_fedora_and_solr
+
+    # Retrieve the valid path for the predicate mappings config file
+    @predicate_config_path = build_predicate_config_path(File.dirname(fedora_config_path))
+
+  end
+
+  def self.load_configs
+    load_config(:fedora)
+    load_config(:solr)
+  end
+
+  def self.load_config(config_type)
+    config_type = config_type.to_s
+    config_path = self.send("#{config_type}_config_path".to_sym)
+
+    logger.info("#{config_type.upcase}: loading ActiveFedora.#{config_type}_config from #{File.expand_path(config_path)}")
+    config = YAML::load(File.open(config_path))
+    raise "The #{@config_env.to_s} environment settings were not found in the #{config_type}.yml config.  If you already have a #{config_type}.yml file defined, make sure it defines settings for the #{@config_env} environment" unless config[@config_env]
+    
+    config[:url] = determine_url(config_type,config)
+
+    self.instance_variable_set("@#{config_type}_config", config)
+    config
+  end
+
+  # Determines and sets the fedora_config[:url] or solr_config[:url]
+  # @param [String] config_type Either 'fedora' or 'solr'
+  # @param [Hash] config The config hash 
+  # @return [String] the solr or fedora url
+  def self.determine_url(config_type,config)  
+    if config_type == "fedora"
+      # support old-style config
+      if config[environment].fetch("fedora",nil)
+        return config[environment]["fedora"]["url"] if config[environment].fetch("fedora",nil)
       else
-        config_path = File.join("config","fedora.yml")
+        return config[environment]["url"]
       end
+    else
+      return get_solr_url(config[environment]) if config_type == "solr"
     end
+  end
 
-    unless File.exist?(config_path)
-      config_path = File.join(File.dirname(__FILE__), "..", "config", "fedora.yml")
-      logger.info "Using the default fedora.yml that comes with active-fedora.  If you want to override this, pass the path to fedora.yml as an argument to ActiveFedora.init or set Rails.root and put fedora.yml into \#{Rails.root}/config."
+  # Given the solr_config that's been loaded for this environment, 
+  # determine which solr url to use
+  def self.get_solr_url(solr_config)
+    if @index_full_text == true && solr_config.has_key?('fulltext') && solr_config['fulltext'].has_key?('url')
+      return solr_config['fulltext']['url']
+    elsif solr_config.has_key?('default') && solr_config['default'].has_key?('url')
+      return solr_config['default']['url']
+    elsif solr_config.has_key?('url')
+      return solr_config['url']
+    elsif solr_config.has_key?(:url)
+      return solr_config[:url]
+    else
+      raise URI::InvalidURIError
     end
-    
-    logger.info("FEDORA: loading ActiveFedora config from #{File.expand_path(config_path)}")
-    fedora_config = YAML::load(File.open(config_path))
-    raise "The #{@config_env.to_s} environment settings were not found in the fedora.yml config.  If you already have a fedora.yml file defined, make sure it defines settings for the #{@config_env} environment" unless fedora_config[@config_env]
-    
-    ActiveFedora.solr_config[:url] = fedora_config[@config_env]['solr']['url']
-    
+  end
+
+  def self.register_fedora_and_solr
     # Register Solr
     logger.info("FEDORA: initializing ActiveFedora::SolrService with solr_config: #{ActiveFedora.solr_config.inspect}")
-    
     ActiveFedora::SolrService.register(ActiveFedora.solr_config[:url])
     logger.info("FEDORA: initialized Solr with ActiveFedora.solr_config: #{ActiveFedora::SolrService.instance.inspect}")
         
-    ActiveFedora.fedora_config[:url] = fedora_config[@config_env]['fedora']['url']
     logger.info("FEDORA: initializing Fedora with fedora_config: #{ActiveFedora.fedora_config.inspect}")
-    
     Fedora::Repository.register(ActiveFedora.fedora_config[:url])
     logger.info("FEDORA: initialized Fedora as: #{Fedora::Repository.instance.inspect}")    
     
-    # Retrieve the valid path for the predicate mappings config file
-    @predicate_config_path = build_predicate_config_path(File.dirname(config_path))
+  end
+
+  # Determine what environment we're running in. Order of preference is:
+  # 1. config_options[:environment]
+  # 2. Rails.env
+  # 3. ENV['environment']
+  # 4. ENV['RAILS_ENV']
+  # 5. raises an exception if none of these is set
+  # @return [String]
+  # @example 
+  #  ActiveFedora.init(:environment=>"test")
+  #  ActiveFedora.environment => "test"
+  def self.environment
+    if config_options.fetch(:environment,nil)
+      return config_options[:environment]
+    elsif defined?(Rails.env) and !Rails.env.nil?
+      return Rails.env.to_s
+    elsif defined?(ENV['environment']) and !(ENV['environment'].nil?)
+      return ENV['environment']
+    elsif defined?(ENV['RAILS_ENV']) and !(ENV['RAILS_ENV'].nil?)
+      logger.warn("You're depending on RAILS_ENV for setting your environment. This is deprecated in Rails3. Please use ENV['environment'] for non-rails environment setting: 'rake foo:bar environment=test'")
+      ENV['environment'] = ENV['RAILS_ENV']
+      return ENV['environment']
+    else
+      raise "Can't determine what environment to run in!"
+    end
+  end
+  
+  # Determine the fedora config file to use. Order of preference is:
+  # 1. Use the config_options[:config_path] if it exists
+  # 2. Look in +Rails.root+/config/fedora.yml
+  # 3. Look in +current working directory+/config/fedora.yml
+  # 4. Load the default config that ships with this gem
+  # @param [String] config_type Either ‘fedora’ or ‘solr’
+  # @return [String]
+  def self.get_config_path(config_type)
+    config_type = config_type.to_s
+    if (config_path = config_options.fetch("#{config_type}_config_path".to_sym,nil) )
+      raise ActiveFedoraConfigurationException unless File.file? config_path
+      return config_path
+    end
+    
+    # if solr, attempt to use path where fedora.yml is first
+    if config_type == "solr" && (config_path = check_fedora_path_for_solr)
+      return config_path
+    elsif config_type == "solr" && fedora_config[environment].fetch("solr",nil)
+      logger.warn("DEPRECATION WARNING: You appear to be using a deprecated format for your fedora.yml file.  The solr url should be stored in a separate solr.yml file in the same directory as the fedora.yml")
+      raise ActiveFedoraConfigurationException
+    end
 
+    if defined?(Rails.root)
+      config_path = "#{Rails.root}/config/#{config_type}.yml"
+      return config_path if File.file? config_path
+    end
+    
+    if File.file? "#{Dir.getwd}/config/#{config_type}.yml"  
+      return "#{Dir.getwd}/config/#{config_type}.yml"
+    end
+    
+    # Last choice, check for the default config file
+    config_path = File.expand_path(File.join(File.dirname(__FILE__), "..", "config", "#{config_type}.yml"))
+    logger.warn "Using the default #{config_type}.yml that comes with active-fedora.  If you want to override this, pass the path to #{config_type}.yml to ActiveFedora - ie. ActiveFedora.init(:#{config_type} => '/path/to/#{config_type}.yml) - or set Rails.root and put #{config_type}.yml into \#{Rails.root}/config."
+    return config_path if File.file? config_path
+    raise ActiveFedoraConfigurationException "Couldn't load #{config_type} config file!"
   end
   
+  # Checks the existing fedora_config_path to see if there is a solr.yml there
+  def self.check_fedora_path_for_solr
+    path = fedora_config_path.split('/')[0..-2].join('/') + "/solr.yml"
+    if File.file? path
+      return path
+    else
+      return nil
+    end
+  end
+
   def self.solr
     ActiveFedora::SolrService.instance
   end
@@ -130,22 +273,6 @@ module ActiveFedora #:nodoc:
 
 end
 
-
-
-
-
-# if ![].respond_to?(:count)
-#   class Array
-#     puts "active_fedora is Adding count method to Array"
-#       def count(&action)
-#         count = 0
-#          self.each { |v| count = count + 1}
-#   #      self.each { |v| count = count + 1 if action.call(v) }
-#         return count
-#       end
-#   end
-# end
-
 module ActiveFedora
   class ServerError < Fedora::ServerError; end # :nodoc:
   class ObjectNotFoundError < RuntimeError; end # :nodoc: