quandl_format 0.3.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d3736904b3e0d1c5ee9b90ebfaca235563775f56
-  data.tar.gz: f12745b06559794e379a999280cb4e6c28ea01ae
+  metadata.gz: 7189ebd211ad89843f508a2c8f250f5fa861c699
+  data.tar.gz: 3eb2d90fab9ec9ded6afcfd1a9f37f8aabd4103d
 SHA512:
-  metadata.gz: 3537467133b0cb0f5b89732974bc034b2c5198970d2b215789a53d2a714ce63a8d09665b0d0afcd6a8b424404e07e7cdb199f34f3fe187ab8ec621ad4facc1d0
-  data.tar.gz: a4ad1d3c31abd11d3ee0a493f1e3126f28db56d6b7d124aec9825b48465b046ce3edabbd41aa596f71e88c89a51d8575f39a3695c49fdd80c423c3a17fbfbfc9
+  metadata.gz: 21c433bfc641a0d32700d5797c7f7640e210f134d12aa7b7d0d39b72441280766fa80744040475062fd758a550245c1c2d1e3811239c44deb25ff130231f6f4a
+  data.tar.gz: 3eda4b6c2e8ec8cde35b9935948bd7295a485b6431bdcf28bff20242d11414a17c161597da6501ee134dafeacfa243059746242ca4fc620d2cc66fc3f7a80f5f

data/README.md

@@ -1,2 +1,53 @@
 # Quandl::Format
 
+## Purpose
+
+Load and dump [quandl data format](http://www.quandl.com/help/toolbelt#Quandl-Flavored-CSV).
+
+
+## Installation
+
+```ruby
+gem 'quandl_format'
+```
+
+
+## Configuration
+
+Add this to your Rakefile:
+
+```ruby
+require 'quandl/format'
+```
+
+
+## Usage
+
+
+#### Load
+
+```ruby
+# open a file
+file = File.open("spec/fixtures/data/annual.qdf")
+# read each line of the file until a dataset node has been built
+# pass each dataset node to the block for manipulation
+Quandl::Format::Dataset.each_line(file) do |dataset|
+  puts "full_code: #{dataset.full_code}"
+  puts "first_line_of_data: #{dataset.data.first.to_s}"
+end
+```
+
+
+#### Dump
+
+```ruby
+# load the file as a collection of Dataset instances
+datasets = Quandl::Format::Dataset.load_from_file("spec/fixtures/data/annual.qdf")
+# make some changes
+dataset = datasets.first
+dataset.code = 'NEW_CODE'
+# dump the collection as QDF
+puts Quandl::Format::Dataset.dump( [dataset] )
+```
+
+

data/Rakefile

@@ -19,6 +19,7 @@ end
 require 'quandl/utility/rake_tasks'
 Quandl::Utility::Tasks.configure do |c|
   c.name              = 'quandl_format'
+  c.tag_prefix        = 'v'
   c.version_path      = 'VERSION'
   c.changelog_path    = 'UPGRADE.md'
   c.changelog_matching  = ['^QUGC','^WIKI']

data/UPGRADE.md

@@ -1,3 +1,9 @@
+## 0.4.0 
+
+* QUGC-123 Use client#valid? since it has been refactored to check everything.
+
+
+
 ## 0.3.0 
 
 * QUGC-104 bump gems to get onboard with new validations and error handling

data/VERSION

@@ -1 +1 @@
-0.3.0
+0.4.0

data/lib/quandl/client/dataset/to_qdf.rb

@@ -4,6 +4,7 @@ module Client
 class Dataset
   
   def to_qdf
+    return if !exists? && status != 0
     Quandl::Format::Dataset.new( qdf_attributes ).to_qdf
   end
   

data/lib/quandl/client/superset/to_qdf.rb

@@ -0,0 +1,15 @@
+module Quandl
+module Client
+class Superset
+  
+  def to_qdf
+    return unless exists?
+    out = attributes.stringify_keys.to_hash.to_yaml[4..-1]
+    out += Quandl::Format::Superset::Node.syntax[:end_of_node]
+    out += "\n"
+    out
+  end
+  
+end
+end
+end

data/lib/quandl/format/abstract/node.rb

@@ -0,0 +1,87 @@
+module Quandl
+module Format
+class Abstract
+class Node
+  
+  cattr_accessor :syntax, instance_reader: true
+  
+  self.syntax = {
+    comment:          '#',
+    end_of_node:      '-',
+  }
+    
+  attr_accessor :block, :line, :lines
+  
+  def initialize(*args)
+    # options
+    opts = args.extract_options!.symbolize_keys!
+    # assign options
+    self.line = opts[:line].to_i if opts[:line].present?
+    self.block = opts[:block]
+  end
+  
+  def add(value)
+    increment_line
+    # clean the value
+    value = clean(value)
+    # does this mark the end of the node?
+    return close if end_of_node?(value)
+    # handle the new line
+    add_to_lines(value)
+    # onwards
+    self
+  end
+  
+  def close
+    # pass the node to the block
+    block.call(self) unless lines.blank?
+    # return a new node
+    self.class.new( line: line, block: block )
+  end
+  
+  def line
+    @line ||= 0
+  end
+  
+  def lines
+    @lines ||= []
+  end
+  
+  def as_json
+    YAML.load(lines.join("\n"))
+  end
+  
+  protected
+  
+  def increment_line
+    self.line += 1
+  end
+  
+  def add_to_lines(value)
+    # ignore comments
+    return false if comment?(value)
+    # otherwise append the value
+    lines << value
+  end
+  
+  def end_of_node?(value)
+    syntax_matches?( :end_of_node, value )
+  end
+  
+  def comment?(value)
+    value.blank? || syntax_matches?(:comment, value)
+  end
+  
+  def syntax_matches?(key, value)
+    syn = syntax[key]
+    value.to_s[ 0..(syn.length) ] == syn
+  end
+  
+  def clean(value)
+    value.to_s.strip.rstrip
+  end
+  
+end
+end
+end
+end

data/lib/quandl/format/abstract.rb

@@ -0,0 +1,53 @@
+require 'quandl/format/abstract/node'
+
+module Quandl
+module Format
+class Abstract
+
+  class << self
+    
+    def load(interface)
+      output = []
+      foreach(interface){|n| output << n }
+      output
+    end
+    
+    def foreach(interface, &block)
+      each_line_as_node(interface) do |node|
+        call_and_catch_block(node, &block)
+      end
+    end
+    
+    def each_line_as_node(interface, &block)
+      # initialize an empty node
+      node = self::Node.new( block: block )
+      # for each_line of the interface
+      interface.each_line do |line|
+        # add the line to the node
+        node = node.add( line )
+      end
+      # we're done
+      node.close
+    end
+    
+    
+    protected
+    
+    def call_and_catch_block(node, &block)
+      # convert the node to an instance of superset
+      node = before_call(node)
+      # pass the superset to the block
+      block.call( node )
+    rescue Exception => error
+      block.call( error )
+    end
+    
+    def before_call(node)
+      node
+    end
+     
+  end
+  
+end
+end
+end

data/lib/quandl/format/dataset/client.rb

@@ -47,7 +47,7 @@ module Client
   protected
   
   def client_should_be_valid!
-    if !client.valid_with_server?
+    if !client.valid?
       client.errors.each{|err, value| self.errors.add( err, value ) }
       return false 
     end

data/lib/quandl/format/dataset.rb

@@ -1,3 +1,5 @@
+require 'quandl/client/dataset/to_qdf'
+
 module Quandl
 module Format
 

data/lib/quandl/format/superset/node.rb

@@ -0,0 +1,12 @@
+module Quandl
+module Format
+class Superset
+  
+class Node < Quandl::Format::Abstract::Node
+  
+  self.syntax[:end_of_node] = '---'
+  
+end
+end
+end
+end

data/lib/quandl/format/superset.rb

@@ -0,0 +1,16 @@
+require 'quandl/client/superset/to_qdf'
+
+module Quandl
+module Format
+
+class Superset < Quandl::Format::Abstract
+
+  require 'quandl/format/superset/node'
+  
+  def self.before_call(node)
+    Quandl::Client::Superset.new( node.as_json )
+  end
+
+end
+end
+end

data/lib/quandl/format.rb

@@ -15,8 +15,9 @@ require "active_support/core_ext/object"
 require 'quandl/error/column_count_mismatch'
 require 'quandl/error/unknown_attribute'
 
+require 'quandl/format/abstract'
 require 'quandl/format/dataset'
-require 'quandl/client/dataset/to_qdf'
+require 'quandl/format/superset'
 
 module Quandl
   module Format

data/quandl_format.gemspec

@@ -17,7 +17,7 @@ Gem::Specification.new do |s|
   s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
   s.require_paths = ["lib"]
   
-  s.add_runtime_dependency "quandl_client", "~> 2.6"
+  s.add_runtime_dependency "quandl_client", "~> 2.7"
   
   s.add_development_dependency "rake", "~> 10.0"
   s.add_development_dependency "rspec", "~> 2.13"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: quandl_format
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.4.0
 platform: ruby
 authors:
 - Blake Hilscher
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-03-05 00:00:00.000000000 Z
+date: 2014-03-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: quandl_client
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: '2.6'
+        version: '2.7'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: '2.6'
+        version: '2.7'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -153,14 +153,19 @@ files:
 - VERSION
 - examples/load.rb
 - lib/quandl/client/dataset/to_qdf.rb
+- lib/quandl/client/superset/to_qdf.rb
 - lib/quandl/error/column_count_mismatch.rb
 - lib/quandl/error/unknown_attribute.rb
 - lib/quandl/format.rb
+- lib/quandl/format/abstract.rb
+- lib/quandl/format/abstract/node.rb
 - lib/quandl/format/dataset.rb
 - lib/quandl/format/dataset/attributes.rb
 - lib/quandl/format/dataset/client.rb
 - lib/quandl/format/dataset/dump.rb
 - lib/quandl/format/dataset/load.rb
+- lib/quandl/format/superset.rb
+- lib/quandl/format/superset/node.rb
 - lib/quandl/format/version.rb
 - quandl_format.gemspec
 - spec/config/client.rb