celluloid-io-pg-listener 0.2.0 → 0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 6b32bda94c9d7c0caa12e0eb1ffe874e2e71fff0
-  data.tar.gz: b81a26d47347897cb829fd411fc672991d2cfec7
+  metadata.gz: 20bb2e2002bda41c462c15c5ab299defb1b63758
+  data.tar.gz: 30afe775d53c72343dcc331dec3059b0592fb6be
 SHA512:
-  metadata.gz: 3af82bdda3b7154ddf349813da7bffb2a355aebe42cb22f05c57404db242c6557c13e177b05e30337bae2bc459d2eb970aecf82be3bd18476f0ffcb8e87f5700
-  data.tar.gz: ea6c3423da0866304ad84cba117f31ff82a1d4aa5a7e104bb9fbd091f738ad8b5ff418ab483a5eff58a7b76de718981d23a650172b35cb3fd50e06504574f8c3
+  metadata.gz: c83597eb06762c5a0f0b56a4e0565cb6892e82a8f73723972c7994b59c7164057106434b12a0d4cbf4257c831701c339ec739a92fe7dd37411718b686d665055
+  data.tar.gz: cf1fd392c57d3d48de25797a3b22e4fe0e9e2645a0261484f97d319758980db100908c6c2d86f0330a86200346a30c20572b3b5dd279945826e71e6c3fe97709

data/.codeclimate.yml

@@ -0,0 +1,11 @@
+engines:
+  rubocop:
+    enabled: true
+  bundler-audit:
+    enabled: false
+ratings:
+  paths:
+  - "**.rb"
+  - Gemfile.lock
+exclude_paths:
+- spec/**/*

data/.gitignore

@@ -9,3 +9,4 @@
 /tmp/
 .ruby-gemset
 .ruby-version
+/spec/apps/log

data/.travis.yml

@@ -10,3 +10,5 @@ script: "bundle exec rspec spec"
 gemfile:
   - gemfiles/rails_4.2.4.gemfile
   - gemfiles/rails_3.2.22.gemfile
+addons:
+  postgresql: "9.4" # json_build_object was introduced in 9.4

data/README.md

@@ -2,9 +2,8 @@
 
 Simple way to NOTIFY and LISTEN to channels in PostgreSQL
 
-The goal is to integrate the listener client with a Rails project, and that is underway in the spec/ folder, but as yet unfinished.  Standalone the listener client works great.
-
-Inspired by https://gist.github.com/tpitale/3915671
+Standalone the listener client works great in an `irb` session.
+Real-world, practical, use requires a long running process, and for an example of that see [bin/supervisor](https://github.com/pboling/celluloid-io-pg-listener/blob/master/bin/supervisor)
 
 | Project                 |  Celluloid IO PG Listener   |
 |------------------------ | ----------------- |
@@ -22,6 +21,19 @@ Inspired by https://gist.github.com/tpitale/3915671
 | author                  |  [Peter Boling](https://coderbits.com/pboling) |
 | Spread ~♡ⓛⓞⓥⓔ♡~      |  [![Endorse Me](https://api.coderwall.com/pboling/endorsecount.png)](http://coderwall.com/pboling) |
 
+## Prerequisites
+
+Compatible with Ruby 2.1+, and tested on Travis.  Might also be compatible with Ruby 2.0, but haven't had time or inclination to find out. That's why we have a fork button!
+
+Requires Celluloid greater than 0.17.2 because that release fixed an important memory leak in Celluloid.
+```
+gem "celluloid", ">= 0.17.2"
+```
+
+Currently requires pg gem v0.18.3 or greater, but really that's only because I haven't had time to test with older versions.  Feel free to do that and send a PR.
+```
+gem "pg", ">= 0.18.3"
+```
 
 ## Installation
 
@@ -166,6 +178,14 @@ module CelluloidIOPGListener
 end
 ```
 
+## Credits
+
+Written by Peter Boling for [Trumaker & Co](https://www.trumaker.com/)
+
+Inspired by:
+* https://gist.github.com/tpitale/3915671
+* https://blog.andyet.com/2015/04/06/postgres-pubsub-with-json
+
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies, and setup the test environment, including creating a role and a database. Then, run `appraisal rake` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
@@ -217,7 +237,7 @@ dependency on this gem using the [Pessimistic Version Constraint][pvc] with two
 For example:
 
 ```ruby
-spec.add_dependency 'celluloid-io-pg-listener', '~> 0.1'
+spec.add_dependency 'celluloid-io-pg-listener', '~> 0.2'
 ```
 
 ## License

data/bin/setup

@@ -14,6 +14,7 @@ fi
 psql -f bin/setup.sql -U $puser
 echo "Setup Role foss"
 psql -U $puser << EOF
+DROP DATABASE IF EXISTS celluloid_io_pg_listener_test;
 CREATE DATABASE celluloid_io_pg_listener_test;
 ALTER DATABASE celluloid_io_pg_listener_test OWNER TO "foss";
 EOF

data/lib/celluloid-io-pg-listener.rb

@@ -10,7 +10,7 @@ require "celluloid-io-pg-listener/initialization/client_extracted_signature"
 require "celluloid-io-pg-listener/initialization/argument_extraction"
 require "celluloid-io-pg-listener/initialization/async_listener"
 require "celluloid-io-pg-listener/client"
-# Require manually, if you want to try them out.
+# Require manually, as in bin/console, if you want to try them out.
 # require "celluloid-io-pg-listener/examples/client"
 # require "celluloid-io-pg-listener/examples/server"
 # require "celluloid-io-pg-listener/examples/listener_client_by_inheritance"

data/lib/celluloid-io-pg-listener/client.rb

@@ -36,13 +36,13 @@ module CelluloidIOPGListener
       @pg_connection ||= PG.connect(conninfo_hash)
     end
 
-    def notify(channel, value)
-      pg_connection.exec("NOTIFY #{channel}, '#{value}';")
-    end
-
+    # Supported channel names are any delimited (double-quoted) identifier:
+    # We supply the double quotes, you supply the contents.
+    # If you want unicode character code support submit a pull request to make the quote style `U&"` a config setting.
+    #   See: http://www.postgresql.org/docs/9.4/static/sql-syntax-lexical.html
     def listen(channel, action)
       actions[channel] = action
-      pg_connection.exec("LISTEN #{channel}")
+      pg_connection.exec(%[LISTEN "#{channel}";])
     end
 
     def start_listening
@@ -77,7 +77,7 @@ module CelluloidIOPGListener
     def unlisten(channel)
       # (@listening ||= {})[channel] = false
       stop_listening # Not sure if there is a way to stop listening to a single channel without affecting the others.
-      pg_connection.exec("UNLISTEN #{channel}")
+      pg_connection.exec(%[UNLISTEN "#{channel}";])
     end
 
   end

data/lib/celluloid-io-pg-listener/examples/server.rb

@@ -42,8 +42,12 @@ module CelluloidIOPGListener
         @pg_connection ||= PG.connect(conninfo_hash)
       end
 
+      # Supported channel names are any delimited (double-quoted) identifier:
+      # We supply the double quotes, you supply the contents.
+      # If you want unicode character code support submit a pull request to make the quote style `U&"` a config setting.
+      #   See: http://www.postgresql.org/docs/9.4/static/sql-syntax-lexical.html
       def notify(channel, value)
-        pg_connection.exec("NOTIFY #{channel}, '#{value}';")
+        pg_connection.exec(%[NOTIFY "#{channel}", '#{value}';])
       end
 
     end

data/lib/celluloid-io-pg-listener/initialization/argument_extraction.rb

@@ -1,7 +1,7 @@
 module CelluloidIOPGListener
   # Prepended to classes including the CelluloidIOPGListener::Client
-  # Takes the arguments relevant to the CelluloidIOPGListener::Client module
-  #   and extracts it leaving the rest of the arguments to be passed to the
+  # Extracts the arguments relevant to the CelluloidIOPGListener::Client module
+  # Leaves the rest of the arguments to be passed to the
   #   initializer of classes including the CelluloidIOPGListener::Client
   module Initialization
     module ArgumentExtraction
@@ -9,11 +9,6 @@ module CelluloidIOPGListener
       # 1st initialize override invoked
       def initialize(*args)
         @client_extracted_signature = CelluloidIOPGListener::Initialization::ClientExtractedSignature.new(*args)
-        # When called from a sub-class of a class including Client
-        #   and the sub-class overrides initialize,
-        #   then the execution order changes,
-        #   and this method may no longer have a super.
-        # However, due to the nature of the initialize method we can't tell if we have a legitimate super or not.
         super(*@client_extracted_signature.super_signature)
       end
 

data/lib/celluloid-io-pg-listener/version.rb

@@ -1,3 +1,3 @@
 module CelluloidIOPGListener
-  VERSION = "0.2.0"
+  VERSION = "0.2.1"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: celluloid-io-pg-listener
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.2.1
 platform: ruby
 authors:
 - Peter Boling
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2015-10-15 00:00:00.000000000 Z
+date: 2015-10-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: celluloid-io
@@ -172,6 +172,7 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".codeclimate.yml"
 - ".gitignore"
 - ".rspec"
 - ".travis.yml"
@@ -221,7 +222,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.8
+rubygems_version: 2.4.5.1
 signing_key: 
 specification_version: 4
 summary: Asynchronously LISTEN for Postgresql NOTIFY messages with payloads and Do