intranet-core 1.0.0

data/spec/core_extensions/string_spec.rb

@@ -0,0 +1,135 @@
+# frozen_string_literal: true
+
+require 'core_extensions/string'
+
+RSpec.describe CoreExtensions::String do
+  before do
+    String.include described_class
+  end
+
+  describe '#unaccentize' do
+    context 'given an empty string' do
+      it 'should return an empty string' do
+        tested_string = ''
+        expect(tested_string.unaccentize).to eql(tested_string)
+      end
+    end
+
+    context 'given the printable ASCII characters (0x20 to 0x7E)' do
+      it 'should not modify them' do
+        tested_string1 = ' !\"#$%&\'()*+,-./0123456789:;<=>?@ABCDEFGHIJKLMNO'
+        tested_string2 = 'PQRSTUVWXYZ[\\]^_`abcdefghijklmnopqrstuvwxyz{|}~'
+        expect(tested_string1.unaccentize).to eql(tested_string1)
+        expect(tested_string2.unaccentize).to eql(tested_string2)
+      end
+    end
+
+    context 'given the Unicode characters from the Latin-1 supplement (0xA0 to 0xFF)' do
+      it 'should replace the accented characters with their unaccented version' do
+        tested_string1   = '¡¢£¤¥¦§¨©ª«¬®¯°±²³´µ¶·¸¹º»¼½¾¿ÀÁÂÃÄÅÆÇÈÉÊËÌÍÎÏÐ'
+        tested_string2   = 'ÑÒÓÔÕÖ×ØÙÚÛÜÝÞßàáâãäåæçèéêëìíîïðñòóôõö÷øùúûüýþÿ'
+        expected_string1 = '¡¢£¤¥¦§¨©ª«¬®¯°±²³´µ¶·¸¹º»¼½¾¿AAAAAAAECEEEEIIIID'
+        expected_string2 = 'NOOOOO×OUUUUYÞssaaaaaaaeceeeeiiiidnooooo÷ouuuuyþy'
+        expect(tested_string1.unaccentize).to eql(expected_string1)
+        expect(tested_string2.unaccentize).to eql(expected_string2)
+      end
+    end
+
+    context 'given the Unicode characters from the Latin Extended-A (0x100 to 0x17F)' do
+      it 'should replace the accented characters with their unaccented version' do
+        tested_string1   = 'ĀāĂ㥹ĆćĈĉĊċČčĎďĐđĒēĔĕĖėĘęĚěĜĝĞğĠġĢģĤĥĦħĨĩĪīĬĭĮįİıIJijĴĵĶķĸĹĺĻļĽľĿ'
+        tested_string2   = 'ŀŁłŃńŅņŇňʼnŊŋŌōŎŏŐőŒœŔŕŖŗŘřŚśŜŝŞşŠšŢţŤťŦŧŨũŪūŬŭŮůŰűŲųŴŵŶŷŸŹźŻżŽžſ'
+        expected_string1 = 'AaAaAaCcCcCcCcDdDdEeEeEeEeEeGgGgGgGgHhHhIiIiIiIiIiIJijJjKkkLlLlLlL'
+        expected_string2 = 'lLlNnNnNnnNnOoOoOoOEoeRrRrRrSsSsSsSsTtTtTtUuUuUuUuUuUuWwYyYZzZzZzs'
+        expect(tested_string1.unaccentize).to eql(expected_string1)
+        expect(tested_string2.unaccentize).to eql(expected_string2)
+      end
+    end
+  end
+
+  describe '#urlize' do
+    context 'given an empty string' do
+      it 'should return an empty string' do
+        tested_string = ''
+        expect(tested_string.urlize).to eql(tested_string)
+      end
+    end
+
+    context 'given an uppercase string' do
+      it 'should return the corresponding downcased string' do
+        tested_string   = 'ABCDEFGHIJKLMNOPQRSTUVWXYZ'
+        expected_string = 'abcdefghijklmnopqrstuvwxyz'
+        expect(tested_string.urlize).to eql(expected_string)
+      end
+    end
+
+    context 'given a string with leading and trailing spaces' do
+      it 'should return the same string with leading and trailing spaces removed' do
+        tested_string   = '  abcde  '
+        expected_string = 'abcde'
+        expect(tested_string.urlize).to eql(expected_string)
+      end
+    end
+
+    context 'given a string with ` ` and `\'` characters' do
+      it 'should return a string with ` ` and `\'` both replaced by `_`' do
+        tested_string   = 'a \'a'
+        expected_string = 'a__a'
+        expect(tested_string.urlize).to eql(expected_string)
+      end
+    end
+
+    context 'given a string with `-` and `_` characters or numbers' do
+      it 'should return the same string' do
+        tested_string   = '-_0123456789'
+        expected_string = '-_0123456789'
+        expect(tested_string.urlize).to eql(expected_string)
+      end
+    end
+
+    context 'given a string with special characters only' do
+      it 'should return an empty string (special characters removed)' do
+        tested_string   = '!"#$%&()*+,./:;<=>?@[\\]^`{|}~'
+        expected_string = ''
+        expect(tested_string.urlize).to eql(expected_string)
+      end
+    end
+
+    context 'given a string with characters from Code page 852 (Latin-2 DOS)' do
+      it 'should return the same string without accented nor special characters, downcased' do
+        tested_string1   = 'ÇüéâäàåçêëèïîìÄÅÉæÆôöòûùÿÖÜø£Ø׃áíóúñѪº¿®¬½¼¡«»░▒▓│┤ÁÂÀ©╣║╗╝¢¥┐'
+        tested_string2   = '└┴┬├─┼ãÃ╚╔╩╦╠═╬¤ðÐÊËÈıÍÎÏ┘┌█▄¦Ì▀ÓßÔÒõÕµþÞÚÛÙýݯ´≡±‗¾¶§÷¸°¨·¹³²■'
+        expected_string1 = 'cueaaaaceeeiiiaaeaeaeooouuyouooaiounnaaa'
+        expected_string2 = 'aaddeeeiiiiiossoooouuuyy'
+        expect(tested_string1.urlize).to eql(expected_string1)
+        expect(tested_string2.urlize).to eql(expected_string2)
+      end
+    end
+  end
+
+  describe '#urlized?' do
+    context 'given an empty string' do
+      it 'should return true' do
+        tested_string = ''
+        expect(tested_string.urlized?).to be true
+      end
+    end
+
+    context 'given a string containing only allowed characters' do
+      it 'should return true' do
+        tested_string = '-_abcdefghijklmnopqrstuvwxyz0123456789'
+        expect(tested_string.urlized?).to be true
+      end
+    end
+
+    context 'given a string containing at least only forbidden character' do
+      it 'should return false' do
+        tested_string1 = 'foo bar'
+        expect(tested_string1.urlized?).to be false
+        # ---
+        tested_string2 = 'fooBar'
+        expect(tested_string2.urlized?).to be false
+      end
+    end
+  end
+end

data/spec/core_extensions/tree_spec.rb

@@ -0,0 +1,208 @@
+# frozen_string_literal: true
+
+require 'core_extensions/tree'
+
+RSpec.describe CoreExtensions::Tree do
+  describe '.initialize' do
+    context 'creating a new Tree' do
+      before do
+        @tree = described_class.new
+      end
+      it 'should return a Tree with no children' do
+        expect(@tree.children?).to be false
+        expect(@tree.children_nodes).to be_empty
+      end
+      it 'should return a Tree with root value equal to nil' do
+        expect(@tree.value).to be_nil
+      end
+    end
+
+    context 'creating a new Tree with a root VALUE' do
+      before do
+        @tree = described_class.new(42)
+      end
+      it 'should return a Tree with no children' do
+        expect(@tree.children?).to be false
+        expect(@tree.children_nodes).to be_empty
+      end
+      it 'should return a Tree with root value equal to VALUE' do
+        expect(@tree.value).to eql(42)
+      end
+    end
+  end
+
+  describe '#add_child_node' do
+    context 'given a child ID' do
+      before do
+        @tree = described_class.new
+        @ref = @tree.add_child_node('first')
+      end
+      it 'should add a new child node to the Tree, identified by ID and holding nil value' do
+        expect(@tree.children?).to be true
+        expect(@tree.children_nodes.size).to be_eql(1)
+        expect(@tree.child_exists?('first')).to be true
+        expect(@tree.child_node('first').value).to be_nil
+      end
+      it 'should return a reference to the newly created child node' do
+        expect(@ref).to be(@tree.child_node('first'))
+      end
+    end
+
+    context 'given a child ID and a VALUE' do
+      before do
+        @tree = described_class.new
+        @ref = @tree.add_child_node('first', 43)
+      end
+      it 'should add a new child node to the Tree, identified by ID and holding VALUE' do
+        expect(@tree.children?).to be true
+        expect(@tree.children_nodes.size).to be_eql(1)
+        expect(@tree.child_exists?('first')).to be true
+        expect(@tree.child_node('first').value).to be_eql(43)
+      end
+      it 'should return a reference to the newly created child node' do
+        expect(@ref).to be(@tree.child_node('first'))
+      end
+    end
+
+    context 'given a child ID corresponding to an existing child' do
+      before do
+        @tree = described_class.new
+        @ref1 = @tree.add_child_node('first', 43)
+        @ref2 = @tree.add_child_node('first', 44)
+      end
+      it 'should left the tree unchanged' do
+        expect(@tree.children?).to be true
+        expect(@tree.children_nodes.size).to be_eql(1)
+        expect(@tree.child_exists?('first')).to be true
+        expect(@tree.child_node('first').value).to be_eql(43)
+      end
+      it 'should return a reference to the existing child with given ID' do
+        expect(@ref2).to be(@ref1)
+      end
+    end
+  end
+
+  describe '#child_exists' do
+    context 'given a non-existant child ID' do
+      before do
+        @tree = described_class.new
+        @tree.add_child_node('first')
+      end
+      it 'should return false' do
+        expect(@tree.child_exists?('second')).to be false
+      end
+    end
+  end
+
+  describe '#child_node' do
+    context 'given a non-existant child ID' do
+      before do
+        @tree = described_class.new
+        @tree.add_child_node('first')
+      end
+      it 'should raise KeyError' do
+        expect { @tree.child_node('second') }.to raise_error(KeyError)
+      end
+    end
+  end
+
+  describe '#to_h' do
+    context 'given a 10-nodes Tree' do
+      before do
+        @tree = described_class.new('node0')
+        @tree.add_child_node('left', 'node1')
+        @tree.add_child_node('middle', 'node2')
+        @tree.add_child_node('right', 'node3')
+        @tree.child_node('left').add_child_node('left', 'node1.1')
+        @tree.child_node('left').add_child_node('right', 'node1.2')
+        @tree.child_node('middle').add_child_node('middle', 'node2.1')
+        @tree.child_node('right').add_child_node('left', 'node3.1')
+        @tree.child_node('right').add_child_node('middle', 'node3.2')
+        @tree.child_node('right').add_child_node('right', 'node3.3')
+      end
+      it 'should return a depth-first representation of the Tree' do
+        expect(@tree.to_h).to eql(
+          Hash['/' => 'node0',
+               '/left' => 'node1',
+               '/left/left' => 'node1.1',
+               '/left/right' => 'node1.2',
+               '/middle' => 'node2',
+               '/middle/middle' => 'node2.1',
+               '/right' => 'node3',
+               '/right/left' => 'node3.1',
+               '/right/middle' => 'node3.2',
+               '/right/right' => 'node3.3']
+        )
+      end
+    end
+
+    context 'given a 10-nodes Tree and a separator' do
+      before do
+        @tree = described_class.new(0.0)
+        @tree.add_child_node('left', 1.0)
+        @tree.add_child_node('middle', 2.0)
+        @tree.add_child_node('right', 3.0)
+        @tree.child_node('left').add_child_node('left', 1.1)
+        @tree.child_node('left').add_child_node('right', 1.2)
+        @tree.child_node('middle').add_child_node('middle', 2.1)
+        @tree.child_node('right').add_child_node('left', 3.1)
+        @tree.child_node('right').add_child_node('middle', 3.2)
+        @tree.child_node('right').add_child_node('right', 3.3)
+      end
+      it 'should return a depth-first representation of the Tree, using the given separator' do
+        expect(@tree.to_h(':')).to eql(
+          Hash[':' => 0.0,
+               ':left' => 1.0,
+               ':left:left' => 1.1,
+               ':left:right' => 1.2,
+               ':middle' => 2.0,
+               ':middle:middle' => 2.1,
+               ':right' => 3.0,
+               ':right:left' => 3.1,
+               ':right:middle' => 3.2,
+               ':right:right' => 3.3]
+        )
+      end
+    end
+  end
+
+  describe '#to_s' do
+    context 'given a 10-nodes Tree' do
+      before do
+        @tree = described_class.new(0.0)
+        @tree.add_child_node('left', 1.0)
+        @tree.add_child_node('middle', 2.0)
+        @tree.add_child_node('right', 3.0)
+        @tree.child_node('left').add_child_node('left', 1.1)
+        @tree.child_node('left').add_child_node('right', 1.2)
+        @tree.child_node('middle').add_child_node('middle', 2.1)
+        @tree.child_node('right').add_child_node('left', 3.1)
+        @tree.child_node('right').add_child_node('middle', 3.2)
+        @tree.child_node('right').add_child_node('right', 3.3)
+      end
+      it 'should return an ASCII representation of the Tree' do
+        expect(@tree.to_s).to eql(
+          "VALUE: 0.0\n" \
+          " * ID:   'left'\n" \
+          "   VALUE: 1.0\n" \
+          "    * ID:   'left'\n" \
+          "      VALUE: 1.1\n" \
+          "    * ID:   'right'\n"\
+          "      VALUE: 1.2\n" \
+          " * ID:   'middle'\n" \
+          "   VALUE: 2.0\n" \
+          "    * ID:   'middle'\n" \
+          "      VALUE: 2.1\n" \
+          " * ID:   'right'\n" \
+          "   VALUE: 3.0\n" \
+          "    * ID:   'left'\n" \
+          "      VALUE: 3.1\n" \
+          "    * ID:   'middle'\n" \
+          "      VALUE: 3.2\n" \
+          "    * ID:   'right'\n" \
+          "      VALUE: 3.3\n"
+        )
+      end
+    end
+  end
+end

data/spec/core_extensions/webrick/httpresponse_spec.rb

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+
+require 'core_extensions/webrick/httpresponse'
+require 'intranet/core/haml_wrapper'
+require 'intranet/core/locales'
+
+RSpec.describe CoreExtensions::WEBrick::HTTPResponse do
+  before do
+    Intranet::Core::Locales.initialize
+    Intranet::Core::HamlWrapper.initialize
+    WEBrick::HTTPResponse.include described_class
+    @httpresponse = WEBrick::HTTPResponse.new(WEBrick::Config::HTTP)
+  end
+
+  describe '#create_error_page' do
+    context 'with an error code' do
+      before do
+        @httpresponse.status = 404
+        @httpresponse.create_error_page
+      end
+      it 'should return a customized error page for that error code' do
+        expect(@httpresponse.body).to eql(
+          "<!DOCTYPE html>\n<html>\n<head>\n" \
+          "<title>\n#{HTMLEntities.new.encode(I18n.t('nav.error.http'), :named)} 404 | \n" \
+          "#{HTMLEntities.new.encode(I18n.t('nav.error.http_404.short'), :named)}\n</title>\n" \
+          "<meta charset='utf-8'>\n" \
+          "<link href='/design/favicon.ico' rel='icon' type='image/x-icon'>\n" \
+          "<link href='/design/style.css' rel='stylesheet' type='text/css'>\n" \
+          "</head>\n<body>\n<header>\n" \
+          "<h1>\n<a href='/index.html'>#{Socket.gethostname.capitalize}</a>\n</h1>\n" \
+          "</header>\n<main>\n<section id='error'>\n" \
+          "<h2>\n#{HTMLEntities.new.encode(I18n.t('nav.error.http'), :named)} 404\n<br>\n" \
+          "#{HTMLEntities.new.encode(I18n.t('nav.error.http_404.short'), :named)}" \
+          "\n</h2>\n<p>\n<img alt='' src='/design/error.png'>\n<br>\n" \
+          "#{HTMLEntities.new.encode(I18n.t('nav.error.http_404.full'), :named)}\n" \
+          "<br>\n<br>\n<a href='/index.html'>" \
+          "#{HTMLEntities.new.encode(I18n.t('nav.back.home'), :named)}</a>\n</p>\n</section>\n" \
+          "</main>\n<footer></footer>\n</body>\n</html>\n"
+        )
+      end
+    end
+  end
+end

data/spec/intranet/core/fr.yml

@@ -0,0 +1,5 @@
+# fr.yml - Dummy translation file for intranet-core tests
+---
+
+fr:
+  dummy: 'Stupide'

data/spec/intranet/core/haml_wrapper_spec.rb

@@ -0,0 +1,70 @@
+# frozen_string_literal: true
+
+require 'intranet/core/haml_wrapper'
+
+RSpec.describe Intranet::Core::HamlWrapper do
+  describe '.initialize' do
+    before do
+      @load_path = File.absolute_path('../../../lib/intranet/resources/haml', __dir__)
+      described_class.initialize(@load_path)
+    end
+
+    it 'should define the default load path' do
+      expect(described_class.load_path).to eql([@load_path])
+    end
+  end
+
+  describe '.add_path' do
+    before do
+      @load_path = File.absolute_path('../../../lib/intranet/resources/haml', __dir__)
+      described_class.initialize(@load_path)
+      described_class.add_path(__dir__)
+    end
+
+    it 'should prepend the given directory to the HAML load path' do
+      expect(described_class.load_path.first).to eql(__dir__)
+    end
+  end
+
+  #---
+
+  let(:included) { Class.new { include Intranet::Core::HamlWrapper } }
+  let(:extended) { Class.new { extend Intranet::Core::HamlWrapper } }
+
+  describe 'to_markup' do
+    before do
+      described_class.initialize
+    end
+
+    context 'if the template is not found in path' do
+      before do
+        described_class.load_path = [] # empty load path
+        expect(described_class.load_path).to be_empty
+      end
+
+      it 'should return an empty string' do
+        expect(included.new.to_markup('')).to be_empty
+        expect(extended.to_markup('')).to be_empty
+
+        expect(included.new.to_markup('unknown')).to be_empty
+        expect(extended.to_markup('unknown')).to be_empty
+
+        expect(included.new.to_markup('title_and_breadcrumb')).to be_empty
+        expect(extended.to_markup('title_and_breadcrumb')).to be_empty
+      end
+    end
+
+    context 'given a valid HAML template and locals' do
+      test_in  = { title: 'TITLE_1', nav: { 'link_1' => '/index.html', 'link_2' => nil } }
+      test_out = "<h2>TITLE_1</h2>\n" \
+                 "<ul class='breadcrumb'>\n" \
+                 "<li>\n<a href='/index.html'>link_1</a>\n</li>\n" \
+                 "<li>link_2</li>\n" \
+                 "</ul>\n"
+      it 'should generate the markup from template using locals value' do
+        expect(included.new.to_markup('title_and_breadcrumb', test_in)).to eql(test_out)
+        expect(extended.to_markup('title_and_breadcrumb', test_in)).to eql(test_out)
+      end
+    end
+  end
+end