dugway 1.0.14 → 1.2.0

data/spec/units/dugway/theme_spec.rb

@@ -4,18 +4,30 @@ describe Dugway::Theme do
   let(:theme) { Dugway.theme }
 
   describe "#layout" do
+    before(:each) do
+      allow_any_instance_of(Dugway::Theme).to receive(:validate_required_color_settings) { true }
+    end
+
     it "should return the theme's layout" do
       theme.layout.should == read_file('layout.html')
     end
   end
 
   describe "#settings" do
+    before(:each) do
+      allow_any_instance_of(Dugway::Theme).to receive(:validate_required_color_settings) { true }
+    end
+
     it "should return a hash of the theme's settings" do
       theme.settings.should == JSON.parse(read_file('settings.json'))
     end
   end
 
   describe "#fonts" do
+    before(:each) do
+      allow_any_instance_of(Dugway::Theme).to receive(:validate_required_color_settings) { true }
+    end
+
     it "should return a hash of font settings values" do
       theme.fonts.should == {
         'text_font' => 'Georgia',
@@ -25,6 +37,10 @@ describe Dugway::Theme do
   end
 
   describe "#images" do
+    before(:each) do
+      allow_any_instance_of(Dugway::Theme).to receive(:validate_required_color_settings) { true }
+    end
+
     it "should return a hash of the image settings" do
       theme.images.should == {
         'logo' => { :url => 'images/logo_bc.png', :width => 1, :height => 1 }
@@ -33,6 +49,10 @@ describe Dugway::Theme do
   end
 
   describe "#image_sets" do
+    before(:each) do
+      allow_any_instance_of(Dugway::Theme).to receive(:validate_required_color_settings) { true }
+    end
+
     it "should return a hash of the image set settings" do
       theme.image_sets.should == {
         'slideshow_images' => [
@@ -47,6 +67,10 @@ describe Dugway::Theme do
   end
 
   describe "#customization" do
+    before(:each) do
+      allow_any_instance_of(Dugway::Theme).to receive(:validate_required_color_settings) { true }
+    end
+
     it "should return a hash of font, color, option, images and image sets settings values" do
       theme.customization.should == {
         'background_color' => 'white',
@@ -76,6 +100,8 @@ describe Dugway::Theme do
         Dugway.stub(:theme) {
           Dugway::Theme.new(:fixed_sidebar => false, :link_text_color => 'blue')
         }
+
+        allow_any_instance_of(Dugway::Theme).to receive(:validate_required_color_settings) { true }
       end
 
       it "should merge those values into the defaults" do
@@ -105,18 +131,30 @@ describe Dugway::Theme do
   end
 
   describe "#name" do
+    before(:each) do
+      allow_any_instance_of(Dugway::Theme).to receive(:validate_required_color_settings) { true }
+    end
+
     it "should return the theme's name" do
       theme.name.should == 'Test Theme'
     end
   end
 
   describe "#version" do
+    before(:each) do
+      allow_any_instance_of(Dugway::Theme).to receive(:validate_required_color_settings) { true }
+    end
+
     it "should return the theme's version" do
       theme.version.should == '1.2.3'
     end
   end
 
   describe "#file_content" do
+    before(:each) do
+      allow_any_instance_of(Dugway::Theme).to receive(:validate_required_color_settings) { true }
+    end
+
     it "should return the file content for most files" do
       %w( home.html products.html screenshot.jpg ).each { |file_name|
         theme.file_content(file_name).should == read_file(file_name)
@@ -133,6 +171,10 @@ describe Dugway::Theme do
   end
 
   describe "#build_file" do
+    before(:each) do
+      allow_any_instance_of(Dugway::Theme).to receive(:validate_required_color_settings) { true }
+    end
+
     it "should return the file content for most files" do
       %w( home.html products.html screenshot.jpg ).each { |file_name|
         theme.build_file(file_name).should == read_file(file_name)
@@ -149,25 +191,55 @@ describe Dugway::Theme do
   end
 
   describe "#files" do
+    before(:each) do
+      allow_any_instance_of(Dugway::Theme).to receive(:validate_required_color_settings) { true }
+    end
+
     it "should return an array of all files" do
       theme.files.should =~ ["cart.html", "contact.html", "home.html", "layout.html", "maintenance.html", "product.html", "products.html", "screenshot.jpg", "settings.json", "theme.css", "theme.js", "images/logo_bc.png", "images/slideshow/1.gif", "images/slideshow/2.gif", "images/slideshow/3.gif", "images/slideshow/4.gif", "images/slideshow/5.gif", "images/small.svg", "fonts/icons.ttf", "fonts/icons.woff"]
     end
   end
 
   describe "#image_files" do
+    before(:each) do
+      allow_any_instance_of(Dugway::Theme).to receive(:validate_required_color_settings) { true }
+    end
+
     it "should return an array of all image files" do
       theme.image_files.should =~ ["images/logo_bc.png", "images/slideshow/1.gif", "images/slideshow/2.gif", "images/slideshow/3.gif", "images/slideshow/4.gif", "images/slideshow/5.gif", "images/small.svg"]
     end
   end
 
   describe "#font_files" do
+    before(:each) do
+      allow_any_instance_of(Dugway::Theme).to receive(:validate_required_color_settings) { true }
+    end
+
     it "should return an array of all font files" do
       theme.font_files.should include("fonts/icons.ttf", "fonts/icons.woff")
     end
   end
 
   describe "#valid?" do
+    let(:required_colors) {[
+      'background_color',
+      'primary_text_color',
+      'link_text_color',
+      'link_hover_color',
+      'button_background_color',
+      'button_text_color',
+      'button_hover_background_color'
+    ]}
+
     it "should return true when a theme has everything it needs" do
+      allow(theme).to receive(:validate_required_color_settings) { true }
+
+      allow(theme).to receive(:settings).and_return({
+        'name' => 'Test Theme',
+        'version' => '1.2.3',
+        'colors' => required_colors.map { |color| {'variable' => color} }
+      })
+
       theme.valid?.should be(true)
       theme.errors.should be_empty
     end
@@ -175,6 +247,7 @@ describe Dugway::Theme do
     describe "when missing a required file" do
       before(:each) do
         theme.stub(:read_source_file).with('cart.html') { theme.unstub(:read_source_file); nil }
+        allow_any_instance_of(Dugway::Theme).to receive(:validate_required_color_settings) { true }
       end
 
       it "should not be valid" do
@@ -187,6 +260,7 @@ describe Dugway::Theme do
     describe "when missing a name" do
       before(:each) do
         theme.stub(:name) { nil }
+        allow_any_instance_of(Dugway::Theme).to receive(:validate_required_color_settings) { true }
       end
 
       it "should not be valid" do
@@ -199,6 +273,7 @@ describe Dugway::Theme do
     describe "when missing a version" do
       before(:each) do
         theme.stub(:version) { nil }
+        allow_any_instance_of(Dugway::Theme).to receive(:validate_required_color_settings) { true }
       end
 
       it "should not be valid" do
@@ -211,6 +286,7 @@ describe Dugway::Theme do
     describe "when having an invalid version" do
       before(:each) do
         theme.stub(:version) { '1.3' }
+        allow_any_instance_of(Dugway::Theme).to receive(:validate_required_color_settings) { true }
       end
 
       it "should not be valid" do
@@ -224,6 +300,7 @@ describe Dugway::Theme do
       before(:each) do
         theme.stub(:name) { nil }
         theme.stub(:version) { nil }
+        allow_any_instance_of(Dugway::Theme).to receive(:validate_required_color_settings) { true }
       end
 
       it "should return all of them" do
@@ -273,6 +350,7 @@ describe Dugway::Theme do
       end
 
       before(:each) do
+        allow(theme).to receive(:validate_required_color_settings) { true }
         allow(theme).to receive(:name) { "Test Theme" }
         allow(theme).to receive(:version) { "1.2.3" }
       end
@@ -293,6 +371,384 @@ describe Dugway::Theme do
         theme.errors.should include('Style in group \'Classic\' - Missing style_name')
       end
     end
+
+    describe "when missing option descriptions" do
+      before(:each) do
+        allow_any_instance_of(Dugway::Theme).to receive(:validate_required_color_settings) { true }
+        theme.stub(:settings) { {
+          'name' => 'Test Theme',
+          'version' => '1.2.3',
+          'colors' => [
+            {'variable' => 'background_color'},
+            {'variable' => 'primary_text_color'},
+            {'variable' => 'link_text_color'},
+            {'variable' => 'link_hover_color'},
+            {'variable' => 'button_background_color'},
+            {'variable' => 'button_text_color'},
+            {'variable' => 'button_hover_background_color'}
+          ],
+          'options' => [{ 'variable' => 'show_search', 'section' => 'global_navigation', 'label' => 'Show search' }]
+        } }
+      end
+
+      it "should not be valid" do
+        theme.valid?.should be(false)
+        theme.errors.size.should == 1
+        theme.errors.first.should == 'Missing descriptions for settings: show_search'
+      end
+
+      it "should be valid when skipping options validation" do
+        theme.valid?(validate_options: false).should be(true)
+      end
+    end
+
+    describe "when validating option requirements" do
+      let(:required_colors) {[
+        'background_color',
+        'primary_text_color',
+        'link_text_color',
+        'link_hover_color',
+        'button_background_color',
+        'button_text_color',
+        'button_hover_background_color'
+      ]}
+
+      it "allows options with no requires" do
+        settings = theme.settings.merge({
+          'options' => [{
+            'variable' => 'show_search',
+            'section' => 'global_navigation',
+            'label' => 'Show search',
+            'description' => 'Show search in header'
+          }]
+        })
+        allow(theme).to receive(:settings).and_return(settings)
+
+        theme.valid?.should be(true)
+        theme.errors.should be_empty
+      end
+
+      it "should not be valid when colors section is missing" do
+        allow(theme).to receive(:settings).and_return({
+          'name' => 'Test Theme',
+          'version' => '1.2.3',
+          'options' => []
+        })
+
+        theme.valid?.should be(false)
+        theme.errors.should include("Missing colors section in theme settings")
+      end
+
+      it "should not be valid when required colors are missing" do
+
+        allow(theme).to receive(:settings).and_return({
+          'name' => 'Test Theme',
+          'version' => '1.2.3',
+          'colors' => [
+            { 'variable' => 'background_color' }
+          ],
+          'options' => []
+        })
+
+        theme.valid?.should be(false)
+        theme.errors.first.should match(/Missing required color settings:/)
+      end
+
+      it "validates feature flag format and values" do
+        settings = theme.settings.merge({
+          'options' => [{
+            'variable' => 'show_foo',
+            'section' => 'general',
+            'description' => 'Show foo thing',
+            'requires' => [
+              'feature:', # invalid: empty
+              'feature:foo_flag gt visible', # invalid operator
+              'feature:foo_flag eq invalid_value', # invalid value
+              'feature:foo_flag neq visible', # valid
+              'feature:foo_flag eq visible' # valid
+            ]
+          }]
+        })
+        allow(theme).to receive(:settings).and_return(settings)
+
+        theme.valid?.should be(false)
+        theme.errors.should include("Option 'show_foo' has invalid feature flag format")
+        theme.errors.should include("Option 'show_foo' has invalid operator 'gt'. Feature flags can only use `eq` or `neq`.")
+        theme.errors.should include("Option 'show_foo' has invalid comparison value 'invalid_value'. Feature flags can only check for `visible`.")
+
+      end
+    end
+
+    describe "when validating option sections" do
+      let(:valid_sections_string) { Dugway::Theme::VALID_SECTIONS.join(', ') }
+      let(:base_settings) do
+        {
+          'name' => 'Test Theme',
+          'version' => '1.2.3',
+          'colors' => required_colors.map { |color| {'variable' => color} },
+          'options' => []
+        }
+       end
+
+      # Define required_colors here if not already available in this scope
+      let(:required_colors) {[
+        'background_color',
+        'primary_text_color',
+        'link_text_color',
+        'link_hover_color',
+        'button_background_color',
+        'button_text_color',
+        'button_hover_background_color'
+      ]}
+
+      # Fix for the failing tests - define constant if needed
+      before(:each) do
+        unless defined?(Dugway::Theme::REQUIRED_FILES)
+          stub_const("Dugway::Theme::REQUIRED_FILES", [
+            "cart.html", "contact.html", "home.html", "layout.html", "maintenance.html",
+            "product.html", "products.html", "screenshot.jpg", "settings.json", "theme.css", "theme.js"
+          ])
+        end
+      end
+
+      it "passes with a valid section" do
+        settings = base_settings.merge({
+          'options' => [{
+            'variable' => 'valid_option',
+            'description' => 'Valid option',
+            'section' => 'homepage'
+          }]
+        })
+        # Stub settings
+        allow(theme).to receive(:settings).and_return(settings)
+
+        # Stub ALL required files first
+        Dugway::Theme::REQUIRED_FILES.each do |file|
+          allow(theme).to receive(:read_source_file).with(file).and_return("some content")
+        end
+
+        # Then override the specific stub for layout.html
+        allow(theme).to receive(:read_source_file).with('layout.html')
+          .and_return('<body data-bc-page-type="home"><div data-bc-hook="header"></div><div data-bc-hook="footer"></div></body>')
+
+        # Stub color validation
+        allow(theme).to receive(:validate_required_color_settings).and_return(true)
+
+        expect(Kernel).not_to receive(:warn)
+        theme.valid?.should be(true)
+      end
+
+      it "warns appropriately for multiple options with missing or invalid sections" do
+        settings = base_settings.merge({
+          'options' => [
+            { 'variable' => 'option_1_valid', 'description' => 'Valid', 'section' => 'homepage' },
+            { 'variable' => 'option_2_missing', 'description' => 'Missing section' }, # Missing section
+            { 'variable' => 'option_3_invalid', 'description' => 'Invalid section', 'section' => 'bad_section' }, # Invalid section
+            { 'variable' => 'option_4_valid', 'description' => 'Valid again', 'section' => 'general' },
+            { 'variable' => 'option_5_missing', 'description' => 'Missing section again' }, # Missing section again
+            { 'description' => 'Option 6 missing variable and section' }, # Missing variable and section
+            { 'variable' => 'option_7_invalid', 'description' => 'Invalid section again', 'section' => 'another_bad_one' } # Invalid section again
+          ]
+        })
+        # Stub settings
+        allow(theme).to receive(:settings).and_return(settings)
+
+        # Stub ALL required files first
+        Dugway::Theme::REQUIRED_FILES.each do |file|
+          allow(theme).to receive(:read_source_file).with(file).and_return("some content")
+        end
+
+        # Then override the specific stub for layout.html
+        allow(theme).to receive(:read_source_file).with('layout.html')
+          .and_return('<body data-bc-page-type="home"><div data-bc-hook="header"></div><div data-bc-hook="footer"></div></body>')
+
+        # Stub color validation
+        allow(theme).to receive(:validate_required_color_settings).and_return(true)
+
+        # Allow warn to be called so we can spy on it
+        allow(Kernel).to receive(:warn)
+
+        # Call valid? and assert true (since warnings don't invalidate)
+        theme.valid?.should be(true)
+
+        # Verify calls
+        expect(Kernel).to have_received(:warn).with("Warning: Theme setting 'option_2_missing' is missing the 'section' property.")
+        expect(Kernel).to have_received(:warn).with("Warning: Theme setting 'option_3_invalid' has an invalid 'section' value: 'bad_section'. Allowed values are: #{valid_sections_string}.")
+        expect(Kernel).to have_received(:warn).with("Warning: Theme setting 'option_5_missing' is missing the 'section' property.")
+        expect(Kernel).to have_received(:warn).with("Warning: Theme setting 'unknown' is missing the 'section' property.")
+        expect(Kernel).to have_received(:warn).with("Warning: Theme setting 'option_7_invalid' has an invalid 'section' value: 'another_bad_one'. Allowed values are: #{valid_sections_string}.")
+      end
+
+      it "handles options without a variable name gracefully when section is invalid" do
+        settings = base_settings.merge({
+          'options' => [{
+            # 'variable' key is missing
+            'description' => 'Option without variable',
+            'section' => 'invalid_area' # Invalid section to trigger warning
+          }]
+        })
+
+        # Stub all necessary methods
+        allow(theme).to receive(:settings).and_return(settings)
+        allow(theme).to receive(:validate_required_color_settings).and_return(true)
+        allow(theme).to receive(:validate_required_layout_attributes).and_return(true)
+        allow(theme).to receive(:validate_options_requires).and_return(true)
+        allow(theme).to receive(:validate_options_descriptions).and_return(true)
+        allow(theme).to receive(:validate_option_defaults).and_return(true)
+
+        # Stub file checks - this is crucial
+        Dugway::Theme::REQUIRED_FILES.each do |file|
+          allow(theme).to receive(:read_source_file).with(file).and_return("some content")
+        end
+
+        # Allow warn to be called
+        allow(Kernel).to receive(:warn)
+
+        # Run the validation
+        theme.valid?.should be(true)
+
+        # Check that the warning was issued
+        expect(Kernel).to have_received(:warn).with("Warning: Theme setting 'unknown' has an invalid 'section' value: 'invalid_area'. Allowed values are: #{valid_sections_string}.")
+      end
+
+      it "handles options without a variable name gracefully when section is missing" do
+        settings = base_settings.merge({
+          'options' => [{
+            # 'variable' key is missing
+            'description' => 'Option without variable or section'
+            # 'section' key is missing
+          }]
+        })
+
+        # Stub all necessary methods
+        allow(theme).to receive(:settings).and_return(settings)
+        allow(theme).to receive(:validate_required_color_settings).and_return(true)
+        allow(theme).to receive(:validate_required_layout_attributes).and_return(true)
+        allow(theme).to receive(:validate_options_requires).and_return(true)
+        allow(theme).to receive(:validate_options_descriptions).and_return(true)
+        allow(theme).to receive(:validate_option_defaults).and_return(true)
+
+        # Stub file checks
+        Dugway::Theme::REQUIRED_FILES.each do |file|
+          allow(theme).to receive(:read_source_file).with(file).and_return("some content")
+        end
+
+        # Allow warn to be called
+        allow(Kernel).to receive(:warn)
+
+        # Run the validation
+        theme.valid?.should be(true)
+
+        # Check that the warning was issued
+        expect(Kernel).to have_received(:warn).with("Warning: Theme setting 'unknown' is missing the 'section' property.")
+      end
+    end
+
+  end
+
+  shared_examples "option value validation" do |value_type|
+    context "when type is 'select' with explicit options" do
+      let(:options) do
+        [{
+          'type' => 'select',
+          'variable' => 'hero_overlay_opacity',
+          'options' => [['Bright', 'bright'], ['Dark', 'dark']],
+          value_type => 'bright'
+        }]
+      end
+
+      it "passes when #{value_type} matches a valid option" do
+        theme.instance_variable_set(:@errors, [])
+        theme.send(:validate_option_defaults)
+        expect(theme.errors).to be_empty
+      end
+
+      it "flags invalid #{value_type} values" do
+        options.first[value_type] = 'invalid'
+        theme.instance_variable_set(:@errors, [])
+        theme.send(:validate_option_defaults)
+        expect(theme.errors).to include("#{value_type.capitalize} 'invalid' is not a valid option for hero_overlay_opacity")
+      end
+    end
+
+    context "when type is 'select' with numeric range" do
+      let(:options) do
+        [{
+          'type' => 'select',
+          'variable' => 'featured_products',
+          'options' => '0..100',
+          value_type => 50
+        }]
+      end
+
+      it "passes when #{value_type} is within range" do
+        theme.instance_variable_set(:@errors, [])
+        theme.send(:validate_option_defaults)
+        expect(theme.errors).to be_empty
+      end
+
+      it "flags #{value_type} outside the range" do
+        options.first[value_type] = 101
+        theme.instance_variable_set(:@errors, [])
+        theme.send(:validate_option_defaults)
+        expect(theme.errors).to include("#{value_type.capitalize} '101' is out of range for featured_products")
+      end
+    end
+
+    context "when type is 'boolean'" do
+      let(:options) do
+        [{
+          'type' => 'boolean',
+          'variable' => 'show_home_page_categories',
+          value_type => true
+        }]
+      end
+
+      it "passes when #{value_type} is a valid boolean" do
+        theme.instance_variable_set(:@errors, [])
+        theme.send(:validate_option_defaults)
+        expect(theme.errors).to be_empty
+      end
+
+      it "flags non-boolean #{value_type}" do
+        options.first[value_type] = 'true'
+        theme.instance_variable_set(:@errors, [])
+        theme.send(:validate_option_defaults)
+        expect(theme.errors).to include("#{value_type.capitalize} 'true' is not a boolean for show_home_page_categories")
+      end
+    end
+
+    context "when type is 'select' with product_orders" do
+      let(:options) do
+        [{
+          'type' => 'select',
+          'variable' => 'related_products_order',
+          'options' => 'product_orders',
+          value_type => 'top-selling'
+        }]
+      end
+
+      it "passes when #{value_type} matches a valid product_orders value" do
+        theme.instance_variable_set(:@errors, [])
+        theme.send(:validate_option_defaults)
+        expect(theme.errors).to be_empty
+      end
+
+      it "flags invalid #{value_type} values" do
+        options.first[value_type] = 'invalid'
+        theme.instance_variable_set(:@errors, [])
+        theme.send(:validate_option_defaults)
+        expect(theme.errors).to include("#{value_type.capitalize} 'invalid' is not a valid option for related_products_order")
+      end
+    end
+  end
+
+  describe "#validate_option_defaults" do
+    let(:settings) { { 'options' => options } }
+    before { allow(theme).to receive(:settings).and_return(settings) }
+
+    it_behaves_like "option value validation", 'default'
+    it_behaves_like "option value validation", 'upgrade_default'
   end
 
   def read_file(file_name)