asproject 0.1.21

data/MIT-LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2007 Luke Bayes
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/Manifest.txt

@@ -0,0 +1,16 @@
+Rakefile
+README.txt
+CHANGELOG.txt
+MIT-LICENSE.txt
+Manifest.txt
+setup.rb
+test/test_helper.rb
+test/asproject_test.rb
+test/projects
+bin/asproject
+bin/asclass
+lib/tasks/asproject.rake
+lib/asproject/version.rb
+lib/asproject.rb
+lib/asproject_base.rb
+lib/asclass.rb

data/README.txt

@@ -0,0 +1,3 @@
+README for asproject
+====================
+

data/TODO.txt

@@ -0,0 +1,10 @@
+---------------------
+Tasks Remaining
+
+* Get empty directories to bundle in the gem file
+* Get mac to follow and manage the flash player process
+
+* Update the pc on the flash player thread process
+* Integrate as2/mxmlc support
+* Create asunit application for test execution/tracking
+

data/bin/asclass

@@ -0,0 +1,16 @@
+#!/usr/bin/env ruby
+
+require 'rubygems'
+version = "> 0"
+
+if ARGV.size > 0 && ARGV[0][0]==95 && ARGV[0][-1]==95
+  if Gem::Version.correct?(ARGV[0][1..-2])
+    version = ARGV[0][1..-2] 
+    ARGV.shift
+  end
+end
+
+require_gem 'asproject', version
+require 'asclass.rb'
+
+AsProject::AsClass.new

data/bin/asproject

@@ -0,0 +1,16 @@
+#!/usr/bin/env ruby
+
+require 'rubygems'
+version = "> 0"
+
+if ARGV.size > 0 && ARGV[0][0]==95 && ARGV[0][-1]==95
+  if Gem::Version.correct?(ARGV[0][1..-2])
+    version = ARGV[0][1..-2] 
+    ARGV.shift
+  end
+end
+
+require_gem 'asproject', version
+require 'asproject.rb'
+
+AsProject::AsProject.new

data/lib/asclass.rb

@@ -0,0 +1,254 @@
+$:.push(File.dirname(__FILE__))
+
+#require 'rake'
+require 'asproject'
+require 'asclass_arguments'
+require 'test_suite_generator'
+
+module AsProject
+  class AsClass < AsProjectBase
+    @@TEMPLATE_TYPE               = 'asclass'
+    @@CLASS_TEMPLATE              = 'Class.as'
+    @@TEST_CASE_TEMPLATE          = 'TestCase.as'
+    @@TEST_SUITE_TEMPLATE         = 'TestSuite.as'
+    @@INTERFACE_TEMPLATE          = 'Interface.as'
+    @@COMPONENT_TEMPLATE          = 'Component.as'
+    @@MXML_TEMPLATE               = 'Component.mxml'
+    
+    def initialize(args=nil)
+#      begin
+        @created_files = []
+        @arguments = parse_args(args)
+        @project = get_project(@arguments.execution_dir)
+        if(!@arguments.name.nil?)
+          configure_project(@arguments.name)
+        end
+        if(@arguments.force)
+          @project.replace_all = true
+        end
+        execute
+        finish
+#      rescue Exception => e
+#        puts e.to_s
+#        exit
+#      end
+    end
+    
+    def parse_args(args=nil)
+      if(args.nil?)
+        args = AsClassArguments.new
+        args.execution_dir = Dir.pwd
+        args.parse!(ARGV)
+      end
+      return args
+    end
+
+    def execute
+      name = @arguments.name
+      
+      # Only build class and test case if a name
+      # was provided...
+      if(!name.nil?)
+        is_test_case = false
+        is_interface = false
+
+        template = ''
+        if(@arguments.mxml)
+          @project['display_object'] = true
+          template = mxml_template
+        elsif(@arguments.component)
+          template = component_template
+        elsif(name.match(/Test$/))
+          is_test_case = true
+          template = test_case_template
+        elsif(name.index('I') == 0 || name.index('able') == name.size - 4)
+          is_interface = true
+          template = interface_template
+        else
+          template = class_template
+        end
+        
+        if(!is_test_case)
+          create_class(template)
+        end
+        
+        if(!is_interface && @arguments.build_test_case || is_test_case)
+          template = test_case_template
+          create_test_case(template)
+        end
+      end
+      
+      if(@arguments.build_test_suites)
+        create_test_suites
+      end
+    end
+    
+    def create_class(template_file)
+      suffix = '.' + template_file.split(File::SEPARATOR).pop.split('.').pop
+      target_name = capitalize(@project['class_name'] + suffix)
+      create_file(template_file, @project.source_dir, target_name)
+    end
+    
+    def create_test_case(template_file)
+      suffix = '.' + template_file.split(File::SEPARATOR).pop.split('.').pop
+      target_name = capitalize(@project['class_name'] + 'Test' + suffix)
+      create_file(template_file, @project.test_dir, target_name)
+    end
+    
+    def create_file(template_file, target_dir, target_name)
+      template_base = select_template_base
+      @arguments.verify_template(template_base)
+      source_location = @project.get_template(template_type, File.join(template_base, template_file))
+      package_dirs = @project['package_name'].split('.').join(File::SEPARATOR)
+      target_location = File.join(target_dir, package_dirs, target_name)
+      @created_files << @project.copy_file(source_location, target_location, true)
+    end
+    
+    def select_template_base
+      if(@arguments.template.nil?)
+        return @project.default_templates[0]
+      else
+        return @arguments.template
+      end
+    end
+    
+    def create_test_suites
+      template_base = select_template_base
+      template = @project.get_template(template_type, File.join(template_base, 'TestSuite.as'))
+      content = IO.read(template)
+      name = 'AllTests.as'
+      suite_generator = TestSuiteGenerator.new(@project.test_dir, name, content)
+      suite_generator.created_files.each do |suite|
+        @created_files << suite
+      end
+    end
+    
+    # package_name
+    # class_name
+    # full_class_name
+    # test_case_name
+    # full_test_case_name
+    # instance_name
+    # add_child_line
+    # remove_child_line
+    
+    def configure_project(name)
+      @project['display_object'] = false
+      @project['package_name'] = get_package_name(name)
+      @project['class_name'] = get_class_name(name)
+      @project['full_class_name'] = @project['package_name'] + '.' + @project['class_name']
+      @project['test_case_name'] = get_test_case_name(name)
+      @project['full_test_case_name'] = @project['package_name'] + '.' + @project['test_case_name']
+      @project['instance_name'] = get_instance_name(name)
+    end
+    
+    def get_package_name(name)
+      parts = name.split('.')
+      parts.pop
+      return parts.join('.')
+    end
+    
+    def get_class_name(name)
+      name = name.sub(/Test$/, '')
+      parts = name.split('.')
+      return parts.pop
+    end
+    
+    def get_class_location(name)
+      pkg = get_package_name(name)
+      return pkg.split('.').join(File::SEPARATOR)
+    end
+    
+    def get_test_case_name(name)
+      return get_class_name(name) + 'Test'
+    end
+    
+    def get_instance_name(name)
+      name = get_class_name(name)
+      chars = name.split('')
+      chars[0] = chars[0].downcase
+      return chars.join('')
+    end
+    
+    def template_type
+      return @@TEMPLATE_TYPE
+    end
+    
+    def class_template
+      return @@CLASS_TEMPLATE
+    end
+    
+    def interface_template
+      return @@INTERFACE_TEMPLATE
+    end
+    
+    def test_case_template
+      return @@TEST_CASE_TEMPLATE
+    end
+    
+    def component_template
+      return @@COMPONENT_TEMPLATE
+    end
+    
+    def mxml_template
+      return @@MXML_TEMPLATE
+    end
+    
+    def get_project(dir)
+      if(File.exists?(File.join(dir, '.project')))
+        return AsClassProject.new(dir)
+      end
+      raise ProjectError.new('AsClass could not find a .project file in the current directory: ' + dir)
+    end
+  end
+  
+  # TODO: Refactor EclipseProject out so that
+  # Project just instantiates a parser as needed
+  # and this class extends the more abstract Project
+  class AsClassProject < EclipseProject
+  
+    def package_name
+      return self['package_name']
+    end
+    
+    def class_name
+      return self['class_name']
+    end
+    
+    def full_class_name
+      return self['full_class_name']
+    end
+    
+    def test_case_name
+      return self['test_case_name']
+    end
+    
+    def full_test_case_name
+      self['full_test_case_name']
+    end
+    
+    def instance_name
+      self['instance_name']
+    end
+    
+    def display_object?
+      self['display_object']
+    end
+
+    def add_child_line
+      if(display_object?)
+        return "\n      addChild(#{instance_name});"
+      else
+        return ""
+      end
+    end
+    
+    def remove_child_line
+      if(display_object?)
+        return "removeChild(#{instance_name});\n      "
+      else
+        return ""
+      end
+    end
+  end
+end

data/lib/asclass_arguments.rb

@@ -0,0 +1,147 @@
+
+module AsProject
+
+  #######################################
+  # ProjectArguments
+  class AsClassArguments < Hash
+    attr_accessor :execution_dir, 
+                  :name,
+                  :mxml,
+                  :component, 
+                  :force, 
+                  :build_test_case,
+                  :build_test_suites,
+                  :display_object,
+                  :template,
+    @@TEMPLATE_TYPE              = 'asclass'
+
+    def initialize(dir=nil)
+      if(dir.nil?)
+        @execution_dir           = Dir.pwd
+      else
+        @execution_dir           = dir
+      end
+      @path_finder               = PathFinder.new(@execution_dir)
+      @force                     = false
+      @mxml                      = false
+      @component                 = false
+      @template                  = nil
+      self[:name]                = nil
+      self[:build_test_suites]   = false # -s == --build-test-suites
+      self[:build_test_case]     = true # -n == --no-test-case ?
+      self[:verbose]             = true
+
+      @class_templates           = @path_finder.get_available_templates(@@TEMPLATE_TYPE)
+    end
+    
+    def parse!(args)
+      opts = OptionParser.new do |opts|
+        opts.banner = <<EOF
+
+Usage: #$0 [options] packagename.ClassName
+
+AsClass will automatically determine which template file to use based on the class name entered.
+1) Names beginning with 'I' or ending with 'able' are assumed to be interfaces and use 'Interface.as'
+2) Names ending with 'Test' are assumed to be test cases and use the 'TestCase.as' template
+3) If the --mxml flag is set, the 'Component.mxml' template is used
+4) If the --component flas is set, the 'Component.as' template is used
+5) If none of the previous criteria are met, the 'Class.as' template is used
+
+Classes will be placed in the ProjectPath/src directory.
+Test cases and test suites will be placed in the ProjectPath/test directory.
+
+Using -t requires a single template selection. The template is a folder name inside of the asclass folder.
+
+Templates will be used when found in the first folder of the following list:
+1) ./{ProjectName}/config/templates/asclass
+2) #{@path_finder.user_asproject_home}/templates/asclass
+3) #{@path_finder.gem_asproject_home}/templates/asclass
+
+Options:
+EOF
+#        opts.on('-c', '--copy-templates', "Copy templates to {ProjectName}/config/templates") do
+#          self[:copy_to_project] = true
+#        end
+#
+#        opts.on('-C', '--copy-templates-to-home', "Copy templates to this user account") do
+#          self[:copy_to_home] = true
+#        end
+#
+#        opts.on('-d', '--default-templates', "Set default templates for this project eg: 'mxml,fb2mxml,asunit'") do
+#          self[:default_templates] = true
+#        end
+#
+#        opts.on('-D', '--default-templates-to-home', "Set the default templates for this user account") do
+#          self[:default_home_templates] = true
+#        end
+
+        opts.on('-f', '--force', "Force creation - overwrite if necessary") do
+          self[:force] = true
+        end
+
+        opts.on('-q', '--quiet', "Do not display created file names") do
+          self[:verbose] = false
+        end
+
+        opts.on('-s', '--build-test-suites', "Build TestSuites in my test directory") do
+          self[:build_test_suites] = true
+        end
+
+        opts.on('-t', '--template [STRING]', "Define which project template folder to use.") do |str|
+          self[:template] = str
+        end
+      
+        opts.on_tail('-h', '--help', 'display this help and exit') do
+          puts opts
+          exit
+        end
+      end
+      opts.parse!(args)
+
+      if(args.size > 0)
+        self[:name] = args.shift.to_s
+      end
+    end
+    
+    def verify_template(template)
+      if(!@class_templates.index template)
+        msg = <<EOF
+
+Template [#{template}] was not found! 
+
+Please try again with one of the following available templates:
+#{@class_templates.join(', ')}
+EOF
+        raise ProjectError.new(msg)
+      end
+    end
+    
+    def template=(template)
+      self[:template] = template
+    end
+    
+    def template
+      return self[:template]
+    end
+    
+    def name
+      return self[:name]
+    end
+    
+    def verbose
+      return self[:verbose]
+    end
+    
+    def build_test_case
+      return self[:build_test_case]
+    end
+    
+    def build_test_suites
+      return self[:build_test_suites]
+    end
+    
+    def force?
+      return self[:force]
+    end
+  end
+end