Class: HelpM

Inherits:
Object
  • Object
show all
Defined in:
lib/actions/help.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Instance Attribute Details

#common_opt ⇒ Object (readonly)

Returns the value of attribute common_opt.



7
8
9
 
# File 'lib/actions/help.rb', line 7

def common_opt
  @common_opt
end

#org_repo ⇒ Object (readonly)

Returns the value of attribute org_repo.



4
5
6
 
# File 'lib/actions/help.rb', line 4

def org_repo
  @org_repo
end

#org_teams ⇒ Object (readonly)

Returns the value of attribute org_teams.



5
6
7
 
# File 'lib/actions/help.rb', line 5

def org_teams
  @org_teams
end

#user ⇒ Object (readonly)

Returns the value of attribute user.



3
4
5
 
# File 'lib/actions/help.rb', line 3

def user
  @user
end

#user_repo ⇒ Object (readonly)

Returns the value of attribute user_repo.



6
7
8
 
# File 'lib/actions/help.rb', line 6

def user_repo
  @user_repo
end

Instance Method Details

#org ⇒ Object 



22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
 
# File 'lib/actions/help.rb', line 22

def org()
  self.common_opt
  puts " Organization options:"
  print "\n\tCOMMAND\t\t\tDESCRIPTION\n\n"
  print "\trepos\t\t\tList the repositories of your organization\n"
  print "\topen\t\t\tOpen the organization's url of github in your web browser.\n"
  print "\t\t\t\tIf you have added the aditional .csv information with, you can open an specific github profile.\n"
  print "\t\t\t\t->\topen [user]\n\n"
  print "\tclone\t\t\tClone a repository or a list of repositories using a regular expresion\n"
  print "\tset\t\t\tMove you to a specific repository\n"
  print "\tpeople\t\t\tShow the members of an organization\n"
  print "\t\t\t\t->\tpeople\n\n"
  print "\t\t\t\tIf you add the parameter 'info', the extended information will be showed\n"
  print "\t\t\t\t->\tpeople info\n\n"
  print "\t\t\t\tTo find a specific member extended info, you can give the github id as parameter.\n"
  print "\t\t\t\t->\tpeople info [github id]\n\n"
  print "\tteams\t\t\tTeams of a organization\n"
  print "\tnew_people_info\t\tGet extended information from a .csv file founded in the excecute path\n"
  print "\t\t\t\t->\tnew_people_info [name of the file]\n\n"
  print "\tassignments\t\tShow the list of assignments created\n"
  print "\tnew_assignment\t\tCreate an Assignment in your organization\n"
  print "\tgroups\t\t\tShow the list of groups with each team and user that it has\n"
  print "\tgroup\t\t\tShow the information of an specific group\n"
  print "\t\t\t\t->\tgroup [name of the group]\n\n"
  print "\tnew_group\t\tCreate a new group. Expected the name and teams given one by one\n"
  print "\t\t\t\t->\tnew_group [name of the group] [team1] [team2] [team3] ... \n\n"
  print "\trm_group\t\tDelete a created group\n"
  print "\t\t\t\t->\trm_group [name of the group]\n\n"
  print "\trm_team\t\t\tDelete a team in you organization. Expected the name of the team\n"
  print "\t\t\t\t->\trm_team [name of the team]\n\n"
  print "\tnew_team\t\tCreate a team in the organization. Expected the name of the team, and/or members given one by one\n"
  print "\t\t\t\t->\tnew_team [name of the team] [member1] [member2] [member3] ... \n\n"

end

#orgs_teams ⇒ Object 



82
83
84
85
86
87
88
89
90
91
 
# File 'lib/actions/help.rb', line 82

def orgs_teams()
  self.common_opt
  puts " Organization team options:"
  print "\n\tCOMMAND\t\t\tDESCRIPTION\n\n"
  print "\tpeople\t\t\tMembers of the team\n"
  print "\topen\t\t\tOpen the team's url of github in your web browser.\n"
  print "\tclone\t\t\tClone a repository or a list of repositories using a regular expresion\n"
  print "\tnew_repository\t\tCreate a repository to this team\n"
  print "\tadd_to_team\t\tAdd a member in the team\n\n"
end

#team_repo ⇒ Object 



118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
 
# File 'lib/actions/help.rb', line 118

def team_repo()
  self.common_opt
  puts " Repository options:"
  print "\n\tCOMMAND\t\t\tDESCRIPTION\n\n"
  print "\tinfo\t\t\tShow information about the repository\n"
  print "\topen\t\t\tOpen the repository's url of github in your web browser.\n"
  print "\tcommits\t\t\tShow the list of commits from the repository\n"
  print "\tnew_issue\t\tCreates a new issue\n"
  print "\tissues\t\t\tShow the list of issues from the repository\n"
  print "\tissue\t\t\tShow the issue and its comments\n"
  print "\tnew_issue_comment\tAdd a comment in a specific issue\n"
  print "\t\t\t\t->\tnew_issue_comment [Id of the issue]\n\n"
  print "\t\t\t\t->\tissue [Id of the issue]\n\n"
  print "\topen_issue\t\tOpen a closed issue\n"
  print "\t\t\t\t->\topen_issue [Id of the issue]\n\n"
  print "\tclose_issue\t\tClose an opened issue\n"
  print "\t\t\t\t->\tclose_issue [Id of the issue]\n\n"
  print "\tfiles\t\t\tShow the files of the repository path given\n"
  print "\tcat\t\t\tShow data from a file\n"
  print "\t\t\t\t->\tcat [file]\n\n"
  print "\tprivate\t\t\tChange the privacy of a repository. Expected 'true' or 'false' as parameter.\n"
  print "\t\t\t\t->\tprivate [true]\n\n"
  print "\tcol\t\t\tShow the list of collaborators from the repository\n\n"
end

#welcome ⇒ Object 



165
166
167
168
 
# File 'lib/actions/help.rb', line 165

def welcome
  puts "\nGitHub Education Shell!"
  puts "_______________________\n\n"
end