marionette_dust 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 079cde9464f0f39843701f532fa51ff16f8fd40e
+  data.tar.gz: 074ca9812423cd91a3985db801ff8ec1fdeef838
+SHA512:
+  metadata.gz: 184bab9d0b4be2889f44ef27009b9c583dd64f33aafa6ddb139b887106d604e28f8ee85520dca7353dcc831cae991c230c4846a484aa8ac7283441470c113a51
+  data.tar.gz: 5c5024395e17239a7ce9501d8cd444e7cdda7b6eae29edb9365988511e51aee2c4fd320d4b2f56850a545687a08e8669f115fa8538426154cc82f5520ee3c954

data/.gitignore

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

data/.rspec

@@ -0,0 +1 @@
+--color

data/.travis.yml

@@ -0,0 +1,5 @@
+language: ruby
+rvm:
+  - 1.9.2
+  - 1.9.3
+  - 2.0.0

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 RobertoDip
+
+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,114 @@
+[![Dependency Status][GM img]][Gemnasium]
+[![Build Status][BS img]][Build Status]
+[![Code Climate][CC img]][Code Climate]
+
+MarionetteDust - Rails
+=======
+
+Provides full integration between [Marionette.js][1] (and dependencies), [Dust.js][2] and the Asset Pipeline, also includes generators for a typical marionette application.
+
+Installation
+-------
+
+
+Add marionette_dust in your gemfile:
+
+```ruby
+gem 'marionette_dust'
+```
+Download and install by running:
+
+```
+$ bundle install
+```
+
+Initialize your app with:
+
+```
+$ rails generate marionette_dust:install
+```
+
+This adds `//= require marionette_dust` in your application.js manifest and generates the basic scaffold for your marionette application:
+
+```
+app/
+└── assets/
+    └── javascripts/
+        ├── apps/
+        ├── entities/
+        └── app.js
+```
+
+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]
+
+- **Scaffold**
+
+    Generates a scaffold for a sub-app, under apps folder, running:
+
+    ```
+    $ rails generate marionette_dust:scaffold Foo
+    ```
+
+    will generate:
+```
+app/
+└── assets/
+    └── javascripts/
+        ├── apps/
+        |    └── foo/
+        |        └── foo_app.js
+        └── entities/
+            └── foo.js
+```
+
+- **Submodule**
+
+    Generates a submodule under an existent app (previously generated with the Scaffold generator), running:
+
+    ```
+    $ rails generate marionette_dust:submodule bar --parent foo
+    ```
+
+    will generate:
+```
+app/
+└── assets/
+    └── javascripts/
+        ├── apps/
+        |    └── foo/
+        |        ├── bar/
+        |            ├── bar_view.js
+        |            └── bar_controller.js
+        |        └── foo_app.js
+        └── entities/
+        |    └── foo.js
+        └── templates/
+            └── foo/
+                └── bar/
+                    └── bar.jst.dust
+```
+
+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
+
+[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/
+
+[Build Status]: https://travis-ci.org/RobertoDip/marionette_dust-rails
+[Code Climate]: https://codeclimate.com/github/RobertoDip/marionette_dust-rails
+[Gemnasium]: https://gemnasium.com/RobertoDip/marionette_dust-rails
+
+[BS img]: https://travis-ci.org/RobertoDip/marionette_dust-rails.png
+[CC img]: https://codeclimate.com/github/RobertoDip/marionette_dust-rails.png
+[GM img]: https://gemnasium.com/RobertoDip/marionette_dust-rails.png

data/Rakefile

@@ -0,0 +1,5 @@
+require "bundler/gem_tasks"
+
+task :default do
+  puts "Default task called!"
+end

data/lib/generators/marionette_dust/common/templates/app.js

@@ -0,0 +1,10 @@
+<%= app_name %>.module("<%= sub_app_name %>", function (<%= sub_app_name %>, <%= app_name %>, Backbone, Marionette, $, _) {
+  <%= sub_app_name %>.Router = Marionette.AppRouter.extend({
+    appRoutes: {}
+  });
+
+  var API = {};
+
+  <%= app_name %>.on("contacts:list", function () {});
+
+});

data/lib/generators/marionette_dust/common/templates/controller.js

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

data/lib/generators/marionette_dust/common/templates/entity.js

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

data/lib/generators/marionette_dust/common/templates/template.jst.dust

@@ -0,0 +1 @@
+

data/lib/generators/marionette_dust/common/templates/view.js

@@ -0,0 +1,5 @@
+<%= app_name %>.module("<%= file_name.capitalize %>.<%= sub_app_scope %>", function (<%= 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/helpers.rb

@@ -0,0 +1,71 @@
+module MarionetteDust
+  module Generators
+    module Helpers
+
+      def asset_path
+        File.join('app', 'assets')
+      end
+
+      def javascript_path
+        File.join(asset_path, 'javascripts')
+      end
+
+      def entities_path
+        File.join(javascript_path, "entities")
+      end
+
+      def apps_path
+        File.join(javascript_path, "apps")
+      end
+
+      def template_path
+        File.join(asset_path, "templates")
+      end
+
+      def singular_file_name
+        "#{file_name.singularize}#{@ext}"
+      end
+
+      def plural_file_name
+        "#{file_name.pluralize}#{@ext}"
+      end
+
+      def asset_file_name(type)
+        "#{@submodule_name.downcase.singularize}_#{type}#{@ext}"
+      end
+
+      def singular_entity_name
+        file_name.singularize.camelize
+      end
+
+      def plural_entity_name
+        file_name.pluralize.camelize
+      end
+
+      def sub_app_name
+        [file_name.pluralize.camelize, "App"].join("")
+      end
+
+      def sub_app_file_name
+        [file_name.singularize.downcase, "_app", "#{@ext}"].join("")
+      end
+
+      def sub_app_scope
+        @submodule_name.capitalize
+      end
+
+      def app_name
+        rails_app_name.camelize
+      end
+
+      def app_filename
+        rails_app_name.underscore
+      end
+
+      def rails_app_name
+        Rails.application.class.name.split('::').first
+      end
+
+    end
+  end
+end

data/lib/generators/marionette_dust/install/install_generator.rb

@@ -0,0 +1,58 @@
+require 'generators/marionette_dust/helpers'
+
+module MarionetteDust
+  module Generators
+    class InstallGenerator < Rails::Generators::Base
+      include MarionetteDust::Generators::Helpers
+
+      source_root File.expand_path("../templates", __FILE__)
+
+      desc "Generates a MarionetteDust.js skeleton directory structure and manifest"
+
+      class_option :coffeescript,
+                    type: :boolean,
+                    aliases: "-c",
+                    default: false,
+                    desc: "Generate CoffeeScript files"
+
+      class_option :manifest,
+                    type: :string,
+                    aliases: "-m",
+                    default: "application.js",
+                    desc: "Javascript manifest file to modify (or create)"
+
+      def create_dir_layout
+        empty_directory entities_path
+        empty_directory apps_path
+      end
+
+      def create_app_file
+        coffee = options.coffeescript
+        ext = coffee ? ".js.coffee" : ".js"
+        template "app#{ext}", "#{javascript_path}/app#{ext}"
+      end
+
+      def inject_required_files
+        manifest = File.join(javascript_path, options.manifest)
+        libs = %w(marionette_dust)
+        paths = %w(../templates ./entities ./apps)
+
+        out = []
+        out << libs.map{ |lib| "//= require #{lib}" }
+        out << "//= require #{app_filename}"
+        out << paths.map{ |path| "//= require_tree #{path}" }
+        out = out.join("\n") + "\n"
+
+        in_root do
+          create_file(manifest) unless File.exists?(manifest)
+          if File.open(manifest).read().include?('//= require_tree')
+            inject_into_file(manifest, out, before: '//= require_tree')
+          else
+            append_file(manifest, out)
+          end
+        end
+      end
+
+    end
+  end
+end

data/lib/generators/marionette_dust/install/templates/app.js

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

data/lib/generators/marionette_dust/install/templates/app.js.coffee

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

data/lib/generators/marionette_dust/scaffold/scaffold_generator.rb

@@ -0,0 +1,64 @@
+require 'generators/marionette_dust/helpers'
+
+module MarionetteDust
+  module Generators
+    class ScaffoldGenerator < Rails::Generators::NamedBase
+      include MarionetteDust::Generators::Helpers
+
+      source_root File.expand_path("../../common/templates", __FILE__)
+
+      desc "Generates a Marionette.js resource scaffold"
+
+      class_option :coffeescript,
+                    type: :boolean,
+                    aliases: "-c",
+                    default: false,
+                    desc: "Generate Coffeescript files"
+
+      class_option :submodule,
+                    type: :array,
+                    aliases: "--sub",
+                    default: "",
+                    desc: ""
+
+      def parse_options
+        js = options.javascript
+        @ext = js ? ".js.coffee" : ".js"
+      end
+
+      def create_marionette_entity
+        file = File.join(entities_path, singular_file_name)
+        template "entity#{@ext}", file
+      end
+
+      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
+      end
+
+      def create_subapp
+        return if options.submodule.empty?
+        for submodule in options.submodule
+          @submodule_name = submodule
+          empty_directory File.join(apps_path, file_name.downcase, submodule.downcase)
+          create_asset("view")
+          create_asset("controller")
+          create_dust_template
+        end
+      end
+
+      protected
+      def create_asset(type)
+        file = File.join(apps_path, file_name.downcase, @submodule_name.downcase, asset_file_name(type))
+        template "#{type}#{@ext}", file
+      end
+
+      def create_dust_template
+        empty_directory File.join(template_path, file_name.downcase, @submodule_name.downcase)
+        file = File.join(template_path, file_name.downcase, @submodule_name.downcase, "#{@submodule_name.downcase}.jst.dust")
+        template "template.jst.dust", file
+      end
+    end
+  end
+end

data/lib/generators/marionette_dust/submodule/submodule_generator.rb

@@ -0,0 +1,52 @@
+require 'generators/marionette_dust/helpers'
+
+module MarionetteDust
+  module Generators
+    class SubmoduleGenerator < Rails::Generators::NamedBase
+      include MarionetteDust::Generators::Helpers
+      include Thor::Actions
+
+      source_root File.expand_path("../../common/templates", __FILE__)
+
+      desc "Generates a Marionette.js resource scaffold"
+
+      class_option :coffeescript,
+                    type: :boolean,
+                    aliases: "-c",
+                    default: false,
+                    desc: "Generate Coffeescript files"
+
+      class_option :parent,
+                    type: :string,
+                    aliases: "-p",
+                    required: true,
+                    desc: "Parent app (required)"
+
+      def parse_options
+        js              = options.javascript
+        @ext            = js ? ".js.coffee" : ".js"
+        @parent_name    = options.parent
+        @submodule_name = file_name
+        puts "#{@parent_name}"
+      end
+
+      def create_subapp
+        create_asset("view")
+        create_asset("controller")
+        create_dust_template
+      end
+
+      protected
+      def create_asset(type)
+        file = File.join(apps_path, @parent_name.downcase, file_name, asset_file_name(type))
+        template "#{type}#{@ext}", file
+      end
+
+      def create_dust_template
+        empty_directory File.join(template_path, @parent_name, @submodule_name)
+        file = File.join(template_path, @parent_name, @submodule_name, "#{@submodule_name}.jst.dust")
+        template "template.jst.dust", file
+      end
+    end
+  end
+end

data/lib/marionette_dust/engine.rb

@@ -0,0 +1,3 @@
+module MarionetteDust
+  class Engine < Rails::Engine; end
+end

data/lib/marionette_dust/version.rb

@@ -0,0 +1,3 @@
+module MarionetteDust
+  VERSION = "0.0.1"
+end

data/lib/marionette_dust.rb

@@ -0,0 +1,6 @@
+require "marionette_dust/version"
+
+module MarionetteDust
+
+  require "marionette_dust/engine" if defined?(Rails::Engine)
+end

data/marionette_dust.gemspec

@@ -0,0 +1,23 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'marionette_dust/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "marionette_dust"
+  spec.version       = MarionetteDust::VERSION
+  spec.authors       = ["RobertoDip"]
+  spec.email         = ["dip.jesusr@gmail.com"]
+  spec.description   = %q{An easy way to get Marionette.js and Dust.js working together with the asset pipeline}
+  spec.summary       = %q{Get up Marionette and Dust in seconds}
+  spec.homepage      = "https://github.com/RobertoDip/marionette_dust-rails"
+  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_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+end