ruby-fedora 0.1.0

data/History.txt

@@ -0,0 +1,4 @@
+== 0.0.1 2008-03-31
+
+* very alpha enhancement:
+  * Initial release

data/License.txt

@@ -0,0 +1,58 @@
+Copyright (c) 2008 Matt Zumwalt <matt.zumwalt@yourmediashelf.com>
+
+You can redistribute it and/or modify it under either the terms of the GPL 
+or the conditions below:
+
+  1. You may make and give away verbatim copies of the source form of the
+     software without restriction, provided that you duplicate all of the
+     original copyright notices and associated disclaimers.
+
+  2. You may modify your copy of the software in any way, provided that
+     you do at least ONE of the following:
+
+       a) place your modifications in the Public Domain or otherwise
+          make them Freely Available, such as by posting said
+	  modifications to Usenet or an equivalent medium, or by allowing
+	  the author to include your modifications in the software.
+
+       b) use the modified software only within your corporation or
+          organization.
+
+       c) rename any non-standard executables so the names do not conflict
+	  with standard executables, which must also be provided.
+
+       d) make other distribution arrangements with the author.
+
+  3. You may distribute the software in object code or executable
+     form, provided that you do at least ONE of the following:
+
+       a) distribute the executables and library files of the software,
+	  together with instructions (in the manual page or equivalent)
+	  on where to get the original distribution.
+
+       b) accompany the distribution with the machine-readable source of
+	  the software.
+
+       c) give non-standard executables non-standard names, with
+          instructions on where to get the original software distribution.
+
+       d) make other distribution arrangements with the author.
+
+  4. You may modify and include the part of the software into any other
+     software (possibly commercial).  But some files in the distribution
+     are not written by the author, so that they are not under this terms.
+
+     They are gc.c(partly), utils.c(partly), regex.[ch], st.[ch] and some
+     files under the ./missing directory.  See each file for the copying
+     condition.
+
+  5. The scripts and library files supplied as input to or produced as 
+     output from the software do not automatically fall under the
+     copyright of the software, but belong to whomever generated them, 
+     and may be sold commercially, and may be aggregated with this
+     software.
+
+  6. THIS SOFTWARE IS PROVIDED "AS IS" AND WITHOUT ANY EXPRESS OR
+     IMPLIED WARRANTIES, INCLUDING, WITHOUT LIMITATION, THE IMPLIED
+     WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
+     PURPOSE.

data/Manifest.txt

@@ -0,0 +1,34 @@
+History.txt
+License.txt
+Manifest.txt
+README.txt
+Rakefile
+config/hoe.rb
+config/requirements.rb
+lib/ruby-fedora.rb
+lib/fedora/base_object.rb
+lib/fedora/connection.rb
+lib/fedora/datastream.rb
+lib/fedora/fedora_object.rb
+lib/fedora/formats.rb
+lib/fedora/repository.rb
+lib/active-fedora.rb
+lib/active_fedora/base.rb
+lib/ambition/adapters/active_fedora.rb
+lib/ambition/adapters/active_fedora/base.rb
+lib/ambition/adapters/active_fedora/query.rb
+lib/ambition/adapters/active_fedora/select.rb
+lib/ambition/adapters/active_fedora/slice.rb
+lib/ambition/adapters/active_fedora/sort.rb
+script/destroy
+script/generate
+script/txt2html
+setup.rb
+tasks/deployment.rake
+tasks/environment.rake
+tasks/website.rake
+website/index.html
+website/index.txt
+website/javascripts/rounded_corners_lite.inc.js
+website/stylesheets/screen.css
+website/template.rhtml

data/README.txt

@@ -0,0 +1,19 @@
+This should describe how this stuff can be built, tested and used...
+
+== Installation
+
+Required gems:
+ - facets
+ - activeresource
+ 
+ - syntax
+ - ParseTree
+ - ambition
+
+== TODO
+
+ - specify gem dependencies in hoe.rb
+ - implement finders with Ambition
+ - implement ActiveFedora::Base.establish_connection to read from repository.yml (or fedora.yml)
+ - remove dependencies on activeresource gem
+ - remove anything in test/* that are no longer relevant

data/Rakefile

@@ -0,0 +1,5 @@
+require 'config/requirements'
+require 'config/hoe' # setup Hoe + all gem configuration
+
+Dir['tasks/**/*.rake'].each { |rake| load rake }
+

data/config/hoe.rb

@@ -0,0 +1,69 @@
+require 'ruby-fedora'
+
+AUTHOR = 'Matt Zumwalt'  # can also be an array of Authors
+EMAIL = 'matt.zumwalt@yourmediashelf.com>'
+DESCRIPTION = "Ruby API for Fedora"
+GEM_NAME = 'ruby-fedora' # what ppl will type to install your gem
+RUBYFORGE_PROJECT = 'rubyfedora' # The unix name for your project
+HOMEPATH = "http://#{RUBYFORGE_PROJECT}.rubyforge.org"
+DOWNLOAD_PATH = "http://rubyforge.org/projects/#{RUBYFORGE_PROJECT}"
+
+@config_file = "~/.rubyforge/user-config.yml"
+@config = nil
+RUBYFORGE_USERNAME = "unknown"
+def rubyforge_username
+  unless @config
+    begin
+      @config = YAML.load(File.read(File.expand_path(@config_file)))
+    rescue
+      puts <<-EOS
+ERROR: No rubyforge config file found: #{@config_file}
+Run 'rubyforge setup' to prepare your env for access to Rubyforge
+ - See http://newgem.rubyforge.org/rubyforge.html for more details
+      EOS
+      exit
+    end
+  end
+  RUBYFORGE_USERNAME.replace @config["username"]
+end
+
+
+REV = nil 
+# UNCOMMENT IF REQUIRED: 
+# REV = `svn info`.each {|line| if line =~ /^Revision:/ then k,v = line.split(': '); break v.chomp; else next; end} rescue nil
+VERS = RubyFedora::VERSION::STRING + (REV ? ".#{REV}" : "")
+RDOC_OPTS = ['--quiet', '--title', 'RubyFedora documentation',
+    "--opname", "index.html",
+    "--line-numbers", 
+    "--main", "README",
+    "--inline-source"]
+
+class Hoe
+  def extra_deps 
+    @extra_deps.reject! { |x| Array(x).first == 'hoe' } 
+    @extra_deps
+  end 
+end
+
+# Generate all the Rake tasks
+# Run 'rake -T' to see list of generated tasks (from gem root directory)
+hoe = Hoe.new(GEM_NAME, VERS) do |p|
+  p.developer(AUTHOR, EMAIL)
+  p.description = DESCRIPTION
+  p.summary = DESCRIPTION
+  p.url = HOMEPATH
+  p.rubyforge_name = RUBYFORGE_PROJECT if RUBYFORGE_PROJECT
+  p.test_globs = ["test/**/test_*.rb"]
+  p.clean_globs |= ['**/.*.sw?', '*.gem', '.config', '**/.DS_Store']  #An array of file patterns to delete on clean.
+  
+  # == Optional
+  p.changes = p.paragraphs_of("History.txt", 0..1).join("\n\n")
+  # An array of rubygem dependencies [name, version], e.g. [ ['active_support', '>= 1.3.1'] ]
+  p.extra_deps = [['activeresource'], ['facets']]
+  #p.spec_extras = {}    # A hash of extra values to set in the gemspec.  
+end
+
+CHANGES = hoe.paragraphs_of('History.txt', 0..1).join("\\n\\n")
+PATH    = (RUBYFORGE_PROJECT == GEM_NAME) ? RUBYFORGE_PROJECT : "#{RUBYFORGE_PROJECT}/#{GEM_NAME}"
+hoe.remote_rdoc_dir = File.join(PATH.gsub(/^#{RUBYFORGE_PROJECT}\/?/,''), 'rdoc')
+hoe.rsync_args = '-av --delete --ignore-errors'

data/config/requirements.rb

@@ -0,0 +1,17 @@
+require 'fileutils'
+include FileUtils
+
+require 'rubygems'
+%w[rake hoe newgem rubigen].each do |req_gem|
+  begin
+    require req_gem
+  rescue LoadError
+    puts "This Rakefile requires the '#{req_gem}' RubyGem."
+    puts "Installation: gem install #{req_gem} -y"
+    exit
+  end
+end
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), %w[.. lib]))
+
+require 'ruby-fedora'

data/lib/active-fedora.rb

@@ -0,0 +1 @@
+require 'active_fedora/base'

data/lib/active_fedora/base.rb

@@ -0,0 +1,22 @@
+module ActiveFedora
+  class Base
+    def self.establish_connection(spec)
+    end
+    
+    def initialize(attrs = nil)
+    end
+    
+    def self.find_objects(*args)
+      puts args.inspect
+    end
+    
+    def create
+    end
+    
+    def update
+    end
+    
+    def save
+    end
+  end
+end

data/lib/ambition/adapters/active_fedora.rb

@@ -0,0 +1,10 @@
+require 'ambition'
+require 'active-fedora'
+require 'ambition/adapters/active_fedora/base'
+require 'ambition/adapters/active_fedora/query'
+require 'ambition/adapters/active_fedora/select'
+require 'ambition/adapters/active_fedora/slice'
+require 'ambition/adapters/active_fedora/sort'
+
+ActiveFedora::Base.extend Ambition::API
+ActiveFedora::Base.ambition_adapter = Ambition::Adapters::ActiveFedora

data/lib/ambition/adapters/active_fedora/base.rb

@@ -0,0 +1,14 @@
+module Ambition
+  module Adapters
+    module ActiveFedora
+      class Base
+        def encode(value)
+          case value
+            when String then value.include?(' ') ? %Q('#{value}') : value
+            else value.to_s
+          end
+        end
+      end
+    end
+  end
+end

data/lib/ambition/adapters/active_fedora/query.rb

@@ -0,0 +1,48 @@
+=begin
+
+These methods are king:
+
+  - owner
+  - clauses
+  - stash
+
++owner+ is the class from which the request was generated.
+
+User.select { |u| u.name == 'Pork' }
+# => owner == User
+
++clauses+ is the hash of translated arrays, keyed by processors
+
+User.select { |u| u.name == 'Pork' }
+# => clauses ==  { :select => [ "users.name = 'Pork'" ] }
+
++stash+ is your personal private stash.  A hash you can use for
+keeping stuff around.
+
+User.select { |u| u.profile.name == 'Pork' }
+# => stash == { :include => [ :profile ] }
+
+The above is totally arbitrary.  It's basically a way for your
+translators to talk to each other and, more importantly, to the Query
+object.
+
+=end
+module Ambition
+  module Adapters
+    module ActiveFedora
+      class Query < Base
+        def kick
+          owner.find_objects(to_s)
+        end
+
+        def size
+          raise "Not Implemented"
+        end
+
+        def to_s
+          clauses[:select].to_s
+        end
+      end
+    end
+  end
+end

data/lib/ambition/adapters/active_fedora/select.rb

@@ -0,0 +1,104 @@
+##
+# The format of the documentation herein is:
+#
+# >> method with block
+# => methods on this class called by Ambition (with arguments)
+#
+module Ambition
+  module Adapters
+    module ActiveFedora
+      class Select < Base
+        # >> select { |u| u.name == 'chris' } 
+        # => #call(:name)
+        def call(method)
+          method
+        end
+
+        # >> select { |u| u.name.downcase == 'chris' } 
+        # => #call(:name, :downcase)
+        def chained_call(*methods)
+          # An idiom here is to call the chained method and pass it
+          # the first method.
+          #
+          #   if respond_to? methods[1]
+          #     send(methods[1], methods[0])
+          #   end
+          #
+          # In the above example, this translates to calling:
+          #
+          #   #downcase(:name)
+          #
+          if respond_to? methods[1]
+            send(methods[1], methods[0])
+          else
+            raise "I don't understand: #{methods.inspect}"
+          end
+        end
+
+        # &&
+        # >> select { |u| u.name == 'chris' && u.age == 22 }
+        # => #both( processed left side, processed right side )
+        def both(left, right)
+          "#{left} #{right}"
+        end
+
+        # ||
+        # >> select { |u| u.name == 'chris' || u.age == 22 }
+        # => #either( processed left side, processed right side )
+        def either(left, right)
+          raise "Not implemented."
+        end
+
+        # >> select { |u| u.name == 'chris' }
+        # => #==( call(:name), 'chris' )
+        def ==(left, right)
+          "#{left}=#{encode(right)}"
+        end
+
+        # !=
+        # >> select { |u| u.name != 'chris' }
+        # => #not_equal( call(:name), 'chris' )
+        def not_equal(left, right)
+          "#{left}!=#{encode(right)}"
+        end
+
+        # >> select { |u| u.name =~ 'chris' }
+        # => #=~( call(:name), 'chris' )
+        def =~(left, right)
+          "#{left}~#{encode(right)}"
+        end
+
+        # !~
+        # >> select { |u| u.name !~ 'chris' }
+        # => #not_regexp( call(:name), 'chris' )
+        def not_regexp(left, right)
+          raise "Not implemented."
+        end
+
+        ##
+        # Etc.
+        def <(left, right)
+          "#{left}<#{encode(right)}"
+        end
+
+        def >(left, right)
+          "#{left}>#{encode(right)}"
+        end
+
+        def >=(left, right)
+          "#{left}>=#{encode(right)}"
+        end
+
+        def <=(left, right)
+          "#{left}<=#{encode(right)}"
+        end
+
+        # >> select { |u| [1, 2, 3].include? u.id }
+        # => #include?( [1, 2, 3], call(:id) )
+        def include?(left, right)
+          raise "Not implemented."
+        end
+      end
+    end
+  end
+end

data/lib/ambition/adapters/active_fedora/slice.rb

@@ -0,0 +1,19 @@
+module Ambition
+  module Adapters
+    module ActiveFedora
+      class Slice < Base
+        # >> User.first(5)
+        # => #slice(0, 5)
+        #
+        # >> User.first
+        # => #slice(0, 1)
+        #
+        # >> User[10, 20]
+        # => #slice(10, 20)
+        def slice(start, length)
+          raise "Not implemented."
+        end
+      end
+    end
+  end
+end