thermometer 0.0.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 24f4d884925af863eb840198fb0ab404db19cc0c
+  data.tar.gz: 47415f7a12bfcf6e07d39b09d806c879f23fb269
+SHA512:
+  metadata.gz: 523a542fdd016ca8218446c006edb19429fdb5130ee9dfd8d6842d3c2633c499f5b9b26264baaa97dc606f3a416d53e0f00a455d01afa8391950b8d224a1cdfc
+  data.tar.gz: a1d7ebed8a309fcc8a5723a51bd5bf378f5640afcec26722f69acfea22066aa80cd26e4785e9eb1299aecfe9a01e1564353859e6381f07d187df73a67eb0ace2

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2014 NICK NEWELL
+
+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.rdoc

@@ -0,0 +1,3 @@
+= Thermometer
+
+This project rocks and uses MIT-LICENSE.

data/Rakefile

@@ -0,0 +1,32 @@
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+require 'rdoc/task'
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'Thermometer'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+
+
+
+Bundler::GemHelper.install_tasks
+
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = false
+end
+
+
+task default: :test

data/lib/generators/thermometer/install_generator.rb

@@ -0,0 +1,14 @@
+module Thermometer
+  module Generators
+    class InstallGenerator < Rails::Generators::Base
+
+      source_root File.expand_path('../templates', __FILE__)
+
+      desc "Copy default YML to config"
+      def copy_yml
+        copy_file 'thermometer.yml', 'config/thermometer.yml'
+        git add: "config/thermometer.yml"
+      end
+    end
+  end
+end

data/lib/generators/thermometer/templates/thermometer.yml

@@ -0,0 +1,76 @@
+# Here are the settings that are common to all environments
+common: &default_settings
+
+  # ============================== DEFAULT OPTIONS ===============================
+
+  date: updated_at
+  sample: 1
+  order: DESC
+
+
+  # ============================== TIME RANGES ===============================
+
+  # By default this time range wil be used, unless explicitly defined as an option in the class
+  # method 'measure_heat_on'
+  # Example :
+  #         measure_the_heat_on :friends , time_range: :brief
+  #         measure_the_heat_on :friends , time_range: {hot: 1.second..1.hour, cold: 1.hour..1.year}
+  #
+  #
+
+  time_range:       detailed
+  intensity_range:  brief
+
+  # Multiple time ranges can be defined here.
+
+  time:
+    detailed:
+      freezing:   4.months..100.years
+      frigid:     3.months..4.months
+      frosty:     2.months..3.months
+      cold:       5.weeks..2.months
+      chilly:     3.weeks..5.weeks
+      cool:       2.weeks..3.weeks
+      temperate:  1.week..2.weeks
+      tepid:      4.days..1.week
+      lukewarm:   2.days..4.days
+      warm:       1.day..2.days
+      hot:        14.hours..1.day
+      burning:    10.hours..14.hours
+      boiling:    6.hours..10.hours
+      scalding:   3.hours..6.hours
+      scorching:  1.hours..3.hours
+      searing:    1.second..1.hour
+
+    brief:
+      cold:      3.days..100.years
+      hot:       1.second..3.days
+
+  intensity:
+    detailed:
+        very_light:         1..5
+        light:              5..10
+        slightly_moderate:  10..15
+        moderate:           15..25
+        heavy:              25..50
+        very_heavy:         50
+
+    brief:
+      light:    1..5
+      moderate: 5..15
+      heavy:    15
+# Application Environments
+# ------------------------------------------
+
+test:
+  <<: *default_settings
+
+development:
+  <<: *default_settings
+
+staging:
+  <<: *default_settings
+
+production:
+  <<: *default_settings
+

data/lib/tasks/thermometer_tasks.rake

@@ -0,0 +1,4 @@
+# desc "Explaining what the task does"
+# task :thermometer do
+#   # Task goes here
+# end

data/lib/thermometer.rb

@@ -0,0 +1,31 @@
+module Thermometer
+  class << self
+    def configure
+      yield configuration
+    end
+
+    def configuration
+      @configuration ||= Configuration.new
+    end
+  end
+end
+
+
+require "active_record"
+
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+
+require 'thermometer/configuration'
+require "thermometer/evaluate"
+require "thermometer/active_record"
+require "thermometer/temperature"
+
+$LOAD_PATH.shift
+
+#if defined?(ActiveRecord::Base)
+#  class ActiveRecord::Base
+#    include Thermometer::Temperature
+#  end
+#end
+
+

data/lib/thermometer/active_record.rb

@@ -0,0 +1,50 @@
+require 'thermometer/evaluate'
+
+module Thermometer
+  module ActiveRecord
+    module RelationMethods
+      include Evaluate::Temperatures
+
+      private
+
+      def sample_records options
+        options = Thermometer.configuration.process_scope_options(proxy_association.reflection.options[:thermometer].merge(options))
+
+        if options[:limit] && options[:order]
+          sample = limit(options[:limit]).order(options[:order]).pluck(options[:date])
+        elsif options[:limit] && options[:order].nil?
+          sample = limit(options[:limit]).pluck(options[:date])
+        elsif options[:limit].nil? && options[:order]
+          sample = order(options[:order]).pluck(options[:date])
+        else
+          sample = pluck(options[:date])
+        end
+      end
+
+
+    end
+=begin
+    module Temperature
+
+      def
+      rel = if ::ActiveRecord::Relation === self
+              self
+            elsif !defined?(::ActiveRecord::Scoping) or ::ActiveRecord::Scoping::ClassMethods.method_defined? :with_scope
+              # Active Record 3
+              scoped
+            else
+              # Active Record 4
+              all
+            end
+
+      rel = rel.extending(RelationMethods)
+    end
+=end
+  end
+
+  #::ActiveRecord::Base.extend RelationMethods
+
+end
+
+
+#ActiveRecord::Relation.send(:include, Thermometer::ActiveRecord::RelationMethods)

data/lib/thermometer/configuration.rb

@@ -0,0 +1,116 @@
+module Thermometer
+  class Configuration
+    def initialize
+      @config = YAML.load_file("#{Rails.root.to_s}/config/thermometer.yml")[Rails.env]
+      load_time_ranges
+      load_scope_options
+    end
+
+    def config
+      @config
+    end
+
+    def time_ranges
+       @time_ranges
+    end
+
+    ##
+    # Defines the date filed in ActiveRecord Model to inspect
+    #
+    def date
+      @date ||= @config['date']
+    end
+
+    ##
+    # Defines how many records to sample
+    #
+    def sample
+      @sample ||= @config['sample'].to_i
+    end
+
+    ##
+    # Default sort order on Collection
+    #
+    def order
+      unless @order
+        raise "'order' must be one of [ASC,DESC]" if !%w(ASC DESC).include?(@config['order'].to_s.upcase)
+      end
+      @order ||= @config['order']
+    end
+
+    ##
+    #  If no range is called expclitly, use this one
+    #
+    def default_time_range
+       @default_time_range ||= @time_ranges[@config['time_range']]
+    end
+
+    def scope_options
+      @scope_options
+    end
+
+    def process_scope_options options
+      processed_options = Hash.new
+
+      unless options.nil?
+
+        processed_options[:date] = options.include?(:date) ? options[:date] : self.date  #we always need this
+
+        if options.include?(:explicit)
+          #dont use defaults when a scope option is absent
+          processed_options[:order] = options.include?(:order) && %w(ASC DESC).include?(options[:order].to_s.upcase) ?
+              "#{processed_options[:date]} #{options[:order].to_s.upcase}"  : nil
+          processed_options[:limit] = options.include?(:sample) ? options[:sample].to_i : nil
+        else
+          processed_options[:order] = options.include?(:order) && %w(ASC DESC).include?(options[:order].to_s.upcase) ?
+              "#{processed_options[:date]} #{options[:order].to_s.upcase}"  :  "#{processed_options[:date]} #{self.order}"
+          processed_options[:limit] = options.include?(:sample) ? options[:sample].to_i : self.sample
+
+        end
+
+        processed_options.each do |k,v|
+           if v.nil?
+             processed_options.delete k
+           end
+        end
+
+      else
+        processed_options = @scope_options
+      end
+      return processed_options
+    end
+
+    private
+
+    def load_scope_options
+      @scope_options = Hash.new
+      @scope_options[:date] = self.date
+      @scope_options[:order] = "#{@scope_options[:date]} #{self.order}"
+      @scope_options[:limit] = self.sample
+    end
+
+    ##
+    #  Load ranges from config file
+    #
+    def load_time_ranges
+      @time_ranges = ActiveSupport::HashWithIndifferentAccess.new
+      time_ranges = @config['time']
+      time_ranges.each do |t,r|
+        time_range = ActiveSupport::HashWithIndifferentAccess.new
+        src_ranges ||= r
+        src_ranges.map { |k,v| time_range[k.to_sym] = rangify_time_boundaries(v) }
+        @time_ranges[t.to_sym] = time_range
+      end
+
+    end
+
+    ##
+    # Takes a string like "2.days..3.weeks"
+    #  and converts to Range object -> 2.days..3.weeks
+    #
+    def rangify_time_boundaries(src)
+      src.split("..").inject{ |s,e| s.split(".").inject{|n,m| n.to_i.send(m)}..e.split(".").inject{|n,m| n.to_i.send(m) }}
+    end
+
+  end
+end

data/lib/thermometer/evaluate.rb

@@ -0,0 +1,87 @@
+module Thermometer
+  module Evaluate
+    module CalcsForTime
+
+      def time_diff_for(date, increment=:days, reference=DateTime.now)
+        now = Time.at(reference)
+        diff = (now - date).to_i
+        (diff.to_f/1.send(increment)).send(increment)
+      end
+
+      ##
+      # @sample is an array of timestamps
+      # @reference is a point in time to evaluate the time_diff
+      def average(sample, increment=:days, reference=DateTime.now)
+        (sample.map { |s| time_diff_for(s,increment,reference)  }.
+            inject{ |d,e| d+ e}.to_f / sample.size.send(increment)).send(increment)
+      end
+
+      def min
+
+      end
+
+      def max
+
+      end
+    end
+
+    module Temperatures
+      include Thermometer::Evaluate::CalcsForTime
+
+
+      def has_temperature(options={})
+        sample = sample_records options
+        if sample.size > 1
+          evaluate_level(average(sample))
+        elsif sample.size == 1
+          evaluate_level(time_diff_for(sample.first))
+        else
+          :none
+        end
+      end
+
+      ##
+      # Read the direct read_temperature on the instance itself
+      #
+      def has_temperature?(level,options={})
+        level.to_s == has_temperature(options).to_s
+      end
+
+      def is_warmer_than?(level,options={})
+        compare_level_to(level,options) do |x,y|
+          x > y
+        end
+      end
+
+      def is_colder_than?(level,options={})
+        compare_level_to(level,options) do |x,y|
+          x < y
+        end
+      end
+
+      private
+
+      def evaluate_level(days, ranges=Thermometer.configuration.default_time_range)
+        level = :none
+        ranges.each do |k,v|
+          if v.include?(days)
+            level = k
+            break
+          end
+        end
+        return level
+      end
+
+      def compare_level_to(level, options)
+        yield Thermometer.configuration.default_time_range[level].max,
+            Thermometer.configuration.default_time_range[has_temperature(options)].min
+      end
+
+      def sample_records
+        raise "Subclass is responsible for defining this method."
+      end
+
+
+    end
+  end
+end