wikibase_representable 0.1.3 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a9e7e9f706f63881e5d8f7eb250fb378371174ef032ceb653de1d0c18db646d7
-  data.tar.gz: 9b14eba39f961b62bd845c080680a80a139e7ebdf8a6b090d511f405a10e86d1
+  metadata.gz: f0172a6186013fc4a2c5584eff040ca1c0ef7f774dac7934c5539f8f646227a3
+  data.tar.gz: 83e494bc775b64224172092b50a903d3b128f462cab6b945abdadd5b733e209b
 SHA512:
-  metadata.gz: 4b7a916708d995839fd19fe1442c4efdd7b240824ae7ac7fa12750e50f93525f892285a819741bba0800c0269b932e3a5c883f4306942bc0abbe3bcebdf083ab
-  data.tar.gz: 45eeafaa918be62997ba41710b1b29de84b0250f5e5fabd4ca4e8ff6f56e6be5eb263f9b9a885631fb49442aa441175711c55ebd3953e648870a6057196538c3
+  metadata.gz: 1ad5a4d89f31b22a5ad54b7370e7c41689c3fa71d657351e6bc21ab876de2e93408a0af33fefa95a23ce2de63e1e935f5328da2dd36d1316b1275a5de4ccbf3f
+  data.tar.gz: b7b25e41ec60dca76a97e1b34695496a36c97921120c19c6b30c6b651b1865d5ea1cd63a5c7c3b40792d02996f0c63d06550b01e4d63903399296b670c2e5545

data/.rspec

@@ -0,0 +1 @@
+--require spec_helper

data/.rubocop.yml

@@ -1,18 +1,5 @@
-require:
-  - rubocop-rake
-  - rubocop-rspec
+inherit_from: .rubocop_todo.yml
 
-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
+inherit_gem:
+  upennlib-rubocop: upennlib_rubocop_defaults.yml
+  

data/.rubocop_todo.yml

@@ -0,0 +1,17 @@
+# This configuration was generated by
+# `rubocop --auto-gen-config`
+# on 2025-01-18 04:14:35 UTC using RuboCop version 1.69.2.
+# The point is for the user to remove these configuration records
+# one by one as the offenses are removed from the code base.
+# Note that changes in the inspected code, or installation of new
+# versions of RuboCop, may require this file to be generated again.
+
+# Offense count: 13
+# This cop supports safe autocorrection (--autocorrect).
+# Configuration parameters: EnforceForPrefixed.
+Rails/Delegate:
+  Exclude:
+    - 'lib/wikibase_representable/model/entity_id_value.rb'
+    - 'lib/wikibase_representable/model/item.rb'
+    - 'lib/wikibase_representable/model/statement.rb'
+    - 'lib/wikibase_representable/model/time_value.rb'

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2024 Michael Holloway
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/lib/wikibase_representable/model/{alias_group_list.rb → alias_group_hash.rb}

@@ -2,8 +2,8 @@
 
 module WikibaseRepresentable
   module Model
-    # Wraps a hash of Term arrays keyed by language code.
-    class AliasGroupList < Hash
+    # Hash of alias lists keyed by language code.
+    class AliasGroupHash < Hash
       def aliases_for_language(language_code)
         fetch(language_code, nil)
       end

data/lib/wikibase_representable/model/data_value.rb

@@ -11,10 +11,12 @@ module WikibaseRepresentable
         @value = value
       end
 
+      def state
+        [type, value]
+      end
+
       def ==(other)
-        other.is_a?(self.class) &&
-          other.type == type &&
-          other.value == value
+        other.class == self.class && other.state == state
       end
 
       def eql?(other)

data/lib/wikibase_representable/model/entity_id.rb

@@ -12,11 +12,12 @@ module WikibaseRepresentable
         @entity_type = entity_type
       end
 
+      def state
+        [id, numeric_id, entity_type]
+      end
+
       def ==(other)
-        other.is_a?(self.class) &&
-          id == other.id &&
-          entity_type == other.entity_type &&
-          numeric_id == other.numeric_id
+        other.class == self.class && other.state == state
       end
 
       def eql?(other)

data/lib/wikibase_representable/model/entity_id_value.rb

@@ -13,23 +13,23 @@ module WikibaseRepresentable
       end
 
       def id
-        @value.id
+        value.id
       end
 
       def entity_type
-        @value.entity_type
+        value.entity_type
       end
 
       def numeric_id
-        @value.numeric_id
+        value.numeric_id
+      end
+
+      def state
+        [type, value]
       end
 
       def ==(other)
-        other.is_a?(self.class) &&
-          type == other.type &&
-          id == other.id &&
-          entity_type == other.entity_type &&
-          numeric_id == other.numeric_id
+        other.class == self.class && other.state == state
       end
 
       def eql?(other)

data/lib/wikibase_representable/model/item.rb

@@ -1,9 +1,9 @@
 # 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/alias_group_hash'
+require 'wikibase_representable/model/site_link_hash'
+require 'wikibase_representable/model/statement_hash'
+require 'wikibase_representable/model/term_hash'
 require 'wikibase_representable/model/term'
 
 module WikibaseRepresentable
@@ -13,64 +13,55 @@ module WikibaseRepresentable
     class Item
       ENTITY_TYPE = 'item'
 
-      attr_accessor :type, :id, :labels, :descriptions, :alias_groups, :site_links, :statements
+      attr_accessor :type, :id, :labels_hash, :descriptions_hash, :alias_groups_hash, :site_links_hash, :statements_hash
 
-      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
+      def initialize(**kwargs)
+        @type = ENTITY_TYPE
+        @id = kwargs[:id]
+        @labels_hash = kwargs[:labels_hash] || TermHash.new
+        @descriptions_hash = kwargs[:descriptions_hash] || TermHash.new
+        @alias_groups_hash = kwargs[:alias_groups_hash] || AliasGroupHash.new
+        @site_links_hash = kwargs[:site_links_hash] || SiteLinkHash.new
+        @statements_hash = kwargs[:statements_hash] || StatementHash.new
       end
 
       def label(language_code)
-        @labels.value_for_language(language_code)
+        labels_hash.value_for_language(language_code)
+      end
+
+      def aliases_for_language(language_code)
+        alias_groups_hash.aliases_for_language(language_code)
       end
 
       def statements_by_property_id(property_id)
-        @statements.statements_by_property_id(property_id)
+        statements_hash.statements_by_property_id(property_id)
       end
 
       def statements_by_property_id?(property_id)
-        @statements.statements_by_property_id?(property_id)
+        statements_hash.statements_by_property_id?(property_id)
       end
 
       def site_link(site_id)
-        @site_links.link_for_site(site_id)
+        site_links_hash.link_for_site(site_id)
       end
 
       def link_to_site?(site_id)
-        @site_links.link_for_site?(site_id)
+        site_links_hash.link_for_site?(site_id)
       end
 
-      def empty?
-        @labels.empty? && @descriptions.empty? && @alias_groups.empty? && @site_links.empty? && @statements.empty?
+      def state
+        [type, id, labels_hash, descriptions_hash, alias_groups_hash, site_links_hash, statements_hash]
       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
+        other.class == self.class && other.state == state
       end
 
       def eql?(other)
         self == other
       end
 
-      alias claims statements
+      alias claims_hash statements_hash
       alias claims_by_property_id statements_by_property_id
       alias claims_by_property_id? statements_by_property_id?
     end

data/lib/wikibase_representable/model/property.rb

@@ -1,8 +1,8 @@
 # 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/alias_group_hash'
+require 'wikibase_representable/model/statement_hash'
+require 'wikibase_representable/model/term_hash'
 require 'wikibase_representable/model/term'
 
 module WikibaseRepresentable
@@ -11,49 +11,24 @@ module WikibaseRepresentable
     class Property
       ENTITY_TYPE = 'property'
 
-      attr_accessor :type, :id, :data_type, :labels, :descriptions, :alias_groups, :statements
+      attr_accessor :type, :id, :data_type, :labels_hash, :descriptions_hash, :alias_groups_hash, :statements_hash
 
-      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
+      def initialize(**kwargs)
+        @type = ENTITY_TYPE
+        @data_type = kwargs[:data_type]
+        @id = kwargs[:id]
+        @labels_hash = kwargs[:labels_hash] || TermHash.new
+        @descriptions_hash = kwargs[:descriptions_hash] || TermHash.new
+        @alias_groups_hash = kwargs[:alias_groups_hash] || AliasGroupHash.new
+        @statements_hash = kwargs[:statements_hash] || StatementHash.new
       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?
+      def state
+        [type, id, data_type, labels_hash, descriptions_hash, alias_groups_hash, statements_hash]
       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
+        other.class == self.class && other.state == state
       end
 
       def eql?(other)

data/lib/wikibase_representable/model/property_value_snak.rb

@@ -18,12 +18,12 @@ module WikibaseRepresentable
         @hash = hash
       end
 
+      def state
+        [type, property_id, data_value, 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
+        other.class == self.class && other.state == state
       end
 
       def eql?(other)

data/lib/wikibase_representable/model/site_link.rb

@@ -12,12 +12,12 @@ module WikibaseRepresentable
         @badges = badges
       end
 
+      def state
+        [site_id, page_name, 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
+        other.class == self.class && other.state == state
       end
 
       def eql?(other)

data/lib/wikibase_representable/model/{site_link_list.rb → site_link_hash.rb}

@@ -3,7 +3,7 @@
 module WikibaseRepresentable
   module Model
     # Hash of SiteLink objects keyed by site id.
-    class SiteLinkList < Hash
+    class SiteLinkHash < Hash
       def link_for_site(site_id)
         fetch(site_id, nil)
       end

data/lib/wikibase_representable/model/{snak_list.rb → snak_hash.rb}

@@ -2,8 +2,8 @@
 
 module WikibaseRepresentable
   module Model
-    # Hash of property ID => Snak array.
-    class SnakList < Hash
+    # Hash of Snak lists keyed by property ID
+    class SnakHash < Hash
       def snaks_by_property_id(property_id)
         fetch(property_id, nil)
       end

data/lib/wikibase_representable/model/statement.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require 'wikibase_representable/model/snak_list'
+require 'wikibase_representable/model/snak_hash'
 
 module WikibaseRepresentable
   module Model
@@ -17,22 +17,13 @@ module WikibaseRepresentable
 
       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?
+      def initialize(**kwargs)
+        @main_snak = kwargs[:main_snak]
+        @type = kwargs[:type] || TYPE
+        @qualifiers = kwargs[:qualifiers]
+        @qualifiers_order = kwargs[:qualifiers_order]
+        @guid = kwargs[:guid]
+        @rank = kwargs[:rank] || RANK_NORMAL
       end
 
       def qualifiers_by_property_id?(property_id)
@@ -44,17 +35,15 @@ module WikibaseRepresentable
       end
 
       def property_id
-        @main_snak.property_id
+        main_snak.property_id
+      end
+
+      def state
+        [main_snak, type, qualifiers, qualifiers_order, guid, rank]
       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
+        other.class == self.class && other.state == state
       end
 
       def eql?(other)

data/lib/wikibase_representable/model/{statement_list.rb → statement_hash.rb}

@@ -2,8 +2,8 @@
 
 module WikibaseRepresentable
   module Model
-    # Wraps a hash of Statement arrays keyed by entity id.
-    class StatementList < Hash
+    # Hash of Statement lists keyed by property id.
+    class StatementHash < Hash
       def statements_by_property_id(property_id)
         fetch(property_id, nil)
       end

data/lib/wikibase_representable/model/term.rb

@@ -11,10 +11,12 @@ module WikibaseRepresentable
         @value = value
       end
 
+      def state
+        [language_code, value]
+      end
+
       def ==(other)
-        other.is_a?(self.class) &&
-          @language_code == other.language_code &&
-          @value == other.value
+        other.class == self.class && other.state == state
       end
 
       def eql?(other)

data/lib/wikibase_representable/model/{term_list.rb → term_hash.rb}

@@ -4,8 +4,8 @@ require 'wikibase_representable/model/term'
 
 module WikibaseRepresentable
   module Model
-    # Wraps a hash of Term objects keyed by language code.
-    class TermList < Hash
+    # Hash of Term objects keyed by language code.
+    class TermHash < Hash
       def term_for_language(language_code)
         fetch(language_code, nil)
       end

data/lib/wikibase_representable/model/time.rb

@@ -6,23 +6,21 @@ module WikibaseRepresentable
     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
+      def initialize(**kwargs)
+        @time = kwargs[:time]
+        @time_zone = kwargs[:time_zone]
+        @before = kwargs[:before]
+        @after = kwargs[:after]
+        @precision = kwargs[:precision]
+        @calendar_model = kwargs[:calendar_model]
+      end
+
+      def state
+        [time, time_zone, before, after, precision, 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
+        other.class == self.class && other.state == state
       end
 
       def eql?(other)

data/lib/wikibase_representable/model/time_value.rb

@@ -13,38 +13,35 @@ module WikibaseRepresentable
       end
 
       def time
-        @value.time
+        value.time
       end
 
       def time_zone
-        @value.time_zone
+        value.time_zone
       end
 
       def before
-        @value.before
+        value.before
       end
 
       def after
-        @value.after
+        value.after
       end
 
       def precision
-        @value.precision
+        value.precision
       end
 
       def calendar_model
-        @value.calendar_model
+        value.calendar_model
+      end
+
+      def state
+        [type, value]
       end
 
       def ==(other)
-        other.is_a?(self.class) &&
-          type == other.type &&
-          time == other.time &&
-          time_zone == other.time_zone &&
-          before == other.before &&
-          after == other.after &&
-          precision == other.precision &&
-          calendar_model == other.calendar_model
+        other.class == self.class && other.state == state
       end
 
       def eql?(other)

data/lib/wikibase_representable/model.rb

@@ -3,7 +3,7 @@
 require 'wikibase_representable/model/snak_data_value_helper'
 require 'wikibase_representable/model/statement_data_value_helper'
 
-require 'wikibase_representable/model/alias_group_list'
+require 'wikibase_representable/model/alias_group_hash'
 require 'wikibase_representable/model/data_value'
 require 'wikibase_representable/model/entity_id'
 require 'wikibase_representable/model/entity_id_value'
@@ -11,11 +11,11 @@ require 'wikibase_representable/model/item'
 require 'wikibase_representable/model/property'
 require 'wikibase_representable/model/property_value_snak'
 require 'wikibase_representable/model/site_link'
-require 'wikibase_representable/model/site_link_list'
-require 'wikibase_representable/model/snak_list'
+require 'wikibase_representable/model/site_link_hash'
+require 'wikibase_representable/model/snak_hash'
 require 'wikibase_representable/model/statement'
-require 'wikibase_representable/model/statement_list'
+require 'wikibase_representable/model/statement_hash'
 require 'wikibase_representable/model/term'
-require 'wikibase_representable/model/term_list'
+require 'wikibase_representable/model/term_hash'
 require 'wikibase_representable/model/time_value'
 require 'wikibase_representable/model/time'

data/lib/wikibase_representable/representers/{alias_group_list_representer.rb → alias_group_hash_representer.rb}

@@ -6,7 +6,7 @@ require 'wikibase_representable/representers/term_representer'
 module WikibaseRepresentable
   module Representers
     # Representer for a hash of language_codes => term arrays
-    class AliasGroupListRepresenter < Representable::Decorator
+    class AliasGroupHashRepresenter < Representable::Decorator
       include Representable::JSON::Hash
 
       values decorator: TermRepresenter.for_collection, instance: ->(_fragment) { [] }

data/lib/wikibase_representable/representers/item_representer.rb

@@ -2,10 +2,10 @@
 
 require 'representable/json'
 require 'wikibase_representable/model'
-require 'wikibase_representable/representers/alias_group_list_representer'
-require 'wikibase_representable/representers/site_link_list_representer'
-require 'wikibase_representable/representers/statement_list_representer'
-require 'wikibase_representable/representers/term_list_representer'
+require 'wikibase_representable/representers/alias_group_hash_representer'
+require 'wikibase_representable/representers/site_link_hash_representer'
+require 'wikibase_representable/representers/statement_hash_representer'
+require 'wikibase_representable/representers/term_hash_representer'
 
 module WikibaseRepresentable
   module Representers
@@ -16,19 +16,18 @@ module WikibaseRepresentable
 
       property :type
       property :id
-      property :labels, decorator: TermListRepresenter,
-                        class: TermList
-      property :descriptions, decorator: TermListRepresenter,
-                              class: TermList
-      property :alias_groups, as: 'aliases',
-                              decorator: AliasGroupListRepresenter,
-                              class: AliasGroupList
-      property :statements, as: 'claims',
-                            decorator: StatementListRepresenter,
-                            class: StatementList
-      property :site_links, as: 'sitelinks',
-                            decorator: SiteLinkListRepresenter,
-                            class: SiteLinkList
+      property :labels_hash, decorator: TermHashRepresenter,
+                             class: TermHash
+      property :descriptions_hash, decorator: TermHashRepresenter,
+                                   class: TermHash
+      property :alias_groups_hash, as: 'aliases_hash',
+                                   decorator: AliasGroupHashRepresenter,
+                                   class: AliasGroupHash
+      property :statements_hash, as: 'claims_hash',
+                                 decorator: StatementHashRepresenter,
+                                 class: StatementHash
+      property :site_links_hash, decorator: SiteLinkHashRepresenter,
+                                 class: SiteLinkHash
     end
   end
 end

data/lib/wikibase_representable/representers/property_representer.rb

@@ -2,9 +2,9 @@
 
 require 'representable/json'
 require 'wikibase_representable/model'
-require 'wikibase_representable/representers/alias_group_list_representer'
-require 'wikibase_representable/representers/statement_list_representer'
-require 'wikibase_representable/representers/term_list_representer'
+require 'wikibase_representable/representers/alias_group_hash_representer'
+require 'wikibase_representable/representers/statement_hash_representer'
+require 'wikibase_representable/representers/term_hash_representer'
 
 module WikibaseRepresentable
   module Representers
@@ -16,16 +16,16 @@ module WikibaseRepresentable
       property :type
       property :data_type, as: 'datatype'
       property :id
-      property :labels, decorator: TermListRepresenter,
-                        class: TermList
-      property :descriptions, decorator: TermListRepresenter,
-                              class: TermList
-      property :alias_groups, as: 'aliases',
-                              decorator: AliasGroupListRepresenter,
-                              class: AliasGroupList
-      property :statements, as: 'claims',
-                            decorator: StatementListRepresenter,
-                            class: StatementList
+      property :labels_hash, decorator: TermHashRepresenter,
+                             class: TermHash
+      property :descriptions_hash, decorator: TermHashRepresenter,
+                                   class: TermHash
+      property :alias_groups_hash, as: 'aliases_hash',
+                                   decorator: AliasGroupHashRepresenter,
+                                   class: AliasGroupHash
+      property :statements_hash, as: 'claims_hash',
+                                 decorator: StatementHashRepresenter,
+                                 class: StatementHash
     end
   end
 end

data/lib/wikibase_representable/representers/{site_link_list_representer.rb → site_link_hash_representer.rb}

@@ -7,7 +7,7 @@ require 'wikibase_representable/representers/site_link_representer'
 module WikibaseRepresentable
   module Representers
     # Representer for a hash of (siteid => sitelink)
-    class SiteLinkListRepresenter < Representable::Decorator
+    class SiteLinkHashRepresenter < Representable::Decorator
       include Representable::JSON::Hash
       include WikibaseRepresentable::Model
 

data/lib/wikibase_representable/representers/{snak_list_representer.rb → snak_hash_representer.rb}

@@ -5,8 +5,8 @@ require 'wikibase_representable/representers/property_value_snak_representer'
 
 module WikibaseRepresentable
   module Representers
-    # Representer for a list of property value snaks.
-    class SnakListRepresenter < Representable::Decorator
+    # Representer for a hash of snak lists keyed by property ID.
+    class SnakHashRepresenter < Representable::Decorator
       include Representable::JSON::Hash
 
       values decorator: PropertyValueSnakRepresenter.for_collection, instance: ->(_fragment) { [] }

data/lib/wikibase_representable/representers/{statement_list_representer.rb → statement_hash_representer.rb}

@@ -6,7 +6,7 @@ require 'wikibase_representable/representers/statement_representer'
 module WikibaseRepresentable
   module Representers
     # Representer for a hash of property IDs => statement arrays.
-    class StatementListRepresenter < Representable::Decorator
+    class StatementHashRepresenter < Representable::Decorator
       include Representable::JSON::Hash
 
       values decorator: StatementRepresenter.for_collection, instance: ->(_fragment) { [] }

data/lib/wikibase_representable/representers/statement_representer.rb

@@ -3,7 +3,7 @@
 require 'representable/json'
 require 'wikibase_representable/model'
 require 'wikibase_representable/representers/property_value_snak_representer'
-require 'wikibase_representable/representers/snak_list_representer'
+require 'wikibase_representable/representers/snak_hash_representer'
 
 module WikibaseRepresentable
   module Representers
@@ -16,8 +16,8 @@ module WikibaseRepresentable
                            decorator: PropertyValueSnakRepresenter,
                            class: PropertyValueSnak
       property :type
-      property :qualifiers, decorator: SnakListRepresenter,
-                            class: SnakList
+      property :qualifiers, decorator: SnakHashRepresenter,
+                            class: SnakHash
       property :qualifiers_order, as: 'qualifiers-order'
       property :guid, as: 'id'
       property :rank

data/lib/wikibase_representable/representers/{term_list_representer.rb → term_hash_representer.rb}

@@ -6,8 +6,8 @@ require 'wikibase_representable/representers/term_representer'
 
 module WikibaseRepresentable
   module Representers
-    # Representer for term lists
-    class TermListRepresenter < Representable::Decorator
+    # Representer for term hashes
+    class TermHashRepresenter < Representable::Decorator
       include Representable::JSON::Hash
       include WikibaseRepresentable::Model
 

data/lib/wikibase_representable/representers.rb

@@ -1,18 +1,18 @@
 # frozen_string_literal: true
 
-require 'wikibase_representable/representers/alias_group_list_representer'
+require 'wikibase_representable/representers/alias_group_hash_representer'
 require 'wikibase_representable/representers/data_value_representer'
 require 'wikibase_representable/representers/entity_id_value_representer'
 require 'wikibase_representable/representers/entity_id_representer'
 require 'wikibase_representable/representers/item_representer'
 require 'wikibase_representable/representers/property_value_snak_representer'
 require 'wikibase_representable/representers/property_representer'
-require 'wikibase_representable/representers/site_link_list_representer'
+require 'wikibase_representable/representers/site_link_hash_representer'
 require 'wikibase_representable/representers/site_link_representer'
-require 'wikibase_representable/representers/snak_list_representer'
-require 'wikibase_representable/representers/statement_list_representer'
+require 'wikibase_representable/representers/snak_hash_representer'
+require 'wikibase_representable/representers/statement_hash_representer'
 require 'wikibase_representable/representers/statement_representer'
-require 'wikibase_representable/representers/term_list_representer'
+require 'wikibase_representable/representers/term_hash_representer'
 require 'wikibase_representable/representers/term_representer'
 require 'wikibase_representable/representers/time_value_representer'
 require 'wikibase_representable/representers/time_representer'

data/lib/wikibase_representable/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module WikibaseRepresentable
-  VERSION = '0.1.3'
+  VERSION = '0.2.0'
 end

data/scripts/test_deserialization_round_trip.rb

@@ -0,0 +1,85 @@
+# frozen_string_literal: true
+
+# Tests round-trip deserialization and serialization of Wikibase entities.
+# Attempts to correct for quirks in the Wikibase output format such as optional escape characters
+# used by PHP and not Ruby (though this can lead to false-positive diffs where the data contains a
+# backslash that looks like an escape character but isn't.).
+
+require 'diffy'
+require 'json'
+require 'optparse'
+require 'wikibase_representable'
+require 'zlib'
+
+dir = File.dirname __FILE__
+
+export_file = File.expand_path '../../../DigitalScriptorium/ds-exports/json/ds-latest.json.gz', dir
+
+OptionParser.new { |opts|
+  opts.banner = 'Usage: test_wikibase_representable_ds_serialization.rb [options]'
+
+  opts.on('-f', '--file=FILE', 'The file path to the Wikibase JSON export file.') do |f|
+    export_file = File.expand_path f, dir
+  end
+}.parse!
+
+lines_examined = 0
+parse_errors = 0
+diff_count = 0
+
+def decorator(type)
+  if type == WikibaseRepresentable::Model::Item::ENTITY_TYPE
+    WikibaseRepresentable::Representers::ItemRepresenter
+  else
+    WikibaseRepresentable::Representers::PropertyRepresenter
+  end
+end
+
+def clazz(type)
+  if type == WikibaseRepresentable::Model::Item::ENTITY_TYPE
+    WikibaseRepresentable::Model::Item
+  else
+    WikibaseRepresentable::Model::Property
+  end
+end
+
+# File.readlines('../../hxsllc/hxs-blacklight/lib/export-prod-0328.json').each do |line|
+Zlib::GzipReader.open(export_file).each_line do |line|
+  next if ["[\n", "]\n"].include?(line)
+
+  lines_examined += 1
+
+  line = line
+         .gsub(/(^\[|\]$|,\n$)/, '')
+         # Strip PHP-specific escape characters for diffing
+         # See https://stackoverflow.com/a/56834902 for discussion
+         .gsub(%r{\\(/|[A-Za-z0-9])}, '\1')
+
+  begin
+    hash = JSON.parse(line)
+  rescue StandardError
+    puts "***PARSE ERROR***\n#{line}\n\n"
+    parse_errors += 1
+    next
+  end
+
+  decorator = decorator(hash['type'])
+  clazz = clazz(hash['type'])
+  obj = decorator.new(clazz.new).from_json(line)
+  diff = Diffy::Diff.new("#{line}\n", "#{decorator.new(obj)
+    .to_json
+    # Adjust empty associative arrays to match PHP serialization
+    .gsub(/\{\}/, '[]')}\n")
+
+  unless diff.to_s.empty?
+    puts("***DIFF***\n#{diff}\n\n")
+    diff_count += 1
+  end
+end
+
+# 3 items with known diffs: Q37381, Q43197 (both due to improperly regex-stripped backslash), Q66686 (TBD)
+puts "Lines examined: #{lines_examined}"
+puts "Parse errors: #{parse_errors}"
+puts "Diff count: #{diff_count}"
+
+exit [diff_count + parse_errors, 1].min

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: wikibase_representable
 version: !ruby/object:Gem::Version
-  version: 0.1.3
+  version: 0.2.0
 platform: ruby
 authors:
 - Michael Holloway
 bindir: exe
 cert_chain: []
-date: 2025-01-08 00:00:00.000000000 Z
+date: 2025-02-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: multi_json
@@ -52,75 +52,89 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '2.5'
 - !ruby/object:Gem::Dependency
-  name: rake
+  name: diffy
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '13.2'
+        version: '3.4'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '13.2'
+        version: '3.4'
 - !ruby/object:Gem::Dependency
-  name: rspec
+  name: pry
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.13'
+        version: 0.15.2
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.13'
+        version: 0.15.2
 - !ruby/object:Gem::Dependency
-  name: rubocop
+  name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.69'
+        version: '13.2'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.69'
+        version: '13.2'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.13'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.13'
 - !ruby/object:Gem::Dependency
-  name: rubocop-rake
+  name: simplecov
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.6'
+        version: 0.22.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.6'
+        version: 0.22.0
 - !ruby/object:Gem::Dependency
-  name: rubocop-rspec
+  name: upennlib-rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.3'
+        version: 1.2.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.3'
+        version: 1.2.0
 description: Provides Wikibase data model classes and support for serializing and
   deserializing Wikibase entities to and from JSON.
 email:
@@ -129,12 +143,15 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".rspec"
 - ".rubocop.yml"
+- ".rubocop_todo.yml"
+- LICENSE.txt
 - README.md
 - Rakefile
 - lib/wikibase_representable.rb
 - lib/wikibase_representable/model.rb
-- lib/wikibase_representable/model/alias_group_list.rb
+- lib/wikibase_representable/model/alias_group_hash.rb
 - lib/wikibase_representable/model/data_value.rb
 - lib/wikibase_representable/model/entity_id.rb
 - lib/wikibase_representable/model/entity_id_value.rb
@@ -142,34 +159,35 @@ files:
 - lib/wikibase_representable/model/property.rb
 - lib/wikibase_representable/model/property_value_snak.rb
 - lib/wikibase_representable/model/site_link.rb
-- lib/wikibase_representable/model/site_link_list.rb
+- lib/wikibase_representable/model/site_link_hash.rb
 - lib/wikibase_representable/model/snak_data_value_helper.rb
-- lib/wikibase_representable/model/snak_list.rb
+- lib/wikibase_representable/model/snak_hash.rb
 - lib/wikibase_representable/model/statement.rb
 - lib/wikibase_representable/model/statement_data_value_helper.rb
-- lib/wikibase_representable/model/statement_list.rb
+- lib/wikibase_representable/model/statement_hash.rb
 - lib/wikibase_representable/model/term.rb
-- lib/wikibase_representable/model/term_list.rb
+- lib/wikibase_representable/model/term_hash.rb
 - lib/wikibase_representable/model/time.rb
 - lib/wikibase_representable/model/time_value.rb
 - lib/wikibase_representable/representers.rb
-- lib/wikibase_representable/representers/alias_group_list_representer.rb
+- lib/wikibase_representable/representers/alias_group_hash_representer.rb
 - lib/wikibase_representable/representers/data_value_representer.rb
 - lib/wikibase_representable/representers/entity_id_representer.rb
 - lib/wikibase_representable/representers/entity_id_value_representer.rb
 - lib/wikibase_representable/representers/item_representer.rb
 - lib/wikibase_representable/representers/property_representer.rb
 - lib/wikibase_representable/representers/property_value_snak_representer.rb
-- lib/wikibase_representable/representers/site_link_list_representer.rb
+- lib/wikibase_representable/representers/site_link_hash_representer.rb
 - lib/wikibase_representable/representers/site_link_representer.rb
-- lib/wikibase_representable/representers/snak_list_representer.rb
-- lib/wikibase_representable/representers/statement_list_representer.rb
+- lib/wikibase_representable/representers/snak_hash_representer.rb
+- lib/wikibase_representable/representers/statement_hash_representer.rb
 - lib/wikibase_representable/representers/statement_representer.rb
-- lib/wikibase_representable/representers/term_list_representer.rb
+- lib/wikibase_representable/representers/term_hash_representer.rb
 - lib/wikibase_representable/representers/term_representer.rb
 - lib/wikibase_representable/representers/time_representer.rb
 - lib/wikibase_representable/representers/time_value_representer.rb
 - lib/wikibase_representable/version.rb
+- scripts/test_deserialization_round_trip.rb
 homepage: https://github.com/mdholloway/wikibase_representable
 licenses:
 - MIT