optipipe 0.4.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: ee49c3430395ba01e41e7ae659d5c6f0751288b6
+  data.tar.gz: 0e9d8b86848478d8293b608e416d989c7ce2f9b4
+SHA512:
+  metadata.gz: 3566d85e227cddfabb05a49132805b109c47e1f1c33959fe32c0d4e29d0dac2147dd2743b764c464323eb8c4cf5b055e8cc00a27a4befb2a5ec80958e02de57e
+  data.tar.gz: 026474edf7a76374a16b2720e92505db71f794fbc462bb07c750150687951b09deb15f5a2bb33aad7aa8765432b3c15ecd50945222ee92f27a264c6025c671e4

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2018 TODO: Write your name
+
+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.ja.md

@@ -0,0 +1,110 @@
+# Optipipe
+Optipipeは、precompile済みのアセットに関して、必要なもののみを読み込む仕組みや、遅延読み込み(onload後等)に簡単に対応できるGemです。
+具体的には、
+
+- 複数のprecompile済みファイルを使用したり、アセットの(主にjavascriptの)依存関係をわかりやすく管理することを前提としたディレクトリ構成
+- controller毎に指定した必要なファイルのみ読み込む仕組み
+- onload後に読み込めれば問題ないファイルに関して、簡単に遅延読み込みを設定できる仕組み
+
+を提供します。
+
+これらによって、特に`HTTP/2`プロトコルを採用した際の並列読み込みに対して速度最適化を行うことができます。
+
+*Read this in other languages: [日本語](README.ja.md)*
+
+## Installation
+Gemfileに以下を追記して、gemを追加して下さい。
+
+```ruby
+gem 'optipipe'
+```
+
+そしてbundle installを行って下さい。
+```bash
+$ bundle
+```
+
+最後に以下のコマンドを実行して初期設定を行って下さい。
+```bash
+$ rails g optipipe:install
+```
+
+## Configure
+初期設定のコマンドを叩くことで、
+
+```
+app/assets/
+├── javascripts
+│   └── optipipe
+│       ├── files
+│       │   ├── example.js
+│       │   └── example_after_onload.js
+│       ├── mappers
+│       │   └── example_mapper.yml
+│       └── precompiles
+│           ├── example_precompile.js
+│           └── example_precompile_after_onload.js
+└── stylesheets
+    └── optipipe
+        ├── files
+        │   └── example.css
+        ├── mappers
+        │   └── example_mapper.yml
+        └── precompiles
+            └── example_precompile.css
+```
+
+上記のような構造でファイルとディレクトリが生成されます。
+初期で生成されるファイルは全てサンプルなので、書き換えまたは削除を行って下さい。
+
+## BasicUsage
+### Helper
+layoutのviewファイルで下記のように実行することで、controller毎に指定したアセットファイルが読み込まれます。
+
+```erb
+<%= optipipe_javascript_include_tag %>
+<%= optipipe_stylesheet_link_tag %>
+```
+
+下記のように当てはまるMapperが無い場合にデフォルトで使用するMapperを指定できます。
+指定するのはcontroller_pathに指定している値になります。
+
+```erb
+<%= optipipe_javascript_include_tag(default: 'welcome') %>
+```
+
+引数にHash形式でmapperのオプション条件を下記のように追加できます。
+
+```erb
+<%= optipipe_javascript_include_tag(mapper_conditions: {device: 'pc'}) %>
+```
+```yml
+controller_path: 'welcome'
+load_files:
+  - example_precompile
+after_onload:
+  - example_precompile_after_onload
+device: 'pc'
+```
+
+### Mapper
+`Mapper`では、controller毎に読み込むprecompile済みのassetを設定できるようになっています。
+
+#### controller_path
+controller名を設定する。
+namespase付きのcontrollerの場合は、`/`で区切って指定して下さい。(`ActionController`の`controller_path`の値を使用しています)
+
+#### load_files
+読み込むprecompile済みのassetファイル名を指定します。
+`optipipe/precompiles`配下にあるファイルを指定します。
+
+#### after_onload
+javascriptのonload後に読み込むassetファイル名を指定します。
+`optipipe/precompiles`配下にあるファイルを指定します。
+これはjavascripts用のMapperのみの設定です。
+
+## License
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+
+## Author
+[ykogure](https://github.com/ykogure)

data/README.md

@@ -0,0 +1,109 @@
+# Optipipe
+Optipipe enables you to correspond to load only required assets, load assets lazy, and so on, about precompiled files.
+
+Specifically, Optipipe provide following functions.
+
+- Structure of directories to manage using some precompiled assets and being easy to understand dependencies of assets (principally javascripts).
+- A funcion that load only required asset files.
+- A funcion that configure lazyloading asset files that have no problem even if load after `onload`.
+
+A funcion that load lazy asset files that have no problem even if load after `onload`
+
+Optipipe enables you to fix your web application's performance by these funtions, when use `HTTP/2` protocol.
+
+*Read this in other languages: [日本語](README.ja.md)*
+
+## Installation
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'optipipe'
+```
+
+And then execute:
+```bash
+$ bundle
+```
+
+And then run initial settings:
+```bash
+$ rails g optipipe:install
+```
+
+## Configure
+Running initial settings create files and directories like following structure.
+
+```
+app/assets/
+├── javascripts
+│   └── optipipe
+│       ├── files
+│       │   ├── example.js
+│       │   └── example_after_onload.js
+│       ├── mappers
+│       │   └── example_mapper.yml
+│       └── precompiles
+│           ├── example_precompile.js
+│           └── example_precompile_after_onload.js
+└── stylesheets
+    └── optipipe
+        ├── files
+        │   └── example.css
+        ├── mappers
+        │   └── example_mapper.yml
+        └── precompiles
+            └── example_precompile.css
+```
+
+All files created initial is sample, please rewriting or delete.
+
+## BasicUsage
+### Helper
+Run helper method like following in layout's view files, and you can load asset files each controllers.
+
+```erb
+<%= optipipe_javascript_include_tag %>
+<%= optipipe_stylesheet_link_tag %>
+```
+
+You can configure like following using default mapper when there aren't any mappers meeting a condition. This value is controller_path.
+
+```erb
+<%= optipipe_javascript_include_tag(default: 'welcome') %>
+```
+
+You can configure mapper's additional conditions by arguments like following.
+
+```erb
+<%= optipipe_javascript_include_tag(device: 'pc') %>
+```
+```yml
+controller_path: 'welcome'
+load_files:
+  - example_precompile
+after_onload:
+  - example_precompile_after_onload
+device: 'pc'
+```
+
+### Mapper
+You can configure precompiled asset files each controllers by `Mapper`.
+
+#### controller_path
+Please set controller path.
+If use controller with namespace, join `/`. (same value of `controller_path` in `ActionController`.)
+
+#### load_files
+Please set precompiled asset file's names.
+Files exist at under `optipipe/precompiles`.
+
+#### after_onload
+Please set asset file's names loaded after onload on javascript.
+Files exist at under `optipipe/precompiles`.
+This setting is only Javascript's Mapper.
+
+## License
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+
+## Author
+[ykogure](https://github.com/ykogure)

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    = 'Optipipe'
+  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 << 'lib'
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = false
+end
+
+
+task default: :test

data/app/views/optipipe/_after_onload.html.erb

@@ -0,0 +1,9 @@
+<script type="text/javascript">
+  window.onload = function() {
+    <% paths.each do |path| %>
+      var script = document.createElement("script");
+      script.src = "<%= path %>";
+      document.body.appendChild(script);
+    <% end %>
+  };
+</script>

data/lib/generators/optipipe/install_generator.rb

@@ -0,0 +1,31 @@
+module Optipipe
+  module Generators
+    class InstallGenerator < Rails::Generators::Base
+      source_root File.expand_path("../../templates", __FILE__)
+
+      desc "Creates a Optipipe initializer to your application."
+
+      def copy_initializer
+        # javascript's templates
+        empty_directory 'app/assets/javascripts/optipipe'
+        empty_directory 'app/assets/javascripts/optipipe/files'
+        empty_directory 'app/assets/javascripts/optipipe/mappers'
+        empty_directory 'app/assets/javascripts/optipipe/precompiles'
+        template        'files/example.js',                               'app/assets/javascripts/optipipe/files/example.js'
+        template        'files/example_after_onload.js',                  'app/assets/javascripts/optipipe/files/example_after_onload.js'
+        template        'precompiles/example_precompile.js',              'app/assets/javascripts/optipipe/precompiles/example_precompile.js'
+        template        'precompiles/example_precompile_after_onload.js', 'app/assets/javascripts/optipipe/precompiles/example_precompile_after_onload.js'
+        template        'mappers/example_mapper_for_javascripts.yml',     'app/assets/javascripts/optipipe/mappers/example_mapper.yml'
+
+        # stylesheet's templates
+        empty_directory 'app/assets/stylesheets/optipipe'
+        empty_directory 'app/assets/stylesheets/optipipe/files'
+        empty_directory 'app/assets/stylesheets/optipipe/mappers'
+        empty_directory 'app/assets/stylesheets/optipipe/precompiles'
+        template        'files/example.css',                          'app/assets/stylesheets/optipipe/files/example.css'
+        template        'precompiles/example_precompile.css',         'app/assets/stylesheets/optipipe/precompiles/example_precompile.css'
+        template        'mappers/example_mapper_for_stylesheets.yml', 'app/assets/stylesheets/optipipe/mappers/example_mapper.yml'
+      end
+    end
+  end
+end

data/lib/generators/templates/files/example.css

@@ -0,0 +1,3 @@
+.example{
+  color: red;
+}

data/lib/generators/templates/files/example.js

@@ -0,0 +1 @@
+console.log('example');

data/lib/generators/templates/files/example_after_onload.js

@@ -0,0 +1 @@
+console.log('example_after_onload');

data/lib/generators/templates/mappers/example_mapper_for_javascripts.yml

@@ -0,0 +1,5 @@
+controller_path: 'welcome'
+load_files:
+  - example_precompile
+after_onload:
+  - example_precompile_after_onload

data/lib/generators/templates/mappers/example_mapper_for_stylesheets.yml

@@ -0,0 +1,3 @@
+controller_path: 'welcome'
+load_files:
+  - example_precompile

data/lib/generators/templates/precompiles/example_precompile.css

@@ -0,0 +1,3 @@
+/*
+ *= require ../files/example
+ */

data/lib/generators/templates/precompiles/example_precompile.js

@@ -0,0 +1 @@
+//= require ../files/example

data/lib/generators/templates/precompiles/example_precompile_after_onload.js

@@ -0,0 +1 @@
+//= require ../files/example_after_onload

data/lib/optipipe/engine.rb

@@ -0,0 +1,38 @@
+require 'optipipe/models/mapper'
+require 'optipipe/helpers/tag_helper'
+
+module Optipipe
+  class Engine < ::Rails::Engine
+    isolate_namespace Optipipe
+
+    # Add precompile paths.
+    initializer "optipipe.assets.precompile" do |app|
+      app.config.assets.precompile = app.config.assets.precompile.map do |precompile_setting|
+        next precompile_setting unless precompile_setting.is_a?(Proc)
+
+        if Rails::VERSION::MAJOR == 3
+          lambda do |path|
+            precompile_setting.call(path) &&
+            !(path =~ /optipipe\/mappers\// &&
+            ['.yml'].include?(File.extname(path)))
+          end
+        else
+          lambda do |logical_path, filename|
+            precompile_setting.call(logical_path, filename) &&
+            !(filename.start_with?(::Rails.root.join("app/assets/optipipe/mappers").to_s) &&
+            ['.yml'].include?(File.extname(logical_path)))
+          end
+        end
+      end
+      app.config.assets.precompile << 'optipipe/precompiles/*.js'
+      app.config.assets.precompile << 'optipipe/precompiles/*.css'
+    end
+
+    # Add helpers
+    initializer 'gtm_on_rails.action_view_helpers' do
+      ActiveSupport.on_load :action_view do
+        include Optipipe::TagHelper
+      end
+    end
+  end
+end

data/lib/optipipe/helpers/tag_helper.rb

@@ -0,0 +1,69 @@
+module Optipipe
+  module TagHelper
+    # options
+    #   mapper_conditions: Limiting conditions when select mapper.
+    #   default:           A mapper used when there aren't any one meeting a condition. This value is controller_path.
+    def optipipe_javascript_include_tag(*args)
+      # set args
+      options             = args[0] || {}
+      include_tag_options = args[1] || {}
+      mapper_conditions   = options.delete(:mapper_conditions) || {}
+
+      mapper_conditions.except!('controller_path', 'load_files', 'after_onload') # Using several key names at mapper_conditions are not allowed.
+      mapper = get_mapper(Optipipe::Mapper.get_javascript_mappers(controller.controller_path), mapper_conditions)
+
+      # default_mapper
+      mapper = (Optipipe::Mapper.get_javascript_mappers(options[:default]) || []).first if mapper.blank?
+
+      return if mapper.blank?
+
+      script = (mapper['load_files'] || []).map do |file_name|
+        javascript_include_tag("optipipe/precompiles/#{file_name}", include_tag_options)
+      end.join("\n").html_safe
+
+      # after onload
+      paths = (mapper['after_onload'] || []).map do |file_name|
+        asset_path("optipipe/precompiles/#{file_name}")
+      end
+      script += render(partial: 'optipipe/after_onload', locals: {paths: paths}) if paths.present?
+
+      script
+    end
+
+    # options
+    #   mapper_conditions: Limiting conditions when select mapper.
+    #   default:           A mapper used when there aren't any one meeting a condition. This value is controller_path.
+    def optipipe_stylesheet_link_tag(*args)
+      # set args
+      options             = args[0] || {}
+      include_tag_options = args[1] || {}
+      mapper_conditions   = options.delete(:mapper_conditions) || {}
+
+      mapper_conditions.except!('controller_path', 'load_files') # Using several key names at mapper_conditions are not allowed.
+      mapper = get_mapper(Optipipe::Mapper.get_stylesheet_mappers(controller.controller_path), mapper_conditions)
+
+      # default_mapper
+      mapper = (Optipipe::Mapper.get_stylesheet_mappers(options[:default]) || []).first if mapper.blank?
+
+      return if mapper.blank?
+
+      (mapper['load_files'] || []).map do |file_name|
+        stylesheet_link_tag("optipipe/precompiles/#{file_name}", {media: 'all'}.merge(include_tag_options))
+      end.join.html_safe
+    end
+
+    private
+
+    def get_mapper(mappers, conditions = {})
+      return if mappers.blank?
+
+      conditions.each do |key, value|
+        mappers.select! do |mapper|
+          mapper[key.to_s] == value
+        end
+      end
+
+      mappers.first
+    end
+  end
+end

data/lib/optipipe/models/mapper.rb

@@ -0,0 +1,32 @@
+module Optipipe
+  class Mapper
+    class << self
+      def get_javascript_mappers(controller_path)
+        get_yaml_data('javascripts')[controller_path]
+      end
+
+      def get_stylesheet_mappers(controller_path)
+        get_yaml_data('stylesheets')[controller_path]
+      end
+
+      private
+      
+      def get_yaml_data(type)
+        const_name = :"#{type.upcase}_YAML_DATA"
+        if self.const_defined?(const_name) && Rails.env.production?
+          yaml_data = self.const_get(const_name)
+        else
+          yaml_data = {}
+          Dir.glob(Rails.root.join('app', 'assets', type, 'optipipe', 'mappers', '*')).each do |mapper_yaml|
+            data = YAML.load(File.open(mapper_yaml))
+            yaml_data[data['controller_path']] ||= []
+            yaml_data[data['controller_path']] << data
+          end
+          self.const_set(const_name, yaml_data)
+        end
+
+        yaml_data
+      end
+    end
+  end
+end

data/lib/optipipe/version.rb

@@ -0,0 +1,3 @@
+module Optipipe
+  VERSION = '0.4.1'
+end

data/lib/optipipe.rb

@@ -0,0 +1,4 @@
+require "optipipe/engine"
+
+module Optipipe
+end

data/lib/tasks/optipipe_tasks.rake

@@ -0,0 +1,4 @@
+# desc "Explaining what the task does"
+# task :optipipe do
+#   # Task goes here
+# end

metadata

@@ -0,0 +1,94 @@
+--- !ruby/object:Gem::Specification
+name: optipipe
+version: !ruby/object:Gem::Version
+  version: 0.4.1
+platform: ruby
+authors:
+- ykogure
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2018-05-29 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.2.22
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.2.22
+- !ruby/object:Gem::Dependency
+  name: mysql2
+  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: This is an plugin that load precompiled asset files each controllers.
+  This plugin is created for optimize to load asset files parallel when had to use
+  `HTTP/2` protocol.
+email:
+- renkin1008@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- MIT-LICENSE
+- README.ja.md
+- README.md
+- Rakefile
+- app/views/optipipe/_after_onload.html.erb
+- lib/generators/optipipe/install_generator.rb
+- lib/generators/templates/files/example.css
+- lib/generators/templates/files/example.js
+- lib/generators/templates/files/example_after_onload.js
+- lib/generators/templates/mappers/example_mapper_for_javascripts.yml
+- lib/generators/templates/mappers/example_mapper_for_stylesheets.yml
+- lib/generators/templates/precompiles/example_precompile.css
+- lib/generators/templates/precompiles/example_precompile.js
+- lib/generators/templates/precompiles/example_precompile_after_onload.js
+- lib/optipipe.rb
+- lib/optipipe/engine.rb
+- lib/optipipe/helpers/tag_helper.rb
+- lib/optipipe/models/mapper.rb
+- lib/optipipe/version.rb
+- lib/tasks/optipipe_tasks.rake
+homepage: https://github.com/ZIGExN/optipipe
+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.6.11
+signing_key: 
+specification_version: 4
+summary: An plugin that load precompiled asset files each controllers.
+test_files: []