has_many_scored 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: d6e3ceacfc424710a369f2556276c3593353e762
+  data.tar.gz: d568b6e4ac4122bad8fa8df24d6609101a0e75a4
+SHA512:
+  metadata.gz: f7c91444fa1250d1be8845623db6d3190a7e2e2012fa9f1cb80b67f1c78b9f5cef808e98ff85f6d2b81b65469a27fcabc7b018ca1bc76d3d88d22f220b575f51
+  data.tar.gz: 58a2fda5405b98b228f89c0bef26bd6475378a4666481ce5c77bab28164b81e2a2b6fe3a6467a4249edd2db678121634d12f2aaff87d58992e959cbb967a59ff

data/.gitignore

@@ -0,0 +1,18 @@
+*.gem
+*.rbc
+.bundle
+.config
+coverage
+InstalledFiles
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+
+# YARD artifacts
+.yardoc
+_yardoc
+doc/

data/.rspec

@@ -0,0 +1 @@
+--colour --format documentation

data/ChangeLog.rdoc

@@ -0,0 +1,4 @@
+=== 1.0.0 / 2014-02-15
+
+* Initial release
+* Stuff works

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in has_many_scored.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,72 @@
+PATH
+  remote: .
+  specs:
+    has_many_scored (0.0.1)
+      activerecord (>= 3.0, <= 4.0.2)
+      redis-objects (>= 0.6.1)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activemodel (4.0.2)
+      activesupport (= 4.0.2)
+      builder (~> 3.1.0)
+    activerecord (4.0.2)
+      activemodel (= 4.0.2)
+      activerecord-deprecated_finders (~> 1.0.2)
+      activesupport (= 4.0.2)
+      arel (~> 4.0.0)
+    activerecord-deprecated_finders (1.0.3)
+    activesupport (4.0.2)
+      i18n (~> 0.6, >= 0.6.4)
+      minitest (~> 4.2)
+      multi_json (~> 1.3)
+      thread_safe (~> 0.1)
+      tzinfo (~> 0.3.37)
+    arel (4.0.2)
+    atomic (1.1.14)
+    builder (3.1.4)
+    coderay (1.1.0)
+    diff-lcs (1.2.5)
+    fakeredis (0.4.3)
+      redis (~> 3.0.0)
+    i18n (0.6.9)
+    json (1.8.1)
+    method_source (0.8.2)
+    minitest (4.7.5)
+    multi_json (1.8.4)
+    pry (0.9.12.4)
+      coderay (~> 1.0)
+      method_source (~> 0.8)
+      slop (~> 3.4)
+    rdoc (4.1.1)
+      json (~> 1.4)
+    redis (3.0.7)
+    redis-objects (0.9.0)
+      redis (>= 3.0.2)
+    rspec (2.14.1)
+      rspec-core (~> 2.14.0)
+      rspec-expectations (~> 2.14.0)
+      rspec-mocks (~> 2.14.0)
+    rspec-core (2.14.7)
+    rspec-expectations (2.14.5)
+      diff-lcs (>= 1.1.3, < 2.0)
+    rspec-mocks (2.14.5)
+    rubygems-tasks (0.2.4)
+    slop (3.4.7)
+    sqlite3 (1.3.8)
+    thread_safe (0.1.3)
+      atomic
+    tzinfo (0.3.38)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  fakeredis
+  has_many_scored!
+  pry
+  rdoc (~> 4.1.0)
+  rspec (~> 2.4)
+  rubygems-tasks (~> 0.2)
+  sqlite3

data/LICENSE

@@ -0,0 +1,20 @@
+The MIT License (MIT)
+
+Copyright (c) 2014 Hsiu-Fan Wang
+
+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,31 @@
+# has_many_scored
+
+## Description
+
+An ActiveRecord plugin that combines an ordered habtm-like association with optional redis caching.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'has_many_scored'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install has_many_scored
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Contributing
+
+1. Fork it ( http://github.com/hfwang/has_many_scored/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,31 @@
+# encoding: utf-8
+
+require "bundler/gem_tasks"
+require 'rake'
+
+begin
+  gem 'rdoc'
+  require 'rdoc/task'
+
+  RDoc::Task.new do |rdoc|
+    rdoc.title = "has_many_scored"
+  end
+rescue LoadError => e
+  warn e.message
+  warn "Run `gem install rdoc` to install 'rdoc/task'."
+end
+task :doc => :rdoc
+
+begin
+  gem 'rspec', '~> 2.4'
+  require 'rspec/core/rake_task'
+
+  RSpec::Core::RakeTask.new
+rescue LoadError => e
+  task :spec do
+    abort "Please run `gem install rspec` to install RSpec."
+  end
+end
+
+task :test    => :spec
+task :default => :spec

data/has_many_scored.gemspec

@@ -0,0 +1,29 @@
+# -*- encoding: utf-8 -*-
+
+require File.expand_path("../lib/has_many_scored/version", __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.name          = "has_many_scored"
+  gem.version       = HasManyScored::VERSION
+  gem.summary       = %q{An ActiveRecord plugin that combines an ordered habtm-like association with optional redis caching}
+  gem.description   = %q{An ActiveRecord plugin that combines an ordered habtm-like association with optional redis caching.}
+  gem.license       = "MIT"
+  gem.authors       = ["Hsiu-Fan Wang"]
+  gem.email         = "hfwang@porkbuns.net"
+  gem.homepage      = "https://rubygems.org/gems/has_many_scored"
+
+  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("activerecord", ">= 3.0", "<= 4.0.2")
+  gem.add_dependency("redis-objects", ">= 0.6.1")
+
+  gem.add_development_dependency "pry"
+  gem.add_development_dependency "sqlite3"
+  gem.add_development_dependency "fakeredis"
+  gem.add_development_dependency "rdoc", "~> 4.1.0"
+  gem.add_development_dependency "rspec", "~> 2.4"
+  gem.add_development_dependency "rubygems-tasks", "~> 0.2"
+end

data/lib/has_many_scored/has_many_scored_extension.rb

@@ -0,0 +1,38 @@
+module HasManyScored
+  # This module is used to extend the join model and mix in additional logic
+  module HasManyScoredExtension
+    def self.bind_extension(options)
+      return Proc.new do
+        include HasManyScored::HasManyScoredExtension
+
+        # Options is defined using define_method so opts can still be within scope.
+        define_method :options do
+          return options
+        end
+      end
+    end
+
+    def update_score(*records)
+      join_table = proxy_association.join_table
+      reflection = proxy_association.reflection
+
+      records.each do |record|
+        update_manager = Arel::UpdateManager.new(join_table.engine)
+        update_manager.table(join_table)\
+          .set(join_table[options[:score_column]] => self.compute_score(record))\
+          .where(join_table[reflection.foreign_key].eq(proxy_association.owner.id))\
+          .where(join_table[reflection.association_foreign_key].eq(record.id))\
+          .take(1)
+        proxy_association.owner.connection.execute(update_manager.to_sql)
+      end
+
+      reset
+
+      self
+    end
+
+    def compute_score(record)
+      record.send(options[:score_field])
+    end
+  end
+end

data/lib/has_many_scored/scored_for_many_extension.rb

@@ -0,0 +1,40 @@
+module HasManyScored
+  # This module is used to extend the join model and mix in additional logic
+  module ScoredForManyExtension
+    def self.bind_extension(options)
+      return Proc.new do
+        include HasManyScored::ScoredForManyExtension
+
+        # Options is defined using define_method so opts can still be within scope.
+        define_method :options do
+          return options
+        end
+      end
+    end
+
+    def update_score(*records)
+      join_table = proxy_association.join_table
+      reflection = proxy_association.reflection
+
+      owner_score = self.compute_score(proxy_association.owner)
+
+      records.each do |record|
+        update_manager = Arel::UpdateManager.new(join_table.engine)
+        update_manager.table(join_table)\
+          .set(join_table[options[:score_column]] => owner_score)\
+          .where(join_table[reflection.foreign_key].eq(proxy_association.owner.id))\
+          .where(join_table[reflection.association_foreign_key].eq(record.id))\
+          .take(1)
+        proxy_association.owner.connection.execute(update_manager.to_sql)
+      end
+
+      reset
+
+      self
+    end
+
+    def compute_score(record)
+      record.send(options[:score_field])
+    end
+  end
+end

data/lib/has_many_scored/version.rb

@@ -0,0 +1,3 @@
+module HasManyScored
+  VERSION = "1.0.0"
+end

data/lib/has_many_scored.rb

@@ -0,0 +1,63 @@
+require "has_many_scored/version"
+require "has_many_scored/has_many_scored_extension"
+require "has_many_scored/scored_for_many_extension"
+
+module HasManyScored
+  module ClassMethods
+    VALID_HABTM_OPTIONS = [:class_name, :join_table, :foreign_key,
+                           :association_foreign_key, :readonly, :validate,
+                           :autosave]
+
+    def has_many_scored(name, opts=nil)
+      opts = opts.try(:dup) || {}
+
+      habtm_opts = opts.select { |k, v| VALID_HABTM_OPTIONS.include?(k) }
+      habtm_opts[:insert_sql] = lambda { |record|
+        proxy_association = self.association(name)
+        join_table = proxy_association.join_table
+        reflection = proxy_association.reflection
+
+        return join_table.compile_insert(
+          join_table[reflection.foreign_key] => self.id,
+          join_table[reflection.association_foreign_key] => record.id,
+          join_table[opts[:score_column]] => proxy_association.scope.compute_score(record))
+      }
+
+      opts[:score_column] ||= :score
+      opts[:score_field] ||= :score
+
+      has_and_belongs_to_many(
+        name,
+        lambda { |owner| order("#{owner.association(name).join_table.name}.#{opts[:score_column]} DESC") },
+        habtm_opts, &HasManyScored::HasManyScoredExtension.bind_extension(opts))
+    end
+
+    def scored_for_many(name, opts=nil)
+      opts = opts.try(:dup) || {}
+
+      habtm_opts = opts.select { |k, v| VALID_HABTM_OPTIONS.include?(k) }
+      habtm_opts[:insert_sql] = lambda { |record|
+        proxy_association = self.association(name)
+        join_table = proxy_association.join_table
+        reflection = proxy_association.reflection
+
+        return join_table.compile_insert(
+          join_table[reflection.foreign_key] => self.id,
+          join_table[reflection.association_foreign_key] => record.id,
+          join_table[opts[:score_column]] => proxy_association.scope.compute_score(self))
+      }
+
+      opts[:score_column] ||= :score
+      opts[:score_field] ||= :score
+
+      has_and_belongs_to_many(
+        name,
+        lambda { |owner| order("#{owner.association(name).join_table.name}.#{opts[:score_column]} DESC") },
+        habtm_opts, &HasManyScored::HasManyScoredExtension.bind_extension(opts))
+    end
+  end
+
+  def self.included(base)
+    base.extend(ClassMethods)
+  end
+end

data/spec/has_many_scored_spec.rb

@@ -0,0 +1,8 @@
+require 'spec_helper'
+require 'has_many_scored'
+
+describe HasManyScored do
+  it "should have a VERSION constant" do
+    subject.const_get('VERSION').should_not be_empty
+  end
+end

data/spec/simple_model_spec.rb

@@ -0,0 +1,125 @@
+require 'spec_helper'
+require 'has_many_scored'
+
+class Topic < ActiveRecord::Base
+  include HasManyScored
+  scored_for_many :tags
+end
+class Tag < ActiveRecord::Base
+  include HasManyScored
+  has_many_scored :topics
+end
+
+def setup_schema!
+  setup_db do
+    create_table :topics do |t|
+      t.column :name, :string
+      t.column :score, :float
+    end
+    create_table :tags do |t|
+      t.column :name, :string
+    end
+    create_table :tags_topics do |t|
+      t.column :topic_id, :integer
+      t.column :tag_id, :integer
+      t.column :score, :float
+    end
+  end
+end
+
+describe Tag do
+  before(:each) do
+    setup_schema!
+  end
+  after(:each) do
+    teardown_db
+  end
+  context "with dummy data" do
+    before do
+      @t1 = Topic.create(:name => "Topic 1", :score => 0.2)
+      @t2 = Topic.create(:name => "Topic 2", :score => 0.1)
+      @t3 = Topic.create(:name => "Topic 3", :score => 0.3)
+      @tag = Tag.create(:name => "Tag 1")
+      @tag.topics << @t1 << @t2 << @t3
+    end
+
+    it "computes size" do
+      expect(@tag.topics.size).to eq(3)
+      @tag.topics = []
+      expect(@tag.topics.size).to eq(0)
+    end
+
+    it "computes score when setting by ID" do
+      @tag.topic_ids = [@t1.id, @t2.id]
+      expect(@tag.topics(true).map(&:name)).to eq(["Topic 1", "Topic 2"])
+
+      @tag.topic_ids = [@t3.id]
+      expect(@tag.topics(true).map(&:name)).to eq(["Topic 3"])
+
+      @tag.topic_ids = [@t3.id, @t2.id, @t1.id]
+      expect(@tag.topics(true).map { |t| t.name }).to eq(["Topic 3", "Topic 1", "Topic 2"])
+    end
+
+    it "computes scores" do
+      expect(@tag.topics.compute_score(@t2)).to eq(0.1)
+    end
+
+    it "reads in scored order" do
+      # Sadly we have to call reload.
+      @tag.topics.reload
+
+      expect(@tag.topics.map { |t| t.name }).to eq(["Topic 3", "Topic 1", "Topic 2"])
+      expect(@tag.topics.first(2).map { |t| t.name }).to eq(["Topic 3", "Topic 1"])
+    end
+
+    it "handles delete" do
+      @tag.topics.delete(@t1)
+
+      expect(@tag.topics.map { |t| t.name }).to eq(["Topic 3", "Topic 2"])
+    end
+
+    it "handles update_score" do
+      @t2.score = 4.0
+      @t2.save
+      @tag.topics.update_score(@t2)
+
+      expect(Tag.first.topics.map { |t| t.name }).to eq(["Topic 2", "Topic 3", "Topic 1"])
+    end
+  end
+end
+
+describe Topic do
+  before(:each) do
+    setup_schema!
+  end
+  after(:each) do
+    teardown_db
+  end
+
+  context "with dummy data" do
+    before do
+      @t1 = Topic.create(:name => "Topic 1", :score => 0.2)
+      @t2 = Topic.create(:name => "Topic 2", :score => 0.1)
+      @t3 = Topic.create(:name => "Topic 3", :score => 0.3)
+      @tag1 = Tag.create(:name => "Tag 1")
+      @tag2 = Tag.create(:name => "Tag 2")
+      @tag2 = Tag.create(:name => "Tag 3")
+      @tag1.topics << @t2 << @t3
+      @t1.tags << @tag1 << @tag2
+    end
+
+    it "computes size" do
+      expect(@t1.tags.size).to eq(2)
+      @t1.tags = []
+      expect(@t1.tags.size).to eq(0)
+    end
+
+    it "reads in scored order" do
+      # Sadly we have to call reload.
+      @tag1.topics.reload
+
+      expect(@tag1.topics.map { |t| t.name }).to eq(["Topic 3", "Topic 1", "Topic 2"])
+      expect(@tag2.topics.map { |t| t.name }).to eq(["Topic 1"])
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,27 @@
+gem "rspec", "~> 2.4"
+require "rspec"
+require "has_many_scored/version"
+
+require "pry"
+require "active_record"
+require "fakeredis"
+require "redis-objects"
+
+include HasManyScored
+
+ActiveRecord::Base.establish_connection(adapter: "sqlite3", database: ":memory:")
+ActiveRecord::Schema.verbose = false
+
+def setup_db(&block)
+  # AR caches columns options like defaults etc. Clear them!
+  ActiveRecord::Base.connection.schema_cache.clear!
+  ActiveRecord::Schema.define(version: 1, &block)
+
+  Redis.current.flushall
+end
+
+def teardown_db
+  ActiveRecord::Base.connection.tables.each do |table|
+    ActiveRecord::Base.connection.drop_table(table)
+  end
+end

metadata

@@ -0,0 +1,182 @@
+--- !ruby/object:Gem::Specification
+name: has_many_scored
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Hsiu-Fan Wang
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-02-18 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.0'
+    - - "<="
+      - !ruby/object:Gem::Version
+        version: 4.0.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.0'
+    - - "<="
+      - !ruby/object:Gem::Version
+        version: 4.0.2
+- !ruby/object:Gem::Dependency
+  name: redis-objects
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.6.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.6.1
+- !ruby/object:Gem::Dependency
+  name: pry
+  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: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: fakeredis
+  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: rdoc
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 4.1.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 4.1.0
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.4'
+- !ruby/object:Gem::Dependency
+  name: rubygems-tasks
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.2'
+description: An ActiveRecord plugin that combines an ordered habtm-like association
+  with optional redis caching.
+email: hfwang@porkbuns.net
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ChangeLog.rdoc
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- README.md
+- Rakefile
+- has_many_scored.gemspec
+- lib/has_many_scored.rb
+- lib/has_many_scored/has_many_scored_extension.rb
+- lib/has_many_scored/scored_for_many_extension.rb
+- lib/has_many_scored/version.rb
+- spec/has_many_scored_spec.rb
+- spec/simple_model_spec.rb
+- spec/spec_helper.rb
+homepage: https://rubygems.org/gems/has_many_scored
+licenses:
+- MIT
+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: 
+rubygems_version: 2.2.1
+signing_key: 
+specification_version: 4
+summary: An ActiveRecord plugin that combines an ordered habtm-like association with
+  optional redis caching
+test_files:
+- spec/has_many_scored_spec.rb
+- spec/simple_model_spec.rb
+- spec/spec_helper.rb