marionette_dust 0.0.2 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ba62515c357e66ce29142cabae7c6f674800ca41
-  data.tar.gz: 873fb60e70579279c896668e5bdfd33e3762725c
+  metadata.gz: f7b327b6b68458d0476694b8417306ac159c29fd
+  data.tar.gz: b635707c5699b47414ff67bf85569a3ee9f06763
 SHA512:
-  metadata.gz: c15598ff82efb603ae99e3bede4eda53606ba71679688426b8aecf16e6221facc55e44466c86fe5d738ba5feed7ddae7d87fe0b0483340a4df7da5f027fbf1d7
-  data.tar.gz: d741e0613351400a3ce5691a2d48a7dfcf9ab8c20a2eb3e2a765d71d87e86e96bc9753a62f30c5bbe03967fc3bb10475a73c3e59a774bc66ca1ce6a79baf5a88
+  metadata.gz: cc88109dcbc9b9baef2eab4ecad52d1b346bc45b25a638ed232ef5f2feefbaa4713f3219282f40a1dfd53bd9af03490394a086e9f8689c1569c964d54e6000b6
+  data.tar.gz: 2cbc754b5333c6e7db22330bbc6da98d6905890d74551bb911666a55e1ba904da9f59cb4fb2f3cb5b925ee46b6f824a6395a7ad3e5854f18b48719d76911c962

data/README.md

@@ -12,7 +12,7 @@ Installation
 -------
 
 
-Add marionette_dust in your gemfile:
+Add marionette_dust to your gemfile:
 
 ```ruby
 gem 'marionette_dust'
@@ -26,7 +26,7 @@ $ bundle install
 Initialize your app with:
 
 ```
-$ rails generate marionette_dust:install
+$ rails generate md:install
 ```
 
 This adds `//= require marionette_dust` in your application.js manifest and generates the basic scaffold for your marionette application:
@@ -40,16 +40,18 @@ app/
         └── app.js
 ```
 
+You can past an optional argument ( -c ) if you want coffeescript files.
+
 Generators
 -------
-All generators are based on [marionette modules][3], the original idea is described in the exellent book [Backbone.Marionette.js: A Gentle Introduction][4], and the all credits go to [BackboneRails.com][5]
+All generators are based on [marionette modules][3], the original idea is described in the excellent book [Backbone.Marionette.js: A Gentle Introduction][4], and the all credits go to [BackboneRails.com][5]
 
 - **Scaffold**
 
     Generates a scaffold for a sub-app, under apps folder, running:
 
     ```
-    $ rails generate marionette_dust:scaffold Foo
+    $ rails generate md:scaffold Foo [-c]
     ```
 
     will generate:
@@ -69,7 +71,7 @@ app/
     Generates a submodule under an existent app (previously generated with the Scaffold generator), running:
 
     ```
-    $ rails generate marionette_dust:submodule bar --parent foo
+    $ rails generate md:submodule bar --parent foo [-c]
     ```
 
     will generate:
@@ -91,6 +93,19 @@ app/
                     └── bar.jst.dust
 ```
 
+About
+-------
+This version includes:
+
+ * Marionette.js v1.2.2
+ * Dust.js v2.2.2
+
+Also this project is inspired by:
+
+[Backbone on rails][7] and [Dust assets][6]
+
+
+
 Contributing
 -------
 
@@ -100,11 +115,15 @@ Contributing
 4. Push to the branch (`git push origin my-new-feature`)
 5. Create new Pull Request
 
+[![githalytics.com alpha](https://cruel-carlota.pagodabox.com/0fcf36aa176a3fc30ebbec87bf7b28d2 "githalytics.com")](http://githalytics.com/RobertoDip/marionette_dust-rails)
+
 [1]: http://marionettejs.com/
 [2]: http://linkedin.github.io/dustjs/
 [3]: https://github.com/marionettejs/backbone.marionette/blob/master/docs/marionette.application.module.md
 [4]: https://leanpub.com/marionette-gentle-introduction
 [5]: http://www.backbonerails.com/
+[6]: https://github.com/hasmanydevelopers/dust_assets
+[7]: https://github.com/meleyal/backbone-on-rails
 
 [Build Status]: https://travis-ci.org/RobertoDip/marionette_dust-rails
 [Code Climate]: https://codeclimate.com/github/RobertoDip/marionette_dust-rails

data/Rakefile

@@ -1,5 +1,12 @@
 require "bundler/gem_tasks"
+require 'rake/testtask'
 
-task :default do
-  puts "Default task called!"
+
+Rake::TestTask.new do |t|
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = true
 end
+
+desc "Run tests"
+task :default => :test

data/lib/dust_engine/dust.rb

@@ -4,8 +4,8 @@ require 'pathname'
 module MarionetteDust
   class Dust
     class << self
-      def precompile(source, name)
-        context.call('dust.compile', source, name)
+      def precompile(src, name)
+        context.call('dust.compile', src, name)
       end
 
       private
@@ -15,11 +15,11 @@ module MarionetteDust
       end
 
       def source
-        @source ||= path.read
+        @source ||= open(path).read
       end
 
       def path
-        @path ||= assets_path.join('dust-full-2.1.0.js')
+        @path ||= assets_path.join('dust-full-2.2.2.js')
       end
 
       def assets_path

data/lib/generators/{marionette_dust → md}/common/templates/app.js

@@ -5,6 +5,9 @@
 
   var API = {};
 
-  <%= app_name %>.on("contacts:list", function () {});
-
+  <%= sub_app_name %>.addInitializer(function() {
+    router = new <%= sub_app_name %>.Router({
+      controller: API
+    });
+  });
 });

data/lib/generators/md/common/templates/app.js.coffee

@@ -0,0 +1,8 @@
+<%= app_name %>.module "<%= sub_app_name %>", (<%= sub_app_name %>, <%= app_name %>, Backbone, Marionette, $, _) ->
+
+  <%= sub_app_name %>.Router = Marionette.AppRouter.extend(appRoutes: {})
+
+  API = {}
+
+  <%= sub_app_name %>.addInitializer ->
+    router = new <%= sub_app_name %>.Router(controller: API)

data/lib/generators/md/common/templates/controller.js.coffee

@@ -0,0 +1,2 @@
+<%= app_name %>.module "<%= file_name.capitalize %>.<%= sub_app_scope %>", (<%= sub_app_scope %>, <%= app_name %>, Backbone, Marionette, $, _) ->
+  <%= sub_app_scope %>.Controller = {}

data/lib/generators/md/common/templates/entity.js.coffee

@@ -0,0 +1,7 @@
+<%= app_name %>.module "Entities", (Entities, <%= app_name %>, Backbone, Marionette, $, _) ->
+
+  Entities.<%= singular_entity_name %> = Backbone.Model.extend({})
+
+  Entities.<%= plural_entity_name %>Collection = Backbone.Collection.extend({})
+
+  API = {}

data/lib/generators/md/common/templates/view.js.coffee

@@ -0,0 +1,3 @@
+<%= app_name %>.module "<%= file_name.capitalize %>.<%= sub_app_scope %>", (<%= sub_app_scope %>, <%= app_name %>, Backbone, Marionette, $, _) ->
+
+  <%= sub_app_scope %>.View = Marionette.ItemView.extend(template: "templates/<%= @submodule_name %>.jst.dust")

data/lib/generators/{marionette_dust → md}/install/install_generator.rb

@@ -1,6 +1,6 @@
-require 'generators/marionette_dust/helpers'
+require 'generators/md/helpers'
 
-module MarionetteDust
+module Md
   module Generators
     class InstallGenerator < Rails::Generators::Base
       include MarionetteDust::Generators::Helpers

data/lib/generators/{marionette_dust → md}/install/templates/app.js

@@ -17,4 +17,9 @@ var <%= app_name %> = new Marionette.Application();
 
 <%= app_name %>.on('initialize:after', function () {
   //Things to do after app initialize
+  if (Backbone.history) {
+    Backbone.history.start({
+      pushState: true
+    });
+  }
 });

data/lib/generators/{marionette_dust → md}/scaffold/scaffold_generator.rb

@@ -1,6 +1,6 @@
-require 'generators/marionette_dust/helpers'
+require 'generators/md/helpers'
 
-module MarionetteDust
+module Md
   module Generators
     class ScaffoldGenerator < Rails::Generators::NamedBase
       include MarionetteDust::Generators::Helpers
@@ -22,8 +22,8 @@ module MarionetteDust
                     desc: ""
 
       def parse_options
-        js = options.javascript
-        @ext = js ? ".js.coffee" : ".js"
+        coffee = options.coffeescript
+        @ext = coffee ? ".js.coffee" : ".js"
       end
 
       def create_marionette_entity
@@ -34,7 +34,7 @@ module MarionetteDust
       def create_marionette_app
         empty_directory File.join(apps_path, file_name.downcase)
         file = File.join(apps_path, file_name.downcase, sub_app_file_name)
-        template "app.js", file
+        template "app#{@ext}", file
       end
 
       def create_subapp

data/lib/generators/{marionette_dust → md}/submodule/submodule_generator.rb

@@ -1,6 +1,6 @@
-require 'generators/marionette_dust/helpers'
+require 'generators/md/helpers'
 
-module MarionetteDust
+module Md
   module Generators
     class SubmoduleGenerator < Rails::Generators::NamedBase
       include MarionetteDust::Generators::Helpers
@@ -23,11 +23,10 @@ module MarionetteDust
                     desc: "Parent app (required)"
 
       def parse_options
-        js              = options.javascript
-        @ext            = js ? ".js.coffee" : ".js"
+        coffee          = options.coffeescript
+        @ext            = coffee ? ".js.coffee" : ".js"
         @parent_name    = options.parent
         @submodule_name = file_name
-        puts "#{@parent_name}"
       end
 
       def create_subapp

data/lib/marionette_dust/version.rb

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

data/marionette_dust.gemspec

@@ -16,6 +16,7 @@ Gem::Specification.new do |spec|
   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'

data/test/lib/generators/marionette_dust/install/install_generator_test.rb

@@ -0,0 +1,47 @@
+require 'test_helper'
+
+class InstallGeneratorTest < Rails::Generators::TestCase
+  tests Md::Generators::InstallGenerator
+  destination File.expand_path("../templates", __FILE__)
+
+  test "creates the folder structure" do
+    run_generator
+
+    assert_directory "app/assets/javascripts/entities"
+    assert_directory "app/assets/templates"
+    assert_directory "app/assets/javascripts/apps"
+  end
+
+  test "creates the default application file(javascript)" do
+    run_generator
+
+    assert_file "app/assets/javascripts/app.js"
+  end
+
+  test "creates the coffeescript application file if required" do
+    run_generator %w(-c)
+
+    assert_file "app/assets/javascripts/app.js.coffee"
+  end
+
+  test "genereates the manifest(default)" do
+    run_generator
+
+    assert_file "app/assets/javascripts/application.js"
+  end
+
+  test "injects the required libraries(default)" do
+    run_generator
+
+    assert_file "app/assets/javascripts/application.js", /require marionette_dust/
+    assert_file "app/assets/javascripts/application.js", /require app/
+  end
+
+  test "injects the required paths(default)" do
+    run_generator
+
+    assert_file "app/assets/javascripts/application.js", /require_tree \.\/apps/
+    assert_file "app/assets/javascripts/application.js", /require_tree \.\/entities/
+    assert_file "app/assets/javascripts/application.js", /require_tree \.\.\/templates/
+  end
+end

data/test/lib/generators/marionette_dust/install/templates/app/assets/javascripts/app.js

@@ -0,0 +1,25 @@
+var Class = new Marionette.Application();
+
+Class.addRegions({
+  //Add application regions here
+});
+
+//Navigate to specific route
+Class.navigate = function (route, options) {
+  options || (options = {});
+  Backbone.history.navigate(route, options);
+};
+
+//Returns current route
+Class.getCurrentRoute = function () {
+  return Backbone.history.fragment;
+};
+
+Class.on('initialize:after', function () {
+  //Things to do after app initialize
+  if (Backbone.history) {
+    Backbone.history.start({
+      pushState: true
+    });
+  }
+});

data/test/lib/generators/marionette_dust/install/templates/app/assets/javascripts/app.js.coffee

@@ -0,0 +1,16 @@
+Class = new Marionette.Application()
+
+#Add application regions here
+Class.addRegions {}
+
+#Navigate to specific route
+Class.navigate = (route, options) ->
+  options or (options = {})
+  Backbone.history.navigate route, options
+
+#Returns current route
+Class.getCurrentRoute = ->
+  Backbone.history.fragment
+
+Class.on "initialize:after", ->
+  #Things to do after app initialize

data/test/lib/generators/marionette_dust/install/templates/app/assets/javascripts/application.js

@@ -0,0 +1,5 @@
+//= require marionette_dust
+//= require app
+//= require_tree ./apps
+//= require_tree ./entities
+//= require_tree ../templates

data/test/lib/generators/marionette_dust/scaffold_and_submodule/scaffold_generator_test.rb

@@ -0,0 +1,36 @@
+require 'test_helper'
+
+class ScaffoldGeneratorTest < Rails::Generators::TestCase
+  tests Md::Generators::ScaffoldGenerator
+  destination File.expand_path("../templates", __FILE__)
+
+  test "creates the folder structure" do
+    run_generator %w(test)
+
+    assert_directory "app/assets/javascripts/apps/test"
+  end
+
+  test "creates the sub application file" do
+    run_generator %w(test)
+
+    assert_file "app/assets/javascripts/apps/test/test_app.js"
+  end
+
+  test "creates the entities file" do
+    run_generator %w(test)
+
+    assert_file "app/assets/javascripts/entities/test.js"
+  end
+
+  test "creates coffeescript sub application file if requried" do
+    run_generator %w(test -c)
+
+    assert_file "app/assets/javascripts/apps/test/test_app.js.coffee"
+  end
+
+  test "creates coffeescript entities file if required" do
+    run_generator %w(test -c)
+
+    assert_file "app/assets/javascripts/entities/test.js.coffee"
+  end
+end

data/test/lib/generators/marionette_dust/scaffold_and_submodule/submodule_generator_test.rb

@@ -0,0 +1,28 @@
+require 'test_helper'
+
+class SubmoduleGeneratorTest < Rails::Generators::TestCase
+  tests Md::Generators::SubmoduleGenerator
+  destination File.expand_path("../templates", __FILE__)
+
+  test "creates the folder structure" do
+    run_generator %w(bar --parent foo)
+
+    assert_directory "app/assets/javascripts/apps/foo"
+    assert_directory "app/assets/javascripts/apps/foo/bar"
+    assert_directory "app/assets/javascripts/entities"
+  end
+
+  test "creates the submodule application" do
+    run_generator %w(bar --parent foo)
+
+    assert_file "app/assets/javascripts/apps/foo/bar/bar_view.js"
+    assert_file "app/assets/javascripts/apps/foo/bar/bar_controller.js"
+  end
+
+  test "creates the submodule application with coffeescript files if required" do
+    run_generator %w(bar --parent foo -c)
+
+    assert_file "app/assets/javascripts/apps/foo/bar/bar_view.js.coffee"
+    assert_file "app/assets/javascripts/apps/foo/bar/bar_controller.js.coffee"
+  end
+end

data/test/lib/generators/marionette_dust/scaffold_and_submodule/templates/app/assets/javascripts/app.js

@@ -0,0 +1,25 @@
+var Class = new Marionette.Application();
+
+Class.addRegions({
+  //Add application regions here
+});
+
+//Navigate to specific route
+Class.navigate = function (route, options) {
+  options || (options = {});
+  Backbone.history.navigate(route, options);
+};
+
+//Returns current route
+Class.getCurrentRoute = function () {
+  return Backbone.history.fragment;
+};
+
+Class.on('initialize:after', function () {
+  //Things to do after app initialize
+  if (Backbone.history) {
+    Backbone.history.start({
+      pushState: true
+    });
+  }
+});

data/test/lib/generators/marionette_dust/scaffold_and_submodule/templates/app/assets/javascripts/app.js.coffee

@@ -0,0 +1,16 @@
+Class = new Marionette.Application()
+
+#Add application regions here
+Class.addRegions {}
+
+#Navigate to specific route
+Class.navigate = (route, options) ->
+  options or (options = {})
+  Backbone.history.navigate route, options
+
+#Returns current route
+Class.getCurrentRoute = ->
+  Backbone.history.fragment
+
+Class.on "initialize:after", ->
+  #Things to do after app initialize

data/test/lib/generators/marionette_dust/scaffold_and_submodule/templates/app/assets/javascripts/application.js

@@ -0,0 +1,5 @@
+//= require marionette_dust
+//= require app
+//= require_tree ./apps
+//= require_tree ./entities
+//= require_tree ../templates

data/test/lib/generators/marionette_dust/scaffold_and_submodule/templates/app/assets/javascripts/apps/foo/bar/bar_controller.js

@@ -0,0 +1,3 @@
+Class.module("Bar.Bar", function (Bar, Class, Backbone, Marionette, $, _) {
+  Bar.Controller = {};
+});

data/test/lib/generators/marionette_dust/scaffold_and_submodule/templates/app/assets/javascripts/apps/foo/bar/bar_controller.js.coffee

@@ -0,0 +1,2 @@
+Class.module "Bar.Bar", (Bar, Class, Backbone, Marionette, $, _) ->
+  Bar.Controller = {}

data/test/lib/generators/marionette_dust/scaffold_and_submodule/templates/app/assets/javascripts/apps/foo/bar/bar_view.js

@@ -0,0 +1,5 @@
+Class.module("Bar.Bar", function (Bar, Class, Backbone, Marionette, $, _) {
+  Bar.View = Marionette.ItemView.extend({
+    template: "templates/bar.jst.dust"
+  });
+});

data/test/lib/generators/marionette_dust/scaffold_and_submodule/templates/app/assets/javascripts/apps/foo/bar/bar_view.js.coffee

@@ -0,0 +1,3 @@
+Class.module "Bar.Bar", (Bar, Class, Backbone, Marionette, $, _) ->
+
+  Bar.View = Marionette.ItemView.extend(template: "templates/bar.jst.dust")

data/test/lib/generators/marionette_dust/scaffold_and_submodule/templates/app/assets/javascripts/apps/test/test_app.js

@@ -0,0 +1,13 @@
+Class.module("TestsApp", function (TestsApp, Class, Backbone, Marionette, $, _) {
+  TestsApp.Router = Marionette.AppRouter.extend({
+    appRoutes: {}
+  });
+
+  var API = {};
+
+  TestsApp.addInitializer(function() {
+    router = new TestsApp.Router({
+      controller: API
+    });
+  });
+});

data/test/lib/generators/marionette_dust/scaffold_and_submodule/templates/app/assets/javascripts/apps/test/test_app.js.coffee

@@ -0,0 +1,8 @@
+Class.module "TestsApp", (TestsApp, Class, Backbone, Marionette, $, _) ->
+
+  TestsApp.Router = Marionette.AppRouter.extend(appRoutes: {})
+
+  API = {}
+
+  TestsApp.addInitializer ->
+    router = new TestsApp.Router(controller: API)

data/test/lib/generators/marionette_dust/scaffold_and_submodule/templates/app/assets/javascripts/entities/test.js

@@ -0,0 +1,9 @@
+Class.module("Entities", function (Entities, Class, Backbone, Marionette, $, _) {
+
+  Entities.Test = Backbone.Model.extend({});
+
+  Entities.TestsCollection = Backbone.Collection.extend({});
+
+  var API = {};
+
+});

data/test/lib/generators/marionette_dust/scaffold_and_submodule/templates/app/assets/javascripts/entities/test.js.coffee

@@ -0,0 +1,7 @@
+Class.module "Entities", (Entities, Class, Backbone, Marionette, $, _) ->
+
+  Entities.Test = Backbone.Model.extend({})
+
+  Entities.TestsCollection = Backbone.Collection.extend({})
+
+  API = {}

data/test/lib/generators/marionette_dust/scaffold_and_submodule/templates/app/assets/templates/foo/bar/bar.jst.dust

@@ -0,0 +1 @@
+<h2>To be filled</h2>

data/test/test_helper.rb

@@ -0,0 +1,23 @@
+require 'bundler'
+Bundler.require
+
+require 'test/unit'
+require 'rails/all'
+require 'rails/generators'
+require 'rails/generators/test_case'
+
+class TestApp < Rails::Application
+  config.root = File.dirname(__FILE__)
+end
+Rails.application = TestApp
+
+module Rails
+  def self.root
+    @root ||= File.expand_path("../../vendor/assets/javascripts/marionette_dust/", __FILE__)
+  end
+end
+Rails.application.config.root = Rails.root
+
+require 'generators/md/install/install_generator'
+require 'generators/md/scaffold/scaffold_generator'
+require 'generators/md/submodule/submodule_generator'