groupdate 2.0.4 → 2.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 30c3377f6edb6fe33f5d0ac0aab691a6a7a6c198
-  data.tar.gz: d725a9a605553a390055a4bbf55a132233aade70
+  metadata.gz: 08308d10dc780963998b4ebcb906f802dd15f6a7
+  data.tar.gz: 4e2a7f3a352b94f22287e2e84e4e8830625914ca
 SHA512:
-  metadata.gz: d121c447a7c6c4c6b9be3e28942c640ea4f7bb5da420314eb863d7ff9a1a648c77129afe726ae3311a61cef6a32d386fbf76e97948adc0313f0a87935f4fe181
-  data.tar.gz: 13e3ba1f7530160f450cb48aa1e5e67f65af979602e2c3ff0d392cc436079db1c12cd457c122e30d63e1c5cac75001af3dafb4b3839520402d1b115015200613
+  metadata.gz: d302a57517c823e80b7192a42153bc4a594af23bd1647f6cd7f3eab77a57252882204e22d40e4a6a3a80253be4adce6577cb9fa723d52342f7f8d8cf4a725d77
+  data.tar.gz: 0fdeb289ba29919be219e0dc1cdaf040552ffdc2ffa1ed5c180178ba8c8f4bb8aa00d8ffb0862eb5030af8996144098b2d03380c96d0a5f97ce248362b148578

data/CHANGELOG.md

@@ -1,3 +1,8 @@
+# 2.1.0
+
+- added last option
+- added format option
+
 # 2.0.4
 
 - added multiple groups

data/README.md

@@ -107,6 +107,12 @@ To get a specific time range, use:
 User.group_by_day(:created_at, range: 2.weeks.ago.midnight..Time.now).count
 ```
 
+To get the most recent time periods, use:
+
+```ruby
+User.group_by_week(:created_at, last: 8).count # last 8 weeks
+```
+
 ### Order
 
 You can order in descending order with:
@@ -121,6 +127,16 @@ or
 User.group_by_day(:created_at).order("day desc").count
 ```
 
+### Pretty Keys
+
+To get keys in a different format, use:
+
+```ruby
+User.group_by_hour_of_day(:created_at, format: "%l %P").count.keys.first # 12 am
+```
+
+Takes a `String`, which is passed to [strftime](http://strfti.me/), or a `Proc`
+
 ## Installation
 
 Add this line to your application’s Gemfile:

data/lib/groupdate/scopes.rb

@@ -76,7 +76,7 @@ module Groupdate
         group = group(Groupdate::OrderHack.new(sanitize_sql_array(query), field, time_zone))
         range = args[2] || options[:range] || true
         unless options[:series] == false
-          Series.new(group, field, column, time_zone_object, range, week_start, day_start, group.group_values.size - 1)
+          Series.new(group, field, column, time_zone_object, range, week_start, day_start, group.group_values.size - 1, options)
         else
           group
         end

data/lib/groupdate/series.rb

@@ -1,7 +1,8 @@
 module Groupdate
   class Series
+    attr_accessor :relation
 
-    def initialize(relation, field, column, time_zone, time_range, week_start, day_start, group_index)
+    def initialize(relation, field, column, time_zone, time_range, week_start, day_start, group_index, options)
       @relation = relation
       @field = field
       @column = column
@@ -10,20 +11,42 @@ module Groupdate
       @week_start = week_start
       @day_start = day_start
       @group_index = group_index
+      @options = options
     end
 
-    def build_series(count)
+    def perform(method, *args, &block)
       utc = ActiveSupport::TimeZone["UTC"]
 
-      reverse = @reverse
-      order = @relation.order_values.first
+      time_range = @time_range
+      if !time_range.is_a?(Range) and @options[:last]
+        step = 1.send(@field) if 1.respond_to?(@field)
+        if step
+          now = Time.now
+          time_range = round_time(now - (@options[:last].to_i - 1).send(@field))..now
+        end
+      end
+
+      relation =
+        if time_range.is_a?(Range)
+          # doesn't matter whether we include the end of a ... range - it will be excluded later
+          @relation.where("#{@column} >= ? AND #{@column} <= ?", time_range.first, time_range.last)
+        else
+          @relation.where("#{@column} IS NOT NULL")
+        end
+
+      # undo reverse since we do not want this to appear in the query
+      reverse = relation.reverse_order_value
+      if reverse
+        relation = relation.reverse_order
+      end
+      order = relation.order_values.first
       if order.is_a?(String)
         parts = order.split(" ")
         reverse_order = (parts.size == 2 && parts[0] == @field && parts[1].to_s.downcase == "desc")
         reverse = !reverse if reverse_order
       end
 
-      multiple_groups = @relation.group_values.size > 1
+      multiple_groups = relation.group_values.size > 1
 
       cast_method =
         case @field
@@ -33,7 +56,7 @@ module Groupdate
           lambda{|k| (k.is_a?(String) ? utc.parse(k) : k.to_time).in_time_zone(@time_zone) }
         end
 
-      count = Hash[ count.map{|k, v| [multiple_groups ? k[0...@group_index] + [cast_method.call(k[@group_index])] + k[(@group_index + 1)..-1] : cast_method.call(k), v] } ]
+      count = Hash[ relation.send(method, *args, &block).map{|k, v| [multiple_groups ? k[0...@group_index] + [cast_method.call(k[@group_index])] + k[(@group_index + 1)..-1] : cast_method.call(k), v] } ]
 
       series =
         case @field
@@ -43,8 +66,8 @@ module Groupdate
           0..23
         else
           time_range =
-            if @time_range.is_a?(Range)
-              @time_range
+            if time_range.is_a?(Range)
+              time_range
             else
               # use first and last values
               sorted_keys =
@@ -57,30 +80,7 @@ module Groupdate
             end
 
           if time_range.first
-            # determine start time
-            time = time_range.first.to_time.in_time_zone(@time_zone) - @day_start.hours
-            starts_at =
-              case @field
-              when "second"
-                time.change(:usec => 0)
-              when "minute"
-                time.change(:sec => 0)
-              when "hour"
-                time.change(:min => 0)
-              when "day"
-                time.beginning_of_day
-              when "week"
-                # same logic as MySQL group
-                weekday = (time.wday - 1) % 7
-                (time - ((7 - @week_start + weekday) % 7).days).midnight
-              when "month"
-                time.beginning_of_month
-              else # year
-                time.beginning_of_year
-              end
-
-            starts_at += @day_start.hours
-            series = [starts_at]
+            series = [round_time(time_range.first)]
 
             step = 1.send(@field)
 
@@ -107,31 +107,70 @@ module Groupdate
         series = series.to_a.reverse
       end
 
+      key_format =
+        if @options[:format]
+          if @options[:format].respond_to?(:call)
+            @options[:format]
+          else
+            sunday = @time_zone.parse("2014-03-02 00:00:00")
+            lambda do |key|
+              case @field
+              when "hour_of_day"
+                key = sunday + key.hours + @day_start.hours
+              when "day_of_week"
+                key = sunday + key.days
+              end
+              key.strftime(@options[:format].to_s)
+            end
+          end
+        else
+          lambda{|k| k }
+        end
+
       Hash[series.map do |k|
-        [k, count[k] || 0]
+        [key_format.call(k), count[k] || 0]
       end]
     end
 
-    def method_missing(method, *args, &block)
-      # https://github.com/rails/rails/blob/master/activerecord/lib/active_record/relation/calculations.rb
-      if ActiveRecord::Calculations.method_defined?(method)
-        relation =
-          if @time_range.is_a?(Range)
-            # doesn't matter whether we include the end of a ... range - it will be excluded later
-            @relation.where("#{@column} >= ? AND #{@column} <= ?", @time_range.first, @time_range.last)
-          else
-            @relation.where("#{@column} IS NOT NULL")
-          end
+    def round_time(time)
+      time = time.to_time.in_time_zone(@time_zone) - @day_start.hours
 
-        # undo reverse since we do not want this to appear in the query
-        if relation.reverse_order_value
-          @reverse = true
-          relation = relation.reverse_order
+      time =
+        case @field
+        when "second"
+          time.change(:usec => 0)
+        when "minute"
+          time.change(:sec => 0)
+        when "hour"
+          time.change(:min => 0)
+        when "day"
+          time.beginning_of_day
+        when "week"
+          # same logic as MySQL group
+          weekday = (time.wday - 1) % 7
+          (time - ((7 - @week_start + weekday) % 7).days).midnight
+        when "month"
+          time.beginning_of_month
+        else # year
+          time.beginning_of_year
         end
 
-        build_series(relation.send(method, *args, &block))
+      time + @day_start.hours
+    end
+
+    def clone
+      Groupdate::Series.new(@relation, @field, @column, @time_zone, @time_range, @week_start, @day_start, @group_index, @options)
+    end
+
+    # clone to prevent modifying original variables
+    def method_missing(method, *args, &block)
+      # https://github.com/rails/rails/blob/master/activerecord/lib/active_record/relation/calculations.rb
+      if ActiveRecord::Calculations.method_defined?(method)
+        clone.perform(method, *args, &block)
       elsif @relation.respond_to?(method)
-        Groupdate::Series.new(@relation.send(method, *args, &block), @field, @column, @time_zone, @time_range, @week_start, @day_start, @group_index)
+        series = clone
+        series.relation = @relation.send(method, *args, &block)
+        series
       else
         super
       end

data/lib/groupdate/version.rb

@@ -1,3 +1,3 @@
 module Groupdate
-  VERSION = "2.0.4"
+  VERSION = "2.1.0"
 end

data/test/test_helper.rb

@@ -549,8 +549,58 @@ module TestGroupdate
     assert !User.group_by_day(:created_at).respond_to?(:no_such_method)
   end
 
+  def test_last
+    create_user "2011-05-01 00:00:00 UTC"
+    create_user "2013-05-01 00:00:00 UTC"
+    expected = {
+      utc.parse("2012-01-01 00:00:00 UTC") => 0,
+      utc.parse("2013-01-01 00:00:00 UTC") => 1,
+      utc.parse("2014-01-01 00:00:00 UTC") => 0
+    }
+    assert_equal expected, User.group_by_year(:created_at, last: 3).count
+  end
+
+  def test_format_day
+    create_user "2014-03-01 00:00:00 UTC"
+    assert_format :day, "March 1, 2014", "%B %-e, %Y"
+  end
+
+  def test_format_month
+    create_user "2014-03-01 00:00:00 UTC"
+    assert_format :month, "March 2014", "%B %Y"
+  end
+
+  def test_format_year
+    create_user "2014-03-01 00:00:00 UTC"
+    assert_format :year, "2014", "%Y"
+  end
+
+  def test_format_hour_of_day
+    create_user "2014-03-01 00:00:00 UTC"
+    assert_format :hour_of_day, "12 am", "%-l %P"
+  end
+
+  def test_format_hour_of_day_day_start
+    create_user "2014-03-01 00:00:00 UTC"
+    assert_format :hour_of_day, "2 am", "%-l %P", day_start: 2
+  end
+
+  def test_format_day_of_week
+    create_user "2014-03-01 00:00:00 UTC"
+    assert_format :day_of_week, "Sun", "%a"
+  end
+
+  def test_format_day_of_week_week_start
+    create_user "2014-03-01 00:00:00 UTC"
+    assert_format :day_of_week, "Sun", "%a", week_start: :sat
+  end
+
   # helpers
 
+  def assert_format(method, expected, format, options = {})
+    assert_equal expected, User.send(:"group_by_#{method}", :created_at, options.merge(format: format)).count.keys.first
+  end
+
   def assert_result_time(method, expected, time_str, time_zone = false, options = {})
     expected = {utc.parse(expected).in_time_zone(time_zone ? "Pacific Time (US & Canada)" : utc) => 1}
     assert_equal expected, result(method, time_str, time_zone, options)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: groupdate
 version: !ruby/object:Gem::Version
-  version: 2.0.4
+  version: 2.1.0
 platform: ruby
 authors:
 - Andrew Kane
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-03-13 00:00:00.000000000 Z
+date: 2014-03-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord