content_pack_rails 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 01e54acea70e4117e3b4aa0eeb0abdd77e6dda0d66f3aba6adb03a7eeb10436b
+  data.tar.gz: 233bce3890613f9fd10988d2a3698d598fbba98cc973498a5d60098af2cac111
+SHA512:
+  metadata.gz: 779ecc0ac8004761f8fee1022081521d2739be5c59c6c718c2d312d9ec3c86b2665a159b3ec7eff67f23a78a160d2574fa174138fa9ae436394f7cd4220374de
+  data.tar.gz: 4ba805bbcd91730f6df4061f1555043db1c4afae8a007063774608bfbea324337936fd2982bb5e914f9eb9ccd203d602a037c8fc67a953f56fd482ee903b2b17

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/doc/
+/log/*.log
+/pkg/
+/tmp/
+/test/dummy/log/*.log
+/test/dummy/tmp/
+.byebug_history
+.ruby-gemset
+.ruby-version
+Gemfile.lock

data/Gemfile

@@ -0,0 +1,5 @@
+source 'https://rubygems.org'
+git_source(:github) { |repo| "https://github.com/#{repo}.git" }
+
+# Specify your gem's dependencies in content_pack_rails.gemspec.
+gemspec

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2021 Andrew Bohush
+
+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,145 @@
+# ContentPackRails
+A thin wrapper around [`ActionView::Helpers::CaptureHelper#content_for`](https://api.rubyonrails.org/classes/ActionView/Helpers/CaptureHelper.html#method-i-content_for).
+Useful when you need to collect multiple content entries during page rendering, for example <script type="text/template"> templates, without woring about possible duplications and name clashes.
+
+## Installation
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'content_pack_rails'
+```
+
+And then execute:
+```bashn
+$ bundle install
+```
+
+## Usage
+
+Include `ContentPackRails` into your `ApplicationHelper`:
+```ruby
+module ApplicationHelper
+    include ContentPackRails
+end
+```
+
+By default, this will add two view helpers `content_pack` and `provide_content_pack`.
+To avoid collisions with a helper of the same name you might already have in your app, provide a different name:
+
+```ruby
+module ApplicationHelper
+    # This will add custom_named_pack and provide_custom_named_pack helpers respectively.
+    include ContentPackRails.init(pack_name: 'custom_named_pack')
+end
+```
+
+Helper `content_pack` declares the same parameters as a standard rails `content_for` and can be used similarly to capture content like this:
+
+```erb
+<% content_pack 'content-id' do |id| %>
+   <!--
+     Your content goes here.
+     Additionally, the content name is passed as the first parameter.
+     So you may use it further, for example, to set it as the id attribute for an element.
+       <div id=<%= id %>></div>
+   -->
+<% end %>
+```
+or pass content as a second argument:
+```erb
+<% content_pack 'content-id', 'Your content' %>
+```
+
+Unlike `content_for`, by default, `content_pack` will not concatenate content with the same name.
+Multiple calls to `content_pack` with the same content name will result in only the first content being added to the pack.
+If you would like to add additional content on a given name, you should pass an `append: true` option like so:
+
+```erb
+<% content_pack 'content-id', 'first content' %>
+<!-- following will be concatenated with the first one -->
+<% content_pack 'content-id', 'second content', append: true %>
+```
+
+In case you want to override content on a given name, provide a `flush: true` option:
+```erb
+<% content_pack 'content-id', 'first content' %>
+<!-- following will override the first one -->
+<% content_pack 'content-id', 'second content', flush: true %>
+```
+
+Every content passed to the `content_pack` is aggregated into one "pack," which you can access through the correspondent `provide_content_pack` helper.
+So later on, you can render the whole pack somewhere in your view, like this:
+```erb
+<%= provide_content_pack %>
+```
+
+Should you want to have multiple packs, for example, to group content, you can set up those by including this module as many times as needed with different names:
+```ruby
+module ApplicationHelper
+    include ContentPackRails.init(pack_name: 'content_pack2')
+    include ContentPackRails.init(pack_name: 'content_pack3')
+    # etc.
+end
+```
+
+### Common use-case example
+
+You may have javascript components that render HTML using templates in the form of `<script type="text/template">`.
+Those templates are usually included as a part of rendered HTML, and if you have enough of them, it is hard to track what has already been included.
+
+Given that the same component may be a part of other components templates and so on, you may end up with multiple copies of the same template included in the final response.
+`ContentPackRails` helpers tandem allow you to organize JS templates provisioning in a way somewhat similar to how it is done with javascript files.
+
+For example, you can keep such templates as regular rails view partials in separate files somewhere under `app/views` directory:
+```bash
+# ...
+app/views/comments/_collection_template.html.erb
+app/views/comments/_item_template.html.erb
+# ...
+```
+Both those templates can be exported using `content_pack` helper like this:
+```erb
+<!-- app/views/comments/_item_template.html.erb -->
+<%= content_pack 'comments-item-template' do |id| %>
+   <script type="text/template" id=<%= id %>>
+      // item component template goes here
+   </script>
+<% end %>
+```
+
+```erb
+<!-- app/views/comments/_collection_template.html.erb -->
+
+<% render 'item_template' %>
+
+<%= content_pack 'comments-collection-template' do |id| %>
+   <script type="text/template" id=<%= id %>>
+      // somewhere here you will likely loop through comments using <comments-item-component> with some properties
+   </script>
+<% end %>
+```
+Note that in `app/views/comments/_collection_template.html.erb` we called `render` for `item_template` because the collection template depends on it.
+Calling `render` here may be thought of as `import` for the template, which in its turn tirgers `content_pack` (aka `export`) to include the template into a bundle.
+Each template contains all the imports it depends on, so you can just grab any template and be sure its dependencies also end up in a final pack, like in the following example.
+
+```erb
+<!-- app/views/comments/index.html.erb -->
+
+<% render 'collection_template' %> <!-- this will include collection and item templates -->
+
+<!-- rest of the index.html -->
+```
+
+Resulting bundle of templates we can include in our `app/views/layouts/application.html.rb` like so:
+```erb
+<html>
+  <head></head>
+  <body>
+    <%= yield %>
+  </body>
+  <%= provide_content_pack %>
+</html>
+```
+
+## 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,13 @@
+require "bundler/setup"
+
+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/content_pack_rails.gemspec

@@ -0,0 +1,23 @@
+require_relative "lib/content_pack_rails/version"
+
+Gem::Specification.new do |spec|
+  spec.name        = "content_pack_rails"
+  spec.version     = ContentPackRails::VERSION
+  spec.authors     = ["Andrew Bohush"]
+  spec.email       = ["a.bohush01@gmail.com"]
+  spec.homepage    = "https://github.com/a-bohush/content_pack_rails.git"
+  spec.summary     = "Ruby on Rails helpers for capturing view content into bundles."
+  spec.license     = "MIT"
+
+  spec.metadata["source_code_uri"] = spec.homepage
+  # spec.metadata["changelog_uri"] = "TODO: Put your gem's CHANGELOG.md URL here."
+
+  # 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.add_development_dependency "rails", "~> 6.1.4", ">= 6.1.4.1"
+  spec.add_development_dependency "pry-byebug"
+end

data/lib/content_pack_rails/version.rb

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

data/lib/content_pack_rails.rb

@@ -0,0 +1,28 @@
+require "content_pack_rails/version"
+
+module ContentPackRails
+  def self.init(configs = { pack_name: 'content_pack' })
+    Module.new do
+      silent = proc { |&block| v = $VERBOSE; $VERBOSE = nil; res = block.call; $VERBOSE = v; res }
+
+      define_method configs[:pack_name] do |id, content=nil, options={}, &block|
+        _id = "_id_#{configs[:pack_name]}_#{id}".to_sym
+        _block = proc { block.call(id) } if block
+        options[:append] || options[:flush] || content_for?(_id) && return
+        content_for(_id, content, options.slice(:flush), &_block)
+        (silent.call { instance_variable_get(:"@_#{configs[:pack_name]}_ids") } ||
+          instance_variable_set(:"@_#{configs[:pack_name]}_ids", Set.new)).add(_id)
+      end
+
+      define_method "provide_#{configs[:pack_name]}" do
+        content_for(configs[:pack_name], nil, flush: true)
+        instance_variable_get(:"@_#{configs[:pack_name]}_ids").each do |id|
+          content_for(configs[:pack_name]) { content_for(id) }
+        end
+        content_for(configs[:pack_name])
+      end
+    end
+  end
+
+  include init
+end

metadata

@@ -0,0 +1,86 @@
+--- !ruby/object:Gem::Specification
+name: content_pack_rails
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Andrew Bohush
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2021-12-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 6.1.4
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 6.1.4.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 6.1.4
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 6.1.4.1
+- !ruby/object:Gem::Dependency
+  name: pry-byebug
+  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:
+- a.bohush01@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- MIT-LICENSE
+- README.md
+- Rakefile
+- content_pack_rails.gemspec
+- lib/content_pack_rails.rb
+- lib/content_pack_rails/version.rb
+homepage: https://github.com/a-bohush/content_pack_rails.git
+licenses:
+- MIT
+metadata:
+  source_code_uri: https://github.com/a-bohush/content_pack_rails.git
+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.1.6
+signing_key: 
+specification_version: 4
+summary: Ruby on Rails helpers for capturing view content into bundles.
+test_files: []