active_snapshot 0.1.0

data/lib/active_snapshot/models/snapshot_item.rb

@@ -0,0 +1,40 @@
+module ActiveSnapshot
+  class SnapshotItem < ActiveRecord::Base
+    self.table_name = "snapshot_items"
+
+    if defined?(ProtectedAttributes)
+      attr_accessible :object, :item_id, :item_type, :child_group_name
+    end
+
+    belongs_to :snapshot, class_name: 'ActiveSnapshot::Snapshot'
+    belongs_to :item, polymorphic: true
+
+    validates :snapshot_id, presence: true
+    validates :item_id, presence: true, uniqueness: { scope: [:snapshot_id, :item_type] }
+    validates :item_type, presence: true, uniqueness: { scope: [:snapshot_id, :item_id] }
+
+    def object
+      @object ||= self[:object].with_indifferent_access
+    end
+
+    def object=(val)
+      @object = nil
+      self[:object] = val
+    end
+
+    def restore_item!
+      ### Add any custom logic here
+      
+      if !item
+        item_klass = item_type.constantize
+
+        self.item = item_klass.new
+      end
+
+      item.assign_attributes(object)
+
+      item.save!(validate: false, touch: false)
+    end
+
+  end
+end

data/lib/active_snapshot/version.rb

@@ -0,0 +1,3 @@
+module ActiveSnapshot
+  VERSION = "0.1.0".freeze
+end

data/lib/generators/active_snapshot/install/install_generator.rb

@@ -0,0 +1,22 @@
+require "generators/active_snapshot/migration_generator"
+
+module ActiveSnapshot
+  class InstallGenerator < MigrationGenerator
+
+    source_root File.expand_path("templates", __dir__)
+
+    desc "Generates a migration to add a the `snapshots` and `snapshot_items` tables"
+
+    def create_migration_file
+      add_migration(
+        MIGRATION_NAME,
+        { 
+          table_options: table_options,
+        }
+      )
+    end
+
+    MIGRATION_NAME = "create_snapshots_tables".freeze
+
+  end
+end

data/lib/generators/active_snapshot/install/templates/create_snapshots_tables.rb.erb

@@ -0,0 +1,21 @@
+class <%= migration_name %> < ActiveRecord::Migration<%= migration_version %>
+
+  def change
+    create_table :snapshots<%= table_options %> do |t|
+      t.belongs_to :item, polymorphic: true, null: false, index: true
+      t.string :identifier, null: false, unique: true, index: true
+      t.belongs_to :user, polymorphic: true
+      t.json :metadata
+      t.datetime :created_at, null: false
+    end
+
+    create_table :snapshot_items<%= table_options %> do |t|
+      t.belongs_to :snapshot, null: false, index: true
+      t.belongs_to :item, polymorphic: true, null: false, unique: [:snapshot_id], index: true
+      t.json :object, null: false
+      t.datetime :created_at, null: false
+      t.string :child_group_name
+    end
+  end
+
+end

data/lib/generators/active_snapshot/migration_generator.rb

@@ -0,0 +1,76 @@
+require "rails/generators"
+require "rails/generators/active_record"
+
+module ActiveSnapshot
+  # Basic structure to support a generator that builds a migration
+  class MigrationGenerator < ::Rails::Generators::Base
+    include ::Rails::Generators::Migration
+
+    def self.next_migration_number(dirname)
+      ::ActiveRecord::Generators::Base.next_migration_number(dirname)
+    end
+
+    protected
+
+    def add_migration(template_name, opts = {})
+      @template_name = template_name
+
+      @migration_path ||= "db/migrate"
+
+      if self.class.migration_exists?(@migration_path, template_name)
+        Kernel.warn "Migration already exists: #{template_name}"
+      else
+        migration_template(
+          "#{template_name}.rb.erb",
+          File.join(@migration_path, "#{template_name}.rb"),
+          { 
+            migration_version: migration_version, 
+          }.merge(opts)
+        )
+      end
+    end
+
+    def migration_version
+      "[#{ActiveRecord::VERSION::MAJOR}.#{ActiveRecord::VERSION::MINOR}]"
+    end
+
+    def migration_name
+      @template_name.titleize.gsub(' ', '')
+    end
+
+    private
+
+    MYSQL_ADAPTERS = [
+      "ActiveRecord::ConnectionAdapters::MysqlAdapter", # Used by gems: `mysql`, `activerecord-jdbcmysql-adapter`.
+      "ActiveRecord::ConnectionAdapters::Mysql2Adapter", # Used by `mysql2` gem.
+    ].freeze
+
+    def mysql?
+      MYSQL_ADAPTERS.include?(ActiveRecord::Base.connection.class.name)
+    end
+
+    # Even modern versions of MySQL still use `latin1` as the default character
+    # encoding. Many users are not aware of this, and run into trouble when they
+    # try to use PaperTrail in apps that otherwise tend to use UTF-8. Postgres, by
+    # comparison, uses UTF-8 except in the unusual case where the OS is configured
+    # with a custom locale.
+    #
+    # - https://dev.mysql.com/doc/refman/5.7/en/charset-applications.html
+    # - http://www.postgresql.org/docs/9.4/static/multibyte.html
+    #
+    # Furthermore, MySQL's original implementation of UTF-8 was flawed, and had
+    # to be fixed later by introducing a new charset, `utf8mb4`.
+    #
+    # - https://mathiasbynens.be/notes/mysql-utf8mb4
+    # - https://dev.mysql.com/doc/refman/5.5/en/charset-unicode-utf8mb4.html
+    #
+    def table_options
+      if mysql?
+        ', { options: "ENGINE=InnoDB DEFAULT CHARSET=utf8mb4 COLLATE=utf8mb4_general_ci" }'
+      else
+        ""
+      end
+    end
+
+  end
+end

data/test/dummy_app/Rakefile

@@ -0,0 +1,7 @@
+#!/usr/bin/env rake
+# 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/test/dummy_app/app/assets/config/manifest.js

@@ -0,0 +1,3 @@
+//= link_tree ../images
+//= link_directory ../javascripts .js
+//= link_directory ../stylesheets .css .scss

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

@@ -0,0 +1,3 @@
+/*
+ *= require_self
+*/

data/test/dummy_app/app/controllers/application_controller.rb

@@ -0,0 +1,3 @@
+class ApplicationController < ActionController::Base
+  protect_from_forgery
+end

data/test/dummy_app/app/models/application_record.rb

@@ -0,0 +1,3 @@
+class ApplicationRecord < ActiveRecord::Base
+  self.abstract_class = true
+end

data/test/dummy_app/app/models/comment.rb

@@ -0,0 +1,5 @@
+class Comment < ActiveRecord::Base
+  include ActiveSnapshot
+
+  belongs_to :post
+end

data/test/dummy_app/app/models/post.rb

@@ -0,0 +1,13 @@
+class Post < ActiveRecord::Base
+  include ActiveSnapshot
+
+  has_many :comments
+
+  has_snapshot_children do
+    instance = self.class.includes(:comments).find(id)
+
+    {
+      comments: instance.comments,
+    }
+  end
+end

data/test/dummy_app/app/models/volatile_post.rb

@@ -0,0 +1,5 @@
+class VolatilePost < ActiveRecord::Base
+  self.table_name = "posts"
+
+  include ActiveSnapshot
+end

data/test/dummy_app/app/views/layouts/application.html.erb

@@ -0,0 +1,14 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title>Dummy App</title>
+  <%= stylesheet_link_tag    "application" %>
+  <%= javascript_include_tag "application" %>
+  <%= csrf_meta_tags %>
+</head>
+<body>
+
+<%= yield %>
+
+</body>
+</html>

data/test/dummy_app/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 Dummy::Application

data/test/dummy_app/config/application.rb

@@ -0,0 +1,61 @@
+require File.expand_path('../boot', __FILE__)
+
+require 'rails/all'
+
+Bundler.require
+
+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.
+
+    # Custom directories with classes and modules you want to be autoloadable.
+    # config.autoload_paths += %W(#{config.root}/extras)
+
+    # Only load the plugins named here, in the order given (default is alphabetical).
+    # :all can be used as a placeholder for all plugins not explicitly named.
+    # config.plugins = [ :exception_notification, :ssl_requirement, :all ]
+
+    # Activate observers that should always be running.
+    # config.active_record.observers = :cacher, :garbage_collector, :forum_observer
+
+    # 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
+
+    # Configure the default encoding used in templates for Ruby 1.9.
+    config.encoding = "utf-8"
+
+    # Configure sensitive parameters which will be filtered from the log file.
+    config.filter_parameters += [:password]
+
+    # Enable the asset pipeline
+    config.assets.enabled = true
+
+    config.assets.quiet = true
+
+    # Version of your assets, change this if you want to expire all your assets
+    config.assets.version = '1.0'
+
+    config.generators.test_framework = false
+    config.generators.helper = false
+    config.generators.stylesheets = false
+    config.generators.javascripts = false
+
+    config.after_initialize do
+      ActiveRecord::Migration.migrate(Rails.root.join("db/migrate/*").to_s)
+    end
+
+    if ActiveRecord.respond_to?(:gem_version)
+      gem_version = ActiveRecord.gem_version
+      if gem_version.to_s.start_with?("5.2.")
+        config.active_record.sqlite3.represent_boolean_as_integer = true
+      end
+    end
+  end
+end

data/test/dummy_app/config/boot.rb

@@ -0,0 +1,10 @@
+require 'rubygems'
+gemfile = File.expand_path('../../../../Gemfile', __FILE__)
+
+if File.exist?(gemfile)
+  ENV['BUNDLE_GEMFILE'] = gemfile
+  require 'bundler'
+  Bundler.setup
+end
+
+$:.unshift File.expand_path('../../../../lib', __FILE__)

data/test/dummy_app/config/database.yml

@@ -0,0 +1,20 @@
+default: &default
+<% if defined?(SQLite3) %>
+  adapter: sqlite3
+  database: ':memory:'
+
+<% elsif defined?(Mysql2) %>
+  adapter: mysql2
+  database: active_snapshot_test
+
+<% elsif defined?(PG) %>
+  adapter: postgresql
+  database: active_snapshot_test
+
+<% end %>
+
+development:
+  <<: *default
+
+test:
+  <<: *default

data/test/dummy_app/config/environment.rb

@@ -0,0 +1,5 @@
+# Load the rails application
+require File.expand_path('../application', __FILE__)
+
+# Initialize the rails application
+Dummy::Application.initialize!

data/test/dummy_app/config/environments/development.rb

@@ -0,0 +1,30 @@
+Dummy::Application.configure do
+  # Settings specified here will take precedence over those in config/application.rb
+
+  # In the development environment your application's code is reloaded on
+  # every request.  This slows down response time but is perfect for development
+  # since you don't have to restart the web server when you make code changes.
+  config.cache_classes = false
+
+  # Log error messages when you accidentally call methods on nil.
+  config.whiny_nils = true
+
+  # Show full error reports and disable caching
+  config.consider_all_requests_local       = true
+  config.action_controller.perform_caching = false
+
+  # Don't care if the mailer can't send
+  config.action_mailer.raise_delivery_errors = false
+
+  # Print deprecation notices to the Rails logger
+  config.active_support.deprecation = :log
+
+  # Only use best-standards-support built into browsers
+  config.action_dispatch.best_standards_support = :builtin
+
+  # Do not compress assets
+  config.assets.compress = false
+
+  # Expands the lines which load the assets
+  config.assets.debug = true
+end

data/test/dummy_app/config/environments/production.rb

@@ -0,0 +1,60 @@
+Dummy::Application.configure do
+  # Settings specified here will take precedence over those in config/application.rb
+
+  # Code is not reloaded between requests
+  config.cache_classes = true
+
+  # Full error reports are disabled and caching is turned on
+  config.consider_all_requests_local       = false
+  config.action_controller.perform_caching = true
+
+  # Disable Rails's static asset server (Apache or nginx will already do this)
+  config.serve_static_files = false
+
+  # Compress JavaScripts and CSS
+  config.assets.compress = true
+
+  # Don't fallback to assets pipeline if a precompiled asset is missed
+  config.assets.compile = false
+
+  # Generate digests for assets URLs
+  config.assets.digest = true
+
+  # Defaults to Rails.root.join("public/assets")
+  # config.assets.manifest = YOUR_PATH
+
+  # Specifies the header that your server uses for sending files
+  # config.action_dispatch.x_sendfile_header = "X-Sendfile" # for apache
+  # config.action_dispatch.x_sendfile_header = 'X-Accel-Redirect' # for nginx
+
+  # Force all access to the app over SSL, use Strict-Transport-Security, and use secure cookies.
+  # config.force_ssl = true
+
+  # See everything in the log (default is :info)
+  # config.log_level = :debug
+
+  # Use a different logger for distributed setups
+  # config.logger = SyslogLogger.new
+
+  # Use a different cache store in production
+  # config.cache_store = :mem_cache_store
+
+  # Enable serving of images, stylesheets, and JavaScripts from an asset server
+  # config.action_controller.asset_host = "http://assets.example.com"
+
+  # Precompile additional assets (application.js, application.css, and all non-JS/CSS are already added)
+  # config.assets.precompile += %w( search.js )
+
+  # Disable delivery errors, bad email addresses will be ignored
+  # config.action_mailer.raise_delivery_errors = false
+
+  # Enable threaded mode
+  # config.threadsafe!
+
+  # Enable locale fallbacks for I18n (makes lookups for any locale fall back to
+  # the I18n.default_locale when a translation can not be found)
+  config.i18n.fallbacks = true
+
+  # Send deprecation notices to registered listeners
+  config.active_support.deprecation = :notify
+end