renshuu 0.2.0 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a43b493faf4ee0d7165c0a6a054f04a1f2e50ecb60d81c1e9226bea9c6be3643
-  data.tar.gz: 71e85c4b84336960eddd66b525167528495ba04fb26f340d6a022aa3bf5d5cff
+  metadata.gz: df6e1af568b7bb56df71d9bd55a92b9a64e0319e4a0daa6df5afec0a4c2d905e
+  data.tar.gz: 06fe422633574facfb49f0c9fbc53b52969026fe9df4fd8f50cf7904768ab379
 SHA512:
-  metadata.gz: a848a7d5c6615157835467a7e564bfe201c13dfbf9f8ffc4ea26d6f15b3f292df68f042f3b0dd352391a8d6ba1577fdd2c68635946cd811aae15ba06b94ad89e
-  data.tar.gz: e3eed0edab20ad32adba4042a6a4d4728c23fceb035ac2ba81704a64952e5aa1ff7ac6026ae2d7ac2bfbc59d6d5cf5aa7ebaa0b73893ecbd16dec7196d33b146
+  metadata.gz: 73dd997e5c0ef3fcd15de076192d660ee36158f7ac8bc54a54d3ce98281358595ae5b9523a8918fd66d2e5a9ebedd04d24c345137fe54e3b2f851ae5733f6813
+  data.tar.gz: 2c639cbe92edd74939c8b9ca2785c64a68b0d827c61f50d638e26605dff70169c1354893fc2a05ff976e4d6a40e5530145889520691555d18719caf714a1050d

data/.rubocop.yml

@@ -26,4 +26,4 @@ RSpec/NestedGroups:
   Max: 4
 RSpec/SpecFilePathFormat:
   Exclude:
-    - spec/renshuu/models/*_spec.rb
+    - spec/renshuu/models/**/*_spec.rb

data/CHANGELOG.md

@@ -1,5 +1,12 @@
 # Changelog
 
+## [1.0.0] - 2025-12-09
+
+### Added
+
+- Schedules
+- Lists
+
 ## [0.2.0] - 2025-12-03
 
 ### Added

data/README.md

@@ -2,7 +2,16 @@
 
 Ruby wrapper for [Renshuu], the Japanese learning platform.
 
+[![Pipeline status badge][pipeline]][pipelines]
+[![Coverage badge][coverage]][pipelines]
+[![Latest release badge][latest-release]][releases]
+
 [Renshuu]: https://renshuu.org
+[pipeline]: https://gitlab.com/Richard-Degenne/renshuu/badges/dev/pipeline.svg?ignore_skipped=true
+[pipelines]: https://gitlab.com/Richard-Degenne/renshuu/-/pipelines/
+[coverage]: https://gitlab.com/Richard-Degenne/renshuu/badges/dev/coverage.svg
+[latest-release]: https://gitlab.com/Richard-Degenne/renshuu/-/badges/release.svg
+[releases]: https://gitlab.com/Richard-Degenne/renshuu/-/releases/
 
 ## Installation
 
@@ -99,6 +108,82 @@ word = Renshuu::Word.get(370)
 word.sentences
 ```
 
+### Study lists
+
+```ruby
+# Lists the user's study lists
+Renshuu::Schedule.list
+
+# Retrieves a specific list
+Renshuu::Schedule.get(36555)
+
+# Retrieves the contents of a list
+list = Renshuu::Schedule.get(36555)
+list.contents
+list.contents(page: 2, group: :review_today)
+
+# Manage list content
+kanji = Renshuu::Kanji.get('食')
+kanji.add_to_list(list)
+kanji.remove_from_list(list)
+# Or
+list.add(kanji)
+list.remove(kanji)
+
+word = Renshuu::Word.get(370)
+word.add_to_list(list)
+word.remove_from_list(list)
+# Or
+list.add(word)
+list.remove(word)
+
+grammar = Renshuu::Grammar.get(927)
+grammar.add_to_list(list)
+grammar.remove_from_list(list)
+# Or
+list.add(grammar)
+list.remove(grammar)
+```
+
+### Lists
+
+```ruby
+# Lists the user's lists
+Renshuu::List.list
+
+# Retrieves the contents of a list
+list = Renshuu::List.list.first.lists.first # Browsing the list groups
+list.contents
+list.contents(page: 2)
+
+# Manage list content
+kanji = Renshuu::Kanji.get('食')
+kanji.add_to_list(list)
+kanji.remove_from_list(list)
+# Or
+list.add(kanji)
+list.remove(kanji)
+
+word = Renshuu::Word.get(370)
+word.add_to_list(list)
+word.remove_from_list(list)
+# Or
+list.add(word)
+list.remove(word)
+
+grammar = Renshuu::Grammar.get(927)
+grammar.add_to_list(list)
+grammar.remove_from_list(list)
+# Or
+list.add(grammar)
+list.remove(grammar)
+```
+
+## Documentation
+
+A comprehensive documenation is available at
+<https://renshuu.richarddegenne.fr>.
+
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run

data/lib/renshuu/models/grammar.rb

@@ -4,6 +4,9 @@ module Renshuu
   ##
   # Model class for grammar entries.
   class Grammar < Model
+    include Schedulable
+    include Listable
+
     ##
     # Searches the grammar dictionary.
     #
@@ -65,11 +68,15 @@ module Renshuu
     ##
     # @!attribute [r] models
     #   @return [Array<Model>]
-    attribute :models, Types::Array.of(Model)
+    attribute(:models, Types::Array.of(Model).default { [] })
 
     ##
     # @!attribute [r] user_data
-    #   @return [UserData]
-    attribute :user_data, UserData
+    #   @return [UserData, nil]
+    attribute? :user_data, UserData
+    ##
+    # @!attribute [r] presence
+    #   @return [Presence, nil]
+    attribute? :presence, Presence
   end
 end

data/lib/renshuu/models/kanji.rb

@@ -6,6 +6,9 @@ module Renshuu
   #
   # @see https://api.renshuu.org/docs/#/Kanji
   class Kanji < Model
+    include Schedulable
+    include Listable
+
     ##
     # Searches the Renshuu kanji dictionary.
     #
@@ -102,58 +105,9 @@ module Renshuu
     # @!attribute [r] user_data
     #   @return [UserData, nil]
     attribute? :user_data, UserData
-
     ##
-    # Model class for kanji presence.
-    class Presence < Model
-      ##
-      # Model class for kanji schedule presence.
-      class Schedule < Model
-        ##
-        # @!attribute [r] sched_id
-        #   @return [String]
-        attribute :sched_id, Types::String
-        alias schedule_id sched_id
-        ##
-        # @!attribute [r] name
-        #   @return [String]
-        attribute :name, Types::String
-        ##
-        # @!attribute [r] has_word
-        #   @return [Boolean]
-        attribute :has_word, Types::Params::Bool
-      end
-      ##
-      # @!attribute [r] scheds
-      #   @return [Array<Schedule>]
-      attribute :scheds, Types::Array.of(Schedule)
-      alias schedules scheds
-
-      ##
-      # Model class for kanji list presence.
-      class List < Model
-        ##
-        # @!attribute [r] list_id
-        #   @return [String]
-        attribute :list_id, Types::String
-        ##
-        # @!attribute [r] name
-        #   @return [String]
-        attribute :name, Types::String
-        ##
-        # @!attribute [r] set_name
-        #   @return [String, nil]
-        attribute? :set_name, Types::String
-        ##
-        # @!attribute [r] has_word
-        #   @return [Boolean]
-        attribute :has_word, Types::Params::Bool
-      end
-      ##
-      # @!attribute [r] lists
-      #   @return [Array<List>]
-      attribute :lists, Types::Array.of(List)
-    end
+    # @!attribute [r] presence
+    #   @return [Presence, nil]
     attribute? :presence, Presence
   end
 end

data/lib/renshuu/models/list.rb

@@ -0,0 +1,138 @@
+# frozen_string_literal: true
+
+module Renshuu
+  ##
+  # Model class for lists.
+  #
+  # @see https://api.renshuu.org/docs/#/User
+  class List < Model
+    ##
+    # Mapping between list termtypes and model classes.
+    #
+    # @see #term_class
+    TERMTYPES = {
+      'kanji' => Kanji, 'vocab' => Word, 'grammar' => Grammar,
+      'sent' => Sentence
+    }.freeze
+
+    ##
+    # Retrives list groups from the API.
+    #
+    # @return [Array<Group>]
+    def self.list
+      body = Renshuu.client.query(:get, 'v1/lists')
+
+      body.fetch(:termtype_groups).flat_map do |termtype_group|
+        termtype = termtype_group.fetch(:termtype)
+        termtype_group.fetch(:groups).map { Group.new(termtype:, **_1) }
+      end
+    end
+
+    ##
+    # Model class for list groups, _a.k.a._ sets.
+    class Group < Model
+      ##
+      # @!attribute [r] group_title
+      #   @return [String]
+      attribute :group_title, Types::String
+      alias title group_title
+      ##
+      # @!attribute [r] termtype
+      #   @return [String]
+      attribute :termtype, Types::String
+
+      ##
+      # @!attribute [r] lists
+      #   @return [Array<List>]
+      attribute :lists, Types::Array.of(List)
+    end
+
+    ##
+    # @!attribute [r] list_id
+    #   @return [String]
+    attribute :list_id, Types::String
+    alias id list_id
+    ##
+    # @!attribute [r] termtype
+    #   @return [String]
+    attribute :termtype, Types::String
+    ##
+    # @!attribute [r] title
+    #   @return [String]
+    attribute :title, Types::String
+    ##
+    # @!attribute [r] description
+    #   @return [String]
+    attribute :description, Types::String
+    ##
+    # @!attribute [r] num_terms
+    #   @return [Integer]
+    attribute :num_terms, Types::Integer
+    ##
+    # @!attribute [r] privacy
+    #   @return [String]
+    attribute :privacy, Types::String
+
+    ##
+    # Retrieves terms contained in the list.
+    #
+    # @param [Integer, nil] page
+    #
+    # @return [Array<Kanji,Word,Grammar,Sentence>] Depending on the type of list
+    def contents(page: nil)
+      params = { pg: page }.compact
+      body = Renshuu.client.query(:get, "v1/list/#{id}", params:)
+
+      body.dig(:contents, :terms).map { term_class.new(_1) }
+    end
+
+    ##
+    # Adds the given item to the list.
+    #
+    # @param [Listable] item
+    #
+    # @return [Void]
+    # @raise [ArgumentError] If the type of the item does not match the
+    #   list's type
+    #
+    # @see Listable#add_to_list
+    def add(item)
+      unless item.is_a?(term_class)
+        raise ArgumentError, "Expected a `#{term_class}`, got a `#{item.class}`"
+      end
+
+      item.add_to_list(self)
+    end
+
+    ##
+    # Removes the given item from the list.
+    #
+    # @param [Listable] item
+    #
+    # @return [Void]
+    # @raise [ArgumentError] If the type of the item does not match the
+    #   list's type
+    #
+    # @see Listable#remove_from_list
+    def remove(item)
+      unless item.is_a?(term_class)
+        raise ArgumentError, "Expected a `#{term_class}`, got a `#{item.class}`"
+      end
+
+      item.remove_from_list(self)
+    end
+
+    ##
+    # Model class to use for this list's terms.
+    #
+    # @return [Class]
+    # @raise [KeyError]
+    #
+    # @see ::TERMTYPES
+    def term_class
+      @term_class ||= TERMTYPES.fetch(termtype) do |key|
+        raise KeyError, "Unkown list type `#{key}`"
+      end
+    end
+  end
+end

data/lib/renshuu/models/mixins/listable.rb

@@ -0,0 +1,69 @@
+# frozen_string_literal: true
+
+module Renshuu
+  ##
+  # Mixin for items that can be added to study {List}s.
+  #
+  # = Interface
+  #
+  # This mixin rely on the following interface:
+  #
+  # * +#id+: Identifier of the listable item;
+  # * +.base_route+: Path part used in URL construction.
+  module Listable
+    def self.included(base) # :nodoc:
+      super
+
+      base.extend(ClassMethods)
+    end
+
+    ##
+    # Adds the item to the given list.
+    #
+    # @param [List, String] list
+    #
+    # @return [Void]
+    def add_to_list(list)
+      list_id = case list
+      when List then list.id
+      else list
+      end
+
+      Renshuu.client.query(
+        :put, "v1/#{self.class.base_route}/#{id}", params: { list_id: }
+      )
+    end
+
+    ##
+    # Removes the item from the given list.
+    #
+    # @param [List, String] list
+    #
+    # @return [Void]
+    def remove_from_list(list)
+      list_id = case list
+      when List then list.id
+      else list
+      end
+
+      Renshuu.client.query(
+        :delete, "v1/#{self.class.base_route}/#{id}", params: { list_id: }
+      )
+    end
+
+    ##
+    # Module for class methods provided with the mixin.
+    module ClassMethods
+      ##
+      # Path part used in URL construction.
+      #
+      # Defaults to the class name, demodulized and underscored. Override to
+      # change behavior.
+      #
+      # @return [String]
+      def base_route
+        name.demodulize.underscore
+      end
+    end
+  end
+end

data/lib/renshuu/models/mixins/schedulable.rb

@@ -0,0 +1,69 @@
+# frozen_string_literal: true
+
+module Renshuu
+  ##
+  # Mixin for items that can be added to study {Schedule}s.
+  #
+  # = Interface
+  #
+  # This mixin rely on the following interface:
+  #
+  # * +#id+: Identifier of the schedulable item;
+  # * +.base_route+: Path part used in URL construction.
+  module Schedulable
+    def self.included(base)
+      super
+
+      base.extend(ClassMethods)
+    end
+
+    ##
+    # Adds the item to the given schedule.
+    #
+    # @param [Schedule, String] schedule
+    #
+    # @return [Void]
+    def add_to_schedule(schedule)
+      sched_id = case schedule
+      when Schedule then schedule.id
+      else schedule
+      end
+
+      Renshuu.client.query(
+        :put, "v1/#{self.class.base_route}/#{id}", params: { sched_id: }
+      )
+    end
+
+    ##
+    # Removes the item from the given schedule.
+    #
+    # @param [Schedule, String] schedule
+    #
+    # @return [Void]
+    def remove_from_schedule(schedule)
+      sched_id = case schedule
+      when Schedule then schedule.id
+      else schedule
+      end
+
+      Renshuu.client.query(
+        :delete, "v1/#{self.class.base_route}/#{id}", params: { sched_id: }
+      )
+    end
+
+    ##
+    # Module for class methods provided with the mixin.
+    module ClassMethods
+      ##
+      # Path part used in URL construction.
+      #
+      # Defaults to the class name, demodulized and underscored. Override to
+      # change behavior.
+      #
+      # @return [String]
+      def base_route
+        name.demodulize.underscore
+      end
+    end
+  end
+end

data/lib/renshuu/models/presence.rb

@@ -0,0 +1,66 @@
+# frozen_string_literal: true
+
+module Renshuu
+  ##
+  # Model class for term presence.
+  class Presence < Model
+    ##
+    # Model class for schedule presence.
+    class Schedule < Model
+      ##
+      # @!attribute [r] sched_id
+      #   @return [String]
+      attribute :sched_id, Types::String
+      alias schedule_id sched_id
+      ##
+      # @!attribute [r] name
+      #   @return [String]
+      attribute :name, Types::String
+      ##
+      # @!attribute [r] has_word
+      #   @return [Boolean]
+      attribute :has_word, Types::Params::Bool
+      alias has_word? has_word
+
+      ##
+      # Retrieves the schedule associated with this presence item.
+      #
+      # @return [Renshuu::Schedule]
+      #
+      # @see Renshuu::Schedule.get
+      def schedule
+        Renshuu::Schedule.get(schedule_id)
+      end
+    end
+    ##
+    # @!attribute [r] scheds
+    #   @return [Array<Schedule>]
+    attribute(:scheds, Types::Array.of(Schedule).default { [] })
+    alias schedules scheds
+
+    ##
+    # Model class for list presence.
+    class List < Model
+      ##
+      # @!attribute [r] list_id
+      #   @return [String]
+      attribute :list_id, Types::String
+      ##
+      # @!attribute [r] name
+      #   @return [String]
+      attribute :name, Types::String
+      ##
+      # @!attribute [r] set_name
+      #   @return [String, nil]
+      attribute? :set_name, Types::String
+      ##
+      # @!attribute [r] has_word
+      #   @return [Boolean]
+      attribute :has_word, Types::Params::Bool
+    end
+    ##
+    # @!attribute [r] lists
+    #   @return [Array<List>]
+    attribute(:lists, Types::Array.of(List).default { [] })
+  end
+end

data/lib/renshuu/models/schedule.rb

@@ -0,0 +1,208 @@
+# frozen_string_literal: true
+
+module Renshuu
+  ##
+  # Model class for schedules.
+  #
+  # @see https://api.renshuu.org/docs/#/Schedules
+  class Schedule < Model
+    ##
+    # Mapping between schedule booktypes and model classes.
+    #
+    # @see #term_class
+    BOOKTYPES = {
+      'kanji' => Kanji, 'vocab' => Word, 'grammar' => Grammar,
+      'sent' => Sentence
+    }.freeze
+
+    ##
+    # Lists all schedules of the current user.
+    #
+    # @return [Array<Schedule>]
+    #
+    # @see https://api.renshuu.org/docs/#/Schedules/get_schedule
+    def self.list
+      body = Renshuu.client.query(:get, 'v1/schedule')
+
+      body.fetch(:schedules).map { new(_1) }
+    end
+
+    ##
+    # Retrieves a specific schedule from the API.
+    #
+    # @param [String, Integer] id
+    # @return [Schedule]
+    #
+    # @see https://api.renshuu.org/docs/#/Schedules/get_schedule__id_
+    def self.get(id)
+      body = Renshuu.client.query(:get, "v1/schedule/#{id}")
+
+      body.fetch(:schedules).first.then { new(_1) }
+    end
+
+    ##
+    # @!attribute [r] id
+    #   @return [String]
+    attribute :id, Types::String
+    ##
+    # @!attribute [r] name
+    #   @return [String]
+    attribute :name, Types::String
+    ##
+    # @!attribute [r] booktype
+    #   @return [String]
+    attribute :booktype, Types::String
+    ##
+    # @!attribute [r] is_frozen
+    #   @return [Boolean]
+    attribute :is_frozen, Types::Params::Bool
+
+    ##
+    # Model class for schedules today counts.
+    class TodayCount < Model
+      transform_keys do |key|
+        key == :new ? :new_terms : key
+      end
+
+      ##
+      # @!attribute [r] review
+      #   @return [Integer]
+      attribute :review, Types::Integer
+      ##
+      # @!attribute [r] new_terms
+      #   @note +new+ is a reserved keyword, so we have to circumvent that.
+      #   @return [Integer]
+      attribute :new_terms, Types::Integer
+    end
+    ##
+    # @!attribute [r] today
+    #   rn [TodayCount]
+    attribute :today, TodayCount
+
+    ##
+    # Model class for schedule upcoming counts.
+    class UpcomingCount < Model
+      ##
+      # @!attribute [r] days_in_future
+      #   @return [Integer]
+      attribute :days_in_future, Types::Integer
+      ##
+      # @!attribute [r] terms_to_review
+      #   @return [Integer]
+      attribute :terms_to_review, Types::Integer
+    end
+    ##
+    # @!attribute [r] upcoming
+    #   @return [Array<UpcomingCount>]
+    attribute :upcoming, Types::Array.of(UpcomingCount)
+
+    ##
+    # Model class for schedule term counts.
+    class TermCount < Model
+      ##
+      # @!attribute [r] total_count
+      #   @return [Integer]
+      attribute :total_count, Types::Integer
+      ##
+      # @!attribute [r] studied_count
+      #   @return [Integer]
+      attribute :studied_count, Types::Integer
+      ##
+      # @!attribute [r] unstudied_count
+      #   @return [Integer]
+      attribute :unstudied_count, Types::Integer
+      ##
+      # @!attribute [r] hidden_count
+      #   @return [Integer]
+      attribute :hidden_count, Types::Integer
+    end
+    ##
+    # @!attribute [r] terms
+    #   @return [TermCount]
+    attribute :terms, TermCount
+
+    ##
+    # Model class for schedule new term counts.
+    class NewTermCount < Model
+      ##
+      # @!attribute [r] today_count
+      #   @return [Integer]
+      attribute :today_count, Types::Integer
+      ##
+      # @!attribute [r] rolling_week_count
+      #   @return [Integer]
+      attribute :rolling_week_count, Types::Integer
+    end
+    ##
+    # @!attribute [r] new_terms
+    #   @return [NewTermCount]
+    attribute :new_terms, NewTermCount
+
+    ##
+    # Retrieves the terms contained in the schedule.
+    #
+    # @param [Integer, nil] page
+    # @param [Symbol, nil] group One of +:all+, +:blocked+, +:studied+,
+    #   +:notyetstudied+, +:cannot_study+, +:review_today+, +:mastery_1+,
+    #   +:mastery_2+, +:mastery_3+, +:mastery_4+, +:mastery_5+, +:mastery_6+,
+    #   +:mastery_7+, +:mastery_8+ or +:mastery_9+.
+    #
+    # @return [Array<Kanji,Word,Grammar,Sentence>] Depending on the type of
+    #   schedule
+    def contents(page: nil, group: nil)
+      params =  { pg: page, group: }.compact
+      body = Renshuu.client.query(:get, "v1/schedule/#{id}/list", params:)
+
+      body.dig(:contents, :terms).map { term_class.new(_1) }
+    end
+
+    ##
+    # Adds the given item to the schedule.
+    #
+    # @param [Schedulable] item
+    #
+    # @return [Void]
+    # @raise [ArgumentError] If the type of the item does not match the
+    #   schedule's type
+    #
+    # @see Schedulable#add_to_schedule
+    def add(item)
+      unless item.is_a?(term_class)
+        raise ArgumentError, "Expected a `#{term_class}`, got a `#{item.class}`"
+      end
+
+      item.add_to_schedule(self)
+    end
+
+    ##
+    # Removes the given item from the schedule.
+    #
+    # @param [Schedulable] item
+    #
+    # @return [Void]
+    # @raise [ArgumentError] If the type of the item does not match the
+    #   schedule's type
+    #
+    # @see Schedulable#remove_from_schedule
+    def remove(item)
+      unless item.is_a?(term_class)
+        raise ArgumentError, "Expected a `#{term_class}`, got a `#{item.class}`"
+      end
+
+      item.remove_from_schedule(self)
+    end
+
+    ##
+    # Model class to use for this schedule's terms.
+    #
+    # @return [Class]
+    # @raise [KeyError]
+    #
+    # @see ::BOOKTYPES
+    def term_class
+      @term_class ||= BOOKTYPES.fetch(booktype) do |key|
+        raise KeyError, "Unkown schedule type `#{key}`"
+      end
+    end
+  end
+end

data/lib/renshuu/models/sentence.rb

@@ -46,8 +46,8 @@ module Renshuu
     attribute :japanese, Types::String
     ##
     # @!attribute [r] hiragana
-    #   @return [String]
-    attribute :hiragana, Types::String
+    #   @return [String, nil]
+    attribute? :hiragana, Types::String
     ##
     # @!attribute [r] meaning
     #   @return [Hash{String => String}]

data/lib/renshuu/models/types.rb

@@ -9,12 +9,11 @@ module Renshuu
     ##
     # Dry type for dates.
     Date = Constructor(::Date) do |date|
-      if date.is_a?(::Date)
-        date
-      elsif date == 'Not yet'
-        nil
-      else
-        ::Date.parse(date)
+      case date
+      when ::Date then date
+      when 'Not yet' then nil
+      when 'Now' then ::Date.today
+      else ::Date.parse(date)
       end
     end
 

data/lib/renshuu/models/user_data.rb

@@ -15,7 +15,7 @@ module Renshuu
     ##
     # @!attribute [r] mastery_avg_perc
     #   @return [Integer]
-    attribute :mastery_avg_perc, Types::Integer
+    attribute :mastery_avg_perc, Types::Integer.fallback(0)
 
     ##
     # Model class for user data study vectors.

data/lib/renshuu/models/word.rb

@@ -6,6 +6,9 @@ module Renshuu
   #
   # @see https://api.renshuu.org/docs/#/Vocabulary
   class Word < Model
+    include Schedulable
+    include Listable
+
     ##
     # Searches the Renshuu vocabulary dictionary.
     #
@@ -44,13 +47,13 @@ module Renshuu
     attribute :hiragana_full, Types::String
     ##
     # @!attribute [r] pic
-    #   @return [Array<URI>, nil]
-    attribute? :pic, Types::Array.of(Types::URI)
+    #   @return [Array<URI>]
+    attribute(:pic, Types::Array.of(Types::URI).default { [] })
     alias pictures pic
     ##
     # @!attribute [r] markers
     #   @return [Array<String>]
-    attribute :markers, Types::Array.of(Types::String)
+    attribute(:markers, Types::Array.of(Types::String).default { [] })
     ##
     # @!attribute [r] pitch
     #   @return [Array<String>]
@@ -69,6 +72,10 @@ module Renshuu
     # @!attribute [r] user_data
     #   @return [UserData, nil]
     attribute? :user_data, UserData
+    ##
+    # @!attribute [r] presence
+    #   @return [Presence, nil]
+    attribute? :presence, Presence
 
     ##
     # Retrieves sentences using this word from the dictionary.

data/lib/renshuu/models.rb

@@ -6,10 +6,15 @@ end
 # Types
 require_relative 'models/types'
 
+# Mixins
+require_relative 'models/mixins/listable'
+require_relative 'models/mixins/schedulable'
+
 # Base class
 require_relative 'models/model'
 
 # Other models (respect blank lines for dependency order)
+require_relative 'models/presence'
 require_relative 'models/user_data'
 
 require_relative 'models/grammar'
@@ -17,3 +22,6 @@ require_relative 'models/kanji'
 require_relative 'models/profile'
 require_relative 'models/sentence'
 require_relative 'models/word'
+
+require_relative 'models/list'
+require_relative 'models/schedule'

data/lib/renshuu/version.rb

@@ -3,5 +3,5 @@
 module Renshuu
   ##
   # Semantic version number of the library.
-  VERSION = '0.2.0'
+  VERSION = '1.0.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: renshuu
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 1.0.0
 platform: ruby
 authors:
 - Richard Degenne
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2025-12-03 00:00:00.000000000 Z
+date: 2025-12-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: dry-struct
@@ -62,8 +62,13 @@ files:
 - lib/renshuu/models.rb
 - lib/renshuu/models/grammar.rb
 - lib/renshuu/models/kanji.rb
+- lib/renshuu/models/list.rb
+- lib/renshuu/models/mixins/listable.rb
+- lib/renshuu/models/mixins/schedulable.rb
 - lib/renshuu/models/model.rb
+- lib/renshuu/models/presence.rb
 - lib/renshuu/models/profile.rb
+- lib/renshuu/models/schedule.rb
 - lib/renshuu/models/sentence.rb
 - lib/renshuu/models/types.rb
 - lib/renshuu/models/user_data.rb