formdown 0.0.1

data/.gitignore

@@ -0,0 +1,14 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/.rspec

@@ -0,0 +1,3 @@
+--color
+--warnings
+--require spec_helper

data/.travis.yml

@@ -0,0 +1,4 @@
+script: bundle exec rspec spec
+rvm:
+  - 1.9.3
+  - 2.1.0

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Brad Gessler
+
+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.md

@@ -0,0 +1,104 @@
+[![Build Status](https://travis-ci.org/bradgessler/formdown.svg?branch=master)](https://travis-ci.org/bradgessler/formdown)
+
+# Formdown
+
+Build HTML forms with the simplicity of [Markdown](http://daringfireball.net/projects/markdown/). In other words, markdown like:
+
+```markdown
+Hi _________(Name)
+
+How are you doing today? () Good () Ok () Bad
+
+Could I have your email address? __________@(Email)
+
+Write a few lines that describe your mood: ____________///(Mood)
+
+[ Submit your feelings ]
+```
+
+Generates the following HTML:
+
+```html
+<p>Hi   <input type="text" placeholder="Name" name="Name" size="9"></input>
+</p>
+
+<p>How are you doing today?   <input type="radio"></input>
+ Good   <input type="radio"></input>
+ Ok   <input type="radio"></input>
+ Bad</p>
+
+<p>Could I have your email address?   <input type="email" placeholder="Email" name="Email" size="10"></input>
+</p>
+
+<p>Write a few lines that describe your mood:   <textarea placeholder="Mood" name="Mood" cols="12" rows="3"></textarea>
+</p>
+
+<p>  <input type="submit" value="Submit your feelings"></input>
+</p>
+```
+
+A more extensive reference of Formdown in action may be found in the [kitchen sink](./spec/fixtures/kitchen_sink.fmd) fmd file. As this gem matures more extensive syntax documentation will be created for version 1.0.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'formdown'
+```
+
+or for Rails:
+
+```ruby
+gem 'formdown', require: 'formdown/rails'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install formdown
+
+## Usage
+
+### CLI
+
+The quickest way to render Formdown is via the command line. Just cat your file into the render and you'll get HTML:
+
+```sh
+$ cat my_form.fmd | formdown render > my_form.html
+```
+
+Now open `my_form.html` and enjoy all of that HTML goodness.
+
+### Ruby
+
+```ruby
+text = "What is your email address? _________@(Email)"
+formdown = Formdown::Renderer.new(text)
+formdown.to_html # => "<p>What is your email address?   <input type=\"email\" placeholder=\"Email\" name=\"Email\" size=\"9\"></input>\n</p>\n"
+```
+
+### Rails
+
+In the rails Gemfile, include the formdown gem via:
+
+```ruby
+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.
+
+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.
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/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`)
+5. Create a new Pull Request

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+

data/bin/formdown

@@ -0,0 +1,5 @@
+#!/usr/bin/env ruby
+
+require 'formdown/cli'
+
+Formdown::CLI.start

data/formdown.gemspec

@@ -0,0 +1,26 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'formdown/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "formdown"
+  spec.version       = Formdown::VERSION
+  spec.authors       = ["Brad Gessler"]
+  spec.email         = ["bradgessler@gmail.com"]
+  spec.summary       = %q{A Markdown-like syntax for web forms.}
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "kramdown", "~> 1.4"
+  spec.add_dependency "thor"
+
+  spec.add_development_dependency "bundler", "~> 1.6"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+end

data/lib/formdown/cli.rb

@@ -0,0 +1,13 @@
+require 'formdown'
+require 'thor'
+
+class Formdown::CLI < Thor
+  desc "render", "Render formdown file to html"
+  def render
+    if $stdin.tty?
+      error "Pipe Formdown into this command. Example: `$ echo 'Email: ____@(Email)' | formdown render`"
+    else
+      puts Formdown::Renderer.new($stdin.read).to_html 
+    end
+  end
+end

data/lib/formdown/rails.rb

@@ -0,0 +1,19 @@
+require 'formdown'
+
+# TODO - Implement rails auto-detection code so that we dont have to
+# `gem 'formdown', require: 'formdown/rails'` from the rails app Gemfile.
+module ActionView
+  module Template::Handlers
+    class Formdown
+      class_attribute :default_format
+      self.default_format = Mime::HTML
+
+      def call(template)
+        ::Formdown::Renderer.new(template.source).to_html.inspect
+      end
+    end
+  end
+end
+
+# Register in the rails stack.
+ActionView::Template.register_template_handler(:fmd, ActionView::Template::Handlers::Formdown.new)

data/lib/formdown/version.rb

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

data/lib/formdown.rb

@@ -0,0 +1,95 @@
+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
+
+module Formdown
+  class Renderer
+    def initialize(content)
+      @document = ::Kramdown::Document.new(content, input: 'FormdownParser')
+    end
+
+    def to_html
+      @document.to_html
+    end
+  end
+end

data/spec/fixtures/kitchen_sink.fmd

@@ -0,0 +1,18 @@
+Hi there __________(Name)
+
+How are you doing today? () Good () OK () Bad
+
+Please elaborate on those feelings: __________///(Description)
+
+Why do you think you feel that way?
+
+[] Because I accidentally swallowed a bug
+[] Its sunny outside
+[] I'm stuck under a cloud of fog
+[] I just ate a Twinkie and they're delicious!
+
+How many times did you sneeze today? __#(Sneezes)
+
+Please enter your email address: ____________@(Email)
+
+[ Submit response ]

data/spec/formdown_spec.rb

@@ -0,0 +1,30 @@
+require 'spec_helper'
+
+describe Formdown::Renderer do
+  subject { Formdown::Renderer.new(File.read('spec/fixtures/kitchen_sink.fmd')).to_html }
+  it "renders text input" do
+    expect(subject).to include(%(<input type="text" placeholder="Name" name="Name" size="10"></input>))
+  end
+
+  it "renders email input" do
+    expect(subject).to include(%(<input type="email" placeholder="Email" name="Email" size="12"></input>))
+  end
+
+  it "renders number input" do
+    expect(subject).to include(%(<input type="number" placeholder="Sneezes" name="Sneezes" size="2"></input>))
+  end
+
+  it "renders submit button" do
+    expect(subject).to include(%(<input type="submit" value="Submit response"></input>))
+  end
+
+  # TODO - Multiline text area inputs for readability.
+  it "renders textarea" do
+    expect(subject).to include(%(<textarea placeholder="Description" name="Description" cols="10" rows="3"></textarea>))
+  end
+
+  # TODO  - Make text to left, right of this be a lable.
+  #       - Support multi-line inputs that act like MD bullets
+  it "renders checkbox input"
+  it "renders radio buttons"
+end

data/spec/spec_helper.rb

@@ -0,0 +1,64 @@
+require 'formdown'
+
+RSpec.configure do |config|
+# The settings below are suggested to provide a good initial experience
+# with RSpec, but feel free to customize to your heart's content.
+=begin
+  # These two settings work together to allow you to limit a spec run
+  # to individual examples or groups you care about by tagging them with
+  # `:focus` metadata. When nothing is tagged with `:focus`, all examples
+  # get run.
+  config.filter_run :focus
+  config.run_all_when_everything_filtered = true
+
+  # Many RSpec users commonly either run the entire suite or an individual
+  # file, and it's useful to allow more verbose output when running an
+  # individual spec file.
+  if config.files_to_run.one?
+    # Use the documentation formatter for detailed output,
+    # unless a formatter has already been configured
+    # (e.g. via a command-line flag).
+    config.default_formatter = 'doc'
+  end
+
+  # Print the 10 slowest examples and example groups at the
+  # end of the spec run, to help surface which specs are running
+  # particularly slow.
+  config.profile_examples = 10
+
+  # Run specs in random order to surface order dependencies. If you find an
+  # order dependency and want to debug it, you can fix the order by providing
+  # the seed, which is printed after each run.
+  #     --seed 1234
+  config.order = :random
+
+  # Seed global randomization in this process using the `--seed` CLI option.
+  # Setting this allows you to use `--seed` to deterministically reproduce
+  # test failures related to randomization by passing the same `--seed` value
+  # as the one that triggered the failure.
+  Kernel.srand config.seed
+
+  # rspec-expectations config goes here. You can use an alternate
+  # assertion/expectation library such as wrong or the stdlib/minitest
+  # assertions if you prefer.
+  config.expect_with :rspec do |expectations|
+    # Enable only the newer, non-monkey-patching expect syntax.
+    # For more details, see:
+    #   - http://myronmars.to/n/dev-blog/2012/06/rspecs-new-expectation-syntax
+    expectations.syntax = :expect
+  end
+
+  # rspec-mocks config goes here. You can use an alternate test double
+  # library (such as bogus or mocha) by changing the `mock_with` option here.
+  config.mock_with :rspec do |mocks|
+    # Enable only the newer, non-monkey-patching expect syntax.
+    # For more details, see:
+    #   - http://teaisaweso.me/blog/2013/05/27/rspecs-new-message-expectation-syntax/
+    mocks.syntax = :expect
+
+    # Prevents you from mocking or stubbing a method that does not exist on
+    # a real object. This is generally recommended.
+    mocks.verify_partial_doubles = true
+  end
+=end
+end

metadata

@@ -0,0 +1,147 @@
+--- !ruby/object:Gem::Specification
+name: formdown
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Brad Gessler
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-08-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: kramdown
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.4'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.4'
+- !ruby/object:Gem::Dependency
+  name: thor
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: 
+email:
+- bradgessler@gmail.com
+executables:
+- formdown
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- .travis.yml
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/formdown
+- formdown.gemspec
+- lib/formdown.rb
+- lib/formdown/cli.rb
+- lib/formdown/rails.rb
+- lib/formdown/version.rb
+- spec/fixtures/kitchen_sink.fmd
+- spec/formdown_spec.rb
+- spec/spec_helper.rb
+homepage: ''
+licenses:
+- MIT
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.23
+signing_key: 
+specification_version: 3
+summary: A Markdown-like syntax for web forms.
+test_files:
+- spec/fixtures/kitchen_sink.fmd
+- spec/formdown_spec.rb
+- spec/spec_helper.rb
+has_rdoc: