scorm-package 0.1.0 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b6c845da6facaddb39a95ceda211bc5f65916e26bcadd79df356fb34b5d1bc8f
-  data.tar.gz: 8ec19304fc472e74a9c21058a2e2e579ab5f2be5dd2a68a5e8dfed0edaf7e6b1
+  metadata.gz: c77235f46904e9d96f27cd7921747dfe4f8ff663f5407e825ab95e3c4b2dfbf4
+  data.tar.gz: 22d29281fbcdf7d62d7335e73236c81ed067205a8df992159eb2d988b9eb6836
 SHA512:
-  metadata.gz: ac99c8c52027ceed7dc9c8180883ec82d45d0bd4926a07e04e85fbc15c7169e0bbff194ce0c42e19afe8dbe7da2619acc30b8cecd387f0146bc2a792056738d1
-  data.tar.gz: 978bf31fcd77485a62b7a7dcb73be8f94e405a51229d20b7117b7bb81c3975cf2626c40d40ef200cd868098038596c5aa4af789b8212ee639c22e60eac51f6ea
+  metadata.gz: 6441635343f691037c0d2027d4644807b753cd39baa911f6ce900306ab9e83818cf78bab81dd1131802dc9d9ff59ab6de4aa50810354d1554d9605d172978def
+  data.tar.gz: f66403c1a34352d07021d2921db7ff383e56084fd4ff649bb4fbb4fae3524479fd1bc7ce89f946b7f4a4c08a964dfec237fd00cd7dc5748649212d4271f70a28

data/CHANGELOG.md

@@ -0,0 +1,22 @@
+# Changelog
+
+### [0.1.2](https://www.github.com/openvitae-tech/scorm-package/compare/v0.1.1...v0.1.2) (2025-02-14)
+
+
+### Bug Fixes
+
+* updated gemfile ([6ef33e9](https://www.github.com/openvitae-tech/scorm-package/commit/6ef33e9b6e74373a937e8d41073be9132c5961bc))
+* updated version ([f8d1470](https://www.github.com/openvitae-tech/scorm-package/commit/f8d14701f84d009494b919eeebe325d05ced3e10))
+
+### [0.1.1](https://www.github.com/openvitae-tech/scorm-package/compare/v0.1.0...v0.1.1) (2025-02-10)
+
+
+### Bug Fixes
+
+* test auto version upgrade ([fea7dd4](https://www.github.com/openvitae-tech/scorm-package/commit/fea7dd4c0a756179251f112032fe258d3278cf19))
+
+## 0.3.1 (2025-02-10)
+
+### Features
+
+- Release 0.3.1 ([3b42b6c](https://www.github.com/openvitae-tech/scorm-package/commit/3b42b6ce908929776a69de67c159dc0a67388645))

data/README.md

@@ -1,6 +1,6 @@
 # Scorm Packaging gem
 
-## Local development with Host Application
+## Local development with the Host Application
 
 ### Installation
 

data/lib/scorm_package/base_course.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module ScormPackage
+  class BaseCourse
+    ABSTRACT_METHODS = %i[title description course_modules].freeze
+
+    def initialize
+      raise "Cannot initialize an abstract BaseCourse class" if instance_of?(BaseCourse)
+
+      missing_methods = ABSTRACT_METHODS.reject { |method| respond_to?(method) }
+      return if missing_methods.empty?
+
+      raise NotImplementedError, "#{self.class} must implement methods: #{missing_methods.join(", ")}"
+    end
+  end
+end

data/lib/scorm_package/base_course_module.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module ScormPackage
+  class BaseCourseModule
+    ABSTRACT_METHODS = %i[title lessons].freeze
+
+    def initialize
+      raise "Cannot initialize an abstract BaseCourseModule class" if instance_of?(BaseCourseModule)
+
+      missing_methods = ABSTRACT_METHODS.reject { |method| respond_to?(method) }
+      return if missing_methods.empty?
+
+      raise NotImplementedError, "#{self.class} must implement methods: #{missing_methods.join(", ")}"
+    end
+  end
+end

data/lib/scorm_package/base_lesson.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module ScormPackage
+  class BaseLesson
+    ABSTRACT_METHODS = %i[title videos].freeze
+
+    def initialize
+      raise "Cannot initialize an abstract BaseLesson class" if instance_of?(BaseLesson)
+
+      missing_methods = ABSTRACT_METHODS.reject { |method| respond_to?(method) }
+      return if missing_methods.empty?
+
+      raise NotImplementedError, "#{self.class} must implement methods: #{missing_methods.join(", ")}"
+    end
+  end
+end

data/lib/scorm_package/base_video.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module ScormPackage
+  class BaseVideo
+    ABSTRACT_METHODS = %i[id language video_url].freeze
+
+    def initialize
+      raise "Cannot initialize an abstract BaseVideo class" if instance_of?(BaseVideo)
+
+      missing_methods = ABSTRACT_METHODS.reject { |method| respond_to?(method) }
+      return if missing_methods.empty?
+
+      raise NotImplementedError, "#{self.class} must implement methods: #{missing_methods.join(", ")}"
+    end
+  end
+end

data/lib/scorm_package/packaging/{generate.rb → generator.rb}

@@ -4,15 +4,14 @@ require_relative "create_zip"
 
 module ScormPackage
   module Packaging
-    class Generate
-      attr_reader :course, :scorm_token
+    class Generator
+      attr_reader :course
 
-      def initialize(course, scorm_token)
+      def initialize(course)
         @course = course
-        @scorm_token = scorm_token
       end
 
-      def process
+      def generate
         manifest = generate_manifest
         lessons_html = generate_lesson_contents
         ScormPackage::Packaging::CreateZip.new(manifest, lessons_html).process
@@ -84,6 +83,18 @@ module ScormPackage
         end.join
       end
 
+      def generate_lesson_contents
+        lessons_hash = {}
+
+        course.course_modules.each_with_index do |mod, mod_index|
+          mod.lessons.each_with_index do |lesson, lesson_index|
+            lesson_path = "content/module#{mod_index + 1}/lesson#{lesson_index + 1}.html"
+            lessons_hash[lesson_path] = generate_lesson_html(lesson)
+          end
+        end
+        lessons_hash
+      end
+
       def generate_lesson_html(lesson)
         <<~HTML
           <!DOCTYPE html>
@@ -94,50 +105,30 @@ module ScormPackage
             <script src="../../scormfunctions.js"></script>
             <title>#{lesson.title}</title>
             <style>
-              .loader { display: none; position: fixed; top: 50%; left: 50%; transform: translate(-50%, -50%); }
+              .loader { display: block; position: fixed; top: 50%; left: 50%; transform: translate(-50%, -50%); }
               iframe { display: none; width: 560px; height: 315px; border: none; }
             </style>
           </head>
           <body>
             <p>Lesson: #{lesson.title}</p>
-            <ul>#{lesson.videos.map do |video|
-              "<li>Language: #{video[:language]}<br>" \
-              "<div id=\"loader-#{video[:id]}\" class=\"loader\">Loading...</div>" \
-              "<iframe id=\"custom-iframe-#{video[:id]}\" data-video-url=\"#{video[:video_url]}\"></iframe></li>"
-            end.join}</ul>
+            <ul>
+              #{lesson.videos.map do |video|
+                "<li>Language: #{video.language}<br>" \
+                "<div id=\"loader-#{video.id}\" class=\"loader\">Loading...</div>" \
+                "<iframe id=\"iframe-#{video.id}\" src=\"#{video.video_url}\" onload=\"hideLoader('#{video.id}')\"></iframe></li>"
+              end.join}
+            </ul>
+
             <script>
-              const loadIframe = async (iframe) => {
-                const loader = document.getElementById(`loader-${iframe.id.split('-').pop()}`);
-                try {
-                  loader.style.display = 'block';
-                  const response = await fetch(iframe.dataset.videoUrl, {
-                    headers: { 'X-Scorm-Token': '#{scorm_token}' }
-                  });
-                  iframe.srcdoc = await response.text();
-                  iframe.style.display = 'block';
-                } catch (error) { console.error(error); }
-                finally { loader.style.display = 'none'; }
-              };
-              window.addEventListener('load', () =>
-                document.querySelectorAll('iframe[data-video-url]').forEach(loadIframe)
-              );
+              function hideLoader(videoId) {
+                document.getElementById('loader-' + videoId).style.display = 'none';
+                document.getElementById('iframe-' + videoId).style.display = 'block';
+              }
             </script>
           </body>
           </html>
         HTML
       end
-
-      def generate_lesson_contents
-        lessons_hash = {}
-
-        course.course_modules.each_with_index do |mod, mod_index|
-          mod.lessons.each_with_index do |lesson, lesson_index|
-            lesson_path = "content/module#{mod_index + 1}/lesson#{lesson_index + 1}.html"
-            lessons_hash[lesson_path] = generate_lesson_html(lesson)
-          end
-        end
-        lessons_hash
-      end
     end
   end
 end

data/lib/scorm_package/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module ScormPackage
-  VERSION = "0.1.0"
+  VERSION = "0.1.2"
 end

data/lib/scorm_package.rb

@@ -1,10 +1,11 @@
 # frozen_string_literal: true
 
 require_relative "scorm_package/version"
-require_relative "scorm_package/abstract_course"
-require_relative "scorm_package/abstract_course_module"
-require_relative "scorm_package/abstract_lesson"
-require_relative "scorm_package/packaging/generate"
+require_relative "scorm_package/base_course"
+require_relative "scorm_package/base_course_module"
+require_relative "scorm_package/base_lesson"
+require_relative "scorm_package/base_video"
+require_relative "scorm_package/packaging/generator"
 
 module ScormPackage
   class Error < StandardError; end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: scorm-package
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.2
 platform: ruby
 authors:
 - Paul Sojan
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2025-01-29 00:00:00.000000000 Z
+date: 2025-02-14 00:00:00.000000000 Z
 dependencies: []
 description:
 email:
@@ -19,20 +19,22 @@ extra_rdoc_files: []
 files:
 - ".rspec"
 - ".rubocop.yml"
+- CHANGELOG.md
 - LICENSE.txt
 - README.md
 - Rakefile
 - lib/scorm_package.rb
-- lib/scorm_package/abstract_course.rb
-- lib/scorm_package/abstract_course_module.rb
-- lib/scorm_package/abstract_lesson.rb
+- lib/scorm_package/base_course.rb
+- lib/scorm_package/base_course_module.rb
+- lib/scorm_package/base_lesson.rb
+- lib/scorm_package/base_video.rb
 - lib/scorm_package/packaging/common/adlcp_rootv1p2.xsd
 - lib/scorm_package/packaging/common/ims_xml.xsd
 - lib/scorm_package/packaging/common/imscp_rootv1p1p2.xsd
 - lib/scorm_package/packaging/common/imsmd_rootv1p2p1.xsd
 - lib/scorm_package/packaging/common/scormfunctions.js
 - lib/scorm_package/packaging/create_zip.rb
-- lib/scorm_package/packaging/generate.rb
+- lib/scorm_package/packaging/generator.rb
 - lib/scorm_package/version.rb
 - sig/scorm_package.rbs
 homepage: https://github.com/openvitae-tech/scorm-package

data/lib/scorm_package/abstract_course.rb

@@ -1,21 +0,0 @@
-# frozen_string_literal: true
-
-module ScormPackage
-  class AbstractCourse
-    def initialize
-      raise "Cannot initialize an abstract Course class"
-    end
-
-    def title
-      raise NotImplementedError, "#{self.class} must implement abstract method 'title'"
-    end
-
-    def description
-      raise NotImplementedError, "#{self.class} must implement abstract method 'description'"
-    end
-
-    def course_modules
-      raise NotImplementedError, "#{self.class} must implement abstract method 'course_modules'"
-    end
-  end
-end

data/lib/scorm_package/abstract_course_module.rb

@@ -1,17 +0,0 @@
-# frozen_string_literal: true
-
-module ScormPackage
-  class AbstractCourseModule
-    def initialize
-      raise "Cannot initialize an abstract CourseModule class"
-    end
-
-    def title
-      raise NotImplementedError, "#{self.class} must implement abstract method 'title'"
-    end
-
-    def lessons
-      raise NotImplementedError, "#{self.class} must implement abstract method 'lessons'"
-    end
-  end
-end

data/lib/scorm_package/abstract_lesson.rb

@@ -1,17 +0,0 @@
-# frozen_string_literal: true
-
-module ScormPackage
-  class AbstractLesson
-    def initialize
-      raise "Cannot initialize an abstract Lesson class"
-    end
-
-    def title
-      raise NotImplementedError, "#{self.class} must implement abstract method 'title'"
-    end
-
-    def videos
-      raise NotImplementedError, "#{self.class} must implement abstract method 'videos'"
-    end
-  end
-end