formdown 0.0.2 → 0.0.4

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 1549297498d9dce25034c8514c18eb75b7cd378a
+  data.tar.gz: b312a44329b33023ce71768e3a26cdaa6ce1e6a2
+SHA512:
+  metadata.gz: 76585ef8f072bbc83129be9b46d8ba43d98a440779ef82ecb196fda46148c646dace2010dcc522bc5b33cf84d0c83331f6e81346b5f974fc511a9706037dc7af
+  data.tar.gz: df513b223b78e76083003b933e4209dc23b4cfe2cb8e0b5d14cadbb10434cc4d8ed85641ffce69f9950331ea40d3ea8b64ec62a685ce3cb73480e0b15e2f4fcb

data/README.md

@@ -39,31 +39,57 @@ Generates the following HTML:
 
 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
+## Installation & Usage
 
-Add this line to your application's Gemfile:
+Formdown works in most popular Ruby web frameworks, the command lin, and of course plain 'ol Ruby.
+
+### Rails
+
+In the rails Gemfile, include the formdown gem via:
 
 ```ruby
-gem 'formdown'
+gem "formdown", require: "formdown/rails"
 ```
 
-or for Rails:
+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.
+
+### Sinatra
+
+In the Gemfile, include the formdown gem via:
 
 ```ruby
-gem 'formdown', require: 'formdown/rails'
+gem "formdown", require: "sinatra/formdown"
 ```
 
-And then execute:
+Place your Formdown file in the [Sinatra](http://www.sinatrarb.com/) `./views` directory (e.g. `views/my_form.html.fmd`), then add the following route to your Sinatra app:
 
-    $ bundle
+```ruby
+get '/my_form' do
+  formdown :my_form
+end
+```
 
-Or install it yourself as:
+and the form will render at `/my_form`.
 
-    $ gem install formdown
+### Middleman
+
+In the Gemfile, include the formdown gem via:
+
+```ruby
+gem "formdown", require: "middleman/formdown"
+```
+
+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`)
 
-## Usage
+### Command line
 
-### CLI
+Install the gem:
+
+    $ gem install formdown
 
 The quickest way to render Formdown is via the command line. Just cat your file into the render and you'll get HTML:
 
@@ -75,36 +101,24 @@ 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:
+Add this line to your application's Gemfile:
 
 ```ruby
-gem "formdown", require: "formdown/rails"
+gem 'formdown'
 ```
 
-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.
+And then execute:
 
-### Middleman
+    $ bundle
 
-In the Gemfile, include the formdown gem via:
+Write the following code in your Ruby application to compile the Formdown:
 
 ```ruby
-gem "formdown", require: "formdown/tilt"
+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"
 ```
 
-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/bradgessler/formdown/fork )

data/lib/formdown/cli.rb

@@ -10,4 +10,9 @@ class Formdown::CLI < Thor
       puts Formdown::Renderer.new($stdin.read).to_html 
     end
   end
+
+  desc "version", "Print the version of formdown"
+  def version
+    puts Formdown::VERSION
+  end
 end

data/lib/formdown/version.rb

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

data/lib/middleman/formdown.rb

@@ -0,0 +1,3 @@
+# We only need to initialize Tilt::FormdownTemplate
+# to work with Middleman.
+require 'tilt/formdown'

data/lib/sinatra/formdown.rb

@@ -0,0 +1,18 @@
+require 'sinatra/base'
+require 'tilt/formdown'
+
+module Sinatra
+  module Formdown
+    module Helpers
+      def formdown(template, options = {}, locals = {}, &block)
+        render(:formdown, template, options, locals, &block)
+      end
+    end
+
+    def self.registered(app)
+      app.helpers Formdown::Helpers
+    end
+  end
+  
+  register Formdown
+end

data/lib/tilt/formdown.rb

@@ -28,4 +28,8 @@ module Tilt
       false
     end
   end
-end
+end
+
+# 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

metadata

@@ -1,8 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: formdown
 version: !ruby/object:Gem::Version
-  version: 0.0.2
-  prerelease: 
+  version: 0.0.4
 platform: ruby
 authors:
 - Brad Gessler
@@ -14,81 +13,71 @@ 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: 
@@ -99,9 +88,9 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
-- .gitignore
-- .rspec
-- .travis.yml
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
 - Gemfile
 - LICENSE.txt
 - README.md
@@ -112,9 +101,10 @@ files:
 - 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/middleman/formdown.rb
+- lib/sinatra/formdown.rb
 - lib/tilt/formdown.rb
 - spec/fixtures/kitchen_sink.fmd
 - spec/formdown_spec.rb
@@ -122,30 +112,28 @@ files:
 homepage: ''
 licenses:
 - MIT
+metadata: {}
 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
+rubygems_version: 2.2.2
 signing_key: 
-specification_version: 3
+specification_version: 4
 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: 

data/lib/formdown/tilt.rb

@@ -1,6 +0,0 @@
-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