normalizexml 0.1.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 9e27d1f6df9f44b6874f8dae18328645a1f33c02
+  data.tar.gz: c33a09275fe1627adc3f459beaf7369b869eb34e
+SHA512:
+  metadata.gz: e70949817d4a696079f3e0bca2549726c07406a0ce9f213b26b4d116e7ff8c289ba1601c446bc35d6087271eec57a8380d44d06137d130edb1eeb8e2f61cc65d
+  data.tar.gz: f3e1ce52dc9009fcb2b270be855701c9ed32ca76d5debcc00eae2ac8a31e492b8cfc361960a3fd560c06589616b1ce3bd0ae852dabb37fe9a03ed5fd77b3fc0c

data/.gitignore

@@ -0,0 +1,7 @@
+# .gitignore
+/buildgem
+/buildgem.cmd
+pkg/
+tmp/
+
+Gemfile.lock

data/.rspec

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

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+gem 'ktcommon', :git => 'ssh://git@bitbucket.org/ktechsystems/ktcommon.git'
+
+# Specify your gem's dependencies in test.gemspec
+gemspec

data/LICENSE

@@ -0,0 +1,22 @@
+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,59 @@
+# NormalizeXml
+
+## Summary
+
+NormalizeXml is used to 'normalize' AMS guideline xml so different
+versions can be easily compared.
+
+As part of normalization, all `id`s are zero'd as well as `order`
+attributes. XML is also pretty-printed.
+
+## Installation
+
+Add this line to your gemfile:
+
+    gem 'normalizexml'
+
+And then execute:
+
+    $ bundle install
+
+or install it yourself as:
+
+    $ gem install normalizexml
+
+## Usage
+
+TODO
+
+## Testing
+
+NormalizeXml uses RSpec for testing.
+
+To run all existing tests:
+
+    $ rake spec
+
+or directly:
+
+    $ bundle exec rspec
+
+## TODO
+
+## Contributing
+
+1. Fork it ( https://github.com/jmcaffee/normalizexml/fork )
+1. Clone it (`git clone git@github.com:[my-github-username]/normalizexml.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
+
+NormalizeXml is licensed under the MIT license.
+
+See [LICENSE](https://github.com/jmcaffee/normalizexml/blob/master/LICENSE) for
+details.
+

data/bin/normalizexml

@@ -0,0 +1,121 @@
+#!/usr/bin/env ruby
+###! C:/tools/Ruby/bin/ruby.exe
+##############################################################################
+# File:: normalizexml.rb
+# Purpose:: Utility to ...
+# 
+# Author::    Jeff McAffee 09/03/2010
+# Copyright:: Copyright (c) 2010, kTech Systems LLC. All rights reserved.
+# Website::   http://ktechsystems.com
+##############################################################################
+
+require 'normalizexml'
+require 'user-choices'
+
+
+class NormalizeXmlApp < UserChoices::Command
+    include UserChoices
+	include NormalizeXml
+    
+    def initialize()
+        super
+        @controller = Controller.new
+    end
+    
+    
+    def add_sources(builder)
+        builder.add_source(CommandLineSource, :usage,
+                            "Usage: #{$0} [options] INPUT_XML {OUTPUT_FILE}",
+                            "Normalize an XML file",
+                            "INPUT_XML   - file to normalize",
+														"OUTPUT_FILE - (optional) filename of output file\n")
+    end # def add_sources
+    
+    
+    def add_choices(builder)
+				# Arguments
+        #builder.add_choice(:cmdArg, :length=>1) { |command_line|   # Use length to REQUIRE args.
+        builder.add_choice(:cmdArg) { |command_line|
+            command_line.uses_arglist
+        }
+        
+        # Switches
+        builder.add_choice(:verbose, :type=>:boolean, :default=>false) { |command_line|
+            command_line.uses_switch("-v", "--verbose",
+                                    "Verbose output.")
+        }
+
+=begin
+        builder.add_choice(:aswitch, :type=>:boolean, :default=>false) { |command_line|
+            command_line.uses_switch("-a", "--aswitch",
+                                    "Switch description.")
+        }
+        
+        # Options
+        builder.add_choice(:option, :type=>:string) { |command_line|
+            command_line.uses_option("-o", "--option ARG",
+                                    "Option description.")
+        }
+=end        
+        
+    end # def add_choices
+    
+    # This method is called automatically by UserChoices.
+	# Use it to handle simple post processing of user choices.
+	def postprocess_user_choices
+		@user_choices[:infile] = @user_choices[:cmdArg][0]
+		@user_choices[:outfile] = @user_choices[:cmdArg][1]
+	end
+	
+	
+    # Execute the NormalizeXml application.
+    # This method is called automatically when 'normalizexml(.rb)' is executed from the command line.
+    def execute
+      $LOG.debug "NormalizeXmlApp::execute"
+
+			if(@user_choices[:verbose])
+        @controller.verbose(@user_choices[:verbose])
+      end
+      
+=begin
+      if(@user_choices[:aswitch])
+        @controller.doSomethingWithSwitch(@user_choices[:aswitch])
+        return
+      end
+=end      
+      if(@user_choices[:cmdArg].empty?) # If no cmd line arg...
+        #return unless @controller.noCmdLineArg()
+        @controller.noCmdLineArg()
+			else
+				#return unless @controller.doSomethingWithCmdLineArg(@user_choices[:cmdArg])
+				@controller.doSomethingWithCmdLineArg(@user_choices[:cmdArg])
+			end
+				
+			@controller.infile 	= @user_choices[:infile] unless @user_choices[:infile].nil? || @user_choices[:infile].empty?
+			@controller.outfile = @user_choices[:outfile] unless @user_choices[:outfile].nil? || @user_choices[:outfile].empty?
+			@controller.normalize()
+		end # def execute
+        
+    
+end # class NormalizeXmlApp
+
+
+# Uncomment the next line if this file can be both loaded via 'require' AND called from the command line.
+# This technique does NOT work if the app is running as a gem.
+#if $0 == __FILE__
+	begin
+		NormalizeXmlApp.new.execute
+	rescue SystemExit
+		
+	rescue Exception => e
+		puts "!!! ERROR:"
+		puts "\t" + e.message
+		puts
+		puts "Try -h for help."
+		puts
+		#exit if !$LOGGING
+		puts "Exception type: #{e.class.to_s}"
+		puts e.backtrace
+		puts
+	end	
+#end    

data/docs/README.CODE.txt

@@ -0,0 +1,21 @@
+========================================================================
+= File: 	README.CODE.txt
+= Purpose: 	Instructions and hints for customizing NormalizeXml.
+=
+= Generated:	09/03/2010
+= Copyright: 	Copyright (c) 2010, kTech Systems LLC. All rights reserved.
+= Website:   	http://ktechsystems.com
+========================================================================
+
+CUSTOMIZING YOUR CODE:
+
+	You should add all of your data functionality to the Parser
+	object that has been created for you in lib/parser.rb.
+	
+	To modify command line arguments, you should edit bin/normalizexml.rb
+	and lib/normalizexmlcontroller.rb
+	
+	Add or modify configuration values by editing lib/normalizexmlcfg.rb.
+	
+	
+	

data/lib/normalizexml.rb

@@ -0,0 +1,58 @@
+##############################################################################
+# File:: normalizexml.rb
+# Purpose:: Include file for NormalizeXml library
+# 
+# Author::    Jeff McAffee 09/03/2010
+# Copyright:: Copyright (c) 2010, kTech Systems LLC. All rights reserved.
+# Website::   http://ktechsystems.com
+##############################################################################
+
+require 'find'
+require 'logger'
+require 'bundler/setup'
+
+
+if(!$LOG)
+  $LOG = Logger.new(STDERR)
+  $LOG.level = Logger::ERROR
+end
+
+if ENV["DEBUG"] == '1'
+  puts "LOGGING: ON due to DEBUG=1"
+  $LOG.level = Logger::DEBUG
+end
+
+$LOGGING = false
+# Uncomment line below to force logging:
+#$LOGGING = true   # TODO: Change this flag to false when releasing production build.
+
+require "#{File.join( File.dirname(__FILE__), 'normalizexml','version')}"
+require "#{File.join( File.dirname(__FILE__), 'normalizexml','config')}"
+
+logcfg = NormalizeXml::Config.new.load
+if(logcfg.key?(:logging) && (true == logcfg[:logging]) )
+  $LOGGING = true 
+end
+
+if($LOGGING)
+  # Create a new log file each time:
+  file = File.open('normalizexml.log', File::WRONLY | File::APPEND | File::CREAT | File::TRUNC)
+  $LOG = Logger.new(file)
+  $LOG.level = Logger::DEBUG
+  #$LOG.level = Logger::INFO
+else
+  if(File.exists?('normalizexml.log'))
+FileUtils.rm('normalizexml.log')
+end
+end
+$LOG.info "**********************************************************************"
+$LOG.info "Logging started for NormalizeXml library."
+$LOG.info "**********************************************************************"
+
+
+class_files = File.join( File.dirname(__FILE__), 'normalizexml', '*.rb')
+$: << File.join( File.dirname(__FILE__), 'normalizexml')  # Add directory to the include file array.
+Dir.glob(class_files) do | class_file |
+    require class_file[/\w+\.rb$/]
+end
+

data/lib/normalizexml/config.rb

@@ -0,0 +1,93 @@
+##############################################################################
+# File:: normalizexmlcfg.rb
+# Purpose:: NormalizeXml configuration file reader/writer class.
+#
+# Author::    Jeff McAffee 09/03/2010
+# Copyright:: Copyright (c) 2010, kTech Systems LLC. All rights reserved.
+# Website::   http://ktechsystems.com
+##############################################################################
+
+require 'ktcommon/ktcfg'
+
+##############################################################################
+# Everything is contained in Module NormalizeXml
+module NormalizeXml
+
+  class Config < KtCfg::CfgFile
+
+  attr_accessor :cfg
+  attr_writer   :cfgFile
+
+
+    def initialize(rootDir=nil)
+      $LOG.debug "Config::initialize"
+      super
+      @cfg = {}
+
+      setDefaults()
+    end
+
+
+    def setDefaults
+      $LOG.debug "Config::setDefaults"
+
+      # Notes about APPDATA paths:
+      # Local app data should be used when an app's data is too
+      # big to move around. Or is specific to the machine running
+      # the application.
+      #
+      # Roaming app data files could be pushed to a server (in a
+      # domain environment) and downloaded onto a different work
+      # station.
+      #
+      # LocalLow is used for data that must be sandboxed. Currently
+      # it is only used by IE for addons and storing data from
+      # untrusted sources (as far as I know).
+      #
+
+
+      appDataPath = ENV["APPDATA"]          # APPDATA returns AppData\Roaming on Vista/W7
+      appDataPath ||= ENV["HOME"]          # APPDATA returns AppData\Roaming on Vista/W7
+      #appDataPath = ENV["LOCALAPPDATA"]        # LOCALAPPDATA returns AppData\Local on Vista/W7
+      appDataPath = File.rubypath(File.join(appDataPath, "normalizexml"))
+      @cfg[:appPath] = appDataPath
+      @cfg[:version]  = NormalizeXml::VERSION
+      @cfg[:logging]  = false
+
+      @cfgFile = "normalizexml.yml"
+
+      # Set the config file path. Default is the 'global' one in APPDATA.
+      if( @rootDir.nil? )
+        @rootDir = appDataPath
+        @cfgFile = "config.yml"
+
+        # Override the gobal config if there is a local (current working dir) version.
+        if(File.exists?(File.join(FileUtils.pwd(), "normalizexml.yml")))
+          @rootDir = FileUtils.pwd()
+          @cfgFile = "normalizexml.yml"
+        end
+      end
+    end
+
+
+    # Load the YAML configuration file.
+    # returns:: a hash containing configuration info.
+    def load
+      $LOG.debug "Config::load"
+      tmpCfg = read(@cfgFile)
+      @cfg = tmpCfg if !tmpCfg.nil? && !tmpCfg.empty?
+      @cfg
+    end
+
+
+    # Save the @cfg hash to a YAML file.
+    def save
+      $LOG.debug "Config::save"
+      write(@cfgFile, @cfg)
+    end
+
+
+  end # class Config
+
+
+end # module NormalizeXml

data/lib/normalizexml/controller.rb

@@ -0,0 +1,83 @@
+##############################################################################
+# File:: controller.rb
+# Purpose:: Main Controller object for NormalizeXml utility
+# 
+# Author::    Jeff McAffee 09/03/2010
+# Copyright:: Copyright (c) 2010, kTech Systems LLC. All rights reserved.
+# Website::   http://ktechsystems.com
+##############################################################################
+
+require 'ktcommon/ktpath'
+require 'ktcommon/ktcmdline'
+
+##############################################################################
+# Everything is contained in Module	NormalizeXml
+module NormalizeXml
+	  
+	class Controller
+
+	attr_accessor 	:someFlag
+	attr_accessor 	:model
+	attr_reader 	:verbose
+		
+		def initialize()
+			$LOG.debug "Controller::initialize"
+			@cfg 			= Config.new.load
+			@someFlag 		= false
+			@model 			= Parser.new
+			@model.verbose 	= false
+		end
+		  
+
+		def verbose(arg)
+			$LOG.debug "Controller::verbose( #{arg} )"
+			puts "Verbose mode: #{arg.to_s}" if @verbose || arg
+			@model.verbose = arg
+		end
+		  
+	  
+		def verbose=(arg)
+			$LOG.debug "Controller::verbose=( #{arg} )"
+			return verbose(arg)
+		end
+		  
+	  
+		def infile=(infile)
+			@model.infile = infile
+		end
+		
+		
+		def outfile=(outfile)
+			@model.outfile = outfile
+		end
+		
+		
+		def doSomethingWithSwitch(arg)
+			$LOG.debug "Controller::doSomethingWithSwitch( #{arg} )"
+		end
+			  
+		  
+		def doSomethingWithCmdLineArg(arg)
+			$LOG.debug "Controller::doSomethingWithCmdLineArg( #{arg} )"
+			#raise ArgumentError.new("Unexpected argument: #{arg}")
+			return true		# I want cmd line args
+		end
+			  
+		  
+		def noCmdLineArg()
+			$LOG.debug "Controller::noCmdLineArg"
+			raise ArgumentError.new("Argument expected.")
+			return false			# No arg, no worky.
+		end
+
+		  
+		def normalize()
+			$LOG.debug "Controller::normalize"
+			@model.normalize()
+		end
+		  
+	  
+	end # class Controller
+
+
+end # module NormalizeXml