tastyhat-cul-fedora-arm 0.1.0

data/.document

@@ -0,0 +1,5 @@
+README.rdoc
+lib/**/*.rb
+bin/*
+features/**/*.feature
+LICENSE

data/.gitignore

@@ -0,0 +1,6 @@
+*.sw?
+private
+.DS_Store
+coverage
+rdoc
+pkg

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 James Stuart
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+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.

data/README.rdoc

@@ -0,0 +1,29 @@
+= cul-fedora-arm
+
+This is designed, given an input specification referring to several metadata and resource files, create and ingest objects into a Fedora reposito
+
+== Input 
+
+The input consists of a specification of relationships and metadata that can be given in one of three ways:
+* A file name
+* An enumerable array of strings
+* A series of FILL IN objects
+
+=== Input Specification
+
+Description goes here.
+
+== Note on Patches/Pull Requests
+ 
+* Fork the project.
+* Make your feature addition or bug fix.
+* Add tests for it. This is important so I don't break it in a
+  future version unintentionally.
+* Commit, do not mess with rakefile, version, or history.
+  (if you want to have your own version, that is fine but
+   bump version in a commit by itself I can ignore when I pull)
+* Send me a pull request. Bonus points for topic branches.
+
+== Copyright
+
+Copyright (c) 2009 James Stuart. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,58 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "cul-fedora-arm"
+    gem.summary = %Q{Tools for dealing with Cul ARM specification}
+    gem.description = %Q{Tools for dealing with Cul ARM specification}
+    gem.email = "tastyhat@jamesstuart.org"
+    gem.homepage = "http://github.com/tastyhat/cul-fedora-arm"
+    gem.authors = ["James Stuart"]
+    gem.add_development_dependency "thoughtbot-shoulda"
+    gem.add_development_dependency "thoughtbot-factory_girl"
+    gem.add_dependency "activesupport"
+    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
+  end
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: sudo gem install jeweler"
+end
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/*_test.rb'
+  test.verbose = true
+end
+
+begin
+  require 'rcov/rcovtask'
+  Rcov::RcovTask.new do |test|
+    test.libs << 'test'
+    test.pattern = 'test/**/*_test.rb'
+    test.verbose = true
+  end
+rescue LoadError
+  task :rcov do
+    abort "RCov is not available. In order to run rcov, you must: sudo gem install spicycode-rcov"
+  end
+end
+
+task :test => :check_dependencies
+
+task :default => :test
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  if File.exist?('VERSION')
+    version = File.read('VERSION')
+  else
+    version = ""
+  end
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "cul-fedora-arm #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.1.1

data/cul-fedora-arm.gemspec

@@ -0,0 +1,67 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE
+# Instead, edit Jeweler::Tasks in Rakefile, and run `rake gemspec`
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{cul-fedora-arm}
+  s.version = "0.1.1"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["James Stuart"]
+  s.date = %q{2009-08-26}
+  s.description = %q{Tools for dealing with Cul ARM specification}
+  s.email = %q{tastyhat@jamesstuart.org}
+  s.extra_rdoc_files = [
+    "LICENSE",
+     "README.rdoc"
+  ]
+  s.files = [
+    ".document",
+     ".gitignore",
+     "LICENSE",
+     "README.rdoc",
+     "Rakefile",
+     "VERSION",
+     "cul-fedora-arm.gemspec",
+     "lib/cul-fedora-arm.rb",
+     "lib/cul/fedora/arm/builder.rb",
+     "test/cul_fedora_arm_builder_test.rb",
+     "test/factories.rb",
+     "test/factories/cul_fedora_arm_builder_factory.rb",
+     "test/fixtures/case1/builder-template.txt",
+     "test/helpers/template_builder.rb",
+     "test/test_helper.rb"
+  ]
+  s.homepage = %q{http://github.com/tastyhat/cul-fedora-arm}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.5}
+  s.summary = %q{Tools for dealing with Cul ARM specification}
+  s.test_files = [
+    "test/cul_fedora_arm_builder_test.rb",
+     "test/factories/cul_fedora_arm_builder_factory.rb",
+     "test/factories.rb",
+     "test/helpers/template_builder.rb",
+     "test/test_helper.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+      s.add_development_dependency(%q<thoughtbot-shoulda>, [">= 0"])
+      s.add_development_dependency(%q<thoughtbot-factory_girl>, [">= 0"])
+      s.add_runtime_dependency(%q<activesupport>, [">= 0"])
+    else
+      s.add_dependency(%q<thoughtbot-shoulda>, [">= 0"])
+      s.add_dependency(%q<thoughtbot-factory_girl>, [">= 0"])
+      s.add_dependency(%q<activesupport>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<thoughtbot-shoulda>, [">= 0"])
+    s.add_dependency(%q<thoughtbot-factory_girl>, [">= 0"])
+    s.add_dependency(%q<activesupport>, [">= 0"])
+  end
+end

data/lib/cul-fedora-arm.rb

@@ -0,0 +1,2 @@
+require "cul/fedora/arm/builder"
+require "activesupport"

data/lib/cul/fedora/arm/builder.rb

@@ -0,0 +1,89 @@
+module Cul
+  module Fedora
+    module Arm
+      class Builder
+        DEFAULT_TEMPLATE_HEADER = [:sequence, :aggregate_under, :metadata, :metadata_type, :content, :content_type, :id, :license]
+        
+        REQUIRED_COLUMNS = [:sequence]
+        MANDATORY_COLUMNS = [:sequence, :aggregate_under, :metadata]
+        VALID_COLUMNS = [:sequence, :aggregate_under, :metadata, :metadata_type, :content, :content_type, :id, :license]
+
+        attr_reader :parts
+        
+        def initialize(*args)
+          options = args.extract_options!
+
+          @parts = []
+
+          
+          if template = options.delete(:template)
+            parse_template(template)
+          end
+          
+          raise ArgumentError, "arguments should only include one of the following: :template" unless options.empty?
+        end
+
+
+        def add_part(*args)
+          value_hash = args.extract_options!
+          
+          test_for_invalid_columns(value_hash.keys)
+          test_for_required_columns(value_hash)
+          
+          raise "Sequence ID already taken" if part_by_sequence(value_hash[:sequence])
+          
+          @parts << value_hash
+        end
+        
+        def part_by_sequence(sequence_id)
+          @parts.detect { |p| p[:sequence] == sequence_id}
+        end
+        
+        protected
+        
+        def test_for_required_columns(value_hash)
+          missing_values = REQUIRED_COLUMNS.select { |col| !value_hash.has_key?(col) || value_hash[col].nil? }
+          raise "Missing required values #{missing_values.join(",")}" unless missing_values.empty?
+        end
+        
+        def test_for_invalid_columns(columns)
+          invalid_columns = columns.select { |c| !VALID_COLUMNS.include?(c) }
+          raise "Invalid column(s) found: #{invalid_columns.join(",")}" unless invalid_columns.empty?          
+        end
+        
+        def parse_template(template)
+          header_columns = []
+          custom_header = false
+          template.each_with_index do |line, i|
+            # check for header
+            if i == 0
+              case line.to_s
+              when /^[0-9]/
+                header_columns = DEFAULT_TEMPLATE_HEADER
+              when /^\w/
+                custom_header = true
+                header_columns = line.split("\t").collect { |cn| cn.strip.underscore.to_sym }
+                raise "First column of custom designed headers must be sequence" unless header_columns[0] == :sequence
+              end
+              
+
+              missing_mandatory_columns = MANDATORY_COLUMNS.select { |c| !header_columns.include?(c) }
+              raise "Missing mandatory column(s) found: #{missing_mandatory_columns.join(",")}" unless missing_mandatory_columns.empty?
+
+              test_for_invalid_columns(header_columns)
+
+              next if custom_header
+
+            end
+            value_hash = Hash[*header_columns.zip(line.split("\t").collect(&:strip)).flatten]
+            add_part(value_hash)
+          end
+          
+          header_columns
+        end
+        
+        
+      end
+    end
+  end
+end

data/test/cul_fedora_arm_builder_test.rb

@@ -0,0 +1,128 @@
+require 'test_helper'
+require 'test/helpers/template_builder'
+
+
+class CulFedoraArmBuilderTest < Test::Unit::TestCase
+  
+  context "The builder class" do
+    setup do
+      @builder_class = Cul::Fedora::Arm::Builder
+    end
+  
+    should "have a blank read_only array of parts" do
+      @builder = @builder_class.new
+      
+      assert_instance_of @builder_class, @builder
+      assert_equal [], @builder.parts
+      assert_raise NoMethodError do
+        @builder.parts = [:test]
+      end
+    end
+
+    should "have a default array of columns for templates without headers" do
+      assert_equal @builder_class::DEFAULT_TEMPLATE_HEADER, [:sequence, :aggregate_under, :metadata, :metadata_type, :content, :content_type, :id, :license]
+    end
+    
+    
+    should "have a list of mandatory, valid, and required columns" do
+      assert_equal @builder_class::REQUIRED_COLUMNS, [:sequence]
+      assert_equal @builder_class::MANDATORY_COLUMNS, [:sequence, :aggregate_under, :metadata]
+      assert_equal @builder_class::VALID_COLUMNS, [:sequence, :aggregate_under, :metadata, :metadata_type, :content, :content_type, :id, :license]
+    end
+    
+    should "accept only options :template" do
+      assert_raise(ArgumentError) do
+        @builder_class.new(:template => nil, :invalid => true)
+      end
+    end
+
+    context "given a blank builder" do
+      setup do
+        @builder = @builder_class.new        
+      end
+      
+      should "have a blank array of parts" do
+        assert_equal @builder.parts, []
+      end
+      
+      should "be able to add parts" do
+        @builder.add_part(:sequence => "0", :aggregate_under => "collection:1;ac:5", :metadata => "/test-0001.xml")
+      end
+
+      should "not add parts without a sequence" do
+        assert_raise RuntimeError, "Missing required values sequence" do
+          @builder.add_part(:aggregate_under => "collection:1;ac:5", :metadata => "/test-0001.xml")
+        end
+      end
+      
+      should "not add parts with the same sequence id" do
+
+        assert_raise(RuntimeError, "Sequence ID already taken") do
+          @builder.add_part(:sequence => "2", :metadata => "/test-0001.xml")
+          @builder.add_part(:sequence => "2", :metadata => "/test-0001.xml")
+        end
+      end
+    end
+
+    context "given headers for templates" do
+      setup do
+        @good_header = %w{sequence aggregateUnder metadata metadataType content contentType id}
+        @invalid_column = %w{sequence aggregateUnder metadata random}
+        @sequence_not_first = %w{aggregateUnder metadata sequence}
+        @missing_mandatory = %w{sequence aggregateUnder metadataType}
+      end
+
+      should "accept good headers" do
+        assert_instance_of @builder_class, @builder_class.new(:template => template_builder(@good_header))
+      end
+      
+      should "accept blank template" do
+        assert_nothing_raised do
+          @builder_class.new(:template => nil)
+        end
+      end
+      
+      should "insist on sequence being the first column" do
+        assert_raise RuntimeError, "First column of custom designed headers must be sequence" do
+          @builder_class.new(:template => template_builder(@sequence_not_first))
+        end
+      end
+      
+      should "reject invalid column names" do
+        assert_raise RuntimeError, "Invalid column name: random"  do
+          @builder_class.new(:template => template_builder(@invalid_column))
+        end
+      end
+      
+      should "insist on all mandatory columns" do
+        assert_raise RuntimeError, "Missing mandatory column: metadata" do
+          @builder_class.new(:template => template_builder(@missing_mandatory))
+        end
+      end
+    end
+    
+    context "with an example template with header" do
+      setup do
+        @builder = @builder_class.new(:template => File.open("test/fixtures/case1/builder-template.txt", "r"))
+      end
+      
+      should "load successfully" do
+        assert_instance_of @builder_class, @builder
+      end
+      
+      should "ignore the header and load template data successfully" do
+        assert_equal @builder.parts.length, 4
+        assert_equal @builder.parts[0][:metadata],  "/test-0001.xml"
+        assert_equal @builder.parts[3][:license],  "http://creativecommons.org/licenses/by-nc-nd/3.0/us/"
+      end
+
+      should "have parts accessible by sequence id" do
+        assert_kind_of Hash, @builder.part_by_sequence("5")
+        assert_equal @builder.parts[3], @builder.part_by_sequence("5")
+      end
+    end
+  end
+  
+  
+end
+

data/test/factories.rb

@@ -0,0 +1 @@
+require "cul-fedora-arm"

data/test/factories/cul_fedora_arm_builder_factory.rb

@@ -0,0 +1,3 @@
+Factory.define :builder, :class => Cul::Fedora::Arm::Builder do |f|
+  
+end

data/test/fixtures/case1/builder-template.txt

@@ -0,0 +1,5 @@
+sequence	aggregateUnder	metadata	metadataType	content	contentType	id	license
+0	collection:1;ac:5	/test-0001.xml	MODS		ContentAggregator	AC:P:5001	
+1	0			/01-Northover_IPD_SovDebt_Working_Paper.pdf	Resource		http://creativecommons.org/licenses/by-nc-nd/3.0/us/
+4	collection:1;ac:5	/test-0002.xml	MODS		ContentAggregator	AC:P:5002	
+5	4			/02-851.pdf	Resource		http://creativecommons.org/licenses/by-nc-nd/3.0/us/

data/test/helpers/template_builder.rb

@@ -0,0 +1,4 @@
+
+def template_builder(*lines_of_elements)
+  lines_of_elements.collect { |l| l.join("\t")}.join("\r\n")
+end

data/test/test_helper.rb

@@ -0,0 +1,14 @@
+require 'rubygems'
+require 'test/unit'
+require 'shoulda'
+require 'factory_girl'
+require 'activesupport'
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+
+require 'cul-fedora-arm'
+
+class ActiveSupport::TestCase
+end
+

metadata

@@ -0,0 +1,102 @@
+--- !ruby/object:Gem::Specification 
+name: tastyhat-cul-fedora-arm
+version: !ruby/object:Gem::Version 
+  version: 0.1.0
+platform: ruby
+authors: 
+- James Stuart
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-08-26 00:00:00 -07:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: thoughtbot-shoulda
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: thoughtbot-factory_girl
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: activesupport
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+description: Tools for dealing with Cul ARM specification
+email: tastyhat@jamesstuart.org
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.rdoc
+files: 
+- .document
+- .gitignore
+- LICENSE
+- README.rdoc
+- Rakefile
+- VERSION
+- cul-fedora-arm.gemspec
+- lib/cul-fedora-arm.rb
+- lib/cul/fedora/arm/builder.rb
+- test/cul_fedora_arm_builder_test.rb
+- test/factories.rb
+- test/factories/cul_fedora_arm_builder_factory.rb
+- test/fixtures/case1/builder-template.txt
+- test/helpers/template_builder.rb
+- test/test_helper.rb
+has_rdoc: false
+homepage: http://github.com/tastyhat/cul-fedora-arm
+licenses: 
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.5
+signing_key: 
+specification_version: 3
+summary: Tools for dealing with Cul ARM specification
+test_files: 
+- test/cul_fedora_arm_builder_test.rb
+- test/factories/cul_fedora_arm_builder_factory.rb
+- test/factories.rb
+- test/helpers/template_builder.rb
+- test/test_helper.rb