dolores-cml 0.3.0

data/lib/cml/tags/option.rb

@@ -0,0 +1,25 @@
+module CML
+  module Tags
+    class Option < Tag
+      Template = <<-HTML.freeze
+<option {{value}} {{selected}}>{{label}}</option>
+      HTML
+      
+      def wrapper(parsed)
+        parsed
+      end
+      
+      def value
+        (@attrs["value"] || @attrs["label"]).to_s
+      end
+      
+      def data
+        super.merge({
+          "value" => @attrs["value"] ? "value=\"#{@attrs["value"]}\"" : "", 
+          "selected" => @attrs["selected"] ? "selected=\"selected\"" : "",
+          "label" => (@attrs["label"] || @cml.inner_html).to_s
+        })
+      end
+    end
+  end
+end

data/lib/cml/tags/radio.rb

@@ -0,0 +1,29 @@
+module CML
+  module Tags
+    class Radio < Tag
+      Template = <<-HTML.freeze
+<label><input name="{{name}}" type="radio" value="{{value}}" class="{{classes}}" {{checked}}/> {{label}}</label>
+      HTML
+      
+      #Radios should always be grouped, but for consistency with checkboxes, we check
+      def grouped?
+        @cml.parent && @cml.parent.name == "radios"
+      end
+      
+      def wrapper(parsed)
+        grouped? ? parsed : super
+      end
+      
+      def value
+        (@attrs["value"] || @attrs["label"]).to_s
+      end
+      
+      def data
+        super.merge({
+          "checked" => @attrs["checked"] ? "checked=\"checked\"" : "",
+          "label" => @attrs["label"].to_s
+        })
+      end
+    end
+  end
+end

data/lib/cml/tags/radios.rb

@@ -0,0 +1,24 @@
+module CML
+  module Tags
+    class Radios < Tag
+      Template = <<-HTML.freeze
+{{legend}}
+  {% for radio in radios %}
+  {{radio}}
+  {% endfor %}
+      HTML
+      
+      def data
+        super.merge({"radios" => children})
+      end
+      
+      def children
+        @cml.xpath("cml:radio").map do |c|
+          c["name"] ||= name
+          c["validates"] ||= @attrs["validates"].to_s
+          Radio.new(c, @opts)
+        end
+      end
+    end
+  end
+end

data/lib/cml/tags/ratings.rb

@@ -0,0 +1,42 @@
+module CML
+  module Tags
+    class Ratings < Tag
+      Template = <<-HTML.freeze
+{{label}}
+<table>
+  <thead>
+    <tr>
+      <th></th>
+      {% for rating in ratings limit:10 %}
+      <th>{{forloop.index}}</th>
+      {% endfor %}
+      <th></th>
+    </tr>
+  </thead>
+  <tbody>
+    <tr>
+      <td>{{from}}</td>
+      {% for rating in ratings limit:10 %}
+      <td>{{rating}}</td>
+      {% endfor %}
+      <td>{{to}}</td>
+    </tr>
+  </tbody>
+</table>
+      HTML
+      
+      def data
+        super.merge({"ratings" => ratings, "from" => @attrs["from"].to_s, "to" => @attrs["to"].to_s})
+      end
+      
+      def ratings
+        @cml.xpath("cml:rating").map do |c|
+          c["name"] ||= prefix
+          c["validates"] ||= @attrs["validates"]
+          c["value"] ||= @attrs["label"]
+          Radio.new(c).convert
+        end
+      end
+    end
+  end
+end

data/lib/cml/tags/select.rb

@@ -0,0 +1,23 @@
+module CML
+  module Tags
+    class Select < Tag
+      Template = <<-HTML.freeze
+{{label}}
+<select name="{{name}}" class="{{classes}}">{% for option in options %}
+  {{option}}{% endfor %}
+</select>
+      HTML
+      
+      def children
+        default = @cml["default"] ? [Option.new("<cml:option value=\"\">#{@cml["default"]}</cml:option>", @opts)] : []  
+        default + @cml.xpath("cml:option").map do |c|
+          Option.new(c, @opts)
+        end
+      end
+      
+      def data
+        super.merge({"options" => children})
+      end
+    end
+  end
+end

data/lib/cml/tags/text.rb

@@ -0,0 +1,10 @@
+module CML
+  module Tags
+    class Text < Tag
+      Template = <<-HTML.freeze
+{{label}}
+<input name="{{name}}" type="text" value="{{value}}" class="{{classes}}"/>
+      HTML
+    end
+  end
+end

data/lib/cml/tags/textarea.rb

@@ -0,0 +1,10 @@
+module CML
+  module Tags
+    class Textarea < Tag
+      Template = <<-HTML.freeze
+{{label}}
+<textarea name="{{name}}" class="{{classes}}">{{value}}</textarea>
+      HTML
+    end
+  end
+end

data/lib/cml/tags/unknown.rb

@@ -0,0 +1,21 @@
+module CML
+  module Tags
+    class Unknown < Tag
+      Template = <<-HTML.freeze
+  {{content}}
+      HTML
+    
+      def validate?
+        false
+      end
+    
+      def wrapper_classes
+        super + " unknown"
+      end
+      
+      def data
+        super.merge({"content" => @cml.inner_html})
+      end
+    end
+  end
+end

data/lib/cml.rb

@@ -0,0 +1,9 @@
+require 'rubygems'
+require 'nokogiri'
+require 'json'
+require 'liquid'
+
+require 'cml/parser'
+require 'cml/liquid_filters'
+require 'cml/tag'
+Dir[File.dirname(__FILE__) + '/cml/tags/*.rb'].each {|dir| require dir }

data/spec/complex_spec.rb

@@ -0,0 +1,53 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+describe "CML Complex" do
+  it "parses" do
+    @p = Parser.new(File.read(File.dirname(__FILE__) + "/fixtures/complex.cml"), {:prefix => "u12345"})
+    @p.to_html.should sorta_match(<<-HTML)
+    <div class="cml" id="u12345">
+      <h1>This is my name</h1>
+      <p>This is a description about me</p>
+      <div class="select">
+        <label>Awesome</label>
+        <select name="u12345[awesome]" class="awesome validates-required">
+          <option value="">Choose an option</option>
+          <option>Awesome</option>
+          <option>Cool</option>
+          <option>Rad</option>
+          <option>Neat</option>
+        </select>
+        <p class="instructions">Just be cool about it</p>
+      </div>
+      <div class="text">
+        <label>Opinion</label>
+        <input name="u12345[opinion]" class="opinion validates-minLength:30 large" type="text" value="">
+      </div>
+      <div class="text">
+        <label>Email</label>
+        <input name="u12345[email]" class="email validates-required validates-email" type="text" value="">
+      </div>
+      <div class="rad">
+        <div class="checkbox">
+          <label><input name="u12345[you_sure]" class="you_sure" type="checkbox" value="yes"> You sure?</label>
+        </div>
+      </div>
+      <div class="group only-if:awesome">
+      
+        <div class="checkboxes">
+          <h2 class="legend">Cool checkboxes</h2>
+        
+          <label>
+            <input name="u12345[rad][]" class="rad" type="checkbox" value="Wanna do it?">
+          Wanna do it?</label>
+        
+          <label>
+            <input name="u12345[rad][]" class="rad" type="checkbox" value="Sure?">
+          Sure?</label>
+          <p class=\"instructions\">This <i>is</i> cool</p>
+        </div>
+        <input type="hidden" name="u12345[secret]" value="cool" class="secret" />
+      </div>
+    </div>
+    HTML
+  end
+end

data/spec/converters/jsawesome_spec.rb

@@ -0,0 +1,57 @@
+require File.expand_path(File.dirname(__FILE__) + "/../spec_helper")
+require File.expand_path(File.dirname(__FILE__) + "/../../lib/cml/converters/jsawesome")
+
+describe "JSAwesome Converter" do
+  it "converts" do
+    json = "[[
+            [\"text_field\", \"default value\"],
+            [\"#text_area\", \"\"],
+            [\"single_select\", [\"boo\", \"~yah\"]],
+            [\"^check\", [\"One|totally_rad\", [\"two\",true], \"three\"]],
+            [\"*radio\", [\"a\", \"b\", [\"c\", true]]],
+            [\"_hidden\",\"hot\"],
+            [[\"^single_check\"],[\"^Edge|edge_case\", false]]
+          ], 
+          {\"text_field\": \"JSAwesome\",
+           \"text_area\": {
+              \"required\":true,
+              \"validation\": [\"\\d+\", \"Field must contain atleast one digit\"],
+              \"label\": \"Input some text with atleast one digit\"
+           },
+           \"single_select\": {
+              \"required\":true
+           },
+           \"gold\": {
+            \"rando\": \"so_cool\",
+            \"check\": \"check_gold\",
+            \"_awesome_gold_strict\": true, 
+            \"text_field\": \"awesome_gold\", 
+            \"_awesome_gold_regex\": [\"\\\\.asdf\\\\.\", \"i\"]
+           }}]"
+    @c = Converters::JSAwesome.new(json)
+    @c.convert.should sorta_match(<<-HTML)
+    <cml:text name="text_field" label="JSAwesome" default="default value">
+      <gold src="awesome_gold" flags="i" regex="\\.asdf\\." strict="true" />
+    </cml:text> 
+    <cml:textarea name="text_area" validates="required" label="Input some text with atleast one digit" /> 
+    <cml:select label="Single select" validates="required"> 
+      <cml:option label="Boo" /> 
+      <cml:option label="Yah" /> 
+    </cml:select>
+    <cml:checkboxes label="Check" gold="true"> 
+      <cml:checkbox label="One" name="totally_rad" /> 
+      <cml:checkbox label="Two" checked="true" /> 
+      <cml:checkbox label="Three" /> 
+    </cml:checkboxes> 
+    <cml:radios label="Radio"> 
+      <cml:radio label="A" /> 
+      <cml:radio label="B" /> 
+      <cml:radio label="C" checked="true" /> 
+    </cml:radios> 
+    <cml:hidden label="Hidden" value="hot" />
+    <cml:checkbox label="Single check" /> 
+    <cml:checkbox label="Edge" name="edge_case" default="false" />
+    <cml:meta name="rando" gold="so_cool"/>
+    HTML
+  end
+end

data/spec/fixtures/complex.cml

@@ -0,0 +1,22 @@
+<h1>This is my name</h1>
+<p>This is a description about me</p>
+<cml:select label="Awesome" validates="required" default="Choose an option" instructions="Just be cool about it">
+  <cml:gold src="awesome_gold" regex="\\.asdf\\." flags="i" strict="true"  />
+  <cml:option label="Awesome" />
+  <cml:option label="Cool" />
+  <cml:option label="Rad" />
+  <cml:option label="Neat" />
+</cml:select>
+<cml:text label="Opinion" validates="minLength:30" class="large" />
+<cml:text label="Email" validates="required email" />
+<div class="rad">
+  <cml:checkbox label="You sure?" value="yes" gold="true" />
+</div>
+<cml:group only-if="awesome">
+  <cml:checkboxes label="Cool checkboxes" name="rad">
+    <cml:instructions>This <i>is</i> great</cml:instructions>
+    <cml:checkbox label="Wanna do it?"/>
+    <cml:checkbox label="Sure?"/>
+  </cml:checkboxes>
+  <cml:hidden name="secret" value="cool"/>
+</cml:group>

data/spec/fixtures/invalid.cml

@@ -0,0 +1,10 @@
+<cml:select label="Awesome">
+  <cml:gold src="awesome_gold" regex="\\.asdf\\." flags="i" strict="true"  />
+  <cml:option label="Awesome" />
+  <cml:option label="Rad" />
+  <cml:option label="Rad" />
+  <cml:option label="Neat" />
+</cml:select>
+<cml:text label="Opinion" validates="minLength:30" class="large" />
+<cml:text label="Awesome" validates="required email" />
+<cml:checkbox label="" value="yes" gold="true" />

data/spec/meta_spec.rb

@@ -0,0 +1,31 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+describe "CML Gold" do
+  it "should give me da gold & fields" do
+    cml = <<-HTML
+      <cml:checkboxes label="Checkboxes" aggregation="all">
+        <cml:gold src="awesome_gold" regex="\\.asdf\\." flags="i" strict="true" />
+        <cml:checkbox label="Wanna do it?" />
+        <cml:checkbox label="Sure?" />
+      </cml:checkboxes>
+      <cml:checkbox label="No way">
+        <cml:gold />
+      </cml:checkbox>
+      <cml:text name="cool" gold="true" aggregation="agg" />
+      <cml:textarea name="sweet" gold="sweetness" />
+    HTML
+    @p = Parser.new(cml, :prefix => "u12345")
+    @p.golds.should == {
+      "_awesome_gold_strict" => "true", 
+      "sweet" => "sweetness",
+      "no_way" => "no_way_gold",
+      "checkboxes" => "awesome_gold", 
+      "_awesome_gold_regex" => ["\\.asdf\\.", "i"], 
+      "cool" => "cool_gold"
+    }
+    @p.fields.should == {
+      "checkboxes"=>"all",
+      "cool"=>"agg"
+    }
+  end
+end

data/spec/sorta_match.rb

@@ -0,0 +1,41 @@
+class SortaMatch
+  def initialize(dom1,dom2)
+    @nodes1 = Nokogiri::HTML(dom1).xpath("//*").to_a
+    @nodes2 = Nokogiri::HTML(dom2).xpath("//*").to_a
+    @children = []
+    @nodes1.each_with_index { |d,i| @children << [d,@nodes2[i]] }
+  end
+  
+  def missed
+    [present(@nodes1[@i]), present(@nodes2[@i])]
+  end
+  
+  def present(node)
+    node ? "<#{node.name}#{node.attributes.map {|k,v| " #{k}=\"#{v}\""}}>#{node.children.first if first_text?(node)}" : @why
+  end
+  
+  def first_text?(node)
+    node.children.first && node.children.first.text?
+  end
+  
+  def matches?
+    @i = 0
+    @children.detect do |a,b|
+      if a.nil? || b.nil?
+        @why = "missing"
+      elsif !a.text?
+        if a.name != b.name
+          @why = "tag"
+        elsif a.attributes.map {|k,v| [k.to_s,v.to_s]} != b.attributes.map {|k,v| [k.to_s,v.to_s]}
+          @why = "attributes"
+        elsif first_text?(b) && a.children.first.to_s.strip != b.children.first.to_s.strip
+          @why = "text"
+        end
+      else
+        @why = nil
+      end
+      @i += 1 unless @why
+      @why
+    end.nil?
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,26 @@
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+require 'cml'
+require 'spec'
+require 'sorta_match'
+#require 'spec/autorun'
+include CML
+
+Spec::Runner.configure do |config|
+  
+end
+
+Spec::Matchers.define :sorta_match do |expected|
+  match do |actual|
+    @sm = SortaMatch.new(expected, actual)
+    @sm.matches?
+  end
+  
+  failure_message_for_should do |actual|
+    "Expected DOM's to sorta match but they had these differences:\n #{@sm.missed.inspect}"
+  end
+end
+
+def convert(html)
+  Nokogiri::HTML.fragment(html)
+end

data/spec/tags/checkbox_spec.rb

@@ -0,0 +1,98 @@
+require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')
+
+describe "CML Radio" do
+  it "should render basic checkbox" do
+    cml = <<-HTML
+      <cml:checkbox label="Check"/>
+    HTML
+    @p = Parser.new(cml, :prefix => "u12345")
+    @p.to_html.should sorta_match(<<-HTML)
+    <div class="cml" id="u12345">
+      <div class="checkbox">
+        <label><input type="checkbox" value="true" name="u12345[check]" class="check"/> Check</label>
+      </div>
+    </div>
+    HTML
+  end
+  
+  it "should render checkbox custom value" do
+    cml = <<-HTML
+      <cml:checkbox label="Check" value="yes"/>
+    HTML
+    @p = Parser.new(cml, :prefix => "u12345")
+    @p.to_html.should sorta_match(<<-HTML)
+    <div class="cml" id="u12345">
+      <div class="checkbox">
+        <label><input type="checkbox" value="yes" name="u12345[check]" class="check"/> Check</label>
+      </div>
+    </div>
+    HTML
+  end
+  
+  it "should render default checkbox" do
+    cml = <<-HTML
+      <cml:checkbox label="Check" default="false"/>
+    HTML
+    @p = Parser.new(cml, :prefix => "u12345")
+    @p.to_html.should sorta_match(<<-HTML)
+    <div class="cml" id="u12345">
+      <div class="checkbox">
+        <input type="hidden" value="false" name="u12345[check]" class="check"/>
+        <label><input type="checkbox" value="true" name="u12345[check]" class="check"/> Check</label>
+      </div>
+    </div>
+    HTML
+  end
+  
+  it "should render checkbox with instructions attribute" do
+    cml = <<-HTML
+      <cml:checkbox label="Rad" instructions="Please be careful when you are selecting these."/>
+    HTML
+    @p = Parser.new(cml, :prefix => "u12345")
+    @p.to_html.should sorta_match(<<-HTML)
+    <div class="cml" id="u12345">
+      <div class="checkbox">
+        <label>
+          <input type="checkbox" value="true" name="u12345[rad]" class="rad"/> Rad
+        </label>
+        <p class="instructions">Please be careful when you are selecting these.</p>
+      </div>
+    </div>
+    HTML
+  end
+  
+  it "should render gold" do
+    cml = <<-HTML
+      <cml:checkbox label="Rad">
+        <cml:gold src="rad_gold"/>
+      </cml:checkbox>
+    HTML
+    @p = Parser.new(cml, :prefix => "u12345")
+    @p.tags[0].should be_gold
+    @p.to_html.should sorta_match(<<-HTML)
+    <div class="cml" id="u12345">
+      <div class="checkbox">
+        <label><input type="checkbox" value="true" name="u12345[rad]" class="rad"/> Rad</label>
+      </div>
+    </div>
+    HTML
+  end
+  
+  it "should render checkbox nested" do
+    cml = <<-HTML
+      <div class="rando">
+        <cml:checkbox label="Rad"/>
+      </div>
+    HTML
+    @p = Parser.new(cml, :prefix => "u12345")
+    @p.to_html.should sorta_match(<<-HTML)
+    <div class="cml" id="u12345">
+      <div class="rando">
+        <div class="checkbox">
+          <label><input type="checkbox" value="true" name="u12345[rad]" class="rad"/> Rad</label>
+        </div>
+      </div>
+    </div>
+    HTML
+  end
+end

data/spec/tags/checkboxes_spec.rb

@@ -0,0 +1,30 @@
+require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')
+
+describe "CML Checkboxes" do
+  it "should render basic checkboxes" do
+    cml = <<-HTML
+      <cml:checkboxes label="Cool checkboxes">
+        <cml:checkbox label="Wanna do it?"/>
+        <cml:checkbox label="Sure?"/>
+        <cml:checkbox label="Not really..." value="nope" checked="true"/>
+      </cml:checkboxes>
+    HTML
+    @p = Parser.new(cml, :prefix => "u12345")
+    @p.to_html.should sorta_match(<<-HTML)
+    <div class="cml" id="u12345">
+      <div class="checkboxes">
+        <h2 class="legend">Cool checkboxes</h2>
+        <label>
+          <input type="checkbox" value="Wanna do it?" name="u12345[cool_checkboxes][]" class="cool_checkboxes"/> Wanna do it?
+        </label>
+        <label>
+          <input type="checkbox" value="Sure?" name="u12345[cool_checkboxes][]" class="cool_checkboxes"/> Sure?
+        </label>
+        <label>
+          <input type="checkbox" value="nope" checked="checked" name="u12345[cool_checkboxes][]" class="cool_checkboxes"/> Sure?
+        </label>
+      </div>
+    </div>
+    HTML
+  end
+end

data/spec/tags/group_spec.rb

@@ -0,0 +1,35 @@
+require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')
+
+describe "CML Select" do
+  it "should render group" do
+    cml = <<-HTML
+      <cml:group only-if="awesome[1]">
+      <cml:checkboxes label="Cool checkboxes" name="rad">
+        <cml:checkbox label="Wanna do it?"/>
+        <cml:checkbox label="Sure?"/>
+      </cml:checkboxes>
+      <cml:text label="Something"/>
+      </cml:group>
+    HTML
+    @p = Parser.new(cml, :prefix => "u12345")
+    @p.to_html.should sorta_match(<<-HTML)
+    <div class="cml" id="u12345">
+      <div class="group only-if:awesome[1]">
+        <div class="checkboxes">
+          <h2 class="legend">Cool checkboxes</h2>
+          <label>
+            <input name="u12345[rad][]" class="rad" type="checkbox" value="Wanna do it?" /> Wanna do it?
+          </label>
+          <label>
+            <input name="u12345[rad][]" class="rad" type="checkbox" value="Sure?" /> Sure?
+          </label>
+        </div>
+        <div class="text">
+          <label>Something</label>
+          <input name="u12345[something]" class="something" type="text" value="" />
+        </div>
+      </div>
+    </div>
+    HTML
+  end
+end

data/spec/tags/hidden_spec.rb

@@ -0,0 +1,15 @@
+require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')
+
+describe "CML Hidden" do
+  it "should render basic hidden field" do
+    cml = <<-HTML
+      <cml:hidden name="secret" value="shit"/>
+    HTML
+    @p = Parser.new(cml, :prefix => "u12345")
+    @p.to_html.should sorta_match(<<-HTML)
+    <div class="cml" id="u12345">
+      <input type="hidden" value="shit" name="u12345[secret]" class="secret"/>
+    </div>
+    HTML
+  end
+end

data/spec/tags/meta_spec.rb

@@ -0,0 +1,14 @@
+require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')
+
+describe "CML Hidden" do
+  it "should render basic hidden field" do
+    cml = <<-HTML
+      <cml:meta name="secret" gold="true"/>
+    HTML
+    @p = Parser.new(cml, :prefix => "u12345")
+    @p.to_html.should sorta_match(<<-HTML)
+    <div class="cml" id="u12345">
+    </div>
+    HTML
+  end
+end