ohm-tallyable 0.1.0

checksums.yaml

@@ -0,0 +1,15 @@
+---
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    NGQyYTQzMTdhZGRjZjRmYWYwZWZkYTE4YzQ5YTEzNzEzOTFiMzAwMA==
+  data.tar.gz: !binary |-
+    YmYwMmFhYWJjMGRlZGI0NTY1YTY5Y2RlNTlmYTQzMWNjNTUxZmM4ZA==
+!binary "U0hBNTEy":
+  metadata.gz: !binary |-
+    ODRjMDMxMjk2ZmY3ZWU5NDNmNDRlMzQwNDMzN2MwNDI1MjIyY2NjM2QwYjdi
+    YTJmNThmODFhZjdkNGRkM2ExZTkyODY2MTJkMTE1MWU1OGVhN2VlMzFiYTI3
+    NzUwMzNiMmM1ZmRjNGNiNjEyYzBmODllY2VlMjYwYjRiZThiZTY=
+  data.tar.gz: !binary |-
+    M2FiODBlMzBmM2VkYzNiNmFjMTg1ZjcwMmVhNjA1YjM4YmVlM2ZkMmQ2OTkw
+    MGZjZmVlYmQ5NjM0NDA3ZjczNjdlYzU1OTFkNjU2NmI0ODJmN2VlMzk1MGRh
+    ZDY4MDA0N2M1ZGRlNDgwOGY0NWQwZTFjOGIwMzllOTVlNTc4ODg=

data/README.md

@@ -0,0 +1,47 @@
+
+ohm-tallyable
+=============
+
+A tally plugin for Ohm
+
+
+Setup
+-----
+
+1. Include the `Tallyable` module in your model:
+
+		include Ohm::Tallyable
+
+2. Add a tally to your model with the following line:
+
+		tally :category
+
+You will need to resave every model if they already exist.
+
+Usage
+-----
+
+To query the tallies, use the `leaderboard` class method.
+
+    Post.leaderboard(:category)
+
+
+Advanced Usage
+--------------
+
+You can also partition the tally by a certain attribute:
+
+    tally :category, :by => :site_id
+
+You will need to provide a value for this attribute every time you check the
+leaderboard:
+
+	Post.leaderboard(:category, :site_id => 'ar') 
+
+
+Acknowledgements
+----------------
+
+Many thanks to Damian Janowski (https://github.com/djanowski) who took care to
+explain me the details of coding an Ohm plugin and providing many ideas on
+how to handle certain cases.

data/Rakefile

@@ -0,0 +1,31 @@
+require "rake/testtask"
+
+REDIS_DIR = File.expand_path(File.join("..", "test"), __FILE__)
+REDIS_CNF = File.join(REDIS_DIR, "test.conf")
+REDIS_PID = File.join(REDIS_DIR, "db", "redis.pid")
+
+task :default => :run
+
+desc "Run tests and manage server start/stop"
+task :run => [:start, :test, :stop]
+
+desc "Start the Redis server"
+task :start do
+    unless File.exists?(REDIS_PID)
+        system "redis-server #{REDIS_CNF}"
+    end
+end
+
+desc "Stop the Redis server"
+task :stop do
+    if File.exists?(REDIS_PID)
+        system "kill #{File.read(REDIS_PID)}"
+        File.delete(REDIS_PID)
+    end
+end
+
+Rake::TestTask.new do |t|
+  t.libs << "test"
+  t.test_files = FileList['test/test*.rb']
+  t.verbose = true
+end

data/UNLICENSE

@@ -0,0 +1,24 @@
+This is free and unencumbered software released into the public domain.
+
+Anyone is free to copy, modify, publish, use, compile, sell, or
+distribute this software, either in source code form or as a compiled
+binary, for any purpose, commercial or non-commercial, and by any
+means.
+
+In jurisdictions that recognize copyright laws, the author or authors
+of this software dedicate any and all copyright interest in the
+software to the public domain. We make this dedication for the benefit
+of the public at large and to the detriment of our heirs and
+successors. We intend this dedication to be an overt act of
+relinquishment in perpetuity of all present and future rights to this
+software under copyright law.
+
+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 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.
+
+For more information, please refer to <http://unlicense.org/>

data/lib/ohm/tallyable.rb

@@ -0,0 +1,72 @@
+require 'ohm'
+require 'ohm/contrib'
+
+module Ohm
+  module Tallyable
+    module Macros
+      def tally(attribute, options={})
+        tallies[attribute] = options
+      end
+
+      def tallies
+        @tallies ||= {}
+      end
+
+      def leaderboard(attribute, by=nil)
+        tally = tallies[attribute]
+        if tally.nil? || (tally[:by] && (by.nil? || !by.include?(tally[:by])))
+          raise ArgumentError
+        end
+        key = self.key[:tallies][attribute]
+        if by
+          key = key[by.keys.first][by.values.first]
+        end
+
+        _load_zset(key)
+          .map { |k, v| [k, v.to_i] }
+          .sort_by { |k, v| [-v, k] }
+      end
+
+      if Redis::VERSION.to_i == 2
+        def _load_zset(key)
+          key.zrevrange(0, -1, with_scores: true).each_slice(2)
+        end
+      else
+        def _load_zset(key)
+          key.zrevrange(0, -1, with_scores: true)
+        end
+      end
+    end
+
+    def self.included(model)
+      model.before(:delete, :_decrement_tallies)
+      model.before(:save, :_decrement_tallies)
+      model.after(:save, :_increment_tallies)
+
+      model.extend(Macros)
+    end
+
+    def _decrement_tallies
+      _update_tallies(-1) { |attribute| read_remote(attribute) }
+    end
+
+    def _increment_tallies
+      _update_tallies(1) { |attribute| send(attribute) }
+    end
+
+    def _update_tallies(amount, &block)
+      self.class.tallies.each do |attribute, options|
+        value = yield(attribute)
+        key = self.class.key[:tallies][attribute]
+        if options[:by]
+          value_by = yield(options[:by])
+          key = key[options[:by]][value_by]
+        end
+        if value
+          key.zincrby(amount, value)
+          key.zrem(value) if key.zscore(value) == 0.0
+        end
+      end
+    end
+  end
+end

data/ohm-tallyable.gemspec

@@ -0,0 +1,12 @@
+Gem::Specification.new do |s|
+  s.name        = 'ohm-tallyable'
+  s.version     = '0.1.0'
+  s.summary     = "Ohm Tally Plugin"
+  s.description = "A tally plugin for Ohm that keeps counts of records for every value of an attribute"
+  s.author      = "Federico Bond"
+  s.email       = 'federico@educabilia.com'
+  s.files       = Dir["UNLICENSE", "README.md", "Rakefile", "lib/**/*.rb", "*.gemspec", "test/*.*"]
+  s.homepage    = 'https://github.com/educabilia/ohm-tallyable'
+
+  s.add_dependency "ohm", ">= 0.1.3"
+end

data/test/test-tallyable.rb

@@ -0,0 +1,100 @@
+require 'test/unit'
+require 'ohm/tallyable'
+
+class Event < Ohm::Model
+  include Ohm::Callbacks
+  include Ohm::Tallyable
+
+  attribute :location
+  tally :location
+end
+
+class TallyableTest < Test::Unit::TestCase
+  def setup
+    Ohm.flush
+    Event.create(location: "Buenos Aires")
+  end
+
+  def test_leaderboard
+    Event.create(location: "Buenos Aires")
+    Event.create(location: "Rosario")
+    l = Event.leaderboard(:location)
+    assert_equal [["Buenos Aires", 2], ["Rosario", 1]], l
+  end
+
+  def test_update
+    Event[1].update(location: "Corrientes")
+    l = Event.leaderboard(:location)
+    assert_equal [["Corrientes", 1]], l
+  end
+
+  def test_nil
+    Event[1].update(location: nil)
+    l = Event.leaderboard(:location)
+    assert_equal [], l
+  end
+
+  def test_create_nil
+    Event.create(location: nil)
+    l = Event.leaderboard(:location)
+    assert_equal [["Buenos Aires", 1]], l
+  end
+
+  def test_delete
+    Event[1].delete
+    l = Event.leaderboard(:location)
+    assert_equal [], l
+  end
+end
+
+class Post < Ohm::Model
+  include Ohm::Callbacks
+  include Ohm::Tallyable
+
+  attribute :category
+  attribute :site
+  tally :category, by: :site
+end
+
+class TallyableByTest < Test::Unit::TestCase
+  def setup
+    Ohm.flush
+    Post.create(category: "Personal", site: "ar")
+    Post.create(category: "Personal", site: "ar")
+    Post.create(category: "Work", site: "ar")
+  end
+
+  def test_leaderboard
+    Post.create(category: "Personal", site: "uy")
+    uy = Post.leaderboard(:category, site: "uy")
+    ar = Post.leaderboard(:category, site: "ar")
+    assert_equal [["Personal", 1]], uy
+    assert_equal [["Personal", 2], ["Work", 1]], ar
+  end
+
+  def test_update
+    Post[1].update(category: "Work", site: "uy")
+    uy = Post.leaderboard(:category, site: "uy")
+    ar = Post.leaderboard(:category, site: "ar")
+    assert_equal [["Work", 1]], uy
+    assert_equal [["Personal", 1], ["Work", 1]], ar
+  end
+
+  def test_delete
+    Post[1].delete
+    l = Post.leaderboard(:category, site: "ar")
+    assert_equal [["Personal", 1], ["Work", 1]], l
+  end
+
+  def test_leaderboard_invalid
+    assert_raise(ArgumentError) do
+      Post.leaderboard(:foo, site: "ar")
+    end
+    assert_raise(ArgumentError) do
+      Post.leaderboard(:category)
+    end
+    assert_raise(ArgumentError) do
+      Post.leaderboard(:category, foo: "bar")
+    end
+  end
+end

data/test/test.conf

@@ -0,0 +1,8 @@
+dir ./test/db
+pidfile ./redis.pid
+port 6379
+timeout 300
+loglevel debug
+logfile stdout
+databases 16
+daemonize yes

metadata

@@ -0,0 +1,64 @@
+--- !ruby/object:Gem::Specification
+name: ohm-tallyable
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Federico Bond
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-08-07 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: ohm
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 0.1.3
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 0.1.3
+description: A tally plugin for Ohm that keeps counts of records for every value of
+  an attribute
+email: federico@educabilia.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- UNLICENSE
+- README.md
+- Rakefile
+- lib/ohm/tallyable.rb
+- ohm-tallyable.gemspec
+- test/test-tallyable.rb
+- test/test.conf
+homepage: https://github.com/educabilia/ohm-tallyable
+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.6
+signing_key: 
+specification_version: 4
+summary: Ohm Tally Plugin
+test_files: []