partial_compiler 0.0.3

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: ea61ca2744f267a516fa1bbdf0509ca403d6da93
+  data.tar.gz: fcaa34f7fd2c0d80d44ba9ad564c5aa3319c05a7
+SHA512:
+  metadata.gz: 2351b4a326e1b91200ee7846ad524f242db014fd4d8629f6ee42b3fdc1566a31a2c83a61efebd96fbddd5cdbd6614618373601d080c8abb3a17e50eed3af4bea
+  data.tar.gz: 553d23d029889c944c8462b05353c3b9c5a155f1382841b9b1d63ffa028a76fc175fa5cd8c47bd1d32fc356e80362b02161ad3d2fbcaa5355d5935122b0328bf

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2017 Noah Kochanowicz
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/Rakefile

@@ -0,0 +1,34 @@
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+require 'rdoc/task'
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'PartialCompiler'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+
+
+
+
+
+Bundler::GemHelper.install_tasks
+
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = false
+end
+
+
+task default: :test

data/lib/partial_compiler/compiler.rb

@@ -0,0 +1,53 @@
+require 'find'
+
+module PartialCompiler
+  class Compiler
+    attr_accessor :files
+
+    def initialize
+      @files = FileCopier.create_files
+      @files.each do |file|
+        find_partials(file) 
+      end
+    end
+
+    private
+
+    def find_partials compiled_file_path
+      text = File.open(compiled_file_path).read
+      compiled_content = ""
+      text.each_line do |line|
+        compiled_content += read_each_line(line, compiled_file_path)
+      end
+      compiled_content.to_s.force_encoding('UTF-8') 
+      File.open(compiled_file_path, "w") {|file| file.puts compiled_content }
+    end
+
+    def read_each_line line, compiled_file_path
+      if line.include? PartialCompiler.config[:rendering_engine_partial_format] 
+        the_partial = PartialReader.new(line, compiled_file_path)
+        if the_partial.contents
+          locals_line = generate_locals(the_partial.locals, line, the_partial.indentation)
+          content_with_locals = [locals_line, the_partial.contents].compact.join("\n")
+          return content_with_locals
+        end
+      end
+      line
+    end
+
+    def generate_locals locals, original_line, indentation
+      if locals
+        condensed_locals = locals.map{|local, value| "#{local}=#{get_local_value(local, original_line)}"}.join(";")
+        return "#{(" " * indentation)}<% #{condensed_locals} %>"
+      else
+        return nil 
+      end
+    end
+
+    def get_local_value local, original_line
+      find_value_of_local = /#{local}:([^,}]*)/
+      original_line.match(find_value_of_local)[-1]
+    end
+
+  end
+end

data/lib/partial_compiler/file_copier.rb

@@ -0,0 +1,31 @@
+require 'find'
+
+module PartialCompiler
+  class FileCopier
+    def self.create_files
+      files_to_compile = []
+      find_files_by_extension.each do |file|
+        compiled_file_path = find_compiled_file(file)
+        files_to_compile << compiled_file_path
+      end
+      files_to_compile
+    end
+
+    private
+
+    def self.find_files_by_extension
+      views_directory = Rails.root.join("app", "views")
+      original_extension = PartialCompiler.config[:original_extension]
+      Find.find(views_directory).select do |p| 
+        /.*\.uc.#{original_extension}$|.*\.uncompiled.#{original_extension}$/ =~ p 
+      end
+    end
+
+    def self.find_compiled_file file_path
+      compiled_file_path = file_path.gsub(/uc|uncompiled/, "compiled")
+      FileUtils.cp(file_path, compiled_file_path)
+      return compiled_file_path
+    end
+
+  end
+end

data/lib/partial_compiler/partial_reader.rb

@@ -0,0 +1,70 @@
+require "safe_ruby"
+require "find"
+
+module PartialCompiler
+  class PartialReader
+    attr_accessor :path, :locals, :contents, :indentation
+    
+    #  @path: Where the partial file is located
+    #  @locals: The locals set in the uncompiled file
+    #  @contents: The actual guts of the partial which will be placed in the compiled file
+    #  @indentation: The indentation on the line where 'render partial' is called
+
+    def initialize original_string, file_called_from 
+      code_to_eval = original_string.match(PartialCompiler.config[:regex_partial_eval_match])[1]
+      path_to_partial, partial_name, @locals = execute_safe_ruby(code_to_eval)
+      set_path(path_to_partial, partial_name, file_called_from)
+      get_indentation(original_string)
+      set_contents(@indentation)
+    end
+
+    private
+
+    def execute_safe_ruby code_to_eval
+      render_method = "def render *args
+        arguments = args[0]
+        split_partial_name = arguments[:partial].split('/')
+        return split_partial_name[0...-1], split_partial_name[-1], arguments[:locals]
+      end
+      #{code_to_eval}"
+      partial_name, locals = SafeRuby.eval(render_method)
+    end
+
+    def set_path(path_to_partial, partial_name, calling_file)
+      # Find a file in the same directory as the parent
+      calling_file_path = calling_file.split("/")[0...-1].join("/")
+      path_to_search = [calling_file_path, path_to_partial].compact.join("/")
+      @path = find_file_in_path(partial_name, path_to_search)
+      # If the path hasn't been found by now, it's likely because it's a layout file
+      if !@path
+        path_to_search = [Rails.root.join("app", "views"), path_to_partial].compact.join("/")
+        @path = find_file_in_path(partial_name, path_to_search)
+      end
+    end
+
+    def get_indentation original_string
+      @indentation = original_string[/\A */].size
+    end
+
+    def set_contents indentation
+      if @path 
+        file = File.open(@path, "rb")
+        @contents = add_indentation(file.read, indentation)
+        file.close
+      else 
+        return nil
+      end
+    end 
+
+    def add_indentation contents, indentation
+      return (" " * indentation) + contents.gsub("\n", "\n" + (" " * indentation)).strip + "\n"
+    end 
+
+    def find_file_in_path file_name, path_to_search
+      Find.find(path_to_search) do |path|
+        return path if path =~ /_(#{file_name})/
+      end rescue nil
+    end
+
+  end
+end

data/lib/partial_compiler/plugin.rb

@@ -0,0 +1,21 @@
+module PartialCompiler 
+  class Plugin 
+    def initialize 
+      original_extension = PartialCompiler.config[:original_extension]
+      template_engine = PartialCompiler.config[:template_engine]
+      if !PartialCompiler.config[:run_compiled]
+        ActionView::Template.register_template_handler(
+          "uc.#{original_extension}".to_sym, "uncompiled.#{original_extension}".to_sym, 
+          template_engine.send(:new)
+        )
+      else
+        ActionView::Template.register_template_handler("compiled.#{original_extension}".to_sym, template_engine.send(:new))
+      end
+    end
+  end
+
+  def self.start
+    Plugin.new
+  end
+end
+

data/lib/partial_compiler/railtie.rb

@@ -0,0 +1,13 @@
+#:nocov:
+require 'rails'
+
+module PartialCompiler 
+  class Railtie < Rails::Railtie
+    railtie_name :parital_compiler
+
+    rake_tasks do
+      load 'tasks/partial_compiler_tasks.rake'
+    end
+  end  
+end
+#:nocov:

data/lib/partial_compiler/version.rb

@@ -0,0 +1,5 @@
+#:nocov:
+module PartialCompiler
+  VERSION = "0.0.3"
+end
+#:nocov:

data/lib/partial_compiler.rb

@@ -0,0 +1,26 @@
+module PartialCompiler
+  require 'partial_compiler/railtie' if defined?(Rails)
+  @config = {
+    template_engine: ActionView::Template::Handlers::ERB,
+    original_extension: "html.erb",
+    rendering_engine_partial_format: "= render partial:",
+    # This code would be the code that's executing inside your template, e.g. `render partial: 'my_partial'`
+    regex_partial_eval_match: /(render .*)%>/,
+    run_compiled: !Rails.env.development? 
+  }
+
+  @valid_config_keys = @config.keys
+
+  def self.configure(opts = {})
+    opts.each {|k,v| @config[k.to_sym] = v if @valid_config_keys.include? k.to_sym}
+  end
+
+  def self.config
+    @config
+  end
+end
+
+require "partial_compiler/plugin"
+require "partial_compiler/file_copier"
+require "partial_compiler/partial_reader"
+require "partial_compiler/compiler"

data/lib/tasks/partial_compiler_tasks.rake

@@ -0,0 +1,6 @@
+namespace :compiler do
+  desc "Compiles your partials"
+  task :run do
+    PartialCompiler::Compiler.new
+  end
+end

data/spec/dummy/README.rdoc

@@ -0,0 +1,28 @@
+== README
+
+This README would normally document whatever steps are necessary to get the
+application up and running.
+
+Things you may want to cover:
+
+* Ruby version
+
+* System dependencies
+
+* Configuration
+
+* Database creation
+
+* Database initialization
+
+* How to run the test suite
+
+* Services (job queues, cache servers, search engines, etc.)
+
+* Deployment instructions
+
+* ...
+
+
+Please feel free to use a different markup language if you do not plan to run
+<tt>rake doc:app</tt>.

data/spec/dummy/Rakefile

@@ -0,0 +1,6 @@
+# Add your own tasks in files placed in lib/tasks ending in .rake,
+# for example lib/tasks/capistrano.rake, and they will automatically be available to Rake.
+
+require File.expand_path('../config/application', __FILE__)
+
+Rails.application.load_tasks

data/spec/dummy/app/assets/javascripts/application.js

@@ -0,0 +1,13 @@
+// This is a manifest file that'll be compiled into application.js, which will include all the files
+// listed below.
+//
+// Any JavaScript/Coffee file within this directory, lib/assets/javascripts, vendor/assets/javascripts,
+// or any plugin's vendor/assets/javascripts directory can be referenced here using a relative path.
+//
+// It's not advisable to add code directly here, but if you do, it'll appear at the bottom of the
+// compiled file.
+//
+// Read Sprockets README (https://github.com/rails/sprockets#sprockets-directives) for details
+// about supported directives.
+//
+//= require_tree .

data/spec/dummy/app/assets/javascripts/items.js

@@ -0,0 +1,2 @@
+// Place all the behaviors and hooks related to the matching controller here.
+// All this logic will automatically be available in application.js.

data/spec/dummy/app/assets/stylesheets/application.css

@@ -0,0 +1,15 @@
+/*
+ * This is a manifest file that'll be compiled into application.css, which will include all the files
+ * listed below.
+ *
+ * Any CSS and SCSS file within this directory, lib/assets/stylesheets, vendor/assets/stylesheets,
+ * or any plugin's vendor/assets/stylesheets directory can be referenced here using a relative path.
+ *
+ * You're free to add application-wide styles to this file and they'll appear at the bottom of the
+ * compiled file so the styles you add here take precedence over styles defined in any styles
+ * defined in the other CSS/SCSS files in this directory. It is generally better to create a new
+ * file per style scope.
+ *
+ *= require_tree .
+ *= require_self
+ */

data/spec/dummy/app/assets/stylesheets/items.css

@@ -0,0 +1,4 @@
+/*
+  Place all the styles related to the matching controller here.
+  They will automatically be included in application.css.
+*/

data/spec/dummy/app/controllers/application_controller.rb

@@ -0,0 +1,5 @@
+class ApplicationController < ActionController::Base
+  # Prevent CSRF attacks by raising an exception.
+  # For APIs, you may want to use :null_session instead.
+  protect_from_forgery with: :exception
+end

data/spec/dummy/app/controllers/items_controller.rb

@@ -0,0 +1,5 @@
+class ItemsController < ApplicationController
+  def index
+  
+  end
+end

data/spec/dummy/app/helpers/application_helper.rb

@@ -0,0 +1,2 @@
+module ApplicationHelper
+end

data/spec/dummy/app/helpers/items_helper.rb

@@ -0,0 +1,2 @@
+module ItemsHelper
+end

data/spec/dummy/app/views/items/_partial_one.html.erb

@@ -0,0 +1,7 @@
+Hey! I'm in a partial.
+
+<%= "This is compiled code too!" %>
+<div class="respect">
+  The indents
+</div>
+

data/spec/dummy/app/views/items/basic.compiled.html.erb

@@ -0,0 +1 @@
+I'm so basic it hurts

data/spec/dummy/app/views/items/basic.uc.html.erb

@@ -0,0 +1 @@
+<%= render partial: "partials/basic_partial" %>

data/spec/dummy/app/views/items/contains_bad_file_path.compiled.html.erb

@@ -0,0 +1 @@
+<%= render partial: "i_dont_exist" %>

data/spec/dummy/app/views/items/contains_bad_file_path.uc.html.erb

@@ -0,0 +1 @@
+<%= render partial: "i_dont_exist" %>

data/spec/dummy/app/views/items/different_file.compiled.html.erb

@@ -0,0 +1 @@
+I'm in a different directory

data/spec/dummy/app/views/items/different_file.uc.html.erb

@@ -0,0 +1 @@
+<%= render partial: "layouts/different_file_partial" %>

data/spec/dummy/app/views/items/indentation.compiled.html.erb

@@ -0,0 +1,9 @@
+<h1> Welcome to my indented page! </h1> 
+
+<div class="container">
+  Don't indent me, bro
+    Keep me indented
+  <div>
+    Help! I'm stuck in this pointless div!
+  </div>
+</div>

data/spec/dummy/app/views/items/indentation.uc.html.erb

@@ -0,0 +1,5 @@
+<h1> Welcome to my indented page! </h1> 
+
+<div class="container">
+  <%= render partial: "partials/indentation_partial" %>
+</div>

data/spec/dummy/app/views/items/index.compiled.html.erb

@@ -0,0 +1,12 @@
+This is a test of another line
+<div class="wrapped">
+  <% variable= @hello;variable2= "itchy and scratchy" %>
+  Hey! I'm in a partial.
+  
+  <%= "This is compiled code too!" %>
+  <div class="respect">
+    The indents
+  </div>
+</div>
+and one below it
+

data/spec/dummy/app/views/items/index.uc.html.erb

@@ -0,0 +1,6 @@
+This is a test of another line
+<div class="wrapped">
+  <%= render partial: "partial_one", locals: {variable: @hello, variable2: "itchy and scratchy"} %>
+</div>
+and one below it
+

data/spec/dummy/app/views/items/multiple.compiled.html.erb

@@ -0,0 +1,7 @@
+<div>
+  Hello from file one
+</div>
+
+<div>
+  Hello from file two
+</div>

data/spec/dummy/app/views/items/multiple.uc.html.erb

@@ -0,0 +1,7 @@
+<div>
+  <%= render partial: "partials/multiple_first_partial" %>
+</div>
+
+<div>
+  <%= render partial: "partials/multiple_second_partial" %>
+</div>

data/spec/dummy/app/views/items/partials/_basic_partial.html.erb

@@ -0,0 +1 @@
+I'm so basic it hurts

data/spec/dummy/app/views/items/partials/_indentation_partial.html.erb

@@ -0,0 +1,5 @@
+Don't indent me, bro
+  Keep me indented
+<div>
+  Help! I'm stuck in this pointless div!
+</div>

data/spec/dummy/app/views/items/partials/_multiple_first_partial.html.erb

@@ -0,0 +1 @@
+Hello from file one

data/spec/dummy/app/views/items/partials/_multiple_second_partial.html.erb

@@ -0,0 +1 @@
+Hello from file two

data/spec/dummy/app/views/items/partials/_partial_with_locals.html.erb

@@ -0,0 +1,4 @@
+I'm a partial that contains locals
+
+<h1><%= header1 %></h1>
+<h2><%= header2 %></h2>

data/spec/dummy/app/views/items/with_locals.compiled.html.erb

@@ -0,0 +1,7 @@
+<div>
+  <% header1= "First Header";header2= "Second Header" %>
+  I'm a partial that contains locals
+  
+  <h1><%= header1 %></h1>
+  <h2><%= header2 %></h2>
+</div>

data/spec/dummy/app/views/items/with_locals.uc.html.erb

@@ -0,0 +1,3 @@
+<div>
+  <%= render partial: "with_locals", locals: {header1: "First Header", header2: "Second Header"} %>
+</div>

data/spec/dummy/app/views/layouts/_different_file_partial.html.erb

@@ -0,0 +1 @@
+I'm in a different directory 

data/spec/dummy/app/views/layouts/application.html.erb

@@ -0,0 +1,14 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title>Dummy</title>
+  <%= stylesheet_link_tag    'application', media: 'all', 'data-turbolinks-track' => true %>
+  <%= javascript_include_tag 'application', 'data-turbolinks-track' => true %>
+  <%= csrf_meta_tags %>
+</head>
+<body>
+
+<%= yield %>
+
+</body>
+</html>

data/spec/dummy/bin/bundle

@@ -0,0 +1,3 @@
+#!/usr/bin/env ruby
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path('../../Gemfile', __FILE__)
+load Gem.bin_path('bundler', 'bundle')

data/spec/dummy/bin/rails

@@ -0,0 +1,4 @@
+#!/usr/bin/env ruby
+APP_PATH = File.expand_path('../../config/application', __FILE__)
+require_relative '../config/boot'
+require 'rails/commands'

data/spec/dummy/bin/rake

@@ -0,0 +1,4 @@
+#!/usr/bin/env ruby
+require_relative '../config/boot'
+require 'rake'
+Rake.application.run

data/spec/dummy/bin/setup

@@ -0,0 +1,29 @@
+#!/usr/bin/env ruby
+require 'pathname'
+
+# path to your application root.
+APP_ROOT = Pathname.new File.expand_path('../../',  __FILE__)
+
+Dir.chdir APP_ROOT do
+  # This script is a starting point to setup your application.
+  # Add necessary setup steps to this file:
+
+  puts "== Installing dependencies =="
+  system "gem install bundler --conservative"
+  system "bundle check || bundle install"
+
+  # puts "\n== Copying sample files =="
+  # unless File.exist?("config/database.yml")
+  #   system "cp config/database.yml.sample config/database.yml"
+  # end
+
+  puts "\n== Preparing database =="
+  system "bin/rake db:setup"
+
+  puts "\n== Removing old logs and tempfiles =="
+  system "rm -f log/*"
+  system "rm -rf tmp/cache"
+
+  puts "\n== Restarting application server =="
+  system "touch tmp/restart.txt"
+end

data/spec/dummy/config/application.rb

@@ -0,0 +1,26 @@
+require File.expand_path('../boot', __FILE__)
+
+require 'rails/all'
+
+Bundler.require(*Rails.groups)
+require "partial_compiler"
+
+module Dummy
+  class Application < Rails::Application
+    # Settings in config/environments/* take precedence over those specified here.
+    # Application configuration should go into files in config/initializers
+    # -- all .rb files in that directory are automatically loaded.
+
+    # Set Time.zone default to the specified zone and make Active Record auto-convert to this zone.
+    # Run "rake -D time" for a list of tasks for finding time zone names. Default is UTC.
+    # config.time_zone = 'Central Time (US & Canada)'
+
+    # The default locale is :en and all translations from config/locales/*.rb,yml are auto loaded.
+    # config.i18n.load_path += Dir[Rails.root.join('my', 'locales', '*.{rb,yml}').to_s]
+    # config.i18n.default_locale = :de
+
+    # Do not swallow errors in after_commit/after_rollback callbacks.
+    config.active_record.raise_in_transactional_callbacks = true
+  end
+end
+

data/spec/dummy/config/boot.rb

@@ -0,0 +1,5 @@
+# Set up gems listed in the Gemfile.
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path('../../../../Gemfile', __FILE__)
+
+require 'bundler/setup' if File.exist?(ENV['BUNDLE_GEMFILE'])
+$LOAD_PATH.unshift File.expand_path('../../../../lib', __FILE__)