Class: Roebe::FinishedBooks

Inherits:
Base show all
Defined in:
lib/roebe/classes/books/finished_books/finished_books.rb

Overview

Roebe::FinishedBooks

Constant Summary collapse

FILE_FINISHED_BOOKS =
#

FILE_FINISHED_BOOKS

#
'/home/x/books/finished_books.md'

Constants inherited from Base

Base::COLOURS, Base::HOME_DIRECTORY_OF_USER_X, Base::N, Base::NAMESPACE

Instance Method Summary collapse

Methods inherited from Base

#actions, #append_this_onto_that_file, #append_what_into, #be_silent, #be_verbose?, #beautiful_url, #burlywood, #call_next, #chdir, #cheerful_guy, #cliner, #complex_esystem, #convert_global_env, #copy_directory, #copy_file, #cornflowerblue, #create_directory, #crimson, #current_month?, #current_time?, #current_year?, #cyan, #darkcyan, #darkgreen, #darkkhaki, #darkslateblue, #deeppink, #delete_symlink, #do_not_use_the_base_colours, #do_use_the_base_colours, #e, #ecomment, #editor_to_use?, #efancy, #eimp, #emphasis, #ensure_main_encoding, #ensure_utf_encoding, #eparse, #erev, #esteelblue, #etomato, #ewarn, #exit_program, #firebrick, #get_current_day, #get_current_month, #get_files_and_directories, #get_files_from, #get_german_name_for_this_weekday, #gold, #green, #grey, #hh_mm_ss, #hh_mm_ss_day_month_year, #home_dir?, #home_directory_of_user_x?, #infer_the_namespace, #internal_hash?, #is_a_directory?, #is_a_file?, #is_a_jpg_file?, #is_an_image_file?, #is_archive?, #is_audio_file?, #is_in_studium_dir?, #is_multimedia_file?, #is_on_roebe?, #is_on_windows?, #is_studium_available?, #is_symlink?, #is_this_a_ruby_file?, #is_video_file?, #iso_encoding?, #le, #left_colour, #lightblue, #lightgreen, #lightseagreen, #lightsteelblue, #lime, #limegreen, #localhost_to_data, #log_directory?, #main_encoding?, #mediumorchid, #mediumpurple, #mediumseagreen, #mediumslateblue, #mediumspringgreen, #mediumturquoise, #mkdir_p, #mv, #n_days_in_this_month, #n_pages_in_this_pdf_file?, #namespace?, #no_file_exists_at, #ogrey, #olive, #olivedrab, #open_in_browser, #opne, #opnesystem, #opnn, #orange, #orchid, #orev, #palegoldenrod, #palevioletred, #pink, #powderblue, #programs_dir?, #project_base_dir?, #random_html_colour, #rds, #read_file_in_iso_encoding, #read_file_via_the_default_encoding, #read_lines_via_iso_encoding, #readlines_with_main_encoding, #red, #register_sigint, #remove, #remove_directory, #remove_file, #rename_kde_konsole_tab, #replace_localhost_with_data, #report_pwd, #require_rescue, #reset_the_internal_hash, #return_all_directories_from_this_directory, #return_all_files_from_this_directory, #return_current_directory, #return_dd_mm_yyyy, #return_file_or_directory_of, #return_files_from_pwd, #return_last_part_of_the_current_directory, #return_utc, #rev, #right_arrow?, #right_colour, #roebe_log_directory?, #rosybrown, #royalblue, #ruby_base_directory?, #run_in_background, #run_rcfiles_then_run_ata_via_qdbus, #sandybrown, #sdir, #seagreen, #set_be_verbose, #set_xorg_buffer, #sfancy, #sfile, #show_help, #silent_redirection?, #simp, #simple_esystem, #skyblue, #slateblue, #slategray, #springgreen, #steelblue, #string_italic, #swarn, #symlink, #teal, #temp_dir?, #to_camelcase, #to_counted_hash, #tomato, #touch, #try_to_require_the_beautiful_url_gem, #try_to_require_the_html_template, #try_to_require_the_open_gem, #try_to_require_the_program_information_gem, #try_to_require_the_xorg_buffer, #use_colours?, #verbose_truth, #weekday?, #word_wrap, #write_what_into, #yellow

Methods included from Base::CommandlineArguments

#append_onto_the_commandline_arguments, #clear_commandline_arguments, #commandline_arguments?, #commandline_arguments_as_string?, #commandline_arguments_without_leading_hyphens?, #first_argument?, #first_argument_without_leading_hyphens?, #has_an_argument_been_passed?, #remove_hyphened_arguments_from_the_commandline_arguments, #return_commandline_arguments_with_leading_hyphens, #second_argument?, #set_commandline_arguments

Constructor Details

#initialize(run_already = true) ⇒ FinishedBooks

#

initialize

#


29
30
31
32
33
34
# File 'lib/roebe/classes/books/finished_books/finished_books.rb', line 29

def initialize(
    run_already = true
  )
  reset
  run if run_already
end

Instance Method Details

#analyse_the_years_from_this_dataset(i) ⇒ Object

#

analyse_the_years_from_this_dataset

#


129
130
131
132
133
134
135
136
137
# File 'lib/roebe/classes/books/finished_books/finished_books.rb', line 129

def analyse_the_years_from_this_dataset(i)
  i.each {|line|
    # " 2 | Learn Java the Easy Way | 02.03.2020 | 14.11.2017 | 300 |  | https://www.amazon.com/Learn-Java-Easy-Way-Hands-ebook/dp/B0713P1RBH\n",
    splitted = line.split('|')
    year = splitted[2].split('.').last.to_i
    n_pages = splitted[4].to_i
    @hash_statistics_per_year[year] += n_pages
  }
end

#report_the_yearly_statisticsObject

#

report_the_yearly_statistics

#


117
118
119
120
121
122
123
124
# File 'lib/roebe/classes/books/finished_books/finished_books.rb', line 117

def report_the_yearly_statistics
  @hash_statistics_per_year.each_pair {|this_year, n_pages_were_read_in_that_year|
    e "  #{rev}Year: #{steelblue(this_year)} "+
      lightgreen(
        n_pages_were_read_in_that_year.to_i.to_s.rjust(5)
      )+"#{rev} pages were read"
  }
end

#resetObject

#

reset (reset tag)

#


39
40
41
42
43
44
45
46
47
# File 'lib/roebe/classes/books/finished_books/finished_books.rb', line 39

def reset
  super()
  infer_the_namespace
  # ======================================================================= #
  # === @hash_statistics_per_year
  # ======================================================================= #
  @hash_statistics_per_year = {}
  @hash_statistics_per_year.default = 0.0
end

#return_n_pages_read(i) ⇒ Object

#

return_n_pages_read

#


52
53
54
55
56
57
58
59
60
61
# File 'lib/roebe/classes/books/finished_books/finished_books.rb', line 52

def return_n_pages_read(i)
  i = [i].flatten.compact
  n_pages_in_total = 0
  i.each {|line|
    splitted = line.split('|').map(&:strip)
    n_pages  = splitted[4].to_i
    n_pages_in_total += n_pages
  }   
  return n_pages_in_total
end

#runObject

#

run

#


66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
# File 'lib/roebe/classes/books/finished_books/finished_books.rb', line 66

def run
  _ = FILE_FINISHED_BOOKS
  if File.exist? _
    # ===================================================================== #
    # Read in our main dataset next:
    # ===================================================================== #
    dataset = default_readlines(_)
    if dataset.any? {|line|
        line.include?('TODO NEXT')
      }
      # =================================================================== #
      # In this case we will chop down towards that line.
      # =================================================================== #
      match_index = dataset.find_index { |entry|
        entry.include?('TODO NEXT')
      }
      dataset = dataset[0 .. match_index]
    end
    dataset.select! {|line|
      # =================================================================== #
      # Select only the correct lines next. What is a correct line?
      # It must start with at the least one number, and include a ' '
      # eventually and then have a '|' token.
      # =================================================================== #
      line.count('|') >= 6 and
      (line =~ /\d+/) and # At the least one number.
      (line =~ /^\s{1}?\d{1,5} \|/)
    }.reject {|line|
      line.include? '--------'
    }
    analyse_the_years_from_this_dataset(dataset)
    e steelblue(
        'Book collection:'.ljust(33)+
        EmojiParadise.book_emoji?
      )
    e
    report_the_yearly_statistics
    e
    e lightblue('  n books were read already:'.ljust(30))+
      gold(dataset.size.to_s.rjust(5))
    e lightblue('  Total number of pages read:'.ljust(30))+
      gold(return_n_pages_read(dataset).to_s)
    e
  else
    no_file_exists_at(_)
  end
end