meibo 0.27.1 → 0.28.0

data/lib/meibo/eportal/v3/enrollment.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module Meibo
+  module Eportal
+    module V3
+      class Enrollment < ::Meibo::JapanProfile::V1_1::Enrollment
+        define_converters(superclass.converters.merge(required: [*superclass.converters[:required], :primary]))
+      end
+    end
+  end
+end

data/lib/meibo/eportal/v3/organization.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module Meibo
+  module Eportal
+    module V3
+      class Organization < ::Meibo::JapanProfile::V1_1::Organization
+        define_converters(superclass.converters.merge(fullwidth: [*superclass.converters[:fullwidth], :name]))
+      end
+    end
+  end
+end

data/lib/meibo/eportal/v3/user.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module Meibo
+  module Eportal
+    module V3
+      class User < ::Meibo::JapanProfile::V1_1::User
+        define_converters(
+          superclass.converters.merge(
+            fullwidth: [*superclass.converters[:fullwidth], :given_name, :family_name, :middle_name, :preferred_given_name, :preferred_middle_name, :preferred_family_name, :kana_given_name, :kana_family_name, :kana_middle_name],
+            required: [*superclass.converters[:required], :user_master_identifier, :preferred_given_name, :preferred_family_name, :kana_given_name, :kana_family_name]
+          )
+        )
+      end
+    end
+  end
+end

data/lib/meibo/eportal/v3/user_profile.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module Meibo
+  module Eportal
+    module V3
+      class UserProfile < ::Meibo::JapanProfile::V1_1::UserProfile
+        define_converters(superclass.converters.merge(fullwidth: [*superclass.converters[:fullwidth], :description]))
+      end
+    end
+  end
+end

data/lib/meibo/eportal/v3.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+module Meibo
+  module Eportal
+    module V3
+      include ::Meibo::JapanProfile::V1_1
+
+      PROFILE = Profile.new(
+        builders: ::Meibo::JapanProfile::V1_1::PROFILE.builders.merge(
+          class: Builder::ClassroomBuilder.create(::Meibo::Eportal::V3::Classroom),
+          course: Builder::CourseBuilder.create(::Meibo::Eportal::V3::Course),
+          enrollment: Builder::EnrollmentBuilder.create(::Meibo::Eportal::V3::Enrollment),
+          org: Builder::OrganizationBuilder.create(::Meibo::Eportal::V3::Organization),
+          user_profile: Builder::UserProfileBuilder.create(::Meibo::Eportal::V3::UserProfile),
+          user: Builder::UserBuilder.create(::Meibo::Eportal::V3::User)
+        ),
+        data_models: ::Meibo::JapanProfile::V1_1::PROFILE.data_models.merge(
+          file_classes: ::Meibo::Eportal::V3::Classroom,
+          file_courses: ::Meibo::Eportal::V3::Course,
+          file_enrollments: ::Meibo::Eportal::V3::Enrollment,
+          file_orgs: ::Meibo::Eportal::V3::Organization,
+          file_user_profiles: ::Meibo::Eportal::V3::UserProfile,
+          file_users: ::Meibo::Eportal::V3::User
+        ),
+        data_set: ::Meibo::JapanProfile::V1_1::PROFILE.data_set,
+        manifest_properties: { oneroster_version: "1.2" }
+      )
+    end
+  end
+end

data/lib/meibo/eportal/v4/user.rb

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+module Meibo
+  module Eportal
+    module V4
+      class User < ::Meibo::JapanProfile::V1_2::User
+        define_converters(
+          superclass.converters.merge(
+            fullwidth: [
+              *superclass.converters[:fullwidth],
+              :given_name,
+              :family_name,
+              :middle_name,
+              :preferred_given_name,
+              :preferred_middle_name,
+              :preferred_family_name,
+              :kana_given_name,
+              :kana_family_name,
+              :kana_middle_name,
+              :kana_preferred_family_name,
+              :kana_preferred_given_name,
+              :kana_preferred_middle_name
+            ],
+            required: [
+              *superclass.converters[:required],
+              :user_master_identifier,
+              :preferred_given_name,
+              :preferred_family_name,
+              :kana_given_name,
+              :kana_family_name
+            ]
+          )
+        )
+      end
+    end
+  end
+end

data/lib/meibo/eportal/v4.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module Meibo
+  module Eportal
+    module V4
+      include ::Meibo::Eportal::V3
+
+      PROFILE = Profile.new(
+        builders: ::Meibo::Eportal::V3::PROFILE.builders.merge(user: Builder::UserBuilder.create(::Meibo::Eportal::V4::User)),
+        data_models: ::Meibo::Eportal::V3::PROFILE.data_models.merge(file_users: ::Meibo::Eportal::V4::User),
+        data_set: ::Meibo::Eportal::V3::PROFILE.data_set,
+        manifest_properties: { oneroster_version: "1.2.1" }
+      )
+    end
+  end
+end

data/lib/meibo/eportal.rb

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+module Meibo
+  module Eportal
+  end
+end

data/lib/meibo/errors.rb

@@ -2,16 +2,37 @@
 
 module Meibo
   class Error < StandardError; end
-  class CsvFileNotFoundError < Error; end
+
+  class CsvFileNotFoundError < Error
+    attr_reader :filename
+
+    def initialize(message = nil, filename:, **kw)
+      super(message, **kw)
+
+      @filename = filename
+    end
+  end
+
   class DataNotFoundError < Error; end
-  class InvalidDataTypeError < Error; end
-  class MissingDataError < Error; end
+
+  class InvalidDataTypeError < Error
+    attr_reader :field, :field_info
+
+    def initialize(message = nil, field:, field_info:, **kw)
+      super(message, **kw)
+
+      @field = field
+      @field_info = field_info
+    end
+  end
+
+  class MissingDataError < InvalidDataTypeError; end
 
   class MissingHeaderFieldsError < Error
     attr_reader :missing_header_fields
 
-    def initialize(message = nil, missing_header_fields:)
-      super(message)
+    def initialize(message = nil, missing_header_fields:, **kw)
+      super(message, **kw)
       @missing_header_fields = missing_header_fields
     end
   end
@@ -19,4 +40,5 @@ module Meibo
   class NotSupportedError < Error; end
   class ScrambledHeaderFieldsError < Error; end
   class SourcedIdDuplicatedError < Error; end
+  class SubjectsAndSubjectCodesLengthNotMatch < Error; end
 end

data/lib/meibo/factory_bot/academic_session.rb

@@ -37,7 +37,7 @@ FactoryBot.define do
     end
 
     trait :jp do
-      initialize_with { Meibo::JapanProfile::AcademicSession.new(**attributes) }
+      initialize_with { Meibo::JapanProfile::V1_2::AcademicSession.new(**attributes) }
     end
   end
 end

data/lib/meibo/factory_bot/classroom.rb

@@ -29,7 +29,7 @@ FactoryBot.define do
     end
 
     trait :jp do
-      initialize_with { Meibo::JapanProfile::Classroom.new(**attributes) }
+      initialize_with { Meibo::JapanProfile::V1_2::Classroom.new(**attributes) }
     end
 
     trait :special_needs do

data/lib/meibo/factory_bot/course.rb

@@ -19,7 +19,7 @@ FactoryBot.define do
     org_sourced_id { organization&.sourced_id }
 
     trait :jp do
-      initialize_with { Meibo::JapanProfile::Course.new(**attributes) }
+      initialize_with { Meibo::JapanProfile::V1_2::Course.new(**attributes) }
     end
   end
 end

data/lib/meibo/factory_bot/demographic.rb

@@ -14,7 +14,7 @@ FactoryBot.define do
     sourced_id { user&.sourced_id || SecureRandom.uuid }
 
     trait :jp do
-      initialize_with { Meibo::JapanProfile::Demographic.new(**attributes) }
+      initialize_with { Meibo::JapanProfile::V1_2::Demographic.new(**attributes) }
     end
 
     trait :male do

data/lib/meibo/factory_bot/enrollment.rb

@@ -35,7 +35,7 @@ FactoryBot.define do
     end
 
     trait :jp do
-      initialize_with { Meibo::JapanProfile::Enrollment.new(**attributes) }
+      initialize_with { Meibo::JapanProfile::V1_2::Enrollment.new(**attributes) }
     end
 
     trait :guardian do

data/lib/meibo/factory_bot/manifest.rb

@@ -8,26 +8,5 @@ FactoryBot.define do
 
     manifest_version { Meibo::Manifest::EXPECTED_VALUES[:manifest_version] }
     oneroster_version { Meibo::Manifest::EXPECTED_VALUES[:oneroster_version] }
-    file_academic_sessions { Meibo::Manifest::EXPECTED_VALUES[:file_academic_sessions] }
-    file_categories { Meibo::Manifest::EXPECTED_VALUES[:file_categories] }
-    file_classes { Meibo::Manifest::EXPECTED_VALUES[:file_classes] }
-    file_class_resources { Meibo::Manifest::EXPECTED_VALUES[:file_class_resources] }
-    file_courses { Meibo::Manifest::EXPECTED_VALUES[:file_courses] }
-    file_course_resources { Meibo::Manifest::EXPECTED_VALUES[:file_course_resources] }
-    file_demographics { Meibo::Manifest::EXPECTED_VALUES[:file_demographics] }
-    file_enrollments { Meibo::Manifest::EXPECTED_VALUES[:file_enrollments] }
-    file_line_item_learning_objective_ids { Meibo::Manifest::EXPECTED_VALUES[:file_line_item_learning_objective_ids] }
-    file_line_items { Meibo::Manifest::EXPECTED_VALUES[:file_line_items] }
-    file_line_item_score_scales { Meibo::Manifest::EXPECTED_VALUES[:file_line_item_score_scales] }
-    file_orgs { Meibo::Manifest::EXPECTED_VALUES[:file_orgs] }
-    file_resources { Meibo::Manifest::EXPECTED_VALUES[:file_resources] }
-    file_result_learning_objective_ids { Meibo::Manifest::EXPECTED_VALUES[:file_result_learning_objective_ids] }
-    file_results { Meibo::Manifest::EXPECTED_VALUES[:file_results] }
-    file_result_score_scales { Meibo::Manifest::EXPECTED_VALUES[:file_result_score_scales] }
-    file_roles { Meibo::Manifest::EXPECTED_VALUES[:file_roles] }
-    file_score_scales { Meibo::Manifest::EXPECTED_VALUES[:file_score_scales] }
-    file_user_profiles { Meibo::Manifest::EXPECTED_VALUES[:file_user_profiles] }
-    file_user_resources { Meibo::Manifest::EXPECTED_VALUES[:file_user_resources] }
-    file_users { Meibo::Manifest::EXPECTED_VALUES[:file_users] }
   end
 end

data/lib/meibo/factory_bot/organization.rb

@@ -64,7 +64,7 @@ FactoryBot.define do
     end
 
     trait :jp do
-      initialize_with { Meibo::JapanProfile::Organization.new(**attributes) }
+      initialize_with { Meibo::JapanProfile::V1_2::Organization.new(**attributes) }
       sequence(:name) { |n| "第#{n}教委" }
     end
   end

data/lib/meibo/factory_bot/role.rb

@@ -75,14 +75,12 @@ FactoryBot.define do
     end
 
     trait :jp do
-      jp_version { "1.1" }
+      jp_version { "1.1.1" }
 
       initialize_with do
         case jp_version
-        when "1.1"
+        when "1.1", "1.1.1"
           Meibo::Role.new(**attributes)
-        when "1.0"
-          Meibo::JapanProfile::RoleJpM0.new(**attributes)
         end
       end
     end

data/lib/meibo/factory_bot/user.rb

@@ -9,8 +9,8 @@ FactoryBot.define do
       case oneroster_version
       when "1.2.1"
         new(**attributes)
-      when "1.2", "1.2.0"
-        Meibo::UserM0.new(**attributes)
+      when "1.2"
+        Meibo::OneRoster::V1_2::User.new(**attributes)
       end
     end
 
@@ -35,9 +35,9 @@ FactoryBot.define do
       initialize_with do
         case oneroster_version
         when "1.2.1"
-          Meibo::JapanProfile::User.new(**attributes)
-        when "1.2", "1.2.0"
-          Meibo::JapanProfile::UserM0.new(**attributes)
+          Meibo::JapanProfile::V1_2::User.new(**attributes)
+        when "1.2"
+          Meibo::JapanProfile::V1_1::User.new(**attributes)
         end
       end
 

data/lib/meibo/factory_bot/user_profile.rb

@@ -19,7 +19,7 @@ FactoryBot.define do
     sequence(:username) { |n| "user#{n}" }
 
     trait :jp do
-      initialize_with { Meibo::JapanProfile::UserProfile.new(**attributes) }
+      initialize_with { Meibo::JapanProfile::V1_2::UserProfile.new(**attributes) }
     end
   end
 end

data/lib/meibo/japan_k12_schools_profile/v1/enrollment.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module Meibo
+  module JapanK12SchoolsProfile
+    module V1
+      class Enrollment < ::Meibo::JapanProfile::V1_2::Enrollment
+        define_attributes(
+          superclass.attribute_names_to_header_fields.merge(
+            shusseki_no: "metadata.jp.shussekiNo",
+            public_flg: "metadata.jp.publicFlg"
+          )
+        )
+      end
+    end
+  end
+end

data/lib/meibo/japan_k12_schools_profile/v1.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module Meibo
+  module JapanK12SchoolsProfile
+    module V1
+      include ::Meibo::JapanProfile::V1_2
+
+      PROFILE = Profile.new(
+        builders: ::Meibo::JapanProfile::V1_2::PROFILE.builders.merge(
+          enrollment: ::Meibo::Builder::EnrollmentBuilder.create(::Meibo::JapanK12SchoolsProfile::V1::Enrollment)
+        ),
+        data_models: ::Meibo::JapanProfile::V1_2::PROFILE.data_models.merge(
+          file_enrollments: ::Meibo::JapanK12SchoolsProfile::V1::Enrollment
+        ),
+        data_set: ::Meibo::JapanProfile::V1_2::PROFILE.data_set,
+        manifest_properties: { oneroster_version: "1.2_JP" }
+      )
+    end
+  end
+end

data/lib/meibo/japan_k12_schools_profile.rb

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+module Meibo
+  module JapanK12SchoolsProfile
+  end
+end

data/lib/meibo/japan_profile/v1_1/academic_session.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+module Meibo
+  module JapanProfile
+    module V1_1
+      class AcademicSession < ::Meibo::OneRoster::V1_2::AcademicSession
+        TYPES = { school_year: "schoolYear" }.freeze
+
+        define_converters(superclass.converters.merge(format: { title: /\A\d+年度\z/ }, enum: { type: TYPES.values }))
+
+        # NOTE: 以下固定
+        #   - titleは連携処理実行時の対象年度西暦 + 「年度」を設定
+        #   - typeはschoolYear固定
+        #   - start_dateは対象年度の開始日固定
+        #   - end_dateは対象年度の終了日固定
+        def initialize(
+          school_year:,
+          title: "#{school_year}年度",
+          type: TYPES[:school_year],
+          start_date: Date.new(school_year, 4, 1),
+          end_date: Date.new(school_year + 1, 3, 31),
+          **
+        )
+          super
+        end
+      end
+    end
+  end
+end

data/lib/meibo/japan_profile/v1_1/classroom.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+module Meibo
+  module JapanProfile
+    module V1_1
+      class Classroom < ::Meibo::OneRoster::V1_2::Classroom
+        define_attributes(
+          superclass.attribute_names_to_header_fields.merge(
+            special_needs: "metadata.jp.specialNeeds"
+          )
+        )
+        define_converters(
+          superclass.converters.merge(
+            boolean: [:special_needs],
+            enum: { class_type: TYPES.values },
+            mext_grade_code: [:grades]
+          )
+        )
+
+        def initialize(special_needs: nil, **)
+          super(**)
+          @special_needs = special_needs
+        end
+      end
+    end
+  end
+end

data/lib/meibo/japan_profile/v1_1/course.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module Meibo
+  module JapanProfile
+    module V1_1
+      class Course < ::Meibo::OneRoster::V1_2::Course
+        define_converters(superclass.converters.merge(enum: { course_code: [""] }, mext_grade_code: [:grades]))
+
+        # NOTE: courseCodeは空文字固定
+        def initialize(course_code: "", **)
+          super
+        end
+      end
+    end
+  end
+end

data/lib/meibo/japan_profile/v1_1/demographic.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module Meibo
+  module JapanProfile
+    module V1_1
+      class Demographic < ::Meibo::OneRoster::V1_2::Demographic
+        define_converters(superclass.converters.merge(enum: { sex: SEX.values.freeze }))
+      end
+    end
+  end
+end

data/lib/meibo/japan_profile/v1_1/enrollment.rb

@@ -0,0 +1,47 @@
+# frozen_string_literal: true
+
+module Meibo
+  module JapanProfile
+    module V1_1
+      class Enrollment < ::Meibo::OneRoster::V1_2::Enrollment
+        ROLES = {
+          student: "student",
+          teacher: "teacher",
+          administrator: "administrator",
+          guardian: "guardian"
+        }.freeze
+
+        define_attributes(
+          superclass.attribute_names_to_header_fields.merge(
+            shusseki_no: "metadata.jp.ShussekiNo",
+            public_flg: "metadata.jp.PublicFlg"
+          )
+        )
+
+        define_converters(
+          superclass.converters.merge(
+            boolean: [*superclass.converters[:boolean], :public_flg],
+            enum: { role: ROLES.values },
+            integer: [:shusseki_no]
+          )
+        )
+
+        # NOTE: 児童生徒の場合primaryはfalse固定
+        # MEMO: 保護者の場合もそうでは?
+        def initialize(
+          role:,
+          shusseki_no: nil,
+          public_flg: nil,
+          primary: (role == ROLES[:student] ? false : nil),
+          **
+        )
+          super(role: role, primary: primary, **)
+          @shusseki_no = shusseki_no
+          @public_flg = public_flg
+        end
+
+        def guardian? = role == ROLES[:guardian]
+      end
+    end
+  end
+end

data/lib/meibo/japan_profile/v1_1/organization.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module Meibo
+  module JapanProfile
+    module V1_1
+      class Organization < ::Meibo::OneRoster::V1_2::Organization
+        TYPES = {
+          district: "district",
+          school: "school"
+        }.freeze
+
+        define_converters(superclass.converters.merge(enum: { type: TYPES.values }))
+      end
+    end
+  end
+end

data/lib/meibo/japan_profile/v1_1/organization_set.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+module Meibo
+  module JapanProfile
+    module V1_1
+      class OrganizationSet < ::Meibo::OneRoster::V1_2::OrganizationSet
+        def check_semantically_consistent
+          super
+
+          each do |organization|
+            next unless organization.parent_sourced_id
+
+            next unless organization.district?
+
+            field = organization.parent_sourced_id
+            field_info = field_info_from(organization, :parent_sourced_id)
+            raise ::Meibo::InvalidDataTypeError.new(field:, field_info:)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/meibo/japan_profile/v1_1/user.rb

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+module Meibo
+  module JapanProfile
+    module V1_1
+      class User < ::Meibo::OneRoster::V1_2::User
+        define_attributes(
+          superclass.attribute_names_to_header_fields.merge(
+            kana_given_name: "metadata.jp.kanaGivenName",
+            kana_family_name: "metadata.jp.kanaFamilyName",
+            kana_middle_name: "metadata.jp.kanaMiddleName",
+            home_class: "metadata.jp.homeClass"
+          )
+        )
+
+        define_converters(
+          superclass.converters.merge(
+            mext_grade_code: [:grades].freeze
+          )
+        )
+
+        # NOTE: enabled_userは必須ではないが固定
+        def initialize(
+          enabled_user: true,
+          kana_given_name: nil, kana_family_name: nil, kana_middle_name: nil, home_class: nil,
+          **
+        )
+          super(enabled_user:, **)
+          @kana_given_name = kana_given_name
+          @kana_family_name = kana_family_name
+          @kana_middle_name = kana_middle_name
+          @home_class = home_class
+        end
+
+        def home_classroom = home_class && ::Meibo.current_roster.classes.find(home_class)
+      end
+    end
+  end
+end

data/lib/meibo/japan_profile/v1_1/user_set.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module Meibo
+  module JapanProfile
+    module V1_1
+      class UserSet < ::Meibo::OneRoster::V1_2::UserSet
+        def check_semantically_consistent
+          super
+
+          each do |user|
+            roster.classes.find(user.home_class) if user.home_class
+          end
+        end
+      end
+    end
+  end
+end

data/lib/meibo/japan_profile/v1_1.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+module Meibo
+  module JapanProfile
+    module V1_1
+      include OneRoster::V1_2
+
+      PROFILE = Profile.new(
+        builders: ::Meibo::OneRoster::V1_2::PROFILE.builders.merge(
+          academic_session: ::Meibo::Builder::AcademicSessionBuilder.create(::Meibo::JapanProfile::V1_1::AcademicSession),
+          class: ::Meibo::Builder::ClassroomBuilder.create(::Meibo::JapanProfile::V1_1::Classroom),
+          course: ::Meibo::Builder::CourseBuilder.create(::Meibo::JapanProfile::V1_1::Course),
+          demographic: ::Meibo::Builder::DemographicBuilder.create(::Meibo::JapanProfile::V1_1::Demographic),
+          enrollment: ::Meibo::Builder::EnrollmentBuilder.create(::Meibo::JapanProfile::V1_1::Enrollment),
+          org: ::Meibo::Builder::OrganizationBuilder.create(::Meibo::JapanProfile::V1_1::Organization),
+          user: ::Meibo::Builder::UserBuilder.create(::Meibo::JapanProfile::V1_1::User)
+        ),
+        data_models: ::Meibo::OneRoster::V1_2::PROFILE.data_models.merge(
+          file_academic_sessions: ::Meibo::JapanProfile::V1_1::AcademicSession,
+          file_classes: ::Meibo::JapanProfile::V1_1::Classroom,
+          file_courses: ::Meibo::JapanProfile::V1_1::Course,
+          file_demographics: ::Meibo::JapanProfile::V1_1::Demographic,
+          file_enrollments: ::Meibo::JapanProfile::V1_1::Enrollment,
+          file_orgs: ::Meibo::JapanProfile::V1_1::Organization,
+          file_users: ::Meibo::JapanProfile::V1_1::User
+        ),
+        data_set: ::Meibo::OneRoster::V1_2::PROFILE.data_set.merge(
+          file_orgs: ::Meibo::JapanProfile::V1_1::OrganizationSet,
+          file_users: ::Meibo::JapanProfile::V1_1::UserSet
+        ),
+        manifest_properties: { oneroster_version: "1.2" }
+      )
+    end
+  end
+end

data/lib/meibo/japan_profile/v1_1_1.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module Meibo
+  module JapanProfile
+    module V1_1_1
+      PROFILE = V1_1::PROFILE
+    end
+  end
+end