mocha_rails 0.0.2 → 0.0.3

data/Readme.md

@@ -10,7 +10,7 @@ It loads [Chai](http://chaijs.com) for assertions, although since Mocha is decou
 use another assertion library if you choose (or even write your own.)
 
 The Mocha interface system allows developers to choose their style of DSL. MochaRails is hardcoded for now to the
-"BDD" interface, but if you want to write in one of the other styles, open an issue and I will make it configurable.
+"BDD" interface, but if you want to write in one of the other styles, please "+1" the open issue to make it configurable.
 
 ## Installation
 
@@ -21,39 +21,42 @@ group :test, :development do
   gem 'mocha_rails'
 end
 ```
+MochaRails includes a convenient install generator that adds a route to `config/routes.rb` and adds a `mocha-suite.js`
+Sprockets manifest file to either `spec/javascripts` or `test/javascripts`.
 
-## Configuration
-
-To access your Mocha test suite at `/mocha`, **you must add** the following line inside your Rails `config/routes.rb`,
-within the block passed to `draw`.
+To install the required configuration, **you must run**:
 
 ```
-mount MochaRails::Engine => "mocha" unless Rails.env.production?
+rails g mocha_rails:install
 ```
 
-There is nothing special about the path `/mocha`, and you can name any path you like,
-as long as it doesn't conflict with any of your existing application paths.
-
-## Adding Mocha Tests
+The generator has a single option, `--mount`, which lets you specify the route to your test suite. The default
+route is `/mocha`.
 
-**You must create** a `mocha-suite.js` or `mocha-suite.js.coffee` Sprockets manifest file in
-one of these locations:
+## Organizing your test files
 
-* `test/javascripts`
+Sprockets will not load two files with the same relative asset path and base name, even if they are located in different directories, such
+as `app/assets/javascripts/example.js` and `test/javascripts/example.js.coffee`. In this example, the test file will
+**not** be loaded.
 
-or
+One solution is to simply give your test files a different name, for example in `test/javascripts/mocha-suite.js`:
 
-* `spec/javascripts`
-
-This directory is also the location for your Mocha tests.
+```
+//= require example
+//= require example-test
+```
 
-Here is a sample `mocha-suite.js.coffee` manifest:
+However, if you prefer to give your test files the same name as your production files, you must then use a different path:
 
 ```
-#= require_tree .
+//= require example
+//= require test/example
 ```
 
-Here is a sample Mocha test including a should assertion, in a file `array-test.js.coffee` located in the same directory or below:
+## Adding a test
+
+To get you started, here is a sample Mocha test with a should style assertion, to be placed in a file
+`test/javascripts/array-test.js.coffee`:
 
 ```
 describe 'Array', ->
@@ -67,7 +70,9 @@ describe 'Array', ->
       @array.indexOf(4).should.equal -1
 ```
 
-Create these files, start your server, and open `http://localhost:3000/mocha`. You should see Mocha's very attractive results page. If you
+## Running
+
+Start your server, and open `http://localhost:3000/mocha`. You should see Mocha's very attractive results page. If you
 see a completely blank page, or an almost blank page with a few zeros in the upper right corner, check your JavaScript console for errors.
 
 ## Credits

data/lib/generators/mocha_rails/install_generator.rb

@@ -0,0 +1,15 @@
+module MochaRails
+  class InstallGenerator < Rails::Generators::Base
+    source_root File.expand_path("../templates", __FILE__)
+
+    class_option :mount, :aliases => '-m', :type => :string, :default => 'mocha', :desc => 'mounts engine at specified MOUNT route'
+
+    desc 'installs mocha_rails into your application'
+    def install    
+      route "mount MochaRails::Engine => '#{options[:mount]}' unless Rails.env.production?"
+
+      test_dir = Dir.exists?(Rails.root.join "spec") ? "spec" : "test"
+      copy_file 'mocha-suite.js', "#{test_dir}/javascripts/mocha-suite.js"
+    end
+  end
+end

data/lib/generators/mocha_rails/templates/mocha-suite.js

@@ -0,0 +1 @@
+//= require_tree .

data/lib/mocha_rails/version.rb

@@ -1,3 +1,3 @@
 module MochaRails
-  VERSION = "0.0.2"
+  VERSION = "0.0.3"
 end

metadata

@@ -1,35 +1,49 @@
---- !ruby/object:Gem::Specification
+--- !ruby/object:Gem::Specification 
 name: mocha_rails
-version: !ruby/object:Gem::Version
-  version: 0.0.2
-  prerelease: 
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 0
+  - 0
+  - 3
+  segments_generated: true
+  version: 0.0.3
 platform: ruby
-authors:
+authors: 
 - Chris smith
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-02-10 00:00:00.000000000Z
-dependencies:
-- !ruby/object:Gem::Dependency
+
+date: 2012-02-11 00:00:00 -07:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
   name: rails
-  requirement: &70223008984560 !ruby/object:Gem::Requirement
+  requirement: &id001 !ruby/object:Gem::Requirement 
     none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 3
+        - 1
+        - 0
+        segments_generated: true
         version: 3.1.0
   type: :runtime
   prerelease: false
-  version_requirements: *70223008984560
-description: MochaRails is a mountable Rails engine that serves a browser-based Mocha
-  test suite, along with your production JavaScript files, via the Asset Pipeline.
-email:
+  version_requirements: *id001
+description: MochaRails is a mountable Rails engine that serves a browser-based Mocha test suite, along with your production JavaScript files, via the Asset Pipeline.
+email: 
 - quartzmo@gmail.com
 executables: []
+
 extensions: []
+
 extra_rdoc_files: []
-files:
+
+files: 
 - app/assets/javascripts/mocha_rails/application.js
 - app/assets/javascripts/mocha_rails/mocha-rails.js
 - app/assets/stylesheets/mocha_rails/application.css
@@ -39,6 +53,8 @@ files:
 - app/views/mocha_rails/tests/index.html.erb
 - config/initializers/mocha_rails.rb
 - config/routes.rb
+- lib/generators/mocha_rails/install_generator.rb
+- lib/generators/mocha_rails/templates/mocha-suite.js
 - lib/mocha_rails/engine.rb
 - lib/mocha_rails/version.rb
 - lib/mocha_rails.rb
@@ -80,38 +96,43 @@ files:
 - test/integration/navigation_test.rb
 - test/mocha_rails_test.rb
 - test/test_helper.rb
+has_rdoc: true
 homepage: https://github.com/quartzmo/mocha_rails
 licenses: []
+
 post_install_message: 
 rdoc_options: []
-require_paths:
+
+require_paths: 
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement
+required_ruby_version: !ruby/object:Gem::Requirement 
   none: false
-  requirements:
-  - - ! '>='
-    - !ruby/object:Gem::Version
-      version: '0'
-      segments:
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3955539576298480198
+      segments: 
       - 0
-      hash: 3400645887190348863
-required_rubygems_version: !ruby/object:Gem::Requirement
+      segments_generated: true
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
   none: false
-  requirements:
-  - - ! '>='
-    - !ruby/object:Gem::Version
-      version: '0'
-      segments:
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3955539576298480198
+      segments: 
       - 0
-      hash: 3400645887190348863
+      segments_generated: true
+      version: "0"
 requirements: []
+
 rubyforge_project: 
-rubygems_version: 1.8.13
+rubygems_version: 1.3.7
 signing_key: 
 specification_version: 3
-summary: Integrates the Mocha JavaScript test framework with the Rails (>= 3.1) Asset
-  Pipeline.
-test_files:
+summary: Integrates the Mocha JavaScript test framework with the Rails (>= 3.1) Asset Pipeline.
+test_files: 
 - test/dummy/app/assets/javascripts/application.js
 - test/dummy/app/assets/stylesheets/application.css
 - test/dummy/app/controllers/application_controller.rb