datamix 0.0.2 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a8a6ea13859c50d3385c273c2bbfd87fb5828977
-  data.tar.gz: 67d4a65967bdd2a3b979db246ae28ebdc17665e0
+  metadata.gz: 2e25311621834c0792028b34973e716c1dc0bce2
+  data.tar.gz: df08942707700a403c16e55bf0cd39659520ec7c
 SHA512:
-  metadata.gz: 6c52d6bf99769dfe22b293c2d439b76d0d261afca936f0e8387f80c8f223b52ecb825231485599c8f1b12916bc06520efa37fd591a4fb6cd2f6352ad7dc062d8
-  data.tar.gz: c70e97e9dd7df50418f9542e4ae932a5fa23230035186df2dab322ec7dc507595cf9541ac30c7dd725e307769d4883a56c924185d1e68d10d649879706ea5550
+  metadata.gz: 643e11e9a83a4c498ca2c042b59780eed0e95a26f07cb6f2624e294b78812c6abeb6669bc897cccb21b65119d906f751b3f671e4696b7d90b802df9a0399d933
+  data.tar.gz: 1c9dc5162696b3b6de6110bee2d0cf183ceec3f913186bc7887554a6d716255212b4761514da3762866b1a668d41c0f55ac2d1a98183d5d86265d36948a82e58

data/README.md

@@ -8,8 +8,8 @@ DataMix - DSL for manipulating tabular data
 
 ---
 
-This library refines Ruby's [`CSV::Table`][1] and `Array` object to provide a DSL
-for manipulating tabular data.
+This library refines Ruby's [`CSV::Table`][1] and `Array` objects to provide 
+a DSL for manipulating tabular data.
 
 ---
 
@@ -29,17 +29,61 @@ gem 'datamix'
 
 
 
-Usage
+Example Usage
 --------------------------------------------------
 
-Require the library and enable the refinements with `using DataMix`:
-
 ```ruby
 require 'datamix'
 using DataMix
+
+# Load data (this is a shortcut to load a CSV::Table object)
+sp500 = file 'sp500.csv'
+vix   = file 'vix.csv'
+
+# Keep only desired columns, rename and round data
+sp500.keep :date, :adjusted_close
+sp500.rename :adjusted_close, to: :close
+sp500.round :close, decimals: 2
+
+# Calculate a Change column, based on the Close column and round
+sp500[:change] = sp500[:close] - sp500[:close].prev
+sp500.round :change, decimals: 2
+
+# Keep only desired columns and rename
+vix.keep :date, :adjusted_close
+vix.rename :adjusted_close, to: :vix
+
+# Join the two tables
+sp500.join vix, on: :date
+
+# Remove all rows that have any empty value
+sp500.delete_empty_rows
+
+# Save and preview
+sp500.save_as 'output.csv'
+sp500.preview
+
+# Output
+# +------------+---------+--------+-------+
+# | date       | close   | change | vix   |
+# +------------+---------+--------+-------+
+# | 2015-03-12 | 2065.95 | 25.71  | 15.42 |
+# | 2015-03-13 | 2053.4  | -12.55 | 16.0  |
+# | 2015-03-16 | 2081.19 | 27.79  | 15.61 |
+# | 2015-03-17 | 2074.28 | -6.91  | 15.66 |
+# | 2015-03-18 | 2099.5  | 25.22  | 13.97 |
+# | 2015-03-19 | 2089.27 | -10.23 | 14.07 |
+# | 2015-03-20 | 2108.1  | 18.83  | 13.02 |
+# | 2015-03-23 | 2104.42 | -3.68  | 13.41 |
+# | 2015-03-24 | 2091.5  | -12.92 | 13.62 |
+# | 2015-03-25 | 2061.05 | -30.45 | 15.44 |
+# +------------+---------+--------+-------+
 ```
 
-TODO: Complete documentation.
+Examples
+--------------------------------------------------
 
+See the [examples index][2] for more examples.
 
 [1]: https://ruby-doc.org/stdlib-2.3.1/libdoc/csv/rdoc/CSV/Table.html
+[2]: https://github.com/DannyBen/datamix/tree/master/examples#examples-index

data/lib/datamix/refinements/array.rb

@@ -1,43 +1,19 @@
 module DataMix
   refine Array do
     def -(other)
-      if other.respond_to? :each
-        each_with_index do |val, index|
-          self[index] = other[index] ? val - other[index] : nil
-        end
-      else
-        map { |val| val - other }
-      end
+      math_operation(other) { |left, right| left - right }
     end
 
     def +(other)
-      if other.respond_to? :each
-        each_with_index do |val, index|
-          self[index] = other[index] ? val + other[index] : nil
-        end
-      else
-        map { |val| val + other }
-      end
+      math_operation(other) { |left, right| left + right }
     end
 
     def *(other)
-      if other.respond_to? :each
-        each_with_index do |val, index|
-          self[index] = other[index] ? val * other[index] : nil
-        end
-      else
-        map { |val| val * other }
-      end
+      math_operation(other) { |left, right| left * right }
     end
 
     def /(other)
-      if other.respond_to? :each
-        each_with_index do |val, index|
-          self[index] = other[index] ? val / other[index].to_f : nil
-        end
-      else
-        map { |val| val / other.to_f }
-      end
+      math_operation(other) { |left, right| left / right.to_f }
     end
 
     def offset(rows)
@@ -53,6 +29,10 @@ module DataMix
       offset rows
     end
 
+    def next(rows=1)
+      offset -rows
+    end
+
     def round(decimals=0)
       map { |val| val ? val.round(decimals) : nil }
     end
@@ -69,5 +49,17 @@ module DataMix
       Array.new(window_size-1).concat result
     end
 
+    private
+
+    def math_operation(other)
+      if other.respond_to? :each
+        each_with_index do |val, index|
+          self[index] = other[index] ? yield(val, other[index]) : nil
+        end
+      else
+        map { |val| yield(val, other) }
+      end
+    end
+
   end
 end

data/lib/datamix/refinements/csv_table.rb

@@ -39,11 +39,13 @@ module DataMix
       raise CSVError, "source[#{on}] is not unique" unless by_col[on].uniq?
       raise CSVError, "other[#{on}] is not unique" unless other.by_col[on].uniq?
 
+      original_headers = headers.dup
+
       by_row.each do |row|
         other_row = other.find { |r| r[on] == row[on] }
         other.headers.each do |col|
           next if col == on
-          new_col = headers.include?(col) ? "_#{col}" : col
+          new_col = original_headers.include?(col) ? "_#{col}" : col
           row[new_col] = other_row ? other_row[col] : nil
         end
       end

data/lib/datamix/version.rb

@@ -1,3 +1,3 @@
 module DataMix
-  VERSION = "0.0.2"
+  VERSION = "0.0.3"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: datamix
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
 platform: ruby
 authors:
 - Danny Ben Shitrit
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-03-03 00:00:00.000000000 Z
+date: 2017-03-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: terminal-table
@@ -136,6 +136,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.10'
+- !ruby/object:Gem::Dependency
+  name: filewatcher
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.5'
 description: DSL for manipulating tabular data
 email: db@dannyben.com
 executables: []