ember-cli-rails 0.6.0 → 0.6.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a36210f5c5119e4b769cec1174106772deb7aaea
-  data.tar.gz: 13161690fc11f87a3ec9786aa3a312eef18a5975
+  metadata.gz: c875893e377992ea0a7935ecff7b435f27f3dd8a
+  data.tar.gz: 20a40093eb23312813a4932a4471d4464e4c651e
 SHA512:
-  metadata.gz: e0c12d193f95eecb0a39002e47504be22a688d44c539018fd9a4328dfe4501490d652e17619254f2ffc2189562d547aa863888e1bc5a1bde56140e674febba26
-  data.tar.gz: 1eb93dd62ab7551dcf556c759aa50ce33d1d17f851bee689fb2826dc0ab168c3f47137da0edc52597dad890054f5ba767f3368ec022242d5040898e49edf6e36
+  metadata.gz: a39aafa84caed46cd0007c4214e73d68268066a6be1c10a9ed0a9f164c461c68f54600beecbae9c2b14703aaca02f29f25e0546335fc3a484089278468250fc7
+  data.tar.gz: a07e683152ffe4fb647baad272dda0535eabc8b2aaafb95468a31ca664d8d43ab2cb7ae4671ef57f41bef5171238610b1a3660300ddfddf3a67a4cfde7be587d

data/CHANGELOG.md

@@ -1,6 +1,17 @@
 master
 ------
 
+0.6.1
+-----
+
+* Extract `include_ember_*_tags` and the associated code to the
+  `ember-cli-rails-assets` gem. Add `ember-cli-rails-assets` as a dependency.
+  [#363]
+* Introduce `mount_ember_assets` to serve Ember assets in asset-helper style
+  projects.
+
+[#363]: https://github.com/thoughtbot/ember-cli-rails/pull/363
+
 0.6.0
 -----
 

data/README.md

@@ -13,9 +13,13 @@ EmberCLI-Rails is designed to give you the best of both worlds:
   stack through JavaScript-enabled Capybara tests
 * Deploy your entire suite of applications to Heroku with a single `git push`
 
-**EmberCLI-Rails Supports EmberCLI 1.13.x and later.**
+If you're having trouble, checkout the [example project]!
 
-## Installation
+**EmberCLI-Rails Supports EmberCLI 1.13.13 and later.**
+
+[example project]: https://github.com/seanpdoyle/ember-cli-rails-heroku-example
+
+## Install
 
 Add the following to your `Gemfile`:
 
@@ -29,7 +33,13 @@ Then run `bundle install`:
 $ bundle install
 ```
 
-## Usage
+If you haven't created an Ember application yet, generate a new one:
+
+```bash
+$ ember new frontend --skip-git
+```
+
+## Setup
 
 First, generate the gem's initializer:
 
@@ -47,25 +57,19 @@ EmberCli.configure do |c|
 end
 ```
 
-The initializer assumes that your Ember application exists in
+This initializer assumes that your Ember application exists in
 `Rails.root.join("frontend")`.
 
 If this is not the case, you could
 
 * move your existing Ember application into `Rails.root.join("frontend")`
-* configure `frontend` to look for the Ember application in its current
+* configure `frontend` to reference the Ember application in its current
   directory:
 
 ```rb
 c.app :frontend, path: "~/projects/my-ember-app"
 ```
 
-* generate a new Ember project:
-
-```bash
-$ ember new frontend --skip-git
-```
-
 **Initializer options**
 
 - `name` - this represents the name of the Ember CLI application.
@@ -105,7 +109,9 @@ For instance, if you're using the `0.6.x` version of the gem, specify
 [addon]: https://github.com/rondale-sc/ember-cli-rails-addon/
 [semver]: http://semver.org/
 
-Next, configure Rails to route requests to the `frontend` Ember application:
+## Mount
+
+Configure Rails to route requests to the `frontend` Ember application:
 
 ```rb
 # config/routes.rb
@@ -115,9 +121,6 @@ Rails.application.routes.draw do
 end
 ```
 
-Ember requests will be set `params[:ember_app]` to the name of the application.
-In the above example, `params[:ember_app] == :frontend`.
-
 **Routing options**
 
 * `to` - The path to handle as an Ember application. This will only apply to
@@ -136,7 +139,69 @@ $ rake ember:install
 Boot your Rails application, navigate to `"/"`, and view your EmberCLI
 application!
 
-## Heroku
+## Develop
+
+EmberCLI Rails exposes several useful rake tasks.
+
+**`ember:install`**
+
+Install the Ember applications' dependencies.
+
+**`ember:compile`**
+
+Compile the Ember applications.
+
+**`ember:test`**
+
+Execute Ember's test suite.
+
+If you're using Rake to run the test suite, make sure to configure your test
+task to depend on `ember:test`.
+
+For example, to configure a bare `rake` command to run both RSpec and Ember test
+suites, configure the `default` task to depend on both `spec` and `ember:test`.
+
+```rb
+task default: [:spec, "ember:test"]
+```
+
+## Deploy
+
+In production environments, assets should be served over a
+Content Delivery Network.
+
+Configuring an `ember-cli-rails` application to serve Ember's assets over a CDN
+is very similar to [configuring an EmberCLI application to serve assets over a
+CDN][ember-cli-cdn]:
+
+[ember-cli-cdn]: http://ember-cli.com/user-guide/#fingerprinting-and-cdn-urls
+
+```js
+var app = new EmberApp({
+  fingerprint: {
+    prepend: 'https://cdn.example.com/'
+  }
+});
+```
+
+If you're serving the Ember application from a path other than `"/"`, the
+`prepend` URL must end with the mounted path:
+
+```js
+var app = new EmberApp({
+  fingerprint: {
+    // for an Ember application mounted to `/admin_panel/`
+    prepend: 'https://cdn.example.com/admin_panel/',
+  }
+});
+```
+
+As long as your [CDN is configured to pull from your Rails application][dns-cdn]
+, your assets will be served over the CDN.
+
+[dns-cdn]: https://robots.thoughtbot.com/dns-cdn-origin
+
+### Heroku
 
 To configure your EmberCLI-Rails applications for Heroku:
 
@@ -163,7 +228,32 @@ applications into the project.
 
 [buildpack]: https://devcenter.heroku.com/articles/using-multiple-buildpacks-for-an-app#adding-a-buildpack
 
-## Overriding the defaults
+### Capistrano
+
+EmberCLI-Rails executes both `npm install` and `bower install` during EmberCLI's
+compilation, triggered by the  `asset:precompilation` rake task.
+
+The `npm` and `bower` executables are required to be defined in the deployment
+SSH session's `$PATH`. It is not sufficient to modify the session's `$PATH` in
+a `.bash_profile`.
+
+To resolve this issue, prepend the Node installation's `bin` directory to the
+target system's `$PATH`:
+
+```ruby
+#config/deploy/production.rb
+
+set :default_env, {
+  "PATH" => "/home/deploy/.nvm/versions/node/v4.2.1/bin:$PATH"
+}
+```
+
+The system in this example is using `nvm` to configure the node version. If
+you're not using `nvm`, make sure the string you prepend to the `$PATH` variable
+contains the directory or directories that contain the `bower` and `npm`
+executables.
+
+## Override
 
 By default, routes defined by `ember_app` will be rendered with the internal
 `EmberCli::EmberController`.
@@ -235,7 +325,7 @@ class ApplicationController < ActionController::Base
 end
 ```
 
-#### Rendering the EmberCLI generated JS and CSS
+### Rendering the EmberCLI generated JS and CSS
 
 Rendering EmberCLI applications with `render_ember_app` is the recommended,
 actively supported method of serving EmberCLI applications.
@@ -253,9 +343,9 @@ In the corresponding view, use the asset helpers:
 <%= include_ember_stylesheet_tags :frontend %>
 ```
 
-### Mounting the Ember applications
+### Mounting multiple Ember applications
 
-Rendering Ember applications from routes other than `/` requires additional
+Rendering Ember applications to paths other than `/` requires additional
 configuration.
 
 Consider a scenario where you had Ember applications named `frontend` and
@@ -339,6 +429,7 @@ and `include_ember_stylesheet_tags` helpers to a path other than `"/"`, a
 `<base>` tag must also be injected with a corresponding `href` value:
 
 ```erb
+<base href="/">
 <%= include_ember_script_tags :frontend %>
 <%= include_ember_stylesheet_tags :frontend %>
 
@@ -347,6 +438,18 @@ and `include_ember_stylesheet_tags` helpers to a path other than `"/"`, a
 <%= include_ember_stylesheet_tags :admin_panel %>
 ```
 
+If you're using the `include_ember` style helpers with a single-page Ember
+application that defers routing to the Rails application, insert a call to
+`mount_ember_assets` at the bottom of your routes file to serve the
+EmberCLI-generated assets:
+
+```rb
+# config/routes.rb
+Rails.application.routes.draw do
+  mount_ember_assets :frontend, to: "/"
+end
+```
+
 ## CSRF Tokens
 
 Your Rails controllers, by default, expect a valid authenticity token to
@@ -377,32 +480,6 @@ the CSRF tags to its view's `<head>`.
 [ember-cli-rails-addon][addon] configures your Ember application to make HTTP
 requests with the injected CSRF tokens in the `X-CSRF-TOKEN` header.
 
-### Integrating with Rake
-
-EmberCLI Rails exposes several useful rake tasks.
-
-**`ember:install`**
-
-Install the Ember applications' dependencies.
-
-**`ember:compile`**
-
-Compile the Ember applications.
-
-**`ember:test`**
-
-Execute Ember's test suite.
-
-If you're using Rake to run the test suite, make sure to configure your test
-task to depend on `ember:test`.
-
-For example, to configure a bare `rake` command to run both RSpec and Ember test
-suites, configure the `default` task to depend on both `spec` and `ember:test`.
-
-```rb
-task default: [:spec, "ember:test"]
-```
-
 ## Serving from multi-process servers in development
 
 If you're using a multi-process server ([Puma], [Unicorn], etc.) in development,
@@ -415,7 +492,7 @@ EmberCLI runners to clobber each others' work][#94].
 [Unicorn]: https://rubygems.org/gems/unicorn
 [#94]: https://github.com/thoughtbot/ember-cli-rails/issues/94#issuecomment-77627453
 
-### `RAILS_ENV`
+## `RAILS_ENV`
 
 While being managed by EmberCLI Rails, EmberCLI process will have
 access to the `RAILS_ENV` environment variable. This can be helpful to detect
@@ -441,6 +518,12 @@ if (environment === 'development') {
 
 [ember-cli-mirage]: http://ember-cli-mirage.com/docs/latest/
 
+## EmberCLI support
+
+This project supports:
+
+* EmberCLI versions `>= 1.13.13`
+
 ## Ruby and Rails support
 
 This project supports:

data/app/helpers/ember_rails_helper.rb

@@ -1,34 +1,13 @@
-require "ember_cli/capture"
-require "ember_cli/assets"
+require "html_page/capture"
 
 module EmberRailsHelper
   def render_ember_app(name, &block)
     EmberCli[name].build
 
-    markup_capturer = EmberCli::Capture.new(sprockets: self, &block)
+    markup_capturer = HtmlPage::Capture.new(self, &block)
 
     head, body = markup_capturer.capture
 
     render inline: EmberCli[name].index_html(head: head, body: body)
   end
-
-  def include_ember_script_tags(name, **options)
-    EmberCli[name].build
-
-    assets = EmberCli::Assets.new(EmberCli[name])
-
-    assets.javascript_assets.
-      map { |src| %{<script src="#{src}"></script>}.html_safe }.
-      reduce(&:+)
-  end
-
-  def include_ember_stylesheet_tags(name, **options)
-    EmberCli[name].build
-
-    assets = EmberCli::Assets.new(EmberCli[name])
-
-    assets.stylesheet_assets.
-      map { |src| %{<link rel="stylesheet" href="#{src}">}.html_safe }.
-      reduce(&:+)
-  end
 end

data/lib/ember-cli-rails.rb

@@ -1,5 +1,6 @@
 require "fileutils"
-require "ember_cli/engine" if defined?(Rails)
+require "ember_cli/engine"
+require "ember-cli-rails-assets"
 require "ember_cli/errors"
 
 module EmberCli

data/lib/ember_cli/app.rb

@@ -1,5 +1,5 @@
 require "ember_cli/shell"
-require "ember_cli/html_page"
+require "html_page/renderer"
 require "ember_cli/build_monitor"
 
 module EmberCli
@@ -24,10 +24,14 @@ module EmberCli
       @build = BuildMonitor.new(name, @paths)
     end
 
-    def root
+    def root_path
       paths.root
     end
 
+    def dist_path
+      paths.dist
+    end
+
     def compile
       @compiled ||= begin
         prepare
@@ -49,7 +53,7 @@ module EmberCli
 
     def index_html(head:, body:)
       if index_file.exist?
-        html = HtmlPage.new(
+        html = HtmlPage::Renderer.new(
           head: head,
           body: body,
           content: index_file.read,

data/lib/ember_cli/path_set.rb

@@ -34,22 +34,10 @@ module EmberCli
       @dist ||= ember_cli_root.join("apps", app_name).tap(&:mkpath)
     end
 
-    def asset_map
-      @asset_map ||= Pathname.glob(assets.join("assetMap*.json")).first
-    end
-
-    def assets
-      @assets ||= dist.join("assets").tap(&:mkpath)
-    end
-
     def gemfile
       @gemfile ||= root.join("Gemfile")
     end
 
-    def package_json_file
-      @package_json_file ||= root.join("package.json")
-    end
-
     def ember
       @ember ||= begin
         root.join("node_modules", ".bin", "ember").tap do |path|

data/lib/ember_cli/route_helpers.rb

@@ -14,13 +14,13 @@ module ActionDispatch
           format: :html,
         )
 
-        dist_directory = EmberCli[app_name].paths.dist
-
         Rails.application.routes.draw do
           scope constraints: EmberCli::HtmlConstraint.new do
             get("#{to}(*rest)", routing_options)
           end
 
+          dist_directory = EmberCli[app_name].paths.dist
+
           mount Rack::File.new(dist_directory.to_s) => to
         end
       end

data/lib/ember_cli/version.rb

@@ -1,3 +1,3 @@
 module EmberCli
-  VERSION = "0.6.0".freeze
+  VERSION = "0.6.1".freeze
 end

data/lib/generators/ember/heroku/heroku_generator.rb

@@ -19,7 +19,7 @@ module EmberCli
 
     def app_paths
       EmberCli.apps.values.map do |app|
-        app.root.relative_path_from(Rails.root)
+        app.root_path.relative_path_from(Rails.root)
       end
     end
   end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ember-cli-rails
 version: !ruby/object:Gem::Version
-  version: 0.6.0
+  version: 0.6.1
 platform: ruby
 authors:
 - Pavel Pravosud
@@ -10,8 +10,22 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-12-11 00:00:00.000000000 Z
+date: 2015-12-19 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: ember-cli-rails-assets
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.6.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.6.1
 - !ruby/object:Gem::Dependency
   name: railties
   requirement: !ruby/object:Gem::Requirement
@@ -46,6 +60,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 0.5.8
+- !ruby/object:Gem::Dependency
+  name: html_page
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.1.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.1.0
 description: 
 email:
 - pavel@pravosud.com
@@ -63,18 +91,13 @@ files:
 - app/views/ember_cli/ember/index.html.erb
 - lib/ember-cli-rails.rb
 - lib/ember_cli/app.rb
-- lib/ember_cli/asset_map.rb
-- lib/ember_cli/assets.rb
 - lib/ember_cli/build_monitor.rb
-- lib/ember_cli/capture.rb
 - lib/ember_cli/command.rb
 - lib/ember_cli/configuration.rb
-- lib/ember_cli/directory_asset_map.rb
 - lib/ember_cli/engine.rb
 - lib/ember_cli/errors.rb
 - lib/ember_cli/helpers.rb
 - lib/ember_cli/html_constraint.rb
-- lib/ember_cli/html_page.rb
 - lib/ember_cli/path_set.rb
 - lib/ember_cli/route_helpers.rb
 - lib/ember_cli/runner.rb

data/lib/ember_cli/asset_map.rb

@@ -1,64 +0,0 @@
-require "ember_cli/errors"
-
-module EmberCli
-  class AssetMap
-    def initialize(ember_app_name:, asset_map:)
-      @ember_app_name = ember_app_name
-      @asset_map = asset_map
-    end
-
-    def javascripts
-      assert_asset_map!
-
-      [
-        asset_matching(%r{vendor(.*)\.js\z}),
-        asset_matching(%r{#{ember_app_name}(.*)\.js\z}),
-      ]
-    end
-
-    def stylesheets
-      assert_asset_map!
-
-      [
-        asset_matching(%r{vendor(.*)\.css\z}),
-        asset_matching(%r{#{ember_app_name}(.*)\.css\z}),
-      ]
-    end
-
-    private
-
-    attr_reader :app_name, :ember_app_name, :asset_map
-
-    def asset_matching(regex)
-      matching_asset = files.detect { |asset| asset =~ regex }
-
-      if matching_asset.blank?
-        raise_missing_asset(regex)
-      end
-
-      prepend + matching_asset
-    end
-
-    def prepend
-      asset_map["prepend"].to_s
-    end
-
-    def files
-      Array(assets.values)
-    end
-
-    def assets
-      asset_map["assets"] || {}
-    end
-
-    def raise_missing_asset(regex)
-      raise BuildError.new("Failed to find assets matching `#{regex}`")
-    end
-
-    def assert_asset_map!
-      if assets.empty?
-        raise BuildError.new("Missing `#{ember_app_name}/assets/assetMap.json`")
-      end
-    end
-  end
-end

data/lib/ember_cli/assets.rb

@@ -1,51 +0,0 @@
-require "ember_cli/errors"
-require "ember_cli/asset_map"
-require "ember_cli/directory_asset_map"
-
-module EmberCli
-  class Assets
-    def initialize(app)
-      @app = app
-    end
-
-    def javascript_assets
-      asset_map.javascripts
-    end
-
-    def stylesheet_assets
-      asset_map.stylesheets
-    end
-
-    private
-
-    attr_reader :app
-
-    def asset_map
-      AssetMap.new(
-        ember_app_name: ember_app_name,
-        asset_map: asset_map_hash.to_h,
-      )
-    end
-
-    def asset_map_file
-      app.paths.asset_map
-    end
-
-    def asset_map_hash
-      if asset_map_file.present? && asset_map_file.exist?
-        JSON.parse(asset_map_file.read)
-      else
-        DirectoryAssetMap.new(app.paths.assets)
-      end
-    end
-
-    def ember_app_name
-      @ember_app_name ||= app.options.fetch(:name) { package_json.fetch(:name) }
-    end
-
-    def package_json
-      @package_json ||=
-        JSON.parse(app.paths.package_json_file.read).with_indifferent_access
-    end
-  end
-end

data/lib/ember_cli/capture.rb

@@ -1,77 +0,0 @@
-module EmberCli
-  class Capture
-    def initialize(sprockets:, &block)
-      @sprockets = sprockets
-      @block = block || NullBlock.new
-    end
-
-    def capture
-      if block.arity > 0
-        block.call(*block_arguments)
-      end
-
-      [head.content, body.content]
-    end
-
-    private
-
-    attr_reader :block, :sprockets
-
-    def block_arguments
-      [head, body].first(block.arity)
-    end
-
-    def body
-      @body ||= Block.new(sprockets)
-    end
-
-    def head
-      @head ||= begin
-        if block.arity < 1
-          BlockWithoutArguments.new(sprockets, &block)
-        else
-          Block.new(sprockets)
-        end
-      end
-    end
-
-    class BlockWithoutArguments
-      def initialize(sprockets, &block)
-        @sprockets = sprockets
-        @block = block
-      end
-
-      def content
-        @sprockets.with_output_buffer(&@block)
-      end
-    end
-    private_constant :BlockWithoutArguments
-
-    class Block
-      def initialize(sprockets)
-        @sprockets = sprockets
-        @content = []
-      end
-
-      def append(&block)
-        @content.push(@sprockets.with_output_buffer(&block))
-        nil
-      end
-
-      def content
-        @content.join
-      end
-    end
-    private_constant :Block
-
-    class NullBlock
-      def arity
-        1
-      end
-
-      def call(*)
-      end
-    end
-    private_constant :NullBlock
-  end
-end

data/lib/ember_cli/directory_asset_map.rb

@@ -1,30 +0,0 @@
-module EmberCli
-  class DirectoryAssetMap
-    def initialize(directory)
-      @directory = Pathname(directory)
-    end
-
-    def to_h
-      {
-        "assets" => files_with_data,
-        "prepend" => "assets/",
-      }
-    end
-
-    def files_with_data
-      files.reduce({}) do |manifest, file|
-        name = File.basename(file.path)
-
-        manifest[name] = name
-
-        manifest
-      end
-    end
-
-    private
-
-    def files
-      @directory.children.map { |path| File.new(path) }
-    end
-  end
-end

data/lib/ember_cli/html_page.rb

@@ -1,49 +0,0 @@
-module EmberCli
-  class HtmlPage
-    def initialize(content:, head: "", body: "")
-      @content = content
-      @head = head
-      @body = body
-    end
-
-    def render
-      if has_head_tag?
-        insert_head_content
-      end
-
-      if has_body_tag?
-        insert_body_content
-      end
-
-      content
-    end
-
-    private
-
-    attr_reader :content
-
-    def has_head_tag?
-      head_tag_index >= 0
-    end
-
-    def has_body_tag?
-      body_tag_index >= 0
-    end
-
-    def insert_head_content
-      content.insert(head_tag_index, @head.to_s)
-    end
-
-    def insert_body_content
-      content.insert(body_tag_index, @body.to_s)
-    end
-
-    def head_tag_index
-      content.index("</head") || -1
-    end
-
-    def body_tag_index
-      content.index("</body") || -1
-    end
-  end
-end