configurable_engine 0.3.3 → 0.4.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 990bdf66a3b906927e53869aa049a82638b13791
-  data.tar.gz: 1107460d5c031cc5b143b950966cb8548b5a5529
+  metadata.gz: 578bcc2a45822abd17223d78f7c7fde6a0dfe3ab
+  data.tar.gz: bc4d2f6a418728cbb09b0753127f7e97469a6c4e
 SHA512:
-  metadata.gz: 204972e4fc0157f654f0900e3156dba911c11d5fd45878d2c3ec3d6cc115c25ac4b8e4d131d10b8d0a43cd000d0aeec431cb29dc9f0faf90199be5fbba50b6d4
-  data.tar.gz: 9422ce1965bd055dc95fc0597f7945433011548172b73b144fdd39ab38aa90ff2d7f66766725f107134d6ecc20038059ad3210af49b257dd0391e4ea9c0c5153
+  metadata.gz: f0a4fb4d57e46d36329fc96650bf8f3be1b970978fc4594acf3bba0b1faf1a4a8dfb70ffa3332a6771db6e54d50e6e2b5e5be5e5b0ad97a4bb804785b6414c1f
+  data.tar.gz: bea51a20af9715fa5feea6a294fdd0008bc222abc4a8c6bf37e86eeb52ab9441996da5d573b7713591c6b4a0753cce5c2e36d194b8829d4829429404a512614b

data/CHANGELOG.md

@@ -1,3 +1,29 @@
+### v0.4.4 - May 21, 2014
+**bug fixes**
+list types can *actually* deserialize comma delimeted nested and non-nested lists
+tested end-to-end but need better specs.  sorry about the mess.
+
+
+### v0.4.3 - May 21, 2014
+**bug fixes**
+list types can deserialize comma delimeted nested and non-nested lists
+
+**in other news**
+... time to learn how to release beta versions.  If I have to release another fix today, I'll do that.
+
+### v0.4.2 - May 21, 2014
+**bug fixes**
+list types can serialize comma delimeted nested and non-nested lists
+
+### v0.4.1 - May 21, 2014
+**bug fixes**
+if cacheing was enabled, configurable engine would never return default for unset values.
+
+### v0.4.0 - May 21, 2014
+**features**
+Configurable.[]= will serialize arrays set to list-type params.
+BREAKING CHANGE: Configurable#value and Configurable.[] should return similarly cast values (previously #value was always the string value)
+
 ### v0.3.3 - May 21, 2014
 **bug fixes**
 No longer uses mass assignment internally.

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 configuration engine. An update to [Behavior](http://github.com/paulca/behavior) for Rails 3.
+A Rails 3/4 configuration engine. An update to [Behavior](http://github.com/paulca/behavior) for Rails 3 and 4.
 
 ## How it works ##
 
@@ -40,7 +40,7 @@ Since Configurable is an ActiveRecord model, if you want to update the config, c
 
 ```ruby
 Configurable.create!(:name => 'site_title', :value => 'My New Site')
-```    
+```
 You can set the `type` attribute to `boolean`, `decimal`,`integer`, or `list` and it will treat those fields as those types.  Lists are comma and/or newline delimeted arrays of strings.
 
 ## Web Interface ##
@@ -59,13 +59,20 @@ and include `ConfigurableEngine::ConfigurablesController`, eg.
 class Admin::ConfigurablesController < ApplicationController
   # include the engine controller actions
   include ConfigurableEngine::ConfigurablesController
-    
+
   # add your own filter(s) / layout
   before_filter :protect_my_code
   layout 'admin'
 end
 ```
 
+To ensure text areas are rendered correctly, ensure that your layout preserves whitespace.  In haml, use the `~` operator
+
+```haml
+  %container
+    ~ yield
+```
+
 If you want to control how the fields in the admin interface appear, you can add additional params in your configurable.yml file:
 
 ```yaml
@@ -100,7 +107,7 @@ 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`)
 
 ## Running the Tests ##

data/app/models/configurable.rb

@@ -6,6 +6,7 @@ class Configurable < ActiveRecord::Base
   validates_uniqueness_of  :name
 
   validate :type_of_value
+  before_save :serialize_value
 
   def self.defaults
     @defaults ||= HashWithIndifferentAccess.new(
@@ -29,32 +30,59 @@ class Configurable < ActiveRecord::Base
   end
 
   def self.[](key)
-    return self.defaults[key][:default] unless table_exists?
+    return parse_value key, defaults[key][:default] unless table_exists?
 
-    value = if ConfigurableEngine::Engine.config.use_cache
-        Rails.cache.fetch("configurable_engine:#{key}") {
-          find_by_name(key).try(:value)
-        }
-      else
+    val = if ConfigurableEngine::Engine.config.use_cache
+      Rails.cache.fetch("configurable_engine:#{key}") {
         find_by_name(key).try(:value)
-      end
+      }
+    else
+      find_by_name(key).try(:value)
+    end
+
+    val ||= parse_value key, defaults[key][:default]
+  end
+
+  def value
+    self.class.parse_value name, super
+  end
 
-    value ||= self.defaults[key][:default]
-    case self.defaults[key][:type]
+  def self.parse_value key, value
+    case defaults[key][:type]
     when 'boolean'
       [true, 1, "1", "t", "true"].include?(value)
     when 'decimal'
+      value ||= 0
       BigDecimal.new(value.to_s)
     when 'integer'
       value.to_i
     when 'list'
-      return value if value.is_a?(Array)
-      value.split("\n").collect{ |v| v.split(',') }
+      value ||= []
+      if value.is_a? Array
+        value
+      else
+        value.split("\n").collect { |v| v =~ /,/ ? v.split(',') : v }
+      end
     else
       value
     end
   end
 
+  def self.serialized_value key
+    value_for_serialization key, self[key]
+  end
+
+  def self.value_for_serialization(key, value)
+    if defaults[key][:type] == 'list' && value.is_a?(Array)
+      if value.all? {|entry| entry.is_a? Array}
+        value = value.collect {|entry| entry.join ','}
+      end
+      value.join("\n")
+    else
+      value.to_s
+    end.gsub("\r\n","\n")
+  end
+
   def self.method_missing(name, *args)
     name_stripped = name.to_s.sub(/[\?=]$/, '')
     if self.keys.include?(name_stripped)
@@ -72,16 +100,23 @@ class Configurable < ActiveRecord::Base
 
   def type_of_value
     return unless name
-    case Configurable.defaults[name][:type]
+    valid = case Configurable.defaults[name][:type]
     when 'boolean'
       [true, 1, "1", "true", false, 0, "0", "false"].include?(value)
     when 'decimal'
-      Float(value) rescue errors.add(:value, I18n.t("activerecord.errors.messages.invalid"))
+      BigDecimal(value) rescue false
     when 'integer'
-      Integer(value) rescue errors.add(:value, I18n.t("activerecord.errors.messages.invalid"))
+      Integer(value) rescue false
     when 'list'
-      value.is_a?(Array) rescue errors.add(:value, I18n.t("activerecord.errors.messages.invalid"))
+      value.is_a?(Array)
+    else
+      true
     end
+    errors.add(:value, I18n.t("activerecord.errors.messages.invalid")) unless valid
+  end
+
+  def serialize_value
+    self.value = Configurable.value_for_serialization name, value
   end
 
   def invalidate_cache

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

@@ -13,7 +13,7 @@
       <%- elsif options[:type] == 'text' -%>
         <%= text_area_tag key, Configurable.send(key) %>
       <%- elsif options[:type] == 'list' -%>
-        <%= text_area_tag key, Configurable.send(key).collect{ |a| a.join(",")}.join("\n") %>
+        <%= text_area_tag key, Configurable.serialized_value(key) -%>
       <%- else -%>
         <%= text_field_tag key, Configurable.send(key) %>
       <%- end -%>

data/lib/configurable_engine/configurables_controller.rb

@@ -5,12 +5,21 @@ module ConfigurableEngine
     end
 
     def update
-      Configurable.keys.each do |key|
-        configurable = Configurable.find_by_name(key) ||
+      failures = Configurable
+        .keys.map do |key|
+          Configurable.find_by_name(key) ||
             Configurable.create {|c| c.name = key}
-        configurable.update_attribute(:value,params[key])
+        end.reject do |configurable|
+          configurable.value = params[configurable.name]
+          configurable.save
+        end
+
+      if failures.empty?
+        redirect_to admin_configurable_path, :notice => "Changes successfully updated"
+      else
+        flash[:error] = failures.flat_map(&:errors).flat_map(&:full_messages).join(',')
+        redirect_to admin_configurable_path
       end
-      redirect_to admin_configurable_path, :notice => "Changes successfully updated"
     end
   end
 end

data/lib/configurable_engine/version.rb

@@ -1,3 +1,3 @@
 module ConfigurableEngine
-  VERSION = '0.3.3'
+  VERSION = '0.4.4'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: configurable_engine
 version: !ruby/object:Gem::Version
-  version: 0.3.3
+  version: 0.4.4
 platform: ruby
 authors:
 - Paul Campbell