content_pack_rails 0.1.0 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 01e54acea70e4117e3b4aa0eeb0abdd77e6dda0d66f3aba6adb03a7eeb10436b
-  data.tar.gz: 233bce3890613f9fd10988d2a3698d598fbba98cc973498a5d60098af2cac111
+  metadata.gz: 8a26d8a1b263627df989ef8d8d97f33b489c8322c92eb503c158b9b2b7cad37b
+  data.tar.gz: f721a69bbed4ed7d6d2c98bf1a3ac10394f4efa8a9946528b3c1193927676d04
 SHA512:
-  metadata.gz: 779ecc0ac8004761f8fee1022081521d2739be5c59c6c718c2d312d9ec3c86b2665a159b3ec7eff67f23a78a160d2574fa174138fa9ae436394f7cd4220374de
-  data.tar.gz: 4ba805bbcd91730f6df4061f1555043db1c4afae8a007063774608bfbea324337936fd2982bb5e914f9eb9ccd203d602a037c8fc67a953f56fd482ee903b2b17
+  metadata.gz: fe733e4d00555d3963a70c7d310063e21feebd17c4392fa1c8930bed30043c12192d17809c0d2906781ed8ab924442835de8a77aa253bb3ff55f5b7296719d90
+  data.tar.gz: 65b7a42f9b7b3bfa5dcf459d9cc52ba02b08793297dae4a7cedb2a7e9aaae74643e0aa178b2750849f2737bfc5ec76f15c2b9e2f88843dccae48dbf7105ec243

data/.github/workflows/tests.yml

@@ -0,0 +1,34 @@
+name: Tests
+
+on:
+  push:
+    branches: [ main ]
+  pull_request:
+    branches: [ main ]
+
+jobs:
+  test:
+    strategy:
+      fail-fast: false
+      matrix:
+        ruby: ['2.7', '3.0']
+        rails: ['6.1', '7.0']
+
+    runs-on: ubuntu-latest
+    name: Test against Ruby ${{ matrix.ruby }} / Rails ${{ matrix.rails }}
+
+    steps:
+      - uses: actions/checkout@v2
+
+      - name: Set up Ruby
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.ruby }}
+
+      - name: Install gems and run tests
+        env:
+          TEST_RAILS_VERSION: ${{ matrix.rails }}
+        run: |
+          gem install bundler
+          bundle install --jobs 4 --retry 3
+          bundle exec rake

data/CHANGELOG.md

@@ -0,0 +1,25 @@
+# Changelog
+
+## 1.0.0 (2022-02-14)
+
+### Bug Fixes
+
+* github workflow - tests with ruby versions 2.7, 3.0, and rails versions 6.1, 7.0
+
+## 0.2.2 (2021-12-08)
+
+### Bug Fixes
+
+* prevent provide_content_pack from crash when no content collected
+
+## 0.2.1 (2021-12-08)
+
+### Bug Fixes
+
+* make sure getter helpers return instance of ActiveSupport::SafeBuffer
+
+## 0.2.0 (2021-12-03)
+
+### Features
+
+* ability to get content entry from pack

data/README.md

@@ -1,4 +1,8 @@
 # ContentPackRails
+
+[![Gem Version](https://badge.fury.io/rb/content_pack_rails.svg)](https://badge.fury.io/rb/content_pack_rails)
+[![Tests](https://github.com/a-bohush/content_pack_rails/actions/workflows/tests.yml/badge.svg?branch=main)](https://github.com/a-bohush/content_pack_rails/actions/workflows/tests.yml)
+
 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.
 
@@ -23,7 +27,7 @@ module ApplicationHelper
 end
 ```
 
-By default, this will add two view helpers `content_pack` and `provide_content_pack`.
+By default, this will add three view helpers `content_pack`, `provide_content_pack` and `content_pack_get`.
 To avoid collisions with a helper of the same name you might already have in your app, provide a different name:
 
 ```ruby
@@ -33,7 +37,7 @@ module ApplicationHelper
 end
 ```
 
-Helper `content_pack` declares the same parameters as a standard rails `content_for` and can be used similarly to capture content like this:
+Helper `content_pack` declares the same parameters as the standard rails `content_for` and can be used similarly to capture content like this:
 
 ```erb
 <% content_pack 'content-id' do |id| %>
@@ -45,14 +49,14 @@ Helper `content_pack` declares the same parameters as a standard rails `content_
    -->
 <% end %>
 ```
-or pass content as a second argument:
+or pass content as the 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:
+If you would like to add additional content on a given name, you should pass the `append: true` option like so:
 
 ```erb
 <% content_pack 'content-id', 'first content' %>
@@ -60,7 +64,7 @@ If you would like to add additional content on a given name, you should pass an
 <% content_pack 'content-id', 'second content', append: true %>
 ```
 
-In case you want to override content on a given name, provide a `flush: true` option:
+In case you want to override content on a given name, provide the `flush: true` option:
 ```erb
 <% content_pack 'content-id', 'first content' %>
 <!-- following will override the first one -->
@@ -73,6 +77,11 @@ So later on, you can render the whole pack somewhere in your view, like this:
 <%= provide_content_pack %>
 ```
 
+To access a single content entry from the pack, use `content_pack_get`:
+```erb
+<%= content_pack_get('content-id') %>
+```
+
 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

data/content_pack_rails.gemspec

@@ -10,14 +10,18 @@ Gem::Specification.new do |spec|
   spec.license     = "MIT"
 
   spec.metadata["source_code_uri"] = spec.homepage
-  # spec.metadata["changelog_uri"] = "TODO: Put your gem's CHANGELOG.md URL here."
-
+  spec.metadata["changelog_uri"] = "https://github.com/a-bohush/content_pack_rails/blob/main/CHANGELOG.md"
+  spec.extra_rdoc_files = ['README.md']
   # 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"
+  if ENV['TEST_RAILS_VERSION'].nil?
+    spec.add_development_dependency "rails", "~> 6.1.4", ">= 6.1.4.1"
+  else
+    spec.add_development_dependency "rails", ENV['TEST_RAILS_VERSION'].to_s
+  end
   spec.add_development_dependency "pry-byebug"
 end

data/lib/content_pack_rails/version.rb

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

data/lib/content_pack_rails.rb

@@ -4,9 +4,10 @@ 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 }
+      to_content_id = -> (id) { "_id_#{configs[:pack_name]}_#{id}".to_sym }
 
       define_method configs[:pack_name] do |id, content=nil, options={}, &block|
-        _id = "_id_#{configs[:pack_name]}_#{id}".to_sym
+        _id = to_content_id.call(id)
         _block = proc { block.call(id) } if block
         options[:append] || options[:flush] || content_for?(_id) && return
         content_for(_id, content, options.slice(:flush), &_block)
@@ -15,11 +16,15 @@ module ContentPackRails
       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) }
+        return unless (ids = silent.call { instance_variable_get(:"@_#{configs[:pack_name]}_ids") })
+        ids.inject(nil) do |acc, id|
+          return acc unless (content = content_for(id))
+          acc ? acc.safe_concat(content) : content
         end
-        content_for(configs[:pack_name])
+      end
+
+      define_method "#{configs[:pack_name]}_get" do |id|
+        content_for(to_content_id.call(id))
       end
     end
   end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: content_pack_rails
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 1.0.0
 platform: ruby
 authors:
 - Andrew Bohush
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-12-02 00:00:00.000000000 Z
+date: 2022-02-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -49,9 +49,12 @@ email:
 - a.bohush01@gmail.com
 executables: []
 extensions: []
-extra_rdoc_files: []
+extra_rdoc_files:
+- README.md
 files:
+- ".github/workflows/tests.yml"
 - ".gitignore"
+- CHANGELOG.md
 - Gemfile
 - MIT-LICENSE
 - README.md
@@ -64,6 +67,7 @@ licenses:
 - MIT
 metadata:
   source_code_uri: https://github.com/a-bohush/content_pack_rails.git
+  changelog_uri: https://github.com/a-bohush/content_pack_rails/blob/main/CHANGELOG.md
 post_install_message: 
 rdoc_options: []
 require_paths: