former 0.0.2 → 1.0.0

data/.ruby-gemset

@@ -0,0 +1 @@
+former

data/.ruby-version

@@ -0,0 +1 @@
+ruby-1.9.3-p392

data/README.rdoc

@@ -32,15 +32,14 @@ In this example, we want to be able to edit the location of all links that have
 To produce the input fields from some example input HTML, first create an instance of your parser.
 
   parsed = Parser.new "<p>some text<a class='important' href='http://alink.com'>some link text<img src='/an/image/path' /></a>last text</p>"
-  puts parsed.to_form_html
 
-This will output:
+Then, we can get information about the editable fields:
 
-  <input name="former_0" type="text" value="some text" />
-  <input name="former_1" type="text" value="http://alink.com" />
-  <input name="former_2" type="text" value="some link text" />
-  <input name="former_3" type="text" value="/an/image/path" />
-  <input name="former_4" type="text" value="last text" />
+  parsed.each { |elem| puts "#{elem.node.name} is #{elem.value}" }
+
+And, even create an html form from this:
+
+  parsed.each { |elem| puts "<input name='former_0' type='text' value='#{elem.value}' />" }
 
 You can also convert the original html to json:
 
@@ -61,14 +60,12 @@ Will produce the original html with the new field values:
 
   <p>A New Description<a class='important' href='http://anewlink.com'>some link...
 
-By default, the fields created are input's.  If you pass a block to the attr/text class methods, though, you can create your own.
+If you want finer grained control over what's considered an editable element, you can pass a block in as well to the attr method.  For instance, if you want only text fields that are not empty, you could use:
 
   class Parser < Former::Builder
-    attr "a.important", :href
-    attr("img", :src) { |elem, name|
-      # If the src url is a really long bit of text, you could do something like this.
-      # The name is the name (which has the index) necessary to set the value on a GET/POST
-      "<textarea name='#{name}'></textarea>"
-    }
-    text "p", "a.important"
+    text("p", "a.important") { |elem| not elem.text.strip.empty? }
   end
+
+  p = Parser.new("<p>\n</p><p>some text</p>").length # this is only 1
+  p[0] = 'other text'
+  p.to_html # => '<p>\n</p><p>other text</p>'

data/former.gemspec

@@ -14,7 +14,6 @@ Gem::Specification.new do |gem|
   gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
   gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
   gem.require_paths = ["lib"]
-  gem.add_dependency("actionpack", ">= 4.0.3")
   gem.add_dependency("nokogiri", ">= 1.6.0")
   gem.add_development_dependency("rake")
   gem.add_development_dependency("rdoc")

data/lib/former/builder.rb

@@ -9,8 +9,8 @@ module Former
       @html = Nokogiri::HTML.parse(html)
 
       matches = {}
-      self.class.queries.each { |path, qs|
-        @html.search(path).each { |node| 
+      self.class.queries.each do |path, qs|
+        @html.search(path).each do |node| 
           # if all we need is the text, only include text kids
           if qs.length == 1 and qs.first[:query] == :text
             node.traverse { |e| matches[e] = qs if e.text? and not matches.keys.include? e }
@@ -18,23 +18,29 @@ module Former
             # otherwise, ignore just text requests
             matches[node] = qs.select { |q| q[:query] != :text }
           end
-        }
-      }
+        end
+      end
 
       @editable = []
-      @html.traverse_prefix { |e|
-        (matches[e] || []).each { |query| 
-          @editable << Element.new(e, query[:query], @editable.length, query[:block]) 
-        }
-      }
+      @html.traverse_prefix do |e|
+        (matches[e] || []).each do |query|
+          if query[:block].nil? or query[:block].call(e)
+            @editable << Element.new(e, query[:query], @editable.length)
+          end
+        end
+      end
+      
+      # if we were given text only (no html), nokogiri will helpfully
+      # wrap it in a <p> - but our output should just be text.  So remember.
+      @nothtml = (@editable.length == 1 and @html.text == html)
     end
 
-    def each(&block)
-      @editable.each { |e| block.call(e) }
+    def length
+      @editable.length
     end
 
-    def to_form_html
-      @editable.map(&:to_form_html).join("\n")
+    def each(&block)
+      @editable.each { |e| block.call(e) }
     end
 
     def to_json
@@ -42,12 +48,15 @@ module Former
     end
 
     def to_html
-      # nokogiri pads w/ xhtml/body elements
-      @html.search("//body").first.children.map(&:to_html).join
+      return @html.text if @nothtml
+      # nokogiri pads w/ html/body elements
+      @html.xpath("/html/body").children.map { |c|
+        c.serialize(:save_with => Nokogiri::XML::Node::SaveOptions::AS_HTML).strip
+      }.join
     end
 
     def []=(index, value)
-      @editable[index].set_value value
+      @editable[index].value = value
     end
 
     # vals should be { :former_0 => 'value', :former_1 => 'value two', ... }

data/lib/former/element.rb

@@ -1,15 +1,12 @@
-require 'action_view'
 require 'json'
 
 module Former
   class Element
-    include ActionView::Helpers::TagHelper
-    attr_reader :node, :query, :block
+    attr_reader :node, :query
 
-    def initialize(node, query, index, block)
+    def initialize(node, query, index)
       @node = node
       @query = query
-      @block = block
       @index = index
     end
 
@@ -22,14 +19,11 @@ module Former
       h.to_json
     end
 
-    def to_form_html
-      name = "former_#{@index}"
-      return @block.call(@node, name) unless @block.nil?
-      value = (@query == :text) ? @node.text : @node[@query]
-      tag(:input, :type => 'text', :name => name, :value => value)
+    def value
+      @query == :text ? @node.content : @node[@query]
     end
 
-    def set_value(value)
+    def value=(value)
       if @query == :text
         @node.content = value
       else

data/lib/former/version.rb

@@ -1,3 +1,3 @@
 module Former
-  VERSION = "0.0.2"
+  VERSION = "1.0.0"
 end

data/test/builder_test.rb

@@ -13,12 +13,36 @@ class AllTextParser < Former::Builder
   text
 end
 
+class AllTextParserNotBlank < Former::Builder
+  attr "a.important", :href
+  attr("img", :src)
+  text { |e| not e.text.strip.empty? }
+end
+
 class BuilderTest < Test::Unit::TestCase
   def setup
     @html_txt = '<p>some text<a class="important" href="http://alink.com">some link text<img src="/an/image/path"></a>last text</p>'
     @parser = Parser.new @html_txt
   end
 
+  def test_ignore_blank_fields
+    p = AllTextParserNotBlank.new "<p>\n</p><h1>  </h1><p> some text </p>"
+    assert_equal p.length, 1
+    p[0] = "other text"
+    assert_equal "<p>\n</p><h1>  </h1><p>other text</p>", p.to_html
+
+    p = AllTextParserNotBlank.new "<p>\n</p><h1>  </h1> some text <p></p>"
+    assert_equal p.length, 1
+    p[0] = "other text"
+    assert_equal "<p>\n</p><h1>  </h1>other text<p></p>", p.to_html
+  end
+
+  def test_nohtml
+    p = Parser.new "some text that is long, and contains stuff!"
+    p.set_values :former_0 => "some other text"
+    assert_equal p.to_html, "some other text"
+  end
+
   def test_parsing
     assert_equal @parser.editable.length, 5
 
@@ -42,6 +66,6 @@ class BuilderTest < Test::Unit::TestCase
 
     # now set it back
     @parser.set_values :former_0 => "some text"
-    @parser = Parser.new @html_txt
+    assert_equal @parser.to_html, @html_txt
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: former
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 1.0.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,24 +9,8 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-02-27 00:00:00.000000000 Z
+date: 2014-03-08 00:00:00.000000000 Z
 dependencies:
-- !ruby/object:Gem::Dependency
-  name: actionpack
-  requirement: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: 4.0.3
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: 4.0.3
 - !ruby/object:Gem::Dependency
   name: nokogiri
   requirement: !ruby/object:Gem::Requirement
@@ -83,6 +67,8 @@ extensions: []
 extra_rdoc_files: []
 files:
 - .gitignore
+- .ruby-gemset
+- .ruby-version
 - Gemfile
 - LICENSE.txt
 - README.rdoc
@@ -108,7 +94,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 4374242057553143574
+      hash: 4051511182999902248
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -117,7 +103,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 4374242057553143574
+      hash: 4051511182999902248
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.25