flex_columns 1.0.0

data/spec/flex_columns/system/delegation_system_spec.rb

@@ -0,0 +1,175 @@
+require 'flex_columns'
+require 'flex_columns/helpers/exception_helpers'
+require 'flex_columns/helpers/system_helpers'
+
+describe "FlexColumns delegation" 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!
+  end
+
+  after :each do
+    drop_standard_system_spec_tables!
+  end
+
+  it "should delegate methods by default" do
+    define_model_class(:User, 'flexcols_spec_users') do
+      flex_column :user_attributes do
+        field :wants_email
+        field :something
+        field :something_else
+      end
+    end
+
+    user = ::User.new
+
+    %w{wants_email something something_else}.each do |method_name|
+      user.respond_to?(method_name).should be
+      user.respond_to?("#{method_name}=").should be
+
+      user.send(method_name).should be_nil
+      value = "abc123#{rand(1_000)}"
+      user.send("#{method_name}=", value).should == value
+      user.send(method_name).should == value
+
+      user.user_attributes.send(method_name).should == value
+      user.user_attributes.send("#{method_name}=", value + "new").should == value + "new"
+      user.send(method_name).should == value + "new"
+    end
+  end
+
+  it "should not override columns on the model object" do
+    migrate do
+      drop_table :flexcols_spec_users
+      create_table :flexcols_spec_users do |t|
+        t.string :name, :null => false
+        t.string :foo
+        t.string :baz
+        t.text :user_attributes
+      end
+    end
+
+    define_model_class(:User, 'flexcols_spec_users') do
+      flex_column :user_attributes do
+        field :foo
+        field :bar
+
+        def baz
+          foo + "!!"
+        end
+      end
+    end
+
+    ::User.reset_column_information
+
+    define_model_class(:UserBackdoor, 'flexcols_spec_users') { }
+
+    user = ::User.new
+    user.name = 'User 1'
+    user.foo = "outer_foo"
+    user.baz = "outer_baz"
+    user.user_attributes.foo = "inner_foo"
+    user.save!
+
+    user_again = ::User.find(user.id)
+    user_again.foo.should == "outer_foo"
+    user_again.user_attributes.foo.should == "inner_foo"
+    user_again.baz.should == "outer_baz"
+    user_again.user_attributes.baz.should == "inner_foo!!"
+
+    user_bd = ::UserBackdoor.find(user.id)
+    user_bd.foo.should == "outer_foo"
+    user_bd.baz.should == "outer_baz"
+    parsed = JSON.parse(user_bd.user_attributes)
+    parsed.keys.should == [ 'foo' ]
+    parsed['foo'].should == "inner_foo"
+  end
+
+  it "should let you turn off delegation for a column" do
+    define_model_class(:User, 'flexcols_spec_users') do
+      flex_column :user_attributes, :delegate => false do
+        field :wants_email
+        field :something
+        field :something_else
+      end
+    end
+
+    user = ::User.new
+
+    %w{wants_email something something_else}.each do |method_name|
+      user.respond_to?(method_name).should_not be
+      user.respond_to?("#{method_name}=").should_not be
+
+      lambda { user.send(method_name) }.should raise_error(NoMethodError.superclass)
+      lambda { user.send("#{method_name}=", 1234) }.should raise_error(NoMethodError.superclass)
+
+      user.user_attributes.send(method_name).should be_nil
+      value = "abc123#{rand(1_000)}"
+      user.user_attributes.send("#{method_name}=", value).should == value
+      user.user_attributes.send(method_name).should == value
+    end
+  end
+
+  it "should let you use private delegation for a column" do
+    define_model_class(:User, 'flexcols_spec_users') do
+      flex_column :user_attributes, :delegate => :private do
+        field :wants_email
+        field :something
+        field :something_else
+      end
+    end
+
+    user = ::User.new
+
+    %w{wants_email something something_else}.each do |method_name|
+      user.respond_to?(method_name).should_not be
+      user.respond_to?("#{method_name}=").should_not be
+
+      lambda { eval("user.#{method_name}") }.should raise_error(NoMethodError)
+      lambda { eval("user.#{method_name} = 123") }.should raise_error(NoMethodError)
+
+      user.send(method_name).should be_nil
+      value = "abc123#{rand(1_000)}"
+      user.send("#{method_name}=", value).should == value
+      user.send(method_name).should == value
+    end
+  end
+
+  it "should let you add a prefix to methods" do
+    define_model_class(:User, 'flexcols_spec_users') do
+      flex_column :user_attributes, :prefix => 'bar' do
+        field :wants_email
+        field :something
+        field :something_else
+      end
+    end
+
+    user = ::User.new
+
+    %w{wants_email something something_else}.each do |method_name|
+      user.respond_to?(method_name).should_not be
+      user.respond_to?("#{method_name}=").should_not be
+
+      lambda { user.send(method_name) }.should raise_error(NoMethodError.superclass)
+      lambda { user.send("#{method_name}=", 1234) }.should raise_error(NoMethodError.superclass)
+
+      correct_method_name = "bar_#{method_name}"
+      user.respond_to?(correct_method_name).should be
+      user.respond_to?("#{correct_method_name}=").should be
+
+      user.send(correct_method_name).should be_nil
+      value = "abc123#{rand(1_000)}"
+      user.send("#{correct_method_name}=", value).should == value
+      user.send(correct_method_name).should == value
+
+      user.user_attributes.send(method_name).should == value
+      user.user_attributes.send("#{method_name}=", value + "new").should == value + "new"
+      user.send(correct_method_name).should == value + "new"
+    end
+  end
+end

data/spec/flex_columns/system/dynamism_system_spec.rb

@@ -0,0 +1,158 @@
+require 'flex_columns'
+require 'flex_columns/helpers/system_helpers'
+
+describe "FlexColumns basic operations" do
+  include FlexColumns::Helpers::SystemHelpers
+
+  before :each do
+    @dh = FlexColumns::Helpers::DatabaseHelper.new
+    @dh.setup_activerecord!
+
+    create_standard_system_spec_tables!
+  end
+
+  after :each do
+    drop_standard_system_spec_tables!
+  end
+
+  it "should let you redefine flex columns, and obey the new settings" do
+    class ::User < ::ActiveRecord::Base
+      self.table_name = 'flexcols_spec_users'
+
+      flex_column :user_attributes do
+        field :att1
+        field :att2
+
+        def abc
+          "abc!"
+        end
+      end
+    end
+
+    user = ::User.new
+    user.att1 = "foo"
+    user.att2 = "bar"
+    user.abc.should == 'abc!'
+
+    class ::User < ::ActiveRecord::Base
+      self.table_name = 'flexcols_spec_users'
+
+      flex_column :user_attributes do
+        field :att3
+        field :att2
+
+        def def
+          "def!"
+        end
+      end
+    end
+
+    user2 = ::User.new
+    user2.respond_to?(:att1).should_not be
+    user2.user_attributes.respond_to?(:att1).should_not be
+    user2.respond_to?(:abc).should_not be
+    user2.user_attributes.respond_to?(:abc).should_not be
+
+    # explicitly not testing if user.respond_to?(:att3) or if user.respond_to?)(:att1); we make no guarantees about
+    # what happened on older objects
+
+    class ::User < ::ActiveRecord::Base
+      self.table_name = 'flexcols_spec_users'
+
+      flex_column :user_attributes do
+        field :att1
+        field :att2
+      end
+    end
+
+    user3 = ::User.new
+    user3.respond_to?(:att1).should be
+    user3.user_attributes.respond_to?(:att1).should be
+    user3.respond_to?(:att2).should be
+    user3.user_attributes.respond_to?(:att2).should be
+    user3.user_attributes.respond_to?(:abc).should_not be
+    user3.respond_to?(:abc).should_not be
+    user3.user_attributes.respond_to?(:def).should_not be
+    user3.respond_to?(:def).should_not be
+  end
+
+  it "should discard all attributes when #reload is called" do
+    define_model_class(:User, 'flexcols_spec_users') do
+      flex_column :user_attributes do
+        field :wants_email
+      end
+    end
+
+    user = ::User.new
+    user.name = 'User 1'
+    user.save!
+
+    user = ::User.find(user.id)
+    user.name = 'User 2'
+    user.wants_email = 'bonko'
+
+    user.reload
+
+    user.name.should == 'User 1'
+    user.wants_email.should be_nil
+  end
+
+  it "should use the most-recently-defined flex-column attribute in delegation, if there's a conflict" do
+    define_model_class(:User, 'flexcols_spec_users') do
+      flex_column :user_attributes do
+        field :att1
+        field :att2
+      end
+
+      flex_column :more_attributes do
+        field :att2
+        field :att3
+      end
+    end
+
+    user = ::User.new
+    user.name = 'User 1'
+    user.att1 = "foo"
+    user.att2 = "bar"
+    user.att3 = "baz"
+
+    user.user_attributes.att1.should == "foo"
+    user.user_attributes.att2.should be_nil
+    user.user_attributes.att2 = "quux"
+    user.more_attributes.att2.should == "bar"
+    user.more_attributes.att3.should == "baz"
+
+    user.att2.should == "bar"
+
+    # Now, reverse them
+
+    define_model_class(:User, 'flexcols_spec_users') do
+      flex_column :more_attributes do
+        field :att2
+        field :att3
+      end
+
+      flex_column :user_attributes do
+        field :att1
+        field :att2
+      end
+    end
+
+    user = ::User.new
+    user.name = 'User 1'
+    user.att1 = "foo"
+    user.att2 = "bar"
+    user.att3 = "baz"
+
+    user.user_attributes.att1.should == "foo"
+    user.user_attributes.att2.should == "bar"
+    user.more_attributes.att2.should be_nil
+    user.more_attributes.att2 = "quux"
+    user.more_attributes.att3.should == "baz"
+
+    user.user_attributes.att2.should == "bar"
+    user.more_attributes.att2.should == "quux"
+
+    user.att2.should == "bar"
+  end
+end

data/spec/flex_columns/system/error_handling_system_spec.rb

@@ -0,0 +1,117 @@
+require 'flex_columns'
+require 'flex_columns/helpers/system_helpers'
+require 'flex_columns/helpers/exception_helpers'
+
+describe "FlexColumns error handling" do
+  include FlexColumns::Helpers::SystemHelpers
+  include FlexColumns::Helpers::ExceptionHelpers
+
+  before :each do
+    @dh = FlexColumns::Helpers::DatabaseHelper.new
+    @dh.setup_activerecord!
+
+    migrate do
+      drop_table :flexcols_spec_users rescue nil
+      create_table :flexcols_spec_users do |t|
+        t.string :name, :null => false
+        t.string :user_attributes, :limit => 100
+      end
+    end
+
+    define_model_class(:User, 'flexcols_spec_users') do
+      flex_column :user_attributes do
+        field :wants_email
+      end
+    end
+
+    define_model_class(:UserBackdoor, 'flexcols_spec_users') { }
+  end
+
+  after :each do
+    migrate do
+      drop_table :flexcols_spec_users rescue nil
+    end
+  end
+
+  it "should return a nice error if JSON parsing fails" do
+    user_bd_1 = ::UserBackdoor.new
+    user_bd_1.name = 'User 1'
+    user_bd_1.user_attributes = "---unparseable json---"
+    user_bd_1.save!
+
+    user = ::User.find(user_bd_1.id)
+
+    e = capture_exception(FlexColumns::Errors::UnparseableJsonInDatabaseError) { user.wants_email }
+    e.message.should match(/user.*id.*#{user.id}/i)
+    e.message.should match(/\-\-\-unparseable json\-\-\-/i)
+    e.message.should match(/JSON::ParserError/i)
+
+    e.data_source.should be(user.user_attributes)
+    e.raw_string.should == "---unparseable json---"
+    e.source_exception.class.should == JSON::ParserError
+  end
+
+  it "should return a nice error if the string isn't even a validly-encoded string" do
+    user = ::UserBackdoor.new
+    user.name = 'User 1'
+    user.save!
+
+    user2 = ::User.find(user.id)
+
+    class << user2
+      def [](x)
+        if x.to_s == "user_attributes"
+          out = "abc\xC3\x28def"
+          out = out.force_encoding("UTF-8") if out.respond_to?(:force_encoding)
+          out
+        else
+          super(x)
+        end
+      end
+    end
+
+    if "foo".respond_to?(:force_encoding) # do we have Ruby >= 1.9?
+      e = capture_exception(FlexColumns::Errors::IncorrectlyEncodedStringInDatabaseError) { user2.wants_email }
+      e.message.should match(/user.*id.*#{user2.id}/i)
+      e.message.should match(/abc.*def/i)
+      e.message.should match(/position 3/i)
+      e.message.should match(/c3/i)
+
+      e.data_source.should be(user2.user_attributes)
+      e.raw_string.should match(/abc.*def/i)
+
+      invalid_char = ["C3"].pack("H*")
+      invalid_char.force_encoding("UTF-8")
+
+      e.invalid_chars_as_array.include?(invalid_char).should be
+      e.raw_data_as_array.include?(invalid_char).should be
+      e.raw_data_as_array.include?("a").should be
+      e.first_bad_position.should == 3
+    else
+      e = capture_exception(FlexColumns::Errors::UnparseableJsonInDatabaseError) { user2.wants_email }
+      e.message.should match(/user.*id.*#{user2.id}/i)
+      e.message.should match(/abc.*def/i)
+      e.message.should match(/JSON::ParserError/i)
+
+      e.data_source.should be(user2.user_attributes)
+      e.raw_string.should match(/abc.*def/i)
+    end
+  end
+
+  it "should fail before storing if the JSON produced is too long for the column" do
+    user = ::User.new
+    user.name = 'User 1'
+    user.wants_email = 'aaa' * 10000
+
+    e = capture_exception(FlexColumns::Errors::JsonTooLongError) { user.save! }
+    e.message.should match(/user_attributes/i)
+    e.message.should match(/100/i)
+    e.message.should match(/aaa/i)
+    e.message.should match(/30[0-9][0-9][0-9]/i)
+    e.message.length.should < 1000
+
+    e.data_source.should be(user.user_attributes)
+    e.limit.should == 100
+    e.json_string.length.should > 30000
+  end
+end