pbcore 0.3.0 → 0.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1b73a92c3b5ee2c05b18c519077beb2952ac546595eb6f12304c0e276f7af48b
-  data.tar.gz: 7648662adcfbfd4b2e6f82e896fa49d51898353e670106264eb02e43a6a19769
+  metadata.gz: 1d5d477ef608efd8f417e4c31d6619485aa287e3a208a0cebfbe13a4e1e30b39
+  data.tar.gz: fc5dd5b45fd58f6207f133b65e1e413c076dc29f2a4c099f6bf7553e315344fa
 SHA512:
-  metadata.gz: e5f41721756eef3d067c33725f115f7552d0ddc4ded015946afc3609eeda97228931c26c8a03892bd2fbddf54a2931dbbcc46e108a8947186ce631c38f24c35d
-  data.tar.gz: 1c0831980ab0de12d8528ef43fef87c5718ddc291fcb75e68e472fd98a808a8b9c3571f7ef6a501dc85819f5ae5cc702c254e1ab564543aa774f86a4a17fcb45
+  metadata.gz: 3bfb1b44e3a55d15969e14ebbfa20ccc5a4fb281ed7993b70610c84ca063a937659f515a294f5b920e071826087e117ba499e8a4c7c45163df3fc11fb24ba486
+  data.tar.gz: a4b577fb1e5b6a023fa515844980f960a1414aec25af4d8898b74e422fe14261071d41cfe3be701d861d47832efbe57b1174d77fed325e56ce2d9b2c06ed8bbf

data/lib/pbcore/version.rb

@@ -1,3 +1,3 @@
 module PBCore
-  VERSION = "0.3.0"
+  VERSION = "0.3.1"
 end

data/pbcore.gemspec

@@ -17,10 +17,18 @@ Gem::Specification.new do |spec|
   spec.license       = "MIT"
 
   # Specify which files should be added to the gem when it is released.
-  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  # Excludes: Tests
+  # Includes:
+  #   * All other files committed to git (using `git ls-files -z`).
+  #   * Factories and their dependencies.
   spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
-    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+    `git ls-files -z`.split("\x0").reject do |f|
+      keep = [ 'spec/support/date_time_helpers' ]
+      keep += Dir.glob('spec/factories/**/*')
+      f.match(%r{^(spec)/}) unless keep.any?(f)
+    end
   end
+
   spec.bindir        = "exe"
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]

data/spec/factories/annotation.rb

@@ -0,0 +1,9 @@
+require 'pbcore'
+require 'faker'
+
+FactoryBot.define do
+  factory :pbcore_annotation, class: PBCore::Annotation, parent: :pbcore_content_element do
+    value { Faker::Quote.famous_last_words }
+    type { Faker::Lorem.word }
+  end
+end

data/spec/factories/asset_date.rb

@@ -0,0 +1,23 @@
+require 'pbcore'
+
+FactoryBot.define do
+  factory :pbcore_asset_date, class: PBCore::AssetDate, parent: :pbcore_content_element do
+    value { DateTimeHelpers.rand_date_time }
+    type { Faker::Lorem.word }
+
+    transient do
+      # `format` should be a valid format string accepted by DateTime#strftime.
+      # Pass a nil or false to skip converting the value from a DateTime object
+      # to ta string.
+      format { nil }
+    end
+
+    after :build do |pbcore_asset_date, evaluator|
+      # If a format is specified, use DateTime to parse the given date and
+      # re-format it.
+      if evaluator.format
+        pbcore_asset_date.value = DateTime.parse(pbcore_asset_date.value).strftime(evaluator.format)
+      end
+    end
+  end
+end

data/spec/factories/asset_type.rb

@@ -0,0 +1,7 @@
+require 'pbcore'
+
+FactoryBot.define do
+  factory :pbcore_asset_type, class: PBCore::AssetType, parent: :pbcore_content_element do
+    value { PBCore::Vocab.asset_types.sample }
+  end
+end

data/spec/factories/audience_level.rb

@@ -0,0 +1,7 @@
+require 'pbcore'
+
+FactoryBot.define do
+  factory :pbcore_audience_level, class: PBCore::AudienceLevel, parent: :pbcore_content_element do
+    value { ['G', 'PG', 'R', 'PG-13', 'NC-17'].sample }
+  end
+end

data/spec/factories/audience_rating.rb

@@ -0,0 +1,7 @@
+require 'pbcore'
+
+FactoryBot.define do
+  factory :pbcore_audience_rating, class: PBCore::AudienceRating, parent: :pbcore_content_element do
+    value { ['General', 'Empty-nester', 'K-7', 'Pre-teen'].sample }
+  end
+end

data/spec/factories/contributor.rb

@@ -0,0 +1,9 @@
+require 'pbcore'
+require 'faker'
+
+FactoryBot.define do
+  factory :pbcore_contributor, class: PBCore::Contributor, parent: :pbcore_element do
+    contributor { build(:pbcore_contributor_contributor) }
+    role { build(:pbcore_contributor_role )  }
+  end
+end

data/spec/factories/contributor/contributor.rb

@@ -0,0 +1,6 @@
+FactoryBot.define do
+  factory :pbcore_contributor_contributor, class: PBCore::Contributor::Contributor, parent: :pbcore_content_element do
+    affiliation { Faker::Company.name }
+    value { Faker::FunnyName.two_word_name }
+  end
+end

data/spec/factories/contributor/role.rb

@@ -0,0 +1,6 @@
+FactoryBot.define do
+  factory :pbcore_contributor_role, class: PBCore::Contributor::Role, parent: :pbcore_content_element do
+    value { Faker::Job.title }
+    portrayal { Faker::Movies::StarWars.character }
+  end
+end

data/spec/factories/coverage.rb

@@ -0,0 +1,22 @@
+require 'pbcore'
+
+FactoryBot.define do
+  factory :pbcore_coverage, class: PBCore::Coverage, parent: :pbcore_element do
+
+
+    coverage  { build(:pbcore_coverage_coverage) }
+    type      { build(:pbcore_coverage_type) }
+
+    trait :spatial do
+      coverage { build :pbcore_coverage_coverage, :spatial }
+      type { build :pbcore_coverage_type, :spatial }
+    end
+
+    trait :temporal do
+      coverage { build :pbcore_coverage_coverage, :temporal }
+      type { build :pbcre_coverage_type, :temporal }
+    end
+
+    
+  end
+end

data/spec/factories/coverage/coverage.rb

@@ -0,0 +1,22 @@
+require 'pbcore'
+
+FactoryBot.define do
+  factory :pbcore_coverage_coverage, class: PBCore::Coverage::Coverage, parent: :pbcore_content_element do
+
+    # TODO: Use controlled vocabularies listed here:
+    # http://pbcore.org/elements/coverage
+    value { Faker::Lorem.words.join(' ') }
+
+    trait :spatial do
+      source { "latitude, longitude" }
+      value  { "#{Faker::Address.latitude}, #{Faker::Address.longitude}" }
+    end
+
+    trait :temporal do
+      source { nil }
+      value { rand(1950..2018) }
+    end
+
+    
+  end
+end

data/spec/factories/coverage/type.rb

@@ -0,0 +1,8 @@
+require 'pbcore'
+
+FactoryBot.define do
+  factory :pbcore_coverage_type, class: PBCore::Coverage::Type, parent: :pbcore_element do
+    # TODO: Replace with rando term from controlled vocab once we get it.
+    value { ["Spatial", "Temporal"].sample }
+  end
+end

data/spec/factories/creator.rb

@@ -0,0 +1,8 @@
+FactoryBot.define do
+  factory :pbcore_creator, class: PBCore::Creator, parent: :pbcore_element do
+    
+    creator { build(:pbcore_creator_creator) }
+    role { build(:pbcore_creator_role) }
+    
+  end
+end

data/spec/factories/creator/creator.rb

@@ -0,0 +1,12 @@
+FactoryBot.define do
+  factory :pbcore_creator_creator, class: PBCore::Creator::Creator, parent: :pbcore_content_element do
+    
+    affiliation { Faker::Lorem.words.join(' ') }
+    affiliation_ref { Faker::Internet.url }
+    affiliation_source { Faker::Internet.url }
+    affiliation_version { FakeVersionHelper.fake_version }
+    affiliation_annotation { Faker::Company.bs }
+    value { Faker::Movies::Lebowski.character }
+    
+  end
+end

data/spec/factories/creator/role.rb

@@ -0,0 +1,8 @@
+FactoryBot.define do
+  factory :pbcore_creator_role, class: PBCore::Creator::Role, parent: :pbcore_content_element do
+    
+
+    value { Faker::Job.title }
+    
+  end
+end

data/spec/factories/description.rb

@@ -0,0 +1,11 @@
+require 'pbcore'
+
+FactoryBot.define do
+  factory :pbcore_description, class: PBCore::Description, parent: :pbcore_content_element do
+    
+    value { Faker::Lorem.paragraph }
+    type { Faker::Hacker.adjective }
+    type_ref { Faker::Internet.url }
+    
+  end
+end

data/spec/factories/description_document.rb

@@ -0,0 +1,28 @@
+require 'pbcore'
+
+FactoryBot.define do
+  factory :pbcore_description_document, class: PBCore::DescriptionDocument, parent: :pbcore_element do
+    
+
+    identifiers       { build_list(:pbcore_identifier, rand(1..3)) }
+    titles            { build_list(:pbcore_title, rand(1..3)) }
+    descriptions      { build_list(:pbcore_description, rand(1..3)) }
+    asset_dates       { build_list(:pbcore_asset_date, rand(1..3)) }
+    asset_types       { build_list(:pbcore_asset_type, rand(1..3)) }
+    subjects          { build_list(:pbcore_subject, rand(1..3)) }
+    genres            { build_list(:pbcore_genre, rand(1..3)) }
+    relations         { build_list(:pbcore_relation, rand(1..3)) }
+    coverages         { build_list(:pbcore_coverage, rand(1..3)) }
+    audience_levels   { build_list(:pbcore_audience_level, rand(1..3)) }
+    audience_ratings  { build_list(:pbcore_audience_rating, rand(1..3)) }
+    contributors      { build_list(:pbcore_contributor, rand(1..3)) }
+    creators          { build_list(:pbcore_creator, rand(1..3)) }
+    publishers        { build_list(:pbcore_publisher, rand(1..3)) }
+    rights_summaries  { build_list(:pbcore_rights_summary, rand(1..3)) }
+    annotations       { build_list(:pbcore_annotation, rand(1..3)) }
+    extensions        { build_list(:pbcore_extension, rand(1..3)) }
+    instantiations    { build_list(:pbcore_instantiation, rand(1..3)) }
+
+    
+  end
+end

data/spec/factories/extension.rb

@@ -0,0 +1,11 @@
+require 'pbcore'
+
+FactoryBot.define do
+  factory :pbcore_extension, class: PBCore::Extension, parent: :pbcore_element do
+    # NOTE: <extensionWrap> and <extensionEmbedded> are mutually exclusive child
+    # elements of <pbcoreExtension>. However, in the factory we always choose
+    # <extensionWrap> by default because we can't produce round-trippable XML
+    # for <extensionEmbedded> because of how SAXMachine parsing works.
+    wrap { build(:pbcore_extension_wrap) }
+  end
+end

data/spec/factories/extension/embedded.rb

@@ -0,0 +1,7 @@
+require 'pbcore'
+
+FactoryBot.define do
+  factory :pbcore_extension_embedded, class: PBCore::Extension::Embedded, parent: :pbcore_content_element do
+    value { "<foo />" }
+  end
+end

data/spec/factories/extension/wrap.rb

@@ -0,0 +1,11 @@
+require 'pbcore'
+
+FactoryBot.define do
+  factory :pbcore_extension_wrap, class: PBCore::Extension::Wrap, parent: :pbcore_element do
+    
+    extension_element   { build(:pbcore_extension_wrap_element) }
+    extension_value     { build(:pbcore_extension_wrap_value) }
+    authority_used      { build(:pbcore_extension_wrap_authority_used) }
+    
+  end
+end

data/spec/factories/extension/wrap/authority_used.rb

@@ -0,0 +1,7 @@
+require 'pbcore'
+
+FactoryBot.define do
+  factory :pbcore_extension_wrap_authority_used, class: PBCore::Extension::Wrap::AuthorityUsed, parent: :pbcore_element do
+    value { Faker::Job.title }
+  end
+end

data/spec/factories/extension/wrap/element.rb

@@ -0,0 +1,7 @@
+require 'pbcore'
+
+FactoryBot.define do
+  factory :pbcore_extension_wrap_element, class: PBCore::Extension::Wrap::Element, parent: :pbcore_element do
+    value { Faker::Job.title }
+  end
+end

data/spec/factories/extension/wrap/value.rb

@@ -0,0 +1,7 @@
+require 'pbcore'
+
+FactoryBot.define do
+  factory :pbcore_extension_wrap_value, class: PBCore::Extension::Wrap::Value, parent: :pbcore_element do
+    value { Faker::Job.title }
+  end
+end

data/spec/factories/genre.rb

@@ -0,0 +1,8 @@
+require 'pbcore'
+
+FactoryBot.define do
+  factory :pbcore_genre, class: PBCore::Genre, parent: :pbcore_content_element do
+    
+    value { Faker::Book.genre }
+  end
+end

data/spec/factories/identifier.rb

@@ -0,0 +1,10 @@
+require 'pbcore'
+require 'securerandom'
+
+FactoryBot.define do
+  factory :pbcore_identifier, class: PBCore::Identifier, parent: :pbcore_content_element do
+    
+    value { SecureRandom.uuid }
+    
+  end
+end

data/spec/factories/instantiation.rb

@@ -0,0 +1,34 @@
+require 'pbcore'
+
+FactoryBot.define do
+  factory :pbcore_instantiation, class: PBCore::Instantiation, parent: :pbcore_element do
+    identifiers             { build_list(:pbcore_instantiation_identifier, rand(1..3)) }
+    dates                   { build_list(:pbcore_instantiation_date, rand(1..3)) }
+    dimensions              { build_list(:pbcore_instantiation_dimensions, rand(1..3)) }
+    digital                 { build(:pbcore_instantiation_digital) }
+    physical                { build(:pbcore_instantiation_physical) }
+    standard                { build(:pbcore_instantiation_standard) }
+    location                { build(:pbcore_instantiation_location) }
+    media_type              { build(:pbcore_instantiation_media_type) }
+    generations             { build_list(:pbcore_instantiation_generations, rand(1..3)) }
+    time_start              { build(:pbcore_instantiation_time_start) }
+    duration                { build(:pbcore_instantiation_duration) }
+    colors                  { build(:pbcore_instantiation_colors) }
+    rights                  { build_list(:pbcore_instantiation_rights, rand(1..3)) }
+    tracks                  { build(:pbcore_instantiation_tracks) }
+    channel_configuration   { build(:pbcore_instantiation_channel_configuration) }
+    alternative_modes       { build(:pbcore_instantiation_alternative_modes) }
+    annotations             { build_list(:pbcore_instantiation_annotation, rand(1..3)) }
+    essence_tracks          { build_list(:pbcore_instantiation_essence_track, rand(1..3)) }
+    extensions              { build_list(:pbcore_instantiation_extension, rand(1..3)) }
+    languages               { build_list(:pbcore_instantiation_language, rand(1..3)) }
+    relations               { build_list(:pbcore_instantiation_relation, rand(1..3)) }
+    file_size               { build(:pbcore_instantiation_file_size) }
+    data_rate               { build(:pbcore_instantiation_data_rate) }
+
+    # time attributes
+    start_time { DateTimeHelpers.rand_date_time }
+    end_time { DateTimeHelpers.rand_date_time after: start_time }
+    time_annotation { Faker::Movies::StarWars.quote }
+  end
+end

data/spec/factories/instantiation/alternative_modes.rb

@@ -0,0 +1,11 @@
+require 'pbcore'
+
+FactoryBot.define do
+  factory :pbcore_instantiation_alternative_modes, class: PBCore::Instantiation::AlternativeModes, parent: :pbcore_content_element do
+    
+
+    value { Faker::Lorem.words.first }
+
+    
+  end
+end

data/spec/factories/instantiation/annotation.rb

@@ -0,0 +1,12 @@
+require 'pbcore'
+
+FactoryBot.define do
+  factory :pbcore_instantiation_annotation, class: PBCore::Instantiation::Annotation, parent: :pbcore_content_element do
+    
+
+    value { Faker::Movies::Ghostbusters.quote }
+    type  { Faker::Hacker.noun }
+
+    
+  end
+end

data/spec/factories/instantiation/channel_configuration.rb

@@ -0,0 +1,11 @@
+require 'pbcore'
+
+FactoryBot.define do
+  factory :pbcore_instantiation_channel_configuration, class: PBCore::Instantiation::ChannelConfiguration, parent: :pbcore_content_element do
+    
+
+    value { Faker::Music.genre }
+
+    
+  end
+end

data/spec/factories/instantiation/colors.rb

@@ -0,0 +1,11 @@
+require 'pbcore'
+
+FactoryBot.define do
+  factory :pbcore_instantiation_colors, class: PBCore::Instantiation::Colors, parent: :pbcore_content_element do
+    
+
+    value { Faker::Color.color_name }
+
+    
+  end
+end

data/spec/factories/instantiation/data_rate.rb

@@ -0,0 +1,12 @@
+require 'pbcore'
+
+FactoryBot.define do
+  factory :pbcore_instantiation_data_rate, class: PBCore::Instantiation::DataRate, parent: :pbcore_content_element do
+    
+
+    value { rand(100).to_s }
+    units_of_measure { %w(Kbps Mbps).sample }
+
+    
+  end
+end