reportier 0.4 → 0.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b7aed0447a45d12d75dac3467f024b34ccff230a
-  data.tar.gz: d26b31a8cb45c81d7ee4ca51d70f77643f99b18c
+  metadata.gz: b060db54ef18ae95264b3da27bc61c7dca574e15
+  data.tar.gz: 2cd5bbb62f9fec8d19764bcb2b5ece1ed70a0ba1
 SHA512:
-  metadata.gz: 269014b83979ca883e041891f90eaa80a0c4743cd6b716f6150e1c08e73a80d882483601c841aece9784835319873b9f4ee427665006cff16dfd5cd5f316b602
-  data.tar.gz: 7c2c0872876920642f9cadd16b132527135885a19cf845d07d41172968a1a3646ea37004374bd263476e2c824e1011079a8f0e43d1e6267c7070d795ffebe538
+  metadata.gz: a54ae56c41cc2b5687937b7d2860684eb8f8dd4f4741ba654f0f0fc4b843060528f949b9466339fd294ce577ca4d2eea1e3270b141732584c89d3f6e1294e20f
+  data.tar.gz: 224b602038052de692254f2702a1ba8806546794c67a171ed84f72ffe95b060eebd54d4ee71af520a2e18fa9d54b7827505917713088b519325701fdf442e244

data/README.md

@@ -3,6 +3,7 @@
 This is a tracker that tracks the count of events.
 
 ## Use
+`gem 'reportier'`
 
 Using the Tracker is fairly simple, by default there are 4 types of trackers.
 An `Hourly`, a `Daily` a `Weekly` and a `Monthly`.
@@ -14,9 +15,9 @@ as long as you keep adding items to them.
 Examples:
 
 ```
-Reportier::Daily.get.add('new user registration')
+Reportier::Tracker[:daily].add('new user registration')
 
-Reportier::Daily.get.report
+Reportier::Tracker[:daily].report
 # -> Daily report started at 2016-06-17T15:34:40+03:00
 # @new_user_registrations: 1
 ```
@@ -47,7 +48,7 @@ So the usage would be
 
 
 ```
-Reportier.set_default_types 'Yearly' => 1.year, 'BiDay' => 2.days
+Reportier.set_default_types yearly: 1.year, bidaily: 2.days
 ```
 
 These new tracker classes will be created and can be used normally like any other tracker,
@@ -77,18 +78,6 @@ class Reportier::Reporter
 end
 ```
 
+### TODO
 
-## More
-
-There are many more features to come, as persiters.
-This has been kind of a personal project, please give me feedback on anything that has room for improvement.
-
-
-
-
-
-
-
-
-
-
+When persisted through redis trackers need to get their starting time from redis

data/lib/reportier.rb

@@ -1,15 +1,20 @@
+require          'date'
 require_relative 'reportier/naming'
 require_relative 'reportier/time'
+require_relative 'reportier/defaults'
 require_relative 'reportier/reporter'
 require_relative 'reportier/persister'
-require_relative 'reportier/stats'
-require_relative 'reportier/defaults'
+require_relative 'reportier/tracker'
 require_relative 'reportier/version'
 
 module Reportier
   def self.add_to_all(item)
-    Default::TYPES.each do |type, v|
-      eval "#{type}.get.add(item)"
+    @types.each do |type, v|
+      Tracker[type].add(item)
     end
   end
+
+  def self.configure(&blk)
+    Defaults.global.configure &blk
+  end
 end

data/lib/reportier/defaults.rb

@@ -1,58 +1,48 @@
 module Reportier
-  module Default
-    extend Time
+  class Defaults
+    attr_accessor :types, :reporting_vars, :reporters,
+      :persister
 
-    TYPES = {
-      'Hourly'  => hours(1),
-      'Daily'   => days(1),
-      'Weekly'  => weeks(1),
-      'Monthly' => months(1)
-    }
-
-    REPORTING_VARS = {}
-
-    REPORTERS = {
-     console: nil
-    }
+    def self.global
+      @global ||= new
+    end
 
-    PERSISTER = :memory
+    def initialize(opts={})
+      initialize_defaults
+      @reporting_vars.merge! Hash(opts[:reporting_vars])
+    end
 
-  end
+    def configure 
+      yield self
+    end
 
-  def self.set_default_reporting_vars(opts={})
-    Default::REPORTING_VARS.merge!(opts)
-  end
+    def update_reporting_vars(hash)
+      @reporting_vars.merge!(hash)
+    end
 
-  def self.set_default_types(opts={})
-    Default::TYPES.merge!(opts)
-    _default_classes_create
-  end
+    def types=(opts)
+      @types = Hash.new(0)
+      @types.merge! opts
+    end
 
-  def self.set_default_reporters(opts={})
-    Default::REPORTERS.merge!(opts) 
-    _require_reporter_libraries
-  end
+    def reporters=(opts)
+      @reporters = opts
+      _require_reporter_libraries
+    end
 
-  private
+    private
 
-  def self._require_reporter_libraries
-    Default::REPORTERS.each do |name, lib|
-      require lib if lib
+    def initialize_defaults
+      @types          = Hash.new(0)
+      @reporting_vars = Hash.new
+      @reporters      = Hash.new
+      @persister      = :memory
     end
-  end
 
-  def self._default_classes_create
-    Default::TYPES.each do |key, val|
-      raise TypeError unless val.kind_of? Integer
-      s_key = Namer.new.name_class(key)
-      eval %{
-      class #{s_key} < Instant
-        def expires_at
-          @started_at + #{val}
-        end
+    def _require_reporter_libraries
+      @reporters.each do |name, lib|
+        require lib if lib
       end
-      }
     end
   end
-  _default_classes_create
 end

data/lib/reportier/naming.rb

@@ -2,11 +2,11 @@ module Reportier
   class Namer
 
     def name_class(item)
-      create_string(item).capitalize
+      name(item).split('_').map(&:capitalize).join
     end
 
     def name_item(item)
-      pluralize(create_string(item))
+      pluralize(name(item))
     end
 
     def name(item)

data/lib/reportier/persister.rb

@@ -1,16 +1,22 @@
 module Reportier
   class Persister
-    def self.get
-      eval "#{Namer.new.name_class(Default::PERSISTER)}Persister.new"
+
+    def self.get(tracker, persister_type = Defaults.global.persister)
+      type = Namer.new.name_class(persister_type)
+      persister = eval "#{type}Persister"
+      persister.new(tracker)
     end
 
-    def initialize
-      _initialize_default_reporting_vars
+    def initialize(tracker)
+      @tracker  = tracker
+      @reporting_vars = {}
+      _initialize_reporting_vars
     end
 
     def save(item)
-      create_accessor(item) unless (eval "@#{item}")
-      eval "@#{item} += 1"
+      item = item.to_sym
+      initialize_reporting_var(item) unless get(item)
+      incr(item)
     end
 
     def report
@@ -18,48 +24,99 @@ module Reportier
     end
 
     def to_json
-      "{#{to_hash.map { |k,v| "\"#{k.to_s}\": #{v.to_s}" }.flatten.join(",\n")}}"
+      "{#{to_hash.map { |k,v| "\"#{k}\": #{v}" }.flatten.join(",\n")}}"
+    end
+
+    def clear
+      @reporting_vars = {}
+      _initialize_reporting_vars
+    end
+
+    def get_date
+      @tracker.started_at
+    end
+
+    def set_date(date)
+      @tracker.started_at = date
+    end
+
+    def to_hash
+      @reporting_vars
     end
 
     private
 
+    def incr(item)
+      @reporting_vars[item] += 1
+    end
+
+    def get(item)
+      @reporting_vars[item]
+    end
+
+    def set(item, val)
+      @reporting_vars[item] = 0
+    end
+
     def attr_messages
-      reporting_vars.map do |var|
-        "#{var}: #{eval var.to_s}\n"
+      to_hash.map do |key, val|
+        "#{key}: #{val}\n"
       end
     end
     
-    def create_accessor(name)
-      self.class.module_eval "attr_accessor :#{name}"
-      eval "@#{name} ||= 0"
+    def initialize_reporting_var(name)
+      set(name, 0)
+    end
+
+    def _initialize_reporting_vars
+      @reporting_vars.merge!(@tracker.defaults.reporting_vars)
+    end
+  end
+  class MemoryPersister < Persister; end
+  class RedisPersister  < Persister
+
+    def clear
+      Redis.current.del(Redis.current.keys(name + '*'))
+    rescue Redis::CommandError
     end
 
     def to_hash
-      Hash[ *reporting_vars.collect { |v| [ v.to_s, (eval v.to_s) ] }.flatten ]
+      Hash[reporting_vars.map { |k| [k, get(k).to_i] }]
     end
 
-    def reporting_vars
-      instance_variables
+    def get_date
+      date = Redis.current.get "Reportier:DateFor#{name}"
+      return if date.nil? || date.empty?
+      DateTime.parse(date)
     end
 
-    def clear
-      reporting_vars.each do |var|
-        eval "#{var} = 0"
-      end
-      initialize
+    def set_date(date)
+      Redis.current.set "Reportier:DateFor#{name}", date.to_s
+      super
     end
 
-    def _initialize_default_reporting_vars
-      Default::REPORTING_VARS.each do |key, val|
-        raise TypeError unless val.kind_of? Integer
-        eval "@#{Namer.new.name(key)} = #{val}"
+    private
+
+    def reporting_vars
+      Redis.current.keys(name + '*').map do |var|
+        var.sub(name,'').to_sym
       end
     end
-  end
-  class MemoryPersister < Persister; end
-  class RedisPersister  < Persister
 
-  end
-end
+    def incr(item)
+      Redis.current.incr name(item)
+    end
 
+    def set(item, val)
+      Redis.current.set name(item), val
+    end
 
+    def get(item)
+      Redis.current.get name(item)
+    end
+    
+    def name(item=nil)
+      "#{@tracker.name}:#{item}"
+    end
+  end
+end

data/lib/reportier/reporter.rb

@@ -3,7 +3,7 @@ module Reportier
     attr_accessor :reporters
 
     def self.get
-      @current ||= new(Default::REPORTERS)
+      @current ||= new(Defaults.global.reporters)
     end
 
     def initialize(reporters)

data/lib/reportier/time.rb

@@ -25,7 +25,7 @@ module Reportier
     end
 
     def years(int)
-      months(int) * 12
+      Integer(days(int) * 365.25)
     end
   end
 end

data/lib/reportier/tracker.rb

@@ -0,0 +1,69 @@
+module Reportier
+  class Tracker
+    attr_accessor :started_at
+    attr_reader :reporter, :persister, :type, :name, :defaults
+      
+
+    def self.[](type)
+      @current       ||= Hash.new
+      @current[type] ||= new(type: type)
+    end
+
+    def initialize(opts = {})
+      @defaults     = Defaults.new
+      @type         = opts[:type]
+      @reporter     = opts[:reporter]  || Reporter.get
+      @persister    = opts[:persister] || Persister.get(self)
+      @name         = Namer.new.name \
+        "#{opts[:name]}#{@type && @type.capitalize}Tracker"
+      @persister.set_date(_set_date)
+    end
+
+    def add(item)
+      (report && clear) unless active?
+      return if Defaults.global.types[@type] == 0
+      @persister.save(Namer.new.name_item(item))
+    end
+
+    def report
+      @reporter.call(self) do
+        "#{@type} report started at #{@started_at}\n" +
+        @persister.report
+      end
+    end
+
+    def to_json
+      @persister.to_json
+    end
+
+    def active?
+      DateTime.now < expires_at
+    end
+
+    private
+
+    def clear
+      @persister.clear
+      @persister.set_date(_set_date)
+    end
+
+    def expires_at
+      @persister.get_date + Defaults.global.types[@type]
+    end
+
+    private
+
+    def _set_date
+      return DateTime.now if _set_to_now?
+      @persister.get_date || expires_at
+    end
+
+    def _set_to_now?
+      @persister.get_date.nil? || _long_due?
+    end
+
+    def _long_due?
+      expires_at < (DateTime.now - Defaults.global.types[@type])
+    end
+  end
+end

data/lib/reportier/version.rb

@@ -1,3 +1,3 @@
 module Reportier
-  VERSION = '0.4'
+  VERSION = '0.5'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: reportier
 version: !ruby/object:Gem::Version
-  version: '0.4'
+  version: '0.5'
 platform: ruby
 authors:
 - Vasilis Spilka
@@ -9,8 +9,36 @@ autorequire:
 bindir: bin
 cert_chain: []
 date: 2016-06-13 00:00:00.000000000 Z
-dependencies: []
-description: A stat tracker that reports automatically as you just add items
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: redis
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: A event/item tracker that reports automatically as you just add items
 email: vasspilka@gmail.com
 executables: []
 extensions: []
@@ -23,8 +51,8 @@ files:
 - lib/reportier/naming.rb
 - lib/reportier/persister.rb
 - lib/reportier/reporter.rb
-- lib/reportier/stats.rb
 - lib/reportier/time.rb
+- lib/reportier/tracker.rb
 - lib/reportier/version.rb
 homepage: http://rubygems.org/gems/reportier
 licenses:
@@ -49,6 +77,5 @@ rubyforge_project:
 rubygems_version: 2.5.1
 signing_key: 
 specification_version: 4
-summary: A stat tracker that reports
+summary: A event/item tracker that reports
 test_files: []
-has_rdoc: 

data/lib/reportier/stats.rb

@@ -1,57 +0,0 @@
-module Reportier
-
-  class Instant
-    attr_accessor :reporter, :persister
-
-    def self.get
-      @current ||= new
-    end
-
-    def initialize(opts = {})
-      @report_type  = self.class.to_s.sub('Reportier::','')
-      @started_at   = DateTime.now
-      @reporter     = opts[:reporter]  || Reporter.get
-      @persister    = opts[:persister] || Persister.get
-    end
-
-    def add(item)
-      (report && clear) unless active?
-      item_name = name(item)
-      @persister.save(item_name)
-      item_added
-    end
-
-    def report
-      @reporter.call(self) do
-        "#{@report_type} report started at #{@started_at}\n" +
-        @persister.report
-      end
-    end
-
-    def to_json
-      @persister.to_json
-    end
-
-    def active?
-      DateTime.now < expires_at
-    end
-
-    private
-
-    def clear
-      @persister.clear
-    end
-
-    def item_added
-      "item added"
-    end
-
-    def name(item)
-      Namer.new.name_item(item)
-    end
-
-    def expires_at
-      @started_at
-    end
-  end
-end