wikibase_representable 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: e29e8b05d572635fd5ef8182cd5528f79cbd31e0526ab8add032ed1a8d06980a
+  data.tar.gz: a9ef980b43682ebf929e17d66890af6262d0598903b6db8cadefcfe31b7b30ca
+SHA512:
+  metadata.gz: 4e357579f5a6a17f7d3a707faa4704e3939009205157d22d445fc7ec5624db33cfabf27cd17e404e18cd5e9f71707b771cb0a8f1014a33f5ed3823cfca3e8d47
+  data.tar.gz: 69001ea25cea8f373d3ddfb503ee6a2f3b56404ea58b7064cb3b8d1775c9a3f4b2861cb6261d9a91fe748cb691e8c3919c9eb56038fb5e81bbe605f1dfe81cd9

data/.rubocop.yml

@@ -0,0 +1,18 @@
+require:
+  - rubocop-rake
+  - rubocop-rspec
+
+AllCops:
+  NewCops: enable
+Gemspec/DevelopmentDependencies:
+  EnforcedStyle: gemspec
+Metrics/AbcSize:
+  Enabled: false
+Metrics/CyclomaticComplexity:
+  Enabled: false
+Metrics/ParameterLists:
+  Enabled: false
+RSpec/MultipleMemoizedHelpers:
+  Enabled: false
+Style/SafeNavigationChainLength:
+  Enabled: false

data/README.md

@@ -0,0 +1,25 @@
+# wikibase_representable
+
+Provides Wikibase data model classes and support (by way of [representable](https://rubygems.org/gems/representable)) for serializing and deserializing Wikibase data objects to and from JSON.
+
+## Install
+```sh
+bundle install
+```
+
+## Example usage
+```ruby
+# Deserialize an object from JSON
+json = '{"type":"item","id":"Q42","labels":{"en":{"language":"en","value":"Douglas Adams"}}}'
+item = ItemRepresenter.new(Item.new).from_json(json)
+# => #<WikibaseRepresentable::Model::Item:0x0000000...
+
+# Serialize an object to JSON
+json = ItemRepresenter.new(item).to_json
+# => "{\"type\":\"item\",\"id\":\"Q42\"...
+```
+
+## Test (run RSpec and RuboCop)
+```sh
+bundle exec rake
+```

data/Rakefile

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+require 'rake'
+require 'rspec/core/rake_task'
+require 'rubocop/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+RuboCop::RakeTask.new(:rubocop)
+
+task default: %i[spec rubocop]

data/lib/wikibase_representable/model/alias_group_list.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module WikibaseRepresentable
+  module Model
+    # Wraps a hash of Term arrays keyed by language code.
+    class AliasGroupList < Hash
+      def aliases_for_language(language_code)
+        fetch(language_code, nil)
+      end
+
+      def aliases_for_language?(language_code)
+        key?(language_code)
+      end
+    end
+  end
+end

data/lib/wikibase_representable/model/data_value.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+module WikibaseRepresentable
+  module Model
+    # Object that represents a single data value.
+    class DataValue
+      attr_accessor :type, :value
+
+      def initialize(type: nil, value: nil)
+        @type = type
+        @value = value
+      end
+
+      def ==(other)
+        other.is_a?(self.class) &&
+          other.type == type &&
+          other.value == value
+      end
+
+      def eql?(other)
+        self == other
+      end
+    end
+  end
+end

data/lib/wikibase_representable/model/entity_id.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+module WikibaseRepresentable
+  module Model
+    # Data value representing an entity ID data value
+    class EntityId
+      attr_accessor :id, :numeric_id, :entity_type
+
+      def initialize(id: nil, numeric_id: nil, entity_type: nil)
+        @id = id
+        @numeric_id = numeric_id
+        @entity_type = entity_type
+      end
+
+      def ==(other)
+        other.is_a?(self.class) &&
+          id == other.id &&
+          entity_type == other.entity_type &&
+          numeric_id == other.numeric_id
+      end
+
+      def eql?(other)
+        self == other
+      end
+    end
+  end
+end

data/lib/wikibase_representable/model/entity_id_value.rb

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+require 'wikibase_representable/model/data_value'
+
+module WikibaseRepresentable
+  module Model
+    # Data value representing an entity ID data value
+    class EntityIdValue < DataValue
+      TYPE = 'wikibase-entityid'
+
+      def initialize(value: nil)
+        super(type: TYPE, value: value)
+      end
+
+      def id
+        @value.id
+      end
+
+      def entity_type
+        @value.entity_type
+      end
+
+      def numeric_id
+        @value.numeric_id
+      end
+
+      def ==(other)
+        other.is_a?(self.class) &&
+          type == other.type &&
+          id == other.id &&
+          entity_type == other.entity_type &&
+          numeric_id == other.numeric_id
+      end
+
+      def eql?(other)
+        self == other
+      end
+    end
+  end
+end

data/lib/wikibase_representable/model/item.rb

@@ -0,0 +1,83 @@
+# frozen_string_literal: true
+
+require 'wikibase_representable/model/alias_group_list'
+require 'wikibase_representable/model/site_link_list'
+require 'wikibase_representable/model/statement_list'
+require 'wikibase_representable/model/term_list'
+require 'wikibase_representable/model/term'
+
+module WikibaseRepresentable
+  module Model
+    # Represents a single Wikibase item.
+    # See https://www.mediawiki.org/wiki/Wikibase/DataModel#Items
+    class Item
+      ENTITY_TYPE = 'item'
+
+      attr_accessor :type, :id, :labels, :descriptions, :alias_groups, :site_links, :statements
+
+      def initialize(type: ENTITY_TYPE,
+                     id: nil,
+                     labels: TermList.new,
+                     descriptions: TermList.new,
+                     alias_groups: AliasGroupList.new,
+                     site_links: SiteLinkList.new,
+                     statements: StatementList.new)
+        @type = type
+        @id = id
+        @labels = labels
+        @descriptions = descriptions
+        @alias_groups = alias_groups
+        @site_links = site_links
+        @statements = statements
+      end
+
+      def label(language_code)
+        @labels.value_for_language(language_code)
+      end
+
+      def statements_by_property_id(property_id)
+        @statements.statements_by_property_id(property_id)
+      end
+
+      def statements_by_property_id?(property_id)
+        @statements.statements_by_property_id?(property_id)
+      end
+
+      def statement_by_property_id(property_id)
+        @statements.statements_by_property_id(property_id)&.first
+      end
+
+      def site_link(site_id)
+        @site_links.link_for_site(site_id)
+      end
+
+      def link_to_site?(site_id)
+        @site_links.link_for_site?(site_id)
+      end
+
+      def empty?
+        @labels.empty? && @descriptions.empty? && @alias_groups.empty? && @site_links.empty? && @statements.empty?
+      end
+
+      def ==(other)
+        other.is_a?(self.class) &&
+          @type == other.type &&
+          @id == other.id &&
+          @labels == other.labels &&
+          @descriptions == other.descriptions &&
+          @alias_groups == other.alias_groups &&
+          @site_links == other.site_links &&
+          @statements == other.statements
+      end
+
+      def eql?(other)
+        self == other
+      end
+
+      alias claims statements
+      alias claims_by_property_id statements_by_property_id
+      alias claims_by_property_id? statements_by_property_id?
+      alias claim_by_property_id statement_by_property_id
+    end
+  end
+end

data/lib/wikibase_representable/model/property.rb

@@ -0,0 +1,64 @@
+# frozen_string_literal: true
+
+require 'wikibase_representable/model/alias_group_list'
+require 'wikibase_representable/model/statement_list'
+require 'wikibase_representable/model/term_list'
+require 'wikibase_representable/model/term'
+
+module WikibaseRepresentable
+  module Model
+    # Represents a single Wikibase property.
+    class Property
+      ENTITY_TYPE = 'property'
+
+      attr_accessor :type, :id, :data_type, :labels, :descriptions, :alias_groups, :statements
+
+      def initialize(type: ENTITY_TYPE,
+                     id: nil,
+                     data_type: nil,
+                     labels: TermList.new,
+                     descriptions: TermList.new,
+                     alias_groups: AliasGroupList.new,
+                     statements: StatementList.new)
+        @type = type
+        @data_type = data_type
+        @id = id
+        @labels = labels
+        @descriptions = descriptions
+        @alias_groups = alias_groups
+        @statements = statements
+      end
+
+      def label(language_code, value)
+        @labels.term(Term.new(language_code, value))
+      end
+
+      def description(language_code, value)
+        @descriptions.term(Term.new(language_code, value))
+      end
+
+      def aliases(language_code, aliases)
+        @alias_groups.aliases_for_language(language_code, aliases)
+      end
+
+      def empty?
+        @labels.empty? && @descriptions.empty? && @alias_groups.empty? && @statements.empty?
+      end
+
+      def ==(other)
+        other.is_a?(self.class) &&
+          @type == other.type &&
+          @id == other.id &&
+          @data_type == other.data_type &&
+          @labels == other.labels &&
+          @descriptions == other.descriptions &&
+          @alias_groups == other.alias_groups &&
+          @statements == other.statements
+      end
+
+      def eql?(other)
+        self == other
+      end
+    end
+  end
+end

data/lib/wikibase_representable/model/property_value_snak.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+module WikibaseRepresentable
+  module Model
+    # Class representing a property value snak.
+    # See https://www.mediawiki.org/wiki/Wikibase/DataModel#PropertyValueSnak
+    class PropertyValueSnak
+      include SnakDataValueHelper
+
+      SNAK_TYPE = 'value'
+
+      attr_accessor :type, :property_id, :data_value, :hash
+
+      def initialize(type: SNAK_TYPE, property_id: nil, data_value: nil, hash: nil)
+        @type = type
+        @property_id = property_id
+        @data_value = data_value
+        @hash = hash
+      end
+
+      def ==(other)
+        other.is_a?(self.class) &&
+          other.type == type &&
+          other.property_id == property_id &&
+          other.data_value == data_value &&
+          other.hash == hash
+      end
+
+      def eql?(other)
+        self == other
+      end
+    end
+  end
+end

data/lib/wikibase_representable/model/site_link.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+module WikibaseRepresentable
+  module Model
+    # Value object representing a link to a page on another site.
+    class SiteLink
+      attr_accessor :site_id, :page_name, :badges
+
+      def initialize(site_id: nil, page_name: nil, badges: nil)
+        @site_id = site_id
+        @page_name = page_name
+        @badges = badges
+      end
+
+      def ==(other)
+        other.is_a?(self.class) &&
+          @site_id == other.site_id &&
+          @page_name == other.page_name &&
+          @badges.size == other.badges.size &&
+          @badges & other.badges == @badges
+      end
+
+      def eql?(other)
+        self == other
+      end
+    end
+  end
+end

data/lib/wikibase_representable/model/site_link_list.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module WikibaseRepresentable
+  module Model
+    # Hash of SiteLink objects keyed by site id.
+    class SiteLinkList < Hash
+      def link_for_site(site_id)
+        fetch(site_id, nil)
+      end
+
+      def link_for_site?(site_id)
+        key?(site_id)
+      end
+    end
+  end
+end

data/lib/wikibase_representable/model/snak_data_value_helper.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+module WikibaseRepresentable
+  module Model
+    # Convenience methods for grabbing values from snaks
+    module SnakDataValueHelper
+      def value_type?(type)
+        main_snak.data_value.is_a?(type)
+      end
+
+      def data_value
+        data_value.value
+      end
+
+      def entity_id_value
+        data_value&.value&.id
+      end
+
+      def time_value
+        data_value&.value&.time
+      end
+    end
+  end
+end

data/lib/wikibase_representable/model/snak_list.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module WikibaseRepresentable
+  module Model
+    # Hash of property ID => Snak array.
+    class SnakList < Hash
+      def snaks_by_property_id(property_id)
+        fetch(property_id, nil)
+      end
+
+      def snaks_by_property_id?(property_id)
+        key?(property_id)
+      end
+    end
+  end
+end

data/lib/wikibase_representable/model/statement.rb

@@ -0,0 +1,69 @@
+# frozen_string_literal: true
+
+require 'wikibase_representable/model/snak_list'
+
+module WikibaseRepresentable
+  module Model
+    # Class representing a Wikibase statement.
+    # See https://www.mediawiki.org/wiki/Wikibase/DataModel#Statements
+    class Statement
+      include StatementDataValueHelper
+
+      TYPE = 'statement'
+
+      RANK_PREFERRED = 'preferred'
+      RANK_NORMAL = 'normal'
+      RANK_DEPRECATED = 'deprecated'
+
+      attr_accessor :main_snak, :type, :qualifiers, :qualifiers_order, :guid, :rank
+
+      def initialize(main_snak: nil,
+                     type: TYPE,
+                     qualifiers: nil,
+                     qualifiers_order: nil,
+                     guid: nil,
+                     rank: RANK_NORMAL)
+        @main_snak = main_snak
+        @type = type
+        @qualifiers = qualifiers
+        @qualifiers_order = qualifiers_order
+        @guid = guid
+        @rank = rank
+      end
+
+      def qualifiers?
+        !!qualifiers && !qualifiers.empty?
+      end
+
+      def qualifiers_by_property_id?(property_id)
+        qualifiers&.snaks_by_property_id?(property_id)
+      end
+
+      def qualifiers_by_property_id(property_id)
+        qualifiers&.snaks_by_property_id(property_id)
+      end
+
+      def qualifier_by_property_id(property_id)
+        qualifiers_by_property_id(property_id)&.first
+      end
+
+      def property_id
+        @main_snak.property_id
+      end
+
+      def ==(other)
+        other.is_a?(self.class) &&
+          other.type == @type &&
+          other.main_snak == @main_snak &&
+          other.qualifiers == @qualifiers &&
+          other.qualifiers_order == @qualifiers_order &&
+          other.rank == @rank &&
+          other.guid == @guid
+      end
+
+      def eql?(other)
+        self == other
+      end
+    end
+  end
+end

data/lib/wikibase_representable/model/statement_data_value_helper.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+module WikibaseRepresentable
+  module Model
+    # Convenience methods for grabbing values from statements' main snaks
+    module StatementDataValueHelper
+      def value_type?(type)
+        main_snak.data_value.is_a?(type)
+      end
+
+      def data_value
+        main_snak.data_value.value
+      end
+
+      def entity_id_value
+        main_snak.data_value.value.id
+      end
+
+      def time_value
+        main_snak.data_value.value.time
+      end
+    end
+  end
+end

data/lib/wikibase_representable/model/statement_list.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+module WikibaseRepresentable
+  module Model
+    # Wraps a hash of Statement arrays keyed by entity id.
+    class StatementList < Hash
+      def statements_by_property_id(property_id)
+        fetch(property_id, nil)
+      end
+
+      def statements_by_property_id?(property_id)
+        key?(property_id)
+      end
+
+      def statement_by_property_id(property_id)
+        statements_by_property_id(property_id)&.first
+      end
+
+      alias claims_by_property_id statements_by_property_id
+      alias claims_by_property_id? statements_by_property_id?
+      alias claim_by_property_id statement_by_property_id
+    end
+  end
+end

data/lib/wikibase_representable/model/term.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+module WikibaseRepresentable
+  module Model
+    # Represents a string value specific to a langugage code.
+    class Term
+      attr_accessor :language_code, :value
+
+      def initialize(language_code: nil, value: nil)
+        @language_code = language_code
+        @value = value
+      end
+
+      def ==(other)
+        other.is_a?(self.class) &&
+          @language_code == other.language_code &&
+          @value == other.value
+      end
+
+      def eql?(other)
+        self == other
+      end
+    end
+  end
+end

data/lib/wikibase_representable/model/term_list.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+require 'wikibase_representable/model/term'
+
+module WikibaseRepresentable
+  module Model
+    # Wraps a hash of Term objects keyed by language code.
+    class TermList < Hash
+      def term_for_language(language_code)
+        fetch(language_code, nil)
+      end
+
+      def value_for_language(language_code)
+        term_for_language(language_code)&.value
+      end
+
+      def term_for_language?(language_code)
+        key?(language_code)
+      end
+    end
+  end
+end

data/lib/wikibase_representable/model/time.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+module WikibaseRepresentable
+  module Model
+    # Represents a point in time.
+    class Time
+      attr_accessor :time, :time_zone, :before, :after, :precision, :calendar_model
+
+      def initialize(time: nil, time_zone: nil, before: nil, after: nil, precision: nil, calendar_model: nil)
+        @time = time
+        @time_zone = time_zone
+        @before = before
+        @after = after
+        @precision = precision
+        @calendar_model = calendar_model
+      end
+
+      def ==(other)
+        other.is_a?(self.class) &&
+          time == other.time &&
+          time_zone == other.time_zone &&
+          before == other.before &&
+          after == other.after &&
+          precision == other.precision &&
+          calendar_model == other.calendar_model
+      end
+
+      def eql?(other)
+        self == other
+      end
+    end
+  end
+end