xforms 0.0.1

data/.gitignore

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

data/.rbenv-version

@@ -0,0 +1 @@
+1.9.3

data/.rspec

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

data/Gemfile

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

data/Rakefile

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

data/lib/xforms/control.rb

@@ -0,0 +1,94 @@
+module XForms
+
+  class ::Object
+    def dyn_value; self; end
+  end
+
+  class XPathRef
+    attr_accessor :form
+    attr_accessor :path
+
+    def initialize(form, path)
+      @form = form
+      @path = path
+    end
+
+    def dyn_value
+      form.model_instance.xpath(path, form.namespaces, self)
+    end
+
+    def itext id
+      form.itext[I18n.locale.to_s][id] || ''
+    end
+  end
+
+  module Label
+    attr_accessor :label
+
+    def label
+      @label.dyn_value
+    end
+  end
+
+  class Control
+    attr_accessor :form
+    attr_accessor :binding
+    attr_accessor :readonly
+    attr_accessor :constraint
+    attr_accessor :constraint_message
+    attr_accessor :relevant
+    include Label
+
+    def initialize(form)
+      @form = form
+      @readonly = false
+    end
+
+    def value=(value)
+      form.model_instance.xpath(binding).first.children = value
+    end
+
+    def value
+      form.model_instance.xpath(binding).first.inner_text
+    end
+
+    def readonly
+      @readonly.dyn_value
+    end
+
+    def valid?
+      return true unless constraint
+      node = form.model_instance.xpath(binding).first
+      node.xpath(constraint) == true
+    end
+
+    def relevant?
+      return true unless @relevant
+      @relevant.dyn_value
+    end
+  end
+
+  class Input < Control
+  end
+
+  class Select1 < Control
+    attr_accessor :items
+
+    def initialize(form)
+      super
+      @items = []
+    end
+  end
+
+  class Item
+    attr_accessor :form
+    attr_accessor :value
+    include Label
+
+    def initialize(form, label = nil, value = nil)
+      @form = form
+      @label = label
+      @value = value
+    end
+  end
+end

data/lib/xforms/form.rb

@@ -0,0 +1,23 @@
+module XForms
+  class Form
+    attr_accessor :model_instance
+    attr_accessor :itext
+    attr_accessor :controls
+    attr_accessor :namespaces
+
+    def initialize
+      @controls = []
+      @namespaces = {}
+    end
+
+    def self.parse_file(path)
+      File.open(path, 'r') do |f|
+        parse f
+      end
+    end
+
+    def self.parse(input)
+      FormParser.new(input).parse
+    end
+  end
+end

data/lib/xforms/form_parser.rb

@@ -0,0 +1,162 @@
+require 'nokogiri'
+
+module XForms
+  class FormParser
+    XFORMS_NS = 'http://www.w3.org/2002/xforms'
+
+    def initialize(input)
+      @reader = Nokogiri::XML::Reader(input)
+      @form = Form.new
+      @bindings = {}
+    end
+
+    def parse
+      while read
+        if is_xforms_element?
+          parse_xforms_element
+        end
+      end
+      @form
+    end
+
+    private
+
+    def parse_xforms_element
+      case @reader.local_name
+      when 'model' then parse_model
+      when 'input' then parse_input
+      when 'select1' then parse_select1
+      end
+    end
+
+    def parse_model
+      read_descendants do
+        if is_xforms_element? 'instance'
+          @form.model_instance = Nokogiri::XML(@reader.inner_xml)
+        elsif is_xforms_element? 'bind'
+          parse_bind
+        elsif is_element? 'itext'
+          parse_itext
+        end
+      end
+    end
+
+    def parse_bind
+      @bindings[@reader.attribute('id')] = {
+        :nodeset => @reader.attribute('nodeset'),
+        :readonly => @reader.attribute('readonly'),
+        :constraint => @reader.attribute('constraint'),
+        :constraint_message => @reader.attribute("#{jr_prefix}:constraintMsg"),
+        :relevant => @reader.attribute('relevant')
+      }
+    end
+
+    def jr_prefix
+      ns = @form.namespaces.key('http://openrosa.org/javarosa')
+      ns.split(':').last if ns
+    end
+
+    def parse_input
+      parse_control XForms::Input
+    end
+
+    def parse_select1
+      parse_control XForms::Select1 do |select1|
+        if is_xforms_element? 'item'
+          select1.items << parse_item
+        end
+      end
+    end
+
+    def parse_item
+      item = XForms::Item.new @form
+      read_descendants do
+        if is_xforms_element? 'label'
+          item.label = parse_label
+        elsif is_xforms_element? 'value'
+          item.value = read_inner_text
+        end
+      end
+      item
+    end
+
+    def parse_control type
+      @form.controls << control = type.new(@form)
+
+      if ref = @reader.attribute('ref')
+        control.binding = ref
+      elsif bind = @reader.attribute('bind')
+        binding = @bindings[bind]
+        control.binding = binding[:nodeset]
+        control.readonly = XPathRef.new(@form, binding[:readonly]) if binding[:readonly]
+        control.constraint = binding[:constraint]
+        control.constraint_message = binding[:constraint_message]
+        control.relevant = XPathRef.new(@form, binding[:relevant]) if binding[:relevant]
+      end
+
+      read_descendants do
+        if is_xforms_element? 'label'
+          control.label = parse_label
+        elsif block_given?
+          yield control
+        end
+      end
+    end
+
+    def parse_label
+      if @reader.attribute('ref')
+        XPathRef.new @form, @reader.attribute('ref')
+      else
+        read_inner_text
+      end
+    end
+
+    def parse_itext
+      @form.itext = Hash.new { |h,k| h[k] = Hash.new { |h,k| h[k] = {} } }
+      read_descendants do
+        if is_element? 'translation'
+          lang = @reader.attribute('lang')
+          read_descendants do
+            if is_element? 'text'
+              id = @reader.attribute('id')
+              read_descendants do
+                @form.itext[lang][id] = read_inner_text if is_element? 'value'
+              end
+            end
+          end
+        end
+      end
+    end
+
+    def read
+      node = @reader.read
+      @form.namespaces.merge! node.namespaces if node
+      node
+    end
+
+    def read_inner_text
+      read_descendants do
+        if @reader.node_type == Nokogiri::XML::Reader::TYPE_TEXT
+          return @reader.value
+        end
+      end
+    end
+
+    def read_descendants
+      unless @reader.self_closing?
+        current_depth = @reader.depth
+        while read && @reader.depth > current_depth
+          yield
+        end
+      end
+    end
+
+    def is_element?(name, ns = nil)
+      @reader.node_type == Nokogiri::XML::Reader::TYPE_ELEMENT && @reader.namespace_uri == ns && (name.nil? || @reader.local_name == name)
+    end
+
+    def is_xforms_element?(name = nil)
+      is_element? name, XFORMS_NS
+    end
+  end
+end

data/lib/xforms/version.rb

@@ -0,0 +1,3 @@
+module XForms
+  VERSION = "0.0.1"
+end

data/lib/xforms.rb

@@ -0,0 +1,10 @@
+require "xforms/control"
+require "xforms/form"
+require "xforms/form_parser"
+require "xforms/version"
+require 'nokogiri'
+require 'i18n'
+
+module XForms
+  # Your code goes here...
+end

data/spec/data/xform1.xml

@@ -0,0 +1,52 @@
+<?xml version='1.0' encoding='utf-8'?>
+<xform xmlns:xf="http://www.w3.org/2002/xforms" xmlns:x="http://tempuri.org/" xmlns:jr="http://openrosa.org/javarosa">
+  <xf:model>
+    <xf:instance>
+      <x:data>
+        <x:foo>123</x:foo>
+        <x:bar />
+        <x:baz />
+      </x:data>
+    </xf:instance>
+
+    <xf:bind id="bind1" nodeset="x:data/x:baz" constraint=". &lt; 10" jr:constraintMsg="Error Message" />
+    <xf:bind id="bind2" nodeset="x:data/x:foo" readonly="true()" />
+    <xf:bind id="bind3" nodeset="x:data/x:bar" relevant="/x:data/x:foo = 321" />
+  </xf:model>
+
+  <xf:input ref="x:data/x:foo">
+    <xf:label>Foo</xf:label>
+  </xf:input>
+
+  <xf:select1 ref="x:data/x:bar">
+    <xf:label>Bar</xf:label>
+    <xf:item>
+      <xf:label>Item1</xf:label>
+      <xf:value>1</xf:value>
+    </xf:item>
+    <xf:item>
+      <xf:label>Item2</xf:label>
+      <xf:value>2</xf:value>
+    </xf:item>
+  </xf:select1>
+
+  <xf:input bind="bind1" />
+
+  <xf:select1>
+    <xf:item />
+    <xf:label>Baz</xf:label>
+  </xf:select1>
+
+  <xf:upload>
+    <xf:label>...</xf:label>
+  </xf:upload>
+
+  <xf:select>
+    <xf:item />
+  </xf:select>
+
+  <xf:input bind="bind2" />
+
+  <xf:input bind="bind3" />
+
+</xform>

data/spec/data/xform_itext.xml

@@ -0,0 +1,40 @@
+<?xml version='1.0' encoding='utf-8'?>
+<xform xmlns:xf="http://www.w3.org/2002/xforms" xmlns:x="http://tempuri.org/" xmlns:jr="http://openrosa.org/javarosa">
+  <xf:model>
+    <xf:instance>
+      <x:data />
+    </xf:instance>
+
+    <itext>
+      <translation lang="es" lang-name="Español">
+        <text id="text_id">
+          <value>Texto</value>
+        </text>
+        <text id="empty">
+          <value></value>
+        </text>
+      </translation>
+      <translation lang="en" lang-name="Español">
+        <text id="text_id">
+          <value>Texto</value>
+        </text>
+      </translation>
+    </itext>
+  </xf:model>
+
+  <xf:input>
+    <xf:label ref="jr:itext('text_id')" />
+  </xf:input>
+
+  <xf:select1>
+    <xf:item>
+      <xf:label ref="jr:itext('text_id')" />
+      <xf:value>1</xf:value>
+    </xf:item>
+  </xf:select1>
+
+  <xf:input>
+    <xf:label ref="jr:itext('empty')" />
+  </xf:input>
+
+</xform>

data/spec/form_itext_spec.rb

@@ -0,0 +1,19 @@
+describe "iText" do
+
+  let(:xform1_path) { File.expand_path '../data/xform_itext.xml', __FILE__ }
+  let(:form) { XForms::Form.parse_file xform1_path }
+  before(:each) { I18n.locale = :es }
+
+  it "gets label from itext" do
+    form.controls[0].label.should == 'Texto'
+  end
+
+  it "gets label from itext for item" do
+    form.controls[1].items.first.label.should == 'Texto'
+  end
+
+  it "gets label from empty itext" do
+    form.controls[2].label.should == ''
+  end
+
+end

data/spec/form_spec.rb

@@ -0,0 +1,103 @@
+require 'spec_helper'
+require 'xforms'
+require 'stringio'
+
+describe "Form" do
+
+  let(:xform1_path) { File.expand_path '../data/xform1.xml', __FILE__ }
+  let(:form) { XForms::Form.parse_file xform1_path }
+  let(:input) { form.controls[0] }
+  let(:select1) { form.controls[1] }
+  let(:model) { form.model_instance }
+
+  it "parse model instance" do
+    model.root.name.should == 'data'
+  end
+
+  it "parse from string" do
+    form = XForms::Form.parse File.read(xform1_path)
+    form.model_instance.root.name.should == 'data'
+  end
+
+  it "parse from IO" do
+    form = XForms::Form.parse StringIO.new(File.read(xform1_path))
+    form.model_instance.root.name.should == 'data'
+  end
+
+  it "parses input" do
+    input.should be_a(XForms::Input)
+    input.label.should == 'Foo'
+  end
+
+  it "parses select1" do
+    select1.should be_a(XForms::Select1)
+    select1.label.should == 'Bar'
+    select1.items[0].label.should == 'Item1'
+    select1.items[0].value.should == '1'
+    select1.items[1].label.should == 'Item2'
+    select1.items[1].value.should == '2'
+  end
+
+  it "set label correctly after empty element" do
+    form.controls[3].label.should == 'Baz'
+  end
+
+  it "set input value" do
+    input.value = 'something'
+    model.xpath('x:data/x:foo').inner_text.should == 'something'
+  end
+
+  it "get input value" do
+    input.value.should == '123'
+  end
+
+  it "set select value" do
+    select1.value = '1'
+    model.xpath('x:data/x:bar').inner_text.should == '1'
+  end
+
+  it "uses binding for third control" do
+    form.controls[2].value = 'something_else'
+    model.xpath('x:data/x:baz').inner_text.should == 'something_else'
+  end
+
+  it "parse readonly" do
+    form.controls[4].readonly.should == true
+  end
+
+  it "readonly is false by default" do
+    form.controls[2].readonly.should == false
+  end
+
+  it "reject invalid value" do
+    form.controls[2].value = '55'
+    form.controls[2].should_not be_valid
+  end
+
+  it "accept valid value" do
+    form.controls[2].value = '5'
+    form.controls[2].should be_valid
+  end
+
+  it "field without constraint is always valid" do
+    form.controls[0].should be_valid
+  end
+
+  it "field with constraint message" do
+    form.controls[2].constraint_message.should == 'Error Message'
+  end
+
+  it "irrelevant field" do
+    form.controls[5].should_not be_relevant
+  end
+
+  it "relevant field" do
+    form.controls[0].value = '321'
+    form.controls[5].should be_relevant
+  end
+
+  it "is relevant if no condition is specified" do
+    form.controls[0].should be_relevant
+  end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,11 @@
+# This file was generated by the `rspec --init` command. Conventionally, all
+# specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.
+# Require this file using `require "spec_helper.rb"` to ensure that it is only
+# loaded once.
+#
+# See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
+RSpec.configure do |config|
+  config.treat_symbols_as_metadata_keys_with_true_values = true
+  config.run_all_when_everything_filtered = true
+  config.filter_run :focus
+end

data/xforms.gemspec

@@ -0,0 +1,25 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "xforms/version"
+
+Gem::Specification.new do |s|
+  s.name        = "xforms"
+  s.version     = XForms::VERSION
+  s.authors     = ["Juan Wajnerman", "Ary Borenszweig"]
+  s.email       = ["jwajnerman@manas.com.ar", "aborenszweig@manas.com.ar"]
+  s.homepage    = ""
+  s.summary     = %q{XForms 1.1 implementation}
+  s.description = %q{This gem can be used to parse and fill XForms 1.1}
+
+  s.rubyforge_project = "xforms"
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+
+  # specify any dependencies here; for example:
+  s.add_development_dependency "rspec"
+  s.add_runtime_dependency "nokogiri"
+  s.add_runtime_dependency "i18n"
+end

metadata

@@ -0,0 +1,101 @@
+--- !ruby/object:Gem::Specification
+name: xforms
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Juan Wajnerman
+- Ary Borenszweig
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-02-17 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: &70165811338460 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70165811338460
+- !ruby/object:Gem::Dependency
+  name: nokogiri
+  requirement: &70165811337980 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *70165811337980
+- !ruby/object:Gem::Dependency
+  name: i18n
+  requirement: &70165811337360 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *70165811337360
+description: This gem can be used to parse and fill XForms 1.1
+email:
+- jwajnerman@manas.com.ar
+- aborenszweig@manas.com.ar
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rbenv-version
+- .rspec
+- Gemfile
+- Rakefile
+- lib/xforms.rb
+- lib/xforms/control.rb
+- lib/xforms/form.rb
+- lib/xforms/form_parser.rb
+- lib/xforms/version.rb
+- spec/data/xform1.xml
+- spec/data/xform_itext.xml
+- spec/form_itext_spec.rb
+- spec/form_spec.rb
+- spec/spec_helper.rb
+- xforms.gemspec
+homepage: ''
+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: xforms
+rubygems_version: 1.8.10
+signing_key: 
+specification_version: 3
+summary: XForms 1.1 implementation
+test_files:
+- spec/data/xform1.xml
+- spec/data/xform_itext.xml
+- spec/form_itext_spec.rb
+- spec/form_spec.rb
+- spec/spec_helper.rb