coffee-cup 0.0.1

data/Gemfile

@@ -0,0 +1,4 @@
+source "http://rubygems.org"
+
+# Specify your gem's dependencies in coffee-cup.gemspec
+gemspec

data/LICENSE

@@ -0,0 +1,7 @@
+Copyright (c) 2012 De Marque inc.
+
+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.md

@@ -0,0 +1,118 @@
+Coffee Cup
+===============
+
+Coffee Cup set the foundations of a Rails like structure for your all your CoffeeScript code.
+
+Problem
+-------
+
+There's currently no convention to structure the CoffeeScript code. The directory /assets/javascripts
+can quickly become a mess and after a while it become really hard to identify which file are used in
+which context.
+
+This is where Coffee Cup is coming to the rescue !
+
+It provide a standardize CoffeeScript structure mirror on the rails directories. For each view, you'll
+exactly know what CoffeeScript dependency it has.
+
+Install
+-------
+
+```
+gem install coffee-cup
+```
+
+Rails 3
+-------
+
+In your Gemfile:
+
+```ruby
+gem 'coffee-cup'
+```
+
+Coffee Cup rely on a data attribute inside the body tag to indicate the current controller and action.
+It is required to add to your body tag the following code :
+
+```ruby
+content_tag(:body, "data-coffee-cup" => CoffeeCup.body_data(request)) do
+  # Layout
+end
+
+```
+
+Usage
+-----
+
+Coffee Cup is mainly a directory convention to store your CoffeeScript.
+
+### Basic File Structure
+
+You must first create the following directories :
+
+
+```
+  # In app/assets/javascripts/
+    app
+     |--- helpers
+           |--- application_helpers.coffee
+     |--- views
+
+```
+
+### Helpers
+
+In the application_helpers.coffee
+
+```coffeescript
+@module "ApplicationHelper", ->
+  @initialize = ->
+```
+
+The code in the initialize will be loaded first. You can place all the global helpers of your application
+in this directory and initialize them from the ApplicationHelper#initialize method.
+
+### Views
+
+Inside the views directory, you will place the code for each view. For example, if you have specific code
+for the users_controller#show, you will create the following file.
+
+```coffeescript
+# /app/assets/javascripts/app/views/users/show.coffee
+@view "Users.Show",
+  constructor: -> # Insert your code for the Users Show action.
+```
+
+This code will only be executed when the Users Show action is called.
+
+### Partials
+
+Sometimes the same block of codes need to be shared between differents actions. To solve this situation,
+you have access to a ```render``` method.
+
+For example, if you need the same code inside the Users New and Edit, let's say for a form. You could do
+the following :
+
+```coffeescript
+# /app/assets/javascripts/app/views/users/new.coffee
+@view "Users.New",
+  constructor: -> @render 'users/form'
+```
+
+```coffeescript
+# /app/assets/javascripts/app/views/users/edit.coffee
+@view "Users.Edit",
+  constructor: -> @render 'users/form'
+```
+
+```coffeescript
+# /app/assets/javascripts/app/views/users/_form.coffee
+@view "Users.Form",
+  constructor: -> # This code will be shared between the New and Edit actions.
+```
+
+
+Copyright
+---------
+
+Copyright (c) 2012 De Marque inc. See LICENSE for further details.

data/Rakefile

@@ -0,0 +1,2 @@
+require 'bundler'
+Bundler::GemHelper.install_tasks

data/app/assets/javascripts/coffee_cup/base.coffee

@@ -0,0 +1,19 @@
+@module = (names, fn) ->
+  names = names.split '.' if typeof names is 'string'
+  space = @[names.shift()] ||= {}
+  space.module ||= @module
+  if names.length
+    space.module names, fn
+  else
+    fn.call space
+
+
+@view = (names, obj) ->
+  names = names.split '.'
+  className = names[names.length - 1]
+  namespace = names[0..names.length-2]
+
+  @module "Views.#{namespace.join('.')}", ->
+    @[className] = class extends ActionView
+      if obj.constructor then constructor: obj.constructor
+      @::[key] = value for key, value of obj when key isnt 'constructor'

data/app/assets/javascripts/coffee_cup/controllers/application_controller.coffee

@@ -0,0 +1,23 @@
+#*************************************************************************************
+# Application Controller
+#*************************************************************************************
+class ApplicationController
+  #*************************************************************************************
+  # PUBLIC INSTANCE METHODS
+  #*************************************************************************************
+  loadHelpers: -> ApplicationHelper.initialize()
+
+  loadView: ->
+    if $('body').data('coffee-cup')
+      CoffeeCup.renderView $('body').data('coffee-cup').split('#').join('.')
+    else
+      alert 'Coffee Cup : Installation incomplete. Please insert the body attribute "data-coffee-cup". See documentation for more details.'
+
+
+#*************************************************************************************
+# When the document is ready, it will load the appropriate objects
+#*************************************************************************************
+$ ->
+  controller = new ApplicationController
+  controller.loadHelpers()
+  controller.loadView()

data/app/assets/javascripts/coffee_cup/helpers.coffee

@@ -0,0 +1,14 @@
+@module "CoffeeCup", ->
+  @camelize = (str) ->
+    str = str.toLowerCase()
+    str = (part.charAt(0).toUpperCase() + part.slice(1) for part in str.split('/')).join('.')
+    str = (part.charAt(0).toUpperCase() + part.slice(1) for part in str.split('_')).join('')
+
+    return str
+
+
+  @renderView = (path) ->
+    instanceName = CoffeeCup.camelize($('body').data('instance'))
+
+    try eval("new Views.#{path}")
+    try eval("new Views.#{instanceName}.#{path}")

data/app/assets/javascripts/coffee_cup/index.js

@@ -0,0 +1,4 @@
+//= require ./base
+//= require ./helpers
+//= require_tree ./controllers
+//= require_tree ./views

data/app/assets/javascripts/coffee_cup/views/base.coffee

@@ -0,0 +1,27 @@
+@module "ApplicationHelper", ->
+
+class @ActionView
+  #*************************************************************************************
+  # ALIASES
+  #*************************************************************************************
+  h: ApplicationHelper
+
+
+  #*************************************************************************************
+  # PUBLIC INSTANCE METHODS
+  #*************************************************************************************
+  loadPartial: (url, callback, rootTag = '') ->
+    if url.indexOf('?') > 0 then url += '&layout=none' else url += '?layout=none'
+
+    $.get(url, (data) => @receivePartial(data, callback, rootTag))
+
+
+  locale: () -> $('meta[name="content-language"]').attr('content')
+
+
+  receivePartial: (data, callback, rootTag) ->
+    partial = $('<div>' + data + '</div>').find(rootTag).html()
+
+    callback partial
+
+  render: (path) -> CoffeeCup.renderView CoffeeCup.camelize(path)

data/lib/coffee-cup/engine.rb

@@ -0,0 +1,5 @@
+module CoffeeCup
+  class Engine < Rails::Engine
+    #auto wire
+  end
+end

data/lib/coffee-cup.rb

@@ -0,0 +1,7 @@
+require "coffee-cup/engine"
+
+module CoffeeCup
+  def self.body_data(request)
+    request[:controller].camelize + '#' + request[:action].camelize
+  end
+end

data/spec/coffee-cup_spec.rb

@@ -0,0 +1,5 @@
+require 'spec_helper'
+
+describe CoffeeCup do
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,12 @@
+require "rubygems"
+require "bundler/setup"
+
+require 'rspec'
+
+require File.expand_path('../../lib/coffee-cup', __FILE__)
+
+Dir["#{File.dirname(__FILE__)}/support/**/*.rb"].each { |f| require f }
+
+RSpec.configure do |config|
+  config.mock_with :rspec
+end

metadata

@@ -0,0 +1,96 @@
+--- !ruby/object:Gem::Specification
+name: coffee-cup
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Sebastien Rosa
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-04-30 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: &2151892760 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 0.8.7
+  type: :development
+  prerelease: false
+  version_requirements: *2151892760
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: &2151891960 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: *2151891960
+- !ruby/object:Gem::Dependency
+  name: metrical
+  requirement: &2151890920 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 0.1.0
+  type: :development
+  prerelease: false
+  version_requirements: *2151890920
+description: Coffee Cup set the foundations of a Rails like structure for your all
+  your CoffeeScript code.
+email:
+- sebastien@demarque.com
+executables: []
+extensions: []
+extra_rdoc_files:
+- LICENSE
+- README.md
+files:
+- app/assets/javascripts/coffee_cup/base.coffee
+- app/assets/javascripts/coffee_cup/controllers/application_controller.coffee
+- app/assets/javascripts/coffee_cup/helpers.coffee
+- app/assets/javascripts/coffee_cup/index.js
+- app/assets/javascripts/coffee_cup/views/base.coffee
+- lib/coffee-cup/engine.rb
+- lib/coffee-cup.rb
+- spec/coffee-cup_spec.rb
+- spec/spec_helper.rb
+- LICENSE
+- README.md
+- Rakefile
+- Gemfile
+homepage: https://github.com/demarque/coffee-cup
+licenses:
+- MIT
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: coffee-cup
+rubygems_version: 1.8.17
+signing_key: 
+specification_version: 3
+summary: Coffee Cup set the foundations of a Rails like structure for your all your
+  CoffeeScript code.
+test_files: []