ember-big_project 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 4dbe5da8f8775543a80386bb8ecc591284cd0d73
+  data.tar.gz: f8599b292f35ec98bf093249f0066c0b9d9fad9a
+SHA512:
+  metadata.gz: 4980b42384541d6175c8635d54cefacb82d3bf56243802580d0d7c7505581be5a3cb4d3f8bca84a71228ef9b93a2357d0f4acfea20a55438040db808967505aa
+  data.tar.gz: 028698a4654fb6bf7abd0816615470da20417033e93a8ea14f551a56bce6e2f3168fcf9de7435203d4e725ccc9a5b1897c259d8f292a5b11c28787788419f17a

data/.gitignore

@@ -0,0 +1,18 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+.DS_Store

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in ember-big_project.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Kristian Mandrup
+
+MIT License
+
+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,208 @@
+# Ember BigProject
+
+Create a sensible and extensible Ember project structure for big projects ;)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'ember-big_project'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install ember-big_project
+
+## Usage
+
+*Important!!*
+
+This bootstrap generators expects that you have set up your Ember project using `ember:bootstrap` or similar generator. Before you execute `ember_proj:bootstrap`, please make sure you have comitted you project to version control, so you go revert in case you need to.
+
+Command:
+
+    $ rails g ember_proj:bootstrap
+
+Help!? (see list of options available):
+
+    $ rails g ember_proj:bootstrap --help
+
+Example: add ember-auth basic authentication and emblem templating ;)
+
+    $ rails g ember_proj:bootstrap --auth ember-auth --emblem
+
+## Ember app structure
+
+Proposed (recommended) app structure for large Ember app.
+
+```
+  - application.js
+
+  + app
+    - app_loader.js
+    + authentication
+      + mixins  
+
+    + config
+      + locales
+      - app.js
+      - locale.js
+      - logging.js
+      - display.js
+
+    + controllers
+      + _mixins
+      + users
+        - user_controller
+        - users_controller
+      - session_controller
+
+    + helpers
+    + lib  
+    + mixins
+
+    + models
+      + extensions
+      + mixins  
+      - user.js  
+
+    + views
+      + extensions
+      + mixins
+      - new_user_view.js
+      - user_view.js
+      - users_view.js
+
+    + routes
+      + helpers
+      + mixins
+      + shortcuts
+      - user_router.js
+      - index_router.js
+
+    + state_managers
+    + templates
+    - authentication.js
+    - config.js
+    - controllers.js
+    - helpers.js
+    - lib.js
+    - mixins.js
+    - models.js
+    - views.js
+    - routes.js
+    - state_managers.js
+    - templates.js
+```
+
+## application.js
+
+```
+# application.js
+
+#= require modernizr
+#= require jquery
+#= require handlebars
+#= require ruby
+#= require ember
+#= require ember-data
+#= require ember-data-validations
+#= require ember-formBuilder
+#= require bootstrap
+
+#= require app/app_loader
+
+#= require rails.validations
+#= require rails.validations.ember
+
+window.App = Ember.Application.create LOG_TRANSITIONS: true
+
+# Defer App readiness until it should be advanced for either
+# testing or production.
+App.deferReadiness()
+
+```
+
+## app/app_loader_.js
+
+Responsible for loading all the Ember app files
+
+```javascript
+# app/app_loader_.js
+
+#= require_self
+
+#= require_tree lib
+#= require_tree mixins
+#= require_tree helpers
+#= require_tree config
+
+#= require store
+#= require models
+#= require controllers
+#= require views
+
+#= require state_managers
+#= require authentication
+#= require routes
+
+```
+
+## models.js
+
+Index files such as 'models.js' are useful in order to quickly change the load order of files or add/remove files to be included in the app ;)
+
+You will likley have specific mixins for models, that should be loaded before the models they are mixed into - the reason for this pattern.
+
+You can then make custom extensions to your models, after they have applied whatever mixins they need or directly extend built-in Ember classes ;)
+
+```javascript
+# models.js
+#= require_tree models/mixins
+#= require_tree models
+#= require_tree models/extensions
+```
+
+And so on ...
+
+## Vendor libs included
+
+These vendor libs can be required directly in your `application.js.coffee`. 
+
+Alternatively create a `vendor.js.coffee` which you require from `application.js.coffee`. 
+
+Note: Some vendor libs will need to be required after `require app/app_loader`, if they hook into the Application classes you have defined (f.ex `rails.validations.ember` lib).
+
+* [ember-formbuilder](https://github.com/luan/ember-formbuilder)
+* [ember-easyForm](https://github.com/dockyard/ember-easyForm)
+* [ember-validations](https://github.com/dockyard/ember-validations)
+* [ember-data-validations](https://github.com/Myslik/ember-data-validations)
+
+See also: [formBuilder](http://luansantos.com/2012/03/19/introducing-ember-formbuilder/)
+
+Distros:
+
+* [validations](https://github.com/dockyard/ember-builds/tree/master/validations)
+* [easyForm](https://github.com/dockyard/ember-builds/tree/master/easyForm)
+
+
+If you find one or more of these vendor libs are outdated, please make a patch with the updated lib and send me a pull request! Thanks :)
+
+## Test setup
+
+For easy test setup of your project, try using the [ember-konacha-rails](https://github.com/kristianmandrup/ember-konacha-rails) gem ;)
+
+TODO: In the future Test setup is likely to be integrated directly in this gem!
+
+Also look at [ember-tools](https://github.com/rpflorence/ember-tools) for more tooling!!
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/ember-big_project.gemspec

@@ -0,0 +1,25 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'ember/big_project/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "ember-big_project"
+  spec.version       = Ember::BigProject::VERSION
+  spec.authors       = ["Kristian Mandrup"]
+  spec.email         = ["kmandrup@gmail.com"]
+  spec.description   = %q{Configure Rails assets structure for a big Ember project}
+  spec.summary       = %q{Creates a more refined Ember project structure}
+  spec.homepage      = "https://github.com/kristianmandrup/ember-big_project"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "rails", ">= 3.1"
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+end

data/lib/ember/big_project.rb

@@ -0,0 +1,7 @@
+require "ember/big_project/version"
+
+module Ember
+  module BigProject
+    # Your code goes here...
+  end
+end

data/lib/ember/big_project/version.rb

@@ -0,0 +1,5 @@
+module Ember
+  module BigProject
+    VERSION = "0.0.1"
+  end
+end

data/lib/generators/ember_proj/bootstrap_generator.rb

@@ -0,0 +1,291 @@
+require 'generators/ember_proj/gem_helper'
+require 'fileutils'
+
+module EmberProj
+  module Generators
+    class BootstrapGenerator < Rails::Generators::Base
+      class_option :csv, type: :boolean, default: false,
+                   desc: 'Add client side validations integration'
+
+      class_option :emblem, type: :boolean, default: false,
+                   desc: 'Use Emblem templates (like slim)'
+
+      class_option :auth, type: :array, default: [],
+                   desc: 'Authentication libraries to use (oauth2, auth)'
+
+      class_option :bundle, type: :boolean, default: false,
+                   desc: 'Do not bundle gems unless absolutely required!'
+
+      TPL_PATH = File.expand_path('../templates', __FILE__)
+
+      source_root TPL_PATH
+
+      def skeleton
+        directory "app", "app/assets/javascripts/app", recursive: true
+
+        app_directories.each do |app_dir|
+          src = "app/#{app_dir}"
+          target = "app/assets/javascripts/app/#{app_dir}"
+
+          directory src, target, recursive: true
+
+          sub_dirs.each do |sub_dir|
+            sub_src = File.join(src, sub_dir)
+
+            full_sub_path = File.join(TPL_PATH, sub_src)
+
+            if File.directory? full_sub_path
+              sub_target = File.join(target, sub_dir)
+              directory sub_src, sub_target, recursive: true 
+            end
+          end
+        end
+
+        copy_file "application.js.coffee", (js_path(application) + '.coffee')
+      end
+
+      def move_ember_files
+        say "Moving existing ember files...", :green
+        move_to_app 'views/application_view', 'controllers/application_controller'
+        move 'store', 'app/stores/store'
+        move 'router', 'app/routes/router'
+
+        # remove default application.js file 
+        # replaced by coffee version supplied by this gem!
+        say "Cleanup...", :green
+
+        if File.exist? Rails.root.join js_path('.js/.coffee')
+          # Somehow I can't seem to get rid of this file!!!
+          remove_file js_path('.js/.coffee')
+        end
+
+        if File.exist? Rails.root.join js_path('.js/.coffee')
+          # remove old application.js manifest
+          remove_file js_path('application')
+        end
+      end
+
+      def authentications
+        return if auth.blank?
+
+        validate_auth! 
+        use_auth_gems.each do |name|
+          auth_notice name
+
+          gem name unless has_gem? name
+        end
+      end
+
+      def emblem
+        return unless emblem?
+        gem 'emblem-rails' unless has_gem? 'emblem-rails'
+
+        say "Note: Emblem templates have the form: my_template.js.emblem", :green
+      end
+
+      def client_side_validations
+        return unless csv?
+        gem 'client_side_validations' unless has_gem? 'client_side_validations'
+        gem 'client_side_validations-ember' unless has_gem? 'client_side_validations-ember'
+      end
+
+      def bundle_all
+        if csv?
+          bundle_gems!
+          invoke "client_side_validations:ember:install" 
+        else
+          bundle_gems! if bundle?
+        end
+      end        
+
+      def notices
+        draw_border :thick
+        auth_notices!
+        extras_notice!
+        other_gems_notice!
+      end
+
+      protected
+
+      include EmberProj::GemHelper
+
+      def sub_dirs
+        %w{locales mixins extensions shortcuts}
+      end
+
+      def bundle?
+        options[:bundle]
+      end
+
+      # TODO: allow customization - which to include/exclude!
+      def app_directories
+        %w{authentication config controllers helpers lib mixins models routes state_managers stores templates views}
+      end
+
+      attr_reader :auth_notices
+
+      def auth_notices!
+        if auth_notices.empty?
+          say "Authentication: was not configured", :green
+          return
+        end
+
+        say "Authentication:", :green
+        say auth_notices.join("\n"), :green
+        say ""
+      end
+
+      def auth_notices
+        @auth_notices ||= []
+      end
+
+      def auth_notice name
+        auth_notices << "See: #{auth_repo name} for authentication configuration details"
+      end
+
+      def auth_repo name
+        case name.to_s
+        when 'ember-auth-rails'
+          'https://github.com/heartsentwined/ember-auth-rails'
+        when 'ember-oauth2-rails'
+          'https://github.com/amkirwan/ember-oauth2'
+        else
+          say "Invalid auth gem: #{name}, must be oauth2 or auth", :red
+          exit
+        end
+      end        
+
+      def validate_auth!
+        return if options[:auth].blank?
+
+        if use_auth_gems.empty?
+          say "Not a supported authentication gem: #{auth}. Must be one of #{auth_gems}", :red
+        end
+      end
+
+      def use_auth_gems
+        [auth].flatten & auth_gems
+      end
+
+      def auth
+        @auth ||= options[:auth].map do |name|
+          case name
+          when 'oauth', 'oauth2', 'ember-oauth', 'ember-oauth2'
+            'ember-oauth2-rails'
+          when 'auth', 'ember-auth'
+            'ember-auth-rails'
+          else
+            name
+          end
+        end
+      end
+
+      def auth_gems
+        %w{ember-auth-rails ember-oauth2-rails}
+      end
+
+      def move_to_app *paths
+        paths.flatten.each do |path|
+          move_it! js_path(path), js_app_path(path)
+        end
+      end
+
+      def move src, target
+        src = js_path(src)
+        target = js_path(target)
+
+        move_it! src, target
+      end
+
+      def move_it! src, target
+        return unless File.exist? src
+        
+        say_status :move, "#{src} -> #{target}"
+
+        FileUtils.mv src, target
+      end
+
+      def strip_front path
+        "app/assets" + path.to_s.split(/app\/assets/)[1]
+      end
+
+      def js_app_path path                
+        js_path File.join('app', path)
+      end
+
+      def js_path path
+        path = "#{path}.js" unless path =~ /\.js$/
+        Rails.root.join('app/assets/javascripts', path)
+      end
+
+      def emblem?
+        options[:emblem]
+      end
+
+      def csv?
+        options[:csv]
+      end
+
+      def extras_notice!
+        draw_border
+        say extras_notice, :green
+      end
+
+      def extras_notice
+        %Q{The following extra libs are referenced in this setup: 
+
+  #{join extras}
+
+Include these libs, using respective gems (#{join gems_list}) or the equivalent js files.
+
+Note: You can also remove the libs you don't need from the application.js.coffee manifest
+}        
+      end
+
+      def draw_border type = :thin
+        say border(type), :green
+      end
+
+      def nice text
+        border + text
+      end
+
+      def border type = :thin
+        border_char(type) * border_width + "\n"
+      end      
+
+      def border_char type
+        type == :thick ? "=" : '-'
+      end
+
+      def border_width
+        80
+      end
+
+      def join list
+        list.join ', '
+      end
+
+      def other_gems_notice!
+        draw_border
+        say other_gems_notice, :green
+      end
+
+      def other_gems_notice
+        "Other useful gems: #{other_gems}\n"
+      end
+
+      def other_gems
+        %q{ember-i18n-rails ember-auth-rails ember-oauth2-rails ember-bootstrap-rails}
+      end
+
+      def extras
+        %w{ember-data ember-data-validations ember-formBuilder ember-easyForm bootstrap rails.validations.ember}
+      end
+
+      def gems_list
+        %w{client_side_validations-ember bootstrap-sass ember-rails}
+      end
+    end
+  end
+end