eagle_labels 0.0.1

data/.gitignore

@@ -0,0 +1,5 @@
+*.gem
+.bundle
+Gemfile.lock
+pkg/*
+.idea

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in eagle_labels.gemspec
+gemspec

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2012 TODO: Write your name
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,67 @@
+# EagleLabels
+
+OO Eagle Lables
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'eagle_labels'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install eagle_labels
+
+## Usage
+
+### Categories definition
+
+    adjective:
+      code: A
+      features:
+        type:
+          qualifying: Q
+        grade:
+          appreciative: A
+        gender:
+          male: M
+          female: F
+          common: C
+        number:
+          singular: S
+          plural: P
+          invariably: N
+        case:
+        function:
+          participle: P
+
+### Initialization
+
+    EagleLabels::Specification.new # with default categories
+    #or
+    EagleLabels::Specification.new 'categories.yml'
+    #or
+    EagleLabels::Specification.new category: {'code' => 'C', 'features' => {'feature' => {'value1' => 1, 'value2' => 2}}}
+
+### Examples
+
+    spec =  EagleLabels::Specification.new
+
+    spec.all_labels
+    spec.valid_label? 'AQMSP'
+    spec.starts_with 'AQ'
+    spec.names_of 'AQMSP'
+    spec.next_codes 'AQ'
+    spec.tails 'AQ'
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Added some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,3 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"
+Bundler::GemHelper.install_tasks

data/config/default_categories.yml

@@ -0,0 +1,186 @@
+adjective:
+  code: A
+  features:
+    type:
+      qualifying: Q
+    grade:
+      appreciative: A
+    gender:
+      male: M
+      female: F
+      common: C
+    number:
+      singular: S
+      plural: P
+      invariably: N
+    case:
+    function:
+      participle: P
+adverb:
+  code: R
+  features:
+    type:
+      general: G
+article:
+  code: T
+  features:
+    type:
+      defined: D
+    gender:
+      male: M
+      female: F
+      common: C
+    number:
+      sigular: S
+      plural: P
+    case:
+determinant:
+  code: D
+  features:
+    type:
+      demonstrative: D
+      possessive: P
+      interrogative: T
+      exclamation: E
+      undefined: I
+    person:
+      first: 1
+      second: 2
+      third: 3
+    gender:
+      male: M
+      female: F
+      common: C
+    number:
+      sigular: S
+      plural: P
+    case:
+    holder:
+      first_singular: 1
+      second_singular: 2
+      third: 0
+      first_plural: 4
+      first_plural: 5
+name:
+  code: N
+  features:
+    type:
+      common: C
+      own: P
+    gender:
+      male: M
+      female: F
+      common: C
+    number:
+      sigular: S
+      plural: P
+    case:
+    semantic_gender:
+    grade:
+      sppreciative: A
+word:
+  code: V
+  features:
+    type:
+      home: M
+      assistant: A
+    mode:
+      callsign: I
+      subjunctive: S
+      imperative: M
+      conditional: C
+      infinitive: N
+      gerund: G
+      participle: P
+    time:
+      present: P
+      imperfect: I
+      future: F
+      past: S
+    person:
+      first: 1
+      second: 2
+      third: 3
+    number:
+      sigular: S
+      plural: P
+    gender:
+      male: M
+      female: F
+      common: C
+pronoun:
+  code: P
+  features:
+    type:
+      personal: P
+      demonstrative: D
+      possessive: X
+      undefined: I
+      interrogative: T
+      relative: R
+    person:
+      first: 1
+      second: 2
+      third: 3
+    gender:
+      male: M
+      female: F
+      common: C
+    number:
+      sigular: S
+      plural: P
+    case:
+      nominative: N
+      accusative: A
+      dative: D
+      oblique: O
+    holder:
+      first_singular: 1
+      first_singular: 2
+      third: 0
+      first_plural: 4
+      first_plural: 5
+    politeness:
+      polite: P
+conjunction:
+  code: C
+  features:
+    type:
+      coordinated: C
+      subordinate: S
+numeral:
+  code: M
+  features:
+    type:
+      cardinal: C
+      ordinal: O
+    gender:
+      male: M
+      female: F
+      common: C
+    number:
+      sigular: S
+      plural: P
+    case:
+    function:
+      pronoun: P
+      determinant: D
+      adjective: A
+interjection:
+  code: R
+abbreviation:
+  code: Y
+preposition:
+  code: S
+  features:
+    type:
+      preposition: P
+    form:
+      simple: S
+      contracted: C
+    gender:
+      male: M
+    number:
+      sigular: S
+punctuation_sign:
+  code: F

data/eagle_labels.gemspec

@@ -0,0 +1,19 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/eagle_labels/version', __FILE__)
+
+Gem::Specification.new do |s|
+  s.name          = 'eagle_labels'
+  s.version       = EagleLabels::VERSION
+  s.authors       = ["Damián D'Onia", "Gabriel Naiman"]
+  s.email         = ['ddonia@gmail.com', 'gnaiman@gmail.com']
+  s.homepage      = 'https://github.com/ddonia/eagle_labels'
+  s.description   = 'OO Eagle Lables'
+  s.summary       = 'OO Eagle Lables'
+
+  s.files         = `git ls-files`.split($\)
+  s.executables   = s.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  s.test_files    = s.files.grep(%r{^(test|spec|features)/})
+  s.require_paths = ["lib"]
+
+  s.add_development_dependency 'rspec'
+end

data/lib/eagle_labels.rb

@@ -0,0 +1,7 @@
+require 'yaml'
+
+require "eagle_labels/version"
+require "eagle_labels/specification"
+require "eagle_labels/category"
+require "eagle_labels/feature"
+require "eagle_labels/value"

data/lib/eagle_labels/category.rb

@@ -0,0 +1,22 @@
+module EagleLabels
+  class Category
+    attr_reader :name, :code
+
+    def initialize(name, spec)
+      @name = name
+      @code = spec['code'].to_s
+      @features = spec['features'] || {}
+    end
+
+    def features
+      @features.map { |k, v| Feature.new(k, v) }
+    end
+
+    def all_labels
+      features.inject([]) do |labels, feature|
+        labels.any? ? labels.product(feature.codes) : feature.codes
+      end.map { |l| "#{code}#{l.is_a?(String) ? l : l.flatten.join}" }
+    end
+
+  end
+end

data/lib/eagle_labels/feature.rb

@@ -0,0 +1,19 @@
+module EagleLabels
+  class Feature
+    attr_reader :name
+
+    def initialize(name, spec)
+      @name = name
+      @values = spec || {}
+    end
+
+    def values
+      @values.map { |k, v| Value.new(k, v) }
+    end
+
+    def codes
+      values.map(&:code) | ['0']
+    end
+
+  end
+end

data/lib/eagle_labels/specification.rb

@@ -0,0 +1,68 @@
+module EagleLabels
+  class Specification
+
+    def initialize(spec=nil)
+      if spec.is_a? Hash
+        @spec = spec
+      elsif spec.is_a?(String) && File.exist?(spec)
+        @spec = YAML.load_file(spec)
+      else
+        @spec = YAML.load_file("#{File.dirname(__FILE__)}/../../config/default_categories.yml")
+      end
+    end
+
+    def categories
+      @spec.map { |k, v| Category.new(k, v) }
+    end
+
+    def all_labels
+      categories.map(&:all_labels).flatten
+    end
+
+    def starts_with(prefix)
+      if prefix.size == 0
+        labels = all_labels
+      else
+        category = categories.detect { |c| c.code == prefix[0] }
+        labels = category.all_labels
+      end
+      labels.select { |l| l.match("^#{prefix}") }
+    end
+
+    def tails(prefix)
+      starts_with(prefix).map { |l| l.sub prefix, '' }
+    end
+
+    def next_codes(prefix)
+      if prefix.size == 0
+        categories.map(&:code)
+      else
+        category = categories.detect { |c| c.code == prefix[0] }
+        category.features.size > prefix.size-1 ? category.features[prefix.size-1].codes : []
+      end
+    end
+
+    def valid_label?(label)
+      all_labels.include? label
+    end
+
+    def names_of(label)
+      return [] unless valid_label? label
+
+      codes = label.chars.to_a
+      category_code = codes.shift
+      category = categories.detect { |c| c.code == category_code }
+      names = [category.name]
+
+      category.features.each do |feature|
+        feature_code = codes.shift
+        if value = feature.values.detect { |v| v.code == feature_code }
+          names << value.name
+        end
+      end
+
+      names
+    end
+
+  end
+end

data/lib/eagle_labels/value.rb

@@ -0,0 +1,11 @@
+module EagleLabels
+  class Value
+    attr_reader :name, :code
+
+    def initialize(name, code)
+      @name = name
+      @code = code.to_s
+    end
+
+  end
+end

data/lib/eagle_labels/version.rb

@@ -0,0 +1,3 @@
+module EagleLabels
+  VERSION = '0.0.1'
+end

data/spec/category_spec.rb

@@ -0,0 +1,11 @@
+require 'spec_helper'
+
+describe Category do
+
+  it 'List all values' do
+    spec = Specification.new 'dummy_spec.yml'
+
+    spec.categories.first.all_labels.should eq %w(1A1 1A2 1A3 1A0 1B1 1B2 1B3 1B0 1C1 1C2 1C3 1C0 101 102 103 100)
+  end
+
+end

data/spec/dummy_spec.yml

@@ -0,0 +1,35 @@
+category_1:
+  code: 1
+  features:
+    letter:
+      value_a: A
+      value_b: B
+      value_c: C
+    number:
+      value_1: 1
+      value_2: 2
+      value_3: 3
+
+category_2:
+  code: 2
+  features:
+    letter:
+      value_a: A
+      value_b: B
+      value_c: C
+    number:
+      value_1: 1
+      value_2: 2
+      value_3: 3
+
+category_3:
+  code: 3
+  features:
+    letter:
+      value_a: A
+      value_b: B
+      value_c: C
+    number:
+      value_1: 1
+      value_2: 2
+      value_3: 3

data/spec/initializations_spec.rb

@@ -0,0 +1,49 @@
+require 'spec_helper'
+
+describe EagleLabels, '-> Initializations' do
+
+  it 'Initialize from hash' do
+    spec = Specification.new category: {'code' => 'C', 'features' => {'feature' => {'value1' => 1, 'value2' => 2}}}
+
+    spec.should have(1).categories
+    spec.categories.first.name.should eq :category
+    spec.categories.first.code.should eq 'C'
+    spec.categories.first.should have(1).features
+    spec.categories.first.features.first.name.should eq 'feature'
+    spec.categories.first.features.first.codes.should eq %w(1 2 0)
+  end
+
+  it 'Initialize from yml file' do
+    spec = Specification.new 'dummy_spec.yml'
+
+    spec.should have(3).categories
+    spec.categories.map(&:name).should eq %w(category_1 category_2 category_3)
+    spec.categories.map(&:code).should eq %w(1 2 3)
+
+    spec.categories.each do |category|
+      category.should have(2).features
+      category.features.map(&:name).should eq %w(letter number)
+
+      category.features[0].values[0].name.should eq 'value_a'
+      category.features[0].values[0].code.should eq 'A'
+      category.features[0].values[1].name.should eq 'value_b'
+      category.features[0].values[1].code.should eq 'B'
+      category.features[0].values[2].name.should eq 'value_c'
+      category.features[0].values[2].code.should eq 'C'
+
+      category.features[1].values[0].name.should eq 'value_1'
+      category.features[1].values[0].code.should eq '1'
+      category.features[1].values[1].name.should eq 'value_2'
+      category.features[1].values[1].code.should eq '2'
+      category.features[1].values[2].name.should eq 'value_3'
+      category.features[1].values[2].code.should eq '3'
+    end
+  end
+
+  it 'Initialize with default configuration' do
+    spec = Specification.new
+
+    spec.should have(13).categories
+  end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,3 @@
+require 'eagle_labels'
+
+include EagleLabels

data/spec/specification_spec.rb

@@ -0,0 +1,58 @@
+require 'spec_helper'
+
+describe Specification do
+
+  let(:spec) { Specification.new 'dummy_spec.yml' }
+
+  it 'List all labels' do
+    combination = %w(A1 A2 A3 A0 B1 B2 B3 B0 C1 C2 C3 C0 01 02 03 00)
+
+    all_labels = spec.categories.inject([]) do |labels, category|
+      labels << combination.map { |c| "#{category.code}#{c}" }
+    end.flatten
+
+    spec.all_labels.should eq all_labels
+  end
+
+  it 'List labels with empty prefix' do
+    list = spec.starts_with ''
+
+    list.should eq spec.all_labels
+  end
+
+  it 'List labels with category prefix' do
+    list = spec.starts_with '1'
+
+    list.should eq %w(1A1 1A2 1A3 1A0 1B1 1B2 1B3 1B0 1C1 1C2 1C3 1C0 101 102 103 100)
+  end
+
+  it 'List labels with feature prefix' do
+    list = spec.starts_with '1A'
+
+    list.should eq %w(1A1 1A2 1A3 1A0)
+  end
+
+  it 'List tails from prefix' do
+    list = spec.tails '1A'
+
+    list.should eq %w(1 2 3 0)
+  end
+
+  it 'List next codes from prefix' do
+    list = spec.next_codes '1A'
+
+    list.should eq %w(1 2 3 0)
+  end
+
+  it 'Validate label' do
+    spec.valid_label?('XXX').should be_false
+    spec.valid_label?('1A1').should be_true
+  end
+
+  it 'Convert label to names' do
+    list = spec.names_of '1A1'
+
+    list.should eq %w(category_1 value_a value_1)
+  end
+
+end

metadata

@@ -0,0 +1,81 @@
+--- !ruby/object:Gem::Specification
+name: eagle_labels
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Damián D'Onia
+- Gabriel Naiman
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-10-22 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: &22386000 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *22386000
+description: OO Eagle Lables
+email:
+- ddonia@gmail.com
+- gnaiman@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- config/default_categories.yml
+- eagle_labels.gemspec
+- lib/eagle_labels.rb
+- lib/eagle_labels/category.rb
+- lib/eagle_labels/feature.rb
+- lib/eagle_labels/specification.rb
+- lib/eagle_labels/value.rb
+- lib/eagle_labels/version.rb
+- spec/category_spec.rb
+- spec/dummy_spec.yml
+- spec/initializations_spec.rb
+- spec/spec_helper.rb
+- spec/specification_spec.rb
+homepage: https://github.com/ddonia/eagle_labels
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.16
+signing_key: 
+specification_version: 3
+summary: OO Eagle Lables
+test_files:
+- spec/category_spec.rb
+- spec/dummy_spec.yml
+- spec/initializations_spec.rb
+- spec/spec_helper.rb
+- spec/specification_spec.rb