chancancode / marionette-rails Goto Github PK

Vendors the Backbone.Marionette library for use with Rails' asset pipeline

License: MIT License

Ruby 100.00%

marionette-rails's Introduction

marionette-rails

This gem is a wrapper for Derick Bailey's Backbone.Marionette library. It vendors the javascript library code for use with Rails' asset pipeline (Rails 3.1+).

This gem is currently maintained by @wingrunr21.

Dependencies

Backbone.Marionette depends on Backbone (and Backbone's dependencies). These dependencies are not currently managed by the marionette-rails gem directly, because there exists multiple options to use Backbone with the Rails asset pipeline, such as backbone-on-rails, backbone-rails, rails-backbone, just to name a few.

Usage

Add it to your Gemfile:

  gem 'marionette-rails'

Then add this to app/assets/javascripts/application.js.coffee after your backbone require:

#= require backbone.marionette

Or, if you are using pure javascript, add this to app/assets/javascripts/application.js:

//= require backbone.marionette

Versioning

The gem will mirror the Backbone.Marionette versioning scheme. That is, version 0.8.2.* of marionette-rails would vendor Backbone.Marionette v0.8.2.

Updating Backbone.Marionette

There are two rake tasks that aid with this process:

rake marionette:latest # => will fetch the latest Backbone.Marionette tag/SHA and print them
rake marionette:update # => will update the gem to the latest Backbone.Marionette js and update the gem version

Contributing

For bugs in Backbone.Marionette itself, head over to their issue tracker. If you have a question, post it at StackOverflow under the backbone.marionette tag.

For bugs in this gem distribution, use the GitHub issue tracker. If you could submit a pull request - that's even better!

License

This library is distributed under the MIT license. Please see the LICENSE file.

marionette-rails's People

Contributors

Stargazers

Watchers

Forkers

eploko markijbema rahilsondhi ncolgan keiko713 ctide ayanko gordonk lsimoneau takuyan mmatvien arthurn philippbosch lbeder davidnorth acolorbright wenpp ikbenale jmadureira jakobwiller

marionette-rails's Issues

Add minified version of MarionetteJS along with source maps

Will do this when MarionetteJS bumps to v1.0.3

Marionette 2.3.2

It would be nice if marionette-rails could be updated to the latest release in the new 2.3.x series (changelog).

Marionette 2.4.1 released

A new version of Marionette (2.4.1) is available. It would be nice if the gem could be updated.

describe where #= require backbone.marionette should go

I think the README should contain instructions for where the

#= require backbone.marionette

should be placed in the application.js.coffee (I'm presuming after the backbone requires).

Add support for Marionette 1.8.8 as the last version in 1.x branch.

Hello, would it be possible to make one more release of this gem that would feature Marionette 1.8.8 as the last supported version in the 1.x branch? We still depend upon it and won't be migrating anytime soon so we thought it might be a good idea to at least move to the latest stable minor and patch version. If no, are you accepting pull requests? I could put it together myself. Would you be willing to at least accept a PR and make a release of the gem? Thanks.

UPDATE: Hmm there's no branch which I could create a PR against. I'd suggest creating v1.x - I've updated Marionette in my fork already - https://github.com/mareksuscak/marionette-rails/tree/v1.x

Buy I can't create a PR until there's a dedicated branch in your repo.

Rake tasks may be missing in Rails >= 4 with Ruby >= 2

I cannot run the rake tasks in the README and do not see them in the output of rake -T. This isn't critical as I'm using the latest version of the gem, just something to be aware of.

Feature: Boiler-plate rails generator

Hi there, we currently use marionette within our application, we have supported the "standard" flavour of design that is described in detail on http://www.backbonerails.com/.

We have become annoyed with the creation of folders and basic boilerplate for every new "app" or "component". So I have had a look around and can't find anything for this (it is kinda project specific).

So Im looking to see wether it might be worth adding in some basic install of marionette structured in a way that is easy to get started and keeps you adhering to a certain structure.

Im thinking a few commands along this line:

An Install Command

creates the basic folder structure and then creates "intermediary" classes so there is room to modify should the need arise. ie;

class {{APP_NAME}}.ItemView extends Marionette.ItemView

A App Generator

creates a new app with a controller and view, with a templates folder and namespaces them correctly in the apps directory.

A Component Command

creates a new component with a controller and view in the components directory.

Example of my folder structure

app/assets/javascripts/
- {{APP_NAME}}/
  - apps/
  - components/
  - config/
    - backbone/
    - marionette/
  - controllers/
  - entities/
  - views/
    app.coffee

Just thought i'd see if there was any interest in this I can explain further and give more detail on my implementation. Rather than develop this for ourselves internally I thought I'd check to see if anyone else was interested in something like this.

Please update to 1.4.1

Thanks :)

License missing from gemspec

RubyGems.org doesn't report a license for your gem. This is because it is not specified in the gemspec of your last release.

via e.g.

  spec.license = 'MIT'
  # or
  spec.licenses = ['MIT', 'GPL-2']

Including a license in your gemspec is an easy way for rubygems.org and other tools to check how your gem is licensed. As you can imagine, scanning your repository for a LICENSE file or parsing the README, and then attempting to identify the license or licenses is much more difficult and more error prone. So, even for projects that already specify a license, including a license in your gemspec is a good practice. See, for example, how rubygems.org uses the gemspec to display the rails gem license.

There is even a License Finder gem to help companies/individuals ensure all gems they use meet their licensing needs. This tool depends on license information being available in the gemspec. This is an important enough issue that even Bundler now generates gems with a default 'MIT' license.

I hope you'll consider specifying a license in your gemspec. If not, please just close the issue with a nice message. In either case, I'll follow up. Thanks for your time!

Appendix:

If you need help choosing a license (sorry, I haven't checked your readme or looked for a license file), GitHub has created a license picker tool. Code without a license specified defaults to 'All rights reserved'-- denying others all rights to use of the code.
Here's a list of the license names I've found and their frequencies

p.s. In case you're wondering how I found you and why I made this issue, it's because I'm collecting stats on gems (I was originally looking for download data) and decided to collect license metadata,too, and make issues for gemspecs not specifying a license as a public service :). See the previous link or my blog post about this project for more information.

require a gem which provides backbone/underscore?

Wouldn't it make sense to require a gem which provides the libraries used by backbone marionette? I currently use https://github.com/meleyal/backbone-on-rails (also the git version, since the released version has (had) a too old version of underscore).

What exactly does this offer in terms of RAILS? Does it just include the marionette library into your rails application for you?

Seems like a silly task if that's all it does...
Does it tie into the generators or anything?