snaps 0.0.1

checksums.yaml

@@ -0,0 +1,15 @@
+---
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    ODEzZWE0YzA0MjY2NTVhYmMxOTE3MGMwNWRjZmM3ZTNlMjcyYjIyYg==
+  data.tar.gz: !binary |-
+    M2RjYmJhZmUxYjE1Njc1YjY1YWQ5N2VhOGEyZGIyOTIxMDAxNWFjYw==
+SHA512:
+  metadata.gz: !binary |-
+    MTU2NGY4ODcxOTcxZTJkYjI5NDFkZTlmNDJmMTgwMmVjMGVmNzZlMmQ2N2Zj
+    ODhmOTFlZThkZDZmYzk2NzI1ZDI2Njg0YWIzMWUyNWQyYjlmNDRiZTdiZWIw
+    MTVhOWQxNWMzNzg5YmI0NGE3YjBmNDNiNDE5ZDgzMGE5MzcwOGQ=
+  data.tar.gz: !binary |-
+    Nzc3MTAwMGMyNjE4Y2JmNjc4MDdkM2I3YWM1ZjgyYjI4NjE5YTkxNGUwMWY2
+    MjNhNzkwYzk3ZGM3MzY4MjNmMWFjNTEwZTZlZTE2NzNmZDU1YzlkNzlmZjIx
+    ODdlNmIwOGM1NTM2MTM3NTU0NzA2MGY5YzZkNWNlN2I4YzgwYjM=

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2015 Vangelis Tsoumenis
+
+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,157 @@
+# Snaps
+
+[![Gem Version](https://badge.fury.io/rb/snaps.svg)](http://badge.fury.io/rb/snaps)
+[![Build Status](https://travis-ci.org/codevise/snaps.svg?branch=master)](https://travis-ci.org/codevise/snaps)
+[![Test Coverage](https://codeclimate.com/github/codevise/snaps/badges/coverage.svg)](https://codeclimate.com/github/codevise/snaps)
+[![Code Climate](https://codeclimate.com/github/codevise/snaps/badges/gpa.svg)](https://codeclimate.com/github/codevise/snaps)
+
+Revisioning and tagging of ActiveRecord models.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'snaps'
+
+And then execute:
+
+    $ bundle
+
+Run the install generator:
+
+    $ rake snaps:install:migrations
+
+Migrate your database to create the `snaps_tags` table:
+
+    $ rake db:migrate
+
+## Basics
+
+Snaps maintains a table of "named pointers" called Tags to other models. Implemented as a polymorphic association. Revisions are kept in the original table and identified by a `perma_id` field.
+
+Snaps provides methods to create copies (snapshots) of models and tag these snapshots as needed.
+
+## Usage Examples
+
+### Basic Usage
+
+A model that is to be revisioned with snaps needs an integer field called `perma_id` and must include the mixin created by `Snaps.revision`.
+
+    # db/migrate/xxx_create_posts.rb
+    create_table :posts do |t|
+      t.integer(:perma_id)
+
+      t.string(:title)
+      t.text(:body)
+    end
+
+
+    # app/models/post.rb
+    class Post < ActiveRecord::Base
+      include Snaps.revision
+    end
+
+
+Now you can create snapshots of your post instances.
+
+    post = Posts.create(body: 'Some text')
+    post_snapshot = post.snapshot!
+
+    post.perma_id == post_snapshot.perma_id # => true
+
+Using Snaps Tags you can assign one revision to be a 'draft'.
+
+    post.perma_id # => 25
+    post.snaps_tag!(:draft)
+
+    draft = Post.with_snaps_tag(:draft).find_by_perma_id(25)
+
+### Using a default Tag
+
+It's easy to create a workflow in which a new post will be tagged by default.
+Also it's convenient to hide calls to `with_snaps_tag` in a scope on your domain models.
+
+
+    # app/models/post.rb
+    class Post < ActiveRecord::Base
+      include Snaps.revision(default_tag: :draft)
+
+      scope :drafts, -> { with_snaps_tag(:draft) }
+    end
+
+    # in controller
+    draft = Post.create(body: 'Some Text')
+
+    existing_draft = Post.drafts.find_by_perma_id(25)
+
+    draft.update(body: "New text")
+    draft.snapshot!
+
+### Managing Lifecycle of records with tags
+
+    # app/models/post.rb
+    class Post < ActiveRecord::Base
+      include Snaps.revision(default_tag: :draft)
+
+      scope :drafts, -> { with_snaps_tag(:draft) }
+      scope :published, -> { with_snaps_tag(:published) }
+
+      def publish
+        snapshot!(tag: :published)
+      end
+    end
+
+    # in controller
+    draft = Post.drafts.find_by_perma_id(25)
+    draft.publish
+
+    all_published_posts = Post.published
+
+### Revisioning composite models
+
+
+    # db/migrate/xxx_create_sections.rb
+    create_table :sections do |t|
+      t.integer(:perma_id)
+      t.references(:post)
+
+      t.text(:body)
+    end
+
+    # app/models/section.rb
+    class Section < ActiveRecord::Base
+      include Snaps.revision
+
+      belongs_to :post
+    end
+
+    # app/models/post.rb
+    class Post < ActiveRecord::Base
+      include Snaps.revision(default_tag: :draft,
+                             components: [:sections])
+
+      has_many :sections
+
+      scope :drafts, -> { with_snaps_tag(:draft) }
+      scope :published, -> { with_snaps_tag(:published) }
+
+      def publish
+        snapshot!(tag: :published)
+      end
+    end
+
+    # in controller
+
+    draft = Post.drafts.find_by_perma_id(25)
+    draft.sections.create(body: "Section text")
+    post = draft.snapshot!
+
+    # snapshots of sections have been created
+
+    draft.sections.first.id != post.sections.first.id
+    draft.sections.first.body == post.sections.first.body
+
+
+### Accessing other revisions of a record
+
+    post.snaps_revisions.where('created_at < ?', post.created_at)

data/Rakefile

@@ -0,0 +1,30 @@
+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    = 'Snaps'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+APP_RAKEFILE = File.expand_path("../spec/dummy/Rakefile", __FILE__)
+load 'rails/tasks/engine.rake'
+
+load 'rails/tasks/statistics.rake'
+
+
+Bundler::GemHelper.install_tasks
+
+# rspec
+require 'rspec/core'
+require 'rspec/core/rake_task'
+desc "Run all specs in spec directory (excluding plugin specs)"
+RSpec::Core::RakeTask.new(:spec => 'app:db:test:prepare')
+task :default => :spec

data/app/assets/javascripts/snaps/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/app/assets/stylesheets/snaps/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/app/controllers/snaps/application_controller.rb

@@ -0,0 +1,4 @@
+module Snaps
+  class ApplicationController < ActionController::Base
+  end
+end

data/app/helpers/snaps/application_helper.rb

@@ -0,0 +1,4 @@
+module Snaps
+  module ApplicationHelper
+  end
+end

data/app/models/concerns/snaps/suppressor.rb

@@ -0,0 +1,55 @@
+module Snaps
+  # ActiveRecord::Suppressor prevents the receiver from being saved during
+  # a given block.
+  #
+  # For example, here's a pattern of creating notifications when new comments
+  # are posted. (The notification may in turn trigger an email, a push
+  # notification, or just appear in the UI somewhere):
+  #
+  #   class Comment < ActiveRecord::Base
+  #     belongs_to :commentable, polymorphic: true
+  #     after_create -> { Notification.create! comment: self,
+  #       recipients: commentable.recipients }
+  #   end
+  #
+  # That's what you want the bulk of the time. New comment creates a new
+  # Notification. But there may well be off cases, like copying a commentable
+  # and its comments, where you don't want that. So you'd have a concern
+  # something like this:
+  #
+  #   module Copyable
+  #     def copy_to(destination)
+  #       Notification.suppress do
+  #         # Copy logic that creates new comments that we do not want
+  #         # triggering notifications.
+  #       end
+  #     end
+  #   end
+  module Suppressor
+    extend ActiveSupport::Concern
+
+    module ClassMethods
+      def suppress(&block)
+        SuppressorRegistry.suppressed[name] = true
+        yield
+      ensure
+        SuppressorRegistry.suppressed[name] = false
+      end
+    end
+
+    # Ignore saving events if we're in suppression mode.
+    def save!(*args) # :nodoc:
+      SuppressorRegistry.suppressed[self.class.name] ? true : super
+    end
+  end
+
+  class SuppressorRegistry # :nodoc:
+    extend ActiveSupport::PerThreadRegistry
+
+    attr_reader :suppressed
+
+    def initialize
+      @suppressed = {}
+    end
+  end
+end

data/app/models/snaps/tag.rb

@@ -0,0 +1,45 @@
+module Snaps
+  class Tag < ActiveRecord::Base
+    include Suppressor
+
+    belongs_to :record, polymorphic: true
+
+    before_save do |tag|
+      tag.record.snaps_untag!(tag.tag)
+    end
+
+    scope :current, -> do
+      where(superseded_at: nil)
+    end
+
+    scope :with_name, ->(name) do
+      where(tag: name)
+    end
+
+    def self.supersede!
+      current.update_all(superseded_at: Time.now)
+    end
+
+    def self.for_all_revisions_of(record)
+      joins(<<-SQL)
+        INNER JOIN #{record.class.table_name}
+        ON #{record.class.table_name}.id = snaps_tags.record_id
+        AND snaps_tags.record_type = '#{record.class.name}'
+        AND perma_id = #{record.perma_id}
+      SQL
+    end
+
+    def self.all_revisions_with_tag(model, tag)
+      model.joins(<<-SQL)
+        INNER JOIN snaps_tags
+        ON #{model.table_name}.id = snaps_tags.record_id
+        AND snaps_tags.record_type = '#{model.name}'
+        AND snaps_tags.tag = '#{tag}'
+      SQL
+    end
+
+    def self.current_revisions_with_tag(model, tag)
+      all_revisions_with_tag(model, tag).where('snaps_tags.superseded_at IS NULL')
+    end
+  end
+end

data/app/views/layouts/snaps/application.html.erb

@@ -0,0 +1,14 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title>Snaps</title>
+  <%= stylesheet_link_tag    "snaps/application", media: "all" %>
+  <%= javascript_include_tag "snaps/application" %>
+  <%= csrf_meta_tags %>
+</head>
+<body>
+
+<%= yield %>
+
+</body>
+</html>

data/config/routes.rb

@@ -0,0 +1,2 @@
+Snaps::Engine.routes.draw do
+end

data/db/migrate/20150321131740_create_snaps_tags.rb

@@ -0,0 +1,12 @@
+class CreateSnapsTags < ActiveRecord::Migration
+  def change
+    create_table :snaps_tags do |t|
+      t.integer :record_id
+      t.string :record_type
+      t.string :tag
+      t.timestamp :superseded_at
+
+      t.timestamps null: false
+    end
+  end
+end

data/lib/snaps.rb

@@ -0,0 +1,61 @@
+require "snaps/engine"
+require "snaps/snapshot"
+
+module Snaps
+  def self.revision(options={})
+    Module.new do
+      extend ActiveSupport::Concern
+
+      included do
+        before_save :ensure_perma_id
+        if options[:default_tag]
+          after_create do
+            snaps_tag!(options[:default_tag])
+          end
+        end
+      end
+
+      def snapshot!(options = {}, &block)
+        Snapshot.create(self,
+                        options.merge(self.class.snaps_options),
+                        &block)
+      end
+
+      def snaps_tag!(tag)
+        Tag.create!(
+          record: self,
+          tag: tag
+        )
+      end
+
+      def snaps_untag!(tag)
+        Tag
+          .for_all_revisions_of(self)
+          .with_name(tag)
+          .supersede!
+      end
+
+      def snaps_revisions
+         self.class.where(perma_id: perma_id)
+      end
+
+      def ensure_perma_id
+        self.perma_id ||= (self.class.maximum(:perma_id) || 0) + 1
+      end
+
+      class_methods do
+        def with_snaps_tag(tag, options={})
+          if options[:all_revisions]
+            Tag.all_revisions_with_tag(self, tag)
+          else
+            Tag.current_revisions_with_tag(self, tag)
+          end
+        end
+
+        define_method :snaps_options do
+          options
+        end
+      end
+    end
+  end
+end