Skip to content

Commit

Permalink
Updated Rakefile to do docs/release a bit better.
Browse files Browse the repository at this point in the history
Removed jswoof (not used anymore).
Added a bit more documentation to RxAutoComplete on how to use
customSearchFunction
  • Loading branch information
dima committed Oct 28, 2009
1 parent bd1d3e6 commit ee386ea
Show file tree
Hide file tree
Showing 14 changed files with 1,174 additions and 1,063 deletions.
1 change: 1 addition & 0 deletions .gitignore
@@ -1 +1,2 @@
*.tmproj
tmp
53 changes: 35 additions & 18 deletions Rakefile
Expand Up @@ -7,6 +7,8 @@
# 6. git commit
# 7. git checkout master

FRAMEWORK_VERSION = "1.2.4"

TEST_APP_NAME = 'TestApp.mxml'
ROOT_DIR = File.dirname(__FILE__)

Expand All @@ -22,7 +24,7 @@ task :default => [:build]
desc "Build the framework"
task :build do
libs = Dir.glob(File.join(ROOT_DIR, 'tests/lib', '*.swc'))
system("#{get_executable('compc')} +configname=air -load-config+=framework/restfulx-config.xml -library-path+=#{libs.join(',')}")
system("#{get_executable('compc')} +configname=air -keep-as3-metadata+=Resource,HasOne,HasMany,BelongsTo,DateTime,Lazy,Ignored,Nested -load-config+=framework/restfulx-config.xml -library-path+=#{libs.join(',')}")
end

desc "Compile and run test application"
Expand All @@ -31,23 +33,38 @@ task :test => ["test:build", "test:run"]
desc "Build API documentation"
task :doc do
libs = Dir.glob(File.join(ROOT_DIR, 'framework/lib', '*.swc'))
packages = ['-package org.restfulx "Provides central access to a number of frequently used subsystems, configuration options and helpers."']
packages << '-package org.restfulx.collections "ArrayCollection extensions that help dealing with RxModels."'
packages << '-package org.restfulx.commands "Command pattern specific classes."'
packages << '-package org.restfulx.components.rx "Reusable MXML components that maybe used by the RestfulX code generation engine."'
packages << '-package org.restfulx.controllers "Various framework controllers such as RXApplicationController and ModelsController."'
packages << '-package org.restfulx.controllers.mock "Adds a few testing specific controllers."'
packages << '-package org.restfulx.events "Events dispatched by the framework."'
packages << '-package org.restfulx.models "Classes used by RX models."'
packages << '-package org.restfulx.serializers "Serializers provided by the framework, including XML, ValueObject and JSON."'
packages << '-package org.restfulx.services "Services provided by the framework including XML-over-HTTP, JSON-over-HTTP, CouchDB and AIR."'
packages << '-package org.restfulx.services.air "Adobe AIR service provider classes."'
packages << '-package org.restfulx.services.as3http "Direct CouchDB, XML and JSON service providers based on the as3httpclientlib."'
packages << '-package org.restfulx.services.http "XML and JSON service providers based on the default Flex HTTPService."'
packages << '-package org.restfulx.services.mock "Adds a few testing specific service providers."'
packages << '-package org.restfulx.utils "Framework utilties."'
packages << '-package org.restfulx.validators "Validation classes for proxying server-side/service provider errors to the UI."'
system("#{get_executable('asdoc')} +configname=air -main-title 'RestfulX Framework 1.2.4 API Documenation' -keep-as3-metadata+=Resource,HasOne,HasMany,BelongsTo,DateTime,Lazy,Ignored,Nested -source-path framework/src -doc-sources framework/src -library-path+=#{libs.join(',')} #{packages.join(" ")} -output doc/api")
packages = {
"org.restfulx" => "Provides central access to a number of frequently used subsystems, configuration options and helpers.",
"org.restfulx.collections" => "ArrayCollection extensions that help dealing with RxModels.",
"org.restfulx.commands" => "Command pattern specific classes.",
"org.restfulx.components.rx" => "Reusable MXML components that maybe used by the RestfulX code generation engine.",
"org.restfulx.controllers" => "Various framework controllers such as RXApplicationController and ModelsController.",
"org.restfulx.controllers.mock" => "Adds a few testing specific controllers.",
"org.restfulx.events" => "Events dispatched by the framework.",
"org.restfulx.models" => "Classes used by RX models.",
"org.restfulx.serializers" => "Serializers provided by the framework, including XML, ValueObject and JSON.",
"org.restfulx.services" => "Services provided by the framework including XML-over-HTTP, JSON-over-HTTP, CouchDB and AIR.",
"org.restfulx.services.air" => "Adobe AIR service provider classes.",
"org.restfulx.services.as3http" => "Direct CouchDB, XML and JSON service providers based on the as3httpclientlib.",
"org.restfulx.services.http" => "XML and JSON service providers based on the default Flex HTTPService.",
"org.restfulx.services.mock" => "Adds a few testing specific service providers.",
"org.restfulx.utils" => "Framework utilties.",
"org.restfulx.validators" => "Validation classes for proxying server-side/service provider errors to the UI."
}

package_list = packages.keys.map do |key|
"-package #{key} \"#{packages[key].gsub(/\s/, "\\ ")}\""
end

system("#{get_executable('asdoc')} +configname=air -source-path framework/src -doc-sources framework/src -library-path+=#{libs.join(',')} #{package_list.join(" ")} -output doc/api -main-title '\"RestfulX\ Framework\ #{FRAMEWORK_VERSION}\ API\ Documenation\"'")
end

desc "Build a framework release"
task :release => ["build", "doc"] do
FileUtils.mkdir_p("tmp/restfulx-#{FRAMEWORK_VERSION}/docs")
FileUtils.cp("framework/bin/restfulx.swc", "tmp/restfulx-#{FRAMEWORK_VERSION}/restfulx-#{FRAMEWORK_VERSION}.swc")
FileUtils.cp_r("doc/api", "tmp/restfulx-#{FRAMEWORK_VERSION}/docs")
FileUtils.cp_r("framework/src", "tmp/restfulx-#{FRAMEWORK_VERSION}")
end

namespace :test do
Expand Down
6 changes: 6 additions & 0 deletions doc/api/all-index-A.html
Expand Up @@ -188,6 +188,12 @@
</td>
</tr>
<tr>
<td colspan="2" class="idxrow"><a onclick="javascript:loadClassListFrame('org/restfulx/components/rx/class-list.html');" href="org/restfulx/components/rx/RxAutoComplete.html#alwaysShow">alwaysShow</a> &mdash; Property in class org.restfulx.components.rx.<a onclick="javascript:loadClassListFrame('org/restfulx/components/rx/class-list.html');" href="org/restfulx/components/rx/RxAutoComplete.html">RxAutoComplete</a></td>
</tr>
<tr>
<td width="20"></td><td> Always invoke show on the model independency of the currently shown status </td>
</tr>
<tr>
<td colspan="2" class="idxrow"><a onclick="javascript:loadClassListFrame('org/restfulx/services/as3http/class-list.html');" href="org/restfulx/services/as3http/AS3GAEHTTPServiceProvider.html">AS3GAEHTTPServiceProvider</a> &mdash; Class in package <a onclick="javascript:loadClassListFrame('org/restfulx/services/as3http/class-list.html');" href="org/restfulx/services/as3http/package-detail.html">org.restfulx.services.as3http</a></td>
</tr>
<tr>
Expand Down
8 changes: 8 additions & 0 deletions doc/api/all-index-S.html
Expand Up @@ -124,6 +124,14 @@
<td width="20"></td><td></td>
</tr>
<tr>
<td colspan="2" class="idxrow"><a onclick="javascript:loadClassListFrame('org/restfulx/services/class-list.html');" href="org/restfulx/services/ServiceResponder.html#service">service</a> &mdash; Property in class org.restfulx.services.<a onclick="javascript:loadClassListFrame('org/restfulx/services/class-list.html');" href="org/restfulx/services/ServiceResponder.html">ServiceResponder</a></td>
</tr>
<tr>
<td width="20"></td><td>
The service provider that this responder has been created for
</td>
</tr>
<tr>
<td colspan="2" class="idxrow"><a onclick="javascript:loadClassListFrame('org/restfulx/events/class-list.html');" href="org/restfulx/events/ServiceCallStartEvent.html">ServiceCallStartEvent</a> &mdash; Class in package <a onclick="javascript:loadClassListFrame('org/restfulx/events/class-list.html');" href="org/restfulx/events/package-detail.html">org.restfulx.events</a></td>
</tr>
<tr>
Expand Down

0 comments on commit ee386ea

Please sign in to comment.