piper 0.0.2 → 3.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: cc3741d101dc8595741550217d9f75380cabe893
+  data.tar.gz: 461c22041159c6ab6931ad0e2b46b5fcee44e031
+SHA512:
+  metadata.gz: 0a37af6c807058ffff32d00e48104aab49916b45e13139d85768c3d7990c5b0faf5310aae0d3477c4527c75c8417c3a86d1542d7b74b0f6c46e692af7c64df36
+  data.tar.gz: ed2f9067d521b85e5f9903febd3731dfb55a74a6fbaa874a87dc82a4d2f43219f41926c3aa8fc94ae60ccedfb69d38e83517d09f0eb7fc7f141ca38fceeb9266

data/.gitignore

@@ -1,4 +1,14 @@
-*.gem
+.DS_Store
 .bundle
-Gemfile.lock
+.idea
 pkg/*
+
+*.lock
+spec/internal/.bundle
+spec/internal/db/*.sqlite3
+spec/internal/log/*.log
+spec/internal/tmp/**/*
+
+.rvmrc
+coverage
+tmp

data/README.md

@@ -0,0 +1,54 @@
+[![License](https://img.shields.io/badge/license-MIT-green.svg)](http://opensource.org/licenses/MIT)
+
+Are you web pages composed of many rails partials? Wouldn't it be cool if the partials can be told to refresh itself?
+
+This gem introduces a jquery method `.reload()`, when executed, pulls a fresh copy of the partial and renders it inside the div.
+
+![demo](https://raw.githubusercontent.com/oystersauce8/piper/master/piper_demo.gif)
+
+This, combined with [Server Generated Javacript Responses](https://signalvnoise.com/posts/3697-server-generated-javascript-responses) gives your app SPA (Single Page App) like benefits, without the added complexity of a client-side JavaScript framework
+
+To install, add this to your Gemfile
+
+    gem "piper"
+
+After that, specify the use of the jquery and best in place javascripts in your application.js
+
+    //= require piper
+
+
+To make use of this gem, use `<%= render_cell %>` instead of `<%= render partial:`  This wraps the rendered partial in a div, and that div gets locals metadata embeded in it as a `data-piper` attribute.
+
+![render](https://raw.githubusercontent.com/oystersauce8/piper/master/render.png)
+
+`render_cell` also expects an addditional argument, called container, which serves as the jquery selector, so if you pass *container: 'foo'* your resulting javascript command becomes `$('.foo').reload()`
+
+Also remember to pass locals literally like this
+
+    locals: '{ var1: "abc", var2: Blog.first }'  # single quotes!
+
+This means we're "passing by reference".
+
+You will also need to add this route
+
+    get '/partial' => 'piper/partials#show'
+
+
+### Prereqs
+
+Assumes jquery-ui has been installed in the rails app.
+
+
+### Authors, License and Stuff
+
+MIT license.
+Many thanks to best_in_place project on github. I borrowed quite a few ideas from it.
+
+
+
+
+
+
+
+
+

data/app/controllers/piper/partials_controller.rb

@@ -0,0 +1,11 @@
+module Piper
+  class PartialsController < ApplicationController
+    def show
+      name, locals = Piper::Encoding::decode(params[:data])
+      render partial: name, locals: eval(locals)
+    end
+
+
+  end
+
+end

data/app/views/_wrapper.html.erb

@@ -0,0 +1,6 @@
+<div
+  class="<%=metadata[:container]%>"
+  data-piper="<%= Piper::Encoding::encode(metadata[:name],metadata[:locals]) %>"
+>
+  <%= yield %>
+</div>

data/lib/assets/javascripts/piper.js

@@ -0,0 +1,15 @@
+/*
+ *
+ * @requires jQuery
+ *
+ */
+
+jQuery.fn.reload = function () {
+    var that = this;
+    $.getJSON( '/partial?'+
+               'data=' + $(this).data('piper')
+    ).complete( function(data) {
+        $(that).html(data.responseText);
+        $(that).toggle( "clip" ).toggle( "clip" );
+    });
+};

data/lib/piper.rb

@@ -1,119 +1,11 @@
+require 'rails/railtie'
+require 'action_view/railtie'
+require 'action_controller/railtie'
 
-class Piper
-  DestinyNotYetChosenException = Class.new(Exception)
-  CannotWriteToReaderException = Class.new(Exception)
-  CannotReadFromWriterException = Class.new(Exception)
-
-  def initialize
-    @readpipe, @writepipe = IO.pipe
-  end
-
-  def destiny_chosen?
-    !(@writer.nil? && @reader.nil?)
-  end
-
-  def writer!
-    if !destiny_chosen?
-      @writer = true
-      @readpipe.close
-    end
-  end
-
-  def reader!
-    if !destiny_chosen?
-      @reader = true
-      @writepipe.close
-    end
-  end
-
-  def writer?
-    !!@writer
-  end
-
-  def reader?
-    !!@reader
-  end
-
-  def <<(obj)
-    raise CannotWriteToReader if reader?
-
-    # Force writer
-    writer!
-
-    dump wrap(obj)
-  end
-
-  def close
-    dump :close => true if writer?
-  end
-
-  def load
-    raise CannotReadFromWriterException if writer?
-
-    # Force reader
-    reader!
-
-    Marshal.load(@readpipe)
-  end
-
-  def raw
-    raise DestinyNotYetChosenException if !destiny_chosen?
-
-    reader? ? @readpipe : @writepipe
-  end
-
-  protected
-
-  def dump(obj)
-    Marshal.dump(obj, @writepipe)
-  end
-
-  def wrap(obj)
-    {:object => obj}
-  end
-
-  class << self
-    def receive(*pipes)
-      open_pipes = [*pipes]
-
-      # Force all pipes to be readers
-      open_pipes.each {|p| p.reader! }
-
-      pipes_by_raw_read_pipe = {}
-      open_pipes.each do |p|
-        pipes_by_raw_read_pipe[p.raw] = p
-      end
-
-      loop do
-        ready = IO.select(open_pipes.map {|p| p.raw }, nil, nil, nil)
-
-        # Should always be ready, but if not, somehow it
-        # timed out. Throw error
-        if !ready
-          raise Exception
-        else
-          ready_pipes = ready[0].select {|p|
-            !p.eof?
-          }.map {|raw_pipe|
-            pipes_by_raw_read_pipe[raw_pipe]
-          }
-
-          ready_pipes.each do |pipe|
-            wrapper = pipe.load
-
-            if wrapper[:close]
-              pipes_by_raw_read_pipe.delete(pipe.raw)
-
-              open_pipes.delete(pipe)
-              return if open_pipes.empty?
-            else
-              object = wrapper.delete :object
-              yield(object)
-            end
-          end
-        end
-      end
-    end
-  end
+module Piper
 end
 
+require 'piper/engine'
+require 'piper/helper'
+require 'piper/railtie'
+require 'piper/encoding'

data/lib/piper/encoding.rb

@@ -0,0 +1,16 @@
+module Piper
+  module Encoding
+
+    def self.encode(name,locals)
+      verifier = ActiveSupport::MessageVerifier.new( Rails.application.secrets[:secret_key_base] )
+      verifier.generate("#{name};#{locals}")
+    end
+
+    def self.decode(arg)
+      verifier = ActiveSupport::MessageVerifier.new( Rails.application.secrets[:secret_key_base] )
+      verifier.verify(arg).split(';')
+    end
+
+
+  end
+end

data/lib/piper/engine.rb

@@ -0,0 +1,7 @@
+module Piper
+  class Engine < Rails::Engine
+    initializer 'piper' do
+      ActionView::Base.send(:include, Piper::Helper)
+    end
+  end
+end

data/lib/piper/helper.rb

@@ -0,0 +1,15 @@
+module Piper
+  module Helper
+    def render_cell(name,locals:,container:)
+      render partial: name,             
+             locals: eval(locals).merge({
+                        metadata: {
+                          :container => container,
+                          :name => name,
+                          :locals => locals
+                      }}),             
+             layout: "/wrapper"
+    end
+
+  end
+end

data/lib/piper/railtie.rb

@@ -0,0 +1,10 @@
+require 'rails/railtie'
+require 'action_view/base'
+
+module Piper
+  class Railtie < ::Rails::Railtie #:nodoc:
+    config.after_initialize do
+      Piper::ViewHelpers = ActionView::Base.new
+    end
+  end
+end

data/lib/piper/version.rb

@@ -1,4 +1,3 @@
-class Piper
-  VERSION = "0.0.2"
+module Piper
+  VERSION = '3.1.1'
 end
-

data/piper.gemspec

@@ -1,21 +1,27 @@
 # -*- encoding: utf-8 -*-
 $:.push File.expand_path("../lib", __FILE__)
-require "piper/version"
+require 'piper/version'
 
 Gem::Specification.new do |s|
   s.name        = "piper"
   s.version     = Piper::VERSION
   s.platform    = Gem::Platform::RUBY
-  s.authors     = ["Justin Camerer"]
-  s.email       = ["iamjwc@gmail.com"]
-  s.homepage    = "http://github.com/iamjwc/piper"
-  s.summary     = %q{Wrapper around IO.pipe to allow easier communication between multiple processes.}
-  s.description = %q{Check the summary.}
-
-  s.rubyforge_project = "piper"
+  s.authors     = ["Sam Weerasinghr"]
+  s.email       = ["oystersauce8@gmail.com"]
+  s.homepage    = "http://www.github.com/oystersauce8/piper"
+  s.summary     = <<SUM
+    Spice up your vanilla rails app with some SPA like benefits
+SUM
+  s.description = <<DESC
+    Spice up your vanilla rails app with some SPA like benefits without the added complexity of a client-side JavaScript framework. From within javascript, there is no straightforward way (at least I'm aware of) to invalidate/reload a partial. Articles describing techniques such as this one have been around for some time now. This gem builds on techniques such as that one, and allows you to reload partials by following a few simple conventions.
+DESC
 
   s.files         = `git ls-files`.split("\n")
-  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.test_files    = `git ls-files -- {spec}/*`.split("\n")
   s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
   s.require_paths = ["lib"]
+
+  s.add_runtime_dependency 'actionpack', '>= 3.2'
+  s.add_runtime_dependency 'railties', '>= 3.2'
+
 end

metadata

@@ -1,77 +1,86 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: piper
-version: !ruby/object:Gem::Version 
-  hash: 27
-  prerelease: 
-  segments: 
-  - 0
-  - 0
-  - 2
-  version: 0.0.2
+version: !ruby/object:Gem::Version
+  version: 3.1.1
 platform: ruby
-authors: 
-- Justin Camerer
+authors:
+- Sam Weerasinghr
 autorequire: 
 bindir: bin
 cert_chain: []
-
-date: 2011-05-12 00:00:00 -04:00
-default_executable: 
-dependencies: []
-
-description: Check the summary.
-email: 
-- iamjwc@gmail.com
+date: 2017-10-14 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: actionpack
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '3.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '3.2'
+- !ruby/object:Gem::Dependency
+  name: railties
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '3.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '3.2'
+description: |2
+      Spice up your vanilla rails app with some SPA like benefits without the added complexity of a client-side JavaScript framework. From within javascript, there is no straightforward way (at least I'm aware of) to invalidate/reload a partial. Articles describing techniques such as this one have been around for some time now. This gem builds on techniques such as that one, and allows you to reload partials by following a few simple conventions.
+email:
+- oystersauce8@gmail.com
 executables: []
-
 extensions: []
-
 extra_rdoc_files: []
-
-files: 
+files:
 - .gitignore
-- .rspec
-- Gemfile
-- Rakefile
+- README.md
+- app/controllers/piper/partials_controller.rb
+- app/views/_wrapper.html.erb
+- lib/assets/javascripts/piper.js
 - lib/piper.rb
+- lib/piper/encoding.rb
+- lib/piper/engine.rb
+- lib/piper/helper.rb
+- lib/piper/railtie.rb
 - lib/piper/version.rb
 - piper.gemspec
-- spec/lib/piper_spec.rb
-- spec/spec_helper.rb
-has_rdoc: true
-homepage: http://github.com/iamjwc/piper
+- piper_demo.gif
+- render.png
+homepage: http://www.github.com/oystersauce8/piper
 licenses: []
-
+metadata: {}
 post_install_message: 
 rdoc_options: []
-
-require_paths: 
+require_paths:
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement 
-  none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      hash: 3
-      segments: 
-      - 0
-      version: "0"
-required_rubygems_version: !ruby/object:Gem::Requirement 
-  none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      hash: 3
-      segments: 
-      - 0
-      version: "0"
+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: piper
-rubygems_version: 1.4.2
+rubyforge_project: 
+rubygems_version: 2.0.14.1
 signing_key: 
-specification_version: 3
-summary: Wrapper around IO.pipe to allow easier communication between multiple processes.
-test_files: 
-- spec/lib/piper_spec.rb
-- spec/spec_helper.rb
+specification_version: 4
+summary: Spice up your vanilla rails app with some SPA like benefits
+test_files: []

data/.rspec

@@ -1,2 +0,0 @@
---colour
-

data/Gemfile

@@ -1,9 +0,0 @@
-source "http://rubygems.org"
-
-# Specify your gem's dependencies in piper.gemspec
-gemspec
-
-group :test do
-  gem "rspec"
-end
-

data/Rakefile

@@ -1,2 +0,0 @@
-require 'bundler'
-Bundler::GemHelper.install_tasks

data/spec/lib/piper_spec.rb

@@ -1,32 +0,0 @@
-require File.expand_path("../../spec_helper", __FILE__)
-
-describe Piper do
-  it "should be able to send a message between two processes" do
-    send_to_child("hi").should == "hi"
-  end
-
-  it "should be able to send all different types of objects" do
-    send_to_child(:hey).should == :hey
-    send_to_child(1).should == 1
-    send_to_child(1.3).should == 1.3
-    send_to_child([1,2,3]).should == [1,2,3]
-  end
-
-  it "should use a special message when sending" do
-    send_to_child(:close).should == :close
-  end
-
-  def send_to_child(message)
-    p = Piper.new
-
-    if fork
-      m = nil
-      Piper.receive(p) {|message| m = message }
-      m
-    else
-      p << message
-      p.close
-      exit!
-    end
-  end
-end

data/spec/spec_helper.rb

@@ -1,5 +0,0 @@
-Bundler.setup(:test)
-require 'rspec'
-
-require File.expand_path(File.dirname(__FILE__)+'/../lib/piper')
-