meibo 0.1.0

data/lib/meibo/demographic.rb

@@ -0,0 +1,70 @@
+# frozen_string_literal: true
+
+module Meibo
+  class Demographic
+    SEX = {
+      male: 'male',
+      female: 'female',
+      unspecified: 'unspecified',
+      other: 'other'
+    }.freeze
+
+    DataModel.define(
+      self,
+      attribute_name_to_header_field_map: {
+        sourced_id: 'sourcedId',
+        status: 'status',
+        date_last_modified: 'dateLastModified',
+        birth_date: 'birthDate',
+        sex: 'sex',
+        american_indian_or_alaska_native: 'americanIndianOrAlaskaNative',
+        asian: 'asian',
+        black_or_african_american: 'blackOrAfricanAmerican',
+        native_hawaiian_or_other_pacific_islander: 'nativeHawaiianOrOtherPacificIslander',
+        white: 'white',
+        demographic_race_two_or_more_races: 'demographicRaceTwoOrMoreRaces',
+        hispanic_or_latino_ethnicity: 'hispanicOrLatinoEthnicity',
+        country_of_birth_code: 'countryOfBirthCode',
+        state_of_birth_abbreviation: 'stateOfBirthAbbreviation',
+        city_of_birth: 'cityOfBirth',
+        public_school_residence_status: 'publicSchoolResidenceStatus'
+      }.freeze,
+      converters: {
+        boolean: [
+          :american_indian_or_alaska_native,
+          :asian,
+          :black_or_african_american,
+          :native_hawaiian_or_other_pacific_islander,
+          :white,
+          :demographic_race_two_or_more_races,
+          :hispanic_or_latino_ethnicity
+        ].freeze,
+        date: [:birth_date].freeze,
+        datetime: [:date_last_modified].freeze,
+        enum: { sex: [*SEX.values, ENUM_EXT_PATTERN].freeze }.freeze,
+        required: [:sourced_id].freeze,
+        status: [:status].freeze
+      }
+    )
+
+    def initialize(sourced_id:, status: nil, date_last_modified: nil, birth_date: nil, sex: nil, american_indian_or_alaska_native: nil, asian: nil, black_or_african_american: nil, native_hawaiian_or_other_pacific_islander: nil, white: nil, demographic_race_two_or_more_races: nil, hispanic_or_latino_ethnicity: nil, country_of_birth_code: nil, state_of_birth_abbreviation: nil, city_of_birth: nil, public_school_residence_status: nil, **extension_fields)
+      @sourced_id = sourced_id
+      @status = status
+      @date_last_modified = date_last_modified
+      @birth_date = birth_date
+      @sex = sex
+      @american_indian_or_alaska_native = american_indian_or_alaska_native
+      @asian = asian
+      @black_or_african_american = black_or_african_american
+      @native_hawaiian_or_other_pacific_islander = native_hawaiian_or_other_pacific_islander
+      @white = white
+      @demographic_race_two_or_more_races = demographic_race_two_or_more_races
+      @hispanic_or_latino_ethnicity = hispanic_or_latino_ethnicity
+      @country_of_birth_code = country_of_birth_code
+      @state_of_birth_abbreviation = state_of_birth_abbreviation
+      @city_of_birth = city_of_birth
+      @public_school_residence_status = public_school_residence_status
+      @extension_fields = extension_fields
+    end
+  end
+end

data/lib/meibo/demographic_set.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module Meibo
+  class DemographicSet < DataSet
+    def initialize(data, user_set:)
+      super(data)
+      @user_set = user_set
+    end
+
+    def check_semantically_consistent
+      super
+
+      each do |demographic|
+        @user_set.find_by_sourced_id(demographic.sourced_id)
+      end
+    end
+  end
+end

data/lib/meibo/enrollment.rb

@@ -0,0 +1,51 @@
+# frozen_string_literal: true
+
+module Meibo
+  class Enrollment
+    ROLES = {
+      administrator: 'administrator',
+      proctor: 'proctor',
+      student: 'student',
+      teacher: 'teacher'
+    }.freeze
+
+    DataModel.define(
+      self,
+      attribute_name_to_header_field_map: {
+        sourced_id: 'sourcedId',
+        status: 'status',
+        date_last_modified: 'dateLastModified',
+        class_sourced_id: 'classSourcedId',
+        school_sourced_id: 'schoolSourcedId',
+        user_sourced_id: 'userSourcedId',
+        role: 'role',
+        primary: 'primary',
+        begin_date: 'beginDate',
+        end_date: 'endDate'
+      }.freeze,
+      converters: {
+        boolean: [:primary].freeze,
+        date: [:begin_date, :end_date].freeze,
+        datetime: [:date_last_modified].freeze,
+        enum: { role: [*ROLES.values, ENUM_EXT_PATTERN].freeze }.freeze,
+        required: [:sourced_id, :class_sourced_id, :school_sourced_id, :user_sourced_id, :role].freeze,
+        status: [:status].freeze
+      }
+    )
+
+    def initialize(sourced_id:, status: nil, date_last_modified: nil, class_sourced_id:, school_sourced_id:, user_sourced_id:, role:, primary: nil, begin_date: nil, end_date: nil, shusseki_no: nil, public_flg: nil, **extension_fields)
+      @sourced_id = sourced_id
+      @status = status
+      @date_last_modified = date_last_modified
+      @class_sourced_id = class_sourced_id
+      @school_sourced_id = school_sourced_id
+      @user_sourced_id = user_sourced_id
+      @role = role
+      @begin_date = begin_date
+      @end_date = end_date
+      @shusseki_no = shusseki_no
+      @public_flg = public_flg
+      @extension_fields = extension_fields
+    end
+  end
+end

data/lib/meibo/enrollment_set.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module Meibo
+  class EnrollmentSet < DataSet
+    def initialize(data, classroom_set:, organization_set:, user_set:)
+      super(data)
+      @classroom_set = classroom_set
+      @organization_set = organization_set
+      @user_set = user_set
+    end
+
+    def check_semantically_consistent
+      super
+
+      each do |enrollment|
+        @classroom_set.find_by_sourced_id(enrollment.class_sourced_id)
+        @organization_set.find_by_sourced_id(enrollment.school_sourced_id)
+        @user_set.find_by_sourced_id(enrollment.user_sourced_id)
+      end
+    end
+  end
+end

data/lib/meibo/errors.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module Meibo
+  class Error < StandardError; end
+  class CsvFileNotFoundError < Error; end
+  class DataNotFoundError < Error; end
+  class InvalidDataTypeError < Error; end
+  class MissingDataError < Error; end
+  class MissingHeadersError < Error; end
+  class NotSupportedError < Error; end
+  class ScrambledHeadersError < Error; end
+  class SourcedIdDuplicatedError < Error; end
+end

data/lib/meibo/factory_bot/academic_session.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+require 'factory_bot'
+require 'securerandom'
+
+FactoryBot.define do
+  factory :meibo_academic_session, class: 'Meibo::AcademicSession' do
+    initialize_with { new(**attributes) }
+
+    transient do
+      today { Date.today }
+      parent { nil }
+    end
+
+    sourced_id { SecureRandom.uuid }
+    title { "#{school_year}年度" }
+    type { Meibo::AcademicSession::TYPES[:school_year] }
+    start_date { Date.new(school_year, 4, 1).iso8601 }
+    end_date { Date.new(school_year + 1, 3, 31).iso8601 }
+    parent_sourced_id { parent&.sourced_id }
+    school_year { today.year }
+  end
+end

data/lib/meibo/factory_bot/all.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+require 'meibo/factory_bot/academic_session'
+require 'meibo/factory_bot/classroom'
+require 'meibo/factory_bot/course'
+require 'meibo/factory_bot/demographic'
+require 'meibo/factory_bot/enrollment'
+require 'meibo/factory_bot/manifest'
+require 'meibo/factory_bot/memory_package'
+require 'meibo/factory_bot/organization'
+require 'meibo/factory_bot/role'
+require 'meibo/factory_bot/user_profile'
+require 'meibo/factory_bot/user'

data/lib/meibo/factory_bot/classroom.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+require 'factory_bot'
+require 'securerandom'
+
+FactoryBot.define do
+  factory :meibo_classroom, class: 'Meibo::Classroom' do
+    initialize_with { new(**attributes) }
+
+    transient do
+      course { nil }
+      school { nil }
+      terms { [] }
+    end
+
+    sourced_id { SecureRandom.uuid }
+    sequence(:title) {|n| "#{n}組" }
+    course_sourced_id { course&.sourced_id }
+    class_type { Meibo::Classroom::TYPES[:homeroom] }
+    school_sourced_id { school&.sourced_id }
+    term_sourced_ids { terms.map(&:sourced_id) }
+    special_needs { false }
+
+    trait :special_needs do
+      special_needs { true }
+    end
+  end
+end

data/lib/meibo/factory_bot/course.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+require 'factory_bot'
+require 'securerandom'
+
+FactoryBot.define do
+  factory :meibo_course, class: 'Meibo::Course' do
+    initialize_with { new(**attributes) }
+
+    transient do
+      school_year { nil }
+      organization { nil }
+    end
+
+    sourced_id { SecureRandom.uuid }
+    school_year_sourced_id { school_year&.sourced_id }
+    title { "#{school_year&.title}ホームルーム" }
+    course_code { '' }
+    org_sourced_id { organization&.sourced_id }
+  end
+end

data/lib/meibo/factory_bot/demographic.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+require 'factory_bot'
+require 'securerandom'
+
+FactoryBot.define do
+  factory :meibo_demographic, class: 'Meibo::Demographic' do
+    initialize_with { new(**attributes) }
+
+    transient do
+      user { nil }
+    end
+
+    sourced_id { user&.sourced_id || SecureRandom.uuid }
+  end
+end

data/lib/meibo/factory_bot/enrollment.rb

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+require 'factory_bot'
+require 'securerandom'
+
+FactoryBot.define do
+  factory :meibo_enrollment, class: 'Meibo::Enrollment' do
+    initialize_with { new(**attributes) }
+
+    transient do
+      classroom { nil }
+      school { nil }
+      user { nil }
+    end
+
+    sourced_id { SecureRandom.uuid }
+    class_sourced_id { classroom&.sourced_id }
+    school_sourced_id { school&.sourced_id }
+    user_sourced_id { user&.sourced_id }
+
+    trait :student do
+      role { Meibo::Enrollment::ROLES[:student] }
+    end
+
+    trait :teacher do
+      role { Meibo::Enrollment::ROLES[:teacher] }
+    end
+
+    trait :administrator do
+      role { Meibo::Enrollment::ROLES[:administrator] }
+    end
+
+    trait :guardian do
+      role { Meibo::Enrollment::ROLES[:guardian] }
+    end
+  end
+end

data/lib/meibo/factory_bot/manifest.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+require 'factory_bot'
+
+FactoryBot.define do
+  factory :meibo_manifest, class: 'Meibo::Manifest' do
+    initialize_with { new(**attributes) }
+
+    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/memory_package.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+require 'factory_bot'
+
+FactoryBot.define do
+  factory :meibo_memory_package, class: 'Meibo::MemoryPackage' do
+    initialize_with { new(**attributes) }
+
+    manifest { build(:meibo_manifest) }
+  end
+end

data/lib/meibo/factory_bot/organization.rb

@@ -0,0 +1,47 @@
+# frozen_string_literal: true
+
+require 'factory_bot'
+require 'securerandom'
+
+FactoryBot.define do
+  factory :meibo_organization, class: 'Meibo::Organization' do
+    initialize_with { new(**attributes) }
+
+    transient do
+      parent { nil }
+
+      # NOTE: https://www.mext.go.jp/content/20210128-mxt_chousa01-000011635_01.pdf
+      school_type { 'B1' } # 小学校
+      prefecture_no { '01' } # 北海道
+      kubun { '2' } #公立
+      sequence(:school_no) {|n| '%07d' % n }
+    end
+
+    sourced_id { SecureRandom.uuid }
+    parent_sourced_id { parent&.sourced_id }
+    identifier do
+      school_type_alphabet_map = { 'A' => '01', 'B' => '02', 'C' => '03', 'D' => '04', 'E' => '05', 'F' => '06', 'G' => '07', 'H' => '08' }.freeze
+      numerized_school_type = school_type.sub(/\A[A-H]/, school_type_alphabet_map)
+      numerized_school_code = "#{numerized_school_type}#{prefecture_no}#{kubun}#{school_no}"
+
+      raise unless numerized_school_code.size == 13
+
+      check_digit = (10 - (numerized_school_code.chars.map(&:to_i).zip([1, 2].cycle).map { (_1 * _2).digits.sum }.sum % 10)) % 10
+      "#{school_type}#{prefecture_no}#{kubun}#{school_no}#{check_digit}"
+    end
+
+    trait :district do
+      type { Meibo::Organization::TYPES[:district] }
+    end
+
+    trait :school do
+      type { Meibo::Organization::TYPES[:school] }
+    end
+
+    trait :elementary_school do |factory|
+      type { Meibo::Organization::TYPES[:school] }
+      sequence(:name) {|n| "第#{n}小学校" }
+      school_type { 'B1' }
+    end
+  end
+end

data/lib/meibo/factory_bot/role.rb

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+
+require 'factory_bot'
+require 'securerandom'
+
+FactoryBot.define do
+  factory :meibo_role, class: 'Meibo::Role' do
+    initialize_with { new(**attributes) }
+
+    transient do
+      user { nil }
+      organization { nil }
+      user_profile { nil }
+    end
+
+    sourced_id { SecureRandom.uuid }
+    user_sourced_id { user&.sourced_id }
+    org_sourced_id { organization&.sourced_id }
+    user_profile_sourced_id { user_profile&.sourced_id }
+
+    trait :primary do
+      role_type { Meibo::Role::TYPES[:primary] }
+    end
+
+    trait :secondary do
+      role_type { Meibo::Role::TYPES[:secondary] }
+    end
+
+    trait :teacher do
+      role { Meibo::Role::ROLES[:teacher] }
+    end
+
+    trait :student do
+      role { Meibo::Role::ROLES[:student] }
+    end
+
+    trait :guardian do
+      role { Meibo::Role::ROLES[:guardian] }
+    end
+  end
+end

data/lib/meibo/factory_bot/user.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+require 'factory_bot'
+require 'securerandom'
+
+FactoryBot.define do
+  factory :meibo_user, class: 'Meibo::User' do
+    initialize_with { new(**attributes) }
+
+    transient do
+      agents { [] }
+      primary_organization { nil }
+    end
+
+    sourced_id { SecureRandom.uuid }
+    sequence(:username) {|n| "user#{n}@example.com" }
+    sequence(:given_name) {|n| "John#{n}" }
+    sequence(:family_name) {|n| "Doe#{n}" }
+    agent_sourced_ids { agents&.map(&:sourced_id) }
+    primary_org_sourced_id { primary_organization&.sourced_id }
+  end
+end

data/lib/meibo/factory_bot/user_profile.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+require 'factory_bot'
+require 'securerandom'
+
+FactoryBot.define do
+  factory :meibo_user_profile, class: 'Meibo::UserProfile' do
+    initialize_with { new(**attributes) }
+
+    transient do
+      user { nil }
+    end
+
+    sourced_id { SecureRandom.uuid }
+    user_sourced_id { user&.sourced_id }
+    profile_type { 'meibo test' }
+    vendor_id { 'meibo' }
+    credential_type { 'plain' }
+    sequence(:username) {|n| "user#{n}"}
+  end
+end

data/lib/meibo/japan_profile/academic_session.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+module Meibo
+  module JapanProfile
+    class AcademicSession < ::Meibo::AcademicSession
+      TYPES = { school_year: 'schoolYear' }.freeze
+
+      DataModel.define(
+        self,
+        attribute_name_to_header_field_map: superclass.attribute_name_to_header_field_map,
+        converters: superclass.converters.merge(
+          enum: { type: TYPES.values.freeze }.freeze
+        )
+      )
+
+      # 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), **other_fields)
+        super(school_year: school_year, title: title, type: type, start_date: start_date, end_date: end_date, **other_fields)
+      end
+    end
+  end
+end

data/lib/meibo/japan_profile/classroom.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module Meibo
+  module JapanProfile
+    class Classroom < ::Meibo::Classroom
+      DataModel.define(
+        self,
+        attribute_name_to_header_field_map: superclass.attribute_name_to_header_field_map.merge(special_needs: 'metadata.jp.specialNeeds').freeze,
+        converters: superclass.converters.merge(
+          boolean: [:special_needs].freeze,
+          enum: { class_type: TYPES.values.freeze }.freeze
+        ).freeze
+      )
+
+      def initialize(special_needs: nil, **other_fields)
+        super(**other_fields)
+        @special_needs = special_needs
+      end
+    end
+  end
+end

data/lib/meibo/japan_profile/course.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module Meibo
+  module JapanProfile
+    class Course < ::Meibo::Course
+      DataModel.define(
+        self,
+        attribute_name_to_header_field_map: superclass.attribute_name_to_header_field_map,
+        converters: superclass.converters.merge(enum: { course_code: [''].freeze }.freeze)
+      )
+
+      # NOTE: courseCodeは空文字固定
+      def initialize(course_code: '', **other_fields)
+        super(course_code: course_code, **other_fields)
+      end
+    end
+  end
+end

data/lib/meibo/japan_profile/demographic.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module Meibo
+  module JapanProfile
+    class Demographic < ::Meibo::Demographic
+      DataModel.define(
+        self,
+        attribute_name_to_header_field_map: superclass.attribute_name_to_header_field_map,
+        converters: superclass.converters.merge(
+          enum: { sex: SEX.values.freeze }
+        ).freeze
+      )
+    end
+  end
+end

data/lib/meibo/japan_profile/enrollment.rb

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

data/lib/meibo/japan_profile/organization.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module Meibo
+  module JapanProfile
+    class Organization < ::Meibo::Organization
+      TYPES = {
+        district: 'district',
+        school: 'school'
+      }.freeze
+
+      DataModel.define(
+        self,
+        attribute_name_to_header_field_map: superclass.attribute_name_to_header_field_map,
+        converters: superclass.converters.merge(
+          enum: { type: TYPES.values.freeze }
+        ).freeze
+      )
+    end
+  end
+end

data/lib/meibo/japan_profile/role.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+module Meibo
+  module JapanProfile
+    class Role < ::Meibo::Role
+      # NOTE: roleは固定
+      #   - 児童生徒の場合student
+      #   - 教職員の場合teacher
+      #   - 保護者の場合guardian
+      # MEMO: enrollments.csvの方ではadministratorとguardianも許可されているがズレてないか
+      ROLES = {
+        teacher: 'teacher',
+        student: 'student',
+        guardian: 'guardian'
+      }.freeze
+
+      DataModel.define(
+        self,
+        attribute_name_to_header_field_map: superclass.attribute_name_to_header_field_map,
+        converters: superclass.converters.merge(
+          enum: superclass.converters[:enum].merge(role: ROLES.values).freeze
+        )
+      )
+    end
+  end
+end