wikibase_representable 0.1.0

data/lib/wikibase_representable/model/time_value.rb

@@ -0,0 +1,55 @@
+# frozen_string_literal: true
+
+require 'wikibase_representable/model/data_value'
+
+module WikibaseRepresentable
+  module Model
+    # Data value object that represents a time value.
+    class TimeValue < DataValue
+      TYPE = 'time'
+
+      def initialize(value: nil)
+        super(type: TYPE, value: value)
+      end
+
+      def time
+        @value.time
+      end
+
+      def time_zone
+        @value.time_zone
+      end
+
+      def before
+        @value.before
+      end
+
+      def after
+        @value.after
+      end
+
+      def precision
+        @value.precision
+      end
+
+      def calendar_model
+        @value.calendar_model
+      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
+      end
+
+      def eql?(other)
+        self == other
+      end
+    end
+  end
+end

data/lib/wikibase_representable/model.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+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/data_value'
+require 'wikibase_representable/model/entity_id'
+require 'wikibase_representable/model/entity_id_value'
+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/statement'
+require 'wikibase_representable/model/statement_list'
+require 'wikibase_representable/model/term'
+require 'wikibase_representable/model/term_list'
+require 'wikibase_representable/model/time_value'
+require 'wikibase_representable/model/time'

data/lib/wikibase_representable/representers/alias_group_list_representer.rb

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

data/lib/wikibase_representable/representers/data_value_representer.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+require 'representable/json'
+
+module WikibaseRepresentable
+  module Representers
+    # Representer for data values
+    class DataValueRepresenter < Representable::Decorator
+      include Representable::JSON
+
+      property :value
+      property :type
+    end
+  end
+end

data/lib/wikibase_representable/representers/entity_id_representer.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+require 'representable/json'
+
+module WikibaseRepresentable
+  module Representers
+    # Representer for data values representing entity IDs
+    class EntityIdRepresenter < Representable::Decorator
+      include Representable::JSON
+
+      property :entity_type, as: 'entity-type'
+      property :numeric_id, as: 'numeric-id'
+      property :id
+    end
+  end
+end

data/lib/wikibase_representable/representers/entity_id_value_representer.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+require 'representable/json'
+require 'wikibase_representable/model'
+require 'wikibase_representable/representers/entity_id_representer'
+
+module WikibaseRepresentable
+  module Representers
+    # Representer for data values referring to entity IDs
+    class EntityIdValueRepresenter < Representable::Decorator
+      include Representable::JSON
+      include WikibaseRepresentable::Model
+
+      property :value, decorator: EntityIdRepresenter, class: EntityId
+      property :type
+    end
+  end
+end

data/lib/wikibase_representable/representers/item_representer.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+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'
+
+module WikibaseRepresentable
+  module Representers
+    # Representer for Wikibase items
+    class ItemRepresenter < Representable::Decorator
+      include Representable::JSON
+      include WikibaseRepresentable::Model
+
+      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
+    end
+  end
+end

data/lib/wikibase_representable/representers/property_representer.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+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'
+
+module WikibaseRepresentable
+  module Representers
+    # Representer for Wikibase properties
+    class PropertyRepresenter < Representable::Decorator
+      include Representable::JSON
+      include WikibaseRepresentable::Model
+
+      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
+    end
+  end
+end

data/lib/wikibase_representable/representers/property_value_snak_representer.rb

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+require 'representable/json'
+require 'wikibase_representable/model'
+require 'wikibase_representable/representers/data_value_representer'
+require 'wikibase_representable/representers/entity_id_value_representer'
+require 'wikibase_representable/representers/time_value_representer'
+
+module WikibaseRepresentable
+  module Representers
+    # Representer for property value snaks.
+    class PropertyValueSnakRepresenter < Representable::Decorator
+      include Representable::JSON
+      include WikibaseRepresentable::Model
+
+      property :type, as: 'snaktype'
+      property :property_id, as: 'property'
+      property :hash
+      property :data_value, as: 'datavalue', decorator: lambda { |input:, **|
+        if input.is_a? EntityIdValue
+          EntityIdValueRepresenter
+        elsif input.is_a? TimeValue
+          TimeValueRepresenter
+        else
+          DataValueRepresenter
+        end
+      }, class: lambda { |input:, **|
+        if input['type'] == EntityIdValue::TYPE
+          EntityIdValue
+        elsif input['type'] == TimeValue::TYPE
+          TimeValue
+        else
+          DataValue
+        end
+      }
+
+      collection_representer class: PropertyValueSnak
+    end
+  end
+end

data/lib/wikibase_representable/representers/site_link_list_representer.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+require 'representable/json/hash'
+require 'wikibase_representable/model'
+require 'wikibase_representable/representers/site_link_representer'
+
+module WikibaseRepresentable
+  module Representers
+    # Representer for a hash of (siteid => sitelink)
+    class SiteLinkListRepresenter < Representable::Decorator
+      include Representable::JSON::Hash
+      include WikibaseRepresentable::Model
+
+      values decorator: SiteLinkRepresenter, class: SiteLink
+    end
+  end
+end

data/lib/wikibase_representable/representers/site_link_representer.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+require 'representable/json'
+
+module WikibaseRepresentable
+  module Representers
+    # Representer for sitelink objects
+    class SiteLinkRepresenter < Representable::Decorator
+      include Representable::JSON
+
+      property :site_id, as: 'siteid'
+      property :page_name, as: 'pagename'
+      collection :badges
+    end
+  end
+end

data/lib/wikibase_representable/representers/snak_list_representer.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+require 'representable/json/hash'
+require 'wikibase_representable/representers/property_value_snak_representer'
+
+module WikibaseRepresentable
+  module Representers
+    # Representer for a list of property value snaks.
+    class SnakListRepresenter < Representable::Decorator
+      include Representable::JSON::Hash
+
+      values decorator: PropertyValueSnakRepresenter.for_collection, instance: ->(_fragment) { [] }
+    end
+  end
+end

data/lib/wikibase_representable/representers/statement_list_representer.rb

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

data/lib/wikibase_representable/representers/statement_representer.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+require 'representable/json'
+require 'wikibase_representable/model'
+require 'wikibase_representable/representers/property_value_snak_representer'
+require 'wikibase_representable/representers/snak_list_representer'
+
+module WikibaseRepresentable
+  module Representers
+    # Representer for a Wikibase statement (aka claim)
+    class StatementRepresenter < Representable::Decorator
+      include Representable::JSON
+      include WikibaseRepresentable::Model
+
+      property :main_snak, as: 'mainsnak',
+                           decorator: PropertyValueSnakRepresenter,
+                           class: PropertyValueSnak
+      property :type
+      property :qualifiers, decorator: SnakListRepresenter,
+                            class: SnakList
+      property :qualifiers_order, as: 'qualifiers-order'
+      property :guid, as: 'id'
+      property :rank
+
+      collection_representer class: Statement
+    end
+  end
+end

data/lib/wikibase_representable/representers/term_list_representer.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+require 'representable/json/hash'
+require 'wikibase_representable/model'
+require 'wikibase_representable/representers/term_representer'
+
+module WikibaseRepresentable
+  module Representers
+    # Representer for term lists
+    class TermListRepresenter < Representable::Decorator
+      include Representable::JSON::Hash
+      include WikibaseRepresentable::Model
+
+      values decorator: TermRepresenter, class: Term
+    end
+  end
+end

data/lib/wikibase_representable/representers/term_representer.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+require 'representable/json'
+require 'wikibase_representable/model'
+
+module WikibaseRepresentable
+  module Representers
+    # Representer for a term object
+    class TermRepresenter < Representable::Decorator
+      include Representable::JSON
+      include WikibaseRepresentable::Model
+
+      property :language_code, as: 'language'
+      property :value
+
+      collection_representer class: Term
+    end
+  end
+end

data/lib/wikibase_representable/representers/time_representer.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+require 'representable/json'
+
+module WikibaseRepresentable
+  module Representers
+    # Representer for time objects
+    class TimeRepresenter < Representable::Decorator
+      include Representable::JSON
+
+      property :time
+      property :time_zone, as: 'timezone'
+      property :before
+      property :after
+      property :precision
+      property :calendar_model, as: 'calendarmodel'
+    end
+  end
+end

data/lib/wikibase_representable/representers/time_value_representer.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+require 'wikibase_representable/model'
+require 'wikibase_representable/representers/time_representer'
+
+module WikibaseRepresentable
+  module Representers
+    # Represents a time value object
+    class TimeValueRepresenter < Representable::Decorator
+      include Representable::JSON
+      include WikibaseRepresentable::Model
+
+      property :value, decorator: TimeRepresenter, class: Time
+      property :type
+    end
+  end
+end

data/lib/wikibase_representable/representers.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+require 'wikibase_representable/representers/alias_group_list_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_representer'
+require 'wikibase_representable/representers/snak_list_representer'
+require 'wikibase_representable/representers/statement_list_representer'
+require 'wikibase_representable/representers/statement_representer'
+require 'wikibase_representable/representers/term_list_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

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

data/lib/wikibase_representable.rb

@@ -0,0 +1,4 @@
+# frozen_string_literal: true
+
+require 'wikibase_representable/model'
+require 'wikibase_representable/representers'

metadata

@@ -0,0 +1,195 @@
+--- !ruby/object:Gem::Specification
+name: wikibase_representable
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Michael Holloway
+bindir: exe
+cert_chain: []
+date: 2025-01-04 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: multi_json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.15'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.15'
+- !ruby/object:Gem::Dependency
+  name: representable
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.2'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.5'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        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
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.69'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.69'
+- !ruby/object:Gem::Dependency
+  name: rubocop-rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.6'
+- !ruby/object:Gem::Dependency
+  name: rubocop-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.3'
+description: Provides Wikibase data model classes and support for serializing and
+  deserializing Wikibase entities to and from JSON.
+email:
+- michael@mdholloway.org
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rubocop.yml"
+- README.md
+- Rakefile
+- lib/wikibase_representable.rb
+- lib/wikibase_representable/model.rb
+- lib/wikibase_representable/model/alias_group_list.rb
+- lib/wikibase_representable/model/data_value.rb
+- lib/wikibase_representable/model/entity_id.rb
+- lib/wikibase_representable/model/entity_id_value.rb
+- lib/wikibase_representable/model/item.rb
+- 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/snak_data_value_helper.rb
+- lib/wikibase_representable/model/snak_list.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/term.rb
+- lib/wikibase_representable/model/term_list.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/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_representer.rb
+- lib/wikibase_representable/representers/snak_list_representer.rb
+- lib/wikibase_representable/representers/statement_list_representer.rb
+- lib/wikibase_representable/representers/statement_representer.rb
+- lib/wikibase_representable/representers/term_list_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
+homepage: https://github.com/mdholloway/wikibase_representable
+licenses:
+- MIT
+metadata:
+  rubygems_mfa_required: 'true'
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '3.0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.6.2
+specification_version: 4
+summary: Work with Wikibase data fluently in Ruby
+test_files: []