Logo Questions Linux Laravel Mysql Ubuntu Git Menu
 

Cons/pros and feasibility of running Yeoman and Rails with an Ember project?

I am working on an Ember-Rails app. I have used Yeoman previously for building non-ember-rails apps and js plugins and I would love to be able to realize the benefits of Yeoman (especially Grunt's livereload) when working on my Ember-Rails projects. However, I am unsure as to whether Ember, Rails, and Yeoman are fully compatible and whether they overlap in their roles and responsibilities. For example:

Dependency Management - I understand Bower is used for dependency management. Does Bower affect how assets are loaded through the rails asset pipeline? What are the advantages/disadvantages of loading dependencies through Bower instead of using Rails gems?

Livereload - Does livereload function with a single-page app (like one built in Ember) in the same way it does with a multi-page app (for example, an html site that doesn't use a js framework)? Are individual models/views/controllers reloaded or does the whole app reload and/or recompile through the Rails asset pipeline?

Existing Project - Are there pitfalls when integrating Yeoman into an existing Ember-Rails app? We're running Ember 1.3.0-beta and Ember Data 1.0.0-beta on our production. If you have experience with up-to-date Ember builds, are Ember-auth and Ember-data compatible with Yeoman?

If anyone has experience combining Ember, Rails, and Yeoman, or if you understand how the frontend and backend would compare with such a stack please share your thoughts! Would you recommend just integrating part of the Yeoman setup (e.g. Grunt) with an Ember-Rails app instead of the whole of Yeoman?

Thanks.

like image 511
Duncan Walker Avatar asked Dec 26 '22 17:12

Duncan Walker


1 Answers

I'm not Rails&Ember guy, but here are my general thoughts about feasibility of using Yeoman:

Not using Yeoman: Feasibility

From my experience in combining Yeoman & Django, I must say that it starts to pay off only in medium-sized or bigger projects.
In smaller ones, particularly with tight deadlines and not much attention paid to the code quality & tech. solutions used (like Univ. projects), you'll be probably better off sticking with bare Rails (downloading JS libraries manually and committing them accordingly to the Rails project structure).

The reason is simple: It might be really time-consuming to fine tune both full-stack framework (Rails) with frontend-framework (Yeoman).
Particularly if Rails is driven by CoC principle.
It might seem to work after some setup, but as the project evolves, you will spot further obstacles and you'll have to tamper waaaaaaay more.

Cons & things I consider not worth this time investment:

  • Livereload
    I like it very much, I was amazed with it at first, but after some time I see that I don't spend that much time editing HTML&CSS in IDE and watching static page on another screen automatically refresh. In majority of cases I still need to do Alt + tab and trigger some action, perform some click, so whether I add one Ctrl+R hit in-between doesn't do any difference.
    In some cases you'll be better off playing around with Local Folders Mappings (Chrome Dev Tools) or web proxy (e.g.: Fiddler).
    There are cases where Livereload does a brilliant job though, such as for instance not needing to perform full reload if you edited only CSS.

    As for your questions:

  • For me if it detects changes in JS it reloads whole page. But maybe it's because I'm using JetBrains IDEs (filesystem cache'ing) and CoffeScript (compilation to JS).
  • Yeoman is best suited for SPAs. Would it be acceptable for you to make it a SPA, not a round trip app ?

  • Bower - Attempt to provide dependency management for github projects
    What bower does for your app is basically downloading stuff from github. No rocket science here.
    If the structure of downloaded thing is non-standard, Bower/RequireJS/Grunt-bower-install has no bloody idea what to do with it next, i.e. how to inject everything so that you won't get errors. For most popular libraries bower just works, for highly customized ones you will end up injecting downloaded stuff manually.
    The ones to blame are people who don't package useful github projects properly.

    Furthermore I heard of workflows where people commit bower_components due to problems with bower, never experienced personally though, perhaps the issues were fixed. If so possibility of not committing 3rd libraries to source code is definitely an advantage.

    Note: As I pointed out above, it's how bower helps you developing your app, but bower has become somewhat a standard in the frontend community, for instance http://ngmodules.org/ is build on top of that, so it's a important tool.

    Can Rails assembly pipeline fetch arbitrary github project ? Yes.
    Can it inject library references to your html ? Duno, I'm not Rails guy.

  • Generators
    Some could do a beautiful job, such as configuring whole heroku-related stuff for you. Too bad generator-heroku doesn't work as expected (tried it sth like 2 months ago). Same was true for travis generator. In this case fix was easy, but see the next point.
    As for Angular generators (I'm Angular guy, not Ember guy, sorry :-) ) - it just adds 2 files and includes them in index.html, furthermore if you are using not so straight-forward syntax for creating JS framework related stuff (sample: Angular-related stuff in coffee) generator will most probably not know about it. Ok, you can submit a patch to generator, but then AngularJS team decides to change the syntax a little bit in the next release - you get the idea ? - again, see the next point.
    What is more, if your project uses layout in which code is structured by feature/module (e.g. admin module, profile settings module, ...), not by type (directives, controllers, ...) framework-specific generators won't work.

  • Stability
    Karma is evolving rapidly, so does Angular, Angular-UI and loads of fronted tools, frameworks.
    It's really difficult for Yeoman to keep up with most recent changes, although they do a nice job here.

Employing Yeoman: Being cutting-edge

Yeoman provides some really cool stuff such as:

  • Linting

  • Compiling coffeescript, SASS/SCSS, etc. on the fly

  • CDNifying
    Really useful when you want to have libraries downloaded locally in case of developing offline and still benefit from pros of CDN.
    Without Grunt you would have ended up writing scripts parsing your HTMLs

  • Automated JS/CSS minification
    Grunt does it for you. You only have to configure it properly.

  • Encouraging separation and low coupling of your frontend and backend
    As for your question: I doubt that you'll be able to manage Rails part solely with Yeoman.
    A good recipe for a web app in Yeoman & sth is: https://stackoverflow.com/a/19425461/1432478.
    That's for Django, adapt it accordingly to Rails.

My opinion

In majority of small projects based purely on Spring MVC, Rails, Django, etc. you simply don't perform any of things done by Grunt (hence there's less time expenditure for setup).
There are cases when producing technologically advanced frontend is a must.
e.g.: Most recently I discovered that my bank account management system doesn't minify JSes. Even funny comments are left as they were. I didn't perform any rushed money withdrawal, but I hope they at least have server-side validation. :-)

Yeoman is a really good combination of solutions facilitating all those chores.

Using only Grunt? IMHO No. Yeoman is Grunt when it comes to app assembly. You get Livereload and other stuff for free.

If:

  1. you're lucky and found sample config that seems to work for the web framework of your choice or managed to configure one on your own
  2. don't have deadlines to hold

then you should probably give it a try.

If you will work on multiple projects, chore of configuring it once might pay off by copy-pasting config to future projects. But keep in mind that frontend technologies are rapidly evolving, that's why tons of samples from the net simply don't work out of the box.

Further reading :)

  • http://blog.tfnico.com/2013/07/considerations-for-javascript-in-modern.html

Java world here, but I hope some concepts will be useful:

  • http://addyosmani.com/blog/making-maven-grunt/
  • Javascript web app and Java server, build all in Maven or use Grunt for web app?
like image 113
vucalur Avatar answered Apr 26 '23 22:04

vucalur