fixlr-dspace-ruby 0.1.0

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 Nathan Fixler
+
+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,12 @@
+= dspace-ruby
+
+Dspace::Config class that can be used to parse the data from a 
+DSpace (www.dspace.org) configuration file to be used within a Ruby script
+so that you do not have to duplicate server configuration values outside the
+main configuration file.
+
+See example file(s) and specs for usage.
+
+== Copyright
+
+Copyright (c) 2009 Nathan Fixler. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,56 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "dspace-ruby"
+    gem.summary = %Q{Collection of tools for working with a DSpace repository in Ruby.}
+    gem.email = "nathan@fixler.org"
+    gem.homepage = "http://github.com/fixlr/dspace-ruby"
+    gem.authors = ["Nathan Fixler"]
+
+    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
+  end
+rescue LoadError
+  puts "Jeweler not available. Install it with: sudo gem install technicalpickles-jeweler -s http://gems.github.com"
+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 :default => :test
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  if File.exist?('VERSION.yml')
+    config = YAML.load(File.read('VERSION.yml'))
+    version = "#{config[:major]}.#{config[:minor]}.#{config[:patch]}"
+  else
+    version = ""
+  end
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "dspace-ruby #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+

data/VERSION.yml

@@ -0,0 +1,4 @@
+--- 
+:major: 0
+:minor: 1
+:patch: 0

data/lib/dspace/active_record.rb

@@ -0,0 +1,17 @@
+# Far, far from a complete ActiveRecord configuration for DSpace.
+
+require 'active_record'
+
+# Override the save methods because I don't want to 
+# accidentally overwrite something in the DSpace DB.
+class ActiveRecord::Base
+  def save
+    false
+  end
+  def save!
+    false
+  end
+end
+ActiveRecord::Base.primary_key_prefix_type = :table_name_with_underscore
+
+Dir.glob(File.join(File.dirname(__FILE__), 'active_record', '*.rb')).each {|f| require f }

data/lib/dspace/active_record/collection.rb

@@ -0,0 +1,23 @@
+class Collection < ActiveRecord::Base
+  set_table_name "collection"
+  has_and_belongs_to_many :items,
+    :class_name => "Item",
+    :join_table => "collection2item",
+    :association_foreign_key => "item_id",
+    :foreign_key => "collection_id"
+    
+  has_and_belongs_to_many :parent_community,
+    :class_name => "Community",
+    :join_table => "community2collection",
+    :association_foreign_key => "community_id",
+    :foreign_key => "collection_id"
+    
+  has_many :items,
+    :class_name => "Item",
+    :foreign_key => "owning_collection"
+    
+  has_one :handle,
+    :class_name => "Handle",
+    :foreign_key => "resource_id",
+    :conditions => "resource_type_id = 3"
+end

data/lib/dspace/active_record/community.rb

@@ -0,0 +1,33 @@
+class Community < ActiveRecord::Base
+  set_table_name "community"
+  has_and_belongs_to_many :items,
+    :class_name => "Item",
+    :join_table => "community2item",
+    :association_foreign_key => "item_id",
+    :foreign_key => "community_id"
+    
+  has_and_belongs_to_many :sub_communities,
+    :class_name => "Community",
+    :join_table => "community2community",
+    :association_foreign_key => "child_comm_id",
+    :foreign_key => "parent_comm_id"
+    
+  has_and_belongs_to_many :parent_community,
+    :class_name => "Community",
+    :join_table => "community2community",
+    :association_foreign_key => "parent_comm_id",
+    :foreign_key => "child_comm_id"
+
+  has_one :handle,
+    :class_name => "Handle",
+    :foreign_key => "resource_id",
+    :conditions => "resource_type_id = 4"
+    
+  def self.find_all_top_level
+    Community.find_by_sql("SELECT community.* FROM community WHERE community_id NOT IN (SELECT child_comm_id FROM community2community)")
+  end
+  
+  def self.find_all_sub_communities
+    Community.find_by_sql("SELECT community.* FROM community WHERE community_id IN (SELECT child_comm_id FROM community2community)")
+  end
+end

data/lib/dspace/active_record/handle.rb

@@ -0,0 +1,11 @@
+class Handle < ActiveRecord::Base
+  set_table_name "handle"
+  has_many :communities,
+    :class_name => "Community",
+    :foreign_key => "resource_id",
+    :conditions => "resource_type_id = 4"
+    
+  def to_s
+    self.handle
+  end
+end

data/lib/dspace/active_record/item.rb

@@ -0,0 +1,23 @@
+class Item < ActiveRecord::Base
+  set_table_name "item"
+
+  has_and_belongs_to_many :community,
+    :class_name => "Community",
+    :join_table => "communities2item",
+    :association_foreign_key => "community_id",
+    :foreign_key => "item_id"
+
+  has_and_belongs_to_many :communities,
+    :class_name => "Community",
+    :join_table => "communities2item",
+    :association_foreign_key => "community_id",
+    :foreign_key => "item_id" do
+      def top_level
+        find :first, :order => "id DESC"
+      end
+    end
+    
+  belongs_to :collection,
+    :class_name => "Collection",
+    :foreign_key => "owning_collection"
+end

data/lib/dspace/config.rb

@@ -0,0 +1,57 @@
+module Dspace
+  class Config
+    attr_accessor :opts
+    
+    def initialize
+      self.opts = {}
+    end
+
+    def [] (k)
+      opts[k]
+    end
+    
+    def []= (k, v)
+      opts[k] = v
+    end
+    
+    def length
+      opts.length
+    end
+    
+    # def find
+
+    def self.load(path)
+      if File.exist?(path)
+        Config.parse File.read(path)
+      else
+        raise "Configuration file does not exist.  #{path}"
+      end
+    end
+    
+    def self.parse(config)
+      retval = Config.new
+      
+      line_stack = []
+      config.each do |line|
+        line.sub!(/\#(.+?)$/, '') # ignore comments
+        
+        # join multi-line statements
+        if line.strip =~ /\\$/
+          line_stack.push line.sub(/\\/, '').strip
+          next
+        elsif line_stack.length != 0
+          line = (line_stack + [line]).join(' ')
+          line_stack = []
+        end
+
+        l = line.split('=').collect {|i| i.strip}
+        if l.length > 1
+          key = l.delete_at(0)
+          val = l.join(' = ').split(',').collect {|i| i.strip}
+          retval[key] = val.length == 1 ? val.first : val
+        end
+      end
+      retval
+    end
+  end
+end

data/lib/dspace_ruby.rb

@@ -0,0 +1 @@
+require File.join(File.dirname(__FILE__), 'dspace', 'config')

data/test/dspace_config_test.rb

@@ -0,0 +1,54 @@
+require 'test_helper'
+
+class DspaceConfigTest < Test::Unit::TestCase
+  should "set a single key and value from the config file" do
+    c = config_parse("foo = bar")
+    assert_equal c.length, 1
+    assert_equal c['foo'], 'bar'
+  end
+  
+  should "set multiple keys and values from the config file" do
+    c = config_parse("foo1 = bar1\nfoo2 = bar2")
+    assert_equal c.length, 2
+    assert_equal c['foo2'], 'bar2'
+  end
+  
+  should "ignore full comment lines" do
+    c = config_parse('# Comment Line')
+    assert_equal c.length, 0
+  end
+  
+  should "ignore partial-line comments" do
+    c = config_parse('foo = bar # partial line comment')
+    assert_equal c.length, 1
+    assert_equal c['foo'], 'bar'
+  end
+  
+  should "parse multi-line statements as value arrays" do
+    c = config_parse(%{foo = bar, \\\nbaz})
+    assert_equal c.length, 1
+    assert_equal c['foo'], ['bar', 'baz']
+  end
+  
+  should "parse multi-line statements beginning with a new line (instead of a value)" do
+    c = config_parse(%{foo = \\\nbar})
+    assert_equal c.length, 1
+    assert_equal c['foo'], 'bar'
+  end
+  
+  should "allow '=' characters in a value" do
+    c = config_parse('foo = bar = baz')
+    assert_equal c.length, 1
+    assert_equal c['foo'], 'bar = baz'
+  end
+  
+  should "allow '=' characters in multi-line values" do
+    c = config_parse(%{foo = \\\n\tbar = baz, \\\n\tbop = bip})
+    assert_equal c.length, 1
+    assert_equal c['foo'], ['bar = baz', 'bop = bip']
+  end
+  
+  def config_parse(c)
+    Dspace::Config.parse(c)
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,11 @@
+require 'rubygems'
+require 'test/unit'
+require 'shoulda'
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'dspace/config'
+require 'dspace/active_record'
+
+class Test::Unit::TestCase
+end

metadata

@@ -0,0 +1,67 @@
+--- !ruby/object:Gem::Specification 
+name: fixlr-dspace-ruby
+version: !ruby/object:Gem::Version 
+  version: 0.1.0
+platform: ruby
+authors: 
+- Nathan Fixler
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-04-29 00:00:00 -07:00
+default_executable: 
+dependencies: []
+
+description: 
+email: nathan@fixler.org
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.rdoc
+files: 
+- LICENSE
+- README.rdoc
+- Rakefile
+- VERSION.yml
+- lib/dspace/active_record.rb
+- lib/dspace/active_record/collection.rb
+- lib/dspace/active_record/community.rb
+- lib/dspace/active_record/handle.rb
+- lib/dspace/active_record/item.rb
+- lib/dspace/config.rb
+- lib/dspace_ruby.rb
+- test/dspace_config_test.rb
+- test/test_helper.rb
+has_rdoc: true
+homepage: http://github.com/fixlr/dspace-ruby
+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.2.0
+signing_key: 
+specification_version: 3
+summary: Collection of tools for working with a DSpace repository in Ruby.
+test_files: 
+- test/dspace_config_test.rb
+- test/test_helper.rb