tableless_model 0.0.2 → 0.0.3

data/README.rdoc

@@ -15,7 +15,8 @@ Tableless Model is available as a Rubygem:
 
 		gem install tableless_model
 
-
+		(current version: 0.0.3)
+		
 
 == Usage
 
@@ -119,6 +120,43 @@ And this is how the content of the serialized column would look like in the data
 		noindex: false
 
 
+== Validations
+
+Tableless Model uses the gem Validatable to support validations methods and callbacks (such as "after_validation").
+Note: it currently uses the Rails 2.x syntax only.
+
+Example:
+
+
+		class SeoOptions < ActiveRecord::TablelessModel
+
+		  attribute :title_tag,         :type => :string,  :default => ""
+		  attribute :meta_description,  :type => :string,  :default => ""  
+		  attribute :meta_keywords,     :type => :string,  :default => ""  
+		  attribute :noindex,           :type => :boolean, :default => false 
+		  attribute :nofollow,          :type => :boolean, :default => false 
+		  attribute :noarchive,         :type => :boolean, :default => false 
+
+			validates_presence_of :meta_keywords
+			
+		end
+
+
+Testing:
+
+		x = SeoOptionsSettings.new
+		 => <#SeoOptions meta_description="" meta_keywords="" noarchive=false nofollow=false noindex=false 
+		title_tag="">
+
+		x.valid?
+		 => false
+		
+		x.meta_keywords = "test"
+		 => "test"
+		
+		x.valid?
+		 => true 
+
 
 == TODO
 

data/lib/activerecord/base/class_methods.rb

@@ -35,7 +35,7 @@ module Base
         
         # Making sure the serialized column contains a new instance of the tableless model
         # if it hasn't been set yet
-        default_value_for column_name => class_type.new 
+        default_value_for column_name, class_type.new 
         
         # Telling AR that the column has to store an instance of the given tableless model in 
         # YAML serialized format

data/lib/tableless_model.rb

@@ -13,6 +13,7 @@ module ActiveRecord
 
     extend   Tableless::ClassMethods
     include  Tableless::InstanceMethods
+    include Validatable
     
     # 
     # 

data/lib/tableless_model/class_methods.rb

@@ -53,11 +53,9 @@ module Tableless
     # 
     # 
     def cast(attribute_name, value)
-      return nil if value.nil?
+      type = self.attributes[attribute_name.to_s][:type] || :string
 
-      type = self.attributes[attribute_name.to_s][:type]
-    
-      return value if type.nil?
+      return nil if value.nil? && ![:string, :integer, :boolean, :float, :decimal].include?(type)
     
       begin
         case type

data/lib/tableless_model/instance_methods.rb

@@ -68,12 +68,11 @@ module Tableless
     
     # 
     # 
-    # Ensures that when merging with a given hash
-    # all the keys are stringified as the keys are always handled 
-    # as strings in the tableless model
+    # Since the object should only allow the defined attributes
+    # merging is forbidden
     # 
     def merge(hash)
-      super hash.stringify_keys
+      raise NoMethodError
     end
 
   end

data/lib/tableless_model/version.rb

@@ -1,3 +1,3 @@
 module TablelessModel
-  VERSION = "0.0.2"
+  VERSION = "0.0.3"
 end

data/spec/tableless_model_spec.rb

@@ -1,93 +1,159 @@
-require "rubygems"
+require File.join(File.dirname(__FILE__), "test_helper")
+
 require "active_record"
 require "lib/tableless_model"
 require 'minitest/autorun'
 
-class TestTablelessModel < ActiveRecord::TablelessModel 
-end
-
 
-describe TestTablelessModel do
-  it "has the accessor 'attributes', originally an empty hash" do
-    TestTablelessModel.must_respond_to("attributes")
-    TestTablelessModel.attributes.must_be_kind_of Hash
-    TestTablelessModel.attributes.must_be_empty
+describe "A class inheriting from ActiveRecord::TablelessModel " do
+  before do
+    class TestClass1 < ActiveRecord::TablelessModel
+    end
   end
   
-  it "responds to 'attribute'" do
-    TestTablelessModel.must_respond_to "attribute"
+  it "has the accessor 'attributes', which is originally an empty hash" do
+    TestClass1.must_respond_to("attributes")
+    TestClass1.attributes.must_be_kind_of Hash
+    TestClass1.attributes.must_be_empty
   end
 
   it "responds to 'attribute', 'cast'" do
-    TestTablelessModel.must_respond_to "attribute"
-    TestTablelessModel.must_respond_to "cast"
+    ["attribute", "cast"].each {|method_name| TestClass1.must_respond_to method_name }
   end
+end
 
-  describe "'attribute' macro" do
-    before do
-      TestTablelessModel.class_eval do
-        attribute :test_attribute
-      end
+describe "The 'attribute' macro" do
+  before do
+    class TestClass < ActiveRecord::TablelessModel
+      attribute :test_attribute
+    end
+  end
+
+  it "adds a key-value pair to the attributes accessor" do
+    TestClass.attributes.wont_be_empty
+    TestClass.attributes.key?("test_attribute").must_equal true, "An attribute named 'test_attribute' should have been defined"
+  end
+end
+
+describe "An instance of TablelessModel" do
+  before do
+    class TestClass2 < ActiveRecord::TablelessModel
+      attribute :test_attribute
+      attribute :test_attribute_with_default_value,           :default => "default value"
+      attribute :test_attribute_with_type_and_default_value,  :default => "003xxx", :type => :integer
     end
     
-    it "adds a key-value pair to the attributes accessor" do
-      TestTablelessModel.attributes.wont_be_empty
-      TestTablelessModel.attributes.key?("test_attribute").must_equal true, "An attribute named 'test_attribute' should have been defined"
+    @instance = TestClass2.new
+  end
+  
+  it "has a getter and a setter for each defined attribute" do
+    [:test_attribute, :test_attribute_with_default_value, :test_attribute_with_type_and_default_value].each do |attribute_name|
+      @instance.must_respond_to attribute_name,       "Getter for #{attribute_name} should have been defined"
+      @instance.must_respond_to "#{attribute_name}=", "Setter for #{attribute_name} should have been defined"
     end
   end
+  
+  it "assigns the default value to an attribute that has not yet been set, if a default value has been specified" do
+    @instance.test_attribute_with_default_value.must_equal "default value"
+    @instance.test_attribute_with_type_and_default_value.must_equal 3
+  end
+  
+  it "should allow overriding the default values" do
+    instance = TestClass2.new( :test_attribute_with_default_value => "changed value" )
+    instance.test_attribute_with_default_value.must_equal "changed value"
+  end
+  
+  it "assumes an attribute's data type is string if the type has not been specified" do
+    @instance.test_attribute.must_be_kind_of String
+  end
 
-  describe "An instance of TablelessModel" do
-    before do
-      TestTablelessModel.class_eval do
-        attribute :test_attribute
-      end
-    end
+  it "assigns the expected not-nil value to an attribute if a default value hasn't been specified" do
+    @instance.test_attribute.must_equal ""
+  end
+  
+  it "does not allow access to undefined attributes" do
+    @instance.wont_respond_to "unknown_attribute"
+    @instance.wont_respond_to "unknown_attribute="
+    
+    proc { @instance["unknown_attribute"] }.must_raise(NoMethodError)
+    proc { @instance["unknown_attribute="] }.must_raise(NoMethodError)
+  end
+  
+  it "shows the expected output on inspect" do
+    @instance.inspect.must_equal "<#TestClass2 test_attribute=\"\" test_attribute_with_default_value=\"default value\" test_attribute_with_type_and_default_value=3>"
+  end
 
-    it "tries to enforce type casting if a type has been specified for an attribute" do
 
-      test_values = [ "test", 1234, true, "1234.12", "2011-01-02 15:23" ]
-      
-      [ :string, :integer, :float, :decimal, :time, :date, :datetime, :boolean ].each do |type|
+  it "should not allow merging" do
+    proc { @instance.merge(:new_symbol_key => "new_symbol_key") }.must_raise NoMethodError
+  end
+  
+end
 
-        # temporarily changing type
-        TestTablelessModel.attributes["test_attribute"][:type] = type
 
-        instance = TestTablelessModel.new
-        
-        # instance.must_respond_to "test_attribute", "Getter for test_attribute should have been defined"
-        # instance.must_respond_to "test_attribute=", "Setter for test_attribute should have been defined"
+describe "An instance of TablelessModel" do
+  before do
+    class TestClass3 < ActiveRecord::TablelessModel
+      attribute :typed_test_attribute,  :type => :integer
+    end
+  end
+  
+  it "tries to enforce type casting if a type has been specified for an attribute" do
 
-        type_name = case type
-        when :datetime then :date_time
-        when :decimal then :big_decimal
-        else type
-        end
+    test_values = [ "test", 1234, true, "1234.12", "2011-01-02 15:23" ]
+    
+    [ :string, :integer, :float, :decimal, :time, :date, :datetime, :boolean ].each do |type|
 
+      # temporarily changing type
+      TestClass3.attributes["typed_test_attribute"][:type] = type
 
-        # excluding some test values that would always faild depending on the type
-        exclude_test_values = case type
-        when :decimal then [ "test", true ]
-        when :time then [ 1234, true ]
-        when :date then [ "test", 1234, true, "1234.12" ]
-        when :datetime then [ "test", 1234, true ]
-        else []
+      instance = TestClass3.new
+      
+      type_name = case type
+      when :datetime then :date_time
+      when :decimal then :big_decimal
+      else type
+      end
+        
+        
+      # excluding some test values that would always fail depending on the type
+      exclude_test_values = case type
+      when :decimal then [ "test", true ]
+      when :time then [ 1234, true ]
+      when :date then [ "test", 1234, true, "1234.12" ]
+      when :datetime then [ "test", 1234, true ]
+      else []
+      end
+        
+      (test_values - exclude_test_values).each do |value|
+        instance.typed_test_attribute = value
+        
+        if type == :boolean
+          [true, false].include?(instance.typed_test_attribute).must_equal true, "Expected #{instance.typed_test_attribute.inspect} to be boolean, not #{type.class}"
+        else
+          instance.typed_test_attribute.must_be_kind_of type_name.to_s.classify.constantize
         end
+      end
 
+    end
+  end
+end
 
-        (test_values - exclude_test_values).each do |value|
-
-          instance.test_attribute = value
-
-          if type == :boolean
-            [true, false].include?(instance.test_attribute).must_equal true, "Expected #{instance.test_attribute.inspect} to be boolean, not #{type.class}"
-          else
-            instance.test_attribute.must_be_kind_of type_name.to_s.classify.constantize
-          end
-          
-        end
 
-      end
+describe "An ActiveRecord::Base model" do
+  before do
+    class ModelOptions < ActiveRecord::TablelessModel
+      attribute :aaa, :default => 111
+      attribute :bbb, :default => "bbb"
+    end
+    
+    class Model < ActiveRecord::Base
+      # has_tableless :options => ModelOptions
     end
   end
-
+  
+  it "responds to default_value_for, has_tableless" do
+    [:default_value_for, :has_tableless].each {|method| Model.must_respond_to(method)}
+  end
+  
 end

data/spec/test_helper.rb

@@ -0,0 +1,154 @@
+require 'rubygems'
+require 'minitest/unit'
+require 'minitest/spec'
+require 'ansi'
+
+class MiniTest::Unit
+  include ANSI::Code
+
+  PADDING_SIZE = 4
+
+  def run(args = [])
+    @verbose = true
+
+    filter = if args.first =~ /^(-n|--name)$/ then
+               args.shift
+               arg = args.shift
+               arg =~ /\/(.*)\// ? Regexp.new($1) : arg
+             else
+               /./ # anything - ^test_ already filtered by #tests
+             end
+
+    @@out.puts "Loaded suite #{$0.sub(/\.rb$/, '')}\nStarted"
+
+    start = Time.now
+    run_test_suites filter
+
+    @@out.puts
+    @@out.puts "Finished in #{'%.6f' % (Time.now - start)} seconds."
+
+    @@out.puts
+
+    @@out.print "%d tests, " % test_count
+    @@out.print "%d assertions, " % assertion_count
+    @@out.print red { "%d failures, " % failures }
+    @@out.print yellow { "%d errors, " % errors }
+    @@out.puts cyan { "%d skips" % skips}
+
+    return failures + errors if @test_count > 0 # or return nil...
+  end
+
+  # Overwrite #run_test_suites so that it prints out reports
+  # as errors are generated.
+  def run_test_suites(filter = /./)
+    @test_count, @assertion_count = 0, 0
+    old_sync, @@out.sync = @@out.sync, true if @@out.respond_to? :sync=
+    TestCase.test_suites.each do |suite|
+      test_cases = suite.test_methods.grep(filter)
+      if test_cases.size > 0
+        @@out.print "\n#{suite}:\n"
+      end
+
+      test_cases.each do |test|
+        inst = suite.new test
+        inst._assertions = 0
+
+        t = Time.now
+
+        @broken = nil
+
+        @@out.print(case inst.run(self)
+                    when :pass
+                      @broken = false
+                      green { pad_with_size "PASS" }
+                    when :error
+                      @broken = true
+                      yellow { pad_with_size "ERROR" }
+                    when :fail
+                      @broken = true
+                      red { pad_with_size "FAIL" }
+                    when :skip
+                      @broken = false
+                      cyan { pad_with_size "SKIP" }
+                    end)
+
+
+        @@out.print " #{test.humanize.gsub(/Test\s\d+\s(.*)/,"\\1")} "
+        @@out.print " (%.2fs) " % (Time.now - t)
+
+        if @broken
+          @@out.puts
+
+          report = @report.last
+          @@out.puts pad(report[:message], 10)
+          trace = MiniTest::filter_backtrace(report[:exception].backtrace).first
+          @@out.print pad(trace, 10)
+
+          @@out.puts
+        end
+
+        @@out.puts
+        @test_count += 1
+        @assertion_count += inst._assertions
+      end
+    end
+    @@out.sync = old_sync if @@out.respond_to? :sync=
+    [@test_count, @assertion_count]
+  end
+
+  def pad(str, size=PADDING_SIZE)
+    " " * size + str
+  end
+
+  def pad_with_size(str)
+    pad("%5s" % str)
+  end
+
+  # Overwrite #puke method so that is stores a hash
+  # with :message and :exception keys.
+  def puke(klass, meth, e)
+    result = nil
+    msg = case e
+        when MiniTest::Skip
+          @skips += 1
+          result = :skip
+          e.message
+        when MiniTest::Assertion
+          @failures += 1
+          result = :fail
+          e.message
+        else
+          @errors += 1
+          result = :error
+          "#{e.class}: #{e.message}\n"
+        end
+
+    @report << {:message => msg, :exception => e}
+    result
+  end
+
+
+  class TestCase
+    # Overwrite #run method so that is uses symbols
+    # as return values rather than characters.
+    def run(runner)
+      result = :pass
+      begin
+        @passed = nil
+        self.setup
+        self.send  self.__name__
+        @passed = true
+      rescue Exception => e
+        @passed = false
+        result = runner.puke(self.class, self.__name__, e)
+      ensure
+        begin
+          self.teardown
+        rescue Exception => e
+          result = runner.puke(self.class, self.__name__, e)
+        end
+      end
+      result
+    end
+  end
+end

data/tableless_model.gemspec

@@ -9,14 +9,13 @@ Gem::Specification.new do |s|
   s.platform    = Gem::Platform::RUBY
   s.authors     = ["Vito Botta"]
   s.email       = ["vito@botta.name"]
-  s.homepage    = "http://rubygems.org/gems/tableless_model"
+  s.homepage    = "https://github.com/vitobotta/tableless_model"
   s.summary     = %q{A serialisable and validatable table-less model with support for associations, useful to store settings, options, etc in a serialized form in a parent object}
   s.description = %q{A serialisable and validatable table-less model with support for associations, useful to store settings, options, etc in a serialized form in a parent object}
 
   s.add_dependency "validatable"
-
-  s.add_development_dependency "activerecord"
   s.add_development_dependency "minitest"
+  s.add_development_dependency "ansi"
   
   s.rubyforge_project = "tableless_model"
 

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: tableless_model
 version: !ruby/object:Gem::Version 
-  hash: 27
+  hash: 25
   prerelease: 
   segments: 
   - 0
   - 0
-  - 2
-  version: 0.0.2
+  - 3
+  version: 0.0.3
 platform: ruby
 authors: 
 - Vito Botta
@@ -33,7 +33,7 @@ dependencies:
   type: :runtime
   version_requirements: *id001
 - !ruby/object:Gem::Dependency 
-  name: activerecord
+  name: minitest
   prerelease: false
   requirement: &id002 !ruby/object:Gem::Requirement 
     none: false
@@ -47,7 +47,7 @@ dependencies:
   type: :development
   version_requirements: *id002
 - !ruby/object:Gem::Dependency 
-  name: minitest
+  name: ansi
   prerelease: false
   requirement: &id003 !ruby/object:Gem::Requirement 
     none: false
@@ -81,9 +81,10 @@ files:
 - lib/tableless_model/instance_methods.rb
 - lib/tableless_model/version.rb
 - spec/tableless_model_spec.rb
+- spec/test_helper.rb
 - tableless_model.gemspec
 has_rdoc: true
-homepage: http://rubygems.org/gems/tableless_model
+homepage: https://github.com/vitobotta/tableless_model
 licenses: []
 
 post_install_message: 
@@ -118,3 +119,4 @@ specification_version: 3
 summary: A serialisable and validatable table-less model with support for associations, useful to store settings, options, etc in a serialized form in a parent object
 test_files: 
 - spec/tableless_model_spec.rb
+- spec/test_helper.rb