ember-konacha-rails 0.1.1 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 8b7440a8b9e2d5fa3b2be784ef9ce5e6774a5b3b
-  data.tar.gz: db2679be97f99263ae2e5612f09f7886bcb4dbbc
+  metadata.gz: 417711f4a932963803b19dce898cfca5f0e020ad
+  data.tar.gz: c24adee490dee6614c5a173c863e8a32a2a1fd70
 SHA512:
-  metadata.gz: 6000dacbf3deaa0f89334a1eb52008497397546f1c1324fef762f31814ed2795cf007f8ea040891c7ea41232ad977c39a7d7976a0f4b8d093779713347b327ae
-  data.tar.gz: 2cd178e88be693a03de798be0efc619a50580c15a1202d68d0d9ff49356376e3f1fffdd1a916b27f6d3d6d1b5b4a57b9a0c1eab19a5bec83c1f3099fee954fd1
+  metadata.gz: ecbf799670c97f937fc638bd6729fe70090a01e20a94c84c2f94878ee09aaf251de88473c15069ccb18ebec2ea574c0dba483785cab2f81233b0b90b5357780f
+  data.tar.gz: 8ebf08d5b905d88f23d97804881f76d03b86dd1bb16d525fd4d02d3722b4580fa97845e87896baea629698a297eab4acbde02aa589e9eac71acea67328eb9bd2

data/EmberStructure.md

@@ -0,0 +1,129 @@
+## Ember app structure
+
+Proposed (recommended) app structure for large Ember app.
+
+```
+
+  - application.js
+
+  + app
+    - _loader.js
+    + authentication
+      + mixins  
+
+    + config
+      + locales
+      - 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
+    - config.js
+    - controllers.js
+    - router.js
+    - helpers.js
+    - lib.js
+    - mixins.js
+    - models.js
+    - views.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/_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/_loader_.js
+
+Responsible for loading all the Ember app files
+
+```javascript
+# 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 templates
+
+#= require state_managers
+#= require authentication
+#= require router
+
+```
+
+## 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.
+
+```javascript
+# models.js
+#= require_tree ./models/mixins
+#= require_tree ./models
+```
+
+And so on ...
+

data/README.md

@@ -2,8 +2,6 @@
 
 Generators to help setup an [ember-rails](https://github.com/emberjs/ember-rails) app with [konacha](https://github.com/jfirebaugh/konacha) testing.
 
-PS: Still young and under development... Please help improve it :)
-
 ## What?
 
 This gem has the stated goal of making it _easy_ to setup a good testing infrastructure for testing your *Ember-Rails* apps.
@@ -36,7 +34,7 @@ You can find more generators/scaffolders as part of [ember-tools](https://github
 
 Add this line to your application's Gemfile:
 
-    gem 'ember-konacha-rails', github: 'kristianmandrup/ember-konacha-rails'
+    gem 'ember-konacha-rails'
 
 And then execute:
 
@@ -46,7 +44,6 @@ Or install it yourself (from rubygems) as:
 
     $ gem install ember-konacha-rails
 
-
 To see if the generators are installed:
 
     $ rails g
@@ -89,6 +86,7 @@ spec/javascripts/app/store_spec.js.coffee
 
 *Clean run (default settings)*
 
+```
 $ rails g ember_konacha:install
      gemfile  konacha
      gemfile  poltergeist
@@ -102,15 +100,17 @@ Trying to download sinon.js (http://sinonjs.org/releases/sinon-1.6.js) ...
         gsub  app/assets/javascripts/application.js.coffee
       append  app/assets/javascripts/application.js.coffee
 ================================================================================
+```
+
 Note: poltergeist requires you have installed PhantomJS headless JS driver.
 
 via Homebrew:
 
-brew install phantomjs
+    brew install phantomjs
 
 MacPorts:
 
-sudo port install phantomjs
+    sudo port install phantomjs
 
 See https://github.com/jonleighton/poltergeist
 
@@ -131,9 +131,16 @@ Now run Konacha!
 
     $ bundle exec rake konacha:run
 
+To run specs in browser
+
+    $ bundle exec rake konacha:serve
+    $ open http://localhost:3500
+
 See more run options at https://github.com/jfirebaugh/konacha
 
-Note: make sure that the following is at the end of your `application.js.coffee` file:
+## Notice
+
+Make sure that the following is at the end of your `application.js.coffee` file (or similar for pure javascript):
 
 ```javascript
 window.App = Ember.Application.create LOG_TRANSITIONS: true
@@ -143,17 +150,24 @@ window.App = Ember.Application.create LOG_TRANSITIONS: true
 App.deferReadiness()
 ```
 
-(or similar for pure javascript)
-
 The basic test setup/configuration can be found in `support/koncha_config.js.coffee` and `spec_helper.js.coffee` files.
 
-The `spec_helper` initializes the app explicitly using `App.advanceReadiness()` within `Ember.run` in the `beforeEach` closure. To run your app in the browser, while also allowing for testing, you need to explicitly call `App.advanceReadiness()` when your DOM is ready.
+The `spec_helper` initializes the app explicitly using `App.advanceReadiness()` within `Ember.run` in the `beforeEach` closure. To run your app in the browser, while also allowing for testing, you need to explicitly call `App.advanceReadiness()`, f.ex  when your DOM is ready.
+
+```javascript
+$ ->
+  App.advanceReadiness()
+```
+
+If you run the `install` generator with the `--with-index` option on, it will attempt to generate a standard application layout and index view file, with this all setup for you (using slim templating language!)
+
+### Install options
 
 To see install options, run:
 
     $ rails g ember_konacha:install --help
 
-Note: To avoid having to `bundle exec` install the gem in your current system gem repository, using `gem install ember_konacha` (when this is an official gem!).
+Note: To avoid having to `bundle exec` install the gem in your current system gem repository, use `gem install ember_konacha` (when this is an official gem!).
 
 ## Guard Koncha config generator
 
@@ -203,7 +217,7 @@ Will generate an object controller, since persons is not a valid plural form!
 
 ### Generate Helper spec
 
-    $ rails g ember_konacha:model_spec gravitation
+    $ rails g ember_konacha:helper_spec gravitation
 
 `spec/javascripts/helpers/gravitation_helper_spec.js.coffee`
 
@@ -213,6 +227,51 @@ The install generator will attempt to download sinon.js, first via httparty and
 
 Read more on [http://sinonjs.org/] for mocking, stubbing and creating test spies ;)
 
+### Application structure
+
+A proposed [Ember App structure](https://github.com/kristianmandrup/ember-konacha-rails/EmberStructure.md) is included for reference.
+
+### Ember::ResourceController
+
+An `Ember::ResourceController` module is now included, which contains utility methods for setting up the Controller actions to respond wth JSON resources. 
+To use it:
+
+```ruby
+require 'ember/resource_controller'
+
+class User
+  include Ember::ResourceController
+
+  # optional: overrides auto-detection via Controller name convention
+  resource :user
+end
+```
+
+Generates controller actions methods:
+
+```ruby
+class UsersController
+  def index
+    render_json users
+  end
+
+  def show
+    render_json user
+  end
+
+  def destroy    
+    render_json user.destroy
+  end
+
+  def update        
+    render_json user.update(user_params)
+  end
+
+  def create    
+    render_json user.save
+  end
+```
+
 ## Contributing
 
 Please help make it easier for developers tp get started using *Test Driven Development* (or BDD) for Ember with Rails.
@@ -222,3 +281,5 @@ Please help make it easier for developers tp get started using *Test Driven Deve
 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
+
+Note: This gem could really use some specs ;) Please help out!

data/ember-konacha-rails.gemspec

@@ -20,6 +20,7 @@ Gem::Specification.new do |spec|
 
   spec.add_dependency "rails", ">= 3.1"
   spec.add_dependency "httparty", ">= 0.9"
+  spec.add_dependency "konacha"
 
   spec.add_development_dependency "bundler", "~> 1.3"
   spec.add_development_dependency "rake"

data/lib/ember/konacha/rails/version.rb

@@ -1,7 +1,7 @@
 module Ember
   module Konacha
     module Rails
-      VERSION = "0.1.1"
+      VERSION = "0.2.0"
     end
   end
 end

data/lib/ember/resource_controller.rb

@@ -0,0 +1,86 @@
+module Ember
+end
+
+module Ember::ResourceController
+  def self.plural_actions
+    [:index]
+  end
+
+  def self.singular_actions
+    [:show, :destroy, :update, :create]
+  end
+
+  def self.resource name
+    @resource_name = name
+  end
+
+  def index
+    render_json all_resources    
+  end
+
+  def show
+    render_json single_resource
+  end
+
+  def destroy    
+    render_json single_resource.destroy
+  end
+
+  def update        
+    render_json single_resource.update(params)
+  end
+
+  def create    
+    render_json single_resource.save
+  end
+
+  protected
+
+  def render_json data, opts = {}
+    render json: data, opts
+  end
+
+  def new_resource
+    @new_resource ||= resource_class.new params
+  end
+
+  def all_resources
+    resource_class.all.to_a
+  end
+
+  def resource
+    @resource ||= resource_class.find resource_id
+  end
+
+  def resource_id
+    params[:id]
+  end
+
+  def params
+    params[resource_name.to_sym]
+  end 
+
+  def controller_resource_name
+    @@resource_name || this.clazz.to_s.gsub(/Controller$/, '').demodulize
+  end
+
+  def resource_class
+    resource_class_name.constantize
+  end
+
+  def resource_class_name
+    controller_resource_name.camelize
+  end
+
+  def resource_name
+    @@resource_name || controller_resource_name.singularize
+  end
+
+  def single_resource
+    send resource_name.singularize
+  end
+
+  def all_resources
+    send  resource_name.pluralize
+  end
+end

data/lib/generators/ember_konacha/install_generator.rb

@@ -1,4 +1,5 @@
 require 'generators/ember_konacha/gem_helper'
+require 'generators/ember_konacha/setup_guide'
 
 module EmberKonacha
   module Generators
@@ -15,6 +16,10 @@ module EmberKonacha
                     desc:   'Generate default view files for single page app',
                     banner: 'Generate html view (index.html)'
 
+      class_option  :guide, type: :boolean, default: false,
+                    desc:   'Display a brief Ember Rails setup guide',
+                    banner: 'Display setup guide'
+
       source_root File.expand_path('../templates', __FILE__)
 
       def do_validations
@@ -93,12 +98,30 @@ Using sinon-1.6.js supplied by this gem ;)}
 
       def create_view_files
         return unless with_index?
+
+        gem 'slim' unless has_gem? 'slim'
         
-        copy_file 'spec/views/layouts/application.html.slim', 'app/views/layouts/application.html.slim'
-        copy_file 'spec/views/application/index.html.slim', 'app/views/application/index.html.slim'
+        draw_border
+        say "Creating application index file and layout (slim)", :green
+
+        copy_file 'views/layouts/application.html.slim', 'app/views/layouts/application.html.slim'
+        copy_file 'views/application/index.html.slim',   'app/views/application/index.html.slim'
+
+        bundle_gems!
       end
 
+      def setup_guide
+        return unless guide?
 
+        draw_border
+        say %q{You might consider using RailsAPI (gem 'rails-api') for the REST API routes
+The root route should go through a normal Rails controller (< ActionController::Base)
+}, :green
+        
+        draw_border
+        say setup_example, :green
+      end        
+    
       def post_install_notice
         return if skipped_driver?
 
@@ -107,14 +130,11 @@ Using sinon-1.6.js supplied by this gem ;)}
 
       protected
 
+      include EmberKonacha::SetupGuide
       include EmberKonacha::GemHelper
 
-      def skip_driver
-        @skipped_driver = true
-      end
-
-      def skipped_driver?
-        @skipped_driver
+      def draw_border width = 80
+        say border(width), :green
       end
 
       def nice text
@@ -125,6 +145,14 @@ Using sinon-1.6.js supplied by this gem ;)}
         @border ||= "=" * width + "\n"
       end
 
+      def skip_driver
+        @skipped_driver = true
+      end
+
+      def skipped_driver?
+        @skipped_driver
+      end
+
       def coffee?
         true
       end

data/lib/generators/ember_konacha/setup_guide.rb

@@ -0,0 +1,60 @@
+module EmberKonacha
+  module SetupGuide
+    def guide?
+      options[:guide]
+    end
+
+    def setup_example
+      %Q{#{routes_ex}
+#{base_controllers_ex}
+}
+    end
+
+    def routes_ex
+      %q{
+# Using 'sweet_routing' gem API
+
+EmberRailsAPI::Application.routes.draw do
+
+  app_root 'application#index'
+  
+  json_resource :users, :except => :edit
+end
+}
+    end    
+
+    def base_controllers_ex
+      %q{
+# Only for root page 
+class ApplicationController < ActionController::Base
+  protect_from_forgery
+
+  def index
+  end
+end
+
+# Base class for all REST API controllers used with Ember
+class APIController < ActionController::API
+end
+
+# Authorization controller
+class AuthController < APIController
+  helper_method :current_user_json
+
+  rescue_from CanCan::AccessDenied do |exception|
+    redirect_to root_path, :alert => exception.message
+  end
+
+  # Perhaps check out ActiveSerializer CanCan
+  def current_user_json
+    if current_user
+      UserSerializer.new(current_user, :scope => current_user, :root => false).to_json
+    else
+      {}.to_json
+    end
+  end
+end
+}
+    end
+  end
+end

data/lib/generators/ember_konacha/templates/spec_helper.js.coffee

@@ -2,7 +2,7 @@
 #= require sinon
 
 # Load all testing support files
-#= require_tree support
+#= require_tree ./support
 
 #= require application
 
@@ -38,29 +38,29 @@ window.T = Test
 Konacha.reset = Ember.K
 
 beforeEach( (done) ->
-    # Fake XHR
-    window.server = TestUtil.fakeServer()
+  # Fake XHR
+  window.server = TestUtil.fakeServer()
 
-    # Prevent automatic scheduling of runloops. For tests, we
-    # want to have complete control of runloops.
-    Ember.testing = true
+  # Prevent automatic scheduling of runloops. For tests, we
+  # want to have complete control of runloops.
+  Ember.testing = true
 
-    # reset all test variables!
-    window.Test = {}
+  # reset all test variables!
+  window.Test = {}
 
-    Ember.run( ->
-      # Advance App readiness, which was deferred when the app
-      # was created.
+  Ember.run( ->
+    # Advance App readiness, which was deferred when the app
+    # was created.
 
-      # This needs to be done here, after each iframe has been setup,
-      # instead of in a global `before`.
-      App.advanceReadiness()
+    # This needs to be done here, after each iframe has been setup,
+    # instead of in a global `before`.
+    App.advanceReadiness()
 
-      # When App readiness promise resolves, setup is complete
-      App.then( ->
-        done()
-      )
+    # When App readiness promise resolves, setup is complete
+    App.then( ->
+      done()
     )
+  )
 )
 
 afterEach( ->
@@ -74,4 +74,4 @@ afterEach( ->
 
   # Restore XHR
   window.server.restore()
-)
+)

data/lib/generators/ember_konacha/templates/specs/controller/array_controller_spec.js.coffee.erb

@@ -1,6 +1,6 @@
 #= require spec_helper
 
-describe "#{array_controller_name}", ->
+describe "<%= array_controller_name %>", ->
   beforeEach( ->
     Test.store = TestUtil.lookupStore()
 
@@ -11,13 +11,13 @@ describe "#{array_controller_name}", ->
         {id: 3, name: 'Zeus'},
       ])
 
-      controller = <%= controller_name %>.create()
+      controller = <%= array_controller_name %>.create()
       controller.set 'content', Test.store.findMany(<%= model_name %>, [1, 2, 3])
     )
   )
 
   it "displays items", ->
-    assert.equal  controller.get('length'), 3)
+    assert.equal  controller.get('length'), 3
     assert.equal  controller.objectAt(0).get('id'), '3'
     assert.equal  controller.objectAt(1).get('id'), '2'
     assert.equal  controller.objectAt(2).get('id'), '1'

data/lib/generators/ember_konacha/templates/specs/controller/base_controller_spec.js.coffee.erb

@@ -1,6 +1,6 @@
 #= require spec_helper
 
-describe "#{base_controller_name}", ->
+describe "<%= controller_name %>", ->
   beforeEach( ->
     # Init store
     Test.store = Util.lookupStore()

data/lib/generators/ember_konacha/templates/specs/model_spec.js.coffee.erb

@@ -12,13 +12,13 @@ describe "<%= model_name %>", ->
   describe "attribute: name", ->
     it "can be created with valid value", ->
       Ember.run( ->
-        Test.contact = <%= model_name %>.createRecord name: 'Joe'
+        Test.contact = Test.store.createRecord '<%= class_name.downcase %>', name: 'Joe'
       )
       expect(Test.contact.get 'name').to.equal 'Joe'
 
     it "can NOT be created with invalid value", ->
       Ember.run( ->
-        Test.contact = <%= model_name %>.createRecord name: '123'
+        Test.contact = Test.store.createRecord '<%= class_name.downcase %>', name: '123'
       )
       expect(Test.contact.get 'name').to.not.equal 'Joe'
       expect(Test.contact.isValid).to.be false

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ember-konacha-rails
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.2.0
 platform: ruby
 authors:
 - Kristian Mandrup
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-04-04 00:00:00.000000000 Z
+date: 2014-04-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -38,6 +38,20 @@ dependencies:
     - - '>='
       - !ruby/object:Gem::Version
         version: '0.9'
+- !ruby/object:Gem::Dependency
+  name: konacha
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -74,6 +88,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - .gitignore
+- EmberStructure.md
 - Gemfile
 - LICENSE.txt
 - README.md
@@ -81,6 +96,7 @@ files:
 - ember-konacha-rails.gemspec
 - lib/ember/konacha/rails.rb
 - lib/ember/konacha/rails/version.rb
+- lib/ember/resource_controller.rb
 - lib/generators/ember_konacha/base_helper.rb
 - lib/generators/ember_konacha/controller_spec_generator.rb
 - lib/generators/ember_konacha/gem_helper.rb
@@ -88,6 +104,7 @@ files:
 - lib/generators/ember_konacha/helper_spec_generator.rb
 - lib/generators/ember_konacha/install_generator.rb
 - lib/generators/ember_konacha/model_spec_generator.rb
+- lib/generators/ember_konacha/setup_guide.rb
 - lib/generators/ember_konacha/templates/.DS_Store
 - lib/generators/ember_konacha/templates/Guard_konacha.erb
 - lib/generators/ember_konacha/templates/konacha_config.js.coffee