capucine 0.1.7 → 0.2.0

data/Gemfile

@@ -1,17 +1,17 @@
 source "http://rubygems.org"
 
-gem 'fssm'
-gem 'compass', '0.12.rc.0'
+gem 'fssm', :require => false
+# gem 'listen'
 gem 'coffee-script'
 gem 'uglifier'
 gem 'packr'
 gem 'json'
+
+gem 'compass'
 gem 'compass-capucine'
 
 group :development do
-  # gem "shoulda", ">= 0"
-  # gem "rdoc", "~> 3.12"
-  gem "bundler", "~> 1.0.0"
-  gem "jeweler", "~> 1.8.3"
-  # gem "rcov", ">= 0"
+  gem "bundler"
+  gem "jeweler"
+  gem "rspec"
 end

data/README.md

@@ -1,51 +1,346 @@
-Capucine
-===
+# Capucine
 
-Capucine is a Frontend micro-framework for test and production.
-This allow you to use CoffeeScript and Compass everywere.
+Capucine is a command line tool for using **Sass** (+ Compass), **CoffeeScript** and **Incloudr** in any project.
+It is completely agnostic and there are few configuration (just a simple and understandable **YAML** file).
 
-- [Full documentation here](http://capucine.dln.name/)
-- [Twitter (@wearecapucine)](http://twitter.com/wearecapucine)
+**The first goal of 
+Capucine is to give to everyone a very easy access to modern 
+frontend tools. **
 
-Installation
-===
-Require Ruby 1.9+
+[Capucine official site](http://capucine.dln.name/)
 
-    gem install capucine
+This meta-languages really solve big problems in frontend development. Some people are using them every day for a cleaner code and better collaboration.
 
-Usage
-===
+* **Sass**
 
-Initialize a Capucine project where you want, this will add a capucine.yaml file :
+Maybe you already know Sass (and Compass).
+If it's not the case, this blog post can be really helpful.
+
+[Understanding Sass](http://sass-lang.com/)
+
+* **CoffeeScript**
+
+CoffeeScript is a pure JavaScript generator. Reading this post can help you to understand his goals.
+
+[Understanding CoffeeScript](http://coffeescript.org/)
+
+* **Incloudr**
+
+Incloudr is a multiple provider JavaScript client library. It allows you to quickly download JavaScript libs from cdnjs.com, git repos, NodeJS Packages (NPM), and raw url files without the mess.
+
+<a target="_blank" href="https://twitter.com/share" class="twitter-share-button" data-via="damln">Tweet This</a>
+
+
+# Do I need Capucine ?
+
+### Rails projects
+
+If you are a Ruby On Rails developer, you probably do not need Capucine. Sprocket does the job. Maybe you are looking for an alternative to Sprocket ? Capucine is faster, test it. Then, you might be interested in the **Incloudr** part of Capucine.
+
+More on this feature here : [**Incloudr**, an easy way to embed JavaScript.]()
+
+### Others projects
+
+If you are coding in PHP, .NET, Java, Perl, Ruby (Sinatra, Padrino, ...) or an other language, Capucine is the simplest way to use Sass and CoffeeScript !
+You don't need to change anything in your application. Just provide the right paths in the capucine.yaml file, compile, and that's work.
+
+# Intallation (22 seconds)
+
+#### Require :
+* Ruby 1.9.*
+* RubyGems
+
+#### Tested on :
+* OSX 10.6
+* OSX 10.7
+* Ubuntu
+* Windows 7
+
+**Quick install** :
+	
+	gem uninstall capucine
+	gem update --system
+	gem install capucine
+
+Troubles ? Read this doc : [Installing Capucine](http://capucine.dln.name)
+
+# Start
+
+This will generate a full ready-to-use project from scratch :
+
+	capucine new my_app_name
+
+If you are already working in a project, initialize a Capucine project where you want, this will just add a `capucine.yaml` file in the current directory:
 
     capucine init
 
-This will generate a full ready-to-use project :
+The `capucine.yaml` file is the **only required file** for using Capucine.
 
-    capucine new my_project
+* [**The full documentation about the capucine.yaml file is here.**](https://github.com/damln/Capucine#config--capucineyaml)
 
-Compile the project, just once :
+If you want to start with another `capucine.yaml` , there are some templates hosted on the Capucine official Github repository. You can create yours, and use them as well.
+	
+##### Use your own configuration (hosted somewhere)
+
+	capucine init http://myhost.com/capucine.yaml
+
+##### Use existing configurations (hosted on Github)
+
+	capucine init:django
+	capucine init:sinatra
+	capucine init:wordpress
+	...
+
+Of course, you can contribute to the official repository ! [Read this section](http://)
+
+* [All officials configurations (`capucine.yaml`) are here](http://github.com/damln/Capucine/)
+
+
+# Usage 
+
+Once you have configured the `capucine.yaml` and write some Sass and/or CoffeeScript, you can compile the project once :
 
     capucine compile
 
-Launch the watcher, this will compile everything on file changes :
+In developement, you might want to **launch the watcher**. This will compile everything once and compile files on changes (use and abuse it):
 
     capucine watch
 
-Update the Capucine gem :
+Maybe you have configured Sass + CoffeeScript in your `capucine.yaml` file but you just want to compile/watch the Sass or the CoffeeScript. You can specify them in this way :
+
+	capucine compile:coffee
+	capucine compile:sass
+	capucine compile:incloudr
+
+This works too :
+	
+	capucine watch:sass
+	capucine watch:coffee
+
+
+*Why there is no `capucine watch:incloudr` ?*
+The Incloudr tool will be explained.
+
+Default to :
+	
+	capucine compile:all
+	capucine watch:all
+	
+
+## Let's recap
+So, you can use **(simple recap)** :
+	
+- Create
+	
+	    cd my_current_project/
+	
+	    # Or
+	
+	    capucine new my_app_name
+	    cd my_app_name/
+	
+- Initialize
+	
+	    # Edit the capucine.yaml file.
+	    
+	    # Or :
+	
+	    capucine init
+	    capucine init:django
+	
+
+- Compile Once
+	    
+	    capucine compile
+	    capucine compile:sass
+	    capucine compile:coffee
+	    capucine compile:incloudr
+	
+- Or Watch (Stop with Ctrl + C)
+	    
+	    capucine watch
+	    capucine watch:sass
+	    capucine watch:coffee
+
+
+# Incloudr
+
+You can directly configure JS libraries you need in the `capucine.yaml` .
+Enter the output directory where you want your libs :
+
+    incloudr_output_dir: public/js_generated/modules
+
+Your JS libraries will be download form the web and they will be move to the `incloudr_output_dir` directory.
+So, list you libs :
+
+    incloudr_libs:
+    
+        - name: jquery
+
+The default CDN is [CDNJS](http://cdnjs.com), and it will download the latest version. So, if you want a specific version :
+
+    incloudr_libs:
+    
+        - name: jquery
+          version: 1.7.2
+
+Need a [NPMJS](http://npmjs.org) package ? Configure the package like this :
+
+    incloudr_libs:
+        
+        # From CDNJS :
+        
+        - name: jquery
+        
+        # From NPMJS (coming) :
+        
+        - name: underscore
+          type: npm
+
+
+With a specific version from NPM ? (coming) :
+
+    incloudr_libs:
+    
+        - name: underscore
+          type: npm
+          version: 1.3.3
+
+Maybe you just want to include a distant JS file :
+    
+    incloudr_libs:
+    
+        - name: my_lib
+          source: http://site/to/my/lib.js
+
+List all JS libraries existing on [CDNJS.com](http://cdnjs.com) :
+
+    capucine js:list
+    
+    
+List all JS libraries existing on [NPMJS.org](http://npmjs.org/) :
+
+    capucine js:list:npm
+    
+Search a library on CDNJS (*example: jquery*) :
+    
+    capucine js:search jquery
+
+Search a library on NPMJS (*example: underscore*) (coming):
+
+    capucine js:search:npm underscore
+
+###### When my lib are download ?
+
+When you type `capucine compile`, your Sass and CoffeeScript are compiled, and Incloudr will look at the `capucine.yaml`, download them, and move the files to the `incloudr_output_dir` directory.
+
+When you type `capucine watch`, Capucine will first do a `capucine compile`, and next it will start the watcher.
+
+# How does it work
+
+Capucine works on top of Compass and CoffeeScript. It use a watcher for compiling CoffeeScript on the fly and uses the official Compass watch for Sass's files.
+So, it generate a configuration file for Compass (`config.rb`). This file is in the TEMP OS directory. (/tmp or Temp).
+
+
+If you activate the `sass_cache` options, Capucine will generate a `.sass-cache/` folder in the working directory.
+
+
+# Tools
+
+Since Capucine generate some needed extra files(`config.rb` and `.sass-cache/`), you can remove them with :
+	 
+	 capucine clean
+
+Update the Capucine gem (will update Compass, SASS and CoffeeScript to the edge):
 
     capucine update
 
-Help :
+If you know what you're doing, you can update them with rubygems :
+
+	gem install sass
+	gem install compass
+	gem install coffeescript
+
+Quick Help :
 
     capucine help
 
-or
 
-    capucine
+### There are shortcuts :
+
+	capucine i   == capucine init
+	capucine n   == capucine new
+	
+	capucine c   == capucine compile
+	capucine w   == capucine watch
+	capucine j   == capucine js
+	
+	capucine h   == capucine help
+	capucine u   == capucine update
+	capucine cl  == capucine clean
+
+# CONFIG : capucine.yaml
+
+All directories are relative to the root project (the parent directory of the `capucine.yaml` file)
+
+### Sass :
+
+- `use_libsass` : For the future.
+- `sass_images_dir` : For Compass.
+- `sass_output_dir` : Where your Sass will be compiled.
+- `sass_line_comments` : Remove line comments for the output.
+- `sass_css_generated_style` : expanded (dev), compact, or compressed (prod).
+- `sass_options` : Raw Sass options. Will be passed to Compass configuration.
+- `compass_config` : Passed to Compass config.  
+
+- `compass_plugins` : A list of plugins. `gem_name` or `plugin_name|gem_name`  
+Ex : `- compass-capucine` or `- compass_twitter_bootstrap`.  
+
+
+- `sass_import_css` : True or False. For using the import system.
+- `sass_import_formats` : Can be `css to scss`, `css to sass`, `scss to sass`, or `sass to scss`.  
+
+- `sass_import_css_dir` : The input directory for import.
+- `sass_import_output_dir` : Where your CSS will be compile.
+
+
+### CoffeeScript :
+
+- `coffeescript_bare` : Use the `--bare` option for CoffeeScript.
+- `coffeescript_files_dir`: Directory where you place your `.coffee` files.
+- `coffeescript_output_dir` : Where your `.js` will be generated.
+
+### Incloudr :
+
+- `incloudr_output_dir` : Where your modules will be placed.
+- `incloudr_libs` : A list of library to use. See the documentation above.
+	
+# Contribute to the official repo
+##### If you want to share you capucine.yaml files :
+
+- Fork the project.
+- Create a branch with the Template name (*example: wordpress*).
+- Add you `capucine.yaml` in the `templates/` directory.
+- Edit the `templates/README.md` file.
+- Commit.
+- Pull Request.
+- Drink a coffee.
+
+
+##### If you want to contribute to the core system :
+
+- Fork the project.
+- Create a branch with a feature name (*example: github-cdn*).
+- Edit.
+- Commit.
+- Pull Request.
+- Drink another coffee.
+
+# TODO
+- Add NPM support for Incloudr
+- Add the `clean` option
 
-Author
-===
+# Author
 
 - [Damian Le Nouaille](http://dln.name/)
 - [Twitter (@damln)](http://twitter.com/damln)

data/Rakefile

@@ -10,27 +10,23 @@ rescue Bundler::BundlerError => e
   exit e.status_code
 end
 require 'rake'
-
 require 'jeweler'
+
+load 'spec/spec.rake'
+
 Jeweler::Tasks.new do |gem|
   # gem is a Gem::Specification... see http://docs.rubygems.org/read/chapter/20 for more options
   gem.name = "capucine"
   gem.homepage = "http://capucine.dln.name"
   gem.license = "MIT"
   gem.summary = %Q{Tools for frontend developers. Use CoffeeScript and Compass everywhere.}
-  gem.description = %Q{longer description of your gem}
+  gem.description = %Q{Improve your worlkflow}
   gem.email = "dam@dln.name"
   gem.authors = ["Damian Le Nouaille"]
   # dependencies defined in Gemfile
 end
 Jeweler::RubygemsDotOrgTasks.new
 
-# require 'rake/testtask'
-# Rake::TestTask.new(:test) do |test|
-#   test.libs << 'lib' << 'test'
-#   test.pattern = 'test/**/test_*.rb'
-#   test.verbose = true
-# end
 
 # require 'rcov/rcovtask'
 # Rcov::RcovTask.new do |test|
@@ -40,7 +36,7 @@ Jeweler::RubygemsDotOrgTasks.new
 #   test.rcov_opts << '--exclude "gems/*"'
 # end
 
-task :default => :test
+task :default => :spec
 
 # require 'rdoc/task'
 # Rake::RDocTask.new do |rdoc|

data/VERSION

@@ -1 +1 @@
-0.1.7
+0.2.0

data/bin/capucine

@@ -1,4 +1,7 @@
 #!/usr/bin/env ruby
+require 'rubygems' unless defined?(Gem)
+require 'bundler/setup' if %w(Gemfile .components).all? { |f| File.exist?(f) }
+
 def fallback_load_path(path)
   retried = false
   begin
@@ -15,6 +18,7 @@ end
 
 fallback_load_path(File.join(File.dirname(__FILE__), '..', 'lib')) do
   require 'capucine.rb'
-  require 'commands.rb'
 end
-Capucine::Commands.new ARGV
+
+@cap = Capucine::Main.new
+@cap.run_command(ARGV)

data/capucine.gemspec

@@ -5,12 +5,12 @@
 
 Gem::Specification.new do |s|
   s.name = "capucine"
-  s.version = "0.1.7"
+  s.version = "0.2.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Damian Le Nouaille"]
-  s.date = "2012-03-28"
-  s.description = "longer description of your gem"
+  s.date = "2012-05-28"
+  s.description = "Improve your worlkflow"
   s.email = "dam@dln.name"
   s.executables = ["capucine"]
   s.extra_rdoc_files = [
@@ -19,13 +19,15 @@ Gem::Specification.new do |s|
   ]
   s.files = [
     "Gemfile",
-    "Gemfile.lock",
     "LICENSE.txt",
     "README.md",
     "Rakefile",
     "VERSION",
     "bin/capucine",
+    "capucine-logo-mini.png",
     "capucine.gemspec",
+    "content/default.yaml",
+    "content/options.yaml",
     "content/shared/capucine.yaml",
     "content/shared/coffeescript/app.coffee",
     "content/shared/index.html",
@@ -39,17 +41,28 @@ Gem::Specification.new do |s|
     "content/shared/sass/_main.scss",
     "content/shared/sass/_responsive.scss",
     "content/shared/sass/screen.scss",
-    "content/templates/capucine.yaml",
     "content/templates/cmd_help.erb",
     "content/templates/compass_config.erb",
     "lib/capucine.rb",
+    "lib/cdnjs.rb",
     "lib/coffeescript.rb",
-    "lib/commands.rb",
     "lib/compass-sass.rb",
     "lib/incloudr.rb",
+    "lib/npm.rb",
     "lib/settings.rb",
     "lib/tools.rb",
-    "lib/watch.rb"
+    "lor",
+    "spec/capucine/capucine_spec.rb",
+    "spec/capucine/coffee_spec.rb",
+    "spec/capucine/incloudr_spec.rb",
+    "spec/capucine_coffee.yaml",
+    "spec/capucine_incloudr.yaml",
+    "spec/capucine_incloudr2.yaml",
+    "spec/capucine_incloudr3.yaml",
+    "spec/spec.rake",
+    "spec/spec_helper.rb",
+    "templates/README.md",
+    "templates/sinatra.yaml"
   ]
   s.homepage = "http://capucine.dln.name"
   s.licenses = ["MIT"]
@@ -62,35 +75,38 @@ Gem::Specification.new do |s|
 
     if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
       s.add_runtime_dependency(%q<fssm>, [">= 0"])
-      s.add_runtime_dependency(%q<compass>, ["= 0.12.rc.0"])
       s.add_runtime_dependency(%q<coffee-script>, [">= 0"])
       s.add_runtime_dependency(%q<uglifier>, [">= 0"])
       s.add_runtime_dependency(%q<packr>, [">= 0"])
       s.add_runtime_dependency(%q<json>, [">= 0"])
+      s.add_runtime_dependency(%q<compass>, [">= 0"])
       s.add_runtime_dependency(%q<compass-capucine>, [">= 0"])
-      s.add_development_dependency(%q<bundler>, ["~> 1.0.0"])
-      s.add_development_dependency(%q<jeweler>, ["~> 1.8.3"])
+      s.add_development_dependency(%q<bundler>, [">= 0"])
+      s.add_development_dependency(%q<jeweler>, [">= 0"])
+      s.add_development_dependency(%q<rspec>, [">= 0"])
     else
       s.add_dependency(%q<fssm>, [">= 0"])
-      s.add_dependency(%q<compass>, ["= 0.12.rc.0"])
       s.add_dependency(%q<coffee-script>, [">= 0"])
       s.add_dependency(%q<uglifier>, [">= 0"])
       s.add_dependency(%q<packr>, [">= 0"])
       s.add_dependency(%q<json>, [">= 0"])
+      s.add_dependency(%q<compass>, [">= 0"])
       s.add_dependency(%q<compass-capucine>, [">= 0"])
-      s.add_dependency(%q<bundler>, ["~> 1.0.0"])
-      s.add_dependency(%q<jeweler>, ["~> 1.8.3"])
+      s.add_dependency(%q<bundler>, [">= 0"])
+      s.add_dependency(%q<jeweler>, [">= 0"])
+      s.add_dependency(%q<rspec>, [">= 0"])
     end
   else
     s.add_dependency(%q<fssm>, [">= 0"])
-    s.add_dependency(%q<compass>, ["= 0.12.rc.0"])
     s.add_dependency(%q<coffee-script>, [">= 0"])
     s.add_dependency(%q<uglifier>, [">= 0"])
     s.add_dependency(%q<packr>, [">= 0"])
     s.add_dependency(%q<json>, [">= 0"])
+    s.add_dependency(%q<compass>, [">= 0"])
     s.add_dependency(%q<compass-capucine>, [">= 0"])
-    s.add_dependency(%q<bundler>, ["~> 1.0.0"])
-    s.add_dependency(%q<jeweler>, ["~> 1.8.3"])
+    s.add_dependency(%q<bundler>, [">= 0"])
+    s.add_dependency(%q<jeweler>, [">= 0"])
+    s.add_dependency(%q<rspec>, [">= 0"])
   end
 end
 

data/content/{templates/capucine.yaml → default.yaml}

@@ -1,14 +1,15 @@
 sass: false
-coffeescript: false
+coffee: false
 incloudr: false
-templates: false
 
 # ----------------------------------------
+use_libsass: false
+
 sass_images_dir: public/images
 sass_files_dir: sass
 sass_output_dir: public/css_generated
 sass_line_comments: false
-sass_css_generated_style: expanded # compact | expanded | compressed
+sass_css_generated_style: expanded
 sass_options: '{:cache => false}'
 
 compass_config: {}
@@ -27,5 +28,4 @@ coffeescript_output_dir: public/js_generated
 incloudr_output_dir: public/js_generated/modules
 incloudr_libs: []
 
-# DOCUMENTATION :
-# http:// capucine.dln.name
+# DOCUMENTATION : http://capucine.dln.name

data/content/options.yaml

@@ -0,0 +1,11 @@
+i: init
+init: init
+
+n: new
+new: new
+
+c: compile
+compile: compile
+
+w: watch
+watch: watch

data/content/shared/capucine.yaml

@@ -1,5 +1,5 @@
 sass: true
-# coffeescript: true
+# coffee: true
 # incloudr: true
 
 # # ----------------------------------------
@@ -25,6 +25,6 @@ sass: true
 
 # incloudr_output_dir: public/js_generated/modules
 # incloudr_libs:
-#   - jquery
+#   - name: jquery
 
 # DOCUMENTATION : http:// capucine.dln.name

data/content/shared/index.html

@@ -32,10 +32,10 @@
   </div>
 
 </div>
-  <script src="public/js_generated/app.js"></script>
+  <!-- <script src="public/js_generated/app.js"></script> -->
   <!-- <script src="public/js_generated/app.min.js"></script> -->
 
-  <!--[if lt IE 7 ]>
+  <!--[if lte IE 7 ]>
     <script defer src="//ajax.googleapis.com/ajax/libs/chrome-frame/1.0.3/CFInstall.min.js"></script>
     <script defer>window.attachEvent('onload',function(){CFInstall.check({mode:'overlay'})})</script>
   <![endif]-->

data/content/shared/public/js/app.js

@@ -1,7 +1,7 @@
 (function() {
+
 var App = {
   initialize: function() {
-    console.log('hello');
   },
 };
 

data/content/shared/sass/_main.scss

@@ -12,7 +12,7 @@ body {
   color: $COLOR_0;
 }
 
-a { @include pressed-effect;}
+a, .pressed { @include pressed-effect;}
 
 p, b, strong, i, blockquote {line-height: 1.5em;}
 

data/content/shared/sass/screen.scss

@@ -1,5 +1,7 @@
-@import "compass"; // COMPASS CORE
-@import "compass-capucine/normalize";
+// @import "compass"; // COMPASS ALL
+@import "compass/css3"; // COMPASS CSS3
+@import "compass/reset"; // COMPASS RESET
+
 @import "compass-capucine"; // CAPUCINE HELPERS =>
 
 @import "./main";