energy_market 0.0.4

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: a226c96bc53007cdb23c9c9f1d3dd22207eecd39
+  data.tar.gz: 531b336f09b2c17860fbfe5c175bd14a7a3f10fc
+SHA512:
+  metadata.gz: f9ec2c23c234e0663b8c4aeec61e039afaf61e7c168fa6e9a8cd72d5a18778ad9a937fadee99c5ff3bb10946be32fd6dc1bc5fff175fe5fef3a230e48cd379e7
+  data.tar.gz: 9d38e26e8e2bf449b38c40ff3bdaa279d584c8eefadf7f7d1b6af076e9e9ae2121abe1d674fa6e0300dc1dd570bdae0ba485a3a96a1982242d58d49233692fea

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 1.9.3
+  - 2.0.0

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in energy_market.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Iwan Buetti
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,32 @@
+# EnergyMarket
+
+[![Build Status](https://travis-ci.org/iwan/energy_market.png)](https://travis-ci.org/iwan/energy_market)
+[![Code Climate](https://codeclimate.com/repos/52a049e813d637419e007ea3/badges/4494ed8a31e52b80f8d7/gpa.png)](https://codeclimate.com/repos/52a049e813d637419e007ea3/feed)
+
+TODO: Write a gem description
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'energy_market'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install energy_market
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,9 @@
+require "bundler/gem_tasks"
+require 'rake/testtask'
+
+Rake::TestTask.new do |t|
+  t.libs << 'test'
+end
+
+desc "Run tests"
+task :default => :test

data/energy_market.gemspec

@@ -0,0 +1,28 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'energy_market/version'
+require 'date' # used for get Date.today 
+
+Gem::Specification.new do |spec|
+  spec.name          = "energy_market"
+  spec.version       = EnergyMarket::VERSION
+  spec.authors       = ["Iwan Buetti"]
+  spec.email         = ["iwan.buetti@gmail.com"]
+  spec.description   = "No description"
+  spec.summary       = "Collection of classes used for energy (electricity and gas) market monitoring and calculation"
+  spec.homepage      = "https://github.com/iwan/energy_market"
+  spec.license       = "MIT"
+  spec.date          = Date.today.to_s
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+
+  spec.add_dependency('activesupport', '~> 3.2')
+  spec.add_dependency('tzinfo', '~> 0.3.29') # '~> 1.1.0'
+end

data/lib/energy_market/energy_market.rb

@@ -0,0 +1,9 @@
+
+module EnergyMarket
+
+
+
+
+end
+
+

data/lib/energy_market/my_util.rb

@@ -0,0 +1,29 @@
+module EnergyMarket
+  module MyUtil
+    
+    # Return the max value of the arguments
+    # Use: max_among(4,9) or max_among(4,9,-6,2)
+    def max_among(*arr)
+      return nil if arr.nil? || arr.empty?
+      arr = arr.first if arr.first.is_a?(Array)
+      arr.max
+    end
+
+    # Return the min value of the arguments
+    # Use: min_among(4,9) or min_among(4,9,-6,2)
+    def min_among(*arr)
+      return nil if arr.nil? || arr.empty?
+      arr = arr.first if arr.first.is_a?(Array)
+      arr.min
+    end
+  end
+  
+end
+
+# include EnergyMarket::MyUtil
+
+# puts max_among(3.4, 3, 2, 5.8)
+# puts max_among()
+# puts max_among nil
+
+# puts max_among([3.4, 3, 2, 5.8])

data/lib/energy_market/values_array.rb

@@ -0,0 +1,6 @@
+module EnergyMarket
+  
+  class ValuesArray < Array
+    
+  end
+end

data/lib/energy_market/vector.rb

@@ -0,0 +1,353 @@
+require 'active_support/core_ext/time/zones'
+require 'active_support/core_ext/time/calculations'
+require 'active_support/core_ext/numeric/time'
+
+module EnergyMarket
+
+  class Vector
+    include EnergyMarket::MyUtil
+
+    attr_reader :start_time, :v, :step
+    @@valid_units = [:hour, :day, :month, :year]
+
+
+    def initialize(start_time=nil, options={})
+      options = {:unit => :hour}.merge(options)
+      Time.zone = options[:zone] if options[:zone]
+      
+      @start_time = floor_start_time(read_start_time(start_time), options[:unit])
+      empty_data
+    end
+
+
+    # Clone the current object
+    def clone
+      @v.nil? ? Vector.new(@start_time) : Vector.new(@start_time).data(@v.clone)
+    end
+
+
+    # Set the array of values. You can define the unit (granularity) of those data.
+    # By default the unit is :hour
+    def data(data, unit=:hour)
+      unit = unit.to_sym
+      data = [data] unless data.is_a? Array
+      empty_data
+      validate_unit unit
+      start_time = (@start_time.nil? ? nil : @start_time.clone)
+
+      # the values are always stored as hour values
+      if unit==:hour
+        @v = data
+      else
+        prev_value = start_time.send(unit)
+        data.each do |v|
+          while start_time.send(unit)==prev_value
+            @v << v
+            start_time+=1.hour
+          end
+          prev_value = start_time.send(unit)
+        end
+      end
+      self
+    end
+
+
+    def set_all_to(value)
+      @v = @v.map{|e| e=value}
+    end
+
+
+    # get the sum of the values
+    def sum(options = {})
+      if options[:values]
+        case options[:values]
+        when :positive, :not_negative
+          @v.inject(0.0){|total, n| total + (n>0.0 ? n : 0.0) }
+        when :negative, :not_positive
+          @v.inject(0.0){|total, n| total + (n<0.0 ? n : 0.0) }
+        when :zero
+          0.0
+        when :all, :not_zero
+          sum_all_elements  
+        else
+          raise ArgumentError, "Option not recognized"
+        end
+      else
+        sum_all_elements
+      end
+    end
+
+
+    # Count the values
+    def count(options = {})
+      return count_all_elements if !options[:values]
+      case options[:values]
+      when :positive
+        @v.count{|e| e>0.0}
+      when :negative
+        @v.count{|e| e<0.0}
+      when :not_positive
+        @v.count{|e| e<=0.0}
+      when :not_negative
+        @v.count{|e| e>=0.0}
+      when :not_zero
+        @v.count{|e| e!=0.0}
+      when :zero
+        @v.count{|e| e==0.0}
+      when :all
+        count_all_elements
+      else
+        raise ArgumentError, "Option not recognized"
+      end
+    end
+
+
+    # Return the mean of values
+    def mean(options = {})
+      c = count(options)
+      return nil if c.zero? # if the array is empty will be returned nil
+      sum(options) / c
+    end
+
+
+    def minimum_value
+      @v.compact.min
+    rescue
+      nil
+    end
+
+    def maximum_value
+      @v.compact.max
+    rescue
+      nil
+    end
+
+
+    def round!(ndigit=3)
+      @v.collect!{|e| e.nil? ? nil : e.round(ndigit)}
+    end
+
+
+    # Return an array with two objects:
+    # - an array of HourNumber element (one HourNumber for each hour). The hours are not necessarily consecutive 
+    # - an array of values (float or integers) (one HourNumber for each hour). The hours are not necessarily consecutive 
+    def xy_array(options={})
+
+      values=[]
+      if options[:values]
+        case options[:values]
+        when :positive
+          values = @v.collect{|v| v if v>0.0}
+        when :negative
+          values = @v.collect{|v| v if v<0.0}
+        when :not_positive
+          values = @v.collect{|v| v if v<=0.0}
+        when :not_negative
+          values = @v.collect{|v| v if v>=0.0}
+        when :not_zero
+          values = @v.collect{|v| v if v!=0.0}
+        when :zero
+          values = @v.collect{|v| v if v==0.0}
+        when :all
+          values = @v.clone
+        else
+          raise ArgumentError, "Option not recognized"
+        end
+      else
+        values = @v.clone
+      end
+      hn = Array.new(@v.size, @start_time)
+      @v.size.times do |i|
+        if values[i].nil?
+          hn[i] = nil
+        else
+          hn[i]+=i.hours
+        end
+      end
+      [hn.compact, values.compact]
+    end
+
+
+    def end_time
+      return nil if empty?
+      @start_time + (@v.size-1).hours
+    end
+
+    def empty?
+      @v.nil? || @v.empty?
+    end
+
+    def empty_data
+      @v = @start_time.nil? ? nil : ValuesArray.new
+    end
+
+    def aligned_with?(v)
+      self.start_time==v.start_time && @v.size==v.size
+    end
+  
+    def align_with(v)
+      @start_time = v.start_time if @start_time.nil? # ====
+      s = [start_time, v.start_time].max
+      if end_time.nil? || v.end_time.nil? || s>(e = [end_time, v.end_time].min)
+        empty_data
+      else
+        data_ary(((s-start_time)/3600).to_i, 1+((e-s)/3600).to_i)
+      end
+      @start_time = s       
+    end
+
+
+    def size
+      @v.size
+    end
+
+    def to_s
+      "Start time: #{@start_time}\nData (size: #{@v.size}):\n#{print_values}"
+    end
+
+    def print_values
+      start_time = @start_time - 1.hour
+      @v.collect{|v| "#{(start_time+=1.hour).strftime('%Y-%m-%d %H:%M %a')}\t#{v}" }.join("\n")
+    end
+
+    def until_the_end_of_the_year(fill_value=0.0)
+      t = Time.zone.parse("#{@start_time.year+1}-01-01")
+      hh = (t-@start_time)/( 60 * 60) # final size
+      @v += ValuesArray.new(hh-@v.size, fill_value) if hh>@v.size
+      self
+    end
+
+    def +(vec)
+      oper(vec, :+)
+    end
+
+    def -(vec)
+      oper(vec, :-)
+    end
+
+    def *(vec)
+      oper(vec, :*)
+    end
+
+    def /(vec)
+      oper(vec, :/)
+    end
+
+    # v1.max(v2) return a new obj where which element is the max between the elements of v1 and v2
+    # v2 can also be of type Numeric
+    def max(vec=0.0)
+      min_max(vec, :max_among)
+    end
+
+    def min(vec=0.0)
+      min_max(vec, :min_among)
+    end
+
+    def value(index)
+      @v[index]
+    end
+
+    def first_values(number)
+      @v[0,number]
+    end
+
+    def set_value(index, new_value)
+      @v[index]=new_value
+    end
+
+
+    private
+
+    def data_ary(start, length)
+      @v = @v[start, length]
+    end
+
+    def min_max(vec, method)
+      return self if vec.nil?
+      c = self.clone
+      if vec.is_a? Numeric # Fixnum or Float...
+        default_value = vec
+      else
+        c.align_with(vec)
+      end
+      c.size.times do |i|
+        c.set_value(i, self.send(method, c.value(i),  default_value || vec.value(i)))
+      end
+      c
+    end
+
+
+    def oper(vec, op)
+      return self if vec.nil?
+
+      c = self.clone
+      if vec.is_a? Numeric # Fixnum or Float...
+        default_value = vec
+      else
+        c.align_with(vec)
+      end
+      
+      c.data(Array.new(vec.size){[:+, :-].include?(op) ? 0.0 : 1.0}) if @v.nil?
+      c.size.times do |i|
+        c.set_value(i, c.value(i).to_f.send(op, (default_value || vec.value(i) || 0.0)))
+      end
+      c
+    end
+
+
+    def floor_start_time(t, unit=:hour)
+      return nil if t.nil?
+      case unit
+      # when :'15minutes'
+      #   t = t - t.sec - (60 * (t.min % 15)) # floor to hour
+      when :hour
+        t = Time.zone.parse("#{t.year}-#{t.month}-#{t.day} #{t.hour}:00:00")
+        # t = t - t.sec - (60 * (t.min % 60)) # floor to hour
+      when :day
+        t = Time.zone.parse("#{t.year}-#{t.month}-#{t.day}")
+      when :month
+        t = Time.zone.parse("#{t.year}-#{t.month}-01")
+      when :year
+        t = Time.zone.parse("#{t.year}-01-01")
+      end
+      t
+    end
+
+
+    def read_start_time(start_time)
+      # start_time = Time.zone.now if start_time.nil? # ====
+      if start_time.is_a?(String)
+        start_time.gsub!("/", "-")
+        begin
+          start_time = Time.zone.parse(start_time)
+        rescue Exception => e
+          case start_time.size
+          when 2
+            start_time = Time.zone.parse("20#{start_time}-01-01")
+          when 4
+            start_time = Time.zone.parse("#{start_time}-01-01")
+          when 7
+            start_time = Time.zone.parse("#{start_time}-01")
+          else
+            raise ArgumentError, "Start time not valid"
+          end
+        end
+      end
+      start_time
+    end
+
+
+    def sum_all_elements
+      @v.inject(0.0){|total, n| total + (n||0.0) }
+    end
+
+    def count_all_elements
+      @v.size
+    end
+    
+    def validate_unit(unit)
+      raise ArgumentError, "Time unit is not valid" if !@@valid_units.include? unit
+    end
+  end
+
+end

data/lib/energy_market/version.rb

@@ -0,0 +1,3 @@
+module EnergyMarket
+  VERSION = "0.0.4"
+end

data/lib/energy_market.rb

@@ -0,0 +1,14 @@
+# require "energy_market/version"
+# require "energy_market/energy_market"
+
+%w(
+    my_util
+    version
+    energy_market
+    vector
+    values_array
+  ).each { |file| require File.join(File.dirname(__FILE__), 'energy_market', file) }
+
+module EnergyMarket
+  # Your code goes here...
+end