meibo 0.27.1 → 0.28.0

data/lib/meibo/classroom.rb

@@ -2,49 +2,62 @@
 
 module Meibo
   class Classroom
+    include DataModel
+
     TYPES = {
       homeroom: "homeroom",
       scheduled: "scheduled"
     }.freeze
 
-    DataModel.define(
-      self,
-      attribute_name_to_header_field_map: {
-        sourced_id: "sourcedId",
-        status: "status",
-        date_last_modified: "dateLastModified",
-        title: "title",
-        grades: "grades",
-        course_sourced_id: "courseSourcedId",
-        class_code: "classCode",
-        class_type: "classType",
-        location: "location",
-        school_sourced_id: "schoolSourcedId",
-        term_sourced_ids: "termSourcedIds",
-        subjects: "subjects",
-        subject_codes: "subjectCodes",
-        periods: "periods"
-      }.freeze,
-      converters: {
-        datetime: [:date_last_modified].freeze,
-        enum: {
-          class_type: [*TYPES.values, ENUM_EXT_PATTERN].freeze
-        }.freeze,
-        list: %i[
-          grades
-          term_sourced_ids
-          subjects
-          subject_codes
-          periods
-        ].freeze,
-        required: %i[sourced_id title class_type course_sourced_id term_sourced_ids school_sourced_id].freeze,
-        status: [:status].freeze
-      }
+    define_attributes(
+      sourced_id: "sourcedId",
+      status: "status",
+      date_last_modified: "dateLastModified",
+      title: "title",
+      grades: "grades",
+      course_sourced_id: "courseSourcedId",
+      class_code: "classCode",
+      class_type: "classType",
+      location: "location",
+      school_sourced_id: "schoolSourcedId",
+      term_sourced_ids: "termSourcedIds",
+      subjects: "subjects",
+      subject_codes: "subjectCodes",
+      periods: "periods"
+    )
+
+    define_converters(
+      datetime: [:date_last_modified],
+      enum: {
+        class_type: [*TYPES.values, ENUM_EXT_PATTERN]
+      },
+      list: %i[
+        grades
+        term_sourced_ids
+        subjects
+        subject_codes
+        periods
+      ],
+      required: %i[sourced_id title class_type course_sourced_id term_sourced_ids school_sourced_id],
+      status: [:status]
     )
 
+    def self.parse(csv)
+      return to_enum(:parse, csv) unless block_given?
+
+      _parse(csv).with_index(1) do |row, line|
+        yield new(**row.to_h)
+      rescue SubjectsAndSubjectCodesLengthNotMatch
+        index = attribute_names.index(:subjects)
+        field = row[index]
+        field_info = CSV::FieldInfo.new(index, line, :subjects, false)
+        raise InvalidDataTypeError.new(field: field, field_info: field_info)
+      end
+    end
+
     def initialize(sourced_id:, title:, course_sourced_id:, class_type:, school_sourced_id:, term_sourced_ids:, status: nil, date_last_modified: nil, grades: [],
                    class_code: nil, location: nil, subjects: [], subject_codes: [], periods: [], **extension_fields)
-      raise InvalidDataTypeError unless subjects.is_a?(Array) && subject_codes.is_a?(Array) && subjects.size == subject_codes.size
+      raise SubjectsAndSubjectCodesLengthNotMatch unless subjects.is_a?(Array) && subject_codes.is_a?(Array) && subjects.size == subject_codes.size
 
       @sourced_id = sourced_id
       @status = status

data/lib/meibo/classroom_set.rb

@@ -7,7 +7,11 @@ module Meibo
 
       each do |classroom|
         school = roster.organizations.find(classroom.school_sourced_id)
-        raise InvalidDataTypeError unless school.school?
+        unless school.school?
+          field = classroom.school_sourced_id
+          field_info = field_info_from(classroom, :school_sourced_id)
+          raise InvalidDataTypeError.new(field: field, field_info: field_info)
+        end
 
         roster.courses.find(classroom.course_sourced_id)
 

data/lib/meibo/converter.rb

@@ -1,7 +1,6 @@
 # frozen_string_literal: true
 
 require "date"
-require "set"
 require "time"
 
 module Meibo
@@ -22,7 +21,7 @@ module Meibo
       year
     ].freeze
 
-    class << self
+    class << self # rubocop:disable Metrics/ClassLength
       def build_header_field_to_attribute_converter(attribute_name_to_header_field_map)
         header_field_to_attribute_name_map = attribute_name_to_header_field_map.to_h do |attribute, header_field|
           [header_field, attribute]
@@ -82,7 +81,7 @@ module Meibo
             when nil
               nil
             else
-              raise InvalidDataTypeError
+              raise InvalidDataTypeError.new(field: field, field_info: field_info)
             end
           else
             field
@@ -108,7 +107,7 @@ module Meibo
             begin
               Date.strptime(field, "%Y-%m-%d")
             rescue StandardError
-              raise InvalidDataTypeError
+              raise InvalidDataTypeError.new(field: field, field_info: field_info)
             end
           else
             field
@@ -134,7 +133,7 @@ module Meibo
             begin
               Time.iso8601(field)
             rescue StandardError
-              raise InvalidDataTypeError
+              raise InvalidDataTypeError.new(field: field, field_info: field_info)
             end
           else
             field
@@ -148,7 +147,7 @@ module Meibo
           return field unless field
 
           enum = enum_definition[field_info.index]
-          raise InvalidDataTypeError if enum&.none? { |pat| pat.is_a?(String) ? field == pat : field.match?(pat) }
+          raise InvalidDataTypeError.new(field: field, field_info: field_info) if enum&.none? { |pat| pat.is_a?(String) ? field == pat : field.match?(pat) }
 
           field
         end
@@ -160,7 +159,7 @@ module Meibo
           return field unless field
 
           format = format_definition[field_info.index]
-          raise InvalidDataTypeError if format && !field.match?(format)
+          raise InvalidDataTypeError.new(field: field, field_info: field_info) if format && !field.match?(format)
 
           field
         end
@@ -169,7 +168,7 @@ module Meibo
       def build_fullwidth_field_parser_converter(fullwidth_field_indexes)
         fullwidth_field_indexes = fullwidth_field_indexes.dup.freeze
         lambda do |field, field_info|
-          raise InvalidDataTypeError if field && fullwidth_field_indexes.include?(field_info.index) && field.match?(/[\p{In_Halfwidth_and_Fullwidth_Forms}&&\p{Katakana}]/)
+          raise InvalidDataTypeError.new(field: field, field_info: field_info) if field && fullwidth_field_indexes.include?(field_info.index) && field.match?(/[\p{In_Halfwidth_and_Fullwidth_Forms}&&\p{Katakana}]/)
 
           field
         end
@@ -180,7 +179,7 @@ module Meibo
         lambda do |grades, field_info|
           next grades unless grade_field_indexes.include?(field_info.index)
 
-          raise InvalidDataTypeError unless grades.all? { |grade| valid_grade.include?(grade) }
+          raise InvalidDataTypeError.new(field: grades, field_info: field_info) unless grades.all? { |grade| valid_grade.include?(grade) }
 
           grades
         end
@@ -193,7 +192,7 @@ module Meibo
             begin
               Integer(field, 10)
             rescue StandardError
-              raise InvalidDataTypeError
+              raise InvalidDataTypeError.new(field: field, field_info: field_info)
             end
           else
             field
@@ -236,11 +235,10 @@ module Meibo
       def build_required_field_parser_converter(required_field_indexes)
         required_field_indexes = required_field_indexes.dup.freeze
         lambda do |field, field_info|
-          if required_field_indexes.include?(field_info.index)
-            raise MissingDataError if field.nil?
-            raise MissingDataError if field.respond_to?(:empty?) && field.empty?
-          end
-          field
+          return field unless required_field_indexes.include?(field_info.index)
+          return field if field && (!field.respond_to?(:empty?) || !field.empty?)
+
+          raise MissingDataError.new(field: field, field_info: field_info)
         end
       end
 
@@ -251,7 +249,7 @@ module Meibo
         status_field_indexes = status_field_indexes.dup.freeze
         lambda do |field, field_info|
           if field && status_field_indexes.include?(field_info.index)
-            raise InvalidDataTypeError, "invalid status: #{field}" unless %w[active tobedeleted].include?(field)
+            raise InvalidDataTypeError.new(field: field, field_info: field_info), "invalid status: #{field}" unless %w[active tobedeleted].include?(field)
           else
             field
           end
@@ -264,7 +262,7 @@ module Meibo
           if user_ids_field_indexes.include?(field_info.index) && !field.all? do |user_id|
                Meibo::User::USER_ID_FORMAT_REGEXP.match?(user_id)
              end
-            raise InvalidDataTypeError
+            raise InvalidDataTypeError.new(field: field, field_info: field_info)
           end
 
           field
@@ -289,7 +287,7 @@ module Meibo
             begin
               Integer(field, 10)
             rescue StandardError
-              raise InvalidDataTypeError
+              raise InvalidDataTypeError.new(field: field, field_info: field_info)
             end
           else
             field

data/lib/meibo/course.rb

@@ -2,31 +2,44 @@
 
 module Meibo
   class Course
-    DataModel.define(
-      self,
-      attribute_name_to_header_field_map: {
-        sourced_id: "sourcedId",
-        status: "status",
-        date_last_modified: "dateLastModified",
-        school_year_sourced_id: "schoolYearSourcedId",
-        title: "title",
-        course_code: "courseCode",
-        grades: "grades",
-        org_sourced_id: "orgSourcedId",
-        subjects: "subjects",
-        subject_codes: "subjectCodes"
-      },
-      converters: {
-        datetime: [:date_last_modified],
-        list: %i[grades subjects subject_codes],
-        required: %i[sourced_id title org_sourced_id],
-        status: [:status]
-      }
+    include DataModel
+
+    define_attributes(
+      sourced_id: "sourcedId",
+      status: "status",
+      date_last_modified: "dateLastModified",
+      school_year_sourced_id: "schoolYearSourcedId",
+      title: "title",
+      course_code: "courseCode",
+      grades: "grades",
+      org_sourced_id: "orgSourcedId",
+      subjects: "subjects",
+      subject_codes: "subjectCodes"
+    )
+
+    define_converters(
+      datetime: [:date_last_modified],
+      list: %i[grades subjects subject_codes],
+      required: %i[sourced_id title org_sourced_id],
+      status: [:status]
     )
 
+    def self.parse(csv)
+      return to_enum(:parse, csv) unless block_given?
+
+      _parse(csv).with_index(1) do |row, line|
+        yield new(**row.to_h)
+      rescue SubjectsAndSubjectCodesLengthNotMatch
+        index = attribute_names.index(:subjects)
+        field = row[index]
+        field_info = CSV::FieldInfo.new(index, line, :subjects, false)
+        raise InvalidDataTypeError.new(field: field, field_info: field_info)
+      end
+    end
+
     def initialize(sourced_id:, title:, org_sourced_id:, status: nil, date_last_modified: nil, school_year_sourced_id: nil,
                    course_code: nil, grades: [], subjects: [], subject_codes: [], **extension_fields)
-      raise InvalidDataTypeError unless subjects.is_a?(Array) && subject_codes.is_a?(Array) && subjects.size == subject_codes.size
+      raise SubjectsAndSubjectCodesLengthNotMatch unless subjects.is_a?(Array) && subject_codes.is_a?(Array) && subjects.size == subject_codes.size
 
       @sourced_id = sourced_id
       @status = status

data/lib/meibo/course_set.rb

@@ -9,7 +9,11 @@ module Meibo
         if course.school_year_sourced_id
           school_year = roster.academic_sessions.find(course.school_year_sourced_id)
 
-          raise InvalidDataTypeError unless school_year.school_year?
+          unless school_year.school_year?
+            field = school_year_sourced_id
+            field_info = field_info_from(course, :school_year_sourced_id)
+            raise InvalidDataTypeError.new(field: field, field_info: field_info)
+          end
         end
 
         roster.organizations.find(course.org_sourced_id)

data/lib/meibo/data_model.rb

@@ -5,13 +5,29 @@ require "csv"
 module Meibo
   module DataModel
     module ClassMethods
+      def define_attributes(attribute_names_to_header_fields)
+        attribute_names_to_header_fields = attribute_names_to_header_fields.dup.freeze
+        attribute_names = attribute_names_to_header_fields.keys.freeze
+        header_fields = attribute_names_to_header_fields.values.freeze
+        define_class_attribute(:attribute_names_to_header_fields, attribute_names_to_header_fields)
+        define_class_attribute(:attribute_names, attribute_names)
+        define_class_attribute(:header_fields, header_fields)
+
+        attr_reader(*attribute_names, :extension_fields)
+      end
+
+      def define_converters(converters)
+        converters = converters.dup.freeze
+        define_class_attribute(:converters, converters)
+        define_header_converters
+        define_parser_converters(converters)
+        define_write_converters(converters)
+      end
+
       def parse(csv)
         return to_enum(:parse, csv) unless block_given?
 
-        validate_header_fields(CSV.parse_line(csv))
-
-        CSV.parse(csv, encoding: Meibo::CSV_ENCODING, headers: true, converters: parser_converters,
-                       header_converters: header_converters).each do |row|
+        _parse(csv) do |row|
           yield new(**row.to_h)
         end
       end
@@ -24,44 +40,38 @@ module Meibo
         end
         raise ScrambledHeaderFieldsError unless actual_header_fields.take(header_fields.size) == header_fields
       end
-    end
 
-    def self.define(klass, attribute_name_to_header_field_map:, converters: {})
-      attribute_name_to_header_field_map = attribute_name_to_header_field_map.dup.freeze
-      attribute_names = attribute_name_to_header_field_map.keys.freeze
-      header_fields = attribute_name_to_header_field_map.values.freeze
-      converters = converters.dup.freeze
-      define_class_attribute(klass, :attribute_name_to_header_field_map, attribute_name_to_header_field_map)
-      define_class_attribute(klass, :attribute_names, attribute_names)
-      define_class_attribute(klass, :header_fields, header_fields)
-      define_class_attribute(klass, :converters, converters)
-
-      define_header_converters(klass, attribute_name_to_header_field_map)
-      define_parser_converters(klass, attribute_names: attribute_names, converters: converters)
-      define_write_converters(klass, attribute_names: attribute_names, converters: converters)
-
-      klass.attr_reader(*attribute_names, :extension_fields)
-      klass.extend(ClassMethods)
-      klass.include(self)
-    end
+      private
 
-    def self.define_class_attribute(klass, attribute, value)
-      klass.define_singleton_method(attribute) { value }
-    end
+      def _parse(csv, &)
+        validate_header_fields(CSV.parse_line(csv))
 
-    def self.define_header_converters(klass, attribute_name_to_header_field_map)
-      header_converters = Converter.build_header_field_to_attribute_converter(attribute_name_to_header_field_map)
-      klass.define_singleton_method(:header_converters) { header_converters }
-    end
+        CSV.parse(csv, encoding: Meibo::CSV_ENCODING, headers: true, converters: parser_converters, header_converters: header_converters).each(&)
+      end
 
-    def self.define_parser_converters(klass, attribute_names:, converters:)
-      parser_converter = Converter.build_parser_converter(fields: attribute_names, converters: converters)
-      klass.define_singleton_method(:parser_converters) { parser_converter }
+      def define_class_attribute(attribute, value)
+        define_singleton_method(attribute) { value }
+      end
+
+      def define_header_converters
+        header_converters = Converter.build_header_field_to_attribute_converter(attribute_names_to_header_fields)
+        define_class_attribute(:header_converters, header_converters)
+      end
+
+      def define_parser_converters(converters)
+        parser_converter = Converter.build_parser_converter(fields: attribute_names, converters: converters)
+        define_class_attribute(:parser_converters, parser_converter)
+      end
+
+      def define_write_converters(converters)
+        write_converter = Converter.build_write_converter(fields: attribute_names, converters: converters)
+        define_class_attribute(:write_converters, write_converter)
+      end
     end
 
-    def self.define_write_converters(klass, attribute_names:, converters:)
-      write_converter = Converter.build_write_converter(fields: attribute_names, converters: converters)
-      klass.define_singleton_method(:write_converters) { write_converter }
+    def self.included(base)
+      super
+      base.extend(ClassMethods)
     end
 
     def lineno

data/lib/meibo/data_set.rb

@@ -14,22 +14,14 @@ module Meibo
 
     def <<(new_data)
       raise DataNotFoundError, "sourcedIdがありません" unless new_data.sourced_id
-
-      if data_by_sourced_id.key?(new_data.sourced_id)
-        raise SourcedIdDuplicatedError,
-              "sourcedId\u304C\u91CD\u8907\u3057\u3066\u3044\u307E\u3059"
-      end
+      raise SourcedIdDuplicatedError, "sourcedIdが重複しています" if data_by_sourced_id.key?(new_data.sourced_id)
 
       @data << new_data
       @cache.clear
     end
 
     def check_semantically_consistent
-      unless @data.size == data_by_sourced_id.size
-        raise SourcedIdDuplicatedError,
-              "sourcedId\u304C\u91CD\u8907\u3057\u3066\u3044\u307E\u3059"
-      end
-
+      raise SourcedIdDuplicatedError, "sourcedIdが重複しています" unless @data.size == data_by_sourced_id.size
       raise DataNotFoundError, "sourcedIdがありません" unless data_by_sourced_id[nil].nil?
     end
 
@@ -81,5 +73,11 @@ module Meibo
     def empty_set
       @empty_set ||= new([])
     end
+
+    def field_info_from(model, attribute_name)
+      index = model.class.attribute_names.index(attribute_name)
+      line = lineno(model)
+      CSV::FieldInfo.new(index, line, attribute_name, false)
+    end
   end
 end

data/lib/meibo/demographic.rb

@@ -2,6 +2,8 @@
 
 module Meibo
   class Demographic
+    include DataModel
+
     SEX = {
       male: "male",
       female: "female",
@@ -9,42 +11,40 @@ module Meibo
       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: %i[
-          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
-      }
+    define_attributes(
+      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"
+    )
+
+    define_converters(
+      boolean: %i[
+        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
+      ],
+      date: [:birth_date],
+      datetime: [:date_last_modified],
+      enum: { sex: [*SEX.values, ENUM_EXT_PATTERN] },
+      required: [:sourced_id],
+      status: [:status]
     )
 
     def initialize(sourced_id:, status: nil, date_last_modified: nil, birth_date: nil, sex: nil,

data/lib/meibo/enrollment.rb

@@ -2,6 +2,8 @@
 
 module Meibo
   class Enrollment
+    include DataModel
+
     ROLES = {
       administrator: "administrator",
       proctor: "proctor",
@@ -9,28 +11,26 @@ module Meibo
       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: %i[begin_date end_date].freeze,
-        datetime: [:date_last_modified].freeze,
-        enum: { role: [*ROLES.values, ENUM_EXT_PATTERN].freeze }.freeze,
-        required: %i[sourced_id class_sourced_id school_sourced_id user_sourced_id role].freeze,
-        status: [:status].freeze
-      }
+    define_attributes(
+      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"
+    )
+
+    define_converters(
+      boolean: [:primary],
+      date: %i[begin_date end_date],
+      datetime: [:date_last_modified],
+      enum: { role: [*ROLES.values, ENUM_EXT_PATTERN] },
+      required: %i[sourced_id class_sourced_id school_sourced_id user_sourced_id role],
+      status: [:status]
     )
 
     def initialize(sourced_id:, class_sourced_id:, school_sourced_id:, user_sourced_id:, role:, status: nil,

data/lib/meibo/enrollment_set.rb

@@ -8,10 +8,17 @@ module Meibo
       each do |enrollment|
         roster.classes.find(enrollment.class_sourced_id)
         school = roster.organizations.find(enrollment.school_sourced_id)
-        raise InvalidDataTypeError unless school.school?
+
+        unless school.school?
+          field = enrollment.school_sourced_id
+          field_info = field_info_from(enrollment, :school_sourced_id)
+          raise InvalidDataTypeError.new(field: field, field_info: field_info)
+        end
 
         roster.users.find(enrollment.user_sourced_id)
-        raise InvalidDataTypeError if enrollment.primary && !enrollment.teacher?
+        next if !enrollment.primary || enrollment.teacher?
+
+        raise InvalidDataTypeError.new(field: enrollment.primary, field_info: field_info_from(enrollment, :primary))
       end
     end
 

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

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

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

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