mx-rabl-extend-compiler 0.2.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 8e399d0228a70571515fabbe1dee74b45fdab8a64ca0ffa4f6f589199e61b099
+  data.tar.gz: 875001bde915ba85e0a2078372ff7d58c294cb90328e1e0ded7d2411f08828f3
+SHA512:
+  metadata.gz: a156d17f5530b7eb9265ec11dd8b73274851667e9385f030c37b5b91101338ce9cb4e4c0402ba49d62ebf0b7f989259f09d8eb38d44485069cb640f56456e7f9
+  data.tar.gz: e3cb0e7c4833bf9c05c39d4c3542a4defbd84e14938ed7536dc542593c3c3bb6fb275c9c363229e873ed2c20e312f41107b2990649308838997a7ef9985a1697

data/.gitignore

@@ -0,0 +1,10 @@
+.ruby*
+*.lock
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.3.0
+before_install: gem install bundler -v 1.16.2

data/Gemfile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+git_source(:github) { |repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in rabl-extend-compiler.gemspec
+gemspec

data/README.md

@@ -0,0 +1,63 @@
+# MX::Rabl::Extend::Compiler
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'mx-rabl-extend-compiler'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install mx-rabl-extend-compiler
+
+## Usage
+
+When using [Rabl](https://github.com/nesquena/rabl) there is a DSL method called `extend` which embeds another template in the current template and serves as a
+mechanism to be DRY and maintain object definitions in a single place.
+
+One signficant downside of such a pattern is that the template rendering for large number of collections can be significantly lower (we have measured from 10-25% slower on collections up to 1000 objects)
+
+In order to help facilitate still using Rabl (it's a great library) we decided to write a few rake tasks that allow us the benefits of then extension system
+without the drawbacks. Attempting to emulate something like what is mentioned in this [issue](https://github.com/nesquena/rabl/issues/500) and running rake tasks to verify or compile the extensions before moving to production.
+
+This gem merely outlines the components and they may be used as you see fit at varying times in your infrastructure (we run the verification rake task in our CI pipeline)
+
+The rake tasks are:
+
+`rake rabl:extend:compiler:all` - Runs all steps.
+
+`rake rabl:extend:compiler:reset` - Will reset all signatures from the extended files.
+
+`rake rabl:extend:compiler:compile` - Will compile and sign each use of `extend` in the code base.
+
+`rake rabl:extend:compiler:verify` - Will `exit(1)` if the extensions are not compiled or the signatures do not match on the compiled extensions.
+
+
+The "signatures" encompass the attributes or files from an extension and are merely a SHA256 digest of the file contents during the compilation step and creates an easy and fast mechanism to determine if the extended files have been altered without updating the extensions.
+
+The rake tasks above will create the signature and file below when extending another file (check spec directory for more examples).
+
+```ruby
+# rabl-extend-compiler extends "extend"   => 9ebbe5e06dc6163365ca3d550b757464f0cdfe4b4227a7d52d4e6c1cc11af484
+#
+# This file segment is generated by rabl-extend-compiler rake task
+# and should not be edited. To edit the generated extension
+# edit the file at: ["extend"]
+attributes :id, :derp, :body
+# 9ebbe5e06dc6163365ca3d550b757464f0cdfe4b4227a7d52d4e6c1cc11af484
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/mxenabled/mx-rabl-extend-compiler.

data/Rakefile

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+require 'mx/rabl/extend/compiler'
+
+desc 'Run specs'
+RSpec::Core::RakeTask.new(:spec)
+
+desc 'Run RuboCop'
+task :rubocop do
+  RuboCop::RakeTask.new
+end
+
+task default: %i[rubocop spec]
+
+Dir['lib/tasks/**/*.rake'].each { |ext| load ext } if defined?(Rake)

data/bin/console

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'bundler/setup'
+require 'rabl/extend/compiler'
+
+# 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/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/lib/mx/rabl/extend/compiler/version.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module Mx
+  module Rabl
+    module Extend
+      module Compiler
+        VERSION = '0.2.0'
+      end
+    end
+  end
+end

data/lib/mx/rabl/extend/compiler.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+require 'rabl'
+require 'mx/rabl/extend/compiler/version'
+
+module Mx
+  module Rabl
+    module Extend
+      module Compiler
+        if defined?(Rake)
+          ::Dir[::File.join(::File.dirname(__FILE__), '..', '..', '..', 'tasks', '**', '*.rake')].each do |rake_file|
+            load rake_file
+          end
+        end
+      end
+    end
+  end
+end

data/lib/tasks/all.rake

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+require 'rake'
+require 'rabl'
+require 'digest'
+require 'stringio'
+require 'mx/rabl/extend/compiler'
+
+namespace :rabl do
+  namespace :extend do
+    namespace :compiler do
+      desc 'compile all extensions into rabl files'
+      task :all do
+        ::Rake::Task['rabl:extend:compiler:reset'].invoke
+        ::Rake::Task['rabl:extend:compiler:compile'].invoke
+      end
+    end
+  end
+end

data/lib/tasks/compile_extensions.rake

@@ -0,0 +1,64 @@
+# frozen_string_literal: true
+
+require 'rake'
+require 'rabl'
+require 'digest'
+require 'stringio'
+
+namespace :rabl do
+  namespace :extend do
+    namespace :compiler do
+      desc 'compile all uncompbiled extensions into rabl files'
+      task :compile do
+        ::Rake.application['environment'].invoke if ::Rake::Task.task_defined?('environment')
+        view_paths = ::Rabl.configuration.view_paths
+
+        loop do
+          did_compile_a_file = false
+          view_paths.each do |view_path|
+            ::Dir.glob("#{view_path}/**/*.rabl").each do |rabl_file|
+              # Rewrite all of the file for extensions
+              file_contents = ::File.read(rabl_file)
+              new_file_contents = ::StringIO.new
+              file_contents.each_line do |file_line|
+                extension_file = file_line.scan(/\A[[:space:]]*extends[([:space:]]*['"]+([^"]*)['"]+/).flatten
+
+                if extension_file.empty?
+                  new_file_contents.puts file_line
+                  next
+                end
+
+                extension_filename = "#{view_path}/#{extension_file.first}.rabl"
+                extension_file_digest = ::Digest::SHA256.file(extension_filename).hexdigest
+                extension_contents = ::File.read(extension_filename)
+
+                new_file_contents.puts <<~EXTENDS_MESSAGE
+                  # rabl-extend-compiler #{file_line.strip} => #{extension_file_digest}
+                  #
+                  # This file segment is generated by rabl-extend-compiler rake task
+                  # and should not be edited. To edit the generated extension
+                  # edit the file at: #{extension_file}
+                EXTENDS_MESSAGE
+
+                new_file_contents.puts extension_contents.gsub(/# frozen_string_literal: true[\r\n]*/, '')
+                new_file_contents.puts "# #{extension_file_digest}"
+              end
+
+              # Replace the file if the contents changed and the following will rewrite it again
+              if file_contents != new_file_contents.string
+                did_compile_a_file = true
+                ::File.write(rabl_file, new_file_contents.string)
+              end
+            end
+          end
+
+          if did_compile_a_file
+            did_compile_a_file = false
+          else
+            break
+          end
+        end
+      end
+    end
+  end
+end

data/lib/tasks/reset_extensions.rake

@@ -0,0 +1,59 @@
+# frozen_string_literal: true
+
+require 'rake'
+require 'rabl'
+require 'digest'
+require 'stringio'
+
+namespace :rabl do
+  namespace :extend do
+    namespace :compiler do
+      desc 'reset extensions to be compiled'
+      task :reset do
+        ::Rake.application['environment'].invoke if ::Rake::Task.task_defined?('environment')
+        view_paths = ::Rabl.configuration.view_paths
+
+        view_paths.each do |view_path|
+          ::Dir.glob("#{view_path}/**/*.rabl").each do |rabl_file|
+            file_contents = ::File.read(rabl_file)
+            new_file_contents = ::StringIO.new
+
+            ##
+            # Run through each line and verify the Sha256 digest of the extension file contents
+            # against the digest that is already stored in the file that extends
+            #
+            waiting = false
+            waiting_hash = ''
+            file_contents.each_line do |file_line|
+              if waiting
+                waiting = !file_line.include?(waiting_hash) # if we are in a waiting state then we throw the line away
+                next
+              end
+
+              if file_line.strip.gsub(/[[:space:]]+/, ' ').start_with?('# rabl-extend-compiler extends')
+                extension_file = file_line.scan(/\A[[:space:]]*#[[:space:]]+rabl-extend-compiler[[:space:]]*extends[([:space:]]*['"]+([^"]*)['"]+/).flatten.first
+                extension_filename = "#{view_path}/#{extension_file}.rabl"
+                extension_file_digest = file_line.split('=>')[1]&.gsub(/[[:space:]]/, '')
+
+                if extension_file_digest == ::Digest::SHA256.file(extension_filename).hexdigest
+                  new_file_contents.puts file_line
+                elsif extension_file_digest.nil?
+                  new_file_contents.puts file_line.split('=>').first.gsub('# rabl-extend-compiler ', '')
+                else
+                  new_file_contents.puts file_line.split('=>').first.gsub('# rabl-extend-compiler ', '')
+                  waiting = true
+                  waiting_hash = extension_file_digest
+                end
+              else
+                new_file_contents.puts file_line
+              end
+            end
+
+            # Replace the file if the contents changed and the following will rewrite it again
+            ::File.write(rabl_file, new_file_contents.string) if file_contents != new_file_contents.string
+          end
+        end
+      end
+    end
+  end
+end

data/lib/tasks/verify_extensions.rake

@@ -0,0 +1,60 @@
+# frozen_string_literal: true
+
+require 'rake'
+require 'rabl'
+require 'digest'
+require 'stringio'
+
+namespace :rabl do
+  namespace :extend do
+    namespace :compiler do
+      desc 'verify that all extensions are created and the signatures match; return exit(1) if not verifiable'
+      task :verify do
+        ::Rake.application['environment'].invoke if ::Rake::Task.task_defined?('environment')
+        view_paths = ::Rabl.configuration.view_paths
+
+        view_paths.each do |view_path|
+          ::Dir.glob("#{view_path}/**/*.rabl").each do |rabl_file|
+            file_contents = ::File.read(rabl_file)
+
+            ##
+            # Run through each line and verify the Sha256 digest of the extension file contents
+            # against the digest that is already stored in the file that extends
+            #
+            waiting = false
+            waiting_hash = ''
+
+            file_contents.each_line do |file_line|
+              if waiting
+                waiting = !file_line.include?(waiting_hash) # if we are in a waiting state then we throw the line away
+                next
+              end
+
+              next unless file_line.strip.gsub(/[[:space:]]+/, ' ').start_with?('# rabl-extend-compiler extends')
+
+              extension_file = file_line.scan(/\A[[:space:]]*#[[:space:]]+rabl-extend-compiler[[:space:]]*extends[([:space:]]*['"]+([^"]*)['"]+/).flatten.first
+              extension_filename = "#{view_path}/#{extension_file}.rabl"
+              extension_file_digest = file_line.split('=>').last.gsub(/[[:space:]]/, '')
+
+              next if extension_file_digest == ::Digest::SHA256.file(extension_filename).hexdigest
+
+              $stderr << "rabl-extend-compiler: Compiled extension digest mismatch #{extension_filename}"
+              $stderr << 'rabl-extend-compiler: Run rake rabl:extend:compiler:all to reset'
+
+              exit(1)
+            end
+
+            file_contents.each_line do |file_line|
+              extension_file = file_line.scan(/\A[[:space:]]*extends[([:space:]]*['"]+([^"]*)['"]+/).flatten
+              next if extension_file.empty?
+
+              $stderr << "rabl-extend-compiler: Uncompiled extenion at #{extension_file.first}"
+
+              exit(1)
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/mx-rabl-extend-compiler.gemspec

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+
+lib = File.expand_path('lib', __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'mx/rabl/extend/compiler/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'mx-rabl-extend-compiler'
+  spec.version       = ::Mx::Rabl::Extend::Compiler::VERSION
+  spec.authors       = ['Brandon Dewitt', 'MXDevExperience', 'Bryant Morrill']
+  spec.email         = ['devexperience@mx.com', 'bryantreadmorrill@gmail.com']
+
+  spec.summary       = ' a set of rake tasks to compile rabl templates for performance '
+  spec.description   = ' a set of rake tasks to compile and verify rabl templates that use `extend` for moooooaaar performance '
+  spec.homepage      = 'https://github.com/mxenabled/mx-rabl-extend-compiler'
+
+  # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
+  # to allow pushing to a single host or delete this section to allow pushing to any host.
+  if spec.respond_to?(:metadata)
+    spec.metadata['allowed_push_host'] = 'https://rubygems.org'
+  else
+    raise 'RubyGems 2.0 or newer is required to protect against ' \
+      'public gem pushes.'
+  end
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files = Dir.chdir(File.expand_path(__dir__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_dependency 'rabl'
+  spec.add_dependency 'rake', '>= 10'
+
+  spec.add_development_dependency 'bundler', '~> 2.6'
+  spec.add_development_dependency 'mad_rubocop'
+  spec.add_development_dependency 'pry'
+  spec.add_development_dependency 'rspec'
+end

metadata

@@ -0,0 +1,142 @@
+--- !ruby/object:Gem::Specification
+name: mx-rabl-extend-compiler
+version: !ruby/object:Gem::Version
+  version: 0.2.0
+platform: ruby
+authors:
+- Brandon Dewitt
+- MXDevExperience
+- Bryant Morrill
+bindir: exe
+cert_chain: []
+date: 2025-04-24 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rabl
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '10'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '10'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.6'
+- !ruby/object:Gem::Dependency
+  name: mad_rubocop
+  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: pry
+  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'
+description: " a set of rake tasks to compile and verify rabl templates that use `extend`\
+  \ for moooooaaar performance "
+email:
+- devexperience@mx.com
+- bryantreadmorrill@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- Gemfile
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/mx/rabl/extend/compiler.rb
+- lib/mx/rabl/extend/compiler/version.rb
+- lib/tasks/all.rake
+- lib/tasks/compile_extensions.rake
+- lib/tasks/reset_extensions.rake
+- lib/tasks/verify_extensions.rake
+- mx-rabl-extend-compiler.gemspec
+homepage: https://github.com/mxenabled/mx-rabl-extend-compiler
+licenses: []
+metadata:
+  allowed_push_host: https://rubygems.org
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.6.3
+specification_version: 4
+summary: a set of rake tasks to compile rabl templates for performance
+test_files: []