reactive-dev 0.2.0

data/History

@@ -0,0 +1,3 @@
+=== 0.1.0 / 2008-04-27
+
+* Initial release, note that this is an early alpha version used for proof-of-concept. Everything has a great chance to change! [PHI]

data/LICENSE

@@ -0,0 +1,21 @@
+Copyright (c) 2008-2009 Pascal Hurni
+Copyright (c) 2004-2007 David Heinemeier Hansson
+
+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

@@ -0,0 +1,29 @@
+History
+LICENSE
+Manifest
+README
+Rakefile
+app_generators/reactive/USAGE
+app_generators/reactive/reactive_generator.rb
+app_generators/reactive/templates/README
+app_generators/reactive/templates/Rakefile
+app_generators/reactive/templates/config/boot.rb
+app_generators/reactive/templates/config/config.rb
+app_generators/reactive/templates/config/empty.log
+app_generators/reactive/templates/script/console
+app_generators/reactive/templates/script/destroy
+app_generators/reactive/templates/script/generate
+app_generators/reactive/templates/script/run
+app_generators/reactive/templates/script/win_script.cmd
+bin/reactive
+lib/reactive-dev.rb
+lib/reactive-dev/code_statistics.rb
+lib/reactive-dev/generated_attribute.rb
+lib/reactive-dev/named_base_generator.rb
+lib/reactive-dev/rubigen_plugin_sources.rb
+lib/reactive-dev/source_annotation_extractor.rb
+lib/reactive-dev/tasks/annotations.rake
+lib/reactive-dev/tasks/app.rake
+lib/reactive-dev/tasks/plugin.rb
+lib/reactive-dev/tasks/statistics.rake
+lib/reactive-dev/tasks/testing.rake

data/README

@@ -0,0 +1,130 @@
+== Welcome to Reactive
+
+Please visit www.ruby-reactive.org for further informations.
+
+== Description:
+
+Reactive is a desktop application framework that gives everything
+needed to create database-backed applications according to the
+Model-View-Control pattern of separation.
+
+Reactive is highly inspired and also uses code of Rails, the famous
+Web-Framework for ruby.
+
+In Reactive, the model is handled by what's called an object-relational mapping
+layer. Reactive doesn't impose any ORM, you may choose the one you like but
+Reactive defaults to Active Record. This means it has baked in support for it,
+without forcing you to use it.
+
+The view part is independant of Reactive, this means that the application has
+to choose a view provider and feed it into Reactive. This leads to complete
+freedom for the GUI part. View providers are packaged as gems, so that it is
+easy for the developer to choose and install them. Look for reactive_view_*
+to discover some view providers (at this early alpha stage, only reactive_view_wx
+is available)
+
+The controller is part of Reactive and is loosely coupled to the view. Simple
+convention set up the link.
+
+
+== Getting Started
+
+1. At the command prompt, start a new Reactive application using the <tt>reactive</tt> command
+   and your application name. Ex: reactive myapp -w wx
+2. Change directory into myapp and start the application: <tt>script/run</tt>
+3. Welcome into your new application!
+
+
+== Debugging Reactive
+
+Sometimes your application goes wrong.  Fortunately there are a lot of tools that
+will help you debug it and get it back on the reactive.
+
+First area to check is the application log files.  Have "tail -f" commands running
+on the development.log. Reactive will automatically display debugging
+and runtime information to these files.
+
+You can also log your own messages directly into the log file from your code using
+the Ruby logger class from inside your controllers. Example:
+
+  class WeblogController < ApplicationController
+    def destroy
+      @weblog = Weblog.find(params[:id])
+      @weblog.destroy
+      logger.info("#{Time.now} Destroyed Weblog ID ##{@weblog.id}!")
+    end
+  end
+
+The result will be a message in your log file along the lines of:
+
+  Mon Oct 08 14:22:29 +1000 2007 Destroyed Weblog ID #1
+
+More information on how to use the logger is at http://www.ruby-doc.org/core/
+
+Also, Ruby documentation can be found at http://www.ruby-lang.org/ including:
+
+* The Learning Ruby (Pickaxe) Book: http://www.ruby-doc.org/docs/ProgrammingRuby/
+* Learn to Program: http://pine.fm/LearnToProgram/  (a beginners guide)
+
+These two online (and free) books will bring you up to speed on the Ruby language
+and also on programming in general.
+
+
+== Debugger
+
+
+== Console
+
+
+== Description of Contents
+
+app
+  Holds all the code that's specific to this particular application.
+
+app/controllers
+  Holds controllers that should be named like products_controller.rb.
+  All controllers should descend from ApplicationController
+  which itself descends from Reactive::Controller::Base.
+
+app/models
+  Holds models that should be named like post.rb.
+  Most models will descend from ActiveRecord::Base if you chose this ORM.
+
+app/views
+  Holds the code or template files for the view that should be named like
+  products/index.rb for the ProductsController#index action. The master views are
+  pure Ruby code.
+
+app/helpers
+  Holds view helpers that should be named like products_helper.rb. These are generated
+  for you automatically when using script/generate for views. Helpers can be used to
+  wrap functionality for your views into methods.
+
+assets
+  Contains specific application files, like icons and help files.
+
+config
+  Configuration files for the Reactive environment, the database, and other dependencies.
+
+db
+  Contains the database schema in schema.rb.  db/migrate contains all
+  the sequence of Migrations for your schema.
+
+doc
+  This directory is where your application documentation will be stored when generated
+  using <tt>rake doc:app</tt>
+
+lib
+  Application specific libraries. Basically, any kind of custom code that doesn't
+  belong under controllers, models, or helpers. This directory is in the load path.
+
+script
+  Helper scripts for automation and generation.
+
+test
+  Unit and functional tests along with fixtures. When using the script/generate scripts, template
+  test files will be generated for you and placed in this directory.
+
+gems
+  Alternate gem repository. You may install dependent gems into this directory. This is used for
+  the plugin system. 

data/Rakefile

@@ -0,0 +1,19 @@
+require 'rubygems'
+require 'reactive-core/version'
+
+@spec = Gem::Specification.new do |s|
+  s.name         = "reactive-dev"
+  s.version      = Reactive::VERSION::STRING
+  s.author       = "Pascal Hurni"
+  s.email        = "phi@ruby-reactive.org"
+  s.homepage     = "http://www.ruby-reactive.org"
+  s.summary      = "Reactive - The desktop application framework"
+  s.description  = "Development tools for reactive applications"
+  s.rubyforge_project = "reactive-dev"
+  s.add_dependency 'reactive-core', ">= #{s.version}"
+  s.add_dependency 'rubigen', '>= 1.3.0'
+  s.add_dependency 'rubyforge', '>= 0.4.2'
+  s.add_dependency 'rake', '>= 0.7.0'
+end
+
+require 'reactive-dev/tasks/plugin'

data/app_generators/reactive/USAGE

@@ -0,0 +1,14 @@
+Description:
+    The 'reactive' command creates a new Reactive application with a default
+    directory structure and configuration at the path you specify.
+    You may pass the plugin names you desire for this application
+    Use the -P switch to create a plugin scaffold.
+
+Example:
+    reactive ~/Code/Ruby/mysales reactive-mvc reactive-activerecord reactive-wx
+
+    This generates a skeletical Reactive application in ~/Code/Ruby/mysales
+    with three plugins: reactive-mvc, reactive-activerecord and reactive-wx.
+    By specifying a dispatcher plugin and an output handler plugin, reactive is able
+    to create an initial view and config files accordingely.
+    See the README in the newly created application to get going.

data/app_generators/reactive/reactive_generator.rb

@@ -0,0 +1,137 @@
+class ReactiveGenerator < RubiGen::Base
+  DEFAULT_SHEBANG = File.join(Config::CONFIG['bindir'],
+                              Config::CONFIG['ruby_install_name']) unless defined? DEFAULT_SHEBANG
+
+  default_options :shebang => DEFAULT_SHEBANG
+  
+  attr_reader :app_name
+    
+  def initialize(runtime_args, runtime_options = {})
+    super
+    usage if args.empty?
+    @destination_root = args.shift
+    @root_path = File.expand_path(@destination_root)
+    @app_name = File.basename(@root_path)
+    extract_options
+  end
+
+  def manifest
+    script_options     = { :chmod => 0755, :shebang => options[:shebang] == DEFAULT_SHEBANG ? nil : options[:shebang] }
+
+    record do |m|
+      # Root directory and all subdirectories.
+      m.directory ''
+      BASEDIRS.each { |path| m.directory path }
+      
+      # copy skeleton
+      m.file_copy_each %w( Rakefile README )
+
+      # Configs
+#      m.file_copy_each %w( development.rb production.rb test.rb ), "config/environments"
+      m.file "config/boot.rb", "config/boot.rb"
+      m.template "config/config.rb", "config/config.rb", :assigns => {:plugins => args}
+
+      # Logs
+      %w( production development test ).each { |file|
+        m.file "config/empty.log", "log/#{file}.log", :chmod => 0666
+      }
+      
+      # Scripts
+     %w( console generate destroy run ).each do |file|
+        m.template "script/#{file}", "script/#{file}", script_options
+        m.template "script/win_script.cmd", "script/#{file}.cmd", :assigns => { :filename => file } if windows
+      end
+
+      m.affiliates(:reactive_app, [@destination_root], options)
+    
+    end
+  end
+  
+  def windows
+    (RUBY_PLATFORM =~ /dos|win32|cygwin/i) || (RUBY_PLATFORM =~ /(:?mswin|mingw)/)
+  end
+  
+  protected
+    def banner
+      <<-EOS
+Creates a Reactive application stub.
+
+Usage: #{spec.name} path_to_your_app [options]
+EOS
+    end
+  
+    def add_options!(opts)
+      # opts.separator ''
+      # opts.separator 'Options:'
+      # # For each option below, place the default
+      # # at the top of the file next to "default_options"
+      # opts.on("-r", "--ruby=path", String,
+      #        "Path to the Ruby binary of your choice (otherwise scripts use env, dispatchers current path).",
+      #        "Default: #{DEFAULT_SHEBANG}") { |options[:shebang]| }
+      opts.separator ''
+      opts.separator 'Options:'
+      opts.on("-v", "--version", "Show the #{File.basename($0)} version number and quit.")
+    end
+
+    def parse!(args, runtime_options = {})
+      self.options = {}
+      plugins = args[0..(args.index(args.find {|arg| arg[0..0] == '-'}) || 0)-1]
+      usage if plugins.empty?
+      
+      @destination_root = plugins.shift
+      @root_path = File.expand_path(@destination_root)
+      load_plugins plugins
+      
+      affiliates_options = []
+      @option_parser = OptionParser.new do |opt|
+        opt.banner = banner
+        add_options!(opt)
+        add_general_options!(opt)
+        self.class.sources.collect {|source| source.collect}.flatten.each do |spec|
+          affiliates_options << (affiliate_options = {})
+          capturer_class = Class.new(spec.klass)
+          capturer_class.send(:define_method, :options) { affiliate_options }
+          capturer_class.spec = spec
+          capturer = capturer_class.new([@destination_root], {})
+          spec.klass.instance_method(:add_options!).bind(capturer).call(opt)
+        end
+        opt.parse!(args)
+        affiliates_options.each {|ao| options.merge!(ao)}
+      end
+    
+      return args
+    ensure
+      self.options = full_options(runtime_options)
+    end
+
+    def load_plugins(gems = [])
+      require 'reactive-core/initializer'
+      Reactive::Initializer.run(:configure) do |config|
+        config.root_dir = @root_path
+        # config may already be up to date because a config file may have been generated
+        gems.each {|name| config.gem name}
+      end
+      self.class.use_plugin_sources! :reactive_app
+    end
+
+    def extract_options
+      # for each option, extract it into a local variable (and create an "attr_reader :author" at the top)
+      # Templates can access these value via the attr_reader-generated methods, but not the
+      # raw instance variable value.
+      # @author = options[:author]
+    end
+  
+    # Installation skeleton.  Intermediate directories are automatically
+    # created so don't sweat their absence here.
+    BASEDIRS = %w(
+      assets/default
+      config/environments
+      config/initializers
+      gems/specifications
+      gems/gems
+      log
+      script
+      test/unit
+    )
+
+end

data/app_generators/reactive/templates/README

@@ -0,0 +1,101 @@
+== Welcome to Reactive
+
+Please visit www.ruby-reactive.org for further informations.
+
+== Description:
+
+Reactive is a desktop application framework that gives everything
+needed to create database-backed applications according to the
+Model-View-Control pattern of separation.
+
+Reactive is highly inspired and also uses code of Rails, the famous
+Web-Framework for ruby.
+
+Every layer in Reactive is pluggable. So you have to create your stack by
+choosing plugins.
+
+The first layer you want is a dispatcher, which will dispatch the requests
+(also comming from the user).
+You may use reactive-mvc. It supplies a complete MVC architecture ala Rails.
+
+The second layer is an output handler. It will interpret the output generated
+by a request (which itself is generated by the dispatcher plugin).
+You may use reactive-wx. It executes ruby code for the wxRuby GUI toolkit.
+
+There's no third layer! But while reading reactive-mvc documentation, you will
+find that it doesn't impose a specific ORM. You have to choose one. Currently
+there's reactive-activerecord which as its name suggests, handles ActiveRecord.
+
+== Getting Started
+
+1. At the command prompt, start a new Reactive application using the <tt>reactive</tt> command
+   and your application name. Ex: reactive myapp
+2. Change directory into myapp and start the application: <tt>script/run</tt>
+3. Welcome into your new application!
+
+Generally you want some plugins to take part of the app, specify them directly on the command line:
+  reactive myapp reactive-mvc reactive-activerecord reactive-wx
+
+== Debugging Reactive
+
+Sometimes your application goes wrong.  Fortunately there are a lot of tools that
+will help you debug it and get it back on the reactive.
+
+First area to check is the application log files.  Have "tail -f" commands running
+on the development.log. Reactive will automatically display debugging
+and runtime information to these files.
+
+You can also log your own messages directly into the log file from your code using
+the Ruby logger class from inside your controllers. Example:
+
+  class ProductController < ApplicationController
+    def destroy
+      @product = Product.find(params[:id])
+      @product.destroy
+      logger.info("#{Time.now} Destroyed Product ID ##{@product.id}!")
+    end
+  end
+
+The result will be a message in your log file along the lines of:
+
+  Mon Oct 08 14:22:29 +1000 2007 Destroyed Product ID #1
+
+More information on how to use the logger is at http://www.ruby-doc.org/core/
+
+Also, Ruby documentation can be found at http://www.ruby-lang.org/ including:
+
+* The Learning Ruby (Pickaxe) Book: http://www.ruby-doc.org/docs/ProgrammingRuby/
+* Learn to Program: http://pine.fm/LearnToProgram/  (a beginners guide)
+
+These two online (and free) books will bring you up to speed on the Ruby language
+and also on programming in general.
+
+== Debugger
+
+
+== Console
+
+
+== Description of Contents
+
+Without a specific dispatcher plugin, the directory layout of a Reactive application looks like this:
+
+assets
+  Contains specific application files, like icons and help files.
+
+config
+  Configuration files for the Reactive environment, the database, and other dependencies.
+
+script
+  Helper scripts for automation and generation.
+
+test
+  Unit and functional tests along with fixtures. When using the script/generate scripts, template
+  test files will be generated for you and placed in this directory.
+
+gems
+  Alternate gem repository. You may install dependent gems into this directory. This is used for
+  the plugin system. 
+  
+log
+  Contains runtime logfiles.