pagehook-rails 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: f1fb9f17ca1a217f7f7d7d2a0aca524fb4a05773
+  data.tar.gz: 032173384668bb9ed8e87411f4db844009066663
+SHA512:
+  metadata.gz: e996a512a9d6e966416ef19ef3f088afac00a3d75aa48958080eb36c9b5bb2235790515373741165360ec6d40c8e70aa2c8fcbfb61ed68d84cdbed2575be045a
+  data.tar.gz: 66bae609658cc2f0d74684c635de547750c66719fabf3d02026b84e8c3f06bfbccb39d21c4077fb22498c310a5862fe44e4be4323e726ac7c3ccfcb5b82aaeb8

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2014 labocho
+
+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,60 @@
+pagehook-rails
+====================
+
+pagehook-rails is Ruby on Rails plugin integrates [Pagehook](https://github.com/labocho/pagehook).
+
+
+Installation
+--------------------
+
+Add this line to your Rails application's Gemfile:
+
+    gem "pagehook-rails"
+
+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`.
+
+
+View helper
+--------------------
+
+`pagehook` view helper method generates "trigger element".
+
+    <%= pagehook("articles/index", id: 123) %>
+
+This generates following HTML.
+
+    <script type="application/json" data-pagehook="articles/index">{"id":123}</script>
+
+
+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
+    });
+
+
+You can also do `rails g pagehook path/to/view --lang coffee` to generate .coffee rather than .js.
+
+
+Contributing
+--------------------
+
+1. Fork it ( http://github.com/labocho/pagehook-rails/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request
+

data/Rakefile

@@ -0,0 +1,40 @@
+#!/usr/bin/env rake
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+begin
+  require 'rdoc/task'
+rescue LoadError
+  require 'rdoc/rdoc'
+  require 'rake/rdoctask'
+  RDoc::Task = Rake::RDocTask
+end
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'PagehookRails'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+APP_RAKEFILE = File.expand_path("../spec/dummy/Rakefile", __FILE__)
+load 'rails/tasks/engine.rake'
+
+
+
+Bundler::GemHelper.install_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/assets/javascripts/pagehook_rails/pagehook.js

@@ -0,0 +1,88 @@
+(function() {
+  var Pagehook,
+    __slice = [].slice;
+
+  this.Pagehook = Pagehook = (function() {
+    Pagehook.GLOBAL_HOOK_NAME = "@global";
+
+    Pagehook.ATTRIBUTE_NAME = "data-pagehook";
+
+    Pagehook.register = function() {
+      var args, _ref;
+      args = 1 <= arguments.length ? __slice.call(arguments, 0) : [];
+      return (_ref = this.instance).register.apply(_ref, args);
+    };
+
+    Pagehook.dispatch = function() {
+      var args, _ref;
+      args = 1 <= arguments.length ? __slice.call(arguments, 0) : [];
+      return (_ref = this.instance).dispatch.apply(_ref, args);
+    };
+
+    function Pagehook() {
+      this.definitions = [];
+      this.handler = (function(_this) {
+        return function() {
+          return _this.handlerUnbound();
+        };
+      })(this);
+    }
+
+    Pagehook.prototype.register = function(name_or_map, func) {
+      var name, _results;
+      if (typeof name_or_map === "string") {
+        return this.definitions.push([name_or_map, func]);
+      } else {
+        _results = [];
+        for (name in name_or_map) {
+          func = name_or_map[name];
+          _results.push(this.definitions.push([name, func]));
+        }
+        return _results;
+      }
+    };
+
+    Pagehook.prototype.dispatch = function(name, params) {
+      var func, registered, _i, _len, _ref, _ref1, _results;
+      _ref = this.definitions;
+      _results = [];
+      for (_i = 0, _len = _ref.length; _i < _len; _i++) {
+        _ref1 = _ref[_i], registered = _ref1[0], func = _ref1[1];
+        if (registered === name) {
+          _results.push(func(params));
+        } else {
+          _results.push(void 0);
+        }
+      }
+      return _results;
+    };
+
+    Pagehook.prototype.handlerUnbound = function() {
+      var args, e, name, _i, _len, _ref, _results;
+      this.dispatch(Pagehook.GLOBAL_HOOK_NAME);
+      _ref = document.querySelectorAll("[" + Pagehook.ATTRIBUTE_NAME + "]");
+      _results = [];
+      for (_i = 0, _len = _ref.length; _i < _len; _i++) {
+        e = _ref[_i];
+        name = e.getAttribute(Pagehook.ATTRIBUTE_NAME);
+        args = this.isBlank(e.textContent) ? void 0 : JSON.parse(e.textContent);
+        _results.push(this.dispatch(name, args));
+      }
+      return _results;
+    };
+
+    Pagehook.prototype.isBlank = function(string) {
+      return !!(string.match(/^\s*$/));
+    };
+
+    return Pagehook;
+
+  })();
+
+  this.Pagehook.instance = new Pagehook();
+
+  this.Pagehook.handler = this.Pagehook.instance.handler;
+
+}).call(this);
+
+//# sourceMappingURL=pagehook.js.map

data/app/helpers/pagehook_rails/pagehook_helper.rb

@@ -0,0 +1,18 @@
+module PagehookRails
+  module PagehookHelper
+    # <%= pagehook("articles/show", id: 123) %>
+    # makes
+    # <script type="application/json" data-pagehook-name="articles/show">{"id": 123}</script>
+    def pagehook(name, data = {})
+      data_json = PagehookRails::PagehookHelper.escape_json(data.to_json)
+      content_tag(:script, data_json, type: "application/json", "data-pagehook" => name)
+    end
+
+    # convert html special characters to \uhhhh form
+    def self.escape_json(json)
+      json.gsub(/[\u2028\u2029><&]/u) {|s|
+        "\\u#{s.ord.to_s(16).rjust(4, "0")}"
+      }.html_safe
+    end
+  end
+end

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

@@ -0,0 +1,17 @@
+module Pagehook
+  class InstallGenerator < Rails::Generators::Base
+    source_root File.expand_path("../templates", __FILE__)
+    class_option :lang, type: :string, default: "js"
+
+    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"
+      else
+        raise "Unknown language: #{lang}"
+      end
+    end
+  end
+end

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

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

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

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

data/lib/generators/pagehook/pagehook_generator.rb

@@ -0,0 +1,20 @@
+class PagehookGenerator < Rails::Generators::NamedBase
+  source_root File.expand_path("../templates", __FILE__)
+  class_option :lang, type: :string, default: "js"
+
+  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"
+    else
+      raise "Unknown language: #{lang}"
+    end
+  end
+
+  private
+  def view_path
+    file_path.gsub(/\..+/, "")
+  end
+end

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

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

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

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

data/lib/pagehook-rails.rb

@@ -0,0 +1,4 @@
+require "pagehook-rails/engine"
+
+module PagehookRails
+end

data/lib/pagehook-rails/engine.rb

@@ -0,0 +1,11 @@
+module PagehookRails
+  class Engine < ::Rails::Engine
+    isolate_namespace PagehookRails
+
+    initializer "pagehook-rails.action_controller" do |app|
+      ActiveSupport.on_load :action_controller do
+        helper PagehookRails::PagehookHelper
+      end
+    end
+  end
+end

data/lib/pagehook-rails/version.rb

@@ -0,0 +1,3 @@
+module PagehookRails
+  VERSION = "0.0.1"
+end

metadata

@@ -0,0 +1,113 @@
+--- !ruby/object:Gem::Specification
+name: pagehook-rails
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- labocho
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-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.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.1'
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  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'
+- !ruby/object:Gem::Dependency
+  name: rspec-rails
+  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'
+- !ruby/object:Gem::Dependency
+  name: nokogiri
+  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: Rails plugin integrates Pagehook (https://github.com/labocho/pagehook)
+email:
+- labocho@penguinlab.jp
+executables: []
+extensions: []
+extra_rdoc_files: []
+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/pagehook_rails.js
+- lib/generators/pagehook/pagehook_generator.rb
+- lib/generators/pagehook/templates/hook.coffee.erb
+- lib/generators/pagehook/templates/hook.js.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: 
+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.2.0
+signing_key: 
+specification_version: 4
+summary: Rails plugin integrates Pagehook (https://github.com/labocho/pagehook)
+test_files: []