acts_as_rrranking 0.1.0 → 0.1.1

Sign up to get free protection for your applications and to get access to all the features.
data/README.md ADDED
@@ -0,0 +1,47 @@
1
+ # ActsAsRrranking
2
+
3
+ [![Build Status](https://travis-ci.org/cctiger36/acts_as_rrranking.png?branch=master)](https://travis-ci.org/cctiger36/acts_as_rrranking) [![Gem Version](https://badge.fury.io/rb/acts_as_rrranking.png)](http://badge.fury.io/rb/acts_as_rrranking) [![Code Climate](https://codeclimate.com/github/cctiger36/acts_as_rrranking.png)](https://codeclimate.com/github/cctiger36/acts_as_rrranking)
4
+
5
+ A rails plugin use redis to sort models on real time.
6
+
7
+ ## Example
8
+
9
+ class Player < ActiveRecord::Base
10
+ acts_as_rrranking :ranking, score: :game_point
11
+ end
12
+
13
+ ## Arguments
14
+
15
+ ### name
16
+
17
+ the name of the ranking field
18
+
19
+ ### options
20
+
21
+ <table>
22
+ <tr>
23
+ <td>score</td><td>the field which the models can be sorted by (default: :score)</td>
24
+ <tr>
25
+ </tr>
26
+ <td>id</td><td>the identification field of the models (default: :id)</td>
27
+ </tr>
28
+ </table>
29
+
30
+ ## Helper Methods
31
+
32
+ Suppose the name is :ranking and the score field is :game_point then the following methods will be generated:
33
+
34
+ <table>
35
+ <tr>
36
+ <td>#current_ranking</td><td>return the current ranking</td>
37
+ <tr>
38
+ </tr>
39
+ <td>#update_ranking(score)</td><td>update the score to redis, also will be invoked in the after_save hook</td>
40
+ <tr>
41
+ </tr>
42
+ <td>::top_rankings(limit, offset)</td><td>return the array of top ids</td>
43
+ <tr>
44
+ </tr>
45
+ <td>::top_ranking_player(limit, offset)</td><td>return the array of top models</td>
46
+ </tr>
47
+ </table>
data/Rakefile CHANGED
@@ -1,27 +1,12 @@
1
- #!/usr/bin/env rake
2
- begin
3
- require 'bundler/setup'
4
- rescue LoadError
5
- puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
6
- end
7
- begin
8
- require 'rdoc/task'
9
- rescue LoadError
10
- require 'rdoc/rdoc'
11
- require 'rake/rdoctask'
12
- RDoc::Task = Rake::RDocTask
13
- end
14
-
15
- RDoc::Task.new(:rdoc) do |rdoc|
16
- rdoc.rdoc_dir = 'rdoc'
17
- rdoc.title = 'ActsAsRrranking'
18
- rdoc.options << '--line-numbers'
19
- rdoc.rdoc_files.include('README.rdoc')
20
- rdoc.rdoc_files.include('lib/**/*.rb')
21
- end
22
-
1
+ require 'rubygems'
2
+ require 'bundler/setup'
23
3
 
4
+ desc 'Default: run specs'
5
+ task :default => :spec
24
6
 
7
+ require 'rspec/core/rake_task'
8
+ RSpec::Core::RakeTask.new do |t|
9
+ t.pattern = "spec/**/*_spec.rb"
10
+ end
25
11
 
26
12
  Bundler::GemHelper.install_tasks
27
-
@@ -1,3 +1,3 @@
1
1
  module ActsAsRrranking
2
- VERSION = "0.1.0"
2
+ VERSION = "0.1.1"
3
3
  end
metadata CHANGED
@@ -1,18 +1,20 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: acts_as_rrranking
3
3
  version: !ruby/object:Gem::Version
4
- version: 0.1.0
4
+ version: 0.1.1
5
+ prerelease:
5
6
  platform: ruby
6
7
  authors:
7
8
  - Weihu Chen
8
9
  autorequire:
9
10
  bindir: bin
10
11
  cert_chain: []
11
- date: 2013-05-08 00:00:00.000000000 Z
12
+ date: 2013-06-08 00:00:00.000000000 Z
12
13
  dependencies:
13
14
  - !ruby/object:Gem::Dependency
14
15
  name: rails
15
16
  requirement: !ruby/object:Gem::Requirement
17
+ none: false
16
18
  requirements:
17
19
  - - ~>
18
20
  - !ruby/object:Gem::Version
@@ -20,6 +22,7 @@ dependencies:
20
22
  type: :runtime
21
23
  prerelease: false
22
24
  version_requirements: !ruby/object:Gem::Requirement
25
+ none: false
23
26
  requirements:
24
27
  - - ~>
25
28
  - !ruby/object:Gem::Version
@@ -27,6 +30,7 @@ dependencies:
27
30
  - !ruby/object:Gem::Dependency
28
31
  name: redis
29
32
  requirement: !ruby/object:Gem::Requirement
33
+ none: false
30
34
  requirements:
31
35
  - - ~>
32
36
  - !ruby/object:Gem::Version
@@ -34,6 +38,7 @@ dependencies:
34
38
  type: :runtime
35
39
  prerelease: false
36
40
  version_requirements: !ruby/object:Gem::Requirement
41
+ none: false
37
42
  requirements:
38
43
  - - ~>
39
44
  - !ruby/object:Gem::Version
@@ -41,6 +46,7 @@ dependencies:
41
46
  - !ruby/object:Gem::Dependency
42
47
  name: sqlite3
43
48
  requirement: !ruby/object:Gem::Requirement
49
+ none: false
44
50
  requirements:
45
51
  - - ! '>='
46
52
  - !ruby/object:Gem::Version
@@ -48,6 +54,7 @@ dependencies:
48
54
  type: :development
49
55
  prerelease: false
50
56
  version_requirements: !ruby/object:Gem::Requirement
57
+ none: false
51
58
  requirements:
52
59
  - - ! '>='
53
60
  - !ruby/object:Gem::Version
@@ -55,6 +62,7 @@ dependencies:
55
62
  - !ruby/object:Gem::Dependency
56
63
  name: rspec-rails
57
64
  requirement: !ruby/object:Gem::Requirement
65
+ none: false
58
66
  requirements:
59
67
  - - ! '>='
60
68
  - !ruby/object:Gem::Version
@@ -62,6 +70,7 @@ dependencies:
62
70
  type: :development
63
71
  prerelease: false
64
72
  version_requirements: !ruby/object:Gem::Requirement
73
+ none: false
65
74
  requirements:
66
75
  - - ! '>='
67
76
  - !ruby/object:Gem::Version
@@ -69,6 +78,7 @@ dependencies:
69
78
  - !ruby/object:Gem::Dependency
70
79
  name: factory_girl_rails
71
80
  requirement: !ruby/object:Gem::Requirement
81
+ none: false
72
82
  requirements:
73
83
  - - ! '>='
74
84
  - !ruby/object:Gem::Version
@@ -76,11 +86,12 @@ dependencies:
76
86
  type: :development
77
87
  prerelease: false
78
88
  version_requirements: !ruby/object:Gem::Requirement
89
+ none: false
79
90
  requirements:
80
91
  - - ! '>='
81
92
  - !ruby/object:Gem::Version
82
93
  version: '0'
83
- description: A rails plugin use redis to sort active_records on real time.
94
+ description: A rails plugin use redis to sort models on real time.
84
95
  email:
85
96
  - cctiger36@gmail.com
86
97
  executables: []
@@ -91,28 +102,30 @@ files:
91
102
  - lib/acts_as_rrranking.rb
92
103
  - MIT-LICENSE
93
104
  - Rakefile
94
- - README.rdoc
105
+ - README.md
95
106
  homepage: https://github.com/cctiger36/acts_as_rrranking
96
- licenses: []
97
- metadata: {}
107
+ licenses:
108
+ - MIT
98
109
  post_install_message:
99
110
  rdoc_options: []
100
111
  require_paths:
101
112
  - lib
102
113
  required_ruby_version: !ruby/object:Gem::Requirement
114
+ none: false
103
115
  requirements:
104
116
  - - ! '>='
105
117
  - !ruby/object:Gem::Version
106
118
  version: '0'
107
119
  required_rubygems_version: !ruby/object:Gem::Requirement
120
+ none: false
108
121
  requirements:
109
122
  - - ! '>='
110
123
  - !ruby/object:Gem::Version
111
124
  version: '0'
112
125
  requirements: []
113
126
  rubyforge_project:
114
- rubygems_version: 2.0.3
127
+ rubygems_version: 1.8.24
115
128
  signing_key:
116
- specification_version: 4
129
+ specification_version: 3
117
130
  summary: Redis Realtime Ranking
118
131
  test_files: []
checksums.yaml DELETED
@@ -1,15 +0,0 @@
1
- ---
2
- !binary "U0hBMQ==":
3
- metadata.gz: !binary |-
4
- NjdjYTdkNjRmZTU4NmFiYTEyZjMxZDEzMjZkNjY1YmM4Mzk2YWM4Yg==
5
- data.tar.gz: !binary |-
6
- ZWY1YzUxNDNkMjZmZGY5ZWIwMzFjMTg1NTUyZThkNDU3NDk2OWEwYw==
7
- !binary "U0hBNTEy":
8
- metadata.gz: !binary |-
9
- NjNiYWZmOTcwOTZkN2M1OGQyYjNhM2I0NWE2ZmFjNzk1NmYwNzg1MmM4OWE4
10
- YjllYjZhNTkzZjkyMmRmNGQxZmVmOGU5ODUwNDQyMzI1MmY4OWM5M2IwYzZi
11
- MDZjOGFiYjU4MGFjN2U4YTNmODYyMjY0ZDZkNGE2ZWI3YThhZGM=
12
- data.tar.gz: !binary |-
13
- ZjM1NDUwZDVjNGNlNGUyN2QwOTY5YTg2MDY5NWMxYzcwMGU4NmY3ZTkxYmI4
14
- ZWJjMmY0ZjQ0NTg3YTY3NmNmM2QzNTg3NzA5ZTgxNGMwOTY0NjM2YTM2Yjc1
15
- M2ZhYTQ4ODQzMzQ4YTM1YWRiZWM3MGExYTZlNjZkZjIwOWFjODk=
data/README.rdoc DELETED
@@ -1,23 +0,0 @@
1
- = ActsAsRrranking
2
-
3
- A rails plugin use redis to sort active_records on real time.
4
-
5
- == Example
6
-
7
- class Player < ActiveRecord::Base
8
- acts_as_rrranking :ranking, score: :game_point
9
- end
10
-
11
- == Arguments
12
-
13
- name: the name of the ranking field
14
- options:
15
- score: the field which the models can be sorted by (default: :score)
16
- id: the identification field of the models (default: :id)
17
-
18
- Suppose the name is :ranking and the score field is :game_point then the following methods will be generated:
19
-
20
- #current_ranking: return the current ranking
21
- #update_ranking(score): update the score to redis, also will be invoked in the after_save hook
22
- ::top_rankings(limit, offset): return the array of top ids
23
- ::top_ranking_player(limit, offset): return the array of top models