intranet-core 2.2.0 → 2.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a6860141eca0145a6d51787a137641ead4978b69d2f7b2d28ce5dcf1a5193f42
-  data.tar.gz: 6f43415cdf7334c81466b1205a838b92762c15dff3fb8ca3e096ccb71ebecfa2
+  metadata.gz: 16b200333caf9c9d025918b638960d84cc75214e4434bda26d4bd77d8f393301
+  data.tar.gz: 1f79effde4c5f7644226cb6667294814583fa09c8fc38bd895d2ca3ddf4eea66
 SHA512:
-  metadata.gz: 84eeb50385f879656140e5b385a98a50c3149fa7b6cb8d31fd49b97ce73d5f69eda2e3e33789876196c0eaccaa47721b089e7870a0b90880392f03aedb279600
-  data.tar.gz: 07e5122a4279dc99efe881651637e932ec36601b3007529e545b13b7ccaef2297ca05b7f6184f02a6693d61ad1147b162961c508992ce57ce09ce56a0a8de32e
+  metadata.gz: afa34d535755b7361b2b62a9b5824455652fc6d93d1e46f4d596f4bed09923ed3e1c7cf09ef6c05e92f615996d6ab4047626d052da61c6ef751c6751ed8227eb
+  data.tar.gz: f2abd667c22214dbe21a78417041a8b39aaec9a6e84f72cbfb423ded76ae58f416b61ffcf782e1427a63cc9435031068ccb2fc427c3d3a732131b76795cdac53

data/lib/core_extensions/tree.rb

@@ -62,10 +62,10 @@ module CoreExtensions
     # (depth-first).
     # @return [String]
     def to_s(offset = '')
-      str = offset + 'VALUE: ' + @value.to_s + "\n"
+      str = offset + "VALUE: #{@value}\n"
       @children_nodes.each do |id, node|
-        str += offset + ' * ID:   \'' + id.to_s + '\'' + "\n"
-        str += node.to_s(offset + '   ')
+        str += offset + " * ID:   '#{id}'\n"
+        str += node.to_s("#{offset}   ")
       end
       str
     end

data/lib/intranet/core.rb

@@ -56,7 +56,7 @@ module Intranet
       raise Errno::EALREADY if @server.status != :Stop
 
       @builder.register(responder, path)
-      module_add_servlet(path.empty? ? ['home'] : path, resources_dir)
+      module_add_servlet(path, resources_dir)
       module_add_locales(resources_dir)
       module_add_haml_templates(resources_dir)
     end
@@ -70,8 +70,8 @@ module Intranet
 
     # Starts the web server.
     def start
-      @logger.info('Intranet::Core: using locale \'' + I18n.default_locale.to_s + '\'')
-      @logger.info('Intranet::Core: running Intranet version ' + VERSION)
+      @logger.info("Intranet::Core: using locale '#{I18n.default_locale}'")
+      @logger.info("Intranet::Core: running Intranet version #{VERSION}")
       # Start serving HTTP requests
       @server.start
     end
@@ -115,7 +115,7 @@ module Intranet
     end
 
     def module_add_servlet(path, resources_dir)
-      @server.mount('/' + path.join('/') + '/design',
+      @server.mount("/#{path.join('/')}/design",
                     WEBrick::HTTPServlet::FileHandler,
                     File.join(resources_dir, 'www'))
     end

data/lib/intranet/core/builder.rb

@@ -38,7 +38,7 @@ module Intranet
         @responders.to_h.each do |path, responder|
           next if responder.nil?
 
-          @logger.debug('Intranet::Builder: finalize responder at \'' + path + '\'')
+          @logger.debug("Intranet::Builder: finalize responder at '#{path}'")
           responder.finalize
         end
       end
@@ -108,7 +108,7 @@ module Intranet
           end
         end
 
-        [current_treenode.value, '/' + parsed_path.join('/'), '/' + unparsed_path.join('/')]
+        [current_treenode.value, "/#{parsed_path.join('/')}", "/#{unparsed_path.join('/')}"]
       end
 
       # Encapsulate the given body in the default page skeleton, effectively
@@ -121,7 +121,8 @@ module Intranet
                               js: responder.js_dependencies, current_path: path)
       end
 
-      # Check whether a path is valid.
+      # Check whether a path is valid. In particular, this function excludes a path containing an
+      # empty ('') or dot ('.') part, for instance '/path//to/./responder'.
       # @param path [Array] The path to test.
       # @return [Boolean] True if the path is valid, False otherwise.
       def valid_path?(path)
@@ -137,8 +138,6 @@ module Intranet
       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

data/lib/intranet/core/haml_wrapper.rb

@@ -50,7 +50,7 @@ module Intranet
       # @return [String] The path to the template if it exists, an empty string otherwise.
       def find_template(template)
         HamlWrapper.load_path.each do |dir|
-          candidate = File.join(dir, template + '.haml')
+          candidate = File.join(dir, "#{template}.haml")
           return candidate if File.exist?(candidate)
         end
         ''

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.2.0'
+    VERSION = '2.3.0'
 
     # The URL of the gem homepage.
     HOMEPAGE_URL = 'https://rubygems.org/gems/intranet-core'

data/lib/intranet/logger.rb

@@ -26,7 +26,7 @@ module Intranet
     # @param level The level of the message
     # @param msg [String] The message
     def log(level, msg)
-      super(level, COLOR[level] + Time.now.strftime('[%Y-%m-%d %H:%M:%S] ') + msg + "\033[0m")
+      super(level, "#{COLOR[level]}#{Time.now.strftime('[%Y-%m-%d %H:%M:%S]')} #{msg}\033[0m")
     end
 
     # Logs an object that responds to +to_s+ at level INFO.

data/spec/intranet/core/haml_wrapper_spec.rb

@@ -37,20 +37,12 @@ RSpec.describe Intranet::Core::HamlWrapper do
     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
 

data/spec/intranet/core_spec.rb

@@ -152,7 +152,7 @@ RSpec.describe Intranet::Core do
 
       it 'should be used to serve URI relative to the module root' do
         socket = TCPSocket.new('localhost', @intranet.port)
-        socket.puts("GET /responder/index.html HTTP/1.1\r\n" \
+        socket.puts("GET /responder/ HTTP/1.1\r\n" \
                     "Host: localhost:#{@intranet.port}\r\n\r\n")
         expect(socket.gets).to include('HTTP/1.1 200 OK')
         socket.close
@@ -264,7 +264,7 @@ RSpec.describe Intranet::Core do
 
         # 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 Layout/LineLength
+          %r{<footer>.*<a href='#{Intranet::Core::HOMEPAGE_URL}'.*>#{Intranet::Core::NAME}</a>.*#{Intranet::Core::VERSION}.*</footer>}m
         )
 
         # Returned HTML document: includes all registered modules version name, version and URL

data/spec/intranet/logger_spec.rb

@@ -18,7 +18,7 @@ RSpec.describe Intranet::Logger do
       @logger = described_class.new
     end
 
-    TEST_CASES = [
+    test_cases = [
       {
         level: described_class::FATAL, level_str: 'FATAL', level_method: :fatal,
         displayed: {
@@ -81,9 +81,9 @@ RSpec.describe Intranet::Logger do
       }
     ].freeze
 
-    TEST_CASES.each do |tc|
-      context 'given a ' + tc[:level_str] + ' message' do
-        it 'should only be displayed if logger level is at least ' + tc[:level_str] do
+    test_cases.each do |tc|
+      context "given a #{tc[:level_str]} message" do
+        it "should only be displayed if logger level is at least #{tc[:level_str]}" do
           tc[:displayed].each do |level, displayed|
             @logger.level = level
             if displayed
@@ -112,7 +112,7 @@ RSpec.describe Intranet::Logger do
             .to_stderr_from_any_process
         end
 
-        it 'should be colored in ' + tc[:color_desc] do
+        it "should be colored in #{tc[:color_desc]}" do
           @logger.level = tc[:level]
           expect { @logger.log(tc[:level], 'TEST_MSG') }
             .to output(tc[:color_regex]).to_stderr_from_any_process

data/spec/spec_helper.rb

@@ -43,8 +43,11 @@ RSpec.configure do |config|
   # Load and start SimpleCov to gather code coverage information
   unless config.files_to_run.one?
     require 'simplecov'
-    SimpleCov.add_filter 'spec' # exclude 'spec' folder from coverage
-    SimpleCov.start
-    require 'intranet/core'
+    SimpleCov.start do
+      enable_coverage :branch                   # measure branches coverage
+      primary_coverage :branch
+      minimum_coverage line: 100, branch: 100   # minimal coverage rate to succeed
+      add_filter 'spec'                         # exclude 'spec' folder from coverage
+    end
   end
 end

data/spec/test_responder/responder.rb

@@ -6,7 +6,7 @@ module Intranet
   class TestResponder < AbstractResponder
     attr_reader :finalized
 
-    def initialize(responses = {}, extra_css = [], extra_js = [], hide_from_menu = false)
+    def initialize(responses = {}, extra_css = [], extra_js = [], hide_from_menu = false) # rubocop:disable Metrics/ParameterLists
       @responses = responses
       @extra_css = extra_css
       @extra_js = extra_js
@@ -37,10 +37,6 @@ module Intranet
       'http://nil/'
     end
 
-    def resources_dir
-      super
-    end
-
     def generate_page(path, query)
       if path.start_with?('/query')
         [200, 'text/plain', dump_with_encoding(path, query)]
@@ -62,7 +58,7 @@ module Intranet
     private
 
     def dump_with_encoding(path, query)
-      "PATH=#{path} (#{path.encoding}), QUERY={" +
+      "PATH=#{path} (#{path.encoding}), QUERY={" + # rubocop:disable Style/StringConcatenation
         query.map { |k, v| "#{k} (#{k.encoding}) => #{v} (#{v.encoding})" }.join(',') +
         "}\r\n"
     end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: intranet-core
 version: !ruby/object:Gem::Version
-  version: 2.2.0
+  version: 2.3.0
 platform: ruby
 authors:
 - Ebling Mis
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-01-02 00:00:00.000000000 Z
+date: 2021-01-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: haml
@@ -112,30 +112,30 @@ dependencies:
   name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 0.81.0
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 0.81.0
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '0.21'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '0.21'
 - !ruby/object:Gem::Dependency
   name: yard
   requirement: !ruby/object:Gem::Requirement
@@ -204,7 +204,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - "~>"
     - !ruby/object:Gem::Version
-      version: '2.3'
+      version: '2.5'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="