quandl_data 1.3.9 → 1.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c3c2e3eed2e151a72e4c55bde8bf974c69f453b8
-  data.tar.gz: ec9f4f6ee49b8c219d977c87cb594f406e837116
+  metadata.gz: 8ba35c6c066aacfe1f15e4007e95e2573594d454
+  data.tar.gz: 7d7418cf6699c656c2495b5621db5e700adfc794
 SHA512:
-  metadata.gz: 13d6f8131b81c6f11bca78fd004be321db1e5e744ff829afecf0c535805e15ad27bd848b016400c96f39b3ac1d881f4977a32da5a05e63ba4d4f8ea1750e7cb5
-  data.tar.gz: 0f49c42c92da222960accbbe615f2d4631bee98f44ed9a3c551e72e81fab0810fb09545cef844f4f757293d031d962098170f9af5db3649bcd57ae204b4b6243
+  metadata.gz: 3801aa3d4c9b908fe7ebd532341e1e797f0882242472e18cfdf45a1b05df30fa16927dd36621ceb01d9e1375c643d7f46eaf51647ef98aea8093781c1769807c
+  data.tar.gz: fa211ba94b2a348724a15bb9a0ab89fc04fcbb69e98b28c633a075eaabd48e6a7d53a94c099e04554ecc3575e5c1da7c80e860947174e56946d710a8baa29e86

data/Rakefile

@@ -2,6 +2,10 @@ require "bundler"
 require "rake"
 require "bundler/gem_tasks"
 require "rspec/core/rake_task"
+require 'quandl/data'
+require 'pry'
+
+require 'quandl/utility/rake_tasks'
 
 task :default => :spec
 
@@ -9,3 +13,14 @@ desc "Run all specs"
 RSpec::Core::RakeTask.new(:spec) do |task|
   task.pattern = "spec/**/*_spec.rb"
 end
+
+task :console do |t,args|
+  binding.pry
+end
+
+Quandl::Utility::Tasks.configure do |c|
+  c.name              = 'quandl_data'
+  c.version_path      = 'VERSION'
+  c.changelog_path    = 'UPGRADE.md'
+  c.changelog_matching  = ['^QUGC','^WIKI']
+end

data/UPGRADE.md

@@ -1,3 +1,9 @@
+## 1.4.0 
+
+* QUGC-104 refactored Quandl::Data to use valid? and errors.
+
+
+
 ## 1.3.9
 
 * add malformed_csv spec and error catching

data/VERSION

@@ -0,0 +1 @@
+1.4.0

data/lib/quandl/data.rb

@@ -1,19 +1,13 @@
 require "quandl/data/version"
 
-require "active_support"
-require "active_support/inflector"
-require "active_support/core_ext/hash"
-require "active_support/core_ext/object"
+require 'quandl/support'
 
 require "quandl/operation"
-
 require 'quandl/babelfish'
-
 require 'quandl/error/date_parse_error'
 
 require 'quandl/data/attributes'
 require 'quandl/data/cleaning'
-require 'quandl/data/enumerator'
 require 'quandl/data/operations'
 require 'quandl/data/format'
 require 'quandl/data/validations'
@@ -23,7 +17,6 @@ module Quandl
 class Data
   include Attributes
   include Cleaning
-  include Enumerator
   include Operations
   include Validations
   include Logging if defined?(QUANDL_LOGGER) && QUANDL_LOGGER == true

data/lib/quandl/data/attributes.rb

@@ -4,33 +4,33 @@ module Attributes
   
   extend ActiveSupport::Concern
   
-  def initialize(*args)
-    self.pristine_data = args.first
-    self.attributes = args.extract_options!
-  end
-  
-  def headers=(value)
-    @headers = value.flatten if value.kind_of?(Array)
-  end
-  def headers
-    ensure_data_is_cleaned
-    @headers
-  end
-  def headers?
-    headers.present?
+  included do
+    
+    include Quandl::Support::Attributes
+    
+    define_attributes :headers, :pristine_data, :cleaned, :data_array
+    
+    delegate *Array.forwardable_methods, to: :data_array
+    delegate :to_json, :as_json, to: :data_array
+
+    def headers=(value)
+      write_attribute(:headers, Array(value).flatten )
+    end
+    
+    def cleaned?
+      read_attribute(:cleaned) == true
+    end
+    
   end
   
-  def attributes
-    @attributes ||= {}
-  end
-  def attributes=(attrs)
-    assign_attributes(attrs)
-    attributes
-  end
-  def assign_attributes(attrs)
-    attrs.each do |name, value|
-      self.send("#{name}=", value) if self.respond_to?("#{name}=")
+  def initialize(*args)
+    # passed an instance of quandl data?
+    if args.first.kind_of?(Quandl::Data)
+      @attributes = args.first.attributes
+    elsif args.first.present?
+      self.pristine_data = args.first
     end
+    valid? unless cleaned?
   end
   
 end

data/lib/quandl/data/cleaning.rb

@@ -4,23 +4,10 @@ module Cleaning
   
   extend ActiveSupport::Concern
   
-  def cleaned
-    @cleaned
-  end
-  def cleaned=(value)
-    @cleaned = (value == true)
-  end
-  def cleaned?
-    cleaned == true
-  end
-  
-  def ensure_data_is_cleaned
-    data_array unless cleaned?
-  end
-  
   protected
   
   def clean(data)
+    data = data.dup if data.is_a?(Array) &&data.respond_to?(:dup)
     # check if data is dirty
     requires_cleaning = ensure_data_requires_cleaning(data)
     # short ciruit unless data is dirty
@@ -34,12 +21,6 @@ module Cleaning
   def ensure_data_requires_cleaning(data)
     # skip cleaning if already clean
     return data if data.kind_of?(Array) && cleaned?
-    # Quandl::Data is already clean, but to avoid errors extract internal array
-    if data.kind_of?(Quandl::Data)
-      # extract headers if present
-      self.headers = data.headers
-      return data.to_date.to_a
-    end
     # Return empty array if given empty string, nil, etc.
     return [] if data.blank?
     # data requires cleaning

data/lib/quandl/data/operations.rb

@@ -43,22 +43,22 @@ module Operations
   end
   
   def to_jd!
-    @data_array = Quandl::Data::Format.to_jd( data_array ); self
+    self.data_array = Quandl::Data::Format.to_jd( data_array ); self
   end
   
   def to_date!
-    @data_array = Quandl::Data::Format.to_date( data_array ); self
+    self.data_array = Quandl::Data::Format.to_date( data_array ); self
   end
   
   def to_date_str!
-    @data_array = to_date!.collect{|r| r = r.dup; r[0] = r[0].to_s; r }; self
+    self.data_array = to_date!.collect{|r| r = r.dup; r[0] = r[0].to_s; r }; self
   end
   
   def trim_start!(date)
     # date format
     date = Quandl::Operation::QDate.parse(date)
     # reject rows with dates less than
-    @data_array = to_date!.sort_descending!.delete_if do |row|
+    self.data_array = to_date!.sort_descending!.delete_if do |row|
       row_date = row[0]
       row_date < date
     end
@@ -69,7 +69,7 @@ module Operations
     # date format
     date = Quandl::Operation::QDate.parse(date)
     # reject rows with dates less than
-    @data_array = to_date!.sort_descending!.delete_if do |row|
+    self.data_array = to_date!.sort_descending!.delete_if do |row|
       row_date = row[0]
       row_date > date
     end
@@ -77,7 +77,7 @@ module Operations
   end
   
   def limit!(amount)
-    @data_array = data_array[0..( amount.to_i - 1 )]; self
+    self.data_array = data_array[0..( amount.to_i - 1 )]; self
   end
   
   def sort_order(dir)
@@ -85,21 +85,21 @@ module Operations
   end
   
   def sort_ascending!
-    @data_array = Quandl::Operation::Sort.asc( data_array ); self
+    self.data_array = Quandl::Operation::Sort.asc( data_array ); self
   end
 
   def sort_descending!
-    @data_array = Quandl::Operation::Sort.desc( data_array ); self
+    self.data_array = Quandl::Operation::Sort.desc( data_array ); self
   end
   
   def to_precision!(value)
-    @data_array = Quandl::Operation::Value.precision(data_array, value); self
+    self.data_array = Quandl::Operation::Value.precision(data_array, value); self
   end
   
   def row(*args)
     return @row if args[0].nil?
     @row = args[0]
-    @data_array = [data_array[ args[0] ]]
+    self.data_array = [data_array[ args[0] ]]
     self
   end
   
@@ -111,8 +111,8 @@ module Operations
   def transform=(value)
     return false unless Quandl::Operation::Transform.valid?(value)
     @transform = value
-    @data_array = Quandl::Operation::Transform.perform( data_array, value )
-    @data_array
+    self.data_array = Quandl::Operation::Transform.perform( data_array, value )
+    self.data_array
   end
 
   def collapse(*args)
@@ -124,7 +124,7 @@ module Operations
     return false unless Quandl::Operation::Collapse.valid?(collapse)
     @collapse = collapse
     @frequency = collapse
-    @data_array = Quandl::Operation::Collapse.perform( data_array, collapse )
+    self.data_array = Quandl::Operation::Collapse.perform( data_array, collapse )
   end
   
   def frequency
@@ -135,7 +135,7 @@ module Operations
   end
   
   def clone
-    self.class.new( data_array.dup, headers: headers, cleaned: cleaned )
+    self.class.new( _attributes: attributes.clone )
   end
   
   def to_precision(value)

data/lib/quandl/data/validations.rb

@@ -2,40 +2,32 @@ module Quandl
 class Data
 module Validations
   
-  extend ActiveSupport::Concern
-
-  module ClassMethods
+  ERROR_TYPES = [ 
+    Error::GuessDateFormat,   Error::InvalidDate,
+    Error::UnknownDateFormat, Error::DateParseError,
+    CSV::MalformedCSVError ]
     
-  end
+  extend ActiveSupport::Concern
   
   included do
-    ERROR_TYPES = [ 
-      Error::GuessDateFormat,   Error::InvalidDate,
-      Error::UnknownDateFormat, Error::DateParseError,
-      CSV::MalformedCSVError ]
-  end
   
-  def valid?
-    raise_error_unless_valid!
-  rescue *ERROR_TYPES => error
-    self.errors << error
-    self.data_array = []
-    false
+    include ActiveModel::Validations
+  
+    validate :data_should_be_clean!
   end
   
-  def raise_error_unless_valid!
-    self.errors = []
-    self.data_array = pristine_data
+  def data_should_be_clean!
+    self.cleaned = false
+    self.data_array = clean(pristine_data)
     true
+    
+  rescue *ERROR_TYPES => err
+    self.errors.add( :data, err.to_s )
+    self.data_array = []
+    false
+    
   end
   
-  def errors
-    @errors ||= []
-  end
-  def errors=(value)
-    @errors = value
-  end
-
 end
 end
 end

data/lib/quandl/data/version.rb

@@ -1,5 +1,5 @@
 module Quandl
 class Data
-  VERSION = "1.3.9"
+  VERSION = File.read(File.expand_path(File.join(File.dirname(__FILE__), '../../../VERSION'))).strip.rstrip
 end
 end

data/lib/quandl/support.rb

@@ -0,0 +1 @@
+require 'quandl/support/attributes'

data/lib/quandl/support/attributes.rb

@@ -0,0 +1,82 @@
+require 'active_model'
+require "active_support/all"
+
+module Quandl
+module Support
+module Attributes
+  
+  extend ActiveSupport::Concern
+  
+  included do
+    extend ActiveModel::Callbacks
+    define_model_callbacks :initialize, only: [:after]
+  end
+  
+  module ClassMethods
+    
+    def inherited(subclass)
+      subclass.define_attributes(*attributes)
+      subclass.formatters = formatters.dup
+    end
+    
+    def define_attributes(*attribute_names)
+      attribute_names.each do |key|
+        define_attribute(key)
+      end
+    end
+
+    def attributes
+      @attributes ||= []
+    end
+
+    protected
+
+    def define_attribute(key)
+      key = key.to_s
+      attributes << key unless attributes.include?(key)
+      define_method( key ){ read_attribute(key) }
+      define_method( "#{key}=" ){ |value| write_attribute(key, value) }
+      define_method( "#{key}?" ){ !read_attribute(key).nil? }
+    end
+    
+  end
+  
+  def initialize(*args)
+    run_callbacks(:initialize) do
+      attrs = args.extract_options!
+      # apply _attributes directly to @attributes
+      @attributes = attrs[:_attributes].is_a?(Hash) ? attrs.delete(:_attributes) : {}
+      # apply attrs through write_attribute
+      self.attributes = attrs if attrs.is_a?(Hash)
+      # onwards
+      super(*args) if defined?(super)
+    end
+  end
+  
+  def attributes=(new_attrs)
+    new_attrs.stringify_keys.each do |attr_key, attr_value|
+      # skip those attributes that are not defined
+      next unless self.class.attributes.include?(attr_key) && self.respond_to?("#{attr_key}=")
+      # pass to the attribute writer
+      self.send( "#{attr_key}=", attr_value )
+    end
+  end
+  
+  def attributes
+    @attributes ||= {}
+  end
+  
+  protected
+  
+  def read_attribute(key)
+    @attributes[key.to_s]
+  end
+  
+  def write_attribute(key, value)
+    @attributes ||= {}
+    @attributes[key.to_s] = value
+  end
+  
+end
+end
+end

data/quandl_data.gemspec

@@ -19,6 +19,7 @@ Gem::Specification.new do |s|
 
   s.add_runtime_dependency "quandl_operation", "~> 0.3"
   s.add_runtime_dependency "quandl_babelfish", "~> 0.0"
+  s.add_runtime_dependency "activemodel", ">= 3.0.0"
   
   s.add_development_dependency "rake", "~> 10.0"
   s.add_development_dependency "rspec", "~> 2.13"
@@ -27,4 +28,5 @@ Gem::Specification.new do |s|
   s.add_development_dependency "simplecov"
   s.add_development_dependency "guard"
   s.add_development_dependency "guard-rspec"
+  s.add_development_dependency "quandl_utility"
 end

data/spec/lib/quandl/data/enumerator_spec.rb

@@ -10,7 +10,7 @@ describe Quandl::Data::Enumerator do
   its(:count){ should eq 4 }
 
   describe "#==" do
-    it{ should eq data.data_array }
+    it{ should eq data.to_a }
   end
 
   [nil, :to_jd, :to_date].each do |date_format|

data/spec/lib/quandl/data/operations_spec.rb

@@ -86,13 +86,13 @@ describe Quandl::Data::Operations do
   
   describe "#to_json" do
     it "should convert the data_array to json and back" do
-      JSON.parse(subject.to_json).should eq JSON.parse(subject.data_array.to_json)
+      JSON.parse(subject.to_json).should eq JSON.parse(subject.send(:data_array).to_json)
     end
   end
   
   describe "#as_json" do
     it "should be a representation of data_array" do
-      subject.as_json.should eq subject.data_array.as_json
+      subject.as_json.should eq subject.send(:data_array).as_json
     end
   end
   
@@ -102,7 +102,7 @@ describe Quandl::Data::Operations do
       data = Quandl::Fabricate::Data.rand( nils: false, rows: 10, columns: 1 ).sort_descending
       date = data[1][0]
       data.trim_end!(date)
-      data.data_array.should be_a Array
+      data.send(:data_array).should be_a Array
       data.count.should eq 9
     end
   

data/spec/lib/quandl/data_spec.rb

@@ -50,7 +50,7 @@ describe Quandl::Data do
     subject{ Quandl::Data.new(malformed_csv) }
     before(:each){ subject.valid? }
     its(:valid?){ should be_false }
-    its('errors.to_s'){ should eq "[#<CSV::MalformedCSVError: Illegal quoting in line 1.>]" }
+    its('errors.messages'){ should eq({:data=>["Illegal quoting in line 1."]}) }
   end
   
   [:to_jd, :sort_ascending, :sort_descending, :to_date_str].each do |o1|

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: quandl_data
 version: !ruby/object:Gem::Version
-  version: 1.3.9
+  version: 1.4.0
 platform: ruby
 authors:
 - Blake Hilscher
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-02-05 00:00:00.000000000 Z
+date: 2014-03-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: quandl_operation
@@ -38,6 +38,20 @@ dependencies:
     - - ~>
       - !ruby/object:Gem::Version
         version: '0.0'
+- !ruby/object:Gem::Dependency
+  name: activemodel
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 3.0.0
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -136,6 +150,20 @@ dependencies:
     - - '>='
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: quandl_utility
+  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: Data will be interfaced
 email:
 - blake@hilscher.ca
@@ -153,10 +181,10 @@ files:
 - README.md
 - Rakefile
 - UPGRADE.md
+- VERSION
 - lib/quandl/data.rb
 - lib/quandl/data/attributes.rb
 - lib/quandl/data/cleaning.rb
-- lib/quandl/data/enumerator.rb
 - lib/quandl/data/format.rb
 - lib/quandl/data/logging.rb
 - lib/quandl/data/operations.rb
@@ -165,6 +193,8 @@ files:
 - lib/quandl/error/date_parse_error.rb
 - lib/quandl/fabricate.rb
 - lib/quandl/fabricate/data.rb
+- lib/quandl/support.rb
+- lib/quandl/support/attributes.rb
 - quandl_data.gemspec
 - spec/lib/fabricate/data_spec.rb
 - spec/lib/quandl/data/enumerator_spec.rb

data/lib/quandl/data/enumerator.rb

@@ -1,24 +0,0 @@
-module Quandl::Data::Enumerator
-  extend ActiveSupport::Concern
-  
-  included do
-    delegate *Array.forwardable_methods, to: :data_array
-  
-    delegate :to_json, :as_json, to: :data_array
-    
-    attr_accessor :pristine_data
-  end
-  
-  def data_array
-    @data_array ||= clean( pristine_data )
-  end
-
-  def data_array=(data)
-    @data_array = clean(data)
-  end
-  
-  def data_array?
-    @data_array.present?
-  end
-
-end