reportier 0.4

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: b7aed0447a45d12d75dac3467f024b34ccff230a
+  data.tar.gz: d26b31a8cb45c81d7ee4ca51d70f77643f99b18c
+SHA512:
+  metadata.gz: 269014b83979ca883e041891f90eaa80a0c4743cd6b716f6150e1c08e73a80d882483601c841aece9784835319873b9f4ee427665006cff16dfd5cd5f316b602
+  data.tar.gz: 7c2c0872876920642f9cadd16b132527135885a19cf845d07d41172968a1a3646ea37004374bd263476e2c824e1011079a8f0e43d1e6267c7070d795ffebe538

data/README.md

@@ -0,0 +1,94 @@
+# Reportier the stat tracker
+
+This is a tracker that tracks the count of events.
+
+## Use
+
+Using the Tracker is fairly simple, by default there are 4 types of trackers.
+An `Hourly`, a `Daily` a `Weekly` and a `Monthly`.
+To add something to a tracker simply `.get` it and `#add` something.
+
+You can also `#report` the current state of the tracker, however trackers report and reset by themselves
+as long as you keep adding items to them.
+
+Examples:
+
+```
+Reportier::Daily.get.add('new user registration')
+
+Reportier::Daily.get.report
+# -> Daily report started at 2016-06-17T15:34:40+03:00
+# @new_user_registrations: 1
+```
+
+You can also use `Reportier.add_to_all('we need to track this')` and it will add the item to all trackers.
+If you keep adding this way, each tracker will report when his time is due, and you have to worry about
+nothing else.
+
+Trackers also have a `#to_json` method for converting tracked items to json.
+
+
+## Setting defaults
+
+Reportier has 3 methods for setting defaults.
+
+`.set_default_reporting_vars`
+
+This is for setting default things you want to track. Example use would be.
+
+```
+Reportier.set_default_reporting_vars active_users: User.active, open_conversations: Conversation.all.count
+```
+
+`.set_default_types`
+
+This is for setting default tracker types, by type we mean how much time it needs for reset.
+So the usage would be
+
+
+```
+Reportier.set_default_types 'Yearly' => 1.year, 'BiDay' => 2.days
+```
+
+These new tracker classes will be created and can be used normally like any other tracker,
+also `Reportier.add_to_all` will take this new classes in account.
+Note that if you don't use Rails you can `import` or `extend` `Reportier::Time` to you current environment
+and use `hours(1)`, `days(1)`, `weeks(1)`,  `months(1)`, `years(1)`, years and months are not exact.
+
+`.set_default_reporters`
+
+This is for setting default reporters, by default Reportier will only report to console
+but we also support reporting to slack and logger, and you can easily create your custom reporting methods.
+
+```
+Reportier.set_default_reporters slack: 'slack-reporter', logger: 'logger'
+```
+
+If you want to add custom reporters just add their name and library and then define a `to_#{name)` method to the `Reporter`
+e.x.
+
+```
+Reportier.set_default_reporters twilio: 'twilio-ruby'
+
+class Reportier::Reporter
+  def to_twilio
+    ## you code here
+  end
+end
+```
+
+
+## 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.
+
+
+
+
+
+
+
+
+
+

data/lib/reportier.rb

@@ -0,0 +1,15 @@
+require_relative 'reportier/naming'
+require_relative 'reportier/time'
+require_relative 'reportier/reporter'
+require_relative 'reportier/persister'
+require_relative 'reportier/stats'
+require_relative 'reportier/defaults'
+require_relative 'reportier/version'
+
+module Reportier
+  def self.add_to_all(item)
+    Default::TYPES.each do |type, v|
+      eval "#{type}.get.add(item)"
+    end
+  end
+end

data/lib/reportier/defaults.rb

@@ -0,0 +1,58 @@
+module Reportier
+  module Default
+    extend Time
+
+    TYPES = {
+      'Hourly'  => hours(1),
+      'Daily'   => days(1),
+      'Weekly'  => weeks(1),
+      'Monthly' => months(1)
+    }
+
+    REPORTING_VARS = {}
+
+    REPORTERS = {
+     console: nil
+    }
+
+    PERSISTER = :memory
+
+  end
+
+  def self.set_default_reporting_vars(opts={})
+    Default::REPORTING_VARS.merge!(opts)
+  end
+
+  def self.set_default_types(opts={})
+    Default::TYPES.merge!(opts)
+    _default_classes_create
+  end
+
+  def self.set_default_reporters(opts={})
+    Default::REPORTERS.merge!(opts) 
+    _require_reporter_libraries
+  end
+
+  private
+
+  def self._require_reporter_libraries
+    Default::REPORTERS.each do |name, lib|
+      require lib if lib
+    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
+      end
+      }
+    end
+  end
+  _default_classes_create
+end

data/lib/reportier/naming.rb

@@ -0,0 +1,38 @@
+module Reportier
+  class Namer
+
+    def name_class(item)
+      create_string(item).capitalize
+    end
+
+    def name_item(item)
+      pluralize(create_string(item))
+    end
+
+    def name(item)
+      create_string(item)
+    end
+
+    private
+
+    def create_string(item)
+      return secure(item.to_s) if stringy?(item)
+      item.class.to_s.downcase
+    end
+
+    def secure(string)
+      string.gsub("\n",'_').gsub('\n', '_').gsub(';', '').gsub(' ', '_') \
+        .gsub('"', '').gsub('\'','')
+    end
+
+    def stringy?(item)
+      item.is_a?(String) || item.is_a?(Symbol)
+    end
+
+    def pluralize(string)
+      string.pluralize
+    rescue NoMethodError
+      string + 's'
+    end
+  end
+end

data/lib/reportier/persister.rb

@@ -0,0 +1,65 @@
+module Reportier
+  class Persister
+    def self.get
+      eval "#{Namer.new.name_class(Default::PERSISTER)}Persister.new"
+    end
+
+    def initialize
+      _initialize_default_reporting_vars
+    end
+
+    def save(item)
+      create_accessor(item) unless (eval "@#{item}")
+      eval "@#{item} += 1"
+    end
+
+    def report
+      attr_messages.inject(&:+).to_s
+    end
+
+    def to_json
+      "{#{to_hash.map { |k,v| "\"#{k.to_s}\": #{v.to_s}" }.flatten.join(",\n")}}"
+    end
+
+    private
+
+    def attr_messages
+      reporting_vars.map do |var|
+        "#{var}: #{eval var.to_s}\n"
+      end
+    end
+    
+    def create_accessor(name)
+      self.class.module_eval "attr_accessor :#{name}"
+      eval "@#{name} ||= 0"
+    end
+
+    def to_hash
+      Hash[ *reporting_vars.collect { |v| [ v.to_s, (eval v.to_s) ] }.flatten ]
+    end
+
+    def reporting_vars
+      instance_variables
+    end
+
+    def clear
+      reporting_vars.each do |var|
+        eval "#{var} = 0"
+      end
+      initialize
+    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}"
+      end
+    end
+  end
+  class MemoryPersister < Persister; end
+  class RedisPersister  < Persister
+
+  end
+end
+
+

data/lib/reportier/reporter.rb

@@ -0,0 +1,48 @@
+module Reportier
+  class Reporter
+    attr_accessor :reporters
+
+    def self.get
+      @current ||= new(Default::REPORTERS)
+    end
+
+    def initialize(reporters)
+      @reporters = reporters
+    end
+
+    def call(tracker, &blk)
+      @reporters.each do |reporter, v|
+        eval "to_#{Namer.new.name(reporter)} \"#{blk.call}\""
+      end
+    end
+
+    private
+
+    def to_console(message)
+      puts message
+    end
+
+    def to_slack(message)
+      type = message.split.first + '_tracker'
+      SlackReporter.new(type).call do
+        message
+      end
+    end
+
+    def to_logger(message)
+      create_dir('log') unless Dir.exists? 'log'
+      Logger.new('log/reportier.log').info("\n" + message)
+    end
+
+    def to_twilio
+
+    end
+
+    private
+
+    def create_dir(dir)
+      require 'fileutils'
+      FileUtils.mkdir_p dir
+    end
+  end
+end

data/lib/reportier/stats.rb

@@ -0,0 +1,57 @@
+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

data/lib/reportier/time.rb

@@ -0,0 +1,31 @@
+module Reportier
+  module Time
+    def seconds(int)
+      int
+    end
+
+    def minutes(int)
+      int * 60
+    end
+
+    def hours(int)
+      minutes(int) * 60
+    end
+
+    def days(int)
+      hours(int) * 24
+    end
+
+    def weeks(int)
+      days(int) * 7
+    end
+
+    def months(int)
+      days(int) * 30
+    end
+
+    def years(int)
+      months(int) * 12
+    end
+  end
+end

data/lib/reportier/version.rb

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

metadata

@@ -0,0 +1,54 @@
+--- !ruby/object:Gem::Specification
+name: reportier
+version: !ruby/object:Gem::Version
+  version: '0.4'
+platform: ruby
+authors:
+- Vasilis Spilka
+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
+email: vasspilka@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- README.md
+- lib/reportier.rb
+- lib/reportier/defaults.rb
+- lib/reportier/naming.rb
+- lib/reportier/persister.rb
+- lib/reportier/reporter.rb
+- lib/reportier/stats.rb
+- lib/reportier/time.rb
+- lib/reportier/version.rb
+homepage: http://rubygems.org/gems/reportier
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.2.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.5.1
+signing_key: 
+specification_version: 4
+summary: A stat tracker that reports
+test_files: []
+has_rdoc: