icss 0.1.3 → 0.3.2

data/spec/core_types_spec.rb

@@ -0,0 +1,119 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+require 'yaml'
+require 'icss'
+require 'icss/protocol'
+require 'icss/message'
+
+def core_files
+  %w[ core datasets ].map do |section|
+    Dir[File.join(Settings[:catalog_root], section, '**/*.icss.yaml')].map do |fn|
+      fn.gsub(%r{.*(#{section}/[^\.]+)\.icss\.yaml$}, '\1')
+    end
+    # So that we can kinda have random load order, but have it be deterministic, sort by the reversed string
+  end.flatten.sort # _by(&:reverse)
+end
+
+unless defined?(Log)
+  if defined?(Rails)
+    Log = Rails.logger
+  else
+    require 'logger'
+    Log = Logger.new($stderr)
+  end
+end
+
+Log.level = 1
+
+describe 'loads all catalog types' do
+  start_time = Time.now
+  last_time  = Time.now
+  [
+    %w[ mu.rating prod.aggregate_rating mu.quantity mu.distance mu.duration
+        social.contact_point prod.item_availability prod.offer_item_condition
+        geo.geo_coordinates
+        culture.creative_work ev.event geo.place business.organization web.web_page_element
+        core/web/web_page
+         ].map{|s| "core/#{s}" },
+    'datasets/science.astronomy.ufo_sighting',
+    core_files,
+  ].flatten.each do |filename_patt|
+    it "loads #{filename_patt}" do
+      Icss::Meta::Protocol.find(:all, filename_patt)
+      Log.debug "************* loaded #{Icss::Meta::Type.registry.size} core types in #{((Time.now-last_time).to_f * 1000).round} **************"
+      last_time = Time.now
+    end
+  end
+end
+
+
+#
+# describe 'instances' do
+#   it '#new_record?'
+#   context 'partial response'
+#   context 'formatting'
+#   context 'reshaping' do
+#     it '#to_model'
+#     it '#to_param'
+#     it '#to_key' # Returns an Container of all key attributes if any is set, regardless if the object is persisted or not
+#   end
+#
+# end
+#
+# describe 'fields' do
+#   context '#name'     do ; end
+#   context '#doc'      do ; end
+#   context '#type'     do ; end
+#   context '#default'  do ; end
+#   context '#index'
+#   context '#versionating' do
+#     # acro versioning
+#   end
+#   context '#order' do
+#     it 'has sort_order'
+#     it 'order is an alias for sort_order'
+#     it 'is "ascending" by default'
+#     it 'sort_order_direction gives -1 / 0 / 1 for descending / ignore / ascending (default)'
+#   end
+#   context 'sugar' do
+#     it '#record?'
+#     it '#union?'
+#     it '#enum?'
+#   end
+#   it 'properties can find themselves in registry'
+#   it 'warns if you say "description" (should be "doc")'
+#   it 'warns if you say :items => FooFactory (should probably be :with if it is a Factory)'
+#
+#   context '' do
+#     # universe, dimension, representation,
+#     # measurement_count, maximum_value, minimum_value, total_value, median_value, average_value, stdev_value
+#   end
+# end
+#
+#
+# describe 'hooks' do
+#   describe 'after_receive'
+#   # before/after initialize, validation, save, create, commit, rollback, destroy
+#   # #dirty?, #new_record?
+# end
+#
+# # # not yet
+# # describe 'associations' do
+# #   it '.belongs_to'
+# #   it '.has_one'
+# #   it '.has_many_through'
+# #   it '.has_many'
+# # ASSOCIATION_METHODS  = [:includes, :eager_load, :preload]
+# # MULTI_VALUE_METHODS  = [:select, :group, :order, :joins, :where, :having]
+# # SINGLE_VALUE_METHODS = [:limit, :offset, :lock, :readonly, :create_with, :from]
+# # end
+#
+#
+# describe 'aspects' do
+# end
+#
+# describe 'relationships' do
+# end
+#
+# # describe Icss::Entity do
+# #
+# # end

data/spec/fixtures/zaml_complex_hash.yaml

@@ -0,0 +1,35 @@
+--- 
+# first comment
+complex:                :hash
+:items:                 
+  2:                    !ruby/regexp /pairs/
+Iñtërnâtiônàlizætiøn:   look out for 'funny quotes'.
+:and:                   
+  # informative comments
+  - :name:              a few
+    :nested:            elements
+    :including:         |-
+      line
+      breaking
+      strings
+    :and_including:     |
+      newline terminated
+      line
+      breaking
+      strings
+
+    :so:                ":what\n            :dyathink, :of, :that\n          "
+  # more informative comments,
+  # spread across
+  #  multiple lines
+  - :name:              bob
+    # comment can be in hash key,
+    # spread across
+    #  multiple lines;
+  
+  
+  
+  - # does the right thing
+    # even when
+    # is the only item
+    []

data/spec/icss_spec.rb

@@ -1,27 +1,90 @@
 require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
 require 'icss'
 
-describe Icss do
-  describe "loading ICSS files from hackboxen and apeyeye" do
-    [
-      Dir[ICSS_ROOT_DIR('examples/hackboxen/**/*.icss.yaml')],
-      Dir[ICSS_ROOT_DIR('examples/apeyeye_endpoints/**/*.icss.yaml')],
-    ].flatten[0.. -1].each do |icss_filename|
-      next if icss_filename =~ %r{culture/art}
-
-      describe "#{icss_filename}" do
-        before do
-          @icss = Icss::Protocol.receive_from_file(icss_filename)
-        end
-
-        it "serializes out and in again" do
-          #convert the icss to json and back
-          raw_json = JSON.generate(@icss)
-          json_icss = Icss::Protocol.receive(JSON.parse(raw_json))
-
-          json_icss.to_hash.should == @icss.to_hash
-        end
-      end
-    end
-  end
+def test_icss
+  YAML.load ENV.load_path('examples/infochimps-catalog/core/thing.icss.yaml')
 end
+
+# describe Icss::Meta::Protocol do
+#
+#
+#   before :each do
+#     @icss = Icss::Meta::Protocol.receive test_icss
+#   end
+#
+#   it "should be able to receive valid YAML files" do
+#     @icss.should be_a Icss::Meta::Protocol
+#   end
+#
+#   # context "receiving referenced types" do
+#   #
+#   #   it "should be able to identify the referenced type specified" do
+#   #     ref_type  = @icss.types.select{ |t| t.name == 'test_ref_type' }.first
+#   #     ref_field = ref_type.field_schemas[:ref_field].first
+#   #     ref_field.to_hash.should == {
+#   #       :name => "ref_field",
+#   #       :doc  => "A field that references a type.",
+#   #       :type => "place"
+#   #     }
+#   #   end
+#   #
+#   #   it "should add the referenced type to the array of types for this protocol" do
+#   #     puts Icss::Meta::DERIVED_TYPES.keys.inspect
+#   #     @icss.types.map(&:name).should include 'place'
+#   #   end
+#   #
+#   # end
+#
+#   # context "receiving is_a" do
+#   #
+#   #   it "should populate the fields array with the referenced type's fields"
+#   #
+#   #   it "should allow additional field definitions to be added after the receive"
+#   #
+#   #   it "should override referenced fields when a field is defined with the same name"
+#   #
+#   # end
+#   #
+#   # context "receiving identifier" do
+#   #
+#   #   it "should be able to return all field definitions specified as identifiers"
+#   #
+#   # end
+#   #
+#   # context "receiving domain_id" do
+#   #
+#   #   it "should be able to return the field definition specified as the domain_id"
+#   #
+#   # end
+#   #
+#   # context "receiving validates" do
+#   #
+#   #   it "should be able validate the received values using the specified active model validators"
+#   #
+#   # end
+#   #
+#   # context "Icss::Klass" do
+#   #
+#   #   it "should be able to return its values with dotted accessors"
+#   #
+#   # end
+#   #
+#   # context "transformation" do
+#   #
+#   #   it " should be able to transform itself into a GeoJson object"
+#   #
+#   #   context "receiving aspects" do
+#   #
+#   #     it "should be able to generate a class form its apect's typing"
+#   #
+#   #     it "should receive the aspect's properties first"
+#   #
+#   #     it "should receive the original Icss::Klass properties"
+#   #
+#   #     it "should receive the original Icss::Klass as an aspect, inlcuding left over properties"
+#   #
+#   #   end
+#   #
+#   # end
+#
+# end

data/spec/message/message_sample_spec.rb

@@ -0,0 +1,4 @@
+require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')
+require 'icss'
+require ENV.root_path('spec/support/icss_test_helper')
+include IcssTestHelper

data/spec/message_spec.rb

@@ -0,0 +1,139 @@
+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::Message do
+  before(:each) do
+    IcssTestHelper.remove_icss_constants('Poppa', 'Smurfette', 'Handy', 'Hefty')
+    class Icss::Poppa < Icss::SmurfRecord
+      field :smurfiness, Integer
+    end
+    class Icss::Smurfette < Icss::SmurfRecord
+      field :blondness, Integer
+    end
+    class Icss::Handy < Icss::Poppa
+      field :tool,       Symbol, :default => :smurfwrench
+      field :weapon,     Symbol, :default => :smurfthrower
+    end
+  end
+
+  let(:smurfy_message_hsh){
+    { :name     => 'dance',
+      :doc      => 'this is how we dance',
+      :request  => [{ :name => 'params', :type => Icss::Poppa },],
+      :response => Icss::Smurfette,
+      :errors   => ['oops']
+    } }
+  let(:smurfy_message){ Icss::Meta::Message.receive(smurfy_message_hsh) }
+
+  # ===========================================================================
+  #
+  # Message samples
+  #
+  describe Icss::Meta::MessageSample do
+    let(:samp_msg_hsh){
+      {
+        :name         => 'lambada',
+        :request      => [{ :smurfiness => 1, :blondness => 12 }],
+        :response_hsh =>  { :smurfiness => 1, :tool => :pipesmurf, :weapon => :broadsmurf },
+      }
+    }
+    let(:smurfy_message_sample){ Icss::Meta::MessageSample.receive(samp_msg_hsh) }
+
+    let(:message_with_sample){ Icss::Meta::Message.receive( smurfy_message_hsh.merge(:samples => [samp_msg_hsh])) }
+    it 'is created by its message' do
+      message_with_sample.should be_a(Icss::Meta::Message)
+      message_with_sample.samples.map(&:class).should == [Icss::Meta::MessageSample]
+    end
+    it 'knows its message' do
+      message_with_sample.samples.first.message.should == message_with_sample
+    end
+
+    describe 'basic behavior' do
+      subject{ smurfy_message_sample }
+      its('name'){         should == 'lambada' }
+      its('request'){      should == [{ :smurfiness => 1, :blondness => 12 }] }
+      its('response_hsh'){ should == { :smurfiness => 1, :tool => :pipesmurf, :weapon => :broadsmurf } }
+    end
+
+    # context 'loading from API'  do
+    #   it 'constructs a URL'
+    #   it 'loads'
+    #   it 'accepts a server'
+    # end
+
+  end
+
+  # ===========================================================================
+  #
+  # Message
+  #
+
+  describe 'basic behavior' do
+    subject{ smurfy_message }    
+    its(:name){                should == 'dance' }
+    its('request.first.name'){ should == :params }
+    its('request.first.type'){ should == Icss::Poppa }
+    its(:params_type){         should == Icss::Poppa }
+    its(:response){            should == Icss::Smurfette }
+    its(:errors){              should == ['oops'] }
+  end
+
+  describe 'knows its protocol' do
+    let(:dance){ fun_protocol.messages[:dance] }
+
+  let(:fun_protocol_hsh){
+    { :protocol => 'smurf.village.fun',
+      :messages => { :dance => smurfy_message_hsh } } }
+  let(:fun_protocol){ Icss::Meta::Protocol.receive(fun_protocol_hsh) }
+    #
+    subject{ dance }
+    it{ should be_a(Icss::Meta::Message) }
+    it 'knows its protocol' do
+      dance.protocol.should == fun_protocol
+    end
+    its(:fullname){ should == 'smurf.village.fun.dance' }
+    its(:path){     should == 'smurf/village/fun/dance' }
+  end
+
+  describe '#to_hash' do
+    it 'correctly' do
+      smurfy_message.to_hash.should == {
+        :request  => [{:name => :params, :type => "poppa"}],
+        :response => "smurfette",
+        :doc      => "this is how we dance",
+        :errors   => ["oops"],
+        :samples  => []
+      }
+    end
+  end
+
+  describe 'reference tracking' do
+    {
+      'simple type' => 'string',
+      'named ref'   => 'poppa',
+      'class'       => Icss::SmurfRecord,
+    }.each do |ref_type, ref|
+      it "is a reference if it receives a #{ref_type}" do
+        smurfy_message_hsh[:request].first[:type] = ref
+        msg = Icss::Meta::Message.receive(smurfy_message_hsh)
+        msg.request.map{|r| r.is_reference? }.should == [true]
+      end
+    end
+    {
+      'record schema' => {:name => 'hefty', :type => :record, :fields => [:name => :strength, :type => :float]},
+      'array schema'  => {:type => :array,  :items  => :poppa},
+      'hash schema'   => {:type => :map,    :values => :smurfette},
+    }.each do |ref_type, ref|
+      it "is not a reference if it receives a string" do
+        smurfy_message_hsh[:request].first[:type] = ref
+        msg = Icss::Meta::Message.receive(smurfy_message_hsh)
+        msg.request.map{|r| r.is_reference? }.should == [false]
+      end
+    end
+
+  end
+
+end

data/spec/protocol/license_spec.rb

@@ -0,0 +1,67 @@
+require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')
+require 'icss'
+
+describe Icss::Meta::License do
+  before do
+    Icss::Meta::License.send :flush_registry
+    Icss::Meta::License._catalog_loaded = true #prevent automatic loading of catalog
+  end
+  let(:license){ Icss::Meta::License.receive(:license_id => 'licenses.test', :title => 'Test license', :description => 'License description', :url => 'http://test.com', :summary => 'short summer of the license', :article_body => 'full text of license') }
+  
+  describe '#name' do
+    specify { license.name.should == 'test' }
+  end
+  
+  describe '#fullname' do  
+    specify { license.fullname.should == 'licenses.test' }
+  end
+  
+  
+  
+  # Calling receive adds license to registry with after_receiver
+  describe :registry do
+    specify { Icss::Meta::License.registry.should include('licenses.test' => license) }
+  end
+  
+  describe '#find' do
+    context 'specific license name parameters' do
+      before { license } # load license into registry
+      it('return license'){ Icss::Meta::License.find('licenses.test').should == license }
+      it('should error if not found'){ lambda{ Icss::Meta::License.find('licenses.not_found') }.should raise_error(Icss::NotFoundError) }
+      it('should error for wildcard name'){ lambda{ Icss::Meta::License.find('licenses.*.test') }.should raise_error(Icss::NotFoundError) }
+    end
+    
+    context 'wildcard license name parameters' do
+      before { license } # load license into registry
+      context ':all' do
+        it('accepts wilcard names'){ Icss::Meta::License.find(:all, 'licenses.*').should == [license] }
+        it('returns empty array if not found'){ Icss::Meta::License.find(:all, 'not.*.found').should == [] }
+      end
+      
+      context ':first' do
+        it('accepts wilcard names'){ Icss::Meta::License.find(:first, 'licenses.*').should == license }
+        it('returns nil if not found'){ Icss::Meta::License.find(:first, 'not.*.found').should be_nil }
+      end
+      
+      context ':last' do
+        it('accepts wilcard names'){ Icss::Meta::License.find(:last, 'licenses.*').should == license }
+        it('returns nil if not found'){ Icss::Meta::License.find(:last, 'not.*.found').should be_nil }
+      end
+    end
+  end
+  describe '#all, #first, #last' do 
+    before { license } # load license into registry
+    it('#all returns all licenses'){ Icss::Meta::License.all.should == [license] }
+    it('#first returns first of all licenses'){ Icss::Meta::License.first.should == license }
+    it('#last returns last of all licenses'){ Icss::Meta::License.last.should == license }
+  end
+  
+  describe '#to_hash' do
+    it { license.to_hash.should == {:license_id => 'licenses.test',
+                                   :title => 'Test license',
+                                   :description => 'License description',
+                                   :url => 'http://test.com',
+                                   :summary => 'short summer of the license',
+                                   :article_body => 'full text of license'}}
+  end
+end