models_auditor 0.1.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (70) hide show
  1. checksums.yaml +7 -0
  2. data/MIT-LICENSE +20 -0
  3. data/Rakefile +37 -0
  4. data/app/assets/javascripts/models_auditor/application.js +13 -0
  5. data/app/assets/stylesheets/models_auditor/application.css +64 -0
  6. data/app/controllers/models_auditor/audit_base_controller.rb +5 -0
  7. data/app/controllers/models_auditor/audit_controller.rb +121 -0
  8. data/app/helpers/models_auditor/application_helper.rb +4 -0
  9. data/app/models/models_auditor/audit_record.rb +17 -0
  10. data/app/models/models_auditor/audit_request.rb +12 -0
  11. data/app/views/layouts/models_auditor/application.html.erb +12 -0
  12. data/app/views/models_auditor/audit/_record.html.erb +39 -0
  13. data/app/views/models_auditor/audit/_request.html.erb +25 -0
  14. data/app/views/models_auditor/audit/index.html.erb +3 -0
  15. data/config/config_option_descriptions.yml +23 -0
  16. data/config/routes.rb +5 -0
  17. data/lib/generators/models_auditor/db_config/USAGE +7 -0
  18. data/lib/generators/models_auditor/db_config/db_config_generator.rb +23 -0
  19. data/lib/generators/models_auditor/install/USAGE +8 -0
  20. data/lib/generators/models_auditor/install/install_generator.rb +25 -0
  21. data/lib/generators/models_auditor/install/templates/initializer.rb.erb +13 -0
  22. data/lib/generators/models_auditor/migrations/USAGE +8 -0
  23. data/lib/generators/models_auditor/migrations/migrations_generator.rb +15 -0
  24. data/lib/generators/models_auditor/migrations/templates/create_audit_records.rb.erb +18 -0
  25. data/lib/generators/models_auditor/migrations/templates/create_audit_requests.rb.erb +12 -0
  26. data/lib/generators/models_auditor/migrations_helper.rb +24 -0
  27. data/lib/models_auditor.rb +37 -0
  28. data/lib/models_auditor/audit.rb +202 -0
  29. data/lib/models_auditor/config.rb +118 -0
  30. data/lib/models_auditor/controller.rb +67 -0
  31. data/lib/models_auditor/engine.rb +5 -0
  32. data/lib/models_auditor/version.rb +3 -0
  33. data/lib/tasks/models_auditor_tasks.rake +75 -0
  34. data/test/dummy/README.rdoc +28 -0
  35. data/test/dummy/Rakefile +6 -0
  36. data/test/dummy/app/assets/javascripts/application.js +13 -0
  37. data/test/dummy/app/assets/stylesheets/application.css +15 -0
  38. data/test/dummy/app/helpers/application_helper.rb +2 -0
  39. data/test/dummy/app/views/layouts/application.html.erb +14 -0
  40. data/test/dummy/bin/bundle +3 -0
  41. data/test/dummy/bin/rails +4 -0
  42. data/test/dummy/bin/rake +4 -0
  43. data/test/dummy/bin/setup +29 -0
  44. data/test/dummy/config.ru +4 -0
  45. data/test/dummy/config/application.rb +26 -0
  46. data/test/dummy/config/boot.rb +5 -0
  47. data/test/dummy/config/database.yml +25 -0
  48. data/test/dummy/config/environment.rb +5 -0
  49. data/test/dummy/config/environments/development.rb +41 -0
  50. data/test/dummy/config/environments/production.rb +79 -0
  51. data/test/dummy/config/environments/test.rb +42 -0
  52. data/test/dummy/config/initializers/assets.rb +11 -0
  53. data/test/dummy/config/initializers/backtrace_silencers.rb +7 -0
  54. data/test/dummy/config/initializers/cookies_serializer.rb +3 -0
  55. data/test/dummy/config/initializers/filter_parameter_logging.rb +4 -0
  56. data/test/dummy/config/initializers/inflections.rb +16 -0
  57. data/test/dummy/config/initializers/mime_types.rb +4 -0
  58. data/test/dummy/config/initializers/session_store.rb +3 -0
  59. data/test/dummy/config/initializers/wrap_parameters.rb +14 -0
  60. data/test/dummy/config/locales/en.yml +23 -0
  61. data/test/dummy/config/routes.rb +4 -0
  62. data/test/dummy/config/secrets.yml +22 -0
  63. data/test/dummy/public/404.html +67 -0
  64. data/test/dummy/public/422.html +67 -0
  65. data/test/dummy/public/500.html +66 -0
  66. data/test/dummy/public/favicon.ico +0 -0
  67. data/test/integration/navigation_test.rb +8 -0
  68. data/test/models_auditor_test.rb +7 -0
  69. data/test/test_helper.rb +21 -0
  70. metadata +249 -0
@@ -0,0 +1,67 @@
1
+ module ModelsAuditor
2
+ module Controller
3
+ def self.included(base)
4
+ base.before_action :set_models_auditor_request_params
5
+ end
6
+
7
+ protected
8
+
9
+ def set_models_auditor_request_params
10
+ ModelsAuditor.store[:audit_request] =
11
+ ModelsAuditor::AuditRequest.new(
12
+ user_id: user_for_models_auditor,
13
+ request_info: info_for_models_auditor
14
+ )
15
+ end
16
+
17
+ # Returns the user who is responsible for any changes that occur.
18
+ # By default this calls `current_user` or `current_employee` and returns the result.
19
+ #
20
+ # Override this method in your controller to call a different
21
+ # method, e.g. `current_person`, or anything you like.
22
+ def user_for_models_auditor
23
+ user =
24
+ case
25
+ when defined?(current_user)
26
+ current_user
27
+ when defined?(current_employee)
28
+ current_employee
29
+ else
30
+ return
31
+ end
32
+ ActiveSupport::VERSION::MAJOR >= 4 ? user.try!(:id) : user.try(:id)
33
+ rescue NoMethodError
34
+ user
35
+ end
36
+
37
+ # Returns any information about the controller or request that you
38
+ # want ModelsAuditor to store alongside any changes that occur. By
39
+ # default this returns an empty hash.
40
+ #
41
+ # Override this method in your controller to return a hash of any
42
+ # information you need. The hash's keys must correspond to columns
43
+ # in your `auditor_requests` table, so don't forget to add any new columns
44
+ # you need.
45
+ #
46
+ # For example:
47
+ #
48
+ # {:ip => request.remote_ip, :user_agent => request.user_agent}
49
+ #
50
+ # The columns `ip` and `user_agent` must exist in your `versions` # table.
51
+ #
52
+ # Use the `:meta` option to `PaperTrail::Model::ClassMethods.has_paper_trail`
53
+ # to store any extra model-level data you need.
54
+ def info_for_models_auditor
55
+ {
56
+ ip: request.remote_ip,
57
+ user_agent: request.user_agent,
58
+ controller: self.class.name,
59
+ action: action_name
60
+ }
61
+ end
62
+ end
63
+
64
+ if defined?(::ActionController)
65
+ ::ActiveSupport.on_load(:action_controller) { include ModelsAuditor::Controller }
66
+ end
67
+ end
@@ -0,0 +1,5 @@
1
+ module ModelsAuditor
2
+ class Engine < ::Rails::Engine
3
+ isolate_namespace ModelsAuditor
4
+ end
5
+ end
@@ -0,0 +1,3 @@
1
+ module ModelsAuditor
2
+ VERSION = '0.1.0'
3
+ end
@@ -0,0 +1,75 @@
1
+ # desc "Explaining what the task does"
2
+ # task :models_auditor do
3
+ # # Task goes here
4
+ # end
5
+ namespace :db do
6
+ namespace :audit do
7
+ task :connect_without_db, [:database] => [:environment] do |t, args|
8
+ db = args.database || [ModelsAuditor.config.connection_namespace, Rails.env].map(&:presence).compact.join('_').to_sym
9
+ raise ArgumentError.new('Required parameter [<database>] was not passed') if db.blank?
10
+
11
+ connection_params =
12
+ ActiveRecord::Base.configurations[db].merge(
13
+ 'database' => 'postgres',
14
+ 'schema_search_path' => 'public'
15
+ )
16
+ ActiveRecord::Base.establish_connection(connection_params)
17
+ end
18
+
19
+ task :connect, [:database] => [:environment] do |t, args|
20
+ db = args.database || [ModelsAuditor.config.connection_namespace, Rails.env].map(&:presence).compact.join('_').to_sym
21
+ raise ArgumentError.new('Required parameter [<database>] was not passed') if db.blank?
22
+
23
+ connection_params = ActiveRecord::Base.configurations[db]
24
+ ActiveRecord::Base.establish_connection(connection_params)
25
+ end
26
+
27
+ desc 'Create the audit db in custom database specified in databases.yml'
28
+ task :create, [:database] => [:connect_without_db, :environment] do |t, args|
29
+ db = args.database || [ModelsAuditor.config.connection_namespace, Rails.env].map(&:presence).compact.join('_').to_sym
30
+ raise ArgumentError.new('Required parameter [<database>] was not passed') if db.blank?
31
+ database_name = ActiveRecord::Base.configurations[db]['database']
32
+
33
+ puts "Applying create on #{db}"
34
+ ActiveRecord::Base.connection.create_database(database_name)
35
+ end
36
+
37
+ desc 'Drop the audit db specified in databases.yml'
38
+ task :drop, [:database] => [:connect_without_db, :environment] do |t, args|
39
+ db = args.database || [ModelsAuditor.config.connection_namespace, Rails.env].map(&:presence).compact.join('_').to_sym
40
+ raise ArgumentError.new('Required parameter [<database>] was not passed') if db.blank?
41
+ database_name = ActiveRecord::Base.configurations[db]['database']
42
+
43
+ # Дропаем существующие подключения
44
+ # и запрещаем новые на время пересоздания базы
45
+ ActiveRecord::Base.connection.execute("SELECT pg_terminate_backend(pid) FROM pg_stat_activity WHERE datname = '#{database_name}';")
46
+ ActiveRecord::Base.connection.execute("UPDATE pg_database SET datallowconn = 'false' WHERE datname = '#{database_name}';")
47
+ begin
48
+ puts "Applying drop on #{db}"
49
+ ActiveRecord::Base.connection.drop_database(database_name)
50
+ ensure
51
+ ActiveRecord::Base.connection.execute("UPDATE pg_database SET datallowconn = 'true' WHERE datname = '#{database_name}';")
52
+ end
53
+ end
54
+
55
+ desc 'Migrate the audit database (options: VERSION=x).'
56
+ task :migrate, [:database] => [:connect, :environment] do |t, args|
57
+ db = args.database || [ModelsAuditor.config.connection_namespace, Rails.env].map(&:presence).compact.join('_').to_sym
58
+ raise ArgumentError.new('Required parameter [<database>] was not passed') if db.blank?
59
+
60
+ migrations_dir = Rails.root.join('db', ModelsAuditor.config.audit_migrations_dir).to_s
61
+ ActiveRecord::Migration.verbose = true
62
+ ActiveRecord::Migrator.migrate(migrations_dir, ENV['VERSION'] ? ENV['VERSION'].to_i : nil)
63
+ end
64
+
65
+ desc 'Rolls the schema of the audit database back to the previous version (specify steps w/ STEP=n).'
66
+ task :rollback, [:database] => [:connect, :environment] do |t, args|
67
+ db = args.database || [ModelsAuditor.config.connection_namespace, Rails.env].map(&:presence).compact.join('_').to_sym
68
+ raise ArgumentError.new('Required parameter [<database>] was not passed') if db.blank?
69
+
70
+ migrations_dir = Rails.root.join('db', ModelsAuditor.config.audit_migrations_dir).to_s
71
+ step = ENV['STEP'] ? ENV['STEP'].to_i : 1
72
+ ActiveRecord::Migrator.rollback(migrations_dir, step)
73
+ end
74
+ end
75
+ 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,2 @@
1
+ module ApplicationHelper
2
+ 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 'models_auditor'
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
@@ -0,0 +1,5 @@
1
+ # Load the Rails application.
2
+ require File.expand_path('../application', __FILE__)
3
+
4
+ # Initialize the Rails application.
5
+ Rails.application.initialize!
@@ -0,0 +1,41 @@
1
+ Rails.application.configure do
2
+ # Settings specified here will take precedence over those in config/application.rb.
3
+
4
+ # In the development environment your application's code is reloaded on
5
+ # every request. This slows down response time but is perfect for development
6
+ # since you don't have to restart the web server when you make code changes.
7
+ config.cache_classes = false
8
+
9
+ # Do not eager load code on boot.
10
+ config.eager_load = false
11
+
12
+ # Show full error reports and disable caching.
13
+ config.consider_all_requests_local = true
14
+ config.action_controller.perform_caching = false
15
+
16
+ # Don't care if the mailer can't send.
17
+ config.action_mailer.raise_delivery_errors = false
18
+
19
+ # Print deprecation notices to the Rails logger.
20
+ config.active_support.deprecation = :log
21
+
22
+ # Raise an error on page load if there are pending migrations.
23
+ config.active_record.migration_error = :page_load
24
+
25
+ # Debug mode disables concatenation and preprocessing of assets.
26
+ # This option may cause significant delays in view rendering with a large
27
+ # number of complex assets.
28
+ config.assets.debug = true
29
+
30
+ # Asset digests allow you to set far-future HTTP expiration dates on all assets,
31
+ # yet still be able to expire them through the digest params.
32
+ config.assets.digest = true
33
+
34
+ # Adds additional error checking when serving assets at runtime.
35
+ # Checks for improperly declared sprockets dependencies.
36
+ # Raises helpful error messages.
37
+ config.assets.raise_runtime_errors = true
38
+
39
+ # Raises error for missing translations
40
+ # config.action_view.raise_on_missing_translations = true
41
+ end
@@ -0,0 +1,79 @@
1
+ Rails.application.configure do
2
+ # Settings specified here will take precedence over those in config/application.rb.
3
+
4
+ # Code is not reloaded between requests.
5
+ config.cache_classes = true
6
+
7
+ # Eager load code on boot. This eager loads most of Rails and
8
+ # your application in memory, allowing both threaded web servers
9
+ # and those relying on copy on write to perform better.
10
+ # Rake tasks automatically ignore this option for performance.
11
+ config.eager_load = true
12
+
13
+ # Full error reports are disabled and caching is turned on.
14
+ config.consider_all_requests_local = false
15
+ config.action_controller.perform_caching = true
16
+
17
+ # Enable Rack::Cache to put a simple HTTP cache in front of your application
18
+ # Add `rack-cache` to your Gemfile before enabling this.
19
+ # For large-scale production use, consider using a caching reverse proxy like
20
+ # NGINX, varnish or squid.
21
+ # config.action_dispatch.rack_cache = true
22
+
23
+ # Disable serving static files from the `/public` folder by default since
24
+ # Apache or NGINX already handles this.
25
+ config.serve_static_files = ENV['RAILS_SERVE_STATIC_FILES'].present?
26
+
27
+ # Compress JavaScripts and CSS.
28
+ config.assets.js_compressor = :uglifier
29
+ # config.assets.css_compressor = :sass
30
+
31
+ # Do not fallback to assets pipeline if a precompiled asset is missed.
32
+ config.assets.compile = false
33
+
34
+ # Asset digests allow you to set far-future HTTP expiration dates on all assets,
35
+ # yet still be able to expire them through the digest params.
36
+ config.assets.digest = true
37
+
38
+ # `config.assets.precompile` and `config.assets.version` have moved to config/initializers/assets.rb
39
+
40
+ # Specifies the header that your server uses for sending files.
41
+ # config.action_dispatch.x_sendfile_header = 'X-Sendfile' # for Apache
42
+ # config.action_dispatch.x_sendfile_header = 'X-Accel-Redirect' # for NGINX
43
+
44
+ # Force all access to the app over SSL, use Strict-Transport-Security, and use secure cookies.
45
+ # config.force_ssl = true
46
+
47
+ # Use the lowest log level to ensure availability of diagnostic information
48
+ # when problems arise.
49
+ config.log_level = :debug
50
+
51
+ # Prepend all log lines with the following tags.
52
+ # config.log_tags = [ :subdomain, :uuid ]
53
+
54
+ # Use a different logger for distributed setups.
55
+ # config.logger = ActiveSupport::TaggedLogging.new(SyslogLogger.new)
56
+
57
+ # Use a different cache store in production.
58
+ # config.cache_store = :mem_cache_store
59
+
60
+ # Enable serving of images, stylesheets, and JavaScripts from an asset server.
61
+ # config.action_controller.asset_host = 'http://assets.example.com'
62
+
63
+ # Ignore bad email addresses and do not raise email delivery errors.
64
+ # Set this to true and configure the email server for immediate delivery to raise delivery errors.
65
+ # config.action_mailer.raise_delivery_errors = false
66
+
67
+ # Enable locale fallbacks for I18n (makes lookups for any locale fall back to
68
+ # the I18n.default_locale when a translation cannot be found).
69
+ config.i18n.fallbacks = true
70
+
71
+ # Send deprecation notices to registered listeners.
72
+ config.active_support.deprecation = :notify
73
+
74
+ # Use default logging formatter so that PID and timestamp are not suppressed.
75
+ config.log_formatter = ::Logger::Formatter.new
76
+
77
+ # Do not dump schema after migrations.
78
+ config.active_record.dump_schema_after_migration = false
79
+ end