patchstream 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 4900b6ac510f622cfeb8ca3433e90dcd84198a3e
+  data.tar.gz: 6d1988cf56a923a0de5166acbe12244bcc978a6f
+SHA512:
+  metadata.gz: 0c5efc756f128186c2898a868c456f5800fa302c188f43deedeb5ca5a07f3279c4b1b3d3e94935c79a2ccaa7c98cf856e68d36723474e022253792c39a1231f2
+  data.tar.gz: e3bbf12c5d8670868f860f49f96f55e3bdfddd1873cf910acb5224690e106a9405d1ff3e94552fbd92e0998d34e7d9d85a6ff81ddeef037fa90e8f74ef3c15b0

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

@@ -0,0 +1,17 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in patchstream.gemspec
+gemspec
+
+group :test do
+	gem 'rspec'
+	gem 'guard', '>= 2.2.4'
+	gem 'guard-rspec'
+	gem 'mocha'
+	gem 'jsondiff'
+	gem 'rails'
+	gem 'rspec-rails'
+	gem 'sqlite3'
+	gem 'timecop'
+	gem 'activeuuid'
+end

data/Guardfile

@@ -0,0 +1,9 @@
+# A sample Guardfile
+# More info at https://github.com/guard/guard#readme
+
+guard :rspec do
+  watch(%r{^spec/.+_spec\.rb$})
+  watch(%r{^lib/(.+)\.rb$})     { |m| "spec/lib/#{m[1]}_spec.rb" }
+  watch('spec/spec_helper.rb')  { "spec" }
+end
+

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 opsb
+
+MIT License
+
+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,59 @@
+# Patchstream
+
+Emits json patches when active records are updated
+
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'patchstream'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install patchstream
+
+## Usage
+
+    class Product
+        include Patchstream
+    end
+
+    stream = [] # anything that responds to <<
+    Product.patch_streams.add(stream)
+
+    product = Product.create name: "Bike", price: 20
+    stream == [
+    	{op: "add", path: "/products/1", value: { 
+    		id: 1, 
+    		name: "Bike", 
+    		price: 20, 
+    		created_at: "2014-06-24T03:19:15.000Z",
+    		updated_at: "2014-06-24T03:19:15.000Z"
+    	}}
+    ]
+    stream.clear
+
+    product.update_attributes name: "Bicycle", price: 30
+    stream == [
+    	{op: "replace", path: "/products/1/name", value: "Bike"},
+    	{op: "replace", path: "/products/1/price", value: 20}
+    ]
+    stream.clear
+
+    product.destroy
+	stream == [
+		{op: "remove", path: "/products/1/name"}
+	]
+
+## Contributing
+
+1. Fork it
+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 @@
+require "bundler/gem_tasks"

data/lib/patchstream.rb

@@ -0,0 +1,92 @@
+require "patchstream/version"
+
+module Patchstream
+	extend ActiveSupport::Concern
+
+	included do
+		around_create PatchStreamCallbacks.new
+		around_update PatchStreamCallbacks.new
+		around_destroy PatchStreamCallbacks.new
+	end
+
+	class PatchStreamCallbacks
+		def around_create(record, &block)
+			record.class.patch_streams.emit_create(record, &block)
+		end
+
+		def around_update(record, &block)
+			record.class.patch_streams.emit_update(record, &block)
+		end
+
+		def around_destroy(record, &block)
+			record.class.patch_streams.emit_destroy(record, &block)
+		end
+	end
+
+	module ClassMethods
+		def patch_streams
+			@patch_streams ||= PatchStreams.new
+		end
+
+		class PatchStreams
+			def add(stream)
+				streams << stream
+			end
+
+			def emit_create(record, &block)
+				emit(build_create_patch(record), &block)
+			end
+
+			def emit_update(record, &block)
+				emit_all(build_update_patches(record), &block)
+			end
+
+			def emit_destroy(record, &block)
+				emit(build_destroy_patch(record), &block)
+			end
+
+			private
+			def build_create_patch(record)
+				{
+					:op => :add, 
+					:path => "/#{record.class.name.tableize}/#{record.id}", 
+					:value => record.changes.inject({}) do |additions, (key, (_, new_value))|
+						additions[key] = new_value.as_json
+						additions
+					end
+				}
+			end
+
+			def build_update_patches(record)
+				record.changes.inject([]) do |changes, (key, (_, new_value))|
+					changes << {
+						:op => :replace,
+						:path => "/#{record.class.name.tableize}/#{record.id}/#{key}",
+						:value => new_value
+					}
+					changes
+				end
+			end	
+
+			def build_destroy_patch(record)
+				{
+					:op => :remove, 
+					:path => "/#{record.class.name.tableize}/#{record.id}"
+				}
+			end
+
+			def streams
+				@streams ||= []
+			end
+
+			def emit(patch)
+				yield if block_given?
+				@streams.each{ |s| s << patch}
+			end
+
+			def emit_all(patches)
+				patches.each{ |patch| emit(patch) }
+			end
+		end
+	end
+end

data/lib/patchstream/version.rb

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

data/patchstream.gemspec

@@ -0,0 +1,23 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'patchstream/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "patchstream"
+  spec.version       = Patchstream::VERSION
+  spec.authors       = ["opsb"]
+  spec.email         = ["oliver@opsb.co.uk"]
+  spec.description   = %q{Emits json patches when active records are updated}
+  spec.summary       = %q{Emits json patches when active records are updated}
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+end

data/spec/dummy/.gitignore

@@ -0,0 +1,16 @@
+# See https://help.github.com/articles/ignoring-files for more about ignoring files.
+#
+# If you find yourself ignoring temporary files generated by your text editor
+# or operating system, you probably want to add a global ignore instead:
+#   git config --global core.excludesfile '~/.gitignore_global'
+
+# Ignore bundler config.
+/.bundle
+
+# Ignore the default SQLite database.
+/db/*.sqlite3
+/db/*.sqlite3-journal
+
+# Ignore all logfiles and tempfiles.
+/log/*.log
+/tmp

data/spec/dummy/Gemfile

@@ -0,0 +1,47 @@
+source 'https://rubygems.org'
+
+# Bundle edge Rails instead: gem 'rails', github: 'rails/rails'
+gem 'rails', '4.0.4'
+
+# Use sqlite3 as the database for Active Record
+gem 'sqlite3'
+
+# Use SCSS for stylesheets
+gem 'sass-rails', '~> 4.0.2'
+
+# Use Uglifier as compressor for JavaScript assets
+gem 'uglifier', '>= 1.3.0'
+
+# Use CoffeeScript for .js.coffee assets and views
+gem 'coffee-rails', '~> 4.0.0'
+
+# See https://github.com/sstephenson/execjs#readme for more supported runtimes
+# gem 'therubyracer', platforms: :ruby
+
+# Use jquery as the JavaScript library
+gem 'jquery-rails'
+
+# Turbolinks makes following links in your web application faster. Read more: https://github.com/rails/turbolinks
+gem 'turbolinks'
+
+# Build JSON APIs with ease. Read more: https://github.com/rails/jbuilder
+gem 'jbuilder', '~> 1.2'
+gem 'activeuuid'
+gem 'patchstream', path: "../../"
+
+group :doc do
+  # bundle exec rake doc:rails generates the API under doc/api.
+  gem 'sdoc', require: false
+end
+
+# Use ActiveModel has_secure_password
+# gem 'bcrypt', '~> 3.1.7'
+
+# Use unicorn as the app server
+# gem 'unicorn'
+
+# Use Capistrano for deployment
+# gem 'capistrano', group: :development
+
+# Use debugger
+# gem 'debugger', group: [:development, :test]

data/spec/dummy/README.rdoc

@@ -0,0 +1,28 @@
+== README
+
+This README would normally document whatever steps are necessary to get the
+application up and running.
+
+Things you may want to cover:
+
+* Ruby version
+
+* System dependencies
+
+* Configuration
+
+* Database creation
+
+* Database initialization
+
+* How to run the test suite
+
+* Services (job queues, cache servers, search engines, etc.)
+
+* Deployment instructions
+
+* ...
+
+
+Please feel free to use a different markup language if you do not plan to run
+<tt>rake doc:app</tt>.

data/spec/dummy/Rakefile

@@ -0,0 +1,6 @@
+# Add your own tasks in files placed in lib/tasks ending in .rake,
+# for example lib/tasks/capistrano.rake, and they will automatically be available to Rake.
+
+require File.expand_path('../config/application', __FILE__)
+
+Dummy::Application.load_tasks

data/spec/dummy/app/assets/javascripts/application.js

@@ -0,0 +1,16 @@
+// This is a manifest file that'll be compiled into application.js, which will include all the files
+// listed below.
+//
+// Any JavaScript/Coffee file within this directory, lib/assets/javascripts, vendor/assets/javascripts,
+// or vendor/assets/javascripts of plugins, if any, can be referenced here using a relative path.
+//
+// It's not advisable to add code directly here, but if you do, it'll appear at the bottom of the
+// compiled file.
+//
+// Read Sprockets README (https://github.com/sstephenson/sprockets#sprockets-directives) for details
+// about supported directives.
+//
+//= require jquery
+//= require jquery_ujs
+//= require turbolinks
+//= require_tree .

data/spec/dummy/app/assets/stylesheets/application.css

@@ -0,0 +1,13 @@
+/*
+ * This is a manifest file that'll be compiled into application.css, which will include all the files
+ * listed below.
+ *
+ * Any CSS and SCSS file within this directory, lib/assets/stylesheets, vendor/assets/stylesheets,
+ * or vendor/assets/stylesheets of plugins, if any, can be referenced here using a relative path.
+ *
+ * You're free to add application-wide styles to this file and they'll appear at the top of the
+ * compiled file, but it's generally better to create a new file per style scope.
+ *
+ *= require_self
+ *= require_tree .
+ */

data/spec/dummy/app/controllers/application_controller.rb

@@ -0,0 +1,5 @@
+class ApplicationController < ActionController::Base
+  # Prevent CSRF attacks by raising an exception.
+  # For APIs, you may want to use :null_session instead.
+  protect_from_forgery with: :exception
+end

data/spec/dummy/app/helpers/application_helper.rb

@@ -0,0 +1,2 @@
+module ApplicationHelper
+end

data/spec/dummy/app/models/product.rb

@@ -0,0 +1,4 @@
+class Product < ActiveRecord::Base
+	include ActiveUUID::UUID
+	include Patchstream
+end

data/spec/dummy/app/views/layouts/application.html.erb

@@ -0,0 +1,14 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title>Dummy</title>
+  <%= stylesheet_link_tag    "application", media: "all", "data-turbolinks-track" => true %>
+  <%= javascript_include_tag "application", "data-turbolinks-track" => true %>
+  <%= csrf_meta_tags %>
+</head>
+<body>
+
+<%= yield %>
+
+</body>
+</html>

data/spec/dummy/bin/bundle

@@ -0,0 +1,3 @@
+#!/usr/bin/env ruby
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path('../../Gemfile', __FILE__)
+load Gem.bin_path('bundler', 'bundle')