backbone_form_helper 0.0.1.1.alpha → 0.0.1.2.alpha

data/README.md

@@ -5,13 +5,15 @@ This Rails gem provide javascript form helper based on Rails principle like 'f.t
 template for each of them (eg. /templates/text_field). Now are templates
 created in Twitter bootstrap style.
 
-**This is still alpha.**
+#### This is still alpha.
+
 
 ## Installation
 
 External dependencies:
 
 * underscore.js
+* sass-rails
 * coffee-rails for assets (now js are written in .coffee)
 
 Add this line to your application's Gemfile:
@@ -26,6 +28,13 @@ Or install it yourself as:
 
     $ gem install backbone_form_helper
 
+Run this from command line:
+  
+    $ rails g backbone_form_helper:copy
+
+This will copy scss/css and coffee script files into your
+vendor/assets/javascripts(stylesheets) directory. If you set as argument
+different destination, it will be copied there (eg. 'app/assets/').
 
 Add this line into your application.js:
 
@@ -39,40 +48,116 @@ Add this line into your application.scss:
 @import 'form_helper/form_helper';
 ```
 
+Templates for fields are in directory 'javascripts/form_helper/templates' so you can change them by your needs. They are in eco templates.
+
 ## Helper list
 For now:
 
-* label
-* text_field
-* text_area
-* select
-* select_tag
-* check_box
-* date_field
+### new FormHelper(model, options=optional)  
+`f = new FormHelper @task` -> take prefix for fields name from class name of model. If task is instance of class Task, then **'f.text_field :name'** will generate name **task[name]**
+
+`f = new FormHelper @task, {name: 'issue'}` -> **'f.text_field :name'** will generate **issue[name]**
+### label(method, text=optional, {html_options=optional})
+Return tag of label. If model has error on this method class 'error' will be added.
+
+```rhtml
+f.label 'name'
+# => <label for="task_name">Name</label>
+f.label :name, 'Title'
+# => <label for="task_name">Title</label>
+f.label :name, {class: 'red bold'}
+# => <label for="task_name" class="red bold">Name</label>
+
+```
+### text_field(method, value=optional, html_options={optional})
+Return text field with prefilled value from model if value isn't directly defined. Added class 'error' if model has error on method and show errors on method.
+
+```rhtml
+f.text_field 'name'
+# => <input type="text" id="task_name" name="task[name]" value="#{model.name value}" />
+# => <span class="help-inline">#{errors on name}</span>
+
+f.text_field 'name', 'John'
+# => <input type="text" id="task_name" name="task[name]" value="John" />
+# => <span class="help-inline">#{errors on name}</span>
+
+f.text_field 'name', {placeholder: 'name of person', class: 'mandatory'}
+# => <input type="text" id="task_name" name="task[name]" placeholder="name of person" class="mandatory"/>
+# => <span class="help-inline">#{errors on name}</span>
+```
+### text_area(method, value=optional, html_options={optional})
+Same as text_field but with textarea tag.
+
+### select(method, options, html_options={optional})
+Return select tag with set options and selected option by value of method on model if value isn't set directly.
+
+```rhtml
+f.select 'group_id', {values: _.map(@groups, (g) -> [g.get('_id'), g.get('name')])}, {class: 'mandatory'}
+# => <select id="task_group_id" name="task[group_id]" class="mandatory">#{generated options}</option>
+
+f.select 'group_id', {values: _.map(@groups, (g) -> [g.get('_id'), g.get('name')]), value: '12'}
+# => return select tag with selected option with value '12'
+```
+### select_tag
+Similar as 'select', but is not relate to model (like in RoR)
+
+```rhtml
+f.select_tag 'only_group_id', {values: _.map(@groups, (g) -> [g.get('_id'), g.get('name')]), value: '12'}
+# => <select id="only_group_id" name="only_group_id" class="mandatory">#{generated options}</option>
+```
+### check_box(method, value=optional, html_options={optional})
+
+```rhtml
+f.check_box 'is_done'
+# =><label class="checkbox">
+  <input id="task_is_done" name="task[is_done]" type="hidden" value="false">
+  <input id="task_is_done" name="task[is_done]" type="checkbox"
+    value="true" #{'checked' if method of model is 1 or true}>
+</label>
+
+f.check_box 'is_done', {title: 'Tick this for done'}
+# =><label class="checkbox">
+  <input id="task_is_done" name="task[is_done]" type="hidden" value="false">
+  <input id="task_is_done" name="task[is_done]" type="checkbox"
+    value="true" #{'checked' if method of model is 1 or true}>
+  Tick this for done
+</label>
+```
+### date_field
+Return bootstrap-datepicker date field (see on [http://www.eyecon.ro/bootstrap-datepicker](http://))
+
+```rhtml
+f.date_field 'date', class: 'text_field', placeholder: 'date'
+```
 
 ## Usage
 
-    <% 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')]) %>
-        
+```rhtml
+<% 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>
+```rhtml
+<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>
+```rhtml
+<input type="text" id="task_name" placeholder="ukol" class="error" name="task[name]" value="">
+<span class="help-inline">
+can't be blank
+</span>
+```
 
 ## Contributing
 
@@ -81,3 +166,4 @@ so after render when model has error on name (model.errors['name'] or model.get(
 3. Commit your changes (`git commit -am 'Added some feature'`)
 4. Push to the branch (`git push origin my-new-feature`)
 5. Create new Pull Request
+

data/lib/backbone_form_helper/railtie.rb

@@ -0,0 +1,4 @@
+module BackboneFormHelper
+  class Railtie < ::Rails::Railtie
+  end
+end

data/lib/backbone_form_helper/version.rb

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

data/lib/backbone_form_helper.rb

@@ -1,5 +1,5 @@
-require "backbone_form_helper/version"
-require "backbone_form_helper/engine"
-
 module BackboneFormHelper
 end
+require "backbone_form_helper/version"
+require "backbone_form_helper/engine"
+require 'backbone_form_helper/railtie' if defined?(Rails::Railtie)

data/lib/rails/generators/backbone_form_helper/copy_generator.rb

@@ -0,0 +1,14 @@
+module BackboneFormHelper
+  module Generators
+    class CopyGenerator < ::Rails::Generators::Base
+      desc "Copy files into your project (default vendor/assetes/..)"
+      source_root File.expand_path('../../../../../vendor/assets/', __FILE__)
+      argument :destination, type: :string, default: 'vendor/assets/'
+
+      def create_initializer
+        directory "#{source_paths.first}/javascripts/form_helper", "#{destination}javascripts/form_helper"
+        directory "#{source_paths.first}/stylesheets/form_helper", "#{destination}stylesheets/form_helper"
+      end
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: backbone_form_helper
 version: !ruby/object:Gem::Version
-  version: 0.0.1.1.alpha
+  version: 0.0.1.2.alpha
   prerelease: 8
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-10-17 00:00:00.000000000 Z
+date: 2012-11-18 00:00:00.000000000 Z
 dependencies: []
 description: Form helper for backbone based on Rails priciple -> f.text_field :name
 email:
@@ -26,7 +26,9 @@ files:
 - backbone_form_helper.gemspec
 - lib/backbone_form_helper.rb
 - lib/backbone_form_helper/engine.rb
+- lib/backbone_form_helper/railtie.rb
 - lib/backbone_form_helper/version.rb
+- lib/rails/generators/backbone_form_helper/copy_generator.rb
 - vendor/assets/javascripts/form_helper/bootstrap-datepicker.js
 - vendor/assets/javascripts/form_helper/form_helper.js.coffee
 - vendor/assets/javascripts/form_helper/templates/check_box.jst.eco