crappycounter 0.0.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- data/.gitignore +18 -0
- data/Gemfile +4 -0
- data/LICENSE.txt +22 -0
- data/README.md +49 -0
- data/Rakefile +1 -0
- data/crappy_counter.gemspec +21 -0
- data/lib/crappy_counter/version.rb +3 -0
- data/lib/crappy_counter.rb +28 -0
- data/spec/crappy_counter_spec.rb +84 -0
- data/spec/spec_helper.rb +13 -0
- metadata +73 -0
data/.gitignore
ADDED
data/Gemfile
ADDED
data/LICENSE.txt
ADDED
|
@@ -0,0 +1,22 @@
|
|
|
1
|
+
Copyright (c) 2012 Richard Hart
|
|
2
|
+
|
|
3
|
+
MIT License
|
|
4
|
+
|
|
5
|
+
Permission is hereby granted, free of charge, to any person obtaining
|
|
6
|
+
a copy of this software and associated documentation files (the
|
|
7
|
+
"Software"), to deal in the Software without restriction, including
|
|
8
|
+
without limitation the rights to use, copy, modify, merge, publish,
|
|
9
|
+
distribute, sublicense, and/or sell copies of the Software, and to
|
|
10
|
+
permit persons to whom the Software is furnished to do so, subject to
|
|
11
|
+
the following conditions:
|
|
12
|
+
|
|
13
|
+
The above copyright notice and this permission notice shall be
|
|
14
|
+
included in all copies or substantial portions of the Software.
|
|
15
|
+
|
|
16
|
+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
|
|
17
|
+
EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
|
|
18
|
+
MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
|
|
19
|
+
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
|
|
20
|
+
LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
|
|
21
|
+
OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
|
|
22
|
+
WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
|
data/README.md
ADDED
|
@@ -0,0 +1,49 @@
|
|
|
1
|
+
# CrappyCounter
|
|
2
|
+
|
|
3
|
+
Gem that just builds up a load of counters in Redis.
|
|
4
|
+
|
|
5
|
+
## Installation
|
|
6
|
+
|
|
7
|
+
Add this line to your application's Gemfile:
|
|
8
|
+
|
|
9
|
+
gem 'crappycounter'
|
|
10
|
+
|
|
11
|
+
And then execute:
|
|
12
|
+
|
|
13
|
+
$ bundle
|
|
14
|
+
|
|
15
|
+
Or install it yourself as:
|
|
16
|
+
|
|
17
|
+
$ gem install crappycounter
|
|
18
|
+
|
|
19
|
+
## Usage
|
|
20
|
+
|
|
21
|
+
This gem assumes you have Redis availble on a global var called `$redis`.
|
|
22
|
+
|
|
23
|
+
On an app I wanted to update stats with simple date filters so that I could easily
|
|
24
|
+
aggregate counts for day year month, but the more states the more of a pain it was:
|
|
25
|
+
|
|
26
|
+
```
|
|
27
|
+
my_key
|
|
28
|
+
my_key:2001
|
|
29
|
+
my_key:200112
|
|
30
|
+
my_key:20011231
|
|
31
|
+
my_key:some_state
|
|
32
|
+
my_key:some_state:2001
|
|
33
|
+
my_key:some_state:200112
|
|
34
|
+
my_key:some_state:20011231
|
|
35
|
+
```
|
|
36
|
+
|
|
37
|
+
CrappyCounter simply takes an array of key (with an optional date) and increments them all for you:
|
|
38
|
+
|
|
39
|
+
```
|
|
40
|
+
CrappyCounter.incr keys: ["my_key", "some_state"], date: today
|
|
41
|
+
```
|
|
42
|
+
|
|
43
|
+
## Contributing
|
|
44
|
+
|
|
45
|
+
1. Fork it
|
|
46
|
+
2. Create your feature branch (`git checkout -b my-new-feature`)
|
|
47
|
+
3. Commit your changes (`git commit -am 'Add some feature'`)
|
|
48
|
+
4. Push to the branch (`git push origin my-new-feature`)
|
|
49
|
+
5. Create new Pull Request
|
data/Rakefile
ADDED
|
@@ -0,0 +1 @@
|
|
|
1
|
+
require "bundler/gem_tasks"
|
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
# -*- encoding: utf-8 -*-
|
|
2
|
+
lib = File.expand_path('../lib', __FILE__)
|
|
3
|
+
$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
|
|
4
|
+
require 'crappy_counter/version'
|
|
5
|
+
|
|
6
|
+
Gem::Specification.new do |gem|
|
|
7
|
+
gem.name = "crappycounter"
|
|
8
|
+
gem.version = CrappyCounter::VERSION
|
|
9
|
+
gem.authors = ["Richard Hart"]
|
|
10
|
+
gem.email = ["richard@ur-ban.com"]
|
|
11
|
+
gem.description = %q{Crappy redis counter}
|
|
12
|
+
gem.summary = %q{Crappy redis counter}
|
|
13
|
+
gem.homepage = ""
|
|
14
|
+
|
|
15
|
+
gem.files = `git ls-files`.split($/)
|
|
16
|
+
gem.executables = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
|
|
17
|
+
gem.test_files = gem.files.grep(%r{^(test|spec|features)/})
|
|
18
|
+
gem.require_paths = ["lib"]
|
|
19
|
+
|
|
20
|
+
gem.add_development_dependency "rspec"
|
|
21
|
+
end
|
|
@@ -0,0 +1,28 @@
|
|
|
1
|
+
require "crappy_counter/version"
|
|
2
|
+
|
|
3
|
+
module CrappyCounter
|
|
4
|
+
|
|
5
|
+
NoRedisFound = Class.new(StandardError)
|
|
6
|
+
|
|
7
|
+
def self.incr(opts)
|
|
8
|
+
raise NoRedisFound unless $redis
|
|
9
|
+
|
|
10
|
+
combined_key = ""
|
|
11
|
+
opts[:keys].each do |key|
|
|
12
|
+
combined_key << (combined_key.empty? ? key : ":#{key}")
|
|
13
|
+
$redis.incr combined_key
|
|
14
|
+
|
|
15
|
+
date_key = ""
|
|
16
|
+
if opts[:date]
|
|
17
|
+
date = opts[:date]
|
|
18
|
+
date_key << "#{combined_key}:"
|
|
19
|
+
[:year, :month, :day].each do |date_param|
|
|
20
|
+
next unless date.respond_to?(date_param)
|
|
21
|
+
date_key << date.send(date_param)
|
|
22
|
+
$redis.incr date_key
|
|
23
|
+
end
|
|
24
|
+
end
|
|
25
|
+
end
|
|
26
|
+
end
|
|
27
|
+
|
|
28
|
+
end
|
|
@@ -0,0 +1,84 @@
|
|
|
1
|
+
require File.dirname(__FILE__) + '/spec_helper'
|
|
2
|
+
|
|
3
|
+
describe CrappyCounter do
|
|
4
|
+
|
|
5
|
+
it "raises an error if $redis is not defined" do
|
|
6
|
+
expect {
|
|
7
|
+
CrappyCounter.incr "key"
|
|
8
|
+
}.to raise_error(CrappyCounter::NoRedisFound)
|
|
9
|
+
end
|
|
10
|
+
|
|
11
|
+
context "no date" do
|
|
12
|
+
|
|
13
|
+
before(:each) do
|
|
14
|
+
$redis = double "Redis"
|
|
15
|
+
end
|
|
16
|
+
|
|
17
|
+
it "increments a single key" do
|
|
18
|
+
$redis.should_receive(:incr).with("first_key")
|
|
19
|
+
|
|
20
|
+
CrappyCounter.incr keys: ["first_key"]
|
|
21
|
+
end
|
|
22
|
+
|
|
23
|
+
it "increments multiple keys" do
|
|
24
|
+
$redis.should_receive(:incr).with("first_key")
|
|
25
|
+
$redis.should_receive(:incr).with("first_key:second_key")
|
|
26
|
+
|
|
27
|
+
CrappyCounter.incr keys: ["first_key", "second_key"]
|
|
28
|
+
end
|
|
29
|
+
|
|
30
|
+
end
|
|
31
|
+
|
|
32
|
+
context "with a date" do
|
|
33
|
+
|
|
34
|
+
let(:today) {
|
|
35
|
+
today = double "Date"
|
|
36
|
+
today.stub(:year => "2000")
|
|
37
|
+
today.stub(:month => "12")
|
|
38
|
+
today.stub(:day => "31")
|
|
39
|
+
today
|
|
40
|
+
}
|
|
41
|
+
|
|
42
|
+
before(:each) do
|
|
43
|
+
$redis = double "Redis"
|
|
44
|
+
end
|
|
45
|
+
|
|
46
|
+
it "ignores an invalid date" do
|
|
47
|
+
today = "non-date"
|
|
48
|
+
|
|
49
|
+
$redis.should_receive(:incr).with("first_key")
|
|
50
|
+
|
|
51
|
+
CrappyCounter.incr keys: ["first_key"], date: today
|
|
52
|
+
end
|
|
53
|
+
|
|
54
|
+
it "ignores a nil date" do
|
|
55
|
+
$redis.should_receive(:incr).with("first_key")
|
|
56
|
+
|
|
57
|
+
CrappyCounter.incr keys: ["first_key"], date: nil
|
|
58
|
+
end
|
|
59
|
+
|
|
60
|
+
it "increments a single key" do
|
|
61
|
+
$redis.should_receive(:incr).with("first_key")
|
|
62
|
+
$redis.should_receive(:incr).with("first_key:2000")
|
|
63
|
+
$redis.should_receive(:incr).with("first_key:200012")
|
|
64
|
+
$redis.should_receive(:incr).with("first_key:20001231")
|
|
65
|
+
|
|
66
|
+
CrappyCounter.incr keys: ["first_key"], date: today
|
|
67
|
+
end
|
|
68
|
+
|
|
69
|
+
it "increments multiple keys" do
|
|
70
|
+
$redis.should_receive(:incr).with("first_key")
|
|
71
|
+
$redis.should_receive(:incr).with("first_key:2000")
|
|
72
|
+
$redis.should_receive(:incr).with("first_key:200012")
|
|
73
|
+
$redis.should_receive(:incr).with("first_key:20001231")
|
|
74
|
+
$redis.should_receive(:incr).with("first_key:second_key")
|
|
75
|
+
$redis.should_receive(:incr).with("first_key:second_key:2000")
|
|
76
|
+
$redis.should_receive(:incr).with("first_key:second_key:200012")
|
|
77
|
+
$redis.should_receive(:incr).with("first_key:second_key:20001231")
|
|
78
|
+
|
|
79
|
+
CrappyCounter.incr keys: ["first_key", "second_key"], date: today
|
|
80
|
+
end
|
|
81
|
+
|
|
82
|
+
end
|
|
83
|
+
|
|
84
|
+
end
|
data/spec/spec_helper.rb
ADDED
|
@@ -0,0 +1,13 @@
|
|
|
1
|
+
require 'rubygems'
|
|
2
|
+
require 'bundler'
|
|
3
|
+
|
|
4
|
+
require 'rspec'
|
|
5
|
+
|
|
6
|
+
$:.unshift File.join(File.dirname(__FILE__), '..', 'lib')
|
|
7
|
+
require 'crappy_counter'
|
|
8
|
+
|
|
9
|
+
RSpec::Matchers.define :have_key do |expected|
|
|
10
|
+
match do |redis|
|
|
11
|
+
redis.exists(expected)
|
|
12
|
+
end
|
|
13
|
+
end
|
metadata
ADDED
|
@@ -0,0 +1,73 @@
|
|
|
1
|
+
--- !ruby/object:Gem::Specification
|
|
2
|
+
name: crappycounter
|
|
3
|
+
version: !ruby/object:Gem::Version
|
|
4
|
+
version: 0.0.1
|
|
5
|
+
prerelease:
|
|
6
|
+
platform: ruby
|
|
7
|
+
authors:
|
|
8
|
+
- Richard Hart
|
|
9
|
+
autorequire:
|
|
10
|
+
bindir: bin
|
|
11
|
+
cert_chain: []
|
|
12
|
+
date: 2012-11-07 00:00:00.000000000 Z
|
|
13
|
+
dependencies:
|
|
14
|
+
- !ruby/object:Gem::Dependency
|
|
15
|
+
name: rspec
|
|
16
|
+
requirement: !ruby/object:Gem::Requirement
|
|
17
|
+
none: false
|
|
18
|
+
requirements:
|
|
19
|
+
- - ! '>='
|
|
20
|
+
- !ruby/object:Gem::Version
|
|
21
|
+
version: '0'
|
|
22
|
+
type: :development
|
|
23
|
+
prerelease: false
|
|
24
|
+
version_requirements: !ruby/object:Gem::Requirement
|
|
25
|
+
none: false
|
|
26
|
+
requirements:
|
|
27
|
+
- - ! '>='
|
|
28
|
+
- !ruby/object:Gem::Version
|
|
29
|
+
version: '0'
|
|
30
|
+
description: Crappy redis counter
|
|
31
|
+
email:
|
|
32
|
+
- richard@ur-ban.com
|
|
33
|
+
executables: []
|
|
34
|
+
extensions: []
|
|
35
|
+
extra_rdoc_files: []
|
|
36
|
+
files:
|
|
37
|
+
- .gitignore
|
|
38
|
+
- Gemfile
|
|
39
|
+
- LICENSE.txt
|
|
40
|
+
- README.md
|
|
41
|
+
- Rakefile
|
|
42
|
+
- crappy_counter.gemspec
|
|
43
|
+
- lib/crappy_counter.rb
|
|
44
|
+
- lib/crappy_counter/version.rb
|
|
45
|
+
- spec/crappy_counter_spec.rb
|
|
46
|
+
- spec/spec_helper.rb
|
|
47
|
+
homepage: ''
|
|
48
|
+
licenses: []
|
|
49
|
+
post_install_message:
|
|
50
|
+
rdoc_options: []
|
|
51
|
+
require_paths:
|
|
52
|
+
- lib
|
|
53
|
+
required_ruby_version: !ruby/object:Gem::Requirement
|
|
54
|
+
none: false
|
|
55
|
+
requirements:
|
|
56
|
+
- - ! '>='
|
|
57
|
+
- !ruby/object:Gem::Version
|
|
58
|
+
version: '0'
|
|
59
|
+
required_rubygems_version: !ruby/object:Gem::Requirement
|
|
60
|
+
none: false
|
|
61
|
+
requirements:
|
|
62
|
+
- - ! '>='
|
|
63
|
+
- !ruby/object:Gem::Version
|
|
64
|
+
version: '0'
|
|
65
|
+
requirements: []
|
|
66
|
+
rubyforge_project:
|
|
67
|
+
rubygems_version: 1.8.24
|
|
68
|
+
signing_key:
|
|
69
|
+
specification_version: 3
|
|
70
|
+
summary: Crappy redis counter
|
|
71
|
+
test_files:
|
|
72
|
+
- spec/crappy_counter_spec.rb
|
|
73
|
+
- spec/spec_helper.rb
|