quandl_cassandra_models 0.3.11 → 0.3.12

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 69f5626f4f3ae37d62c6c4eb1eb005b2f9e6f385
-  data.tar.gz: 642f964098fbe5ee0b5482631ab0eff51f7bb612
+  metadata.gz: 19c6f57810b76a53543512153c5b92509b37067e
+  data.tar.gz: ba82d7c28e4e048f1abd221765d779a5d981fe4a
 SHA512:
-  metadata.gz: 09cddb90fbc340b9cd008ae4c79303e92e70bd32ad1e150dc158507f943e73877de14faa9d8f171440de58a3d76bce7f0b99118f35c745c5caa821d1ddbeea18
-  data.tar.gz: 17b32587b0e906d50439d73a79a3bba6db4af34edea62fbc3d36f585a0edf43d10baa64448526d13439adea088857d3acd4400d8405b6c06dae71d82996c02b8
+  metadata.gz: 9d39a799aeb081836cd8debf0e0c033fc2f06ee9b9433f0c7e9ced7307a06ec67a30d3490e7e27172486e8048a15effe8119f37a4b505eff7e7755afb3c17d84
+  data.tar.gz: b7417e67ee39584d3d34fc8b14e6524929827ef28358950f0d0692c44ae136871399299faed4168bda9ff08378977524360cb7c7141080d7166b4d25cdd5b72b

data/Gemfile

@@ -1,4 +1,8 @@
 source "https://rubygems.org"
 gemspec
 
-gem 'cassandra_migrations','~> 0.3', git: 'git@github.com:blakehilscher/cassandra_migrations.git'
+gem 'cassandra_migrations','~> 0.3', git: 'git@github.com:blakehilscher/cassandra_migrations.git'
+
+if ENV['BUNDLE_LOCAL_GEMS'] == "true" && ENV['BUNDLE_LOCAL_DIR']
+  gem 'quandl_cassandra', path: "#{ENV['BUNDLE_LOCAL_DIR']}/quandl/cassandra"
+end

data/UPGRADE.md

@@ -1,3 +1,9 @@
+## 0.3.12
+
+* refactor read to use define_attributes for trim_start, trim_end, collapse WIKI-28 passes
+* add trim_spec, type_spec
+
+
 ## 0.3.11
 
 * stub Quandl::Fabricate::Data.rand to return spec/fixtures/data.csv

data/lib/quandl/cassandra/models/column/read/data.rb

@@ -11,7 +11,7 @@ class Quandl::Cassandra::Models::Column::Read::Data < Quandl::Cassandra::Models:
     data.column_ids = column_ids unless attributes[:column].present?
     data.column_frequencies = attributes[:column_frequencies] unless attributes[:column].present?
     # post process
-    data = collapse(data)
+    data = data.collapse( collapse ) if collapse?
     data = transform(data)
     data = trim(data)
     data = sort( data )
@@ -32,11 +32,6 @@ class Quandl::Cassandra::Models::Column::Read::Data < Quandl::Cassandra::Models:
     data = data.sort_order( attributes[:order] )
   end
   
-  def collapse(data)
-    data = data.collapse( attributes[:collapse] ) if attributes[:collapse]
-    data
-  end
-  
   def transform(data)
     data = data.transform( attributes[:transform] ) if attributes[:transform]
     data

data/lib/quandl/cassandra/models/column/read/limit.rb

@@ -0,0 +1,9 @@
+class Quandl::Cassandra::Models::Column::Read::Limit < Quandl::Cassandra::Models::Column::Read
+  
+  def perform
+    return unless attributes[:limit].is_a?(Integer)
+    # given limit, it must be greater than or equal to 1
+    attributes[:limit] = 1 if attributes[:limit] <= 0
+  end
+  
+end

data/lib/quandl/cassandra/models/column/read/offset.rb

@@ -9,15 +9,15 @@ class Quandl::Cassandra::Models::Column::Read::Offset < Quandl::Cassandra::Model
   end
   
   def required_attributes_present?
-    column_ids.present? && trim_start.is_a?(Date) && trim_end.is_a?(Date)
+    column_ids.present? && column_collapses.present? && columns_trim_start.is_a?(Date) && columns_trim_end.is_a?(Date)
   end
   
   def apply_offset_with_transform
     # rdiff_from needs the data from the current to offset
     if attributes[:row].present? && attributes[:transform] == :rdiff_from
       # limit the results by trim 
-      attributes[:trim_start] = trim_start.occurrences_of_frequency_ago( attributes[:row], collapse_with_frequency ).end_of_frequency(collapse_with_frequency).jd if order == :desc
-      attributes[:trim_end] = trim_end.occurrences_of_frequency_ahead( attributes[:row], collapse_with_frequency ).end_of_frequency(collapse_with_frequency).jd if order == :asc
+      self.trim_start = columns_trim_start.occurrences_of_frequency_ago( attributes[:row], collapse_with_frequency ).end_of_frequency(collapse_with_frequency) if order == :desc
+      self.trim_end   = columns_trim_end.occurrences_of_frequency_ahead( attributes[:row], collapse_with_frequency ).end_of_frequency(collapse_with_frequency) if order == :asc
       # the query should not limit or offset the data
       attributes[:limit] = nil
       attributes[:offset] = nil
@@ -31,27 +31,27 @@ class Quandl::Cassandra::Models::Column::Read::Offset < Quandl::Cassandra::Model
   
   def apply_offset_asc
     # calculate ranges
-    offset_start  = trim_end.occurrences_of_frequency_ahead( offset, collapse_with_frequency ).start_of_frequency(collapse_with_frequency)
+    offset_start  = columns_trim_end.occurrences_of_frequency_ahead( offset, collapse_with_frequency ).start_of_frequency(collapse_with_frequency)
     offset_end    = offset_start.occurrences_of_frequency_ahead( accuracy_with_limit, collapse_with_frequency ).end_of_frequency( collapse_with_frequency ) if limit
     # set trims
-    attributes[:trim_start]  = offset_start.jd
-    attributes[:trim_end]    = offset_end.jd  if limit
+    self.trim_start = offset_start
+    self.trim_end   = offset_end if limit
   end
   
   def apply_offset_desc
     # calculate ranges
-    offset_start  = trim_start.occurrences_of_frequency_ago( offset, collapse_with_frequency ).end_of_frequency(collapse_with_frequency)
+    offset_start  = columns_trim_start.occurrences_of_frequency_ago( offset, collapse_with_frequency ).end_of_frequency(collapse_with_frequency)
     offset_end    = offset_start.occurrences_of_frequency_ago( accuracy_with_limit, collapse_with_frequency ).start_of_frequency( collapse_with_frequency ) if limit
     # set trims
-    attributes[:trim_start] = offset_end.jd  if limit
-    attributes[:trim_end]   = offset_start.jd
+    self.trim_start = offset_end  if limit
+    self.trim_end   = offset_start
   end
   
-  def trim_start
+  def columns_trim_start
     @trim_start ||= Quandl::Cassandra::Column.find_max_time_by_ids(column_ids, column_collapses, "DESC")
   end
   
-  def trim_end
+  def columns_trim_end
     @trim_end ||= Quandl::Cassandra::Column.find_max_time_by_ids(column_ids, column_collapses, "ASC")
   end
   
@@ -66,7 +66,7 @@ class Quandl::Cassandra::Models::Column::Read::Offset < Quandl::Cassandra::Model
     accuracy = attributes[:accuracy]
     # otherwise guess at the accuracy by collapse
     if accuracy.blank?
-      accuracy = case frequency
+      accuracy = case frequency.to_sym
       when :daily     then 0
       when :weekly    then 1
       when :monthly   then 1
@@ -99,8 +99,4 @@ class Quandl::Cassandra::Models::Column::Read::Offset < Quandl::Cassandra::Model
     attributes[:frequency]
   end
   
-  def collapse
-    attributes[:collapse]
-  end
-  
 end

data/lib/quandl/cassandra/models/column/read/select_columns.rb

@@ -48,8 +48,8 @@ class Quandl::Cassandra::Models::Column::Read::SelectColumns < Quandl::Cassandra
     columns = count? ? "COUNT(*)" : "time,value"
     cql = "SELECT #{columns} FROM columns WHERE"
     # cql += "ORDER"
-    cql += " time >= #{attributes[:trim_start]} AND " if attributes[:trim_start]
-    cql += " time <= #{attributes[:trim_end]} AND " if attributes[:trim_end]
+    cql += " time >= #{trim_start.jd} AND " if trim_start?
+    cql += " time <= #{trim_end.jd} AND " if trim_end?
     cql += " id = ? AND type = ?"
     cql += " ORDER BY type #{order}"
     cql += " LIMIT #{attributes[:limit]}" if attributes[:limit]

data/lib/quandl/cassandra/models/column/read/transform.rb

@@ -23,8 +23,8 @@ class Quandl::Cassandra::Models::Column::Read::Transform < Quandl::Cassandra::Mo
     # limit requires limit
     attributes[:limit] = attributes[:limit] + 1 if attributes[:limit]
     # trims should be increased by one
-    attributes[:trim_start] = trim_start.occurrences_of_frequency_ago( 1, attributes[:collapse] ).jd if trim_start.present? && order == :desc
-    attributes[:trim_end] = trim_end.occurrences_of_frequency_ahead( 1, attributes[:collapse] ).jd if trim_end.present? && order == :asc
+    self.trim_start = trim_start.occurrences_of_frequency_ago( 1, collapse ) if trim_start? && order == :desc
+    self.trim_end   = trim_end.occurrences_of_frequency_ahead( 1, collapse ) if trim_end? && order == :asc
   end
   
   def transform?(*keys)
@@ -34,14 +34,6 @@ class Quandl::Cassandra::Models::Column::Read::Transform < Quandl::Cassandra::Mo
     false
   end
   
-  def trim_end
-    @trim_end ||= attributes[:trim_end].present? ? Date.jd( attributes[:trim_end] ) : nil
-  end
-  
-  def trim_start
-    @trim_start ||= attributes[:trim_start].present? ? Date.jd( attributes[:trim_start] ) : nil
-  end
-  
   def limit
     attributes[:limit]
   end

data/lib/quandl/cassandra/models/column/read/trim.rb

@@ -1,14 +1,22 @@
 class Quandl::Cassandra::Models::Column::Read::Trim < Quandl::Cassandra::Models::Column::Read
   
   def perform
-    # if both are provided
-    if attributes[:trim_end].is_a?(Integer) && attributes[:trim_start].is_a?(Integer)
-      # if trim_start exceeds trim_end
-      if attributes[:trim_start] > attributes[:trim_end]
-        # then set trim_end to trim_start, since they are requesting nothing
-        attributes[:trim_end] = attributes[:trim_start]
-      end
-    end
+    trim_start_should_begin_at_start_of_frequency if trim_start? && collapse?
+    trim_end_should_finish_at_end_of_frequency if trim_end? && collapse?
+    trim_start_should_not_exceed_trim_end if trim_start? && trim_end?
+  end
+  
+  def trim_start_should_begin_at_start_of_frequency
+    self.trim_start = trim_start.start_of_frequency(collapse)
+  end
+  
+  def trim_end_should_finish_at_end_of_frequency
+    self.trim_end = trim_end.end_of_frequency(collapse)
+  end
+  
+  def trim_start_should_not_exceed_trim_end
+    # must not exceed trim_start
+    self.trim_end = trim_start if trim_start > trim_end
   end
   
 end

data/lib/quandl/cassandra/models/column/read/type.rb

@@ -11,15 +11,35 @@ class Quandl::Cassandra::Models::Column::Read::Type < Quandl::Cassandra::Models:
   
   def enforce_type(key, value)
     case key
-    when :limit, :column, :trim_start, :trim_end, :offset, :accuracy, :row
-      return value.try(:to_i)
-    when :collapse, :transform, :frequency
-      return value.try(:to_sym)
-    when :order
-      return value.try(:to_sym) == :asc ? :asc : :desc
+    when *date_types      then parse_date(value)
+    when *integer_types   then value.try(:to_i)
+    when *sym_types       then value.try(:to_sym)
+    when :order           then value.try(:to_sym) == :asc ? :asc : :desc
     else
       value
     end
   end
   
+  def sym_types
+    [:collapse, :transform, :frequency]
+  end
+  
+  def date_types
+    [:trim_start, :trim_end]
+  end
+  
+  def integer_types
+    [:limit, :column, :offset, :accuracy, :row]
+  end
+  
+  def parse_date(value)
+    date = Date.jd(value.to_i) if value.kind_of?(String) && value.numeric?
+    date = Date.jd(value) if value.is_a?(Integer)
+    date = Date.parse(value) if value.is_a?(String) && value =~ /^[0-9]{4}\-[0-9]{2}\-[0-9]{2}$/
+    date = value if value.is_a?(Date)
+    date
+  rescue
+    nil
+  end
+  
 end

data/lib/quandl/cassandra/models/column/read.rb

@@ -9,12 +9,14 @@ class Quandl::Cassandra::Models::Column::Read < Quandl::Strategy::Strategize
   require_relative 'read/transform'
   require_relative 'read/trim'
   require_relative 'read/type'
+  require_relative 'read/limit'
 
-  define_attributes :id
+  define_attributes :id, :trim_start, :trim_end, :collapse
 
   def self.perform(attributes)
     strategy = Quandl::Strategy.new( attributes ) do |c|
       c.use Quandl::Cassandra::Models::Column::Read::Type
+      c.use Quandl::Cassandra::Models::Column::Read::Limit
       c.use Quandl::Cassandra::Models::Column::Read::Row
       c.use Quandl::Cassandra::Models::Column::Read::Column
       c.use Quandl::Cassandra::Models::Column::Read::Collapse
@@ -26,7 +28,7 @@ class Quandl::Cassandra::Models::Column::Read < Quandl::Strategy::Strategize
     end
     strategy.perform
   rescue => e
-    Quandl::Logger.error("#{e} #{strategy.attributes}")
+    Quandl::Logger.error("#{e} #{attributes}")
     raise
   end
   

data/lib/quandl/cassandra/models/version.rb

@@ -1,7 +1,7 @@
 module Quandl
 module Cassandra
 module Models
-  VERSION = '0.3.11'
+  VERSION = '0.3.12'
 end
 end
 end

data/spec/lib/quandl/cassandra/models/column/read/trim_spec.rb

@@ -0,0 +1,30 @@
+# encoding: utf-8
+require 'spec_helper'
+
+describe Quandl::Cassandra::Models::Column::Read::Trim do
+  # column_ids.present? && trim_start.is_a?(Date) && trim_end.is_a?(Date)
+  
+  let(:trim_start){ Date.parse("2010-02-13") }
+  let(:trim_end){ Date.parse("2013-10-21") }
+  let(:collapse){ 'daily' }
+  
+  let(:strategy){ Quandl::Cassandra::Models::Column::Read::Trim.new( 
+    trim_start:         trim_start,
+    trim_end:           trim_end,
+    collapse:           collapse,
+  )}
+  
+  [:daily, :weekly, :monthly, :quarterly, :annual].each do |collapse|
+    context collapse do
+      let(:collapse){ collapse }
+    
+      describe "#attributes" do
+        subject{ OpenStruct.new(strategy.attributes) }
+        its(:trim_start){ should eq Date.parse("2010-02-13").start_of_frequency(collapse) }
+        its(:trim_end){ should eq Date.parse("2013-10-21").end_of_frequency(collapse) }
+      end
+    end
+    
+  end
+  
+end

data/spec/lib/quandl/cassandra/models/column/read/type_spec.rb

@@ -0,0 +1,37 @@
+# encoding: utf-8
+require 'spec_helper'
+
+describe Quandl::Cassandra::Models::Column::Read::Type do
+
+  let(:strategy){
+    Quandl::Cassandra::Models::Column::Read::Type.new({
+      collapse:       'monthly',
+      transform:      'rdiff',
+      frequency:      'daily',
+      trim_start:     Date.today,
+      trim_end:       Date.today.jd.to_s,
+      limit:          '10',
+      row:            '2',
+    })
+  }
+  
+  describe "#attributes" do
+    subject{ OpenStruct.new(strategy.attributes) }
+    its(:collapse){ should eq :monthly }
+    its(:transform){ should eq :rdiff }
+    its(:frequency){ should eq :daily }
+    its(:trim_start){ should eq Date.today }
+    its(:trim_end){ should eq Date.today }
+    its(:limit){ should eq 10 }
+    its(:row){ should eq 2 }
+  
+    [ Date.today, Date.today.jd.to_s, Date.today.to_s, Date.today.jd ].each do |date_type|
+      context "#trim_start #{date_type.class}" do
+        let(:strategy){ Quandl::Cassandra::Models::Column::Read::Type.new({ trim_start: date_type }) }
+        its(:trim_start){ should eq Date.today }
+      end
+    end
+    
+  end
+  
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: quandl_cassandra_models
 version: !ruby/object:Gem::Version
-  version: 0.3.11
+  version: 0.3.12
 platform: ruby
 authors:
 - Blake Hilscher
@@ -145,6 +145,7 @@ files:
 - lib/quandl/cassandra/models/column/read/collapse.rb
 - lib/quandl/cassandra/models/column/read/column.rb
 - lib/quandl/cassandra/models/column/read/data.rb
+- lib/quandl/cassandra/models/column/read/limit.rb
 - lib/quandl/cassandra/models/column/read/offset.rb
 - lib/quandl/cassandra/models/column/read/row.rb
 - lib/quandl/cassandra/models/column/read/select_columns.rb
@@ -173,6 +174,8 @@ files:
 - spec/expectations/time.rb
 - spec/factories/dataset.rb
 - spec/fixtures/data.csv
+- spec/lib/quandl/cassandra/models/column/read/trim_spec.rb
+- spec/lib/quandl/cassandra/models/column/read/type_spec.rb
 - spec/lib/quandl/cassandra/models/column/read_spec.rb
 - spec/lib/quandl/cassandra/models/column/write/group_data_by_frequency_spec.rb
 - spec/lib/quandl/cassandra/models/column/write_spec.rb
@@ -223,6 +226,8 @@ test_files:
 - spec/expectations/time.rb
 - spec/factories/dataset.rb
 - spec/fixtures/data.csv
+- spec/lib/quandl/cassandra/models/column/read/trim_spec.rb
+- spec/lib/quandl/cassandra/models/column/read/type_spec.rb
 - spec/lib/quandl/cassandra/models/column/read_spec.rb
 - spec/lib/quandl/cassandra/models/column/write/group_data_by_frequency_spec.rb
 - spec/lib/quandl/cassandra/models/column/write_spec.rb