如何在 Rails 3.1 中使用 Sprockets 编写 DRY、模块化的 CoffeeScript？

Question

我正处于尝试编写一些合理的 Javascript 的早期阶段。我想将基本上所有内容命名为我的应用程序名称下的名称，以尽可能避免全局变量，但仍然给我一种访问该位置周围声明的函数的方法。但是，我不想在函数定义中变得非常冗长。

我理想的 CoffeeScript 应该是这样的：

class @MyApp
  @myClassMethod = ->
    console.log 'This is MyApp.myClassMethod()'

  class @Module1
    @moduleMethod = ->
      console.log 'This is MyApp.Module1.moduleMethod()'

你明白了。这样我就可以避免每次想要正确定义命名空间函数时都必须编写 MyApp.Module.submoduleMethod = -> - 使用 @ 并在其中定义内容 我的类定义使事情变得美好而简短。

一切进展顺利，直到我想将我的功能拆分为多个 CoffeeScript 文件。那么我真正想要的是这样的：

// application.js
class @MyApp
  //= require 'module1'
  //= require 'module2'

// module1.js
class @Module1
  @moduleMethod = ->
    console.log 'This is STILL MyApp.Module1.moduleMethod()'

链轮似乎不能做到这一点。

有没有一种明智的方法来要求我的 CoffeeScript 文件位于容器文件中的正确位置？或者使用 CoffeeScript、Sprockets 和 Rails 3.1 编写分成单独文件的模块化代码的另一种方法？

Answer 1

只需保持 module1.js 不变，并使 application.js 看起来像这样：

//= require 'module1'

class @MyApp
  ...

  @Module1 = Module1

这将起作用，因为您已将 Module1 设为全局（声明 class @Module1 等效）编写 @Module1 = class Module1，并且 @ 指向该上下文中的 window），并且在 class @MyApp正文，<代码>@指向类本身。

如果您希望 Module1 在附加后仅成为全局 MyApp 类的属性，您可以添加以下行

delete window.Module1

Answer 2

我有一个在代码中使用的模块解决方案。

我定义了我的模块，如下所示。 令人惊奇的是

@module "foo", ->
    @module "bar", ->
        class @Amazing
            toString: "ain't it"

可用的

foo.bar.Amazing

， @module 帮助器的实现是

window.module = (name, fn)->
  if not @[name]?
    this[name] = {}
  if not @[name].module?
    @[name].module = window.module
  fn.apply(this[name], [])

，它写在 Coffeescript 网站上。

https://github.com/jashkenas/coffee-script/wiki /Easy-modules-with-coffeescript

Answer 3

下面是我使用 sprocket 管理 CoffeeScript 的模块化模式（也适用于 Rails 4）：

  # utils.js.coffee

  class Utils
    constructor: ->

    foo: ->
      alert('bar!!!')

    # private methods should be prefixed with an underscore
    _privateFoo: ->
      alert('private methods should not be exposed')

  instance = new Utils()

  # only expose the methods you need to.
  # because this is outside of the class,
  # you can use coffee's sugar to define on window

  @utils = foo: instance.foo

  # otherscript.js.coffee 

  //= require utils
  class OtherScript
    constructor: ->
      @utils.foo()         # alerts bar!!!
      @utils._privateFoo() # undefined method error

这种方法的一个缺点是您在窗口上公开对象。根据您的需求，添加模块加载器或在模块周围采用一些新的 es 语法可能是一个不错的选择。