semillagen 0.0.1

data/lib/semillagen/generator.rb

@@ -0,0 +1,248 @@
+# encoding: utf-8
+
+
+module SemillaGen
+  
+  #Contains description information for a single template item.
+  # A class template can have more than one file in it, for example:
+  # a class definition and the test case definition for the class.
+  class TemplateItem
+    attr_accessor :target, :name_pattern, :source
+  end
+  
+  
+  
+  # Generates items (Projects or Classes) using the specified
+  # template and name.
+  # 
+  # @param [itemtype] The  kind of item to create, ':class' or ':project'.
+  # @param [template] The name of the template to use.
+  # @param [name] The name of project or qualified class name to generate.
+  def self.generate(itemtype, template, name)
+    
+    #find the template folder
+    template_folder = SemillaGen::findTemplate(itemtype, template)
+    
+    raise "Template not found." if template_folder.nil?
+    
+    
+    if itemtype == :class
+      #When item is a class type
+      
+      #Read the info.semilla file
+      files = SemillaGen::parseInfoFile File.join(template_folder, "info.semilla")
+      SemillaGen::generateFiles(template_folder, files, name)
+    
+    elsif itemtype == :project
+      #when item is a project type
+      
+      SemillaGen::generateProject(template_folder, name)
+    end
+  end
+
+
+
+  # Read a info.semilla file. This file contains
+  # a description of the files to create.
+  # Each line has the following format:
+  #    filename_pattern : template_file => target_path
+  # 
+  #    filename_pattern = How the generated file should be named.
+  #    template_file = The file whose contents will be used to generate the new file.
+  #                    Some keywords inside the text will be replaced
+  #                    (@@PACKAGE@@, @@NAME@@)
+  #    target_path = The folder where the file should be created.
+  #
+  # @param [path] The path to the info.semilla file to read.
+  #
+  # @return [Array of TemplateItem] The collection of TemplateItem parsed.
+  def self.parseInfoFile(path)
+    
+    files = {}
+    
+    if File.exists? path
+      File.open(path, 'r') do |f|
+        while(line = f.gets)
+          line.strip! #Remove white space
+          
+          next if line.start_with?("#") or line.empty? #Skip comments or blank lines
+          
+          #Match "FILENAME => PATH"
+          line.match(/([@\w.\-]+)\s*:\s*([\w.\-]+\.tpl) => ([\w.\-\/]+)/) do |m|
+             nameFormat, sourceFile, targetPath = m.captures
+             
+             item = SemillaGen::TemplateItem.new
+             item.target = targetPath
+             item.name_pattern = nameFormat
+             item.source = sourceFile
+             
+             files[sourceFile] = item
+          end
+          
+        end
+      end
+    end
+    
+    return files
+    
+  end
+  
+  
+  
+  # Creates a directory hierarchy for the given directory path if the directories
+  # do not exist.
+  #
+  # @param [path] The path to create if it does not exist already.
+  def self.recursive_mkdir(path)
+    steps = path.split File::SEPARATOR
+    
+    original_dir = Dir.pwd
+    
+    steps.each do |s|
+      #Make dir if it does not exist
+      if !File.directory? s
+        Dir.mkdir s
+        #puts "mkdir #{s}"
+      end 
+      Dir.chdir s
+    end
+    
+    Dir.chdir original_dir
+    
+  end
+
+
+
+  # Generates files for a class.
+  # @param [templateFolder] The folder where the template to be used is located.
+  # @param [fileList] The collection of TemplateItems to be generated.
+  # @param [qualifiedName] The qualified name of the class to be generated (includes namespaces)
+  def self.generateFiles(templateFolder, fileList, qualifiedName)
+    puts "Generating files for: #{qualifiedName}"
+    
+    fileList.map do |key, item|
+      #puts "----------#{key}"
+      
+      #Check that the sourceFile exists
+      source_full_path = File.absolute_path(File.join(templateFolder, item.source))
+      if File.exists? source_full_path
+        #Obtain namespaces
+        namespaces = qualifiedName.split '.' #Separate all the qualified name components
+        itemName = namespaces.last #the last component is the class name
+        namespaces = namespaces.take(namespaces.length-1) #The rest is the namespace (as array)
+        namespace_text = namespaces.join('.') #the namespace in ActionScript notation
+        
+        #Append to the target path, the namespaces as folders
+        final_path = namespaces.unshift(item.target).join(File::SEPARATOR)
+        #Make sure the final_path directories exist
+        self.recursive_mkdir final_path
+        
+        #Generate the new name
+        fileName = item.name_pattern.sub('@@', itemName)
+        
+        #Read the source file
+        source_text = IO.read source_full_path
+        
+        #Define the keywords to be replaced in the template
+        keywords = {}
+        keywords['@@PACKAGE@@'] = namespace_text
+        keywords['@@NAME@@'] = itemName
+        #Replace the keywords in the source text
+        keywords.each do |k,v|
+          source_text.gsub! k, v #use gsub to teplace all ocurrences
+        end
+        #Write out the file
+        outpath = File.join(final_path, fileName)
+        puts "    => #{outpath}"
+        File.open(outpath, 'w') {|w| w << source_text}
+                
+      else #The source file is not found but it was specified in the info.semilla file.
+        raise "Template file is missing: [#{item.source}]"
+      end
+      
+    end
+    
+  end
+  
+  # Copies (while adjusting contents of files) files and directories recursively.
+  #
+  # @param [path] The path where the source files are read
+  # @param [target_path] The path where the new files will be copied to
+  # @param [options] Hash containing some settings for the file generation/adjustment
+  def self.recursiveCopyDir(path, target_path, options)
+    Dir.foreach path do |f|
+      #Skip hidden files, unless in 'allowedFiles' list
+      next if f.start_with?(".") and !options[:allowed_files].include?(f)
+      
+      #The absolute path for the template file/dir
+      source_path = File.join path, f
+      #The name of the file/dir to generate
+      target_name = self.processText f, options
+      #The absolute path of the file/dir to generate
+      generate_path = File.join target_path, target_name
+      
+      if File.directory?(source_path)
+        #Create the new dir
+        Dir.mkdir generate_path
+        puts "mkdir #{generate_path}"
+        self.recursiveCopyDir(source_path, generate_path, options)
+        
+      else
+        #Copy the file to the new destination
+        
+        # -> **Only process files whose extension is not in options[:dont_process_contents]
+        should_process = options[:dont_process_contents].index{|x| source_path.end_with? x}.nil?
+        if should_process
+          # -> Read file contents
+          fileContents = IO.read source_path
+          # -> Adjust project name in content
+          fileContents = self.processText fileContents, options
+          # -> Write file to destination path
+          puts "write #{generate_path} [E]" #The [E] at the end means that the file's contents were editted (ex: Project name replaced).
+          File.open(generate_path, 'w') {|w| w << fileContents}
+        else
+          #just copy the file as is
+          puts "write #{generate_path}"
+          `cp "#{source_path}" "#{generate_path}"`
+        end
+        
+        
+      end
+    end
+  end
+  
+  
+  # Replaces the DEFAULT_PROJECTNAME in the string to the one specified in options
+  #
+  # @param [text] The that will we processed
+  # @param [options] Hash array with the values to be used while processing the text
+  # @return [String]
+  def self.processText(text, options)
+    return text.gsub(SemillaGen::DEFAULT_PROJECTNAME, options[:project_name]) 
+  end
+  
+  # Generates a project
+  #
+  # @param [templateFolder] The folder containing the project template to use
+  # @param [name] The name of the new project
+  def self.generateProject(templateFolder, name)
+    puts "Generating project [#{name}]"
+    
+    #Create directory
+    Dir.mkdir name
+    
+    options = {}
+    options[:project_name] = name
+    options[:allowed_files] = %w{.gitignore} 
+    options[:dont_process_contents] = %w{.swc .swf .jar .exe .bin}
+    
+    target_path = File.join(Dir.pwd, name)
+    
+    self.recursiveCopyDir(templateFolder, target_path, options)
+      
+  end
+  
+  
+  
+end
+

data/lib/semillagen/utils.rb

@@ -0,0 +1,40 @@
+# encoding: utf-8
+require 'pp'
+
+module SemillaGen
+
+  TEMPLATE_FOLDER = "semilla_templates"
+
+  # Find the template for the specified item type and template name.
+  # Ex: Find a template for projects, named ClassicMVVMProjectTemplate
+  #
+  # @param [itemtype] can be ':class' or ':project'
+  # @param [templatename] 
+  def self.findTemplate(itemtype, templatename)
+
+    dirs = [
+      File.expand_path(TEMPLATE_FOLDER), #current folder
+      File.expand_path("~/#{TEMPLATE_FOLDER}"), #home folder
+      SemillaGen::DEFAULT_TEMPLATE_FOLDER #gem lib folder
+    ]
+
+    absolute_path = nil;
+    location = File.join(itemtype.to_s, templatename.to_s)
+    #puts "location #{location}"
+    
+    dirs.each do |dir|
+      #Look for location in dir
+      currentlocation = File.join(dir, location)
+      #puts currentlocation
+      if File.directory? currentlocation
+        absolute_path = currentlocation
+        break;
+      end
+    end
+
+    #If we found the template, absolute_path should not be nil
+    puts "Template found at: #{absolute_path}"
+    return absolute_path
+  end
+
+end

data/lib/semillagen/version.rb

@@ -0,0 +1,3 @@
+module SemillaGen
+  VERSION = '0.0.1'
+end

data/lib/semillagen.rb

@@ -0,0 +1,33 @@
+
+
+module SemillaGen
+  
+  DEFAULT_TEMPLATE_FOLDER = File.expand_path('../default_templates', File.dirname(__FILE__))
+  
+  DEFAULT_PROJECTNAME = "MagicBox" 
+end
+
+require 'semillagen/utils'
+require 'semillagen/generator'
+
+## semillagen Usage:
+
+=begin
+ 
+## Usage
+
+- To generate a project (with default template)
+
+    $ semillagen project MyProject
+
+- To generate a class (with default template)
+
+    $ semillagen class MyProject.MyNamespace.MyClass
+
+- To generate a class with a specific template
+
+    $ semillagen class MyProject.MySpecialStuff.SpecialClass -t SkinnedControlTemplate
+
+
+  
+=end

data/rakefile.rb

@@ -0,0 +1,39 @@
+require 'rubygems'
+require 'rake/clean'
+require 'rake'
+require_relative "lib/semillagen/version"
+
+
+version = SemillaGen::VERSION
+gemfile = "semillagen-#{version}.gem"
+gemspecfile = "semillagen.gemspec"
+########################################################################################################################
+
+#####################################
+#Clean
+CLEAN << FileList["*.gem"]
+
+
+#####################################
+#Build the gem file
+file gemfile => [gemspecfile] do |t|
+  sh "gem build #{gemspecfile}"
+end
+
+desc "Builds the gem"
+task :build => gemfile
+
+####################################
+desc "Uninstall the gem"
+task :uninstall do |t|
+  sh "gem uninstall semillagen"
+end
+
+##################################
+desc "Install the gem"
+task :install => :build do |t|
+  sh "gem install #{gemfile}"
+end
+
+##################################
+task :default => [:clean, :build, :install]

data/semillagen.gemspec

@@ -0,0 +1,76 @@
+
+# -*- encoding: utf-8 -*-
+$:.push('lib')
+require "semillagen/version"
+
+Gem::Specification.new do |s|
+  s.name     = "semillagen"
+  s.version  = SemillaGen::VERSION.dup
+  s.date     = "2012-03-22"
+  s.summary  = "Simple ActionScript project generation."
+  s.email    = "support@semilla.com"
+  s.homepage = "http://github.com/Darkoleptiko/SemillaGen/"
+  s.authors  = ['Victor G. Rosales']
+  
+  s.description = <<-EOF
+SemillaGen let's you create (Actionscript3.0 based) projects and classes with ease.
+SemillaGen generated projects or classes are customizable via templates.
+
+The default templates setup the project for Continuous Integration using FlexUnit.
+the default class template creates a class and a test case automatically.
+
+usage:
+
+To create a new project run:
+  $ semillagen project MyAwesomeProject  
+  $ ls
+  MyAwesomeProject
+  
+To create a new class with test case:
+  $ cd MyAwesomeProject
+  $ semillagen class com.semilla.MillionDollarClass
+  
+You will see that semillagen created the following files:
+src/com/semilla/MillionDollarClass.as
+test-src/com/semilla/MillionDollarClassTest.as
+
+The default template is ready for building as soon as created.
+To build and test your project we use rake.
+
+  $ rake
+  
+Rake will build a debug and release versions of your project. It will also create a FlexUnit test swf and run the test.
+You will see the results of the tests and also you will see some xml files under the [test-report] folder. These reports
+are JUnit compatible.
+
+You can use a CI tool like Jenkins to automatically build and test your project.
+    
+EOF
+  
+  dependencies = [
+    # Examples:
+    # [:runtime,     "rack",  "~> 1.1"],
+    # [:development, "rspec", "~> 2.1"],
+    [:semilla, "semilla", "~> 0.0.5"],
+    [:rake, "rake", "~> 0.9.2"]
+  ]
+  
+  s.files         = Dir['**/*']
+  s.test_files    = Dir['test/**/*'] + Dir['spec/**/*']
+  s.executables   = Dir['bin/*'].map { |f| File.basename(f) }
+  s.require_paths = ["lib"]
+  
+  
+  ## Make sure you can build the gem on older versions of RubyGems too:
+  s.rubygems_version = "1.8.15"
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.specification_version = 3 if s.respond_to? :specification_version
+  
+  dependencies.each do |type, name, version|
+    if s.respond_to?("add_#{type}_dependency")
+      s.send("add_#{type}_dependency", name, version)
+    else
+      s.add_dependency(name, version)
+    end
+  end
+end

metadata

@@ -0,0 +1,136 @@
+--- !ruby/object:Gem::Specification
+name: semillagen
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Victor G. Rosales
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-03-22 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: semilla
+  requirement: &2160461360 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.0.5
+  type: :runtime
+  prerelease: false
+  version_requirements: *2160461360
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: &2160460320 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.9.2
+  type: :runtime
+  prerelease: false
+  version_requirements: *2160460320
+description: ! "SemillaGen let's you create (Actionscript3.0 based) projects and classes
+  with ease.\nSemillaGen generated projects or classes are customizable via templates.\n\nThe
+  default templates setup the project for Continuous Integration using FlexUnit.\nthe
+  default class template creates a class and a test case automatically.\n\nusage:\n\nTo
+  create a new project run:\n  $ semillagen project MyAwesomeProject  \n  $ ls\n  MyAwesomeProject\n
+  \ \nTo create a new class with test case:\n  $ cd MyAwesomeProject\n  $ semillagen
+  class com.semilla.MillionDollarClass\n  \nYou will see that semillagen created the
+  following files:\nsrc/com/semilla/MillionDollarClass.as\ntest-src/com/semilla/MillionDollarClassTest.as\n\nThe
+  default template is ready for building as soon as created.\nTo build and test your
+  project we use rake.\n\n  $ rake\n  \nRake will build a debug and release versions
+  of your project. It will also create a FlexUnit test swf and run the test.\nYou
+  will see the results of the tests and also you will see some xml files under the
+  [test-report] folder. These reports\nare JUnit compatible.\n\nYou can use a CI tool
+  like Jenkins to automatically build and test your project.\n    \n"
+email: support@semilla.com
+executables:
+- semillagen
+extensions: []
+extra_rdoc_files: []
+files:
+- bin/semillagen
+- default_templates/class/default/classTemplate.as.tpl
+- default_templates/class/default/info.semilla
+- default_templates/class/default/testClassTemplate.as.tpl
+- default_templates/project/default/Gemfile
+- default_templates/project/default/Gemfile.lock
+- default_templates/project/default/lib/flexunit4/flexunit-4.1.0-8-as3_4.1.0.16076.swc
+- default_templates/project/default/lib/flexunit4/flexunit-cilistener-4.1.0-8-4.1.0.16076.swc
+- default_templates/project/default/lib/flexunit4/flexunit-uilistener-4.1.0-8-4.1.0.16076.swc
+- default_templates/project/default/lib/flexunit4/FlexUnit1Lib.swc
+- default_templates/project/default/lib/flexunit4/flexUnitTasks-4.1.0-8-javadoc.jar
+- default_templates/project/default/lib/flexunit4/flexUnitTasks-4.1.0-8-sources.jar
+- default_templates/project/default/lib/flexunit4/flexUnitTasks-4.1.0-8.jar
+- default_templates/project/default/lib/flexunit4/fluint-extensions-4.1.0-8-4.1.0.16076.swc
+- default_templates/project/default/lib/flexunit4/hamcrest-as3-flex-1.1.3.swc
+- default_templates/project/default/MagicBox.as3proj
+- default_templates/project/default/rakefile.rb
+- default_templates/project/default/src/MagicBox.as
+- default_templates/project/default/src/PlainButton.as
+- default_templates/project/default/src/transforms/LeetTransform.as
+- default_templates/project/default/src/transforms/LowerCaseTransform.as
+- default_templates/project/default/src/transforms/ReverseTransform.as
+- default_templates/project/default/src/transforms/SplitTransform.as
+- default_templates/project/default/src/transforms/UpperCaseTransform.as
+- default_templates/project/default/test-src/listeners/SemillaCIListener.as
+- default_templates/project/default/test-src/listeners/TraceListener.as
+- default_templates/project/default/test-src/TestRunner.template
+- default_templates/project/default/test-src/TextFieldListener.as
+- default_templates/project/default/test-src/transforms/LeetTransformTest.as
+- default_templates/project/default/test-src/transforms/LowerCaseTransformTest.as
+- default_templates/project/default/test-src/transforms/ReverseTransformTest.as
+- default_templates/project/default/test-src/transforms/SplitTransformTest.as
+- default_templates/project/default/test-src/transforms/UpperCaseTransformTest.as
+- doc/_index.html
+- doc/class_list.html
+- doc/css/common.css
+- doc/css/full_list.css
+- doc/css/style.css
+- doc/file_list.html
+- doc/frames.html
+- doc/index.html
+- doc/js/app.js
+- doc/js/full_list.js
+- doc/js/jquery.js
+- doc/method_list.html
+- doc/SemillaGen/TemplateItem.html
+- doc/SemillaGen.html
+- doc/top-level-namespace.html
+- lib/semillagen/generator.rb
+- lib/semillagen/utils.rb
+- lib/semillagen/version.rb
+- lib/semillagen.rb
+- rakefile.rb
+- README.md
+- semillagen.gemspec
+homepage: http://github.com/Darkoleptiko/SemillaGen/
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.15
+signing_key: 
+specification_version: 3
+summary: Simple ActionScript project generation.
+test_files: []
+has_rdoc: