Class: Roebe::GenerateGemspec

Inherits:
Base show all
Defined in:
lib/roebe/classes/generate_gemspec/generate_gemspec.rb,
lib/roebe/classes/generate_gemspec/constants.rb

Overview

require ‘generate_gemspec’; GenerateGemspec

Constant Summary collapse

AUTHOR_NAME =
#

AUTHOR_NAME

#
'Robert A. Heiler'
AUTHOR_EMAIL =
#

AUTHOR_EMAIL

#
'[email protected]'
REQUIRED_MINIMAL_RUBY_VERSION =
#

REQUIRED_MINIMAL_RUBY_VERSION

Which ruby version to use. Has to be manually updated for now.

#
'2.3.2'
REQUIRED_RUBYGEM_VERSION =

Which is the most recent rubygem version.

'2.6.8'
USE_THIS_LICENSE =
#

USE_THIS_LICENSE

#
'GPL-2.0'
USE_THIS_EDITOR =
#

USE_THIS_EDITOR

#
'vim'
USE_THIS_DATE =
#

USE_THIS_DATE

#
"Time.now.strftime('%Y-%m-%d')"
COMMENT =
#

COMMENT

#
'# =========================================================================== #'

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(name_to_use = nil, run_already = true) ⇒ GenerateGemspec

#

initialize

#


24
25
26
27
28
29
30
31
 
# File 'lib/roebe/classes/generate_gemspec/generate_gemspec.rb', line 24

def initialize(
    name_to_use = nil,
    run_already = true
  )
  reset
  set_projectname(name_to_use)
  run if run_already
end

Instance Method Details

#generate_gemspec ⇒ Object

#

generate_gemspec

#


141
142
143
144
145
146
 
# File 'lib/roebe/classes/generate_gemspec/generate_gemspec.rb', line 141

def generate_gemspec
  opne "Storing into #{sfile(@filename)} now."
  remove(@filename)
  save_what_to(@string, @filename) # This method can be found in the save_file library.
  open_this_in_editor(@filename)
end

#generate_usage_file(i = '') ⇒ Object

#

generate_usage_file

#


131
132
133
134
135
136
 
# File 'lib/roebe/classes/generate_gemspec/generate_gemspec.rb', line 131

def generate_usage_file(i = '')
  begin
    require 'roebe/classes/usage.rb' # bl $RSRC/roebe/lib/roebe/classes/usage.rb
    Roebe::Usage.new(i)
  rescue LoadError; end
end

#open_this_in_editor(i) ⇒ Object

#

open_this_in_editor

#


151
152
153
154
155
 
# File 'lib/roebe/classes/generate_gemspec/generate_gemspec.rb', line 151

def open_this_in_editor(i)
  opne 'We will also open it in the editor now.'
  _ = USE_THIS_EDITOR+' '+i
  esystem _
end

#projectname? ⇒ Boolean

#

projectname?

#

Returns:

  • (Boolean) 


55
56
57
 
# File 'lib/roebe/classes/generate_gemspec/generate_gemspec.rb', line 55

def projectname?
  @projectname
end

#reset ⇒ Object

#

reset

#


36
37
38
39
40
41
42
43
 
# File 'lib/roebe/classes/generate_gemspec/generate_gemspec.rb', line 36

def reset
  super()
  infer_the_namespace
  @dir = return_pwd # Base this on the current directory.
  splitted = @dir.split('/')
  last = splitted.last
  set_projectname(last)
end

#return_date ⇒ Object

#

return_date

#


48
49
50
 
# File 'lib/roebe/classes/generate_gemspec/generate_gemspec.rb', line 48

def return_date # Must be in format: 2012-06-17
  Time.now.strftime('%Y-%m-%d') 
end

#run ⇒ Object

#

run (run tag)

#


185
186
187
188
189
 
# File 'lib/roebe/classes/generate_gemspec/generate_gemspec.rb', line 185

def run
  set_default_main_string
  generate_gemspec
  generate_usage_file 'USAGE.md' # Disabled as of May 2013. Re-enabled Feb 2014.
end

#set_default_main_string ⇒ Object

#

set_default_main_string

#


62
63
64
65
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
113
114
115
116
 
# File 'lib/roebe/classes/generate_gemspec/generate_gemspec.rb', line 62

def set_default_main_string
  # ========================================================================= #
  # We must set a default homepage here.
  # ========================================================================= #
  homepage_url = "'https://github.com/shevegen/#{projectname?}'"
  @string = COMMENT+"
# Gemspec for Project "+to_camelcase(projectname?)+".
# =========================================================================== #
Gem::Specification.new { |s|

s.name        = '"+projectname?+"'
s.version     = '"+projectname?+"::VERSION' # '"+projectname?.capitalize+"::VERSION'
s.date        = "+USE_THIS_DATE+"

DESCRIPTION = <<-EOF

This project is called #{projectname?}.

EOF

s.summary     = DESCRIPTION
s.description = DESCRIPTION

# ========================================================================= #
# Show this message when a user installs this project.
# ========================================================================= #
s.post_install_message = <<-EOF

Usage instruction go in here.

Thank you and have fun.

EOF

s.extra_rdoc_files = %w()

s.authors    = ['"+AUTHOR_NAME+"']
s.email      = '"+AUTHOR_EMAIL+"'
s.files      = Dir['**/*']
s.files     << 'README.md' if File.exist? 'README.md'
s.files     << 'USAGE.md'  if File.exist? 'USAGE.md'
s.license    = '#{USE_THIS_LICENSE}'
s.homepage   = #{homepage_url}

s.required_ruby_version     = '>= #{RUBY_VERSION}'
s.rubygems_version          = '>= "+use_which_rubygem_version?+"'
s.required_rubygems_version = '>= "+use_which_rubygem_version?+"'

# ========================================================================= #
# External dependencies for the project:
# ========================================================================= #
# s.add_dependency 'foo'

}" # Keep a newline before. It looks nicer in the generated .gemspec.
end

#set_filename(i = return_.pwd+projectname?+'.gemspec') ⇒ Object

#

set_filename

This will depend on @projectname to have been set properly before.

#


177
178
179
180
 
# File 'lib/roebe/classes/generate_gemspec/generate_gemspec.rb', line 177

def set_filename(i = return_.pwd+projectname?+'.gemspec')
  i = i.squeeze('/')
  @filename = i
end

#set_projectname(i = projectname?) ) ⇒ Object

#

set_projectname

Whenever set_projectname is modified, we must also modify the

#


163
164
165
166
167
168
169
170
 
# File 'lib/roebe/classes/generate_gemspec/generate_gemspec.rb', line 163

def set_projectname(i = projectname?)
  i = projectname? if i.nil? # Default. A Safeguard.
  i = i.to_s.dup # .dup because the string can be frozen.
  i.gsub!(/\.rb$/,'') if i.include? '.rb'
  i = File.basename(i) # Added as of Jul 2014.
  @projectname = i
  set_filename
end

#use_which_rubygem_version? ⇒ Boolean

#

use_which_rubygem_version?

First, we will try to use “gem –version”. If that fails, we will default to another version.

#

Returns:

  • (Boolean) 


124
125
126
 
# File 'lib/roebe/classes/generate_gemspec/generate_gemspec.rb', line 124

def use_which_rubygem_version?
  REQUIRED_RUBYGEM_VERSION
end