chaplin-on-rails 0.7.0.1

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2013 Mikhail Di
+
+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,42 @@
+# ChaplinOnRails
+
+Gem for using [Chaplin.js](https://github.com/chaplinjs/chaplin) with Rails asset pipeline, based on
+[chaplin-rails](https://github.com/chaplinjs/chaplin-rails) boilerplate project.
+
+Since Chaplin requires module system this gem has
+[requirejs-rails](https://github.com/jwhitley/requirejs-rails) gem
+in dependecy. Those, you're forced to use `requirejs` for your project :)
+
+Gem already comes with `underscore.js` and `backbone.js`.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'chaplin-on-rails', git: 'git://github.com/eicca/chaplin-on-rails.git'
+
+And then execute:
+
+    $ bundle
+
+## Usage
+
+Run
+
+    rails g chaplin:install
+
+It should create basic application structure with some basic files.
+To learn more about this see
+[chaplin-rails](https://github.com/chaplinjs/chaplin-rails).
+
+This gem generates new `application.js.coffee` for you, so you should
+migrate your old `application.js` to `requirejs` config file and remove
+`application.js` file.
+
+Also, there might be a problem with replacing `requirejs_include_tag`.
+Just follow for generator's output instructions.
+
+## TODO
+
+1. Write tests for install generator.
+2. Write generators for scaffold/resource/controller/model.

data/Rakefile

@@ -0,0 +1,38 @@
+#!/usr/bin/env rake
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+begin
+  require 'rdoc/task'
+rescue LoadError
+  require 'rdoc/rdoc'
+  require 'rake/rdoctask'
+  RDoc::Task = Rake::RDocTask
+end
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'ChaplinOnRails'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+
+
+
+Bundler::GemHelper.install_tasks
+
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = false
+end
+
+
+task :default => :test

data/lib/chaplin-on-rails.rb

@@ -0,0 +1,2 @@
+require "chaplin-on-rails/engine"
+require "chaplin-on-rails/version"

data/lib/chaplin-on-rails/engine.rb

@@ -0,0 +1,6 @@
+require 'requirejs-rails'
+
+module ChaplinOnRails
+  class Engine < Rails::Engine
+  end
+end

data/lib/chaplin-on-rails/version.rb

@@ -0,0 +1,3 @@
+module ChaplinOnRails
+  VERSION = "0.7.0.1"
+end

data/lib/generators/chaplin/helpers.rb

@@ -0,0 +1,94 @@
+module Chaplin
+  module Generators
+    module Helpers
+
+      def asset_path
+        File.join('app', 'assets')
+      end
+
+      def javascript_path
+        File.join(asset_path, 'javascripts')
+      end
+
+      def model_path
+        File.join(javascript_path, "models")
+      end
+
+      def view_path
+        File.join(javascript_path, "views")
+      end
+
+      def controller_path
+        File.join(javascript_path, "controllers")
+      end
+
+      def lib_path
+        File.join(javascript_path, "lib")
+      end
+
+      def base_path(path)
+        File.join(path, 'base')
+      end
+
+      def template_path
+        File.join(asset_path, "templates")
+      end
+
+      def singular_file_name
+        "#{file_name.singularize}#{@ext}"
+      end
+
+      def plural_file_name
+        "#{file_name.pluralize}#{@ext}"
+      end
+
+      def router_file_name
+        "#{file_name.pluralize}_router#{@ext}"
+      end
+
+      def view_file_name
+        "#{file_name.pluralize}_index#{@ext}"
+      end
+
+      def model_namespace
+        [app_name, "Models", file_name.singularize.camelize].join(".")
+      end
+
+      def collection_namespace
+        [app_name, "Collections", file_name.pluralize.camelize].join(".")
+      end
+
+      def router_namespace
+        [app_name, "Routers", file_name.pluralize.camelize].join(".")
+      end
+
+      def view_namespace
+        [app_name, "Views", "#{file_name.pluralize.camelize}Index"].join(".")
+      end
+
+      def template_namespace
+        File.join(file_path.pluralize, "index")
+      end
+
+      def app_name
+        rails_app_name.camelize
+      end
+
+      def app_filename
+        rails_app_name.underscore
+      end
+
+      def rails_app_name
+        Rails.application.class.name.split('::').first
+      end
+
+      def layout_path
+        Dir['app/views/layouts/application*'].first
+      end
+
+      def display(output, color = :green)
+        say(" - #{output}", color)
+      end
+    end
+  end
+end

data/lib/generators/chaplin/install/install_generator.rb

@@ -0,0 +1,68 @@
+require 'generators/chaplin/helpers'
+
+module Chaplin
+  module Generators
+    class InstallGenerator < Rails::Generators::Base
+      include Chaplin::Generators::Helpers
+
+      source_root File.expand_path("../templates", __FILE__)
+
+      desc "Generates a Chaplin.js skeleton directory structure and manifest"
+
+      # TODO currently only coffee works
+      #class_option :javascript,
+                    #type: :boolean,
+                    #aliases: "-j",
+                    #default: false,
+                    #desc: "Generate JavaScript"
+
+      def copy_app_boilerplate
+        # it should remove empty directories during 'destroy' command
+        %w(controllers lib models views).each do |dir_name|
+          empty_directory File.join(javascript_path, dir_name)
+        end
+
+        # copy all /javascripts directory
+        directory 'javascripts', javascript_path
+
+        # create empty 'assets/templates' directory
+        empty_directory template_path
+      end
+
+      def generate_app_files
+        template "application.js.coffee", "#{javascript_path}/application.js.coffee"
+        template "app_template.js.coffee", "#{javascript_path}/#{app_filename}.js.coffee"
+      end
+
+      def apply_requirejs
+        # copy config file
+        copy_file 'requirejs.yml', 'config/requirejs.yml'
+
+        # check if we can find layout file
+        # TODO doesn't work during 'destroy' command
+        if layout_path
+          # inject requirejs tag
+          unless gsub_file(layout_path, /javascript_include_tag/, 'requirejs_include_tag')
+            display "Can't find a javascript_include_tag in '#{layout_path}'!"
+            display "You must add 'requirejs_include_tag' instead of 'javascript_include_tag'"
+            display "in your layout(s)."
+          end
+        else
+          display "Can't find a layout to inject requirejs tag!"
+          display "You must add 'requirejs_include_tag' instead of 'javascript_include_tag'"
+          display "in your layout(s)."
+        end
+      end
+
+
+      def post_install_messages
+        if File.exists?("#{javascript_path}/application.js")
+          display "You have 'application.js' file in your 'assets/' folder."
+          display "You should migrate all dependencies to the 'requirejs.yml' config file"
+          display "and remove 'application.js file."
+        end
+      end
+
+    end
+  end
+end

data/lib/generators/chaplin/install/templates/app_template.js.coffee

@@ -0,0 +1,65 @@
+define [
+  'chaplin'
+  'views/layout'
+  'routes'
+  # Require base controllers manually because
+  # they aren’t compiled individually
+  # 'controllers/my_controller'
+], (Chaplin, Layout, routes) ->
+  'use strict'
+
+  # The application object
+  # Choose a meaningful name for your application
+  class <%= app_name %> extends Chaplin.Application
+
+    # Set your application name here so the document title is set to
+    # “Controller title – Site title” (see Layout#adjustTitle)
+    title: '<%= rails_app_name %>'
+
+    initialize: ->
+      super
+
+      # Initialize core components
+      @initDispatcher()
+      @initLayout()
+      @initMediator()
+
+      # Application-specific scaffold
+      @initControllers()
+
+      # Register all routes and start routing
+      @initRouter routes
+      # You might pass Router/History options as the second parameter.
+      # Chaplin enables pushState per default and Backbone uses / as
+      # the root per default. You might change that in the options
+      # if necessary:
+      # @initRouter routes, pushState: false, root: '/subdir/'
+
+      # Freeze the application instance to prevent further changes
+      Object.freeze? this
+
+    # Override standard layout initializer
+    # ------------------------------------
+    initLayout: ->
+      # Use an application-specific Layout class. Currently this adds
+      # no features to the standard Chaplin Layout, it’s an empty placeholder.
+      @layout = new Layout {@title}
+
+    # Instantiate common controllers
+    # ------------------------------
+    initControllers: ->
+      # These controllers are active during the whole application runtime.
+      # You don’t need to instantiate all controllers here, only special
+      # controllers which do not to respond to routes. They may govern models
+      # and views which are needed the whole time, for example header, footer
+      # or navigation views.
+      # e.g. new NavigationController()
+
+    # Create additional mediator properties
+    # -------------------------------------
+    initMediator: ->
+      # Create a user property
+      Chaplin.mediator.user = null
+      # Add additional application-specific properties and methods
+      # Seal the mediator
+      Chaplin.mediator.seal()

data/lib/generators/chaplin/install/templates/application.js.coffee

@@ -0,0 +1,13 @@
+#
+# add '= require hamlcoffee' for hamlcoffee support
+#
+#= require_tree ../templates
+
+# Bootstrap the application
+require [
+  '<%= app_filename %>'
+], (<%= app_name %>) ->
+  'use strict'
+
+  app = new <%= app_name %>()
+  app.initialize()

data/lib/generators/chaplin/install/templates/javascripts/controllers/base/controller.js.coffee

@@ -0,0 +1,8 @@
+define [
+  'chaplin'
+], (Chaplin) ->
+  'use strict'
+
+  class Controller extends Chaplin.Controller
+
+    # Place your application-specific controller features here

data/lib/generators/chaplin/install/templates/javascripts/lib/support.js.coffee

@@ -0,0 +1,19 @@
+define [
+  'underscore'
+  'lib/utils'
+  'chaplin'
+], (_, utils, Chaplin) ->
+
+  # Application-specific feature detection
+  # --------------------------------------
+
+  # Delegate to Chaplin’s support module
+  support = utils.beget Chaplin.support
+
+  # Add additional application-specific properties and methods
+
+  # _(support).extend
+  #   someProperty: 'foo'
+  #   someMethod: ->
+
+  support

data/lib/generators/chaplin/install/templates/javascripts/lib/utils.js.coffee

@@ -0,0 +1,18 @@
+define [
+  'underscore'
+  'chaplin'
+], (_, Chaplin) ->
+
+  # Application-specific utilities
+  # ------------------------------
+
+  # Delegate to Chaplin’s utils module
+  utils = Chaplin.utils.beget Chaplin.utils
+
+  # Add additional application-specific properties and methods
+
+  # _(utils).extend
+  #   someProperty: 'foo'
+  #   someMethod: ->
+
+  utils

data/lib/generators/chaplin/install/templates/javascripts/lib/view_helper.js.coffee

@@ -0,0 +1,16 @@
+define [
+  'chaplin'
+  'lib/utils'
+], (Handlebars, Chaplin, utils) ->
+  'use strict'
+
+  # View helpers (HAML Coffee in this case)
+  # ---------------------------------------
+
+  HAML.globals = ->
+    {
+      #someProperty: 'foo'
+      #someMethod: ->
+    }
+
+  null

data/lib/generators/chaplin/install/templates/javascripts/models/base/collection.js.coffee

@@ -0,0 +1,9 @@
+define [
+  'chaplin'
+], (Chaplin) ->
+
+  class Collection extends Chaplin.Collection
+    # Mixin a synchronization state machine
+    # _(@prototype).extend Chaplin.SyncMachine
+
+    # Place your application-specific collection features here

data/lib/generators/chaplin/install/templates/javascripts/models/base/model.js.coffee

@@ -0,0 +1,9 @@
+define [
+  'chaplin'
+], (Chaplin) ->
+
+  class Model extends Chaplin.Model
+    # Mixin a synchronization state machine
+    # _(@prototype).extend Chaplin.SyncMachine
+
+    # Place your application-specific model features here