configurable_engine 0.3.2 → 0.3.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 1811d51a74023fce2888c443a4e18b484e03e64d
-  data.tar.gz: a513bf6396dbb4edda39ab28a29bf2e6579478cb
+  metadata.gz: 990bdf66a3b906927e53869aa049a82638b13791
+  data.tar.gz: 1107460d5c031cc5b143b950966cb8548b5a5529
 SHA512:
-  metadata.gz: 9d6083ff4f21055b7c6c03074ec1348b405e6a2928119fe26529ea03a8118af35b067060bec2c0f5a24a89c9f71afbba3e963b0ae97117fd8f182acdfaa3d620
-  data.tar.gz: ca72a610057f1b1370f84a6ec0e1afa4ff93230f460f782c6e09aa3a70a31f1ea31d91299ebcd6a9ebcabdf0d25c9b528f62193046bab3508f7d9f03b432e7b1
+  metadata.gz: 204972e4fc0157f654f0900e3156dba911c11d5fd45878d2c3ec3d6cc115c25ac4b8e4d131d10b8d0a43cd000d0aeec431cb29dc9f0faf90199be5fbba50b6d4
+  data.tar.gz: 9422ce1965bd055dc95fc0597f7945433011548172b73b144fdd39ab38aa90ff2d7f66766725f107134d6ecc20038059ad3210af49b257dd0391e4ea9c0c5153

data/CHANGELOG.md

@@ -1,3 +1,7 @@
+### v0.3.3 - May 21, 2014
+**bug fixes**
+No longer uses mass assignment internally.
+
 ### v0.3.2 - Mar 12, 2014
 **features**
 re-releasing gem without test files included to shrink it.  Should have no code changes.

data/README.md

@@ -12,11 +12,15 @@ If you or your app users need to change these variables, Configurable stores new
 
 Configurable is available as a Ruby gem. Simply add it to your Rails 3 app's `Gemfile`:
 
-    gem 'configurable_engine'
+```ruby
+gem 'configurable_engine'
+```
 
 Then run the `configurable_engine:install` generator:
 
-    rails generate configurable_engine:install
+```bash
+$ rails generate configurable_engine:install
+```
 
 ## Usage ##
 
@@ -24,68 +28,79 @@ There are two parts to how configurable_engine works. First of all there is a co
 
 For example, if you wanted to have access to a config variable "site_title", put this in configurable.yml:
 
-    site_title:
-      name: Site Title
-      default: My Site
-  
+```yaml
+site_title:
+  name: Site Title
+  default: My Site
+  # type: String is the default
+```
 Now, within your app, you can access `Configurable[:site_title]` (or `Configurable.site_title` if you prefer).
 
 Since Configurable is an ActiveRecord model, if you want to update the config, create a Configurable record in the database:
 
-    Configurable.create!(:name => 'site_title', :value => 'My New Site')
-    
+```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 ##
 
 Configurable comes with a web interface that is available to your app straight away at `http://localhost:3000/admin/configurable`.
 
 If you want to add a layout, or protect the configurable controller, create `app/controllers/admin/configurables_controller.rb` as such:
 
-    bundle exec rails generate controller admin/configurables
+```bash
+$ bundle exec rails generate controller admin/configurables
+```
 
 and include `ConfigurableEngine::ConfigurablesController`, eg.
 
-    class Admin::ConfigurablesController < ApplicationController
-      # include the engine controller actions
-      include ConfigurableEngine::ConfigurablesController
+```ruby
+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
+  # add your own filter(s) / layout
+  before_filter :protect_my_code
+  layout 'admin'
+end
+```
 
 If you want to control how the fields in the admin interface appear, you can add additional params in your configurable.yml file:
 
-    site_title:
-      name: Name of Your Site   # sets the edit label
-      default: My Site          # sets the default value
-      type: string              # uses input type="text"
-
-    site_description:
-      name: Describe Your Site  # sets the edit label
-      default: My Site          # sets the default value
-      type: text                # uses textarea
-
-    secret:
-      name: A Secret Passphrase # sets the edit label
-      default: passpass         # sets the default value
-      type: password            # uses input type="password"
-
-    Value:
-      name: A number            # sets the edit label
-      default: 10               # sets the default value
-      type: integer             # coerces the value to an integer
-
-    Price:
-      name: A price             # sets the edit label
-      default: "10.00"          # sets the default value
-      type: decimal             # coerces the value to a decimal
-      
+```yaml
+site_title:
+  name: Name of Your Site   # sets the edit label
+  default: My Site          # sets the default value
+  type: string              # uses input type="text"
+site_description:
+  name: Describe Your Site  # sets the edit label
+  default: My Site          # sets the default value
+  type: text                # uses textarea
+secret:
+  name: A Secret Passphrase # sets the edit label
+  default: passpass         # sets the default value
+  type: password            # uses input type="password"
+
+Value:
+  name: A number            # sets the edit label
+  default: 10               # sets the default value
+  type: integer             # coerces the value to an integer
+
+Price:
+  name: A price             # sets the edit label
+  default: "10.00"          # sets the default value
+  type: decimal             # coerces the value to a decimal
+```
+
 ## Cacheing ##
 
 If you want to use rails caching of Configurable updates, simply set
 
-    config.use_cache = true
-    
+
+```ruby
+config.use_cache = true
+```    
 in your `config/application.rb` (or `config/production.rb`)
 
 ## Running the Tests ##
@@ -94,9 +109,11 @@ The tests for this rails engine are in the `spec` and `features` directories.  T
 
 From the top level run:
 
-    $ bundle exec rake app:db:schema:load app:db:test:prepare
-    $ bundle exec rake
-    
+```bash
+$ bundle exec rake app:db:schema:load app:db:test:prepare
+$ bundle exec rake
+```
+
 ## Contributing ##
 
 All contributions are welcome. Just fork the code, ensure your changes include a test, ensure all the current tests pass and send a pull request.

data/app/models/configurable.rb

@@ -24,7 +24,7 @@ class Configurable < ActiveRecord::Base
     if exisiting
       exisiting.update_attribute(:value, value)
     else
-      create(:name => key.to_s, :value => value)
+      create {|c| c.name = key.to_s; c.value = value}
     end
   end
 

data/lib/configurable_engine/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: configurable_engine
 version: !ruby/object:Gem::Version
-  version: 0.3.2
+  version: 0.3.3
 platform: ruby
 authors:
 - Paul Campbell
@@ -68,7 +68,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.0
+rubygems_version: 2.2.2
 signing_key: 
 specification_version: 4
 summary: Database-backed configuration for Rails 3, with defaults from config file.