ledermann-rails-settings 2.0.1 → 2.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: acfe3a67b8daf8e9108c0ddf270e638c4310d2b1
-  data.tar.gz: ef9c5a3a455365f5817f56f5476b12d9283d2440
+  metadata.gz: 1e95ccf650df85deaa3086b12f49c7cf6d10cd13
+  data.tar.gz: 4d2a68fa5cda6250f29440ec426bef760f65a72f
 SHA512:
-  metadata.gz: 5fd20605f8b1dc5474b94402140baba09d08a5d59429269ebb37bc4bd5b63742088a24ed0c2ccbf6b7cb127c631fb5522b85636735a1a6b28f94853ed97b90e5
-  data.tar.gz: 3c4f8c5f8f5732e727cf116a341d04f09e519e8e1aa13df8b94e72f3dfd532a6155a1cfa7c4af0de44ceebce271ca4e28a1e5b129008994a992362fb14de44ea
+  metadata.gz: b6dd9ded21d964802a6a20b01b38a5d9361ce2b8d6d6ac960886504a1db17a3e562b34325351ed7c9684b33f57c872a1b48908e079d199889722401805d33135
+  data.tar.gz: 1cdd6dbf6085d40544b52678ccaeea7cab94dbb6b907f3a10371cac806ea8263bfef230ab393da421b81692a338861dfdc1219e5c11c1fe649b9cc95f9bb52ac

data/.travis.yml

@@ -6,3 +6,8 @@ rvm:
 gemfile:
   - ci/Gemfile.rails-3.1.x
   - ci/Gemfile.rails-3.2.x
+env:
+  - DB=sqlite
+  - DB=mysql
+before_script:
+  - "mysql -e 'create database rails_settings_test;' >/dev/null"

data/Changelog.md

@@ -1,3 +1,25 @@
+Version 2.0.2 (2013-03-17)
+
+- Changed database schema to allow NULL for column `value` to fix serialization
+  bug with MySQL. Thanks to @steventen for pointing this out in issue #31.
+
+  IMPORTANT: The migration generator of version 2.0.0 and 2.0.1 was broken. If
+             you use MySQL it's required to update your database schema like
+             this:
+
+             ```ruby
+             class FixSettings < ActiveRecord::Migration
+               def up
+                 change_column :settings, :value, :text, :null => true
+               end
+
+               def down
+                 change_column :settings, :value, :text, :null => false
+               end
+             end
+             ```
+
+
 Version 2.0.1 (2013-03-08)
 
 - Added mass assignment security by protecting all regular attributes

data/README.md

@@ -3,14 +3,12 @@
 [![Build Status](https://travis-ci.org/ledermann/rails-settings.png?branch=master)](https://travis-ci.org/ledermann/rails-settings)
 [![Code Climate](https://codeclimate.com/github/ledermann/rails-settings.png)](https://codeclimate.com/github/ledermann/rails-settings)
 
-Ruby gem to handle settings for ActiveRecord objects by storing them as serialized Hash in a separate database table. Optional: Defaults and Namespaces.
+Ruby gem to handle settings for ActiveRecord instances by storing them as serialized Hash in a separate database table. Namespaces and defaults included.
 
-**BEWARE: This is version 2 which is a complete rewrite and NOT compatible with version 1.x**
 
+## Usage
 
-## Example
-
-### Defining settings
+### Define settings
 
 ```ruby
 class User < ActiveRecord::Base
@@ -98,13 +96,13 @@ User.without_settings_for(:calendar)
 
 ## Requirements
 
-Rails 3.1.x or 3.2.x
-Ruby 1.8.7, 1.9.3 or 2.0.0
+* Ruby 1.8.7, 1.9.3 or 2.0.0
+* Rails 3.1.x or 3.2.x
 
 
 ## Installation
 
-Include the gem in your Gemfile:
+Include the gem in your Gemfile und run `bundle` to install it:
 
 ```ruby
 gem 'ledermann-rails-settings', :require => 'rails-settings'
@@ -119,8 +117,7 @@ rake db:migrate
 
 ## Compatibility
 
-Version 2 is a complete rewrite and has a new DSL, so it's **not** compatible with Version 1. But the database schema is unchanged, so you can use the same data after upgrading.
-In addition, Rails 2.3 is not supported anymore.
+Version 2 is a complete rewrite and has a new DSL, so it's **not** compatible with Version 1. In addition, Rails 2.3 is not supported anymore. But the database schema is unchanged, so you can continue to use the data created by 1.x, no conversion is needed.
 
 If you don't want to upgrade, you find the old version in the [1.x](https://github.com/ledermann/rails-settings/commits/1.x) branch. But don't expect any updates there.
 
@@ -128,6 +125,7 @@ If you don't want to upgrade, you find the old version in the [1.x](https://gith
 ## License
 
 MIT License
-Copyright (c) 2013 Georg Ledermann
+
+Copyright (c) 2013 [Georg Ledermann](http://www.georg-ledermann.de)
 
 This gem is a complete rewrite of [rails-settings](https://github.com/Squeegy/rails-settings) by [Alex Wayne](https://github.com/Squeegy)

data/ci/Gemfile.rails-3.1.x

@@ -2,5 +2,6 @@ source :rubygems
 
 gem 'activerecord', '~> 3.1.0'
 gem 'sqlite3', '~> 1.3'
+gem 'mysql2', '>= 0.3.6'
 gem 'rake', '~> 10.0'
 gem 'rspec', '~> 2.13'

data/ci/Gemfile.rails-3.2.x

@@ -2,5 +2,6 @@ source :rubygems
 
 gem 'activerecord', '~> 3.2.0'
 gem 'sqlite3', '~> 1.3'
+gem 'mysql2', '>= 0.3.6'
 gem 'rake', '~> 10.0'
 gem 'rspec', '~> 2.13'

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

@@ -2,7 +2,7 @@ class RailsSettingsMigration < ActiveRecord::Migration
   def self.up
     create_table :settings do |t|
       t.string     :var,    :null => false
-      t.text       :value,  :null => false
+      t.text       :value
       t.references :target, :null => false, :polymorphic => true
       t.timestamps
     end

data/lib/rails-settings/version.rb

@@ -1,3 +1,3 @@
 module RailsSettings
-  VERSION = '2.0.1'
+  VERSION = '2.0.2'
 end

data/rails-settings.gemspec

@@ -9,7 +9,7 @@ Gem::Specification.new do |gem|
   gem.authors       = ['Georg Ledermann']
   gem.email         = ['mail@georg-ledermann.de']
   gem.description   = %q{Settings gem for Ruby on Rails}
-  gem.summary       = %q{Handling settings for ActiveRecord objects by storing them as serialized Hash in a separate database table. Optional: Defaults and Namespaces.}
+  gem.summary       = %q{Ruby gem to handle settings for ActiveRecord instances by storing them as serialized Hash in a separate database table. Namespaces and defaults included.}
   gem.homepage      = 'https://github.com/ledermann/rails-settings'
 
   gem.files         = `git ls-files`.split($/)
@@ -21,5 +21,6 @@ Gem::Specification.new do |gem|
 
   gem.add_development_dependency 'rake', '~> 10.0'
   gem.add_development_dependency 'sqlite3', '~> 1.3'
+  gem.add_development_dependency 'mysql2', '~> 0.3.11'
   gem.add_development_dependency 'rspec', '~> 2.13'
 end

data/spec/database.yml

@@ -0,0 +1,8 @@
+sqlite:
+  adapter: sqlite3
+  database: ":memory:"
+mysql:
+  adapter: mysql2
+  database: rails_settings_test
+  username:
+  encoding: utf8

data/spec/setting_object_spec.rb

@@ -5,6 +5,12 @@ describe RailsSettings::SettingObject do
   let(:new_setting_object) { user.setting_objects.build({ :var => 'dashboard'}, :without_protection => true) }
   let(:saved_setting_object) { user.setting_objects.create!({ :var => 'dashboard', :value => { 'theme' => 'pink', 'filter' => true}}, :without_protection => true) }
 
+  describe "serialization" do
+    it "should have a hash default" do
+      RailsSettings::SettingObject.new.value.should == {}
+    end
+  end
+
   describe "Getter and Setter" do
     context "on unsaved settings" do
       it "should respond to setters" do
@@ -40,11 +46,18 @@ describe RailsSettings::SettingObject do
         new_setting_object.filter.should eq(false)
       end
 
-      it "should store to value hash" do
-        new_setting_object.foo = 42
-        new_setting_object.bar = 'hello'
-
-        new_setting_object.value.should eq({'foo' => 42, 'bar' => 'hello'})
+      it "should store different objects to value hash" do
+        new_setting_object.integer = 42
+        new_setting_object.float   = 1.234
+        new_setting_object.string  = 'Hello, World!'
+        new_setting_object.array   = [ 1,2,3 ]
+        new_setting_object.symbol  = :foo
+
+        new_setting_object.value.should eq('integer' => 42,
+                                           'float'   => 1.234,
+                                           'string'  => 'Hello, World!',
+                                           'array'   => [ 1,2,3 ],
+                                           'symbol'  => :foo)
       end
 
       it "should set and return attributes" do

data/spec/spec_helper.rb

@@ -23,9 +23,6 @@ end
 require 'active_record'
 require 'rails-settings'
 
-ActiveRecord::Base.establish_connection(:adapter => "sqlite3", :database => ":memory:")
-ActiveRecord::Migration.verbose = false
-
 class User < ActiveRecord::Base
   has_settings do |s|
     s.key :dashboard, :defaults => { :theme => 'blue', :view => 'monthly', :filter => false }
@@ -56,10 +53,22 @@ class ProjectSettingObject < RailsSettings::SettingObject
 end
 
 def setup_db
+  ActiveRecord::Base.configurations = YAML.load_file(File.dirname(__FILE__) + '/database.yml')
+  db_name = ENV['DB'] || 'sqlite'
+  ActiveRecord::Base.establish_connection(db_name)
+
+  ActiveRecord::Migration.verbose = false
+  ActiveRecord::Base.connection.tables.each do |table|
+    next if table == 'schema_migrations'
+    ActiveRecord::Base.connection.execute("DROP TABLE #{table}")
+  end
+
+  puts "Testing on #{db_name} with ActiveRecord #{ActiveRecord::VERSION::STRING}"
+
   ActiveRecord::Schema.define(:version => 1) do
     create_table :settings do |t|
       t.string     :var,    :null => false
-      t.text       :value,  :null => false
+      t.text       :value
       t.references :target, :null => false, :polymorphic => true
       t.timestamps
     end
@@ -86,5 +95,4 @@ def clear_db
   RailsSettings::SettingObject.delete_all
 end
 
-puts "Testing with ActiveRecord #{ActiveRecord::VERSION::STRING}"
 setup_db

data/spec/support/query_counter.rb

@@ -11,7 +11,7 @@ module ActiveRecord
     end
 
     def callback(name, start, finish, message_id, values)
-      @query_count += 1 unless %w(CACHE SCHEMA).include?(values[:name]) || values[:sql] == 'begin transaction' || values[:sql] == 'commit transaction'
+      @query_count += 1 unless %w(CACHE SCHEMA).include?(values[:name]) || values[:sql] =~ /^begin/i || values[:sql] =~ /^commit/i
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ledermann-rails-settings
 version: !ruby/object:Gem::Version
-  version: 2.0.1
+  version: 2.0.2
 platform: ruby
 authors:
 - Georg Ledermann
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-03-08 00:00:00.000000000 Z
+date: 2013-03-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -52,6 +52,20 @@ dependencies:
     - - ~>
       - !ruby/object:Gem::Version
         version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: mysql2
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.3.11
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.3.11
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -92,6 +106,7 @@ files:
 - lib/rails-settings/version.rb
 - rails-settings.gemspec
 - spec/configuration_spec.rb
+- spec/database.yml
 - spec/queries_spec.rb
 - spec/scopes_spec.rb
 - spec/serialize_spec.rb
@@ -119,13 +134,14 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.0.2
+rubygems_version: 2.0.3
 signing_key: 
 specification_version: 4
-summary: 'Handling settings for ActiveRecord objects by storing them as serialized
-  Hash in a separate database table. Optional: Defaults and Namespaces.'
+summary: Ruby gem to handle settings for ActiveRecord instances by storing them as
+  serialized Hash in a separate database table. Namespaces and defaults included.
 test_files:
 - spec/configuration_spec.rb
+- spec/database.yml
 - spec/queries_spec.rb
 - spec/scopes_spec.rb
 - spec/serialize_spec.rb