groupdate 3.1.1 → 3.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a75601315268495e473958ab19c6a39197efb3b9
-  data.tar.gz: 1b0e1d8b246e49e5e4d3abb76c40bc617f97e7bf
+  metadata.gz: df818b929dceeddfccab948ceb591ad26c7334c8
+  data.tar.gz: 370a704d7ff6a17fb82bb057d717141ed87bc69f
 SHA512:
-  metadata.gz: 4c0edf976534abc2ccb263b39e48b3664991122ed50b541d4535f139243e5d657a2a525054a2906a1d037a4a65f7dbe1ea9d5f932d70f1d1fd507433cb00d499
-  data.tar.gz: 073ec218da11f747a93af186e5c82ed7e4035f0904816013b34f89130608befe984af491acbc3fcfd8da55ffd6d92d6545eeffb2a3ed15f946e821f3eb45dcf3
+  metadata.gz: 7a77d1af0c530bfab9552ddff8f7149575c9821bcff772d33454b50c0050561d861a7eb5f220c5aa19200f80194f07c6a550c412be2ac76eedd88dbddb143faf
+  data.tar.gz: 91d207a5493bcafe51e94a884809e37b8250e9c2e581bf26172a5d0810d32c64aa63f21aead7935d1096c4d27dcde4c8d49cc8de821cdae4c83634e6a168cf94

data/CHANGELOG.md

@@ -1,3 +1,7 @@
+## 3.2.0
+
+- Added limited support for SQLite
+
 ## 3.1.1
 
 - Fixed `current: false`

data/README.md

@@ -13,6 +13,8 @@ The simplest way to group by:
 
 Supports PostgreSQL, MySQL, and Redshift, plus arrays and hashes
 
+Limited support for [SQLite](#for-sqlite)
+
 [![Build Status](https://travis-ci.org/ankane/groupdate.svg?branch=master)](https://travis-ci.org/ankane/groupdate)
 
 :cupid: Goes hand in hand with [Chartkick](http://ankane.github.io/chartkick/)
@@ -126,13 +128,7 @@ User.group_by_week(:created_at, last: 8, current: false).count
 You can order in descending order with:
 
 ```ruby
-User.group_by_day(:created_at).reverse_order.count
-```
-
-or
-
-```ruby
-User.group_by_day(:created_at).order("day desc").count
+User.group_by_day(:created_at, reverse: true).count
 ```
 
 ### Keys
@@ -234,6 +230,28 @@ mysql_tzinfo_to_sql /usr/share/zoneinfo | mysql -u root mysql
 
 or copy and paste [these statements](https://gist.githubusercontent.com/ankane/1d6b0022173186accbf0/raw/time_zone_support.sql) into a SQL console.
 
+You can confirm it worked with:
+
+```sql
+SELECT CONVERT_TZ(NOW(), '+00:00', 'Etc/UTC');
+```
+
+It should return the time instead of `NULL`.
+
+#### For SQLite
+
+Groupdate has limited support for SQLite.
+
+- No time zone support
+- No `day_start` or `week_start` options
+- No `group_by_quarter` method
+
+If your application’s time zone is set to something other than `Etc/UTC` (the default), create an initializer with:
+
+```ruby
+Groupdate.time_zone = false
+```
+
 ## Upgrading
 
 ### 3.0

data/Rakefile

@@ -5,6 +5,7 @@ task default: :test
 Rake::TestTask.new do |t|
   t.libs << "test"
   t.test_files = FileList["test/**/*_test.rb"].exclude(/redshift/)
+  t.warning = false
 end
 
 namespace :test do

data/groupdate.gemspec

@@ -7,7 +7,7 @@ Gem::Specification.new do |spec|
   spec.name          = "groupdate"
   spec.version       = Groupdate::VERSION
   spec.authors       = ["Andrew Kane"]
-  spec.email         = ["acekane1@gmail.com"]
+  spec.email         = ["andrew@chartkick.com"]
   spec.description   = "The simplest way to group temporal data"
   spec.summary       = "The simplest way to group temporal data"
   spec.homepage      = "https://github.com/ankane/groupdate"
@@ -28,8 +28,10 @@ Gem::Specification.new do |spec|
   if RUBY_PLATFORM == "java"
     spec.add_development_dependency "activerecord-jdbcpostgresql-adapter"
     spec.add_development_dependency "activerecord-jdbcmysql-adapter"
+    spec.add_development_dependency "activerecord-jdbcsqlite3-adapter"
   else
     spec.add_development_dependency "pg"
     spec.add_development_dependency "mysql2", "~> 0.3.20"
+    spec.add_development_dependency "sqlite3"
   end
 end

data/lib/groupdate.rb

@@ -4,6 +4,8 @@ require "groupdate/version"
 require "groupdate/magic"
 
 module Groupdate
+  class Error < RuntimeError; end
+
   PERIODS = [:second, :minute, :hour, :day, :week, :month, :quarter, :year, :day_of_week, :hour_of_day, :day_of_month, :month_of_year]
   # backwards compatibility for anyone who happened to use it
   FIELDS = PERIODS

data/lib/groupdate/magic.rb

@@ -8,9 +8,9 @@ module Groupdate
       @field = field
       @options = options
 
-      raise "Unrecognized time zone" unless time_zone
+      raise Groupdate::Error, "Unrecognized time zone" unless time_zone
 
-      raise "Unrecognized :week_start option" if field == :week && !week_start
+      raise Groupdate::Error, "Unrecognized :week_start option" if field == :week && !week_start
     end
 
     def group_by(enum, &_block)
@@ -20,7 +20,7 @@ module Groupdate
 
     def relation(column, relation)
       if relation.default_timezone == :local
-        raise "ActiveRecord::Base.default_timezone must be :utc to use Groupdate"
+        raise Groupdate::Error, "ActiveRecord::Base.default_timezone must be :utc to use Groupdate"
       end
 
       time_zone = self.time_zone.tzinfo.name
@@ -77,6 +77,42 @@ module Groupdate
           else
             ["(DATE_TRUNC('#{field}', (#{column}::timestamptz - INTERVAL '#{day_start} second') AT TIME ZONE ?) + INTERVAL '#{day_start} second') AT TIME ZONE ?", time_zone, time_zone]
           end
+        when "SQLite"
+          raise Groupdate::Error, "Time zones not supported for SQLite" unless self.time_zone.utc_offset.zero?
+          raise Groupdate::Error, "day_start not supported for SQLite" unless day_start.zero?
+          raise Groupdate::Error, "week_start not supported for SQLite" unless week_start == 6
+
+          if field == :week
+            ["strftime('%%Y-%%m-%%d 00:00:00 UTC', #{column}, '-6 days', 'weekday 0')"]
+          else
+            format =
+              case field
+                when :hour_of_day
+                  "%H"
+                when :day_of_week
+                  "%w"
+                when :day_of_month
+                  "%d"
+                when :month_of_year
+                  "%m"
+                when :second
+                  "%Y-%m-%d %H:%M:%S UTC"
+                when :minute
+                  "%Y-%m-%d %H:%M:00 UTC"
+                when :hour
+                  "%Y-%m-%d %H:00:00 UTC"
+                when :day
+                  "%Y-%m-%d 00:00:00 UTC"
+                when :month
+                  "%Y-%m-01 00:00:00 UTC"
+                when :quarter
+                  raise Groupdate::Error, "Quarter not supported for SQLite"
+                else # year
+                  "%Y-01-01 00:00:00 UTC"
+                end
+
+            ["strftime('#{format.gsub(/%/, '%%')}', #{column})"]
+          end
         when "Redshift"
           case field
           when :day_of_week # Sunday = 0, Monday = 1, etc.
@@ -97,7 +133,7 @@ module Groupdate
             ["CONVERT_TIMEZONE(?, 'Etc/UTC', DATE_TRUNC(?, CONVERT_TIMEZONE(?, #{column}) - INTERVAL '#{day_start} second'))::timestamp + INTERVAL '#{day_start} second'", time_zone, field, time_zone]
           end
         else
-          raise "Connection adapter not supported: #{adapter_name}"
+          raise Groupdate::Error, "Connection adapter not supported: #{adapter_name}"
         end
 
       if adapter_name == "MySQL" && field == :week
@@ -144,14 +180,14 @@ module Groupdate
           lambda { |k| (k.is_a?(String) || !k.respond_to?(:to_time) ? utc.parse(k.to_s) : k.to_time).in_time_zone(time_zone) }
         end
 
-      count =
-        begin
-          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] }]
-        rescue NoMethodError
-          raise "Be sure to install time zone support - https://github.com/ankane/groupdate#for-mysql"
-        end
+      result = relation.send(method, *args, &block)
+      missing_time_zone_support = multiple_groups ? (result.keys.first && result.keys.first[@group_index].nil?) : result.key?(nil)
+      if missing_time_zone_support
+        raise Groupdate::Error, "Be sure to install time zone support - https://github.com/ankane/groupdate#for-mysql"
+      end
+      result = Hash[result.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(count, (options.key?(:default_value) ? options[:default_value] : 0), multiple_groups, reverse)
+      series(result, (options.key?(:default_value) ? options[:default_value] : 0), multiple_groups, reverse)
     end
 
     protected
@@ -159,7 +195,7 @@ module Groupdate
     def time_zone
       @time_zone ||= begin
         time_zone = "Etc/UTC" if options[:time_zone] == false
-        time_zone ||= options[:time_zone] || Groupdate.time_zone || Time.zone || "Etc/UTC"
+        time_zone ||= options[:time_zone] || Groupdate.time_zone || (Groupdate.time_zone == false && "Etc/UTC") || Time.zone || "Etc/UTC"
         time_zone.is_a?(ActiveSupport::TimeZone) ? time_zone : ActiveSupport::TimeZone[time_zone]
       end
     end
@@ -349,7 +385,7 @@ module Groupdate
         when :month_of_year
           time.month
         else
-          raise "Invalid field"
+          raise Groupdate::Error, "Invalid field"
         end
 
       time.is_a?(Time) ? time + day_start.seconds : time

data/lib/groupdate/version.rb

@@ -1,3 +1,3 @@
 module Groupdate
-  VERSION = "3.1.1"
+  VERSION = "3.2.0"
 end

data/test/enumerable_test.rb

@@ -1,7 +1,7 @@
 require_relative "test_helper"
 require "ostruct"
 
-class TestEnumerable < Minitest::Test
+class EnumerableTest < Minitest::Test
   include TestGroupdate
 
   def test_enumerable

data/test/gemfiles/activerecord31.gemfile

@@ -1,6 +1,6 @@
 source 'https://rubygems.org'
 
-# Specify your gem's dependencies in searchkick.gemspec
+# Specify your gem's dependencies in groupdate.gemspec
 gemspec path: "../../"
 
 gem "activerecord", "~> 3.1.0"

data/test/gemfiles/activerecord32.gemfile

@@ -1,6 +1,6 @@
 source 'https://rubygems.org'
 
-# Specify your gem's dependencies in searchkick.gemspec
+# Specify your gem's dependencies in groupdate.gemspec
 gemspec path: "../../"
 
 gem "activerecord", "~> 3.2.0"

data/test/gemfiles/activerecord40.gemfile

@@ -1,6 +1,6 @@
 source 'https://rubygems.org'
 
-# Specify your gem's dependencies in searchkick.gemspec
+# Specify your gem's dependencies in groupdate.gemspec
 gemspec path: "../../"
 
 gem "activerecord", "~> 4.0.0"

data/test/gemfiles/activerecord41.gemfile

@@ -1,6 +1,6 @@
 source 'https://rubygems.org'
 
-# Specify your gem's dependencies in searchkick.gemspec
+# Specify your gem's dependencies in groupdate.gemspec
 gemspec path: "../../"
 
 gem "activerecord", "~> 4.1.0"

data/test/gemfiles/activerecord42.gemfile

@@ -1,6 +1,6 @@
 source 'https://rubygems.org'
 
-# Specify your gem's dependencies in searchkick.gemspec
+# Specify your gem's dependencies in groupdate.gemspec
 gemspec path: "../../"
 
 gem "activerecord", "~> 4.2.0"

data/test/gemfiles/redshift.gemfile

@@ -1,6 +1,6 @@
 source 'https://rubygems.org'
 
-# Specify your gem's dependencies in searchkick.gemspec
+# Specify your gem's dependencies in groupdate.gemspec
 gemspec path: "../../"
 
 gem "activerecord", "~> 4.2.0"

data/test/mysql_test.rb

@@ -1,6 +1,6 @@
 require_relative "test_helper"
 
-class TestMysql < Minitest::Test
+class MysqlTest < Minitest::Test
   include TestGroupdate
   include TestDatabase
 

data/test/postgresql_test.rb

@@ -1,6 +1,6 @@
 require_relative "test_helper"
 
-class TestPostgresql < Minitest::Test
+class PostgresqlTest < Minitest::Test
   include TestGroupdate
   include TestDatabase
 

data/test/redshift_test.rb

@@ -1,6 +1,6 @@
 require_relative "test_helper"
 
-class TestRedshift < Minitest::Test
+class RedshiftTest < Minitest::Test
   include TestGroupdate
   include TestDatabase
 

data/test/sqlite_test.rb

@@ -0,0 +1,29 @@
+require_relative "test_helper"
+
+class TestSqlite < Minitest::Test
+  include TestGroupdate
+  include TestDatabase
+
+  def setup
+    super
+    @@setup ||= begin
+      ActiveRecord::Base.establish_connection adapter: "sqlite3", database: ":memory:"
+      create_tables
+      true
+    end
+  end
+
+  def test_where_after
+    skip
+  end
+
+  def call_method(method, field, options)
+    if method == :quarter || options[:time_zone] || options[:day_start] || options[:week_start] || Groupdate.week_start != :sun || (Time.zone && options[:time_zone] != false)
+      error = assert_raises(Groupdate::Error) { super }
+      assert_includes error.message, "not supported for SQLite"
+      skip # after assertions
+    else
+      super
+    end
+  end
+end

data/test/test_helper.rb

@@ -225,6 +225,21 @@ module TestDatabase
     assert_equal expected, User.group_by_year(:created_at, last: 3).count
   end
 
+  def test_last_date
+    Time.zone = pt
+    today = Date.today
+    create_user today.to_s
+    this_month = pt.parse(today.to_s).beginning_of_month
+    last_month = this_month - 1.month
+    expected = {
+      last_month.to_date => 0,
+      this_month.to_date => 1
+    }
+    assert_equal expected, call_method(:month, :created_on, last: 2)
+  ensure
+    Time.zone = nil
+  end
+
   def test_last_hour_of_day
     error = assert_raises(ArgumentError) { User.group_by_hour_of_day(:created_at, last: 3).count }
     assert_equal "Cannot use last option with hour_of_day", error.message
@@ -241,13 +256,15 @@ module TestDatabase
   end
 
   def test_quarter_and_last
-    create_user "#{this_year}-#{this_quarters_month}-01"
-    create_user "#{this_year}-#{this_quarters_month - 6}-01"
+    today = Date.today
+    create_user today.to_s
+    this_quarter = today.to_time.beginning_of_quarter
+    last_quarter = this_quarter - 3.months
     expected = {
-      Date.parse("#{this_year}-#{this_quarters_month - 3}-01") => 0,
-      Date.parse("#{this_year}-#{this_quarters_month}-01") => 1
+      last_quarter.to_date => 0,
+      this_quarter.to_date => 1
     }
-    assert_equal expected, User.group_by_quarter(:created_at, last: 2).count
+    assert_equal expected, call_method(:quarter, :created_at, last: 2)
   end
 
   def test_format_locale
@@ -337,7 +354,7 @@ module TestDatabase
 
   def test_default_timezone_local
     User.default_timezone = :local
-    assert_raises(RuntimeError) { User.group_by_day(:created_at).count }
+    assert_raises(Groupdate::Error) { User.group_by_day(:created_at).count }
   ensure
     User.default_timezone = :utc
   end
@@ -352,7 +369,7 @@ module TestDatabase
       Date.parse("2014-10-19") => 1,
       Date.parse("2014-10-20") => 1
     }
-    assert_equal expected, User.group_by_day(:created_at, time_zone: "Brasilia").count
+    assert_equal expected, call_method(:day, :created_at, time_zone: "Brasilia")
   end
 
   # carry_forward option
@@ -391,7 +408,7 @@ module TestDatabase
   end
 
   def test_using_listed_but_undefined_custom_calculation_method_raises_error
-    assert_raises(RuntimeError) do
+    assert_raises(NoMethodError) do
       User.group_by_day(:created_at).undefined_calculation
     end
   end
@@ -1165,11 +1182,15 @@ module TestGroupdate
   end
 
   def this_quarters_month
-    Time.now.utc.beginning_of_quarter.month
+    Time.now.beginning_of_quarter.month
   end
 
   def this_year
-    Time.now.utc.year
+    Time.now.year
+  end
+
+  def this_month
+    Time.now.month
   end
 
   def utc

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: groupdate
 version: !ruby/object:Gem::Version
-  version: 3.1.1
+  version: 3.2.0
 platform: ruby
 authors:
 - Andrew Kane
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-10-26 00:00:00.000000000 Z
+date: 2017-01-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -108,9 +108,23 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 0.3.20
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: The simplest way to group temporal data
 email:
-- acekane1@gmail.com
+- andrew@chartkick.com
 executables: []
 extensions: []
 extra_rdoc_files: []
@@ -142,6 +156,7 @@ files:
 - test/mysql_test.rb
 - test/postgresql_test.rb
 - test/redshift_test.rb
+- test/sqlite_test.rb
 - test/test_helper.rb
 homepage: https://github.com/ankane/groupdate
 licenses:
@@ -163,7 +178,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.1
+rubygems_version: 2.6.8
 signing_key: 
 specification_version: 4
 summary: The simplest way to group temporal data
@@ -178,4 +193,5 @@ test_files:
 - test/mysql_test.rb
 - test/postgresql_test.rb
 - test/redshift_test.rb
+- test/sqlite_test.rb
 - test/test_helper.rb