haken 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: f8d40e52bacc9753ca563572a44eaeb96689de024dbc02d2dbca0583819a4405
+  data.tar.gz: 80b503d505ee57bab86e9ec46b1a80323ecb5ebdb59399a73ba2cb931127f1a5
+SHA512:
+  metadata.gz: d0809f760acb7e21a19292a5f7c0e122bacfda17a1f9a5689161376ae1d0f86add74174846dfcec9f911d63b6db5956c59a1dfb0142b3e13739a5c1297907868
+  data.tar.gz: f1193638052ac7bcb59b4673cfbdb147201f5c11dc74ece7ed914031b6a9482f597a89f413590690cc6c374b8bd548cc28c88f612f9ec17ce7d454cb2dc55c0c

data/.gitignore

@@ -0,0 +1,8 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/Gemfile

@@ -0,0 +1,6 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in haken.gemspec
+gemspec
+
+gem 'rake', '~> 12.0'

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2022 Davis Namsons
+
+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,25 @@
+# Haken
+
+A very simple gem for defining places where additional content can be injected from elsewhere.
+
+## Usage
+
+Define a place where additional content can be injected:
+
+`views/layouts/_navbar.html.erb`
+```erb
+<nav>
+  <%= load_view_hooks_for :navbar %>
+</nav>
+```
+
+Then you can define a partial elsewhere(for example in a different Rails engine) and inject it into the navbar via an initializer like this:
+```rb
+module MyEngine
+  class Engine < Rails::Engine
+    initializer 'my_engine.view_hooks' do
+      Haken.on_load(:navbar) { render 'layouts/my_engine/navbar_extension' }
+    end
+  end
+end
+```

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "haken"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/haken.gemspec

@@ -0,0 +1,21 @@
+require_relative 'lib/haken/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'haken'
+  spec.version       = Haken::VERSION
+  spec.authors       = ['Davis Namsons']
+
+  spec.summary       = 'Add load hooks into your views'
+  spec.description   = 'Haken allows you to define places in your views where additional content can be injected from elsewhere(for example, a seperate rails engine)'
+  spec.license       = 'MIT'
+  spec.required_ruby_version = Gem::Requirement.new('>= 2.3.0')
+
+  # 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(__dir__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+end

data/lib/haken/helpers.rb

@@ -0,0 +1,9 @@
+module Haken
+  module Helpers
+    def load_view_hooks_for(identifier, *args)
+      Listeners.load_hooks_for(self, identifier, *args).html_safe
+    end
+  end
+
+  ActionView::Base.include Helpers
+end

data/lib/haken/listeners.rb

@@ -0,0 +1,29 @@
+module Haken
+  class Listeners
+    include Singleton
+
+    def self.subscribe(identifier, &block)
+      instance.subscribe(identifier, &block)
+    end
+
+    def self.load_hooks_for(identifier, *args)
+      instance.load_hooks_for(identifier, *args)
+    end
+
+    def initialize
+      @load_hooks = {}
+    end
+
+    def subscribe(identifier, &block)
+      @load_hooks[identifier] ||= []
+
+      @load_hooks[identifier] << block
+    end
+
+    def load_hooks_for(view_context, identifier)
+      @load_hooks[identifier].map do |hook|
+        view_context.instance_eval(&hook)
+      end.join
+    end
+  end
+end

data/lib/haken/version.rb

@@ -0,0 +1,3 @@
+module Haken
+  VERSION = "0.1.0"
+end

data/lib/haken.rb

@@ -0,0 +1,13 @@
+require 'haken/version'
+require 'haken/listeners'
+require 'haken/helpers' if defined?(ActionView)
+
+module Haken
+  def self.on_load(identifier, &block)
+    Listeners.subscribe(identifier, &block)
+  end
+
+  def load_hooks_for(identifier, *args)
+    Listeners.load_hooks_for(identifier, *args)
+  end
+end

metadata

@@ -0,0 +1,55 @@
+--- !ruby/object:Gem::Specification
+name: haken
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Davis Namsons
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2022-10-10 00:00:00.000000000 Z
+dependencies: []
+description: Haken allows you to define places in your views where additional content
+  can be injected from elsewhere(for example, a seperate rails engine)
+email: 
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- haken.gemspec
+- lib/haken.rb
+- lib/haken/helpers.rb
+- lib/haken/listeners.rb
+- lib/haken/version.rb
+homepage: 
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.3.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.3
+signing_key: 
+specification_version: 4
+summary: Add load hooks into your views
+test_files: []