cml 1.4.2 → 1.5.0

data/lib/cml/tags/taxonomy.rb

@@ -0,0 +1,148 @@
+require 'uri'
+
+module CML
+  module Tags
+    class Taxonomy < Tag
+      SIMPLE_OPTIONS = ["root-select", "log-search", "multi-select", "select-all"]
+      URL_OPTIONS = ["src", "search-src"]
+      ARRAY_OPTIONS = ["top-level", "selectable", "nonselectable"]
+
+      BareTemplate = <<-HTML.freeze
+        {{inputs}}
+        {{search_log}}
+        <div class="taxonomy_widget_container" {{taxonomy_options}}></div>
+      HTML
+
+      MultiInputTemplate = <<-HTML.freeze
+        <div class="taxonomy_choices">
+          {{inputs}} 
+        </div>
+      HTML
+
+      InputTemplate = <<-HTML.freeze
+        <div class="cml_row taxonomy_choice">
+          <input name="{{name}}" type="{{input_type}}" class="{{classes}}" value="{{value}}" />
+          <input name="{{id_name}}" type="{{input_type}}" class="taxonomy_id no_validate" value="{{id_value}}" />
+        </div>
+      HTML
+    
+      # The actual search logging is done by the taxonomy widget by adding
+      # input array fields to this div
+      SearchLogTemplate = <<-HTML.freeze
+        <div class="cml_row taxonomy_search" data-name="{{search_log_name}}"></div>
+      HTML
+
+      Template = <<-HTML.freeze
+        {{label}}
+        #{BareTemplate}
+      HTML
+      
+      #allow use of the taxonomy tool for browsing without a form input
+      def is_field?
+        !(@attrs["field"] && @attrs["field"].to_s == "false")
+      end
+      
+      def in_logic_graph?
+        is_field?
+      end
+      
+      def finite_value?
+        true
+      end
+
+      def taxonomy_options
+        cw_data = {}
+
+        (SIMPLE_OPTIONS + ARRAY_OPTIONS).each do |opt|
+          attr_opt = @attrs[opt]
+          cw_data[opt] = attr_opt.to_s if attr_opt
+        end
+
+        URL_OPTIONS.each do |opt|
+          attr_opt = @attrs[opt]
+          cw_data[opt] = URI.escape(attr_opt.to_s) if attr_opt
+        end
+        
+        cw_data.map{|opt_name, opt_value| "data-#{opt_name}=\"#{opt_value}\""}.join(" ")
+      end
+      memoize :taxonomy_options
+
+      # Overriden to get the right name prefix/suffix
+      def multi_type
+        @attrs["multi-select"] ? :list : nil
+      end
+
+      def value
+        (@attrs["value"] || (@opts[:data] || {})[name] || "").to_s
+      end
+
+      def id_value
+       ( (@opts[:data] || {})[id_name] || "" ).to_s 
+      end
+
+      def id_name
+        name(false, "id")
+      end
+
+      def search_log_name
+        name(true, "search_log")
+      end
+
+      def data
+        super.merge({
+          "taxonomy_options" => taxonomy_options,
+          "value" => value,
+          "id_value" => id_value,
+          "id_name" => prefix(id_name),
+          "search_log_name" => search_log_name, 
+          "input_type" => "text"
+        })
+      end
+
+
+      def to_html
+        if is_field?
+          if @opts[:normalize]
+            data_opt = opts[:data] || {}
+            seeds = Array(data_opt[@opts[:parser].golds[name(false)]] || data_opt[name(false)])
+            # Zip in the id values for taxonomy nodes
+            seeds = seeds.zip(data_opt[id_name] || [])
+            seeds << nil if seeds.length == 0
+          
+            inputs = seeds.map do |input, p_name|
+              Liquid::Template.parse(InputTemplate).render(data.merge({
+                "value" => input.to_s, 
+                "id_value" => p_name.to_s,
+                "classes" => classes+(input ? " cml_gold_loaded" : ""),
+                "input_type" => "text"
+              }))
+            end.join("\n")
+            search_log = ""
+          else
+            search_src = @attrs["search-src"].to_s
+            log_search = @attrs["log-search"].to_s
+            multi_select = @attrs["multi-select"].to_s
+
+            inputs = Liquid::Template.parse(InputTemplate).render(data)
+            inputs = Liquid::Template.parse(MultiInputTemplate).render({"inputs" => inputs}) if !multi_select.empty?
+            
+            if !search_src.empty? && !log_search.empty?
+              search_log = Liquid::Template.parse(SearchLogTemplate).render(data)
+            else
+              search_log = ""
+            end
+          end
+        else
+          inputs = ""
+          search_log = ""
+        end
+        
+        wrapper(Liquid::Template.parse(Template).render(data.merge({
+          "inputs" => inputs,
+          "search_log" => search_log
+        }), [LiquidFilters]))
+      end
+
+    end
+  end
+end

data/lib/cml/tags/thumb.rb

@@ -4,6 +4,10 @@ module CML
       Template = <<-HTML.freeze
       <img src="http://nodenailer.crowdflower.com/?{{query_string}}" />
       HTML
+      
+      def in_logic_graph?
+        false
+      end
 
       def validate?
         false

data/lib/cml/tags/unknown.rb

@@ -4,6 +4,10 @@ module CML
       Template = <<-HTML.freeze
   {{content}}
       HTML
+      
+      def in_logic_graph?
+        false
+      end
     
       def validate?
         false

data/lib/cml/version.rb

@@ -0,0 +1,3 @@
+module CML
+  VERSION = "1.5.0"
+end

data/lib/cml.rb

@@ -3,6 +3,9 @@ require 'nokogiri'
 require 'json'
 require 'liquid'
 
+require 'cml/logic'
+require 'cml/logic_tree/graph'
+require 'cml/logic_tree/solver'
 require 'cml/parser'
 require 'cml/liquid_filters'
 require 'cml/tag'

data/spec/converters/jsawesome_spec.rb

@@ -61,15 +61,6 @@ describe "JSAwesome Converter" do
     @c.convert.should sorta_match(<<-HTML)
       <cml:textarea label="Street address (eg. 35 W Forth St.)" name="w_forth_st" validates="required" /> 
       <cml:text label="City" validates="required" /> 
-      <cml:text label="State/Province" name="stateprovince" />
     HTML
-    
-    #For some reason can't get this spec to pass... not worth my time right now.
-    #<cml:text label="Zip/Postal Code" name="zippostal_code" />
-    #<cml:text label="Country" validates="required" /> 
-    #<cml:textarea label="Any extra company or address information?" name="extra_address_information"/> 
-    #<cml:checkboxes label="Any issues?" name="any_issues"> 
-    #  <cml:checkbox label="No address could be found even after checking the url or searching the web" name="searching_the_web" /> 
-    #</cml:checkboxes>
   end
 end

data/spec/fixtures/logic_broken.cml

@@ -0,0 +1,5 @@
+<cml:checkboxes label="Do you have a name?" name="do_you_have_a_name" validates="required">
+  <cml:checkbox label="Yes" />
+  <cml:checkbox label="No" />
+</cml:checkboxes>
+<cml:text label="name" validates="required" only-if="lol:[yes]" />

data/spec/fixtures/logic_circular.cml

@@ -0,0 +1,5 @@
+<cml:checkboxes label="Do you have a name?" name="do_you_have_a_name" validates="required" only-if="name">
+  <cml:checkbox label="Yes" />
+  <cml:checkbox label="No" />
+</cml:checkboxes>
+<cml:text label="name" validates="required" only-if="do_you_have_a_name:[yes]" />

data/spec/fixtures/logic_grouped.cml

@@ -0,0 +1,7 @@
+<cml:checkboxes label="Do you have a name?" name="do_you_have_a_name" validates="required">
+  <cml:checkbox label="Yes" />
+  <cml:checkbox label="No" />
+</cml:checkboxes>
+<cml:text label="name" validates="required" only-if="do_you_have_a_name:[yes]" />
+<cml:text label="age" only-if="do_you_have_a_name:[yes]++name:alpha"/>
+<cml:text label="foo" only-if="!age||(do_you_have_a_name:[yes]++name)" />

data/spec/fixtures/logic_nested.cml

@@ -0,0 +1,7 @@
+<cml:checkboxes label="Do you have a name?" name="do_you_have_a_name" validates="required">
+  <cml:checkbox label="Yes" />
+  <cml:checkbox label="No" />
+</cml:checkboxes>
+<cml:text label="name" validates="required" only-if="do_you_have_a_name:[yes]" />
+<cml:text label="age" only-if="do_you_have_a_name:[yes]++name:alpha"/>
+<cml:text label="foo" only-if="!age||do_you_have_a_name" />

data/spec/fixtures/logic_none.cml

@@ -0,0 +1,7 @@
+<cml:checkboxes label="Do you have a name?" name="do_you_have_a_name" validates="required">
+  <cml:checkbox label="Yes" />
+  <cml:checkbox label="No" />
+</cml:checkboxes>
+<cml:text label="name" validates="required" />
+<cml:text label="age" />
+<cml:text label="foo" only-if="" />

data/spec/fixtures/logic_not_nested.cml

@@ -0,0 +1,7 @@
+<cml:checkboxes label="Do you have a name?" name="do_you_have_a_name" validates="required">
+  <cml:checkbox label="Yes" />
+  <cml:checkbox label="No" />
+</cml:checkboxes>
+<cml:text label="name" validates="required" only-if="(do_you_have_a_name:[yes])" />
+<cml:text label="age" />
+<cml:text label="foo" only-if="" />

data/spec/liquid_filter_spec.rb

@@ -0,0 +1,19 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+describe "CML Liquid Filters" do
+  it "allow random" do
+    @p = Liquid::Template.parse(<<-HTML)
+    {% capture my_value %}{{ 3 | random }}{% endcapture %}
+    {% case my_value %}
+    {% when '1' %}
+      One
+    {% when '2' %}
+      Two
+    {% when '0' %}
+      Zero
+    {% endcase %}
+    HTML
+
+    @p.render({}, [LiquidFilters]).should =~ /One|Two|Zero/
+  end
+end

data/spec/logic_depends_on_spec.rb

@@ -0,0 +1,242 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+describe "CML logic tree dependencies" do
+  
+  it "lists a simple only-if selector" do
+    @p = Parser.new(<<-HTML)
+      <cml:text label="OMG" />
+      <cml:checkboxes label="w t f" only-if="omg">
+        <cml:checkbox label="lol" />
+        <cml:checkbox label="rtfm" />
+      </cml:checkboxes>
+    HTML
+    
+    dependent_tag_names = @p.logic_tree.nodes['w_t_f'].depends_on.collect {|n| n.tag.name }
+    dependent_tag_names.should == %w{omg}
+    
+    dependencies = @p.logic_tree.nodes['w_t_f'].dependencies_on
+    dependencies['||'].should == [{'omg' => [{ :match_key => nil, :is_not => true }]}]
+    dependencies['&&'].should be_nil
+  end
+  
+  it "lists an only-if 'not' selector" do
+    @p = Parser.new(<<-HTML)
+      <cml:text label="OMG" />
+      <cml:checkboxes label="w t f" only-if="!omg">
+        <cml:checkbox label="lol" />
+        <cml:checkbox label="rtfm" />
+      </cml:checkboxes>
+    HTML
+    dependent_tag_names = @p.logic_tree.nodes['w_t_f'].depends_on.collect {|n| n.tag.name }
+    dependent_tag_names.should == %w{omg}
+    
+    dependencies = @p.logic_tree.nodes['w_t_f'].dependencies_on
+    dependencies['||'].should == [{'omg' => [{ :match_key => nil, :is_not => false }]}]
+    dependencies['&&'].should be_nil
+  end
+  
+  it "lists an only-if 'unchecked' selector for checkboxes" do
+    @p = Parser.new(<<-HTML)
+      <cml:checkboxes label="w t f">
+        <cml:checkbox label="lol" />
+        <cml:checkbox label="rtfm" />
+      </cml:checkboxes>
+      <cml:text label="OMG" only-if="w_t_f:unchecked" />
+    HTML
+    dependent_tag_names = @p.logic_tree.nodes['omg'].depends_on.collect {|n| n.tag.name }
+    dependent_tag_names.should == %w{w_t_f}
+    
+    dependencies = @p.logic_tree.nodes['omg'].dependencies_on
+    dependencies['||'].should == [{'w_t_f' => [{ :match_key => 'lol', :is_not => true }, { :match_key => 'rtfm', :is_not => true }]}]
+    dependencies['&&'].should be_nil
+  end
+  
+  it "lists an only-if 'unchecked' selector for one checkbox" do
+    @p = Parser.new(<<-HTML)
+      <cml:checkbox label="w t f">
+      <cml:text label="OMG" only-if="w_t_f:unchecked" />
+    HTML
+    dependent_tag_names = @p.logic_tree.nodes['omg'].depends_on.collect {|n| n.tag.name }
+    dependent_tag_names.should == %w{w_t_f}
+    
+    dependencies = @p.logic_tree.nodes['omg'].dependencies_on
+    dependencies['||'].should == [{'w_t_f' => [{ :match_key => 'true', :is_not => true }]}]
+    dependencies['&&'].should be_nil
+  end
+  
+  it "lists an only-if 'not unchecked' selector for one checkbox" do
+    @p = Parser.new(<<-HTML)
+      <cml:checkbox label="w t f">
+      <cml:text label="OMG" only-if="!w_t_f:unchecked" />
+    HTML
+    dependent_tag_names = @p.logic_tree.nodes['omg'].depends_on.collect {|n| n.tag.name }
+    dependent_tag_names.should == %w{w_t_f}
+    
+    dependencies = @p.logic_tree.nodes['omg'].dependencies_on
+    dependencies['||'].should == [{'w_t_f' => [{ :match_key => 'true', :is_not => false }]}]
+    dependencies['&&'].should be_nil
+  end
+  
+  it "lists complex only-if '&&' selectors" do
+    @p = Parser.new(<<-HTML)
+      <cml:text label="OMG" />
+      <cml:checkboxes label="w t f" only-if="omg">
+        <cml:checkbox label="lol" />
+        <cml:checkbox label="rtfm" />
+      </cml:checkboxes>
+      <cml:radios label="bacon" only-if="omg:[crispy]++w_t_f:[lol]">
+        <cml:radio label="tasty" />
+        <cml:radio label="too meaty" />
+      </cml:radios>
+    HTML
+    dependent_tag_names = @p.logic_tree.nodes['bacon'].depends_on.collect {|n| n.tag.name }
+    dependent_tag_names.should == %w{omg w_t_f}
+    
+    dependencies = @p.logic_tree.nodes['bacon'].dependencies_on
+    dependencies['&&'].should be_nil
+    dependencies['||'].should == [{
+      '&&' => [
+        {'omg' => [{ :match_key => 'crispy', :is_not => false }]},
+        {'w_t_f' => [{ :match_key => 'lol', :is_not => false }]}
+      ]
+    }]
+  end
+  
+  it "lists complex only-if '||' selectors" do
+    @p = Parser.new(<<-HTML)
+      <cml:text label="OMG" />
+      <cml:checkboxes label="w t f" only-if="omg">
+        <cml:checkbox label="lol" />
+        <cml:checkbox label="rtfm" />
+      </cml:checkboxes>
+      <cml:radios label="bacon" only-if="omg:[crispy]||!w_t_f:[lol]">
+        <cml:radio label="tasty" />
+        <cml:radio label="too meaty" />
+      </cml:radios>
+    HTML
+    dependent_tag_names = @p.logic_tree.nodes['bacon'].depends_on.collect {|n| n.tag.name }
+    dependent_tag_names.should == %w{omg w_t_f}
+    
+    dependencies = @p.logic_tree.nodes['bacon'].dependencies_on
+    dependencies['&&'].should be_nil
+    dependencies['||'].should == [
+      {'omg' => [{ :match_key => 'crispy', :is_not => false }]},
+      {'w_t_f' => [{ :match_key => 'lol', :is_not => true }]}
+    ]
+  end
+  
+  it "lists complex nested only-if selectors" do
+    @p = Parser.new(<<-HTML)
+      <cml:text label="OMG" />
+      <cml:checkboxes label="w t f" only-if="omg">
+        <cml:checkbox label="lol" />
+        <cml:checkbox label="rtfm" />
+      </cml:checkboxes>
+      <cml:checkboxes label="f t w" only-if="omg">
+        <cml:checkbox label="lmao" />
+        <cml:checkbox label="rtfm" />
+      </cml:checkboxes>
+      <cml:radios label="bacon" only-if="omg:[crispy]||(w_t_f:[rtfm]++f_t_w:[rtfm]||f_t_w:[lmao])">
+        <cml:radio label="tasty" />
+        <cml:radio label="too meaty" />
+      </cml:radios>
+    HTML
+    dependent_tag_names = @p.logic_tree.nodes['bacon'].depends_on.collect {|n| n.tag.name }
+    dependent_tag_names.should == %w{omg w_t_f f_t_w}
+    
+    dependencies = @p.logic_tree.nodes['bacon'].dependencies_on
+    dependencies['&&'].should be_nil
+    dependencies['||'].should == [
+      {'omg' => [{ :match_key => 'crispy', :is_not => false }]},
+      {"||"=>[
+        {'&&' => [
+          {'w_t_f' => [{ :match_key => 'rtfm', :is_not => false }]},
+          {'f_t_w' => [{ :match_key => 'rtfm', :is_not => false }]}
+        ]},
+        {'f_t_w' => [{ :match_key => 'lmao', :is_not => false }]}
+      ]}
+    ]
+  end
+  
+  it "is aware of only-if group" do
+    @p = Parser.new(<<-HTML)
+      <cml:text label="OMG" />
+      <cml:group only-if="omg">
+        <cml:checkboxes label="w t f">
+          <cml:checkbox label="lol" />
+          <cml:checkbox label="rtfm" />
+        </cml:checkboxes>
+        <cml:radios label="bacon">
+          <cml:radio label="tasty" />
+          <cml:radio label="too meaty" />
+        </cml:radios>
+      </cml:group>
+    HTML
+    dependent_tag_names = @p.logic_tree.nodes['w_t_f'].depends_on.collect {|n| n.tag.name }
+    dependent_tag_names.should == %w{omg}
+    dependent_tag_names = @p.logic_tree.nodes['bacon'].depends_on.collect {|n| n.tag.name }
+    dependent_tag_names.should == %w{omg}
+    
+    dependencies = @p.logic_tree.nodes['w_t_f'].dependencies_on
+    dependencies['||'].should == [{'omg' => [{ :match_key => nil, :is_not => true }]}]
+    dependencies['&&'].should be_nil
+    
+    dependencies = @p.logic_tree.nodes['bacon'].dependencies_on
+    dependencies['||'].should == [{'omg' => [{ :match_key => nil, :is_not => true }]}]
+    dependencies['&&'].should be_nil
+  end
+  
+  it "is aware of nested only-if group" do
+    @p = Parser.new(<<-HTML)
+      <cml:text label="OMG" />
+      <cml:group only-if="omg">
+        <cml:checkboxes label="w t f">
+          <cml:checkbox label="lol" />
+          <cml:checkbox label="rtfm" />
+        </cml:checkboxes>
+        <cml:group only-if="!w_t_f:[rtfm]">
+          <cml:radios label="bacon">
+            <cml:radio label="tasty" />
+            <cml:radio label="too meaty" />
+          </cml:radios>
+        </cml:group>
+      </cml:group>
+    HTML
+    dependent_tag_names = @p.logic_tree.nodes['w_t_f'].depends_on.collect {|n| n.tag.name }
+    dependent_tag_names.should == %w{omg}
+    dependent_tag_names = @p.logic_tree.nodes['bacon'].depends_on.collect {|n| n.tag.name }
+    dependent_tag_names.should == %w{omg w_t_f}
+    
+    dependencies = @p.logic_tree.nodes['w_t_f'].dependencies_on
+    dependencies['||'].should == [
+      {'omg' => [{ :match_key => nil, :is_not => true }]}
+    ]
+    dependencies['&&'].should be_nil
+    
+    dependencies = @p.logic_tree.nodes['bacon'].dependencies_on
+    dependencies['||'].should == [
+      {'omg' => [{ :match_key => nil, :is_not => true }]},
+      {'w_t_f' => [{ :match_key => 'rtfm', :is_not => true }]}
+    ]
+    dependencies['&&'].should be_nil
+  end
+  
+  it "lists a simple only-if selector with indexed match" do
+    @p = Parser.new(<<-HTML)
+      <cml:checkboxes label="w t f">
+        <cml:checkbox label="lol" />
+        <cml:checkbox label="rtfm" />
+      </cml:checkboxes>
+      <cml:text label="OMG" only-if="w_t_f:[1]" />
+    HTML
+    
+    dependent_tag_names = @p.logic_tree.nodes['omg'].depends_on.collect {|n| n.tag.name }
+    dependent_tag_names.should == %w{w_t_f}
+    
+    dependencies = @p.logic_tree.nodes['omg'].dependencies_on
+    dependencies['||'].should == [
+      {'w_t_f' => [{ :match_key => 'rtfm', :is_not => false }]}
+    ]
+  end
+  
+end