streakable 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 2117453eb59848b55a11e27607df503b4a3e8c32
-  data.tar.gz: b88852d4a47c1f5b20290d0706e2f5284e108bf8
+  metadata.gz: 726ca092eee86d7af43a51665e0293cb6cb9f4de
+  data.tar.gz: 92c319a54b0593658eb97abed907bb815ae0a007
 SHA512:
-  metadata.gz: 92cc3cdf95b76c1df41c4d49f469ec0703cda4d96cd62c373c390de98fc96d939666b13a11edce31fd5d7bf2ab078c044fa3bca8388bbf1f0c5a22471ca47e0b
-  data.tar.gz: 438bcda9fd55f5470cb9d973547fcfabdbc11a6f48d88fae8ad392f464bd8b0a1ac1f047357aaadcbf15fcc0b42013652de96624b12d3ab8c08dbbdd40d11ee1
+  metadata.gz: b70d48925fa792efd5337f0810d4cd81eb2edadf122ee0ac5ca77182a549f1b30cc332435e83077bb7d51f896652f10a127ed8d279e7126e89efded5c0ceb337
+  data.tar.gz: 75662d9a63b49f3b4191a9a1434f73ae24967ad543d5702e9ad5c24b05313758e82598a10bc46f7e912f14c89b5e73d63700bec2e4e72d54b3cc0c0228247d6d

data/.travis.yml

@@ -5,7 +5,6 @@ matrix:
 branches:
   only: master
 rvm:
-  - 2.0.0
   - 2.1.0
   - 2.2.0
   - 2.3.0

data/README.md

@@ -1,8 +1,8 @@
-[![Build Status](https://travis-ci.org/szTheory/streakable.svg?branch=master)](https://travis-ci.org/szTheory/streakable)
+[![Gem Version](https://badge.fury.io/rb/streakable.svg)](https://badge.fury.io/rb/streakable) [![Build Status](https://travis-ci.org/szTheory/streakable.svg?branch=master)](https://travis-ci.org/szTheory/streakable) [![Inline docs](http://inch-ci.org/github/szTheory/streakable.svg?branch=master)](http://inch-ci.org/github/szTheory/streakable) [![MIT License](https://img.shields.io/github/license/mashape/apistatus.svg)](https://github.com/szTheory/streakable/blob/master/LICENSE.txt)
 
 # Streakable
 
-Track consecutive day streaks on your ActiveRecord models. Fork of [has_streak](https://github.com/garrettqmartin8/has_streak) by Garrett Martin. This version has a different include interface and more options.
+Ruby gem to track consecutive day streaks :calendar: on your Rails/ActiveRecord models. Fork of [has_streak](https://github.com/garrettqmartin8/has_streak) by Garrett Martin. This version has a different include interface and more options. Requires Ruby >= 2.1 and ActiveRecord >= 3.0. GitHub project page: https://github.com/szTheory/streakable
 
 ## Installation
 
@@ -28,12 +28,10 @@ class User < ActiveRecord::Base
 end
 ```
 
-I want to track how many days in a row that each user wrote a post. I just have to add <code>streakable</code> to the model:
+I want to track how many days in a row that each user wrote a post. I just have to include <code>streakable</code> in the model:
 
 ```ruby
 class User < ActiveRecord::Base
-  # ...
-
   include Streakable
 end
 ```
@@ -50,22 +48,39 @@ The <code>streak</code> instance method can be called with any association:
 user.streak(:other_association)
 ```
 
-And you can change the column the streak is calculated on
+And you can change the column the streak is calculated on:
 
 ```ruby
 user.streak(:posts, :updated_at)
 ```
 
-Don't penalize the current day being absent when determining streaks
+Don't penalize the current day being absent when determining streaks (the User could write another Post before the day ends):
 
 ```ruby
 user.streak(:posts, except_today: true)
 ```
 
+Find the longest streak, not just the current one:
+
+```ruby
+user.streak(:posts, longest: true)
+```
+
+To get all of the streaks, not just the current one:
+
+```ruby
+user.streaks(:posts)
+```
+
 ## Contributing
 
 1. Fork it
-2. Create your feature branch (`git checkout -b my-new-feature`)
+2. Create your feature branch (`git checkout -b feature/my-new-feature`)
 3. Commit your changes (`git commit -am 'Add some feature'`)
-4. Push to the branch (`git push origin my-new-feature`)
-5. Create new Pull Request
+4. Push to the branch (`git push origin feature/my-new-feature`)
+5. Make sure specs are passing (`bundle exec rspec`)
+6. Create new Pull Request
+
+## License
+
+See the [LICENSE](https://github.com/szTheory/streakable/blob/master/LICENSE.txt) file.

data/_config.yml

@@ -0,0 +1 @@
+theme: jekyll-theme-tactile

data/lib/streakable.rb

@@ -1,6 +1,29 @@
 require "streakable/streak"
 require "active_record"
 
+# Let's say I have a +User+ that +has_many+ posts:
+# 
+#   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 +include Streakable+ in the model:
+# 
+#   class User < ActiveRecord::Base
+#     include Streakable
+#   end
+#
+# Now I can display the user's streak:
+#   user.streak(:posts) # => number of days in a row that this user wrote a post (as determined by the created_at column, by default)
+# 
+# The +streak+ instance method can be called with any association:
+#   user.streak(:other_association)
+# 
+# And you can change the column the streak is calculated on:
+#   user.streak(:posts, :updated_at)
+# 
+# Don't penalize the current day being absent when determining streaks (the User could write another Post before the day ends):
+#   user.streak(:posts, except_today: true)
 module Streakable
   def self.included(klass)
     klass.class_eval do
@@ -8,9 +31,42 @@ module Streakable
     end
   end
 
-  module InstanceMethods
-    def streak(association, column=:created_at, except_today: false)
-      Streak.new(self, association, column, except_today).length
+  module InstanceMethods # :nodoc:
+    # Calculate a calendar streak. That is to say, the number of consecutive
+    # days that exist for some date column, on an asociation with this object.
+    #
+    # For example if you have a User with many :posts, and one was created
+    # today that would be a streak of 1. If that user also created a Post yesterday,
+    # then the streak would be 2. If he created another Post the day before that one,
+    # he'd have a streak of 3, etc.
+    # 
+    # On the other hand imagine that the User hasn't created a Post yet today, but
+    # he did create one yesterday. Is that a streak? By default, it would be a streak of 0,
+    # so no. If you want to exclude the current day from this calculation, and count from
+    # yesterday, set +except_today+ to +true+.
+    # 
+    # @param [Symbol] association the ActiveRecord association on the instance
+    # @param [Symbol] column the column on the association that you want to calculate the streak against.
+    # @param [Boolean] except_today whether to include today in the streak length calculation or not. If this is true, then you are assuming there is still time today for the streak to be extended
+    # @param [Boolean] longest if true, calculate the longest day streak in the sequence, not just the current one
+    def streak(association, column=:created_at, except_today: false, longest: false)
+      build_streak(association, column, except_today: except_today).length(longest: longest)
     end
+
+    # Calculate all calendar streaks. Returns a list of Date arrays. That is to say, a listing of consecutive
+    # days counts that exist for some date column, on an asociation with this object.
+    # 
+    # @param [Symbol] association the ActiveRecord association on the instance
+    # @param [Symbol] column the column on the association that you want to calculate the streak against.
+    # @param [Boolean] except_today whether to include today in the streak length calculation or not. If this is true, then you are assuming there is still time today for the streak to be extended
+    # @param [Boolean] longest if true, calculate the longest day streak in the sequence, not just the current one
+    def streaks(association, column=:created_at)
+      build_streak(association, column, except_today: true).streaks
+    end
+
+    private
+      def build_streak(association, column, except_today:)
+        Streak.new(self, association, column, except_today: except_today)
+      end
   end
 end

data/lib/streakable/streak.rb

@@ -1,6 +1,31 @@
+# Represents a streak of calendar days as computed
+# by a date column on an association.
+#
+# So for example if you have a User that has_many :posts, then
+# +Streak.new(user, :posts, :created_at).length+ will tell you how many
+# consecutive days a given user created posts.
 class Streak
-  attr_reader :instance, :association, :column, :except_today
-  def initialize(instance, association, column, except_today)
+  # the base ActiveRecord object instance for this streak calculation
+  attr_reader :instance
+
+  # the AR association through which we want to grab a column to caculate a streak
+  attr_reader :association
+
+  # an AR column resolving to a date. the column that we want to calculate a calendar date streak against
+  attr_reader :column
+
+  # whether to include today in the streak length 
+  # calculation or not. If this is true, then you are assuming there 
+  # is still time today for the streak to be extended
+  attr_reader :except_today
+
+  # Creates a new Streak
+  # 
+  # @param [ActiveRecord::Base] instance an ActiveRecord object instance
+  # @param [Symbol] association a key representing the ActiveRecord association on the instance
+  # @param [Symbol] column a key representing the column on the association that you want to calculate the streak against
+  # @param [Boolean] except_today whether to include today in the streak length calculation or not. If this is true, then you are assuming there is still time today for the streak to be extended
+  def initialize(instance, association, column, except_today: false)
     @instance = instance
     @association = association
     @column = column
@@ -8,41 +33,70 @@ class Streak
     @except_today = except_today
   end
 
-  def length
-    @length ||= begin
-      val = 0
-      streak_map.each do |map_bool|
-        break if !map_bool
-        val += 1
+  # Calculate the length of this calendar day streak
+  # 
+  # @param [Boolean] longest if true, calculate the longest day streak in the sequence, 
+  # not just the current one
+  def length(longest: false)
+    if streaks.empty?
+      0
+    elsif longest
+      streaks.sort.first.size
+    else
+      streak = streaks.first
+      if streak.include?(Date.current) || except_today && streak.include?(Date.yesterday)
+        streak.size
+      else
+        0
       end
-
-      val
     end
   end
 
-  private
-    def days
-      @days ||= instance.send(association).order(column => :desc).pluck(column).map(&:to_date).uniq
-    end
+  # Get a list of all calendar day streaks, sorted descending 
+  # (from most recent to farthest away)
+  # Includes 1-day streaks. If you want to filter
+  # the results further, for example if you want 2 only
+  # include 2+ day streaks, you'll have to filter on the result
+  def streaks
+    return [] if days.empty?
 
-    def streak_map
-      @streak_map || begin
-        days.map.with_index do |day, i|
-          if i == 0
-            streak_day(day)
-          else
-            days[i-1] == day.tomorrow
-          end
-        end
-      end
-    end
+    streaks = []
+    streak = []
+    days.each.with_index do |day, i|
+      # first day
+      if i == 0
+        # since this is the first one,
+        # push to our new streak
+        streak << day
 
-    def streak_day(day)
-      if !except_today
-        day == Date.current
+      # consecutive day, the previous day was "tomorrow" 
+      # relative to day (since we're date descending)
+      elsif days[i-1] == day.tomorrow
+        # push to existing streak
+        streak << day
+
+      # streak was broken
       else
-        day == Date.current ||
-        day == Date.yesterday
+        # push our current streak
+        streaks << streak
+
+        # start a new streak
+        # and push day to our new streak
+        streak = []
+        streak << day
+      end
+
+      # the jig is up, push the current streak
+      if i == (days.size-1) 
+        streaks << streak 
       end
     end
+
+    streaks
+  end
+
+  private
+    def days
+      @days ||= instance.send(association).order(column => :desc).pluck(column).map(&:to_date).uniq
+    end
 end

data/spec/streakable_spec.rb

@@ -1,24 +1,24 @@
 require 'spec_helper'
 
 describe Streakable do
+  let(:user) { User.create }
+
+  let!(:posts) do
+    post_dates.each do |date|
+      user.posts.create(created_at: date)
+    end
+  end
+  let(:post_dates) { [] }
+
   describe "#streak" do
     subject { user.streak(:posts) }
 
-    let(:user) { User.create }
-
-    context "when a user has no posts" do
+    context "user has no posts" do
       before { expect(user.posts).to be_empty }
       it { is_expected.to be 0 }
     end
 
-    let!(:posts) do
-      post_dates.each do |date|
-        user.posts.create(created_at: date)
-      end
-    end
-    let(:post_dates) { [] }
-
-    context "when a user posted on each of the last three days" do
+    context "user posted on each of the last three days" do
       let(:post_dates) { [2.days.ago, 1.day.ago, DateTime.current] }
 
       it "returns the streak" do
@@ -26,8 +26,37 @@ describe Streakable do
       end
     end
 
-    context "when a user didn't post today" do
+    context "user only has a post today" do
+      let(:post_dates) { [DateTime.current] }
+      before do
+        expect(user.posts.size).to eql(1)
+        expect(user.posts.first.created_at.to_date).to eql(Date.current)
+      end
+
+      it "returns the streak of 1" do
+        expect(subject).to eq(1)
+      end
+    end
+
+    context "user has streak today, and a longer streak before that" do
+      let(:post_dates) { [5.days.ago, 4.days.ago, 3.days.ago, 1.day.ago, DateTime.current] }
+
+      it "still returns the current streak" do
+        expect(subject).to eq(2)
+      end
+
+      context "with longest option" do
+        subject { user.streak(:posts, longest: true) }
+
+        it "returns the longer streak" do
+          expect(subject).to eq(3)
+        end
+      end
+    end
+
+    context "user didn't post today, but has a streak before that" do
       let(:post_dates) { [3.days.ago, 2.day.ago, 1.day.ago] }
+      before { expect(post_dates.map(&:to_date)).to_not include(Date.current) }
 
       it "returns streak of zero" do
         expect(subject).to eq(0)
@@ -40,6 +69,14 @@ describe Streakable do
           expect(subject).to eq(post_dates.size)
         end
       end
+
+      context "but has three streaks, longest in the middle" do
+        let(:post_dates) { [3.days.ago, 4.days.ago, 6.days.ago, 7.days.ago, 8.days.ago, 10.days.ago, 11.days.ago] }
+
+        it "returns 0" do
+          expect(subject).to eq(0)
+        end
+      end
     end
 
     context "spanning two months" do
@@ -55,4 +92,89 @@ describe Streakable do
       end
     end
   end
+
+  describe "#streaks" do
+    subject { user.streaks(:posts) }
+
+    context "user has no posts" do
+      before { expect(user.posts).to be_empty }
+      it { is_expected.to eql([]) }
+    end
+
+    context "user posted on each of the last two days" do
+      let(:post_dates) { [1.day.ago, DateTime.current] }
+
+      it "returns the streak" do
+        expect(subject).to eq([[Date.current, 1.day.ago.to_date]])
+      end
+    end
+
+    context "user posted on each of the last three days" do
+      let(:post_dates) { [2.days.ago, 1.day.ago, DateTime.current] }
+
+      it "returns the streak" do
+        expect(subject).to eq([[Date.current, 1.day.ago.to_date, 2.days.ago.to_date]])
+      end
+    end
+
+    context "user only has a post today" do
+      let(:post_dates) { [DateTime.current] }
+      before do
+        expect(user.posts.size).to eql(1)
+        expect(user.posts.first.created_at.to_date).to eql(Date.current)
+      end
+
+      it "returns the streak of 1" do
+        expect(subject).to eq([[Date.current]])
+      end
+    end
+
+    context "user only has a post yesterday" do
+      let(:post_dates) { [DateTime.current.yesterday] }
+      before do
+        expect(user.posts.size).to eql(1)
+        expect(user.posts.first.created_at.to_date).to eql(Date.current.yesterday)
+      end
+
+      it "returns the streak of 1" do
+        expect(subject).to eq([[Date.current.yesterday]])
+      end
+    end
+
+    context "user has streak today, and a longer streak before that" do
+      let(:post_dates) { [DateTime.current, 1.day.ago, 3.days.ago, 4.days.ago, 5.days.ago] }
+
+      it "returns the streaks" do
+        expected = [[Date.current, 1.day.ago], [3.days.ago, 4.days.ago, 5.days.ago]].map do |x|
+          x.map(&:to_date)
+        end
+
+        expect(subject).to eq(expected)
+      end
+    end
+
+    context "user didn't post today, but has a streak of 3 before that" do
+      let(:post_dates) { [1.days.ago, 2.days.ago, 3.day.ago] }
+
+      it "returns the streak" do
+        expected = [[1.day.ago, 2.days.ago, 3.days.ago]].map do |x|
+          x.map(&:to_date)
+        end
+
+        expect(subject).to eq(expected)
+      end
+    end
+
+    context "user has three streaks, longest in the middle" do
+      let(:post_dates) { [3.days.ago, 4.days.ago, 6.days.ago, 7.days.ago, 8.days.ago, 10.days.ago, 11.days.ago] }
+
+      it "returns the streaks" do
+        expected = [[3.days.ago, 4.days.ago], [6.days.ago, 7.days.ago, 8.days.ago], [10.days.ago, 11.days.ago]].map do |x|
+          x.map(&:to_date)
+        end
+
+        expect(subject).to eq(expected)
+      end
+    end
+  end
 end

data/streakable.gemspec

@@ -2,13 +2,15 @@
 
 Gem::Specification.new do |spec|
   spec.name          = 'streakable'
-  spec.version       = '0.1.0'
+  spec.version       = '0.1.1'
   spec.authors       = ['szTheory', 'Garrett Martin']
-  spec.email         = ['szTheory@github.com']
   spec.description   = %q{Track consecutive day streaks on ActiveRecord models.}
-  spec.summary       = %q{Easily track consecutive day streaks on your Rails/ActiveRecord models.}
-  spec.homepage      = 'https://github.com/szTheory/streakable'
+  spec.summary       = %q{Easily track consecutive day streaks on your Rails/ActiveRecord model associations for a given date column.}
+  spec.homepage      = 'https://sztheory.github.io/streakable/'
   spec.license       = 'MIT'
+  spec.metadata = {
+    "source_code_uri"   => "https://github.com/szTheory/streakable",
+  }
 
   spec.files         = `git ls-files`.split($/)
   spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: streakable
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - szTheory
@@ -166,8 +166,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: 0.9.1
 description: Track consecutive day streaks on ActiveRecord models.
-email:
-- szTheory@github.com
+email: 
 executables: []
 extensions: []
 extra_rdoc_files: []
@@ -178,6 +177,7 @@ files:
 - LICENSE.txt
 - README.md
 - Rakefile
+- _config.yml
 - lib/streakable.rb
 - lib/streakable/streak.rb
 - spec/spec_helper.rb
@@ -186,10 +186,11 @@ files:
 - spec/support/post.rb
 - spec/support/user.rb
 - streakable.gemspec
-homepage: https://github.com/szTheory/streakable
+homepage: https://sztheory.github.io/streakable/
 licenses:
 - MIT
-metadata: {}
+metadata:
+  source_code_uri: https://github.com/szTheory/streakable
 post_install_message: 
 rdoc_options: []
 require_paths:
@@ -209,7 +210,8 @@ rubyforge_project:
 rubygems_version: 2.6.11
 signing_key: 
 specification_version: 4
-summary: Easily track consecutive day streaks on your Rails/ActiveRecord models.
+summary: Easily track consecutive day streaks on your Rails/ActiveRecord model associations
+  for a given date column.
 test_files:
 - spec/spec_helper.rb
 - spec/streakable_spec.rb