ember-konacha-rails 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 59080e2ad04da84928d83f08cad96ceef3fc0af7
+  data.tar.gz: 5e73f9a3edd49bb7d42f36ee2c98e4456b5eec9e
+SHA512:
+  metadata.gz: 84c49116c93ab27703179324260c6e17f52aaffbfcde0c0339d0bfdc61be3163688b018092da2fe21a3056eae0f63bb772c106111053718ebe484e192041e9d0
+  data.tar.gz: 2dbcf67cd4141d73c7fecf7fc58fc2bb97c9442322c2c3ae63c28c9d182c35fcf0b5c18821afc714a86f3ca60b22eac3943e58c644b2e378ea4a45b4a2c3201c

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-konacha-rails.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,203 @@
+# Ember Konacha generators for Rails
+
+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.
+
+An `install` generator is included for initial infrastructure setup!
+
+Configures your Ember app with *Konacha* using a Javascript driver (poltergeist for PhantomJS by default). Adds the basic Konacha infrastructure so you can start writing tests/specs.
+
+Can generate *Konacha* spec-skeletons for:
+
+* models
+* controllers
+* views
+* helpers
+
+Please help provide more skeleton generators or improve the existing ones!!! :)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'ember-konacha-rails', github: 'kristianmandrup/ember-konacha-rails'
+
+And then execute:
+
+    $ bundle
+
+Or (in the near future) install it yourself (from rubygems) as:
+
+    $ gem install ember-konacha-rails
+
+
+To see if the generators are installed:
+
+    $ rails g
+
+Note: or use `$ bundle exec rails g` (to execute in context of current bundled environment)
+
+```
+...
+
+EmberKonacha:
+  ember_konacha:controller_spec
+  ember_konacha:helper_spec
+  ember_konacha:install
+  ember_konacha:model_spec
+  ember_konacha:view_spec
+
+...  
+```
+
+## Usage
+
+Install basic Konacha infrastructure
+
+    $ bundle exec rails g ember_konacha:install
+
+Files that should be generated
+
+```
+vendor/assets/javascripts/sinon.js
+
+spec/javascripts/spec_helper.js.coffee
+spec/javascripts/support/sinon_mvc_mocks.js.coffee
+spec/javascripts/support/koncha_config.js.coffee
+
+spec/javascripts/app/router_spec.js.coffee
+spec/javascripts/app/store_spec.js.coffee
+```
+
+### Run examples 
+
+*Clean run (default settings)*
+
+$ rails g ember_konacha:install
+     gemfile  konacha
+     gemfile  poltergeist
+      create  spec/javascripts/spec_helper.js.coffee
+      create  spec/javascripts/support/konacha_config.js.coffee
+      create  spec/javascripts/support/sinon_mvc_mocks.js
+Trying to download sinon.js (http://sinonjs.org/releases/sinon-1.6.js) ...      
+      vendor  assets/javascripts/sinon.js
+      create  spec/javascripts/app/store_spec.js.coffee
+      create  spec/javascripts/app/router_spec.js.coffee
+        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
+
+MacPorts:
+
+sudo port install phantomjs
+
+See https://github.com/jonleighton/poltergeist
+
+*Install generator was run previously*
+
+```
+$ rails g ember_konacha:install
+   identical  spec/javascripts/spec_helper.js.coffee
+   identical  spec/javascripts/support/konacha_config.js.coffee
+   identical  spec/javascripts/support/sinon_mvc_mocks.js
+   identical  spec/javascripts/app/store_spec.js.coffee
+   identical  spec/javascripts/app/router_spec.js.coffee
+        gsub  app/assets/javascripts/application.js.coffee
+      append  app/assets/javascripts/application.js.coffee
+```
+
+Now run Konacha!
+
+    $ bundle exec rake konacha:run
+
+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:
+
+```javascript
+window.App = Ember.Application.create LOG_TRANSITIONS: true
+
+# Defer App readiness until it should be advanced for either
+# testing or production.
+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.
+
+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!).
+
+### Generate Controller spec
+
+Use the `--type` or `-t` option to specify type of controller (will try to auto-determine otherwise)
+
+    $ rails g ember_konacha:controller_spec login -t base
+
+`spec/javascripts/controllers/login_controller_spec.js.coffee`
+
+    $ rails g ember_konacha:controller User --type object
+
+`spec/javascripts/controllers/user_controller_spec.js.coffee`
+
+    $ rails g ember_konacha:controller_spec Users -t array
+
+`spec/javascripts/controllers/user_controller_spec.js.coffee`
+
+    $ rails g ember_konacha:controller_spec Users
+
+Will autodetect that users is a plural form of user and assume you have an array (resource) controller.
+
+    $ rails g ember_konacha:helper_spec persons 
+
+Will generate an object controller, since persons is not a valid plural form!
+
+### Generate Model spec
+
+    $ rails g ember_konacha:model_spec user
+
+`spec/javascripts/models/user_spec.js.coffee`
+
+### Generate View spec
+
+    $ bundle exec rails g ember_konacha:view_spec NewUser
+
+`spec/javascripts/views/new_user_view_spec.js.coffee`
+
+### Generate Helper spec
+
+    $ rails g ember_konacha:model_spec gravitation
+
+`spec/javascripts/helpers/gravitation_helper_spec.js.coffee`
+
+## Sinon notice
+
+The install generator will attempt to download sinon.js, first via httparty and then try via curl. On any exception it will fall back to just copying _sinon-1.6.0.js_.
+
+Read more on [http://sinonjs.org/] for mocking, stubbing and creating test spies ;)
+
+## Contributing
+
+Please help make it easier for developers tp get started using *Test Driven Development* (or BDD) for Ember with Rails.
+
+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-konacha-rails.gemspec

@@ -0,0 +1,26 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'ember/konacha/rails/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "ember-konacha-rails"
+  spec.version       = Ember::Konacha::Rails::VERSION
+  spec.authors       = ["Kristian Mandrup"]
+  spec.email         = ["kmandrup@gmail.com"]
+  spec.description   = %q{Generate Konacha spec infrastructure for your Ember-Rails apps}
+  spec.summary       = %q{Generate Konacha infrastructure for Ember}
+  spec.homepage      = ""
+  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_dependency "httparty", ">= 0.9"
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+end

data/lib/ember/konacha/rails.rb

@@ -0,0 +1,9 @@
+require "ember/konacha/rails/version"
+
+module Ember
+  module Konacha
+    module Rails
+      # Your code goes here...
+    end
+  end
+end

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

@@ -0,0 +1,7 @@
+module Ember
+  module Konacha
+    module Rails
+      VERSION = "0.1.0"
+    end
+  end
+end

data/lib/generators/ember_konacha/base_helper.rb

@@ -0,0 +1,15 @@
+module EmberKonacha
+  module BaseHelper    
+    def spec_target
+      target_file File.join(folder, "#{file_name}_spec.js.coffee")
+    end
+
+    def target_file path
+      File.join target_dir, path
+    end
+
+    def target_dir
+      "spec/javascripts/app/"
+    end
+  end
+end

data/lib/generators/ember_konacha/controller_spec_generator.rb

@@ -0,0 +1,82 @@
+require 'active_support'
+require 'generators/ember_konacha/base_helper'
+
+module EmberKonacha
+  module Generators
+    class ControllerSpecGenerator < Rails::Generators::NamedBase
+      class_option  :type, type: :string, aliases: ['t'],
+                    desc:   'The type of controller to test',
+                    banner: 'controller type: (array, object, base)'
+
+
+      source_root File.expand_path('../templates', __FILE__)
+
+      def create_controller
+        say "Creating #{type_name} controller spec", :green
+        template "specs/controller/#{type}_controller_spec.js.coffee.erb", spec_target
+      end
+
+      protected
+
+      def type_name
+        article = case type.to_sym
+        when :array, :object
+          "an"
+        else
+          "a"
+        end
+        "#{article} #{type}"
+      end
+
+      def validate_type!
+        unless valid_type? type
+          raise "Invalid Type, must be one of: #{valid_types}, was: #{type}"
+        end
+      end
+
+      include EmberKonacha::BaseHelper
+
+      def folder
+        'controllers'
+      end      
+
+      def model_name
+        "App.#{class_name}"
+      end
+
+      def array_controller_name
+        "App.#{class_name.pluralize}Controller"
+      end
+
+      def controller_name
+        "App.#{class_name}Controller"
+      end
+
+      def valid_type?
+        valid_types.include? type.to_s
+      end
+
+      def valid_types
+        %w{array object base}
+      end
+
+      def type
+        @type ||= resolved_type || options[:type]
+      end
+
+      def resolved_type
+        if options[:type].blank?
+          return is_plural?(name) ? 'array' : 'object'
+        end
+      end
+
+      def is_plural? str
+        str.singularize.pluralize == str
+      end
+
+      def is_singular? str
+        str.pluralize.singularize == str
+      end      
+    end
+  end
+end

data/lib/generators/ember_konacha/helper_spec_generator.rb

@@ -0,0 +1,25 @@
+require 'generators/ember_konacha/base_helper'
+
+module EmberKonacha
+  module Generators
+    class HelperSpecGenerator < Rails::Generators::NamedBase
+      source_root File.expand_path('../templates', __FILE__)
+
+      def create_model
+        template "specs/helper_spec.js.coffee.erb", spec_target
+      end
+
+      protected
+
+      include EmberKonacha::BaseHelper
+
+      def folder
+        'helpers'
+      end      
+
+      def helper_name
+        "App.#{class_name}Helper"
+      end
+    end
+  end
+end

data/lib/generators/ember_konacha/install_generator.rb

@@ -0,0 +1,298 @@
+module EmberKonacha
+  module Generators
+    class InstallGenerator < Rails::Generators::Base
+      class_option  :sinon, type: :string, default: '1.6.0',
+                    desc:   'Sinon version to get',
+                    banner: 'Sinon version'
+
+      class_option  :driver, type: :string, default: 'poltergeist',
+                    desc:   'Javascript driver to use',
+                    banner: 'Javascript driver'
+
+      class_option  :with_index, type: :boolean, default: false,
+                    desc:   'Generate default view files for single page app',
+                    banner: 'Generate html view (index.html)'
+
+      source_root File.expand_path('../templates', __FILE__)
+
+      def do_validations
+        validate_driver!
+        validate_sinon_version! 
+      end
+
+      def add_gems        
+        unless has_gem? 'konacha'
+          gem 'konacha', group: [:development, :test] 
+        end
+
+        has_gem?(js_driver) ? skip_driver : gem(js_driver, group: [:development, :test])
+
+        unless has_gem?('coffee-rails') || !coffee?
+          gem 'coffee-rails'
+        end
+      end
+
+      def create_infra_files
+        infra_files.each do |name|
+          begin
+            coffee_template name
+          rescue
+            js_template name
+          end            
+        end        
+      end
+
+      def create_vendor_files
+        return if has_sinon_file?
+
+        require 'httparty'
+
+        sinon_content = get_remote_file :sinon, sinon_version
+
+        return if has_file? sinon_file_path
+
+        if sinon_content.blank?
+          fallback_sinon!
+        end
+
+        vendor(sinon_path, sinon_content)
+
+      rescue Exception => e
+        say e.message, :red
+        say %Q{Sinon URI access/download error: #{@uri}. 
+Using sinon-1.6.js supplied by this gem ;)}
+        fallback_sinon!
+      end
+
+      def fallback_sinon!
+        template 'vendor/sinon.js', 'vendor/assets/javascripts/sinon.js'
+      end
+
+      def create_spec_files
+        spec_files.each do |name|
+          spec_template name
+        end
+      end
+
+      def add_pre
+        return unless has_file? Rails.root.join(coffee_manifest_file)
+
+        # ensure App is prefixed with window namespace!
+        gsub_file coffee_manifest_file, /[^\.]App =/ do |match|
+          match << "window.App ="
+        end        
+
+        append_to_file coffee_manifest_file do
+          'App.deferReadiness()'
+        end
+      end
+
+      def create_view_files
+        return unless with_index?
+        
+        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'
+      end
+
+
+      def post_install_notice
+        return if skipped_driver?
+
+        say nice(js_driver_notice) , :green
+      end
+
+      protected
+
+      def skip_driver
+        @skipped_driver = true
+      end
+
+      def skipped_driver?
+        @skipped_driver
+      end
+
+      def nice text
+        border + text
+      end
+
+      def border width = 80
+        @border ||= "=" * width + "\n"
+      end
+
+      def coffee?
+        true
+      end
+
+      def has_sinon_file?
+        @has_sinon ||= has_file? sinon_file_path
+      end
+
+      def has_file? path
+        File.exist?(path) && !blank_file?(sinon_file_path)
+      end
+
+      def blank_file? path
+        File.open(path).read.blank?
+      end
+
+      def sinon_file_path
+        Rails.root.join('vendor', sinon_path)
+      end
+
+      def sinon_path
+        "assets/javascripts/sinon.js"
+      end
+
+      def js_driver_notice 
+        case js_driver.to_sym
+        when :poltergeist
+           %q{Note: poltergeist requires you have installed PhantomJS headless JS driver. 
+
+via Homebrew: 
+
+brew install phantomjs
+
+MacPorts: 
+
+sudo port install phantomjs
+
+See https://github.com/jonleighton/poltergeist
+}
+        else
+          %q{Note: Install a suitable Javascript driver for headless js testing.
+
+Google V8: 
+
+gem install therubyracer
+
+Mozilla Rhino (JRuby only) : 
+
+gem install therubyrhino
+}
+        end
+      end
+
+      def has_gem? name
+        gemfile_content =~ /gem\s+('|")#{name}/
+      end
+
+      def gemfile_content
+        @gemfile_content ||= gemfile.read
+      end
+
+      def gemfile
+        @gemfile ||= File.open Rails.root.join('Gemfile'), 'r'
+      end
+
+      def sinon_version
+        @sinon_version ||= options[:sinon]
+      end
+
+      def validate_sinon_version!
+        unless sinon_version =~ /\d\.\d\.\d/
+          say "Invalid sinon version format, must be of the form: x.y.z, f.ex 1.5.2, was: #{sinon_version}", :red
+        end
+      end
+
+      def with_index?
+        options[:with_index]
+      end
+
+      def coffee_manifest_file
+        'app/assets/javascripts/application.js.coffee'
+      end
+
+      def validate_driver! 
+        unless valid_driver? js_driver
+          say "Invalid javascript driver #{js_driver}, must be one of: #{valid_drivers}" , :red
+        end
+      end
+
+      def js_driver
+        options[:driver] || 'poltergeist'
+      end
+
+      def valid_driver? name
+        valid_drivers.include? name.to_s
+      end
+
+      def valid_drivers
+        %w{poltergeist selenium}
+      end
+
+      def spec_template name
+        src_file = File.join 'specs/app', name.to_s
+        target_file = File.join 'app', name.to_s
+        template coffee_filename(src_file), coffee_target_file(target_file)      
+      end
+
+      def spec_files
+        [:store_spec, :router_spec]
+      end      
+
+      def get_remote_file name, version = nil    
+        url = version_it remote_uri[name.to_sym], version
+        @uri = URI url
+        say "Trying to download sinon.js (#{@uri}) ..."
+        response = HTTParty.get @uri
+
+        response.code != "404" ? result.body : nil
+
+      rescue Exception => e
+        empty_directory "vendor/assets/javascripts"
+        command = "curl #{@uri} -o vendor/#{sinon_path}"
+        %x[curl #{@uri} -o vendor/#{sinon_path}]
+      end
+
+      def version_it uri, version = nil
+        return uri if !version
+        uri.sub /VERSION/, version
+      end
+
+      def remote_uri
+        {
+          sinon: 'http://sinonjs.org/releases/sinon-VERSION.js'
+        }
+      end
+
+      def infra_files
+        [:spec_helper, :konacha_config, :sinon_mvc_mocks]
+      end
+
+      def coffee_template name
+        template coffee_filename(name), coffee_target_file(name)
+      end
+
+      def js_template name
+        template js_filename(name), js_target_file(name)
+      end
+
+      def js_target_file name
+        File.join 'spec/javascripts', js_filename(resolved_target name)
+      end
+
+      def coffee_target_file name
+        File.join 'spec/javascripts', coffee_filename(resolved_target name)
+      end
+
+      def resolved_target name
+        resolve_map[name.to_sym] || name
+      end
+
+      def resolve_map
+        {
+          sinon_mvc_mocks: 'support/sinon_mvc_mocks',
+          konacha_config: 'support/konacha_config'
+        }
+      end
+
+      def js_filename name
+        "#{name}.js"
+      end
+
+      def coffee_filename name
+        "#{name}.js.coffee"
+      end
+    end
+  end
+end