quaid 0.0.1 → 0.0.2

data/.rspec

@@ -0,0 +1,3 @@
+--color
+--fail-fast
+--drb

data/.travis.yml

@@ -0,0 +1,5 @@
+language: ruby
+rvm:
+  - "1.9.3"
+services: mongodb
+script: bundle exec rspec spec

data/Gemfile

@@ -1,4 +1,25 @@
-source 'https://rubygems.org'
+source :rubygems
 
 # Specify your gem's dependencies in quaid.gemspec
 gemspec
+
+group :test do
+  gem 'rspec'
+  gem 'fuubar'
+  gem 'rb-fsevent'
+  gem 'spork'
+  gem 'faker'
+  gem 'database_cleaner'
+  gem 'factory_girl'
+end
+
+group :development do
+  gem 'terminal-notifier-guard'
+  gem 'guard'
+  gem 'guard-rspec'
+  gem 'guard-bundler'
+  gem 'guard-spork'
+  gem 'rb-inotify', :require => false
+  gem 'rb-fsevent', :require => false
+  gem 'rb-fchange', :require => false
+end

data/Guardfile

@@ -0,0 +1,23 @@
+# A sample Guardfile
+# More info at https://github.com/guard/guard#readme
+
+guard :bundler do
+  watch('Gemfile')
+  watch(/^.+\.gemspec/)
+end
+
+guard :spork do
+  watch('Gemfile')
+  watch('Gemfile.lock')
+  watch('spec/spec_helper.rb') { :rspec }
+end
+
+guard :rspec do
+  watch(%r{^spec/.+_spec\.rb$})
+  watch(%r{^lib/(.+)\.rb$})     { |m| "spec/lib/#{m[1]}_spec.rb" }
+  watch('spec/spec_helper.rb')  { "spec" }
+
+  watch(%r{^spec/support/(.+)\.rb$})                  { "spec" }
+end
+
+

data/README.md

@@ -1,3 +1,4 @@
+[![Build Status](https://travis-ci.org/musicglue/quaid.png?branch=master)](https://travis-ci.org/musicglue/quaid)
 # Quaid
 
 TODO: Write a gem description

data/lib/mongoid/quaid.rb

@@ -5,27 +5,48 @@ module Mongoid
     included do |klass|
       field :version,     type: Integer,  default: 0
 
-      has_many :versions, class_name: self.to_s + "::Version", foreign_key: "owner_id"
+      has_many :versions, class_name: self.to_s + "::Version", foreign_key: "owner_id", dependent: :destroy
 
       def last_version
-        self.class.new versions[1].attributes
+        self.class.new versions[1].try(:attributes)
       end
 
-      klass.class_eval %Q{
-        set_callback :save, :before do |doc|
-          doc.version += 1
-        end
+      set_callback :save, :before do |doc|
+        doc.version += 1
+      end
 
-        set_callback :save, :after do |doc|
-          attributes = MultiJson.decode MultiJson.encode doc
-          Version.create(attributes.merge(owner_id: doc.id, deleted_at: DateTime.now))
+      set_callback :save, :after do |doc|
+        attributes = MultiJson.decode MultiJson.encode doc
+        doc.class::Version.create(attributes.merge(owner_id: doc.id))
+        doc.last_version.try(:set, {deleted_at: DateTime.now})
+        if doc.class.versions && doc.versions.count > doc.class.versions
+          doc.versions.last.delete
         end
+      end
 
+      module_eval <<-RUBY, __FILE__, __LINE__ + 1
+        class << self
+          attr_accessor :versions
+          def quaid opts={}
+            return unless opts[:versions]
+            @versions = opts[:versions]
+          end
+
+          def find_with_version id, version
+            v = Version.where(owner_id: id, version: version).first.try(:attributes)
+            if v.nil?
+              nil
+            else
+              new v
+            end
+          end
+        end
 
         class Version
           include Mongoid::Document
           include Mongoid::Timestamps
-
+          include Mongoid::Paranoia
+          
           store_in collection: self.to_s.underscore.gsub("/version", "") + "_versions"
 
           def initialize(attributes={}, options=nil)
@@ -35,8 +56,10 @@ module Mongoid
 
           index owner_id: 1
           default_scope desc(:created_at)
+
+          field :deleted_at, type: DateTime
         end
-      }
+      RUBY
     end
 
     module ClassMethods

data/lib/quaid/version.rb

@@ -1,3 +1,3 @@
 module Quaid
-  VERSION = "0.0.1"
+  VERSION = "0.0.2"
 end

data/quaid.gemspec

@@ -10,12 +10,13 @@ Gem::Specification.new do |gem|
   gem.email         = ["john@musicglue.com", "adam@musicglue.com"]
   gem.description   = %q{Total Recall for Mongoid}
   gem.summary       = %q{...}
-  gem.homepage      = "http://github.com/musicglue/quaid"
+  gem.homepage      = "https://github.com/musicglue/quaid"
 
   gem.files         = `git ls-files`.split($/)
   gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
   gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
   gem.require_paths = ["lib"]
 
-  gem.add_dependency  'mongoid', '~> 3.0.14'
+  gem.add_dependency 'mongoid', '~> 3.0.14'
+  gem.add_dependency 'activesupport', '~> 3.2.0'
 end

data/spec/factories/item_factory.rb

@@ -0,0 +1,5 @@
+FactoryGirl.define do
+  factory :item do
+    name { Faker::Name.name }
+  end
+end

data/spec/factories/list_factory.rb

@@ -0,0 +1,5 @@
+FactoryGirl.define do
+  factory :list do
+    name { Faker::Name.name }
+  end
+end

data/spec/factories/max_versions_project_factory.rb

@@ -0,0 +1,5 @@
+FactoryGirl.define do
+  factory :max_versions_project do
+    name { Faker::Name.name }
+  end
+end

data/spec/factories/paranoid_project_factory.rb

@@ -0,0 +1,5 @@
+FactoryGirl.define do
+  factory :paranoid_project do
+    name { Faker::Name.name }
+  end
+end

data/spec/factories/project_factory.rb

@@ -0,0 +1,5 @@
+FactoryGirl.define do
+  factory :project do
+    name { Faker::Name.name }
+  end
+end

data/spec/lib/embedded_docs_spec.rb

@@ -0,0 +1,24 @@
+require 'spec_helper'
+
+describe Mongoid::Quaid do
+
+  before do
+    @list = create(:list)
+    @list.items << build(:item)
+    @list.save
+    @list.reload
+  end
+
+  it "should save a version on adding an item" do
+    @list.versions.size.should eq(2)
+  end
+
+  it "should correctly instantiate embedded docs in saved versions" do
+    @list.name = Faker::Name.name
+    @list.save
+    @list.reload
+    @list.last_version.items.first.class.should eq(Item)
+    @list.last_version.items.first.name.should eq(@list.items.first.name)
+  end
+
+end

data/spec/lib/paranoia_spec.rb

@@ -0,0 +1,18 @@
+require 'spec_helper'
+
+describe Mongoid::Quaid do
+
+  context "paranoid classes" do
+
+    before do
+      @project = create(:paranoid_project)
+    end
+
+    it "should not destroy associated documents when parent is destroyed" do
+      @project.destroy
+      ParanoidProject::Version.unscoped.count.should eq(1)
+    end
+
+  end
+
+end

data/spec/lib/quaid_spec.rb

@@ -0,0 +1,78 @@
+require 'spec_helper'
+
+describe Mongoid::Quaid do
+
+  context "Make like Rekall and..." do
+
+    before do
+      @project = create(:project)
+    end
+
+    it "should include Quaid" do
+      @project.class.ancestors.should include(Mongoid::Quaid)
+    end
+
+    it "should create a Project::Version class" do
+      Project.should have_constant(:Version)
+    end
+
+    it "should persist versions for projects in the project_versions collection" do
+      Project::Version.collection_name.should eq(:project_versions)
+    end
+
+    it "should have a version of 1" do
+      @project.version.should eq(1)
+    end
+
+    it "should have created a saved version" do
+      Project::Version.count.should eq(1)
+    end
+
+    it "should have access to its last version through #last_version" do
+      @project.last_version.version.should eq(0)
+    end
+
+    it "should return an arbitrary version" do
+      old_name = @project.name
+      @project.name = Faker::Name.name
+      @project.save
+      old_proj = Project.find_with_version(@project.id, 1)
+      old_proj.version.should eq(1)
+    end
+
+    it "should create a new version with the current attributes if updated" do
+      old_name = @project.name
+      @project.name = Faker::Name.name
+      @project.save
+      @project.reload
+      @project.last_version.version.should eq(1)
+      @project.last_version.name.should eq(old_name)
+    end
+
+    it "should create a new version with each save" do
+      n = 10
+      lambda {
+        n.times {
+          @project.name = Faker::Name.name
+          @project.save
+        }
+      }.should change{ Project::Version.count }.from(1).to(n+1)
+    end
+
+    it "should order the versions by their creation date descending" do
+      5.times {
+        @project.name = Faker::Name.name
+        @project.save
+      }
+      Project::Version.last.version.should eq(1)
+    end
+
+    it "should destroy associated versions when record is destroy" do
+      id = @project.id
+      @project.destroy
+      Project::Version.where(owner_id: id).count.should eq(0)
+    end
+
+  end
+
+end

data/spec/lib/version_limit_spec.rb

@@ -0,0 +1,26 @@
+require 'spec_helper'
+
+describe Mongoid::Quaid do
+
+  before do
+    @project = create(:max_versions_project)
+  end
+
+  it "should limit the maximum number of versions that can be stored" do
+    5.times {
+      @project.name = Faker::Name.new
+      @project.save
+    }
+    @project.versions.count.should eq(5)
+  end
+
+  it "should retain the most recent versions when limited" do
+    5.times {
+      @project.name = Faker::Name.new
+      @project.save
+    }
+    @project.reload
+    @project.versions.last.version.should eq(2)
+  end
+
+end

data/spec/mongoid.yml

@@ -0,0 +1,9 @@
+test:
+  sessions:
+    default:
+      hosts:
+        - localhost:27017
+      database: quaid-test
+      options:
+        identity_map_enabled: false
+        safe: false

data/spec/spec_helper.rb

@@ -0,0 +1,44 @@
+require 'rubygems'
+require 'bundler/setup'
+require 'spork'
+require 'guard/rspec'
+require 'rspec'
+
+Spork.prefork do
+  require 'factory_girl'
+  require 'database_cleaner'
+  require 'faker'
+  require 'mongoid'
+  require 'quaid'
+  Mongoid.load!(File.expand_path("../mongoid.yml", __FILE__), :test)
+
+  RSpec.configure do |config|
+    config.include FactoryGirl::Syntax::Methods
+
+    config.before(:suite) do
+      DatabaseCleaner.strategy = :truncation
+      DatabaseCleaner.clean
+    end
+
+    config.after(:each) do
+      DatabaseCleaner.clean
+    end
+  end
+
+  Dir['./spec/support/**/*.rb'].each{ |file| require file }
+end
+
+Spork.each_run do
+  require 'quaid'
+  FactoryGirl.find_definitions
+end
+
+
+
+
+
+
+
+
+
+

data/spec/support/models/item.rb

@@ -0,0 +1,7 @@
+class Item
+  include Mongoid::Document
+
+  field :name, type: String
+
+  embedded_in :list
+end

data/spec/support/models/list.rb

@@ -0,0 +1,8 @@
+class List
+  include Mongoid::Document
+  include Mongoid::Quaid
+
+  field :name, type: String
+  embeds_many :items
+
+end

data/spec/support/models/max_versions_project.rb

@@ -0,0 +1,8 @@
+class MaxVersionsProject
+  include Mongoid::Document
+  include Mongoid::Quaid
+
+  field :name, type: String
+
+  quaid versions: 5
+end

data/spec/support/models/paranoid_project.rb

@@ -0,0 +1,8 @@
+class ParanoidProject
+  include Mongoid::Document
+  include Mongoid::Quaid
+  include Mongoid::Paranoia
+
+  field :name, type: String
+
+end

data/spec/support/models/project.rb

@@ -0,0 +1,6 @@
+class Project
+  include Mongoid::Document
+  include Mongoid::Quaid
+
+  field :name, type: String
+end

data/spec/support/utilities.rb

@@ -0,0 +1,5 @@
+RSpec::Matchers.define :have_constant do |const|
+  match do |owner|
+    owner.const_defined?(const)
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: quaid
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
   prerelease: 
 platform: ruby
 authors:
@@ -12,7 +12,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-12-03 00:00:00.000000000 Z
+date: 2013-01-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: mongoid
@@ -30,6 +30,22 @@ dependencies:
     - - ~>
       - !ruby/object:Gem::Version
         version: 3.0.14
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 3.2.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 3.2.0
 description: Total Recall for Mongoid
 email:
 - john@musicglue.com
@@ -39,7 +55,10 @@ extensions: []
 extra_rdoc_files: []
 files:
 - .gitignore
+- .rspec
+- .travis.yml
 - Gemfile
+- Guardfile
 - LICENSE.txt
 - README.md
 - Rakefile
@@ -47,7 +66,24 @@ files:
 - lib/quaid.rb
 - lib/quaid/version.rb
 - quaid.gemspec
-homepage: http://github.com/musicglue/quaid
+- spec/factories/item_factory.rb
+- spec/factories/list_factory.rb
+- spec/factories/max_versions_project_factory.rb
+- spec/factories/paranoid_project_factory.rb
+- spec/factories/project_factory.rb
+- spec/lib/embedded_docs_spec.rb
+- spec/lib/paranoia_spec.rb
+- spec/lib/quaid_spec.rb
+- spec/lib/version_limit_spec.rb
+- spec/mongoid.yml
+- spec/spec_helper.rb
+- spec/support/models/item.rb
+- spec/support/models/list.rb
+- spec/support/models/max_versions_project.rb
+- spec/support/models/paranoid_project.rb
+- spec/support/models/project.rb
+- spec/support/utilities.rb
+homepage: https://github.com/musicglue/quaid
 licenses: []
 post_install_message: 
 rdoc_options: []
@@ -71,5 +107,22 @@ rubygems_version: 1.8.24
 signing_key: 
 specification_version: 3
 summary: ! '...'
-test_files: []
+test_files:
+- spec/factories/item_factory.rb
+- spec/factories/list_factory.rb
+- spec/factories/max_versions_project_factory.rb
+- spec/factories/paranoid_project_factory.rb
+- spec/factories/project_factory.rb
+- spec/lib/embedded_docs_spec.rb
+- spec/lib/paranoia_spec.rb
+- spec/lib/quaid_spec.rb
+- spec/lib/version_limit_spec.rb
+- spec/mongoid.yml
+- spec/spec_helper.rb
+- spec/support/models/item.rb
+- spec/support/models/list.rb
+- spec/support/models/max_versions_project.rb
+- spec/support/models/paranoid_project.rb
+- spec/support/models/project.rb
+- spec/support/utilities.rb
 has_rdoc: