configurable_engine 0.4.8 → 2.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: fa9a553b5686f2be89941fb0d8662cdd9c12d030
-  data.tar.gz: 0ac4f3f329a280a57747250eddc73f965fe3d221
+SHA256:
+  metadata.gz: 35d8e042be21d9ecc3832fcf236bec6145e58ee6a545185121cda190f26a935e
+  data.tar.gz: 5d3619555b52de54a69da528aec0e92a9b5911425ea06f244a01082e6cfd588d
 SHA512:
-  metadata.gz: 240d819eb7f2c6caaee975de94b372b705a6bb97a0e506c187ae59b68bc49a1d9b412b633726d994f389eee16ff79b5136b70cacf26f6e35dcc7bb0223eaae9c
-  data.tar.gz: a6341025e1c7cc59c19dfcbb66755f6ea55c0e19b9e0c92eff8e453ca43291233f0ce0da33a339863a424359af8cc5f9a3ba41efca59dc6a974611eb455ffa71
+  metadata.gz: ebc8c63d1ea3ac3722dd7632ab38ecba3cd60dd0b2a23b6595f9905e7aaa947aa8b069f0f8de5e0f275ca69cd09b786ee9f866aba82c6c7672f02f937116bdaf
+  data.tar.gz: b09227577c08b4e35523d134dbf7dbeff3ff2c1c45f6f01c536985c446239ec2ee8ee39b8c649e334c4bd9ee5a3a165a85b3c3fbdabbc2332fba4cbb2aec7f5e

data/CHANGELOG.md

@@ -1,3 +1,33 @@
+### v2.0.2 - August 20, 2020
+**bug fixes**
+fix rendering with included module
+
+### v2.0.1 - August 20, 2020
+**bug fixes**
+Can render layout of parent application
+
+### 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
+
+**breaking changes**
+No further support for rails < 5.2
+
+### v0.5.0 - August 3, 2018
+**features**
+Official rails 4.2 support (Thanks @ento)
+
+**breaking changes**
+No further support for rails < 4.2, and non-mri rubies. Happy to accept those back as PRs!
+
+
 ### v0.4.8 - March 4, 2015
 **bug fix**
 Cacheing was just totally broken.  Whoops! (thanks, @antoshalee)

data/README.md

@@ -1,6 +1,6 @@
 # Configurable [![Build Status](https://travis-ci.org/paulca/configurable_engine.png?branch=master)](https://travis-ci.org/paulca/configurable_engine)
 
-A Rails 3/4 configuration engine. An update to [Behavior](http://github.com/paulca/behavior) for Rails 3 and 4.
+A Rails 4 configuration engine. An update to [Behavior](http://github.com/paulca/behavior) for Rails 4.
 
 ## How it works ##
 
@@ -10,7 +10,7 @@ If you or your app users need to change these variables, Configurable stores new
 
 ## Installation ##
 
-Configurable is available as a Ruby gem. Simply add it to your Rails 3 app's `Gemfile`:
+Configurable is available as a Ruby gem. Simply add it to your Rails 4 app's `Gemfile`:
 
 ```ruby
 gem 'configurable_engine'
@@ -22,11 +22,17 @@ 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.
+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.
 
-For example, if you wanted to have access to a config variable "site_title", put this in configurable.yml:
+For example, if you wanted to have access to a config variable `site_title`, put this in `configurable.yml`:
 
 ```yaml
 site_title:
@@ -53,12 +59,12 @@ If you want to add a layout, or protect the configurable controller, create `app
 $ bundle exec rails generate controller admin/configurables
 ```
 
-and include `ConfigurableEngine::ConfigurablesController`, eg.
+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
@@ -66,6 +72,19 @@ class Admin::ConfigurablesController < ApplicationController
 end
 ```
 
+and replace
+```ruby
+route 'mount ConfigurableEngine::Engine, at: "/admin/configurable", as: "configurable"'
+```
+
+with
+
+```ruby
+namespace :admin do
+  resource :configurable, only: [:show, :update]
+end
+```
+
 To ensure text areas are rendered correctly, ensure that your layout preserves whitespace.  In haml, use the `~` operator
 
 ```haml
@@ -100,16 +119,50 @@ Price:
   type: decimal             # coerces the value to a decimal
 ```
 
-## Cacheing ##
+## Caching ##
 
 If you want to use rails caching of Configurable updates, simply set
 
-
 ```ruby
 config.use_cache = true
 ```
+
 in your `config/application.rb` (or `config/production.rb`)
 
+## Styling the interface ##
+
+To style the web interface you are advised to use Sass. Here's an example scss file that will make the interface bootstrap-3 ready:
+
+```
+@import 'bootstrap';
+
+.configurable-container {
+  @extend .col-md-6;
+
+  .configurable-options {
+    form {
+      @extend .form-horizontal;
+
+      .configurable {
+        @extend .col-md-12;
+        @extend .form-group;
+
+        textarea, input[type=text], input[type=password] {
+          @extend .form-control;
+        }
+      }
+
+      input[type=submit] {
+        @extend .btn;
+        @extend .btn-primary;
+      }
+    }
+  }
+}
+```
+
+Just save this into your rails assets and you're ready to go.
+
 ## Running the Tests ##
 
 The tests for this rails engine are in the `spec` and `features` directories.  They use the dummy rails app in `spec/dummy`
@@ -130,4 +183,3 @@ All contributions are welcome. Just fork the code, ensure your changes include a
 
 Copyright (c) 2011 Paul Campbell. See LICENSE.txt for
 further details.
-

data/app/controllers/configurable_engine/application_controller.rb

@@ -0,0 +1,6 @@
+module ConfigurableEngine
+  class ApplicationController < ActionController::Base
+    layout "configurable_engine/application"
+    protect_from_forgery with: :exception
+  end
+end

data/app/controllers/configurable_engine/configurables_controller.rb

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

data/app/models/configurable.rb

@@ -1,4 +1,6 @@
 class Configurable < ActiveRecord::Base
+  serialize :value
+
   after_save    :invalidate_cache, if: -> { ConfigurableEngine::Engine.config.use_cache }
   after_destroy :invalidate_cache, if: -> { ConfigurableEngine::Engine.config.use_cache }
 
@@ -61,7 +63,11 @@ class Configurable < ActiveRecord::Base
     if found
       value
     else
-      parse_value key, defaults[key][:default]
+      parse_value(key, defaults[key][:default]).tap do |val|
+        if ConfigurableEngine::Engine.config.use_cache
+          Rails.cache.write cache_key(key), val
+        end
+      end
     end
   end
 
@@ -75,7 +81,7 @@ class Configurable < ActiveRecord::Base
       [true, 1, "1", "t", "true"].include?(value)
     when 'decimal'
       value ||= 0
-      BigDecimal.new(value.to_s)
+      BigDecimal(value.to_s)
     when 'integer'
       value.to_i
     when 'list'
@@ -85,6 +91,12 @@ class Configurable < ActiveRecord::Base
       else
         value.split("\n").collect { |v| v =~ /,/ ? v.split(',') : v }
       end
+    when 'date'
+      if value.is_a? Date
+        value
+      else
+       Date.parse(value) if value.present?
+      end
     else
       value
     end
@@ -131,6 +143,8 @@ class Configurable < ActiveRecord::Base
       Integer(value) rescue false
     when 'list'
       value.is_a?(Array)
+    when 'date'
+      value.is_a?(Date)
     else
       true
     end

data/app/views/configurable_engine/configurables/show.html.erb

@@ -0,0 +1,30 @@
+<div class='configurable-container'>
+  <div class="header">
+    <h2>Config</h2>
+  </div>
+
+  <div class="configurable-options">
+    <%= form_tag({}, method: :put) do -%>
+      <%- @keys.each do |key| -%>
+        <%- options = Configurable.defaults[key] -%>
+        <div class="configurable">
+          <%= label_tag key, options[:name] %>
+          <%- if options[:type] == 'boolean' %>
+            <%= hidden_field_tag key, "0" %>
+            <%= check_box_tag key, "1", Configurable.send(key) %>
+          <%- elsif options[:type] == 'password' -%>
+            <%= password_field_tag key, Configurable.send(key) %>
+          <%- elsif options[:type] == 'text' -%>
+            <%= text_area_tag key, Configurable.send(key) %>
+          <%- elsif options[:type] == 'list' -%>
+            <%= text_area_tag key, Configurable.serialized_value(key) -%>
+          <%- else -%>
+            <%= text_field_tag key, Configurable.send(key) %>
+          <%- end -%>
+        </div>
+      <%- end -%>
+
+      <%= submit_tag 'Save' %>
+    <%- end -%>
+  </div>
+</div>

data/app/views/layouts/configurable_engine/application.html.erb

@@ -0,0 +1,13 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title>Configurable engine</title>
+  <%= csrf_meta_tags %>
+  <%= csp_meta_tag %>
+</head>
+<body>
+
+<%= yield %>
+
+</body>
+</html>

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: '/', only: [:show, :update]
+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,7 +1,8 @@
 module ConfigurableEngine
-  module ConfigurablesController
+  module ConfigurablesControllerMethods
     def show
       @keys = Configurable.keys
+      render 'configurable_engine/configurables/show'
     end
 
     def update
@@ -15,11 +16,11 @@ module ConfigurableEngine
         end
 
       if failures.empty?
-        redirect_to admin_configurable_path, :notice => "Changes successfully updated"
+        redirect_to(action: :show, :notice => "Changes successfully updated")
       else
         flash[:error] = failures.flat_map(&:errors).flat_map(&:full_messages).join(',')
-        redirect_to admin_configurable_path
+        redirect_to(action: :show)
       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 = '0.4.8'
+  VERSION = '2.0.2'
 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", as: "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,15 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: configurable_engine
 version: !ruby/object:Gem::Version
-  version: 0.4.8
+  version: 2.0.2
 platform: ruby
 authors:
 - Paul Campbell
 - Michael Glass
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2015-03-04 00:00:00.000000000 Z
+date: 2020-08-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -17,17 +17,17 @@ dependencies:
     requirements:
     - - ">"
       - !ruby/object:Gem::Version
-        version: 3.1.0
+        version: 5.2.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">"
       - !ruby/object:Gem::Version
-        version: 3.1.0
-description: 'Configurable is a Rails 3/4 engine that allows you to set up config
-  variables in a config file, specifying default values for all environmentspec. These
-  variables can then be set on a per-app basis using a user facing configuration screen. '
+        version: 5.2.0
+description: 'Configurable is a Rails 4 engine that allows you to set up config variables
+  in a config file, specifying default values for all environmentspec. These variables
+  can then be set on a per-app basis using a user facing configuration screen. '
 email: paul@rslw.com
 executables: []
 extensions: []
@@ -38,12 +38,14 @@ files:
 - CHANGELOG.md
 - LICENSE.txt
 - README.md
-- app/controllers/admin/configurables_controller.rb
+- app/controllers/configurable_engine/application_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
+- app/views/layouts/configurable_engine/application.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
@@ -53,7 +55,7 @@ homepage: http://github.com/paulca/configurable_engine
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -68,9 +70,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.4.2
-signing_key: 
+rubygems_version: 3.0.3
+signing_key:
 specification_version: 4
-summary: Database-backed configuration for Rails 3, with defaults from config file.
+summary: Database-backed configuration for Rails 4, with defaults from config file.
 test_files: []

data/app/controllers/admin/configurables_controller.rb

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

data/app/views/admin/configurables/show.html.erb

@@ -1,24 +0,0 @@
-<h2>Config</h2>
-
-<%= form_tag(admin_configurable_path, :method => :put) do -%>
-  <%- @keys.each do |key| -%>
-    <%- options = Configurable.defaults[key] -%>
-    <div class="configurable">
-      <%= label_tag key, options[:name] %>
-      <%- if options[:type] == 'boolean' %>
-        <%= hidden_field_tag key, "0" %>
-        <%= check_box_tag key, "1", Configurable.send(key) %>
-      <%- elsif options[:type] == 'password' -%>
-        <%= password_field_tag key, Configurable.send(key) %>
-      <%- elsif options[:type] == 'text' -%>
-        <%= text_area_tag key, Configurable.send(key) %>
-      <%- elsif options[:type] == 'list' -%>
-        <%= text_area_tag key, Configurable.serialized_value(key) -%>
-      <%- else -%>
-        <%= text_field_tag key, Configurable.send(key) %>
-      <%- end -%>
-    </div>
-  <%- end -%>
-  
-  <%= submit_tag 'Save' %>
-<%- end -%>