act_as_backdrop 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 84c7e2be7f550dd3ba1850051f52acaa3d27b974
+  data.tar.gz: f6d685eca8fbe179a3256bb3f027b02a2d6df01f
+SHA512:
+  metadata.gz: 0e8dacbdb9ffacc549785674ebf4f293fecad28d04156e15f07d2ae620d4a8ee2bdbe6cd11d55a64594676b0cffc0c359f4be511f286943f360ada2a73ad7e10
+  data.tar.gz: fc9d356a5f176cc704ee9c1291d263563123a6fdf3cd03f90318a5bb7ab28e8fd3a48b777e31f9c3966688018a6b298515849affb5336f80e572ace405d2090d

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2015 Grigoriy Dobryakov
+
+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.markdown

@@ -0,0 +1,37 @@
+acts_as_backdrop
+----------------
+
+This gem allows you to write async processing code to your models right into your models code.
+
+Example
+-------
+
+    class Something < ActiveRecord::Base
+      acts_as_backdrop
+
+      def backdrop_process(message)
+
+        # example that you receive:
+        # { "class"=>"Something",
+        #   "gid"=>"gid://dummy/Something/1",
+        #   "changes"=>{"title"=>[nil, "abc"],
+        #   "created_at"=>[nil, "2015-12-17T20:28:52.307Z"],
+        #   "updated_at"=>[nil, "2015-12-17T20:28:52.307Z"],
+        #   "id"=>[nil, 1]} }
+
+      end
+
+    end
+
+Why
+---
+
+Because you might need to process some data *after* the model is saved, asynchronously.
+
+How it works
+------------
+
+When your model instance saved (on after_save callback), the model itself and it's changes published to async job queue as usual DelayedJob.
+The special worker (BackdropJob class) will process this message and will trigger your 'backdrop_process' method inside your model.
+
+You receive full information about model changes, and can process it as you wish.

data/Rakefile

@@ -0,0 +1,34 @@
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+require 'rdoc/task'
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'Backdrop'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.markdown')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+
+
+
+
+
+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/lib/backdrop.rb

@@ -0,0 +1,22 @@
+require 'backdrop/act_as_backdrop'
+require 'backdrop/backdrop_job'
+
+module Backdrop
+  class Event
+    def self.publish(payload)
+
+      klass   = payload[:model].class.to_s
+      gid     = payload[:model].to_global_id.to_s
+      changes = payload[:changes]
+
+      message = {
+        class:   klass,
+        gid:     gid,
+        changes: changes
+      }
+
+      BackdropJob.perform_later message.to_json
+
+    end
+  end
+end

data/lib/backdrop/act_as_backdrop.rb

@@ -0,0 +1,26 @@
+module Backdrop
+  module ActAsBackdrop
+
+    extend ActiveSupport::Concern
+
+    included do
+      after_save :acts_as_backdrop
+    end
+
+    module ClassMethods
+      def acts_as_backdrop(options = {})
+        include Backdrop::ActAsBackdrop::LocalInstanceMethods
+      end
+    end
+
+    module LocalInstanceMethods
+      def acts_as_backdrop(options = {})
+        changes = self.previous_changes
+        Backdrop::Event.publish model: self, changes: changes
+      end
+    end
+
+  end
+end
+
+ActiveRecord::Base.include(Backdrop::ActAsBackdrop)

data/lib/backdrop/backdrop_job.rb

@@ -0,0 +1,11 @@
+class BackdropJob < ActiveJob::Base
+
+  queue_as :default
+
+  def perform(message_json)
+    message = JSON.parse(message_json)
+    model   = GlobalID::Locator.locate message['gid']
+    model.send(:backdrop_process, message) if model.present? && model.respond_to?(:backdrop_process)
+  end
+
+end

data/lib/backdrop/version.rb

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

data/lib/tasks/backdrop_tasks.rake

@@ -0,0 +1,4 @@
+# desc "Explaining what the task does"
+# task :backdrop do
+#   # Task goes here
+# end

data/test/act_as_backdrop_test.rb

@@ -0,0 +1,25 @@
+
+require 'test_helper'
+
+class ActAsBackdropTest < ActiveSupport::TestCase
+
+  def test_model_act_as_backdrop
+
+    model = Something.new
+    model.save
+
+    model.title = 'abc'
+    model.save
+
+    model.title = 'def'
+    model.save
+
+    model.title = 'something better'
+    model.save
+
+    model.reload
+    assert_equal 'def', model.check
+
+  end
+
+end

data/test/backdrop_test.rb

@@ -0,0 +1,7 @@
+require 'test_helper'
+
+class BackdropTest < ActiveSupport::TestCase
+  test "truth" do
+    assert_kind_of Module, Backdrop
+  end
+end

data/test/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/test/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__)
+
+Rails.application.load_tasks

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

@@ -0,0 +1,13 @@
+// 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 any plugin's vendor/assets/javascripts directory 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/rails/sprockets#sprockets-directives) for details
+// about supported directives.
+//
+//= require_tree .

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

@@ -0,0 +1,15 @@
+/*
+ * 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 any plugin's vendor/assets/stylesheets directory 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 bottom of the
+ * compiled file so the styles you add here take precedence over styles defined in any styles
+ * defined in the other CSS/SCSS files in this directory. It is generally better to create a new
+ * file per style scope.
+ *
+ *= require_tree .
+ *= require_self
+ */

data/test/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/test/dummy/app/helpers/application_helper.rb

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

data/test/dummy/app/models/something.rb

@@ -0,0 +1,23 @@
+class Something < ActiveRecord::Base
+  acts_as_backdrop
+
+  def backdrop_process(message)
+
+    # example that you receive:
+    # { "class"=>"Something",
+    #   "gid"=>"gid://dummy/Something/1",
+    #   "changes"=>{"title"=>[nil, "abc"],
+    #   "created_at"=>[nil, "2015-12-17T20:28:52.307Z"],
+    #   "updated_at"=>[nil, "2015-12-17T20:28:52.307Z"],
+    #   "id"=>[nil, 1]} }
+
+    # for example, we put changes of the title into 'check' attribute to check them in tests
+    if message['changes'].present? && message['changes']['title'].present?
+      old_title = message['changes']['title'].first
+      new_title = message['changes']['title'].last
+      self.update(:check => new_title)
+    end
+
+  end
+
+end

data/test/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/test/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')

data/test/dummy/bin/rails

@@ -0,0 +1,4 @@
+#!/usr/bin/env ruby
+APP_PATH = File.expand_path('../../config/application', __FILE__)
+require_relative '../config/boot'
+require 'rails/commands'

data/test/dummy/bin/rake

@@ -0,0 +1,4 @@
+#!/usr/bin/env ruby
+require_relative '../config/boot'
+require 'rake'
+Rake.application.run

data/test/dummy/bin/setup

@@ -0,0 +1,29 @@
+#!/usr/bin/env ruby
+require 'pathname'
+
+# path to your application root.
+APP_ROOT = Pathname.new File.expand_path('../../',  __FILE__)
+
+Dir.chdir APP_ROOT do
+  # This script is a starting point to setup your application.
+  # Add necessary setup steps to this file:
+
+  puts "== Installing dependencies =="
+  system "gem install bundler --conservative"
+  system "bundle check || bundle install"
+
+  # puts "\n== Copying sample files =="
+  # unless File.exist?("config/database.yml")
+  #   system "cp config/database.yml.sample config/database.yml"
+  # end
+
+  puts "\n== Preparing database =="
+  system "bin/rake db:setup"
+
+  puts "\n== Removing old logs and tempfiles =="
+  system "rm -f log/*"
+  system "rm -rf tmp/cache"
+
+  puts "\n== Restarting application server =="
+  system "touch tmp/restart.txt"
+end

data/test/dummy/config.ru

@@ -0,0 +1,4 @@
+# This file is used by Rack-based servers to start the application.
+
+require ::File.expand_path('../config/environment', __FILE__)
+run Rails.application

data/test/dummy/config/application.rb

@@ -0,0 +1,26 @@
+require File.expand_path('../boot', __FILE__)
+
+require 'rails/all'
+
+Bundler.require(*Rails.groups)
+require "backdrop"
+
+module Dummy
+  class Application < Rails::Application
+    # Settings in config/environments/* take precedence over those specified here.
+    # Application configuration should go into files in config/initializers
+    # -- all .rb files in that directory are automatically loaded.
+
+    # Set Time.zone default to the specified zone and make Active Record auto-convert to this zone.
+    # Run "rake -D time" for a list of tasks for finding time zone names. Default is UTC.
+    # config.time_zone = 'Central Time (US & Canada)'
+
+    # The default locale is :en and all translations from config/locales/*.rb,yml are auto loaded.
+    # config.i18n.load_path += Dir[Rails.root.join('my', 'locales', '*.{rb,yml}').to_s]
+    # config.i18n.default_locale = :de
+
+    # Do not swallow errors in after_commit/after_rollback callbacks.
+    config.active_record.raise_in_transactional_callbacks = true
+  end
+end
+

data/test/dummy/config/boot.rb

@@ -0,0 +1,5 @@
+# Set up gems listed in the Gemfile.
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path('../../../../Gemfile', __FILE__)
+
+require 'bundler/setup' if File.exist?(ENV['BUNDLE_GEMFILE'])
+$LOAD_PATH.unshift File.expand_path('../../../../lib', __FILE__)

data/test/dummy/config/database.yml

@@ -0,0 +1,25 @@
+# SQLite version 3.x
+#   gem install sqlite3
+#
+#   Ensure the SQLite 3 gem is defined in your Gemfile
+#   gem 'sqlite3'
+#
+default: &default
+  adapter: sqlite3
+  pool: 5
+  timeout: 5000
+
+development:
+  <<: *default
+  database: db/development.sqlite3
+
+# Warning: The database defined as "test" will be erased and
+# re-generated from your development database when you run "rake".
+# Do not set this db to the same as development or production.
+test:
+  <<: *default
+  database: db/test.sqlite3
+
+production:
+  <<: *default
+  database: db/production.sqlite3