Merge pull request #1115 from concord-consortium/186748228-add-hide-question-numbers-setting

feat: Added setting to hide question numbers per activity or per sequence [PT-#186748228]

Author: dougmartin

app/models/lightweight_activity.rb

@@ -30,7 +30,7 @@ class LightweightActivity < ActiveRecord::Base
                   :time_to_complete, :is_locked, :notes, :thumbnail_url, :project_id,
                   :portal_run_count, :layout, :editor_mode, :publication_hash, :copied_from_id,
                   :student_report_enabled, :show_submit_button, :project, :background_image,
-                  :glossary_id, :hide_read_aloud, :font_size
+                  :glossary_id, :hide_read_aloud, :font_size, :hide_question_numbers
 
   belongs_to :user # Author
   belongs_to :changed_by, :class_name => 'User'
@@ -111,6 +111,7 @@ def to_hash
       student_report_enabled: student_report_enabled,
       show_submit_button: show_submit_button,
       hide_read_aloud: hide_read_aloud,
+      hide_question_numbers: hide_question_numbers,
       font_size: font_size
     }
   end
@@ -158,6 +159,7 @@ def export(host)
                                         :background_image,
                                         :defunct,
                                         :hide_read_aloud,
+                                        :hide_question_numbers,
                                         :font_size ])
     activity_json[:version] = 2
     activity_json[:project] = self.project ? self.project.export : nil
@@ -224,6 +226,7 @@ def self.import(activity_json_object,new_owner,imported_activity_url=nil,helper=
     import_activity.imported_activity_url = imported_activity_url
     import_activity.is_official = activity_json_object[:is_official]
     import_activity.hide_read_aloud = activity_json_object[:hide_read_aloud]
+    import_activity.hide_question_numbers = activity_json_object[:hide_question_numbers]
     import_activity.font_size = activity_json_object[:font_size]
     import_activity.project = Project.find_or_create(activity_json_object[:project]) if activity_json_object[:project]
     self.link_glossaries_on_import(activity_json_object, import_activity)

app/models/sequence.rb

@@ -2,7 +2,7 @@ class Sequence < ActiveRecord::Base
 
   attr_accessible :description, :title, :project_id, :defunct,
     :user_id, :logo, :display_title, :thumbnail_url, :abstract, :publication_hash,
-    :project, :background_image, :hide_read_aloud, :font_size, :layout_override
+    :project, :background_image, :hide_read_aloud, :font_size, :layout_override, :hide_question_numbers
 
   include Publishable # defines methods to publish to portals
   include PublicationStatus # defines publication status scopes and helpers
@@ -57,6 +57,7 @@ def to_hash
       display_title: display_title,
       thumbnail_url: thumbnail_url,
       hide_read_aloud: hide_read_aloud,
+      hide_question_numbers: hide_question_numbers,
       font_size: font_size,
       layout_override: layout_override
     }
@@ -104,6 +105,7 @@ def export(host)
                                         :background_image,
                                         :defunct,
                                         :hide_read_aloud,
+                                        :hide_question_numbers,
                                         :font_size,
                                         :layout_override
     ])
@@ -216,6 +218,7 @@ def self.extract_from_hash(sequence_json_object)
       title: sequence_json_object[:title],
       background_image: sequence_json_object[:background_image],
       hide_read_aloud: sequence_json_object[:hide_read_aloud],
+      hide_question_numbers: sequence_json_object[:hide_question_numbers],
       font_size: sequence_json_object[:font_size],
       layout_override: sequence_json_object[:layout_override]
     }

app/views/lightweight_activities/_form.html.haml

@@ -8,6 +8,10 @@
   = f.check_box :hide_read_aloud
   = f.label :hide_read_aloud,  "Hide Read-Aloud Toggle"
   .hint Check this box if you do not want the "Tap text to listen" toggle to appear on this activity.
+.field
+  = f.check_box :hide_question_numbers
+  = f.label :hide_question_numbers,  "Hide Question Numbers"
+  .hint Check this box if you do not want question numbers to appear to the student in this activity.
 .field
   = f.label :layout, "Activity Layout"
   = f.select :layout, options_for_select(LightweightActivity::LAYOUT_OPTIONS, @activity.layout)

app/views/sequences/_form.html.haml

@@ -27,6 +27,10 @@
       = f.check_box :hide_read_aloud
       = f.label :hide_read_aloud,  "Hide Read-Aloud Toggle"
       .hint Check this box if you do not want the "Tap text to listen" toggle to appear on activities in this sequence.
+    .field
+      = f.check_box :hide_question_numbers
+      = f.label :hide_question_numbers,  "Hide Question Numbers"
+      .hint Check this box if you do not want question numbers to appear to the student in activities in this sequence.
     .field
       = f.label :layout_override, "Activity Layout Override"
       = f.select :layout_override, options_for_select(LightweightActivity::LAYOUT_OVERRIDE_OPTIONS, @sequence.layout_override)

db/migrate/20240103135547_add_hide_question_numbers.rb

@@ -0,0 +1,6 @@
+class AddHideQuestionNumbers < ActiveRecord::Migration
+  def change
+    add_column :lightweight_activities, :hide_question_numbers, :boolean, default: false
+    add_column :sequences, :hide_question_numbers, :boolean, default: false
+  end
+end

db/schema.rb

@@ -11,7 +11,7 @@
 #
 # It's strongly recommended to check this file into your version control system.
 
-ActiveRecord::Schema.define(:version => 20231129130443) do
+ActiveRecord::Schema.define(:version => 20240103135547) do
 
   create_table "admin_events", :force => true do |t|
     t.string   "kind"
@@ -456,6 +456,7 @@
     t.string   "migration_status",                       :default => "not_migrated"
     t.boolean  "hide_read_aloud",                        :default => false
     t.string   "font_size",                              :default => "normal"
+    t.boolean  "hide_question_numbers",                  :default => false
   end
 
   add_index "lightweight_activities", ["changed_by_id"], :name => "index_lightweight_activities_on_changed_by_id"
@@ -750,6 +751,7 @@
     t.boolean  "hide_read_aloud",                        :default => false
     t.string   "font_size",                              :default => "normal"
     t.integer  "layout_override",                        :default => 0
+    t.boolean  "hide_question_numbers",                  :default => false
   end
 
   add_index "sequences", ["project_id"], :name => "index_sequences_on_project_id"

spec/import_examples/valid_lightweight_activity_import_v2.json

@@ -2,6 +2,7 @@
   "background_image": "",
   "defunct": false,
   "hide_read_aloud": true,
+  "hide_question_numbers": true,
   "font_size": "large",
   "description": "<p>Contains all page layout formats</p>",
   "editor_mode": 0,

spec/models/lightweight_activity_spec.rb

@@ -4,7 +4,7 @@
   let(:thumbnail_url) { "http://fake.url.com/image" }
   let(:author)        { FactoryGirl.create(:author) }
   let(:glossary)      { nil }
-  let(:act_opts)      { {thumbnail_url: thumbnail_url, glossary: glossary, hide_read_aloud: true, font_size: "large"} }
+  let(:act_opts)      { {thumbnail_url: thumbnail_url, glossary: glossary, hide_read_aloud: true, hide_question_numbers: true, font_size: "large"} }
   let(:activity)      {
     activity = FactoryGirl.create(:activity, act_opts)
     activity.user = author
@@ -188,6 +188,7 @@
         layout: activity.layout,
         editor_mode: activity.editor_mode,
         hide_read_aloud: activity.hide_read_aloud,
+        hide_question_numbers: activity.hide_question_numbers,
         font_size: activity.font_size,
        }
       expect(activity.to_hash).to eq(expected)
@@ -230,6 +231,9 @@
       it 'includes the hide_read_aloud setting' do
         expect(export["hide_read_aloud"]).to eq(true)
       end
+      it 'includes the hide_question_numbers setting' do
+        expect(export["hide_question_numbers"]).to eq(true)
+      end
       it 'includes the font_size setting' do
         expect(export["font_size"]).to eq("large")
       end
@@ -291,6 +295,7 @@
       expect(activity.glossary_id).to eq(glossary.id)
       expect(dup.glossary_id).to eq(activity.glossary_id)
       expect(dup.hide_read_aloud).to eq(activity.hide_read_aloud)
+      expect(dup.hide_question_numbers).to eq(activity.hide_question_numbers)
       expect(dup.font_size).to eq(activity.font_size)
     end
 
@@ -451,6 +456,7 @@
       expect(act.pages.count).to eq(json[:pages].length)
       expect(act.glossary_id).to eq(nil)
       expect(act.hide_read_aloud).to eq(true)
+      expect(act.hide_question_numbers).to eq(true)
       expect(act.font_size).to eq("large")
     end
 

spec/models/sequence_spec.rb

@@ -195,7 +195,7 @@
   end
 
   describe '#to_hash' do
-    let(:sequence_opts) { {hide_read_aloud: true, font_size: "large", layout_override: 2} }
+    let(:sequence_opts) { {hide_read_aloud: true, hide_question_numbers: true, font_size: "large", layout_override: 2} }
     it 'returns a hash with relevant values for sequence duplication' do
       expected = {
         title: sequence.title,
@@ -207,6 +207,7 @@
         display_title: sequence.display_title,
         thumbnail_url: sequence.thumbnail_url,
         hide_read_aloud: true,
+        hide_question_numbers: true,
         font_size: "large",
         layout_override: 2,
       }
@@ -215,12 +216,13 @@
   end
 
   describe '#export' do
-    let(:sequence_opts) { {hide_read_aloud: true, font_size: "large", layout_override: 2} }
+    let(:sequence_opts) { {hide_read_aloud: true, hide_question_numbers: true, font_size: "large", layout_override: 2} }
     let(:host) { 'http://test.host' }
     it 'returns json of a sequence' do
       sequence_json = JSON.parse(sequence.export(host))
       expect(sequence_json['activities'].length).to eq(sequence.activities.count)
       expect(sequence_json['hide_read_aloud']).to eq(true)
+      expect(sequence_json['hide_question_numbers']).to eq(true)
       expect(sequence_json['font_size']).to eq("large")
       expect(sequence_json['layout_override']).to eq(2)
     end
@@ -251,9 +253,10 @@
     let(:thumbnail_url) { "https://concord.org/sunflower.jpg" }
     let(:title)         { "title" }
     let(:hide_read_aloud) { true }
+    let(:hide_question_numbers) { true }
     let(:font_size) { "large" }
     let(:layout_override) { 2 }
-    let(:sequence_opts) { {logo: logo, thumbnail_url: thumbnail_url, title: title, hide_read_aloud: hide_read_aloud, font_size: font_size, layout_override: layout_override} }
+    let(:sequence_opts) { {logo: logo, thumbnail_url: thumbnail_url, title: title, hide_read_aloud: hide_read_aloud, hide_question_numbers: hide_question_numbers, font_size: font_size, layout_override: layout_override} }
     let(:owner)         { FactoryGirl.create(:user) }
     let(:host)          { 'http://test.host' }
 
@@ -263,6 +266,7 @@
       expect(imported.thumbnail_url).to eq(thumbnail_url)
       expect(imported.logo).to eq(logo)
       expect(imported.hide_read_aloud).to eq(hide_read_aloud)
+      expect(imported.hide_question_numbers).to eq(hide_question_numbers)
       expect(imported.font_size).to eq(font_size)
       expect(imported.layout_override).to eq(layout_override)
     end

spec/views/lightweight_activities/edit.html.haml_spec.rb

@@ -10,13 +10,16 @@ def official_checkbox
 def hide_read_aloud_checkbox
   '//*[@id="lightweight_activity_hide_read_aloud"]'
 end
+def hide_question_numbers_checkbox
+  '//*[@id="lightweight_activity_hide_question_numbers"]'
+end
 def font_size_select
   '//*[@id="lightweight_activity_font_size"]'
 end
 
 describe "lightweight_activities/edit" do
 
-  let(:activity)  { stub_model(LightweightActivity, :id => 1, :name => 'Activity name', :defunct => false, :hide_read_aloud => false, :font_size => "normal") }
+  let(:activity)  { stub_model(LightweightActivity, :id => 1, :name => 'Activity name', :defunct => false, :hide_read_aloud => false, :hide_question_numbers => false, :font_size => "normal") }
   let(:user)      { stub_model(User, :is_admin => false)      }
 
   before(:each) do
@@ -56,13 +59,39 @@ def font_size_select
 
       context "when the current user is not an admin" do
         let (:user) { stub_model(User, :is_admin => false)}
-        it "should show the checkbox" do
+        it "should not show the checkbox" do
           render
           expect(rendered).to have_xpath hide_read_aloud_checkbox
         end
       end
     end
 
+    describe "hide_question_numbers checkbox" do
+      context "when the current user is an admin" do
+        let (:user) { stub_model(User, :is_admin => true)}
+        it "should show the checkbox" do
+          render
+          expect(rendered).to have_xpath hide_question_numbers_checkbox
+        end
+      end
+
+      context "when the current user is an author" do
+        let (:user) { stub_model(User, :is_author => true)}
+        it "should show the checkbox" do
+          render
+          expect(rendered).to have_xpath hide_question_numbers_checkbox
+        end
+      end
+
+      context "when the current user is not an admin or author" do
+        let (:user) { stub_model(User, :is_admin => false, :is_author => false)}
+        it "should not show the checkbox" do
+          render
+          expect(rendered).to have_xpath hide_question_numbers_checkbox
+        end
+      end
+    end
+
     describe "font_size select" do
       context "when the current user is an admin" do
         let (:user) { stub_model(User, :is_admin => true)}

spec/views/sequences/edit.html.haml_spec.rb

@@ -19,6 +19,7 @@
       assert_select "input#sequence_title", :name => "sequence[title]"
       assert_select "textarea#sequence_description", :name => "sequence[description]"
       assert_select "input#sequence_hide_read_aloud", :name => "sequence[hide_read_aloud]"
+      assert_select "input#sequence_hide_question_numbers", :name => "sequence[hide_question_numbers]"
       assert_select "select#sequence_font_size", :name => "sequence[font_size]"
     end
   end