public
Description: RubyOpals is a package manager for Ruby
Homepage: http://blog.rubyopals.org
Clone URL: git://github.com/tflynn/rubyopals.git
rubyopals / .yardoc
100644 198 lines (193 sloc) 18.733 kb
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
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
56
57
58
59
60
61
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
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
[IC:SymbolHash{::Opal::SUCCESSo:&YARD::CodeObjects::ConstantObject :@namespaceo:$YARD::CodeObjects::ModuleObject;o:"YARD::CodeObjects::RootObject ;0:
@tags[:@childrenIC:&YARD::CodeObjects::CodeObjectList[ @o:#YARD::CodeObjects::ClassObject;@ ; [:
@linei; IC; [o:$YARD::CodeObjects::MethodObject:@short_docstring0;@ ; [o:YARD::Tags::Tag : @types["Opal::Logger::MiniLogger:@tag_name" return:
@name0:
@text""Singleton MiniLogger instance:@explicitT;i”:
@file"lib/logger/mini_logger.rb: @source"Cdef opal_logger
  return Opal::Logger::MiniLogger.instance
end;:opal_logger: @scope: instance:@signature"def opal_logger:@docstring"2Method to globally access current opal logger:@visibility: public: @owner@ ;@: @aliases{;: Object:@attributesIC;{;IC;{:@symbolize_valueT:
classIC;{;%T;%T;": @mixinsIC; [;!@ o; ;@ ; [;i;"lib/version.rb;"sRUBYOPALS_VERSION_PARTS = { :major => 0, :minor => 0, :point => 1} unless defined?(RUBYOPALS_VERSION_PARTS);:RUBYOPALS_VERSION_PARTS;"IRUBYOPALS_VERSION_PARTS = { :major => 0, :minor => 0, :point => 1;"o; ;@ ; [;i ;@";"¡RUBYOPALS_VERSION = "#{RUBYOPALS_VERSION_PARTS[:major]}.#{RUBYOPALS_VERSION_PARTS[:minor]}.#{RUBYOPALS_VERSION_PARTS[:point]}" unless defined?(RUBYOPALS_VERSION);:RUBYOPALS_VERSION;"¡RUBYOPALS_VERSION = "#{RUBYOPALS_VERSION_PARTS[:major]}.#{RUBYOPALS_VERSION_PARTS[:minor]}.#{RUBYOPALS_VERSION_PARTS[:point]}" unless defined?(RUBYOPALS_VERSION);";!@ ;"{;: root;$IC;{;IC;{;%T;⁣{;%T;%T;";'IC; [;!@ ; [;i; IC; [o; ;@; [;i; IC; [o; ;@3; [;i';"lib/bootstrap/bootstrap.rb;"öBOOTSTRAP_OPALS = [{ :opal_name => 'opal', :opal_version => '0.0.0' , :opal_version_condition => :at_least }, { :opal_name => 'log4r', :opal_version => '0.0.0' , :opal_version_condition => :at_least }, { :opal_name => 'rake', :opal_version => '0.0.0' , :opal_version_condition => :at_least }, { :opal_name => 'rspec', :opal_version => '0.0.0', :opal_version_condition => :at_least }, { :opal_name => 'test-spec', :opal_version => '0.0.0', :opal_version_condition => :at_least }, { :opal_name => 'yard', :opal_version => '0.0.0', :opal_version_condition => :at_least } ].freeze unless defined?(Opal::Bootstrap::BOOTSTRAP_OPALS);:BOOTSTRAP_OPALS;"öBOOTSTRAP_OPALS = [{ :opal_name => 'opal', :opal_version => '0.0.0' , :opal_version_condition => :at_least }, { :opal_name => 'log4r', :opal_version => '0.0.0' , :opal_version_condition => :at_least }, { :opal_name => 'rake', :opal_version => '0.0.0' , :opal_version_condition => :at_least }, { :opal_name => 'rspec', :opal_version => '0.0.0', :opal_version_condition => :at_least }, { :opal_name => 'test-spec', :opal_version => '0.0.0', :opal_version_condition => :at_least }, { :opal_name => 'yard', :opal_version => '0.0.0', :opal_version_condition => :at_least } ].freeze unless defined?(Opal::Bootstrap::BOOTSTRAP_OPALS);"o; ;@3; [;i/;@8;"dOPAL_STANDARD_DIRS = ['bin', 'lib'].freeze unless defined?(Opal::Bootstrap::OPAL_STANDARD_DIRS);:OPAL_STANDARD_DIRS;"dOPAL_STANDARD_DIRS = ['bin', 'lib'].freeze unless defined?(Opal::Bootstrap::OPAL_STANDARD_DIRS);"o;;0;@3; [;i4; IC; [o;;0;@A; [o; ;[" Hash;"
param;" options;"Configuration options;T;i=;@8;"def bootstrap(options = {})
  BOOTSTRAP_OPALS.each do |bootstrap_opal_definition|
    name = bootstrap_opal_definition[:opal_name]
    version = bootstrap_opal_definition[:opal_version]
    options = {:boostrap_mode => true}.merge(options)
    opal(name,version, options)
  end
end;:bootstrap;;&;" def bootstrap(options = {});"Bootstrap RubyOpals build;; o;;0;@A; [ o; ;[" String;"
param;" name;"Opal Nameo; ;[" String;"
param;" version;"Opal Versiono; ;[" Symbol;"
param;"condition;"(Condition to match for Opal Versiono; ;[" Hash;"
param;" options;"Configuration options;T;iN;@8;"_def opal(name,version = nil , condition = :at_least, options = {})
  options = {:auto_require => true}.merge(options)
  unless defined?(RUBYOPALS_DEV_BASE_DIR)
    Object.const_set("RUBYOPALS_DEV_BASE_DIR",File.expand_path(File.join(File.dirname(__FILE__),'../../bootstrap/development')))
  end
  unless defined?(RUBYOPALS_DEV_BASE_OPALS_DIR)
    Object.const_set("RUBYOPALS_DEV_BASE_OPALS_DIR",File.expand_path(File.join(RUBYOPALS_DEV_BASE_DIR,'opals','sources')))
  end
  unless defined?(RUBYOPALS_BASE_LIB_DIR)
    Object.const_set("RUBYOPALS_BASE_LIB_DIR",File.expand_path(File.join(File.dirname(__FILE__),'../../lib')))
  end
  # THe 'opal' opal is a special case.
  # Point to the development build libraries since we aren't built yet
  if name == 'opal'
    $:.unshift(RUBYOPALS_BASE_LIB_DIR)
    # Do we want a bin dir too?
    # $:.each {|path| puts path}
  else
    opal_source_dir = File.join(RUBYOPALS_DEV_BASE_OPALS_DIR,"#{name}-#{version}")
    #opal_logger.debug("Bootstrap:opal name #{name} version #{version}")
    #opal_logger.debug(""Bootstrap:opal opal_source_dir #{opal_source_dir}")
    if File.directory?(opal_source_dir)
      OPAL_STANDARD_DIRS.each do |standard_dir|
        qualified_standard_dir = File.join(opal_source_dir,standard_dir)
        #opal_logger.debug("Bootstrap:opal qualified_standard_dir #{qualified_standard_dir}")
        if File.directory?(qualified_standard_dir)
          #opal_logger.debug("Bootstrap:opal adding to path #{qualified_standard_dir}")
          $:.unshift(qualified_standard_dir)
        end
      end
 
      if options[:auto_require]
        require_file = File.join(opal_source_dir,'opal_init')
        #opal_logger.debug("Bootstrap:opal requiring #{require_file}")
        if File.exists?(require_file + '.rb')
          require require_file
        end
      end
    else
      return Opal::ERROR
    end
  end
  
end;: opal;;&: @dynamicT;"Gdef opal(name,version = nil , condition = :at_least, options = {});"Bootstrap opal command;; ;!@A;@8;"{;:Bootstrap;$IC;{;IC;{;%T;⁣{;%T;%T;"BClass to add Dev Bootstrap resources into current environment:@superclasso:YARD::CodeObjects::Proxy;@3;;#: @obj@ ;'IC; [;!@A;!@3;@8;"{;;0;$IC;{;IC;{;%T;⁣{;%T;%T;";'IC; [;!@3o; ;@; [;i; IC; [o;;0;@y; [o; ;0;" version;0;"
0.0.1o; ;0;" author;0;"Tracy Flynn;i; IC; [ o;;0;@|; [ o; ;["
Array;"
param;" args;"Command line argumentso; ;[" Hash;"
param;" options;"Configuration optionso; ;[" Integer;" return;0;"#Opal::SUCCESS or Opal::FAILUREo; ;0;"api;0;" public;T;i;"lib/build/builder.rb;"jdef run(args = [],options = {})
  return Opal::Build::Builder.instance(options).run(args,options)
end;:run;;&;"$def run(args = [],options = {});"'Run the standard RubyOpals builder;; o;;0;@|; [o; ;[" Hash;"
param;" options;"Configuration optionso; ;["Opal::Build::Builder;" return;0;",Singleton instance of RubyOpals buildero; ;0;"api;0;" public;T;i&;@–;"‰def instance(options = {})
  unless defined?(@@instance)
    @@instance = Opal::Build::Builder.new(options)
  end
  return @@instance
end;;;;&;/T;"def instance(options = {});"8Get the singleton instance of the RubyOpals Builder;; o;;0;@|; [o; ;[" Hash;"
param;" options;"Configuration optionso; ;0;"api;0;" public;T;i6;@–;"&def initialize(options = {})
 
end;:initialize;;;"!def initialize(options = {});"(Create a standard RubyOpals builder;: privateo;;0;@|; [ o; ;["
Array;"
param;" args;"Command line argumentso; ;[" Hash;"
param;" options;"Configuration optionso; ;[" Integer;" return;0;"#Opal::SUCCESS or Opal::FAILUREo; ;0;"api;0;" public;T;iL;@–;"hdef run(args = [],options = {})
  opal_logger.debug("Opal::Build::Builder: Running builder")
  
end;;4;;;/T;"$def run(args = [],options = {});"Run the standard RubyOpals builder
 
Steps:
 1 - Create temporary build directory
 2 - Add (boostrap) installer
 3 - Create Boostrap Opal + zip
 3 - Create Opal for (whatever) RubyOpals version needed - zip
 4 - Create Opals for all core Opals - zip
 5 - Create the entire package;; ;!@|;@–;"{;: Builder;$IC;{;IC;{;%T;⁣{;%T;%T;"Standard RubyOpals builder;1o;2;@y;;#;3@ ;'IC; [;!@|;!@y;"lib/build/build.rb;"{;:
Build;$IC;{;IC;{;%T;⁣{;%T;%T;";'IC; [;!@yo; ;@; [;i; IC; [o;;0;@â; [;i ; IC; [
o;;0;@å; [o; ;[" Hash;"
param;" options;"Configuration optionso; ;["!Opal::Initialization::Config;" return;0;"%singleton Configuration instance;T;i;"!lib/initialization/config.rb;"‘def instance(options = {})
  unless defined?(@@instance)
    @@instance = Opal::Initialization::Config.new(options)
  end
  return @@instance
end;;;;&;"def instance(options = {});".Get the singleton instance for this class;; o;;0;@å; [o; ;[" Object;" return;0;"&Environment settings in OPALS_ENV;T;i#;@õ;"9def env
  ENV["_opals_env"] ||= ENV["OPALS_ENV"]
end;:env;;&;/T;" def env;"Get Opals Env settings;; o;;0;@å; [o; ;["String|Symbol;"
param;" name;""Name of configuration settingo; ;["
Array;"
param;" args;"Argumentso; ;[" Object;" return;0;"Configuration value;T;i.;@õ;"Xdef method_missing(sym, *args)
  ev = "_opals_#{sym}".downcase
  return ENV[ev]
end;:method_missing;;&;/T;"#def method_missing(sym, *args);""Get any configuration setting;; o;;0;@å; [o; ;["String|Symbol;"
param;" name;""Name of configuration settingo; ;[" Object;"
param;"
value;"#Value of configuration setting;T;i9;@õ;"Kdef set(name, value)
  ENV["_opals_#{name.to_s.downcase}"] = value
end;:set;;&;/T;"def set(name, value);" Set a configuration setting;; o;;0;@å; [o; ;[" Hash;"
param;" options;"Configuration options;T;iG;@õ;":def initialize(options = {})
  @options = options
end;;5;;;"!def initialize(options = {});"(Create a new Configuration instance;;6;!@å;@õ;"{;: Config;$IC;{;IC;{;%T;⁣{;%T;%T;"TSingleton configuration instance that holds all Opals configuration information;1o;2;@â;;#;3@ ;'IC; [;!@å;!@â;@õ;"{;:Initialization;$IC;{;IC;{;%T;⁣{;%T;%T;";'IC; [;!@âo; ;@; [;i; IC; [;!@B;"lib/install/install.rb;"{;: Install;$IC;{;IC;{;%T;⁣{;%T;%T;";'IC; [;!@Bo; ;@; [;i; IC; [;!@L;"lib/legacy/legacy.rb;"{;: Legacy;$IC;{;IC;{;%T;⁣{;%T;%T;";'IC; [;!@Lo; ;@; [;i; IC; [ o; ;@V; [;i ;@;"|DEFAULT_LOG_LEVELS = { :debug => 0, :info => 1 , :warn => 2 , :error => 3, :fatal => 4 } unless defined?(DEFAULT_LOG_LEVELS);:DEFAULT_LOG_LEVELS;"|DEFAULT_LOG_LEVELS = { :debug => 0, :info => 1 , :warn => 2 , :error => 3, :fatal => 4 } unless defined?(DEFAULT_LOG_LEVELS);"o; ;@V; [;i
;@;">DEFAULT_LOG_DIR = 'logs' unless defined?(DEFAULT_LOG_DIR);:DEFAULT_LOG_DIR;">DEFAULT_LOG_DIR = 'logs' unless defined?(DEFAULT_LOG_DIR);"o; ;@V; [;i ;@;"KDEFAULT_LOG_NAME = "opal_logger.log" unless defined?(DEFAULT_LOG_NAME);:DEFAULT_LOG_NAME;"KDEFAULT_LOG_NAME = "opal_logger.log" unless defined?(DEFAULT_LOG_NAME);"o;;0;@V; [;i; IC; [o;;0;@h; [o; ;[" Hash;"
param;" options;"Configuration optionso; ;["Opal::Logger::MiniLogger;" return;0;""Singleton MiniLogger instance;T;i;@;"±def instance(options = {})
  unless defined?(@@mini_logger_instance)
    @@mini_logger_instance = Opal::Logger::MiniLogger.new(options)
  end
  return @@mini_logger_instance
end;;;;&;"def instance(options = {});"*Get the singleton MiniLogger instance;; o;;0;@h; [o; ;[;"
param;"
value;"1the value to set the attribute +log_dir+ to.;i#;@;"/def log_dir=(value)
  @log_dir = value
end;: log_dir=;;;"def log_dir=(value);"!Sets the attribute +log_dir+;; o;;0;@h; [;i#;@;"def log_dir
  @log_dir
end;: log_dir;;;"def log_dir;"-Returns the value of attribute +log_dir+;; o;;0;@h; [o; ;[;"
param;"
value;"2the value to set the attribute +log_name+ to.;i#;@;"1def log_name=(value)
  @log_name = value
end;:log_name=;;;"def log_name=(value);""Sets the attribute +log_name+;; o;;0;@h; [;i#;@;"!def log_name
  @log_name
end;: log_name;;;"def log_name;".Returns the value of attribute +log_name+;; o;;0;@h; [o; ;[;"
param;"
value;"3the value to set the attribute +log_level+ to.;i#;@;"3def log_level=(value)
  @log_level = value
end;:log_level=;;;"def log_level=(value);"#Sets the attribute +log_level+;; o;;0;@h; [;i#;@;"#def log_level
  @log_level
end;:log_level;;;"def log_level;"/Returns the value of attribute +log_level+;; o;;0;@h; [o; ;[;"
param;"
value;"6the value to set the attribute +logger_types+ to.;i#;@;"9def logger_types=(value)
  @logger_types = value
end;:logger_types=;;;"def logger_types=(value);"&Sets the attribute +logger_types+;; o;;0;@h; [;i#;@;")def logger_types
  @logger_types
end;:logger_types;;;"def logger_types;"2Returns the value of attribute +logger_types+;; o;;0;@h; [o; ;[" Hash;"
param;" options;"Configuration options;T;i*;@;"def initialize(options = {})
  @options = {:logger_types => [:stdout, :file], :default_level => 0 }.merge(options)
  @logger_types = @options[:logger_types]
  @log_level = @options[:default_level]
  @log_dir = DEFAULT_LOG_DIR
  @log_name = DEFAULT_LOG_NAME
end;;5;;;"!def initialize(options = {});"Create a logger;;6o;;0;@h; [o; ;[" String;" return;0;"Fully qualified log dir;T;i9;@;"ldef qualified_log_dir
  return File.expand_path(File.join(File.dirname(__FILE__),"../..",@log_dir))
end;:qualified_log_dir;;;/T;"def qualified_log_dir;" Get fully qualified log dir;;6o;;0;@h; [o; ;[" String;" return;0;""Fully qualified log file name;T;iD;@;"adef qualified_log_file
  return File.expand_path(File.join(qualified_log_dir,@log_name))
end;:qualified_log_file;;;/T;"def qualified_log_file;"&Get fully qualified log file name;; o;;0;@h; [o; ;[" String;"
param;"msg;" Message;T;iM;@;"bdef debug(msg)
  log_level = DEFAULT_LOG_LEVELS[:debug]
  log_msg(:debug, log_level, msg)
end;:
debug;;;/T;"def debug(msg);"Log a debug message;; o;;0;@h; [o; ;[" String;"
param;"msg;" Message;T;iW;@;"_def info(msg)
  log_level = DEFAULT_LOG_LEVELS[:info]
  log_msg(:info, log_level, msg)
end;: info;;;/T;"def info(msg);"Log an info message;; o;;0;@h; [o; ;[" String;"
param;"msg;" Message;T;ia;@;"_def warn(msg)
  log_level = DEFAULT_LOG_LEVELS[:warn]
  log_msg(:warn, log_level, msg)
end;: warn;;;/T;"def warn(msg);"Log an warn message;; o;;0;@h; [o; ;[" String;"
param;"msg;" Message;T;ik;@;"bdef error(msg)
  log_level = DEFAULT_LOG_LEVELS[:error]
  log_msg(:error, log_level, msg)
end;:
error;;;/T;"def error(msg);"Log an error message;; o;;0;@h; [o; ;[" String;"
param;"msg;" Message;T;iu;@;"bdef fatal(msg)
  log_level = DEFAULT_LOG_LEVELS[:fatal]
  log_msg(:fatal, log_level, msg)
end;:
fatal;;;/T;"def fatal(msg);"Log an fatal message;; o;;0;@h; [o; ;[" Integer;"
param;"log_level;"Logging Levelo; ;[" String;"
param;"log_level_type;"Symbol for logging levelo; ;["
Array;"
param;" args;"5Arguments - currently only take first as message;T;i|;@;"Œdef log_msg(log_level_type, log_level,*args)
  return unless log_level >= @log_level
  msg = args[0]
  log_msg = "%-7s %s - %s" % ["[%s]" % log_level_type.to_s.upcase, Time.now.utc.strftime("%Y-%m-%d %H:%M:%S"), msg]
  if @logger_types.include?(:stdout)
    STDOUT.puts(log_msg)
  end
  if @logger_types.include?(:file)
    File.open(qualified_log_file,'a+') {|file| file.puts(log_msg)}
  end
end;: log_msg;;;/T;"1def log_msg(log_level_type, log_level,*args);"Log a message;; ;!@h;@;"{;:MiniLogger;$IC;{;IC;{ ;DIC;{:
write@{: read@…;%T;FIC;{;T@Š;U@”;%T;HIC;{;T@™;U@£;%T;JIC;{;T@¨;U@²;%T;%T;⁣{;%T;%T;"IMimimal class to supply logging until main opal libraries are loaded;1o;2;@V;;#;3@ ;'IC; [;!@h;!@V;@;"{;: Logger;$IC;{;IC;{;%T;⁣{;%T;%T;";'IC; [;!@V@o; ;@; [;i;"lib/opals.rb;"6FAILURE = :failure unless defined?(Opal::FAILURE);: FAILURE;"6FAILURE = :failure unless defined?(Opal::FAILURE);"o; ;@; [;i;@7;"0ERROR = :error unless defined?(Opal::ERROR);:
ERROR;"0ERROR = :error unless defined?(Opal::ERROR);";!@;@8;"{;: Opal;$IC;{;IC;{;%T;&IC;{;%T;%T;";'IC; [;!@; [;i;@7;"9SUCCESS = :successful unless defined?(Opal::SUCCESS);: SUCCESS;"9SUCCESS = :successful unless defined?(Opal::SUCCESS);":0Opal::Logger::MiniLogger#qualified_log_file@Ì:%Opal::Logger::DEFAULT_LOG_LEVELS@Y:+Opal::Initialization::Config::instance@è:#Opal::Logger::MiniLogger#fatal@:'Opal::Logger::MiniLogger#log_level@£:'Opal::Logger::MiniLogger#log_name=@Š:Opal::Logger::MiniLogger@h:Opal::Install@B:Opal::Initialization@â:%Opal::Bootstrap::Bootstrap::opal@O:(Opal::Bootstrap::OPAL_STANDARD_DIRS@<:&Opal::Initialization::Config::env@ù;*@ :%Opal::Logger::MiniLogger#log_msg@ :*Opal::Logger::MiniLogger#logger_types@²:(Opal::Logger::MiniLogger#log_level=@™;(@ :Opal::FAILURE@5:#Opal::Logger::MiniLogger#debug@Ö:"Opal::Logger::DEFAULT_LOG_DIR@^:1Opal::Initialization::Config::method_missing@:Opal::Build::Builder::run@€:Opal::Bootstrap@3:(Opal::Logger::MiniLogger#initialize@·:+Opal::Logger::MiniLogger#logger_types=@¨:Opal::Legacy@L:!Opal::Initialization::Config@å:Opal::Build@y;)@&:"Opal::Logger::MiniLogger#info@á:&Opal::Initialization::Config::set@:#Opal::Build::Builder::instance@š:Opal::Bootstrap::Bootstrap@A:Object#opal_logger@;#@ :/Opal::Logger::MiniLogger#qualified_log_dir@Â:Opal::ERROR@;:"Opal::Logger::MiniLogger#warn@ì:%Opal::Logger::MiniLogger#log_dir@…:#Opal::Logger::DEFAULT_LOG_NAME@c:$Opal::Build::Builder#initialize@­:%Opal::Bootstrap::BOOTSTRAP_OPALS@6;Y@:'Opal::Logger::MiniLogger::instance@k:Opal::Logger@V:Opal::Build::Builder@|:*Opal::Bootstrap::Bootstrap::bootstrap@D:#Opal::Logger::MiniLogger#error@÷:&Opal::Logger::MiniLogger#log_name@”:&Opal::Logger::MiniLogger#log_dir=@{:,Opal::Initialization::Config#initialize@*:Opal::Build::Builder#run@»;%T{" Object;&