ember-cli-rails-deploy-redis 0.0.2 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c0829308f6398b8ade4f11bf04fa83b3a7243392
-  data.tar.gz: 5e19061bab3f94f1041f9d1d0553e70f80eaa459
+  metadata.gz: b5c7f3078429466c27bcc7f640adb22618d35ed1
+  data.tar.gz: 7e4e2b8d539de1d7b1d28e225d35082859d3ca7b
 SHA512:
-  metadata.gz: c0952a9566d0e83d4ed00b81e4ae3e7337847162078d7627768672a1724e531c3300a3ab3fd13788d298da79126d4c3cb0f9eda008b3bf5532c00ba4760584da
-  data.tar.gz: c19d3a1e60490a052575ffca1784903ea56f2dda20bb7e197688f34b683dde7d26c21bd8007be9f7030ad8359ecdff0a7516961227a877b2e6b9326510357f42
+  metadata.gz: 8a26fe4f83931158dfdfe225543c5b21d836a25affb880a76df464afabaf22a4159ea0f9c32ef2aa3e71f16ab0221bd62829b1ca11d0393f9bb3c2abaa28005a
+  data.tar.gz: 8a0e9cad0901ea1e63b31dc315e9d35fc7200148fd13ec2fa5da755bfc6b28ed60f17b276ca067fcc37c7eb51b172e6b1da7e8028399a7dabaceb62772deb573

data/CHANGELOG.md

@@ -1,6 +1,15 @@
 master
 ------
 
+0.1.0
+-----
+
+* Integrate with `ember-cli-rails` deployment strategies. [#4]
+* Rename `EmberCLI` module to `EmberCli`. [#4]
+* Rename `ember-cli` directories to `ember_cli`. [#4]
+
+[#4]: https://github.com/seanpdoyle/ember-cli-rails-deploy-redis/pull/4
+
 0.0.2
 -----
 

data/README.md

@@ -1,119 +1,126 @@
-# EmberCLI::Rails - Deploy Redis
+# EmberCli::Deploy::Redis
 
-[EmberCLI Rails] is an integration story between (surprise suprise) EmberCLI and
-Rails 3.1 and up.
+[EmberCLI Rails] is a tool to unify your EmberCLI and Rails Workflows.
 
 [ember-cli-deploy] is a simple, flexible deployment for your Ember CLI app.
 
-[ember-deploy-redis] is the redis-adapter implementation to use Redis with ember-deploy.
+[ember-cli-deploy-redis] is an `ember-cli-deploy` plugin to upload `index.html`
+to a Redis store.
 
-`ember-cli-rails-deploy-redis` wires up all three.
+`ember-cli-rails-deploy-redis` is a gem that integrates all three.
 
-[EmberCLI Rails]: https://github.com/rwz/ember-cli-rails
-[ember-cli-deploy]: https://github.com/ember-cli/ember-cli-deploy
-[ember-deploy-redis]: https://github.com/LevelbossMike/ember-deploy-redis
+This project streamlines the process of pushing and serving EmberCLI-built
+assets from Rails.
 
-## Installation
+[EmberCLI Rails]: https://github.com/thoughtbot/ember-cli-rails
+[ember-cli-deploy]: http://ember-cli.com/ember-cli-deploy/
+[ember-cli-deploy-redis]: https://github.com/ember-cli-deploy/ember-cli-deploy-redis
+
+## Install
 
 Add this line to your application's Gemfile:
 
 ```ruby
-gem 'ember-cli-rails-deploy-redis'
+group :production do
+  gem "ember-cli-rails-deploy-redis"
+end
 ```
 
 And then execute:
 
 ```bash
-$ bundle
+$ bundle install
 ```
 
-## Usage
+## Setup
 
-The EmberCLI community recently unified the various deployment techniques into a
-single, core-team supported project: [ember-cli-deploy][ember-cli-deploy].
+First, [configure your application to integrate with
+`ember-cli-rails`][ember-cli-rails-setup].
 
-This project attempts to streamline the process of pushing and serving
-EmberCLI-built static assets.
+Then, to integrate with `ember-cli-deploy`'s ["Lightning Fast Deploys"][lightning]
+(using the Redis adapter) in `production`, instantiate configure EmberCLI-Rails
+to deploy with the `EmberCli::Deploy::Redis` strategy:
 
-To integrate with `ember-cli-deploy`'s ["Lightning Fast Deploys"][lightning]
-(using the Redis adapter), instantiate an `EmberCLI::Deploy::Redis`
-in your controller:
+[ember-cli-rails-setup]: https://github.com/thoughtbot/ember-cli-rails#setup
 
 ```ruby
-require "ember-cli/deploy/redis"
-
-class ApplicationController < ActionController::Base
-  def index
-    @deploy = EmberCLI::Deploy::Redis.new(namespace: "frontend")
+# config/initializers/ember.rb
 
-    render text: @deploy.html, layout: false
-  end
+EmberCli.configure do |config|
+  config.app :frontend, deploy: { production: EmberCli::Deploy::Redis }
 end
 ```
 
-`EmberCLI::Deploy::Redis` takes a `namespace` (the name of your app declared in
-your initializer) and handles all interaction with the Redis instance.
+Finally, set `ENV["REDIS_URL"]` to the URL [ember-cli-deploy-redis references][redis-config].
 
-This is great for `staging` and `production` deploys, but introduces an extra
-step in the feedback loop during development.
+If you're deploying from Redis in `development` or `test`, disable
+EmberCLI-Rails' build step by setting `ENV["SKIP_EMBER"] = true`.
 
-Luckily, `EmberCLI::Deploy::Redis` also accepts an `index_html` override, which
-will replace the call to the Redis instance. This allows integration with the
-normal `ember-cli-rails` workflow:
+[redis-config]: https://github.com/ember-cli-deploy/ember-cli-deploy-redis#configuration-options
 
-```ruby
-require "ember-cli/deploy/redis"
+## Deploy
 
-class ApplicationController < ActionController::Base
-  def index
-    @deploy = EmberCLI::Deploy::Redis.new(
-      namespace: "frontend",
-      index_html: index_html,
-    )
+Deploy your application through [ember-cli-deploy-redis][deploy].
 
-    render text: @deploy.html, layout: false
-  end
+[deploy]: https://github.com/ember-cli-deploy/ember-cli-deploy-redis#quick-start
 
-  private
+## Use without `ember-cli-rails`
 
-  def index_html
-    if serve_with_ember_cli_rails?
-      render_to_string(:index)
-    end
-  end
+Although this gem was designed to integrate with `ember-cli-rails`, there isn't
+a direct dependency on it.
 
-  def serve_with_ember_cli_rails?
-    ! %w[production staging].include?(Rails.env)
-  end
-end
-```
+Similar behavior can be achieved by using a gem like [`html_page`][html_page]:
 
-Additionally, having access to the outbound HTML beforehand also enables
-controllers to inject additional markup, such as metadata, CSRF tokens, or
-analytics tags:
+[html_page]: https://github.com/seanpdoyle/html_page
 
+```rb
+require "html_page"
 
-```ruby
-require "ember-cli/deploy"
+class EmberHelper
+  def render_html(html)
+    capturer = HtmlPage::Capture.new(self, &block)
 
-class ApplicationController < ActionController::Base
-  def index
-    @deploy = EmberCLI::Deploy::Redis.new(
-      namespace: "frontend",
-      index_html: index_html,
+    head, body = capturer.capture
+
+    renderer = HtmlPage::Renderer.new(
+      content: html,
+      head: head,
+      body: body,
     )
 
-    @deploy.append_to_head(render_to_string(partial: "my_csrf_and_metadata")
-    @deploy.append_to_body(render_to_string(partial: "my_analytics")
+    render inline: renderer.render
+  end
+end
+
+class EmberController
+  def index
+    redis = EmberCli::Deploy::Redis.new(ember_app)
 
-    render text: @deploy.html, layout: false
+    @html_from_redis = redis.index_html
+
+    render layout: false
+  end
+
+  private
+
+  def ember_app
+    OpenStruct.new(name: "my-ember-app")
   end
-  # ...
 end
 ```
 
-[ember-cli-deploy]: https://github.com/ember-cli/ember-cli-deploy
-[lightning]: https://github.com/ember-cli/ember-cli-deploy#lightning-approach-workflow
+```erb
+<!-- app/views/ember/index.html.erb -->
+<%= render_html @html_from_redis do |head, body| %>
+  <% head.append do %>
+    <title>Appended to the `head` element</title>
+  <% end %>
+
+  <% body.append do %>
+    <p>Appended to the `body` element</p>
+  <% end %>
+<% end %>
+```
 
 ## Development
 

data/ember-cli-rails-deploy-redis.gemspec

@@ -1,11 +1,11 @@
 # coding: utf-8
 lib = File.expand_path("../lib", __FILE__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require "ember-cli/deploy/version"
+require "ember_cli/deploy/redis/version"
 
 Gem::Specification.new do |spec|
   spec.name          = "ember-cli-rails-deploy-redis"
-  spec.version       = EmberCLI::Deploy::VERSION
+  spec.version       = EmberCli::Deploy::Redis::VERSION
   spec.authors       = ["Sean Doyle"]
   spec.email         = ["sean.p.doyle24@gmail.com"]
 

data/lib/ember_cli/deploy/redis.rb

@@ -0,0 +1,55 @@
+require "active_support/core_ext/object/blank"
+require "redis"
+
+module EmberCli
+  module Deploy
+    class Redis
+      def initialize(app)
+        @app = app
+      end
+
+      def index_html
+        redis_client.get(deploy_key).presence || index_html_missing!
+      end
+
+      private
+
+      attr_reader :app
+
+      def redis_client
+        @redis_client ||= ::Redis.new(url: ENV.fetch("REDIS_URL"))
+      end
+
+      def namespace
+        app.name
+      end
+
+      def current_key
+        "#{namespace}:current"
+      end
+
+      def deploy_key
+        key = redis_client.get(current_key).presence ||
+              deployment_not_activated!
+
+        "#{namespace}:#{key}"
+      end
+
+      def index_html_missing!
+        raise KeyError.new <<-FAIL
+        HTML for #{deploy_key} is missing.
+
+        Did you forget to call `ember deploy`?
+        FAIL
+      end
+
+      def deployment_not_activated!
+        raise KeyError.new <<-FAIL
+        #{current_key} is empty.
+
+        Did you forget to call `ember deploy:activate`?
+        FAIL
+      end
+    end
+  end
+end

data/lib/ember_cli/deploy/redis/version.rb

@@ -0,0 +1,7 @@
+module EmberCli
+  module Deploy
+    class Redis
+      VERSION = "0.1.0"
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ember-cli-rails-deploy-redis
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.1.0
 platform: ruby
 authors:
 - Sean Doyle
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2015-12-13 00:00:00.000000000 Z
+date: 2015-12-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: railties
@@ -147,9 +147,8 @@ files:
 - bin/console
 - bin/setup
 - ember-cli-rails-deploy-redis.gemspec
-- lib/ember-cli/deploy/page.rb
-- lib/ember-cli/deploy/redis.rb
-- lib/ember-cli/deploy/version.rb
+- lib/ember_cli/deploy/redis.rb
+- lib/ember_cli/deploy/redis/version.rb
 homepage: https://github.com/seanpdoyle/ember-cli-rails-deploy-redis
 licenses:
 - MIT
@@ -170,9 +169,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.0
+rubygems_version: 2.4.5.1
 signing_key: 
 specification_version: 4
 summary: Lightning Fast deploys with ember-cli-rails
 test_files: []
-has_rdoc: 

data/lib/ember-cli/deploy/page.rb

@@ -1,55 +0,0 @@
-module EmberCLI
-  module Deploy
-    class Page
-      def initialize(html:)
-        @html = html.clone
-        @body_markup = []
-        @head_markup = []
-      end
-
-      def build
-        if has_head?
-          head_markup.each do |markup|
-            html.insert(head_position, markup)
-          end
-        end
-
-        if has_body?
-          body_markup.each do |markup|
-            html.insert(body_position, markup)
-          end
-        end
-
-        html
-      end
-
-      def append_to_body(markup)
-        body_markup << markup
-      end
-
-      def append_to_head(markup)
-        head_markup << markup
-      end
-
-      private
-
-      attr_reader :body_markup, :head_markup, :html
-
-      def has_head?
-        html.include?("<head")
-      end
-
-      def has_body?
-        html.include?("<body")
-      end
-
-      def head_position
-        html.index("</head")
-      end
-
-      def body_position
-        html.index("</body")
-      end
-    end
-  end
-end

data/lib/ember-cli/deploy/redis.rb

@@ -1,84 +0,0 @@
-require "active_support/core_ext/object/blank"
-require "ember-cli/deploy/page"
-require "redis"
-
-module EmberCLI
-  module Deploy
-    class Redis
-      def initialize(namespace:, index_html: nil, redis_client: build_client)
-        @redis_client = redis_client
-        @namespace = namespace
-        @index_html = index_html
-        @body_markup = []
-        @head_markup = []
-      end
-
-      def append_to_body(markup)
-        body_markup << markup
-      end
-
-      def append_to_head(markup)
-        head_markup << markup
-      end
-
-      def html
-        if index_html.present?
-          page = Page.new(html: index_html)
-
-          body_markup.each do |markup|
-            page.append_to_body(markup)
-          end
-
-          head_markup.each do |markup|
-            page.append_to_head(markup)
-          end
-
-          page.build
-        else
-          index_html_missing!
-        end
-      end
-
-      private
-
-      attr_reader :body_markup, :head_markup, :namespace, :redis_client
-
-      def index_html
-        @index_html ||= redis_client.get(deploy_key).presence
-      end
-
-      def current_key
-        "#{namespace}:current"
-      end
-
-      def deploy_key
-        key = redis_client.get(current_key).presence || deployment_not_activated!
-        "#{namespace}:#{key}"
-      end
-
-      def build_client
-        ::Redis.new(url: ENV.fetch("REDIS_URL"))
-      end
-
-      def index_html_missing!
-        message = <<-FAIL
-        HTML for #{deploy_key} is missing.
-
-        Did you forget to call `ember deploy`?
-        FAIL
-
-        raise KeyError, message
-      end
-
-      def deployment_not_activated!
-        message = <<-FAIL
-        #{current_key} is empty.
-
-        Did you forget to call `ember deploy:activate`?
-        FAIL
-
-        raise KeyError, message
-      end
-    end
-  end
-end

data/lib/ember-cli/deploy/version.rb

@@ -1,5 +0,0 @@
-module EmberCLI
-  module Deploy
-    VERSION = "0.0.2"
-  end
-end