intranet-core 1.0.2 → 1.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 16bba6e4fbd42e10c7c782d5171b4092f5d116a0
-  data.tar.gz: ac817457c107a692555ae55af7bd98337094c778
+  metadata.gz: bf5a56e43b31aff50e2987cb337fdca3308f5444
+  data.tar.gz: c319c8fa7398563f469bb403edb7fff1923c126c
 SHA512:
-  metadata.gz: 4446887c3d60d16dbacea6820f17f4679490ee0bb83b20cbd5c12d2c9c5e5f98d60e21df0126632539d6789f92a9723bec7ff6a8b7c34d32197ed07e73c9cea4
-  data.tar.gz: 6708f510f4beeb3dc7bb2d981dd2ce49292f602b23489bf9a6c177829ef04040f5f3fe0dba129c9480723f7131dbee754dafa82d9d76e8c496b345450f1f7304
+  metadata.gz: 0cd16c07120e3a5f3996a9b186d69c40a5816ad58b3852b988d334a82a18637bf2f130dc098ce7d465976a4148b412cbb1955e001cad546ccf5c77d2d23b7599
+  data.tar.gz: a280390146e29d0fa3be5c44faebdc6f72b54d4c7e4599dd81ae94bde5c15e4481ece613c236d777522433beae0c9cb16dd92842488318a109b712f7ef2b9a8d

data/lib/intranet/abstract_responder.rb

@@ -3,6 +3,18 @@
 module Intranet
   # The default implementation and interface of an Intranet module.
   class AbstractResponder
+    # Returns the name of the module.
+    # @return [String] The name of the module
+    def self.module_name; end
+
+    # The version of the module, according to semantic versionning.
+    # @return [String] The version of the module
+    def self.module_version; end
+
+    # The homepage of the module, if any.
+    # @return [String/Nil] The homepage URL of the module, or nil if no homepage is available.
+    def self.module_homepage; end
+
     # Destroys the responder instance.
     # This method gets called when server is shut down.
     def finalize

data/lib/intranet/core/builder.rb

@@ -16,11 +16,16 @@ module Intranet
       # @return [CoreExtensions::Tree]
       attr_reader :responders
 
+      # The metadata concerning all registered modules (for Haml)
+      # @return [Hash]
+      attr_reader :modules
+
       # Initializes a new builder.
       # @param logger [Object] The logger.
       def initialize(logger)
         @logger = logger
         @responders = CoreExtensions::Tree.new
+        @modules = { NAME => { version: VERSION, homepage: HOMEPAGE_URL } }
       end
 
       # Finalizes the builder. Each registered responder is called for +finalize+.
@@ -63,17 +68,14 @@ module Intranet
       #                     directory. If empty, the responder will be registered as Home responder
       #                     (to serve /index.html in particular). Subdirectories are allowed using
       #                     an array element for each directory level.
+      # @raise [ArgumentError] If the +responder+ is not a valid responder instance.
       # @raise [ArgumentError] If one of the element of the +path+ contains invalid characters.
       def register(responder, path = [])
+        raise ArgumentError unless responder.class.superclass.to_s == 'Intranet::AbstractResponder'
         raise ArgumentError unless path.all?(&:urlized?)
 
-        current_node = @responders
-        path.each do |part|
-          next if part.empty? || part == '.'
-
-          current_node = current_node.add_child_node(part)
-        end
-        current_node.value = responder
+        insert_responder(responder, path)
+        store_module_metadata(responder)
       end
 
       private
@@ -93,6 +95,29 @@ module Intranet
 
         [current_treenode.value, '/' + relative_path.join('/')]
       end
+
+      # Inserts a responder instance in the appropriate Tree node according the given +path+.
+      # Missing Tree nodes are created.
+      # @param responder [Intranet::AbstractResponder] The responder instance of the module.
+      # @param path [Array] See Intranet::Builder::register().
+      def insert_responder(responder, path)
+        current_node = @responders
+        path.each do |part|
+          next if part.empty? || part == '.'
+
+          current_node = current_node.add_child_node(part)
+        end
+        current_node.value = responder
+      end
+
+      # Stores the module name, version and homepage URL. These information are used to display the
+      # 'about' modal window when partial content is returned by a module. The hash structure
+      # ensures that each module metadata are stored once only.
+      # @param responder [Intranet::AbstractResponder] The responder instance of the module.
+      def store_module_metadata(responder)
+        @modules[responder.class.module_name] = { version: responder.class.module_version,
+                                                  homepage: responder.class.module_homepage }
+      end
     end
   end
 end

data/lib/intranet/core/version.rb

@@ -2,7 +2,16 @@
 
 module Intranet
   class Core
-    # The version of the Intranet core, according to semantic versionning.
-    VERSION = '1.0.2'
+    # The name of the gem.
+    NAME = 'intranet-core'
+
+    # The version of the gem, according to semantic versionning.
+    VERSION = '1.1.1'
+
+    # The URL of the gem homepage.
+    HOMEPAGE_URL = 'https://rubygems.org/gems/intranet-core'
+
+    # The URL of the gem source code.
+    SOURCES_URL = 'https://bitbucket.org/ebling-mis/intranet-core'
   end
 end

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

@@ -45,8 +45,11 @@
       %aside#modal
         %div#modal-content
           %h2= 'Intranet'
-          %p
-            %strong
-              %a{href: 'https://rubygems.org/gems/intranet-core', target: '_blank'}= 'core'
-            = '  '
-            = Intranet::Core::VERSION
+          %dl
+            - modules.each do |name, metadata|
+              %dt
+                - if metadata[:homepage].nil?
+                  = name
+                - else
+                  %a{href: metadata[:homepage], target: '_blank'}= name
+              %dd= metadata[:version]

data/lib/intranet/resources/www/style.css

@@ -3,7 +3,7 @@
  * Design for the IntraNet core.
  */
 
-/******************************* External Fonts *******************************/
+/***************************************** External Fonts *****************************************/
 
 @font-face {
     font-family: "Source Sans Pro";
@@ -13,7 +13,7 @@
     unicode-range: U+0-FF, U+131, U+152-153, U+2C6, U+2DA, U+2DC, U+2000-206F, U+2074, U+20AC, U+2212, U+2215;
 }
 
-/******************************* General design *******************************/
+/***************************************** General design *****************************************/
 
 body, html {
     padding: 0px;
@@ -21,7 +21,7 @@ body, html {
     height: 100%;
 }
 body {
-    background: #1e262b url('background.jpg') fixed top right no-repeat;
+    background: #1e262b;
     font-family: "Source Sans Pro", Cantarell, sans-serif;
     color: black;
 }
@@ -38,7 +38,7 @@ a {
     cursor: pointer;
 }
 
-/********************************* Navigation *********************************/
+/******************************************* Navigation *******************************************/
 
 header {
     position: fixed;
@@ -193,6 +193,7 @@ ul.breadcrumb li a, main article a {
 /******************************** Main content *******************************/
 
 body > aside {
+    background: url('background.jpg') fixed top right no-repeat;
     height: 45%;
     min-height: 350px;
     max-height: 500px; /* less than height of background.jpg */
@@ -280,6 +281,19 @@ body > footer aside#modal #modal-content { /* modal box */
     width: 400px;
     font-size: 125%;
 }
+body > footer aside#modal #modal-content dl {
+  display: grid;
+  grid-template-columns: repeat(2, 50%);
+  grid-gap: 5px 25px;
+}
+body > footer aside#modal #modal-content dl dt {
+  font-weight: bold;
+  text-align: right;
+}
+body > footer aside#modal #modal-content dl dd {
+  text-align: left;
+  margin-left: 0;
+}
 /* Mobile devices only */
 @media only screen and (max-width: 600px), only screen and (max-device-width: 600px) {
     body > footer {
@@ -288,7 +302,7 @@ body > footer aside#modal #modal-content { /* modal box */
 }
 
 
-/********************************* Error pages *********************************/
+/******************************************* Error pages ******************************************/
 
 section#error h2 {
     color: #ff3333;

data/spec/intranet/core_spec.rb

@@ -109,26 +109,9 @@ RSpec.describe Intranet::Core do
     end
 
     context 'registering an invalid module' do
-      it 'should succeed but accesses to the module URL should return HTTP error 404' do
-        begin
-          @intranet = described_class.new(Intranet::Logger.new(Intranet::Logger::FATAL))
-          @intranet.register_module(nil, [], '')
-          thread = Thread.new do
-            @intranet.start
-          end
-          while @intranet.instance_variable_get(:@server).status != :Running
-          end
-
-          socket = TCPSocket.new('localhost', @intranet.port)
-          socket.puts("GET /index.html HTTP/1.1\r\n" \
-                      "Host: localhost:#{@intranet.port}\r\n\r\n")
-          expect(socket.gets).to include('HTTP/1.1 404 Not Found')
-          socket.close
-        ensure
-          socket.close
-          Thread.kill(thread)
-          thread.join
-        end
+      it 'should fail' do
+        @intranet = described_class.new(Intranet::Logger.new(Intranet::Logger::FATAL))
+        expect { @intranet.register_module(nil, [], '') }.to raise_error ArgumentError
       end
     end
 
@@ -315,9 +298,15 @@ RSpec.describe Intranet::Core do
           expect(html).to match(%r{<script defer='defer' src='module.js'></script>})
           expect(html).to match(%r{<script defer='defer' src='/js/interactive.js'></script>})
 
-          # Returned HTML document: includes Intranet Core Version
-          expect(html).to match(%r{<footer>.*#{Intranet::Core::VERSION}.*</footer>}m)
-          expect(html).to match(%r{<footer>.*https://rubygems.org/gems/intranet-core.*</footer>}m)
+          # Returned HTML document: includes Intranet Core name, version and URL
+          expect(html).to match(
+            %r{<footer>.*<a href='#{Intranet::Core::HOMEPAGE_URL}'.*>#{Intranet::Core::NAME}</a>.*#{Intranet::Core::VERSION}.*</footer>}m # rubocop:disable Metrics/LineLength
+          )
+
+          # Returned HTML document: includes all registered modules version name, version and URL
+          expect(html).to match(
+            %r{<footer>.*<a href='http://nil/'.*>test-responder</a>.*0.0.0.*</footer>}m
+          )
         ensure
           socket.close
           Thread.kill(thread)

data/spec/test_responder/responder.rb

@@ -15,6 +15,19 @@ module Intranet
 
     def finalize
       @finalized = true
+      super
+    end
+
+    def self.module_name
+      'test-responder'
+    end
+
+    def self.module_version
+      '0.0.0'
+    end
+
+    def self.module_homepage
+      'http://nil/'
     end
 
     def resources_dir

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: intranet-core
 version: !ruby/object:Gem::Version
-  version: 1.0.2
+  version: 1.1.1
 platform: ruby
 authors:
 - Ebling Mis
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-12-24 00:00:00.000000000 Z
+date: 2019-02-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: haml
@@ -191,10 +191,11 @@ files:
 - spec/spec_helper.rb
 - spec/test_responder/responder.rb
 - spec/test_responder/www/style.css
-homepage: https://bitbucket.org/ebling-mis/intranet-core
+homepage: https://rubygems.org/gems/intranet-core
 licenses:
 - MIT
-metadata: {}
+metadata:
+  source_code_uri: https://bitbucket.org/ebling-mis/intranet-core
 post_install_message: 
 rdoc_options: []
 require_paths: