abaci 0.2.0 → 0.3.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: e252a38ec5636513420c452f2d7cdec05d6567dc
+  data.tar.gz: f015dddb26cb408520a8f0530c3249541b57b61a
+SHA512:
+  metadata.gz: c72157e2fe5f73ea73858780a66f8a0c1202f539db1cb73f349d3aa5e75c6ad404ebbe4695e06702294727291753a26e3779a38a226afc717fbf75f148ad445e
+  data.tar.gz: 9619d2ef96579a8a2f3039495ad769eb4e4b46abe6f3bf06f4f14c1b81122adb75c0fbfe14f5ee61c87ce56ab6c2a0d9ee3e512bf030d889b14dcb970190cda6

data/CHANGELOG.md

@@ -1,3 +1,8 @@
+## Abaci 0.3.0
+
+* Dependency updates, bump minimum Ruby version.
+* Add some better tests and general clean up
+
 ## Abaci 0.2.0
 
 * Added testing suite
@@ -7,4 +12,4 @@
 
 ## Abaci 0.1.0
 
-* Initial build
+* Initial build

data/README.md

@@ -1,6 +1,6 @@
 # Abaci
 
-[![Build Status](https://secure.travis-ci.org/jdtornow/abaci.png)](http://travis-ci.org/jdtornow/abaci) [![Dependency Status](https://gemnasium.com/jdtornow/abaci.png?travis)](https://gemnasium.com/jdtornow/abaci)
+[![Build Status](https://travis-ci.org/jdtornow/abaci.svg?branch=master)](http://travis-ci.org/jdtornow/abaci)
 
 Abaci (pronounced abba-sigh) is a simple structure for the collection and reporting on numerical counters. Counters can be used to track time-based statistics for a wide array of functions within your application. Abaci uses a Redis backend to store all counters for lightning quick read and write access.
 
@@ -8,14 +8,14 @@ What does *abaci* mean? Its the plural form of [Abacus](http://en.wikipedia.org/
 
 ## Requirements
 
-* Ruby 1.9.2+
+* Ruby 2.2+
 * Redis
 
 ## Configuration
 
 Abaci will use the default Redis instance by default, assumed to be available via `Redis.current`. To use with a specific Redis instance, pass a `Redis` object to `Abaci.options[:redis]`. You can use it this way with [Redis Namespace](https://github.com/defunkt/redis-namespace) if necessary.
 
-By default, the prefix `ab` is used before all stats stored in Redis. If you are using running multiple apps using the same Redis instance (likely in development mode), you can change the prefix by setting `Abaci.options[:prefix]`.
+By default, the prefix `stats` is used before all stats stored in Redis. If you are using running multiple apps using the same Redis instance (likely in development mode), you can change the prefix by setting `Abaci.options[:prefix]`.
 
 Here's a sample configuration that we use often:
 
@@ -64,6 +64,16 @@ Abaci['views'].keys
 Abaci['views'].del
 ```
 
+## Time Zone
+
+When used within a Rails app, Abaci will use the same time zone as your Rails app, so there is no configuration needed.
+
+To manually override the time zone used in Abaci, just set the config variable:
+
+```ruby
+Abaci.time_zone = "Central Time (US & Canada)"
+```
+
 ## Issues
 
 If you have any issues or find bugs running Abaci, please [report them on Github](https://github.com/jdtornow/abaci/issues). While most functions should be stable, Abaci is still in its infancy and certain issues may be present.

data/lib/abaci.rb

@@ -1,10 +1,10 @@
-require 'abaci/version'
+require "abaci/version"
 
 module Abaci
-  autoload :Counter,      'abaci/counter'
-  autoload :DateRange,    'abaci/date_range'
-  autoload :Metric,       'abaci/metric'
-  autoload :Store,        'abaci/store'
+  autoload :Counter,      "abaci/counter"
+  autoload :DateRange,    "abaci/date_range"
+  autoload :Metric,       "abaci/metric"
+  autoload :Store,        "abaci/store"
 
   # Configuration options
   class << self
@@ -19,8 +19,18 @@ module Abaci
 
     def options
       @options ||= {
-        :redis => nil,
-        :prefix => 'ab'
+        # the redis store to use for storage
+        redis: nil,
+
+        # a prefix to put before each key
+        prefix: "stats",
+
+        # the time zone to store date values in
+        time_zone: "UTC",
+
+        # separates metric keys from date parameters, change
+        # this if you want to use it elsewhere in a key
+        separator: "@"
       }
     end
 
@@ -47,13 +57,25 @@ module Abaci
       Counter.all
     end
 
+    def time_zone
+      options[:time_zone]
+    end
+
+    def time_zone=(value)
+      options[:time_zone] = value
+    end
+
     def method_missing(method, *args)
       Counter.send(method, *args)
     end
   end
 
+  if defined?(Rails)
+    require "abaci/railtie"
+  end
+
   # Alias Stat to Abaci::Counter if nothing else is using the Stat namespace
   unless defined?(::Stat)
     ::Stat = Counter
   end
-end
+end

data/lib/abaci/counter.rb

@@ -1,18 +1,20 @@
 module Abaci
+  require "active_support/core_ext/time"
+
   class Counter
     attr_reader :key
 
     def initialize(key = nil)
-      @key = key
+      @key = key.to_s.downcase.strip
     end
 
     def decr(by = 1)
-    decrement_at(nil, by)
+      decrement_at(nil, by)
     end
     alias_method :decrement, :decr
 
     def decrement_at(date = nil, by = 1)
-      date = Time.now unless date.respond_to?(:strftime)
+      date = now unless date.respond_to?(:strftime)
       run(:decrby, by, date)
     end
 
@@ -23,13 +25,18 @@ module Abaci
     end
 
     def get(year = nil, month = nil, day = nil, hour = nil, min = nil)
-      get_key = [ key, year, month, day, hour, min ].compact.join(':')
+      get_key = [ key, year, month, day, hour, min ].compact.join(":")
       Abaci.store.get(get_key).to_i
     end
 
+    def get_date(date)
+      get_key = date_in_time_zone(date).strftime("%Y:%-m:%-d")
+      Abaci.store.get("#{ key }#{ Abaci.options[:separator] }#{ get_key }").to_i
+    end
+
     def get_last_days(number_of_days = 30)
       dates = DateRange.ago(number_of_days).keys
-      dates.map { |date| Abaci.store.get("#{key}:#{date}" ).to_i }.reduce(:+)
+      dates.map { |date| Abaci.store.get("#{ key }#{ Abaci.options[:separator] }#{ date }" ).to_i }.reduce(:+)
     end
 
     def incr(by = 1)
@@ -38,18 +45,15 @@ module Abaci
     alias_method :increment, :incr
 
     def increment_at(date = nil, by = 1)
-      date = Time.now unless date.respond_to?(:strftime)
+      date = now unless date.respond_to?(:strftime)
       Metric.add(key)
       run(:incrby, by, date)
     end
 
     def keys
-      Abaci.store.keys("#{key}*")
+      Abaci.store.keys("#{ key }*")
     end
 
-    ## Class methods ##
-    ############################################################################
-
     # Alias for Counter#new(key)
     def self.[](key)
       Counter.new(key)
@@ -68,31 +72,38 @@ module Abaci
     def self.method_missing(method, *args)
       ms = method.to_s.downcase.strip
 
-      if ms =~ /(incr|decr)(ement|ease)?_([a-z_]*)$/
+      if ms =~ /(incr|decr)(ement|ease)?_([a-z0-9_]*)$/
         return self[$3].send($1, *args)
-      elsif ms =~ /^(clear|reset|del)_([a-z_]*)!$/
+      elsif ms =~ /^(clear|reset|del)_([a-z0-9_]*)!$/
         return self[$2].del
-      elsif ms =~ /^last_(\d*)_days_of_([a-z_]*)$/
+      elsif ms =~ /^last_(\d*)_days_of_([a-z0-9_]*)$/
         return self[$2].get_last_days($1)
       else
         self[ms].get(*args)
       end
     end
 
-    ## Protected methods ##
-    ############################################################################
+    private
 
-    protected
-      def run(method, by, date)
-        now = date.strftime('%Y/%m/%d/%k/%M').split('/')
+    def run(method, by, date)
+      time_segments = date_in_time_zone(date).strftime('%Y/%-m/%-d/%-k/%M').split("/").map(&:to_i)
 
-        now.inject(key) do |memo, t|
-          memo = "#{memo}:#{t.to_i}"
-          Abaci.store.send(method, memo, by)
-          memo
-        end
+      Abaci.store.send(method, key, by)
 
-        Abaci.store.send(method, key, by)
+      time_segments.reduce([]) do |result, time|
+        result.push(time)
+        Abaci.store.send(method, "#{ key }#{ Abaci.options[:separator] }#{ result.join(":") }", by)
+        result
       end
+    end
+
+    def date_in_time_zone(raw_date)
+      raw_date.in_time_zone(Abaci.time_zone)
+    end
+
+    def now
+      Time.now.in_time_zone(Abaci.time_zone)
+    end
+
   end
-end
+end

data/lib/abaci/date_range.rb

@@ -1,5 +1,8 @@
 module Abaci
+  require "active_support/core_ext/time"
+
   class DateRange
+
     attr_reader :start, :finish
 
     def initialize(start, finish)
@@ -17,7 +20,7 @@ module Abaci
     end
 
     def keys
-      days.map { |d| d.strftime('%Y:%-m:%-d') }
+      days.map { |d| d.strftime("%Y:%-m:%-d") }
     end
 
     def range
@@ -26,16 +29,21 @@ module Abaci
 
     def self.ago(days = 30)
       seconds = days.to_i * 86400
-      start = (Date.today - Rational(seconds, 86400)).to_date
-      new(start, Date.today)
+      start = (now.to_date - Rational(seconds, 86400)).to_date
+      new(start, now.to_date)
     end
 
     def self.between(start, finish)
       new(start, finish)
     end
 
+    def self.now
+      Time.now.in_time_zone(Abaci.time_zone)
+    end
+
     def self.since(date)
-      new(date, Date.today)
+      new(date, now.to_date)
     end
+
   end
-end
+end

data/lib/abaci/metric.rb

@@ -1,15 +1,17 @@
 module Abaci
   class Metric
+
     def self.add(key)
-      Abaci.store.sadd('_metrics', key)
+      Abaci.store.sadd("#{ Abaci.options[:separator] }metrics", key)
     end
 
     def self.all
-      Abaci.store.smembers('_metrics')
+      Abaci.store.smembers("#{ Abaci.options[:separator] }metrics")
     end
 
     def self.remove(key)
-      Abaci.store.srem('_metrics', key)
+      Abaci.store.srem("#{ Abaci.options[:separator] }metrics", key)
     end
+
   end
-end
+end

data/lib/abaci/railtie.rb

@@ -0,0 +1,9 @@
+module Abaci
+  class Railtie < Rails::Railtie
+
+    initializer "abaci.set_time_zone" do |app|
+      Abaci.time_zone = app.config.time_zone
+    end
+
+  end
+end

data/lib/abaci/store.rb

@@ -1,5 +1,5 @@
 module Abaci
-  require 'redis'
+  require "redis"
 
   # Common interface for Redis. In the future this could be
   # swapped out for an alternate datastore.
@@ -8,7 +8,7 @@ module Abaci
 
     def initialize(options)
       @redis = options[:redis] || Redis.current
-      @prefix = options[:prefix] || 'ab'
+      @prefix = options[:prefix] || "stats"
     end
 
     def decrby(key, by = 1)
@@ -28,8 +28,8 @@ module Abaci
     end
 
     def keys(pattern = "*")
-      sub = Regexp.new("^#{prefix}:")
-      exec(:keys, pattern).map { |k| k.gsub(sub, '') }
+      sub = Regexp.new("^#{ prefix }:")
+      exec(:keys, pattern).map { |k| k.gsub(sub, "") }
     end
 
     def set(key, value)
@@ -37,32 +37,34 @@ module Abaci
     end
 
     def sadd(key, member)
-      exec_without_prefix(:sadd, "#{prefix}-#{key}", member)
+      exec_without_prefix(:sadd, "#{ prefix }#{ key }", member)
     end
 
     def smembers(key)
-      exec_without_prefix(:smembers, "#{prefix}-#{key}")
+      exec_without_prefix(:smembers, "#{ prefix }#{ key }")
     end
 
     def srem(key, member)
-      exec_without_prefix(:srem, "#{prefix}-#{key}", member)
+      exec_without_prefix(:srem, "#{ prefix }#{ key }", member)
     end
 
-    protected
-      def exec(command, key, *args)
-        if @redis and @redis.respond_to?(command)
-          @redis.send(command, prefixed_key(key), *args)
-        end
-      end
+    private
 
-      def exec_without_prefix(command, key, *args)
-        if @redis and @redis.respond_to?(command)
-          @redis.send(command, key, *args)
-        end
+    def exec(command, key, *args)
+      if @redis and @redis.respond_to?(command)
+        @redis.send(command, prefixed_key(key), *args)
       end
+    end
 
-      def prefixed_key(key)
-        [ prefix, key ].compact.join(':')
+    def exec_without_prefix(command, key, *args)
+      if @redis and @redis.respond_to?(command)
+        @redis.send(command, key, *args)
       end
+    end
+
+    def prefixed_key(key)
+      [ prefix, key ].compact.join(":")
+    end
+
   end
-end
+end

data/lib/abaci/version.rb

@@ -1,3 +1,3 @@
 module Abaci
-  VERSION = "0.2.0" unless defined?(::Abaci::VERSION)
-end
+  VERSION = "0.3.0" unless defined?(::Abaci::VERSION)
+end

data/vendor/bundle/bin/coderay

@@ -0,0 +1,17 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+#
+# This file was generated by Bundler.
+#
+# The application 'coderay' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require "pathname"
+ENV["BUNDLE_GEMFILE"] ||= File.expand_path("../../../../Gemfile",
+  Pathname.new(__FILE__).realpath)
+
+require "rubygems"
+require "bundler/setup"
+
+load Gem.bin_path("coderay", "coderay")

data/vendor/bundle/bin/erubis

@@ -0,0 +1,17 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+#
+# This file was generated by Bundler.
+#
+# The application 'erubis' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require "pathname"
+ENV["BUNDLE_GEMFILE"] ||= File.expand_path("../../../../Gemfile",
+  Pathname.new(__FILE__).realpath)
+
+require "rubygems"
+require "bundler/setup"
+
+load Gem.bin_path("erubis", "erubis")

data/vendor/bundle/bin/htmldiff

@@ -0,0 +1,17 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+#
+# This file was generated by Bundler.
+#
+# The application 'htmldiff' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require "pathname"
+ENV["BUNDLE_GEMFILE"] ||= File.expand_path("../../../../Gemfile",
+  Pathname.new(__FILE__).realpath)
+
+require "rubygems"
+require "bundler/setup"
+
+load Gem.bin_path("diff-lcs", "htmldiff")