intranet-core 2.3.3 → 2.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 76f13ef8a3ab5032152a1a6d5c4a94fca53f02a74492ae02fe3e0af354e06e2c
-  data.tar.gz: ee7c7404de4b6c417ff25f1d39d94eef2adc8a482e0a9b1ed5f7817f6b62a5e8
+  metadata.gz: ba7fae26118e05ab115341089026cbbff79721a77bccb8412a6db8713c048d36
+  data.tar.gz: d759168cea8f4500321fec20e1bd555a54033e1ccebbcdb335596b1b55c5b211
 SHA512:
-  metadata.gz: d5e60003e1e2071a6da97d46d54a116cafd4b66d171d98914f0fb6c88ebee962a700681e96dd5ffbfdf2799a49677148840c49443aa1e31d0c4085688678a0d2
-  data.tar.gz: 2c40affb90abccfca11a0c38032f03f094c8fa9f907cf60cf1815a93a35c51b0736b9572bb4e249ed71462305e2a834ba245c73bb2aa387a7123f15dd17d7ee4
+  metadata.gz: 8c3c35cd768e6eed859d44343f40b93293ac3bd11f5b13cb9586e85cff96de7bef93a83774c5f2479397c15c16f2a3de0b571d3d5453454e847dbdff04ff4711
+  data.tar.gz: 7e26eb4903abd95964ae9ecf1f810d631043a92d32974ffbc81ee6ebf62c670b8427f65fb2feee6798899a18c542c40154acd26b7a77beecbe28a10cf23a40bc

data/lib/intranet/abstract_responder.rb

@@ -37,30 +37,44 @@ module Intranet
       # nothing to do
     end
 
-    # Generates the HTML content associated to the given +path+ and +query+.
+    # Generates the HTML answer (HTTP return code, MIME type and body) associated to the given
+    # +path+ and +query+.
+    #
+    # The function may return a partial content, in which case the HTTP return code must be 206 and
+    # the answer body is expected to be a +Hash+ with the following keys:
+    # * +:title+ (mandatory): the page title
+    # * +:content+ (mandatory): the partial content
+    # * +:stylesheets+ (optional): an array of the required Cascade Style Sheets (CSS) files, either
+    #   absolute or relative to the module root
+    # * +:scripts+ (optional): an array of hashes, each representing a <script> element to be
+    #   included in the generated page. Keys are the one accepted by the HTML <script> tag. The
+    #   +:src+ key may be either absolute or relative to the module root
     # @param path [String] The requested URI, relative to that module root URI
     # @param query [Hash] The URI variable/value pairs, if any
-    # @return [Array] The HTTP return code, the MIME type and the answer body.
+    # @return [Array<Integer, String, String> or Array<Integer, String, Hash>] The HTTP return code,
+    #         the MIME type and the answer body (partial if return code is 206).
     def generate_page(path, query)
       [404, '', '']
     end
 
     # Provides the list of Cascade Style Sheets (CSS) dependencies for this module, either using
     # absolute or relative (from the module root) paths.
-    # If redefined, this method should probably append dependencies rather than overwriting them.
+    # @deprecated Use {generate_page} partial content feature, setting +:stylesheets+ attribute of
+    #             the returned body.
     # @return [Array] The list of CSS dependencies, as absolute path or relative to the module root
     #                 URL.
     def css_dependencies
-      ['/design/style.css']
+      []
     end
 
     # Provides the list of Javascript files (JS) dependencies for this module, either using
     # absolute or relative (from the module root) paths.
-    # If redefined, this method should probably append dependencies rather than overwriting them.
+    # @deprecated Use {generate_page} partial content feature, setting +:scripts+ attribute of the
+    #             returned body.
     # @return [Array] The list of JS dependencies, as absolute path or relative to the module root
     #                 URL.
     def js_dependencies
-      ['/design/nav.js']
+      []
     end
   end
 end

data/lib/intranet/core/builder.rb

@@ -117,8 +117,9 @@ module Intranet
       # @param responder [Intranet::AbstractResponder] The responder that produced the body
       # @param path [String] The path to the responder
       def add_header_and_footer(body, responder, path)
-        to_markup('skeleton', body: body, css: responder.css_dependencies,
-                              js: responder.js_dependencies, current_path: path)
+        body[:stylesheets] ||= responder.css_dependencies
+        body[:scripts] ||= responder.js_dependencies.map { |url| { src: url, defer: 'defer' } }
+        to_markup('skeleton', body: body, current_path: path)
       end
 
       # Check whether a path is valid. In particular, this function excludes a path containing an

data/lib/intranet/core/version.rb

@@ -6,7 +6,7 @@ module Intranet
     NAME = 'intranet-core'
 
     # The version of the gem, according to semantic versionning.
-    VERSION = '2.3.3'
+    VERSION = '2.4.0'
 
     # The URL of the gem homepage.
     HOMEPAGE_URL = 'https://rubygems.org/gems/intranet-core'

data/lib/intranet/resources/haml/skeleton.haml

@@ -4,23 +4,21 @@
     %title= Socket.gethostname.capitalize + ' | ' + body[:title]
     %meta{charset: 'utf-8'}
     %link{rel: 'icon', type: 'image/x-icon', href: '/design/favicon.ico'}
-    - css.each do |url|
-      - if url.start_with?('/')
-        %link{rel: 'stylesheet', type: 'text/css', href: url}
-      - else
-        %link{rel: 'stylesheet', type: 'text/css', href: current_path + '/' + url}
-    - js.each do |url|
-      - if url.start_with?('/')
-        %script{src: url, defer: 'defer'}
-      - else
-        %script{src: current_path + '/' + url, defer: 'defer'}
+    %link{rel: 'stylesheet', type: 'text/css', href: '/design/style.css'}
+    - body[:stylesheets].each do |url|
+      - url = current_path + '/' + url unless url.start_with?('/')
+      %link{rel: 'stylesheet', type: 'text/css', href: url}
+    %script{type: 'module', src: '/design/nav.js'}
+    - body[:scripts].each do |script|
+      - script[:src] = current_path + '/' + script[:src] unless script[:src].start_with?('/')
+      %script{script}
   %body
     %header
-      %a{id: 'openmenu', onclick: 'openNavMenu();'}= '☰'
+      %a{id: 'openmenu'}= '☰'
       %h1
         %a{href: '/index.html', title: I18n.t('nav.back.home')}= Socket.gethostname.capitalize
       %nav
-        %a{id: 'closemenu', onclick: 'closeNavMenu();'}= '×'
+        %a{id: 'closemenu'}= '×'
         %ul
           - responders.children_nodes.each do |path, node|
             - if node.children?
@@ -48,7 +46,7 @@
         = ' ' + I18n.t('nav.generated.on_date') + ' ' + Time.now.strftime(I18n.t('date_format'))
         = ' ' + I18n.t('date_time_separator') + Time.now.strftime(I18n.t('time_format'))
         %br
-        %a{onclick: 'openModal();'}= I18n.t('nav.about')
+        %a{id: 'openmodal'}= I18n.t('nav.about')
       %aside#modal
         %div#modal-content
           %h2= 'Intranet'

data/lib/intranet/resources/www/nav.js

@@ -4,23 +4,13 @@
  * and for the modal box.
  */
 
+const openMenu = document.getElementById('openmenu');
+const closeMenu = document.getElementById('closemenu');
+const navMenu = document.querySelectorAll('header nav')[0];
+openMenu.addEventListener('click', function() { navMenu.style.width = 'auto'; });
+closeMenu.addEventListener('click', function() { navMenu.style.width = ''; });
 
-function openNavMenu() {
-  document.querySelectorAll('header nav')[0].style.width = 'auto';
-}
-
-function closeNavMenu() {
-  /* Remove value property set in openNavMenu() */
-  document.querySelectorAll('header nav')[0].style.width = '';
-}
-
-function openModal() {
-  document.getElementById('modal').style.display = 'block';
-}
-
-window.onclick = function(event) {
-  if (event.target == document.getElementById('modal')) {
-    document.getElementById('modal').style.display = 'none';
-  }
-}
-
+const openModal = document.getElementById('openmodal');
+const modal = document.getElementById('modal');
+openModal.addEventListener('click', function() { modal.style.display = 'block'; });
+modal.addEventListener('click', function() { modal.style.display = 'none'; });

data/spec/intranet/core_spec.rb

@@ -244,13 +244,21 @@ RSpec.describe Intranet::Core do
       it 'should be called to retrieve the body of the page' do
         @intranet = described_class.new(Intranet::Logger.new(Intranet::Logger::FATAL))
 
-        responder = Intranet::TestResponder.new(
-          {
-            '/index.html' => [206, 'text/html', { content: 'PARTIAL_CONTENT', title: 'MyTitle' }]
-          },
-          ['/responder.css', 'nav.css'],
-          ['module.js', '/js/interactive.js']
-        )
+        responder = Intranet::TestResponder.new({
+                                                  '/index.html' => [
+                                                    206,
+                                                    'text/html',
+                                                    {
+                                                      content: 'PARTIAL_CONTENT',
+                                                      title: 'MyTitle',
+                                                      stylesheets: ['/resp.css', 'nav.css'],
+                                                      scripts: [
+                                                        { src: 'module.js', type: 'module' },
+                                                        { src: '/js/interactive.js', defer: 'defer' }
+                                                      ]
+                                                    }
+                                                  ]
+                                                })
         @intranet.register_module(responder, ['r'], responder.resources_dir)
 
         thread = Thread.new { @intranet.start }
@@ -280,11 +288,11 @@ RSpec.describe Intranet::Core do
         expect(html).to match(%r{<footer>.*#{hostname}.*</footer>}m)
 
         # Returned HTML document: includes all CSS dependencies, relative or absolute path
-        expect(html).to match(%r{<link href='/responder.css' rel='stylesheet' type='text/css'})
+        expect(html).to match(%r{<link href='/resp.css' rel='stylesheet' type='text/css'})
         expect(html).to match(%r{<link href='/r/nav.css' rel='stylesheet' type='text/css'})
 
         # Returned HTML document: includes all JS dependencies
-        expect(html).to match(%r{<script defer='defer' src='/r/module.js'></script>})
+        expect(html).to match(%r{<script src='/r/module.js' type='module'></script>})
         expect(html).to match(%r{<script defer='defer' src='/js/interactive.js'></script>})
 
         # Returned HTML document: includes Intranet Core name, version and URL
@@ -306,7 +314,7 @@ RSpec.describe Intranet::Core do
         responder = Intranet::TestResponder.new(
           '/index.html' => [206, 'text/html', { content: 'PARTIAL_CONTENT', title: 'MyTitle' }]
         )
-        other_responder = Intranet::TestResponder.new({}, [], [], true)
+        other_responder = Intranet::TestResponder.new({}, true)
         @intranet.register_module(responder, %w[r], responder.resources_dir)
         @intranet.register_module(responder, %w[dep_th1], responder.resources_dir)
         @intranet.register_module(responder, %w[depth2 res_p1], responder.resources_dir)

data/spec/test_responder/responder.rb

@@ -6,10 +6,8 @@ module Intranet
   class TestResponder < AbstractResponder
     attr_reader :finalized
 
-    def initialize(responses = {}, extra_css = [], extra_js = [], hide_from_menu = false) # rubocop:disable Metrics/ParameterLists
+    def initialize(responses = {}, hide_from_menu = false)
       @responses = responses
-      @extra_css = extra_css
-      @extra_js = extra_js
       @finalized = false
       @hide_from_menu = hide_from_menu
     end
@@ -47,14 +45,6 @@ module Intranet
       super(path, query)
     end
 
-    def css_dependencies
-      super + @extra_css
-    end
-
-    def js_dependencies
-      super + @extra_js
-    end
-
     private
 
     def dump_with_encoding(path, query)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: intranet-core
 version: !ruby/object:Gem::Version
-  version: 2.3.3
+  version: 2.4.0
 platform: ruby
 authors:
 - Ebling Mis
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-05-30 00:00:00.000000000 Z
+date: 2021-10-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: haml
@@ -211,8 +211,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.6.2
+rubygems_version: 3.2.5
 signing_key: 
 specification_version: 4
 summary: Core component to build a custom intranet.