rcfiles 1.2.46

Sign up to get free protection for your applications and to get access to all the features.

Potentially problematic release.


This version of rcfiles might be problematic. Click here for more details.

Files changed (101) hide show
  1. checksums.yaml +7 -0
  2. data/README.md +559 -0
  3. data/bin/rcfiles +12 -0
  4. data/bin/rcfiles_run_it +7 -0
  5. data/doc/README.gen +516 -0
  6. data/img/LOGO_FOR_THE_RCFILES_PROJECT.png +0 -0
  7. data/lib/rcfiles/aggregate_all_rcfiles/aggregate_all_rcfiles.rb +137 -0
  8. data/lib/rcfiles/class/colours.rb +54 -0
  9. data/lib/rcfiles/class/initialize.rb +66 -0
  10. data/lib/rcfiles/class/misc.rb +300 -0
  11. data/lib/rcfiles/class/rcfiles.rb +31 -0
  12. data/lib/rcfiles/class/reset.rb +26 -0
  13. data/lib/rcfiles/class/run.rb +17 -0
  14. data/lib/rcfiles/colours/colours.rb +111 -0
  15. data/lib/rcfiles/commandline/commandline.rb +177 -0
  16. data/lib/rcfiles/constants/constants.rb +253 -0
  17. data/lib/rcfiles/directory_aliases/README.md +2 -0
  18. data/lib/rcfiles/directory_aliases/directory_aliases.rb +647 -0
  19. data/lib/rcfiles/directory_aliases/toplevel_stored_dataset.rb +177 -0
  20. data/lib/rcfiles/directory_aliases/yaml_file_used_by_class_directory_aliases.rb +67 -0
  21. data/lib/rcfiles/files/file_aliases.rb +78 -0
  22. data/lib/rcfiles/files/file_cd_aliases.rb +85 -0
  23. data/lib/rcfiles/files/file_ls_colours.rb +76 -0
  24. data/lib/rcfiles/files/file_path_variable.rb +74 -0
  25. data/lib/rcfiles/files/file_pkgconfig.rb +74 -0
  26. data/lib/rcfiles/files/file_programs_aliases.rb +68 -0
  27. data/lib/rcfiles/files/file_ps1.rb +80 -0
  28. data/lib/rcfiles/files/file_system_settings.rb +66 -0
  29. data/lib/rcfiles/help/help.rb +46 -0
  30. data/lib/rcfiles/no_colours.rb +13 -0
  31. data/lib/rcfiles/project/project.rb +45 -0
  32. data/lib/rcfiles/rcfiles/README.md +5 -0
  33. data/lib/rcfiles/rcfiles/aliases_rc +20431 -0
  34. data/lib/rcfiles/rcfiles/cd_aliases_rc +14980 -0
  35. data/lib/rcfiles/rcfiles/cflags_rc +9 -0
  36. data/lib/rcfiles/rcfiles/compile_rc +11 -0
  37. data/lib/rcfiles/rcfiles/file_information_rc +16 -0
  38. data/lib/rcfiles/rcfiles/gnome_rc +10 -0
  39. data/lib/rcfiles/rcfiles/kde_rc +17 -0
  40. data/lib/rcfiles/rcfiles/kernel_rc +12 -0
  41. data/lib/rcfiles/rcfiles/lang_rc +9 -0
  42. data/lib/rcfiles/rcfiles/ldflags_rc +8 -0
  43. data/lib/rcfiles/rcfiles/ls_colours_rc +9 -0
  44. data/lib/rcfiles/rcfiles/network_rc +37 -0
  45. data/lib/rcfiles/rcfiles/path_variable_rc +9 -0
  46. data/lib/rcfiles/rcfiles/pkgconfig_rc +9 -0
  47. data/lib/rcfiles/rcfiles/programs_aliases_rc +17571 -0
  48. data/lib/rcfiles/rcfiles/ps1_rc +9 -0
  49. data/lib/rcfiles/rcfiles/special_aliases_rc +8 -0
  50. data/lib/rcfiles/rcfiles/system_rc +13 -0
  51. data/lib/rcfiles/rcfiles/system_settings_rc +192 -0
  52. data/lib/rcfiles/rcfiles/term_rc +9 -0
  53. data/lib/rcfiles/rcfiles/video_rc +24 -0
  54. data/lib/rcfiles/requires/require_the_directory_aliases.rb +7 -0
  55. data/lib/rcfiles/requires/require_the_rcfiles_constants.rb +18 -0
  56. data/lib/rcfiles/requires/require_the_rcfiles_project.rb +67 -0
  57. data/lib/rcfiles/requires/try_to_require_syck_and_psych.rb +18 -0
  58. data/lib/rcfiles/toplevel_methods/autogenerate_rc_file_from_this_yaml_file.rb +102 -0
  59. data/lib/rcfiles/toplevel_methods/change_directory.rb +16 -0
  60. data/lib/rcfiles/toplevel_methods/convert.rb +118 -0
  61. data/lib/rcfiles/toplevel_methods/convert_global_variables_in_the_cd_aliases_file_to_a_standalone_yaml_file.rb +50 -0
  62. data/lib/rcfiles/toplevel_methods/create_windows_cd_aliases_bat_file.rb +51 -0
  63. data/lib/rcfiles/toplevel_methods/e.rb +16 -0
  64. data/lib/rcfiles/toplevel_methods/esystem.rb +19 -0
  65. data/lib/rcfiles/toplevel_methods/generate_yaml_files.rb +148 -0
  66. data/lib/rcfiles/toplevel_methods/infer.rb +83 -0
  67. data/lib/rcfiles/toplevel_methods/is_on_roebe.rb +16 -0
  68. data/lib/rcfiles/toplevel_methods/main_directory.rb +108 -0
  69. data/lib/rcfiles/toplevel_methods/misc.rb +341 -0
  70. data/lib/rcfiles/toplevel_methods/n_registered_aliases_in_total.rb +55 -0
  71. data/lib/rcfiles/toplevel_methods/no_file_exists_at.rb +19 -0
  72. data/lib/rcfiles/toplevel_methods/notifications.rb +35 -0
  73. data/lib/rcfiles/toplevel_methods/rds.rb +16 -0
  74. data/lib/rcfiles/toplevel_methods/remove_newlines.rb +29 -0
  75. data/lib/rcfiles/toplevel_methods/report.rb +53 -0
  76. data/lib/rcfiles/toplevel_methods/return_standard_header.rb +36 -0
  77. data/lib/rcfiles/toplevel_methods/run_it.rb +46 -0
  78. data/lib/rcfiles/toplevel_methods/save_file.rb +27 -0
  79. data/lib/rcfiles/toplevel_methods/use_psych_or_syck.rb +50 -0
  80. data/lib/rcfiles/toplevel_methods/use_quotes.rb +68 -0
  81. data/lib/rcfiles/toplevel_methods/verbosity.rb +28 -0
  82. data/lib/rcfiles/version/version.rb +26 -0
  83. data/lib/rcfiles/yaml/aliases.yml +23069 -0
  84. data/lib/rcfiles/yaml/cd_aliases.yml +15699 -0
  85. data/lib/rcfiles/yaml/global_variables/README.md +3 -0
  86. data/lib/rcfiles/yaml/global_variables/global_variables_extracted_from_the_file_cd_aliases.yml +121 -0
  87. data/lib/rcfiles/yaml/ls_colours.yml +128 -0
  88. data/lib/rcfiles/yaml/path_variable.yml +13 -0
  89. data/lib/rcfiles/yaml/pkgconfig.yml +46 -0
  90. data/lib/rcfiles/yaml/programs_aliases.yml +19203 -0
  91. data/lib/rcfiles/yaml/programs_aliases.yml~ +19086 -0
  92. data/lib/rcfiles/yaml/ps1.yml +82 -0
  93. data/lib/rcfiles/yaml/store_into_this_directory.yml +1 -0
  94. data/lib/rcfiles/yaml/system_settings.yml +526 -0
  95. data/lib/rcfiles/yaml/use_psych_or_syck.yml +1 -0
  96. data/lib/rcfiles.rb +1 -0
  97. data/rcfiles.gemspec +57 -0
  98. data/test/testing_directory_aliases.rb +47 -0
  99. data/test/testing_using_another_path_to_directory_aliases.rb +17 -0
  100. data/test/testing_yaml_to_rcfiles.rb +9 -0
  101. metadata +205 -0
@@ -0,0 +1,68 @@
1
+ #!/usr/bin/ruby -w
2
+ # Encoding: UTF-8
3
+ # frozen_string_literal: true
4
+ # =========================================================================== #
5
+ # require 'rcfiles/files/file_programs_aliases.rb'
6
+ # =========================================================================== #
7
+ module Rcfiles
8
+
9
+ require 'rcfiles/project/project.rb'
10
+ require 'rcfiles/toplevel_methods/is_on_roebe.rb'
11
+ require 'rcfiles/toplevel_methods/convert.rb'
12
+ require 'rcfiles/toplevel_methods/notifications.rb'
13
+
14
+ # ========================================================================= #
15
+ # === Rcfiles.set_programs_aliases
16
+ # ========================================================================= #
17
+ def self.set_programs_aliases(
18
+ i = :default
19
+ )
20
+ case i
21
+ when :default, nil
22
+ if is_on_roebe? and File.exist?('/Depot/programs_aliases.yml')
23
+ i = '/Depot/programs_aliases.yml'
24
+ else
25
+ i = "#{project_yaml_dir?}programs_aliases.yml"
26
+ end
27
+ end
28
+ @file_programs_aliases = i
29
+ end
30
+
31
+ # ========================================================================= #
32
+ # === Rcfiles::@file_programs_aliases
33
+ # ========================================================================= #
34
+ @file_programs_aliases = nil
35
+
36
+ set_programs_aliases
37
+
38
+ # ========================================================================= #
39
+ # === Rcfiles.file_programs_aliases?
40
+ # ========================================================================= #
41
+ def self.file_programs_aliases?
42
+ @file_programs_aliases
43
+ end; self.instance_eval { alias file_programs_aliases file_programs_aliases? } # === Rcfiles.file_programs_aliases
44
+
45
+ # ========================================================================= #
46
+ # === Rcfiles.generate_programs_aliases_rcfile
47
+ # ========================================================================= #
48
+ def self.generate_programs_aliases_rcfile
49
+ _ = @file_programs_aliases
50
+ if File.exist? _
51
+ into = "#{main_directory?}programs_aliases_rc"
52
+ notify_the_user_that_this_file_will_be_generated_from_that_existing_file(into, _)
53
+ what = return_standard_header(into).dup
54
+ hash_dataset = YAML.load_file(_)
55
+ hash_dataset.each_pair {|key, value|
56
+ if @use_quotes
57
+ what << "alias '#{key}'=\"#{value}\"\n"
58
+ else
59
+ what << "alias #{key}=#{value}\n"
60
+ end
61
+ }
62
+ write_what_into(what, into)
63
+ else
64
+ no_file_exists_at(_)
65
+ end
66
+ end
67
+
68
+ end
@@ -0,0 +1,80 @@
1
+ #!/usr/bin/ruby -w
2
+ # Encoding: UTF-8
3
+ # frozen_string_literal: true
4
+ # =========================================================================== #
5
+ # require 'rcfiles/files/file_ps1.rb'
6
+ # Rcfiles.generate_ps1_rcfile
7
+ # =========================================================================== #
8
+ module Rcfiles
9
+
10
+ require 'rcfiles/project/project.rb'
11
+ require 'rcfiles/toplevel_methods/is_on_roebe.rb'
12
+ require 'rcfiles/toplevel_methods/convert.rb'
13
+ require 'rcfiles/toplevel_methods/notifications.rb'
14
+ require 'rcfiles/files/file_path_variable.rb'
15
+
16
+ # ========================================================================= #
17
+ # === Rcfiles.set_file_ps1
18
+ # ========================================================================= #
19
+ def self.set_file_ps1(
20
+ i = :default
21
+ )
22
+ case i
23
+ when :default, nil
24
+ if is_on_roebe? and File.exist?('/Depot/ps1.yml')
25
+ i = '/Depot/ps1.yml'
26
+ else
27
+ i = "#{project_yaml_dir?}ps1.yml"
28
+ end
29
+ end
30
+ @file_ps1 = i
31
+ end
32
+
33
+ # ========================================================================= #
34
+ # === @file_ps1
35
+ #
36
+ # On my home system, the value of the toplevel @file_ps1 instance
37
+ # variable points to a file path such as:
38
+ #
39
+ # /Programs/Ruby/2.5.0/lib/ruby/site_ruby/2.5.0/rcfile_generator/yaml/ps1.yml
40
+ #
41
+ # It may also point to another target location, though.
42
+ # ========================================================================= #
43
+ @file_ps1 = nil
44
+
45
+ # ========================================================================= #
46
+ # === Rcfiles.file_ps1?
47
+ # ========================================================================= #
48
+ def self.file_ps1?
49
+ @file_ps1
50
+ end; self.instance_eval { alias file_ps1 file_path_variable? } # === Rcfiles.file_ps1
51
+
52
+ # ========================================================================= #
53
+ # And set it at once.
54
+ # ========================================================================= #
55
+ set_file_ps1
56
+
57
+ # ========================================================================= #
58
+ # === Rcfiles.generate_ps1_rcfile
59
+ # ========================================================================= #
60
+ def self.generate_ps1_rcfile
61
+ _ = @file_ps1
62
+ if File.exist? _
63
+ into = "#{main_directory?}ps1_rc"
64
+ notify_the_user_that_this_file_will_be_generated_from_that_existing_file(into, _)
65
+ dataset = YAML.load_file(_)
66
+ what = return_standard_header(into).dup
67
+ what << convert_this_hash_to_export_file(
68
+ dataset
69
+ )
70
+ write_what_into(what, into)
71
+ else
72
+ no_file_exists_at(_)
73
+ end
74
+ end
75
+
76
+ end
77
+
78
+ if __FILE__ == $PROGRAM_NAME
79
+ Rcfiles.generate_ps1_rcfile
80
+ end
@@ -0,0 +1,66 @@
1
+ #!/usr/bin/ruby -w
2
+ # Encoding: UTF-8
3
+ # frozen_string_literal: true
4
+ # =========================================================================== #
5
+ # require 'rcfiles/files/file_system_settings.rb'
6
+ # =========================================================================== #
7
+ module Rcfiles
8
+
9
+ require 'rcfiles/project/project.rb'
10
+ require 'rcfiles/toplevel_methods/is_on_roebe.rb'
11
+ require 'rcfiles/toplevel_methods/convert.rb'
12
+ require 'rcfiles/toplevel_methods/notifications.rb'
13
+
14
+ # ========================================================================= #
15
+ # === Rcfiles.set_system_settings
16
+ # ========================================================================= #
17
+ def self.set_system_settings(
18
+ i = :default
19
+ )
20
+ case i
21
+ when :default, nil
22
+ if is_on_roebe? and File.exist?('/Depot/system_settings.yml')
23
+ i = '/Depot/system_settings.yml'
24
+ else
25
+ i = "#{project_yaml_dir?}system_settings.yml"
26
+ end
27
+ end
28
+ @file_system_settings = i.to_s
29
+ end
30
+
31
+ # ========================================================================= #
32
+ # === Rcfiles::@file_system_settings
33
+ # ========================================================================= #
34
+ @file_system_settings = nil
35
+
36
+ set_system_settings
37
+
38
+ # ========================================================================= #
39
+ # === Rcfiles.file_system_settings?
40
+ # ========================================================================= #
41
+ def self.file_system_settings?
42
+ @file_system_settings
43
+ end; self.instance_eval { alias file_system_settings file_system_settings? } # === Rcfiles.file_system_settings
44
+ self.instance_eval { alias system_settings file_system_settings? } # === Rcfiles.system_settings
45
+ self.instance_eval { alias system_settings? file_system_settings? } # === Rcfiles.system_settings?
46
+
47
+ # ========================================================================= #
48
+ # === Rcfiles.generate_system_settings_rcfile
49
+ # ========================================================================= #
50
+ def self.generate_system_settings_rcfile
51
+ _ = @file_system_settings
52
+ if File.exist? _
53
+ into = "#{main_directory?}system_settings_rc"
54
+ notify_the_user_that_this_file_will_be_generated_from_that_existing_file(into, _)
55
+ what = return_standard_header(into).dup
56
+ hash_dataset = YAML.load_file(_)
57
+ hash_dataset.each_pair {|key, value|
58
+ what << "export #{key}=\"#{value}\"\n"
59
+ }
60
+ write_what_into(what, into)
61
+ else
62
+ no_file_exists_at(_)
63
+ end
64
+ end
65
+
66
+ end
@@ -0,0 +1,46 @@
1
+ #!/usr/bin/ruby -w
2
+ # Encoding: UTF-8
3
+ # frozen_string_literal: true
4
+ # =========================================================================== #
5
+ # require 'rcfiles/help/help.rb'
6
+ # =========================================================================== #
7
+ require 'rcfiles/colours/colours.rb'
8
+ require 'rcfiles/toplevel_methods/e.rb'
9
+
10
+ module Rcfiles
11
+
12
+ # ========================================================================= #
13
+ # === Rcfiles.show_help (help tag)
14
+ #
15
+ # To invoke this help method, do this:
16
+ #
17
+ # rcfiles --help
18
+ #
19
+ # ========================================================================= #
20
+ def self.show_help
21
+ result = <<EOF
22
+
23
+ These options are available for the Rcfiles namespace:
24
+
25
+ --directory? # get notified which directory will be used
26
+ # to keep the generated rc-files
27
+ --set /directory # generate the rc-files into this directory
28
+ --no-quotes # generate the files without any "" quotes
29
+ --utf8 # generate UTF8-conforming yaml files
30
+ --copy-rcfiles # copies the rcfiles into the current working directory
31
+ # (note that --copy or just --cp would also work)
32
+ --windows-cd-aliases # create a .bat file for the cd-aliases on windows
33
+ --n_aliases? # return how many aliases are registered in the
34
+ # rcfiles project
35
+
36
+ Note that if you do not pass any options then the rc-files will
37
+ be generated into the default directory.
38
+
39
+ If you pass a .yml file as input, then we will generate rc-files
40
+ based on the entries found within that yaml file.
41
+
42
+ EOF
43
+ e result
44
+ end
45
+
46
+ end
@@ -0,0 +1,13 @@
1
+ #!/usr/bin/ruby -w
2
+ # Encoding: UTF-8
3
+ # frozen_string_literal: true
4
+ # =========================================================================== #
5
+ # This file can be used to require the namespace Rcfiles, with colours
6
+ # support already having been disabled.
7
+ # =========================================================================== #
8
+ # require 'rcfiles/no_colours.rb'
9
+ # require 'rcfiles/no_colours.rb'; Rcfiles.run
10
+ # =========================================================================== #
11
+ require 'rcfiles/requires/require_the_rcfiles_project.rb'
12
+
13
+ Rcfiles.no_colours
@@ -0,0 +1,45 @@
1
+ #!/usr/bin/ruby -w
2
+ # Encoding: UTF-8
3
+ # frozen_string_literal: true
4
+ # =========================================================================== #
5
+ # require 'rcfiles/project/project.rb'
6
+ # =========================================================================== #
7
+ module Rcfiles
8
+
9
+ # ========================================================================= #
10
+ # === Rcfiles.set_project_base_directory
11
+ # ========================================================================= #
12
+ def self.set_project_base_directory(
13
+ i = :default
14
+ )
15
+ case i
16
+ when :default
17
+ i = File.absolute_path("#{__dir__}/..")
18
+ end
19
+ unless i.end_with? '/'
20
+ i = i.dup if i.frozen?
21
+ i << '/'
22
+ end
23
+ # ======================================================================= #
24
+ # === Rcfiles::@project_base_directory
25
+ # ======================================================================= #
26
+ @project_base_directory = i
27
+ end
28
+
29
+ set_project_base_directory(:default)
30
+
31
+ # ========================================================================= #
32
+ # === Rcfiles.project_base_dir?
33
+ # ========================================================================= #
34
+ def self.project_base_dir?
35
+ @project_base_directory
36
+ end; self.instance_eval { alias project_base_directory? project_base_dir? } # === Rcfiles.project_base_directory?
37
+
38
+ # ========================================================================= #
39
+ # === Rcfiles.project_yaml_dir?
40
+ # ========================================================================= #
41
+ def self.project_yaml_dir?
42
+ "#{@project_base_directory}yaml/"
43
+ end; self.instance_eval { alias project_yaml_directory? project_yaml_dir? } # === Rcfiles.project_yaml_directory?
44
+
45
+ end
@@ -0,0 +1,5 @@
1
+ This directory also includes a copy of my autogenerated rc-files.
2
+
3
+ By bundling these files into the rcfiles-project directly, it is
4
+ made significantly easier for me to re-use these aliases on
5
+ other computers.