configurable_engine 0.4.5 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: f02a18fcb303b5b130db98893a3d0e5977fb2017
-  data.tar.gz: 8cd584d266b1a2824c62c74f519567194cf42acd
+SHA256:
+  metadata.gz: 70df04df8400f52621c669ff912d9b648b4cac4a1107b3e5e0e102f2aeaabe51
+  data.tar.gz: 3a32bee140f6e905ce74f5079ed034611055f46727645f8dbe39ff22e7e4d9a0
 SHA512:
-  metadata.gz: 4984b350d139195314f8749eb82833c9232fb37ef2322f4fc3b3a2a98d28c5e52f6529f0b0aaf065c232a32b664f9cfbbb93abf5ab301ba9229e92bbc629d752
-  data.tar.gz: e64e0fa495ee59fbe59d7acb99eb835b8004401d4850cded6636a218d463a3db0e427b4145aaefd30f34065fe944f1d8932c1a17c47c61289274c359ebf5f874
+  metadata.gz: 9fe20672f98d7b4166c224d73bf1d10675a71418d3a32dcc7e952cba3a0dffa62c4e03635877fa097c21e592a970f8d952c8602c6fc7db91e39857b1710b0339
+  data.tar.gz: c77bb417b1bf4cbe6f4d23b9875049fedd05fcbad8efb6db25f87f698ec7c70fa97eda580dd11da0e4b842caaf8d40fab1e76cd570fb6fcc85af9bb8a438f7f8

data/CHANGELOG.md

@@ -1,3 +1,30 @@
+### 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)
+
+### v0.4.7 - November 4, 2014
+**bug fix**
+Configurable broke for users using cacheing.
+
+### v0.4.6 - October 28, 2014
+**cleanup**
+When using Configurable with cache, destroying a configurable instance erases it from cache
+
 ### v0.4.5 - October 13, 2014
 **bug fixes**
 Configurable can store false values when the default is true (https://github.com/paulca/configurable_engine/pull/24, thanks @lilliealbert)

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'
@@ -24,9 +24,9 @@ $ rails generate configurable_engine:install
 
 ## 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:
@@ -100,16 +100,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`
@@ -117,7 +151,8 @@ The tests for this rails engine are in the `spec` and `features` directories.  T
 From the top level run:
 
 ```bash
-$ bundle exec rake app:db:schema:load app:db:test:prepare
+$ bundle exec rake app:db:schema:load
+$ bundle exec rake app:db:test:prepare
 $ bundle exec rake
 ```
 
@@ -129,4 +164,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/models/configurable.rb

@@ -1,6 +1,8 @@
 class Configurable < ActiveRecord::Base
+  serialize :value
 
-  after_save :invalidate_cache, if: -> { ConfigurableEngine::Engine.config.use_cache }
+  after_save    :invalidate_cache, if: -> { ConfigurableEngine::Engine.config.use_cache }
+  after_destroy :invalidate_cache, if: -> { ConfigurableEngine::Engine.config.use_cache }
 
   validates_presence_of    :name
   validates_uniqueness_of  :name
@@ -29,20 +31,44 @@ class Configurable < ActiveRecord::Base
     end
   end
 
+  def self.cache_key(key)
+    "configurable_engine:#{key}"
+  end
+
   def self.[](key)
     return parse_value key, defaults[key][:default] unless table_exists?
 
-    config = if ConfigurableEngine::Engine.config.use_cache
-      Rails.cache.fetch("configurable_engine:#{key}") {
-        find_by_name(key)
-      }
-    else
-      find_by_name(key)
+    value, found = [false, false]
+    database_finder = -> do
+      config = find_by_name(key)
+      found = !!config
+      value = config.try(:value)
     end
 
-    return parse_value key, defaults[key][:default] unless config
 
-    config.value
+    if ConfigurableEngine::Engine.config.use_cache
+      found = Rails.cache.exist?(cache_key(key))
+      if found
+        value = Rails.cache.fetch(cache_key(key))
+      else
+        database_finder.call
+        if found
+          Rails.cache.write cache_key(key), value
+        end
+      end
+    else
+      database_finder.call
+    end
+
+    if found
+      value
+    else
+      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
 
   def value
@@ -55,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'
@@ -65,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
@@ -111,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
@@ -122,6 +156,6 @@ class Configurable < ActiveRecord::Base
   end
 
   def invalidate_cache
-    Rails.cache.delete("configurable_engine:#{self.name}")
+    Rails.cache.delete(Configurable.cache_key self.name)
   end
 end

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

@@ -1,24 +1,31 @@
-<h2>Config</h2>
+<div class='configurable-container'>
 
-<%= 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) %>
+  <div class="header">
+    <h2>Config</h2>
+  </div>
+
+  <div class="configurable-options">
+    <%= 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 -%>
-    </div>
-  <%- end -%>
-  
-  <%= submit_tag 'Save' %>
-<%- end -%>
+
+      <%= submit_tag 'Save' %>
+    <%- end -%>
+  </div>
+</div>

data/lib/configurable_engine/version.rb

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

metadata

@@ -1,15 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: configurable_engine
 version: !ruby/object:Gem::Version
-  version: 0.4.5
+  version: 1.0.0
 platform: ruby
 authors:
 - Paul Campbell
 - Michael Glass
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2014-10-13 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: []
@@ -53,7 +53,7 @@ homepage: http://github.com/paulca/configurable_engine
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -68,9 +68,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: []