has_streak 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 5bc92c9b28f09aebafeed5d5777934687b466eea
-  data.tar.gz: 2b053c10a0644c46e3ced087631f91f3ee11705d
+  metadata.gz: 3addd5db918bed4cc4714e6d64767c6a3ea3d84f
+  data.tar.gz: e1949a658bef8b49596d4565ab5405fa84173c42
 SHA512:
-  metadata.gz: 42453ff1e357a2ab4a802739284f753a41104174535a24a8818167d75ef4a9ff1a7589d8d110057925aafb620ac575782a66417d4e5ade4b8d4531abf375eb0d
-  data.tar.gz: 2a78ab6fe71310a9e22a415581925d6719f16af35478f8804b28bd0d2f1b34fc37aaa6d65c2c79279e4e80c63f133db9a3eda45c35971199862ac62d099f973d
+  metadata.gz: 73dedc299b1b06899914fae3db6aa5ed95e8dde0daa9fdc33c1eee8610e9078cdc3bbb325393acf6c9e38018c220c629652f10d2814ee69177b8c9b56852e3e3
+  data.tar.gz: fed002fc0506f3c96cd21ed76af1a3ed57a2e1564dbb72942a66e6715cd05aa595f8723ed49d78c1b5d2ac384fe183775a00e8dc3ebeeaa131e5c2e8fb64545a

data/README.md

@@ -1,6 +1,6 @@
 # HasStreak
 
-TODO: Write a gem description
+Track streaks on your ActiveRecord models.
 
 ## Installation
 
@@ -18,7 +18,37 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+Let's say I have a <code>User</code> that <code>has_many</code> posts:
+
+```ruby
+class User < ActiveRecord::Base
+  has_many :posts
+end
+```
+
+I want to track how many days in a row that each user wrote a post. I just have to add <code>has_streak</code> to the model:
+
+```ruby
+class User < ActiveRecord::Base
+  # ...
+
+  has_streak
+end
+```
+
+Now I can display the user's streak:
+
+```ruby
+user.streak(:posts) # => number of days in a row that this user wrote a post.
+```
+
+The <code>streak</code> instance method can be called with any association:
+
+```ruby
+user.streak(:other_association)
+```
+
+This gem assumes that the model you want to track has a <code>created_at</code> timestamp.
 
 ## Contributing
 

data/lib/has_streak/streakable.rb

@@ -15,12 +15,12 @@ module HasStreak
       private
 
       def get_days_in_descending_order(association)
-        self.send(association).order("created_at DESC").pluck(:created_at).map(&:day)
+        self.send(association).order(:created_at).pluck(:created_at).map(&:to_date).uniq
       end
 
       def determine_consecutive_days(days)
-        days.each_with_index.inject(1) do |streak, (day, index)|
-          streak += 1 if day - 1 == days[index + 1]
+        days.each_with_index.inject(0) do |streak, (day, index)|
+          streak += 1 if day + 1 == day.tomorrow
           streak
         end
       end

data/lib/has_streak/version.rb

@@ -1,3 +1,3 @@
 module HasStreak
-  VERSION = "0.0.1"
+  VERSION = "0.0.2"
 end

data/spec/streakable_spec.rb

@@ -5,11 +5,20 @@ describe HasStreak::Streakable do
     let(:user) { User.create(name: "garrett") }
 
     it "returns a streak of 3" do
-      oldest = Post.create(content: "hello", user_id: user.id, created_at: 2.days.ago)
-      old = Post.create(content: "hello", user_id: user.id, created_at: 1.day.ago)
-      new = Post.create(content: "hello", user_id: user.id)
+      user.posts.create(content: "hello", created_at: 2.days.ago)
+      user.posts.create(content: "hello", created_at: 1.day.ago)
+      user.posts.create(content: "hello")
 
       expect(user.streak(:posts)).to eq(3)
     end
+
+    context "spanning two months" do
+      it "returns a streak of 2" do
+        user.posts.create(content: "hello", created_at: Date.new.end_of_month)
+        user.posts.create(content: "hello", created_at: Date.new.end_of_month.advance(days: 1))
+
+        expect(user.streak(:posts)).to eq(2)
+      end
+    end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: has_streak
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Garrett Martin
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-10-12 00:00:00.000000000 Z
+date: 2014-10-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord