icss 0.1.3 → 0.3.2

data/VERSION

@@ -1 +1 @@
-0.1.3
+0.3.2

data/examples/avro_examples/complicated.icss.yaml

@@ -81,14 +81,15 @@ types:
           type: your_mom
           doc:  wears combat boots
           
-        # - name: field_that_is_an_array
-        #   type: array
-        #   items: int
-        #   doc:  I am an array of primitives
-        # - name: field_that_is_a_named_type_holy_fuck
-        #   type: array
-        #   items: your_mom
-        #   doc:  I am an array of Iccs::Type::YourMomType
+        - name: field_that_is_an_array
+          type: array
+          items: int
+          doc:  I am an array of primitives
+        - name: field_that_is_a_named_type_holy_fuck
+          type:
+            - type: array
+              items: your_mom
+          doc:  I am an array of Iccs::Type::YourMomType
             
     - name: chronic_parse_response
       type: record
@@ -107,11 +108,11 @@ types:
           doc:  >-
             Your params, right back atcha'
           type: string  # map
-        # - name: errors
-        #   doc:  >-
-        #     Error conditions
-        #   type: array
-        #   optional: true
+        - name: errors
+          doc:  >-
+            Error conditions
+          type: array
+          optional: true
         - name: whatever
           doc:  dummy string
           type:

data/examples/bnc.icss.yaml

@@ -0,0 +1,70 @@
+---
+namespace: language.corpora.word_freq
+protocol: bnc
+
+targets:
+  catalog:
+    - name: word_freq_bnc
+      title: Word Frequencies From the British National Corpus
+      description: foobar
+      tags:
+        - bnc
+        - british-national-corpus
+        - awesomeapi
+        - token
+        - word
+        - corpus
+        - word-frequency
+        - british
+        - words
+        - language
+      messages:
+        - word_stats
+
+messages:
+  word_stats:
+    request:
+      - name: word_stats_request
+        type: word_stats_request
+    response: word_statistics_record
+    doc: Query on a head word to get back word statistics (and word variants) from the British National Corpus.
+
+data_assets:
+  - name: word_stats_data_asset
+    location: data/word_stats
+    type: word_statistics_record
+      
+code_assets:
+  - location: code/bnc_endpoint.rb
+    name: word_stats
+    
+types:
+
+  
+  - name: test_record
+    doc: A record for testing
+    type: record
+    fields:
+    - name: name
+      doc: A person's name.
+      type: string
+    - name: age
+      doc: A person's age.
+      type: whatever
+    - name: email
+      doc: A person's email address
+      type: string
+      validates:
+        :length:
+          :maximum: 10
+
+  - name: whatever
+    doc: lkajd
+    type: record
+    fields:
+    - name: f
+      doc: bar
+      type: place
+  
+- name: place
+  

data/examples/chronic.icss.yaml

@@ -1,5 +1,5 @@
 ---
-namespace: util.time
+namespace: st.time_utils
 protocol: chronic
 
 doc: >-
@@ -11,7 +11,7 @@ code_assets:
 
 targets:
   catalog:
-    - name: util_time_chronic_parse
+    - name: st_time_utils_chronic_parse
       title: Utils - Parse Times
       description: An API call to parse human-readable date / time strings
       messages:
@@ -29,7 +29,7 @@ targets:
 types:
     - name:     chronic_parse_params
       type:     record
-      doc: Query API parameters for the /util/time/chronic/parse call
+      doc: Query API parameters for the /st/time_utils/chronic/parse call
       fields:
         - name: time_str
           type: string

data/examples/license.icss.yaml

@@ -0,0 +1,7 @@
+:license_id:   licenses.example
+:title:        Terms of use
+:url:          http://whatever.com/whatever
+:description:  Basic developer license
+:summary:      A short summary of the license
+:article_body: >-
+    The full text of the license

data/examples/source1.icss.yaml

@@ -0,0 +1,4 @@
+:source_id:   sources.source1
+:title:       Source 1
+:description: Whatever description the source wants
+:url:         http://source1.com

data/examples/source2.icss.yaml

@@ -0,0 +1,4 @@
+:source_id:   sources.source2
+:title:       Source 2
+:description: Whatever description the source wants
+:url:         http://source2.com

data/examples/test_icss.yaml

@@ -0,0 +1,67 @@
+---
+namespace: foo.bar
+protocol: baz
+types:
+
+- name: test_simple_type
+  doc: A record to test simple record types.
+  type: record
+  fields:
+  - name: my_happy_string
+    doc:  field 1
+    type: string
+  - name: my_happy_int
+    doc:  field 2
+    type: int
+  - name: my_happy_boolean
+    doc:  field 3
+    type: boolean
+
+- name: test_ref_type
+  doc: A record to test referenced types.
+  type: record
+  fields:
+  - name: ref_field
+    doc: A field that references a type.
+    type: icss.core.place
+
+- name: test_is_a_method
+  doc: A record to test the is_a method.
+  type: record
+  is_a:
+  - icss.core.place
+  fields:
+  - name: additional_field
+    doc: A field to test the ability to add additional fields with the is_a method.
+    type: int
+  - name: description
+    doc: A field to test the override of is_a properties.
+    type: string
+
+- name: test_identifiers
+  doc: A record to test the identifier methods.
+  type: record
+  domain_id: ssn
+  fields:
+  - name: name
+    doc: A field that is NOT an identifier.
+    type: string
+  - name: age
+    doc: A field that IS an identifier.
+    type: int
+    identifier: true
+  - name: ssn
+    doc: A field to test the domain_id.
+    type: int
+    identifier: true
+
+- name: test_validators
+  doc: A record to test validations.
+  type: record
+  fields:
+  - name: homepage
+    doc: A field needing formatting validation.
+    type: string
+    validates:
+      format:
+        with: "/[\w+]\.[com?|org|net]/"

data/icss.gemspec

@@ -4,27 +4,26 @@
 # -*- encoding: utf-8 -*-
 
 Gem::Specification.new do |s|
-  s.name = %q{icss}
-  s.version = "0.1.3"
+  s.name = "icss"
+  s.version = "0.3.1"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Philip (flip) Kromer for Infochimps"]
-  s.date = %q{2011-07-15}
-  s.description = %q{Infochimps Stupid Schema library: an avro-compatible data description standard. ICSS completely describes a collection of data (and associated assets) in a way that is expressive, scalable and sufficient to drive remarkably complex downstream processes.}
-  s.email = %q{coders@infochimps.com}
+  s.date = "2011-11-09"
+  s.description = "Infochimps Simple Schema library: an avro-compatible data description standard. ICSS completely describes a collection of data (and associated assets) in a way that is expressive, scalable and sufficient to drive remarkably complex downstream processes."
+  s.email = "coders@infochimps.com"
   s.extra_rdoc_files = [
     "LICENSE.textile",
-    "README.textile"
+    "README.md"
   ]
   s.files = [
     ".document",
     ".rspec",
     ".watchr",
-    "CHANGELOG.textile",
+    "CHANGELOG.md",
     "Gemfile",
-    "Gemfile.lock",
     "LICENSE.textile",
-    "README.textile",
+    "README.md",
     "Rakefile",
     "TODO.md",
     "VERSION",
@@ -41,71 +40,132 @@ Gem::Specification.new do |s|
     "examples/avro_examples/org/apache/avro/mapred/tether/OutputProtocol.avpr",
     "examples/avro_examples/simple.avpr",
     "examples/avro_examples/weather.avsc",
+    "examples/bnc.icss.yaml",
     "examples/chronic.icss.yaml",
+    "examples/license.icss.yaml",
+    "examples/source1.icss.yaml",
+    "examples/source2.icss.yaml",
+    "examples/test_icss.yaml",
     "icss.gemspec",
     "icss_specification.textile",
-    "init.rb",
     "lib/icss.rb",
-    "lib/icss/brevity.rb",
-    "lib/icss/code_asset.rb",
-    "lib/icss/core_ext.rb",
-    "lib/icss/data_asset.rb",
+    "lib/icss/core_types.rb",
+    "lib/icss/error.rb",
+    "lib/icss/init.rb",
     "lib/icss/message.rb",
-    "lib/icss/old.rb",
+    "lib/icss/message/message_sample.rb",
     "lib/icss/protocol.rb",
-    "lib/icss/protocol_set.rb",
-    "lib/icss/sample_message_call.rb",
-    "lib/icss/target.rb",
+    "lib/icss/protocol/code_asset.rb",
+    "lib/icss/protocol/data_asset.rb",
+    "lib/icss/protocol/license.rb",
+    "lib/icss/protocol/source.rb",
+    "lib/icss/protocol/target.rb",
+    "lib/icss/receiver_model.rb",
+    "lib/icss/receiver_model/active_model_shim.rb",
+    "lib/icss/receiver_model/acts_as_catalog.rb",
+    "lib/icss/receiver_model/acts_as_hash.rb",
+    "lib/icss/receiver_model/acts_as_loadable.rb",
+    "lib/icss/receiver_model/acts_as_tuple.rb",
+    "lib/icss/receiver_model/locale/en.yml",
+    "lib/icss/receiver_model/to_geo_json.rb",
+    "lib/icss/receiver_model/tree_merge.rb",
+    "lib/icss/receiver_model/validations.rb",
+    "lib/icss/serialization.rb",
+    "lib/icss/serialization/zaml.rb",
     "lib/icss/type.rb",
-    "lib/icss/type/factory.rb",
-    "lib/icss/validations.rb",
+    "lib/icss/type/base_type.rb",
+    "lib/icss/type/named_type.rb",
+    "lib/icss/type/record_field.rb",
+    "lib/icss/type/record_model.rb",
+    "lib/icss/type/record_schema.rb",
+    "lib/icss/type/record_type.rb",
+    "lib/icss/type/simple_types.rb",
+    "lib/icss/type/structured_schema.rb",
+    "lib/icss/type/type_factory.rb",
+    "lib/icss/type/union_schema.rb",
     "lib/icss/view_helper.rb",
+    "notes/named_array.md",
+    "notes/on_include_vs_extend_etc.rb",
+    "notes/technical_details.md",
+    "spec/core_types_spec.rb",
+    "spec/fixtures/zaml_complex_hash.yaml",
     "spec/icss_spec.rb",
+    "spec/message/message_sample_spec.rb",
+    "spec/message_spec.rb",
+    "spec/protocol/license_spec.rb",
+    "spec/protocol/protocol_catalog_spec.rb",
+    "spec/protocol/protocol_validations_spec.rb",
+    "spec/protocol/source_spec.rb",
     "spec/protocol_spec.rb",
+    "spec/receiver_model_spec.rb",
+    "spec/serialization/zaml_spec.rb",
+    "spec/serialization/zaml_test.rb",
+    "spec/serialization_spec.rb",
     "spec/spec_helper.rb",
-    "spec/validations_spec.rb"
+    "spec/support/icss_test_helper.rb",
+    "spec/support/load_example_protocols.rb",
+    "spec/type/base_type_spec.rb",
+    "spec/type/named_type_spec.rb",
+    "spec/type/record_field_spec.rb",
+    "spec/type/record_model_spec.rb",
+    "spec/type/record_schema_spec.rb",
+    "spec/type/record_type_spec.rb",
+    "spec/type/simple_types_spec.rb",
+    "spec/type/structured_schema_spec.rb",
+    "spec/type/type_catalog_spec.rb",
+    "spec/type/type_factory_spec.rb",
+    "spec/type/union_schema_spec.rb",
+    "spec/type_spec.rb"
   ]
-  s.homepage = %q{http://github.com/mrflip/icss}
+  s.homepage = "http://github.com/mrflip/icss"
   s.licenses = ["MIT"]
   s.require_paths = ["lib"]
-  s.rubygems_version = %q{1.3.7}
-  s.summary = %q{Infochimps Stupid Schema library: an avro-compatible data description standard. ICSS completely describes a collection of data (and associated assets) in a way that is expressive, scalable and sufficient to drive remarkably complex downstream processes.}
-  s.test_files = [
-    "spec/icss_spec.rb",
-    "spec/protocol_spec.rb",
-    "spec/spec_helper.rb",
-    "spec/validations_spec.rb"
-  ]
+  s.rubygems_version = "1.8.11"
+  s.summary = "Infochimps Simple Schema library: an avro-compatible data description standard. ICSS completely describes a collection of data (and associated assets) in a way that is expressive, scalable and sufficient to drive remarkably complex downstream processes."
 
   if s.respond_to? :specification_version then
-    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
     s.specification_version = 3
 
     if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
-      s.add_runtime_dependency(%q<gorillib>, ["~> 0.1.1"])
+      s.add_runtime_dependency(%q<json>, [">= 0"])
       s.add_runtime_dependency(%q<activemodel>, ["~> 3.0.9"])
-      s.add_development_dependency(%q<rspec>, ["~> 2.3.0"])
+      s.add_runtime_dependency(%q<addressable>, ["~> 2.2"])
+      s.add_runtime_dependency(%q<configliere>, ["~> 0.4.8"])
+      s.add_runtime_dependency(%q<gorillib>, ["~> 0.1.7"])
+      s.add_runtime_dependency(%q<addressable>, ["~> 2.2"])
+      s.add_development_dependency(%q<bundler>, ["~> 1"])
+      s.add_development_dependency(%q<jeweler>, ["~> 1.6.4"])
       s.add_development_dependency(%q<yard>, ["~> 0.6.0"])
-      s.add_development_dependency(%q<bundler>, ["~> 1.0.0"])
-      s.add_development_dependency(%q<jeweler>, ["~> 1.5.2"])
+      s.add_development_dependency(%q<rspec>, ["~> 2.3.0"])
       s.add_development_dependency(%q<rcov>, [">= 0"])
+      s.add_development_dependency(%q<awesome_print>, ["~> 0.4.0"])
     else
-      s.add_dependency(%q<gorillib>, ["~> 0.1.1"])
+      s.add_dependency(%q<json>, [">= 0"])
       s.add_dependency(%q<activemodel>, ["~> 3.0.9"])
-      s.add_dependency(%q<rspec>, ["~> 2.3.0"])
+      s.add_dependency(%q<addressable>, ["~> 2.2"])
+      s.add_dependency(%q<configliere>, ["~> 0.4.8"])
+      s.add_dependency(%q<gorillib>, ["~> 0.1.7"])
+      s.add_dependency(%q<addressable>, ["~> 2.2"])
+      s.add_dependency(%q<bundler>, ["~> 1"])
+      s.add_dependency(%q<jeweler>, ["~> 1.6.4"])
       s.add_dependency(%q<yard>, ["~> 0.6.0"])
-      s.add_dependency(%q<bundler>, ["~> 1.0.0"])
-      s.add_dependency(%q<jeweler>, ["~> 1.5.2"])
+      s.add_dependency(%q<rspec>, ["~> 2.3.0"])
       s.add_dependency(%q<rcov>, [">= 0"])
+      s.add_dependency(%q<awesome_print>, ["~> 0.4.0"])
     end
   else
-    s.add_dependency(%q<gorillib>, ["~> 0.1.1"])
+    s.add_dependency(%q<json>, [">= 0"])
     s.add_dependency(%q<activemodel>, ["~> 3.0.9"])
-    s.add_dependency(%q<rspec>, ["~> 2.3.0"])
+    s.add_dependency(%q<addressable>, ["~> 2.2"])
+    s.add_dependency(%q<configliere>, ["~> 0.4.8"])
+    s.add_dependency(%q<gorillib>, ["~> 0.1.7"])
+    s.add_dependency(%q<addressable>, ["~> 2.2"])
+    s.add_dependency(%q<bundler>, ["~> 1"])
+    s.add_dependency(%q<jeweler>, ["~> 1.6.4"])
     s.add_dependency(%q<yard>, ["~> 0.6.0"])
-    s.add_dependency(%q<bundler>, ["~> 1.0.0"])
-    s.add_dependency(%q<jeweler>, ["~> 1.5.2"])
+    s.add_dependency(%q<rspec>, ["~> 2.3.0"])
     s.add_dependency(%q<rcov>, [">= 0"])
+    s.add_dependency(%q<awesome_print>, ["~> 0.4.0"])
   end
 end
 

data/lib/icss.rb

@@ -1,28 +1,50 @@
 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/hashlike'
+require 'gorillib/hashlike/tree_merge'
 require 'gorillib/hash/compact'
 require 'gorillib/hash/keys'
 require 'gorillib/hash/tree_merge'
 require 'gorillib/metaprogramming/class_attribute'
-
+require 'gorillib/serialization'
 require 'gorillib/hashlike'
-require 'gorillib/receiver'
-require 'gorillib/receiver_model'
 
-require 'time' # ain't that always the way
-
-$: << File.dirname(__FILE__)
-#require 'icss/core_ext' unless Object.respond_to?(:class_attribute)
-require 'icss/validations'
-require 'icss/type'
+#
+require 'configliere'
+Settings.define :catalog_root, :type => :filename, :default => (defined?(Rails) ? (Rails.root+'catalog') : File.expand_path('../../infochimps_catalog', __FILE__))
+#
+require 'icss/error'
+require 'icss/receiver_model/acts_as_hash'
+require 'icss/receiver_model/acts_as_loadable'
+require 'icss/receiver_model/acts_as_catalog'
+require 'icss/receiver_model/active_model_shim'
+require 'icss/receiver_model/validations'
+require 'icss/receiver_model/acts_as_tuple'
+#
+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' # generate type from array, hash, &c schema
+require 'icss/type/union_schema'      # factory for instances based on type
+require 'icss/type/record_schema'
+require 'icss/type/record_field'
+#
+require 'icss/receiver_model'
+require 'icss/serialization'
+#
 require 'icss/message'
-require 'icss/sample_message_call'
-require 'icss/data_asset'
-require 'icss/code_asset'
-require 'icss/target'
+require 'icss/protocol/data_asset'
+require 'icss/protocol/code_asset'
+require 'icss/protocol/target'
+require 'icss/protocol/license'
+require 'icss/protocol/source'
 require 'icss/protocol'
-
-require 'icss/type/factory'
+require 'icss/message/message_sample'