mustache_form 0.1.1 → 0.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a6a3874eb1b2b591a7d98fc14b476ab3f16b8477
-  data.tar.gz: 033d6ccab29e0813f1162a7f41308dec88135aa9
+  metadata.gz: 1e7a3e7f0799ba94da894f6fa0840cf3494a80d4
+  data.tar.gz: 2fe8498eb18012c4df44f885fd71af0f3957273d
 SHA512:
-  metadata.gz: 003fa3e0f7f3532f118c0e3144ed216d2f6e176f676d3462f8473dfc428938d862dd415b2c65bbd6750b30ed8647c5aa084de9022dfff1138c0fc7bd1b0dfc3f
-  data.tar.gz: e2b812055d236b4ad71e49cca805c91dc969067f76e7ecfb636f11c20c66884a66f5cca3e6c06f641069027836a6bf073ebb5b9739eea2c0db2f80638079c593
+  metadata.gz: b889fb68a570fe1d1316627555ab77d72b85795a13244bf8050bf38ac36dc77a67bf9fb67e933a786beaa735f6b8f87fab0c6210da8310ecbbab38df89f4f56f
+  data.tar.gz: a4094992cd5c36796c783eec395932fa12a0618d5387cf9aa0f3f5c1000f0cf0e2e726184687a0a09879ec7a7982951959388d6008eb73df4234c681239870ee

data/README.md

@@ -1,8 +1,9 @@
 # MustacheForm
 
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/mustache_form`. To experiment with that code, run `bin/console` for an interactive prompt.
+This is a small library that adds a set of helper methods to Mustache view classes. Mustache allows complete
+seperation of concerns with view templates. With Mustache, the typical view layer is split up into two sub-layers: a Ruby Class-based "view" and an HTML "template", so you can concentrate on crafting your HTML without polluting it with embedded Ruby logic. This separation also makes it easier to test your view-code. The helper module has wrapper methods for the basic rails form_tag and form_for helpers. The current version also has wrappers for the simple_form form_helpers as well.
 
-TODO: Delete this and the text above, and describe your gem
+The idea initially was sparked off by a gist from (https://github.com/dbi) - Thanks!
 
 ## Installation
 
@@ -22,7 +23,111 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+The best way to explain how to use this little gem is with a few code samples from an existing
+project of mine.
+
+Sample template file with a form...
+
+```
+{{# labeled_simple_form }}
+  {{ alert }}
+
+  <fieldset>
+  <div class="input_row">
+    <div class="input_field">
+      <!--{{ first_name_label }}-->
+      {{ first_name_field }}
+    </div>
+
+    <div class="input_field">
+      {{ last_name_field }}
+    </div>
+
+    <div class="input_field">
+      {{ email_address_field }}
+    </div>
+
+    <div class="input_field">
+      {{ mobile_phone_field }}
+    </div>
+
+    <div class="input_field">
+      {{ home_number_field }}
+    </div>
+  </div>
+
+  <div class="buttons">
+    {{ submit_button }} {{ cancel_button }}
+  </div>
+</fieldset>
+
+{{/ labeled_simple_form }}
+```
+
+Sample view class that goes along with the above template.
+
+```
+module People
+  #
+  class New < FormView
+    include Wrapper::People::Form
+
+    def labeled_simple_form
+      custom_simple_form_for(@person, url: {controller: "people", action: "create"}) do |f|
+        simple_form_common(f)
+      end
+    end
+
+  end
+end
+```
+
+The example code here is taken from one of my projects that is using the Stache gem and hence I have a small
+class that wraps that gem.. which is what the above view class inherits from. The important piece here is the
+included module "MustacheForm::FormHelper". This has all the smarts to wrap the standard rails form_helper methods
+and also the simple_form ones which are also used in this example. You would simply include this module in your
+view class..
+
+```
+class FormView < ::Stache::Mustache::View
+  include MustacheForm::FormHelper
+end
+```
+
+Finally the form module that is included in the above New class. The form_helper yields to this method and
+it returns a hash (data pair) with the field names and values that are then forwarded with the form_tag smarts
+to the Mustache render method to finally create the complete view. The biggest win here being that we have complete
+separation of concerns between the view class and the logicless Mustache template!
+
+```
+module People
+  module Form
+
+    def simple_form_common(f)
+      {
+        first_name_field: f.input(:first_name),
+        last_name_field: f.input(:last_name),
+        email_address_field: f.input(:email_address),
+        mobile_phone_field: f.input(:mobile_phone),
+        home_phone_field: f.input(:home_phone),
+
+        # Submit
+        cancel_button: cancel_button,
+        submit_button: submit_button(f),
+      }
+    end
+
+    def submit_button(f)
+      object_name = f.object.class.to_s.underscore.pluralize
+      f.button :submit, t("#{object_name}.new.submit"), class: "#{PRIMARY_ACTION_BUTTON_CLASS}"
+    end
+
+```
+
+#### NB: simple_form gem dependancy
+
+This version has an inbuilt dependancy on the simple_form gem. I intend to remove this dependancy in the next
+build and include an install generator that lets the user decide whether it should be included and enabled or not.
 
 ## Development
 
@@ -33,4 +138,3 @@ To install this gem onto your local machine, run `bundle exec rake install`. To
 ## Contributing
 
 Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/mustache_form.
-

data/lib/mustache_form/version.rb

@@ -1,3 +1,3 @@
 module MustacheForm
-  VERSION = "0.1.1"
+  VERSION = "0.1.3"
 end

data/mustache_form.gemspec

@@ -26,6 +26,7 @@ Gem::Specification.new do |spec|
   #
   # - gem related ones
   spec.add_development_dependency 'mustache'
+  spec.add_development_dependency 'simple_form'
   spec.add_development_dependency 'rack'
   spec.add_development_dependency 'rspec'
   spec.add_development_dependency 'rspec-given'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: mustache_form
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.3
 platform: ruby
 authors:
 - Steve Forkin
@@ -66,6 +66,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: simple_form
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rack
   requirement: !ruby/object:Gem::Requirement