Class: RubyPackager::ReleaseInfo

Inherits:
Object
  • Object
show all
Defined in:
lib/RubyPackager/ReleaseInfo.rb

Overview

This class is the base class of all releases info to be provided by packages.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize ⇒ ReleaseInfo

Constructor



52
53
54
55
56
57
58
59
60
61
62
63
64
65
 
# File 'lib/RubyPackager/ReleaseInfo.rb', line 52

def initialize
  # This sets also default values
  @author_info = {}
  @project_info = {}
  @executables_info = []
  @install_info = {}
  @sf_info = {}
  @rf_info = {}
  @gem_info = {}
  # Files patterns list
  @core_files = []
  @additional_files = []
  @test_files = []
end

Instance Attribute Details

#additional_files ⇒ Object (readonly)

List of additional files patterns

list< String >



45
46
47
 
# File 'lib/RubyPackager/ReleaseInfo.rb', line 45

def additional_files
  @additional_files
end

#author_info ⇒ Object (readonly)

Information about the author

map< Symbol, Object >



13
14
15
 
# File 'lib/RubyPackager/ReleaseInfo.rb', line 13

def author_info
  @author_info
end

#core_files ⇒ Object (readonly)

List of core files patterns

list< String >



41
42
43
 
# File 'lib/RubyPackager/ReleaseInfo.rb', line 41

def core_files
  @core_files
end

#executables_info ⇒ Object (readonly)

Information about the executables

list< map< Symbol, Object > >



21
22
23
 
# File 'lib/RubyPackager/ReleaseInfo.rb', line 21

def executables_info
  @executables_info
end

#gem_info ⇒ Object (readonly)

Information about the Gem

map< Symbol, Object >



37
38
39
 
# File 'lib/RubyPackager/ReleaseInfo.rb', line 37

def gem_info
  @gem_info
end

#install_info ⇒ Object (readonly)

Information about the installer

map< Symbol, Object >



25
26
27
 
# File 'lib/RubyPackager/ReleaseInfo.rb', line 25

def install_info
  @install_info
end

#project_info ⇒ Object (readonly)

Information about the project

map< Symbol, Object >



17
18
19
 
# File 'lib/RubyPackager/ReleaseInfo.rb', line 17

def project_info
  @project_info
end

#rf_info ⇒ Object (readonly)

Information about RubyForge

map< Symbol, Object >



33
34
35
 
# File 'lib/RubyPackager/ReleaseInfo.rb', line 33

def rf_info
  @rf_info
end

#sf_info ⇒ Object (readonly)

Information about SourceForge

map< Symbol, Object >



29
30
31
 
# File 'lib/RubyPackager/ReleaseInfo.rb', line 29

def sf_info
  @sf_info
end

#test_files ⇒ Object (readonly)

List of test files patterns

list< String >



49
50
51
 
# File 'lib/RubyPackager/ReleaseInfo.rb', line 49

def test_files
  @test_files
end

Instance Method Details

#add_additional_files(iFilesPatternsList) ⇒ Object

Add additional files patterns

Parameters

  • iFilesPatternsList (list<String>): The list of files patterns to add

Return

  • ReleaseInfo: self



201
202
203
204
205
 
# File 'lib/RubyPackager/ReleaseInfo.rb', line 201

def add_additional_files(iFilesPatternsList)
  @additional_files.concat(iFilesPatternsList)

  return self
end

#add_core_files(iFilesPatternsList) ⇒ Object

Add core files patterns

Parameters

  • iFilesPatternsList (list<String>): The list of files patterns to add

Return

  • ReleaseInfo: self



189
190
191
192
193
 
# File 'lib/RubyPackager/ReleaseInfo.rb', line 189

def add_core_files(iFilesPatternsList)
  @core_files.concat(iFilesPatternsList)

  return self
end

#add_test_files(iFilesPatternsList) ⇒ Object

Add test files patterns

Parameters

  • iFilesPatternsList (list<String>): The list of files patterns to add

Return

  • ReleaseInfo: self



213
214
215
216
217
 
# File 'lib/RubyPackager/ReleaseInfo.rb', line 213

def add_test_files(iFilesPatternsList)
  @test_files.concat(iFilesPatternsList)

  return self
end

#author(iParams) ⇒ Object

Add Author properties

Parameters

  • iParams (map<Symbol,Object>): The parameters:

    • :name (String): The author name

    • :email (String): The author’s email

    • :web_page_url (String): The author’s web page

Return

  • ReleaseInfo: self



76
77
78
79
80
 
# File 'lib/RubyPackager/ReleaseInfo.rb', line 76

def author(iParams)
  @author_info.merge!(iParams)

  return self
end

#executable(iParams) ⇒ Object

Add executable package properties. This method can be called several times to specify several executables.

Parameters

  • iParams (map<Symbol,Object>): The parameters:

    • :startup_rb_file (String): Name of RB file to execute as startup file.

    • :exe_name (String): Name of executable file to produce.

    • :icon_name (String): Name of the executable icon.

    • :terminal_application (Boolean): Does this binary execute in a terminal ?

Return

  • ReleaseInfo: self



113
114
115
116
117
 
# File 'lib/RubyPackager/ReleaseInfo.rb', line 113

def executable(iParams)
  @executables_info << iParams

  return self
end

#gem(iParams) ⇒ Object

Add Gem properties

Parameters

  • iParams (map<Symbol,Object>): The parameters:

    • :gem_name (String): The Gem name

    • :gem_platform_class_name (String): The name of the Gem platform class

    • :require_path (String): Single path to require

    • :require_paths (list<String>): Paths to require

    • :has_rdoc (String): Include RDoc in the Gem ?

    • :extra_rdoc_files (list<String>): List of file patterns to be included in the RDoc but not in the Gem

    • :test_file (String): Name of the test file to execute

    • :gem_dependencies (list< [String,String] >): List of [ Gem, Version criteria ] this Gem depends on

Return

  • ReleaseInfo: self



177
178
179
180
181
 
# File 'lib/RubyPackager/ReleaseInfo.rb', line 177

def gem(iParams)
  @gem_info.merge!(iParams)

  return self
end

#install(iParams) ⇒ Object

Add installer properties

Parameters

  • iParams (map<Symbol,Object>): The parameters:

    • :nsis_file_name (String): Name of the NSI file to use to generate the installer

    • :installer_name (String): Name of the generated installer

Return

  • ReleaseInfo: self



127
128
129
130
131
 
# File 'lib/RubyPackager/ReleaseInfo.rb', line 127

def install(iParams)
  @install_info.merge!(iParams)

  return self
end

#project(iParams) ⇒ Object

Add Project properties

Parameters

  • iParams (map<Symbol,Object>): The parameters:

    • :name (String): Project name

    • :web_page_url (String): Project home page

    • :summary (String): Project Summary

    • :description (String): Project description

    • :image_url (String): URL of the project’s image

    • :favicon_url (String): URL of the project’s favicon

    • :browse_source_url (String): URL to browse the source code

    • :dev_status (String): Development status

Return

  • ReleaseInfo: self



96
97
98
99
100
 
# File 'lib/RubyPackager/ReleaseInfo.rb', line 96

def project(iParams)
  @project_info.merge!(iParams)

  return self
end

#ruby_forge(iParams) ⇒ Object

Add RubyForge properties

Parameters

  • iParams (map<Symbol,Object>): The parameters:

    • :login (String): The releaser’s RubyForge login

    • :project_unix_name (String): Unix name of the RubyForge project

Return

  • ReleaseInfo: self



157
158
159
160
161
 
# File 'lib/RubyPackager/ReleaseInfo.rb', line 157

def ruby_forge(iParams)
  @rf_info.merge!(iParams)

  return self
end

#source_forge(iParams) ⇒ Object

Add SF.NET properties

Parameters

  • iParams (map<Symbol,Object>): The parameters:

    • :login (String): The releaser’s SF.NET login

    • :project_unix_name (String): Unix name of the SF project

    • :ask_for_password (Boolean): Do we ask for the user password to give to SSH ?

    • :ask_for_key_passphrase (Boolean): Do we ask for the key passphrase to give to SSH ?

Return

  • ReleaseInfo: self



143
144
145
146
147
 
# File 'lib/RubyPackager/ReleaseInfo.rb', line 143

def source_forge(iParams)
  @sf_info.merge!(iParams)

  return self
end