rimless 0.1.0

data/Rakefile

@@ -0,0 +1,76 @@
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+require 'rails/code_statistics'
+require 'pp'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec
+
+# Load some railties tasks
+load 'rails/tasks/statistics.rake'
+load 'rails/tasks/annotations.rake'
+
+# Clear the default statistics directory constant
+#
+# rubocop:disable Style/MutableConstant because we define it
+Object.send(:remove_const, :STATS_DIRECTORIES)
+::STATS_DIRECTORIES = []
+# rubocop:enable Style/MutableConstant
+
+# Monkey patch the Rails +CodeStatistics+ class to support configurable
+# patterns per path. This is reuqired to support top-level only file matches.
+class CodeStatistics
+  DEFAULT_PATTERN = /^(?!\.).*?\.(rb|js|coffee|rake)$/.freeze
+
+  # Pass the possible +pattern+ argument down to the
+  # +calculate_directory_statistics+ method call.
+  def calculate_statistics
+    Hash[@pairs.map do |pair|
+      [pair.first, calculate_directory_statistics(*pair[1..-1])]
+    end]
+  end
+
+  # Match the pattern against the individual file name and the relative file
+  # path. This allows top-level only matches.
+  def calculate_directory_statistics(directory, pattern = DEFAULT_PATTERN)
+    stats = CodeStatisticsCalculator.new
+
+    Dir.foreach(directory) do |file_name|
+      path = "#{directory}/#{file_name}"
+
+      if File.directory?(path) && (/^\./ !~ file_name)
+        stats.add(calculate_directory_statistics(path, pattern))
+      elsif file_name =~ pattern || path =~ pattern
+        stats.add_by_file_path(path)
+      end
+    end
+
+    stats
+  end
+end
+
+# Configure all code statistics directories
+vendors = [
+  # @TODO: Add your library structure here
+  # [:unshift, 'Clients', 'lib/hausgold/client'],
+  # [:unshift, 'Top-levels', 'lib', %r{lib(/hausgold)?/[^/]+\.rb$}],
+  # [:unshift, 'Clients specs', 'spec/client'],
+  # [:unshift, 'Top-levels specs', 'spec',
+  #  %r{spec/rimless(_spec\.rb|/[^/]+\.rb$)}]
+].reverse
+
+vendors.each do |method, type, dir, pattern|
+  ::STATS_DIRECTORIES.send(method, [type, dir, pattern].compact)
+  ::CodeStatistics::TEST_TYPES << type if type.include? 'specs'
+end
+
+# Setup annotations
+ENV['SOURCE_ANNOTATION_DIRECTORIES'] = 'spec,doc'
+
+desc 'Enumerate all annotations'
+task :notes do
+  SourceAnnotationExtractor.enumerate '@?OPTIMIZE|@?FIXME|@?TODO', tag: true
+end

data/bin/console

@@ -0,0 +1,16 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'bundler/setup'
+require 'rimless'
+require 'pp'
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require 'irb'
+IRB.start(__FILE__)

data/bin/run

@@ -0,0 +1,12 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'bundler/setup'
+require 'rimless'
+require 'pp'
+
+$stdout.sync = true
+
+exit 1 if ARGV.empty?
+
+ARGV.each { |cmd| eval(cmd); $stdout.flush }

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/config/docker/.bash_profile

@@ -0,0 +1,3 @@
+if [ -f ~/.bashrc ]; then
+  . ~/.bashrc
+fi

data/config/docker/.bashrc

@@ -0,0 +1,49 @@
+# ~/.bashrc: executed by bash(1) for non-login shells.
+# see /usr/share/doc/bash/examples/startup-files (in the package bash-doc)
+# for examples
+
+_GEM_PATHS=$(ls -d1 ${HOME}/.gem/ruby/*/bin 2>/dev/null | paste -sd ':')
+_APP_PATHS=$(ls -d1 /app/vendor/bundle/ruby/*/bin 2>/dev/null | paste -sd ':')
+
+export PATH="${_GEM_PATHS}:${_APP_PATHS}:${PATH}"
+export PATH="/app/node_modules/.bin:${HOME}/.bin:/app/bin:${PATH}"
+
+# Disable the autostart of all supervisord units
+sudo sed -i 's/autostart=.*/autostart=false/g' /etc/supervisor/conf.d/*
+
+# Start the supervisord (empty, no units)
+sudo supervisord >/dev/null 2>&1 &
+
+# Wait for supervisord
+while ! supervisorctl status >/dev/null 2>&1; do sleep 1; done
+
+# Boot the mDNS stack
+echo '# Start the mDNS stack'
+sudo supervisorctl start dbus avahi
+echo
+
+export MAKE_ENV=baremetal
+
+function watch-make-test()
+{
+  while [ 1 ]; do
+    inotifywait --quiet -r `pwd` -e close_write --format '%e -> %w%f'
+    make test
+  done
+}
+
+function watch-make()
+{
+  while [ 1 ]; do
+    inotifywait --quiet -r `pwd` -e close_write --format '%e -> %w%f'
+    make $@
+  done
+}
+
+function watch-run()
+{
+  while [ 1 ]; do
+    inotifywait --quiet -r `pwd` -e close_write --format '%e -> %w%f'
+    bash -c "$@"
+  done
+}

data/config/docker/.inputrc

@@ -0,0 +1,17 @@
+# mappings for Ctrl-left-arrow and Ctrl-right-arrow for word moving
+"\e[1;5C": forward-word
+"\e[1;5D": backward-word
+"\e[5C": forward-word
+"\e[5D": backward-word
+"\e\e[C": forward-word
+"\e\e[D": backward-word
+
+# handle common Home/End escape codes
+"\e[1~": beginning-of-line
+"\e[4~": end-of-line
+"\e[7~": beginning-of-line
+"\e[8~": end-of-line
+"\eOH": beginning-of-line
+"\eOF": end-of-line
+"\e[H": beginning-of-line
+"\e[F": end-of-line

data/doc/assets/project.svg

@@ -0,0 +1,68 @@
+<?xml version="1.0" encoding="UTF-8" standalone="no"?>
+<svg
+   xmlns:dc="http://purl.org/dc/elements/1.1/"
+   xmlns:cc="http://creativecommons.org/ns#"
+   xmlns:rdf="http://www.w3.org/1999/02/22-rdf-syntax-ns#"
+   xmlns:svg="http://www.w3.org/2000/svg"
+   xmlns="http://www.w3.org/2000/svg"
+   version="1.1"
+   id="Ebene_1"
+   x="0px"
+   y="0px"
+   viewBox="0 0 800 200"
+   xml:space="preserve"
+   width="800"
+   height="200"><metadata
+   id="metadata33"><rdf:RDF><cc:Work
+       rdf:about=""><dc:format>image/svg+xml</dc:format><dc:type
+         rdf:resource="http://purl.org/dc/dcmitype/StillImage" /><dc:title></dc:title></cc:Work></rdf:RDF></metadata><defs
+   id="defs31" />
+<style
+   type="text/css"
+   id="style2">
+    .st0{fill-rule:evenodd;clip-rule:evenodd;fill:#E73E11;}
+    .st1{fill-rule:evenodd;clip-rule:evenodd;fill:#0371B9;}
+    .st2{fill:#132E48;}
+    .st3{font-family:'OpenSans-Bold';}
+    .st4{font-size:29.5168px;}
+    .st5{fill-rule:evenodd;clip-rule:evenodd;fill:none;}
+    .st6{opacity:0.5;fill:#132E48;}
+    .st7{font-family:'OpenSans';}
+    .st8{font-size:12px;}
+</style>
+<g
+   transform="translate(0,1.53584)"
+   id="g828"><g
+   transform="translate(35.93985,35.66416)"
+   id="g8">
+    <path
+   style="clip-rule:evenodd;fill:#e73e11;fill-rule:evenodd"
+   id="path4"
+   d="m -0.1,124.4 c 0,0 33.7,-123.2 66.7,-123.2 12.8,0 26.9,21.9 38.8,47.2 -23.6,27.9 -66.6,59.7 -94,76 -7.1,0 -11.5,0 -11.5,0 z"
+   class="st0" />
+    <path
+   style="clip-rule:evenodd;fill:#0371b9;fill-rule:evenodd"
+   id="path6"
+   d="m 88.1,101.8 c 13.5,-10.4 18.4,-16.2 27.1,-25.4 10,25.7 16.7,48 16.7,48 0,0 -41.4,0 -78,0 14.6,-7.9 18.7,-10.7 34.2,-22.6 z"
+   class="st1" />
+</g><text
+   y="106.40316"
+   x="192.43155"
+   style="font-style:normal;font-variant:normal;font-weight:bold;font-stretch:normal;font-size:29.51733398px;font-family:'Open Sans', sans-serif;-inkscape-font-specification:'OpenSans-Bold, Bold';font-variant-ligatures:normal;font-variant-caps:normal;font-variant-numeric:normal;font-feature-settings:normal;text-align:start;writing-mode:lr-tb;text-anchor:start;fill:#132e48"
+   id="text10"
+   class="st2 st3 st4">rimless</text>
+<rect
+   style="clip-rule:evenodd;fill:none;fill-rule:evenodd"
+   id="rect12"
+   height="24"
+   width="314.5"
+   class="st5"
+   y="118.06416"
+   x="194.23985" /><text
+   y="127.22146"
+   x="194.21715"
+   style="font-size:12px;font-family:'Open Sans', sans-serif;opacity:0.5;fill:#132e48;-inkscape-font-specification:'Open Sans, sans-serif, Normal';font-weight:normal;font-style:normal;font-stretch:normal;font-variant:normal;text-anchor:start;text-align:start;writing-mode:lr;font-variant-ligatures:normal;font-variant-caps:normal;font-variant-numeric:normal;font-feature-settings:normal;"
+   id="text14"
+   class="st6 st7 st8">A bundle of opinionated Apache Kafka / Confluent Schema Registry helpers</text>
+</g>
+</svg>

data/docker-compose.yml

@@ -0,0 +1,8 @@
+version: "3"
+services:
+  test:
+    build: .
+    network_mode: bridge
+    working_dir: /app
+    volumes:
+      - .:/app

data/gemfiles/rails_4.2.gemfile

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+# This file was generated by Appraisal
+
+source 'https://rubygems.org'
+
+gem 'activesupport', '~> 4.2.11'
+gem 'railties', '~> 4.2.11'
+
+gemspec path: '../'

data/gemfiles/rails_5.0.gemfile

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+# This file was generated by Appraisal
+
+source 'https://rubygems.org'
+
+gem 'activesupport', '~> 5.0.7'
+gem 'railties', '~> 5.0.7'
+
+gemspec path: '../'

data/gemfiles/rails_5.1.gemfile

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+# This file was generated by Appraisal
+
+source 'https://rubygems.org'
+
+gem 'activesupport', '~> 5.1.6'
+gem 'railties', '~> 5.1.6'
+
+gemspec path: '../'

data/gemfiles/rails_5.2.gemfile

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+# This file was generated by Appraisal
+
+source 'https://rubygems.org'
+
+gem 'activesupport', '~> 5.2.2'
+gem 'railties', '~> 5.2.2'
+
+gemspec path: '../'

data/lib/rimless.rb

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+require 'active_support'
+require 'active_support/concern'
+require 'active_support/configurable'
+require 'active_support/time'
+require 'active_support/time_with_zone'
+require 'active_support/core_ext/object'
+require 'active_support/core_ext/module'
+require 'active_support/core_ext/hash'
+require 'active_support/core_ext/string'
+require 'waterdrop'
+require 'avro_turf/messaging'
+require 'sparsify'
+require 'erb'
+require 'pp'
+
+# The top level namespace for the rimless gem.
+module Rimless
+  # Top level elements
+  autoload :Configuration, 'rimless/configuration'
+  autoload :ConfigurationHandling, 'rimless/configuration_handling'
+  autoload :AvroHelpers, 'rimless/avro_helpers'
+  autoload :AvroUtils, 'rimless/avro_utils'
+  autoload :KafkaHelpers, 'rimless/kafka_helpers'
+  autoload :Dependencies, 'rimless/dependencies'
+
+  # Load standalone code
+  require 'rimless/version'
+  require 'rimless/railtie' if defined? Rails
+
+  # Include top-level features
+  include Rimless::ConfigurationHandling
+  include Rimless::AvroHelpers
+  include Rimless::KafkaHelpers
+  include Rimless::Dependencies
+end

data/lib/rimless/avro_helpers.rb

@@ -0,0 +1,46 @@
+# frozen_string_literal: true
+
+module Rimless
+  # The top-level Apache Avro helpers.
+  module AvroHelpers
+    extend ActiveSupport::Concern
+
+    class_methods do
+      # A top-level avro instance
+      mattr_accessor :avro
+
+      # The Apache Avro Ruby gem requires simple typed hashes for encoding.
+      # This forces us to convert eg. Grape entity representations into simple
+      # string-keyed hashes. Use this method to prepare a hash for the Apache
+      # Avro serialization.
+      #
+      # Note about the implementation: JSON serialization and parsing is the
+      # simplest and fastest way to accomplish this.
+      #
+      # @param hash [Hash{Mixed => Mixed}] the hash to sanitize
+      # @return [Hash{String => Mixed}] the simple typed input hash
+      def avro_to_h(hash)
+        JSON.parse(hash.to_json)
+      end
+      alias_method :avro_sanitize, :avro_to_h
+
+      # Convert the given deep hash into a sparsed flat hash while transforming
+      # all values to strings. This allows to convert a schema-less hash to a
+      # Apache Avro compatible map.
+      #
+      # @see http://avro.apache.org/docs/current/spec.html#Maps
+      # @example Convert schema-less hash
+      #   avro_schemaless_map(a: { b: { c: true } })
+      #   # => { "a.b.c" => "true" }
+      #
+      # @param hash [Hash{Mixed => Mixed}] the deep hash
+      # @return [Hash{String => String}] the flatted and sparsed hash
+      def avro_schemaless_h(hash)
+        Sparsify(hash, sparse_array: true)
+          .transform_values(&:to_s)
+          .transform_keys { |key| key.delete('\\') }
+      end
+      alias_method :avro_schemaless_map, :avro_schemaless_h
+    end
+  end
+end

data/lib/rimless/avro_utils.rb

@@ -0,0 +1,96 @@
+# frozen_string_literal: true
+
+module Rimless
+  # Due to dynamic contrains on the Apache Avro schemas we need to compile our
+  # schema templates to actual ready-to-consume schemas. The namespace part of
+  # the schemas and cross-references to other schemas must be rendered
+  # according to the dynamic namespace prefix which reflects the application
+  # environment.  Unfortunately we need to mess around with actual files to
+  # support the Avro and AvroTurf gems.
+  class AvroUtils
+    attr_reader :namespace, :env
+
+    # Create a new instance of the +AvroUtil+ class.
+    #
+    # @return [AvroUtil] the new instance
+    def initialize
+      @namespace = ENV.fetch('KAFKA_SCHEMA_SUBJECT_PREFIX',
+                             Rimless.topic_prefix).tr('-', '_').gsub(/\.$/, '')
+      @env = @namespace.split('.').first
+    end
+
+    # Clean and recompile all templated Avro schema files to their respective
+    # output path.
+    def recompile_schemas
+      clear
+      Dir[base_path.join('**', '*.erb')].each { |src| render_file(src) }
+    end
+
+    # Render (compile) a single Avro schema template. The given source file
+    # path will serve to calculate the destination path. So even deep path'ed
+    # templates will keep their hierarchy.
+    #
+    # @param src [String] the Avro schema template file path
+    def render_file(src)
+      # Convert the template path to the destination path
+      dest = schema_path(src)
+      # Create the deep path when not yet existing
+      FileUtils.mkdir_p(File.dirname(dest))
+      # Write the rendered file contents to the destination
+      File.write(dest, ERB.new(File.read(src)).result(binding))
+      # Check the written file for correct JSON
+      validate_file(dest)
+    end
+
+    # Check the given file for valid JSON.
+    #
+    # @param dest [Pathname, File, IO] the file to check
+    # @raise [JSON::ParserError] when invalid
+    #
+    # rubocop:disable Security/JSONLoad because we wrote the file contents
+    def validate_file(dest)
+      JSON.load(dest)
+    rescue JSON::ParserError => err
+      path = File.expand_path(dest.is_a?(File) ? dest.path : dest.to_s)
+      prefix = "Invalid JSON detected: #{path}"
+      Rimless.logger.fatal("#{prefix}\n#{err.message}")
+      err.message.prepend("#{prefix} - ")
+      raise err
+    end
+    # rubocop:enable Security/JSONLoad
+
+    # Clear previous compiled Avro schema files to provide a clean rebuild.
+    def clear
+      FileUtils.rm_rf(output_path)
+      FileUtils.mkdir_p(output_path)
+    end
+
+    # Return the compiled Avro schema file path for the given Avro schema
+    # template.
+    #
+    # @param src [String] the Avro schema template file path
+    # @return [Pathname] the resulting schema file path
+    def schema_path(src)
+      # No trailing dot on the prefix namespace directory
+      prefix = env.remove(/\.$/)
+      # Calculate the destination path based on the source file
+      Pathname.new(src.gsub(/^#{base_path}/, output_path.join(prefix).to_s)
+                      .gsub(/\.erb$/, ''))
+    end
+
+    # Return the base path of the Avro schemas on our project.
+    #
+    # @return [Pathname] the Avro schemas base path
+    def base_path
+      Rimless.configuration.avro_schema_path
+    end
+
+    # Return the path to the compiled Avro schemas. This path must be consumed
+    # by the +AvroTurf::Messaging+ constructor.
+    #
+    # @return [Pathname] the compiled Avro schemas path
+    def output_path
+      Rimless.configuration.compiled_avro_schema_path
+    end
+  end
+end