uwdc 0.0.1 → 0.0.2

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    MzZmZTU4NjE2MmIyNDdlYTdiYzI4NjlhNTc0NDNiYTAxYzYyZWZjMw==
+    MmJlMGM4Nzk5ZWJjMGFlZGQ1OGM5MmVmOTA3NmViZmIyYjBiOGZhNg==
   data.tar.gz: !binary |-
-    ZGQyOTczOTcxZjlmZTIwNjhkZWFmMDc3YzEzMjE1MjExMmI5ZWI0OA==
+    OGI3Y2E1ZWM0ZTYyMWYzNDVjOTUyNWVmNTFlOTliYTM2OWVjNzY2MA==
 !binary "U0hBNTEy":
   metadata.gz: !binary |-
-    ODFkNzNlNjVmNThiMDNkNGM1OGMyZGEwMGY1YzM1NWY0NDg2ZDcyODRmNzBj
-    NDg4N2I1Zjg5MjA1NjU3OTc4ZWY1MjZkZDc2MjIzYjcyYmQ0ZjgxN2RjMWFl
-    NzAyNzFkYWVhNjFkOWZjMmRmZWUyNjUwNGE5YjNkNTA2YTRkMTM=
+    MjNiODBlYjQ2ZTczZGRlODViZTE3NzQ2NTU1NTAzYWYxMTZmNTY5NjcxNDA2
+    NzI2ODAyNjYwNGE2ODZiYTBlNmM3MWZhNGFjNGM4MTQyMWJhZDU2ZGQ3ZTMx
+    ZTI3N2Q0ZjU3ZDY2OGRiOTg2MjJiMDQwYmZjYzZlMDhjMzA4YjM=
   data.tar.gz: !binary |-
-    ODc5NTM2YzE1OTRmODgzYjJjOTU5MzQ1YmZiOWE5ZDk1Y2Y2YWE4M2UxNGVh
-    NWY3MzllYzA3N2QzNzVhZTExOGJiNzRhMWEzMzM4MjgwYzBkMTliZjhhNTVl
-    ZDMxNmRlYjM2YTcwNWJjNGExNWQ2ZDg5ZDEzNzUzYTcyZTYwMTM=
+    NDRlZTViMDZjYjNkZGM2YjAzMDFmNDRkMGZlZDI0MDg5NjI4NzY4NTY0OWYx
+    MWZiY2QyY2Q1OWIwOTI0M2YxY2YwM2U4ZWFmNzc3YWQxZDM0NWJhMmRiYTUz
+    MTY2ZWNlZDNiMTBlNDU0MzZlYWIzZGNiNTg5MDEwZWJhMjRkYWY=

data/README.md

@@ -1,6 +1,7 @@
 UWDC
 ====
 
+[![Gem Version](https://badge.fury.io/rb/uwdc.png)](http://badge.fury.io/rb/uwdc)
 [![Build Status](https://travis-ci.org/ewlarson/uwdc.png)](https://travis-ci.org/ewlarson/uwdc)
 [![Dependency Status](https://gemnasium.com/ewlarson/uwdc.png)](https://gemnasium.com/ewlarson/uwdc)
 [![Code Climate](https://codeclimate.com/github/ewlarson/uwdc.png)](https://codeclimate.com/github/ewlarson/uwdc)
@@ -9,6 +10,10 @@ UWDC
 
 Gem for accessing University of Wisconsin Digital Collection items from our Fedora Commons repository.
 
+## Install
+
+gem install uwdc
+
 ## Usage
 
 ### METS
@@ -16,9 +21,13 @@ Obtain the METS metadata for a UWDC object.
 
 ```ruby
 require 'uwdc'
-mets = UWDC::Mets.new('33QOBSVPJLWEM8S') # Ignoring 
+mets = UWDC::Mets.new('33QOBSVPJLWEM8S')
 mets.mods
 mets.mods.titles
+# => ["A life idyl"]
+
+mets.mods.metadata
+# => {:titles=>["A life idyl"], :names=>[], :dates=>["1869"], :forms=>["text"], ...}
 ```
 
 UWDC METS will contain:
@@ -90,9 +99,9 @@ MODS top-level elements are boiled in Ruby to something more dot-syntax friendly
   </tbody>
 </table>
 
+Transform via to_* calls. Supports JSON, Ruby and XML
+
 ```ruby
-# Transform via to_* calls
-# - supports JSON, Ruby and XML
 mods.to_json
 mods.to_ruby
 mods.to_xml

data/lib/uwdc.rb

@@ -4,6 +4,7 @@ require 'httpclient'
 require 'nokogiri'
 require 'json'
 require 'active_support/core_ext/hash'
+require 'ostruct'
 
 # UWDC
 module UWDC

data/lib/uwdc/display.rb

@@ -1,5 +1,10 @@
 module UWDC
-  # Return an object to drive the display of UWDC items
+  # Public: Return an object to drive the display of UWDC items
+  #
+  # Example
+  #
+  # @display = UWDC::Display.new('33QOBSVPJLWEM8S')
+  # # => object
   class Display
     
     attr_accessor :mets, :title, :visual_representation
@@ -8,7 +13,7 @@ module UWDC
       @mets = UWDC::Mets.new(id,xml)
     end
     
-    def use
+    def self.use
       {
         "title"                 => { :view => false,  :partial => "text" },
         "visualrepresentation"  => { :view => false,  :partial => "text" },
@@ -20,7 +25,7 @@ module UWDC
       }
     end
     
-    def cmodels
+    def self.cmodels
       {
         "info:fedora/1711.dl:CModelAudio"                   => { :view => true,   :partial => "audio" },
         "info:fedora/1711.dl:CModelAudioStream"             => { :view => true,   :partial => "audio" },
@@ -44,7 +49,7 @@ module UWDC
     end
     
     def image_files(model)
-      files.select{|file| file.id.include?(model) && use[file.use][:partial] == "image"}
+      files.select{|file| file.id.include?(model) && UWDC::Display.use[file.use][:partial] == "image"}
     end
     
     def images
@@ -64,6 +69,20 @@ module UWDC
       @mets.mods
     end
     
+    # @TODO: 
+    # Public: Partials is the intersection of the struct_map and the object cmodels
+    # Need to preserve the struct map's "div" structure
+    # But also tease out which objects are displayable via which partials
+    # 
+    # Return an array of Hashes (possibly nested) of ids keying to view partials
+    def partials
+      @mets.struct_map.structure
+    end
+    
+    def models
+      @mets.rels_ext.models
+    end
+
     alias :metadata :mods
     
     private
@@ -73,7 +92,7 @@ module UWDC
     end
     
     def viewable_model?(model)
-      model.last.detect{|name| cmodels[name][:view] == true}
+      model.last.detect{|name| UWDC::Display.cmodels[name][:view] == true}
     end
 
     def viewable_models

data/lib/uwdc/mods.rb

@@ -1,5 +1,3 @@
-require 'ostruct'
-
 module UWDC
   # Public: Obtain the MODS metadata for a UWDC METS object
   #
@@ -140,7 +138,7 @@ module UWDC
     # @mods.access_conditions.rights
     # # => "Delehanty, Jim"
     #
-    # Retuns an OpenStruct
+    # Returns an OpenStruct
     def access_conditions
       OpenStruct.new(rights: rights, reuse: reuse)
     end

data/lib/uwdc/version.rb

@@ -1,3 +1,3 @@
 module UWDC
-  VERSION = "0.0.1"
+  VERSION = "0.0.2"
 end

data/spec/models/display_spec.rb

@@ -2,6 +2,11 @@
 require File.expand_path(File.dirname(__FILE__) + '../../spec_helper')
 require 'uwdc'
 
+def clean_id(id)
+  clean = id.split("-")
+  "#{clean[0]}-#{clean[1]}"
+end
+
 describe UWDC::Display do
   
   context 'PBO' do
@@ -11,11 +16,11 @@ describe UWDC::Display do
     end
     
     it "should include use attributes" do
-      expect(@display.use).to be_true
+      expect(UWDC::Display.use).to be_true
     end
     
     it "should include content models" do
-      expect(@display.cmodels).to be_true
+      expect(UWDC::Display.cmodels).to be_true
     end
     
     it "should include files" do
@@ -31,6 +36,18 @@ describe UWDC::Display do
       expect(@display.metadata).to be_true
       expect(@display.metadata).to be_an_instance_of(UWDC::Mods)
     end
+    
+    it "should have partials" do
+      #puts @display.partials.inspect
+      expect(@display.partials).to be_true
+    end
+    
+    it "should have models" do
+      @display.partials.each do |div|
+        puts @display.models.select{|model| model.include?(clean_id(div.id))}
+      end
+      expect(@display.models).to be_true
+    end
   end
   
   context 'UNTAC' do

data/uwdc.gemspec

@@ -12,10 +12,10 @@ Gem::Specification.new do |gem|
   gem.summary       = %q{Use the UWDC collections}
   gem.homepage      = "https://github.com/ewlarson/uwdc"
   
-  gem.add_dependency 'httpclient'
-  gem.add_dependency 'nokogiri'
-  gem.add_dependency 'json'
-  gem.add_dependency 'active_support'
+  gem.add_dependency('httpclient', '~>2.3.3')
+  gem.add_dependency('nokogiri', '~>1.5.2')
+  gem.add_dependency('json', '~>1.8.0')
+  gem.add_dependency('active_support', '~>3.0.0')
 
   gem.add_development_dependency 'rake'
   gem.add_development_dependency 'rspec'

metadata

@@ -1,71 +1,71 @@
 --- !ruby/object:Gem::Specification
 name: uwdc
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Eric Larson
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-04-22 00:00:00.000000000 Z
+date: 2013-05-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httpclient
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 2.3.3
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 2.3.3
 - !ruby/object:Gem::Dependency
   name: nokogiri
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 1.5.2
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 1.5.2
 - !ruby/object:Gem::Dependency
   name: json
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 1.8.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 1.8.0
 - !ruby/object:Gem::Dependency
   name: active_support
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 3.0.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 3.0.0
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement