icss 0.1.3 → 0.3.2

data/spec/serialization_spec.rb

@@ -0,0 +1,63 @@
+require File.expand_path('spec_helper', File.dirname(__FILE__))
+require 'time'
+require 'icss'
+require ENV.root_path('spec/support/icss_test_helper')
+include IcssTestHelper
+
+module Fake
+  class Thing
+    include Icss::ReceiverModel
+    field :name, String
+    field :description, String
+  end
+
+  class GeoCoordinates
+    include Icss::ReceiverModel
+    field :longitude, Float, :validates => { :numericality => { :>= => -180, :<= => 180  } }
+    field :latitude,  Float, :validates => { :numericality => { :>= =>  -90, :<= =>  90  } }
+    def coordinates
+      [ longitude, latitude ]
+    end
+  end
+
+  class Place < Thing
+    field :geo, GeoCoordinates
+  end
+
+  class MenuItem < Thing
+    field :price, Float, :required => true
+  end
+
+  class TacoTrailer < Place
+    field :menu,          Array, :items => MenuItem
+    field :founding_date, Time
+  end
+end
+
+TORCHYS_HSH = {
+  :name => "Torchy's Taco's",
+  :geo  => { :longitude => 30.295, :latitude => -97.745 },
+  :menu => [
+    { :name => "Dirty Sanchez", :price => 3.50 },
+    { :name => "Fried Avocado", :price => 2.95 }
+  ],
+  :founding_date => '2006-08-01T00:00:00Z',
+}
+
+describe Icss::ReceiverModel do
+  let(:torchys) do
+    Fake::TacoTrailer.receive(TORCHYS_HSH)
+  end
+
+  context 'serializations' do
+
+    context '#to_wire' do
+      it 'works on a complex record' do
+        # p torchys
+        # p torchys.to_wire
+        torchys.to_wire.should == TORCHYS_HSH
+      end
+    end
+  end
+
+end

data/spec/spec_helper.rb

@@ -1,16 +1,33 @@
-require 'rubygems'
 require 'spork'
 require 'rspec'
 
-ICSS_ROOT_DIR = File.expand_path(File.join(File.dirname(__FILE__),'..'))
-def ICSS_ROOT_DIR *paths
-  File.join(::ICSS_ROOT_DIR, *paths)
+def ENV.root_path(*args)
+  File.expand_path(File.join(File.dirname(__FILE__), '..', *args))
 end
 
 Spork.prefork do # Must restart for changes to config / code from libraries loaded here
-  $LOAD_PATH.unshift(ICSS_ROOT_DIR('lib'))
-  $LOAD_PATH.unshift(ICSS_ROOT_DIR('spec/support'))
-  Dir[ICSS_ROOT_DIR('spec/support/matchers/*.rb')].each {|f| require f}
+  $LOAD_PATH.unshift(ENV.root_path('lib'))
+  Dir[ENV.root_path('spec/support/matchers/*.rb')].each {|f| require f}
+
+  require 'awesome_print'
+
+  require 'gorillib/object/blank'
+  require 'gorillib/object/try_dup'
+  require 'gorillib/string/inflections'
+  require 'gorillib/string/constantize'
+  require 'gorillib/array/compact_blank'
+  require 'gorillib/array/extract_options'
+  require 'gorillib/hash/compact'
+  require 'gorillib/hash/keys'
+  require 'gorillib/hash/tree_merge'
+  require 'gorillib/metaprogramming/class_attribute'
+  require 'gorillib/hashlike'
+
+  require 'yaml'
+  require 'json' unless defined?(JSON)
+
+  # note: please do NOT include library methods here.
+  # They should be painfully explicity included in your specs.
 
   # Configure rspec
   RSpec.configure do |config|

data/spec/support/icss_test_helper.rb

@@ -0,0 +1,67 @@
+module IcssTestHelper
+  FALSE_PARENTS = %w[Boolean Icss::Mu::EpochTime Long Double]
+
+  SIMPLE_TYPES_TO_TEST = {
+    :null               => [ ::NilClass,              NilClass,   nil],
+    :boolean            => [ ::Boolean,               TrueClass, true],
+    :int                => [ ::Integer,               Integer,      1],
+    :long               => [ ::Long,                  Integer,      1],
+    :float              => [ ::Float,                 Float,      1.0],
+    :double             => [ ::Double,                Float,      1.0],
+    :string             => [ ::String,                String, "hello"],
+    :bytes              => [ ::Binary,                String, "hello"],
+    :binary             => [ ::Binary,                String, "hello"],
+    :integer            => [ ::Integer,               Integer,      1],
+    :regexp             => [ ::Regexp,                Regexp,     /a/],
+    :numeric            => [ ::Numeric,               ::Numeric,  1.0],
+    :symbol             => [ ::Symbol,                Symbol,    :bob],
+    :time               => [ ::Time,                  Time,  Time.now],
+  }
+
+
+  def remove_icss_constants(*names)
+    ['Icss', 'Icss::Meta'].each do |outer_mod|
+      names.each do |name|
+        name_parts = name.to_s.split(/::/)
+        const_name = name_parts.pop
+        parent_mod = ([outer_mod]+name_parts).join('::')
+        ['', 'Type', 'Model'].each do |tail|
+          remove_potential_constant(parent_mod, const_name+tail)
+        end
+      end
+    end
+  end
+
+  def remove_potential_constant(parent_mod, const_name)
+    begin
+      parent_mod = (parent_mod.is_a?(Module) ? parent_mod : parent_mod.to_s.constantize)
+    rescue ; return ; end
+    parent_mod.send(:remove_const, const_name) if parent_mod.const_defined?(const_name)
+  end
+end
+
+module Icss
+  module This
+    module That
+      class TheOther
+      end
+    end
+    module Blinken ; end
+  end
+end
+
+if defined?(Icss::Meta::RecordModel)
+  module Icss
+    class SmurfRecord
+      include Icss::Meta::RecordModel
+    end
+  end
+end
+
+if defined?(Icss::ReceiverModel)
+  module Icss
+    class SmurfModel
+      include Icss::ReceiverModel
+    end
+  end
+end

data/spec/support/load_example_protocols.rb

@@ -0,0 +1,17 @@
+module Icss
+  module Spec
+    module LoadExampleProtocols
+
+      def load_example_protocols
+        [
+          Dir[ENV.root_path('examples/hackboxen/**/*.icss.yaml')],
+          Dir[ENV.root_path('examples/apeyeye_endpoints/**/*.icss.yaml')],
+        ].flatten[0.. -1].each do |icss_filename|
+          next if icss_filename =~ %r{culture/art}
+          Icss::Meta::Protocol.receive_from_file(icss_filename)
+        end
+      end
+
+    end
+  end
+end

data/spec/type/named_type_spec.rb

@@ -0,0 +1,75 @@
+require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')
+require 'icss/type'
+require 'icss/type/simple_types'
+require 'icss/type/named_type'
+
+describe Icss::Meta::NamedType do
+
+  module Icss
+    module This
+      module That
+        class TheOther
+        end
+      end
+    end
+    Blinken = 7
+  end
+  #
+  #  modules defined outside of Icss with the same names will cause problems
+  #  unless const_defined? and const_get are used correctly
+  #
+  module Nod
+  end
+  module Wears
+  end
+
+  context '.make' do
+    it 'succeeds when the class already exists' do      
+      klass, klass_metamodel = Icss::Meta::NamedType.make('this.that.the_other', Object)
+      klass.should be_a(Class)
+      klass.name.should == 'Icss::This::That::TheOther'
+      klass_metamodel.should be_a(Module)
+      klass_metamodel.name.should == 'Icss::Meta::This::That::TheOtherModel'
+    end
+    it 'succeeds when the class does not already exist' do
+      Icss.should_not be_const_defined(:YourMom)
+      klass, klass_metamodel = Icss::Meta::NamedType.make('your_mom.wears.combat_boots', Hash)
+      klass.name.should == 'Icss::YourMom::Wears::CombatBoots'
+      klass.should < Hash
+      Icss::Meta::YourMom::Wears::CombatBootsModel.class.should == Module
+      Icss::Meta::YourMom::Wears.class.should                  == Module
+      Icss::YourMom::Wears::CombatBoots.class.should           == Class
+      Icss::YourMom::Wears.class.should                        == Module
+      Icss::Meta.send(:remove_const, :YourMom)
+      Icss.send(:remove_const, :YourMom)
+    end
+    it 'creates a klass which inherits (includes) its metatype' do
+      klass, klass_metamodel = Icss::Meta::NamedType.make('this.that.the_other', Object)
+      klass.metamodel.should == Icss::Meta::This::That::TheOtherModel
+    end
+  end
+
+  context '.get_nested_module' do
+    it 'adds a new child when parents exist' do
+      Icss::This::That.should_not be_const_defined(:AlsoThis)
+      new_module = Icss::Meta::NamedType.get_nested_module(%w[Icss This That AlsoThis])
+      new_module.name.should == 'Icss::This::That::AlsoThis'
+      Icss::This::That::AlsoThis.class.should == Module
+      Icss::This::That.send(:remove_const, :AlsoThis)
+    end
+    it 'adds parents as necessary' do
+      Icss.should_not be_const_defined(:Winken)
+      new_module = Icss::Meta::NamedType.get_nested_module(%w[Icss Winken Blinken Nod])
+      new_module.name.should == 'Icss::Winken::Blinken::Nod'
+      Icss::Winken::Blinken::Nod.class.should == Module
+      Icss::Winken::Blinken.class.should      == Module
+      Icss::Winken.class.should               == Module
+      Icss.send(:remove_const, :Winken)
+    end
+  end
+
+  context '.define_metamodel_method' do
+    it 'does not overwrite an existing method'
+  end
+
+ end

data/spec/type/record_field_spec.rb

@@ -0,0 +1,44 @@
+require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')
+require 'icss'
+require ENV.root_path('spec/support/icss_test_helper')
+include IcssTestHelper
+
+describe Icss::Meta::RecordType do
+  before do
+    IcssTestHelper.remove_icss_constants('Handy')
+    class Icss::Handy < Icss::SmurfRecord ; end
+  end
+
+  context '.field' do
+    it 'with record_field loaded, adds RecordFields not hashes' do
+      Icss::Handy.field :foo, Integer
+      Icss::Handy.field_named(:foo).should be_a(Icss::Meta::RecordField)
+    end
+
+    it 'allows sloppy complex types when I use Hash' do
+      Icss::Handy.field :foo, Hash, :values => Integer
+      fld = Icss::Handy.field_named(:foo)
+      fld.type.to_s.should == 'Icss::HashOfInteger'
+      fld.type.values == Integer
+    end
+
+    it 'allows sloppy complex types when I use Array' do
+      Icss::Handy.field :foo, Array, :items => Integer
+      fld = Icss::Handy.field_named(:foo)
+      fld.type.to_s.should == 'Icss::ArrayOfInteger'
+      fld.type.items == Integer
+    end
+
+    it 'does not allow sloppy complex types when I use :hash' do
+      lambda{ Icss::Handy.field :bar, :hash, :values => Integer }.should raise_error
+    end
+
+    it 'handles complex fields in line' do
+      Icss::Handy.field :foo, { :type => :hash, :values => Integer }
+      fld = Icss::Handy.field_named(:foo)
+      fld.type.to_s.should == 'Icss::HashOfInteger'
+      fld.type.values == Integer
+    end
+  end
+end
+

data/spec/type/record_model_spec.rb

@@ -0,0 +1,206 @@
+require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')
+require 'gorillib/object/try_dup'
+require 'icss/receiver_model/acts_as_hash'
+require 'icss/receiver_model/active_model_shim'
+require 'icss/type'                   #
+require 'icss/type/simple_types'      # Boolean, Integer, ...
+require 'icss/type/named_type'        # class methods for a named type: .metamodel .doc, .fullname, &c
+require 'icss/type/record_type'       # class methods for a record model: .field, .receive,
+require 'icss/type/record_model'      # instance methods for a record model
+#
+require 'icss/type/type_factory'      #
+require 'icss/type/structured_schema'
+require 'icss/type/record_schema'
+require 'icss/type/record_field'
+
+require ENV.root_path('spec/support/icss_test_helper')
+include IcssTestHelper
+
+describe Icss::Meta::RecordModel do
+
+  before(:each) do
+    IcssTestHelper.remove_icss_constants('Poppa', 'Brainy', 'Smurfette', 'Hefty', 'Glad')
+    module Icss
+      class Poppa < Icss::SmurfRecord
+        field :smurfiness, Integer
+      end
+      module Brainy
+        include Icss::Meta::RecordModel
+        field :has_glasses, Boolean
+      end
+      class Smurfette < Poppa
+        include Brainy
+        field :blondness, Integer
+      end
+      class Hefty < Icss::SmurfRecord
+      end
+      class Glad  < Hefty
+      end
+    end
+  end
+
+  let(:poppa     ){ Icss::Poppa.new() }
+  let(:smurfette ){ Icss::Smurfette.new() }
+
+  context '#receive!' do
+    it 'sets values' do
+      smurfette.receive!({ :smurfiness => '98', :blondness => 12.7 })
+      smurfette.smurfiness.should == 98
+      smurfette.blondness.should == 12
+    end
+    it 'handles values with #receive_foo methods' do
+      smurfette.should_receive(:receive_smurfiness).with('99')
+      smurfette.receive!({ :smurfiness => '99' })
+    end
+    it 'which goes through _set_field_val' do
+      smurfette.should_receive(:_set_field_val).with(:smurfiness, 100)
+      smurfette.receive!({ :smurfiness => '100' })
+    end
+    it 'sends to field type klass .receive method' do
+      dummy = mock
+      foo_type = Class.new
+      Icss::Poppa.field :foo, foo_type
+      #
+      foo_type.should_receive(:receive).with(dummy)
+      Icss::Poppa.receive({ :foo => dummy })
+    end
+  end
+
+  context 'decorates instances' do
+    it 'with accessors and receivers' do
+      [:smurfiness, :has_glasses, :blondness].each do |f|
+        smurfette.should respond_to(f)
+        smurfette.should respond_to("#{f}=")
+      end
+      smurfette.should respond_to(:receive_smurfiness)
+      smurfette.should respond_to(:receive_blondness)
+      smurfette.blondness.should == nil
+       smurfette.blondness = 77
+      smurfette.blondness.should == 77
+      smurfette.receive_blondness(99)
+      smurfette.blondness.should == 99
+    end
+  end
+
+  context '.after_receive' do
+    it 'adds an after_receiver' do
+      blk = lambda{ 1 }
+      Icss::Poppa.after_receive(:foo, &blk)
+      Icss::Poppa.after_receivers[:foo].should == blk
+    end
+  end
+
+  context '.after_receivers' do
+    it 'is run after receive' do
+      dummy = mock ; hsh = { :smurfiness => 9 }
+      Icss::Poppa.after_receive(:howdy){|hsh| dummy.hello("hello!", smurfiness) }
+      dummy.should_receive(:hello).with("hello!", 9)
+      Icss::Poppa.receive(hsh)
+    end
+    it 'gets received hash as args' do
+      dummy = mock ; hsh = { :smurfiness => 10 }
+      Icss::Poppa.after_receive(:howdy){|hsh| dummy.hello("hello!", hsh) }
+      dummy.should_receive(:hello).with("hello!", hsh)
+      Icss::Poppa.receive(hsh)
+    end
+  end
+
+  context '.rcvr_remaining' do
+    it 'adds a new field' do
+      Icss::Poppa.rcvr_remaining(:bob)
+      Icss::Poppa.field_names.should == [:smurfiness, :bob]
+      Icss::Poppa.field_named(:bob)[:type].to_s.should == 'Icss::HashOfMetaDotIdenticalFactory'
+    end
+    it 'receives leftover attrs' do
+      Icss::Poppa.rcvr_remaining(:bob)
+      obj = Icss::Poppa.receive(:smurfiness => 12, :bogosity => 97)
+      obj.bob.should == {:bogosity => 97}
+    end
+    it 'applies schema to leftover attrs' do
+      Icss::Poppa.rcvr_remaining(:bob, :values => :int)
+      obj = Icss::Poppa.receive({:smurfiness => 12, :bogosity => "11", :converts => 31.2})
+      obj.bob.should == {:bogosity => 11, :converts => 31}
+    end
+    it 'is {} when no leftover attrs' do
+      Icss::Poppa.rcvr_remaining(:bob)
+      obj = Icss::Poppa.receive({:smurfiness => 12})
+      obj.bob.should == {}
+      obj = Icss::Poppa.receive({})
+      obj.bob.should == {}
+    end
+  end
+
+  context ':default =>' do
+    before do
+      Icss::Hefty.field :tool,    Symbol, :default => :smurfwrench
+      Icss::Hefty.field :weapon,  Symbol, :default => :smurfthrower
+      Icss::Hefty.field :no_default, Symbol
+    end
+    let(:hefty_smurf){  Icss::Hefty.receive({ :tool => :smurfwrench }) }
+    let(:glad_smurf ){  Icss::Glad.receive({  :tool => :smurfwrench }) }
+
+    it 'sets default' do
+      hefty_smurf.tool.should   == :smurfwrench
+      hefty_smurf.weapon.should == :smurfthrower
+      hefty_smurf.no_default.should be_nil
+      hefty_smurf.attr_set?(:no_default).should be_false
+    end
+
+    it 'does not set default if explicitly nil' do
+      hefty_smurf = Icss::Hefty.receive({ :tool => :smurfwrench, :weapon => nil })
+      hefty_smurf.weapon.should == nil
+      hefty_smurf.attr_set?(:weapon).should be_true
+    end
+
+    it 'uses an after_receiver with a predictable name' do
+      Icss::Hefty.after_receivers[:default_tool].should be_a(Proc)
+    end
+
+    it 'is overridable' do
+      proc_before = Icss::Hefty.after_receivers[:default_weapon]
+      Icss::Hefty.field :weapon, Symbol, :default => :flamesmurf
+      Icss::Hefty.after_receivers[:default_weapon].should_not == proc_before
+      hefty_smurf.weapon.should == :flamesmurf
+    end
+
+    it 'is overridable in subclass without affecting parent' do
+      hefty_proc = Icss::Hefty.after_receivers[:default_weapon]
+      Icss::Glad.field :weapon, Symbol, :default => :flamesmurf
+      Icss::Hefty.after_receivers[:default_weapon].should     == hefty_proc
+      Icss::Glad.after_receivers[ :default_weapon].should_not == hefty_proc
+      hefty_smurf.weapon.should == :smurfthrower
+      glad_smurf.weapon.should  == :flamesmurf
+    end
+
+    it 'try_dups the object when setting default' do
+      smurfed_cheese = mock
+      Icss::Hefty.field :food, Symbol, :default => smurfed_cheese
+      smurfed_cheese.should_receive(:try_dup).with()
+      hefty_smurf
+    end
+
+    it 'accepts a proc' do
+      dummy = mock
+      Icss::Glad.field :weapon, Symbol, :default => lambda{ [dummy, tool, self] }
+      glad_smurf.weapon.should == [dummy, :smurfwrench, glad_smurf]      
+    end
+
+    context 'can also be set with set_field_default' do
+      it 'with a value' do
+        dummy = mock
+        Icss::Glad.class_eval do
+          set_field_default :weapon, :gatlingsmurf
+        end
+        glad_smurf.weapon.should == :gatlingsmurf
+      end
+      it 'with a proc' do
+        dummy = mock
+        Icss::Glad.class_eval do
+          set_field_default :weapon, lambda{ [dummy, tool, self] }
+        end
+        glad_smurf.weapon.should == [dummy, :smurfwrench, glad_smurf]
+      end
+    end
+  end
+
+end