intranet-core 1.0.0

data/spec/intranet/logger_spec.rb

@@ -0,0 +1,129 @@
+# frozen_string_literal: true
+
+require 'intranet/logger'
+
+RSpec.describe Intranet::Logger do
+  it 'should define 5 logging levels (FATAL, ERROR, WARN, INFO, DEBUG)' do
+    expect { described_class::FATAL }.not_to raise_error
+    expect { described_class::ERROR }.not_to raise_error
+    expect { described_class::WARN  }.not_to raise_error
+    expect { described_class::INFO  }.not_to raise_error
+    expect { described_class::DEBUG }.not_to raise_error
+  end
+
+  it { is_expected.to respond_to(:fatal, :error, :warn, :info, :debug) }
+
+  describe '#log' do
+    before(:all) do
+      @logger = described_class.new
+    end
+
+    TEST_CASES = [
+      {
+        level: described_class::FATAL, level_str: 'FATAL', level_method: :fatal,
+        displayed: {
+          described_class::FATAL => true,
+          described_class::ERROR => true,
+          described_class::WARN => true,
+          described_class::INFO => true,
+          described_class::DEBUG => true
+        },
+        color_regex: /^\033\[1;37;41m.*\033\[0m$/,
+        color_desc: 'bold white on a red background'
+      },
+      {
+        level: described_class::ERROR, level_str: 'ERROR', level_method: :error,
+        displayed: {
+          described_class::FATAL => false,
+          described_class::ERROR => true,
+          described_class::WARN => true,
+          described_class::INFO => true,
+          described_class::DEBUG => true
+        },
+        color_regex: /^\033\[0;31m.*\033\[0m$/,
+        color_desc: 'red'
+      },
+      {
+        level: described_class::WARN, level_str: 'WARN', level_method: :warn,
+        displayed: {
+          described_class::FATAL => false,
+          described_class::ERROR => false,
+          described_class::WARN => true,
+          described_class::INFO => true,
+          described_class::DEBUG => true
+        },
+        color_regex: /^\033\[0;33m.*\033\[0m$/,
+        color_desc: 'yellow'
+      },
+      {
+        level: described_class::INFO, level_str: 'INFO', level_method: :info,
+        displayed: {
+          described_class::FATAL => false,
+          described_class::ERROR => false,
+          described_class::WARN => false,
+          described_class::INFO => true,
+          described_class::DEBUG => true
+        },
+        color_regex: /^\033\[0;36m.*\033\[0m$/,
+        color_desc: 'cyan'
+      },
+      {
+        level: described_class::DEBUG, level_str: 'DEBUG', level_method: :debug,
+        displayed: {
+          described_class::FATAL => false,
+          described_class::ERROR => false,
+          described_class::WARN => false,
+          described_class::INFO => false,
+          described_class::DEBUG => true
+        },
+        color_regex: /^\033\[0;35m.*\033\[0m$/,
+        color_desc: 'purple'
+      }
+    ].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
+          tc[:displayed].each do |level, displayed|
+            @logger.level = level
+            if displayed
+              expect { @logger.log(tc[:level], 'TEST_MSG') }
+                .to output(/TEST_MSG/).to_stderr_from_any_process
+              expect { @logger.send(tc[:level_method], 'TEST_MSG') }
+                .to output(/TEST_MSG/).to_stderr_from_any_process
+            else
+              expect { @logger.log(tc[:level], 'TEST_MSG') }
+                .not_to output.to_stderr_from_any_process
+              expect { @logger.send(tc[:level_method], 'TEST_MSG') }
+                .not_to output.to_stderr_from_any_process
+            end
+          end
+        end
+
+        it 'should be timestamped' do
+          @logger.level = tc[:level]
+          time_of_test = Time.now
+          allow(Time).to receive(:now).and_return(time_of_test)
+          expect { @logger.log(tc[:level], 'TEST_MSG') }
+            .to output(/#{time_of_test.strftime("\\[%Y-%m-%d %H:%M:%S\\]")}/)
+            .to_stderr_from_any_process
+          expect { @logger.send(tc[:level_method], 'TEST_MSG') }
+            .to output(/#{time_of_test.strftime("\\[%Y-%m-%d %H:%M:%S\\]")}/)
+            .to_stderr_from_any_process
+        end
+
+        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
+          expect { @logger.send(tc[:level_method], 'TEST_MSG') }
+            .to output(tc[:color_regex]).to_stderr_from_any_process
+        end
+      end
+    end
+
+    after(:all) do
+      @logger.close
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,50 @@
+# frozen_string_literal: true
+
+# This file is automatically loaded in each *_spec.rb file, so keep it light!
+
+RSpec.configure do |config|
+  config.expect_with :rspec do |expectations|
+    expectations.include_chain_clauses_in_custom_matcher_descriptions = true
+  end
+
+  config.mock_with :rspec do |mocks|
+    mocks.verify_partial_doubles = true
+  end
+
+  config.shared_context_metadata_behavior = :apply_to_host_groups
+
+  config.disable_monkey_patching!
+
+  # config.warnings = true
+
+  # Use the documentation formatter when RSpec is launched with one file only
+  config.default_formatter = 'doc' if config.files_to_run.one?
+
+  # Print the 10 slowest examples and example groups at the
+  # end of the spec run, to help surface which specs are running
+  # particularly slow.
+  # config.profile_examples = 10
+
+  # Run specs in random order to surface order dependencies. If you find an
+  # order dependency and want to debug it, you can fix the order by providing
+  # the seed, which is printed after each run.
+  #     --seed 1234
+  config.order = :random
+
+  # Seed global randomization in this process using the `--seed` CLI option.
+  # Setting this allows you to use `--seed` to deterministically reproduce
+  # test failures related to randomization by passing the same `--seed` value
+  # as the one that triggered the failure.
+  Kernel.srand config.seed
+
+  # Add lib/ directory to load path
+  $LOAD_PATH << File.absolute_path(File.join('..', 'lib'), __dir__)
+
+  # 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'
+  end
+end

data/spec/test_responder/responder.rb

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+
+require 'intranet/abstract_responder'
+
+module Intranet
+  class TestResponder < AbstractResponder
+    attr_reader :finalized
+
+    def initialize(responses = {}, extra_css = [], extra_js = [])
+      @responses = responses
+      @extra_css = extra_css
+      @extra_js = extra_js
+      @finalized = false
+    end
+
+    def finalize
+      @finalized = true
+    end
+
+    def resources_dir
+      __dir__
+    end
+
+    def generate_page(path, query)
+      if path == '/query'
+        [200, 'text/plain', query.to_s + "\r\n"]
+      else
+        @responses.fetch(path)
+      end
+    rescue KeyError
+      super(path, query)
+    end
+
+    def css_dependencies
+      super + @extra_css
+    end
+
+    def js_dependencies
+      super + @extra_js
+    end
+  end
+end

data/spec/test_responder/www/style.css

@@ -0,0 +1,5 @@
+/**
+ * test_responder/www/style.css
+ * Design for the Test Responder of the Intranet-Core.
+ */
+

metadata

@@ -0,0 +1,218 @@
+--- !ruby/object:Gem::Specification
+name: intranet-core
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Ebling Mis
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2018-12-23 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: haml
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: htmlentities
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+- !ruby/object:Gem::Dependency
+  name: i18n
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: titleize
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: webrick
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.61.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.61.0
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: 
+email: ebling.mis@protonmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- README.md
+- lib/core_extensions.rb
+- lib/core_extensions/string.rb
+- lib/core_extensions/tree.rb
+- lib/core_extensions/webrick/httpresponse.rb
+- lib/intranet/abstract_responder.rb
+- lib/intranet/core.rb
+- lib/intranet/core/builder.rb
+- lib/intranet/core/haml_wrapper.rb
+- lib/intranet/core/locales.rb
+- lib/intranet/core/servlet.rb
+- lib/intranet/core/version.rb
+- lib/intranet/logger.rb
+- lib/intranet/resources/haml/http_error.haml
+- lib/intranet/resources/haml/skeleton.haml
+- lib/intranet/resources/haml/title_and_breadcrumb.haml
+- lib/intranet/resources/locales/en.yml
+- lib/intranet/resources/locales/fr.yml
+- lib/intranet/resources/www/background.jpg
+- lib/intranet/resources/www/error.png
+- lib/intranet/resources/www/favicon.ico
+- lib/intranet/resources/www/fonts/SourceSansPro.woff2
+- lib/intranet/resources/www/nav.js
+- lib/intranet/resources/www/style.css
+- spec/core_extensions/string_spec.rb
+- spec/core_extensions/tree_spec.rb
+- spec/core_extensions/webrick/httpresponse_spec.rb
+- spec/intranet/core/fr.yml
+- spec/intranet/core/haml_wrapper_spec.rb
+- spec/intranet/core/locales_spec.rb
+- spec/intranet/core_spec.rb
+- spec/intranet/logger_spec.rb
+- spec/spec_helper.rb
+- spec/test_responder/responder.rb
+- spec/test_responder/www/style.css
+homepage: https://bitbucket.org/ebling-mis/intranet-core.git
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - "~>"
+    - !ruby/object:Gem::Version
+      version: '2.3'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.5.2.1
+signing_key: 
+specification_version: 4
+summary: Core component to build a custom intranet.
+test_files: []