former 0.0.1

data/.gitignore

@@ -0,0 +1,18 @@
+docs
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Brian Muller
+
+MIT License
+
+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,68 @@
+= Former
+
+Former turns an html string into a set of editable fields.  For instance, if you want to give users the ability to edit certain parts of pregenerated HTML (like the href's of a's), this gem makes it easy to create the form and handle user input.
+
+== Installation
+
+Add this line to your application's Gemfile:
+
+   gem 'former'
+
+And then execute:
+
+   $ bundle
+
+Or install it yourself as:
+
+   $ gem install former
+
+== Usage
+First, create a new parser that extends Builder class.
+
+  class Parser < Former::Builder
+    attr "a.important", :href
+    attr "img", :src
+    text "p", "a.important"
+  end
+
+In this example, we want to be able to edit the location of all links that have a class of "important", the location of all images, and the text in any paragraphs or important links.
+
+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:
+
+  <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" />
+
+You can then set fields individually or as a group (with, say, the params from a POST/GET):
+
+  parsed[0] = "A New Description"
+  parsed[1] = "http://anewlink.com"
+  # or...
+  parsed.set_values :former_0 => "A New Description", :former_1 => "http://anewlink.com"
+
+When the new values have been set, you can spit out the new HTML version:
+
+  puts parsed.to_html
+
+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.
+
+  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"
+  end

data/Rakefile

@@ -0,0 +1,19 @@
+require "bundler/gem_tasks"
+require 'rdoc/task'
+require 'rake/testtask'
+
+task :default => [:test]
+
+RDoc::Task.new("doc") { |rdoc|
+  rdoc.title = "Former - convert HTML to input forms for editable values"
+  rdoc.rdoc_dir = 'docs'
+  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+}
+
+desc "Run all unit tests"
+Rake::TestTask.new("test") { |t|
+  t.libs << "lib"
+  t.test_files = FileList['test/*.rb']
+  t.verbose = true
+}

data/former.gemspec

@@ -0,0 +1,21 @@
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'former/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = "former"
+  gem.version       = Former::VERSION
+  gem.authors       = ["Brian Muller"]
+  gem.email         = ["bamuller@gmail.com"]
+  gem.description   = "Converts HTML to form fields for editing values in the HTML"
+  gem.summary       = "Converts HTML to form fields for editing values in the HTML"
+  gem.homepage      = "http://github.com/opbandit/former"
+  gem.files         = `git ls-files`.split($/)
+  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", ">= 3.2.0")
+  gem.add_dependency("nokogiri", ">= 1.5.6")
+  gem.add_development_dependency("rake")
+  gem.add_development_dependency("rdoc")
+end

data/lib/former/builder.rb

@@ -0,0 +1,65 @@
+require 'nokogiri'
+
+module Former
+  class Builder
+    attr_reader :editable
+
+    def initialize(html)
+      @html = Nokogiri::HTML.parse(html)
+
+      matches = {}
+      @@queries.each { |path, qs|
+        @html.search(path).each { |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 }
+          else
+            # otherwise, ignore just text requests
+            matches[node] = qs.select { |q| q[:query] != :text }
+          end
+        }
+      }
+
+      @editable = []
+      @html.traverse_prefix { |e|
+        (matches[e] || []).each { |query| 
+          @editable << Element.new(e, query[:query], @editable.length, query[:block]) 
+        }
+      }
+    end
+
+    def each(&block)
+      @editable.each { |e| block.call(e) }
+    end
+
+    def to_form_html
+      @editable.map { |e| e.to_form_html }.join("\n")
+    end
+
+    def to_html
+      # nokogiri pads w/ xhtml/body elements
+      @html.search("//body").first.children.first.to_html
+    end
+
+    def []=(index, value)
+      @editable[index].set_value value
+    end
+
+    # vals should be { :former_0 => 'value', :former_1 => 'value two', ... }
+    def set_values(vals)
+      vals.each { |key, value|
+        self[key.to_s.split('_').last.to_i] = value
+      }
+    end
+
+    def self.attr(elem, attr, &block)
+      @@queries ||= {}
+      @@queries[elem] ||= []
+      @@queries[elem] << { :query => attr, :block => block }
+    end
+    
+    def self.text(*elems, &block)
+      elems.each { |elem| attr(elem, :text, &block) }
+    end
+  end
+end

data/lib/former/element.rb

@@ -0,0 +1,34 @@
+require 'action_view'
+
+module Former
+  class Element
+    include ActionView::Helpers::TagHelper
+    attr_reader :node, :query, :block
+
+    def initialize(node, query, index, block)
+      @node = node
+      @query = query
+      @block = block
+      @index = index
+    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)
+    end
+
+    def set_value(value)
+      if @query == :text
+        @node.content = value
+      else
+        @node[@query] = value
+      end
+    end
+
+    def to_html
+      @node.to_html
+    end
+  end
+end

data/lib/former/ext.rb

@@ -0,0 +1,10 @@
+module Nokogiri
+  module XML
+    class Node
+      def traverse_prefix(&block)
+        block.call(self)
+        children.each{ |j| j.traverse_prefix(&block) }
+      end
+    end
+  end
+end

data/lib/former/version.rb

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

data/lib/former.rb

@@ -0,0 +1,4 @@
+require "former/version"
+require "former/builder"
+require "former/element"
+require "former/ext"

data/test/builder_test.rb

@@ -0,0 +1,31 @@
+require 'test/unit'
+require 'former'
+
+class Parser < Former::Builder
+  attr "a.important", :href
+  attr("img", :src)
+  text "p", "a.important"
+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
+    puts @parser.to_form_html
+  end
+
+  def test_parsing
+    assert_equal @parser.editable.length, 5
+  end
+
+  def test_building
+    assert_equal @parser.to_html, @html_txt
+    new_html_txt = '<p>some new text<a class="important" href="http://alink.com">some link text<img src="/an/image/path"></a>last text</p>'
+    @parser[0] = "some new text"
+    assert_equal @parser.to_html, new_html_txt
+
+    # now set it back
+    @parser.set_values :former_0 => "some text"
+    @parser = Parser.new @html_txt
+  end
+end

metadata

@@ -0,0 +1,115 @@
+--- !ruby/object:Gem::Specification 
+name: former
+version: !ruby/object:Gem::Version 
+  prerelease: 
+  version: 0.0.1
+platform: ruby
+authors: 
+- Brian Muller
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2013-02-19 00:00:00 Z
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: actionpack
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 3.2.0
+  type: :runtime
+  prerelease: false
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: nokogiri
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 1.5.6
+  type: :runtime
+  prerelease: false
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: rake
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+  type: :development
+  prerelease: false
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  name: rdoc
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+  type: :development
+  prerelease: false
+  version_requirements: *id004
+description: Converts HTML to form fields for editing values in the HTML
+email: 
+- bamuller@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.rdoc
+- Rakefile
+- former.gemspec
+- lib/former.rb
+- lib/former/builder.rb
+- lib/former/element.rb
+- lib/former/ext.rb
+- lib/former/version.rb
+- test/builder_test.rb
+homepage: http://github.com/opbandit/former
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: -2404963171909705179
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: -2404963171909705179
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: Converts HTML to form fields for editing values in the HTML
+test_files: 
+- test/builder_test.rb