acts_as_saveable 0.10.1

data/spec/shared_example/saver_model_spec.rb

@@ -0,0 +1,275 @@
+shared_examples "a saver_model" do
+  let (:saveable_klass) { saveable.class }
+
+  it "should be saved on after a saver has saved" do
+    saveable.save_by :saver => saver
+    expect(saver.saved_on?(saveable)).to be true
+    expect(saver.saved_for?(saveable)).to be true
+  end
+
+  it "should not be saved on if a saver has not saved" do
+    expect(saver.saved_on?(saveable)).to be false
+  end
+
+  it "should be saved on after a saver has saved under scope" do
+    saveable.save_by :saver => saver, :save_scope => 'rank'
+    expect(saver.saved_on?(saveable, :save_scope => 'rank')).to be true
+  end
+
+  it "should not be saved on other scope after a saver has saved under one scope" do
+    saveable.save_by :saver => saver, :save_scope => 'rank'
+    expect(saver.saved_on?(saveable)).to be false
+  end
+
+  it "should be saved as true when a saver has saved true" do
+    saveable.save_by :saver => saver
+    expect(saver.saved_as_when_saved_on(saveable)).to be true
+    expect(saver.saved_as_when_saved_for(saveable)).to be true
+  end
+
+  it "should be saved as true when a saver has saved true under scope" do
+    saveable.save_by :saver => saver, :save_scope => 'rank'
+    expect(saver.saved_as_when_saved_for(saveable, :save_scope => 'rank')).to be true
+  end
+
+  it "should be saved as false when a saver has saved false" do
+    saveable.save_by :saver => saver, :saved => false
+    expect(saver.saved_as_when_saved_for(saveable)).to be false
+  end
+
+  it "should be saved as false when a saver has saved false under scope" do
+    saveable.save_by :saver => saver, :saved => false, :save_scope => 'rank'
+    expect(saver.saved_as_when_saved_for(saveable, :save_scope => 'rank')).to be false
+  end
+
+  it "should be saved as nil when a saver has never saved" do
+    expect(saver.saved_as_when_saving_on(saveable)).to be nil
+  end
+
+  it "should be saved as nil when a saver has never saved under the scope" do
+    saveable.save_by :saver => saver, :saved => false, :save_scope => 'rank'
+    expect(saver.saved_as_when_saving_on(saveable)).to be nil
+  end
+
+  it "should return true if saver has saved true" do
+    saveable.save_by :saver => saver
+    expect(saver.saved_up_on?(saveable)).to be true
+  end
+
+  it "should return false if saver has not saved true" do
+    saveable.save_by :saver => saver, :saved => false
+    expect(saver.saved_up_on?(saveable)).to be false
+  end
+
+  it "should return true if the saver has saved false" do
+    saveable.save_by :saver => saver, :saved => false
+    expect(saver.saved_down_on?(saveable)).to be true
+  end
+
+  it "should return false if the saver has not saved false" do
+    saveable.save_by :saver => saver, :saved => true
+    expect(saver.saved_down_on?(saveable)).to be false
+  end
+
+  it "should provide reserve functionality, saver can saved on saveable" do
+    saver.saved :saveable => saveable, :saved => 'bad'
+    expect(saver.saved_as_when_saving_on(saveable)).to be false
+  end
+
+  it "should allow the saver to saved up a model" do
+    saver.save_up_for saveable
+    expect(saveable.get_up_saves.first.saver).to eq(saver)
+    expect(saveable.saves_for.up.first.saver).to eq(saver)
+  end
+
+  it "should allow the saver to saved down a model" do
+    saver.save_down_for saveable
+    expect(saveable.get_down_saves.first.saver).to eq(saver)
+    expect(saveable.saves_for.down.first.saver).to eq(saver)
+  end
+
+  it "should allow the saver to unsaved a model" do
+    saver.save_up_for saveable
+    saver.unsave_for saveable
+    expect(saveable.find_saves_for.size).to eq(0)
+    expect(saveable.saves_for.count).to eq(0)
+  end
+
+  it "should get all of the savers saves" do
+    saver.save_up_for saveable
+    expect(saver.find_saves.size).to eq(1)
+    expect(saver.saves.up.count).to eq(1)
+  end
+
+  it "should get all of the savers up saves" do
+    saver.save_up_for saveable
+    expect(saver.find_up_saves.size).to eq(1)
+    expect(saver.saves.up.count).to eq(1)
+  end
+
+  it "should get all of the savers down saves" do
+    saver.save_down_for saveable
+    expect(saver.find_down_saves.size).to eq(1)
+    expect(saver.saves.down.count).to eq(1)
+  end
+
+  it "should get all of the saves saves for a class" do
+    saveable.save_by :saver => saver
+    saveable2.save_by :saver => saver, :saved => false
+    expect(saver.find_saves_for_class(saveable_klass).size).to eq(2)
+    expect(saver.saves.for_type(saveable_klass).count).to eq(2)
+  end
+
+  it "should get all of the savers up saves for a class" do
+    saveable.save_by :saver => saver
+    saveable2.save_by :saver => saver, :saved => false
+    expect(saver.find_up_saves_for_class(saveable_klass).size).to eq(1)
+    expect(saver.saves.up.for_type(saveable_klass).count).to eq(1)
+  end
+
+  it "should get all of the savers down saves for a class" do
+    saveable.save_by :saver => saver
+    saveable2.save_by :saver => saver, :saved => false
+    expect(saver.find_down_saves_for_class(saveable_klass).size).to eq(1)
+    expect(saver.saves.down.for_type(saveable_klass).count).to eq(1)
+  end
+
+  it "should be contained to instances" do
+    saver.saved :saveable => saveable, :saved => false
+    saver2.saved :saveable => saveable
+
+    expect(saver.saved_as_when_saving_on(saveable)).to be false
+  end
+
+  describe '#find_saved_items' do
+    it 'returns objects that a user has upsaved for' do
+      saveable.save_by :saver => saver
+      saveable2.save_by :saver => saver2
+      expect(saver.find_saved_items).to include saveable
+      expect(saver.find_saved_items.size).to eq(1)
+    end
+
+    it 'returns objects that a user has upsaved for, using scope' do
+      saveable.save_by :saver => saver, :save_scope => 'rank'
+      saveable2.save_by :saver => saver2, :save_scope => 'rank'
+      expect(saver.find_saved_items(:save_scope => 'rank')).to include saveable
+      expect(saver.find_saved_items(:save_scope => 'rank').size).to eq(1)
+    end
+
+    it 'returns objects that a user has downsaved for' do
+      saveable.save_down saver
+      saveable2.save_down saver2
+      expect(saver.find_saved_items).to include saveable
+      expect(saver.find_saved_items.size).to eq(1)
+    end
+
+    it 'returns objects that a user has downsaved for, using scope' do
+      saveable.save_down saver, :save_scope => 'rank'
+      saveable2.save_down saver2, :save_scope => 'rank'
+      expect(saver.find_saved_items(:save_scope => 'rank')).to include saveable
+      expect(saver.find_saved_items(:save_scope => 'rank').size).to eq(1)
+    end
+  end
+
+  describe '#find_up_saved_items' do
+    it 'returns objects that a user has upsaved for' do
+      saveable.save_by :saver => saver
+      saveable2.save_by :saver => saver2
+      expect(saver.find_up_saved_items).to include saveable
+      expect(saver.find_up_saved_items.size).to eq(1)
+    end
+
+    it 'returns objects that a user has upsaved for, using scope' do
+      saveable.save_by :saver => saver, :save_scope => 'rank'
+      saveable2.save_by :saver => saver2, :save_scope => 'rank'
+      expect(saver.find_up_saved_items(:save_scope => 'rank')).to include saveable
+      expect(saver.find_up_saved_items(:save_scope => 'rank').size).to eq(1)
+    end
+
+    it 'does not return objects that a user has downsaved for' do
+      saveable.save_down saver
+      expect(saver.find_up_saved_items.size).to eq(0)
+    end
+
+    it 'does not return objects that a user has downsaved for, using scope' do
+      saveable.save_down saver, :save_scope => 'rank'
+      expect(saver.find_up_saved_items(:save_scope => 'rank').size).to eq(0)
+    end
+  end
+
+  describe '#find_down_saved_items' do
+    it 'does not return objects that a user has upsaved for' do
+      saveable.save_by :saver => saver
+      expect(saver.find_down_saved_items.size).to eq(0)
+    end
+
+    it 'does not return objects that a user has upsaved for, using scope' do
+      saveable.save_by :saver => saver, :save_scope => 'rank'
+      expect(saver.find_down_saved_items(:save_scope => 'rank').size).to eq(0)
+    end
+
+    it 'returns objects that a user has downsaved for' do
+      saveable.save_down saver
+      saveable2.save_down saver2
+      expect(saver.find_down_saved_items).to include saveable
+      expect(saver.find_down_saved_items.size).to eq(1)
+    end
+
+    it 'returns objects that a user has downsaved for, using scope' do
+      saveable.save_down saver, :save_scope => 'rank'
+      saveable2.save_down saver2, :save_scope => 'rank'
+      expect(saver.find_down_saved_items(:save_scope => 'rank')).to include saveable
+      expect(saver.find_down_saved_items(:save_scope => 'rank').size).to eq(1)
+    end
+
+ end
+
+  describe '#get_saved' do
+    subject { saver.get_saved(saveable.class) }
+
+    it 'returns objects of a class that a saver has saved for' do
+      saveable.save_by :saver => saver
+      saveable2.save_down saver
+      expect(subject).to include saveable
+      expect(subject).to include saveable2
+      expect(subject.size).to eq(2)
+    end
+
+    it 'does not return objects of a class that a saver has saved for' do
+      saveable.save_by :saver => saver2
+      saveable2.save_by :saver => saver2
+      expect(subject.size).to eq(0)
+    end
+  end
+
+  describe '#get_up_saved' do
+    subject { saver.get_up_saved(saveable.class) }
+
+    it 'returns up saved items that a saver has saved for' do
+      saveable.save_by :saver => saver
+      expect(subject).to include saveable
+      expect(subject.size).to eq(1)
+    end
+
+    it 'does not return down saved items a saver has saved for' do
+      saveable.save_down saver
+      expect(subject.size).to eq(0)
+    end
+  end
+
+  describe '#get_down_saved' do
+    subject { saver.get_down_saved(saveable.class) }
+
+    it 'does not return up saved items that a saver has saved for' do
+      saveable.save_by :saver => saver
+      expect(subject.size).to eq(0)
+    end
+
+    it 'returns down saved items a saver has saved for' do
+      saveable.save_down saver
+      expect(subject).to include saveable
+      expect(subject.size).to eq(1)
+    end
+  end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,132 @@
+$LOAD_PATH << File.join(File.dirname(__FILE__), '..', 'lib')
+require 'sqlite3'
+require 'acts_as_saveable'
+
+Dir["./spec/shared_example/**/*.rb"].sort.each {|f| require f}
+Dir["./spec/support/**/*.rb"].sort.each {|f| require f}
+
+ActiveRecord::Base.establish_connection(:adapter => "sqlite3", :database => ":memory:")
+
+ActiveRecord::Schema.define(:version => 1) do
+  create_table :saves do |t|
+    t.references :saveable, :polymorphic => true
+    t.references :saver, :polymorphic => true
+
+    t.boolean :save_flag
+    t.string :save_scope
+    t.integer :save_weight
+
+    t.timestamps
+  end
+
+  add_index :saves, [:saveable_id, :saveable_type]
+  add_index :saves, [:saver_id, :saver_type]
+  add_index :saves, [:saver_id, :saver_type, :save_scope]
+  add_index :saves, [:saveable_id, :saveable_type, :save_scope]
+
+  create_table :savers do |t|
+    t.string :name
+  end
+
+  create_table :not_savers do |t|
+    t.string :name
+  end
+
+  create_table :saveables do |t|
+    t.string :name
+  end
+
+  create_table :saveable_savers do |t|
+    t.string :name
+  end
+
+  create_table :sti_saveables do |t|
+    t.string :name
+    t.string :type
+  end
+
+  create_table :sti_not_saveables do |t|
+    t.string :name
+    t.string :type
+  end
+
+  create_table :not_saveables do |t|
+    t.string :name
+  end
+
+  create_table :saveable_caches do |t|
+    t.string :name
+    t.integer :cached_saves_total
+    t.integer :cached_saves_score
+    t.integer :cached_saves_up
+    t.integer :cached_saves_down
+    t.integer :cached_weighted_total
+    t.integer :cached_weighted_score
+    t.float :cached_weighted_average
+
+    t.integer :cached_scoped_test_saves_total
+    t.integer :cached_scoped_test_saves_score
+    t.integer :cached_scoped_test_saves_up
+    t.integer :cached_scoped_test_saves_down
+    t.integer :cached_scoped_weighted_total
+    t.integer :cached_scoped_weighted_score
+    t.float :cached_scoped_weighted_average
+  end
+
+end
+
+
+class Saver < ActiveRecord::Base
+  acts_as_saver
+end
+
+class NotSaver < ActiveRecord::Base
+
+end
+
+class Saveable < ActiveRecord::Base
+  acts_as_saveable
+  validates_presence_of :name
+end
+
+class SaveableSaver < ActiveRecord::Base
+  acts_as_saveable
+  acts_as_saver
+end
+
+class StiSaveable < ActiveRecord::Base
+  acts_as_saveable
+end
+
+class ChildOfStiSaveable < StiSaveable
+end
+
+class StiNotSaveable < ActiveRecord::Base
+  validates_presence_of :name
+end
+
+class SaveableChildOfStiNotSaveable < StiNotSaveable
+  acts_as_saveable
+end
+
+class NotSaveable < ActiveRecord::Base
+end
+
+class SaveableCache < ActiveRecord::Base
+  acts_as_saveable
+  validates_presence_of :name
+end
+
+class ABoringClass
+  def self.hw
+    'hello world'
+  end
+end
+
+
+def clean_database
+  models = [ActsAsSaveable::Save, Saver, NotSaver, Saveable, NotSaveable, SaveableCache]
+  models.each do |model|
+    ActiveRecord::Base.connection.execute "DELETE FROM #{model.table_name}"
+  end
+end

data/spec/words_spec.rb

@@ -0,0 +1,30 @@
+require 'acts_as_saveable'
+require 'spec_helper'
+
+describe ActsAsSaveable::Helpers::Words do
+
+  before :each do
+    @saved = ActsAsSaveable::Save.new
+  end
+
+  it "should know that like is a true saved" do
+    expect(@saved.saveable_words.that_mean_true).to include "like"
+  end
+
+  it "should know that bad is a false saved" do
+    expect(@saved.saveable_words.that_mean_false).to include "bad"
+  end
+
+  it "should be a saved for true when word is good" do
+    expect(@saved.saveable_words.meaning_of('good')).to be true
+  end
+
+  it "should be a saved for false when word is down" do
+    expect(@saved.saveable_words.meaning_of('down')).to be false
+  end
+
+  it "should be a saved for true when the word is unknown" do
+    expect(@saved.saveable_words.meaning_of('lsdhklkadhfs')).to be true
+  end
+
+end

metadata

@@ -0,0 +1,103 @@
+--- !ruby/object:Gem::Specification
+name: acts_as_saveable
+version: !ruby/object:Gem::Version
+  version: 0.10.1
+platform: ruby
+authors:
+- Ali Ibrahim
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-02-07 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.3.9
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.3.9
+description: Rails gem to allowing records to be saveable
+email:
+- aliibrahim@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- Gemfile
+- README.markdown
+- Rakefile
+- acts_as_saveable.gemspec
+- lib/acts_as_saveable.rb
+- lib/acts_as_saveable/extenders/controller.rb
+- lib/acts_as_saveable/extenders/saveable.rb
+- lib/acts_as_saveable/extenders/saver.rb
+- lib/acts_as_saveable/helpers/words.rb
+- lib/acts_as_saveable/save.rb
+- lib/acts_as_saveable/saveable.rb
+- lib/acts_as_saveable/saver.rb
+- lib/acts_as_saveable/version.rb
+- lib/generators/acts_as_saveable/migration/migration_generator.rb
+- lib/generators/acts_as_saveable/migration/templates/active_record/migration.rb
+- spec/saveable_saver_spec.rb
+- spec/saveable_spec.rb
+- spec/saver_spec.rb
+- spec/shared_example/saveable_model_spec.rb
+- spec/shared_example/saver_model_spec.rb
+- spec/spec_helper.rb
+- spec/words_spec.rb
+homepage: http://rubygems.org/gems/acts_as_saveable
+licenses: []
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: acts_as_saveable
+rubygems_version: 2.5.2
+signing_key: 
+specification_version: 4
+summary: Rails gem to allowing records to be saveable
+test_files:
+- spec/saveable_saver_spec.rb
+- spec/saveable_spec.rb
+- spec/saver_spec.rb
+- spec/shared_example/saveable_model_spec.rb
+- spec/shared_example/saver_model_spec.rb
+- spec/spec_helper.rb
+- spec/words_spec.rb
+has_rdoc: