mustache_form 0.1.3 → 0.2.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 1e7a3e7f0799ba94da894f6fa0840cf3494a80d4
-  data.tar.gz: 2fe8498eb18012c4df44f885fd71af0f3957273d
+  metadata.gz: 4a634f7998badd9cb4bf7ca76be09ac2b928ca72
+  data.tar.gz: 1a9b57331d0c95076edcade87e5ece415b46f796
 SHA512:
-  metadata.gz: b889fb68a570fe1d1316627555ab77d72b85795a13244bf8050bf38ac36dc77a67bf9fb67e933a786beaa735f6b8f87fab0c6210da8310ecbbab38df89f4f56f
-  data.tar.gz: a4094992cd5c36796c783eec395932fa12a0618d5387cf9aa0f3f5c1000f0cf0e2e726184687a0a09879ec7a7982951959388d6008eb73df4234c681239870ee
+  metadata.gz: ba6faa080c298d0a6de9b3a6b38d7c0e33397fa23eb5d882785445bf726d00d254689c2ed97c8e2043bcdf090627e3e34d37d51407e5bb81c94805ddd7a51f47
+  data.tar.gz: 79363d7486b4ee22330c489f6572dd45fdb2076c6d07323232af437abb275748f3161538b3441901b5d49f157c507fc34a2e16a3a674af1d657944409e357b44

data/README.md

@@ -1,5 +1,9 @@
 # MustacheForm
 
+## Builds
+[![Build Status](https://travis-ci.org/netflakes/mustache_form.svg?branch=master)](https://travis-ci.org/netflakes/mustache_form)
+[![Coverage Status](https://coveralls.io/repos/netflakes/mustache_form/badge.svg)](https://coveralls.io/r/netflakes/mustache_form)
+
 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.
 
@@ -21,6 +25,23 @@ Or install it yourself as:
 
     $ gem install mustache_form
 
+
+## Installation - Configuration
+
+Mustache form has an install generator that creates an initializer allowing you to turn on and off
+options. For now the only option is to enable the SimpleForm support globally. Basically this means
+that when this option is turned on - then the simple_form helper will always be used.
+
+
+```
+  rails generate mustache_form:install
+```
+
+
+You can safely turn this on if you are using simple_form as you can also turn it off for individual
+forms, see below:
+
+
 ## Usage
 
 The best way to explain how to use this little gem is with a few code samples from an existing
@@ -73,7 +94,7 @@ module People
     include Wrapper::People::Form
 
     def labeled_simple_form
-      custom_simple_form_for(@person, url: {controller: "people", action: "create"}) do |f|
+      mustache_simple_form_for(@person, url: {controller: "people", action: "create"}) do |f|
         simple_form_common(f)
       end
     end
@@ -124,10 +145,26 @@ module People
 
 ```
 
-#### NB: simple_form gem dependancy
+#### SimpleForm - Simple Fields For
+
+**Simple Form** also comes with some extra helpers you can use inside rails default forms without relying
+on `simple_form_for` helper. They are listed below.
+
+Wrapper to use **Simple Form** inside a default rails form. It works in the same way that the `fields_for`
+Rails helper, but change the builder to use the `SimpleForm::FormBuilder`.
+
+```ruby
+form_for @user do |f|
+  f.simple_fields_for :posts do |posts_form|
+    # Here you have all simple_form methods available
+    posts_form.input :title
+  end
+end
+```
 
-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.
+**Mustache Form** should support these as we are simply yielding to your view method that contains the inputs
+during the process and hence you should be able to use these - though I would caution that I have not had the
+chance to test this feature.
 
 ## Development
 

data/Rakefile

@@ -1,6 +1,13 @@
 require "bundler/gem_tasks"
-require "rspec/core/rake_task"
-
+require 'rspec/core/rake_task'
+#
 RSpec::Core::RakeTask.new(:spec)
-
 task :default => :spec
+#
+desc 'Run the test suite for ruby scripts'
+namespace :spec do
+  task :all do
+    Rake::Task["spec"].reenable
+    Rake::Task["spec"].invoke
+  end
+end

data/lib/generators/mustache_form/install_generator.rb

@@ -0,0 +1,12 @@
+module MustacheForm
+  module Generators
+    class InstallGenerator < Rails::Generators::Base
+      desc "Copy MustacheForm initializer"
+      source_root File.expand_path('../templates', __FILE__)
+
+      def copy_config
+        template "config/initializers/mustache_form.rb"
+      end
+    end
+  end
+end

data/lib/generators/mustache_form/templates/config/initializers/mustache_form.rb

@@ -0,0 +1,7 @@
+#
+MustacheForm.setup do |config|
+  #
+  # - by default simple_form is not enabled
+  #
+  config.simple_form_enabled = false
+end

data/lib/mustache_form.rb

@@ -4,15 +4,21 @@ require File.dirname(__FILE__) + '/mustache_form/form_helper'
 require File.dirname(__FILE__) + '/mustache_form/railtie' if defined? ::Rails::Railtie
 #
 module MustacheForm
-  class Config
-    attr_accessor :simple_form_enabled
-  end
 
-  def self.config
-    @@config ||= Config.new
+  @@configured = false
+
+  def self.configured?
+    @@configured
   end
 
-  def self.configure
-    yield self.config
+  # - the configuration option to turn on simple_form support or off (in the initializer)
+  mattr_accessor :simple_form_enabled
+  @@error_method = false
+
+  # Default way to setup MustacheForm. Run rails generate mustache_form:install
+  # to create a fresh initializer with all configuration values.
+  def self.setup
+    @@configured = true
+    yield self if block_given?
   end
 end

data/lib/mustache_form/form_helper.rb

@@ -1,62 +1,60 @@
 require 'mustache'
 #
+# When the Mustache variable is a callable object, such as a function or lambda, the
+# object will be invoked and passed the block of text. hence we then yield to the
+# standard ruby form_for to build our form and then have Mustache render each key value pair
 module MustacheForm
   module FormHelper
 
-    def custom_form_tag(url: nil, html: nil)
-      # When the Mustache variable is a callable object, such as a function or lambda, the
-      # object will be invoked and passed the block of text. hence we then yield to the
-      # standard ruby form_for to build our form and then have Mustache render each key value pair
+    # The basic form_tag just wraps the rails form_tag helper and then yields to
+    # the view method that handles the form inputs
+    #
+    #-form_tag(url_for_options = {}, options = {}, &block)
+    #
+    def mustache_form_tag(url_for_options: {}, html_options: {})
+      formable = :form_tag
       lambda do |text|
-        form_tag(url: url, html: html) do |f|
+        send(formable, url_for_options, html_options) do |f|
           obj = FormedMustache.new(yield(f))
           Mustache.render(text, obj).html_safe
         end
       end
     end
 
-    def custom_form_for(object, url: nil, html: nil)
-      # When the Mustache variable is a callable object, such as a function or lambda, the
-      # object will be invoked and passed the block of text. hence we then yield to the
-      # standard ruby form_for to build our form and then have Mustache render each key value pair
+    # The form_for version in the basic form wraps the rails form_for helper and
+    # then yields to the method that handles the form inputs. It also handles the
+    # the optional use of the simple_form form helper. Since the method signature
+    # is identical it just needs to call the correct method name
+    #
+    #-form_for(record, options = {}, &block)
+    #-simple_form_for(record, options = {}, &block)
+    #
+    def mustache_form_for(object, url_for_options: {}, html_options: {}, use_rails_form_helper: false)
+      MustacheForm.simple_form_enabled == true ? formable = :simple_form_for : formable = :form_for
+      formable = :form_for if use_rails_form_helper
       lambda do |text|
-        form_for(object, url: url, html: html) do |f|
+        options = {
+          url: url_for_options, html: html_options
+        }
+        send(formable, object, options) do |f|
           obj = FormedMustache.new(yield(f))
           Mustache.render(text, obj).html_safe
         end
       end
     end
 
-    def custom_simple_form_tag(url: nil, html: nil)
-      # When the Mustache variable is a callable object, such as a function or lambda, the
-      # object will be invoked and passed the block of text. hence we then yield to the
-      # standard ruby form_for to build our form and then have Mustache render each key value pair
-      lambda do |text|
-        simple_form_tag(url: url, html: html) do |f|
-          obj = FormedMustache.new(yield(f))
-          Mustache.render(text, obj).html_safe
-        end
+    def self.included(base)
+      base.class_eval do
+        alias_method :custom_form_tag, :mustache_form_tag
+        alias_method :custom_form_for, :mustache_form_for
       end
     end
 
-    def custom_simple_form_for(object, url: nil, html: nil)
-      # When the Mustache variable is a callable object, such as a function or lambda, the
-      # object will be invoked and passed the block of text. hence we then yield to the
-      # standard ruby form_for to build our form and then have Mustache render each key value pair
-      lambda do |text|
-        simple_form_for(object, url: url, html: html) do |f|
-          obj = FormedMustache.new(yield(f))
-          Mustache.render(text, obj).html_safe
-        end
-      end
-    end
   end
-  #
-  class FormedMustache < Mustache
 
+  class FormedMustache < Mustache
     def initialize(data)
       data.each_pair do |key, value|
-        #puts "\n\nFormedMustache k:#{key}, v: #{value}\n\n"
         FormedMustache.send(:define_method, key, proc{value})
       end
     end

data/lib/mustache_form/railtie.rb

@@ -1,19 +1,14 @@
 #
 module MustacheForm
   class Railtie < Rails::Railtie
-    #
-    # enable namespaced configuration in Rails environments
-    config.mustache_form = ActiveSupport::OrderedOptions.new
-    #
-    initializer :after_initialize do |app|
-      #
-      MustacheForm.configure do |config|
-        config.simple_form_enabled = app.config.mustache_form[:simple_form_enabled]
+    config.eager_load_namespaces << MustacheForm
+
+    config.after_initialize do
+      unless MustacheForm.configured?
+        warn 'Mustache Form is not configured in the application and will use the default values.' +
+          ' Use `rails generate mustache_form:install` to generate the Mustache Form configuration.'
       end
-      #
-      # dynamically load the client rails app module that has the stuff
-      #LoadLists.load
-    end
+    end  
   end
 end
 #

data/lib/mustache_form/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: mustache_form
 version: !ruby/object:Gem::Version
-  version: 0.1.3
+  version: 0.2.2
 platform: ruby
 authors:
 - Steve Forkin
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2015-07-30 00:00:00.000000000 Z
+date: 2015-08-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -181,6 +181,8 @@ files:
 - Rakefile
 - bin/console
 - bin/setup
+- lib/generators/mustache_form/install_generator.rb
+- lib/generators/mustache_form/templates/config/initializers/mustache_form.rb
 - lib/mustache_form.rb
 - lib/mustache_form/form_helper.rb
 - lib/mustache_form/railtie.rb