cml 1.4.2

data/.document

@@ -0,0 +1,5 @@
+README.rdoc
+lib/**/*.rb
+bin/*
+features/**/*.feature
+LICENSE

data/.gitignore

@@ -0,0 +1,5 @@
+*.sw?
+.DS_Store
+coverage
+rdoc
+pkg

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 Chris Van Pelt
+
+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.rdoc

@@ -0,0 +1,18 @@
+= cml
+
+Description goes here.
+
+== Note on Patches/Pull Requests
+ 
+* Fork the project.
+* Make your feature addition or bug fix.
+* Add tests for it. This is important so I don't break it in a
+  future version unintentionally.
+* Commit, do not mess with rakefile, version, or history.
+  (if you want to have your own version, that is fine but
+   bump version in a commit by itself I can ignore when I pull)
+* Send me a pull request. Bonus points for topic branches.
+
+== Copyright
+
+Copyright (c) 2009 Chris Van Pelt. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,56 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "cml"
+    gem.summary = "CML is CrowdFlower Markup Language"
+    gem.description = "CML let's you easily create form elements and custom interfaces for the CrowdFlower Croud Labor platform"
+    gem.email = "vanpelt@doloreslabs.com"
+    gem.homepage = "http://github.com/dolores/cml"
+    gem.authors = ["Chris Van Pelt"]
+    gem.add_dependency 'liquid', '>= 2.0.0'
+    gem.add_dependency 'nokogiri', '>= 1.4.2'
+    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
+  end
+
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: sudo gem install jeweler"
+end
+
+require 'spec/rake/spectask'
+Spec::Rake::SpecTask.new(:spec) do |spec|
+  spec.libs << 'lib' << 'spec'
+  spec.spec_opts = ["--format", "specdoc"]
+  spec.spec_files = FileList['spec/**/*_spec.rb']
+end
+
+Spec::Rake::SpecTask.new(:rcov) do |spec|
+  spec.libs << 'lib' << 'spec'
+  spec.pattern = 'spec/**/*_spec.rb'
+  spec.rcov = true
+end
+
+task :refresh_builder => [:build] do
+  cp "pkg/cml-#{File.read("VERSION").strip}.gem", "../builder/gems/cache/"
+  rm_rf "../builder/gems/gems/cml-#{File.read("VERSION").strip}/"
+  `cd ../builder && bin/thor merb:gem:redeploy`
+end
+
+task :default => :spec
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  if File.exist?('VERSION.yml')
+    config = YAML.load(File.read('VERSION.yml'))
+    version = "#{config[:major]}.#{config[:minor]}.#{config[:patch]}"
+  else
+    version = ""
+  end
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "cml #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+1.4.1

data/cml.gemspec

@@ -0,0 +1,129 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE
+# Instead, edit Jeweler::Tasks in Rakefile, and run `rake gemspec`
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{cml}
+  s.version = "1.4.2"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Chris Van Pelt"]
+  s.date = %q{2011-02-28}
+  s.description = %q{CML let's you easily create form elements and custom interfaces for the CrowdFlower Croud Labor platform}
+  s.email = %q{vanpelt@doloreslabs.com}
+  s.extra_rdoc_files = [
+    "LICENSE",
+     "README.rdoc"
+  ]
+  s.files = [
+    ".document",
+     ".gitignore",
+     "LICENSE",
+     "README.rdoc",
+     "Rakefile",
+     "VERSION",
+     "cml.gemspec",
+     "lib/cml.rb",
+     "lib/cml/converters/jsawesome.rb",
+     "lib/cml/gold.rb",
+     "lib/cml/liquid_filters.rb",
+     "lib/cml/parser.rb",
+     "lib/cml/tag.rb",
+     "lib/cml/tags/checkbox.rb",
+     "lib/cml/tags/checkboxes.rb",
+     "lib/cml/tags/group.rb",
+     "lib/cml/tags/hidden.rb",
+     "lib/cml/tags/iterate.rb",
+     "lib/cml/tags/meta.rb",
+     "lib/cml/tags/multiple_text.rb",
+     "lib/cml/tags/option.rb",
+     "lib/cml/tags/radio.rb",
+     "lib/cml/tags/radios.rb",
+     "lib/cml/tags/ratings.rb",
+     "lib/cml/tags/search.rb",
+     "lib/cml/tags/select.rb",
+     "lib/cml/tags/text.rb",
+     "lib/cml/tags/textarea.rb",
+     "lib/cml/tags/thumb.rb",
+     "lib/cml/tags/unknown.rb",
+     "spec/complex_spec.rb",
+     "spec/converters/jsawesome_spec.rb",
+     "spec/fixtures/complex.cml",
+     "spec/fixtures/html.cml",
+     "spec/fixtures/invalid.cml",
+     "spec/fixtures/script-style.cml",
+     "spec/fixtures/segfault.cml",
+     "spec/gold_spec.rb",
+     "spec/meta_spec.rb",
+     "spec/normalize_spec.rb",
+     "spec/show_data_spec.rb",
+     "spec/sorta_match.rb",
+     "spec/spec_helper.rb",
+     "spec/tags/checkbox_spec.rb",
+     "spec/tags/checkboxes_spec.rb",
+     "spec/tags/group_spec.rb",
+     "spec/tags/hidden_spec.rb",
+     "spec/tags/iterate_spec.rb",
+     "spec/tags/meta_spec.rb",
+     "spec/tags/multiple_text_spec.rb",
+     "spec/tags/radios_spec.rb",
+     "spec/tags/ratings_spec.rb",
+     "spec/tags/search_spec.rb",
+     "spec/tags/select_spec.rb",
+     "spec/tags/tag_spec.rb",
+     "spec/tags/text_spec.rb",
+     "spec/tags/textarea_spec.rb",
+     "spec/tags/thumb_spec.rb",
+     "spec/tags/unknown_spec.rb",
+     "spec/validation_spec.rb"
+  ]
+  s.homepage = %q{http://github.com/dolores/cml}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.7}
+  s.summary = %q{CML is CrowdFlower Markup Language}
+  s.test_files = [
+    "spec/complex_spec.rb",
+     "spec/converters/jsawesome_spec.rb",
+     "spec/gold_spec.rb",
+     "spec/meta_spec.rb",
+     "spec/normalize_spec.rb",
+     "spec/show_data_spec.rb",
+     "spec/sorta_match.rb",
+     "spec/spec_helper.rb",
+     "spec/tags/checkbox_spec.rb",
+     "spec/tags/checkboxes_spec.rb",
+     "spec/tags/group_spec.rb",
+     "spec/tags/hidden_spec.rb",
+     "spec/tags/iterate_spec.rb",
+     "spec/tags/meta_spec.rb",
+     "spec/tags/multiple_text_spec.rb",
+     "spec/tags/radios_spec.rb",
+     "spec/tags/ratings_spec.rb",
+     "spec/tags/search_spec.rb",
+     "spec/tags/select_spec.rb",
+     "spec/tags/tag_spec.rb",
+     "spec/tags/text_spec.rb",
+     "spec/tags/textarea_spec.rb",
+     "spec/tags/thumb_spec.rb",
+     "spec/tags/unknown_spec.rb",
+     "spec/validation_spec.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<liquid>, [">= 2.0.0"])
+      s.add_runtime_dependency(%q<nokogiri>, [">= 1.4.2"])
+    else
+      s.add_dependency(%q<liquid>, [">= 2.0.0"])
+      s.add_dependency(%q<nokogiri>, [">= 1.4.2"])
+    end
+  else
+    s.add_dependency(%q<liquid>, [">= 2.0.0"])
+    s.add_dependency(%q<nokogiri>, [">= 1.4.2"])
+  end
+end

data/lib/cml/converters/jsawesome.rb

@@ -0,0 +1,103 @@
+module CML
+  module Converters
+    class JSAwesome
+      def initialize(json)
+        parsed = JSON.parse(json)
+        @json = parsed[0] || []
+        @labels = parsed[1] || {}
+        @tags = []
+      end
+      
+      def convert
+        @json.map do |k,v|
+          if k.is_a?(Array)
+            (k << v).map {|k,v| process(k,v)}
+          else
+            process(k,v)
+          end
+        end.join("\n") + meta
+      end
+      
+      def meta
+        (@labels["gold"] || {}).select do |k,v|
+          next if k =~ /^_/
+          !@tags.map {|t| t.name }.include?(k)
+        end.map do |k,v|
+          tag("meta", k, {:meta => true})
+        end.compact.join("\n")
+      end
+      
+      def label(k)
+        k = k.sub(/^[_#*^~]?\+?/,'')
+        l = @labels[k]
+        label = l.is_a?(Hash) ? l["label"] : l if l
+        label ||= k.capitalize.gsub(/_/,' ')
+      end
+      
+      def tag(tag, val, opts = {})
+        val = Array(val)
+        return nil unless val[0]
+        parts = val[0].split("|")
+        key = parts[0].sub(/^[_#*^~]?\+?/,'')
+        label = label(parts[0])
+        parts << key if label != key.capitalize.gsub(/_/,' ') || opts[:meta]
+        attrs = opts[:meta] ? [] : ["label=\"#{label}\""]
+        attrs << "#{opts[:nested] ? "value" : "name"}=\"#{parts[1]}\"" if parts[1]
+        attrs << "checked=\"true\"" if val[1]
+        attrs << "validates=\"required\"" if @labels[key] && @labels[key]["required"]
+        opts.reject {|k,v| v.to_s.strip.length == 0 || k.is_a?(Symbol) }.each do |k,v|
+          attrs << "#{k}=\"#{v}\""
+        end
+        if @labels["gold"] && @labels["gold"][key]
+          opts["gold"] = {}
+          src = @labels["gold"][key]
+          opts["gold"]["src"] = src
+          opts["gold"]["regex"], opts["gold"]["flags"] = Array(@labels["gold"]["_"+src+"_regex"])
+          opts["gold"]["strict"] = @labels["gold"]["_"+src+"_strict"]
+        else
+          opts["gold"] = false
+        end
+        
+        tag = Parser.tag_class(tag).new("<cml:#{tag} #{attrs.join(" ")} />")
+        tag.gold = opts["gold"]
+        opts[:children].each { |c| tag.cml.add_child(tag(*c).cml) } if opts[:children]
+        @tags << tag if opts[:parent]
+        tag
+      end
+      
+      def process(k,v)
+        select_default = @labels['{}'] || "Choose Category"
+        cml = case v
+        #a select tag or group of radios/checkboxes
+        when Array:
+          if(k =~ /^[^_]/)
+            if $~[0] == "*"
+              parent = "radios"
+              child = "radio"
+            elsif $~[0] == "^"
+              parent = "checkboxes"
+              child = "checkbox"
+            else
+              parent = "select"
+              child = "option"
+            end
+            tag(parent, k, {:children => v.map { |c| [child, c, {:nested => child}]}, :parent => parent })
+          #Multiple hidden fields...
+          elsif(k =~ /^_/)
+            v.map { |c| tag("hidden", c, :parent => true)}.join("\n")
+          end
+        else
+          if(k =~ /^#/)
+            tag("textarea", k, {"default" => v, :parent => true})
+          elsif(k =~ /^_/)
+            tag("hidden", k, {"value" => v, :parent => true})
+          elsif(k =~ /^\^/)
+            tag("checkbox", k, {"default" => v, :parent => true})
+          else
+            tag("text", k, {"default" => v, :parent => true})
+          end
+        end
+      end
+    end
+  end
+end

data/lib/cml/gold.rb

@@ -0,0 +1,33 @@
+module CML
+  class Gold
+    Attrs = ["exact","strict","regex","structured","matcher"]
+    attr_reader *(Attrs + [:src, :name])
+        
+    def initialize(tag, gold)
+      @name = tag.name(false)
+      @src = (gold.attributes["gold"] || gold.attributes["src"]).to_s
+      @src = "#{@name}_gold" if @src =~ /^(true|\s*)$/
+      Attrs.each do |attribute|
+        if a = gold.attributes[attribute]
+          value = case attribute
+          when "regex": [a.to_s, gold.attributes["flags"].to_s, gold.attributes["no_escape"].to_s]
+          when "matcher": a.to_s
+          else
+            a.to_s == "true"
+          end
+          instance_variable_set "@#{attribute}", value
+        end
+      end
+      @structured = true if tag.iterating?
+    end
+    
+    def to_hash
+      Hash[
+        *[@name,@src].concat(Attrs.map do |a|
+          val = instance_variable_get("@#{a}")
+          val ? ["_#{@src}_#{a}", val] : nil
+        end.compact.flatten(1))
+      ]
+    end
+  end
+end

data/lib/cml/liquid_filters.rb

@@ -0,0 +1,13 @@
+module CML
+  module LiquidFilters    
+    def to_json(input)
+      input.to_json
+    end
+  end
+  
+  class LiquidHash < Hash
+    def to_s
+      self["to_s"]
+    end
+  end
+end

data/lib/cml/parser.rb

@@ -0,0 +1,160 @@
+module CML
+  class Parser
+    attr_reader :doc, :cftags, :tags, :errors
+    BASE_TAGS_XPATH = ".//cml:*[not(ancestor::cml:checkboxes or ancestor::cml:ratings or ancestor::cml:select or ancestor::cml:radios or self::cml:gold or self::cml:instructions)]"
+    
+    def initialize(content, opts = {})
+      @opts = opts.merge(:parser => self)
+      if content.is_a?(String)
+        #Because nokogiri is munging my CDATA sections, we parse it out ahead of time
+        @cdata = content.scan(/(<(script|style)[^>]*?>)(.*?)(<\/\2>)/m)
+        @doc = Parser.parse(content)
+      else
+        @cdata = []
+        @doc = content
+      end
+      #Pull all cml tags that aren't children
+      @cftags = @doc.xpath(BASE_TAGS_XPATH, "xmlns:cml"=>"http://crowdflower.com")
+      normalize if opts[:normalize]
+      @tags = @cftags.map do |t|
+        t = Parser.tag_class(t.name).new(t, @opts)
+      end.flatten
+    end
+    
+    def self.parse(content)
+      #This sucks, we remove scripts, styles, and close non self closed tags
+      #We could potentially add CDATA clauses to them, but this is "easier"
+      xhtml = content.gsub(/(<(script|style)[^>]*?>)(.*?)(<\/\2>)/m, "\\1\\4").gsub(/(<(input|link|img|br|hr).*?)\/?>/,'\1/>') #base, basefont, area, meta
+      Nokogiri::XML("<root xmlns:cml=\"http://crowdflower.com\">#{xhtml}</root>")
+    end
+    
+    def convert(opts = nil)
+      @opts.merge!(opts) if opts
+      cloned = @doc.dup
+      cloned.xpath(BASE_TAGS_XPATH, "xmlns:cml"=>"http://crowdflower.com").each_with_index do |t,i|
+        t.namespace = nil
+        t.replace(@tags[i].convert(opts))
+      end
+      cloned
+    end
+    
+    def normalize
+      @cftags.each do |t|
+        if ["radios", "select"].include?(t.name)
+          child = t.name == "radios" ? "radio" : "option"
+          t.name = "checkboxes"
+          t.xpath("cml:#{child}").each { |c| c.name = "checkbox" }
+        elsif t.name == "meta"
+          t.name = "text"
+        end
+      end
+    end
+    
+    def fields
+      @fields = {}
+      @tags.each do |g|
+        agg = g.attrs["aggregation"]
+        @fields[g.name] = agg.to_s if agg
+      end
+      @fields
+    end
+    
+    def golds(rich = false, opts={})
+      unless @golds
+        @golds = @tags.map do |tag|
+          next unless gold = tag.gold?
+          Gold.new(tag, gold)
+        end.compact
+      end
+      
+      if rich
+        golds = @golds
+      else
+        golds = rich_gold_to_hash( @golds )
+        if opts[:no_meta]
+          golds.reject! { |k,v| k =~ /^_/ }
+        end
+      end
+      
+      golds
+    end
+    
+    def rich_gold_to_hash(golds)
+      golds.inject({}) do |m, gold|
+        m.merge(gold.to_hash)
+      end
+    end
+    
+    def valid?
+      @errors = []
+      if e = @doc.errors.select {|e| e.fatal? }.last
+        @errors << "Malformed CML (#{e.level}).  #{e.message.chomp} on line #{e.line} column #{e.column}."
+      end
+      @tags.select {|t| t.validate? && t.name =~ /^\s*$/ }.each do |t|
+        @errors << "#{t.to_s.split("\n")[0]} does not have a label or name specified."
+      end
+      dupes = @tags.select do |tag|
+        tag.validate? && @tags.select {|t| t.name == tag.name}.length > 1
+      end
+      (dupes[1..-1] || []).each do |t|
+        @errors << "#{t.to_s.split("\n")[0]} has a duplicated name, please specify a unique name attribute."
+      end
+      @tags.each do |t|
+        next if !t.children || ["group","iterate"].include?(t.tag) 
+        dupes = t.children.select do |child|
+          child.validate? && t.children.select {|c| c.value == child.value}.length > 1
+        end
+        (dupes[1..-1] || []).each do |c|
+          @errors << "#{c} a child of #{t.to_s.split("\n")[0]} has a duplicated value, please specify a unique value attribute."
+        end
+      end
+      @errors.length == 0
+    end
+    
+    def wrap(content)
+      #This happens when variables are inside of href's
+      content = content.gsub(/%7B%7B/,'{{').gsub(/%7D%7D/,'}}')
+      @opts[:no_wrap] ? content : "<div class=\"cml#{" "+@opts[:class] if @opts[:class]}\" id=\"#{@opts[:prefix]}\">#{content}</div>"
+    end
+    
+    def to_s
+      to_html
+    end
+    
+    def to_cml
+      cml = @doc.to_xhtml.gsub(/<\/?root[^>]*?>|<\/?>/,'').gsub(/(<(input|link|img|br|hr).*?)\/?>/,'\1/>').gsub(/%7B%7B/,'{{').gsub(/%7D%7D/,'}}')
+      #Hack to ensure the next sub doesn't match...
+      @cdata.each do |matches| 
+        cml.sub!(/(<(script|style)[^>]*>)<\/\2>/m) do |m|
+          "#{$1}#{matches[2].empty? ? " " : matches[2]}</#{$2}>"
+        end
+      end
+      cml
+    end
+    
+    def to_html(opts = nil)
+      #We convert the entire document and strip root tags / rando empty tags ALA libxml 2.6.32
+      #We're also adding self closing tags
+      html = convert(opts).to_xhtml.gsub(/<\/?(root|group)[^>]*?>|<\/?>/,'').gsub(/(<(input|link|img|br|hr).*?)\/?>/,'\1/>').gsub(/%7B%7B/,'{{').gsub(/%7D%7D/,'}}') 
+      #Let's re-insert that CDATA, tricky because scripts will sometimes contain single quotes...
+      @cdata.each do |matches| 
+        html.sub!(/(<(script|style)[^>]*>)<\/\2>/m) do |m|
+          "#{$1}#{matches[2].empty? ? " " : matches[2]}</#{$2}>"
+        end
+      end
+      wrap(html)
+    end
+    
+    def self.escape( string )
+      string.to_s.gsub( /&/, "&amp;" ).
+             gsub( /</, "&lt;" ).
+             gsub( />/, "&gt;" ).
+             gsub( /"/, "&quot;" )
+    end
+        
+    #This takes the name of the tag and converts it to the appropriate tag class
+    def self.tag_class(name)
+      CML::TagClasses[name] || CML::Tags::Unknown      
+    end
+  end
+end