bee 0.4.0 → 0.5.0

data/README

@@ -25,4 +25,4 @@ or go to URL http://www.apache.org/licenses/LICENSE-2.0).
 
 = Copyright
 
-bee version 0.4.0 (C) Michel Casabianca & Contributors - 2006-2007
+bee version 0.5.0 (C) Michel Casabianca & Contributors - 2006-2008

data/bin/bee

@@ -1,6 +1,6 @@
 #!/usr/bin/env ruby
 
-# Copyright 2006-2007 Michel Casabianca <michel.casabianca@gmail.com>
+# Copyright 2006-2008 Michel Casabianca <michel.casabianca@gmail.com>
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.

data/bin/bee.bat

@@ -7,7 +7,7 @@ goto endofruby
 goto endofruby
 #!/usr/bin/env ruby
 
-# Copyright 2006-2007 Michel Casabianca <michel.casabianca@gmail.com>
+# Copyright 2006-2008 Michel Casabianca <michel.casabianca@gmail.com>
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.

data/egg/package.yml

@@ -0,0 +1,100 @@
+- build: package
+  default: all
+  description: "Generate a bee package project"
+
+- properties:
+  - project_name: bee_hello
+  - description: |
+      This script will create a project for a bee package with sample task (in
+      'lib' directory) and template (in 'egg' directory). A unit test for the
+      task is generated in 'test' directory. Generated build file has a target
+      'test' to run unit tests, a target 'gem' to generate a gem archive, a
+      'clean' target to clean generated files and a 'install' target to build
+      and install gem.
+
+- target: welcome
+  description: "Print information message"
+  script:
+  - print: :description
+
+- target: prompt
+  depends: welcome
+  description: "Prompt for project information"
+  script:
+  - print: "Please answer following questions to generate the project:"
+  - prompt:
+      message: "What is the project's name?"
+      default: :project_name
+      property: project_name
+
+- target: generate
+  depends: prompt
+  description: "Generate project"
+  script:
+  - print: "Generating project..."
+  - rb: |
+      project_name = "bee_#{project_name}" if not project_name =~ /^bee_/
+      error "A directory named '#{project_name}' already exists, aborting" if
+        File.exists?("#{here}/#{project_name}")
+      project_short_name = project_name[4 .. -1]
+  - mkdir: "#{here}/#{project_name}"
+  - erb:
+      src:  "#{base}/package/build.erb"
+      dest: "#{here}/#{project_name}/build.yml"
+  - cp:
+      src:  "#{base}/package/gem_spec.erb"
+      dest: "#{here}/#{project_name}/gem.spec.erb"
+  - cp:
+      src:  "#{base}/package/readme.erb"
+      dest: "#{here}/#{project_name}/readme.erb"
+  - cp:
+      src:  "#{base}/package/license"
+      dest: "#{here}/#{project_name}/LICENSE"
+  - mkdir: "#{here}/#{project_name}/lib"
+  - erb:
+      src:  "#{base}/package/bee_task.erb"
+      dest: "#{here}/#{project_name}/lib/bee_task_#{project_short_name}.rb"
+  - mkdir: "#{here}/#{project_name}/test"
+  - erb:
+      src:  "#{base}/package/test.erb"
+      dest: "#{here}/#{project_name}/test/tc_bee_task_#{project_short_name}.rb"
+  - cp:
+      src:  "#{base}/package/test_suite.rb"
+      dest: "#{here}/#{project_name}/test/ts_#{project_name}.rb"
+  - cp:
+      src:  "#{base}/package/test_build.rb"
+      dest: "#{here}/#{project_name}/test/test_build.rb"
+  - cp:
+      src:  "#{base}/package/test_build_listener.rb"
+      dest: "#{here}/#{project_name}/test/test_build_listener.rb"
+  - erb:
+      src:  "#{base}/package/test_build.erb"
+      dest: "#{here}/#{project_name}/test/build.yml"
+  - mkdir: "#{here}/#{project_name}/egg"
+  - cp:
+      src:  "#{base}/package/egg.yml"
+      dest: "#{here}/#{project_name}/egg/#{project_short_name}.yml"
+  - mkdir: "#{here}/#{project_name}/egg/#{project_short_name}"
+  - cp:
+      src:  "#{base}/package/egg_build.erb"
+      dest: "#{here}/#{project_name}/egg/#{project_short_name}/build.erb"
+  - cp:
+      src:  "#{base}/package/egg_launcher.erb"
+      dest: "#{here}/#{project_name}/egg/#{project_short_name}/launcher.erb"
+  - cp:
+      src:  "#{base}/package/egg_script.rb"
+      dest: "#{here}/#{project_name}/egg/#{project_short_name}/script.rb"
+
+- target: customization
+  depends: generate
+  description: "Print information about project customization"
+  script:
+  - print: |
+      Project has been generated in directory '#{project_name}'. Please edit
+      build file '#{project_name}/build.yml' and customize properties that are
+      not set (with a value '~'). Type 'bee -b' to print information about
+      generated build file.
+      Enjoy!
+
+- target: all
+  depends: [welcome, prompt, generate, customization]

data/egg/package/bee_task.erb

@@ -0,0 +1,25 @@
+require 'bee_task'
+
+module Bee
+  
+  module Task
+  
+    # Package for <%= project_short_name.capitalize %> tasks.
+    class <%= project_short_name.capitalize %> < Package
+    
+      # Sample hello task that prints greeting message on console.
+      # 
+      # - who: who to greet.
+      # 
+      # Example
+      # 
+      #  - <%= project_short_name %>.hello: "World"
+      def hello(who)
+        puts "Hello #{who}!"
+      end
+
+    end
+
+  end
+
+end

data/egg/package/build.erb

@@ -0,0 +1,70 @@
+# Build info
+- build: <%= project_name %>
+  default: all
+  description: |
+    Project for bee package <%= project_name %>
+
+# Build properties
+- properties:
+  - name: <%= project_name %>
+  - version: 0.0.1
+  - author: ~
+  - years: ~
+  - platform: "Gem::Platform::RUBY"
+  - summary: ~
+  - email: ~
+  - homepage: "http://<%= project_name %>.rubyforge.org"
+  - rubyforge: ~
+  - dependencies:
+      "bee": [">= 0.5.0"]
+  - lib_dir: "lib"
+  - test_dir: "test"
+  - build_dir: "build"
+  - readme_erb: "readme.erb"
+  - readme_file: "#{build_dir}/README"
+  - license_file: "LICENSE"
+  - gem_spec_erb: "gem.spec.erb"
+  - gem_spec: "#{build_dir}/gem.spec"
+  - gem_package: "#{name}-#{version}.gem"
+  - clean_dirs: :build_dir
+  - clean_files: ""
+
+# Build targets
+- target: test
+  description: Run unit tests
+  script:
+  - mkdir: :build_dir
+  - test:
+      includes: "#{test_dir}/**/tc_*.rb"
+      dir:      :test_dir
+
+- target: gem
+  depends: [clean, test]
+  description: Generate Gem package
+  script:
+  - mkdir: :build_dir
+  - erb: { src: :readme_erb, dest: :readme_file }
+  - erb: { src: :gem_spec_erb, dest: :gem_spec }
+  - gem: :gem_spec
+  - mv: { src: :gem_package, dest: :build_dir }
+
+- target: install
+  depends: gem
+  description: Install generated gem
+  script:
+  - "sudo gem install -l #{build_dir}/#{gem_package}"
+
+- target: uninstall
+  description: Uninstall gem
+  script:
+  - "sudo gem uninstall -x #{name}"
+
+- target: clean
+  description: Clean generated files
+  script:
+  - rmdir: :clean_dirs
+  - rm:    :clean_files
+
+- target: all
+  depends: [clean, gem]
+  description: Generate the whole project

data/egg/package/egg.yml

@@ -0,0 +1,58 @@
+- build: hello
+  default: all
+  description: "Generate a project for a Ruby script"
+
+- properties:
+  - project_name: hello
+  - description: |
+      This script will create a project for a Ruby script that might be
+      distributed as a gem. Generated build file has a single target gem
+      to generate the distribution gem.
+
+- target: welcome
+  description: "Print information message"
+  script:
+  - print: :description
+
+- target: prompt
+  depends: welcome
+  description: "Prompt for project information"
+  script:
+  - print: "Please answer following questions to generate the project:"
+  - prompt:
+      message: "What is the project's name?"
+      default: :project_name
+      property: project_name
+
+- target: generate
+  depends: prompt
+  description: "Generate project"
+  script:
+  - print: "Generating project..."
+  - rb: |
+      error "A directory named '#{project_name}' already exists, aborting" if
+        File.exists?("#{here}/#{project_name}")
+      name = "<%= name %>"
+  - mkdir: "#{here}/#{project_name}"
+  - mkdir: "#{here}/#{project_name}/bin"
+  - mkdir: "#{here}/#{project_name}/lib"
+  - erb:
+      src:  "#{base}/hello/build.erb"
+      dest: "#{here}/#{project_name}/build.yml"
+  - cp:
+      includes: "#{base}/hello/script.rb"
+      dest:     "#{here}/#{project_name}/lib/#{project_name}.rb"
+  - erb:
+      src:  "#{base}/hello/launcher.erb"
+      dest: "#{here}/#{project_name}/bin/#{project_name}"
+
+- target: customization
+  depends: generate
+  description: "Print information about project customization"
+  script:
+  - print: |
+      Project has been generated in directory '#{project_name}'. Type 'bee -b'
+      to print information about generated build file. Enjoy!
+
+- target: all
+  depends: [welcome, prompt, generate, customization]

data/egg/package/egg_build.erb

@@ -0,0 +1,57 @@
+- build: <%= project_name %>
+  description: "Project to generate a gem for a Ruby script"
+  default: all
+
+- properties:
+  - name: <%= project_name %>
+  - version: 0.0.1
+  - build: build
+  - gem_spec: "#{build}/gem_spec"
+  - gem_erb: |
+      require 'rubygems'
+      SPEC = Gem::Specification.new do |spec|
+        spec.name = '<%= name %>'
+        spec.version = '0.0.1'
+        spec.platform = 'ruby'
+        spec.summary = 'summary'
+        spec.author = 'author'
+        spec.email = 'email'
+        spec.homepage = 'homepage'
+        spec.rubyforge_project = 'rubyforge project'
+        spec.require_path = 'lib'
+        spec.files = Dir.glob('{bin,lib}/*')
+        spec.has_rdoc = true
+        spec.executables = ['<%= name %>']
+      end
+
+- target: gem
+  description: "Generate gem archive"
+  script:
+  - mkdir: :build
+  - erb:
+      source: :gem_erb
+      dest:   :gem_spec
+  - gem: :gem_spec
+  - mv:
+      src:  "*.gem"
+      dest: :build
+
+- target: install
+  depends: gem
+  description: Install generated gem
+  script:
+  - "sudo gem install #{build}/#{name}-#{version}.gem"
+
+- target: uninstall
+  description: Uninstall gem
+  script:
+  - "sudo gem uninstall -x #{name}"
+
+- target: clean
+  description: Clean generated files
+  script:
+  - rmdir: :build
+
+- target: all
+  depends: [clean, gem, install]
+  description: Generate and install the gem

data/egg/package/egg_launcher.erb

@@ -0,0 +1,6 @@
+#!/usr/bin/env ruby
+# Launching script.
+
+$:.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+
+load '<%= project_name %>.rb'

data/egg/package/egg_script.rb

@@ -0,0 +1,31 @@
+#!/usr/bin/env ruby
+
+# Greet a given person.
+# - who: the person to greey.
+def hello(who)
+  return "Hello #{who}!"
+end
+
+# command line help
+HELP = 'hello [-h] who ...
+-h      To print this help screen
+who     The person(s) to greet'
+
+# parse command line arguments
+require 'getoptlong'
+opts = GetoptLong.new(['--help', '-h', GetoptLong::NO_ARGUMENT])
+begin
+  opts.each do |opt, arg|
+    case opt
+    when '--help'
+      puts HELP
+      exit
+    end
+  end
+rescue
+  puts HELP
+  exit
+end
+for who in ARGV
+  puts hello(who)
+end

data/egg/package/gem_spec.erb

@@ -0,0 +1,23 @@
+require 'rubygems'
+
+SPEC = Gem::Specification.new do |spec|
+  spec.name = '<%= name %>'
+  spec.version = '<%= version %>'
+  spec.author = '<%= author %>'
+  spec.email = '<%= email %>'
+  spec.homepage = '<%= homepage %>'
+  spec.rubyforge_project = '<%= rubyforge %>'
+  spec.platform = <%= platform %>
+  spec.summary = '<%= summary %>'
+  spec.files = Dir.glob('{lib,test,egg}/**/*').delete_if do |file|
+    file =~ /CVS/
+  end
+  spec.require_path = '<%= lib_dir %>'
+  spec.test_file = 'test/ts_<%= name %>.rb'
+  spec.has_rdoc = true
+  spec.extra_rdoc_files = ['<%= readme_file %>', '<%= license_file %>']
+<% for key in dependencies.keys.sort %>
+  spec.add_dependency("<%= key %>", <%= dependencies[key].inspect %>)
+<% end %>
+  spec.post_install_message = 'Enjoy bee!'
+end

data/egg/package/license

@@ -0,0 +1,202 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.