depo 0.0.1

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2010 [name of plugin creator]
+
+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.rdoc

@@ -0,0 +1,71 @@
+= Depo (Dojo On Rails)
+
+Is attempt to automate many tasks and practices in building RIA using Dojo and Rails.
+
+== Installation
+
+1. sudo gem install depo  
+   or in config/environment.rb:
+      ...
+      config.gem 'depo'
+      ...
+   >> sudo rake gems:install
+1. rake dojo:install
+
+
+== FEATURES ABSTRACT:
+
+* Some conventions and practices about Dojo-Rails project structure and management
+* Automate dojo installation and update 
+* Automate builds
+* Generators for custom widgets (DijitGenerator) and one page applications 
+* ActionView Helper
+
+== SAMPLE CONFIGURATION:
+  Depo.configure {
+    author 'niquola'
+    themes ['basic']
+    default_theme 'basic'
+    dojo_version '1.4.1'
+    base_webpath '/myapplication'
+
+    build_options {
+      cssOptimize 'comments.keepLines'
+      optimize 'shrinksafe.keepLines'
+      cssImportIgnore '../dijit.css'
+      internStrings 'true'
+    }
+
+    build_profile {
+      libs<< 'app'
+
+      pages<< "app.pages.dashboard"
+      pages<< "app.pages.admin"
+    }
+  }
+
+
+== LICENSE:
+
+(The MIT License)
+
+Copyright (c) 2010 niquola
+
+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/Rakefile

@@ -0,0 +1,50 @@
+require 'rubygems'
+require 'rake'
+require 'rake/testtask'
+require 'rake/rdoctask'
+require 'rake/gempackagetask'
+
+desc 'Default: run unit tests.'
+task :default => :test
+
+desc 'Test the dojo_on_rails plugin.'
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.libs << 'test'
+  #t.pattern = 'test/*_test.rb'
+  t.test_files = FileList['test/*_test.rb']
+  t.verbose = true
+end
+
+desc 'Generate documentation for the dojo_on_rails plugin.'
+Rake::RDocTask.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'depo'
+  rdoc.options << '--line-numbers' << '--inline-source'
+  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+PKG_FILES = FileList[ '[a-zA-Z]*', 'generators/**/*', 'lib/**/*', 'rails/**/*', 'tasks/**/*', 'test/**/*' ]
+
+spec = Gem::Specification.new do |s|
+  s.name = "depo"
+  s.version = "0.0.1"
+  s.author = "niquola, smecsia"
+  s.email = "niquola@gmail.com"
+  #s.homepage = ""
+  s.platform = Gem::Platform::RUBY
+  s.summary = "Rails & Dojo integration"
+  s.add_dependency('dojo_src')
+  s.add_dependency('rails', '>= 2.3.5')
+  s.add_dependency('kung_figure', '0.0.2')
+  s.files = PKG_FILES.to_a 
+  s.require_path = "lib"
+  s.has_rdoc = false
+  s.extra_rdoc_files = ["README.rdoc"]
+end
+
+desc 'Turn this plugin into a gem.'
+Rake::GemPackageTask.new(spec) do |pkg|
+  pkg.gem_spec = spec
+end

data/generators/depo_config/USAGE

@@ -0,0 +1,5 @@
+Description:
+  Generate depo config
+
+Modules Example:
+    `./script/generate depo_config 

data/generators/depo_config/depo_config_generator.rb

@@ -0,0 +1,8 @@
+class DepoConfigGenerator < Rails::Generator::Base
+  def manifest
+    record do |m|
+      m.directory  File.join('config')
+      m.template "depo.rb", File.join('config','depo.rb')
+    end
+  end
+end

data/generators/depo_config/templates/depo.rb

@@ -0,0 +1,9 @@
+Depo.configure do
+  root 'public'
+  author 'yorname'
+  generators do
+    head_of_test_page <<-HTML
+     <!-- some code to title of test page -->
+    HTML
+  end
+end

data/generators/dijit/dijit_generator.rb

@@ -0,0 +1,34 @@
+class DijitGenerator < Rails::Generator::Base
+  attr :dijit
+
+  def extract_opts!(args)
+    @dijit_full_name = args.shift
+    @dijit=Depo::DijitConventions.new(@dijit_full_name)
+  end
+
+  def assigns
+   @assigns ||= {:assigns=>dijit.to_hash.merge(:config=>Depo.config)}
+  end
+
+  def test?
+    true
+  end
+
+  def style?
+    true
+  end
+
+  def manifest
+    record do |m|
+      extract_opts!(args)
+      m.directory dijit.package_path
+      m.directory dijit.style_dir_path
+      m.directory dijit.test_dir_path
+
+      m.template "class.js", dijit.class_path, assigns
+      m.template "test.js", dijit.test_code_path,assigns if test?
+      m.template "test.html", dijit.test_page_path,assigns if test?
+      m.template "style.css", dijit.style_path,assigns if style?
+    end
+  end
+end

data/generators/dijit/templates/class.js

@@ -0,0 +1,30 @@
+/**
+ * <%= dijit_full_name %>
+ * Created by <%= config.author %> 
+ **/
+dojo.provide("<%= dijit_full_name %>");
+<% if dijit_base_class != 'null' %> 
+dojo.require("<%= dijit_base_class %>"); 
+<% end %>
+(function () {
+	//here go private vars and functions
+	dojo.declare("<%= dijit_full_name %>",<%= dijit_base_class %>, {
+		// summary:
+		//  HERE WIDGET SUMMARY 
+    
+		// baseClass: [protected] String
+		baseClass: "<%= dijit_style_class_name %>",
+    //templateString: dojo.cache("<%= dijit_package_name %>", "templates/<%= dijit_class_name %>.html"),
+    //widgetsInTemplate: true,
+		//buildRendering: function () {
+			//this.inherited(arguments);
+		//},
+		//layout: function () {
+			//var cb = this._contentBox;
+      //dojo.marginBox(this.containerNode, cb);
+		//},
+		//postCreate: function () {
+			//this.inherited(arguments);
+		//}
+  });
+});

data/generators/dijit/templates/style.css

@@ -0,0 +1,4 @@
+.<%= dijit_style_class_name %> { 
+}
+.<%= dijit_style_class_name %>Container { 
+}

data/generators/dijit/templates/test.html

@@ -0,0 +1,15 @@
+<?xml version='1.0' encoding='utf-8' ?>
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+<html>
+  <head>
+    <title><%= dijit_full_name %></title>
+
+    <script type="text/javascript" src="/ria/src/dojo/dojo.js" djConfig="isDebug:false,parseOnLoad:true"> </script>
+    <script src="<%= dijit_class_name %>.js"></script>
+    <%= config.generators.head_of_test_page %>
+    <link rel="stylesheet" href="/<%= style_path %>" type="text/css" />
+  </head>
+  <body class="app">
+  </body>
+</html>
+

data/generators/dijit/templates/test.js

@@ -0,0 +1,11 @@
+dojo.require("doh.runner");
+//dojo.require("dojo.robot");
+dojo.require("<%= dijit_full_name %>");
+
+dojo.addOnLoad(function () {
+	doh.register("<%= dijit_full_name %>", [
+	function test(t) {
+    t.t(false,"not implemented");
+	}]);
+	doh.run();
+});

data/generators/dpage/USAGE

@@ -0,0 +1,33 @@
+Description:
+    Stubs out a new controller,its views and page.js with page.css. Pass the controller name, either
+    CamelCased or under_scored, and a list of views as arguments. The name of js will be action name.
+
+
+    TODO update documentation
+
+    To create a controller within a module, specify the controller name as a
+    path like 'parent_module/controller_name'.
+
+    This generates a controller class in app/controllers, view templates in
+    app/views/controller_name, a helper class in app/helpers, a functional
+    test suite in test/functional and a helper test suite in test/unit/helpers.
+
+Example:
+    `./script/generate controller CreditCard open debit credit close`
+
+    Credit card controller with URLs like /credit_card/debit.
+        Controller:      app/controllers/credit_card_controller.rb
+        Functional Test: test/functional/credit_card_controller_test.rb
+        Views:           app/views/credit_card/debit.html.erb [...]
+        Helper:          app/helpers/credit_card_helper.rb
+        Helper Test:     test/unit/helpers/credit_card_helper_test.rb
+
+Modules Example:
+    `./script/generate controller 'admin/credit_card' suspend late_fee`
+
+    Credit card admin controller with URLs /admin/credit_card/suspend.
+        Controller:      app/controllers/admin/credit_card_controller.rb
+        Functional Test: test/functional/admin/credit_card_controller_test.rb
+        Views:           app/views/admin/credit_card/debit.html.erb [...]
+        Helper:          app/helpers/admin/credit_card_helper.rb
+        Helper Test:     test/unit/helpers/admin/credit_card_helper_test.rb

data/generators/dpage/dpage_generator.rb

@@ -0,0 +1,39 @@
+class DpageGenerator < Rails::Generator::NamedBase
+  def manifest
+    record do |m|
+      # Check for class naming collisions.
+      m.class_collisions "#{class_name}Controller", "#{class_name}ControllerTest", "#{class_name}Helper", "#{class_name}HelperTest"
+
+      action = actions[0]
+      page=Depo::DijitConventions.new("#{Depo.config.default_page_lib}.#{action}")
+      
+      # Controller, helper, views, and test directories.
+      m.directory File.join('app/controllers', class_path)
+      m.directory File.join('app/helpers', class_path)
+      m.directory File.join('app/views', class_path, file_name)
+      m.directory File.join('test/unit/helpers', class_path)
+      m.directory page.package_path
+
+      # Controller class, functional test, and helper class.
+      m.template 'controller.rb',
+        File.join('app/controllers',
+                  class_path,
+                            "#{file_name}_controller.rb")
+
+      m.template 'helper.rb',
+        File.join('app/helpers',
+                  class_path,
+                            "#{file_name}_helper.rb")
+
+      m.template 'helper_test.rb',
+        File.join('test/unit/helpers',
+                  class_path,
+                            "#{file_name}_helper_test.rb")
+
+      path = File.join('app/views', class_path, file_name, "#{action}.haml")
+      m.template 'view.haml', path, :assigns => { :action => action, :path => path }
+
+      m.template 'dpage.js', page.class_path, :assigns => { :page_name=> page.dijit_full_name }
+    end
+  end
+end

data/generators/dpage/templates/app/controllers.js

@@ -0,0 +1,12 @@
+(function() {
+	var controllers = dojo.provide('<%= app_name%>.controllers');
+	//published actions 
+	controllers.actions = {
+		startup: function() {},
+		exit: function() {}
+	};
+	//views topics two level hash
+	controllers.views = {};
+	//models topics three level hash
+	controllers.models = {};
+})();

data/generators/dpage/templates/app/models.js

@@ -0,0 +1,5 @@
+(function() {
+	//dojo.require('kley.rails.Store');
+	var models = dojo.provide('<%= app_name %>.models');
+	//models.myModel = new kley.rails.Store('patients');
+})();

data/generators/dpage/templates/app/views.js

@@ -0,0 +1,4 @@
+(function() {
+	var views = dojo.provide('<%= app_name %>.views');
+	views.jsIdFromTemplate = function(view) {};
+})();

data/generators/dpage/templates/controller.rb

@@ -0,0 +1,8 @@
+class <%= class_name %>Controller < ApplicationController
+<% for action in actions -%>
+  def <%= action %>
+  end
+
+<% end -%>
+end
+

data/generators/dpage/templates/default_stylesheets/common.css

@@ -0,0 +1,11 @@
+@import url(reset.css);
+@import url(../../../dijit/themes/tundra/tundra.css);
+html,body,#mainContainer{
+ width:100%;
+ height:100%;
+}
+#topContainer{
+}
+#leftContainer, #trailingContainer{
+  width:15em;
+}

data/generators/dpage/templates/default_stylesheets/reset.css

@@ -0,0 +1,51 @@
+html, body, div, span, applet, object, iframe,
+h1, h2, h3, h4, h5, h6, p, blockquote, pre,
+a, abbr, acronym, address, big, cite, code,
+del, dfn, em, font, img, ins, kbd, q, s, samp,
+small, strike, strong, sub, sup, tt, var,
+b, u, i, center,
+dl, dt, dd, ol, ul, li,
+fieldset, form, label, legend,
+table, caption, tbody, tfoot, thead, tr, th, td {
+  margin: 0;
+  padding: 0;
+  border: 0;
+  outline: 0;
+  font-size: 100%;
+  vertical-align: baseline;
+  background: transparent;
+}
+body {
+  line-height: 1;
+}
+ol, ul {
+  list-style: none;
+}
+blockquote, q {
+  quotes: none;
+}
+blockquote:before, blockquote:after,
+q:before, q:after {
+  content: '';
+  content: none;
+}
+
+/* remember to define focus styles! */
+:focus {
+  outline: 0;
+}
+
+/* remember to highlight inserts somehow! */
+ins {
+  text-decoration: none;
+}
+del {
+  text-decoration: line-through;
+}
+
+/* tables still need 'cellspacing="0"' in the markup */
+table {
+  border-collapse: collapse;
+  border-spacing: 0;
+}
+

data/generators/dpage/templates/default_stylesheets/theme_override.css

@@ -0,0 +1,3 @@
+.tundra .dijitBorderContainer-child{
+  border:1px solid #ccf; 
+}

data/generators/dpage/templates/dpage.css

@@ -0,0 +1,6 @@
+@import url(common.css);
+/**
+ * import here files specific for this page
+ * @import url('../../../dojox/grid/themes/tundraGrid.js');
+ ** /
+

data/generators/dpage/templates/dpage.js

@@ -0,0 +1,4 @@
+dojo.provide('<%= page_name%>');
+
+dojo.addOnLoad(function() {
+});

data/generators/dpage/templates/helper.rb

@@ -0,0 +1,9 @@
+require 'test_helper'
+
+class <%= class_name %>ControllerTest < ActionController::TestCase
+  # Replace this with your real tests.
+  test "the truth" do
+    assert true
+  end
+end
+

data/generators/dpage/templates/helper_test.rb

@@ -0,0 +1,5 @@
+require 'test_helper'
+
+class <%= class_name %>HelperTest < ActionView::TestCase
+end
+

data/generators/dpage/templates/view.haml

@@ -0,0 +1,28 @@
+
+!!! XML
+!!! Strict
+%html
+  %head
+    %title <%= action %>
+    =dojo :app=> '<%= action %>'
+  %body{:class=>theme}
+    #mainContainer{ :dojoType => "dijit.layout.BorderContainer"}
+      #topContainer{ :region => "top", :dojoType => "dijit.layout.ContentPane" }
+        %h1#logo Dojo On Rails
+      #leftContainer{ :region => "leading", :dojoType => "dijit.layout.AccordionContainer" }
+        %div{ :dojoType => "dijit.layout.ContentPane", :title => "pane #1" }
+          accordion pane #1
+        %div{ :dojoType => "dijit.layout.ContentPane", :title => "pane #2" }
+          accordion pane #2
+        %div{ :dojoType => "dijit.layout.ContentPane", :title => "pane #3" }
+          accordion pane #3
+      #centerContainer{ :region => "center", :dojoType => "dijit.layout.TabContainer" }
+        %div{ :dojoType => "dijit.layout.ContentPane", :title => "Content Viewer" , :jsId=>'views.contentViewer'}
+          WE NEED YOUR HELP
+        %div{ :dojoType => "dijit.layout.ContentPane", :title => "tab #2" }
+          TEST IT AND SEND FEEDBACK TO US
+        %div{ :dojoType => "dijit.layout.ContentPane", :title => "tab #3" }
+          PARTICIPATE IN DEVELOPMENT
+      #trailingContainer{ :region => "trailing", :dojoType => "dijit.layout.ContentPane" , :jsId=> 'views.console'}
+        %h3 Log:
+      #bottomContainer{ :region => "bottom", :dojoType => "dijit.layout.ContentPane" } nicolA

data/init.rb

@@ -0,0 +1,2 @@
+# Include hook code here
+

data/install.rb

@@ -0,0 +1 @@
+# Install hook code here

data/lib/depo/build.rb

@@ -0,0 +1,53 @@
+require 'erb'
+require 'fileutils'
+
+module Depo
+  class Build
+    class << self
+      def generate_profile(opts={})
+        @rails_root = opts[:rails_root] if opts.key?(:rails_root)
+        profile_content = profile_template.result(binding)
+        open(profile_path,'w') do |f|
+          f<< profile_content
+        end
+      end
+
+      def profile_path
+        raise "I need RAILS ROOT to generate profile" unless Object.const_defined? :RAILS_ROOT
+        file_path = File.join(RAILS_ROOT,Depo.config.profile_path)
+        file_dir = File.dirname(file_path)
+        unless File.exists?(file_dir)
+          FileUtils.mkdir_p(file_dir)
+        end
+        file_path
+      end
+
+      def profile_template
+        return @template if @template
+        tpl_string = IO.readlines("#{File.dirname(__FILE__)}/templates/profile.js",'').to_s
+        @template = ERB.new(tpl_string)
+      end
+
+      def layers
+        Depo.config.build_profile.pages.map do |page|
+          file="../#{page.gsub('.','/')}.js"
+          <<-JS
+          {
+            name:"#{file}",
+            dependencies: ["#{page}"]
+          }
+          JS
+        end.join(',')
+      end
+
+      def prefixes
+        result = %w{dijit dojox}.map{|lib| %Q<["#{lib}","../#{lib}"]>}
+        Depo.config.build_profile.libs.each do |lib|
+          result<< %Q<["#{lib}","#{@rails_root}/#{Depo.config.src_path}/#{lib}"]>
+        end
+        "#{result.join(',')}"
+      end
+
+    end
+  end
+end

data/lib/depo/config.rb

@@ -0,0 +1,82 @@
+module Depo
+  class Config < KungFigure::Base
+    define_prop :root,'public/ria'
+    define_prop :webroot,'public'
+    define_prop :base_webpath,''
+    define_prop :author,'NotConfigured'
+    define_prop :themes,['tundra']
+    define_prop :default_theme,'tundra'
+    define_prop :profile_path,'tmp/dojo_build_profile.js'
+    define_prop :default_page_lib,'app.pages'
+    define_prop :dojo_version,'1.4.102'
+    define_prop :enable_dojofy, true
+
+    def src_path
+      "#{root}/src"
+    end
+
+    def builds_path
+      "#{root}/builds"
+    end
+
+    def root_webpath
+      "#{base_webpath}#{root.gsub(webroot, "")}"
+    end
+
+    def src_webpath
+      "#{base_webpath}#{src_path.gsub(webroot, "")}"
+    end
+
+    def last_build_webpath
+     "#{base_webpath}#{(Dir[File.join(builds_path,'*')].max).to_s.gsub(webroot, "")}"
+    end
+
+    def env_dj_config(env)
+      return (env == "production") ? environments.productionDjConfig : environments.developmentDjConfig
+    end
+
+    def env_root_webpath(env)
+      return (env == "production") ? last_build_webpath : src_webpath
+    end
+
+    def buildscripts_path
+      File.join(src_path,'util','buildscripts')
+    end
+
+    def to_hash
+      @props
+    end
+
+    class Generators < KungFigure::Base
+      define_prop :head_of_test_page,''
+    end
+
+    class Environments < KungFigure::Base
+      define_prop :developmentDjConfig, 'parseOnLoad:true,isDebug:true'
+      define_prop :productionDjConfig, 'parseOnLoad:true,isDebug:false'
+    end
+
+    class BuildProfile < KungFigure::Base
+      define_prop :libs,[]
+      define_prop :pages,[]
+    end
+
+    class BuildOptions < KungFigure::Base
+      define_prop :cssOptimize,'comments.keepLines'
+      define_prop :optimize,'shrinksafe.keepLines'
+      define_prop :cssImportIgnore,'../dijit.css'
+      define_prop :internStrings, 'false'
+
+      #FIXME: fix kung_figure to do such things simpler
+      def get_options
+        {
+          :cssOptimize => cssOptimize,
+          :optimize=> optimize,
+          :cssImportIgnore=>cssImportIgnore,
+          :internStrings=>internStrings
+        }
+      end
+    end
+  end
+
+end