dateslices 0.0.2 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b68aa17be20ba5b07f590ae06385ccf18b5a5c64
-  data.tar.gz: 15da28cf505321ef535b07a0a5e51859c9b19085
+  metadata.gz: 3efa5cfa855a50c696f0d04409b2ed0187920eea
+  data.tar.gz: 26c2e49f84cb16c2c3dcd2a2a1f5924e0f134f21
 SHA512:
-  metadata.gz: df4ef7ce5e1bc900f25b55e92bf8ecaf843bc8869f5a6abcb35ef162267554b61d50f45cf1a9bdb516fa21bc112f9391956a35d2021c906ee3b4b6f9f186fc22
-  data.tar.gz: 987181e91f8152f6d6ba21b388f6330e42253188be26928158e3434d9cc31aa09cd8a8be63cd83c477028b142b3ae03f56f6ba7ba73a347e1e16b958eb974587
+  metadata.gz: 854d8b6e033cf34ce2a673fcc2a5eb4b1968bb2869fb77b9a4d3038fd8f31968fe2d7684c56e4a83b10669cb99c53c0a2b0abad20014f7c65529b6b13f4a1ac0
+  data.tar.gz: 0ec27b6e51699b05d77facf95b1dfa280c2bdc6021dba6711450789571d808efda8f81efef6d75c98df0eeac2cd475b7046e0fa55aea5ff2a668edf63502919c

data/README.md

@@ -0,0 +1,61 @@
+# Dateslices
+
+This project rocks and uses MIT-LICENSE.
+
+This project is based upon [groupdate](https://github.com/ankane/groupdate) and follows a similar API.
+
+The differences between the groupdate and dateslices are:
+- dateslices supports sqlite3.
+- dateslices has much less functionality.
+- dateslices ignores timezones.
+- dateslices is rails 4 only.
+- dateslices uses rspecs for tests.
+- dateslices doesn't have hour_of_day since it doesn't deal with timezones
+
+
+The reason that I wrote this is that I use sqlite in development, and wanted to make sure that I could test things locally.  I didn't understand the test suite of groupdate, so I ended up rewriting it.
+
+
+## Example Usage
+
+```
+User.where( :created_at > 1.month.ago ).group_by_day
+```
+
+## Summing up a column
+
+```
+User.group_by_day( :created_at, "sum", "karma" )
+```
+
+## Averaging a column
+
+```
+Post.group_by_week( :updated_at, "avg", "comment_count")
+```
+
+## All find methods
+
+These methods take three optional arguments:
+
+1. column to group by, normally "created_at"
+2. sql function to run, normally "count".  Also "sum", "avg"
+3. column to do the function on, normally "*"
+
+- group_by_second
+- group_by_minute
+- group_by_hour
+- group_by_day
+- group_by_week
+- group_by_day_of_week
+- group_by_month
+- group_by_year
+
+## Configuration
+
+The output format now defaults to a Chartkick compatible hash of dates and values.
+If you wish to use the dateslice format, please add `Dateslices.output_format = :dateslice` to an initializer.
+
+## Tests
+
+Rspec tests need to be run out of the spec/dummy directory, and you'll need to have a postgres and a mysql database named "dateslice_test" for them to succeed.

data/lib/dateslices.rb

@@ -5,9 +5,9 @@ module Dateslices
   FIELDS = [:second, :minute, :hour, :day, :week, :day_of_week, :month, :year ]
   METHODS = FIELDS.map{|v| :"group_by_#{v}" }
 
-  mattr_accessor :week_start, :day_start, :time_zone
-  self.week_start = :sun
-  self.day_start = 0
+  mattr_accessor :output_format
+
+  self.output_format = :groupdate
 end
 
 begin

data/lib/dateslices/mysql.rb

@@ -20,7 +20,7 @@ module Dateslices
         when :week # Sigh...
           "DATE_FORMAT( date_sub( created_at, interval ((weekday( created_at ) + 1)%7) day ), '%Y-%m-%d 00:00:00 UTC')"
         else
-          throw "Implement #{field}"
+          throw "Unknown time filter #{field}"
       end
     end
 

data/lib/dateslices/scopes.rb

@@ -3,41 +3,51 @@ module Dateslices
 
     Dateslices::FIELDS.each do |field|
       define_method :"group_by_#{field}" do |*args|
+
         args = args.dup
 
-        column = args[0]
-        column = 'created_at' if column.blank?
+        column = args[0].blank? ? 'created_at' : args[0]
+
+        aggregation = args[1].blank? ? 'count' : args[1]
+
+        aggregation_column = args[2].blank? ? '*' : args[2]
 
-        aggregation = args[1]
-        aggregation = 'count' if aggregation.blank?
+        sql = ["#{aggregation}(#{aggregation_column}) as count"]
 
-        aggregation_column = args[2]
-        aggregation_column = "*" if aggregation_column.blank?
+        time_filter = case connection.adapter_name
+                        when 'SQLite'
+                          Dateslices::Sqlite.time_filter(column, field)
+                        when 'PostgreSQL', 'PostGIS'
+                          Dateslices::Postgresql.time_filter(column, field)
+                        when 'MySQL', 'Mysql2'
+                          Dateslices::Mysql.time_filter(column, field)
+                        else
+                          throw "Unknown database adaptor #{connection.adapter_name}"
+                      end
+
+        sql << "#{time_filter} as date_slice"
 
-        sql = ["#{aggregation}(#{aggregation_column}) as cnt"]
+        slices = select( sql.join(', ')).where.not(column => nil).group('date_slice').order('date_slice')
 
-        time_filter = ''
+        if Dateslices.output_format == :groupdate
 
-        case connection.adapter_name
-        when 'SQLite'
-          time_filter = Dateslices::Sqlite.time_filter(column, field)
-        when 'PostgreSQL', 'PostGIS'
-          time_filter = Dateslices::Postgresql.time_filter(column, field)
-        when 'MySQL', 'Mysql2'
-          time_filter = Dateslices::Mysql.time_filter(column, field)
+          slices.collect! do |c|
+            slice = c['date_slice']
+            slice = slice.is_a?(Float) ? slice.to_i.to_s : slice.to_s
+            [slice, c['count']]
+          end
+
+          Hash[slices]
         else
-          throw "Unknown database adaptor #{connection.adapter_name}"
-        end
 
-        sql << "#{time_filter} as date_slice"
+          slices.collect do |c|
+            slice = c['date_slice']
+            slice = slice.is_a?(Float) ? slice.to_i.to_s : slice.to_s
+            { date_slice: slice, aggregation.to_sym => c['count'] }
+          end
 
-        select( sql.join(', ')).where.not(column => nil).group('date_slice').order('date_slice').collect do |c|
-          slice = c['date_slice']
-          slice = slice.to_i.to_s if slice.is_a? Float
-          slice = slice.to_s if slice.is_a? Integer
-          slice = slice.to_s
-          { date_slice: slice, aggregation.to_sym => c["cnt"] }
         end
+
       end
     end
 

data/lib/dateslices/version.rb

@@ -1,3 +1,3 @@
 module Dateslices
-  VERSION = '0.0.2'
+  VERSION = '0.0.3'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: dateslices
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
 platform: ruby
 authors:
 - Will Schenk
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-11-16 00:00:00.000000000 Z
+date: 2014-12-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -117,6 +117,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - MIT-LICENSE
+- README.md
 - Rakefile
 - lib/dateslices.rb
 - lib/dateslices/mysql.rb