cbt 0.0.1

data/README.md

@@ -0,0 +1,221 @@
+CBT - A Bundle of Corona SDK Build Tools
+==============================================
+
+Concepts
+------------
+
+You split your CoronaSDK based mobile app into many `component`s.
+
+Each component contains one or more `.lua` module files, a series of `*_spec.lua`
+unit-test files, a `main.lua` file used to run the unit-tests, and may also have
+some asset files (pictures and audio files). 
+
+The default location to store components under `components/` folder, one
+sub-folder corresponds for one component. You create/edit your `.lua` files
+under the `components/` folder, and use 
+
+    $ cbt
+
+to copy those files along with other component files to `workspace` folder, where
+you check the behavior of your component using Corona's simulator. Cbt command will
+figure out which component you are working on from the current git branch name (we will 
+describe more options and commands later).
+
+All your components are configured in `config/components.yml` file.
+
+Every `.lua` file and asset file may have several platform-specific versions, include:
+
+- iOS: for iphone and ipad build
+- android: for android build
+- mock: provide a **mock-up** module for other component's development
+- debug: the default file that used for development and test
+
+For example you may have `Timer.mock.lua`, `Timer.android.lua` ... Where `cbt` will
+chose one of them to use. Also, there is a mechanism to include platform specific 
+code inside a file using Luobo syntax (we will reveal the details later).
+
+Component Development
+--------------------------
+
+A **workspace** is a sub-folder under `workspaces`, like `workspace/component_platform`.
+
+You use `cbt checkout` command to create and update a workspace.
+
+For example, 
+
+    $ cbt checkout --platform ios --require debug component_a
+
+Will create (or update existing contents inside) `workspaces/component_a_ios`, the
+`.lua` and asset files for component `components_a` are copied to the workspace using
+their `ios` version, but files that `components_a` requires from other components
+will be copied using their `debug` version.
+
+The default value for the developing component and required components are `debug` and `mock`, so
+
+    $ cbt checkout component_a
+
+means
+
+    $ cbt checkout --platform debug --require mock component_a
+
+Work with Dev-flow Tool
+---------------------------
+
+Create tasks with the component name in format like one of the follows
+
+    [++] component/component_name: xxxxxx
+    [++] comp/component_name: xxxxxx
+    [++] ct/component_name: xxxxxx
+
+`cbt` commands will respect `component_name` as the current working component 
+so you do not need to specify it in the command line: 
+
+    $ cbt checkout 
+
+under `ct/comp_a` branch will checkout `comp_a`. Also, `checkout` is the default
+command for cbt tool, so the above command can be write as simple as:
+
+    $ cbt
+
+(same as `cbt checkout --platform debug --require mock component_a` if you are
+in a proper git branch).
+
+**NOTE**: do not edit any file under `workspace` folder. Usually you should add
+`workspace` in you `.gitignore` file.
+
+Start A New Component
+--------------------------
+
+To begin a new component development, first you add an entry in `config/components.yml` like:
+
+    components:
+      component_name1:
+        lua_modules: [lua_file1, SomeClass<SuperClass]
+
+This defined a component `component_name1` and two `.lua` module files inside the component.
+
+If your component only have one module `.lua` file and has the same name as the component itself, 
+you can omit the `module` key in component definitions.
+
+`SomeClass<SuperClass` means `SomeClass` will inherited from `SuperClass`. 
+
+Then you can:
+
+    $ cbt create component_name1
+
+to create file skeleton for those `.lua` files under `components/component_name1`.
+
+Then you:
+
+    $ cbt checkout component_name1
+
+to create a folder under `workspaces/component_name1`, include the `debug` version of `lua_file1.lua` ...
+and `mock` version of _ALL_ other files from other components. 
+
+    $ cbt cleanup
+
+or 
+
+    $ cbt close
+
+Will safely delete files and folders under workspace.
+
+Platforms
+--------------------
+
+Each `.lua` module file and asset file may has several platform-specific versions of them. 
+
+The current supported platforms include `ios`, `android`, `mock` and `debug`. You name you file like:
+
+    comp.ios.lua
+    comp.mock.lua
+    ...
+
+Debug is the default platform so you could use just `comp.lua`.
+
+Asset files use the similar naming role, such as  `slash.png`, `slash.mock.png`, `slash.ios.png` ...
+
+The debug version `component.lua` is the _default_ version, will be used if other version is not available.
+Ensure it exists otherwise `cbt` raise errors.
+
+Usually you do not need a `component.debug.lua` (as `component.lua` is the debug version already), 
+but you can provide this file if you will edit `component.lua` for a while, but do not prevent others from
+build a debug app use your stable version of `component.lua` file.
+
+Luobo Converters
+--------------------
+
+The `mock` version of the component should be implement as quickly as possible, provide only
+`mocking` functions of public APIs. This helps other component's development, as they can interact with
+a quick version of _your_ component.
+
+For `ios`, `android` and `debug` versions of your component, usually they are not so different so you
+do not need to separate them to different files. An other way to provide platform-specific code is use
+Luobo (search luobo-gem) converter's syntax:
+
+    IOS ->
+      some_code_only_for_iOS
+
+    Android ->
+      some_code_only_for_android
+
+    DEBUG ->
+      ...
+
+Use indent to end the code block. If you want no indent before your code, use:
+
+    IOS: noindent ->
+      code_without_indent
+
+Refer `luobo-gem` for more syntax details.
+
+By this way, usually you only need platform-specific lua file `component_name.lua` and 
+`component_name.mock.lua`, and occasionally provide a `component_name.debug.lua` while
+you make a long term development on that component.
+
+API and SPEC tests
+----------------------
+
+You should provide the same API for both build and mock version of your component.
+
+You should have a `component_lua_file_spec.lua` file as unit test for each `.lua` module file.
+
+This spec file should in `Luobo::CoronaSpec` format.
+
+Components Diagram
+---------------------
+
+Based on `components.yml` and API function definition in your source lua file (the debug version
+will be parsed),
+
+    $ cbt diagram
+
+will create a series of diagram png file reflect component relationships under `docs` folder.
+
+Class inherit relations and class method definitions will automatically handled. You can also create
+custom relationship with:
+
+    # diagram -> SomeLuaModule related to
+
+Strings after SomeLuaModule will become `label` of Graphviz's edge (arrow).
+
+When you done your development of all components, issue `cbt build` to create a device build of
+the whole app.
+
+Build the Entire Application
+---------------------------------
+
+For example if you have a application names `dulcinea`, you define `main` as `lua_module` in it,
+then you can build a distribution version as:
+
+    $ cbt checkout --platform ios --require_platform ios dulcinea
+
+`build` is a alias of command `checkout` and will force `require_platform` to the same of `platform`
+option. So the above command also can be issued as:
+
+    $ cbt build -p ios dulcinea
+
+Which will results a `workspaces/dulcinea_ios` folder that contains files you can use to build
+you application to distribute to AppStore.
+
+

data/ROADMAP

@@ -0,0 +1,33 @@
+% ----
+title: CBT - Corona Build Tools
+status: producing
+leader: huangw
+moderator: xuyc
+team: [liudx cuibg wangqh]
+year: 2013
+% ----
+
+[+] design: define the interface of command line program 04/06 @huangw:04/06
+  [++] readme: rewrite readme document 04/06 @huangw:04/06
+  [++] test_design: design test strategy  04/06 @huangw:04/06
+
+[+] alpha_release: implement all features 04/06-04/15 @huangw:04/08
+  [++] struct: create new directory structure 04/06-04/07 @huangw:04/07
+  [++] copy: copy library files to build directory 04/08-04/09 @huangw:04/08
+  
+[+] alpha2: implement all features under new design 04/06-04/20 @huangw:05/23
+  [++] review_readme: review readme again 04/08 @huangw:04/08
+  [++] revise_cmd: revise command line options again 04/12 @huangw:04/12
+  [++] create: create skeleton files 04/12 @huangw:04/12
+  [++] digest: a mechanism for file contestency 04/12-04/13 @huangw:04/12
+  [++] revise_again: revise command structure again 04/15 @huangw:04/15
+  [++] cout: checkout lua and asset files 04/13-04/15 @huangw:04/17
+  [++] spec: spec test mechanism with TTS function 04/16-04/22 @huangw:04/19
+  [++] erd: create component-relationship diagram 04/22-04/23 @huangw:05/23
+
+[+] release_v0.0.1: create gem for the first time 06/03 @huangw:06/04
+
+[+] beta_release: fix functionalities 04/23-04/27 @huangw
+  [++] rewrite_beta: review and rewrite all functions 04/23-04/25 @huangw:10
+
+[+] release_v0.1.0: first public release 04/27 @huangw

data/Rakefile

@@ -0,0 +1,3 @@
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new('spec')
+

data/bin/cbt

@@ -0,0 +1,130 @@
+#!/usr/bin/env ruby
+# vim: syn=ruby
+
+# $: << 'lib' # debug only
+
+require "cbt"
+require "optparse"
+require "term/ansicolor"
+class String; include Term::ANSIColor end
+require "dev_flow"
+
+# setup for some constants
+known_platforms = %w[ios android mock debug]
+cmd_alias = {co: 'checkout', close: 'cleanup'}
+
+# parse command line options
+options = {}
+optparse = OptionParser.new do |opt|
+  opt.banner = "Usage: cbt [OPTIONS] COMMAND [COMPONENT,COMPONENT,...]"
+  opt.separator ""
+  opt.separator "Commands:"
+  opt.separator "  checkout: checkout file to workspace for development"
+  opt.separator "  build   : an alias of checkout, but force require files use"
+  opt.separator "            the same platform version as the current component"
+  opt.separator "  create  : create skeleton files for a component"
+  opt.separator "  diagram : create/update component relationship diagram"
+  opt.separator "  cleanup : safely delete a workspace folder"
+  opt.separator ""
+  opt.separator "Platforms: " + known_platforms.join(', ')
+  opt.separator ""
+  opt.separator ""
+
+  # ------------------------
+  options[:components_dir] = 'components'
+  opt.on('--components_dir DIR', 'direcctory name contains all components') do |dir|
+    options[:components_dir] = dir
+  end
+
+  options[:workspace_dir] = 'workspaces'
+  opt.on('-w DIR', '--workspace_dir DIR', 'direcctory for development') do |dir|
+    options[:workspace_dir] = dir
+  end
+
+  options[:assets_dir] = 'assets'
+  opt.on('-t DIR', '--assets_dir DIR', 'global assets directory') do |dir|
+    options[:assets_dir] = dir
+  end
+
+  options[:config_file] = 'config/components.yml'
+  opt.on('-c FILE', '--config_file FILE', 'specify the components definition file') do |file|
+    options[:config_file] = file
+  end
+
+  options[:platform] = 'debug'
+  opt.on("-p PLATFORM", "--platform PLATFORM", 'platform version for component') do |platform|
+    raise "unknown platform #{platform}" unless known_platforms.include? platform
+    options[:platform] = platform
+  end
+
+  options[:require_platform] = 'mock'
+  opt.on("-r PLATFORM", "--require_platform PLATFORM", 'platform version for required components') do |rp|
+    raise "unknown platform #{rp}" unless known_platforms.include? rp
+    options[:require_platform] = rp
+  end
+
+  opt.on('-a', '--all', 'apply to all components') do
+    options[:all] = true
+  end
+
+  opt.on('-v', '--verbose', 'print more messages') do
+    options[:verbose] = true
+  end
+
+  opt.on('-f', '--force', 'create/checkout even if file exists') do
+    options[:force] = true
+  end
+
+  opt.on('--no-consistency-check', 'checkout without check file consistency') do
+    options[:no_consistency_check] = true
+  end
+
+  opt.on('--all-spec', 'copy spec test files from all components') do
+    options[:all_spec] = true
+  end
+
+  opt.on('-s', '--similation', 'do not actually copy files, only show file list') do
+    options[:simulation] = true
+  end
+
+  # restrict output for models with those tag only
+  options[:tag] = []
+  opt.on('-t', '--tag TAG,LIST', 'restrict diagram for modules with those tag only') do |list|
+    options[:tag] = list.split(/\s*,\s*/)
+  end
+  
+  opt.on_tail('-h', '--help', 'Display this screen') do
+    puts opt
+    exit
+  end
+end
+
+optparse.parse!(ARGV)
+command = ARGV[0]
+options[:component] = ARGV[1]
+
+unless command
+  # puts "Use 'checkout' as default command"
+  command = 'checkout'
+end
+
+# if the user used a short version of command
+command = cmd_alias[command.to_sym] if cmd_alias[command.to_sym]
+
+if command == 'build'
+  options[:build] = true
+  command = 'checkout'
+end
+
+case command
+when 'create'
+  Cbt::Creator.new(options).process!
+when 'checkout'
+  Cbt::Checkout.new(options).process!
+when 'cleanup'
+  Cbt::Cleanup.new(options).process!
+when 'diagram'
+  Cbt::Diagram.new(options).process!
+else
+  raise "use one of the commands: create/checkout/build/cleanup/diagram"
+end

data/cbt.gemspec

@@ -0,0 +1,19 @@
+$LOAD_PATH.unshift File.expand_path('../lib', __FILE__)
+require 'cbt/version'
+
+Gem::Specification.new 'cbt', Cbt::VERSION do |s|
+  s.description       = "Cbt is a bundle of tools for build and test corona based applications."
+  s.summary           = "Cbt is a bundle of tools for build and test corona based applications."
+  s.executables       << "cbt"
+  s.authors           = ["Huang Wei"]
+  s.email             = "huangw@pe-po.com"
+  s.homepage          = "https://github.com/huangw/cbt-gem"
+  s.files             = `git ls-files`.split("\n") - %w[.gitignore]
+  s.test_files        = Dir.glob("{spec,test}/**/*.rb")
+  s.rdoc_options      = %w[--line-numbers --inline-source --title Cbt --main README.rdoc --encoding=UTF-8]
+
+  s.add_development_dependency 'rspec', '~> 2.5'
+  s.add_dependency 'erubis'
+  s.add_dependency 'rviz'
+end
+

data/config/components.yml

@@ -0,0 +1,20 @@
+components:
+  utils:
+    lua_modules: [util,timer]  
+    tag: utils
+  LiveObject:
+    tag: ui.base
+  Panel:
+    lua_modules: [Panel<LiveObject]
+    tag: ui.full
+  dulcinea:
+    lua_modules: [main]
+    tag: utils
+
+tags:
+  _default: {shape: record, style: filled, fillcolor: beige}
+  utils: {fillcolor: bisque3}
+  ui: {shape: Mrecord}
+  ui.base: {fillcolor: bisque3}
+  ui.full: {fillcolor: cornflowerblue}
+  

data/config/members.yml

@@ -0,0 +1,16 @@
+members:
+  huangw: ['黄巍', 'huangw@pe-po.com']
+  xuyc: ['徐以臣', 'xuyc@pe-po.com']
+  sunyr: ['孙云蕊', 'sunyr@pe-po.com']
+  lizh: ['李中华', 'lizh@pe-po.com']
+  songcy: ['宋春月', 'songcy@pe-po.com']  
+  du: ['杜丽玲', 'du@pe-po.com']
+  zhaogl: ['赵桂兰', 'zhaogl@pe-po.com']
+  wangh: ['王浩', 'wangh@pe-po.com']
+  liudx: ['刘东旭', 'liudx@pe-po.com']
+  zhangy: ['张祎', 'zhangy@pe-po.com']
+  wangqh: ['王清华', 'wangqh@pe-po.com']
+  cuibg: ['崔保国', 'cuibg@pe-po.com']
+  lixf: ['李现凤', 'lixf@pe-po.com']
+  zhaoxx: ['赵秀秀', 'zhaoxx@pe-po.com']
+