aggtive_record 0.0.1

checksums.yaml

@@ -0,0 +1,15 @@
+---
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    NzY2MmY5YWYwNGY3NTQ2OGZjOWFkNmQ0OGMzMGY0OTBhYTI5YWU5ZQ==
+  data.tar.gz: !binary |-
+    OGMyYzBiZTRiYWI1NjBhYzA2YTFmYzAwY2U0YzI1MWU0MzYyYmM5Yg==
+!binary "U0hBNTEy":
+  metadata.gz: !binary |-
+    MzFjZDIyMzk5MjVlOTNjYjA0ZWFlZjZhM2Q1MzcxMmUzZjQxNWQ2NTZmODRj
+    ZDFkMGIwZjNiODNhODk1NWU1Zjg2Y2UwNzFlM2E5ZDM0YTgwM2UzODA1NzA3
+    MmJkN2FiNjFjNGU1NTRkYWNiMzBmNTgyYWE1ODM3MTU2OWI2NGM=
+  data.tar.gz: !binary |-
+    OWYzYjlhNjgwMWZmZjc2MjBmYTUxMjEzYThmOTY0NDQ0M2VhMTg2ZTlmMzYz
+    M2FlZDQ5NzlmMGJmYTc2ZTczZmY0MDFmNGExNWQwNmUxOTE2NzFmMWUwZDRi
+    MjMwMzZlYjEzOTIyZGFiMzZkYmRmNWYyYTZiMzI2NzJmODE5NWQ=

data/.document

@@ -0,0 +1,5 @@
+lib/**/*.rb
+bin/*
+- 
+features/**/*.feature
+LICENSE.txt

data/.rspec

@@ -0,0 +1 @@
+--color

data/Gemfile

@@ -0,0 +1,11 @@
+source "http://rubygems.org"
+
+
+group :development do
+  gem "rspec", "~> 2.14.1"
+  gem "bundler"
+  gem "jeweler", "~> 1.8.4"
+  gem 'pry'
+end
+
+gem 'activesupport', '~> 3.2.14'

data/Gemfile.lock

@@ -0,0 +1,75 @@
+GEM
+  remote: http://rubygems.org/
+  specs:
+    activesupport (3.2.14)
+      i18n (~> 0.6, >= 0.6.4)
+      multi_json (~> 1.0)
+    addressable (2.3.5)
+    builder (3.2.2)
+    coderay (1.0.9)
+    diff-lcs (1.2.4)
+    faraday (0.8.8)
+      multipart-post (~> 1.2.0)
+    git (1.2.6)
+    github_api (0.10.1)
+      addressable
+      faraday (~> 0.8.1)
+      hashie (>= 1.2)
+      multi_json (~> 1.4)
+      nokogiri (~> 1.5.2)
+      oauth2
+    hashie (2.0.5)
+    highline (1.6.19)
+    httpauth (0.2.0)
+    i18n (0.6.5)
+    jeweler (1.8.7)
+      builder
+      bundler (~> 1.0)
+      git (>= 1.2.5)
+      github_api (= 0.10.1)
+      highline (>= 1.6.15)
+      nokogiri (= 1.5.10)
+      rake
+      rdoc
+    json (1.8.0)
+    jwt (0.1.8)
+      multi_json (>= 1.5)
+    method_source (0.8.2)
+    multi_json (1.7.9)
+    multi_xml (0.5.5)
+    multipart-post (1.2.0)
+    nokogiri (1.5.10)
+    oauth2 (0.9.2)
+      faraday (~> 0.8)
+      httpauth (~> 0.2)
+      jwt (~> 0.1.4)
+      multi_json (~> 1.0)
+      multi_xml (~> 0.5)
+      rack (~> 1.2)
+    pry (0.9.12.2)
+      coderay (~> 1.0.5)
+      method_source (~> 0.8)
+      slop (~> 3.4)
+    rack (1.5.2)
+    rake (10.1.0)
+    rdoc (4.0.1)
+      json (~> 1.4)
+    rspec (2.14.1)
+      rspec-core (~> 2.14.0)
+      rspec-expectations (~> 2.14.0)
+      rspec-mocks (~> 2.14.0)
+    rspec-core (2.14.5)
+    rspec-expectations (2.14.2)
+      diff-lcs (>= 1.1.3, < 2.0)
+    rspec-mocks (2.14.3)
+    slop (3.4.6)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  activesupport (~> 3.2.14)
+  bundler
+  jeweler (~> 1.8.4)
+  pry
+  rspec (~> 2.14.1)

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2013 Dan Nguyen
+
+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,99 @@
+# AggtiveRecord
+
+**NOTE:** This gem is not really functional yet. I just like to commit things good and early.
+
+An attempt to formalize the description of common aggregations across timestamped records.
+
+I wrote this gem because I found myself writing, over and over again, these kind of ActiveRecord scope:
+
+
+To get the number of messages sent in the last two weeks:
+
+    Message.where('sent_at >= ?', 14.days.ago).count 
+
+To get the *rate* of messages *per week*:
+
+    Message.count * SECONDS_PER_WEEK / (Message.order('sent_at ASC').last - Message.order('sent_at ASC').first) 
+
+Or how about the rate *per week* for messages sent in the *past month* (because it's interesting to know if someone has sent more messages recently)?
+
+    Message.where('sent_at >= ?', 1.month.ago) * SECONDS_PER_WEEK / (Time.now - 1.month.ago)
+
+This is easily enough to formalize in one application, but I figured maybe it'd be useful to have a convention for every app that I ever do that tries to aggregate records by time.
+
+### Let's make some meta-magic
+
+So for the first example, for counting messages in the past two weeks, something like:
+
+    Message.count_past_14_days
+
+OK, admittedly that's not much nicer than the standard ActiveRecord chain. But for the second example, it could be simplified to this:
+
+    Message.rate_per_week
+
+And for the third example:
+
+    Message.rate_during_past_month_per_week
+
+
+
+**AggtiveRecord** is an extension that can be applied to ActiveRecord. Maybe you'll find it useful, maybe not.
+
+
+This gem takes some inspiration from the highly useful groupdate.
+
+
+    Message.count_during_past_year_per_day
+
+
+    Message.group_by_day.where('sent_at >= ?' 1.year.ago)
+
+
+
+
+
+
+### Interaction with :has_many
+
+*Obviously, this is just speculative*
+
+    @person.rate_of_messages_per_day
+
+    @person.messages_count_during_past_year_per_day
+
+    @person.rate_word_count_from_messages_during_past_year_per_day
+
+    @person.count_messages_during_past_year_per_day
+    @person.messages_count_during_past_year_per_day
+
+    Message.count_during_past_year
+
+
+A standard verbose call:
+
+    @person.sum_word_count_from_messages_during_past_year_per_day
+
+
+*Under the hood query:*
+
+    @person.egg.sum(:word_count).
+      from(:messages).
+      during(:past_year).
+      per(:day)
+
+*Which translates to this in ActiveRecord:*
+
+    @person.messages.
+      where('sent_at >= ?', 1.year.ago).
+      group('DAY(sent_at)').
+      sum(:word_count)
+  
+
+### Result types
+
+
+
+
+### Scalars and arrays
+
+

data/Rakefile

@@ -0,0 +1,48 @@
+# encoding: utf-8
+
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'rake'
+
+require 'jeweler'
+Jeweler::Tasks.new do |gem|
+  gem.name = "aggtive_record"
+  gem.homepage = "http://github.com/dannguyen/aggtive_record"
+  gem.license = "MIT"
+  gem.summary = %Q{A convoluted way to describe aggregations of ActiveRecords over a datetime attribute}
+  gem.description = %Q{This is not even remotely finished or even started on. Please don't download.}
+  gem.email = "dansonguyen@gmail.com"
+  gem.authors = ["Dan Nguyen"]
+  # dependencies defined in Gemfile
+end
+Jeweler::RubygemsDotOrgTasks.new
+
+require 'rspec/core'
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec) do |spec|
+  spec.pattern = FileList['spec/**/*_spec.rb']
+end
+
+RSpec::Core::RakeTask.new(:rcov) do |spec|
+  spec.pattern = 'spec/**/*_spec.rb'
+  spec.rcov = true
+end
+
+task :default => :spec
+
+require 'rdoc/task'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "aggtive_record #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.0.1

data/lib/aggtive_record/adapter/mysql.rb

@@ -0,0 +1,7 @@
+module AggtiveRecord
+  module Adapter
+    module Mysql
+
+    end
+  end
+end

data/lib/aggtive_record/adapter.rb

@@ -0,0 +1,5 @@
+module AggtiveRecord
+  module Adapter
+
+  end
+end

data/lib/aggtive_record/aggable.rb

@@ -0,0 +1,29 @@
+module AggtiveRecord
+  module Aggable
+    extend ActiveSupport::Concern
+
+    included do 
+      class_attribute :datetime_attribute
+    end
+
+    module ClassMethods
+      def attr_timestamp(attname)
+        raise ArgumentError unless is_a_datetime?(att)
+        self.datetime_attribute = attname 
+      end
+
+      def is_a_datetime?(attname)
+        self.columns.select{|r| r.name == attname.to_s && r.type =~ /date|time/}.first.present?
+      end
+    end
+
+
+    def method_missing
+
+    end
+
+    def respond_to
+
+    end
+  end
+end

data/lib/aggtive_record/memo.rb

@@ -0,0 +1,15 @@
+module AggtiveRecord
+  class Egg 
+
+    attr_reader :timezone, :collation, :time_bucket, :time_span, :collective_method
+
+    def self.valid_format?
+
+    end
+
+    def self.parse(str)
+
+    end
+
+  end
+end

data/lib/aggtive_record/scopes/collation.rb

@@ -0,0 +1,7 @@
+module AggtiveRecord
+  module Scopes
+    module Collation
+      extend ActiveRecord::Concern
+    end
+  end
+end

data/lib/aggtive_record/scopes/time_bucket.rb

@@ -0,0 +1,12 @@
+module AggtiveRecord
+  module Scopes
+    module TimeBucket
+      extend ActiveRecord::Concern
+
+      mattr_reader :prefix
+      self.prefix = 'by'
+    
+
+    end
+  end
+end

data/lib/aggtive_record/scopes/time_span.rb

@@ -0,0 +1,22 @@
+module AggtiveRecord
+  module Scopes
+    module TimeSpan
+
+      extend ActiveRecord::Concern
+      
+      # where("#{}" => 1.year.ago..Time.now)
+      #past_year
+
+      mattr_reader :prefix
+      self.prefix = 'during'
+
+=begin
+ 
+  
+  
+=end
+
+
+    end
+  end
+end

data/lib/aggtive_record/scopes.rb

@@ -0,0 +1,5 @@
+module AggtiveRecord
+  module Scopes
+
+  end
+end

data/lib/aggtive_record/time.rb

@@ -0,0 +1,35 @@
+module AggtiveRecord
+  module Time 
+
+    UNIFORM_PERIODS = [:week, :day, :hour, :minute, :second]
+    CALENDAR_PERIODS = [:year, :month]
+
+    PERIODS = CALENDAR_PERIODS + UNIFORM_PERIODS 
+
+    TIMESTAMP_QUANTITIES = [
+      year: {
+        str: '%Y' 
+      },
+      month:{
+        str: '%m'
+      },
+      day: {
+        str: '%d'
+      }
+      
+      hour: {
+        str: '%H'
+      },
+
+      minute: {
+        str: '%i'
+      },
+
+      second: {
+        str: '%S'
+      }
+
+    ]
+
+  end
+end

data/lib/aggtive_record.rb

@@ -0,0 +1,7 @@
+require 'active_support'
+
+module AggtiveRecord
+end
+
+
+

data/spec/functional/basic_object_run_spec.rb

@@ -0,0 +1,60 @@
+require 'spec_helper'
+
+require 'hashie'
+
+class AnObject < ActiveRecord::Base
+  include AggtiveRecord
+  attr_accessor :star_count, :time_posted
+  attr_timestamp :time_posted 
+end
+
+describe 'possible methods', skip: true do 
+
+  context 'singular scopes' do 
+
+    it '#past_14_days'
+    it '#past_year'
+    it '#past_20_years'
+    it 'should not have #past_years'
+
+    it 'by_year'
+    it 'by_minute'
+    it 'not by_microsecond'
+  end
+
+end
+
+describe 'AnObject with AggtiveRecord mixedin', skip: true do 
+
+  context 'class setup' do 
+    it 'should have @@timestamp_attribute set to :time_posted' 
+  end
+
+  context 'scopes' do
+
+    describe '#during' do 
+
+      describe '.past_[time frame]' do  
+        it 'should scope within past_14_days'
+        it 'should scope within past_year'
+      end
+
+      describe '.[epoch_name]' do 
+        it 'should scope #overall'
+        it 'should scope year(1995)' do 
+          pending %q{
+            er...what's the <s></s>yntax for that...?
+
+
+          }
+        end
+      end
+
+    context 'AnObject scoped collection' do 
+      describe '[agg]_of methods' do 
+        it 'should have #count_of '
+      end
+    end
+  end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,25 @@
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'rspec'
+require 'aggtive_record'
+
+
+# Requires supporting files with custom matchers and macros, etc,
+# in ./support/ and its subdirectories.
+Dir["#{File.dirname(__FILE__)}/support/**/*.rb"].each {|f| require f}
+
+
+
+
+RSpec.configure do |config|
+  config.color_enabled = true
+  config.tty = true
+  config.formatter = :documentation # :progress, :html, :textmate
+
+  config.before(:each) do
+  end
+
+  config.after(:each) do
+  end
+end
+

data/spec/unit/aggable.rb

@@ -0,0 +1,24 @@
+require 'spec_helper'
+
+describe "AggtiveRecord::Aggable" do
+
+  context 'class methods' do 
+
+    describe '#is_a_datetime?' do 
+      it 'returns true if named column exists and is date/time' do 
+        @klass.is_a_datetime?
+      end
+
+      it 'returns false if named column does not exist'
+      it 'returns false if named column is not date/time'
+    end
+
+
+    describe '#attr_datetime' do 
+      it 'sets @@datetime_attribute'
+      it 'raises ArgumentError if not a valid datetime column'
+    end
+
+  end
+
+end

metadata

@@ -0,0 +1,137 @@
+--- !ruby/object:Gem::Specification
+name: aggtive_record
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Dan Nguyen
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-08-20 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 3.2.14
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 3.2.14
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.14.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.14.1
+- !ruby/object:Gem::Dependency
+  name: bundler
+  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'
+- !ruby/object:Gem::Dependency
+  name: jeweler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.8.4
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.8.4
+- !ruby/object:Gem::Dependency
+  name: pry
+  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: This is not even remotely finished or even started on. Please don't download.
+email: dansonguyen@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files:
+- LICENSE.txt
+- README.md
+files:
+- .document
+- .rspec
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- VERSION
+- lib/aggtive_record.rb
+- lib/aggtive_record/adapter.rb
+- lib/aggtive_record/adapter/mysql.rb
+- lib/aggtive_record/aggable.rb
+- lib/aggtive_record/memo.rb
+- lib/aggtive_record/scopes.rb
+- lib/aggtive_record/scopes/collation.rb
+- lib/aggtive_record/scopes/time_bucket.rb
+- lib/aggtive_record/scopes/time_span.rb
+- lib/aggtive_record/time.rb
+- spec/functional/basic_object_run_spec.rb
+- spec/spec_helper.rb
+- spec/unit/aggable.rb
+homepage: http://github.com/dannguyen/aggtive_record
+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.0.5
+signing_key: 
+specification_version: 4
+summary: A convoluted way to describe aggregations of ActiveRecords over a datetime
+  attribute
+test_files: []