act_as_backdrop 0.0.1

Sign up to get free protection for your applications and to get access to all the features.
Files changed (57) hide show
  1. checksums.yaml +7 -0
  2. data/MIT-LICENSE +20 -0
  3. data/README.markdown +37 -0
  4. data/Rakefile +34 -0
  5. data/lib/backdrop.rb +22 -0
  6. data/lib/backdrop/act_as_backdrop.rb +26 -0
  7. data/lib/backdrop/backdrop_job.rb +11 -0
  8. data/lib/backdrop/version.rb +3 -0
  9. data/lib/tasks/backdrop_tasks.rake +4 -0
  10. data/test/act_as_backdrop_test.rb +25 -0
  11. data/test/backdrop_test.rb +7 -0
  12. data/test/dummy/README.rdoc +28 -0
  13. data/test/dummy/Rakefile +6 -0
  14. data/test/dummy/app/assets/javascripts/application.js +13 -0
  15. data/test/dummy/app/assets/stylesheets/application.css +15 -0
  16. data/test/dummy/app/controllers/application_controller.rb +5 -0
  17. data/test/dummy/app/helpers/application_helper.rb +2 -0
  18. data/test/dummy/app/models/something.rb +23 -0
  19. data/test/dummy/app/views/layouts/application.html.erb +14 -0
  20. data/test/dummy/bin/bundle +3 -0
  21. data/test/dummy/bin/rails +4 -0
  22. data/test/dummy/bin/rake +4 -0
  23. data/test/dummy/bin/setup +29 -0
  24. data/test/dummy/config.ru +4 -0
  25. data/test/dummy/config/application.rb +26 -0
  26. data/test/dummy/config/boot.rb +5 -0
  27. data/test/dummy/config/database.yml +25 -0
  28. data/test/dummy/config/environment.rb +5 -0
  29. data/test/dummy/config/environments/development.rb +41 -0
  30. data/test/dummy/config/environments/production.rb +79 -0
  31. data/test/dummy/config/environments/test.rb +42 -0
  32. data/test/dummy/config/initializers/assets.rb +11 -0
  33. data/test/dummy/config/initializers/backtrace_silencers.rb +7 -0
  34. data/test/dummy/config/initializers/cookies_serializer.rb +3 -0
  35. data/test/dummy/config/initializers/filter_parameter_logging.rb +4 -0
  36. data/test/dummy/config/initializers/inflections.rb +16 -0
  37. data/test/dummy/config/initializers/mime_types.rb +4 -0
  38. data/test/dummy/config/initializers/session_store.rb +3 -0
  39. data/test/dummy/config/initializers/wrap_parameters.rb +14 -0
  40. data/test/dummy/config/locales/en.yml +23 -0
  41. data/test/dummy/config/routes.rb +56 -0
  42. data/test/dummy/config/secrets.yml +22 -0
  43. data/test/dummy/db/development.sqlite3 +0 -0
  44. data/test/dummy/db/migrate/20151217194635_create_somethings.rb +9 -0
  45. data/test/dummy/db/migrate/20151217203211_add_check_to_something.rb +5 -0
  46. data/test/dummy/db/schema.rb +23 -0
  47. data/test/dummy/db/test.sqlite3 +0 -0
  48. data/test/dummy/log/development.log +41 -0
  49. data/test/dummy/log/test.log +2279 -0
  50. data/test/dummy/public/404.html +67 -0
  51. data/test/dummy/public/422.html +67 -0
  52. data/test/dummy/public/500.html +66 -0
  53. data/test/dummy/public/favicon.ico +0 -0
  54. data/test/dummy/test/fixtures/somethings.yml +7 -0
  55. data/test/dummy/test/models/something_test.rb +7 -0
  56. data/test/test_helper.rb +19 -0
  57. metadata +175 -0
@@ -0,0 +1,7 @@
1
+ ---
2
+ SHA1:
3
+ metadata.gz: 84c7e2be7f550dd3ba1850051f52acaa3d27b974
4
+ data.tar.gz: f6d685eca8fbe179a3256bb3f027b02a2d6df01f
5
+ SHA512:
6
+ metadata.gz: 0e8dacbdb9ffacc549785674ebf4f293fecad28d04156e15f07d2ae620d4a8ee2bdbe6cd11d55a64594676b0cffc0c359f4be511f286943f360ada2a73ad7e10
7
+ data.tar.gz: fc9d356a5f176cc704ee9c1291d263563123a6fdf3cd03f90318a5bb7ab28e8fd3a48b777e31f9c3966688018a6b298515849affb5336f80e572ace405d2090d
@@ -0,0 +1,20 @@
1
+ Copyright 2015 Grigoriy Dobryakov
2
+
3
+ Permission is hereby granted, free of charge, to any person obtaining
4
+ a copy of this software and associated documentation files (the
5
+ "Software"), to deal in the Software without restriction, including
6
+ without limitation the rights to use, copy, modify, merge, publish,
7
+ distribute, sublicense, and/or sell copies of the Software, and to
8
+ permit persons to whom the Software is furnished to do so, subject to
9
+ the following conditions:
10
+
11
+ The above copyright notice and this permission notice shall be
12
+ included in all copies or substantial portions of the Software.
13
+
14
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
15
+ EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
16
+ MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
17
+ NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
18
+ LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
19
+ OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
20
+ WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
@@ -0,0 +1,37 @@
1
+ acts_as_backdrop
2
+ ----------------
3
+
4
+ This gem allows you to write async processing code to your models right into your models code.
5
+
6
+ Example
7
+ -------
8
+
9
+ class Something < ActiveRecord::Base
10
+ acts_as_backdrop
11
+
12
+ def backdrop_process(message)
13
+
14
+ # example that you receive:
15
+ # { "class"=>"Something",
16
+ # "gid"=>"gid://dummy/Something/1",
17
+ # "changes"=>{"title"=>[nil, "abc"],
18
+ # "created_at"=>[nil, "2015-12-17T20:28:52.307Z"],
19
+ # "updated_at"=>[nil, "2015-12-17T20:28:52.307Z"],
20
+ # "id"=>[nil, 1]} }
21
+
22
+ end
23
+
24
+ end
25
+
26
+ Why
27
+ ---
28
+
29
+ Because you might need to process some data *after* the model is saved, asynchronously.
30
+
31
+ How it works
32
+ ------------
33
+
34
+ When your model instance saved (on after_save callback), the model itself and it's changes published to async job queue as usual DelayedJob.
35
+ The special worker (BackdropJob class) will process this message and will trigger your 'backdrop_process' method inside your model.
36
+
37
+ You receive full information about model changes, and can process it as you wish.
@@ -0,0 +1,34 @@
1
+ begin
2
+ require 'bundler/setup'
3
+ rescue LoadError
4
+ puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
5
+ end
6
+
7
+ require 'rdoc/task'
8
+
9
+ RDoc::Task.new(:rdoc) do |rdoc|
10
+ rdoc.rdoc_dir = 'rdoc'
11
+ rdoc.title = 'Backdrop'
12
+ rdoc.options << '--line-numbers'
13
+ rdoc.rdoc_files.include('README.markdown')
14
+ rdoc.rdoc_files.include('lib/**/*.rb')
15
+ end
16
+
17
+
18
+
19
+
20
+
21
+
22
+ Bundler::GemHelper.install_tasks
23
+
24
+ require 'rake/testtask'
25
+
26
+ Rake::TestTask.new(:test) do |t|
27
+ t.libs << 'lib'
28
+ t.libs << 'test'
29
+ t.pattern = 'test/**/*_test.rb'
30
+ t.verbose = false
31
+ end
32
+
33
+
34
+ task default: :test
@@ -0,0 +1,22 @@
1
+ require 'backdrop/act_as_backdrop'
2
+ require 'backdrop/backdrop_job'
3
+
4
+ module Backdrop
5
+ class Event
6
+ def self.publish(payload)
7
+
8
+ klass = payload[:model].class.to_s
9
+ gid = payload[:model].to_global_id.to_s
10
+ changes = payload[:changes]
11
+
12
+ message = {
13
+ class: klass,
14
+ gid: gid,
15
+ changes: changes
16
+ }
17
+
18
+ BackdropJob.perform_later message.to_json
19
+
20
+ end
21
+ end
22
+ end
@@ -0,0 +1,26 @@
1
+ module Backdrop
2
+ module ActAsBackdrop
3
+
4
+ extend ActiveSupport::Concern
5
+
6
+ included do
7
+ after_save :acts_as_backdrop
8
+ end
9
+
10
+ module ClassMethods
11
+ def acts_as_backdrop(options = {})
12
+ include Backdrop::ActAsBackdrop::LocalInstanceMethods
13
+ end
14
+ end
15
+
16
+ module LocalInstanceMethods
17
+ def acts_as_backdrop(options = {})
18
+ changes = self.previous_changes
19
+ Backdrop::Event.publish model: self, changes: changes
20
+ end
21
+ end
22
+
23
+ end
24
+ end
25
+
26
+ ActiveRecord::Base.include(Backdrop::ActAsBackdrop)
@@ -0,0 +1,11 @@
1
+ class BackdropJob < ActiveJob::Base
2
+
3
+ queue_as :default
4
+
5
+ def perform(message_json)
6
+ message = JSON.parse(message_json)
7
+ model = GlobalID::Locator.locate message['gid']
8
+ model.send(:backdrop_process, message) if model.present? && model.respond_to?(:backdrop_process)
9
+ end
10
+
11
+ end
@@ -0,0 +1,3 @@
1
+ module Backdrop
2
+ VERSION = "0.0.1"
3
+ end
@@ -0,0 +1,4 @@
1
+ # desc "Explaining what the task does"
2
+ # task :backdrop do
3
+ # # Task goes here
4
+ # end
@@ -0,0 +1,25 @@
1
+
2
+ require 'test_helper'
3
+
4
+ class ActAsBackdropTest < ActiveSupport::TestCase
5
+
6
+ def test_model_act_as_backdrop
7
+
8
+ model = Something.new
9
+ model.save
10
+
11
+ model.title = 'abc'
12
+ model.save
13
+
14
+ model.title = 'def'
15
+ model.save
16
+
17
+ model.title = 'something better'
18
+ model.save
19
+
20
+ model.reload
21
+ assert_equal 'def', model.check
22
+
23
+ end
24
+
25
+ end
@@ -0,0 +1,7 @@
1
+ require 'test_helper'
2
+
3
+ class BackdropTest < ActiveSupport::TestCase
4
+ test "truth" do
5
+ assert_kind_of Module, Backdrop
6
+ end
7
+ end
@@ -0,0 +1,28 @@
1
+ == README
2
+
3
+ This README would normally document whatever steps are necessary to get the
4
+ application up and running.
5
+
6
+ Things you may want to cover:
7
+
8
+ * Ruby version
9
+
10
+ * System dependencies
11
+
12
+ * Configuration
13
+
14
+ * Database creation
15
+
16
+ * Database initialization
17
+
18
+ * How to run the test suite
19
+
20
+ * Services (job queues, cache servers, search engines, etc.)
21
+
22
+ * Deployment instructions
23
+
24
+ * ...
25
+
26
+
27
+ Please feel free to use a different markup language if you do not plan to run
28
+ <tt>rake doc:app</tt>.
@@ -0,0 +1,6 @@
1
+ # Add your own tasks in files placed in lib/tasks ending in .rake,
2
+ # for example lib/tasks/capistrano.rake, and they will automatically be available to Rake.
3
+
4
+ require File.expand_path('../config/application', __FILE__)
5
+
6
+ Rails.application.load_tasks
@@ -0,0 +1,13 @@
1
+ // This is a manifest file that'll be compiled into application.js, which will include all the files
2
+ // listed below.
3
+ //
4
+ // Any JavaScript/Coffee file within this directory, lib/assets/javascripts, vendor/assets/javascripts,
5
+ // or any plugin's vendor/assets/javascripts directory can be referenced here using a relative path.
6
+ //
7
+ // It's not advisable to add code directly here, but if you do, it'll appear at the bottom of the
8
+ // compiled file.
9
+ //
10
+ // Read Sprockets README (https://github.com/rails/sprockets#sprockets-directives) for details
11
+ // about supported directives.
12
+ //
13
+ //= require_tree .
@@ -0,0 +1,15 @@
1
+ /*
2
+ * This is a manifest file that'll be compiled into application.css, which will include all the files
3
+ * listed below.
4
+ *
5
+ * Any CSS and SCSS file within this directory, lib/assets/stylesheets, vendor/assets/stylesheets,
6
+ * or any plugin's vendor/assets/stylesheets directory can be referenced here using a relative path.
7
+ *
8
+ * You're free to add application-wide styles to this file and they'll appear at the bottom of the
9
+ * compiled file so the styles you add here take precedence over styles defined in any styles
10
+ * defined in the other CSS/SCSS files in this directory. It is generally better to create a new
11
+ * file per style scope.
12
+ *
13
+ *= require_tree .
14
+ *= require_self
15
+ */
@@ -0,0 +1,5 @@
1
+ class ApplicationController < ActionController::Base
2
+ # Prevent CSRF attacks by raising an exception.
3
+ # For APIs, you may want to use :null_session instead.
4
+ protect_from_forgery with: :exception
5
+ end
@@ -0,0 +1,2 @@
1
+ module ApplicationHelper
2
+ end
@@ -0,0 +1,23 @@
1
+ class Something < ActiveRecord::Base
2
+ acts_as_backdrop
3
+
4
+ def backdrop_process(message)
5
+
6
+ # example that you receive:
7
+ # { "class"=>"Something",
8
+ # "gid"=>"gid://dummy/Something/1",
9
+ # "changes"=>{"title"=>[nil, "abc"],
10
+ # "created_at"=>[nil, "2015-12-17T20:28:52.307Z"],
11
+ # "updated_at"=>[nil, "2015-12-17T20:28:52.307Z"],
12
+ # "id"=>[nil, 1]} }
13
+
14
+ # for example, we put changes of the title into 'check' attribute to check them in tests
15
+ if message['changes'].present? && message['changes']['title'].present?
16
+ old_title = message['changes']['title'].first
17
+ new_title = message['changes']['title'].last
18
+ self.update(:check => new_title)
19
+ end
20
+
21
+ end
22
+
23
+ end
@@ -0,0 +1,14 @@
1
+ <!DOCTYPE html>
2
+ <html>
3
+ <head>
4
+ <title>Dummy</title>
5
+ <%= stylesheet_link_tag 'application', media: 'all', 'data-turbolinks-track' => true %>
6
+ <%= javascript_include_tag 'application', 'data-turbolinks-track' => true %>
7
+ <%= csrf_meta_tags %>
8
+ </head>
9
+ <body>
10
+
11
+ <%= yield %>
12
+
13
+ </body>
14
+ </html>
@@ -0,0 +1,3 @@
1
+ #!/usr/bin/env ruby
2
+ ENV['BUNDLE_GEMFILE'] ||= File.expand_path('../../Gemfile', __FILE__)
3
+ load Gem.bin_path('bundler', 'bundle')
@@ -0,0 +1,4 @@
1
+ #!/usr/bin/env ruby
2
+ APP_PATH = File.expand_path('../../config/application', __FILE__)
3
+ require_relative '../config/boot'
4
+ require 'rails/commands'
@@ -0,0 +1,4 @@
1
+ #!/usr/bin/env ruby
2
+ require_relative '../config/boot'
3
+ require 'rake'
4
+ Rake.application.run
@@ -0,0 +1,29 @@
1
+ #!/usr/bin/env ruby
2
+ require 'pathname'
3
+
4
+ # path to your application root.
5
+ APP_ROOT = Pathname.new File.expand_path('../../', __FILE__)
6
+
7
+ Dir.chdir APP_ROOT do
8
+ # This script is a starting point to setup your application.
9
+ # Add necessary setup steps to this file:
10
+
11
+ puts "== Installing dependencies =="
12
+ system "gem install bundler --conservative"
13
+ system "bundle check || bundle install"
14
+
15
+ # puts "\n== Copying sample files =="
16
+ # unless File.exist?("config/database.yml")
17
+ # system "cp config/database.yml.sample config/database.yml"
18
+ # end
19
+
20
+ puts "\n== Preparing database =="
21
+ system "bin/rake db:setup"
22
+
23
+ puts "\n== Removing old logs and tempfiles =="
24
+ system "rm -f log/*"
25
+ system "rm -rf tmp/cache"
26
+
27
+ puts "\n== Restarting application server =="
28
+ system "touch tmp/restart.txt"
29
+ end
@@ -0,0 +1,4 @@
1
+ # This file is used by Rack-based servers to start the application.
2
+
3
+ require ::File.expand_path('../config/environment', __FILE__)
4
+ run Rails.application
@@ -0,0 +1,26 @@
1
+ require File.expand_path('../boot', __FILE__)
2
+
3
+ require 'rails/all'
4
+
5
+ Bundler.require(*Rails.groups)
6
+ require "backdrop"
7
+
8
+ module Dummy
9
+ class Application < Rails::Application
10
+ # Settings in config/environments/* take precedence over those specified here.
11
+ # Application configuration should go into files in config/initializers
12
+ # -- all .rb files in that directory are automatically loaded.
13
+
14
+ # Set Time.zone default to the specified zone and make Active Record auto-convert to this zone.
15
+ # Run "rake -D time" for a list of tasks for finding time zone names. Default is UTC.
16
+ # config.time_zone = 'Central Time (US & Canada)'
17
+
18
+ # The default locale is :en and all translations from config/locales/*.rb,yml are auto loaded.
19
+ # config.i18n.load_path += Dir[Rails.root.join('my', 'locales', '*.{rb,yml}').to_s]
20
+ # config.i18n.default_locale = :de
21
+
22
+ # Do not swallow errors in after_commit/after_rollback callbacks.
23
+ config.active_record.raise_in_transactional_callbacks = true
24
+ end
25
+ end
26
+
@@ -0,0 +1,5 @@
1
+ # Set up gems listed in the Gemfile.
2
+ ENV['BUNDLE_GEMFILE'] ||= File.expand_path('../../../../Gemfile', __FILE__)
3
+
4
+ require 'bundler/setup' if File.exist?(ENV['BUNDLE_GEMFILE'])
5
+ $LOAD_PATH.unshift File.expand_path('../../../../lib', __FILE__)
@@ -0,0 +1,25 @@
1
+ # SQLite version 3.x
2
+ # gem install sqlite3
3
+ #
4
+ # Ensure the SQLite 3 gem is defined in your Gemfile
5
+ # gem 'sqlite3'
6
+ #
7
+ default: &default
8
+ adapter: sqlite3
9
+ pool: 5
10
+ timeout: 5000
11
+
12
+ development:
13
+ <<: *default
14
+ database: db/development.sqlite3
15
+
16
+ # Warning: The database defined as "test" will be erased and
17
+ # re-generated from your development database when you run "rake".
18
+ # Do not set this db to the same as development or production.
19
+ test:
20
+ <<: *default
21
+ database: db/test.sqlite3
22
+
23
+ production:
24
+ <<: *default
25
+ database: db/production.sqlite3