fumoffu 0.0.2 → 0.1.0

data/Gemfile

@@ -18,11 +18,4 @@ platforms :jruby do
     gem "rcov", ">= 0.9.9"
     gem "shoulda"
   end
-  #  group :db do
-  #    gem "activerecord-jdbcmysql-adapter"
-  #    gem "activerecord-jdbcpostgresql-adapter"
-  #  end
-
-  #  gem "rawr"
-  #  gem "log4r"
 end

data/README.md

@@ -4,9 +4,14 @@ Lionel Abderemane aka Bouba
 
 http://github.com/bouba/fumoffu
 
-I just started a month ago so the whole thing is still pretty fresh and VERY unstable ^_^.
+The current version of fumoffu has changed quite a bit. It is still "fresh" but I believe that the structure
+is much better and easier to understand. I still have not found a satisfactory way to run the tests. 
 
-So I hope you will be able to enjoy it. I will try may best documenting the project progressively.
+But I think I manage to improve the way the application is packaged.
+
+Fumoffu is now released as a gem. So you may find it on [Rubygem](https://rubygems.org/gems/fumoffu) website
+
+So I hope you will be able to enjoy it.
 
 ## Description
 
@@ -25,15 +30,23 @@ You can see a tutorial of a sample application made with this framework [here](h
 
 ## Installation
 
--   **Setup your [JRuby][jruby] environment**
+### From gem
+
+    gem i fumoffu
+
+### From sources
+
+**Setup your [JRuby][jruby] environment**
+
+First download and install [JRuby][jruby] if do not have it
 
-    _First download and install [JRuby][jruby] if do not have it_  
 __On a terminal__  
+
 To load your [JRuby][jruby] environment in a terminal just make a quick export  
 
       export PATH=/your/local/path/jruby-X.X.X/bin:$PATH
 
--   **Download and setup the Fumoffu gem**
+Download and setup the Fumoffu gem
 
     _Since I still did put the gem on ruby forge to install it you to download and generate the gem manually to install it_  
 
@@ -43,49 +56,10 @@ To load your [JRuby][jruby] environment in a terminal just make a quick export
         bundle install
         rake install
         cd pkg
-        gem i fumoffu-0.0.1.gem --local
-
-
--   **Setup your project files**
-
-    New project install the gem.  
-Then create a new project
-
-      mkdir MyApp
-      cd MyApp
-      fumoffu -i
-
-   Switch the boolean in the rake file to enable the rawr tasks then execute
-
-      rake rawr:get:current-stable-jruby
-
--   **Setup your IDE**
-
-    Currently this step is still in my opinion it is still way too complicated to do.  
-(I personally use Netbeans.)  
-
-    Here is the basic idea of how I setup my development environment.  
-I create 2 Projects:  
-  
-    * A Java Project
-    * A Ruby Project (where I switch the compiler to JRuby and add the root folder to the sources to be 
-    able to access to my Rake tasks using my IDE)  
-  
-_I think will make a video or something regarding the IDE setup, until I script the setup._
+        gem i fumoffu-0.1.0.gem --local
 
 
 * * *
-## Packaging
-
-To package your application first you need to create a jar of all the bundled
-
-
-    bundle install lib/ruby
-    rake pkg:rawr:bundle_jar
-    rake rawr:jar
-    rake rawr:bundle:app
-
-
-Then configure the rake file in config/tasks/package.rake
 
+Tutorial to setup your project are available [here](http://github.com/bouba/fumoffu_example).
 [jruby]: http://jruby.org/download "[JRuby][jruby]"

data/Rakefile

@@ -28,6 +28,8 @@ Jeweler::Tasks.new do |gem|
                         'lib/**/*.sh',
                         'lib/**/Gemfile',
                         'lib/**/Rakefile',
+                        'lib/**/*.erb',
+                        "tasks/*.rake",
                         'bin/*', 
                         '[A-Z]*', 
                         'test/**/*'].to_a
@@ -36,7 +38,6 @@ Jeweler::Tasks.new do |gem|
   #gem.add_runtime_dependency 'log4r', '>= 1.1.9'
   #gem.add_runtime_dependency 'rawr', '>= 1.4.5'
   #gem.add_runtime_dependency 'bundler', '>= 1.0.10'
-  
   gem.add_development_dependency 'shoulda'
 end
 Jeweler::RubygemsDotOrgTasks.new
@@ -45,6 +46,7 @@ require 'rake/testtask'
 Rake::TestTask.new(:test) do |test|
   test.libs << 'lib' << 'test'
   test.pattern = 'test/**/*_test.rb'
+  test.options = "--verbose"
   test.verbose = true
 end
 
@@ -68,4 +70,4 @@ Rake::RDocTask.new do |rdoc|
   rdoc.title = "fumoffu #{version}"
   rdoc.rdoc_files.include('README*')
   rdoc.rdoc_files.include('lib/**/*.rb')
-end
+end

data/VERSION

@@ -1 +1 @@
-0.0.2
+0.1.0

data/bin/fumoffu

@@ -10,27 +10,33 @@ require 'optparse'
 require 'rubygems'
 require 'fumoffu'
 require 'rake'
+
+
 options = {}
+bundle_format = [:jar, :exe, :app]
 
 optparse = OptionParser.new do|opts|
   # Set a banner, displayed at the top
   # of the help screen.
   opts.banner = "Usage: fumoffu [options] dir_name"
 
-  # Define the options, and what they do
-  options[:verbose] = false
-  opts.on( '-v', '--verbose', 'Output more information' ) do
-    options[:verbose] = true
-  end
 
   options[:install] = false
-  opts.on( '-i', '--install', 'Install the skeleton of the fumoffu App' ) do
+  options[:project_dir] = nil
+  opts.on( '-i', '--install [FILE]', 'Install the skeleton of the fumoffu App' ) do |dir|
     options[:install] = true
+    options[:project_dir] = dir
   end
 
-  options[:logfile] = nil
-  opts.on( '-l', '--logfile FILE', 'Write log to FILE' ) do|file|
-    options[:logfile] = file
+  options[:bundle] = nil
+  opts.on("-b", "--bundle [BUNDLE]", bundle_format,
+          "Bundle the application to the chosen format (jar, exe, app)") do |format|
+         options[:bundle] = format
+  end
+
+  options[:dependencies] = false
+  opts.on("-d", "--dependencies", "Download and install the dependencies") do
+    options[:dependencies] = true
   end
 
   # This displays the help screen, all programs are
@@ -43,18 +49,57 @@ end
 
 optparse.parse!
 
-puts "Being verbose" if options[:verbose]
-puts "Being quick" if options[:quick]
-puts "Logging to file #{options[:logfile]}" if options[:logfile]
+def jruby_jar
+  # we check if the jruby jar is in the libs if not we download it
+  if not File.exist? Fumoffu::Application.app_dir+"/interface/lib/jruby-complete.jar" then
+    puts "You do not have JRuby Complete jar file in '#{Fumoffu::Application.app_dir}/interface/lib/jruby-complete.jar'. Please download the JRuby Complete version 1.5.6 at http://www.jruby.org/download"
+  #  puts "We download the last stable version of jruby-complete jar..."
+  #  sh "rake -f #{File.dirname(__FILE__)}/../tasks/rawr_bundle.rake rawr:get:current-stable-jruby"
+  #  sh "mv #{Fumoffu::Application.app_dir}/lib/java/jruby-complete.jar #{Fumoffu::Application.app_dir}/interface/lib"
+  #  sh "rmdir #{Fumoffu::Application.app_dir}/lib/java"
+  #  sh "rmdir #{Fumoffu::Application.app_dir}/lib"
+  end
+end
 
 begin
   if options[:install] then
+    project_dir = "."
+    if not options[:project_dir].nil? then
+      project_dir = options[:project_dir]
+      mkdir_p project_dir
+      Fumoffu::Application.app_dir = project_dir
+    end
+    
     app = Fumoffu::Application.new
     Fumoffu::Generators::Application.generate
     # we add the missing gems
     puts "Installing default packages ..."
-    sh "bundle install"
+    Dir.chdir project_dir do 
+      sh "bundle install --path engine/lib/ruby"
+    end
+    exit
+  end
+  
+  if not options[:bundle].nil? 
+    if bundle_format.include? options[:bundle].to_sym then
+      task = nil
+      jruby_jar
+      if options[:bundle] == :jar
+        task = "rawr:jar"
+      else
+        task = "rawr:bundle:#{options[:bundle]}"
+      end
+      sh "rake -f #{File.dirname(__FILE__)}/../tasks/rawr_bundle.rake #{task}"
+      exit
+    end
   end
+  
+  if options[:dependencies] then
+    jruby_jar
+    exit
+  end
+
+  puts "Invalid command line."
 end
 #
 # Sample to handle argument

data/lib/fumoffu/controller.rb

@@ -9,7 +9,7 @@ module Fumoffu
   
     def extract_controller_name
       name = self.class.to_s
-      name.scan(/^(\w+)Controller$/).first.first.downcase
+      name.scan(/^\w+Controller$/).first.downcase
     end
   end
 end

data/lib/fumoffu/generators/fumoffu_config_generator.rb

@@ -1,16 +1,48 @@
 module Fumoffu
   module Generators
      class Configuration
+       # :call-seq:
+       #    generate()
+       #
+       # Use this to generate the application configuration skeleton
+       #
+       #    Fumoffu::Generators::Configuration.generate
+       #
+       # Generate default configuration files for the engine component of the application
+       # which by default contains 2 parts the file used for the initialization of the application
+       # and also the tasks related the application engine.
+       #
        def self.generate
           source_dir = File.dirname(__FILE__)
-          # We generate the containers
-          mkdir_p "#{Fumoffu::Application.app_dir}/config/tasks", :verbose => false
+          mkdir_p "#{Fumoffu::Application.app_dir}/engine", :verbose => false
+          mkdir_p "#{Fumoffu::Application.app_dir}/engine/config", :verbose => false
+          
+          self.generate_engine
+          mkdir_p "#{Fumoffu::Application.app_dir}/engine/config/tasks", :verbose => false
           
           # We include the default files
-          cp "#{source_dir}/tasks/package.rake", "#{Fumoffu::Application.app_dir}/config/tasks", :verbose => false
-          cp "#{source_dir}/templates/build_configuration.rb", "#{Fumoffu::Application.app_dir}/", :verbose => false
-          cp "#{source_dir}/templates/Gemfile", "#{Fumoffu::Application.app_dir}/", :verbose => false
-          cp "#{source_dir}/templates/Rakefile", "#{Fumoffu::Application.app_dir}/", :verbose => false
+          cp "#{source_dir}/tasks/package.rake",                "#{Fumoffu::Application.app_dir}/engine/config/tasks", :verbose => false
+          cp "#{source_dir}/tasks/generator.rake",              "#{Fumoffu::Application.app_dir}/engine/config/tasks", :verbose => false
+          cp "#{source_dir}/templates/build_configuration.rb",  "#{Fumoffu::Application.app_dir}/", :verbose => false
+          cp "#{source_dir}/templates/Gemfile",                 "#{Fumoffu::Application.app_dir}/", :verbose => false
+          cp "#{source_dir}/templates/Rakefile",                "#{Fumoffu::Application.app_dir}/", :verbose => false
+       end
+       
+       
+       protected
+       
+       def self.generate_engine
+          source_dir = File.dirname(__FILE__)+"/templates"
+          # We generate the containers
+          init_dir = "#{Fumoffu::Application.app_dir}/engine/config/initializers"
+          mkdir_p init_dir, :verbose => false
+
+          # We copy the required files
+          cp "#{source_dir}/engine/config/initializers/app_classes.rb",     init_dir, :verbose => false
+          cp "#{source_dir}/engine/config/initializers/configuration.rb",   init_dir, :verbose => false
+          cp "#{source_dir}/engine/config/initializers/init.rb",            init_dir, :verbose => false
+          cp "#{source_dir}/engine/config/initializers/java_classes.rb",    init_dir, :verbose => false
+          cp "#{source_dir}/engine/config/initializers/ruby_classes.rb",    init_dir, :verbose => false
        end
      end
   end

data/lib/fumoffu/generators/fumoffu_generator.rb

@@ -3,6 +3,7 @@ Dir[File.dirname(__FILE__).concat("/*.rb")].each {|file| require file }
 module Fumoffu
   module Generators
      class Application
+
        def self.generate
          # we generate the configuration
          Configuration.generate
@@ -14,11 +15,12 @@ module Fumoffu
          # We generate the sources from where it is executed
          @dir_structure = [
            "dist",
-           "log",
-           "resources/medias",
+           "engine/log",
+           "engine/resources",
+           "interface/resources/medias",
            "scripts",
-           "test/java",
-           "test/ruby/spec"
+           "interface/test",
+           "engine/test/spec"
            ]
            
          @dir_structure.each do |dir|

data/lib/fumoffu/generators/fumoffu_lib_generator.rb

@@ -2,20 +2,22 @@ module Fumoffu
   module Generators
      class Lib
        def self.generate
-         @@source_dir = File.dirname(__FILE__)
          generate_dirs
          copy_libraries
        end
        
        def self.generate_dirs
          # We generate the containers
-         mkdir_p "#{Fumoffu::Application.app_dir}/lib/java/generated", :verbose => false
-         mkdir_p "#{Fumoffu::Application.app_dir}/lib/ruby", :verbose => false
+         mkdir_p "#{Fumoffu::Application.app_dir}/engine/lib/java/generated", :verbose => false
+         mkdir_p "#{Fumoffu::Application.app_dir}/engine/lib/ruby", :verbose => false
+         mkdir_p "#{Fumoffu::Application.app_dir}/interface/lib", :verbose => false
        end
        
        
        def self.copy_libraries
-         cp_r "#{@@source_dir}/templates/lib/java", "#{Fumoffu::Application.app_dir}/lib/", :verbose => false
+         source_dir = File.dirname(__FILE__)+"/templates"
+         cp   "#{source_dir}/interface/lib/AbsoluteLayout.jar", "#{Fumoffu::Application.app_dir}/interface/lib", :verbose => false
+         cp   "#{source_dir}/interface/lib/SwingLayout.jar",   "#{Fumoffu::Application.app_dir}/interface/lib", :verbose => false
        end
      end
   end

data/lib/fumoffu/generators/fumoffu_src_generator.rb

@@ -3,20 +3,24 @@ module Fumoffu
      class Source
        def self.generate
          @@source_dir = File.dirname(__FILE__)
-         copy_sources
          generate_dirs
+         copy_sources
        end
-       
+
        def self.generate_dirs
          # We generate the containers
-         mkdir_p "#{Fumoffu::Application.app_dir}/src/java", :verbose => false
-         mkdir_p "#{Fumoffu::Application.app_dir}/src/ruby/app/actions/helpers", :verbose => false
-         mkdir_p "#{Fumoffu::Application.app_dir}/src/ruby/app/commons", :verbose => false 
+         mkdir_p "#{Fumoffu::Application.app_dir}/interface/src",       :verbose => false
+         mkdir_p "#{Fumoffu::Application.app_dir}/engine/src",          :verbose => false
+         mkdir_p "#{Fumoffu::Application.app_dir}/engine/test",         :verbose => false
+         mkdir_p "#{Fumoffu::Application.app_dir}/engine/src/commons",  :verbose => false
+         mkdir_p "#{Fumoffu::Application.app_dir}/engine/src/models",   :verbose => false
        end
-       
-       
+
+
        def self.copy_sources
-         cp_r "#{@@source_dir}/templates/src/", "#{Fumoffu::Application.app_dir}/", :verbose => false
+         cp_r "#{@@source_dir}/templates/engine/src/.",     "#{Fumoffu::Application.app_dir}/engine/src",     :verbose => false
+         cp_r "#{@@source_dir}/templates/interface/src/.",  "#{Fumoffu::Application.app_dir}/interface/src",  :verbose => false
+         cp_r "#{@@source_dir}/templates/engine/test/.",    "#{Fumoffu::Application.app_dir}/engine/test",    :verbose => false
        end
      end
   end

data/lib/fumoffu/generators/tasks/generator.rake

@@ -0,0 +1,65 @@
+require 'fumoffu'
+# We assume the the name is written in ruby fashion
+def update_name name, ref_name
+  split_name = name.split "_"
+  # check the controller name
+  if split_name.last != ref_name.downcase then
+    # if it has no controller at the end of the name add it
+    split_name << ref_name.downcase
+  end
+
+  # update the name to class name standard
+  split_name.join("_")
+end
+
+def generate_name type_class, param
+  new_name = param
+  raise "Failed to generate a #{type_class}: a #{type_class} name is mandatory." unless not new_name.nil?
+  update_name new_name, type_class.capitalize
+end
+
+def generate_file name,dir,content
+  # create the file
+  new_controller_file = File.new("#{dir}/#{name}.rb", "w")
+  # add the content
+  new_controller_file.write(content)
+  # close the file
+  new_controller_file.close
+end
+
+namespace :fumoffu do
+  namespace :generate do
+    desc "Generate controller."
+    task :controller, :controller_name do |c,args|
+      name = generate_name "controller",args[:controller_name]
+
+      file_content = "class #{name.split("_").collect{|n|n.capitalize!}.join} < ApplicationController\nend"
+
+      generate_file name, "#{Fumoffu::Application.app_dir}/engine/src/actions/controllers", file_content
+      puts "The new controller #{name} has been generated."
+    end
+
+    desc "Generate handler"
+    task :handler, :handler_name do |h,args|
+      name = generate_name "handler",args[:handler_name]
+
+      file_content = "class #{name.split("_").collect{|n|n.capitalize!}.join} < Fumoffu::Handler\n"
+      file_content<< "    def initialize\n"
+      file_content<< "      super\n"
+      file_content<< "      @controller = SampleActionController.new\n"
+      file_content<< "    end\n\n\n"
+      file_content<< "    def handleAction evt, action, caller\n"
+      file_content<< "      # sample of use\n"
+      file_content<< "      # if action == UIActions::SAMPLE_ACTION then\n"
+      file_content<< "      #     component = component_by_name evt.getSource, \"mainPanel\"\n"
+      file_content<< "      #     label     = component_child_by_name component, \"myLabel\"\n"
+      file_content<< "      # end\"\n"
+      file_content<< "      return false\n"
+      file_content<< "    end\n"
+      file_content<< "end\n"
+
+      generate_file name, "#{Fumoffu::Application.app_dir}/engine/src/actions/handlers", file_content
+      puts "The new handler #{name} has been generated."
+    end
+  end
+end