backbone_form_helper 0.0.1 → 0.0.1.1.alpha

data/README.md

@@ -1,9 +1,19 @@
 # BackboneFormHelper
 
-TODO: Write a gem description
+This Rails gem provide javascript form helper based on Rails principle like 'f.text_field
+:name'. For each helper exist template so you can create your own
+template for each of them (eg. /templates/text_field). Now are templates
+created in Twitter bootstrap style.
+
+**This is still alpha.**
 
 ## Installation
 
+External dependencies:
+
+* underscore.js
+* coffee-rails for assets (now js are written in .coffee)
+
 Add this line to your application's Gemfile:
 
     gem 'backbone_form_helper'
@@ -16,9 +26,53 @@ Or install it yourself as:
 
     $ gem install backbone_form_helper
 
+
+Add this line into your application.js:
+
+```js
+//= require form_helper/form_helper
+```
+
+Add this line into your application.scss:
+
+```scss
+@import 'form_helper/form_helper';
+```
+
+## Helper list
+For now:
+
+* label
+* text_field
+* text_area
+* select
+* select_tag
+* check_box
+* date_field
+
 ## Usage
 
-TODO: Write usage instructions here
+    <% form = new FormHelper @task %>
+    <%- form.check_box 'is_done', title: 'Is done' %>
+    <%- form.date_field 'date', class: 'text_field', placeholder: 'datum' %>
+    <%- form.text_area 'description', placeholder: 'ukol' %>
+    <%- form.select 'group_id', values: _.map(@groups, (g) -> [g.get('_id'), g.get('name')]) %>
+    <%- form.select 'user_id', values: _.map(@users, (g) -> [g.get('_id'), g.get('name')]) %>
+        
+
+Value and errors are taken from model automaticly how Rails do it and shown in template (eg. text_field template):
+
+    <input type="text" id="<%= @field_id %>" <%- @unfold_options %> name="<%= @field_name %>" value="<%= @value %>" />
+    <span class="help-inline">
+    <%= @errors if @errors %>
+    </span>
+
+so after render when model has error on name (model.errors['name'] or model.get('errors')['name']) it looks like:
+
+    <input type="text" id="task_name" placeholder="ukol" class="error" name="task[name]" value="">
+    <span class="help-inline">
+    can't be blank
+    </span>
 
 ## Contributing
 

data/backbone_form_helper.gemspec

@@ -4,9 +4,10 @@ require File.expand_path('../lib/backbone_form_helper/version', __FILE__)
 Gem::Specification.new do |gem|
   gem.authors       = ["Zdenal"]
   gem.email         = ["nevralaz@gmail.com"]
-  gem.description   = %q{Form helper for backbone on Rails priciple -> f.text_field :name}
+  gem.description   = %q{Form helper for backbone based on Rails priciple -> f.text_field :name}
   gem.summary       = %q{Backbone form helper}
-  gem.homepage      = ""
+  gem.homepage      = "http://github.com/zdenal/backbone_form_helper.git"
+  gem.rubyforge_project = "backbone_form_helper"
 
   gem.files         = `git ls-files`.split($\)
   gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }

data/lib/backbone_form_helper/engine.rb

@@ -0,0 +1,6 @@
+module BackboneFormHelper
+  module Rails
+    class Engine < ::Rails::Engine
+    end
+  end
+end

data/lib/backbone_form_helper/version.rb

@@ -1,3 +1,3 @@
 module BackboneFormHelper
-  VERSION = "0.0.1"
+  VERSION = "0.0.1.1.alpha"
 end

data/lib/backbone_form_helper.rb

@@ -1,5 +1,5 @@
 require "backbone_form_helper/version"
+require "backbone_form_helper/engine"
 
 module BackboneFormHelper
-  # Your code goes here...
 end