motorhead 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: cf3ab034b43dbc253be1de3a52bd36888ab9d330
-  data.tar.gz: 84414b462e0b69d805cf8f54b569fc11f99e3107
+  metadata.gz: 246da5136e75d7169d3ec087b9eae348b6bee1c5
+  data.tar.gz: b2ba78b7defc6ad3cfee28339cab1a054279c59d
 SHA512:
-  metadata.gz: 64a8d3b384a52eb0ef859c5a6f02b9386c6efde194d1d4c59ae0241d50815d45b341b675c43378be929ee12aaec0e901a8d81c001af03b4376930d8fe70f52b6
-  data.tar.gz: d26b8028e083213581fbe434f1cf003b5f5fa98caf3863816ad300ae294575e911475455bf4043db32d95d73024be6c2ac9883cd79eb65d46f58f5457795252b
+  metadata.gz: 933ed54450abf427c2bc8a11b12586b930f399eb395eec12562224a1ecbadd1dcbdfe7aa3107c54ebe6138abaa438a16b0663886ec80850cdb3f75bbc6f93d56
+  data.tar.gz: 1bdf2fb57cdde93a48fa81e22d0bc160256217dc7a8eaa08597eb60405b8e47aa1f8310179b745f5a316a0c501c0e7039d998f66112d36e0dd68760ed2280930

data/README.md

@@ -106,6 +106,22 @@ module MyAwesomeNewFeature
 end
 ```
 
+You can configure a path to mount the Engine via `mount_at` directive. This value is defaulted to "/", which means the Engine routes will be mixed into the main app's routes.
+
+Example:
+
+```ruby
+# app/engines/my_awesome_new_feature/config/routes.rb
+module MyAwesomeNewFeature
+  class Engine < ::Rails::Engine
+    include Motorhead::Engine
+
+    # all routes inside this Engine will be prefixed by "/harley"
+    mount_at 'harley'
+  end
+end
+```
+
 ### routes.rb
 
 All routes in engines' routes.rb will be automatically prepended to the main app's Routes.
@@ -189,6 +205,29 @@ Example:
   This generates a motorhead Engine in ~/app/engines/my\_awesome\_new\_feature/ directory.  Plus, a controller that extends WelcomeController and implements index action inside the Engine.
 
 
+## Managing Engines
+
+Motorhead includes a tiny admin console Engine call "RoadCrew" through which you can easily enable/disable each mounted Engine.
+To use this, require `'motorhead/road_crew'` when bundling motorhead gem in your Gemfile:
+
+```ruby
+# Gemfile
+gem 'motorhead', path: '~/src/motorhead', require: ['motorhead', 'motorhead/road_crew']
+```
+
+then render the `road_crew/button` Engine partial to put a button inside somewhere in your view (usually in the header or footer?):
+
+```erb
+# app/views/layouts/application.html.erb
+<%= render engine: 'road_crew/button' %>
+```
+
+You might also want to configure the RoadCrew Engine's `active_if` directive for security.
+
+```ruby
+# config/initializers/mh_road_crew.rb
+RoadCrew::Engine.active_if { current_user.admin? }
+```
 
 
 

data/gemfiles/Gemfile-rails.4.2.x

@@ -10,3 +10,4 @@ gem 'routes_fallback', path: '../test/dummy_app/app/engines/routes_fallback'
 gem 'italian', path: '../test/dummy_app/app/engines/italian'
 gem 'spanish', path: '../test/dummy_app/app/engines/spanish'
 gem 'simple_controller', path: '../test/dummy_app/app/engines/simple_controller'
+gem 'mount_at_capricorn', path: '../test/dummy_app/app/engines/mount_at_capricorn'

data/lib/motorhead/action_view.rb

@@ -4,12 +4,13 @@ ActionView::Base.class_eval do
     if (Hash === options) && options.key?(:engine)
       ext_name = options[:engine][/[^\/]*/]
       if ext_name.classify.constantize::Engine.active? controller
-        return view_renderer.render(self, options, &block)
-      else
-        return capture(&block)
+        view_renderer.render(self, options, &block)
+      elsif block
+        capture(&block)
       end
+    else
+      render_without_motorhead options, locals, &block
     end
-    render_without_motorhead options, locals, &block
   end
 
   alias_method_chain :render, :motorhead

data/lib/motorhead/engine.rb

@@ -3,7 +3,7 @@ module Motorhead
     extend ActiveSupport::Concern
 
     module ClassMethods
-      attr_accessor :on_error
+      attr_accessor :on_error, :mount_at
 
       def active_if(&block)
         @active_if = block
@@ -12,6 +12,10 @@ module Motorhead
       def active?(controller)
         controller.instance_eval(&@active_if)
       end
+
+      def mount_at(path = nil)
+        path ? @mount_at = path : @mount_at
+      end
     end
 
     included do
@@ -20,7 +24,7 @@ module Motorhead
       engine_kls = self
       ActiveSupport.on_load :after_initialize do
         Rails.application.routes.prepend do
-          mount engine_kls, at: '/'
+          mount engine_kls, at: engine_kls.mount_at || '/'
         end
       end
     end

data/lib/motorhead/road_crew.rb

@@ -0,0 +1 @@
+require 'motorhead/road_crew/lib/road_crew'

data/lib/motorhead/road_crew/app/assets/javascripts/road_crew/application.js

@@ -0,0 +1,13 @@
+// This is a manifest file that'll be compiled into application.js, which will include all the files
+// listed below.
+//
+// Any JavaScript/Coffee file within this directory, lib/assets/javascripts, vendor/assets/javascripts,
+// or any plugin's vendor/assets/javascripts directory can be referenced here using a relative path.
+//
+// It's not advisable to add code directly here, but if you do, it'll appear at the bottom of the
+// compiled file.
+//
+// Read Sprockets README (https://github.com/rails/sprockets#sprockets-directives) for details
+// about supported directives.
+//
+//= require_tree .

data/lib/motorhead/road_crew/app/assets/javascripts/road_crew/engine_settings.js

@@ -0,0 +1,2 @@
+// Place all the behaviors and hooks related to the matching controller here.
+// All this logic will automatically be available in application.js.

data/lib/motorhead/road_crew/app/assets/stylesheets/road_crew/application.css

@@ -0,0 +1,15 @@
+/*
+ * This is a manifest file that'll be compiled into application.css, which will include all the files
+ * listed below.
+ *
+ * Any CSS and SCSS file within this directory, lib/assets/stylesheets, vendor/assets/stylesheets,
+ * or any plugin's vendor/assets/stylesheets directory can be referenced here using a relative path.
+ *
+ * You're free to add application-wide styles to this file and they'll appear at the bottom of the
+ * compiled file so the styles you add here take precedence over styles defined in any styles
+ * defined in the other CSS/SCSS files in this directory. It is generally better to create a new
+ * file per style scope.
+ *
+ *= require_tree .
+ *= require_self
+ */

data/lib/motorhead/road_crew/app/assets/stylesheets/road_crew/engine_settings.scss

@@ -0,0 +1,3 @@
+// Place all the styles related to the road_crew/engine_settings controller here.
+// They will automatically be included in application.css.
+// You can use Sass (SCSS) here: http://sass-lang.com/

data/lib/motorhead/road_crew/app/controllers/road_crew/engine_settings_controller.rb

@@ -0,0 +1,18 @@
+class RoadCrew::EngineSettingsController < ActionController::Base
+  include Motorhead::Controller
+  layout false
+
+  def index
+    @engine_settings = JSON.parse(cookies['road_crew_engine_settings'].presence || '{}')
+    all_engine_names = Rails::Engine.subclasses.select {|e| e < Motorhead::Engine}.map {|e| e.parent.name} - ['RoadCrew']
+    # enable by default
+    (all_engine_names - @engine_settings.keys).each {|engine_name| @engine_settings[engine_name] = '1'}
+  end
+
+  def update_all
+#     on, off = engines.partition {|k, v| v == '1'}.map {|a| a.map {|kv| kv.first}}
+    engine_settings = JSON.parse(cookies['road_crew_engine_settings'].presence || '{}').merge params[:engine_setting]
+    cookies['road_crew_engine_settings'] = engine_settings.to_json
+    redirect_to request.referer
+  end
+end

data/lib/motorhead/road_crew/app/views/road_crew/_button.html.erb

@@ -0,0 +1,11 @@
+<%= link_to '㊙️', road_crew.engine_settings_path, id: 'road_crew_button', class: 'closed', remote: true %>
+<div id="road_crew_container" style="position:fixed; bottom: 0px; right: 0px"></div>
+<script type="text/javascript">
+(function() {
+  $(function() {
+    $("#road_crew_button").on("ajax:success", function(e, data, status, xhr) {
+      $("#road_crew_container").html(xhr.responseText);
+    })
+  });
+}).call(this);
+</script>

data/lib/motorhead/road_crew/app/views/road_crew/engine_settings/index.html.erb

@@ -0,0 +1,26 @@
+<div style="background-color: #fbbaaf; border: 1px solid #000; border-radius: 7px; padding: 2px;">
+  <div style="text-align: right;"><%= link_to '×', 'javascript: void(0);', id: 'road_crew_close' %></div>
+  <% if @engine_settings.any? %>
+    <strong>Engines List</strong><br>
+    <%= form_for road_crew.engine_settings_path, method: :put do %>
+      <% @engine_settings.each do |name, enabled| %>
+        <p>
+          <%= hidden_field_tag "engine_setting[#{name}]", '0' %><%= check_box_tag "engine_setting[#{name}]", '1', enabled == '1' %>
+          <label for="<%= "engine_setting_#{name}" %>"><%= name %></label>
+        </p>
+      <% end %>
+      <div style="text-align: center;"><%= submit_tag 'Save' %></div>
+    <% end %>
+  <% else %>
+    No Motorhead Engine found.
+  <% end %>
+</div>
+<script type="text/javascript">
+(function() {
+  $(function() {
+    $("#road_crew_close").on("click", function(e) {
+      $("#road_crew_container").empty();
+    })
+  });
+}).call(this);
+</script>

data/lib/motorhead/road_crew/config/routes.rb

@@ -0,0 +1,4 @@
+RoadCrew::Engine.routes.draw do
+  resources :engine_settings, only: :index
+  put 'engine_settings' => 'engine_settings#update_all'
+end

data/lib/motorhead/road_crew/lib/road_crew.rb

@@ -0,0 +1,2 @@
+require_relative 'road_crew/engine'
+$LOAD_PATH.unshift __dir__

data/lib/motorhead/road_crew/lib/road_crew/engine.rb

@@ -0,0 +1,20 @@
+require 'motorhead/engine'
+
+module RoadCrew
+  class Engine < ::Rails::Engine
+    include Motorhead::Engine
+
+    active_if { true }
+    mount_at 'motorhead/road_crew'
+
+    Motorhead::Engine::ClassMethods.class_eval do
+      # overwrite active? to check cookie value as well
+      def active?(controller)
+        if (settings = controller.send(:cookies)['road_crew_engine_settings'])
+          return false if JSON.parse(settings)[controller.class.parent.name] == '0'
+        end
+        controller.instance_eval(&@active_if)
+      end
+    end
+  end
+end

data/lib/motorhead/road_crew/road_crew.gemspec

@@ -0,0 +1,19 @@
+$:.push File.expand_path("../lib", __FILE__)
+
+# Describe your gem and declare its dependencies:
+Gem::Specification.new do |s|
+  s.name        = "road_crew"
+  s.version     = '0'
+  s.authors     = [""]
+  s.email       = [""]
+  s.homepage    = ""
+  s.summary     = ""
+  s.description = ""
+  s.license     = "MIT"
+
+  s.files = Dir["{app,config,db,lib}/**/*", "MIT-LICENSE", "Rakefile", "README.rdoc"]
+
+  s.add_dependency "rails", "~> 4.2.4"
+
+  s.add_development_dependency "sqlite3"
+end

data/lib/motorhead/version.rb

@@ -1,3 +1,3 @@
 module Motorhead
-  VERSION = '0.2.0'.freeze
+  VERSION = '0.3.0'.freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: motorhead
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Akira Matsuda
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2015-11-06 00:00:00.000000000 Z
+date: 2015-11-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -132,6 +132,18 @@ files:
 - lib/motorhead/action_view.rb
 - lib/motorhead/config.rb
 - lib/motorhead/engine.rb
+- lib/motorhead/road_crew.rb
+- lib/motorhead/road_crew/app/assets/javascripts/road_crew/application.js
+- lib/motorhead/road_crew/app/assets/javascripts/road_crew/engine_settings.js
+- lib/motorhead/road_crew/app/assets/stylesheets/road_crew/application.css
+- lib/motorhead/road_crew/app/assets/stylesheets/road_crew/engine_settings.scss
+- lib/motorhead/road_crew/app/controllers/road_crew/engine_settings_controller.rb
+- lib/motorhead/road_crew/app/views/road_crew/_button.html.erb
+- lib/motorhead/road_crew/app/views/road_crew/engine_settings/index.html.erb
+- lib/motorhead/road_crew/config/routes.rb
+- lib/motorhead/road_crew/lib/road_crew.rb
+- lib/motorhead/road_crew/lib/road_crew/engine.rb
+- lib/motorhead/road_crew/road_crew.gemspec
 - lib/motorhead/version.rb
 - motorhead.gemspec
 homepage: https://github.com/amatsuda/motorhead