thefox-wallet 0.16.0 → 0.17.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 371beb2557b5d4b13a93fa29ec2a4314d3988253
-  data.tar.gz: 557b1b3fd12d91150875cae58ca6a7226f2aaa1a
+  metadata.gz: f1d2d7b98050da769b3220c1b93ae33fa2d66732
+  data.tar.gz: 901db16b1cc71053ccbe69b11a71b03f27e460a0
 SHA512:
-  metadata.gz: 626f9cc9eb31732942d00247bed4059b0652923a11b842e46b54803817c6abd7a3ca489ad0acc441d44f6d158910e0553c0afc2d9654ea51920287e29063f378
-  data.tar.gz: 7fe39b9adf2b48a9d95d1cc89e1e4b3f2c7152ff3159442c3191b36b2962bc4cae53f12787540df836ea26b005efd20fff1d0d2db45364dff18dccd8d4c3ad0d
+  metadata.gz: 0102a8e412d49f20f5b2123c45c4834546b82037cdbecd564f44fb696734f174bae911e802fb6d297c7b379b7fc9ff091b4ac1d706a5eef4f1fb37f3461f50c0
+  data.tar.gz: bbf235d00f3b8aad963226867ee385c713ffa02ee77c6e49fbbf58e9a5186e1b09e75ef82637e45bf3c39b8e0e3c658aaa8fe6395a4923104707b8b792ecf592

data/.gitlab-ci.yml

@@ -35,8 +35,17 @@ test_23:
     script:
         - make test
 
-release_gem:
-    image: ruby:2.3
+test_24:
+    image: ruby:2.4
+    stage: test
+    environment: test
+    only:
+        - tags
+    script:
+        - make test
+
+release:
+    image: ruby:2.4
     stage: release
     environment: gem
     only:

data/.travis.yml

@@ -3,7 +3,7 @@ rvm:
     - 2.1
     - 2.2
     - 2.3
-    - 2.4.0-preview2
+    - 2.4.0
     - ruby-head
 sudo: required
 before_install:

data/Makefile

@@ -5,7 +5,7 @@ include Makefile.common
 
 .PHONY: dev
 dev:
-	$(BUNDLER) exec ./bin/wallet -w wallet_test2 add -t 'test' -e 5 -c 'test'
+	$(BUNDLER) exec ./bin/wallet -w wallet_test2 add -t 'Taxes Q1' -e 5 -c Company
 
 .PHONY: test
 test:
@@ -18,3 +18,12 @@ cov:
 .PHONY: cov_local
 cov_local:
 	RUBYOPT=-w TZ=Europe/Vienna SIMPLECOV_PHPUNIT_LOAD_PATH=../simplecov-phpunit COVERAGE=1 $(BUNDLER) exec ./test/suite_all.rb -v
+
+README.html: README.md
+	mkreadme
+
+watch_readme:
+	while true; do \
+		$(MAKE) README.html; \
+		sleep 1; \
+	done

data/README.md

@@ -13,7 +13,7 @@ While conventionally programs like Microsoft Excel or [LibreOffice](https://www.
 - Import CSV files.
 - Export data to CSV.
 - Generate HTML summary.
-- VI/editor import mode. (CSV)
+- Categories
 
 ## Install
 
@@ -24,16 +24,136 @@ The preferred method of installation is via RubyGems.org:
 
 or via `Gemfile`:
 
-	gem 'thefox-wallet', '~>0.15'
+	gem 'thefox-wallet', '~>0.16'
 
 Use it in your sources:
 
 	require 'thefox-wallet'
 
+## Options
+
+- `-w`, `--wallet <path>`  
+	Base path to a wallet directory. Each wallet has its own directory storing all informations. This option can be used for all comamnds.
+- `--id <id>`  
+	ID used for a new entry. If an ID is provided no new entry will be added if an entry with the same ID already exists. Use `--force` to overwrite this.
+- `-t`, `--title <title>`  
+	Title used for a new entry.
+- `-d`, `--date <date>`  
+	Date used for a new entry.
+- `--start <date>`  
+	Start-date used for a range.
+- `--end <date>`  
+	End-date used for a range.
+- `-r`, `--revenue <revenue>`  
+	Revenue used for a new entry.
+- `-e`, `--expense <expense>`  
+	Expense used for a new entry.
+- `-c`, `--category <category>`  
+	Category used for a new entry.
+- `-o`, `--comment <comment>`  
+	Comment used for a new entry.
+- `--import`, `--export`  
+	Import/Export CSV
+- `-p`, `--path <path>`  
+	Path used for `csv` import/export and `html` directory path.
+- `-i`, `--interactive`  
+	Use some commands interactively.
+- `-f`, `--force`, `--no-force`  
+	Force (or no force) `add` command. See `--id` option.
+- `-v`, `--verbose`  
+	Log on debug level.
+- `-V`, `--version`  
+	Show version.
+- `-h`, `--help`  
+	Show help page.
+
+## Commands
+
+### Add Command
+
+Add a new entry.
+
+	$ wallet add [-w <path>] [--id <id>] [-r <revenue>] [-e <expense>] [-c <category>] [-o <comment>] [-i] [-f|--no-force] -t|--title <title>
+
+When `--interactive` (`-i`) option is used, parse `%d` with `printf`. Separate multiple `%`-variables with `,`. This feature can be used on template scripts that run the `wallet add` command with pre-defined texts.
+
+For example. To use the following in a template script
+
+	$ wallet add --title 'Income tax %d/Q%d' --interactive
+
+and set the values on interactive input when the command is running.
+
+```bash
+$ wallet add --title 'Income tax %d/Q%d' --interactive
+title: [Income tax %d/Q%d] 2017,1
+```
+
+This would set the title to `Income tax 2017/Q1`. So the input will not be set as value rather than replaced by the variables in the template text. Acting like `printf`.
+
+Expenses are always converted to minus.
+
+Calculations will be `eval`ed as Ruby code. For example:
+
+	$ wallet add --title Test --expense 14+7
+
+The expense will be `-21`. Expenses are always minus.
+
+In the following example the expense will be `-3`:
+
+	$ wallet add --title Test --expense 10-7
+
+The same applies to revenue.
+
+See `AddCommand::revenue` and `AddCommand::expense` functions.
+
+### Categories Command
+
+List all used categories.
+
+	$ wallet categories [-w <path>]
+
+Each entry can have one category. It's planned to implement [Multiple Categories](https://github.com/TheFox/wallet/issues/3) for entries.
+
+You can define the categories yourself. The `list` command has a filter option `-c` to list all entries of a certain category. The `html` command (for generating a HTML output) will also sum all entries for each category. If the category is not set on `add` command the category will be set to `default`. The `default` category will not be shown in list views.
+
+### Clear Command
+
+Clear temp and cache files.
+
+	$ wallet clear [-w <path>]
+
+If the html directory path (`-p`) provided to the `html` command is outside of the wallet base path (`-w`) this directory will **NOT** be deleted by the `clear` command. If the default html directory (`wallet/html`) is used this directory will be removed. This command does **NOT** delete any entries stored at `wallet/data`.
+
+### CSV Command
+
+Import or export to/from CSV file format.
+
+	$ wallet csv [-w <path>] [--import|--export] -p <path>
+
+### HTML Command
+
+Exports a wallet as HTML. List all years in an index HTML file and all months for each year. Generates a HTML file for each month based on entries.
+
+	$ wallet html [-w <path>] [--start <date>] [--end <date>] [-c <category,...>] [-p <path>] [-v]
+
+Option `-c` can take multiple categories separated by `,`.
+
+### List Command
+
+List entries. Per default this command lists all entries of today's date.
+
+	$ wallet list [-w <path>] [-d <YYYY>[-<MM>[-<DD>]]] [-c <category>]
+
+You can either provide a year `YYYY`, a month `YYYY-MM` or a day `YYYY-MM-DD`.
+
+## Dates
+
+Dates (`<date>` or `YYYY-MM-DD`) used in this documentation are not limited to `YYYY-MM-DD` format. You can also use `MM/DD/YYYY`, `DD.MM.YYYY`, `YYYYMMDD`, etc. Dates are parsed by [`Date::parse`](https://ruby-doc.org/stdlib-1.9.3/libdoc/date/rdoc/DateTime.html#method-c-parse).
+
 ## Project Links
 
 - [Blog Post about Wallet](http://blog.fox21.at/2015/07/09/wallet.html)
-- [Gem](https://rubygems.org/gems/thefox-wallet)
+- [Wallet Gem](https://rubygems.org/gems/thefox-wallet)
 - [Travis CI Repository](https://travis-ci.org/TheFox/wallet)
 
 ## License

data/bin/wallet

@@ -20,56 +20,59 @@ opts = OptionParser.new do |o|
 	o.separator('    categories   List categories')
 	o.separator('    clear        Clear temp and cache files')
 	o.separator('    csv          Import/Export CSV file')
-	o.separator('    html         Generate HTML files')
+	o.separator('    html         Exports a wallet as HTML')
 	o.separator('    list         List entries')
-	o.separator('    vi           Import per VIM editor')
 	o.separator('')
 	
 	o.on('-w', '--wallet <path>', 'Path to wallet directory.') do |path|
 		@options[:wallet_path] = Pathname.new(path).expand_path
 	end
 	
-	o.on('--id <id>', 'ID used for the entry.') do |id|
+	o.on('--id <id>', 'ID used for a new entry.') do |id|
 		@options[:entry_id] = id
 	end
 	
-	o.on('-t', '--title <title>', 'Title used for the entry.') do |title|
+	o.on('-t', '--title <title>', 'Title used for a new entry.') do |title|
 		@options[:entry_title] = title
 	end
 	
-	o.on('-d', '--date <date>', 'Date used for the entry.') do |date|
+	o.on('-d', '--date <YYYY-MM-DD>', 'Date used for a new entry.') do |date|
 		@options[:entry_date] = date
 	end
 	
-	o.on('--start <date>', 'Start date used for a range.') do |date|
+	o.on('--start <YYYY-MM-DD>', 'Start-date used for a range.') do |date|
 		@options[:entry_date_start] = Date.parse(date)
 	end
 	
-	o.on('--end <date>', 'End date used for a range.') do |date|
+	o.on('--end <YYYY-MM-DD>', 'End-date used for a range.') do |date|
 		@options[:entry_date_end] = Date.parse(date)
 	end
 	
-	o.on('-r', '--revenue <revenue>', 'Revenue used for the entry.') do |revenue|
-		@options[:entry_revenue] = revenue.to_s.sub(/,/, '.').to_f.abs
+	o.on('-r', '--revenue <revenue>', 'Revenue used for a new entry.') do |revenue|
+		# @TODO replace with Wumber.
+		# @options[:entry_revenue] = revenue.to_s.sub(/,/, '.').to_f.abs
+		@options[:entry_revenue] = eval(revenue.to_s.to_s.gsub(/,/, '.')).to_f.round(TheFox::Wallet::NUMBER_ROUND).abs
 	end
 	
-	o.on('-e', '--expense <expense>', 'Expense used for the entry.') do |expense|
-		@options[:entry_expense] = -expense.to_s.sub(/,/, '.').to_f.abs
+	o.on('-e', '--expense <expense>', 'Expense used for a new entry.') do |expense|
+		# @TODO replace with Wumber.
+		# @options[:entry_expense] = -expense.to_s.sub(/,/, '.').to_f.abs
+		@options[:entry_expense] = -eval(expense.to_s.gsub(/,/, '.')).to_f.round(TheFox::Wallet::NUMBER_ROUND).abs
 	end
 	
-	o.on('-c', '--category <category>', 'Category used for the entry.') do |category|
+	o.on('-c', '--category <category>', 'Category used for a new entry.') do |category|
 		@options[:entry_category] = category
 	end
 	
-	o.on('-o', '--comment <comment>', 'Comment used for the entry.') do |comment|
+	o.on('-o', '--comment <comment>', 'Comment used for a new entry.') do |comment|
 		@options[:entry_comment] = comment
 	end
 	
-	o.on('--import', 'Import') do
+	o.on('--import', 'Import CSV') do
 		@options[:is_import] = true
 	end
 	
-	o.on('--export', 'Export') do
+	o.on('--export', 'Export CSV') do
 		@options[:is_export] = true
 	end
 	
@@ -118,5 +121,6 @@ if command_name
 		exit 1
 	end
 else
+	# Show help page when no argument was given.
 	opts.parse(['-h'])
 end

data/lib/wallet/command.rb

@@ -1,4 +1,7 @@
 
+# Basic Command
+# All other commands subclass from this class.
+
 require 'date'
 require 'pathname'
 
@@ -9,9 +12,9 @@ module TheFox::Wallet
 		NAME = 'default'
 		
 		def initialize(options = Hash.new)
-			@options = options || Hash.new
-			@options[:logger] ||= nil
-			
+			# Initialize all options.
+			@options = options
+			@options[:logger] ||= Logger.new(IO::NULL)
 			@options[:wallet_path] ||= Pathname.new('wallet')
 			@options[:entry_id] ||= nil
 			@options[:entry_title] ||= nil
@@ -32,7 +35,7 @@ module TheFox::Wallet
 		def run
 		end
 		
-		def self.create_by_name(name, options = nil)
+		def self.create_by_name(name, options = Hash.new)
 			classes = [
 				AddCommand,
 				CategoriesCommand,
@@ -42,10 +45,12 @@ module TheFox::Wallet
 				ListCommand,
 			]
 			
+			# Search class by name.
 			classes.each do |cclass|
-				#puts "class: '#{cclass::NAME}' '#{cclass.is_matching_class(name)}'"
 				if cclass.is_matching_class(name)
-					return cclass.new(options)
+					# Create a new Object from the found Class.
+					cmd = cclass.new(options)
+					return cmd
 				end
 			end
 			

data/lib/wallet/command_add.rb

@@ -3,6 +3,7 @@ require 'date'
 
 module TheFox::Wallet
 	
+	# Add a new Entry.
 	class AddCommand < Command
 		
 		NAME = 'add'
@@ -13,15 +14,18 @@ module TheFox::Wallet
 			end
 			
 			if @options[:is_interactively]
+				# Interactive User Input
+				
 				print "title: [#{@options[:entry_title]}] "
 				title_t = STDIN.gets.strip
 				if title_t.length > 0
+					# Search for '%d' in title.
 					if @options[:entry_title] =~ /%d/
+						# Like sprintf.
 						@options[:entry_title] = @options[:entry_title] % title_t.split(',').map{ |s| s.strip }
 					else
 						@options[:entry_title] = title_t
 					end
-					puts "title: #{@options[:entry_title]}"
 				end
 				
 				print "date: [#{@options[:entry_date]}] "
@@ -61,6 +65,8 @@ module TheFox::Wallet
 				raise "Option --title is required for command '#{NAME}'"
 			end
 			
+			# --force option
+			# --id    option
 			is_unique = !@options[:force] && @options[:entry_id]
 			
 			puts "id:       '#{@options[:entry_id]}'"
@@ -74,8 +80,13 @@ module TheFox::Wallet
 			puts "force:    #{@options[:force] ? 'YES' : 'NO'}"
 			puts "unique:   #{is_unique ? 'YES' : 'NO'} (#{is_unique})"
 			
+			# Create new Entry.
 			entry = Entry.new(@options[:entry_id], @options[:entry_title], @options[:entry_date], @options[:entry_revenue], @options[:entry_expense], @options[:entry_category], @options[:entry_comment])
+			
+			# Initialize Wallet.
 			wallet = Wallet.new(@options[:wallet_path])
+			
+			# Add Entry to Wallet.
 			added = wallet.add(entry, is_unique)
 			
 			puts "added:    #{added ? 'YES' : 'NO'}"
@@ -83,20 +94,23 @@ module TheFox::Wallet
 			added
 		end
 		
+		# @TODO replace with Wumber.
 		def revenue(revenue_s)
-			rv = nil
 			if !revenue_s.nil? && revenue_s.length > 0
-				rv = eval(revenue_s.to_s.gsub(/,/, '.')).to_f.round(NUMBER_ROUND).abs
+				# Replace , with . in numbers. '1,23' means '1.23'.
+				# eval the revenue so calculations are solved.
+				eval(revenue_s.to_s.gsub(/,/, '.')).to_f.round(NUMBER_ROUND).abs
 			end
-			rv
 		end
 		
+		# @TODO replace with Wumber.
 		def expense(expense_s)
-			rv = nil
 			if !expense_s.nil? && expense_s.length > 0
-				rv = -eval(expense_s.to_s.gsub(/,/, '.')).to_f.round(NUMBER_ROUND).abs
+				# Replace , with . in numbers. '1,23' means '1.23'.
+				# eval the revenue so calculations are solved.
+				# Expenses are always minus.
+				-eval(expense_s.to_s.gsub(/,/, '.')).to_f.round(NUMBER_ROUND).abs
 			end
-			rv
 		end
 		
 	end

data/lib/wallet/command_categories.rb

@@ -1,6 +1,7 @@
 
 module TheFox::Wallet
 	
+	# List all used categories.
 	class CategoriesCommand < Command
 		
 		NAME = 'categories'

data/lib/wallet/command_clear.rb

@@ -3,6 +3,7 @@ require 'pathname'
 
 module TheFox::Wallet
 	
+	# Clear temp and cache files.
 	class ClearCommand < Command
 		
 		NAME = 'clear'

data/lib/wallet/command_csv.rb

@@ -1,6 +1,7 @@
 
 module TheFox::Wallet
 	
+	# Import or export to/from CSV file format.
 	class CsvCommand < Command
 		
 		NAME = 'csv'
@@ -13,11 +14,14 @@ module TheFox::Wallet
 			wallet = Wallet.new(@options[:wallet_path])
 			wallet.logger = @options[:logger]
 			
+			# Import by default.
 			if @options[:is_import] || !@options[:is_export]
+				# Import
 				@options[:logger].info("import csv #{@options[:path]} ...") if @options[:logger]
 				wallet.import_csv_file(@options[:path])
 				@options[:logger].info("import csv #{@options[:path]} done") if @options[:logger]
 			elsif @options[:is_export]
+				# Export
 				@options[:logger].info("export csv #{@options[:path]} ...") if @options[:logger]
 				wallet.export_csv_file(@options[:path])
 				@options[:logger].info("export csv #{@options[:path]} done") if @options[:logger]

data/lib/wallet/command_html.rb

@@ -3,6 +3,9 @@ require 'pathname'
 
 module TheFox::Wallet
 	
+	# Exports a wallet as HTML.
+	# List all years in an index HTML file and all months for each year.
+	# Generates a HTML file for each month based on entries.
 	class HtmlCommand < Command
 		
 		NAME = 'html'

data/lib/wallet/command_list.rb

@@ -1,6 +1,8 @@
 
 module TheFox::Wallet
 	
+	# List entries. Per default this command lists all entries of today.
+	# @TODO Use terminal-table for output? https://github.com/tj/terminal-table
 	class ListCommand < Command
 		
 		NAME = 'list'
@@ -10,8 +12,8 @@ module TheFox::Wallet
 			
 			wallet = Wallet.new(@options[:wallet_path])
 			entries = wallet.entries(@options[:entry_date], @options[:entry_category].to_s)
-			#entries = wallet.entries(@options[:entry_date], @options[:entry_end_date], @options[:entry_category].to_s)
 			
+			# Get max length of all columns.
 			entries_l = entries
 				.map{ |day_name, day_items| day_items.count }
 				.inject{ |sum, n| sum + n }
@@ -55,6 +57,7 @@ module TheFox::Wallet
 				.select{ |i| i != '' }
 				.count > 0
 			
+			# Limit some columns to a maximum length.
 			if title_l < 6
 				title_l = 6
 			end
@@ -78,6 +81,7 @@ module TheFox::Wallet
 				comment_l = 25
 			end
 			
+			# Format String for each column.
 			entries_f = "%#{entries_l}s"
 			title_f = "%-#{title_l}s"
 			revenue_f = "%#{revenue_l}s"
@@ -86,6 +90,7 @@ module TheFox::Wallet
 			category_f = "%-#{category_l}s"
 			comment_f = "%-#{comment_l}s"
 			
+			# Create a table header.
 			header = ''
 			header << '#' * entries_l << '  '
 			header << 'Date ' << ' ' * 7
@@ -102,15 +107,24 @@ module TheFox::Wallet
 			
 			header_l = header.length
 			header.sub!(/ +$/, '')
+			
+			# Print table header.
 			puts header
 			puts '-' * header_l
 			
+			# Sums
 			revenue_total = 0.0
 			expense_total = 0.0
 			balance_total = 0.0
+			
+			# Do not repeat the same date over and over again.
 			previous_date = ''
+			
 			entry_no = 0
+			
+			# Iterate all days.
 			entries.sort.each do |day_name, day_items|
+				# Iterate all entries of a day.
 				day_items.each do |entry|
 					entry_no += 1
 					
@@ -124,7 +138,6 @@ module TheFox::Wallet
 					balance_total += entry['balance']
 					
 					category = entry['category'] == 'default' ? '' : entry['category']
-					# has_category = category != ''
 					
 					comment = entry['comment']
 					if comment.length >= 25

data/lib/wallet/entry.rb

@@ -37,6 +37,7 @@ module TheFox
 				revenue_t = revenue.to_f
 				expense_t = expense.to_f
 				if revenue_t < 0 && expense_t == 0
+					# Revenue is minus and no expense was provided.
 					self.revenue = 0.0
 					self.expense = revenue_t
 				else
@@ -57,19 +58,17 @@ module TheFox
 			end
 			
 			def date=(date)
-				# puts "class: #{date.class}"
 				case date
 				when String
-					# puts 'String'
+					# String
 					@date = Date.parse(date)
 				when Fixnum
-					# puts 'Fixnum'
+					# Fixnum
 					@date = Time.at(date).to_date
 				when Date
-					# puts 'Date'
+					# Date
 					@date = date
 				else
-					# puts 'RAISE'
 					raise ArgumentError, "Wrong class: #{date.class}"
 				end
 			end
@@ -104,6 +103,7 @@ module TheFox
 				@comment = comment.nil? ? '' : comment.to_s
 			end
 			
+			# Convert Entry to a Hash.
 			def to_h
 				{
 					'id' => @id,
@@ -117,6 +117,7 @@ module TheFox
 				}
 			end
 			
+			# Restore a Entry from a Hash.
 			def self.from_h(h)
 				id = h['id']
 				title = h['title']

data/lib/wallet/version.rb

@@ -2,8 +2,8 @@
 module TheFox
 	module Wallet
 		NAME = 'Wallet'
-		VERSION = '0.16.0'
-		DATE = '2017-02-19'
+		VERSION = '0.17.0'
+		DATE = '2017-08-12'
 		HOMEPAGE = 'https://github.com/TheFox/wallet'
 		
 		NUMBER_FORMAT = '%.2f'

data/lib/wallet/wallet.rb

@@ -1,5 +1,5 @@
 
-# Schmeisst die Fuffies durch den Club und schreit Boah Boah!
+# Wallet Main Class
 
 require 'logger'
 require 'yaml'
@@ -7,8 +7,9 @@ require 'yaml/store'
 require 'csv'
 require 'pathname'
 require 'fileutils'
-require 'ostruct' # OpenStruct use to generate HTML.
-# require 'pp'
+
+# OpenStruct use to generate HTML.
+require 'ostruct'
 
 module TheFox
 	module Wallet
@@ -20,12 +21,14 @@ module TheFox
 			
 			def initialize(dir_path = nil)
 				@exit = false
-				@logger = nil
+				@logger = Logger.new(IO::NULL)
 				@dir_path = dir_path || Pathname.new('wallet').expand_path
 				@dir_path_basename = @dir_path.basename
 				@dir_path_basename_s = @dir_path_basename.to_s
 				@data_path = Pathname.new('data').expand_path(@dir_path)
 				@tmp_path = Pathname.new('tmp').expand_path(@dir_path)
+				
+				# Internal path. Not the same as provided by --path option.
 				@html_path = Pathname.new('html').expand_path(@dir_path)
 				
 				@has_transaction = false
@@ -37,11 +40,13 @@ module TheFox
 				@entries_index_is_loaded = false
 				
 				Signal.trap('SIGINT') do
-					#@logger.warn('received SIGINT. break ...') if @logger
+					#@logger.warn('received SIGINT. break ...')
 					@exit = true
 				end
 			end
 			
+			# Add an Entry to the wallet.
+			# Used by Add Command.
 			def add(entry, is_unique = false)
 				if !entry.is_a?(Entry)
 					raise ArgumentError, 'variable must be a Entry instance'
@@ -166,6 +171,7 @@ module TheFox
 				@transaction_files = Hash.new
 			end
 			
+			# Sums a year, a month, a day or a certain category.
 			def sum(year = nil, month = nil, day = nil, category = nil)
 				year_s = year.to_i.to_s
 				month_f = '%02d' % month.to_i
@@ -225,8 +231,25 @@ module TheFox
 				sum(nil, nil, nil, category)
 			end
 			
+			# Get all entries.
+			# Used by List Command.
 			def entries(begin_date, category = nil)
-				begin_year, begin_month, begin_day = begin_date.split('-').map{ |n| n.to_i }
+				begin_year, begin_month, begin_day = begin_date.split('-') #.map{ |n| n.to_i }
+				
+				if begin_year.length > 4
+					# When begin_date got not splitted by '-'.
+					# YYYYM[MD[D]]
+					
+					begin_month = begin_year[4..-1]
+					begin_year = begin_year[0..3]
+					
+					if begin_month.length > 2
+						# YYYYMMD[D]
+						
+						begin_day = begin_month[2..-1]
+						begin_month = begin_month[0..1]
+					end
+				end
 				
 				begin_year_s = begin_year.to_i.to_s
 				begin_month_f = '%02d' % begin_month.to_i
@@ -243,7 +266,7 @@ module TheFox
 				
 				category = category.to_s.downcase
 				
-				entries_a = Hash.new
+				entries_h = Hash.new
 				Dir[glob].each do |file_path|
 					
 					data = YAML.load_file(file_path)
@@ -251,21 +274,21 @@ module TheFox
 						if begin_day
 							day_key = "#{begin_year_s}-#{begin_month_f}-#{begin_day_f}"
 							if data['days'].has_key?(day_key)
-								entries_a[day_key] = data['days'][day_key]
+								entries_h[day_key] = data['days'][day_key]
 							end
 						else
-							entries_a.merge!(data['days'])
+							entries_h.merge!(data['days'])
 						end
 					else
 						if begin_day
 							day_key = "#{begin_year_s}-#{begin_month_f}-#{begin_day_f}"
 							if data['days'].has_key?(day_key)
-								entries_a[day_key] = data['days'][day_key].keep_if{ |day_item|
+								entries_h[day_key] = data['days'][day_key].keep_if{ |day_item|
 									day_item['category'].downcase == category
 								}
 							end
 						else
-							entries_a.merge!(data['days'].map{ |day_name, day_items|
+							entries_h.merge!(data['days'].map{ |day_name, day_items|
 								day_items.keep_if{ |day_item|
 									day_item['category'].downcase == category
 								}
@@ -277,9 +300,11 @@ module TheFox
 					end
 					
 				end
-				entries_a
+				entries_h
 			end
 			
+			# Get all used categories.
+			# Used by Categories Command.
 			def categories
 				categories_h = Hash.new
 				Dir[Pathname.new('month_*.yml').expand_path(@data_path)].each do |file_path|
@@ -304,14 +329,14 @@ module TheFox
 				categories_a
 			end
 			
-			##
+			# Used by HTML Command.
 			# Generate HTML files from date_start to date_end.
 			def generate_html(html_path = nil, date_start = nil, date_end = nil, category = nil)
 				# @FIXME use @exit on all loops in this function
 				
 				html_path ||= @html_path
 				
-				@logger.info("generate html to #{html_path} ...") if @logger
+				@logger.info("generate html to #{html_path} ...")
 				
 				create_dirs
 				
@@ -352,6 +377,7 @@ module TheFox
 				gitignore_file.write('*')
 				gitignore_file.close
 				
+				# Write CSS file.
 				css_file_path = Pathname.new('style.css').expand_path(html_path)
 				css_file = File.open(css_file_path, 'w')
 				css_file.write('
@@ -396,7 +422,7 @@ module TheFox
 								<link rel="stylesheet" href="style.css" type="text/css" />
 							</head>
 							<body>
-								<h1><a href="index.html">' << @dir_path_basename_s << '</a></h1>
+								<h1><a href=".">' << @dir_path_basename_s << '</a></h1>
 								<p>Generated @ ' << DateTime.now.strftime('%Y-%m-%d %H:%M:%S') << ' by <a href="' << HOMEPAGE << '">' << NAME << '</a> v' << VERSION << '</p>
 								
 								<h2>Year: ' << year_s << '</h2>
@@ -423,7 +449,7 @@ module TheFox
 					categories_available.map{ |item| categories_year_balance[item] = 0.0 }
 					year_total = Hash.new
 					
-					@logger.info("generate year #{year}") if @logger
+					@logger.info("generate year #{year}")
 					@data_path.each_child do |file_path|
 						file_name_p = file_path.basename
 						file_name_s = file_name_p.to_s
@@ -476,7 +502,7 @@ module TheFox
 						end
 						
 						if write_html
-							@logger.debug("file: #{month_file_name_s} (from #{file_name_s})") if @logger
+							@logger.debug("file: #{month_file_name_s} (from #{file_name_s})")
 							
 							month_file = File.open(month_file_path, 'w')
 							month_file.write('
@@ -487,7 +513,7 @@ module TheFox
 										<link rel="stylesheet" href="style.css" type="text/css" />
 									</head>
 									<body>
-										<h1><a href="index.html">' << @dir_path_basename_s << '</a></h1>
+										<h1><a href=".">' << @dir_path_basename_s << '</a></h1>
 										<p>Generated @ ' << DateTime.now.strftime('%Y-%m-%d %H:%M:%S') << ' by  <a href="' << HOMEPAGE << '">' << NAME << '</a> v' << VERSION << ' from <code>' << file_name_s << '</code></p>
 										
 										<h2>Month: ' << month_s << ' <a href="' << year_file_name_s << '">' << year_s << '</a></h2>
@@ -619,8 +645,10 @@ module TheFox
 					yeardat_file_path = Pathname.new("year_#{year_s}.dat").expand_path(@tmp_path)
 					yeardat_file = File.new(yeardat_file_path, 'w')
 					yeardat_file.write(year_total
+						.sort{ |a, b| a[0] <=> b[0] }
 						.map{ |k, m| "#{year_s}-#{m.month_s} #{m.revenue} #{m.expense} #{m.balance} #{m.balance_total} #{m.balance_total}" }
 						.join("\n"))
+					yeardat_file.write("\n")
 					yeardat_file.close
 					
 					gnuplot_file_path = Pathname.new("year_#{year_s}.gp").expand_path(@tmp_path)
@@ -727,10 +755,15 @@ module TheFox
 					store['changes'] = html_options['changes']
 				end
 				
+				# Convert Years Totals to DAT file rows.
 				totaldat_file_c = years_total.map{ |k, y| "#{y.year} #{y.revenue} #{y.expense} #{y.balance} #{y.balance_total}" }
+				
+				# Print maximal 10 years on GNUPlot.
 				if totaldat_file_c.count > 10
 					totaldat_file_c = totaldat_file_c.slice(-10, 10)
 				end
+				
+				# Convert DAT file rows to one String.
 				totaldat_file_c = totaldat_file_c.join("\n")
 				
 				# DAT file for GNUPlot.
@@ -768,9 +801,10 @@ module TheFox
 				
 				system("gnuplot #{gnuplot_file_path} &> /dev/null")
 				
-				@logger.info('generate html done') if @logger
+				@logger.info('generate html done')
 			end
 			
+			# Used by CSV Command.
 			def import_csv_file(file_path)
 				transaction_start
 				
@@ -800,14 +834,15 @@ module TheFox
 					
 					added = add(Entry.new(id, title, date, revenue, expense, category, comment), true)
 					
-					@logger.debug("import row '#{id}' -- #{added ? 'YES' : 'NO'}") if @logger
+					@logger.debug("import row '#{id}' -- #{added ? 'YES' : 'NO'}")
 				end
 				
-				@logger.info('save data ...') if @logger
+				@logger.info('save data ...')
 				
 				transaction_end
 			end
 			
+			# Used by CSV Command.
 			def export_csv_file(file_path)
 				csv_options = {
 					:col_sep => ',',
@@ -820,7 +855,7 @@ module TheFox
 				}
 				CSV.open(file_path, 'wb', csv_options) do |csv|
 					Dir[Pathname.new('month_*.yml').expand_path(@data_path)].each do |yaml_file_path|
-						@logger.info("export #{File.basename(yaml_file_path)}") if @logger
+						@logger.info("export #{File.basename(yaml_file_path)}")
 						
 						data = YAML.load_file(yaml_file_path)
 						
@@ -853,9 +888,11 @@ module TheFox
 				@entries_index.include?(entry.id)
 			end
 			
+			# Build an entry-by-id Hash.
+			# ID => Entry
 			def build_entry_by_id_index(force = false)
 				if @entries_by_ids.nil? || force
-					@logger.debug('build entry-by-id index') if @logger
+					@logger.debug('build entry-by-id index')
 					
 					glob = Pathname.new('month_*.yml').expand_path(@data_path)
 					
@@ -872,12 +909,14 @@ module TheFox
 				end
 			end
 			
+			# Find an Entry by a given ID.
 			def find_entry_by_id(id)
 				build_entry_by_id_index
 				
 				@entries_by_ids[id]
 			end
 			
+			# Used by Clear Command.
 			def clear
 				c = 0
 				
@@ -907,6 +946,7 @@ module TheFox
 			
 			private
 			
+			# Create all needed subdirectories for this wallet.
 			def create_dirs
 				unless @dir_path.exist?
 					@dir_path.mkpath
@@ -920,6 +960,7 @@ module TheFox
 					@tmp_path.mkpath
 				end
 				
+				# Ignore all files in wallet/tmp.
 				tmp_gitignore_path = Pathname.new('.gitignore').expand_path(@tmp_path)
 				unless tmp_gitignore_path.exist?
 					gitignore_file = File.open(tmp_gitignore_path, 'w')
@@ -930,12 +971,14 @@ module TheFox
 				if @entries_index_file_path.exist?
 					load_entries_index_file
 				else
+					# When the entries index file does not exist from an older Wallet version.
 					build_entry_by_id_index(true)
 					@entries_index = @entries_by_ids.keys
 					save_entries_index_file
 				end
 			end
 			
+			# Get the sums for a given day.
 			def calc_day(day, category = nil)
 				revenue = 0
 				expense = 0
@@ -965,8 +1008,9 @@ module TheFox
 				}
 			end
 			
+			# Get all used years.
+			# Range is optional.
 			def years(date_start = nil, date_end = nil)
-				
 				files = Array.new
 				@data_path.each_child(false) do |file|
 					if file.extname == '.yml' && /^month_/.match(file.to_s)
@@ -984,18 +1028,23 @@ module TheFox
 					.map{ |file| file.to_s[6, 4].to_i }
 					.uniq
 					.keep_if{ |year| year >= date_start_year && year <= date_end_year }
+					.sort
 			end
 			
+			# Load the entries index file only once.
 			def load_entries_index_file
-				unless @entries_index_is_loaded
-					@entries_index_is_loaded = true
-					if @entries_index_file_path.exist?
-						data = YAML.load_file(@entries_index_file_path.to_s)
-						@entries_index = data['index']
-					end
+				if @entries_index_is_loaded
+					return
+				end
+				
+				@entries_index_is_loaded = true
+				if @entries_index_file_path.exist?
+					data = YAML.load_file(@entries_index_file_path.to_s)
+					@entries_index = data['index']
 				end
 			end
 			
+			# Save the entries index file.
 			def save_entries_index_file
 				store = YAML::Store.new(@entries_index_file_path.to_s)
 				store.transaction do

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: thefox-wallet
 version: !ruby/object:Gem::Version
-  version: 0.16.0
+  version: 0.17.0
 platform: ruby
 authors:
 - Christian Mayer
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-02-19 00:00:00.000000000 Z
+date: 2017-08-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: pry
@@ -131,7 +131,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.10
+rubygems_version: 2.6.12
 signing_key: 
 specification_version: 4
 summary: Finances Tracking