flex_scaffold 0.1.0

data/CHANGELOG

@@ -0,0 +1,4 @@
+
+0.1.0 ==========
+
+* Initial release 03/04/2007

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2007 toddb
+
+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/README

@@ -0,0 +1,169 @@
+=FlexScaffold
+
+
+Flex Scaffold should allow you to swap in and out different view layers on your REST controller.
+For example, to use the model <tt>contact</tt>, use <tt>flex_scaffold: contact</tt>
+
+  class ContactsController < ApplicationController
+  
+	layout 'flex_scaffold'
+    flex_scaffold :contact               (optional - :size => '800x600')
+
+    # The following line can be used instead of the generated definitions
+    # of index, show, new, edit, update, destroy. There is also the action
+    # schema to look at the data model
+    ...
+  end
+
+Other files that are created:
+
+  /app/flex/contacts/_list.mxml
+  /app/flex/contacts/_contacts.mxml         <-- these are compiled to a swf file
+
+  /public/swfs/flex_scaffold/_contacts.swf  <-- created via rake flex:app mxml=contacts
+  
+  /app/views/layout/flex_scaffold.rhtml     <-- templated pages
+  /app/views/flex_scaffold/index.rhtml      <-- loads up the swf
+    
+==USAGE
+
+===Summary
+
+To generate a scaffold for the model <tt>message</tt> with fields <tt>title</tt> and <tt>body</tt>:
+
+  > ruby script/generate flex_scaffold_resource message title:string body:string
+  > rake db:migrate
+  > ruby script/generate flex_scaffold message
+  > rake flex:app mxml=messages
+  > ruby script/server start
+  
+===1. Install a REST service from flex_scaffold_resource
+
+Create an Active Resource (REST service)
+
+  > ruby script/generate flex_scaffold_resource message title:string body:string
+
+This simple command will generate a lot of stuff, in detail:
+
+* A controller with REST actions and an action for getting the schema
+* A model named message
+* A migration named xxx_create_messages
+* Fixture and unit tests for the model and the controller
+* A line in your <tt>config/routes.rb</tt> file <tt>map.resources :messages</tt>
+
+    
+Alternatively, you can add scaffolding to any REST resources by adding to any controller:
+
+  flex_scaffold :message
+
+Note: You can then delete or extend all the other REST actions as they are implicitly scaffolded
+
+===2. Migrate the database
+
+  > db:migrate
+
+This updates the database ready for the scaffold to pick up the columns.
+
+===3. Create the scaffolds
+
+  > ruby script/generate flex_scaffold message
+  
+This will generate:
+
+* A scaffold view for the controller which loads the swf
+* A template layout for the controller
+* Scaffolded mxml files (in <tt>app/flex</tt>)
+
+===4. Compile the scaffolds
+
+  > rake flex:app mxml=messages
+  
+This will generate:
+
+* copy assets into the <tt>/app/flex/<model></tt> folder ready for compilation (see below)
+* compile the swf files based on the configuration in the related controller to <tt>/app/flex/<model></tt>
+* save the resulting swf in <tt>/public/swfs/flex_scaffold</tt>
+* ensure that all needed public assets are copied to <tt>/public/</tt> [stylesheets, javascript] (also see Restart server below)
+
+This +Rake+ task infact copies the necessary assets into the build folder </tt>/app/flex</tt> and then remove when finished. To avoid you compile only. This would involved steps either side for use:
+
+ > rake flex:build:install mxml=contacts  [move the assets into the build structure]
+ > rake flex:compile mxml=contacts        [repeat this as many times as needed]
+ 
+Optionally you may wish to clean up: 
+ > rake flex:build:clobber mxml=contacts
+ 
+ Note: There is currently no way to build multiple scaffolds at one time.
+
+===5. (Re)Start server?
+
+Just check this. You should only need to restart the start to init the plugin. This will also copy the correct files to public which is equivalent to the +Rake+ task: <tt>rake flex:public:install</tt> 
+
+ 
+==General Design Notes:
+
+Key features:
+ 
+* Easily scaffold
+* Be able to manually compile
+* Getting model validation generated out to the client (still working out on full validation conversion)
+
+To do:
+
+* Be able to cutomise views
+* Automatic (re)complilation
+* Perhaps, auto install <tt>flex_sdk2</tt> (this will probably break license - but could have local repository/or checked into a library)
+
+Long run:
+ 
+I suspect that there will need to split out flex_scaffold and ActionView::Helpers::FlexObjectHelper. I would hope
+that flex have an equivalent set of helpers as javascript.
+ 
+===Phase I (complete)
+* tie in REST (resource) generation for flex_scaffold
+* scaffold model for flex viewing (flex_scaffold)
+* generate mxml files for model
+* compile swf
+* transfer swf to public folder
+* load page which points flash file (use JavascriptHelper in openLaszlo)
+* add CRUD actions on controller
+* add return schema onto controller
+ 
+===Phase II
+* remove js, styles, etc as generator and put as rake command at startup
+* add the view layer as the plugin rather than generator
+* duplicate model validation (at compile time) into client (as well as server)
+* autocompilation (generator knows whether there were changes)
+
+===Phase III
+* configurable scaffold see ajax_scaffold [http://ajaxscaffold.stikipad.com/doc/show/4.0+Design+Docs]
+
+	flex_scaffold :task do 
+	    table :only => [ :name, :role ]
+	    form :except => [ :created_at, :updated_at ]
+	    columns do 
+	      name do
+	        sort("name.downcase")
+	        is_required
+	      end
+	    end
+	end
+	  
+
+* template the flex code created in generator using helpers (develop ActiveView::Helpers::FlexHelper)
+* that is use, rhtml to embed flex within pages (scaffold as a plugin) [unsure whether this will work and/or is desirable]
+ 
+===Phase IV
+* multiple models on a page
+
+==Credits
+
+Released under the MIT license (included)
+
+* toddb --- Flex Scaffold plugin
+
+The initial code was inspired by (or lifted from)
+* <tt>flex_engenial_scaffold:</tt> This is the basis for the CRUD look and feel and early code basis
+* <tt>flexible_rails:</tt> I have used his section from FlexibleRails for using REST services
+* <tt>ajax_scaffold:</tt> basically reproduced their tables and hook code
+* <tt>laszlo-plugin:</tt> this separates out the generators well and has a good javascript helper

data/Rakefile

@@ -0,0 +1,116 @@
+require 'rake'
+require 'rake/testtask'
+require 'rake/rdoctask'
+require 'rake/packagetask'
+require 'rake/gempackagetask'
+require 'rake/contrib/rubyforgepublisher'
+
+PKG_NAME = "flex_scaffold"
+PKG_VERSION = '0.1.0'
+RUBYFORGE_PROJECT = 'flexible-rails'
+RUBYFORGE_USER = ENV['RUBYFORGE_USER']
+
+desc 'Default: run unit tests.'
+task :default => :test
+
+desc 'Test the flex_scaffold plugin.'
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = true
+end
+
+# Generate packages ------------------------------------------------------------------
+
+Rake::PackageTask.new(PKG_NAME, PKG_VERSION) do |p|
+  p.need_tar = true
+  p.need_zip = true
+  p.package_files.include("./**/*")
+  p.package_files.exclude 'pkg', 'rdoc'
+  p.package_files.exclude 'notes.txt', '#*'
+end
+
+# Tag SVN for releases ------------------------------------------------------------------
+
+task :tag_svn do
+  url = `svn info`[/^URL:\s*(.*\/)trunk/, 1]
+  tag_message = "-m \"tag release #{PKG_VERSION}\""
+  system("svn cp #{tag_message} #{url}/trunk #{url}/tags/REL-#{PKG_VERSION.gsub(/\./,'_')}")
+  system("svn cp #{tag_message} #{url}/trunk #{url}/rails/plugins/flex_scaffold")
+end
+
+# Generate documentation ------------------------------------------------------------------
+
+desc 'Generate documentation for the flex_scaffold plugin.'
+Rake::RDocTask.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'Flexible Scaffolding for Rails -- Embedding Flex in Rails through REST'
+  rdoc.main     = 'README'
+  rdoc.options << '--line-numbers' << '--inline-source'
+  rdoc.rdoc_files.include('README', 'TODO', 'MIT-LICENSE', 'CHANGELOG')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+# Generate GEM ----------------------------------------------------------------------------
+
+PKG_FILES = FileList[
+  '[a-zA-Z]*',
+  'tasks/**/*',
+  'public/**/*', 
+  'generators/**/*', 
+  'lib/**/*'
+] - [ 'test' ]
+
+spec = Gem::Specification.new do |s|
+  s.name = 'flex_scaffold'
+  s.version = PKG_VERSION
+  s.summary = "Plugin for scaffolding a Flex view within Rails on REST services."
+  s.description = <<-EOF
+    Flexible Rails Scaffolding is a plugin to scaffold REST controllers and a flex view for models. Use generators 
+    to create the code and rake to compile. Flexible Rails generates .mxml and .as code so that it can be edited 
+    by both Rails and Flex coders. 
+  EOF
+
+  s.add_dependency('rake', '>= 0.7.2')
+  s.add_dependency('rails','>= 1.2.0')
+
+  s.rdoc_options << '--exclude' << '.'
+  s.has_rdoc = false
+
+  s.files = PKG_FILES.to_a.delete_if {|f| f.include?('.svn')}
+  s.require_path = 'lib'
+
+  s.author = "toddb"
+  s.email = "todd@8wireunlimited.com"
+  s.homepage = "http://flexible-rails.rubyforge.org"
+  s.rubyforge_project = "flexible-rails"
+end
+
+Rake::GemPackageTask.new(spec) do |pkg|
+  pkg.gem_spec = spec
+end
+
+
+# Publishing -------------------------------------------------------
+#desc "Publish the API documentation"
+#task :pgem => [:gem] do 
+#  Rake::SshFilePublisher.new("davidhh@wrath.rubyonrails.org", "public_html/gems/gems", "pkg", "#{PKG_FILE_NAME}.gem").upload
+#  `ssh davidhh@wrath.rubyonrails.org './gemupdate.sh'`
+#end
+
+desc "Publish the API documentation"
+task :publish_rdoc => [:rdoc] do
+  program = (RUBY_PLATFORM =~ /mswin32/) ? "winscp3" : "scp"
+  system("#{program} -r rdoc/* #{RUBYFORGE_USER}@rubyforge.org:/var/www/gforge-projects/#{RUBYFORGE_PROJECT}")
+end
+
+desc "Publish the release files to RubyForge."
+task :release => [ :package ] do
+  require 'rubyforge'
+
+  packages = %w( gem tgz zip ).collect{ |ext| "pkg/#{PKG_NAME}-#{PKG_VERSION}.#{ext}" }
+
+  rubyforge = RubyForge.new
+  rubyforge.login
+  rubyforge.add_release(RUBYFORGE_PROJECT, PKG_NAME, "REL #{PKG_VERSION}", *packages)
+end

data/TODO

@@ -0,0 +1,23 @@
+= Flexible Rails -- To Do List
+
+== Fixes
+* Sizing on pages at 100% height is dodgy because it needs it is based on the parent element - if this is body it is not implicitly sized (see http://www.webmasterworld.com/forum83/200.htm) 
+* Update is slightly broken
+
+== Better understanding
+* Flex use of CSS (personally I'm finding it limited) for themes
+
+== New features
+* Warn when needs recompilation
+* Automatic recompilation
+* themes
+* Ensure app/flex/ can be used in conjunction with FlexBuilder
+
+==Refactoring
+* The generator code is ugly
+* Separate out the functions in the mxml code
+
+==Limitations
+* Extend validation conversions
+* No test suite
+* Remove the hooks into the validation on the ActiveRecord (see lib\validations.rb)

data/generators/flex_scaffold/USAGE

@@ -0,0 +1,16 @@
+Description:
+    The flex_scaffold generator creates a Flex application mxml source file and
+    a view that displays it.  The model and controller must alrady exist: user script/generate
+    flex_scaffold_resource.
+
+    The generator takes a model name (singular) as its first argument.
+    
+Example:
+    ./script/generate flex_scaffold contact
+
+    This will create:
+        app/flex/contacts/contacts.mxml
+        app/flex/contacts/_list.mxml
+        app/views/contacts/index.rhtml
+        app/views/layouts/contacts.rhtml
+