cstimer_analyser_cli 0.1.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 939e3d59781617a1d6d0b8f5cb7fd6afaebd5961
+  data.tar.gz: 08296733e846e709245f209e4c7efd7ae2c472b5
+SHA512:
+  metadata.gz: c18dbde81b064f9b2e4938f9163465c7e7ac8c95cbab10d3be8cefe6d723eafc6749d4c3cb953218ced8b273b55cc4909c49b8aab9a831271531dd07ee8e54da
+  data.tar.gz: 682fd608d0e791aa51d527066327c154fa6aae1850a5f720f224543ec91cecd187961bc587b7997f01450d89a27a7d08662a708c87a3f158f721ca6e862ebe5d

data/.gitignore

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

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 2.1.7
+before_install: gem install bundler -v 1.10.6

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,13 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, we pledge to respect all people who contribute through reporting issues, posting feature requests, updating documentation, submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free experience for everyone, regardless of level of experience, gender, gender identity and expression, sexual orientation, disability, personal appearance, body size, race, ethnicity, age, or religion.
+
+Examples of unacceptable behavior by participants include the use of sexual language or imagery, derogatory comments or personal attacks, trolling, public or private harassment, insults, or other unprofessional conduct.
+
+Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct. Project maintainers who do not follow the Code of Conduct may be removed from the project team.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by opening an issue or contacting one or more of the project maintainers.
+
+This Code of Conduct is adapted from the [Contributor Covenant](http://contributor-covenant.org), version 1.0.0, available at [http://contributor-covenant.org/version/1/0/0/](http://contributor-covenant.org/version/1/0/0/)

data/Gemfile

@@ -0,0 +1,9 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in cstimer_analyser_cli.gemspec
+gemspec
+#gem 'statsample'
+#gem 'optparse'
+#gem 'gnuplot'
+#gem 'cli-console'
+#gem 'highline'

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Siddharth Kannan
+
+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,41 @@
+# CstimerAnalyserCli
+
+Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/cstimer_analyser_cli`. To experiment with that code, run `bin/console` for an interactive prompt.
+
+TODO: Delete this and the text above, and describe your gem
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'cstimer_analyser_cli'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install cstimer_analyser_cli
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` 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]/cstimer_analyser_cli. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](contributor-covenant.org) code of conduct.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "cstimer_analyser_cli"
+
+# 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

data/bin/setup

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

data/cstimer_analyser_cli.gemspec

@@ -0,0 +1,38 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'cstimer_analyser_cli/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "cstimer_analyser_cli"
+  spec.version       = CstimerAnalyserCli::VERSION
+  spec.authors       = ["Siddharth Kannan"]
+  spec.email         = ["kannan.siddharth12@gmail.com"]
+
+  spec.summary       = %q{Analyse your solving times, generated using cstimer}
+  spec.description   = %q{Gain insights into how you have improved over time. Has graphs, histograms, and other fancy stuff!}
+  spec.homepage      = "http://icyflame.me/"
+  spec.license       = "MIT"
+
+  # Prevent pushing this gem to RubyGems.org by setting 'allowed_push_host', or
+  # delete this section to allow pushing this gem to any host.
+  #if spec.respond_to?(:metadata)
+    #spec.metadata['allowed_push_host'] = "TODO: Set to 'http://mygemserver.com'"
+  #else
+    #raise "RubyGems 2.0 or newer is required to protect against public gem pushes."
+  #end
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.10"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 0.0"
+
+	spec.add_dependency "statsample"
+	spec.add_dependency "gnuplot"
+	spec.add_dependency "highline"
+	spec.add_dependency "cli-console"
+end

data/exe/cstimer-analyse

@@ -0,0 +1,4 @@
+#!/usr/bin/env ruby
+
+require 'cstimer_analyser_cli'
+puts CstimerAnalyserCli::main()

data/lib/MainCalculations.rb

@@ -0,0 +1,229 @@
+require "gnuplot"
+require "statsample"
+require "cli-console"
+
+class MainCalculations
+	private
+	extend CLI::Task
+
+	public
+
+	attr_accessor :file_name, :all_times
+
+	def initialize(file_name)
+		@file_name = file_name
+		@all_times = Array.new
+		read_from_file
+	end
+
+	usage 'Say Hello to the user'
+	desc 'Imitating human warmth in a computer program!'
+	def hello(params)
+		puts "Hello, what's up?"
+		puts "You gave me #{params.inspect} as parameters"
+	end
+
+	def read_from_file
+		start_reading = false
+		# read the input file
+		File.open(@file_name, "r") do |filin|
+			while(line = filin.gets)
+				if not start_reading and /Time\sList/.match(line)
+					start_reading = true
+				end
+
+				if start_reading
+					matches = line.scan(/\d{2}.\d{2}/)
+					matches.each do |match|
+						@all_times.push(match.to_f)
+					end
+				end
+			end
+		end
+		@main_vector = @all_times.to_vector(:scale)
+	end
+
+	usage 'Show some basic statistics about the solvetimes'
+	desc 'Statistics include average, standard deviation, best and worst times'
+	def basic_stats(params)
+		p '----------------------------'
+		p '----------------------------'
+		p '-------- STATISTICS --------'
+		p 'Mean of the solvetimes   : %0.2f' % @main_vector.mean
+		p 'Median of the solvetimes : %0.2f' % @main_vector.median
+		p 'Best solvetime           : %0.2f' % @main_vector.min
+		p 'Worst solvetime          : %0.2f' % @main_vector.max
+		p 'Mode solvetime           : %0.2f' % @main_vector.mode
+	end
+	
+	usage 'Show a history of averages, and how they changed over time'
+	desc 'avg 100: will show a history of your distinct average of 100 solves'
+	def build_history_of_averages(params)
+		raise ArgumentError, "What is the number of solves to computer average for?" unless params.count >= 1
+		num_solves = params[0].to_i
+		num_datapoints = (@all_times.count / num_solves).to_i
+		all_means = Array.new
+		for i in 0..num_datapoints
+			this_mean = @all_times[i*num_solves..(i+1)*num_solves].to_vector.mean
+			all_means.push(this_mean)
+		end
+		Gnuplot.open do |gp|
+			Gnuplot::Plot.new( gp ) do |plot|
+
+				plot.title  "Average of #{num_solves} versus time (Total of #{@all_times.count} solves)"
+				plot.xlabel "n-th set of #{num_solves} solves"
+				plot.ylabel "Average of #{num_solves}"
+				plot.xrange "[0:#{all_means.count+2}]"
+
+				y = all_means
+				x = (1..all_means.count).to_a
+
+				plot.data << Gnuplot::DataSet.new( [x, y] ) do |ds|
+					ds.with = "linespoints"
+					ds.notitle
+				end
+			end
+		end
+	end
+	
+	usage 'Build a history of your best solves over time'
+	desc 'best 100: plots the best solve among 100 discontinuous and non-overlapping solves'
+	def build_history_of_best_solves(params)
+		raise ArgumentError, "What is the number of solves to computer average for?" unless params.count >= 1
+		num_solves = params[0].to_i
+		num_datapoints = (@all_times.count / num_solves).to_i
+		all_best_times = Array.new
+		for i in 0..num_datapoints
+			this_min = @all_times[i*num_solves..(i+1)*num_solves].to_vector.min
+			all_best_times.push(this_min)
+		end
+		Gnuplot.open do |gp|
+			Gnuplot::Plot.new( gp ) do |plot|
+
+				plot.title  "Best of #{num_solves} versus time (Total of #{@all_times.count} solves)"
+				plot.xlabel "n-th set of #{num_solves} solves"
+				plot.ylabel "Best of #{num_solves}"
+				plot.xrange "[0:#{all_best_times.count+2}]"
+
+				y = all_best_times
+				x = (1..all_best_times.count+2).to_a
+
+				plot.data << Gnuplot::DataSet.new( [x, y] ) do |ds|
+					ds.with = "linespoints"
+					ds.notitle
+				end
+			end
+		end
+	end
+	
+	usage 'Build a line graph of your solvetime evolution'
+	desc 'history: A congested graph showing when your best and lowest times were achieved, helpful in noticing patterns'
+	def build_graph_of_solve_times(params)
+		Gnuplot.open do |gp|
+			Gnuplot::Plot.new( gp ) do |plot|
+
+				plot.title  "Solvetime evolution over time (Total of #{@all_times.count} solves)"
+				plot.xlabel "Time"
+				plot.ylabel "Solvetimes"
+
+				y = @all_times
+				x = (1..@all_times.count).to_a
+
+				plot.data << Gnuplot::DataSet.new( [x, y] ) do |ds|
+					ds.with = "linespoints"
+					ds.notitle
+				end
+			end
+		end
+	end
+
+	usage 'Solvetime evolution for the last few times, want to know how that last session went?'
+	desc 'last 100: plots the last 100 solve times with index on the horizontal axis'
+
+	def build_graph_of_last_few_solve_times(params)
+		raise ArgumentError, "What is the number of solves to computer average for?" unless params.count >= 1
+		num_solves = params[0].to_i
+		Gnuplot.open do |gp|
+			Gnuplot::Plot.new( gp ) do |plot|
+
+				plot.title  "Last #{num_solves} solvetimes (Total of #{@all_times.count} solves)"
+				plot.xlabel "Time"
+				plot.ylabel "Solvetime"
+
+				#start_index = @all_times.count - num_solves
+				#end_index = @all_times.count-1
+
+				y = @all_times[@all_times.count-num_solves..@all_times.count-1]
+				x = (@all_times.count-num_solves..@all_times.count-1).to_a
+
+				plot.data << Gnuplot::DataSet.new( [x, y] ) do |ds|
+					ds.with = "linespoints"
+					ds.notitle
+				end
+			end
+		end
+	end
+	
+	usage 'Find where most of your times lie'
+	desc 'distribute 20 25 0.5: will show a histogram with 10 bins, with the first bin at 20-20.5 and the last bin for 24.5-25, and the height of the bin being the number of solves in that interval'
+	def build_hist_of_time_distribution(params)
+		raise ArgumentError, "What is the number of solves to computer average for?" unless params.count >= 3
+		start_time = params[0].to_f
+		end_time = params[1].to_f
+		min_distance = params[2].to_f
+
+		main_hash = Hash.new(0)
+		num_bins = ((end_time - start_time) / min_distance).to_f.ceil
+
+		printf "Number of bins is %d\n", num_bins
+
+		@all_times.each do |time|
+			if time >= start_time and time <= end_time
+				main_hash[((time - start_time) / min_distance).floor] += 1
+			end
+		end
+
+		puts main_hash.count
+		puts main_hash.to_s
+
+		data = Array.new
+
+		for i in main_hash
+			data.push([i, main_hash[i]])
+		end
+
+		Gnuplot.open do |gp|
+			Gnuplot::Plot.new(gp) do |plot|
+
+				plot.title  "Time Distribution (Total of #{@all_times.count} solves)"
+				plot.style  "data histograms"
+				plot.xtics	"nomirror rotate"
+				plot.boxwidth "0.5"
+				# plot.xtics  "nomirror rotate by +45"
+
+				x = Array.new
+				y = Array.new
+
+				(0..num_bins-1).to_a.each do |index|
+					x.push((start_time + index * min_distance).to_s + "-" + (start_time + (index+1) * min_distance).to_s)
+					y.push(main_hash[index])
+				end
+
+				plot.yrange "[0:#{main_hash.max_by{|k, v| v}[1] * 1.25}]"
+
+				plot.data = [
+					Gnuplot::DataSet.new( [x, y] ) { |ds|
+						ds.using = "2:xtic(1)"
+						ds.with = "boxes fill solid 0.8"
+						# ds.with = "candlesticks"
+						ds.title = "Number of solves"
+					},
+					Gnuplot::DataSet.new( [x, y] ) { |ds|
+						ds.using = "0:(10 + $2):2 with labels"
+						ds.title = ""
+					}
+				]
+			end
+		end
+	end
+end

data/lib/cstimer_analyser_cli.rb

@@ -0,0 +1,68 @@
+require "cstimer_analyser_cli/version"
+require "optparse"
+require "MainCalculations.rb"
+require "highline"
+require "cli-console"
+
+module CstimerAnalyserCli
+	def self.main
+		# code to parse the command line options
+		options = {}
+		OptionParser.new do |opts|
+			opts.banner = "Usage: cstimer-analyse [options]"
+
+			opts.on("-v", "--[no-]verbose", "Run verbosely") do |v|
+				options[:verbose] = v
+			end
+			opts.on("-i=INPUT", "--input-file=INPUT", "Input file path") do |i|
+				options[:input_file] = i
+				if not i
+					p "You need to pass an input file!"
+				end
+			end
+		end.parse!
+
+		#VERBOSE = options[:verbose]
+
+		#if VERBOSE
+		#p "Options read from the command line:"
+		#p options
+		#end
+
+		# do not allow user to proceed without input file
+		if not options[:input_file]
+			puts "You need to supply an input file path"
+			exit
+		end
+
+		calculater = MainCalculations.new(options[:input_file])
+
+		io = HighLine.new
+		console = CLI::Console.new(io)
+
+		console.addCommand('hello', calculater.method(:hello), "Say hello!")
+		console.addAlias('hi', 'hello')
+
+		console.addCommand('statistics', calculater.method(:basic_stats), "Show some basic statistics")
+		console.addAlias('stats', 'statistics')
+		
+		console.addCommand('average', calculater.method(:build_history_of_averages), "Show the evolution of averages over time")
+		console.addAlias('avg', 'average')
+
+		console.addCommand('best', calculater.method(:build_history_of_best_solves), "show the evolution of best solves over time")
+
+		console.addCommand('last', calculater.method(:build_graph_of_last_few_solve_times), "show the history of the last n solves, helpful for session quality")
+
+		console.addCommand('distribute', calculater.method(:build_hist_of_time_distribution), "Plot a distribution graph of times, helpful for locating clusters")
+		console.addAlias('dist', 'distribute')
+
+		console.addCommand('history', calculater.method(:build_graph_of_solve_times), "A complete history of your solves over time")
+
+		console.addHelpCommand('help', 'Help')
+		console.addExitCommand('exit', 'Exit from program')
+		console.addAlias('quit', 'exit')
+
+		console.start("%s> ",["analyse"])
+
+	end
+end

data/lib/cstimer_analyser_cli/version.rb

@@ -0,0 +1,3 @@
+module CstimerAnalyserCli
+  VERSION = "0.1.2"
+end

metadata

@@ -0,0 +1,159 @@
+--- !ruby/object:Gem::Specification
+name: cstimer_analyser_cli
+version: !ruby/object:Gem::Version
+  version: 0.1.2
+platform: ruby
+authors:
+- Siddharth Kannan
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2015-12-29 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+- !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: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.0'
+- !ruby/object:Gem::Dependency
+  name: statsample
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: gnuplot
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: highline
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: cli-console
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Gain insights into how you have improved over time. Has graphs, histograms,
+  and other fancy stuff!
+email:
+- kannan.siddharth12@gmail.com
+executables:
+- cstimer-analyse
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- cstimer_analyser_cli.gemspec
+- exe/cstimer-analyse
+- lib/MainCalculations.rb
+- lib/cstimer_analyser_cli.rb
+- lib/cstimer_analyser_cli/version.rb
+homepage: http://icyflame.me/
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.8
+signing_key: 
+specification_version: 4
+summary: Analyse your solving times, generated using cstimer
+test_files: []