meibo 0.16.0 → 0.17.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e25f22026f4551e67b4016aad6a5e526e8ccfefe07e860b0f1ec092b6e21dd37
-  data.tar.gz: 608bd3b794791f86d01a3931ddb17433d26ce7631ac125881b3bb01f14e7958d
+  metadata.gz: a5350e34b1f267f232e20b8551f5b34b24977191b4806d081f66934e816ef6a2
+  data.tar.gz: 71e84fe449b9b64a78cf53b605633eacc9e0a56ebefe80d844e36741b2a760fe
 SHA512:
-  metadata.gz: 0cc22ea80b35a152b99de89bd6452cad6699d950653a8461976f73e0d93f64e4a3974641cf1f12802372e0a8d9f8f31e2b7c7d1c49deddbd03d66eb2006970f4
-  data.tar.gz: 3f60761df5b94e9dd8f60661b730598b34788c6ff980eb83924bc8c472a9facf890e12d0b08a6d777fdd4184954d023f37fb613b494eee889544664807ada22d
+  metadata.gz: 40950b59e99e11e1925afbb8474d5b09b7812619348a216a55639ea960a0fa5cff4c584850395cc5180b0057f65ed02439adeae5d9570b9837037a1cfe04e038
+  data.tar.gz: 8fbf1f6b72c2939c0a8ac9cf39fb1094eca8838b09f8024ce4fe4b31d8845c72402d2c871e21eaccf5c4ca615e796fcd7bab41e517061e5edc437e152f5a10b9

data/.rubocop.yml

@@ -1,5 +1,12 @@
+require:
+  - rubocop-rake
+  - rubocop-rspec
+
+inherit_from: .rubocop_todo.yml
+
 AllCops:
-  TargetRubyVersion: 2.6
+  NewCops: enable
+  TargetRubyVersion: 2.7
 
 Style/StringLiterals:
   Enabled: true
@@ -8,6 +15,3 @@ Style/StringLiterals:
 Style/StringLiteralsInInterpolation:
   Enabled: true
   EnforcedStyle: double_quotes
-
-Layout/LineLength:
-  Max: 120

data/.rubocop_todo.yml

@@ -0,0 +1,130 @@
+# This configuration was generated by
+# `rubocop --auto-gen-config`
+# on 2022-12-06 10:28:10 UTC using RuboCop version 1.36.0.
+# The point is for the user to remove these configuration records
+# one by one as the offenses are removed from the code base.
+# Note that changes in the inspected code, or installation of new
+# versions of RuboCop, may require this file to be generated again.
+
+# Offense count: 19
+# Configuration parameters: AllowComments.
+Lint/EmptyInPattern:
+  Exclude:
+    - 'spec/meibo/reader_spec.rb'
+    - 'spec/meibo/roster_spec.rb'
+
+# Offense count: 1
+# This cop supports safe autocorrection (--autocorrect).
+# Configuration parameters: AllowUnusedKeywordArguments, IgnoreEmptyMethods, IgnoreNotImplementedMethods.
+Lint/UnusedMethodArgument:
+  Exclude:
+    - 'lib/meibo/enrollment.rb'
+
+# Offense count: 10
+# Configuration parameters: AllowedMethods, AllowedPatterns, IgnoredMethods, CountRepeatedAttributes.
+Metrics/AbcSize:
+  Max: 28
+
+# Offense count: 11
+# Configuration parameters: CountComments, CountAsOne, ExcludedMethods, AllowedMethods, AllowedPatterns, IgnoredMethods, inherit_mode.
+# AllowedMethods: refine
+Metrics/BlockLength:
+  Max: 57
+
+# Offense count: 4
+# Configuration parameters: CountComments, CountAsOne.
+Metrics/ClassLength:
+  Max: 156
+
+# Offense count: 1
+# Configuration parameters: AllowedMethods, AllowedPatterns, IgnoredMethods.
+Metrics/CyclomaticComplexity:
+  Max: 10
+
+# Offense count: 26
+# Configuration parameters: CountComments, CountAsOne, ExcludedMethods, AllowedMethods, AllowedPatterns, IgnoredMethods.
+Metrics/MethodLength:
+  Max: 25
+
+# Offense count: 1
+# Configuration parameters: CountComments, CountAsOne.
+Metrics/ModuleLength:
+  Max: 222
+
+# Offense count: 16
+# Configuration parameters: CountKeywordArgs, MaxOptionalParameters.
+Metrics/ParameterLists:
+  Max: 25
+
+# Offense count: 1
+# Configuration parameters: AllowedMethods, AllowedPatterns, IgnoredMethods.
+Metrics/PerceivedComplexity:
+  Max: 11
+
+# Offense count: 25
+# Configuration parameters: MinNameLength, AllowNamesEndingInNumbers, AllowedNames, ForbiddenNames.
+# AllowedNames: as, at, by, db, id, in, io, ip, of, on, os, pp, to
+Naming/MethodParameterName:
+  Exclude:
+    - 'lib/meibo/builder.rb'
+    - 'lib/meibo/builder/academic_session_builder.rb'
+    - 'lib/meibo/builder/classroom_builder.rb'
+    - 'lib/meibo/builder/course_builder.rb'
+    - 'lib/meibo/builder/demographic_builder.rb'
+    - 'lib/meibo/builder/enrollment_builder.rb'
+    - 'lib/meibo/builder/organization_builder.rb'
+    - 'lib/meibo/builder/role_builder.rb'
+    - 'lib/meibo/builder/user_builder.rb'
+    - 'lib/meibo/builder/user_profile_builder.rb'
+
+# Offense count: 5
+# Configuration parameters: CountAsOne.
+RSpec/ExampleLength:
+  Max: 213
+
+# Offense count: 1
+# Configuration parameters: Include, CustomTransform, IgnoreMethods, SpecSuffixOnly.
+# Include: **/*_spec*rb*, **/spec/**/*
+RSpec/FilePath:
+  Exclude:
+    - 'spec/meibo/japan_profile_user_set_spec.rb'
+
+# Offense count: 2
+RSpec/MultipleExpectations:
+  Max: 9
+
+# Offense count: 4
+# Configuration parameters: AllowSubject.
+RSpec/MultipleMemoizedHelpers:
+  Max: 6
+
+# Offense count: 1
+# Configuration parameters: AllowedGroups.
+RSpec/NestedGroups:
+  Max: 4
+
+# Offense count: 49
+# Configuration parameters: AllowedConstants.
+Style/Documentation:
+  Enabled: false
+
+# Offense count: 2
+# This cop supports safe autocorrection (--autocorrect).
+# Configuration parameters: EnforcedStyle.
+# SupportedStyles: format, sprintf, percent
+Style/FormatString:
+  Exclude:
+    - 'lib/meibo/converter.rb'
+    - 'lib/meibo/factory_bot/organization.rb'
+
+# Offense count: 1
+Style/MultilineBlockChain:
+  Exclude:
+    - 'lib/meibo/data_set.rb'
+
+# Offense count: 12
+# This cop supports safe autocorrection (--autocorrect).
+# Configuration parameters: AllowHeredoc, AllowURI, URISchemes, IgnoreCopDirectives, AllowedPatterns, IgnoredPatterns.
+# URISchemes: http, https
+Layout/LineLength:
+  Max: 454

data/Gemfile

@@ -10,6 +10,8 @@ gem "rake", "~> 13.0"
 gem "rspec", "~> 3.0"
 
 gem "rubocop", "~> 1.21"
+gem "rubocop-rake"
+gem "rubocop-rspec"
 
 gem "factory_bot"
 

data/Gemfile.lock

@@ -1,7 +1,8 @@
 PATH
   remote: .
   specs:
-    meibo (0.16.0)
+    meibo (0.17.0)
+      csv (>= 3.1.4)
       rubyzip
       zeitwerk
 
@@ -15,6 +16,7 @@ GEM
       tzinfo (~> 2.0)
     ast (2.4.2)
     concurrent-ruby (1.1.10)
+    csv (3.2.5)
     debug (1.6.3)
       irb (>= 1.3.6)
       reline (>= 0.3.1)
@@ -62,14 +64,19 @@ GEM
       unicode-display_width (>= 1.4.0, < 3.0)
     rubocop-ast (1.22.0)
       parser (>= 3.1.1.0)
+    rubocop-rake (0.6.0)
+      rubocop (~> 1.0)
+    rubocop-rspec (2.15.0)
+      rubocop (~> 1.33)
     ruby-progressbar (1.11.0)
     rubyzip (2.3.2)
     tzinfo (2.0.5)
       concurrent-ruby (~> 1.0)
     unicode-display_width (2.3.0)
-    zeitwerk (2.6.5)
+    zeitwerk (2.6.6)
 
 PLATFORMS
+  ruby
   x86_64-linux
 
 DEPENDENCIES
@@ -79,6 +86,8 @@ DEPENDENCIES
   rake (~> 13.0)
   rspec (~> 3.0)
   rubocop (~> 1.21)
+  rubocop-rake
+  rubocop-rspec
 
 BUNDLED WITH
    2.3.7

data/lib/meibo/academic_session.rb

@@ -3,36 +3,37 @@
 module Meibo
   class AcademicSession
     TYPES = {
-      grading_period: 'gradingPeriod',
-      semester: 'semester',
-      school_year: 'schoolYear',
-      term: 'term'
+      grading_period: "gradingPeriod",
+      semester: "semester",
+      school_year: "schoolYear",
+      term: "term"
     }.freeze
 
     DataModel.define(
       self,
       attribute_name_to_header_field_map: {
-        sourced_id: 'sourcedId',
-        status: 'status',
-        date_last_modified: 'dateLastModified',
-        title: 'title',
-        type: 'type',
-        start_date: 'startDate',
-        end_date: 'endDate',
-        parent_sourced_id: 'parentSourcedId',
-        school_year: 'schoolYear'
+        sourced_id: "sourcedId",
+        status: "status",
+        date_last_modified: "dateLastModified",
+        title: "title",
+        type: "type",
+        start_date: "startDate",
+        end_date: "endDate",
+        parent_sourced_id: "parentSourcedId",
+        school_year: "schoolYear"
       }.freeze,
       converters: {
         enum: { type: [*TYPES.values.freeze, ENUM_EXT_PATTERN] }.freeze,
-        date: [:start_date, :end_date].freeze,
+        date: %i[start_date end_date].freeze,
         datetime: [:date_last_modified].freeze,
-        required: [:sourced_id, :title, :type, :start_date, :end_date, :school_year].freeze,
+        required: %i[sourced_id title type start_date end_date school_year].freeze,
         status: [:status].freeze,
         year: [:school_year].freeze
       }.freeze
     )
 
-    def initialize(sourced_id:, status: nil, date_last_modified: nil, school_year:, title: nil, type:, start_date:, end_date:, parent_sourced_id: nil, **extension_fields)
+    def initialize(sourced_id:, school_year:, type:, start_date:, end_date:, status: nil, date_last_modified: nil,
+                   title: nil, parent_sourced_id: nil, **extension_fields)
       @sourced_id = sourced_id
       @status = status
       @date_last_modified = date_last_modified

data/lib/meibo/builder/academic_session_builder.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require 'securerandom'
+require "securerandom"
 
 module Meibo
   class Builder
@@ -8,7 +8,7 @@ module Meibo
       extend BaseBuilder
 
       def self.builder_attribute_names
-        [:builder, :parent]
+        %i[builder parent]
       end
 
       def initialize(builder:, sourced_id: SecureRandom.uuid, parent: nil, **kw)

data/lib/meibo/builder/base_builder.rb

@@ -1,13 +1,14 @@
+# frozen_string_literal: true
+
 module Meibo
   class Builder
     module BaseBuilder
       def create(klass)
         builder_klass = Class.new(klass)
         builder_klass.prepend(self)
-        builder_klass.attr_reader(*self.builder_attribute_names)
+        builder_klass.attr_reader(*builder_attribute_names)
         builder_klass
       end
     end
   end
 end
-

data/lib/meibo/builder/classroom_builder.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require 'securerandom'
+require "securerandom"
 
 module Meibo
   class Builder
@@ -8,10 +8,10 @@ module Meibo
       extend BaseBuilder
 
       def self.builder_attribute_names
-        [:builder, :course, :school, :terms]
+        %i[builder course school terms]
       end
 
-      def initialize(builder:, sourced_id: SecureRandom.uuid, course:, school:, terms:, **kw)
+      def initialize(builder:, course:, school:, terms:, sourced_id: SecureRandom.uuid, **kw)
         super(
           sourced_id: sourced_id,
           course_sourced_id: course.sourced_id,

data/lib/meibo/builder/course_builder.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require 'securerandom'
+require "securerandom"
 
 module Meibo
   class Builder
@@ -8,10 +8,10 @@ module Meibo
       extend BaseBuilder
 
       def self.builder_attribute_names
-        [:builder, :school_year, :organization]
+        %i[builder school_year organization]
       end
 
-      def initialize(builder:, sourced_id: SecureRandom.uuid, school_year: nil, organization:, **kw)
+      def initialize(builder:, organization:, sourced_id: SecureRandom.uuid, school_year: nil, **kw)
         super(
           sourced_id: sourced_id,
           school_year_sourced_id: school_year&.sourced_id,

data/lib/meibo/builder/demographic_builder.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require 'securerandom'
+require "securerandom"
 
 module Meibo
   class Builder
@@ -8,7 +8,7 @@ module Meibo
       extend BaseBuilder
 
       def self.builder_attribute_names
-        [:builder, :user]
+        %i[builder user]
       end
 
       def initialize(builder:, user:, **kw)

data/lib/meibo/builder/enrollment_builder.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require 'securerandom'
+require "securerandom"
 
 module Meibo
   class Builder
@@ -8,10 +8,10 @@ module Meibo
       extend BaseBuilder
 
       def self.builder_attribute_names
-        [:builder, :classroom, :school, :user]
+        %i[builder classroom school user]
       end
 
-      def initialize(builder:, sourced_id: SecureRandom.uuid, classroom:, school:, user:, **kw)
+      def initialize(builder:, classroom:, school:, user:, sourced_id: SecureRandom.uuid, **kw)
         super(
           sourced_id: sourced_id,
           class_sourced_id: classroom.sourced_id,

data/lib/meibo/builder/organization_builder.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require 'securerandom'
+require "securerandom"
 
 module Meibo
   class Builder
@@ -8,7 +8,7 @@ module Meibo
       extend BaseBuilder
 
       def self.builder_attribute_names
-        [:builder, :parent]
+        %i[builder parent]
       end
 
       def initialize(builder:, sourced_id: SecureRandom.uuid, parent: nil, **kw)

data/lib/meibo/builder/role_builder.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require 'securerandom'
+require "securerandom"
 
 module Meibo
   class Builder
@@ -8,10 +8,10 @@ module Meibo
       extend BaseBuilder
 
       def self.builder_attribute_names
-        [:builder, :user, :organization, :user_profile]
+        %i[builder user organization user_profile]
       end
 
-      def initialize(builder:, sourced_id: SecureRandom.uuid, user:, organization:, user_profile: nil, **kw)
+      def initialize(builder:, user:, organization:, sourced_id: SecureRandom.uuid, user_profile: nil, **kw)
         super(
           sourced_id: sourced_id,
           user_sourced_id: user.sourced_id,

data/lib/meibo/builder/user_builder.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require 'securerandom'
+require "securerandom"
 
 module Meibo
   class Builder
@@ -8,7 +8,7 @@ module Meibo
       extend BaseBuilder
 
       def self.builder_attribute_names
-        [:builder, :agents, :primary_organization]
+        %i[builder agents primary_organization]
       end
 
       def initialize(builder:, sourced_id: SecureRandom.uuid, agents: nil, primary_organization: nil, **kw)

data/lib/meibo/builder/user_profile_builder.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require 'securerandom'
+require "securerandom"
 
 module Meibo
   class Builder
@@ -8,10 +8,10 @@ module Meibo
       extend BaseBuilder
 
       def self.builder_attribute_names
-        [:builder, :user]
+        %i[builder user]
       end
 
-      def initialize(builder:, sourced_id: SecureRandom.uuid, user:, **kw)
+      def initialize(builder:, user:, sourced_id: SecureRandom.uuid, **kw)
         super(sourced_id: sourced_id, user_sourced_id: user.sourced_id, **kw)
         @builder = builder
         @user = user

data/lib/meibo/builder.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require 'forwardable'
+require "forwardable"
 
 module Meibo
   class Builder
@@ -8,7 +8,8 @@ module Meibo
 
     attr_reader :roster, :profile
 
-    def_delegators :@roster, :academic_sessions, :classes, :courses, :demographics, :enrollments, :organizations, :roles, :users, :user_profiles
+    def_delegators :@roster, :academic_sessions, :classes, :courses, :demographics, :enrollments, :organizations,
+                   :roles, :users, :user_profiles
 
     def initialize(roster:, profile: Meibo.default_profile)
       @roster = roster

data/lib/meibo/classroom.rb

@@ -3,49 +3,48 @@
 module Meibo
   class Classroom
     TYPES = {
-      homeroom: 'homeroom',
-      scheduled: 'scheduled'
+      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'
+        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: [
-          :grades,
-          :term_sourced_ids,
-          :subjects,
-          :subject_codes,
-          :periods
+        list: %i[
+          grades
+          term_sourced_ids
+          subjects
+          subject_codes
+          periods
         ].freeze,
-        required: [:sourced_id, :title, :class_type, :course_sourced_id, :term_sourced_ids, :school_sourced_id].freeze,
+        required: %i[sourced_id title class_type course_sourced_id term_sourced_ids school_sourced_id].freeze,
         status: [:status].freeze
       }
     )
 
-    def initialize(sourced_id:, status: nil, date_last_modified: nil, title:, grades: [], course_sourced_id:, class_code: nil, class_type:, location: nil, school_sourced_id:, term_sourced_ids:, subjects: [], subject_codes: [], periods: [], **extension_fields)
-      unless subjects.is_a?(Array) && subject_codes.is_a?(Array) && subjects.size == subject_codes.size
-        raise InvalidDataTypeError
-      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
 
       @sourced_id = sourced_id
       @status = status
@@ -85,7 +84,7 @@ module Meibo
     end
 
     def terms
-      term_sourced_ids.map {|term_sourced_id| Meibo.current_roster.academic_sessions.find(term_sourced_id) }
+      term_sourced_ids.map { |term_sourced_id| Meibo.current_roster.academic_sessions.find(term_sourced_id) }
     end
 
     def enrollments

data/lib/meibo/classroom_set.rb

@@ -9,9 +9,7 @@ module Meibo
         roster.organizations.find(classroom.school_sourced_id)
         roster.courses.find(classroom.course_sourced_id)
 
-        if classroom.term_sourced_ids.empty?
-          raise DataNotFoundError, "termSourcedIdは1つ以上指定してください"
-        end
+        raise DataNotFoundError, "termSourcedIdは1つ以上指定してください" if classroom.term_sourced_ids.empty?
 
         classroom.term_sourced_ids.each do |term_sourced_id|
           roster.academic_sessions.find(term_sourced_id)