acts_as_rrranking 0.1.0

checksums.yaml

@@ -0,0 +1,15 @@
+---
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    NjdjYTdkNjRmZTU4NmFiYTEyZjMxZDEzMjZkNjY1YmM4Mzk2YWM4Yg==
+  data.tar.gz: !binary |-
+    ZWY1YzUxNDNkMjZmZGY5ZWIwMzFjMTg1NTUyZThkNDU3NDk2OWEwYw==
+!binary "U0hBNTEy":
+  metadata.gz: !binary |-
+    NjNiYWZmOTcwOTZkN2M1OGQyYjNhM2I0NWE2ZmFjNzk1NmYwNzg1MmM4OWE4
+    YjllYjZhNTkzZjkyMmRmNGQxZmVmOGU5ODUwNDQyMzI1MmY4OWM5M2IwYzZi
+    MDZjOGFiYjU4MGFjN2U4YTNmODYyMjY0ZDZkNGE2ZWI3YThhZGM=
+  data.tar.gz: !binary |-
+    ZjM1NDUwZDVjNGNlNGUyN2QwOTY5YTg2MDY5NWMxYzcwMGU4NmY3ZTkxYmI4
+    ZWJjMmY0ZjQ0NTg3YTY3NmNmM2QzNTg3NzA5ZTgxNGMwOTY0NjM2YTM2Yjc1
+    M2ZhYTQ4ODQzMzQ4YTM1YWRiZWM3MGExYTZlNjZkZjIwOWFjODk=

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2013 Weihu Chen
+
+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.rdoc

@@ -0,0 +1,23 @@
+= ActsAsRrranking
+
+A rails plugin use redis to sort active_records on real time.
+
+== Example
+
+  class Player < ActiveRecord::Base
+    acts_as_rrranking :ranking, score: :game_point
+  end
+
+== Arguments
+
+  name: the name of the ranking field
+  options:
+    score: the field which the models can be sorted by (default: :score)
+    id: the identification field of the models (default: :id)
+
+Suppose the name is :ranking and the score field is :game_point then the following methods will be generated:
+
+  #current_ranking: return the current ranking
+  #update_ranking(score): update the score to redis, also will be invoked in the after_save hook
+  ::top_rankings(limit, offset): return the array of top ids
+  ::top_ranking_player(limit, offset): return the array of top models

data/Rakefile

@@ -0,0 +1,27 @@
+#!/usr/bin/env rake
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+begin
+  require 'rdoc/task'
+rescue LoadError
+  require 'rdoc/rdoc'
+  require 'rake/rdoctask'
+  RDoc::Task = Rake::RDocTask
+end
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'ActsAsRrranking'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+
+
+
+Bundler::GemHelper.install_tasks
+

data/lib/acts_as_rrranking.rb

@@ -0,0 +1,52 @@
+require 'active_support'
+require 'active_record'
+
+module ActsAsRrranking
+  extend ActiveSupport::Concern
+
+  module ClassMethods
+    def acts_as_rrranking(ranking_key, options = {})
+      @ranking_key = ranking_key
+      @redis_ranking_key = "#{self.name.underscore}_#{@ranking_key}"
+      @score_key = options[:score] || :score
+      @ranking_id = options[:id] || :id
+
+      class_eval <<-STR
+        def update_#{@ranking_key}
+          self.class.redis.zadd('#{@redis_ranking_key}', self.#{@score_key}, self.#{@ranking_id})
+        end
+
+        def current_#{@ranking_key}
+          if self.#{@score_key} && self.#{@score_key} > 0
+            (self.class.redis.zrevrank('#{@redis_ranking_key}', self.#{@ranking_id}) || -1) + 1
+          else
+            nil
+          end
+        end
+
+        after_save :update_#{@ranking_key}
+      STR
+
+      instance_eval <<-STR
+        def top_#{@ranking_key.to_s.pluralize}(limit = 10, offset = 0)
+          self.redis.zrange('#{@redis_ranking_key}', offset, limit)
+        end
+
+        def top_#{@ranking_key}_#{self.name.underscore.pluralize}(limit = 10, offset = 0)
+          ids = self.top_#{@ranking_key.to_s.pluralize}(limit, offset)
+          self.where(#{@ranking_id}: ids)
+        end
+
+        def redis_ranking_key
+          '#{@redis_ranking_key}'
+        end
+      STR
+    end
+
+    def redis
+      @redis ||= Redis.new
+    end
+  end
+end
+
+ActiveRecord::Base.send :include, ActsAsRrranking

data/lib/acts_as_rrranking/version.rb

@@ -0,0 +1,3 @@
+module ActsAsRrranking
+  VERSION = "0.1.0"
+end

metadata

@@ -0,0 +1,118 @@
+--- !ruby/object:Gem::Specification
+name: acts_as_rrranking
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Weihu Chen
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-05-08 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 3.2.13
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 3.2.13
+- !ruby/object:Gem::Dependency
+  name: redis
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 3.0.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 3.0.1
+- !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: rspec-rails
+  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: factory_girl_rails
+  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'
+description: A rails plugin use redis to sort active_records on real time.
+email:
+- cctiger36@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/acts_as_rrranking/version.rb
+- lib/acts_as_rrranking.rb
+- MIT-LICENSE
+- Rakefile
+- README.rdoc
+homepage: https://github.com/cctiger36/acts_as_rrranking
+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: 
+rubygems_version: 2.0.3
+signing_key: 
+specification_version: 4
+summary: Redis Realtime Ranking
+test_files: []