actionview_precompiler 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: fadda94921df406ea9a921ae1c2a0ef61cb9a70a5a082ed906ead3a91ca0ab79
+  data.tar.gz: a4eb7f984757e30d29eecdf348dc4ce1456f1f2d51e1092dd1bbc86b50d5511a
+SHA512:
+  metadata.gz: c86dcaa26a379be5cb1832c7ea036e0dcca6ea2a26582706aa54fc35ba9abc95cd23507bba329e1f6968b70516878b5b8ea153bf419c7b2b67bf249197e3f430
+  data.tar.gz: f00fd1a1202d766df59977b982c75364dfe350f54a47131f74dde6ba0413c9e19b14818b2bc56f94f26521b3516bf383319fcc7a3663a9dd3bbf8c89f2fae269

data/.gitignore

@@ -0,0 +1,8 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at john@hawthorn.email. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+gem "pry"
+
+# Specify your gem's dependencies in actionview_precompiler.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,62 @@
+PATH
+  remote: .
+  specs:
+    actionview_precompiler (0.1.0)
+      actionview (>= 6.0.a)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    actionview (6.0.0.rc1)
+      activesupport (= 6.0.0.rc1)
+      builder (~> 3.1)
+      erubi (~> 1.4)
+      rails-dom-testing (~> 2.0)
+      rails-html-sanitizer (~> 1.0, >= 1.0.3)
+    activesupport (6.0.0.rc1)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 0.7, < 2)
+      minitest (~> 5.1)
+      tzinfo (~> 1.1)
+      zeitwerk (~> 2.1, >= 2.1.4)
+    builder (3.2.3)
+    coderay (1.1.2)
+    concurrent-ruby (1.1.5)
+    crass (1.0.4)
+    erubi (1.8.0)
+    i18n (1.6.0)
+      concurrent-ruby (~> 1.0)
+    loofah (2.2.3)
+      crass (~> 1.0.2)
+      nokogiri (>= 1.5.9)
+    method_source (0.9.2)
+    mini_portile2 (2.4.0)
+    minitest (5.11.3)
+    nokogiri (1.10.3)
+      mini_portile2 (~> 2.4.0)
+    pry (0.12.2)
+      coderay (~> 1.1.0)
+      method_source (~> 0.9.0)
+    rails-dom-testing (2.0.3)
+      activesupport (>= 4.2.0)
+      nokogiri (>= 1.6)
+    rails-html-sanitizer (1.0.4)
+      loofah (~> 2.2, >= 2.2.2)
+    rake (12.3.2)
+    thread_safe (0.3.6)
+    tzinfo (1.2.5)
+      thread_safe (~> 0.1)
+    zeitwerk (2.1.5)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  actionview_precompiler!
+  bundler (~> 2.0)
+  minitest (~> 5.0)
+  pry
+  rake (~> 12.0)
+
+BUNDLED WITH
+   2.0.1

data/README.md

@@ -0,0 +1,54 @@
+# ActionviewPrecompiler
+
+Precompiles ActionView templates at app boot.
+
+The main challenge in precompiling these templates is determining the locals they're going to be passed.
+Without the initialization, local vars look the same as method calls, so we need to compile separate copies for each different set of local variable passed in.
+
+We determine the locals passed to each template by parsing all templates looking for render calls and extracting the local keys passed to that.
+
+Right now this assumes every template with the same `virtual_path` takes the same locals (there may be smarter options, we just aren't doing them).
+A curse/blessing/actually still a curse of this approach is that mis-predicting render calls doesn't cause any issues, it just wastes RAM.
+
+Templates are half-compiled using standard ActionView handlers, so this should work for erb/builder/haml/whatever.
+Parsing is done using Ruby 2.6's `RubyVM::AbstractSyntaxTree`.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'actionview_precompiler'
+```
+
+And then execute:
+
+    $ bundle install
+
+## Usage
+
+``` ruby
+ActionviewPrecompiler.precompile
+```
+
+## TODO
+
+* Doesn't understand (common) relative renders: `render "form"`
+* Support more `render` invocations
+* Parse controllers/helpers for more renders
+* Cache detected locals to avoid parsing cost
+* Upstream more bits to Rails
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` 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/jhawthorn/actionview_precompiler. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+## Code of Conduct
+
+Everyone interacting in the ActionviewPrecompiler project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/jhawthorn/actionview_precompiler/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList["test/**/*_test.rb"]
+end
+
+task :default => :test

data/actionview_precompiler.gemspec

@@ -0,0 +1,31 @@
+lib = File.expand_path("lib", __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "actionview_precompiler/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "actionview_precompiler"
+  spec.version       = ActionviewPrecompiler::VERSION
+  spec.authors       = ["John Hawthorn"]
+  spec.email         = ["john@hawthorn.email"]
+
+  spec.summary       = %q{Precompiles ActionView templates}
+  spec.description   = %q{Parses templates for render calls and uses them to precompile}
+  spec.homepage      = "https://github.com/jhawthorn/actionview_precompiler"
+
+  # 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('..', __FILE__)) 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.required_ruby_version = ">= 2.6"
+
+  spec.add_dependency "actionview", ">= 6.0.a"
+
+  spec.add_development_dependency "bundler", "~> 2.0"
+  spec.add_development_dependency "rake", "~> 12.0"
+  spec.add_development_dependency "minitest", "~> 5.0"
+end

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "actionview_precompiler"
+
+# 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/actionview_precompiler.rb

@@ -0,0 +1,32 @@
+require "actionview_precompiler/version"
+require "actionview_precompiler/template_parser"
+require "actionview_precompiler/render_parser"
+require "actionview_precompiler/precompiler"
+require "actionview_precompiler/parsed_filename"
+
+module ActionviewPrecompiler
+  class Error < StandardError; end
+
+  def self.precompile(verbose: false)
+    target = ActionController::Base # fixme
+    view_paths = target.view_paths
+    lookup_context = ActionView::LookupContext.new(view_paths)
+    paths = view_paths.map(&:path)
+    precompiler = Precompiler.new(paths)
+
+    mod = target.view_context_class
+    count = 0
+    precompiler.each_lookup_args do |args|
+      templates = lookup_context.find_all(*args)
+      templates.each do |template|
+        puts "precompiling: #{template.inspect}" if verbose
+        count += 1
+        template.send(:compile!, mod)
+      end
+    end
+
+    if verbose
+      puts "Precompiled #{count} Templates"
+    end
+  end
+end

data/lib/actionview_precompiler/parsed_filename.rb

@@ -0,0 +1,51 @@
+module ActionviewPrecompiler
+  class ParsedFilename
+    attr_reader :path, :action, :prefix, :options, :details
+
+    def initialize(path)
+      @path = path
+
+      details = parse_template_path(path)
+      @prefix = details.delete(:prefix)
+      @action = details.delete(:action)
+      @partial = details.delete(:partial)
+      @details = details
+    end
+
+    def partial?
+      @partial
+    end
+
+    def path_regex
+      handlers = ActionView::Template::Handlers.extensions.map { |x| Regexp.escape(x) }.join("|")
+      formats = ActionView::Template::Types.symbols.map { |x| Regexp.escape(x) }.join("|")
+      locales = "[a-z]{2}(?:-[A-Z]{2})?"
+      variants = "[^.]*"
+      %r{
+        \A
+        (?:(?<prefix>.*)/)?
+        (?<partial>_)?
+        (?<action>.*?)
+        (?:\.(?<locale>#{locales}))??
+        (?:\.(?<format>#{formats}))??
+        (?:\+(?<variant>#{variants}))??
+        (?:\.(?<handler>#{handlers}))?
+        \z
+      }x
+    end
+
+    def parse_template_path(path)
+      match = path_regex.match(path)
+
+      {
+        prefix: match[:prefix] || "",
+        action: match[:action],
+        partial: !!match[:partial],
+        locale: match[:locale]&.to_sym,
+        handler: match[:handler]&.to_sym,
+        format: match[:format]&.to_sym,
+        variant: match[:variant]
+      }
+    end
+  end
+end

data/lib/actionview_precompiler/precompiler.rb

@@ -0,0 +1,89 @@
+module ActionviewPrecompiler
+  class Precompiler
+    class Template
+      attr_reader :fullpath, :relative_path, :virtual_path
+      attr_reader :action, :prefix, :details
+
+      def initialize(fullpath, relative_path)
+        @fullpath = fullpath
+        @relative_path = relative_path
+        @virtual_path = relative_path.slice(0, relative_path.index("."))
+
+        parsed = ParsedFilename.new(relative_path)
+        @prefix = parsed.prefix
+        @action = parsed.action
+        @partial = parsed.partial?
+        @details = parsed.details
+      end
+
+      def partial?
+        @partial
+      end
+    end
+
+    attr_reader :templates
+
+    def initialize(view_dirs)
+      @templates =
+        view_dirs.flat_map do |view_dir|
+          Dir["**/*", base: view_dir].map do |file|
+            fullpath = File.expand_path(file, view_dir)
+            next if File.directory?(fullpath)
+
+            Template.new(fullpath, file)
+          end.compact
+        end
+
+      determine_locals
+    end
+
+    def each_lookup_args
+      return enum_for(__method__) unless block_given?
+
+      each_template_render do |template, locals|
+        details = {
+          locale: Array(template.details[:locale]),
+          variants: Array(template.details[:variant]),
+          formats: Array(template.details[:format]),
+          handlers: Array(template.details[:handler])
+        }
+
+        yield [template.action, template.prefix, template.partial?, locals, details]
+      end
+
+      nil
+    end
+
+    def each_template_render
+      return enum_for(__method__) unless block_given?
+
+      @templates.each do |template|
+        locals_set = @locals_sets[template.virtual_path]
+        if locals_set
+          locals_set.each do |locals|
+            yield template, locals
+          end
+        elsif !template.partial?
+          # For now, guess that non-partials we haven't seen take no locals
+          yield template, []
+        else
+          # Locals unknown
+        end
+      end
+    end
+
+    def determine_locals
+      @locals_sets = {}
+
+      @templates.each do |template|
+        parser = TemplateParser.new(template.fullpath)
+        parser.render_calls.each do |render_call|
+          @locals_sets[render_call.virtual_path] ||= []
+          @locals_sets[render_call.virtual_path] << render_call.locals_keys.map(&:to_s).sort
+        end
+      end
+
+      @locals_sets.each_value(&:uniq!)
+    end
+  end
+end

data/lib/actionview_precompiler/render_parser.rb

@@ -0,0 +1,128 @@
+module ActionviewPrecompiler
+  RenderCall = Struct.new(:render_type, :template, :locals, :locals_keys) do
+    def virtual_path
+      if render_type == :partial
+        @virtual_path ||= template.gsub(%r{/([^/]*)\z}, '/_\1')
+      else
+        template
+      end
+    end
+  end
+
+  class RenderParser
+    def initialize(code)
+      @code = code
+      @code = RubyVM::AbstractSyntaxTree.parse(code) if code.is_a?(String)
+    end
+
+    def render_calls
+      render_nodes = extract_render_nodes(@code)
+      render_nodes.map do |node|
+        parse_render(node)
+      end.compact
+    end
+
+    private
+
+    def parse_render(node)
+      node = node.children[1]
+      node = node.children
+      if (node.length == 2 || node.length == 3) && node[0].type == :STR
+        # FIXME: from template vs controller
+        options = {}
+        options[:partial] = node[0]
+        if node.length == 3
+          return unless node[1].type == :HASH
+          options[:locals] = node[1]
+        end
+        return parse_render_from_options(options)
+      elsif node.length == 2 && node[0].type == :HASH
+        options = parse_hash_to_symbols(node[0])
+        return parse_render_from_options(options)
+      else
+        nil
+      end
+    end
+
+    def parse_hash(node)
+      return nil unless node.type == :HASH
+
+      node.children[0].children[0..-2].each_slice(2).to_h
+    end
+
+    def parse_hash_to_symbols(node)
+      hash = parse_hash(node)
+      return unless hash
+      hash.transform_keys do |node|
+        key = parse_sym(node)
+        return unless key
+        key
+      end
+    end
+
+    RENDER_TYPE_KEYS = [:partial, :template, :layout]
+    IGNORED_KEYS = [:formats]
+    ALL_KNOWN_KEYS = [*RENDER_TYPE_KEYS, *IGNORED_KEYS, :locals]
+
+    def parse_render_from_options(options_hash)
+      keys = options_hash.keys
+
+      unless (keys & RENDER_TYPE_KEYS).one?
+        # Must have one of partial:, template:, or layout:
+        return nil
+      end
+
+      unless (keys - ALL_KNOWN_KEYS).empty?
+        # de-opt in case of unknown option
+        return nil
+      end
+
+      render_type = (keys & RENDER_TYPE_KEYS)[0]
+      template = parse_str(options_hash[render_type])
+      return unless template
+
+      if options_hash.key?(:locals)
+        locals = options_hash[:locals]
+        parsed_locals = parse_hash(locals)
+        return nil unless parsed_locals
+        locals_keys = parsed_locals.keys.map do |local|
+          return nil unless local.type == :LIT
+          local.children[0]
+        end
+      else
+        locals = nil
+        locals_keys = []
+      end
+
+      RenderCall.new(render_type, template, locals, locals_keys)
+    end
+
+    def parse_str(node)
+      node.children[0] if node.type == :STR && String === node.children[0]
+    end
+
+    def parse_sym(node)
+      node.children[0] if node.type == :LIT && Symbol === node.children[0]
+    end
+
+    def debug(message)
+      warn message
+    end
+
+    def extract_render_nodes(node)
+      return [] unless RubyVM::AbstractSyntaxTree::Node === node
+      renders = node.children.flat_map { |c| extract_render_nodes(c) }
+      if render_call?(node)
+        renders << node
+      end
+      renders
+    end
+
+    def render_call?(node)
+      node.type == :FCALL &&
+        node.children[0] == :render &&
+        node.children[1] &&
+        node.children[1].type == :ARRAY
+    end
+  end
+end

data/lib/actionview_precompiler/template_parser.rb

@@ -0,0 +1,37 @@
+require "action_view"
+
+module ActionviewPrecompiler
+  class TemplateParser
+    attr_reader :filename, :basename, :handler
+
+    class FakeTemplate
+      def type
+        nil
+      end
+    end
+
+    def initialize(filename)
+      @filename = filename
+      @basename = File.basename(filename)
+      handler_ext = @basename.split(".").last
+      @handler = ActionView::Template.handler_for_extension(handler_ext)
+      @is_partial = !!@basename.start_with?("_")
+    end
+
+    def partial?
+      @is_partial
+    end
+
+    def render_calls
+      RenderParser.new(parsed).render_calls
+    end
+
+    def parsed
+      @parsed ||= RubyVM::AbstractSyntaxTree.parse(compiled_source)
+    end
+
+    def compiled_source
+      @handler.call(FakeTemplate.new, File.read(@filename))
+    end
+  end
+end

data/lib/actionview_precompiler/version.rb

@@ -0,0 +1,3 @@
+module ActionviewPrecompiler
+  VERSION = "0.1.0"
+end

metadata

@@ -0,0 +1,113 @@
+--- !ruby/object:Gem::Specification
+name: actionview_precompiler
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- John Hawthorn
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2019-05-03 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: actionview
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 6.0.a
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 6.0.a
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+description: Parses templates for render calls and uses them to precompile
+email:
+- john@hawthorn.email
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- README.md
+- Rakefile
+- actionview_precompiler.gemspec
+- bin/console
+- bin/setup
+- lib/actionview_precompiler.rb
+- lib/actionview_precompiler/parsed_filename.rb
+- lib/actionview_precompiler/precompiler.rb
+- lib/actionview_precompiler/render_parser.rb
+- lib/actionview_precompiler/template_parser.rb
+- lib/actionview_precompiler/version.rb
+homepage: https://github.com/jhawthorn/actionview_precompiler
+licenses: []
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '2.6'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.3
+signing_key: 
+specification_version: 4
+summary: Precompiles ActionView templates
+test_files: []