meibo 0.27.0 → 0.28.0

data/lib/meibo/reader.rb

@@ -60,46 +60,46 @@ module Meibo
       each_user_profile.to_a
     end
 
-    def each_academic_session(&block)
-      read_data(:file_academic_sessions, &block)
+    def each_academic_session(&)
+      read_data(:file_academic_sessions, &)
     end
 
-    def each_class(&block)
-      read_data(:file_classes, &block)
+    def each_class(&)
+      read_data(:file_classes, &)
     end
 
-    def each_course(&block)
-      read_data(:file_courses, &block)
+    def each_course(&)
+      read_data(:file_courses, &)
     end
 
-    def each_demographic(&block)
-      read_data(:file_demographics, &block)
+    def each_demographic(&)
+      read_data(:file_demographics, &)
     end
 
-    def each_enrollment(&block)
-      read_data(:file_enrollments, &block)
+    def each_enrollment(&)
+      read_data(:file_enrollments, &)
     end
 
-    def each_organization(&block)
-      read_data(:file_orgs, &block)
+    def each_organization(&)
+      read_data(:file_orgs, &)
     end
 
-    def each_role(&block)
-      read_data(:file_roles, &block)
+    def each_role(&)
+      read_data(:file_roles, &)
     end
 
-    def each_user_profile(&block)
-      read_data(:file_user_profiles, &block)
+    def each_user_profile(&)
+      read_data(:file_user_profiles, &)
     end
 
-    def each_user(&block)
-      read_data(:file_users, &block)
+    def each_user(&)
+      read_data(:file_users, &)
     end
 
     def manifest
       @manifest ||= begin
         filename = Meibo::Manifest.filename
-        raise CsvFileNotFoundError, "#{filename} not found" unless file_entry?(filename)
+        raise CsvFileNotFoundError.new("#{filename} not found", filename: filename) unless file_entry?(filename)
 
         csv = @zipfile.read(filename)
         Meibo::Manifest.parse(csv)
@@ -107,20 +107,8 @@ module Meibo
     end
 
     def load_bulk_files
-      bulk_file_attributes = manifest.file_attributes(processing_mode: Meibo::Manifest::PROCESSING_MODES[:bulk])
-      {
-        file_academic_sessions: :academic_sessions,
-        file_classes: :classes,
-        file_courses: :courses,
-        file_demographics: :demographics,
-        file_enrollments: :enrollments,
-        file_orgs: :organizations,
-        file_roles: :roles,
-        file_users: :users,
-        file_user_profiles: :user_profiles
-      }.filter_map do |file_attribute, data_method|
-        [data_method, public_send(data_method).to_a] if bulk_file_attributes.include?(file_attribute)
-      end.to_h
+      bulk_file_attributes = manifest.file_attributes(processing_mode: ProcessingMode.bulk)
+      bulk_file_attributes.to_h { |file_attribute| [file_attribute, read_data(file_attribute)&.to_a] }.compact
     end
 
     def file_entry?(filename)
@@ -131,12 +119,12 @@ module Meibo
 
     private
 
-    def read_data(file_attribute, &block)
+    def read_data(file_attribute, &)
       filename = Manifest.filename_for(file_attribute)
-      raise CsvFileNotFoundError, "#{filename} not found" unless file_entry?(filename)
+      raise CsvFileNotFoundError.new("#{filename} not found", filename: filename) unless file_entry?(filename)
 
       csv = @zipfile.read(filename)
-      profile.data_model_for(file_attribute).parse(csv, &block)
+      profile.data_model_for(file_attribute)&.parse(csv, &)
     end
   end
 end

data/lib/meibo/role.rb

@@ -2,6 +2,8 @@
 
 module Meibo
   class Role
+    include DataModel
+
     TYPES = {
       primary: "primary",
       secondary: "secondary"
@@ -22,30 +24,28 @@ module Meibo
       teacher: "teacher"
     }.freeze
 
-    DataModel.define(
-      self,
-      attribute_name_to_header_field_map: {
-        sourced_id: "sourcedId",
-        status: "status",
-        date_last_modified: "dateLastModified",
-        user_sourced_id: "userSourcedId",
-        role_type: "roleType",
-        role: "role",
-        begin_date: "beginDate",
-        end_date: "endDate",
-        org_sourced_id: "orgSourcedId",
-        user_profile_sourced_id: "userProfileSourcedId"
-      }.freeze,
-      converters: {
-        date: %i[begin_date end_date].freeze,
-        datetime: [:date_last_modified].freeze,
-        required: %i[sourced_id user_sourced_id role_type role org_sourced_id].freeze,
-        enum: {
-          role: [*ROLES.values, ENUM_EXT_PATTERN].freeze,
-          role_type: TYPES.values.freeze
-        }.freeze,
-        status: [:status].freeze
-      }.freeze
+    define_attributes(
+      sourced_id: "sourcedId",
+      status: "status",
+      date_last_modified: "dateLastModified",
+      user_sourced_id: "userSourcedId",
+      role_type: "roleType",
+      role: "role",
+      begin_date: "beginDate",
+      end_date: "endDate",
+      org_sourced_id: "orgSourcedId",
+      user_profile_sourced_id: "userProfileSourcedId"
+    )
+
+    define_converters(
+      date: %i[begin_date end_date],
+      datetime: [:date_last_modified],
+      required: %i[sourced_id user_sourced_id role_type role org_sourced_id],
+      enum: {
+        role: [*ROLES.values, ENUM_EXT_PATTERN],
+        role_type: TYPES.values
+      },
+      status: [:status]
     )
 
     def initialize(sourced_id:, user_sourced_id:, role_type:, role:, org_sourced_id:, status: nil, date_last_modified: nil,

data/lib/meibo/roster.rb

@@ -6,6 +6,20 @@ require "csv"
 module Meibo
   class Roster
     class << self
+      def file_attribute_name_to_data_attribute_name(file_attribute)
+        {
+          file_academic_sessions: :academic_sessions,
+          file_classes: :classes,
+          file_courses: :courses,
+          file_demographics: :demographics,
+          file_enrollments: :enrollments,
+          file_orgs: :organizations,
+          file_roles: :roles,
+          file_user_profiles: :user_profiles,
+          file_users: :users
+        }[file_attribute]
+      end
+
       def from_file(file_path, profile: Meibo.current_profile)
         Reader.open(file_path, profile: profile) do |reader|
           return read_data(reader, profile)
@@ -18,9 +32,9 @@ module Meibo
         end
       end
 
-      def open(io_or_path, **opts)
+      def open(io_or_path, **)
         m = io_or_path.is_a?(IO) ? :from_buffer : :from_file
-        roster = public_send(m, io_or_path, **opts)
+        roster = public_send(m, io_or_path, **)
         return roster unless block_given?
 
         Meibo.with_roster(roster) { yield roster }
@@ -32,20 +46,19 @@ module Meibo
         begin
           manifest = reader.manifest
         rescue CsvFileNotFoundError
-          raise NotSupportedError, "OneRoster 1.0\u306F\u30B5\u30DD\u30FC\u30C8\u3057\u3066\u3044\u307E\u305B\u3093"
+          raise NotSupportedError, "OneRoster 1.0はサポートしていません"
         rescue StandardError
           raise NotSupportedError, "#{Meibo::Manifest.filename}の読み込みに失敗しました"
         end
 
-        validate_manifest_version(manifest.manifest_version)
-        validate_oneroster_version(manifest.oneroster_version)
+        validate_manifest_version(profile, manifest.manifest_version)
+        validate_oneroster_version(profile, manifest.oneroster_version)
         validate_supported_processing_mode(manifest)
-        processing_modes = Meibo::Manifest::PROCESSING_MODES
-        validate_absent_files(reader, manifest.filenames(processing_mode: processing_modes[:absent]))
-        validate_bulk_files(reader, manifest.filenames(processing_mode: processing_modes[:bulk]))
+        validate_absent_files(reader, manifest.filenames(processing_mode: ProcessingMode.absent))
+        validate_bulk_files(reader, manifest.filenames(processing_mode: ProcessingMode.bulk))
 
-        new(manifest_properties: manifest.to_h, profile: profile,
-            **reader.load_bulk_files).tap(&:check_semantically_consistent)
+        data_attributes = reader.load_bulk_files.transform_keys { |file_attribute| file_attribute_name_to_data_attribute_name(file_attribute) }
+        new(manifest_properties: manifest.to_h, profile: profile, **data_attributes).tap(&:check_semantically_consistent)
       end
 
       def validate_absent_files(reader, absent_filenames)
@@ -64,22 +77,22 @@ module Meibo
         end
       end
 
-      def validate_manifest_version(manifest_version)
-        return if manifest_version == Meibo::Manifest::MANIFEST_VERSION
+      def validate_manifest_version(profile, manifest_version)
+        return if manifest_version == profile.manifest_version
 
         raise NotSupportedError, "manifest.version: #{manifest_version}はサポートしていません"
       end
 
-      def validate_oneroster_version(oneroster_version)
-        return if oneroster_version == Meibo::Manifest::ONEROSTER_VERSION
+      def validate_oneroster_version(profile, oneroster_version)
+        return if oneroster_version == profile.oneroster_version
 
         raise NotSupportedError, "oneroster.version: #{oneroster_version}はサポートしていません"
       end
 
       def validate_supported_processing_mode(manifest)
-        return if manifest.file_attributes(processing_mode: Meibo::Manifest::PROCESSING_MODES[:delta]).empty?
+        return if manifest.file_attributes(processing_mode: ProcessingMode.delta).empty?
 
-        raise NotSupportedError, "DELTA\u306F\u30B5\u30DD\u30FC\u30C8\u3057\u3066\u3044\u307E\u305B\u3093"
+        raise NotSupportedError, "DELTAはサポートしていません"
       end
     end
 
@@ -90,15 +103,15 @@ module Meibo
                    courses: [], demographics: [], enrollments: [], organizations: [], roles: [], user_profiles: [], users: [])
       @profile = profile
       @manifest_properties = manifest_properties
-      @academic_sessions = profile.data_set_for(:academic_sessions).new(academic_sessions, roster: self)
-      @classes = profile.data_set_for(:classes).new(classes, roster: self)
-      @courses = profile.data_set_for(:courses).new(courses, roster: self)
-      @demographics = profile.data_set_for(:demographics).new(demographics, roster: self)
-      @enrollments = profile.data_set_for(:enrollments).new(enrollments, roster: self)
-      @organizations = profile.data_set_for(:orgs).new(organizations, roster: self)
-      @roles = profile.data_set_for(:roles).new(roles, roster: self)
-      @user_profiles = profile.data_set_for(:user_profiles).new(user_profiles, roster: self)
-      @users = profile.data_set_for(:users).new(users, roster: self)
+      @academic_sessions = profile.data_set_for(:file_academic_sessions).new(academic_sessions, roster: self)
+      @classes = profile.data_set_for(:file_classes).new(classes, roster: self)
+      @courses = profile.data_set_for(:file_courses).new(courses, roster: self)
+      @demographics = profile.data_set_for(:file_demographics).new(demographics, roster: self)
+      @enrollments = profile.data_set_for(:file_enrollments).new(enrollments, roster: self)
+      @organizations = profile.data_set_for(:file_orgs).new(organizations, roster: self)
+      @roles = profile.data_set_for(:file_roles).new(roles, roster: self)
+      @user_profiles = profile.data_set_for(:file_user_profiles).new(user_profiles, roster: self)
+      @users = profile.data_set_for(:file_users).new(users, roster: self)
     end
 
     def builder
@@ -119,8 +132,8 @@ module Meibo
       ].each(&:check_semantically_consistent)
     end
 
-    def write_to_buffer(io)
-      Zip::File.open_buffer(io) do |zipfile|
+    def write_to_buffer(io, create: true)
+      Zip::File.open_buffer(io, create:) do |zipfile|
         write(zipfile)
       end
     end
@@ -135,8 +148,8 @@ module Meibo
 
     def write(zipfile)
       manifest = build_manifest
-      zipfile.get_output_stream(::Meibo::Manifest.filename) do |f|
-        f.puts ::Meibo::Manifest.header_fields.to_csv
+      zipfile.get_output_stream(Manifest.filename) do |f|
+        f.puts Manifest.header_fields.to_csv
         manifest.to_a.each do |row|
           f.puts row.to_csv
         end
@@ -156,24 +169,10 @@ module Meibo
       end
     end
 
-    def build_manifest
-      new_manifest_properties = file_properties.merge(manifest_properties)
-      Meibo::Manifest.build_from_default(**new_manifest_properties)
-    end
+    def build_manifest = Manifest.new(**profile.manifest_properties, **manifest_properties, **file_properties)
 
     def data_for(file_attribute)
-      data_method = {
-        file_academic_sessions: :academic_sessions,
-        file_classes: :classes,
-        file_courses: :courses,
-        file_demographics: :demographics,
-        file_enrollments: :enrollments,
-        file_orgs: :organizations,
-        file_roles: :roles,
-        file_user_profiles: :user_profiles,
-        file_users: :users
-      }[file_attribute]
-      public_send(data_method)
+      public_send(self.class.file_attribute_name_to_data_attribute_name(file_attribute))
     end
 
     def file_properties
@@ -192,9 +191,9 @@ module Meibo
 
     def procesing_mode(data)
       if data.empty?
-        Meibo::Manifest::PROCESSING_MODES[:absent]
+        ProcessingMode.absent
       else
-        Meibo::Manifest::PROCESSING_MODES[:bulk]
+        ProcessingMode.bulk
       end
     end
   end

data/lib/meibo/user.rb

@@ -2,42 +2,42 @@
 
 module Meibo
   class User
-    USER_ID_FORMAT_REGEXP = /\A\{[^:}]+:[^}]+\}\z/.freeze
+    include DataModel
 
-    DataModel.define(
-      self,
-      attribute_name_to_header_field_map: {
-        sourced_id: "sourcedId",
-        status: "status",
-        date_last_modified: "dateLastModified",
-        enabled_user: "enabledUser",
-        username: "username",
-        user_ids: "userIds",
-        given_name: "givenName",
-        family_name: "familyName",
-        middle_name: "middleName",
-        identifier: "identifier",
-        email: "email",
-        sms: "sms",
-        phone: "phone",
-        agent_sourced_ids: "agentSourcedIds",
-        grades: "grades",
-        password: "password",
-        user_master_identifier: "userMasterIdentifier",
-        preferred_given_name: "preferredGivenName",
-        preferred_middle_name: "preferredMiddleName",
-        preferred_family_name: "preferredFamilyName",
-        primary_org_sourced_id: "primaryOrgSourcedId",
-        pronouns: "pronouns"
-      }.freeze,
-      converters: {
-        boolean: [:enabled_user].freeze,
-        datetime: [:date_last_modified].freeze,
-        list: %i[user_ids agent_sourced_ids grades].freeze,
-        required: %i[sourced_id enabled_user username given_name family_name].freeze,
-        status: [:status].freeze,
-        user_ids: [:user_ids].freeze
-      }.freeze
+    USER_ID_FORMAT_REGEXP = /\A\{[^:}]+:[^}]+\}\z/
+
+    define_attributes(
+      sourced_id: "sourcedId",
+      status: "status",
+      date_last_modified: "dateLastModified",
+      enabled_user: "enabledUser",
+      username: "username",
+      user_ids: "userIds",
+      given_name: "givenName",
+      family_name: "familyName",
+      middle_name: "middleName",
+      identifier: "identifier",
+      email: "email",
+      sms: "sms",
+      phone: "phone",
+      agent_sourced_ids: "agentSourcedIds",
+      grades: "grades",
+      password: "password",
+      user_master_identifier: "userMasterIdentifier",
+      preferred_given_name: "preferredGivenName",
+      preferred_middle_name: "preferredMiddleName",
+      preferred_family_name: "preferredFamilyName",
+      primary_org_sourced_id: "primaryOrgSourcedId",
+      pronouns: "pronouns"
+    )
+
+    define_converters(
+      boolean: [:enabled_user],
+      datetime: [:date_last_modified],
+      list: %i[user_ids agent_sourced_ids grades],
+      required: %i[sourced_id enabled_user username given_name family_name],
+      status: [:status],
+      user_ids: [:user_ids]
     )
 
     def initialize(sourced_id:, username:, given_name:, family_name:, status: nil, date_last_modified: nil,

data/lib/meibo/user_profile.rb

@@ -2,26 +2,26 @@
 
 module Meibo
   class UserProfile
-    DataModel.define(
-      self,
-      attribute_name_to_header_field_map: {
-        sourced_id: "sourcedId",
-        status: "status",
-        date_last_modified: "dateLastModified",
-        user_sourced_id: "userSourcedId",
-        profile_type: "profileType",
-        vendor_id: "vendorId",
-        application_id: "applicationId",
-        description: "description",
-        credential_type: "credentialType",
-        username: "username",
-        password: "password"
-      },
-      converters: {
-        datetime: [:date_last_modified],
-        required: %i[sourced_id user_sourced_id profile_type vendor_id credential_type username],
-        status: [:status]
-      }
+    include DataModel
+
+    define_attributes(
+      sourced_id: "sourcedId",
+      status: "status",
+      date_last_modified: "dateLastModified",
+      user_sourced_id: "userSourcedId",
+      profile_type: "profileType",
+      vendor_id: "vendorId",
+      application_id: "applicationId",
+      description: "description",
+      credential_type: "credentialType",
+      username: "username",
+      password: "password"
+    )
+
+    define_converters(
+      datetime: [:date_last_modified],
+      required: %i[sourced_id user_sourced_id profile_type vendor_id credential_type username],
+      status: [:status]
     )
 
     def initialize(sourced_id:, user_sourced_id:, profile_type:, vendor_id:, credential_type:, username:, status: nil, date_last_modified: nil,

data/lib/meibo/user_set.rb

@@ -5,7 +5,7 @@ module Meibo
     def check_semantically_consistent
       super
 
-      raise Error, "userMasterIdentifier\u304C\u91CD\u8907\u3057\u3066\u3044\u307E\u3059" if @data.filter_map(&:user_master_identifier).tally.values.any? { |v| v > 1 }
+      raise Error, "userMasterIdentifierが重複しています" if @data.filter_map(&:user_master_identifier).tally.values.any? { |v| v > 1 }
 
       each do |user|
         roster.organizations.find(user.primary_org_sourced_id) if user.primary_org_sourced_id

data/lib/meibo/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Meibo
-  VERSION = "0.27.0"
+  VERSION = "0.28.0"
 end

data/lib/meibo.rb

@@ -4,6 +4,14 @@ require "zeitwerk"
 loader = Zeitwerk::Loader.for_gem
 loader.ignore("#{__dir__}/meibo/errors.rb")
 loader.ignore("#{__dir__}/meibo/factory_bot")
+loader.inflector.inflect(
+  "oneroster" => "OneRoster",
+  "pse_interoperability_standard" => "PSEInteroperabilityStandard",
+  "v1_1_1" => "V1_1_1",
+  "v1_1" => "V1_1",
+  "v1_2_1" => "V1_2_1",
+  "v1_2" => "V1_2"
+)
 loader.setup
 
 require_relative "meibo/version"
@@ -11,7 +19,7 @@ require_relative "meibo/errors"
 
 module Meibo
   CSV_ENCODING = "UTF-8"
-  ENUM_EXT_PATTERN = /\Aext:[a-zA-Z0-9.\-_]+\z/.freeze
+  ENUM_EXT_PATTERN = /\Aext:[a-zA-Z0-9.\-_]+\z/
 
   class << self
     attr_accessor :default_profile
@@ -50,4 +58,4 @@ end
 
 loader.eager_load
 
-Meibo.default_profile = Meibo::Profiles["v1.2"]
+Meibo.default_profile = Meibo::Profiles["IMS OneRoster: CSV Binding Final Release v1.2.1"]

data/meibo.gemspec

@@ -11,7 +11,7 @@ Gem::Specification.new do |spec|
   spec.summary = "Meibo is a ruby library for OneRoster CSV Binding Japan Profile."
   spec.homepage = "https://github.com/hanachin/meibo"
   spec.license = "MIT"
-  spec.required_ruby_version = ">= 2.7.0"
+  spec.required_ruby_version = ">= 3.4.0"
 
   spec.metadata["allowed_push_host"] = "https://rubygems.org/"