wikibase_representable 0.1.1 → 0.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ccd5493d0f929bb58a2e3aba367d95f8c0c6e5a595f8b8bb20a6e03867a3205f
-  data.tar.gz: d971a0a5ec30ff38fe8e8390bf6511515b7b44129558ea944efd9006ea65edc4
+  metadata.gz: a9e7e9f706f63881e5d8f7eb250fb378371174ef032ceb653de1d0c18db646d7
+  data.tar.gz: 9b14eba39f961b62bd845c080680a80a139e7ebdf8a6b090d511f405a10e86d1
 SHA512:
-  metadata.gz: 25a9cfb3201769026b95316fb51a620b9dc3a503f8e7684f941428503a0951d0bacb9a4f21a26ddfa0b8804f761718bdd2229b575a706d296c79f54b8d81e0b5
-  data.tar.gz: 6c1c3e3b81a13a6e89407db5d06f086b93e30dcd78a2ac3d769b283d4bbc1c184f4766fcfafd4585c6c745809ef3b4c3c094ca783dacba9f07c1a3ff577d5189
+  metadata.gz: 4b7a916708d995839fd19fe1442c4efdd7b240824ae7ac7fa12750e50f93525f892285a819741bba0800c0269b932e3a5c883f4306942bc0abbe3bcebdf083ab
+  data.tar.gz: 45eeafaa918be62997ba41710b1b29de84b0250f5e5fabd4ca4e8ff6f56e6be5eb263f9b9a885631fb49442aa441175711c55ebd3953e648870a6057196538c3

data/README.md

@@ -1,25 +1,51 @@
-# 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.
+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.
 
-## Install
-```sh
-bundle install
+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:
+
+```bash
+bundle add wikibase_representable
 ```
 
-## Example usage
+If bundler is not being used to manage dependencies, install the gem by executing:
+
+```bash
+gem install wikibase_representable
+```
+
+## Usage
 ```ruby
-# Deserialize an object from JSON
+include WikibaseRepresentable::Model
+include WikibaseRepresentable::Representers
+
+# Deserialize an entity 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
+# Retrieve entity data 
+item.labels('en')
+# => "Douglas Adams"
+
+# Serialize an entity to JSON
 json = ItemRepresenter.new(item).to_json
 # => "{\"type\":\"item\",\"id\":\"Q42\"...
 ```
 
-## Test (run RSpec and RuboCop)
-```sh
-bundle exec rake
-```
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/mdholloway/wikibase_representable.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require 'rake'
+require 'bundler/gem_tasks'
 require 'rspec/core/rake_task'
 require 'rubocop/rake_task'
 

data/lib/wikibase_representable/model/item.rb

@@ -43,10 +43,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
@@ -77,7 +73,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/snak_data_value_helper.rb

@@ -8,10 +8,6 @@ module WikibaseRepresentable
         main_snak.data_value.is_a?(type)
       end
 
-      def data_value
-        data_value.value
-      end
-
       def entity_id_value
         data_value&.value&.id
       end

data/lib/wikibase_representable/model/statement.rb

@@ -43,10 +43,6 @@ 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

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/version.rb

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

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: wikibase_representable
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.3
 platform: ruby
 authors:
 - Michael Holloway
 bindir: exe
 cert_chain: []
-date: 2025-01-04 00:00:00.000000000 Z
+date: 2025-01-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: multi_json