streakable 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 2117453eb59848b55a11e27607df503b4a3e8c32
+  data.tar.gz: b88852d4a47c1f5b20290d0706e2f5284e108bf8
+SHA512:
+  metadata.gz: 92cc3cdf95b76c1df41c4d49f469ec0703cda4d96cd62c373c390de98fc96d939666b13a11edce31fd5d7bf2ab078c044fa3bca8388bbf1f0c5a22471ca47e0b
+  data.tar.gz: 438bcda9fd55f5470cb9d973547fcfabdbc11a6f48d88fae8ad392f464bd8b0a1ac1f047357aaadcbf15fcc0b42013652de96624b12d3ab8c08dbbdd40d11ee1

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/.travis.yml

@@ -0,0 +1,13 @@
+language: ruby
+cache: bundler
+matrix:
+  fast_finish: true
+branches:
+  only: master
+rvm:
+  - 2.0.0
+  - 2.1.0
+  - 2.2.0
+  - 2.3.0
+  - 2.4.0
+script: bundle exec rspec

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in streakable.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,46 @@
+Copyright (c) 2018 szTheory
+
+MIT License
+
+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.
+
+
+Copyright (c) 2014 Garrett Martin
+
+MIT License
+
+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,71 @@
+[![Build Status](https://travis-ci.org/szTheory/streakable.svg?branch=master)](https://travis-ci.org/szTheory/streakable)
+
+# 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.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'streakable'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install streakable
+
+## Usage
+
+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>streakable</code> to the model:
+
+```ruby
+class User < ActiveRecord::Base
+  # ...
+
+  include Streakable
+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 (as determined by the created_at column, by default)
+```
+
+The <code>streak</code> instance method can be called with any association:
+
+```ruby
+user.streak(:other_association)
+```
+
+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
+
+```ruby
+user.streak(:posts, except_today: true)
+```
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b 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

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/lib/streakable.rb

@@ -0,0 +1,16 @@
+require "streakable/streak"
+require "active_record"
+
+module Streakable
+  def self.included(klass)
+    klass.class_eval do
+      include InstanceMethods
+    end
+  end
+
+  module InstanceMethods
+    def streak(association, column=:created_at, except_today: false)
+      Streak.new(self, association, column, except_today).length
+    end
+  end
+end

data/lib/streakable/streak.rb

@@ -0,0 +1,48 @@
+class Streak
+  attr_reader :instance, :association, :column, :except_today
+  def initialize(instance, association, column, except_today)
+    @instance = instance
+    @association = association
+    @column = column
+    # Don't penalize the current day being absent when determining streaks
+    @except_today = except_today
+  end
+
+  def length
+    @length ||= begin
+      val = 0
+      streak_map.each do |map_bool|
+        break if !map_bool
+        val += 1
+      end
+
+      val
+    end
+  end
+
+  private
+    def days
+      @days ||= instance.send(association).order(column => :desc).pluck(column).map(&:to_date).uniq
+    end
+
+    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
+
+    def streak_day(day)
+      if !except_today
+        day == Date.current
+      else
+        day == Date.current ||
+        day == Date.yesterday
+      end
+    end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,22 @@
+require "streakable"
+require "database_cleaner"
+require "support/database_cleaner"
+require "support/user"
+require "support/post"
+require "timecop"
+
+ActiveRecord::Base.establish_connection(adapter: "sqlite3", database: ":memory:")
+
+ActiveRecord::Schema.define do
+  self.verbose = true
+
+  create_table :users, force: true do |t|
+    t.string :name
+  end
+
+  create_table :posts, force: true do |t|
+    t.string :content
+    t.integer :user_id
+    t.timestamps
+  end
+end

data/spec/streakable_spec.rb

@@ -0,0 +1,58 @@
+require 'spec_helper'
+
+describe Streakable do
+  describe "#streak" do
+    subject { user.streak(:posts) }
+
+    let(:user) { User.create }
+
+    context "when a 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
+      let(:post_dates) { [2.days.ago, 1.day.ago, DateTime.current] }
+
+      it "returns the streak" do
+        expect(subject).to eq(posts.size)
+      end
+    end
+
+    context "when a user didn't post today" do
+      let(:post_dates) { [3.days.ago, 2.day.ago, 1.day.ago] }
+
+      it "returns streak of zero" do
+        expect(subject).to eq(0)
+      end
+
+      context "except today" do
+        subject { user.streak(:posts, except_today: true) }
+
+        it "returns the streak" do
+          expect(subject).to eq(post_dates.size)
+        end
+      end
+    end
+
+    context "spanning two months" do
+      around do |example|
+        Timecop.freeze(DateTime.current.beginning_of_month) do
+          example.run
+        end
+      end
+      let(:post_dates) { [1.day.ago, DateTime.current] }
+
+      it "returns a streak of 2" do
+        expect(subject).to eq(2)
+      end
+    end
+  end
+end

data/spec/support/database_cleaner.rb

@@ -0,0 +1,17 @@
+RSpec.configure do |config|
+  config.before(:suite) do
+    DatabaseCleaner.clean_with(:truncation)
+  end
+
+  config.before(:each) do
+    DatabaseCleaner.strategy = :transaction
+  end
+
+  config.before(:each) do
+    DatabaseCleaner.start
+  end
+
+  config.after(:each) do
+    DatabaseCleaner.clean
+  end
+end

data/spec/support/post.rb

@@ -0,0 +1,3 @@
+class Post < ActiveRecord::Base
+  belongs_to :user
+end

data/spec/support/user.rb

@@ -0,0 +1,5 @@
+class User < ActiveRecord::Base
+  has_many :posts
+
+  include Streakable
+end

data/streakable.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+
+Gem::Specification.new do |spec|
+  spec.name          = 'streakable'
+  spec.version       = '0.1.0'
+  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.license       = 'MIT'
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ['lib']
+
+  spec.add_runtime_dependency 'activerecord', '>= 3.0'
+
+  spec.add_development_dependency 'sqlite3', '~> 1.3', '>= 1.3.13'
+  spec.add_development_dependency 'rspec', '~> 3.8', '>= 3.8.0'
+  spec.add_development_dependency 'database_cleaner', '~> 1.7.0', '>= 1.7.0'
+  spec.add_development_dependency 'bundler', '~> 1.3', '>= 1.3'
+  spec.add_development_dependency 'rake', '~> 12.3', '>= 12.3.1'
+  spec.add_development_dependency 'pry', '~> 0.11', '>= 0.11.3'
+  spec.add_development_dependency 'timecop', '~> 0.9', '>= 0.9.1'
+end

metadata

@@ -0,0 +1,218 @@
+--- !ruby/object:Gem::Specification
+name: streakable
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- szTheory
+- Garrett Martin
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2018-11-04 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.3.13
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.3.13
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.8'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.8.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.8'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.8.0
+- !ruby/object:Gem::Dependency
+  name: database_cleaner
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.7.0
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.7.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.7.0
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.7.0
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.3'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 12.3.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.3'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 12.3.1
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.11'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.11.3
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.11'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.11.3
+- !ruby/object:Gem::Dependency
+  name: timecop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.9.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.9.1
+description: Track consecutive day streaks on ActiveRecord models.
+email:
+- szTheory@github.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/streakable.rb
+- lib/streakable/streak.rb
+- spec/spec_helper.rb
+- spec/streakable_spec.rb
+- spec/support/database_cleaner.rb
+- spec/support/post.rb
+- spec/support/user.rb
+- streakable.gemspec
+homepage: https://github.com/szTheory/streakable
+licenses:
+- MIT
+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.6.11
+signing_key: 
+specification_version: 4
+summary: Easily track consecutive day streaks on your Rails/ActiveRecord models.
+test_files:
+- spec/spec_helper.rb
+- spec/streakable_spec.rb
+- spec/support/database_cleaner.rb
+- spec/support/post.rb
+- spec/support/user.rb