wikibase_representable 0.1.2 → 0.1.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f6a7ec0afc5588cc6cbd018f510a7727633c1fbc72e2b4df934440ca43db1e3f
-  data.tar.gz: b4f0d00b21687df51d49a82d1ad2315200ac3d95c91daf2b356325207edd7c9d
+  metadata.gz: defaee30f588f7bee23fa3fd57e8ddcceb8537abe62b1807ba35fdcbf72d435c
+  data.tar.gz: 7acba0104544f026a193f005a26921ae905c5d7b351ecc02b88390caa7d28e47
 SHA512:
-  metadata.gz: 057c51bc2b5895abd83884674320452d97d112a5b590f3cd6d0c713e41818b6da668cc6a9ac9e0e7c204f5b4b897dafd97c04f15451c5586d142c3315eec4281
-  data.tar.gz: 895b1932e18b95325d7ae03707d86db28e8fdc4b2a816a2e0d66c75b7a9352cce7bb775fd4508677e32767670eb823fd8a25fdde91395e407f9067ebcdf1febc
+  metadata.gz: e45f476441a66d51c1f16090e71e6b2cfd34e4e5edde277166dd22f9665743efa3551fb81e9128becdc3240212c92fcb11717e4f44d34a03847e2f0c6b006201
+  data.tar.gz: fad708bfd76fa145e89c1b1dc841e397e73891695e566489d0c92087652591956ce24b004930814c6155ae130d433fe7f4af3499ff39e86accb6b1b9f514063b

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/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/README.md

@@ -1,7 +1,9 @@
-# wikibase_representable
+# WikibaseRepresentable
 
 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 and fluently accessing their properties.
 
+For an overview of the Wikibase data model, see [Wikibase/DataModel](https://www.mediawiki.org/wiki/Wikibase/DataModel) on mediawiki.org.
+
 ## Installation
 Install the gem and add to the application's Gemfile by executing:
 

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

@@ -24,12 +24,12 @@ module WikibaseRepresentable
         @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

@@ -15,26 +15,24 @@ module WikibaseRepresentable
 
       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
+      def initialize(**kwargs)
+        @type = ENTITY_TYPE
+        @id = kwargs[:id]
+        @labels = kwargs[:labels] || TermList.new
+        @descriptions = kwargs[:descriptions] || TermList.new
+        @alias_groups = kwargs[:alias_groups] || AliasGroupList.new
+        @site_links = kwargs[:site_links] || SiteLinkList.new
+        @statements = kwargs[:statements] || StatementList.new
       end
 
       def label(language_code)
         @labels.value_for_language(language_code)
       end
 
+      def aliases_for_language(language_code)
+        @alias_groups.aliases_for_language(language_code)
+      end
+
       def statements_by_property_id(property_id)
         @statements.statements_by_property_id(property_id)
       end
@@ -43,10 +41,6 @@ module WikibaseRepresentable
         @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
@@ -59,15 +53,12 @@ module WikibaseRepresentable
         @labels.empty? && @descriptions.empty? && @alias_groups.empty? && @site_links.empty? && @statements.empty?
       end
 
+      def state
+        [@type, @id, @labels, @descriptions, @alias_groups, @site_links, @statements]
+      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)
@@ -77,7 +68,6 @@ module WikibaseRepresentable
       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

@@ -13,20 +13,14 @@ module WikibaseRepresentable
 
       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
+      def initialize(**kwargs)
+        @type = ENTITY_TYPE
+        @data_type = kwargs[:data_type]
+        @id = kwargs[:id]
+        @labels = kwargs[:labels] || TermList.new
+        @descriptions = kwargs[:descriptions] || TermList.new
+        @alias_groups = kwargs[:alias_groups] || AliasGroupList.new
+        @statements = kwargs[:statements] || StatementList.new
       end
 
       def label(language_code, value)
@@ -45,15 +39,12 @@ module WikibaseRepresentable
         @labels.empty? && @descriptions.empty? && @alias_groups.empty? && @statements.empty?
       end
 
+      def state
+        [@type, @id, @data_type, @labels, @descriptions, @alias_groups, @statements]
+      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/statement.rb

@@ -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)
@@ -43,22 +34,16 @@ module WikibaseRepresentable
         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 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

@@ -12,13 +12,8 @@ module WikibaseRepresentable
         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

@@ -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/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

@@ -36,15 +36,12 @@ module WikibaseRepresentable
         @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/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module WikibaseRepresentable
-  VERSION = '0.1.2'
+  VERSION = '0.1.4'
 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.2
+  version: 0.1.4
 platform: ruby
 authors:
 - Michael Holloway
 bindir: exe
 cert_chain: []
-date: 2025-01-05 00:00:00.000000000 Z
+date: 2025-01-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: multi_json
@@ -52,75 +52,61 @@ 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
-  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
+  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: rubocop-rake
+  name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.6'
+        version: '3.13'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.6'
+        version: '3.13'
 - !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:
@@ -130,6 +116,8 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".rubocop.yml"
+- ".rubocop_todo.yml"
+- LICENSE.txt
 - README.md
 - Rakefile
 - lib/wikibase_representable.rb
@@ -170,6 +158,7 @@ files:
 - 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