active-fedora 2.2.1 → 2.2.2

data/README.textile

@@ -18,7 +18,7 @@ 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.
 
-h2. Installation
+h2. Testing
 
 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.
 
@@ -26,9 +26,11 @@ In order to run the RSpec tests, you need to have a copy of the ActiveFedora sou
 git clone https://github.com/mediashelf/active_fedora.git
 cd /wherever/active_fedora/is
 bundle install
+git submodule init
+git submodule update
 </pre>
 
-h2. Testing with Hudson Rake Task
+h3. Testing with Hudson Rake Task
 
 The hudson rake task will spin up jetty, import the fixtures, and run the tests for you.
 
@@ -36,7 +38,7 @@ The hudson rake task will spin up jetty, import the fixtures, and run the tests
   rake hudson
 </pre>
 
-h2. Testing Manually
+h3. Testing Manually
 
 If you want to run the tests manually, follow these instructions.
 
@@ -49,16 +51,15 @@ java -jar start.jar
 Then open a new terminal, go to your ActiveFedora source directory, and import fedora's demo objects.
 
 <pre>
+  export FEDORA_HOME=/path/to/hydra/jetty/fedora/default
   rake active_fedora:load_fixtures RAILS_ENV=test
 </pre>
 
 This does the equivalent of:
 
 <pre>
-cd /wherever/active_fedora/is
-export FEDORA_HOME=/path/to/hydra/jetty/fedora/default
-$FEDORA_HOME/client/bin/fedora-ingest-demos.sh localhost 8983 fedoraAdmin fedoraAdmin http
-rake af:import_fixture pid=hydrangea:fixture_mods_article1 RAILS_ENV=test
+  $FEDORA_HOME/client/bin/fedora-ingest-demos.sh localhost 8983 fedoraAdmin fedoraAdmin http
+  rake af:import_fixture pid=hydrangea:fixture_mods_article1 RAILS_ENV=test
 </pre>
 
 Now you're ready to run the tests.  In the directory where active_fedora is installed, run
@@ -67,6 +68,18 @@ Now you're ready to run the tests.  In the directory where active_fedora is inst
   rake spec
 </pre>
 
+h2. 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 ActiveFedora:
+
+<pre>
+ActiveFedora.init("/path/to/my/config/fedora.yml")
+</pre>
+
+If no predicate_mappings.yml file is found, ActiveFedora will use the default mappings.
+
 h2. Acknowledgements
 
 Creator: Matt Zumwalt ("MediaShelf":http://yourmediashelf.com)
@@ -101,4 +114,4 @@ MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
 IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
 CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
 TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
-SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/lib/active_fedora.rb

@@ -58,7 +58,6 @@ module ActiveFedora #:nodoc:
 
     
     logger.info("FEDORA: loading ActiveFedora config from #{File.expand_path(config_path)}")
-    
     fedora_config = YAML::load(File.open(config_path))
     raise "The #{config_env} 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]
     
@@ -77,16 +76,7 @@ module ActiveFedora #:nodoc:
     logger.info("FEDORA: initialized Fedora as: #{Fedora::Repository.instance.inspect}")    
     
     # Retrieve the valid path for the predicate mappings config file
-    pred_config_paths = [File.dirname(config_path),File.join(File.dirname(__FILE__),"..","config")]
-    pred_config_paths.each do |path|
-      testfile = File.join(path,"predicate_mappings.yml")
-      if File.exist?(testfile)
-        @predicate_config_path = testfile
-        break
-      end
-    end
-    raise "Could not find predicate_mappings.yml in these locations: #{pred_config_paths.join("; ")}." unless @predicate_config_path
-
+    @predicate_config_path = build_predicate_config_path(File.dirname(config_path))
 
   end
   
@@ -103,17 +93,41 @@ module ActiveFedora #:nodoc:
   end
 
   def self.predicate_config
-    @predicate_config_path
+    @predicate_config_path ||= build_predicate_config_path
   end
 
   def self.version
     ActiveFedora::VERSION
   end
+
+  protected
+
+  def self.build_predicate_config_path(config_path=nil)
+    pred_config_paths = [File.expand_path(File.join(File.dirname(__FILE__),"..","config"))]
+    pred_config_paths.unshift config_path if config_path
+    pred_config_paths.each do |path|
+      testfile = File.join(path,"predicate_mappings.yml")
+      if File.exist?(testfile) && valid_predicate_mapping?(testfile)
+        return testfile
+      end
+    end
+    raise PredicateMappingsNotFoundError #"Could not find predicate_mappings.yml in these locations: #{pred_config_paths.join("; ")}." unless @predicate_config_path
+  end
+
+  def self.valid_predicate_mapping?(testfile)
+    mapping = YAML::load(File.open(testfile))
+    return false unless mapping.has_key?(:default_namespace) && mapping[:default_namespace].is_a?(String)
+    return false unless mapping.has_key?(:predicate_mapping) && mapping[:predicate_mapping].is_a?(Hash)
+    true
+  end
+    
+
 end
 
 
 
 
+
 # if ![].respond_to?(:count)
 #   class Array
 #     puts "active_fedora is Adding count method to Array"
@@ -129,5 +143,6 @@ end
 module ActiveFedora
   class ServerError < Fedora::ServerError; end # :nodoc:
   class ObjectNotFoundError < RuntimeError; end # :nodoc:
+  class PredicateMappingsNotFoundError < RuntimeError; end # :nodoc:
 end
 

data/lib/active_fedora/version.rb

@@ -1,3 +1,3 @@
 module ActiveFedora
-    VERSION = "2.2.1"
+    VERSION = "2.2.2"
 end

data/lib/tasks/active_fedora_dev.rake

@@ -38,6 +38,7 @@ task :hudson do
       :startup_wait=>30
     }
     error = Jettywrapper.wrap(jetty_params) do
+      ENV["FEDORA_HOME"]=File.expand_path(File.join(File.dirname(__FILE__),'..','..','jetty','fedora','default'))
       Rake::Task["active_fedora:load_fixtures"].invoke
       Rake::Task["active_fedora:rspec"].invoke
     end
@@ -94,7 +95,7 @@ namespace :active_fedora do
     require 'solrizer'
     require 'solrizer-fedora'
     require 'spec/samples/models/hydrangea_article'
-    ENV["FEDORA_HOME"]=File.expand_path(File.join(File.dirname(__FILE__),'..','..','jetty','fedora','default'))
+    ENV["FEDORA_HOME"] ||= File.expand_path(File.join(File.dirname(__FILE__),'..','..','jetty','fedora','default'))
     retval = `$FEDORA_HOME/client/bin/fedora-ingest-demos.sh localhost 8983 fedoraAdmin fedoraAdmin http`
     puts "loaded demo objects #{retval}"
     ActiveFedora.init unless Thread.current[:repo]

data/spec/unit/active_fedora_spec.rb

@@ -12,4 +12,72 @@ describe ActiveFedora do
       # push the model definition into the cmodel's datastream (ie. dsname: oral_history.rb vs dsname: ruby)
     end
   end
-end
+
+  describe ".build_predicate_config_path" do
+    it "should return the path to the default config/predicate_mappings.yml if no valid path is given" do
+      ActiveFedora.send(:build_predicate_config_path, nil).should == default_predicate_mapping_file
+    end
+
+    it "should return the path to the default config/predicate_mappings.yml if specified config file not found" do
+      File.expects(:exist?).with("/path/to/predicate_mappings.yml").returns(false)
+      File.expects(:exist?).with(default_predicate_mapping_file).returns(true)
+      ActiveFedora.send(:build_predicate_config_path,"/path/to").should == default_predicate_mapping_file
+    end
+
+    it "should return the path to the specified config_path if it exists" do
+      File.expects(:exist?).with("/path/to/predicate_mappings.yml").returns(true)
+      ActiveFedora.expects(:valid_predicate_mapping?).returns(true)
+      ActiveFedora.send(:build_predicate_config_path,"/path/to").should == "/path/to/predicate_mappings.yml"
+    end    
+  end
+
+  describe ".predicate_config" do
+    it "should return the default mapping if it has not been initialized" do
+      ActiveFedora.instance_variable_set("@predicate_config_path",nil)
+      ActiveFedora.predicate_config().should == default_predicate_mapping_file
+    end
+    it "should return the path that was set at initialization" do
+      pending()
+      File.expects(:exist?).with("/path/to/my/files/predicate_mappings.yml").returns(true)
+      mock_file = mock("fedora.yml")
+      File.expects(:open).returns(mock_file)
+      YAML.expects(:load).returns({"test"=>{"solr"=>{"url"=>"http://127.0.0.1:8983/solr/development"}, "fedora"=>{"url"=>"http://fedoraAdmin:fedoraAdmin@127.0.0.1:8983/fedora"}}})
+      ActiveFedora.init("/path/to/my/files/fedora.yml")
+      ActiveFedora.predicate_config.should == "/path/to/my/files/predicate_mappings.yml"
+    end
+  end
+
+  describe ".valid_predicate_mapping" do
+    it "should return true if the predicate mapping has the appropriate keys and value types" do
+      ActiveFedora.send(:valid_predicate_mapping?,default_predicate_mapping_file).should be_true
+    end
+    it "should return false if the mapping is missing the :default_namespace" do
+      mock_yaml({:default_namespace0=>"my_namespace",:predicate_mapping=>{:key0=>"value0", :key1=>"value1"}})
+      ActiveFedora.send(:valid_predicate_mapping?,"/path/to/predicate_mappings.yml").should be_false
+    end
+    it "should return false if the :default_namespace is not a string" do
+      mock_yaml({:default_namespace=>{:foo=>"bar"}, :predicate_mapping=>{:key0=>"value0", :key1=>"value1"}})
+      ActiveFedora.send(:valid_predicate_mapping?,"/path/to/predicate_mappings.yml").should be_false
+    end
+    it "should return false if the :predicate_mappings key is missing" do
+      mock_yaml({:default_namespace=>"a string"})
+      ActiveFedora.send(:valid_predicate_mapping?,"/path/to/predicate_mappings.yml").should be_false
+    end
+    it "should return false if the :predicate_mappings key is not a hash" do
+      mock_yaml({:default_namespace=>"a string",:predicate_mapping=>"another string"})
+      ActiveFedora.send(:valid_predicate_mapping?,"/path/to/predicate_mappings.yml").should be_false
+    end
+
+  end
+end
+
+
+def mock_yaml(hash)
+  mock_file = mock("predicate_mappings.yml")
+  File.expects(:open).with("/path/to/predicate_mappings.yml").returns(mock_file)
+  YAML.expects(:load).returns(hash)
+end
+
+def default_predicate_mapping_file
+  File.expand_path(File.join(File.dirname(__FILE__),"..","..","config","predicate_mappings.yml"))
+end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: active-fedora
 version: !ruby/object:Gem::Version 
-  hash: 5
+  hash: 3
   prerelease: 
   segments: 
   - 2
   - 2
-  - 1
-  version: 2.2.1
+  - 2
+  version: 2.2.2
 platform: ruby
 authors: 
 - Matt Zumwalt
@@ -16,7 +16,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-05-31 00:00:00 Z
+date: 2011-06-05 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: solr-ruby