osullivan 0.0.2

data/spec/integration/iiif/service_spec.rb

@@ -0,0 +1,211 @@
+require 'active_support/inflector'
+require 'json'
+
+describe IIIF::Service do
+
+  let(:fixtures_dir) { File.join(File.dirname(__FILE__), '../../fixtures') }
+  let(:manifest_from_spec_path) { File.join(fixtures_dir, 'manifests/complete_from_spec.json') }
+
+  describe 'self.parse' do
+    it 'works from a file' do
+      s = described_class.parse(manifest_from_spec_path)
+      expect(s['label']).to eq 'Book 1'
+    end
+    it 'works from a string of JSON' do
+      file = File.open(manifest_from_spec_path, 'rb')
+      json_string = file.read
+      file.close
+      s = described_class.parse(json_string)
+      expect(s['label']).to eq 'Book 1'
+    end
+    describe 'works from a hash' do
+      it 'plain old' do
+        h = JSON.parse(IO.read(manifest_from_spec_path))
+        s = described_class.parse(h)
+        expect(s['label']).to eq 'Book 1'
+      end
+      it 'ActiveSupport::OrderedHash' do
+        h = JSON.parse(IO.read(manifest_from_spec_path))
+        oh = ActiveSupport::OrderedHash[h]
+        s = described_class.parse(oh)
+        expect(s['label']).to eq 'Book 1'
+      end
+    end
+    it 'turns camels to snakes' do
+      s = described_class.parse(manifest_from_spec_path)
+      expect(s.keys.include?('see_also')).to be_truthy
+      expect(s.keys.include?('seeAlso')).to be_falsey
+    end
+  end
+
+  describe 'self#from_ordered_hash' do
+    let(:fixture) { JSON.parse('{
+        "@context": "http://iiif.io/api/presentation/2/context.json",
+        "@id": "http://example.com/manifest",
+        "@type": "sc:Manifest",
+        "label": "My Manifest",
+        "service": {
+          "@context": "http://iiif.io/api/image/2/context.json",
+          "@id":"http://www.example.org/images/book1-page1",
+          "profile":"http://iiif.io/api/image/2/profiles/level2.json"
+        },
+        "some_other_thing": {
+          "foo" : "bar"
+        },
+        "seeAlso": {
+          "@id": "http://www.example.org/library/catalog/book1.marc",
+          "format": "application/marc"
+        },
+        "sequences": [
+          {
+            "@id":"http://www.example.org/iiif/book1/sequence/normal",
+            "@type":"sc:Sequence",
+            "label":"Current Page Order",
+
+            "viewingDirection":"left-to-right",
+            "viewingHint":"paged",
+            "startCanvas": "http://www.example.org/iiif/book1/canvas/p2",
+
+            "canvases": [
+              {
+                "@id": "http://example.com/canvas",
+                "@type": "sc:Canvas",
+                "width": 10,
+                "height": 20,
+                "label": "My Canvas",
+                "otherContent": [
+                  {
+                    "@id": "http://example.com/content",
+                    "@type":"sc:AnnotationList",
+                    "motivation": "sc:painting"
+                  }
+                ]
+              }
+            ]
+          }
+        ]
+      }')
+    }
+    it 'doesn\'t raise a NoMethodError when we check the keys' do
+      expect { described_class.from_ordered_hash(fixture) }.to_not raise_error
+    end
+    it 'turns the fixture into a Manifest instance' do
+      expected_klass = IIIF::Presentation::Manifest
+      parsed = described_class.from_ordered_hash(fixture)
+      expect(parsed.class).to be expected_klass
+    end
+    it 'turns keys without "@type" into an OrderedHash' do
+      expected_klass = ActiveSupport::OrderedHash
+      parsed = described_class.from_ordered_hash(fixture)
+      expect(parsed['some_other_thing'].class).to be expected_klass
+    end
+
+    it 'turns services into Services' do
+     expected_klass = IIIF::Service
+      parsed = described_class.from_ordered_hash(fixture)
+      expect(parsed['service'].class).to be expected_klass
+    end
+
+    it 'round-trips' do
+      fp = '/tmp/osullivan-spec.json'
+      parsed = described_class.from_ordered_hash(fixture)
+      File.open(fp,'w') do |f|
+        f.write(parsed.to_json)
+      end
+      from_file = IIIF::Service.parse('/tmp/osullivan-spec.json')
+      File.delete(fp)
+      # is this sufficient?
+      expect(parsed.to_ordered_hash.to_a - from_file.to_ordered_hash.to_a).to eq []
+      expect(from_file.to_ordered_hash.to_a - parsed.to_ordered_hash.to_a).to eq []
+    end
+    it 'turns each memeber of "sequences" into an instance of Sequence' do
+      expected_klass = IIIF::Presentation::Sequence
+      parsed = described_class.from_ordered_hash(fixture)
+      parsed['sequences'].each do |s|
+        expect(s.class).to be expected_klass
+      end
+    end
+    it 'turns each member of sequences/canvaes in an instance of Canvas' do
+      expected_klass = IIIF::Presentation::Canvas
+      parsed = described_class.from_ordered_hash(fixture)
+      parsed['sequences'].each do |s|
+        s.canvases.each do |c|
+          expect(c.class).to be expected_klass
+        end
+      end
+    end
+    it 'turns the keys into snakes' do
+      expect(described_class.from_ordered_hash(fixture).has_key?('seeAlso')).to be_falsey
+      expect(described_class.from_ordered_hash(fixture).has_key?('see_also')).to be_truthy
+    end
+    it 'copies over plain-old key-values' do
+      parsed = described_class.from_ordered_hash(fixture)
+      expect(parsed['label']).to eq 'My Manifest'
+    end
+
+  end
+
+  describe '#to_ordered_hash' do
+    let(:logo_uri) { 'http://www.example.org/logos/institution1.jpg' }
+    let(:within_uri) { 'http://www.example.org/collections/books/' }
+    let(:see_also) { 'http://www.example.org/library/catalog/book1.xml' }
+
+    describe 'it puts the json-ld keys at the top' do
+      let(:extra_props) { [ 
+        ['label','foo'], 
+        ['logo','http://example.com/logo.jpg'],
+        ['within','http://example.com/something']
+      ] }
+      let(:sorted_ld_keys) { 
+        subject.keys.select { |k| k.start_with?('@') }.sort!
+      }
+      before(:each) { 
+        extra_props.reverse.each do |k,v| 
+          subject.unshift(k,v) 
+        end
+      }
+
+      it 'by default' do
+        (0..extra_props.length-1).each do |i|
+          expect(subject.keys[i]).to eq(extra_props[i][0])
+        end
+        oh = subject.to_ordered_hash
+        (0..sorted_ld_keys.length-1).each do |i|
+          expect(oh.keys[i]).to eq(sorted_ld_keys[i])
+        end
+      end
+      it 'unless you say not to' do
+        (0..extra_props.length-1).each do |i|
+          expect(subject.keys[i]).to eq(extra_props[i][0])
+        end
+        oh = subject.to_ordered_hash(sort_json_ld_keys: false)
+        (0..extra_props.length-1).each do |i|
+          expect(oh.keys[i]).to eq(extra_props[i][0])
+        end
+      end
+    end
+
+    describe 'removes empty keys' do
+      it 'if they\'re arrays' do
+        subject['logo'] = logo_uri
+        subject['within'] = []
+        ordered_hash = subject.to_ordered_hash
+        expect(ordered_hash.has_key?('within')).to be_falsey
+      end
+      it 'if they\'re nil' do
+        subject['logo'] = logo_uri
+        subject['within'] = nil
+        ordered_hash = subject.to_ordered_hash
+        expect(ordered_hash.has_key?('within')).to be_falsey
+      end
+    end
+
+    it 'converts snake_case keys to camelCase' do
+      subject['see_also'] = logo_uri
+      subject['within'] = within_uri
+      ordered_hash = subject.to_ordered_hash
+      expect(ordered_hash.keys.include?('seeAlso')).to be_truthy
+    end
+  end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,104 @@
+require 'iiif/presentation'
+require 'coveralls'
+Dir["#{File.dirname(__FILE__)}/unit/iiif/presentation/shared_examples/*.rb"].each do |f|
+  require f
+end
+require 'vcr'
+
+VCR.configure do |c|
+  c.cassette_library_dir = 'spec/fixtures/vcr_cassettes'
+  c.hook_into :webmock
+  c.configure_rspec_metadata!
+end
+
+Coveralls.wear!
+
+# This file was generated by the `rspec --init` command. Conventionally, all
+# specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.
+# The generated `.rspec` file contains `--require spec_helper` which will cause this
+# file to always be loaded, without a need to explicitly require it in any files.
+#
+# Given that it is always loaded, you are encouraged to keep this file as
+# light-weight as possible. Requiring heavyweight dependencies from this file
+# will add to the boot time of your test suite on EVERY test run, even for an
+# individual file that may not need all of that loaded. Instead, consider making
+# a separate helper file that requires the additional dependencies and performs
+# the additional setup, and require it from the spec files that actually need it.
+#
+# The `.rspec` file also contains a few flags that are not defaults but that
+# users commonly want.
+#
+# See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
+RSpec.configure do |config|
+  # rspec-expectations config goes here. You can use an alternate
+  # assertion/expectation library such as wrong or the stdlib/minitest
+  # assertions if you prefer.
+  config.expect_with :rspec do |expectations|
+    # This option will default to `true` in RSpec 4. It makes the `description`
+    # and `failure_message` of custom matchers include text for helper methods
+    # defined using `chain`, e.g.:
+    # be_bigger_than(2).and_smaller_than(4).description
+    #   # => "be bigger than 2 and smaller than 4"
+    # ...rather than:
+    #   # => "be bigger than 2"
+    expectations.include_chain_clauses_in_custom_matcher_descriptions = true
+  end
+
+  # rspec-mocks config goes here. You can use an alternate test double
+  # library (such as bogus or mocha) by changing the `mock_with` option here.
+  config.mock_with :rspec do |mocks|
+    # Prevents you from mocking or stubbing a method that does not exist on
+    # a real object. This is generally recommended, and will default to
+    # `true` in RSpec 4.
+    mocks.verify_partial_doubles = true
+  end
+
+# The settings below are suggested to provide a good initial experience
+# with RSpec, but feel free to customize to your heart's content.
+=begin
+  # These two settings work together to allow you to limit a spec run
+  # to individual examples or groups you care about by tagging them with
+  # `:focus` metadata. When nothing is tagged with `:focus`, all examples
+  # get run.
+  config.filter_run :focus
+  config.run_all_when_everything_filtered = true
+
+  # Limits the available syntax to the non-monkey patched syntax that is recommended.
+  # For more details, see:
+  #   - http://myronmars.to/n/dev-blog/2012/06/rspecs-new-expectation-syntax
+  #   - http://teaisaweso.me/blog/2013/05/27/rspecs-new-message-expectation-syntax/
+  #   - http://myronmars.to/n/dev-blog/2014/05/notable-changes-in-rspec-3#new__config_option_to_disable_rspeccore_monkey_patching
+  config.disable_monkey_patching!
+
+  # This setting enables warnings. It's recommended, but in some cases may
+  # be too noisy due to issues in dependencies.
+  config.warnings = true
+
+  # Many RSpec users commonly either run the entire suite or an individual
+  # file, and it's useful to allow more verbose output when running an
+  # individual spec file.
+  if config.files_to_run.one?
+    # Use the documentation formatter for detailed output,
+    # unless a formatter has already been configured
+    # (e.g. via a command-line flag).
+    config.default_formatter = 'doc'
+  end
+
+  # Print the 10 slowest examples and example groups at the
+  # end of the spec run, to help surface which specs are running
+  # particularly slow.
+  config.profile_examples = 10
+
+  # Run specs in random order to surface order dependencies. If you find an
+  # order dependency and want to debug it, you can fix the order by providing
+  # the seed, which is printed after each run.
+  #     --seed 1234
+  config.order = :random
+
+  # Seed global randomization in this process using the `--seed` CLI option.
+  # Setting this allows you to use `--seed` to deterministically reproduce
+  # test failures related to randomization by passing the same `--seed` value
+  # as the one that triggered the failure.
+  Kernel.srand config.seed
+=end
+end

data/spec/unit/active_support/ordered_hash_spec.rb

@@ -0,0 +1,155 @@
+describe ActiveSupport::OrderedHash do
+
+  describe '#camelize_keys' do
+    before(:each) do
+      @uri = 'http://www.example.org/descriptions/book1.xml'
+      @within_uri = 'http://www.example.org/collections/books/'
+      subject['see_also'] = @uri
+      subject['within'] = @within_uri
+    end
+    it 'changes snake_case keys to camelCase' do
+      subject.camelize_keys # #send gets past protection
+      expect(subject.keys.include?('seeAlso')).to be_truthy
+      expect(subject.keys.include?('see_also')).to be_falsey
+    end
+    it 'keeps the right values' do
+      subject.camelize_keys
+      expect(subject['seeAlso']).to eq @uri
+      expect(subject['within']).to eq @within_uri
+    end
+    it 'keeps things in the same position' do
+      see_also_position = subject.keys.index('see_also')
+      within_position = subject.keys.index('within')
+      subject.camelize_keys
+      expect(subject.keys[see_also_position]).to eq 'seeAlso'
+      expect(subject.keys[within_position]).to eq 'within'
+    end
+
+  end
+
+  describe '#snakeize_keys' do
+    before(:each) do
+      @uri = 'http://www.example.org/descriptions/book1.xml'
+      @within_uri = 'http://www.example.org/collections/books/'
+      subject['seeAlso'] = @uri
+      subject['within'] = @within_uri
+    end
+    it 'changes camelCase keys to snake_case' do
+      subject.snakeize_keys
+      expect(subject.keys.include?('see_also')).to be_truthy
+      expect(subject.keys.include?('seeAlso')).to be_falsey
+    end
+    it 'keeps the right values' do
+      subject.snakeize_keys
+      expect(subject['see_also']).to eq @uri
+      expect(subject['within']).to eq @within_uri
+    end
+    it 'keeps things in the same position' do
+      see_also_position = subject.keys.index('seeAlso')
+      within_position = subject.keys.index('within')
+      subject.snakeize_keys
+      expect(subject.keys[see_also_position]).to eq 'see_also'
+      expect(subject.keys[within_position]).to eq 'within'
+    end
+  end
+
+  describe 'insertion patches' do
+
+    let (:init_data) { [ ['wubble', 'fred'], ['baz', 'qux'], ['grault','garply'] ] }
+    
+    subject do 
+      hsh = ActiveSupport::OrderedHash.new
+      init_data.each { |e| hsh[e[0]] = e[1] }
+      hsh
+    end
+
+    describe '#insert' do
+      it 'inserts as expected' do
+        subject.insert(2, 'quux', 'corge')
+        expect(subject[subject.keys[0]]).to eq 'fred'
+        expect(subject[subject.keys[1]]).to eq 'qux'
+        expect(subject[subject.keys[2]]).to eq 'corge'
+        expect(subject[subject.keys[3]]).to eq 'garply'
+      end
+      it 'returns the instance' do
+        expect(subject.insert(1, 'quux','corge')).to eq subject
+      end
+      it 'raises IndexError if a negative index is too small' do
+        expect { subject.insert(-5, 'quux','corge') }.to raise_error IndexError
+      end
+      it 'puts index -1 on the end' do
+        subject.insert(-1, 'thud','wibble')
+        expect(subject[subject.keys.last]).to eq 'wibble'
+      end
+    end
+
+    describe '#insert_before' do
+      it 'inserts in the expected place with a supplied key' do
+        subject.insert_before(existing_key: 'grault', new_key: 'quux', value: 'corge')
+        expect(subject.keys).to eq ['wubble','baz','quux','grault']
+      end
+      it 'inserts in the expected place with a supplied block' do
+        subject.insert_before(new_key: 'quux', value: 'corge') { |k,v| k.start_with?('g') }
+        expect(subject.keys).to eq ['wubble','baz','quux','grault']
+      end
+      it 'returns the instance' do
+        expect(subject.insert_before(existing_key: 'grault', new_key: 'quux', value: 'corge')).to be subject
+      end
+      describe 'raises KeyError' do
+        it 'when the supplied existing key is not found' do
+          expect { subject.insert_before(existing_key: 'foo', new_key: 'quux', value: 'corge') }.to raise_error KeyError
+        end
+        it 'when the supplied new key already exists' do
+          expect { subject.insert_before(existing_key: 'grault', new_key: 'wubble', value: 'corge') }.to raise_error KeyError
+        end
+      end
+    end
+
+    describe '#insert_after' do
+      it 'inserts in the expected place with a supplied key' do
+        subject.insert_after(existing_key: 'baz', new_key: 'quux', value: 'corge')
+        expect(subject.keys).to eq ['wubble','baz','quux','grault']
+      end
+      it 'inserts in the expected place with a supplied block' do
+        subject.insert_after(new_key: 'quux', value: 'corge') { |k,v| k.start_with?('g') }
+        expect(subject.keys).to eq ['wubble','baz','quux','grault']
+      end
+      it 'returns the instance' do
+        expect(subject.insert_after(existing_key: 'baz', new_key: 'quux', value: 'corge')).to be subject
+      end
+      describe 'raises KeyError' do
+        it 'when the supplied existing key is not found' do
+          expect { subject.insert_after(existing_key: 'foo', new_key: 'quux', value: 'corge') }.to raise_error KeyError
+        end
+        it 'when the supplied new key already exists' do
+          expect { subject.insert_after(existing_key: 'grault', new_key: 'wubble', value: 'corge') }.to raise_error KeyError
+        end
+      end
+    end
+
+    describe '#unshift' do
+      it 'adds an entry to the front of the object' do
+        subject.unshift('thud','wibble')
+        expect(subject[subject.keys[0]]).to eq 'wibble'
+      end
+      it 'returns the instance' do
+        expect(subject.unshift('thud','wibble')).to be subject
+      end
+    end
+
+    describe '#remove_empties' do
+      it 'if they\'re arrays' do
+        subject[:wubble] = []
+        subject.remove_empties
+        expect(subject.has_key?(:wubble)).to be_falsey
+      end
+      it 'if they\'re nil' do
+        subject[:wubble] = nil
+        subject.remove_empties
+        expect(subject.has_key?(:wubble)).to be_falsey
+      end
+    end
+
+  end
+end
+