redcrumbs 0.5.0 → 0.5.1

data/spec/redcrumbs/options_spec.rb

@@ -0,0 +1,70 @@
+require 'spec_helper'
+
+describe Redcrumbs::Options do
+  describe '.redcrumbs_callback_options' do
+    context 'with empty configuration' do
+      let!(:default_options) { Game.redcrumbs_options.dup }
+
+      before { Game.prepare_redcrumbed_options({}) }
+      after  { Game.prepare_redcrumbed_options(default_options) }
+
+      subject { Game.redcrumbs_callback_options }
+
+      it { is_expected.not_to have_key(:if) }
+      it { is_expected.not_to have_key(:unless) }
+    end
+
+    context 'with explicit configuration' do
+      let!(:options){ {:store => {:only =>[:id, :name]}, :if => :new_record?, :unless => :persisted?} }
+      let!(:default_options) { Game.redcrumbs_options.dup }
+
+      before { Game.prepare_redcrumbed_options(options) }
+      after  { Game.prepare_redcrumbed_options(default_options) }
+
+      subject { Game.redcrumbs_callback_options }
+
+      it { is_expected.to have_key(:if) }
+      it { is_expected.to have_key(:unless) }
+      it { is_expected.not_to have_key(:store) }
+
+      it { is_expected.to include(:if => :new_record?) }
+      it { is_expected.to include(:unless => :persisted?) }
+    end
+  end
+
+
+  describe '.redcrumbs_options' do
+    context 'with empty configuration' do
+      let!(:default_options) { Game.redcrumbs_options.dup }
+
+      before { Game.prepare_redcrumbed_options({}) }
+      after  { Game.prepare_redcrumbed_options(default_options) }
+
+      subject { Game.redcrumbs_options }
+
+      it { is_expected.to have_key(:only) }
+      it { is_expected.to have_key(:store) }
+
+      it { is_expected.to include(:only => []) }
+      it { is_expected.to include(:store => {}) }
+    end
+
+    context 'with explicit configuration' do
+      let!(:options){ {'only' => [:id, :name], :store => {:only => [:name]}} }
+      let!(:default_options) { Game.redcrumbs_options.dup }
+
+      before { Game.prepare_redcrumbed_options(options) }
+      after  { Game.prepare_redcrumbed_options(default_options) }
+
+      subject { Game.redcrumbs_options }
+
+      it { is_expected.to have_key(:only) }
+      it { is_expected.to have_key(:store) }
+
+      it { is_expected.not_to have_key('only')}
+
+      it { is_expected.to include(:only => [:id, :name]) }
+      it { is_expected.to include(:store => {:only => [:name]}) }
+    end
+  end
+end

data/spec/redcrumbs/serializable_association_spec.rb

@@ -0,0 +1,101 @@
+require 'spec_helper.rb'
+
+describe Redcrumbs::SerializableAssociation do
+  let(:foo) { Class.new { include Redcrumbs::SerializableAssociation } }
+
+  describe 'self.serializable_association' do
+    context 'when including module' do
+      subject { foo.new }
+      it { expect(foo).to respond_to(:serializable_association).with(1).argument }
+    end
+
+    context 'when given a valid association' do
+      subject { foo.new }
+      before  { foo.serializable_association(:creator) }
+
+      it { expect(foo.serializable_association(:creator)).to be_truthy }
+      it { is_expected.to respond_to(:creator_id).with(0).arguments }
+      it { is_expected.to respond_to(:creator_id=).with(1).arguments }
+      it { is_expected.to respond_to(:creator_type).with(0).arguments }
+      it { is_expected.to respond_to(:creator_type=).with(1).arguments }
+      it { is_expected.to respond_to(:stored_creator).with(0).arguments }
+      it { is_expected.to respond_to(:stored_creator=).with(1).arguments }
+      it { is_expected.to respond_to(:creator).with(0).arguments }
+      it { is_expected.to respond_to(:creator=).with(1).arguments }
+      it { is_expected.to respond_to(:full_creator).with(0).arguments }
+      it { is_expected.to respond_to(:has_loaded_creator?).with(0).arguments }
+    end
+
+    context 'when given an invalid association' do
+      subject { foo.new }
+      it { expect {foo.serializable_association(:bar)}.to raise_error(ArgumentError) }
+    end
+  end
+
+  context "inclusion of module" do
+    it 'should define a public load_associated method' do
+      expect(foo.new).to respond_to(:load_associated).with(1).arguments
+    end
+  end
+
+
+  describe '.serialize' do
+    let(:player) { Player.create(:name => "John Hope") }
+    let(:game) { Game.create(:name => 'Paperboy', :highscore => 0)}
+    let(:new_foo) { foo.new }
+
+    before { Redcrumbs.store_creator_attributes = [:id, :name] }
+
+    context 'when serializing subject' do
+      subject { new_foo.send('serialize', :subject, game) }
+      it { is_expected.to eq(game.attributes.slice('id', 'name')) }
+    end
+
+    context 'when serializing creator' do
+      subject { new_foo.send('serialize', :creator, player) }
+      it { is_expected.to eq(player.attributes.slice('id', 'name')) }
+    end
+  end
+
+
+  describe '.deserialize' do
+    let(:player) { Player.create(:name => "John Hope") }
+    let(:new_foo) { foo.new }
+
+    before { foo.serializable_association :creator }
+
+    context 'with no stored attributes' do
+      subject { new_foo.send('deserialize', :creator) }
+
+      it { is_expected.to be_nil }
+    end
+
+    context 'with stored attributes' do
+      before do
+        new_foo.creator_type = player.class.name
+        new_foo.stored_creator = {id: player.id, name: player.name}
+        new_foo.creator_id = player.id
+      end
+
+      subject { new_foo.send('deserialize', :creator) }
+
+      it { is_expected.to have_attributes(id: player.id) }
+      it { is_expected.to have_attributes(name: player.name) }
+    end
+
+    context 'when creator_type nil' do
+      before do 
+        Redcrumbs.creator_class_sym = :player
+
+        new_foo.stored_creator = { name: player.name }
+        new_foo.creator_id = player.id
+      end
+
+      after  { Redcrumbs.creator_class_sym = :user }
+
+      subject { new_foo.send('deserialize', :creator) }
+
+      it { is_expected.to have_attributes(name: player.name) }
+    end
+  end
+end

data/spec/redcrumbs/users_spec.rb

@@ -0,0 +1,55 @@
+require 'spec_helper.rb'
+
+describe Redcrumbs::Users do
+  let(:computer_player) { ComputerPlayer.create(:name => 'Jon Hope') }
+  let(:player) { Player.create(:name => 'Jon Hope') }
+
+  let!(:crumb_1) do 
+    c = Redcrumbs::Crumb.new
+    c.creator = computer_player
+    c.save
+    c
+  end
+
+  let!(:crumb_2) do 
+    c = Redcrumbs::Crumb.new
+    c.creator = computer_player
+    c.save
+    c
+  end
+
+  let!(:crumb_3) do 
+    c = Redcrumbs::Crumb.new
+    c.creator = player
+    c.target  = computer_player
+    c.save
+    c
+  end
+
+
+  describe '.crumbs_by' do
+    context 'when in reverse order' do
+      subject { computer_player.crumbs_by(:order => [:created_at.desc, :id.desc]) }
+
+      it { is_expected.to eq([crumb_2, crumb_1])}
+    end
+  end
+
+
+  describe '.crumbs_for' do
+    context 'when in reverse order' do
+      subject { computer_player.crumbs_for(:order => [:created_at.desc, :id.desc]) }
+
+      it { is_expected.to eq([crumb_3]) }
+    end
+  end
+
+
+  describe '.crumbs_as_user' do
+    context 'when in reverse order' do
+      subject { computer_player.crumbs_as_user(:order => [:created_at.desc, :id.desc]) }
+
+      it { is_expected.to eq([crumb_3, crumb_2, crumb_1]) }
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,27 @@
+require 'codeclimate-test-reporter'
+CodeClimate::TestReporter.start
+
+require 'redcrumbs'
+
+require 'bundler'
+Bundler.require(:test)
+
+RSpec.configure do |c|
+  c.before(:suite) do
+    Redcrumbs.redis = 'localhost:6379'
+    I18n.config.enforce_available_locales = true
+    CreateSchema.suppress_messages{ CreateSchema.migrate(:up) }
+  end
+
+  c.before(:each) do
+    Redcrumbs.redis.flushdb
+  end
+
+  c.after(:suite) do
+    Redcrumbs.redis.flushdb
+  end
+
+  c.mock_with :rspec
+end
+
+Dir[File.expand_path('../support/*.rb', __FILE__)].each{|f| require f }

data/spec/support/models.rb

@@ -0,0 +1,34 @@
+class Player < ActiveRecord::Base
+  has_many :victories, as: :high_scorer
+end
+
+class ComputerPlayer < ActiveRecord::Base
+  has_many :victories, as: :high_scorer
+end
+
+class Game < ActiveRecord::Base
+  redcrumbed only: [:name, :highscore], store: {only: [:id, :name]}
+
+  belongs_to :high_scorer, polymorphic: true
+
+  alias :creator :high_scorer
+
+  # Target is whoever is being dispossessed of the top spot
+  #
+  def target
+    high_scorer_was if high_scorer_changed?
+  end
+
+  private
+
+  def high_scorer_changed?
+    high_scorer_id_was != high_scorer_id or 
+    high_scorer_type_was != high_scorer_type
+  end
+
+  def high_scorer_was
+    if high_scorer_id_was.present? and high_scorer_type_was.present?
+      high_scorer_type_was.constantize.find(high_scorer_id_was)
+    end
+  end
+end

data/spec/support/schema.rb

@@ -0,0 +1,26 @@
+ActiveRecord::Base.establish_connection(
+  :adapter  => 'sqlite3',
+  :database => ':memory:'
+)
+
+class CreateSchema < ActiveRecord::Migration
+  def self.up
+    create_table :computer_players, :force => true do |t|
+      t.string :name
+      t.timestamps
+    end
+
+    create_table :players, :force => true do |t|
+      t.string :name
+      t.timestamps
+    end
+
+    create_table :games, :force => true do |t|
+      t.references :high_scorer, :polymorphic => true
+      t.string :name
+      t.string :platform
+      t.integer :highscore
+      t.timestamps
+    end
+  end
+end

metadata

@@ -1,109 +1,181 @@
 --- !ruby/object:Gem::Specification
 name: redcrumbs
 version: !ruby/object:Gem::Version
-  version: 0.5.0
-  prerelease: 
+  version: 0.5.1
 platform: ruby
 authors:
 - John Hope
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-07-05 00:00:00.000000000 Z
+date: 2014-11-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: data_mapper
-  requirement: &70244416746320 !ruby/object:Gem::Requirement
-    none: false
+  requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: 1.2.0
   type: :runtime
   prerelease: false
-  version_requirements: *70244416746320
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 1.2.0
+- !ruby/object:Gem::Dependency
+  name: redis
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 2.2.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 2.2.2
 - !ruby/object:Gem::Dependency
   name: dm-redis-adapter
-  requirement: &70244416741460 !ruby/object:Gem::Requirement
-    none: false
+  requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - ! '>='
       - !ruby/object:Gem::Version
         version: 0.6.2
   type: :runtime
   prerelease: false
-  version_requirements: *70244416741460
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 0.6.2
 - !ruby/object:Gem::Dependency
-  name: redis
-  requirement: &70244416737940 !ruby/object:Gem::Requirement
-    none: false
+  name: redis-namespace
+  requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - ! '>='
       - !ruby/object:Gem::Version
-        version: 2.2.2
+        version: 1.3.0
   type: :runtime
   prerelease: false
-  version_requirements: *70244416737940
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 1.3.0
 - !ruby/object:Gem::Dependency
-  name: redis-namespace
-  requirement: &70244416736920 !ruby/object:Gem::Requirement
-    none: false
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '3.1'
+    - - <
+      - !ruby/object:Gem::Version
+        version: '5'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '3.1'
+    - - <
+      - !ruby/object:Gem::Version
+        version: '5'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
-        version: 1.1.0
+        version: '3.1'
+    - - <
+      - !ruby/object:Gem::Version
+        version: '5'
   type: :runtime
   prerelease: false
-  version_requirements: *70244416736920
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '3.1'
+    - - <
+      - !ruby/object:Gem::Version
+        version: '5'
 description: Fast and unobtrusive activity tracking of ActiveRecord models using DataMapper
   and Redis
 email:
-- info@midhirrecords.com
+- john@shiftdock.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
 - .gitignore
+- .travis.yml
 - Gemfile
+- LICENSE
 - README.md
 - Rakefile
-- app/models/redcrumbs/crumb.rb
-- app/models/redcrumbs/crumb/expiry.rb
-- app/models/redcrumbs/crumb/getters.rb
-- app/models/redcrumbs/crumb/setters.rb
+- gemfiles/Gemfile.rails-3.1.x
+- gemfiles/Gemfile.rails-3.2.x
+- gemfiles/Gemfile.rails-4.0.x
+- gemfiles/Gemfile.rails-4.1.x
 - lib/generators/redcrumbs/install_generator.rb
 - lib/generators/redcrumbs/templates/initializer.rb
 - lib/redcrumbs.rb
 - lib/redcrumbs/config.rb
 - lib/redcrumbs/creation.rb
-- lib/redcrumbs/engine.rb
+- lib/redcrumbs/crumb.rb
 - lib/redcrumbs/options.rb
+- lib/redcrumbs/serializable_association.rb
 - lib/redcrumbs/users.rb
 - lib/redcrumbs/version.rb
 - redcrumbs.gemspec
-homepage: https://github.com/projectzebra/Redcrumbs
-licenses: []
+- spec/redcrumbs/config_spec.rb
+- spec/redcrumbs/creation_spec.rb
+- spec/redcrumbs/crumb_spec.rb
+- spec/redcrumbs/options_spec.rb
+- spec/redcrumbs/serializable_association_spec.rb
+- spec/redcrumbs/users_spec.rb
+- spec/spec_helper.rb
+- spec/support/models.rb
+- spec/support/schema.rb
+homepage: https://github.com/JonMidhir/Redcrumbs
+licenses:
+- MIT
+metadata: {}
 post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: redcrumbs
-rubygems_version: 1.8.10
+rubygems_version: 2.2.2
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: Fast and unobtrusive activity tracking of ActiveRecord models using DataMapper
   and Redis
-test_files: []
+test_files:
+- spec/redcrumbs/config_spec.rb
+- spec/redcrumbs/creation_spec.rb
+- spec/redcrumbs/crumb_spec.rb
+- spec/redcrumbs/options_spec.rb
+- spec/redcrumbs/serializable_association_spec.rb
+- spec/redcrumbs/users_spec.rb
+- spec/spec_helper.rb
+- spec/support/models.rb
+- spec/support/schema.rb