popular_stream 1.0.0 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 6df6ce9f9726447977830802fe8a7e6f15cb8c00
-  data.tar.gz: 72253cc504abd85e4893ce25ac9d1310c3b5ddc3
+  metadata.gz: 708930f3a23948e3ddeaa0ead9859fd297b5c8bf
+  data.tar.gz: 330abf086c97cb67dd827abec0fe79de154b69d5
 SHA512:
-  metadata.gz: 3952dc948f1bef9002534db2d36891ad893e05ad5b790d49b6ab27b08e2cb90a217f8c09310c553f057617a99456f00dca7250d39946fd3c6de3ec410baf2b60
-  data.tar.gz: 5e7cdca746f55e2922ecdaec2ee25e06b1120562bf78222a86983c3c3f0e77221f9b2cce34226f051de3b42b952af032ddd35bba8c22458488032da9dadc01bc
+  metadata.gz: 55cfa96f06fb25393f8265791921adc196a707939f6ec6bd66e6616f296d897baf08455a71a154a7f74f883a63152f185fb5970c660af8ee4086f7289716e10c
+  data.tar.gz: 0385c246417bf059cda48f3982c4fcc5c1e67936d9d0f69747f20ee8d60d2a4b2f39a5d46829ba0f95dd8174e380c202e6ef1f854df855f75f8e479fac993b43

data/.editorconfig

@@ -0,0 +1,20 @@
+; EditorConfig is awesome: http://EditorConfig.org
+
+; top-most EditorConfig file
+root = true
+
+; Unix-style newlines with a newline ending every file
+[*]
+indent_style = space
+end_of_line = lf
+insert_final_newline = true
+trim_trailing_whitespace = true
+charset = "utf-8"
+
+[*.{yml,rb,rake,coffee,scss,css,ru}]
+indent_style = space
+indent_size = 2
+
+[Rakefile]
+indent_style = space
+indent_size = 2

data/.travis.yml

@@ -0,0 +1,6 @@
+language: ruby
+cache: bundler
+rvm:
+  - 2.1.5
+
+script: "bundle exec rake"

data/CHANGELOG.md

@@ -0,0 +1,9 @@
+# Version 1.1 (Nov. 30, 2014)
+
+* Adding ability to get the scores with the results. This will be the default
+in V 2.0.0
+
+# Version 1.0 (Nov. 29, 2014)
+
+* Extracting code from We Heart It and making it a gem.
+

data/README.md

@@ -1,12 +1,12 @@
 # Popular Stream
 
-# THIS IS NOT READY YET!
+[![Build Status](https://travis-ci.org/nhocki/popular_streams.svg?branch=master)](https://travis-ci.org/nhocki/popular_streams)
 
 Simple popular content tracker with a Redis backend.
 
-Mostly taken from the "Popular Stream" code
-[here](http://stdout.heyzap.com/2013/04/08/surfacing-interesting-content/) but
-bundled up as a gem.
+Mostly taken from the "Popular Stream" code found in the
+[Surfacing Interesting Content](http://stdout.heyzap.com/2013/04/08/surfacing-interesting-content/)
+post but bundled up as a gem.
 
 PopularStream tracks an "event" on a group of "fields" and returns the ones that
 are currently popular.
@@ -18,6 +18,8 @@ The way this works is that "old" votes will count less than newer votes, that wa
 a tag that was used 20 times today will be more popular than a tag used 30 times
 last week.
 
+Once again, thanks to Micah Fivecoate for his post.
+
 ## Installation
 
 Add this line to your application's Gemfile:
@@ -34,6 +36,8 @@ Or install it yourself as:
 
     $ gem install popular_stream
 
+This gems requires **Ruby 2.1**.
+
 ## Usage
 
 There are two main methods `vote` and `get`. `vote` adds an event to the list
@@ -57,6 +61,9 @@ stream.get # => ['rubygems', 'ruby']
 # You can pass `limit` and `offset`
 stream.get(limit: 1, offset: 1) # => ['ruby']
 stream.get(offset: 10) # => []
+
+# You can ask to get the scores as well
+stream.get(with_scores: true) # => [['ruby', 0.00001]]
 ```
 
 ## Seting up & Configuring Redis
@@ -84,3 +91,6 @@ them as needed.
 3. Commit your changes (`git commit -am 'Add some feature'`)
 4. Push to the branch (`git push origin my-new-feature`)
 5. Create a new Pull Request
+
+If you're gonna open a Pull Request, please install [EditorConfig](http://editorconfig.org/),
+it will keep most of the basic code styling consistent.

data/lib/popular_stream/version.rb

@@ -1,3 +1,3 @@
 class PopularStream
-  VERSION = "1.0.0"
+  VERSION = "1.1.0"
 end

data/lib/popular_stream.rb

@@ -32,8 +32,8 @@ class PopularStream
     trim
   end
 
-  def get(limit: 20, offset: 0)
-    redis.zrevrange(name, offset, offset + limit - 1)
+  def get(limit: 20, offset: 0, **options)
+    redis.zrevrange(name, offset, offset + limit - 1, options)
   end
 
   def clear!

data/popular_stream.gemspec

@@ -18,11 +18,12 @@ Gem::Specification.new do |spec|
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ["lib"]
 
+  spec.required_ruby_version = '~> 2.1'
+  spec.add_dependency "redis", "~> 3.1.0"
+
   spec.add_development_dependency "bundler", "~> 1.7"
   spec.add_development_dependency "rake", "~> 10.0"
   spec.add_development_dependency "rspec", "~> 3.1.0"
   spec.add_development_dependency "timecop", "~> 0.7.1"
   spec.add_development_dependency "fakeredis", "~> 0.5.0"
-
-  spec.add_dependency "redis", "~> 3.1.0"
 end

data/spec/lib/popular_stream_spec.rb

@@ -4,6 +4,12 @@ RSpec.describe PopularStream do
   let(:one_week) { 60 * 60 * 24 * 7 } # 1 week in seconds.
   let(:stream) { PopularStream.new("popular_stream") }
 
+  # Make a new "Redis" for each test to not leak the doubles.
+  before do
+    PopularStream.redis = Redis.new
+    stream.clear!
+  end
+
   describe ".redis" do
     let(:redis) { double }
 
@@ -33,41 +39,52 @@ RSpec.describe PopularStream do
       expect(stream.get(limit: 1, offset: 1)).to eql([ '2' ])
       expect(stream.get(limit: 1, offset: 2)).to eql([ '1' ])
     end
-  end
 
-  it "ranks most popular for same time as higher" do
-    Timecop.freeze do
-      stream.vote(field: '1')
-      stream.vote(field: '1')
-      stream.vote(field: '2')
-      expect(stream.get).to eql(['1', '2'])
+    it "is possible to get the scores if an option is passed" do
+      results = stream.get(with_scores: true)
+      results.each do |result|
+        expect(result).to be_a(Array)
+        expect(result.size).to eql(2)
+      end
     end
   end
 
-  it "accepts a weight for the vote of a specific field" do
-    Timecop.freeze do
-      stream.vote(field: '1')
-      stream.vote(field: '1')
-      stream.vote(field: '2', weight: 3)
-      expect(stream.get).to eql(['2', '1'])
+  describe "#vote" do
+    it "ranks most popular for same time as higher" do
+      Timecop.freeze do
+        stream.vote(field: '1')
+        stream.vote(field: '1')
+        stream.vote(field: '2')
+        expect(stream.get).to eql(['1', '2'])
+      end
     end
-  end
 
-  it "keeps old votes with lower weight on values" do
-    Timecop.freeze do
-      stream.vote(field: '1', time: Time.now - 2 * one_week)
-      stream.vote(field: '2', time: Time.now - 3 * one_week)
+    it "accepts a weight for the vote of a specific field" do
+      Timecop.freeze do
+        stream.vote(field: '1')
+        stream.vote(field: '1')
+        stream.vote(field: '2', weight: 3)
+        expect(stream.get).to eql(['2', '1'])
+      end
+    end
 
-      stream.vote(field: '1')
-      stream.vote(field: '2')
+    it "keeps old votes with lower weight on values" do
+      Timecop.freeze do
+        stream.vote(field: '1', time: Time.now - 2 * one_week)
+        stream.vote(field: '2', time: Time.now - 3 * one_week)
+
+        stream.vote(field: '1')
+        stream.vote(field: '2')
+      end
+      expect(stream.get).to eql(['1', '2'])
     end
-    expect(stream.get).to eql(['1', '2'])
   end
 
   it "#count gets the number of elements and #clear! removes them all" do
     stream.vote(field: '1')
     stream.vote(field: '1')
     expect(stream.count).to eql(1)
+
     stream.clear!
     expect(stream.count).to eql(0)
   end

metadata

@@ -1,15 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: popular_stream
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.0
 platform: ruby
 authors:
 - Nicolás Hock Isaza
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-11-30 00:00:00.000000000 Z
+date: 2014-12-01 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: redis
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.1.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.1.0
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -80,20 +94,6 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 0.5.0
-- !ruby/object:Gem::Dependency
-  name: redis
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 3.1.0
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 3.1.0
 description: Ruby gem to track popular streams with a redis backend.
 email:
 - nhocki@gmail.com
@@ -101,8 +101,11 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".editorconfig"
 - ".gitignore"
 - ".rspec"
+- ".travis.yml"
+- CHANGELOG.md
 - Gemfile
 - LICENSE.txt
 - README.md
@@ -122,9 +125,9 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - "~>"
     - !ruby/object:Gem::Version
-      version: '0'
+      version: '2.1'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="