clli 0.0.1

data/lib/clli/validations.rb

@@ -0,0 +1,79 @@
+class CLLI
+  ##
+  # This module provides methods to validate the parsed +CLLI+ attributes.
+  module Validations
+    ##
+    # When this modeule is included then extend the including class with the
+    # methods defined in +ClassMethods+.
+    def self.included(o)
+      o.extend(ClassMethods)
+    end
+
+    ##
+    # These methods will be available in the CLLI class.
+    module ClassMethods
+      def validate(str, attributes, **options)
+        validate_place(str, attributes[:place], options)
+        validate_region(str, attributes[:region], options)
+        %i(network_site entity_code location_code location_id customer_code customer_id).each do |attribute|
+          send("validate_#{attribute}", str, attributes[attribute], options) if attributes.key?(attribute)
+        end
+      end
+
+      private
+
+      def validate_place(str, place, **options)
+        error_prefix = "Invalid CLLI #{str.inspect} place (characters 0..3)"
+        validate_attribute(error_prefix, place, 4, /\A[A-Z]+\s*\z/, options)
+      end
+
+      def validate_region(str, region, **options)
+        error_prefix = "Invalid CLLI #{str.inspect} region (characters 4..5)"
+        validate_attribute(error_prefix, region, 2, /\A[A-Z]{2}\z/, options)
+      end
+
+      def validate_network_site(str, site, **options)
+        error_prefix = "Invalid CLLI #{str.inspect} network site (characters 6..7)"
+        validate_attribute(error_prefix, site, 2, /\A([A-Z]{2}|[0-9]{2})\z/, options)
+      end
+
+      def validate_entity_code(str, entity_code, **options)
+        error_prefix = "Invalid CLLI #{str.inspect} entity code (characters 8..11)"
+        validate_attribute(error_prefix, entity_code, 3, /\A[A-Z0-9]{3}\z/, options)
+      end
+
+      def validate_location_code(str, location, **options)
+        error_prefix = "Invalid CLLI #{str.inspect} non-building location code (character 8)"
+        validate_attribute(error_prefix, location, 1, /\A[A-Z]\z/, options)
+      end
+
+      def validate_location_id(str, location, **options)
+        error_prefix = "Invalid CLLI #{str.inspect} non-building location ID (characters 9..11)"
+        validate_attribute(error_prefix, location, 4, /\A[0-9]{4}\z/, options)
+      end
+
+      def validate_customer_code(str, location, **options)
+        error_prefix = "Invalid CLLI #{str.inspect} customer location code (characters 8)"
+        validate_attribute(error_prefix, location, 1, /\A[0-9]\z/, options)
+      end
+
+      def validate_customer_id(str, location, **options)
+        error_prefix = "Invalid CLLI #{str.inspect} customer location ID (characters 9..11)"
+        validate_attribute(error_prefix, location, 4, /\A[A-Z][0-9]{3}\z/, options)
+      end
+
+      def validate_attribute(error_prefix, value, length, regexp, **options)
+        fail "#{error_prefix} cannot be nil." if value.nil?
+        fail "#{error_prefix} cannot be empty." if value.to_s.empty?
+        fail "#{error_prefix} must be #{length} #{pluralize(length, 'character')} long." unless value.to_s.size == length
+        return unless options[:strict]
+        fail "#{error_prefix} is not properly formatted." unless regexp =~ value
+      end
+
+      def pluralize(count, singular, plural = nil)
+        plural ||= singular + 's'
+        count == 1 ? singular : plural
+      end
+    end
+  end
+end

data/lib/clli/version.rb

@@ -0,0 +1,4 @@
+# This file defines the gem version.
+class CLLI
+  VERSION = '0.0.1'
+end

data/lib/clli/yaml_data.rb

@@ -0,0 +1,56 @@
+class CLLI
+  ##
+  # This module provides methods to load external data from YAML files.
+  class YAMLData
+    class << self
+      @cache = nil
+
+      ##
+      # Expand the relative path into a real path.
+      #
+      # Params:
+      # +paths+:: a splat containing the path names.
+      def real_path(*paths)
+        File.join([File.dirname(__FILE__), '..'] + paths)
+      end
+    end
+
+    ##
+    # Create a new +YAMLData+ object loading the data from the specified YAML
+    # file.
+    #
+    # Params:
+    # +paths+:: a splat containing the path names.
+    def initialize(*paths)
+      @cache = YAML.load_file(self.class.real_path(paths)).freeze
+    end
+
+    ##
+    # Get the +Hash+ keys from the cached data.
+    def keys
+      @cache.keys
+    end
+
+    ##
+    # Get the cached data +Hash+. Note the +hash+ is frozen, any modification
+    # will cause a +RuntimeError+ to be thrown.
+    def data
+      @cache
+    end
+
+    ##
+    # Get the data at the corresponding keys. Note the keys are interpreted as a
+    # tree. So a second key indicates that the first key returns a +Hash+ which
+    # contains the second key. If no matching records are found then +nil+ will
+    # be returned.
+    #
+    # Porams:
+    # +keys+:: the keys to lookup.
+    def get(*keys)
+      keys.inject(@cache) do |data, key|
+        return nil unless data.respond_to?(:[])
+        data[key]
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,130 @@
+--- !ruby/object:Gem::Specification
+name: clli
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Steven Wheeler
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-01-13 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: countries
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0'
+    - - ">"
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0'
+    - - ">"
+      - !ruby/object:Gem::Version
+        version: '0'
+description: A simple gem to parse CLLI strings.
+email:
+- steven@steventwheeler.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rubocop.yml"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- clli.gemspec
+- doc/795-100-100_I5.pdf
+- lib/clli.rb
+- lib/clli/cities.rb
+- lib/clli/data/cities.yml
+- lib/clli/data/entity_types.yml
+- lib/clli/data/location_types.yml
+- lib/clli/data/region_conversions.yml
+- lib/clli/entity_type.rb
+- lib/clli/iso3166.rb
+- lib/clli/location_type.rb
+- lib/clli/pattern.rb
+- lib/clli/validations.rb
+- lib/clli/version.rb
+- lib/clli/yaml_data.rb
+homepage: https://github.com/steventwheeler/clli
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.5.1
+signing_key: 
+specification_version: 4
+summary: A gem to parse CLLI strings
+test_files: []