ranking 0.1.0

data/.document

@@ -0,0 +1,4 @@
+lib/**/*.rb
+README.rdoc
+ChangeLog.rdoc
+LICENSE.txt

data/.gitignore

@@ -0,0 +1,4 @@
+Gemfile.lock
+html/
+pkg/
+vendor/cache/*.gem

data/.rspec

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

data/ChangeLog.rdoc

@@ -0,0 +1,4 @@
+=== 0.1.0 / 2012-07-04
+
+* Initial release:
+

data/Gemfile

@@ -0,0 +1,13 @@
+source :rubygems
+
+gemspec
+
+group :development do
+
+  gem "pry"
+  gem 'rubygems-tasks',  '~> 0.2'
+  gem 'rdoc',  '~> 3.0'
+  gem 'rspec',  '~> 2.4'
+  gem 'bundler',  '~> 1.0'
+  gem 'rake',  '~> 0.8'
+end

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2012 Ryan Michael
+
+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,33 @@
+# ranking
+
+## Description
+
+Extends `Set` to be ordered by a score.  
+
+## Examples
+
+``` ruby
+require 'ranking'
+
+ranking = Ranking.new
+ranking << :foo
+ranking << :bar
+
+ranking.inc(:foo, 2)      # Incremente score of :foo by one
+ranking.dec(:bar)         # Decrement, defaults to 1
+ranking.score(:baz, 3)    # Set score explicitly, implicitly adds :baz to the set
+
+ranking.to_a              # => [:baz, :foo, :bar]
+ranking.scores[:foo]      # => 2
+```
+
+
+## Install
+
+  $ gem install ranking
+
+## Copyright
+
+Copyright (c) 2012 Ryan Michael
+
+See LICENSE.txt for details.

data/Rakefile

@@ -0,0 +1,36 @@
+# encoding: utf-8
+
+require 'rubygems'
+
+begin
+  require 'bundler'
+rescue LoadError => e
+  warn e.message
+  warn "Run `gem install bundler` to install Bundler."
+  exit e.status_code
+end
+
+begin
+  Bundler.setup(:development)
+rescue Bundler::BundlerError => e
+  warn e.message
+  warn "Run `bundle install` to install missing gems."
+  exit e.status_code
+end
+
+require 'rake'
+
+require 'rubygems/tasks'
+Gem::Tasks.new
+
+require 'rdoc/task'
+RDoc::Task.new do |rdoc|
+  rdoc.title = "ranking"
+end
+task :doc => :rdoc
+
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new
+
+task :test    => :spec
+task :default => :spec

data/lib/ranking.rb

@@ -0,0 +1,12 @@
+require 'set'
+
+class Ranking < Set
+  require 'ranking/instance_methods'
+  require 'ranking/set_methods'
+
+  include InstanceMethods
+  include SetMethods
+
+  attr_reader :scores
+end
+

data/lib/ranking/instance_methods.rb

@@ -0,0 +1,24 @@
+module Ranking::InstanceMethods
+  def initialize(*args)
+    @scores = Hash.new(0)
+    super *args
+  end
+
+  def inc(object, value=1)
+    self << object
+    scores[object] += value 
+    self
+  end
+
+  def dec(object, value=1)
+    self << object
+    scores[object] -= value
+    self
+  end
+
+  def score(object, value)
+    self << object
+    scores[object] = value
+    self
+  end
+end

data/lib/ranking/set_methods.rb

@@ -0,0 +1,94 @@
+module Ranking::SetMethods
+  def &(enum)
+    raise NotImplementedError
+  end
+
+  def |(enum)
+    dup.merge(enum)
+  end
+
+  def -(enum)
+    raise NotImplementedError
+  end
+
+  def ==(other)
+    other.kind_of?(Ranking) and other.scores == scores and super(other)
+  end
+
+  def ^(other)
+    raise NotImplementedError
+  end
+
+  def clear
+    @scores = Hash.new(0)
+    super
+  end
+
+  def collect
+    raise NotImplementedError
+  end
+
+  def delete(object)
+    scores.delete(object)
+    super object
+  end
+
+  def delete?(object)
+    scores.delete(object)
+    super object
+  end
+
+  def delete_if(&block)
+    raise NotImplementedError
+  end
+
+  def divide(&block)
+    raise NotImplementedError
+  end
+
+  def each(&block)
+    to_a.each(&block)
+  end
+
+  def flatten
+    raise NotImplementedError
+  end
+
+  def inspect
+    "<Ranking: #{to_a.map(&:inspect).join(', ')}>"
+  end
+
+  def keep_if(&block)
+    raise NotImplementedError
+  end
+
+  def merge(enum)
+    if enum.kind_of?(Ranking)
+      scores.merge!(enum.scores)
+    end
+
+    super enum
+  end
+
+  def reject!(&block)
+    raise NotImplementedError
+  end
+
+  def replace(enum)
+    raise NotImplementedError
+  end
+
+  def select!(&block)
+    raise NotImplementedError
+  end
+
+  def to_a
+    super.sort do |a,b|
+      if scores[a] == scores[b]
+        a <=> b
+      else
+        scores[b] <=> scores[a]
+      end
+    end
+  end
+end

data/ranking.gemspec

@@ -0,0 +1,19 @@
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |gem|
+  gem.name          = "ranking"
+  gem.version       = "0.1.0"
+  gem.summary       = %q{Sorted sets using scores}
+  gem.description   = %q{Extends Set with a score.  Sorts by score on #to_a, #each, etc}
+  gem.license       = "MIT"
+  gem.authors       = ["Ryan Michael"]
+  gem.email         = "kerinin@gmail.com"
+  gem.homepage      = "https://github.com/kerinin/ranking#readme"
+
+  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_development_dependency 'bundler', '~> 1.0'
+end

data/spec/instance_methods_spec.rb

@@ -0,0 +1,84 @@
+require 'spec_helper'
+require 'ranking'
+
+describe Ranking::InstanceMethods do
+  before(:each) do
+    @instance = Ranking[:foo, :bar]
+  end
+
+  describe "::new" do
+    it "creates an empty scores hash" do
+      Ranking.new.scores.should == {}
+    end
+
+    it "defaults to score=0" do
+      Ranking[:foo].scores[:foo].should == 0
+    end
+  end
+
+  describe "#inc" do
+    it "returns self" do
+      @instance.inc(:foo).should be_a(Ranking)
+    end
+
+    it "adds element if not already there" do
+      @instance.inc(:baz).should include(:baz)
+    end
+
+    it "increments by passed value" do
+      @instance.inc(:foo, 10).scores[:foo].should == 10
+    end
+
+    it "is idempotent" do
+      @instance.inc(:foo, 5).inc(:foo, 5).scores[:foo].should == 10
+    end
+
+    it "defaults to 1" do
+      @instance.inc(:foo).scores[:foo].should == 1
+    end
+  end
+
+  describe "#dec" do
+    it "returns self" do
+      @instance.dec(:foo).should be_a(Ranking)
+    end
+
+    it "adds element if not already there" do
+      @instance.dec(:baz).should include(:baz)
+    end
+
+    it "decrements by passed value" do
+      @instance.dec(:foo, 10).scores[:foo].should == -10
+    end
+
+    it "is idempotent" do
+      @instance.dec(:foo, 5).dec(:foo, 5).scores[:foo].should == -10
+    end
+
+    it "defaults to 1" do
+      @instance.dec(:foo).scores[:foo].should == -1
+    end
+  end
+
+  describe "#score" do
+    it "returns self" do
+      @instance.score(:foo, 10).should be_a(Ranking)
+    end
+
+    it "adds element if not already there" do
+      @instance.score(:baz, 10).should include(:baz)
+    end
+
+    it "scorerements by passed value" do
+      @instance.score(:foo, 10).scores[:foo].should == 10
+    end
+
+    it "is idempotent" do
+      @instance.score(:foo, 5).score(:foo, 10).scores[:foo].should == 10
+    end
+
+    it "requires a value" do
+      expect { @instance.score(:foo) }.to raise_error(ArgumentError)
+    end
+  end
+end

data/spec/ranking_spec.rb

@@ -0,0 +1,5 @@
+require 'spec_helper'
+require 'ranking'
+
+describe Ranking do
+end

data/spec/set_methods_spec.rb

@@ -0,0 +1,250 @@
+require 'spec_helper'
+require 'ranking'
+
+describe Ranking::SetMethods do
+  before(:each) do
+    @instance = Ranking[:foo, :bar]
+  end
+
+  describe "#&" do
+    it "isn't implemented" do
+      expect { @instance & @instance }.to raise_error(NotImplementedError)
+    end
+  end
+
+  describe "#|" do
+    before(:each) do
+      other = Ranking[:bar, :baz].inc(:bar).inc(:baz)
+      @union = @instance | other
+    end
+
+    it "creates the union set" do
+      @union.to_set.should == [:foo, :bar, :baz].to_set
+    end
+
+    it "merges scores with preference to other" do
+      @union.scores.should == {:bar => 1, :baz => 1}
+    end
+  end
+
+  describe "#-" do
+    it "isn't implemented" do
+      expect { @instance - @instance }.to raise_error(NotImplementedError)
+    end
+  end
+
+  describe "#==" do
+    it "is true if the same" do
+      @instance.should == @instance
+    end
+
+    it "is false if scores different" do
+      other = Ranking[@instance.to_a].dec(:foo)
+      @instance.should_not == @other
+    end
+
+    it "is false if sets different" do
+      other = Ranking[:bar, :baz]
+      other.instance_variable_set(:@scores, @instance.scores)
+      @instance.should_not == other
+    end
+  end
+
+  describe "#^" do
+    it "isn't implemented" do
+      expect { @instance ^ @instance }.to raise_error(NotImplementedError)
+    end
+  end
+
+  describe "#add" do
+    before(:each) do
+      @instance.add :baz
+    end
+
+    it "returns self" do
+      @instance.add(:qux).should be_a(Ranking)
+    end
+
+    it "adds to the set" do
+      @instance.should include(:baz)
+    end
+  end
+
+  describe "#add?" do
+    it "calls add" do
+      @instance.should_receive(:add).with(:baz)
+      @instance.add?(:baz)
+    end
+
+    it "returns nil if already a member" do
+      @instance.add?(:foo).should be_false
+    end
+  end
+
+  describe "#clear" do
+    before(:each) do
+      @instance.clear
+    end
+
+    it "removes set elements" do
+      @instance.to_set.should == Set.new
+    end
+
+    it "clears scores" do
+      @instance.scores.should == {}
+    end
+  end
+
+  describe "#collect" do
+    it "isn't implemented" do
+      expect { @instance.collect {} }.to raise_error(NotImplementedError)
+    end
+  end
+
+  describe "#delete" do
+    before(:each) do
+      @instance.delete(:foo)
+    end
+
+    it "removes from set" do
+      @instance.should_not include(:foo)
+    end
+
+    it "removes from scores" do
+      @instance.scores.keys.should_not include(:foo)
+    end
+  end
+
+  describe "#delete?" do
+    it "removes from the set" do
+      @instance.delete?(:foo).should_not include(:foo)
+    end
+
+    it "removes from the scores" do
+      @instance.delete?(:foo).scores.keys.should_not include(:foo)
+    end
+
+    it "returns nil if not a member" do
+      @instance.delete?(:baz).should be_false
+    end
+  end
+
+  describe "#delete_if" do
+    it "isn't implemented" do
+      expect { @instance.delete_if {} }.to raise_error(NotImplementedError)
+    end
+  end
+
+  describe "#divide" do
+    it "isn't implemented" do
+      expect { @instance.divide {} }.to raise_error(NotImplementedError)
+    end
+  end
+
+  describe "#each" do
+    it "yields in order" do
+      @instance.score(:foo, 5)
+      @instance.score(:bar, 0)
+      @instance.score(:baz, 3)
+
+      yielder = double
+      yielder.should_receive(:call).with(:foo).ordered
+      yielder.should_receive(:call).with(:baz).ordered
+      yielder.should_receive(:call).with(:bar).ordered
+
+      @instance.each {|i| yielder.call(i)}
+    end
+  end
+
+  describe "#flatten" do
+    it "isn't implemented" do
+      expect { @instance.flatten }.to raise_error(NotImplementedError)
+    end
+  end
+
+  describe "#inspect" do
+    it "returns string" do
+      @instance.inc(:baz)
+      @instance.inspect.should == "<Ranking: :baz, :bar, :foo>"
+    end
+  end
+
+  describe "#keep_if" do
+    it "isn't implemented" do
+      expect { @instance.keep_if {} }.to raise_error(NotImplementedError)
+    end
+  end
+
+  describe "#merge" do
+    it "adds to set" do
+      @instance.merge Ranking[:baz]
+      @instance.should include(:baz)
+    end
+
+    it "adds to scores" do
+      @instance.merge Ranking[:baz].score(:baz,10)
+      @instance.scores[:baz].should == 10
+    end
+
+    it "merges scores with preference to other" do
+      @instance.merge Ranking[:bar].score(:bar,10)
+      @instance.scores[:bar].should == 10
+    end
+
+    it "accepts enumerable" do
+      @instance.merge [:bar, :baz]
+      @instance.should include(:baz)
+    end
+
+    it "retains existing scores if enumerable part of set" do
+      @instance.score(:bar, 10).merge [:bar, :baz]
+      @instance.scores[:bar].should == 10
+    end
+
+    it "defaults to zero if enumerable not part of set" do
+      @instance.merge [:bar, :baz]
+      @instance.scores[:baz].should == 0
+    end
+  end
+
+  describe "#reject!" do
+    it "isn't implemented" do
+      expect { @instance.reject! {} }.to raise_error(NotImplementedError)
+    end
+  end
+
+  describe "#replace" do
+    it "isn't implemented" do
+      expect { @instance.replace @replace }.to raise_error(NotImplementedError)
+    end
+  end
+
+  describe "#select!" do
+    it "isn't implemented" do
+      expect { @instance.select! {} }.to raise_error(NotImplementedError)
+    end
+  end
+
+  describe "#to_a" do
+    it "returns an array" do
+      @instance.to_a.should be_a(Array)
+    end
+
+    it "sorts by score" do
+      @instance.score(:foo, 5)
+      @instance.score(:bar, 0)
+      @instance.score(:baz, 3)
+
+      @instance.to_a.should == [:foo, :baz, :bar]
+    end
+
+    it "sorts by value if score equivalent" do
+      @instance.score(:foo, 5)
+      @instance.score(:bar, 0)
+      @instance.score(:qux, 2)
+      @instance.score(:baz, 2)
+
+      @instance.to_a.should == [:foo, :baz, :qux, :bar]
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,3 @@
+require 'rspec'
+require 'pry'
+require 'ranking'

metadata

@@ -0,0 +1,87 @@
+--- !ruby/object:Gem::Specification
+name: ranking
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+  prerelease: 
+platform: ruby
+authors:
+- Ryan Michael
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-07-04 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.0'
+description: ! 'Extends Set with a score.  Sorts by score on #to_a, #each, etc'
+email: kerinin@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .document
+- .gitignore
+- .rspec
+- ChangeLog.rdoc
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/ranking.rb
+- lib/ranking/instance_methods.rb
+- lib/ranking/set_methods.rb
+- ranking.gemspec
+- spec/instance_methods_spec.rb
+- spec/ranking_spec.rb
+- spec/set_methods_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/kerinin/ranking#readme
+licenses:
+- MIT
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: 2123784621627134409
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: 2123784621627134409
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.23
+signing_key: 
+specification_version: 3
+summary: Sorted sets using scores
+test_files:
+- spec/instance_methods_spec.rb
+- spec/ranking_spec.rb
+- spec/set_methods_spec.rb
+- spec/spec_helper.rb