reactive 0.1.0

data/History.txt

@@ -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/MIT-LICENSE

@@ -0,0 +1,21 @@
+Copyright (c) 2008 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.txt

@@ -0,0 +1,60 @@
+History.txt
+MIT-LICENSE
+Manifest.txt
+README.txt
+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/app/controllers/application_controller.rb
+app_generators/reactive/templates/app/helpers/application_helper.rb
+app_generators/reactive/templates/config/boot.rb
+app_generators/reactive/templates/config/databases/frontbase.yml
+app_generators/reactive/templates/config/databases/mysql.yml
+app_generators/reactive/templates/config/databases/oracle.yml
+app_generators/reactive/templates/config/databases/postgresql.yml
+app_generators/reactive/templates/config/databases/sqlite2.yml
+app_generators/reactive/templates/config/databases/sqlite3.yml
+app_generators/reactive/templates/config/empty.log
+app_generators/reactive/templates/config/environment.rb
+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/code_statistics.rb
+lib/controller.rb
+lib/controller/base.rb
+lib/controller/filters.rb
+lib/controller/flash.rb
+lib/controller/helpers.rb
+lib/controller/layout.rb
+lib/dispatcher.rb
+lib/generated_attribute.rb
+lib/initializer.rb
+lib/named_base_generator.rb
+lib/reactive.rb
+lib/request.rb
+lib/source_annotation_extractor.rb
+lib/tasks/annotations.rake
+lib/tasks/databases.rake
+lib/tasks/log.rake
+lib/tasks/misc.rake
+lib/tasks/reactive.rb
+lib/tasks/statistics.rake
+lib/tasks/testing.rake
+lib/version.rb
+lib/view.rb
+lib/view/base.rb
+reactive_generators/model/USAGE
+reactive_generators/model/model_generator.rb
+reactive_generators/model/templates/fixtures.yml
+reactive_generators/model/templates/migration.rb
+reactive_generators/model/templates/model.rb
+reactive_generators/model/templates/unit_test.rb
+reactive_generators/scaffold/USAGE
+reactive_generators/scaffold/scaffold_generator.rb
+reactive_generators/scaffold/templates/controller.rb
+reactive_generators/scaffold/templates/functional_test.rb
+reactive_generators/scaffold/templates/helper.rb

data/README.txt

@@ -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,14 @@
+# -*- ruby -*-
+
+require 'rubygems'
+require 'hoe'
+require './lib/version.rb'
+
+Hoe.new('reactive', Reactive::VERSION::STRING) do |p|
+  p.developer('Pascal Hurni', 'phi@ruby-reactive.org')  
+  p.url = 'www.ruby-reactive.org'
+  p.extra_deps << ['activesupport', '>= 1.4.0']
+  p.extra_deps << ['rubigen', '>= 1.0.0']
+end
+
+# vim: syntax=Ruby

data/app_generators/reactive/USAGE

@@ -0,0 +1,11 @@
+Description:
+    The 'reactive' command creates a new Reactive application with a default
+    directory structure and configuration at the path you specify.
+    Used without arguments and within an application path, it starts the app.
+
+Example:
+    reactive ~/Code/Ruby/mysales -w wx
+
+    This generates a skeletal Reactive application in ~/Code/Ruby/mysales
+    with wx as the view provider.
+    See the README in the newly created application to get going.

data/app_generators/reactive/reactive_generator.rb

@@ -0,0 +1,160 @@
+class ReactiveGenerator < RubiGen::Base
+  DEFAULT_SHEBANG = File.join(Config::CONFIG['bindir'],
+                              Config::CONFIG['ruby_install_name']) unless defined? DEFAULT_SHEBANG
+  
+
+  DATABASES = %w(mysql oracle postgresql sqlite2 sqlite3 frontbase none)
+
+  default_options :shebang => DEFAULT_SHEBANG, :database => (ENV["REACTIVE_DEFAULT_DATABASE"] || "mysql"), :view_provider => ENV["REACTIVE_DEFAULT_VIEW_PROVIDER"]
+  
+  attr_reader :app_name, :database, :view_provider
+    
+  def initialize(runtime_args, runtime_options = {})
+    super
+    usage if args.empty?
+    usage("Sorry, ActiveRecord is not available, can't configure for: #{options[:database] || default_options[:database]}") if options[:database].to_s.downcase != 'none' && !has_activerecord?
+    usage("Databases supported for preconfiguration are: #{DATABASES.join(", ")}\nYou may also disable ActiveRecord by passing: none") if (options[:database] && !DATABASES.include?(options[:database]))
+    @destination_root = args.shift
+    @app_name = File.basename(File.expand_path(@destination_root))
+    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 )
+      m.file_copy_each %w( application_controller.rb ), "app/controllers"
+      m.file_copy_each %w( application_helper.rb ), "app/helpers"
+      #m.file_copy_each %w( development.rb production.rb test.rb ), "config/environments"
+
+      # Configs
+      m.file "config/boot.rb", "config/boot.rb"
+      m.template "config/environment.rb", "config/environment.rb"
+      m.template "config/databases/#{@database}.yml", "config/database.yml", :assigns => {
+        :app_name => @app_name,
+        :socket   => @database == "mysql" ? mysql_socket_location : nil
+      } if @database
+
+      # Logs
+      %w( production development test ).each { |file|
+        m.file "config/empty.log", "log/#{file}.log", :chmod => 0666
+      }
+      
+      # Scripts
+      m.directory "script"
+
+      %w( 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
+    
+      # View
+      if view_provider
+        view_provider_fullname = "reactive_view_#{view_provider}"
+        require view_provider_fullname
+        view_provider_path = Gem.loaded_specs[view_provider_fullname].full_gem_path
+        self.class.append_sources(RubiGen::PathFilteredSource.new(:RubyGems, view_provider_path, :reactive))
+        m.dependency "application_view", [@destination_root, @app_name], :shebang => options[:shebang], :collision => :force
+      end
+    end
+  end
+  
+  def windows
+    (RUBY_PLATFORM =~ /dos|win32|cygwin/i) || (RUBY_PLATFORM =~ /(:?mswin|mingw)/)
+  end
+
+  def has_activerecord?
+    require 'activerecord'
+    true
+  rescue LoadError
+    false
+  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.")
+      
+      opts.on("-w", "--view=name", String,
+            "Specify the view provider.",
+            "Defaults to the env variable REACTIVE_DEFAULT_VIEW_PROVIDER") { |v| options[:view_provider] = v }
+      opts.on("-d", "--database=name", String,
+            "Preconfigure for selected database (options: mysql/oracle/postgresql/sqlite2/sqlite3).", "Pass none to disable ActiveRecord.",
+            "Default: mysql (or the env variable REACTIVE_DEFAULT_DATABASE)") { |v| options[:database] = v }
+    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]
+      @view_provider = options[:view_provider] || default_options[:view_provider]
+      
+      until @view_provider
+        puts "You didn't chose a view provider, it doesn't prevent you from generating an application, but it will not run until you manually add one in the environment.rb file."
+        print "Continue anyway? [Yn] "
+        answer = gets
+        break if answer =~ /^y/i
+        exit if answer =~ /^n/i
+      end
+      
+      @database = options[:database] || default_options[:database]
+      @database = nil if @database.downcase == 'none'
+    end
+  
+    def mysql_socket_location
+      MYSQL_SOCKET_LOCATIONS.find { |f| File.exist?(f) } unless RUBY_PLATFORM =~ /(:?mswin|mingw)/
+    end
+
+    # Installation skeleton.  Intermediate directories are automatically
+    # created so don't sweat their absence here.
+    BASEDIRS = %w(
+      app/controllers
+      app/models
+      app/helpers
+      app/views
+      config/environments
+      config/initializers
+      lib
+      log
+      script
+      test/unit
+      gems
+      assets
+    )
+
+  MYSQL_SOCKET_LOCATIONS = [
+    "/tmp/mysql.sock",                        # default
+    "/var/run/mysqld/mysqld.sock",            # debian/gentoo
+    "/var/tmp/mysql.sock",                    # freebsd
+    "/var/lib/mysql/mysql.sock",              # fedora
+    "/opt/local/lib/mysql/mysql.sock",        # fedora
+    "/opt/local/var/run/mysqld/mysqld.sock",  # mac + darwinports + mysql
+    "/opt/local/var/run/mysql4/mysqld.sock",  # mac + darwinports + mysql4
+    "/opt/local/var/run/mysql5/mysqld.sock",  # mac + darwinports + mysql5
+    "/opt/lampp/var/mysql/mysql.sock"         # xampp for linux
+  ]
+
+end

data/app_generators/reactive/templates/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.