moving_average 0.0.2 → 0.0.3

data/lib/moving_average/moving_average.rb

@@ -1,5 +1,15 @@
 class Array
 
+  def idx_and_tail_or_defaults(idx, tail)
+    if tail.nil?
+      tail = self.size
+      if idx.nil?
+        idx = self.size - 1
+      end
+    end
+    [idx, tail]
+  end; private :idx_and_tail_or_defaults
+
   def valid_for_ma(idx, tail)
     unless idx >= 0 && idx < self.size
       raise MovingAverage::Errors::InvalidIndexError
@@ -13,7 +23,8 @@ class Array
     true
   end; private :valid_for_ma
 
-  def exponential_moving_average(idx, tail)
+  def exponential_moving_average(idx=nil, tail=nil)
+    idx, tail = idx_and_tail_or_defaults(idx, tail)
     valid_for_ma(idx, tail)
     # Taken from
     #   http://en.wikipedia.org/wiki/Moving_average#Exponential_moving_average
@@ -27,13 +38,15 @@ class Array
   end
   alias_method :ema, :exponential_moving_average
 
-  def simple_moving_average(idx, tail)
+  def simple_moving_average(idx=nil, tail=nil)
+    idx, tail = idx_and_tail_or_defaults(idx, tail)
     valid_for_ma(idx, tail)
     self[idx-tail+1..idx].sum.to_f / tail
   end
   alias_method :sma, :simple_moving_average
 
-  def weighted_moving_average(idx, tail)
+  def weighted_moving_average(idx=nil, tail=nil)
+    idx, tail = idx_and_tail_or_defaults(idx, tail)
     valid_for_ma(idx, tail)
     # Taken from
     #   http://en.wikipedia.org/wiki/Moving_average#Weighted_moving_average

data/lib/moving_average/version.rb

@@ -1,3 +1,3 @@
 module MovingAverage
-  VERSION = '0.0.2'
+  VERSION = '0.0.3'
 end

data/spec/moving_average_spec.rb

@@ -2,46 +2,84 @@ require 'moving_average'
 
 describe MovingAverage do
 
-  it "exponential moving average should work for valid arguments" do
+  describe "exponential moving average" do
+
     # Example taken from
     #   http://stockcharts.com/school/doku.php?id=chart_school:technical_indicators:moving_averages
-    a = [22.27, 22.19, 22.08, 22.17, 22.18, 22.13, 22.23, 22.43, 22.24, 22.29]
-    a.exponential_moving_average(9, 10).round(3).should eql(22.247)
-    a.ema(9, 10).round(3).should eql(22.247)
-  end
+    EMA_DATA = [22.27, 22.19, 22.08, 22.17, 22.18, 22.13, 22.23, 22.43, 22.24, 22.29].freeze
+    EMA = 22.247
 
-  it "exponential moving average should raise NotEnoughDataError for invalid arguments" do
-    expect { [1, 2, 3].exponential_moving_average(-1, 3) }.to raise_exception(MovingAverage::Errors::InvalidIndexError, "Given idx is outside the Array.")
-    expect { [1, 2, 3].exponential_moving_average(3, 3) }.to raise_exception(MovingAverage::Errors::InvalidIndexError, "Given idx is outside the Array.")
-    expect { [1, 2, 3].exponential_moving_average(1, -1) }.to raise_exception(MovingAverage::Errors::InvalidTailError, "Given tail is <= 0.")
-    expect { [1, 2, 3].exponential_moving_average(1, 3) }.to raise_exception(MovingAverage::Errors::NotEnoughDataError, "Given tail is too large for idx.")
-  end
+    it "should work for missing arguments" do
+      EMA_DATA.exponential_moving_average.round(3).should eql(EMA)
+      EMA_DATA.ema.round(3).should eql(EMA)
+      EMA_DATA.exponential_moving_average(9).round(3).should eql(EMA)
+      EMA_DATA.ema(9).round(3).should eql(EMA)
+    end
+
+    it "should work for valid arguments" do
+      # Example taken from
+      #   http://stockcharts.com/school/doku.php?id=chart_school:technical_indicators:moving_averages
+      EMA_DATA.exponential_moving_average(9, 10).round(3).should eql(EMA)
+      EMA_DATA.ema(9, 10).round(3).should eql(EMA)
+    end
+
+    it "should raise proper errors for invalid arguments" do
+      expect { [1, 2, 3].exponential_moving_average(-1, 3) }.to raise_exception(MovingAverage::Errors::InvalidIndexError, "Given idx is outside the Array.")
+      expect { [1, 2, 3].exponential_moving_average(3, 3) }.to raise_exception(MovingAverage::Errors::InvalidIndexError, "Given idx is outside the Array.")
+      expect { [1, 2, 3].exponential_moving_average(1, -1) }.to raise_exception(MovingAverage::Errors::InvalidTailError, "Given tail is <= 0.")
+      expect { [1, 2, 3].exponential_moving_average(1, 3) }.to raise_exception(MovingAverage::Errors::NotEnoughDataError, "Given tail is too large for idx.")
+    end
 
-  it "simple moving average should work" do
-    (1..5).to_a.simple_moving_average(4, 5).should ==(3)
-    (1..5).to_a.sma(4, 5).should ==(3)
   end
 
-  it "simple moving average should raise proper errors for invalid arguments" do
-    expect { [1, 2, 3].simple_moving_average(-1, 3) }.to raise_exception(MovingAverage::Errors::InvalidIndexError, "Given idx is outside the Array.")
-    expect { [1, 2, 3].simple_moving_average(3, 3) }.to raise_exception(MovingAverage::Errors::InvalidIndexError, "Given idx is outside the Array.")
-    expect { [1, 2, 3].simple_moving_average(1, -1) }.to raise_exception(MovingAverage::Errors::InvalidTailError, "Given tail is <= 0.")
-    expect { [1, 2, 3].simple_moving_average(1, 3) }.to raise_exception(MovingAverage::Errors::NotEnoughDataError, "Given tail is too large for idx.")
+  describe "simple moving average" do
+
+    it "should work for missing arguments" do
+      (1..5).to_a.simple_moving_average.should ==(3)
+      (1..5).to_a.sma.should ==(3)
+      (1..5).to_a.simple_moving_average(4).should ==(3)
+      (1..5).to_a.sma(4).should ==(3)
+    end
+
+    it "should work for valid arguments" do
+      (1..5).to_a.simple_moving_average(4, 5).should ==(3)
+      (1..5).to_a.sma(4, 5).should ==(3)
+    end
+
+    it "should raise proper errors for invalid arguments" do
+      expect { [1, 2, 3].simple_moving_average(-1, 3) }.to raise_exception(MovingAverage::Errors::InvalidIndexError, "Given idx is outside the Array.")
+      expect { [1, 2, 3].simple_moving_average(3, 3) }.to raise_exception(MovingAverage::Errors::InvalidIndexError, "Given idx is outside the Array.")
+      expect { [1, 2, 3].simple_moving_average(1, -1) }.to raise_exception(MovingAverage::Errors::InvalidTailError, "Given tail is <= 0.")
+      expect { [1, 2, 3].simple_moving_average(1, 3) }.to raise_exception(MovingAverage::Errors::NotEnoughDataError, "Given tail is too large for idx.")
+    end
   end
 
-  it "weighted moving average should work" do
+  describe "weighted moving average" do
+
     # Example taken from
     #   http://daytrading.about.com/od/indicators/a/MovingAverages.htm
-    vals = [1.2900, 1.2900, 1.2903, 1.2904]
-    vals.weighted_moving_average(3, 4).should eql(1.29025)
-    vals.wma(3, 4).should eql(1.29025)
-  end
+    WMA_DATA = [1.2900, 1.2900, 1.2903, 1.2904].freeze
+    WMA = 1.29025
+
+    it "should work for missing arguments" do
+      WMA_DATA.weighted_moving_average.should eql(WMA)
+      WMA_DATA.wma.should eql(WMA)
+      WMA_DATA.weighted_moving_average(3).should eql(WMA)
+      WMA_DATA.wma(3).should eql(WMA)
+    end
+
+    it "should work for valid arguments" do
+      WMA_DATA.weighted_moving_average(3, 4).should eql(WMA)
+      WMA_DATA.wma(3, 4).should eql(WMA)
+    end
+
+    it "should raise proper errors for invalid arguments" do
+      expect { [1, 2, 3].weighted_moving_average(-1, 3) }.to raise_exception(MovingAverage::Errors::InvalidIndexError, "Given idx is outside the Array.")
+      expect { [1, 2, 3].weighted_moving_average(3, 3) }.to raise_exception(MovingAverage::Errors::InvalidIndexError, "Given idx is outside the Array.")
+      expect { [1, 2, 3].weighted_moving_average(1, -1) }.to raise_exception(MovingAverage::Errors::InvalidTailError, "Given tail is <= 0.")
+      expect { [1, 2, 3].weighted_moving_average(1, 3) }.to raise_exception(MovingAverage::Errors::NotEnoughDataError, "Given tail is too large for idx.")
+    end
 
-  it "weighted moving average should raise proper errors for invalid arguments" do
-    expect { [1, 2, 3].weighted_moving_average(-1, 3) }.to raise_exception(MovingAverage::Errors::InvalidIndexError, "Given idx is outside the Array.")
-    expect { [1, 2, 3].weighted_moving_average(3, 3) }.to raise_exception(MovingAverage::Errors::InvalidIndexError, "Given idx is outside the Array.")
-    expect { [1, 2, 3].weighted_moving_average(1, -1) }.to raise_exception(MovingAverage::Errors::InvalidTailError, "Given tail is <= 0.")
-    expect { [1, 2, 3].weighted_moving_average(1, 3) }.to raise_exception(MovingAverage::Errors::NotEnoughDataError, "Given tail is too large for idx.")
   end
 
 end

metadata

@@ -1,48 +1,40 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: moving_average
-version: !ruby/object:Gem::Version 
-  hash: 27
+version: !ruby/object:Gem::Version
+  version: 0.0.3
   prerelease: 
-  segments: 
-  - 0
-  - 0
-  - 2
-  version: 0.0.2
 platform: ruby
-authors: 
+authors:
 - Brad Cater
 autorequire: 
 bindir: bin
 cert_chain: []
-
-date: 2013-03-16 00:00:00 -04:00
-default_executable: 
-dependencies: 
-- !ruby/object:Gem::Dependency 
+date: 2013-03-17 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
   name: rspec
-  prerelease: false
-  requirement: &id001 !ruby/object:Gem::Requirement 
+  requirement: !ruby/object:Gem::Requirement
     none: false
-    requirements: 
+    requirements:
     - - ~>
-      - !ruby/object:Gem::Version 
-        hash: 25
-        segments: 
-        - 2
-        - 13
-        version: "2.13"
+      - !ruby/object:Gem::Version
+        version: '2.13'
   type: :development
-  version_requirements: *id001
-description: This gem adds methods to the Array class to compute different types of moving averages.
-email: 
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.13'
+description: This gem adds methods to the Array class to compute different types of
+  moving averages.
+email:
 - bradcater@gmail.com
 executables: []
-
 extensions: []
-
 extra_rdoc_files: []
-
-files: 
+files:
 - .gitignore
 - Gemfile
 - LICENSE
@@ -54,39 +46,30 @@ files:
 - lib/moving_average/version.rb
 - moving_average.gemspec
 - spec/moving_average_spec.rb
-has_rdoc: true
-homepage: ""
+homepage: ''
 licenses: []
-
 post_install_message: 
 rdoc_options: []
-
-require_paths: 
+require_paths:
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement 
+required_ruby_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      hash: 3
-      segments: 
-      - 0
-      version: "0"
-required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      hash: 3
-      segments: 
-      - 0
-      version: "0"
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
 requirements: []
-
 rubyforge_project: 
-rubygems_version: 1.6.2
+rubygems_version: 1.8.23
 signing_key: 
 specification_version: 3
-summary: This gem adds methods to the Array class to compute different types of moving averages.
-test_files: 
+summary: This gem adds methods to the Array class to compute different types of moving
+  averages.
+test_files:
 - spec/moving_average_spec.rb