flex_columns 1.0.0

data/spec/flex_columns/system/including_system_spec.rb

@@ -0,0 +1,285 @@
+require 'flex_columns'
+require 'flex_columns/helpers/system_helpers'
+
+describe "FlexColumns including" do
+  include FlexColumns::Helpers::SystemHelpers
+
+  before :each do
+    @dh = FlexColumns::Helpers::DatabaseHelper.new
+    @dh.setup_activerecord!
+  end
+
+  context "with standard setup" do
+    before :each do
+      create_standard_system_spec_tables!
+
+      migrate do
+        drop_table :flexcols_spec_user_preferences rescue nil
+        create_table :flexcols_spec_user_preferences, :id => false do |t|
+          t.integer :user_id, :null => false
+          t.text :attribs1
+          t.text :attribs2
+        end
+
+        add_index :flexcols_spec_user_preferences, :user_id, :unique => true
+      end
+
+      define_model_class(:UserPreference, 'flexcols_spec_user_preferences') do
+        self.primary_key = :user_id
+
+        belongs_to :user
+
+        flex_column :attribs1 do
+          field :foo
+          field :bar
+
+          def inc_foo!
+            self.foo += 1
+          end
+        end
+      end
+    end
+
+    after :each do
+      drop_standard_system_spec_tables!
+
+      migrate do
+        drop_table :flexcols_spec_user_preferences rescue nil
+      end
+    end
+
+    it "should include columns appropriately, including flex-column names and defined methods" do
+      define_model_class(:User, 'flexcols_spec_users') do
+        has_one :preference, :class_name => 'UserPreference'
+
+        include_flex_columns_from :preference
+      end
+
+      user = ::User.new
+      user.name = 'User 1'
+
+      user.foo = 123
+      user.attribs1.bar = 'bar1'
+      user.attribs1.foo.should == 123
+      user.bar.should == 'bar1'
+
+      user.inc_foo!
+      user.attribs1.foo.should == 124
+      user.foo.should == 124
+
+      user.save!
+
+      user_again = ::User.find(user.id)
+      user_again.foo.should == 124
+      user_again.bar.should == 'bar1'
+      user_again.attribs1.foo.should == 124
+      user_again.attribs1.bar.should == 'bar1'
+
+      preferences = ::UserPreference.find(user.id)
+      preferences.foo.should == 124
+      preferences.bar.should == 'bar1'
+      preferences.attribs1.foo.should == 124
+      preferences.attribs1.bar.should == 'bar1'
+    end
+
+    it "should allow turning off delegation, but should still include base names, prefixed as needed" do
+      define_model_class(:User, 'flexcols_spec_users') do
+        has_one :preference, :class_name => 'UserPreference'
+
+        include_flex_columns_from :preference, :delegate => false, :prefix => :abc
+      end
+
+      user = ::User.new
+      user.name = 'User 1'
+
+      user.respond_to?(:foo).should_not be
+      user.respond_to?(:bar).should_not be
+      user.respond_to?(:abc_foo).should_not be
+      user.respond_to?(:abc_bar).should_not be
+      user.respond_to?(:inc_foo!).should_not be
+      user.respond_to?(:abc_inc_foo!).should_not be
+
+      user.abc_attribs1.foo = 123
+      user.abc_attribs1.bar = 'bar1'
+      user.abc_attribs1.inc_foo!.should == 124
+      user.abc_attribs1.foo.should == 124
+
+      user.save!
+
+      user_again = ::User.find(user.id)
+      user_again.abc_attribs1.foo.should == 124
+      user_again.abc_attribs1.bar.should == 'bar1'
+
+      preferences = ::UserPreference.find(user.id)
+      preferences.foo.should == 124
+      preferences.bar.should == 'bar1'
+    end
+
+    it "should include columns and methods privately, if requested" do
+      define_model_class(:User, 'flexcols_spec_users') do
+        has_one :preference, :class_name => 'UserPreference'
+
+        include_flex_columns_from :preference, :visibility => :private
+      end
+
+      user = ::User.new
+      user.name = 'User 1'
+
+      user.respond_to?(:foo).should_not be
+      user.respond_to?(:foo=).should_not be
+      user.respond_to?(:bar).should_not be
+      user.respond_to?(:bar=).should_not be
+      user.respond_to?(:inc_foo).should_not be
+      user.respond_to?(:attribs1).should_not be
+
+      lambda { user.foo }.should raise_error(NoMethodError)
+      lambda { user.foo = 123 }.should raise_error(NoMethodError)
+      lambda { user.bar }.should raise_error(NoMethodError)
+      lambda { user.bar = 123 }.should raise_error(NoMethodError)
+      lambda { user.inc_foo }.should raise_error(NoMethodError)
+      lambda { user.attribs1 }.should raise_error(NoMethodError)
+
+      user.send(:foo=, 123).should == 123
+      user.send(:bar=, 'bar1').should == 'bar1'
+      user.send(:inc_foo!).should == 124
+      user.send(:foo).should == 124
+      user.send(:attribs1).foo.should == 124
+
+      user.save!
+
+      user_again = ::User.find(user.id)
+      user_again.send(:foo).should == 124
+      user_again.send(:bar).should == 'bar1'
+      user_again.send(:attribs1).foo.should == 124
+
+      preferences = ::UserPreference.find(user.id)
+      preferences.foo.should == 124
+      preferences.bar.should == 'bar1'
+    end
+
+    it "should prefix included method names, if requested" do
+      define_model_class(:User, 'flexcols_spec_users') do
+        has_one :preference, :class_name => 'UserPreference'
+
+        include_flex_columns_from :preference, :prefix => 'abc'
+      end
+
+      user = ::User.new
+      user.name = 'User 1'
+
+      lambda { user.send(:foo) }.should raise_error(NoMethodError)
+      lambda { user.send(:foo=, 123) }.should raise_error(NoMethodError)
+      lambda { user.send(:bar) }.should raise_error(NoMethodError)
+      lambda { user.send(:bar=, 123) }.should raise_error(NoMethodError)
+      lambda { user.send(:inc_foo!) }.should raise_error(NoMethodError)
+      lambda { user.send(:attribs1) }.should raise_error(NoMethodError)
+
+      user.abc_foo = 123
+      user.abc_bar = 'bar1'
+      user.abc_inc_foo!.should == 124
+      user.abc_foo.should == 124
+      user.abc_attribs1.foo.should == 124
+      user.abc_attribs1.bar.should == 'bar1'
+
+      user.save!
+
+      user_again = ::User.find(user.id)
+      user_again.abc_foo.should == 124
+      user_again.abc_bar.should == 'bar1'
+      user_again.abc_attribs1.foo.should == 124
+      user_again.abc_attribs1.bar.should == 'bar1'
+
+      preferences = ::UserPreference.find(user.id)
+      preferences.foo.should == 124
+      preferences.bar.should == 'bar1'
+    end
+  end
+
+  it "should not clobber methods that already exist, or columns on the included-into object" do
+    migrate do
+      drop_table :flexcols_spec_users rescue nil
+      create_table :flexcols_spec_users do |t|
+        t.string :name, :null => false
+        t.string :foo
+        t.string :quux
+        t.string :attribs1
+      end
+
+      drop_table :flexcols_spec_user_preferences rescue nil
+      create_table :flexcols_spec_user_preferences, :id => false do |t|
+        t.integer :user_id, :null => false
+        t.text :attribs1
+      end
+
+      add_index :flexcols_spec_user_preferences, :user_id, :unique => true
+    end
+
+    define_model_class(:UserPreference2, 'flexcols_spec_user_preferences') do
+      self.primary_key = :user_id
+
+      belongs_to :user, :class_name => 'User2'
+
+      flex_column :attribs1 do
+        field :foo
+        field :bar
+        field :baz
+
+        def quux
+          self.foo
+        end
+      end
+    end
+
+    define_model_class(:User2, 'flexcols_spec_users') do
+      has_one :preference, :class_name => 'UserPreference2', :foreign_key => :user_id
+
+      include_flex_columns_from :preference
+    end
+
+    define_model_class(:UserBackdoor2, 'flexcols_spec_users') { }
+
+    define_model_class(:UserPreferenceBackdoor2, 'flexcols_spec_user_preferences') { }
+
+    user = ::User2.new
+    user.name = 'User 1'
+    user.foo = 'user_1 foo'
+    user.quux = 'user_1 quux'
+    user.attribs1 = "user_1 attribs1"
+    user.save!
+
+    user_bd = ::UserBackdoor2.find(user.id)
+    user_bd.attribs1.should == 'user_1 attribs1'
+    user_bd.foo.should == 'user_1 foo'
+    user_bd.quux.should == 'user_1 quux'
+
+    user.build_preference
+    user.preference.foo = 'prefs foo'
+    user.preference.bar = 'prefs bar'
+    user.preference.baz = 'prefs baz'
+    user.preference.quux.should == 'prefs foo'
+
+    user.preference.attribs1.class.name.should match(/flexcontents/i)
+    user.attribs1.should == 'user_1 attribs1'
+    user.save!
+
+
+    user_bd = ::UserBackdoor2.find(user.id)
+    user_bd.attribs1.should == 'user_1 attribs1'
+    user_bd.foo.should == 'user_1 foo'
+    user_bd.quux.should == 'user_1 quux'
+
+    prefs_bd = ::UserPreferenceBackdoor2.where(:user_id => user.id).first
+    parsed = JSON.parse(prefs_bd.attribs1)
+    parsed.keys.sort.should == %w{foo bar baz}.sort
+    parsed['foo'].should == 'prefs foo'
+    parsed['bar'].should == 'prefs bar'
+    parsed['baz'].should == 'prefs baz'
+
+    user_again = ::User2.find(user.id)
+    user_again.foo.should == 'user_1 foo'
+    user_again.quux.should == 'user_1 quux'
+    user_again.attribs1.should == 'user_1 attribs1'
+    user_again.bar.should == 'prefs bar'
+    user_again.baz.should == 'prefs baz'
+  end
+end

data/spec/flex_columns/system/json_alias_system_spec.rb

@@ -0,0 +1,171 @@
+require 'flex_columns'
+require 'flex_columns/helpers/system_helpers'
+require 'flex_columns/helpers/exception_helpers'
+
+describe "FlexColumns JSON aliasing" do
+  include FlexColumns::Helpers::SystemHelpers
+  include FlexColumns::Helpers::ExceptionHelpers
+
+  before :each do
+    @dh = FlexColumns::Helpers::DatabaseHelper.new
+    @dh.setup_activerecord!
+
+    create_standard_system_spec_tables!
+
+    define_model_class(:UserBackdoor, 'flexcols_spec_users') { }
+  end
+
+  after :each do
+    drop_standard_system_spec_tables!
+  end
+
+  it "should store attributes under their JSON alias, but use other names absolutely everywhere else" do
+    define_model_class(:User, 'flexcols_spec_users') do
+      flex_column :user_attributes do
+        field :wants_email, :integer, :json => :we
+        field :language_setting, :json => :ls
+
+        validates :wants_email, :numericality => { :greater_than_or_equal_to => 0 }
+      end
+    end
+
+    user = ::User.new
+    user.name = 'User 1'
+    user.wants_email = 123
+    user.language_setting = 'foobar'
+    user.save!
+
+    user_bd = ::UserBackdoor.find(user.id)
+    json = user_bd.user_attributes
+    parsed = JSON.parse(json)
+
+    parsed.keys.sort.should == %w{we ls}.sort
+    parsed['we'].should == 123
+    parsed['ls'].should == 'foobar'
+
+    # make sure hashes work on original field names
+    lambda { user.user_attributes[:we] }.should raise_error(FlexColumns::Errors::NoSuchFieldError)
+    lambda { user.user_attributes[:ls] }.should raise_error(FlexColumns::Errors::NoSuchFieldError)
+
+    # Make sure methods work on original field names
+    lambda { user.user_attributes.send(:we) }.should raise_error(NoMethodError)
+    lambda { user.user_attributes.send(:ls) }.should raise_error(NoMethodError)
+
+    # Make sure validations work still
+    user.valid?.should be
+
+    user.wants_email = -123
+
+    user.valid?.should_not be
+    user.errors.keys.should == [ :'user_attributes.wants_email' ]
+
+    user.user_attributes.valid?.should_not be
+    user.user_attributes.errors.keys.should == [ :wants_email ]
+  end
+
+  it "should prohibit conflicting JSON names" do
+    e = capture_exception(FlexColumns::Errors::ConflictingJsonStorageNameError) do
+      define_model_class(:User, 'flexcols_spec_users') { }
+
+      define_model_class(:User, 'flexcols_spec_users') do
+        flex_column :user_attributes, :unknown_fields => :delete do
+          field :wants_email, :json => :aaa
+          field :language_setting, :json => :aaa
+        end
+      end
+    end
+
+    e.model_class.should == ::User
+    e.column_name.should == :user_attributes
+    e.new_field_name.should == :language_setting
+    e.existing_field_name.should == :wants_email
+    e.json_storage_name.should == :aaa
+
+    e.message.should match(/User/i)
+    e.message.should match(/user_attributes/i)
+    e.message.should match(/language_setting/i)
+    e.message.should match(/wants_email/i)
+    e.message.should match(/aaa/i)
+  end
+
+  it "should prohibit JSON names from conflicting with non-aliased fields" do
+    e = capture_exception(FlexColumns::Errors::ConflictingJsonStorageNameError) do
+      define_model_class(:User, 'flexcols_spec_users') { }
+
+      define_model_class(:User, 'flexcols_spec_users') do
+        flex_column :user_attributes, :unknown_fields => :delete do
+          field :wants_email
+          field :language_setting, :json => :wants_email
+        end
+      end
+    end
+
+    e.model_class.should == ::User
+    e.column_name.should == :user_attributes
+    e.new_field_name.should == :language_setting
+    e.existing_field_name.should == :wants_email
+    e.json_storage_name.should == :wants_email
+
+    e.message.should match(/User/i)
+    e.message.should match(/user_attributes/i)
+    e.message.should match(/language_setting/i)
+    e.message.should match(/wants_email/i)
+    e.message.should match(/wants_email/i)
+  end
+
+  it "should treat field names present in the JSON hash as unknown fields, and delete them if asked to" do
+    define_model_class(:User, 'flexcols_spec_users') do
+      flex_column :user_attributes, :unknown_fields => :delete do
+        field :wants_email, :json => :we
+        field :language_setting, :json => :ls
+      end
+    end
+
+    user = ::User.new
+    user.name = 'User 1'
+    user.save!
+
+    user_bd = ::UserBackdoor.find(user.id)
+    user_bd.user_attributes = { 'wants_email' => 123, 'we' => 456, 'language_setting' => 'bonko' }.to_json
+    user_bd.save!
+
+    user_again = ::User.find(user.id)
+    user_again.wants_email.should == 456
+    user_again.language_setting.should be_nil
+    user_again.user_attributes.touch!
+    user_again.save!
+
+    user_bd = ::UserBackdoor.find(user.id)
+    JSON.parse(user_bd.user_attributes).keys.sort.should == %w{we}.sort
+  end
+
+  it "should treat field names present in the JSON hash as unknown fields, and preserve them if asked to" do
+    define_model_class(:User, 'flexcols_spec_users') do
+      flex_column :user_attributes do
+        field :wants_email, :json => :we
+        field :language_setting, :json => :ls
+      end
+    end
+
+    user = ::User.new
+    user.name = 'User 1'
+    user.save!
+
+    user_bd = ::UserBackdoor.find(user.id)
+    user_bd.user_attributes = { 'wants_email' => 123, 'we' => 456, 'language_setting' => 'bonko' }.to_json
+    user_bd.save!
+
+    user_again = ::User.find(user.id)
+    user_again.wants_email.should == 456
+    user_again.wants_email = 567
+    user_again.language_setting.should be_nil
+    user_again.save!
+
+    user_bd = ::UserBackdoor.find(user.id)
+    parsed = JSON.parse(user_bd.user_attributes)
+    parsed.keys.sort.should == %w{wants_email we language_setting}.sort
+    parsed['wants_email'].should == 123
+    parsed['we'].should == 567
+    parsed['language_setting'].should == 'bonko'
+  end
+end