uottawa_odesi_utils 0.0.2alpha

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 962c5f93167d6650ec0f2a0f1986a4b95663f12d
+  data.tar.gz: 1bc29f1c3e0620374f8aaed2d4bbaac4abf8dddc
+SHA512:
+  metadata.gz: 672efaee5d6fb0960914ff5b3894740c908fff19e9e3dc3d5d43a5939abfaa80fce46ba87ec461b4259eefe625f3a032c5f058fc2919f71d1bb52f6bbbaf4ea4
+  data.tar.gz: 9dfb978bca564e3ba876438e4bbf00b1ab7cb6fa17e7b045918febf8171406dc1ad7b51b07fbcf746bbca70dd7b5e004da412afd2cee2ab660421bd4b61d6a5f

data/.gitignore

@@ -0,0 +1,17 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log
+
+#I don't know yet if the xml of statcan is public or confidential
+spec/data/*xml

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2015 Guinsly Mondesir
+
+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,59 @@
+# UottawaOdesiUtils
+
+Ceci est une librairie pour agir en tant que Helper pour travailler avec les Documentations xml d'Odesi. Le logiciel SPPS va abrégé toutes les phrases qui ont une taille plus grande que  251 caractères. Le but de cette libraire est de rendre plus facile de faire la traduction des `<labl>` et des balises `<qstnLit>` en créant un hash des valeurs des balises. Ensuite je pourrai savoir quel `<labl>` sera écourté en examinant la taille totale de caractères contenu dans cette balise et utilisé une application comme Rails/sinatra pour faire la traduction ou pour modifier la pharse écourtée par SPSS.
+
+This is an utils library to work with DDI-xml. The purpose of this library is to ease the process of translating variable label in a document. This library will retrieve the `<labl>` and the `<qstnLit>` value of an IDD file and will also tell if the label.size is greater than 251 caracters, that will mean that it will be chopped in SPSS. So that it will be easy to create a json file, export it to a db for a Rails/Flask app. The python27 library can be found [here:pyodesi](http://www.github.com/guinslym)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'uottawa_odesi_utils'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install uottawa_odesi_utils
+
+## Usage
+
+Dealing with one Documentation file
+```ruby
+	content = retrieve_label_and_qstnlit('esg-cycle-xx.xml')
+	puts content
+	=> {:label=>"Lorem ipsum dolor sit amet, consectetur adipiscing elit.", 
+	:qstnLit=>"Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat.", 
+	:label_warning=>false, :variable_name=>"VARIABLE_000"}
+```
+
+Comparing two files
+```ruby
+	content = retrieve_label_and_qstnlit('esg-cycle-xx_fr.xml', 'gss-cycle-xx_en.xml')
+	#french file must be first
+	puts content
+	=> {
+	:label_fr=>"Lorem ipsum dolor sit amet, consectetur adipiscing elit.", 
+	:qstnLit_fr=>"Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat.", 
+	:label_warning_fr=>false, 
+	:variable_name=>"VARIABLE_000":label_en=>"Lorem ipsum dolor sit amet, consectetur adipiscing elit.", 
+	:qstnLit_en=>"Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat.", 
+	:label_warning_en=>false, 
+	:variable_name=>"VARIABLE_000"}
+```
+Now it's easier to create a web app so that I can view the English and the French translation side-by-side and make corrections if the translation is not good enough or if the label size is greater than 251 character
+
+##TODO
+Sinatra app to put the json in a DB
+
+## Contributing
+
+1. Fork it ( https://github.com/guinslym/uottawa_odesi_utils/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+

data/lib/uottawa_odesi_utils.rb

@@ -0,0 +1,76 @@
+require "uottawa_odesi_utils/version"
+require 'nokogiri'
+
+module UottawaOdesiUtils
+
+def self.retrieve_label_and_qstnlit(file)
+	l = -> (name) { Nokogiri::XML(File.open("#{name}")) }
+	doc = l.call(file)
+
+	sentences = doc.children.css('dataDscr').children.search('var')
+
+	node_found = []
+	sentences.each do |sentence|
+
+		x = -> (elem) {sentence.children.search("#{elem}")}
+		label = x.call('qstnLit')
+		qstnLit = x.call('labl')
+
+		if label.text.size > 0 and qstnLit.text.size > 0
+			label =  label.first.text.strip
+			qstnLit =  qstnLit.first.text.strip
+			label_warning = label.size > 251
+			tmp = {label: label, qstnLit: qstnLit, label_warning: label_warning,
+			 variable_name: sentence['name']}
+			node_found.push(tmp)
+		end
+	end
+	return node_found
+
+end
+
+def self.bilingual_files(xml_fr, xml_en)
+	l = -> (name) { Nokogiri::XML(File.open("#{name}")) }
+	doc = l.call(xml_fr)
+	doc_other = l.call(xml_en)
+  
+	sentences = doc.children.css('dataDscr').children.search('var')
+
+	idd_value = []
+	sentences.each do |sentence|
+
+		x = -> (elem) {sentence.children.search("#{elem}")}
+		label = x.call('labl')
+		qstnLit = x.call('qstnLit')
+
+		if label.text.size > 0 and qstnLit.text.size > 0
+			variable_name = sentence['name'] 
+			label_fr =  label.first.text.strip
+			qstnLit_fr =  qstnLit.first.text.strip
+			label_warning_fr = label_fr.size > 251
+
+			#other language
+			var =  doc_other.children.css("var[@name=#{variable_name}]")
+
+      #if this French Node is not Present in the English file, than I'll leave it blank
+      begin
+      	b = -> (elem) { var.children.search("#{elem}").first.text.strip }
+			  label_en= b.call('labl')
+			  qstnLit_en= b.call('qstnLit')
+			rescue
+			  label_en= ""
+			  qstnLit_en= ""
+			end
+
+			tmp = {variable_name: variable_name, label_en: label_en, qstnLit_en: qstnLit_en, 
+				label_warning_en: label_en.size > 251, label_fr: label_fr, qstnLit_fr: qstnLit_fr,
+				label_warning_fr: label_fr.size > 251}
+			#puts tmp
+			idd_value.push(tmp)
+		end
+	end
+	return idd_value
+
+  end#bilingual_files
+
+end#module

data/lib/uottawa_odesi_utils/version.rb

@@ -0,0 +1,3 @@
+module UottawaOdesiUtils
+  VERSION = "0.0.2alpha"
+end

data/spec/Uottawa_odesi_spec.rb

@@ -0,0 +1,30 @@
+require 'spec_helper'
+
+describe UottawaOdesiUtils do
+
+  # Crappy specs start here
+  describe ".IDD Documentation" do
+     let(:lines) { UottawaOdesiUtils.retrieve_label_and_qstnlit(Dir.pwd+'/spec/data/esg-c-25.xml')}
+     let(:b_lines) { UottawaOdesiUtils.bilingual_files(Dir.pwd+'/spec/data/gss-c-25.xml',
+                                                Dir.pwd+'/spec/data/esg-c-25.xml')}
+
+    it "expecting it to be at least 79" do
+      expect(lines.size).to be >= 79
+    end
+
+    it "expecting it to return an array" do
+      expect(lines).to be_instance_of Array
+    end
+
+    it "each element is a Hash" do
+      expect(lines.first).to be_instance_of Hash
+    end
+
+    it "both file will have at least 79 elements" do
+      expect(b_lines.size).to be >= 79
+    end
+
+  end
+
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,12 @@
+require 'uottawa_odesi_utils'
+
+RSpec.configure do |config|
+  # Use color in STDOUT
+  config.color = true
+
+  # Use color not only in STDOUT but also in pagers and files
+  config.tty = true
+
+  # Use the specified formatter
+  config.formatter = :documentation # :progress, :html, :textmate
+end

data/uottawa_odesi_utils.gemspec

@@ -0,0 +1,28 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'uottawa_odesi_utils/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "uottawa_odesi_utils"
+  spec.version       = UottawaOdesiUtils::VERSION
+  spec.authors       = ["Guinsly Mondesir"]
+  spec.email         = ["guinslym@gmail.com"]
+  spec.summary       = %q{A library to work with uottawa ddi xml file }
+  spec.description   = %q{Utils library for DDI file}
+  spec.homepage      = "https://github.com/guinslym/uottawa_odesi_utils"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.7"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency 'rspec', '~> 3.2', '>= 3.2.0'
+  spec.add_development_dependency 'nokogiri', '~> 1.6', '>= 1.6.6.2'
+  spec.add_development_dependency 'rspec-nc', '~> 0.2', '>= 0.2.0'
+  spec.add_development_dependency 'guard', '~> 2.12', '>= 2.12.4'
+  spec.add_development_dependency 'guard-rspec', '~> 4.5', '>= 4.5.0'
+end

metadata

@@ -0,0 +1,185 @@
+--- !ruby/object:Gem::Specification
+name: uottawa_odesi_utils
+version: !ruby/object:Gem::Version
+  version: 0.0.2alpha
+platform: ruby
+authors:
+- Guinsly Mondesir
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-03-08 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !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: '3.2'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.2.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.2'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.2.0
+- !ruby/object:Gem::Dependency
+  name: nokogiri
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.6.6.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.6.6.2
+- !ruby/object:Gem::Dependency
+  name: rspec-nc
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.2'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.2.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.2'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.2.0
+- !ruby/object:Gem::Dependency
+  name: guard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.12'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.12.4
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.12'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.12.4
+- !ruby/object:Gem::Dependency
+  name: guard-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.5'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.5.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.5'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.5.0
+description: Utils library for DDI file
+email:
+- guinslym@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/uottawa_odesi_utils.rb
+- lib/uottawa_odesi_utils/version.rb
+- spec/Uottawa_odesi_spec.rb
+- spec/spec_helper.rb
+- uottawa_odesi_utils.gemspec
+homepage: https://github.com/guinslym/uottawa_odesi_utils
+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: 1.3.1
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: A library to work with uottawa ddi xml file
+test_files:
+- spec/Uottawa_odesi_spec.rb
+- spec/spec_helper.rb
+has_rdoc: