pagehook-rails 0.0.13 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f2852ade6233194d94418a3654f9bea38e4b0442e62077bcc6c34bf7e7f0a9c4
-  data.tar.gz: 3b9af4d616394e071a10a74a41c9ce3f8c9a4ef2e3d042c8a6a011b271051e24
+  metadata.gz: a1233e455124a9255cf37b940682d2df66e7eafc0e76ebd683f4eeebb0ef8623
+  data.tar.gz: 7ae8e6be99a95183bbb6879accb037f898f8eb0aa9614283c430a30144d6fedc
 SHA512:
-  metadata.gz: fb0f881127bf6258fc690126c5d3bbf7520d5b837e931281d6a7e41fb4fbf19cace07285b4ba649f1beda950c8ffff031e796b3ff72706b035bbefd3b43a2c5a
-  data.tar.gz: bcebf3b94676101d493a10a46bebfbc9405d7f1b1a0a800339b9427404a62f7b642b0739f4f56823839617f56afde0830878f65b54e9c0ea299153c7931d91a2
+  metadata.gz: 85584053052956a9daea5450062c42d6f4086f6919411a648c0aa9db484e6d56d671f7e268b2221fc5ed23ad4eef03bd07f51053ae79ec6dcd30953e7ba804c5
+  data.tar.gz: ac5cc2da3288405507820c6825c14675a771b40ffd4d9d2e8925252166bc9fef26f5e2efeb4ab18951bc8c078b13be25993d636f0336e0c1df28d6e02f8a9878

data/README.md

@@ -15,9 +15,7 @@ And then execute:
 
     $ bundle
     $ rails g pagehook:install
-    # Or `rails g pagehook:install --lang coffee` if you like CoofeeScript
-
-If you use turbolinks, you should load `pagehook_rails` after `turbolinks` in `app/assets/javascripts/application.js`.
+    # Or `rails g pagehook:install --lang js` if you dont use TypeScript
 
 
 View helper
@@ -25,7 +23,7 @@ View helper
 
 `pagehook` view helper method generates "trigger element".
 
-    <%= pagehook("articles/index", id: 123) %>
+    <%= pagehook("articles/index", {id: 123}) %>
 
 This generates following HTML.
 
@@ -38,15 +36,14 @@ Generator
 `rails g pagehook path/to/view` generates hook definition template.
 
     $ rails g pagehook articles/index
-          create  app/assets/javascripts/pagehook/articles/index.coffee
-    $ cat app/assets/javascripts/pagehook/articles/index.coffee
-    //= require pagehook_rails
-    Pagehook.register("articles/index", function(data) {
-        // Your code
+          create  app/javascript/pagehook/articles/index.ts
+    $ cat app/javascript/pagehook/articles/index.ts
+    import Pagehook from "pagehook"
+    Pagehook.register("articles/index", (data: any) => {
+      console.log(data);
     });
 
-
-You can also do `rails g pagehook path/to/view --lang coffee` to generate .coffee rather than .js.
+You can also do `rails g pagehook path/to/view --lang js` to generate .js rather than .ts.
 
 
 Contributing

data/lib/generators/pagehook/install/install_generator.rb

@@ -1,17 +1,30 @@
 module Pagehook
   class InstallGenerator < Rails::Generators::Base
     source_root File.expand_path("../templates", __FILE__)
-    class_option :lang, type: :string, default: "js"
+    class_option :lang, type: :string, default: "ts"
+
+    def install
+      run "yarn add pagehook@^0.1.4"
+    end
 
     def copy_loader
       case options[:lang].downcase
-      when "coffee", "coffeescript"
-        copy_file "pagehook_rails.coffee", "app/assets/javascripts/pagehook_rails.coffee"
       when "js", "javascript"
-        copy_file "pagehook_rails.js", "app/assets/javascripts/pagehook_rails.js"
+        copy_file "pagehook_rails.js", "app/javascript/pagehook_rails.js"
+        copy_file "global.js", "app/javascript/pagehook/global.js"
+      when "ts", "typescript"
+        copy_file "pagehook_rails.ts", "app/javascript/pagehook_rails.ts"
+        copy_file "global.ts", "app/javascript/pagehook/global.ts"
       else
         raise "Unknown language: #{lang}"
       end
+
+      case
+      when File.exists?("app/javascript/packs/application.ts")
+        append_file_with_newline "app/javascript/packs/application.ts", %(\nimport "../pagehook_rails")
+      when File.exists?("app/javascript/packs/application.js")
+        append_file_with_newline "app/javascript/packs/application.js", %(\nimport "../pagehook_rails")
+      end
     end
   end
 end

data/lib/generators/pagehook/install/templates/global.js

@@ -0,0 +1,4 @@
+import Pagehook from "pagehook"
+Pagehook.register("@global", function() {
+  // Your code
+});

data/lib/generators/pagehook/install/templates/global.ts

@@ -0,0 +1,4 @@
+import Pagehook from "pagehook"
+Pagehook.register("@global", () => {
+  // Your code
+});

data/lib/generators/pagehook/install/templates/pagehook_rails.js

@@ -1,8 +1,13 @@
-//= require pagehook_rails/pagehook
 // Register event handler
-if (typeof(Turbolinks) === "undefined") {
-    document.addEventListener("DOMContentLoaded", Pagehook.handler);
-} else {
-    document.addEventListener("turbolinks:load", Pagehook.handler);
-    document.addEventListener("page:load", Pagehook.handler);
-}
+import Pagehook from "pagehook";
+document.addEventListener("DOMContentLoaded", Pagehook.handler);
+
+const requireHook = require.context(
+  "./pagehook",
+  true, // Whether or not to look in subfolders
+  /[a-z0-9_]+\.(js|ts)$/u,
+);
+
+requireHook.keys().forEach((fileName) => {
+  requireHook(fileName);
+});

data/lib/generators/pagehook/install/templates/pagehook_rails.ts

@@ -0,0 +1,22 @@
+// Register event handler
+import Pagehook from "pagehook";
+document.addEventListener("DOMContentLoaded", Pagehook.handler);
+
+// Require all hooks in ./pagehook
+interface RequireHook {
+  (fileName: string): object | {default: object};
+  keys: () => string[];
+}
+interface NodeRequireWithContext extends NodeRequire {
+  context: (a: string, b: boolean, c: RegExp) => RequireHook;
+}
+
+const requireHook = (require as NodeRequireWithContext).context(
+  "./pagehook",
+  true, // Whether or not to look in subfolders
+  /[a-z0-9_]+\.(js|ts)$/u,
+);
+
+requireHook.keys().forEach((fileName: string) => {
+  requireHook(fileName);
+});

data/lib/generators/pagehook/pagehook_generator.rb

@@ -1,13 +1,13 @@
 class PagehookGenerator < Rails::Generators::NamedBase
   source_root File.expand_path("../templates", __FILE__)
-  class_option :lang, type: :string, default: "js"
+  class_option :lang, type: :string, default: "ts"
 
   def generate_script
     case options[:lang].downcase
-    when "coffee", "coffeescript"
-      template "hook.coffee.erb", "app/assets/javascripts/pagehook/#{view_path}.coffee"
     when "js", "javascript"
-      template "hook.js.erb", "app/assets/javascripts/pagehook/#{view_path}.js"
+      template "hook.js.erb", "app/javascript/pagehook/#{view_path}.js"
+    when "ts", "typescript"
+      template "hook.ts.erb", "app/javascript/pagehook/#{view_path}.ts"
     else
       raise "Unknown language: #{lang}"
     end

data/lib/generators/pagehook/templates/hook.js.erb

@@ -1,4 +1,4 @@
-//= require pagehook_rails
+import Pagehook from "pagehook"
 Pagehook.register("<%= view_path %>", function(data) {
-    // Your code
+  // Your code
 });

data/lib/generators/pagehook/templates/hook.ts.erb

@@ -0,0 +1,4 @@
+import Pagehook from "pagehook"
+Pagehook.register("<%= view_path %>", (data: any) => {
+  // Your code
+});

data/lib/pagehook-rails/engine.rb

@@ -3,7 +3,7 @@ module PagehookRails
     isolate_namespace PagehookRails
 
     initializer "pagehook-rails.action_controller" do |app|
-      ActiveSupport.on_load :action_controller do
+      Rails.application.reloader.to_prepare do
         ActionController::Base.helper PagehookRails::PagehookHelper
       end
     end

data/lib/pagehook-rails/version.rb

@@ -1,3 +1,3 @@
 module PagehookRails
-  VERSION = "0.0.13"
+  VERSION = "0.1.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: pagehook-rails
 version: !ruby/object:Gem::Version
-  version: 0.0.13
+  version: 0.1.0
 platform: ruby
 authors:
 - labocho
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2019-08-20 00:00:00.000000000 Z
+date: 2022-12-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '3.1'
+        version: '6.1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '3.1'
+        version: '6.1'
 - !ruby/object:Gem::Dependency
   name: loofah
   requirement: !ruby/object:Gem::Requirement
@@ -118,21 +118,22 @@ files:
 - MIT-LICENSE
 - README.md
 - Rakefile
-- app/assets/javascripts/pagehook_rails/pagehook.js
 - app/helpers/pagehook_rails/pagehook_helper.rb
 - lib/generators/pagehook/install/install_generator.rb
-- lib/generators/pagehook/install/templates/pagehook_rails.coffee
+- lib/generators/pagehook/install/templates/global.js
+- lib/generators/pagehook/install/templates/global.ts
 - lib/generators/pagehook/install/templates/pagehook_rails.js
+- lib/generators/pagehook/install/templates/pagehook_rails.ts
 - lib/generators/pagehook/pagehook_generator.rb
-- lib/generators/pagehook/templates/hook.coffee.erb
 - lib/generators/pagehook/templates/hook.js.erb
+- lib/generators/pagehook/templates/hook.ts.erb
 - lib/pagehook-rails.rb
 - lib/pagehook-rails/engine.rb
 - lib/pagehook-rails/version.rb
 homepage: https://github.com/labocho/pagehook-rails
 licenses: []
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -147,8 +148,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
-signing_key: 
+rubygems_version: 3.3.3
+signing_key:
 specification_version: 4
 summary: Rails plugin integrates Pagehook (https://github.com/labocho/pagehook)
 test_files: []

data/app/assets/javascripts/pagehook_rails/pagehook.js

@@ -1,82 +0,0 @@
-!function(e){if("object"==typeof exports&&"undefined"!=typeof module)module.exports=e();else if("function"==typeof define&&define.amd)define([],e);else{var o;"undefined"!=typeof window?o=window:"undefined"!=typeof global?o=global:"undefined"!=typeof self&&(o=self),o.Pagehook=e()}}(function(){var define,module,exports;return (function e(t,n,r){function s(o,u){if(!n[o]){if(!t[o]){var a=typeof require=="function"&&require;if(!u&&a)return a(o,!0);if(i)return i(o,!0);var f=new Error("Cannot find module '"+o+"'");throw f.code="MODULE_NOT_FOUND",f}var l=n[o]={exports:{}};t[o][0].call(l.exports,function(e){var n=t[o][1][e];return s(n?n:e)},l,l.exports,e,t,n,r)}return n[o].exports}var i=typeof require=="function"&&require;for(var o=0;o<r.length;o++)s(r[o]);return s})({1:[function(require,module,exports){
-"use strict";
-
-// constructor
-var Pagehook = function() {
-  this.definitions = {};
-  this.handler = this.handlerUnbound.bind(this);
-};
-
-// constant
-Pagehook.GLOBAL_HOOK_NAME = "@global";
-Pagehook.ATTRIBUTE_NAME = "data-pagehook";
-
-// static methods
-Pagehook.register = function(name_or_map, func) {
-  this.instance.register(name_or_map, func);
-};
-
-Pagehook.dispatch = function(name, arg) {
-  this.instance.dispatch(name, arg);
-};
-
-// Pagehook.register "name", (arg)-> ...
-// // or
-// Pagehoook.register
-//   name: (arg)->
-Pagehook.prototype.register = function(name_or_map, func) {
-  var name;
-
-  if (typeof(name_or_map) === "string") {
-    if (!this.definitions[name_or_map]) {
-      this.definitions[name_or_map] = [];
-    }
-    this.definitions[name_or_map].push(func);
-  } else {
-    for (name in name_or_map) {
-      this.register(name, name_or_map[name]);
-    }
-  }
-};
-
-// Pagehook.dispatch("name", {foo: 1, bar: 2})
-Pagehook.prototype.dispatch = function(name, arg) {
-  if (this.definitions[name]) {
-    this.definitions[name].forEach(function(func) {
-      func(arg);
-    });
-  } else {
-    if (name !== Pagehook.GLOBAL_HOOK_NAME) {
-      console.log("Pagehook for " + name + " is undefined");
-    }
-  }
-};
-
-// Event handler for DOMContentLoaded or turbolinks:load (turbolinks)
-// Use `handler` property instead of this
-Pagehook.prototype.handlerUnbound = function() {
-  var elements, i, e, name, arg;
-
-  this.dispatch(Pagehook.GLOBAL_HOOK_NAME);
-
-  elements = document.querySelectorAll("[" + Pagehook.ATTRIBUTE_NAME + "]");
-  for (i = 0; i < elements.length; i++) {
-    e = elements[i];
-    name = e.getAttribute(Pagehook.ATTRIBUTE_NAME);
-    arg = this.isBlank(e.textContent) ? undefined : JSON.parse(e.textContent);
-    this.dispatch(name, arg);
-  }
-};
-
-Pagehook.prototype.isBlank = function(string) {
-  return !!(string.match(/^\s*$/));
-};
-
-// instanciate singleton object
-Pagehook.instance = new Pagehook();
-Pagehook.handler = Pagehook.instance.handler;
-
-module.exports = Pagehook;
-
-},{}]},{},[1])(1)
-});

data/lib/generators/pagehook/install/templates/pagehook_rails.coffee

@@ -1,7 +0,0 @@
-#= require pagehook_rails/pagehook
-# Register event handler
-if typeof(Turbolinks) == "undefined"
-  document.addEventListener("DOMContentLoaded", Pagehook.handler)
-else
-  document.addEventListener("turbolinks:load", Pagehook.handler)
-  document.addEventListener("page:load", Pagehook.handler)

data/lib/generators/pagehook/templates/hook.coffee.erb

@@ -1,3 +0,0 @@
-#= require pagehook_rails
-Pagehook.register "<%= view_path %>", (data) ->
-  # Your code