custom_tracker 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: abf4674f2aced8badf74b1d922c6eb88a4900f125890e181f58ee6d349aeaaf3
+  data.tar.gz: 16d2709415d57ae08a7663e19c76fd6f8a8380558424e917dcf1133b5431d9b2
+SHA512:
+  metadata.gz: 8f31ebd752a9de71c5ad195d6e6bf422d34ad44b7da71a351f77f535f480de5f6018b9875927045dc74d7adc9364e95e7969269ca7eee8fd3ab4452e8f55fa25
+  data.tar.gz: 4133a0df76e079118eb0b9b7d2a1e7677f20b1d5c1d52cda840bec64afc8596973f05782f86187e216f8594a07bdd1e267724e0ace0d8bc7123643d9a048e11c

data/.gitignore

@@ -0,0 +1,8 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.travis.yml

@@ -0,0 +1,7 @@
+---
+sudo: false
+language: ruby
+cache: bundler
+rvm:
+  - 2.5.5
+before_install: gem install bundler -v 2.0.2

data/Gemfile

@@ -0,0 +1,8 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in custom_tracker.gemspec
+gemspec
+
+gem "csv", "~> 3.1"
+
+gem "date", "~> 2.0"

data/Gemfile.lock

@@ -0,0 +1,28 @@
+PATH
+  remote: .
+  specs:
+    custom_tracker (1.0.0)
+      csv (~> 3.1)
+      date (~> 2.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    csv (3.1.1)
+    date (2.0.0)
+    minitest (5.12.0)
+    rake (10.5.0)
+
+PLATFORMS
+  x64-mingw32
+
+DEPENDENCIES
+  bundler (~> 2.0)
+  csv (~> 3.1)
+  custom_tracker!
+  date (~> 2.0)
+  minitest (~> 5.0)
+  rake (~> 10.0)
+
+BUNDLED WITH
+   2.0.2

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2019 Fizvlad
+
+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,107 @@
+# CustomTracker
+
+This small gem is created to help saving data on some common events.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'custom_tracker'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install custom_tracker
+
+## Usage
+
+### Entries
+
+Data bout some event must be stored in `Entry` object. Each of them stores it's unique ID, time of creation and provided data hash:
+
+```ruby
+entry = CustomTracker::Entry.new(
+  type: :command_call,
+  command: :help,
+  author: "username",
+  author_status: nil,
+  server_id: 8675309
+)
+entry.id # => "5d943aa8a61d"
+entry.time # => 2019-10-02 08:50:32 +0300
+entry.columns # => [:type, :command, :author, :author_status, :server_id]
+``` 
+Notice that keys of provided hash must be symbols.
+
+### Tables
+
+`Table` objects provide interface for storing and exporting objects:
+
+```ruby
+server_events = CustomTracker::Table.new(
+  columns: [:type, :server_id], # List of data which MUST exist in entries
+  saving_block: Proc.new do |entries, table|
+    # This block recieves array of entries which must be saved somewhere
+    CSV.open("table.csv", "a") do |csv|
+      entries.each do |entry|
+        csv << [ entry.id, entry.time.to_i ] + table.columns.map { |c| entry[c] }
+      end
+    end
+  end
+)
+```
+
+To add event to table simply use method `Table#record`:
+
+```ruby
+server_events.record entry
+server_events.size_unsaved # => 1
+server_events.save # Export recorded entries using block above
+server_events.size_unsaved # => 0
+```
+
+### Tracker
+
+You can handle several tables using `Tracker`:
+
+```ruby
+tracker = CustomTracker::Tracker.new(
+  saving_block: Proc.new do |entries, table_sym, table|
+    # This block receives name entries to save, table symbol and table itself
+    CSV.open("table_#{ table_sym }.csv", "a") do |csv|
+      entries.each do |entry|
+        csv << [ entry.id, entry.time.to_i ] + table.columns.map { |c| entry[c] }
+      end
+    end
+  end
+)
+
+# Adding tables
+tracker.new_table(:command_events, columns: [:type, :command])
+tracker.new_table(:authored_events, columns: [:type, :author, :author_status])
+
+# Recording
+tracker.record_all entry
+
+# Saving
+tracker.save_all
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/custom_tracker.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList["test/**/*_test.rb"]
+end
+
+task :default => :test

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "custom_tracker"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/custom_tracker.gemspec

@@ -0,0 +1,36 @@
+lib = File.expand_path("lib", __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "custom_tracker/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "custom_tracker"
+  spec.version       = CustomTracker::VERSION
+  spec.authors       = ["Fizvlad"]
+  spec.email         = ["fizvlad@mail.ru"]
+
+  spec.summary       = "A small gem to track custom events and export saved data"
+  spec.homepage      = "https://github.com/fizvlad/custom-tracker-rb"
+  spec.license       = "MIT"
+
+  spec.required_ruby_version = ">= 2.5.0"
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = "https://github.com/fizvlad/custom-tracker-rb"
+  spec.metadata["changelog_uri"] = "https://github.com/fizvlad/custom-tracker-rb/releases"
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features|examples)/}) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_runtime_dependency "csv", "~> 3.1"
+  spec.add_runtime_dependency "date", "~> 2.0"
+
+  spec.add_development_dependency "bundler", "~> 2.0"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "minitest", "~> 5.0"
+end

data/lib/custom_tracker.rb

@@ -0,0 +1,11 @@
+require "csv"
+require "date"
+
+require "custom_tracker/version"
+require "custom_tracker/entry"
+require "custom_tracker/table"
+require "custom_tracker/tracker"
+
+##
+# Main module of the library.
+module CustomTracker; end

data/lib/custom_tracker/entry.rb

@@ -0,0 +1,79 @@
+module CustomTracker
+
+  ##
+  # Single tracker entry.
+  class Entry
+    include Enumerable
+
+    ##
+    # Calls the given block once for each pair in data.
+    #
+    # @yieldparam [Symbol] key
+    # @yieldparam [Object] value
+    #
+    # @return [self]
+    def each(&block)
+      @data.each &block
+    end
+
+    ##
+    # @return [Time] time of entry creation
+    attr_reader :time
+
+    ##
+    # @return [String] id of entry
+    attr_reader :id
+
+    ##
+    # @return [Array<Symbols>] Array of column names.
+    def columns
+      @data.keys
+    end
+
+    ##
+    # @param sym [Symbol]
+    #
+    # @return [Object] data from entry.
+    def [](sym)
+      @data[sym]
+    end
+
+    ##
+    # @param sym [Symbol]
+    #
+    # @return [Boolean] whether entry stores this column.
+    def has?(sym)
+      @data.has_key?(sym)
+    end
+
+    ##
+    # @return [String] human-readable string.
+    def to_s
+      <<~HEREDOC
+        Entry #{@id} from #{@time}. Data: #{@data}
+      HEREDOC
+    end
+
+    ##
+    # Creates new entry.
+    #
+    # @param data [Hash<Symbol, Object>]
+    def initialize(data)
+      @time = Time.now
+      @time.freeze
+
+      # Generating id from current time and random suffix
+      @id = (@time.to_i * 65536 + rand(65536)).to_s(16)
+      @id.freeze
+
+      @data = {}
+      data.each_pair do |key, value|
+        next unless key.is_a? Symbol
+        @data[key] = value
+      end
+      @data.freeze
+    end
+
+  end
+
+end

data/lib/custom_tracker/table.rb

@@ -0,0 +1,99 @@
+module CustomTracker
+
+  ##
+  # A group of entries with similar data.
+  class Table
+    include Enumerable
+
+    ##
+    # @return [Integer] total amount of entries.
+    def size
+      size_unsaved + size_saved
+    end
+
+    ##
+    # @return [Integer] amount of unsaved entries.
+    def size_unsaved
+      @unsaved_entries.size
+    end
+
+    ##
+    # @return [Integer] amount of saved entries.
+    def size_saved
+      @size_saved
+    end
+
+    ##
+    # @return [Array<Symbol>] Array of column names.
+    attr_reader :columns
+
+    ##
+    # Creates new table.
+    #
+    # @param options [Hash]
+    #
+    # @option options [Array<Symbol>] columns array of column names all the entries
+    #   which are added to this table are required to store it.
+    # @option options [#call] saving_block callable object which must accept
+    #   +Array<Entry>+ - array of entries to save and +Table+ - +self+
+    def initialize(options)
+      @columns = options[:columns].select { |s| s.is_a? Symbol }
+      @columns.freeze
+
+      @saving_block = options[:saving_block]
+      unless @saving_block.respond_to? :call
+        raise ArgumentError, "saving_block is not responding to call method!", caller
+      end
+
+      @size_saved = 0
+      @unsaved_entries = []
+    end
+
+    ##
+    # @param entry [Entry]
+    # 
+    # @return [Boolean] whether this entry is acceptable.
+    def accepts?(entry)
+      @columns.all? { |sym| entry.has? sym }
+    end
+
+    ##
+    # Checks whether this entry is acceptable and saves it.
+    #
+    # @param entry [Entry, Hash<Symbol, Object>] if +Hash+ provided, +Entry+ will
+    #   be created automatically with {Entry#initialize}.
+    # @param options [Hash]
+    #
+    # @option options [Boolean] instant_save if enabled {Table#save} will be called after adding.
+    #
+    # @return [Entry, nil] +Entry+ if it was saved or +nil+ if it wasn't.
+    def record(entry, options = {})
+      entry = Entry.new(entry) if entry.is_a? Hash
+
+      instant_save = !!options[:instant_save]
+
+      if accepts? entry
+        @unsaved_entries.push(entry)
+        save if instant_save
+        entry
+      else
+        nil
+      end
+    end
+
+    ##
+    # Saves all unsaved entries.
+    #
+    # @return [Integer] amount of saved entries.
+    def save
+      @saving_block.call(@unsaved_entries, self)
+      re = @unsaved_entries.size
+      @size_saved += re
+      @unsaved_entries.clear
+
+      re
+    end
+
+  end
+
+end

data/lib/custom_tracker/tracker.rb

@@ -0,0 +1,105 @@
+module CustomTracker
+
+  ##
+  # A class to handle several tables.
+  class Tracker
+
+    ##
+    # @return [Array<Symbol>] array of table names.
+    def tables
+      @tables.keys
+    end
+
+    ##
+    # Access stored table.
+    #
+    # @return [Table]
+    def [](sym)
+      @tables[sym]
+    end
+
+    ##
+    # Creates new tracker.
+    #
+    # @param options [Hash]
+    #
+    # @option options [#call] saving_block callable object which must accept following
+    #   parameters: +Array<Entry>+ - entries to save, +Symbol+ - name of table and
+    #   +Table+ for which this block will be called.
+    def initialize(options)
+      @saving_block = options[:saving_block]
+      unless @saving_block.respond_to? :call
+        raise ArgumentError, "saving_block is not responding to call method!", caller
+      end
+
+      @tables = {}
+    end
+
+    ##
+    # Create new table and add it to handling.
+    #
+    # @param sym [Symbol]
+    # @param options [Hash]
+    #
+    # @option options [Array<Symbol>] columns array of column names all the entries
+    #   which are added to this table are required to store it.
+    #
+    # @return [Table] created table.
+    def new_table(sym, options)
+      raise ArgumentError, "sym must be a Symbol", caller unless sym.is_a? Symbol
+      raise ArgumentError, "This table already exists", caller if @tables.has_key? sym
+      table = Table.new(
+        options.merge(
+          saving_block: Proc.new do |arr, table_local|
+            @saving_block.call(arr, sym, table_local)
+          end
+        )
+      )
+      @tables[sym] = table
+
+      table
+    end
+
+    ##
+    # Records entry for every table
+    #
+    # @param entry [Entry]
+    #
+    # @return [Integer] amount of tables which registred 
+    def record_all(entry)
+      @tables.values.count { |t| t.record entry }
+    end
+
+    ##
+    # Records entry for table.
+    #
+    # @param table_name [Symbol] name of table.
+    # @param entry [Entry]
+    #
+    # @return [Entry, nil] +Entry+ if it was saved or +nil+ if it wasn't.
+    def record(table_name, entry)
+      @tables[table_name].record entry
+    end
+
+    ##
+    # Saves all the tables.
+    #
+    # @return [nil]
+    def save_all
+      @tables.values.each(&:save)
+      nil
+    end
+
+    ##
+    # Saves the table.
+    #
+    # @param table_name [Symbol] name of table.
+    #
+    # @return [Integer] amount of saved entries.
+    def save(table_name)
+      @tables[table_name].save
+    end
+
+  end
+
+end

data/lib/custom_tracker/version.rb

@@ -0,0 +1,7 @@
+module CustomTracker
+
+  ##
+  # Gem version.
+  VERSION = "1.0.0"
+
+end

metadata

@@ -0,0 +1,131 @@
+--- !ruby/object:Gem::Specification
+name: custom_tracker
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Fizvlad
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2019-10-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: csv
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.1'
+- !ruby/object:Gem::Dependency
+  name: date
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+description: 
+email:
+- fizvlad@mail.ru
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- custom_tracker.gemspec
+- lib/custom_tracker.rb
+- lib/custom_tracker/entry.rb
+- lib/custom_tracker/table.rb
+- lib/custom_tracker/tracker.rb
+- lib/custom_tracker/version.rb
+homepage: https://github.com/fizvlad/custom-tracker-rb
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/fizvlad/custom-tracker-rb
+  source_code_uri: https://github.com/fizvlad/custom-tracker-rb
+  changelog_uri: https://github.com/fizvlad/custom-tracker-rb/releases
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.5.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.4
+signing_key: 
+specification_version: 4
+summary: A small gem to track custom events and export saved data
+test_files: []