rails-template-cache 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: bc268901f07132d99450aeb81de8122eaf154505
+  data.tar.gz: 791cb335571992755d5f3aeb0c344b09d8c35750
+SHA512:
+  metadata.gz: 65419d317d7e51c7844ec856e81f185eb3643cf74d7b3afe7e2a23728516f3fb9b91ff1882ea21507876f5923c1dafe7e4247f621b32e6f910fe50b045cd609e
+  data.tar.gz: 7a8b5a9ed68d100e2953d2000fcfd375c8bca0f4ec8a1507b73b37dd397ff6cfbcd1a87b754bdbe8fd9126d6b4be6882aa6b5992cda874a00d8c38c9a81cf5f9

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2015 Fernando Mendes
+
+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/app/assets/javascripts/rails-template-cache/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/app/assets/javascripts/rails-template-cache/rails-template-cache.js.erb

@@ -0,0 +1,11 @@
+(function() {
+  angular
+    .module('rails-template-cache', [])
+    .run(['$templateCache', function($templateCache) {
+      <% environment.context_class.instance_eval { include ActionView::Helpers::JavaScriptHelper } %>
+      <% RailsTemplateCache.templates.each do |key, template| %>
+        <% depend_on template.source_file %>
+        $templateCache.put("<%= key %>", "<%= escape_javascript(template.render) %>");
+      <% end %>
+    }])
+})();

data/lib/rails-template-cache.rb

@@ -0,0 +1,27 @@
+require "rails-template-cache/version"
+require "rails-template-cache/template"
+require "rails-template-cache/engine"
+
+module RailsTemplateCache
+  mattr_accessor :templates
+  self.templates ||= {}
+
+  def self.setup(&block)
+    set_config
+    yield @@config.rails_template_cache if block
+    @@config.rails_template_cache
+  end
+
+  def self.config
+    Rails.application.config
+  end
+
+  private
+
+  def self.set_config
+    unless @config
+      @@config = RailsTemplateCache::Engine::Configuration.new
+      @@config.rails_template_cache = ActiveSupport::OrderedOptions.new
+    end
+  end
+end

data/lib/rails-template-cache/engine.rb

@@ -0,0 +1,33 @@
+module RailsTemplateCache
+  class Engine < ::Rails::Engine
+    isolate_namespace RailsTemplateCache
+
+    config.before_configuration do |app|
+      # Setting default options for the setup
+      RailsTemplateCache.setup do |rtc_config|
+        rtc_config.compress_html = false
+        rtc_config.templates_path = File.join( ['app', 'assets', 'javascripts'] )
+        rtc_config.extensions = %w(erb haml html slim)
+      end
+    end
+
+    initializer "rails-template-cache" do |app|
+      base = Rails.root.join(config.rails_template_cache.templates_path)
+      exts = "{#{ config.rails_template_cache.extensions.join(',') }}"
+
+      Dir.glob("#{base}/**/*.#{exts}").each do |f|
+        key, ext = RailsTemplateCache::Template
+          .asset_data(f, config.rails_template_cache.templates_path)
+
+        RailsTemplateCache.templates[key] = RailsTemplateCache::Template
+          .new(f, ext, compress: config.rails_template_cache.compress_html)
+      end
+
+      # Clear cache if config changes
+      app.config.assets.version = [
+        app.config.assets.version,
+        Digest::MD5.hexdigest("#{VERSION}-#{app.config.rails_template_cache}")
+      ].join('-')
+    end
+  end
+end

data/lib/rails-template-cache/template.rb

@@ -0,0 +1,39 @@
+module RailsTemplateCache
+  class Template
+    attr_reader :source_file
+
+    def initialize(source_file, markup, options = {})
+      silence_warnings do
+        @template = Tilt[markup]
+        @source_file = source_file
+        @opts = options
+      end
+    end
+
+    def render
+      # Only render when needed, to avoid caching issues
+      rendered_template = @template.new(@source_file).render
+      @opts[:compress] ? compress_html(rendered_template) : rendered_template
+    end
+
+    def self.asset_data(path, templates_path = "")
+      result = []
+      case path.to_s
+        when /#{templates_path}\/(.*)(\.html)$/
+          result = "#{$1}#{$2}", $2
+        when /#{templates_path}\/(.*\.html)(\.\w+)$/
+          result = $1, $2
+        when /#{templates_path}\/(.*)(\.\w+)$/
+          result = "#{$1}.html", $2
+      end
+      result
+    end
+
+  private
+
+    def compress_html(html)
+      @compressor ||= HtmlCompressor::Compressor.new
+      @compressor.compress(html)
+    end
+  end
+end

data/lib/rails-template-cache/version.rb

@@ -0,0 +1,3 @@
+module RailsTemplateCache
+  VERSION = "0.1.1"
+end

data/spec/integration/assets_integration_spec.rb

@@ -0,0 +1,30 @@
+require 'rails_helper'
+
+describe "RailsTemplateCache inclusion", :type => :feature do
+  before do
+    @files = RailsTemplateCache.templates.keys
+    visit '/assets/rails-template-cache/rails-template-cache.js'
+  end
+
+  it "adds templates to angular templateCache" do
+    @files.each do |f|
+      expect(page.source).to include("$templateCache.put(\"#{f}")
+    end
+  end
+end
+
+describe "asset rendering", :type => :feature, :js => true do
+  before do
+    @files = RailsTemplateCache.templates.values.map do |f|
+      # Adding angular classes
+      f.render.gsub(/(<[^\/]\w+)>/, '\1 class="ng-scope">')
+    end
+    visit '/'
+  end
+
+  it "adds templates to page" do
+    @files.each do |f|
+      expect(page.source).to include(f)
+    end
+  end
+end

data/spec/rails_helper.rb

@@ -0,0 +1,48 @@
+# This file is copied to spec/ when you run 'rails generate rspec:install'
+ENV['RAILS_ENV'] ||= 'test'
+require File.expand_path('../../test/dummy/config/environment', __FILE__)
+# Prevent database truncation if the environment is production
+abort("The Rails environment is running in production mode!") if Rails.env.production?
+require 'spec_helper'
+require 'rspec/rails'
+# Add additional requires below this line. Rails is not loaded until this point!
+
+# Requires supporting ruby files with custom matchers and macros, etc, in
+# spec/support/ and its subdirectories. Files matching `spec/**/*_spec.rb` are
+# run as spec files by default. This means that files in spec/support that end
+# in _spec.rb will both be required and run as specs, causing the specs to be
+# run twice. It is recommended that you do not name files matching this glob to
+# end with _spec.rb. You can configure this pattern with the --pattern
+# option on the command line or in ~/.rspec, .rspec or `.rspec-local`.
+#
+# The following line is provided for convenience purposes. It has the downside
+# of increasing the boot-up time by auto-requiring all files in the support
+# directory. Alternatively, in the individual `*_spec.rb` files, manually
+# require only the support files necessary.
+#
+# Dir[Rails.root.join('spec/support/**/*.rb')].each { |f| require f }
+
+RSpec.configure do |config|
+  # Remove this line if you're not using ActiveRecord or ActiveRecord fixtures
+  config.fixture_path = "#{::Rails.root}/spec/fixtures"
+
+  # If you're not using ActiveRecord, or you'd prefer not to run each of your
+  # examples within a transaction, remove the following line or assign false
+  # instead of true.
+  config.use_transactional_fixtures = true
+
+  # RSpec Rails can automatically mix in different behaviours to your tests
+  # based on their file location, for example enabling you to call `get` and
+  # `post` in specs under `spec/controllers`.
+  #
+  # You can disable this behaviour by removing the line below, and instead
+  # explicitly tag your specs with their type, e.g.:
+  #
+  #     RSpec.describe UsersController, :type => :controller do
+  #       # ...
+  #     end
+  #
+  # The different available types are documented in the features, such as in
+  # https://relishapp.com/rspec/rspec-rails/docs
+  config.infer_spec_type_from_file_location!
+end

data/spec/spec_helper.rb

@@ -0,0 +1,17 @@
+ENV['RAILS_ENV'] ||= 'test'
+
+require File.expand_path("../../test/dummy/config/environment.rb",  __FILE__)
+require 'rspec/rails'
+require 'capybara/rspec'
+
+Rails.backtrace_cleaner.remove_silencers!
+
+# Load support files
+Dir["#{File.dirname(__FILE__)}/support/**/*.rb"].each { |f| require f }
+
+RSpec.configure do |config|
+  config.mock_with :rspec
+  config.use_transactional_fixtures = true
+  config.infer_base_class_for_anonymous_controllers = false
+  config.order = "random"
+end

metadata

@@ -0,0 +1,155 @@
+--- !ruby/object:Gem::Specification
+name: rails-template-cache
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+platform: ruby
+authors:
+- Fernando Mendes
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-08-11 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: railties
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: sprockets
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: tilt
+  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: rspec-rails
+  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-its
+  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: capybara
+  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: selenium-webdriver
+  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:
+- devfrmendes@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- MIT-LICENSE
+- app/assets/javascripts/rails-template-cache/application.js
+- app/assets/javascripts/rails-template-cache/rails-template-cache.js.erb
+- lib/rails-template-cache.rb
+- lib/rails-template-cache/engine.rb
+- lib/rails-template-cache/template.rb
+- lib/rails-template-cache/version.rb
+- spec/integration/assets_integration_spec.rb
+- spec/rails_helper.rb
+- spec/spec_helper.rb
+homepage: https://github.com/frmendes/rails-template-cache
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+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: []
+rubyforge_project: 
+rubygems_version: 2.4.5
+signing_key: 
+specification_version: 4
+summary: Adding templates to Angular's templateCache with Rails.
+test_files:
+- spec/integration/assets_integration_spec.rb
+- spec/rails_helper.rb
+- spec/spec_helper.rb