formdown 0.0.1 → 0.0.2

data/README.md

@@ -89,15 +89,25 @@ In the rails Gemfile, include the formdown gem via:
 gem "formdown", require: "formdown/rails"
 ```
 
-Rails will pick up files with the extension `.fmd` and render them as HTML. For example, `app/views/user/my_form.fmd.html` would render the formdown document.
+Rails will pick up files with the extension `.fmd` and render them as HTML. For example, `app/views/user/my_form.html.fmd` would render the formdown document.
 
 Its recommended to use a layout around the Formdown file to handle the form submission action and surrounding HTML content.
 
 **Note**: There's currently no simple way of mapping Formdown fields to ActiveRecord model attributes.
 
+### Middleman
+
+In the Gemfile, include the formdown gem via:
+
+```ruby
+gem "formdown", require: "formdown/tilt"
+```
+
+Place your Formdown file in the [Middleman](http://middlemanapp.com/) source directory and the form will render (e.g. `source/my_form.html.fmd` will render the form at `/my_form.html`)
+
 ## Contributing
 
-1. Fork it ( https://github.com/[my-github-username]/formdown/fork )
+1. Fork it ( https://github.com/bradgessler/formdown/fork )
 2. Create your feature branch (`git checkout -b my-new-feature`)
 3. Commit your changes (`git commit -am 'Add some feature'`)
 4. Push to the branch (`git push origin my-new-feature`)

data/lib/formdown/rails.rb

@@ -16,4 +16,4 @@ module ActionView
 end
 
 # Register in the rails stack.
-ActionView::Template.register_template_handler(:fmd, ActionView::Template::Handlers::Formdown.new)
+ActionView::Template.register_template_handler(*Formdown::FILE_EXTENSIONS, ActionView::Template::Handlers::Formdown.new)

data/lib/formdown/renderer.rb

@@ -0,0 +1,15 @@
+require 'kramdown'
+require 'kramdown/parser/formdown'
+require 'kramdown/document'
+
+module Formdown
+  class Renderer
+    def initialize(content)
+      @document = ::Kramdown::Document.new(content, input: 'Formdown')
+    end
+
+    def to_html
+      @document.to_html
+    end
+  end
+end

data/lib/formdown/tilt.rb

@@ -0,0 +1,6 @@
+require 'tilt'
+require 'tilt/formdown'
+
+# TODO - Support lazy registration when Middleman supports Tilt 2.x.
+# Tilt.register_lazy :FormdownTemplate, 'tilt/formdown', 'formdown', 'fmd'
+Tilt.register Tilt::FormdownTemplate, *Formdown::FILE_EXTENSIONS

data/lib/formdown/version.rb

@@ -1,3 +1,3 @@
 module Formdown
-  VERSION = "0.0.1"
+  VERSION = "0.0.2"
 end

data/lib/formdown.rb

@@ -1,95 +1,8 @@
-require "formdown/version"
-
-# Formdown extends the Markdown language with practical HTML form builder syntax.
-#
-# TODO
-# - name: parameters should be applied at a different layer, NOT within this file. This will
-#   make sure that we don't clobber the users form submissions.
-# - DRY up the methods below into more of a macro language. The constants, extractions, etc.
-#   are a common pattern.
-
-require 'kramdown'
-require 'kramdown/parser/kramdown'
-require 'kramdown/document'
-
-module Formdown
-  class Parser < Kramdown::Parser::Kramdown
-    def initialize(source, options)
-      super
-      @span_parsers.unshift :text_fields, :text_areas, :checkboxes, :buttons, :radio_buttons
-    end
-
-    TEXT_FIELD_START = /(_+)([@\#]?)\((.+?)\)/
-
-    def parse_text_fields
-      @src.pos += @src.matched_size
-      line, type, placeholder = TEXT_FIELD_START.match(@src.matched).captures
-      # Optionally pull out email or number types.
-      type = case type
-      when '@' then :email
-      when '#' then :number
-      else :text
-      end
-      @tree.children << Element.new(:html_element, :input, type: type, placeholder: placeholder, name: placeholder, size: line.size)
-    end
-    define_parser(:text_fields, TEXT_FIELD_START, '_{')
-
-
-    TEXT_AREA_START = /(_+)(\/+)\((.+?)\)/
-
-    def parse_text_areas
-      @src.pos += @src.matched_size
-      col, rows, placeholder = TEXT_AREA_START.match(@src.matched).captures
-      @tree.children << Element.new(:html_element, :textarea, placeholder: placeholder, name: placeholder, cols: col.size, rows: rows.size)
-    end
-    define_parser(:text_areas, TEXT_AREA_START, '_/')
-
-
-    CHECKBOX_FIELD_START = /\[([\sxX])?\]/
-
-    def parse_checkboxes
-      @src.pos += @src.matched_size
-      @tree.children << Element.new(:html_element, :input, type: :checkbox)
-    end
-    define_parser(:checkboxes, CHECKBOX_FIELD_START, '\[')
-
-    RADIO_BUTTON_FIELD_START = /\(([\sxX])?\)/
-
-    def parse_radio_buttons
-      @src.pos += @src.matched_size
-      @tree.children << Element.new(:html_element, :input, type: :radio)
-    end
-    define_parser(:radio_buttons, RADIO_BUTTON_FIELD_START, '\(')
-
-    BUTTON_START = /\[\s(.+)\s\]([\!])?/
-
-    def parse_buttons
-      @src.pos += @src.matched_size
-      value, type = BUTTON_START.match(@src.matched).captures
-      type = case type
-      when '!' then :submit
-      # else :button
-      else :submit # TODO - Should we even support other types of buttons? Probably not... just make it a submit.
-      end
-      @tree.children << Element.new(:html_element, :input, type: type, value: value)
-    end
-    define_parser(:buttons, BUTTON_START, '\[')
-  end
-end
-
-# Work around to get this build passing for Ruby 1.9 since the kramdown Parser.const_get()
-# TODO - Patch kramdown to work with nested namespaces in Ruby 1.9.
-# Details about the issue noted at https://github.com/gettalong/kramdown/commit/cd5423f23eb783a2c435e8545a98625cb280f286#diff-1f46a84d29e6ac9751ae5d75bafc25aeR88
-FormdownParser = Formdown::Parser
+require 'formdown/version'
 
 module Formdown
-  class Renderer
-    def initialize(content)
-      @document = ::Kramdown::Document.new(content, input: 'FormdownParser')
-    end
+  # File extensions for various template handlers.
+  FILE_EXTENSIONS = %w[formdown fmd].freeze
 
-    def to_html
-      @document.to_html
-    end
-  end
+  autoload :Renderer, 'formdown/renderer'
 end

data/lib/kramdown/parser/formdown.rb

@@ -0,0 +1,76 @@
+require 'kramdown/parser/kramdown'
+
+# Formdown extends the Markdown language with practical HTML form builder syntax.
+#
+# TODO
+# - name: Form values should be applied at a different layer, NOT within this file. This will
+#   make sure that we don't clobber the users form submissions.
+# - DRY up the methods below into more of a macro language. The constants, extractions, etc.
+#   are a common pattern.
+
+module Kramdown
+  module Parser
+    class Formdown < Kramdown::Parser::Kramdown
+      def initialize(source, options)
+        super
+        @span_parsers.unshift :text_fields, :text_areas, :checkboxes, :buttons, :radio_buttons
+      end
+
+      TEXT_FIELD_START = /(_+)([@\#]?)\((.+?)\)/
+
+      def parse_text_fields
+        @src.pos += @src.matched_size
+        line, type, placeholder = TEXT_FIELD_START.match(@src.matched).captures
+        # Optionally pull out email or number types.
+        type = case type
+        when '@' then :email
+        when '#' then :number
+        else :text
+        end
+        @tree.children << Element.new(:html_element, :input, type: type, placeholder: placeholder, name: placeholder, size: line.size)
+      end
+      define_parser(:text_fields, TEXT_FIELD_START, '_{')
+
+
+      TEXT_AREA_START = /(_+)(\/+)\((.+?)\)/
+
+      def parse_text_areas
+        @src.pos += @src.matched_size
+        col, rows, placeholder = TEXT_AREA_START.match(@src.matched).captures
+        @tree.children << Element.new(:html_element, :textarea, placeholder: placeholder, name: placeholder, cols: col.size, rows: rows.size)
+      end
+      define_parser(:text_areas, TEXT_AREA_START, '_/')
+
+
+      CHECKBOX_FIELD_START = /\[([\sxX])?\]/
+
+      def parse_checkboxes
+        @src.pos += @src.matched_size
+        @tree.children << Element.new(:html_element, :input, type: :checkbox)
+      end
+      define_parser(:checkboxes, CHECKBOX_FIELD_START, '\[')
+
+      RADIO_BUTTON_FIELD_START = /\(([\sxX])?\)/
+
+      def parse_radio_buttons
+        @src.pos += @src.matched_size
+        @tree.children << Element.new(:html_element, :input, type: :radio)
+      end
+      define_parser(:radio_buttons, RADIO_BUTTON_FIELD_START, '\(')
+
+      BUTTON_START = /\[\s(.+)\s\]([\!])?/
+
+      def parse_buttons
+        @src.pos += @src.matched_size
+        value, type = BUTTON_START.match(@src.matched).captures
+        type = case type
+        when '!' then :submit
+        # else :button
+        else :submit # TODO - Should we even support other types of buttons? Probably not... just make it a submit.
+        end
+        @tree.children << Element.new(:html_element, :input, type: type, value: value)
+      end
+      define_parser(:buttons, BUTTON_START, '\[')
+    end
+  end
+end

data/lib/tilt/formdown.rb

@@ -0,0 +1,31 @@
+require 'formdown'
+require 'tilt/template'
+
+module Tilt
+  class FormdownTemplate < Template
+    # DUMB_QUOTES = [39, 39, 34, 34]
+
+    def self.engine_initialized?
+      defined? ::Formdown
+    end
+
+    def initialize_engine
+      require_template_library 'formdown'
+    end
+
+    def prepare
+      # options[:smart_quotes] = DUMB_QUOTES unless options[:smartypants]
+      # @engine = Formdown::Document.new(data, options)
+      @engine = Formdown::Renderer.new(data)
+      @output = nil
+    end
+
+    def evaluate(scope, locals, &block)
+      @output ||= @engine.to_html
+    end
+
+    def allows_script?
+      false
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: formdown
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-08-02 00:00:00.000000000 Z
+date: 2014-08-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: kramdown
@@ -111,7 +111,11 @@ files:
 - lib/formdown.rb
 - lib/formdown/cli.rb
 - lib/formdown/rails.rb
+- lib/formdown/renderer.rb
+- lib/formdown/tilt.rb
 - lib/formdown/version.rb
+- lib/kramdown/parser/formdown.rb
+- lib/tilt/formdown.rb
 - spec/fixtures/kitchen_sink.fmd
 - spec/formdown_spec.rb
 - spec/spec_helper.rb