ember-cli-rails-assets-6 0.6.2.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 2054ef506715b40221c284dbe44c99614cb5347bbaa111831ec9928ba893deb3
+  data.tar.gz: e95641066476364865bfa44b6242f286945a1d874f6ab7747c98f4a7593c24fe
+SHA512:
+  metadata.gz: 555e0bc7e8f4ad61e7bc9a056ebd57120b55c2885f0740e43b3dce0fcd270666b942bb8a9f4f2960789f1055b32db36f3b7e7750489f3d711834b36bd9e9ad25
+  data.tar.gz: ae197e756b8c79c0baf248ecd0a4e8bfdbf34e7640f21d3ccb5683e363c578b68d65a10653dff08cd4b2e76204aa0c83a61134d6714311b90696de24449ffb66

data/README.md

@@ -0,0 +1,165 @@
+# EmberCLI Rails - Assets
+
+The `ember-cli-rails-assets` gem extends [`ember-cli-rails`][ember-cli-rails] to
+enable rendering EmberCLI-generated JavaScript and CSS stylesheets into your
+Rails application's layout HTML.
+
+**This project and the behavior it supports is deprecated.**
+
+Rendering EmberCLI applications with `render_ember_app` is the recommended,
+actively supported method of serving EmberCLI applications.
+
+However, for the sake of backwards compatibility, `ember-cli-rails-assets`
+supports injecting the EmberCLI-generated assets into an existing Rails layout.
+
+[ember-cli-rails]: https://github.com/thoughtbot/ember-cli-rails
+
+## Install
+
+Add the following to your `Gemfile`:
+
+```ruby
+gem "ember-cli-rails-assets"
+```
+
+Then run `bundle install`:
+
+```bash
+$ bundle install
+```
+
+## Setup
+
+To configure your project to use `ember-cli-rails`, follow the instructions
+listed in the [`ember-cli-rails` README][README].
+
+To configure your project to user `ember-cli-rails-assets`, ensure each Ember
+application's `ember-cli-build.js` includes the following values:
+
+```js
+// frontend/ember-cli-build.js
+
+module.exports = function(defaults) {
+  var app = new EmberApp(defaults, {
+    // http://ember-cli.com/user-guide/#application-configuration
+    storeConfigInMeta: false,
+
+    fingerprint: {
+      // https://github.com/rickharrison/broccoli-asset-rev#options
+      generateAssetMap: true,
+    },
+  });
+};
+```
+
+[README]: https://github.com/thoughtbot/ember-cli-rails#readme
+
+## Mount
+
+Mount the Ember application (in this example, the `frontend` application) to the
+desired path:
+
+```rb
+# config/routes.rb
+
+Rails.application.routes.draw do
+  mount_ember_app :frontend, to: "/", controller: "ember#index"
+end
+```
+
+Then, in the corresponding view, use the asset helpers:
+
+```erb
+<!-- app/views/ember/index.html.erb -->
+
+<%= include_ember_script_tags :frontend %>
+<%= include_ember_stylesheet_tags :frontend %>
+```
+
+## Caveats
+
+### Mounting
+
+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
+```
+
+### Rendering
+
+When injecting the EmberCLI-generated assets with the `include_ember_script_tags`
+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 %>
+
+<base href="/admin_panel/">
+<%= include_ember_script_tags :admin_panel %>
+<%= include_ember_stylesheet_tags :admin_panel %>
+```
+
+#### Rendering without `<base>` element
+
+To render the asset elements without using a `<base>` element, pass the URL or
+path to prepend:
+
+```erb
+<-- assuming Ember's assets are mounted to `"/"` -->
+<%= include_ember_script_tags :frontend, prepend: "/" %>
+<%= include_ember_stylesheet_tags :frontend, prepend: "/" %>
+
+<%= include_ember_script_tags :admin_panel, prepend: "/" %>
+<%= include_ember_stylesheet_tags :admin_panel, prepend: "/" %>
+```
+
+## EmberCLI support
+
+This project supports:
+
+* EmberCLI versions `>= 1.13.13`
+
+## Ruby and Rails support
+
+This project supports:
+
+* Ruby versions `>= 2.1.0`
+* Rails versions `>=4.1.x`.
+
+## Contributing
+
+See the [CONTRIBUTING] document.
+Thank you, [contributors]!
+
+  [CONTRIBUTING]: CONTRIBUTING.md
+  [contributors]: https://github.com/seanpdoyle/ember-cli-rails-assets/graphs/contributors
+
+## License
+
+Open source templates are Copyright (c) 2015 Sean Doyle.
+It contains free software that may be redistributed
+under the terms specified in the [LICENSE] file.
+
+[LICENSE]: /LICENSE.txt
+
+## About
+
+ember-cli-rails was originally created by
+[Pavel Pravosud][rwz] and
+[Jonathan Jackson][rondale-sc].
+
+ember-cli-rails-assets was extracted from ember-cli-rails is maintained by
+[Sean Doyle][seanpdoyle].
+
+[rwz]: https://github.com/rwz
+[rondale-sc]: https://github.com/rondale-sc
+[seanpdoyle]: https://github.com/seanpdoyle

data/Rakefile

@@ -0,0 +1,39 @@
+require "rubygems"
+begin
+  require "bundler/setup"
+rescue LoadError
+  puts "You must `gem install bundler` and `bundle install` to run rake tasks"
+end
+require "appraisal"
+
+require "rdoc/task"
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = "rdoc"
+  rdoc.title    = "EmberCli::Assets"
+  rdoc.options << "--line-numbers"
+  rdoc.rdoc_files.include("README.md")
+  rdoc.rdoc_files.include("{app,lib}/**/*.rb")
+end
+
+APP_RAKEFILE = File.expand_path("../spec/dummy/Rakefile", __FILE__)
+load "rails/tasks/engine.rake"
+load "rails/tasks/statistics.rake"
+
+Bundler::GemHelper.install_tasks
+
+require "rspec/core/rake_task"
+
+task(:default).clear
+task default: :spec
+
+if defined? RSpec
+  task(:spec).clear
+  RSpec::Core::RakeTask.new(:spec) do |t|
+    t.verbose = false
+  end
+end
+
+if !ENV["APPRAISAL_INITIALIZED"] && !ENV["TRAVIS"]
+  task :default => :appraisal
+end

data/app/helpers/ember_cli_rails_assets_helper.rb

@@ -0,0 +1,25 @@
+require "ember_cli/assets/lookup"
+
+module EmberCliRailsAssetsHelper
+  def include_ember_script_tags(name, prepend: "")
+    EmberCli[name].build
+
+    assets = EmberCli::Assets::Lookup.new(EmberCli[name])
+
+    assets.javascript_assets.
+      map { |src| [prepend, src].join }.
+      map { |src| %{<script src="#{src}"></script>}.html_safe }.
+      inject(&:+)
+  end
+
+  def include_ember_stylesheet_tags(name, prepend: "")
+    EmberCli[name].build
+
+    assets = EmberCli::Assets::Lookup.new(EmberCli[name])
+
+    assets.stylesheet_assets.
+      map { |src| [prepend, src].join }.
+      map { |src| %{<link rel="stylesheet" href="#{src}">}.html_safe }.
+      inject(&:+)
+  end
+end

data/lib/ember-cli-rails-assets.rb

@@ -0,0 +1,6 @@
+require "ember_cli/assets/engine"
+
+module EmberCli
+  module Assets
+  end
+end

data/lib/ember_cli/assets/asset_map.rb

@@ -0,0 +1,68 @@
+require "ember_cli/assets/errors"
+
+module EmberCli
+  module Assets
+    class AssetMap
+      def initialize(name:, asset_map:)
+        @name = name
+        @asset_map = asset_map
+      end
+
+      def javascripts
+        assert_asset_map!
+
+        [
+          asset_matching(/vendor(.*)\.js\z/),
+          asset_matching(/#{name}(.*)\.js\z/),
+        ]
+      end
+
+      def stylesheets
+        assert_asset_map!
+
+        [
+          asset_matching(/vendor(.*)\.css\z/),
+          asset_matching(/#{name}(.*)\.css\z/),
+        ]
+      end
+
+      private
+
+      attr_reader :name, :asset_map
+
+      def asset_matching(regex)
+        matching_asset = files.detect { |asset| asset =~ regex }
+
+        if matching_asset.to_s.empty?
+          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 <<-MSG
+            Missing `#{name}/assets/assetMap.json`
+          MSG
+        end
+      end
+    end
+  end
+end

data/lib/ember_cli/assets/directory_asset_map.rb

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

data/lib/ember_cli/assets/engine.rb

@@ -0,0 +1,11 @@
+module EmberCli
+  module Assets
+    class Engine < ::Rails::Engine
+      initializer "ember-cli-rails-assets" do
+        ActiveSupport.on_load(:action_controller) do
+          ActionController::Base.helper EmberCliRailsAssetsHelper
+        end
+      end
+    end
+  end
+end

data/lib/ember_cli/assets/errors.rb

@@ -0,0 +1,5 @@
+module EmberCli
+  module Assets
+    class BuildError < StandardError; end
+  end
+end

data/lib/ember_cli/assets/lookup.rb

@@ -0,0 +1,52 @@
+require "ember_cli/assets/paths"
+require "ember_cli/assets/asset_map"
+require "ember_cli/assets/directory_asset_map"
+
+module EmberCli
+  module Assets
+    class Lookup
+      def initialize(app)
+        @paths = Paths.new(app)
+      end
+
+      def javascript_assets
+        asset_map.javascripts
+      end
+
+      def stylesheet_assets
+        asset_map.stylesheets
+      end
+
+      private
+
+      attr_reader :paths
+
+      def asset_map
+        AssetMap.new(
+          name: name_from_package_json,
+          asset_map: asset_map_hash.to_h,
+        )
+      end
+
+      def asset_map_file
+        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(paths.assets)
+        end
+      end
+
+      def name_from_package_json
+        package_json.fetch("name")
+      end
+
+      def package_json
+        @package_json ||= JSON.parse(paths.package_json.read)
+      end
+    end
+  end
+end

data/lib/ember_cli/assets/paths.rb

@@ -0,0 +1,25 @@
+module EmberCli
+  module Assets
+    class Paths
+      def initialize(app)
+        @app = app
+      end
+
+      def assets
+        app.dist_path.join("assets")
+      end
+
+      def asset_map
+        Pathname.glob(assets.join("assetMap*.json")).first
+      end
+
+      def package_json
+        app.root_path.join("package.json")
+      end
+
+      protected
+
+      attr_reader :app
+    end
+  end
+end

data/lib/ember_cli/assets/version.rb

@@ -0,0 +1,5 @@
+module EmberCli
+  module Assets
+    VERSION = "0.6.2.1"
+  end
+end

metadata

@@ -0,0 +1,56 @@
+--- !ruby/object:Gem::Specification
+name: ember-cli-rails-assets-6
+version: !ruby/object:Gem::Version
+  version: 0.6.2.1
+platform: ruby
+authors:
+- Sean Doyle
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2019-11-29 00:00:00.000000000 Z
+dependencies: []
+description: Include EmberCLI-generated JavaScript and CSS stylesheet tags in your
+  Rails layouts
+email:
+- sean.p.doyle24@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- README.md
+- Rakefile
+- app/helpers/ember_cli_rails_assets_helper.rb
+- lib/ember-cli-rails-assets.rb
+- lib/ember_cli/assets/asset_map.rb
+- lib/ember_cli/assets/directory_asset_map.rb
+- lib/ember_cli/assets/engine.rb
+- lib/ember_cli/assets/errors.rb
+- lib/ember_cli/assets/lookup.rb
+- lib/ember_cli/assets/paths.rb
+- lib/ember_cli/assets/version.rb
+homepage: https://github.com/seanpdoyle/ember-cli-rails-assets
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.3
+signing_key: 
+specification_version: 4
+summary: Include EmberCLI-generated JavaScript and CSS stylesheet tags in your Rails
+  layouts
+test_files: []