ams_var_file 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 02c6e9779069f285e6889fb2fb7baf1253be2562
+  data.tar.gz: c3d4d6ef936ba2dcf05495b215fc3952147fa1fa
+SHA512:
+  metadata.gz: fd8e9bed2ca5ed7981759bc224d119f86b188d5ca0227de75961f75366af744b8402059fcb526c85a832cbd02931dba0da69ef8b7bb5b92b755e7d88c667a5c2
+  data.tar.gz: 88fa6404762bdeb8eafbcbc0ff45d8d0dd3c35e3102a59e400ce9eb4f96dfe3b23d4c9c32448c1569b839814c6a6ebbd900678e57d0414a883e58b4b463be578

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 2.1.2
+before_install: gem install bundler -v 1.10.5

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Gem dependencies specified in ams_var_file.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Jeff McAffee
+
+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,180 @@
+# AmsVarFile
+
+AmsVarFile generates DPM and DSM variable declaration files and provides for
+adding and deleting variables programmatically.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'ams_var_file'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install ams_var_file
+
+## Usage
+
+First, require the gem:
+
+```ruby
+require "ams_var_file"
+```
+
+Note: AmsVarFile can output informative messages to `$stdout` and `$stderr`.
+To have the messages output, set verbose to true (it's false by default).
+
+```ruby
+AmsVarFile::File.verbose = true
+```
+
+### Generate a Var File
+
+To generate a `DPM` var file:
+
+```ruby
+AmsVarFile::File.generate("dpm", "path/to/dpms.gdl")
+```
+
+To generate a `DSM` var file:
+
+```ruby
+AmsVarFile::File.generate("dsm", "path/to/dsms.gdl")
+```
+
+AmsVarFile will throw an `IOError` exception if the file already exists.
+
+The generated files will contain markers that allow AmsVarFile to understand
+where to insert/delete variables. Removing or modifying these markers will
+result in a `InvalidFileFormat` exception being thrown.
+
+The markers are:
+
+    // START DEFINITIONS
+
+    // END DEFINITIONS
+
+    // START INITS
+
+    // END INITS
+
+The naming convention of the files are `dpms.gdl` for DPMs
+and `dsms.gdl` for DSMs.
+
+### Adding Variable Declarations
+
+Before adding a variable to a file, the file must exist. See the `generation`
+details above for information on generating a file.
+
+To add a `DPM` variable:
+
+```ruby
+# var_type can be one of:
+#               boolean
+#               date
+#               datetime
+#               money
+#               numeric
+#               numeric(#) where '#' indicates precision
+#               percentage
+#               text
+
+var_type = "text"
+
+
+# var_id is a valid GDL identifier (ie, no spaces or special chars)
+
+var_id = "myDummyVar"
+
+
+# var_alias is the variable's actual name in the AMS system. It *can*
+# contain spaces and such.
+
+var_alias = "My Dummy Var"
+
+
+# file_path is any valid path to the `.gdl` file to add the variable to.
+
+file_path = "path/to/dpms.gdl"
+
+
+AmsVarFile::File.add_dpm_var(var_type, var_id, var_alias, file_path)
+```
+
+Adding a `DSM` variable is virtually the same, except a different method
+is called:
+
+```ruby
+var_type  = "text"
+var_id    = "myDummyDSMVar"
+var_alias = "My Dummy DSM Var"
+file_path = "path/to/dsms.gdl"
+
+
+AmsVarFile::File.add_dsm_var(var_type, var_id, var_alias, file_path)
+```
+
+### Deleting Variable Declarations
+
+Obviously, deleting a variable from a non-existing file won't work.
+
+To delete a `DPM` variable:
+
+```ruby
+var_id = "myDummyVar"
+file_path = "path/to/dpms.gdl"
+
+
+AmsVarFile::File.del_dpm_var(var_id, file_path)
+```
+
+Ditto for a `DSM` variable:
+
+```ruby
+var_id = "myDummyDSMVar"
+file_path = "path/to/dsms.gdl"
+
+
+AmsVarFile::File.del_dsm_var(var_id, file_path)
+```
+
+AmsVarFile will handle the deletion of a non-existing variable gracefully:
+it will not throw an exception. If `verbose` is `true`, you will
+see a message (output on `$stderr`) indicating the variable wasn't found.
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then,
+run `rake rspec` to run the tests. You can also run `bin/console` for an
+interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`.
+To release a new version, update the version number in `version.rb`, and then
+run `bundle exec rake release`, which will create a git tag for the version,
+push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/jmcaffee/ams_var_file.
+
+1. Fork it ( https://github.com/jmcaffee/ams_var_file/fork )
+1. Clone it (`git clone git@github.com:[my-github-username]/ams_var_file.git`)
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Create tests for your feature branch
+4. Commit your changes (`git commit -am 'Add some feature'`)
+5. Push to the branch (`git push origin my-new-feature`)
+6. Create a new Pull Request
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+
+See [LICENSE.txt](https://github.com/jmcaffee/ams_var_file/blob/master/LICENSE.txt) for
+details.
+

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/ams_var_file.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'ams_var_file/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "ams_var_file"
+  spec.version       = AmsVarFile::VERSION
+  spec.authors       = ["Jeff McAffee"]
+  spec.email         = ["jeff@ktechsystems.com"]
+
+  spec.description   = %q{Generate AMS variable declaration files and provide for adding and deleting variables.}
+  spec.summary       = spec.description
+  spec.homepage      = "https://github.com/jmcaffee/ams_var_file"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.10"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec"
+  spec.add_development_dependency "pry"
+  spec.add_development_dependency "pry-byebug"
+end

data/bin/console

@@ -0,0 +1,7 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "ams_var_file"
+
+require "pry"
+Pry.start

data/bin/setup

@@ -0,0 +1,7 @@
+#!/bin/bash
+set -euo pipefail
+IFS=$'\n\t'
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/ams_var_file.rb

@@ -0,0 +1,13 @@
+require "ams_var_file/version"
+
+require 'date'
+
+module AmsVarFile
+  class InvalidFileFormat < StandardError
+  end
+
+  class VariableExists < StandardError
+  end
+end
+
+require 'ams_var_file/file'

data/lib/ams_var_file/file.rb

@@ -0,0 +1,289 @@
+module AmsVarFile
+  class File
+
+    START_DEFS  = 'START DEFINITIONS'
+    END_DEFS    = 'END DEFINITIONS'
+    START_INITS = 'START INITS'
+    END_INITS   = 'END INITS'
+
+    # Capture groups:
+    #  :type = var type
+    #  :id = identifier
+    #  :name = name
+    DEF_PATTERN     = /^[\s]*dpm (?<type>text|numeric|numeric\(\d+\)|date|percentage|datetime|boolean)[\s]*(?<id>\w+)[\s]*"(?<name>.+)";/
+    DEF_DSM_PATTERN = /^[\s]*decision[\s]*dpm (?<type>text|numeric|numeric\(\d+\)|date|percentage|datetime|boolean)[\s]*(?<id>\w+)[\s]*"(?<name>.+)";/
+
+    # Usage:
+    #  '   dpm numeric(3)      myVariable      "My Variable";'.match(DEF_PATTERN)
+    #  Regexp.last_match        # Returns nil if no match found
+    #  Regexp.last_match(:id)   # Returns 'myVariable' or nil if no match found
+    #
+    INIT_PATTERN = /^[\s]*tempString[\s]*=[\s]*(?<id>\w+);/
+
+
+    def self.verbose= flag
+      @@verbose = flag
+    end
+
+    def self.verbose
+      @@verbose ||= false
+    end
+
+    ###
+    # Add a DPM variable declaration to the given file.
+    #
+    # type: one of
+    #               boolean
+    #               date
+    #               datetime
+    #               money
+    #               numeric
+    #               numeric(#) where '#' indicates precision
+    #               percentage
+    #               text
+    # id: valid GDL id (ie. no spaces or special chars)
+    # name: GDL alias/human readable name, visible in guidelines
+    # file: full path to declaration file to update
+    #
+    # Message indicating success or failure is output on $stdout/$stderr
+    #
+
+    def self.add_dpm_var type, id, name, file
+      add_variable(type, id, name, DEF_PATTERN, INIT_PATTERN, file, false)
+    end
+
+    ###
+    # Delete a DPM variable declaration from the given file.
+    #
+    # id: valid GDL id (ie. no spaces or special chars) of variable to delete
+    # file: full path to declaration file to update
+    #
+    # Message indicating success or failure is output on $stdout/$stderr
+    #
+
+    def self.del_dpm_var id, file
+      del_variable(id, DEF_PATTERN, INIT_PATTERN, file)
+    end
+
+    ###
+    # Add a DSM variable declaration to the given file.
+    #
+    # type: one of
+    #               boolean
+    #               date
+    #               datetime
+    #               money
+    #               numeric
+    #               numeric(#) where '#' indicates precision
+    #               percentage
+    #               text
+    # id: valid GDL id (ie. no spaces or special chars)
+    # name: GDL alias/human readable name, visible in guidelines
+    # file: full path to declaration file to update
+    #
+    # Message indicating success or failure is output on $stdout/$stderr
+    #
+
+    def self.add_dsm_var type, id, name, file
+      add_variable(type, id, name, DEF_DSM_PATTERN, INIT_PATTERN, file, true)
+    end
+
+    ###
+    # Delete a DSM variable declaration from the given file.
+    #
+    # id: valid GDL id (ie. no spaces or special chars) of variable to delete
+    # file: full path to declaration file to update
+    #
+    # Message indicating success or failure is output on $stdout/$stderr
+    #
+
+    def self.del_dsm_var id, file
+      del_variable(id, DEF_DSM_PATTERN, INIT_PATTERN, file)
+    end
+
+    ###
+    # Generate a new dpm/dsm declaration file.
+    #
+    # file_type: 'dpm' or 'dsm'
+    # file_path: full path to file to generate
+    #   Ex: path/to/dpms.gdl
+    #       path/to/dsms.gdl
+    #
+    #   dpms.gdl and dsms.gdl are the standard name to be used.
+    #
+    # Message indicating success or failure is output on $stdout/$stderr
+    #
+
+    def self.generate(file_type, file_path)
+
+      text = <<FILE_TEXT
+/* ***************************************************************************
+  File:     #{file_type.downcase}s.gdl
+  Purpose:  #{file_type.upcase} definitions
+
+  Author:   Generated #{Date.today.month}/#{Date.today.day}/#{Date.today.year}
+
+*************************************************************************** */
+
+// #{START_DEFS}
+
+// #{END_DEFS}
+
+
+// ++++++++++++++++++++++++ Upload Rule Definitions +++++++++++++++++++++++++
+
+ruleset z-#{file_type.downcase}-upload(continue)
+  rule z-#{file_type.downcase}-upload-#{file_type.downcase}s()
+    if(pLoanAmount != pLoanAmount)
+    then  // #{START_INITS}
+
+    end   // #{END_INITS}
+  end // rule
+end // ruleset z-#{file_type.downcase}-upload
+
+FILE_TEXT
+
+      raise IOError, "#{file_type.upcase} File already exists (#{file_path})" if ::File.exist?(file_path)
+
+      ::File.open(file_path, 'w') do |f|
+        f << text
+      end
+
+      $stdout << "#{file_type.upcase} file generated (#{file_path})\n" if verbose
+    end
+
+    private
+
+    def self.generation_tags_found(lines)
+      start_def = false
+      end_def = false
+      start_init = false
+      end_init = false
+
+      lines.each do |line|
+        start_def = true if line.include? START_DEFS
+        end_def = true if line.include? END_DEFS
+        start_init = true if line.include? START_INITS
+        end_init = true if line.include? END_INITS
+      end
+
+      return (start_def && end_def && start_init && end_init)
+    end
+
+    def self.id_exists_in_file?(id, lines, pattern)
+      lines.each do |line|
+        return true if match_found(id, line, pattern)
+      end
+      return false
+    end
+
+    def self.match_found(id, line, pattern)
+      line.match(pattern)
+      return false if Regexp.last_match.nil?
+      return true if id.downcase == Regexp.last_match[:id].downcase
+      false
+    end
+
+    def self.location_found(id, line, pattern)
+      line.match(pattern)
+      return false if Regexp.last_match.nil?
+      return true if id.downcase < Regexp.last_match[:id].downcase
+      false
+    end
+
+    def self.find_def_insert_index(id, lines, pattern)
+      start_i = lines.index { |line| line.include? START_DEFS }
+      end_i = lines.index { |line| line.include? END_DEFS }
+
+      i = lines[start_i..end_i].index do |line|
+        location_found(id, line, pattern)
+      end
+
+      return end_i if i.nil?
+      i + start_i
+    end
+
+    def self.find_def_delete_index(id, lines, pattern)
+      start_i = lines.index { |line| line.include? START_DEFS }
+      end_i = lines.index { |line| line.include? END_DEFS }
+
+      i = lines[start_i..end_i].index do |line|
+        match_found(id, line, pattern)
+      end
+
+      return nil if i.nil?
+      i + start_i
+    end
+
+    def self.find_init_insert_index(id, lines, pattern)
+      start_i = lines.index { |line| line.include? START_INITS }
+      end_i = lines.index { |line| line.include? END_INITS }
+
+      i = lines[start_i..end_i].index do |line|
+        location_found(id, line, pattern)
+      end
+
+      return end_i if i.nil?
+      i + start_i
+    end
+
+    def self.find_init_delete_index(id, lines, pattern)
+      start_i = lines.index { |line| line.include? START_INITS }
+      end_i = lines.index { |line| line.include? END_INITS }
+
+      i = lines[start_i..end_i].index do |line|
+        match_found(id, line, pattern)
+      end
+
+      return nil if i.nil?
+      i + start_i
+    end
+
+    def self.add_variable(type, id, name, def_pattern, init_pattern, var_file, dsm = false)
+      lines = ::File.new(var_file).readlines
+      raise InvalidFileFormat, "Missing generation tags (#{START_DEFS}, #{END_DEFS}, #{START_INITS}, #{END_INITS})" unless generation_tags_found(lines)
+      raise VariableExists, "ID '#{id}' already exists in file #{var_file}" if id_exists_in_file?(id, lines, def_pattern)
+
+      add_def = "    dpm #{type.downcase.ljust(12)}#{id.ljust(52)}\"#{name}\";\n"
+      add_def = "decision" + add_def if dsm
+      add_init = "      tempString  = #{id};\n"
+
+      insert_index = find_def_insert_index(id, lines, def_pattern)
+      lines.insert(insert_index, add_def)
+
+      insert_index = find_init_insert_index(id, lines, init_pattern)
+      lines.insert(insert_index, add_init)
+
+      ::File.open(var_file, 'w') do |f|
+        lines.each do |line|
+          f << line
+        end
+      end
+
+      $stdout << "'#{id}' successfully added to #{var_file}.\n" if verbose
+    end
+
+    def self.del_variable(id, def_pattern, init_pattern, var_file)
+      lines = ::File.new(var_file).readlines
+      raise InvalidFileFormat, "Missing generation tags (#{START_DEFS}, #{END_DEFS}, #{START_INITS}, #{END_INITS})" unless generation_tags_found(lines)
+      unless id_exists_in_file?(id, lines, def_pattern)
+        $stderr << "ID '#{id}' does not exist in file #{var_file}\n" if verbose
+        return
+      end
+
+      delete_index = find_def_delete_index(id, lines, def_pattern)
+      lines.delete_at(delete_index) unless delete_index.nil?
+
+      delete_index = find_init_delete_index(id, lines, init_pattern)
+      lines.delete_at(delete_index) unless delete_index.nil?
+
+      ::File.open(var_file, 'w') do |f|
+        lines.each do |line|
+          f << line
+        end
+      end
+
+      $stdout << "'#{id}' successfully deleted from #{var_file}.\n" if verbose
+    end
+  end
+end

data/lib/ams_var_file/version.rb

@@ -0,0 +1,3 @@
+module AmsVarFile
+  VERSION = "1.0.0"
+end

metadata

@@ -0,0 +1,130 @@
+--- !ruby/object:Gem::Specification
+name: ams_var_file
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Jeff McAffee
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2015-10-15 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+- !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: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry-byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Generate AMS variable declaration files and provide for adding and deleting
+  variables.
+email:
+- jeff@ktechsystems.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- ams_var_file.gemspec
+- bin/console
+- bin/setup
+- lib/ams_var_file.rb
+- lib/ams_var_file/file.rb
+- lib/ams_var_file/version.rb
+homepage: https://github.com/jmcaffee/ams_var_file
+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.3.0
+signing_key: 
+specification_version: 4
+summary: Generate AMS variable declaration files and provide for adding and deleting
+  variables.
+test_files: []
+has_rdoc: