embed_view 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 4cdcb883310d969dd741bd97e1267794458abaa0edb076f39d9abcf009c12d38
+  data.tar.gz: 35433eafab8095a8901540418c43eb94448177d262e04f31ab28e3aa3f5925d5
+SHA512:
+  metadata.gz: 6b3d14b410e684ff53dfa445c961acc844d6e714e282c231e7fa2ba745687dc05ca5876f117e30618922d075cf8093d9b636d62b42637e40a39fa8e86579b65b
+  data.tar.gz: a94009231249f1037f8eae51a69a103e8940cd5c90d7271e6b901c579216a846ac6d9c4d3913767a430d29429b25cc0e311a602d0bb323e5a0fe68a4ac6490cc

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2019 Igor Kasyanchuk
+
+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/README.md

@@ -0,0 +1,83 @@
+# EmbedView
+
+Improve application performance by 5-20% (depending on your views and layouts) without major code changes.
+
+Rails have slow rendering, expecially when you have view and many partials included inside.
+
+This gem simply embeds views into another views. Works similar to partials, but instead of rendering main view, partials - it's creates a bigger view with content from partials and renders all together.
+
+So if you have a pretty stable app, rarely changed ERB views(_header, _footer, _ga, _etc...) you can embed them in main view/layout and render together.
+
+Such small tweak could give 5-20% boost for performance.
+
+## Usage
+
+Currently works only with ERB templates.
+
+Instead of:
+
+```
+  <%= render '/shared/header' %>
+```
+
+just write:
+
+```
+  <%= embed_view "../shared/_header.html.erb" %>
+```
+
+Please note that this is not a typical helper. This is just a meta tag which will be replaced with content from file.
+
+There are no familiar "locals", "collection", etc things from "partial". 
+
+During development just follow the rule that content from embedded file is inside this file. So all variables available before `embed_view` will be available in inserted file.
+
+## Installation
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'embed_view'
+```
+
+And then execute:
+```bash
+$ bundle
+```
+
+Or install it yourself as:
+```bash
+$ gem install embed_view
+```
+
+## Known issues
+
+- if you have an issue in code in embedded file you won't see correct line with error
+- not tested with older Rails (only with Rails 5.2)
+
+## TODO
+
+- better readme with many samples
+- SLIM support
+- HAML support
+- verify how it works with AJAX requests
+- support older Rails
+- show line with error in code if crash in ERB
+- check regexp in code if it's good and fast
+- think about better logging
+- other file types support
+- absolute path (using Rails.root)
+- more tests (check that content from partials was rendered)
+- travis.ci
+- compare numbers(benchmark), visualize in readme
+- mention in readme links to 2 stagings + source code on heroku
+- reame in samples apps with link to heroku
+
+## Benchmarking
+
+`wrk -t2 -c2 -d10s http://localhost:3000`
+
+## Contributing
+Contribution directions go here.
+
+## License
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,27 @@
+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    = 'EmbedView'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.md')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+require 'bundler/gem_tasks'
+
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = false
+end
+
+task default: :test

data/lib/embed_view.rb

@@ -0,0 +1,5 @@
+require "embed_view/railtie"
+
+module EmbedView
+  # Your code goes here...
+end

data/lib/embed_view/railtie.rb

@@ -0,0 +1,42 @@
+module InlineERB
+  module ClassMethods
+    SNIPPET_RE = Regexp.new("<%=.*embed_view.*(\"|\')(.*)(\"|\').*%>").freeze
+
+    def new(*args, &block)
+      source     = args[0]
+      identifier = args[1]
+      while (matches = source.scan(SNIPPET_RE)).any? do
+        #puts matches.inspect
+        #puts "-----------------------------------------#{matches.size}--"
+        matches.each do |(a, b, c)|
+          path = File.expand_path(File.join(File.dirname(identifier), b.strip))
+          Rails.logger.debug "  embed_view: #{b.strip}"
+          source.gsub!(Regexp.new("<%=.*embed_view.*#{a}#{b}#{c}.*%>"), File.binread(path))
+          identifier = path
+        end
+      end
+      #binding.pry
+      # puts source
+      # puts "--------------------------"
+      # puts "--------------------------"
+      # puts "--------------------------"
+      args[0] = source
+      super(*args, &block)
+    end
+  end
+
+  class << self
+    def included(klass)
+      klass.extend(ClassMethods)
+    end
+  end
+end
+
+
+module EmbedView
+  class Railtie < ::Rails::Railtie
+    initializer 'embed_view.helpers' do
+      ActionView::Template.send :include, InlineERB
+    end
+  end
+end

data/lib/embed_view/version.rb

@@ -0,0 +1,3 @@
+module EmbedView
+  VERSION = '0.1.0'
+end

metadata

@@ -0,0 +1,119 @@
+--- !ruby/object:Gem::Specification
+name: embed_view
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Igor Kasyanchuk
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2019-01-23 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 5.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 5.0.0
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  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: minitest-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: minitest-rails-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: 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'
+description: Embed partial inline into your views to increase performance of rendering.
+email:
+- igorkasyanchuk@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- MIT-LICENSE
+- README.md
+- Rakefile
+- lib/embed_view.rb
+- lib/embed_view/railtie.rb
+- lib/embed_view/version.rb
+homepage: http://github.com/igorkasyanchuk/embed_view
+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: []
+rubygems_version: 3.0.2
+signing_key: 
+specification_version: 4
+summary: Embed partial inline into your views to increase performance of rendering.
+test_files: []