configurable_engine 1.0.0 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 70df04df8400f52621c669ff912d9b648b4cac4a1107b3e5e0e102f2aeaabe51
-  data.tar.gz: 3a32bee140f6e905ce74f5079ed034611055f46727645f8dbe39ff22e7e4d9a0
+  metadata.gz: 541d4ad357b6438a52c6b017f67cd7d83a3f84069671c69952a55babc64afec9
+  data.tar.gz: 99acc47f826dedf5d0b6a6e35020864028e58977c8a6f072ac9a4152b62e29df
 SHA512:
-  metadata.gz: 9fe20672f98d7b4166c224d73bf1d10675a71418d3a32dcc7e952cba3a0dffa62c4e03635877fa097c21e592a970f8d952c8602c6fc7db91e39857b1710b0339
-  data.tar.gz: c77bb417b1bf4cbe6f4d23b9875049fedd05fcbad8efb6db25f87f698ec7c70fa97eda580dd11da0e4b842caaf8d40fab1e76cd570fb6fcc85af9bb8a438f7f8
+  metadata.gz: df600a1f9d9c6af12d826983027fd05bdd90f0879d0cfea87320fccfe4301df62296c5e05b552c3c75ed9f90059ea630e4dd927808a7a25ab0f0371dbbd75c35
+  data.tar.gz: b2e0e897399245a072d060d7e714baf3924a393cde664cd8449ea10c98dacee9e01cbba086d1b12fc4dd9688183f1793d6fbfcef5a4beb9a348632607aa99eaa

data/CHANGELOG.md

@@ -1,3 +1,10 @@
+### v2.0.0 - August 20, 2020
+**features**
+Configurable_Engine is mountable. This allows folks to use it with a catch-all route
+
+**breaking changes**
+Existing users must add `mount ConfigurableEngine::Engine, at: "/admin/configurable"` to their routes.rb. Routing helpers may not work as they used to.
+
 ### v1.0.0 - August 20, 2020
 **features**
 Official rails 5.2 support

data/README.md

@@ -22,6 +22,12 @@ Then run the `configurable_engine:install` generator:
 $ rails generate configurable_engine:install
 ```
 
+this will
+- add config/configurable.yml
+- create a migration for your configurable table
+- mount the UI in your routes (defaulting to admin/configurables)
+
+
 ## Usage ##
 
 There are two parts to how configurable_engine works. First of all there is a config file, `config/configurable.yml`. This file controls the variables that are allowed to be set in the app.
@@ -58,7 +64,7 @@ and include `ConfigurableEngine::ConfigurablesController`, eg.
 ```ruby
 class Admin::ConfigurablesController < ApplicationController
   # include the engine controller actions
-  include ConfigurableEngine::ConfigurablesController
+  include ConfigurableEngine::ConfigurablesControllerMethods
 
   # add your own filter(s) / layout
   before_filter :protect_my_code

data/app/controllers/configurable_engine/configurables_controller.rb

@@ -0,0 +1,5 @@
+module ConfigurableEngine
+  class ConfigurablesController < ApplicationController
+    include ConfigurableEngine::ConfigurablesControllerMethods
+  end
+end

data/app/views/{admin → configurable_engine}/configurables/show.html.erb

@@ -5,7 +5,7 @@
   </div>
 
   <div class="configurable-options">
-    <%= form_tag(admin_configurable_path, :method => :put) do -%>
+    <%= form_tag(configurable_path, :method => :put) do -%>
       <%- @keys.each do |key| -%>
         <%- options = Configurable.defaults[key] -%>
         <div class="configurable">

data/config/routes.rb

@@ -1,5 +1,3 @@
-Rails.application.routes.draw do
-  namespace :admin do
-    resource :configurable
-  end
-end
+ConfigurableEngine::Engine.routes.draw do
+  resource :configurable, path: '/'
+end

data/lib/configurable_engine.rb

@@ -1,2 +1,2 @@
 require 'configurable_engine/engine'
-require 'configurable_engine/configurables_controller'
+require 'configurable_engine/configurables_controller_methods'

data/lib/configurable_engine/{configurables_controller.rb → configurables_controller_methods.rb}

@@ -1,5 +1,5 @@
 module ConfigurableEngine
-  module ConfigurablesController
+  module ConfigurablesControllerMethods
     def show
       @keys = Configurable.keys
     end
@@ -15,11 +15,11 @@ module ConfigurableEngine
         end
 
       if failures.empty?
-        redirect_to admin_configurable_path, :notice => "Changes successfully updated"
+        redirect_to configurable_path, :notice => "Changes successfully updated"
       else
         flash[:error] = failures.flat_map(&:errors).flat_map(&:full_messages).join(',')
-        redirect_to admin_configurable_path
+        redirect_to configurable_path
       end
     end
   end
-end
+end

data/lib/configurable_engine/engine.rb

@@ -1,8 +1,10 @@
 module ConfigurableEngine
-  class Engine < Rails::Engine
+  class Engine < ::Rails::Engine
+    engine_name "configurable"
+    isolate_namespace ConfigurableEngine
     config.use_cache = false
     config.generators do |g|
       g.test_framework :rspec
     end
   end
-end
+end

data/lib/configurable_engine/version.rb

@@ -1,3 +1,3 @@
 module ConfigurableEngine
-  VERSION = '1.0.0'
+  VERSION = '2.0.0'
 end

data/lib/generators/configurable_engine/install_generator.rb

@@ -20,5 +20,9 @@ class InstallGenerator < Rails::Generators::Base
       copy_file 'configurable.yml', 'config/configurable.yml'
       migration_template 'migration.rb', 'db/migrate/create_configurables.rb'
     end
+
+    def mount_interface
+      route 'mount ConfigurableEngine::Engine, at: "/admin/configurable"'
+    end
   end
-end
+end

data/lib/generators/configurable_engine/templates/migration.rb

@@ -1,4 +1,4 @@
-class CreateConfigurables < ActiveRecord::Migration
+class CreateConfigurables < ActiveRecord::Migration[5.2]
   def self.up
     create_table :configurables do |t|
       t.string :name
@@ -14,4 +14,4 @@ class CreateConfigurables < ActiveRecord::Migration
     remove_index :configurables, :name
     drop_table :configurables
   end
-end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: configurable_engine
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 2.0.0
 platform: ruby
 authors:
 - Paul Campbell
@@ -38,12 +38,12 @@ files:
 - CHANGELOG.md
 - LICENSE.txt
 - README.md
-- app/controllers/admin/configurables_controller.rb
+- app/controllers/configurable_engine/configurables_controller.rb
 - app/models/configurable.rb
-- app/views/admin/configurables/show.html.erb
+- app/views/configurable_engine/configurables/show.html.erb
 - config/routes.rb
 - lib/configurable_engine.rb
-- lib/configurable_engine/configurables_controller.rb
+- lib/configurable_engine/configurables_controller_methods.rb
 - lib/configurable_engine/engine.rb
 - lib/configurable_engine/version.rb
 - lib/generators/configurable_engine/install_generator.rb

data/app/controllers/admin/configurables_controller.rb

@@ -1,3 +0,0 @@
-class Admin::ConfigurablesController < ApplicationController
-  include ConfigurableEngine::ConfigurablesController
-end