icss 0.1.3 → 0.3.2

data/lib/icss/target.rb

@@ -1,72 +0,0 @@
-module Icss
-
-  #
-  # Instantiates an array of target objects
-  #
-  class TargetListFactory
-    def self.receive target_info_list, target_name
-      klass = "Icss::#{target_name.camelize}Target".constantize
-      target_info_list.map{|target_info| klass.receive(target_info)}
-    end
-  end
-
-  class Target
-    include Receiver
-    include Receiver::ActsAsHash
-    include Gorillib::Hashlike
-    #
-    # Name should not be something like 'default', it should be something
-    # that 'appeals' to the message name.
-    #
-    rcvr_accessor :name, String
-  end
-
-  class MysqlTarget < Target
-    rcvr_accessor :data_assets, Array, :of => String
-    rcvr_accessor :database,    String
-    rcvr_accessor :table_name,  String
-  end
-
-  class ApeyeyeTarget < Target
-    rcvr_accessor :code_assets, Array, :of => String
-  end
-
-  class HbaseTarget < Target
-    rcvr_accessor :data_assets,     Array, :of => String
-    rcvr_accessor :table_name,      String
-    rcvr_accessor :column_families, Array, :of => String
-    rcvr_accessor :column_family,   String
-    rcvr_accessor :loader,          String
-    rcvr_accessor :id_field,        String
-  end
-
-  class ElasticSearchTarget < Target
-    rcvr_accessor :data_assets, Array, :of => String
-    rcvr_accessor :index_name,  String
-    rcvr_accessor :id_field,    String
-    rcvr_accessor :object_type, String
-    rcvr_accessor :loader,      String
-  end
-
-  class GeoIndexTarget < Target
-    rcvr_accessor :data_assets,    Array, :of => String
-    rcvr_accessor :table_name,     String
-    rcvr_accessor :min_zoom,       Integer
-    rcvr_accessor :max_zoom,       Integer
-    rcvr_accessor :chars_per_page, Integer
-    rcvr_accessor :sort_field,     String
-  end
-
-  class CatalogTarget < Target
-    rcvr_accessor :name,        String
-    rcvr_accessor :license,     String
-    rcvr_accessor :title,       String
-    rcvr_accessor :link,        String
-    rcvr_accessor :description, String
-    rcvr_accessor :owner,       String
-    rcvr_accessor :price,       Float
-    rcvr_accessor :tags,        Array, :of => String
-    rcvr_accessor :messages,    Array, :of => String
-    rcvr_accessor :packages,    Array, :of => Hash
-  end
-end

data/lib/icss/type/factory.rb

@@ -1,196 +0,0 @@
-module Icss
-  class MetaType
-    include Receiver
-
-    def initialize *args
-      receive! *args unless args.empty?
-    end
-
-    # Returns a string containing an XML representation of its receiver:
-    #
-    #   {"foo" => 1, "bar" => 2}.to_xml
-    #   # =>
-    #   # <?xml version="1.0" encoding="UTF-8"?>
-    #   # <hash>
-    #   #   <foo type="integer">1</foo>
-    #   #   <bar type="integer">2</bar>
-    #   # </hash>
-    #
-    # To do so, the method loops over the pairs and builds nodes that depend on
-    # the _values_. Given a pair +key+, +value+:
-    #
-    # * If +value+ is a hash there's a recursive call with +key+ as <tt>:root</tt>.
-    #
-    # * If +value+ is an array there's a recursive call with +key+ as <tt>:root</tt>,
-    #   and +key+ singularized as <tt>:children</tt>.
-    #
-    # * If +value+ is a callable object it must expect one or two arguments. Depending
-    #   on the arity, the callable is invoked with the +options+ hash as first argument
-    #   with +key+ as <tt>:root</tt>, and +key+ singularized as second argument. Its
-    #   return value becomes a new node.
-    #
-    # * If +value+ responds to +to_xml+ the method is invoked with +key+ as <tt>:root</tt>.
-    #
-    # * Otherwise, a node with +key+ as tag is created with a string representation of
-    #   +value+ as text node. If +value+ is +nil+ an attribute "nil" set to "true" is added.
-    #   Unless the option <tt>:skip_types</tt> exists and is true, an attribute "type" is
-    #   added as well according to the following mapping:
-    #
-    #     XML_TYPE_NAMES = {
-    #       "Symbol"     => "symbol",
-    #       "Fixnum"     => "integer",
-    #       "Bignum"     => "integer",
-    #       "BigDecimal" => "decimal",
-    #       "Float"      => "float",
-    #       "TrueClass"  => "boolean",
-    #       "FalseClass" => "boolean",
-    #       "Date"       => "date",
-    #       "DateTime"   => "datetime",
-    #       "Time"       => "datetime"
-    #     }
-    #
-    # By default the root node is "hash", but that's configurable via the <tt>:root</tt> option.
-    #
-    # The default XML builder is a fresh instance of <tt>Builder::XmlMarkup</tt>. You can
-    # configure your own builder with the <tt>:builder</tt> option. The method also accepts
-    # options like <tt>:dasherize</tt> and friends, they are forwarded to the builder.
-    # Returns a string containing an XML representation of its receiver:
-    #
-    #   {"foo" => 1, "bar" => 2}.to_xml
-    #   # =>
-    #   # <?xml version="1.0" encoding="UTF-8"?>
-    #   # <hash>
-    #   #   <foo type="integer">1</foo>
-    #   #   <bar type="integer">2</bar>
-    #   # </hash>
-    #
-    # To do so, the method loops over the pairs and builds nodes that depend on
-    # the _values_. Given a pair +key+, +value+:
-    #
-    # * If +value+ is a hash there's a recursive call with +key+ as <tt>:root</tt>.
-    #
-    # * If +value+ is an array there's a recursive call with +key+ as <tt>:root</tt>,
-    #   and +key+ singularized as <tt>:children</tt>.
-    #
-    # * If +value+ is a callable object it must expect one or two arguments. Depending
-    #   on the arity, the callable is invoked with the +options+ hash as first argument
-    #   with +key+ as <tt>:root</tt>, and +key+ singularized as second argument. Its
-    #   return value becomes a new node.
-    #
-    # * If +value+ responds to +to_xml+ the method is invoked with +key+ as <tt>:root</tt>.
-    #
-    # * Otherwise, a node with +key+ as tag is created with a string representation of
-    #   +value+ as text node. If +value+ is +nil+ an attribute "nil" set to "true" is added.
-    #   Unless the option <tt>:skip_types</tt> exists and is true, an attribute "type" is
-    #   added as well according to the following mapping:
-    #
-    #     XML_TYPE_NAMES = {
-    #       "Symbol"     => "symbol",
-    #       "Fixnum"     => "integer",
-    #       "Bignum"     => "integer",
-    #       "BigDecimal" => "decimal",
-    #       "Float"      => "float",
-    #       "TrueClass"  => "boolean",
-    #       "FalseClass" => "boolean",
-    #       "Date"       => "date",
-    #       "DateTime"   => "datetime",
-    #       "Time"       => "datetime"
-    #     }
-    #
-    # By default the root node is "hash", but that's configurable via the <tt>:root</tt> option.
-    #
-    # The default XML builder is a fresh instance of <tt>Builder::XmlMarkup</tt>. You can
-    # configure your own builder with the <tt>:builder</tt> option. The method also accepts
-    # options like <tt>:dasherize</tt> and friends, they are forwarded to the
-    #builder.
-    #
-    def to_xml options={}, &block
-      options = options.reverse_merge(:root => self.class.xml_type_name)
-      xml_hsh = self.to_hash
-      # # remove once microsoft has signed off on this
-      # xml_hsh.merge!(:_note => "XML support is experimental, structure may change in future") unless options[:skip_instruct]
-      xml_hsh.to_xml(options, &block)
-    end
-
-    def self.xml_type_name
-      self.to_s.demodulize.underscore.gsub(/_/, '-')
-    end
-
-    def to_json *args
-      to_hash.to_json(*args)
-    end
-  end
-
-  class RecordType < NamedType
-
-    def ruby_klass_scope_names
-      fullname.split('.').map(&:camelize)
-    end
-    def ruby_klass_name
-      "::" + ruby_klass_scope_names.join('::')
-    end
-    def ruby_klass_parent
-      ("::" + ruby_klass_scope_names[0..-2].join('::')).constantize
-    end
-
-    def ensure_parent_modules!
-      ruby_klass_scope_names[0..-2].inject(Object) do |parent_module, module_name|
-        new_parent   = "::#{parent_module}::#{module_name}".constantize rescue nil
-        new_parent ||= parent_module.const_set(module_name.to_sym, Module.new)
-        # p [parent_module, new_parent, module_name]
-        new_parent
-      end
-    end
-
-    def define_klass
-      ensure_parent_modules!
-      parent_module = ruby_klass_parent
-      klass_basename = ruby_klass_scope_names.last.to_sym
-      klass   = parent_module.const_get(klass_basename) rescue nil
-      klass ||= parent_module.const_set(klass_basename, Class.new(::Icss::MetaType))
-      klass
-    end
-
-    def ruby_klass
-      return @klass if @klass
-      klass = define_klass
-      decorate_with_receivers(klass)
-      decorate_with_conveniences(klass)
-      @klass = klass
-    end
-
-    def decorate_with_receivers klass
-      fields.each do |field|
-        field.define_receiver_on(klass)
-      end
-    end
-
-    def decorate_with_conveniences klass
-      klass.send :include, Receiver::ActsAsHash
-    end
-
-  end
-
-  Icss::RecordField.class_eval do
-    def define_receiver_on(klass)
-      if union? || enum?
-        warn "Can't handle union or enum types yet: #{self.inspect}"
-        return
-      end
-      p self if type.nil?
-      klass.rcvr_accessor name.to_sym, type.ruby_klass, field_receiver_attrs
-    end
-
-    def field_receiver_attrs
-      attrs = {}
-      (self.class.receiver_attr_names - [:name, :type]).each do |attr|
-        val = attr_set?(attr) && self.send(attr) or next
-        attrs[attr] = val
-      end
-      case self.type
-      when Icss::ArrayType then attrs[:of] = self.type.items.ruby_klass
-      end
-      attrs
-    end
-  end
-end

data/lib/icss/validations.rb

@@ -1,16 +0,0 @@
-module Icss
-  module Validations
-
-    # An avro name must
-    # * start with [A-Za-z_]
-    # * subsequently contain only [A-Za-z0-9_]
-    def validate_name
-      (name =~ /\A[A-Za-z_]\w*\z/) or raise "An avro name must start with [A-Za-z_] and contain only [A-Za-z0-9_]; have #{name}. A namespace is the dot-separated sequence of such names."
-    end
-
-    def validate_namespace
-      (name =~ /\A([A-Za-z_]\w*\.?)+\z/) or raise "An avro name must start with [A-Za-z_] and contain only [A-Za-z0-9_]; have #{name}. A namespace is the dot-separated sequence of such names."
-    end
-
-  end
-end

data/spec/validations_spec.rb

@@ -1,171 +0,0 @@
-require 'rubygems'
-require 'rspec'
-require 'icss'
-
-def template_icss
-  return <<EOS
----
-namespace: foo.bar
-protocol: baz
-
-data_assets:
-- name: test_data_asset
-  location: data/test_data.tsv
-  type: test_data_record
-
-messages:
-  search:
-    doc: A testable template message
-    request:
-    - name: test_request
-      type: test_request_record
-    response: test_data_record
-    samples:
-    - request:
-      - first_param: foo
-        second_param: bar
-
-targets:
-  catalog:
-  - name: test_catalog_entry
-    title: Test Icss
-    description: This is a template Icss to test the error handling of the Icss library.
-    tags:
-    - test
-    - icss
-    - template
-    messages:
-    - search
-    packages:
-    - data_assets:
-      - test_data_asset
-
-types:
-- name: test_request_record
-  doc: A template request record
-  type: record
-  fields:
-  - name: first_param
-    doc: The first test parameter
-    type: string
-  - name: second param
-    doc: The second test parameter
-    type: string
-
-- name: test_complex_data
-  doc: A template complex data type
-  type: record
-  fields:
-  - name: field_one
-    doc: A simple field for a complex data type
-    type: string
-  - name: field_two
-    doc: Another simple field for a complex data type
-    type: string
-
-- name: test_data_record
-  doc: A template data record
-  type: record
-  fields:
-  - name: simple_data
-    doc: A simple piece of data
-    type: int
-  - name: complex_data
-    doc: A complex piece of data
-    type: test_complex_data
-
-EOS
-end
-
-describe "Icss::Protocol validations" do
-  before :each do
-    @template = YAML.load(template_icss)
-  end
-
-  it "should be able to receive a correctly formatted template Icss" do
-    lambda { @icss =Icss::Protocol.receive @template }.should_not raise_error
-    @icss.errors.should be_empty
-  end
-
-  it "should contain only the keys that were included in the Icss file" do
-    @icss = Icss::Protocol.receive @template
-    @icss.keys.map { |k| k.to_s }.should == @template.keys
-  end
-
-  it "should generate an error when the namespace if formatted incorrectly" do
-    @template['namespace'] = '$bad_namespace'
-    Icss::Protocol.receive(@template).errors.keys.should == [:namespace]
-  end
-
-  it "should generate an error when the protocol if formatted incorrectly" do
-    @template['protocol'] = '$bad_protocol'
-    Icss::Protocol.receive(@template).errors.keys.should == [:protocol]
-  end
-
-  context "Catalog Target" do
-
-    it "should generate an error when an undefined data_asset is specified" do
-      @template['targets']['catalog'].first['packages'].first['data_assets'] = ['fake_data_asset']
-      Icss::Protocol.receive(@template).errors.keys.should == [:catalog]
-    end
-
-    it "should generate an error when an undefined message name is specified" do
-      @template['targets']['catalog'].first['messages'] = ['fake_message']
-      Icss::Protocol.receive(@template).errors.keys.should == [:catalog]
-    end
-
-  end
-
-  context "Data Assets" do
-
-    it "should generate an error when an asset's type is undefined" do
-      @template['data_assets'].first['type'] = 'fake_data_asset'
-      Icss::Protocol.receive(@template).errors.keys.should == [:data_assets]
-    end
-
-  end
-
-  context "Messages" do
-
-    it "should generate an error when a message's request type is undefined" do
-      @template['messages']['search']['request'].first['type'] = 'fake_request_type'
-      Icss::Protocol.receive(@template).errors.keys.should == [:messages]
-    end
-
-    it "should generate an error when a message's response type is undefined" do
-      @template['messages']['search']['response'] = 'fake_response_type'
-      Icss::Protocol.receive(@template).errors.keys.should == [:messages]
-    end
-
-    it "should generate an error when a message's sample request types do not match the request record" do
-      @template['messages']['search']['samples'].first['request'] = [{ 'foo' => 'bar' }]
-      Icss::Protocol.receive(@template).errors.keys.should == [:messages]
-    end
-
-  end
-
-  context "Types" do
-
-    it "should generate an error when an bad type definition is given for a specific type" do
-      @template['types'].push({
-          'name' => 'fake_type_record',
-          'type' => 'fake'
-        })
-      Icss::Protocol.receive(@template).errors.keys.should == [:types]
-    end
-
-    it "should generate an error when an undefined type definition is given for a specific field" do
-      @template['types'].push({
-          'name' => 'fake_type_record',
-          'type' => 'record',
-          'fields' => [{
-              'name' => 'fake_field',
-              'type' => 'fake_type'
-            }]
-        })
-      Icss::Protocol.receive(@template).errors.keys.should == [:types]
-    end
-
-  end
-
-end