choco 0.1.0

data/.document

@@ -0,0 +1,5 @@
+README.rdoc
+lib/**/*.rb
+bin/*
+features/**/*.feature
+LICENSE

data/.gitignore

@@ -0,0 +1,21 @@
+## MAC OS
+.DS_Store
+
+## TEXTMATE
+*.tmproj
+tmtags
+
+## EMACS
+*~
+\#*
+.\#*
+
+## VIM
+*.swp
+
+## PROJECT::GENERAL
+coverage
+rdoc
+pkg
+
+## PROJECT::SPECIFIC

data/HISTORY

@@ -0,0 +1,3 @@
+== 0.1.0 [07-22-10]
+
+* Initial release

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2010 Anthony Heukmes
+
+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,326 @@
+= Choco
+
+A delicious Javascript web framework made in Belgium!
+
+Choco brings the MVC to the client side!
+
+You like Javascript and you want to develop rich internet applications?
+You also know that HTML & CSS are powerful?
+Cappuccino & Sproutcore don't feel like web development anymore?
+
+Thanks to Choco, you'll be able to easily develop maintainable web applications.
+A Choco app consists of only one HTML page, all the interactions are managed by Javascript.
+Your UI only uses HTML and CSS!
+
+Choco is based on powerful libaries : 
+
+* Sammy (http://github.com/quirkey/sammy)
+* js-model (http://github.com/benpickles/js-model)
+* Jim (http://github.com/quirkey/jim)
+
+Huge thanks to Aaron Quint and Ben Pickles for their incredible work.
+
+== Installation
+
+Choco is a Ruby gem, simply install it :
+
+  $ gem install choco
+
+== A new application
+
+  $ choco new my_project
+
+This will generate your project structure.
+
+You can then install the required JS dependencies (jQuery, Sammy, ...) by executing the following command at the root of your project :
+
+  $ rake choco:js:install
+
+== Location
+
+A Choco app is composed of static files (js, css, images, ...), it must be directly accessible on your web server.
+If you use Rails, you can for example put your Choco app inside the public/javascripts folder.
+
+Once you've chosen the location where your application will reside, don't forget to configure the path to your view files.
+You can find the line to edit in your application_controller (app/controllers).
+
+Example for Rails :
+
+  this.use(Sammy.SmartRenderer, '/javascripts/my_project/app/views/');
+
+== Jim
+
+Jim is mix of Ruby gems & Bundler but for Javascript libraries.
+
+When you install a JS library using the $ jim install command, it is stored in your home folder (~/.jim/lib).
+All your projects can then use this repository to load the required dependencies.
+
+The $ rake choco:js:install command installs all the dependencies you need to run a Choco app.
+
+A Jimfile is located at the root of your project, it lists all these dependencies.
+They can be libraries (jQuery, Sammy, ...) but also local JS files of your application (controllers, models, ...).
+
+All these files are bundled into the compressed/bundled.js file, so you only have to include this file in your HTML page and all your Choco app will be loaded.
+
+You can continuously track changes in your JS files by running the following command in your project root folder :
+
+  $ choco --watch
+
+The watch script will track your JS files (creation, edition, suppression) and automatically update your Jimfile & bundled.js to reflect these changes.
+You never have to worry about including your JS files inside your HTML page, just include bundled.js!
+
+== Access your homepage
+
+To launch your application, just call the index.html page.
+I'm using Rails, I will call the following URL in my web browser :
+http://localhost:3000/javascripts/choco_app/index.html
+
+Notice that when the app is launched, the URL changes to :
+http://localhost:3000/javascripts/choco_app/index.html#/main
+
+#/main is a route in your Choco app (thanks to Sammy), it is defined in your ApplicationController.
+
+  this.get('#/main', function(cx) {
+	});
+	
+You have to include this # in every HTML link you add into your views.
+
+  <a href="#/posts">List all the posts</a>
+  <a href="#/posts/new">Add a new post</a>
+  ...
+
+= Project structure
+
+A Choco project has the following structure :
+
+== Jimfile
+This file list all the dependencies for your project (libraries & local files).
+
+== app
+It contains four sub-folders : controllers, helpers, models & views.
+This is where you will spend most of your development time.
+
+== compressed
+This is where the bundled.js file is created, it bundles all your JS files in one single file.
+It is highly recommended to compress this file before going live (rake choco:deploy).
+
+== images
+Store all the images used by your application in this folder.
+
+== index.html
+This is the file you have to open in your browser to launch your Choco application.
+It includes your bundled.js file, your stylesheets and defines the layout of your application.
+
+The #choco div is very important, this is where the HTML generated by your views will be inserted.
+If you change his name, you must configure it into the app/controllers/application_controller.js as well.
+
+== lib
+Use this folder to store your JS files which are specific to your project but don't have their place in the app folder.
+If this is a library that can be used by other projects, you should use Jim instead.
+
+== script
+This folder contains the choco script file.
+It brings you a few generators (model, controller, layout, scaffold, json, plugin).
+
+== spec
+Test your application using Behavior Driven Development (BDD).
+
+== stylesheets
+Store all the stylesheets used by your application in this folder.
+
+= A first resource (CRUD)
+
+First of all, don't forget to start the choco watcher ($ choco --watch) if you don't want to update your Jimfile manually.
+
+The easiest way to get started is to generate a scaffold based on JSON.
+Use your server side technology to create a web service that returns JSON representing your resource.
+
+For example, with Rails : 
+
+  def index
+    render :json => Post.all
+  end
+
+Once you have that, you can generate your scaffold very easily :
+
+$ choco generate scaffold post http://localhost:3000/posts
+
+This will create the PostsController with all the actions, the views and the model.
+
+Notice that the Choco watcher automatically updated your Jimfile and your bundled.js.
+
+It also updated your ApplicationController by adding the following line :
+
+  PostsController(this);
+
+You can now call this new page with the following URL :
+http://localhost:3000/javascripts/choco_app/index.html#/posts
+
+This will send a GET request to the #/posts URL of your application.
+This request will be handled by your PostsController and more precisely by this action :
+
+  get('#/posts', function(cx) {
+	  cx.posts = Post.all();
+  });
+
+We are using our model to get all the posts (locally) and store them in the posts variable.
+Using cx will make this variable available in your view.
+
+Like Rails, Choco will automatically render the view with the same name as the current action (located in the view folder with the same name as the current controller).
+In our case app/views/posts/index.template will be rendered.
+
+This is a simple HTML page with some Javascript tags.
+
+Here is a part of it :
+
+  <% $.each(posts, function(i, post) { %>
+    <tr id="post_<%= post.id() %>">
+      <td>
+        <%= post.attr('created_at') %>
+      </td>
+      <td>
+        <%= post.attr('author') %>
+      </td>
+      ...
+    
+We are iterating on our posts array to create a table row for each of them.
+
+You will not see any post yet because you haven't loaded the post from your server (JSON).
+
+To do that, just update your ApplicationController by adding your Post model in the models array :
+
+  var models = [Post];
+  ChocoUtils.loadModels(models, function() {
+	  app.run('#/main');
+  });
+
+All your models will be loaded by calling the load() method on their class.
+This action will send Ajax requests to your server.
+The Choco application will then be launched when all the responses have been received and treated.
+
+To create, remove & update posts, you have to create your REST controller on the server side.
+Have a look at the sample demo for an example (http://github.com/ahe/choco_demo).
+
+= Generators
+
+The following code generators are available :
+
+* $ choco generate controller <controller_name>
+* $ choco generate model <model_name>
+* $ choco generate scaffold <name> [field1 field2 ...]
+* $ choco generate scaffold <name> <url>
+* $ choco generate layout <layout_name>
+* $ choco generate plugin <plugin_name>
+
+Don't forget to start the choco --watch command before executing any generator. Otherwise you'll have to update manually your Jimfile, bundled.js & application_controller.js.
+
+= Controllers
+
+To learn more about controllers, please read Sammy documentation : http://code.quirkey.com/sammy
+
+You may be wondering about the best solution to execute Javascript code after rendering a template.
+Let's say we want to add a specific behavior to one of our link, in the app/views/posts/index.template view, I add this simple link : 
+
+  <a href="#" id="test_link">Hey, click me, I'm a simple test!</a>
+  
+I want to open a Javascript alert when it is clicked.
+
+I can simply update my controller like this :
+
+  get('#/posts', function(cx) {
+  	cx.posts = Post.all();
+  	cx.render({ template: 'posts/index', event: 'posts_loaded', data: { size: cx.posts.length }});
+  });
+
+  bind('posts_loaded', function(e, data) {
+  	$('#test_link').click(function() {
+  		alert('Hey! We have ' + data['size'] + ' posts!');
+  		return false;
+  	});
+  });
+  
+I call the render() method explicitly because I want to trigger an event when the template is rendered.
+This event is named 'posts_loaded' and when it is executed it simply add a Javascript behavior to my link.
+
+The render method supports various options like like layouts, events & more.
+You can read the doc here : http://github.com/ahe/choco.libs/blob/master/plugins/sammy/choco.plugins.sammy.smart_renderer.js
+
+= Views
+
+By default, Choco uses simple template views where you can combine HTML and Javascript.
+
+You can easily display values in your views :
+
+  <%= post.attr('title') %>
+  
+Or call helpers you defined :
+
+  <% myHelper(); %> // Don't forget the ;
+  
+You can also of course use conditions, iterators & more.
+
+You can easily switch to HAML or Mustache by configuring it in your application controller.
+Have a look at Sammy documentation for more information.
+
+To create a DELETE link, just use the following attributes :
+
+  <a href="#/posts/<%= post.id() %>" verb="delete" confirm="Are you sure?">Delete</a>
+
+= Models
+
+For more information about models, please read js-model documentation : http://github.com/benpickles/js-model
+
+js-model stores all the data locally. You can persist your models to the server using methods like save() but don't forget to implement your REST controller on the server side.
+Have a look at the demo for an example : http://github.com/ahe/choco_demo
+
+js-model expects JSON without the ROOT element included. In Rails that means you have to disable this option :
+
+  ActiveRecord::Base.include_root_in_json = false
+
+= Logger
+
+You can call the logger from anywhere in your application by simply calling :
+
+  app.logger('hello choco!');
+
+= Plugins
+
+Models, views & controllers can easily be extended using plugins.
+
+You can generate a new plugin using the following command : 
+
+  $ choco generate plugin <plugin_name>
+
+Existing plugins & Choco libs are stored here : http://github.com/ahe/choco.libs
+
+= Deploy
+
+When you deploy your application on live, don't forget to compress your files :
+
+  $ rake choco:deploy
+
+Then just copy the required files on your web server.
+
+= BDD
+
+BDD is currently being implemented, it will be soon very easy to test all the parts of your Choco apps.
+A first solution can be found here : http://github.com/ahe/sammy_demo/tree/master/test/javascript
+
+= Note on Patches/Pull Requests
+ 
+* Fork the project.
+* Make your feature addition or bug fix.
+* Add tests for it. This is important so I don't break it in a
+  future version unintentionally.
+* Commit, do not mess with rakefile, version, or history.
+  (if you want to have your own version, that is fine but bump version in a commit by itself I can ignore when I pull)
+* Send me a pull request. Bonus points for topic branches.
+
+== Copyright
+
+Copyright (c) 2010 Anthony Heukmes. See LICENSE for details.
+
+*  http://2dconcept.com
+*  http://intotheweb.be
+*  http://twitter.com/2dc
+*  http://twitter.com/intotheweb

data/Rakefile

@@ -0,0 +1,55 @@
+require 'rubygems'
+require 'rake'
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), 'lib'))
+
+require 'choco'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "choco"
+    gem.version = Choco::VERSION
+    gem.summary = %Q{A delicious Javascript web framework made in Belgium!}
+    gem.description = %Q{Choco brings the MVC to the client side! It allows you to easily develop maintainable Rich Internet Applications using Javascript.}
+    gem.email = "anthony.heukmes@skynet.be"
+    gem.homepage = "http://github.com/ahe/choco"
+    gem.authors = ["Anthony Heukmes"]
+    
+    gem.add_dependency "jim"
+    gem.add_dependency "fssm"
+    gem.add_dependency "thor"
+    gem.add_dependency "activesupport"    
+    
+    gem.add_development_dependency "rspec", ">= 1.2.9"
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: gem install jeweler"
+end
+
+require 'spec/rake/spectask'
+Spec::Rake::SpecTask.new(:spec) do |spec|
+  spec.libs << 'lib' << 'spec'
+  spec.spec_files = FileList['spec/**/*_spec.rb']
+end
+
+Spec::Rake::SpecTask.new(:rcov) do |spec|
+  spec.libs << 'lib' << 'spec'
+  spec.pattern = 'spec/**/*_spec.rb'
+  spec.rcov = true
+end
+
+task :spec => :check_dependencies
+
+task :default => :spec
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "choco #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/bin/choco

@@ -0,0 +1,45 @@
+#!/usr/bin/env ruby
+
+require 'choco'
+require 'pathname'
+
+module Choco
+  module ScriptChocoLoader
+    SCRIPT_CHOCO = File.join('script', 'choco')
+
+    def self.exec_script_choco!
+      cwd = Dir.pwd
+      exec 'ruby', SCRIPT_CHOCO, *ARGV if in_choco_application?
+      
+      Dir.chdir("..") do
+        # Recurse in a chdir block: if the search fails we want to be sure
+        # the application is generated in the original working directory.
+        exec_script_choco! unless cwd == Dir.pwd
+      end
+    rescue SystemCallError
+      # could not chdir, no problem just return
+    end
+    
+    def self.in_choco_application?
+      File.exists?(SCRIPT_CHOCO) || in_choco_application_subdirectory?
+    end
+    
+    def self.in_choco_application_subdirectory?(path = Pathname.new(Dir.pwd))
+      File.exists?(File.join(path, SCRIPT_CHOCO)) || !path.root? && in_choco_application_subdirectory?(path.parent)
+    end
+  end
+end
+
+Choco::ScriptChocoLoader.exec_script_choco!
+
+ARGV << '--help' if ARGV.empty?
+command = ARGV.shift
+
+case command
+  when 'new'
+    Choco::AppGenerator.start ARGV
+  when '-v'
+    puts "Choco version #{Choco::VERSION}" 
+  else
+    puts "\nWelcome to Choco!\nA delicious Javascript web framework made in Belgium!\n\nUsage:\n\n$ choco new <project_name>\n-> Generates a new Choco project\n\n$ choco -v\n-> Displays current version\n"
+end