foundation-formbuilder-rails 0.2.2 → 0.2.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 827b18acfa92f945be3a48f81574b80a8a6edb17
-  data.tar.gz: 02dd3ff317f269155bfbfdf59c752c3bbb5f1006
+  metadata.gz: 9d43eeb91f25647575889ad3fb4a85337fdf23ee
+  data.tar.gz: 07a1537e5c9fe3b194c5ff4d1352ca2184285aed
 SHA512:
-  metadata.gz: d053d31a056d78fba3f0a209b37eace519bd1adeb3b236b30a2f9e1f0cb688dfd0b4d88fa52cbaf34173ccda225e7ce6b56f5d8d0101b589d767f75ef4931b68
-  data.tar.gz: 3882052b6a98e18fc41b91cfa3d3bac3a933552e79dadbd007b148bda4f1e2a2adbf1511817bd5c53f5944a4e130bc9123b716b1446426311edeb0c0968f9056
+  metadata.gz: 697513b1a40fd7ed11708be683a16eef4ba861a80206903e84c91d96937069aabafa38ce7e6b290bed79122876fc5e957fe16a1cba85bbb960797c05105f0b97
+  data.tar.gz: f833896949f50bde3d069adb0bcef88ea02197dcdbbc2a1798151a79d81b2c0bae3424d79b0a893c1171e75635f267ecfcbbdfdc172bbfd2d9474c8789c4f13e

data/README.md

@@ -1,18 +1,18 @@
-# foundation-formbuilder-rails v0.2.1
+# foundation-formbuilder-rails v0.2.3
 
 This is a custom FormBuilder used to display form elements generated
-by the form_for helpers in the correct style for
+by the `form_for` helpers in the correct style for
 the [*Foundation 5 Framework*](http://foundation.zurb.com/).
 
 
 See the Foundation [docs](http://foundation.zurb.com/docs/components/forms.html)
 for form specifics.
 
-# Getting Started
+## Getting Started
 
-1.  Add the foundation-formbuilder-rails Gem to your project's `Gemfile`:
+1.  Add the `foundation-formbuilder-rails` Gem to your project's `Gemfile`:
 
-        gem 'foundation-formbuilder-rails', '0.2.1'
+        gem 'foundation-formbuilder-rails'
 
 2.  Ensure you are using the FormBuilder in your form:
 
@@ -20,15 +20,41 @@ for form specifics.
            ...
         end
 
-3.  For usage, see comments in the [source code](https://github.com/ashleybye/foundation-formbuilder-rails/blob/master/lib/foundation/form_builder/rails/form_builder.rb). I will get around to adding proper use examples to the README in the future.
+3.  Alternatively, you can set the FormBuilder globally in an initializer,
+    `ActionView::Base.default_form_builder = Foundation::FormBuilder::Rails::FormBuilder`.
 
-# Complete
+4.  This can be achieved by running:
+
+        rails generate foundation:form_builder:install
+
+5.  Be sure to restart your application once this has been done. Then you only need:
+
+        form_for @test do |f|
+
+6.  For usage, see comments in the [source code](https://github.com/ashleybye/foundation-formbuilder-rails/blob/master/lib/foundation/form_builder/rails/form_builder.rb). I will get around to adding proper use examples to the README in the future. However, as a quick reference, the original Rails methods will
+still return the standard content but prefix with `zurb_` and it will return the content formatted
+for Foundation:
+
+        form_for @test do |f|
+          f.zurb_text_field :name
+        end
+        # => <form accept-charset="UTF-8" action="/test" class="new_test" id="new_test" method="post">
+                <div style="display:none">
+                  <input name="utf8" type="hidden" value="&#x2713;" />
+                  <input name="authenticity_token" type="hidden" value="ofJbUSioJ9w+c6EkPy993jtBskYMK/97gp667ACWZDI=" />
+                </div>
+                <label for="test">Name
+                  <input id="message_name" name="test[name]" type="text" />
+                </label>
+              </form>
+
+## Complete
 
 I have completed the builder for all of the Rails FormBuilder and FormOptionsHelper
 methods. I have also included some Foundation specific methods, but I may remove these
 before the final release.
 
-## FormHelper
+### FormHelper
 
 `check_box`
 `color_field`
@@ -51,7 +77,7 @@ before the final release.
 `url_field`
 `week_field`
 
-## FormOptionsHelper
+### FormOptionsHelper
 
 `collection_check_boxes`
 `collection_radio_buttons`
@@ -60,16 +86,29 @@ before the final release.
 `select`
 `time_zone_select`
 
-## Foundation Specific
+### Foundation Specific
 
-(May be removed at a later stage)
 `check_box_group`
 `radio_button_group`
 
-# TODO
+(May be removed at a later stage)
+
+## Development
+
+This project is still under development, although the main functionality works. I am still deciding
+whether to keep the `zurb_` prefix plus the ability to produce field tags that are not wrapped in a
+label.
+
+If you wish to contribute please contact me.
+
+### Possibilities
 
 I am still deciding whether it is worth writing builder methods to provide the following:
 
 `Pre/Postfix labels (Foundation)`
 `Switches (Foundation)`
-`Abide Validation (Foundaation)`
+`Abide Validation (Foundaation)`
+
+## Issues
+
+If you notice any problems with this Gem please file an [issue](https://github.com/ashleybye/foundation-formbuilder-rails/issues).

data/lib/foundation/form_builder/rails.rb

@@ -1,3 +1,4 @@
 require 'foundation/form_builder/rails/engine'
 require 'foundation/form_builder/rails/version'
-require 'foundation/form_builder/rails/form_builder'
+require 'foundation/form_builder/rails/form_builder'
+require 'foundation/form_builder/rails/generators/install_generator'

data/lib/foundation/form_builder/rails/generators/install_generator.rb

@@ -0,0 +1,17 @@
+module Foundation
+  module FormBuilder
+    # module Rails
+      module Generators
+        class InstallGenerator < ::Rails::Generators::Base
+          source_root File.join(File.dirname(__FILE__), '..', 'templates')
+
+          def add_initialiser
+            # Adds an initialiser for global use of the FormBuilder
+            settings_file = File.join(File.dirname(__FILE__),"..", "templates", "global_formbuilder.rb")
+            create_file "config/initializers/global_formbuilder.rb", File.read(settings_file)
+          end
+        end
+      end
+    # end
+  end
+end

data/lib/foundation/form_builder/rails/templates/global_formbuilder.rb

@@ -0,0 +1,3 @@
+# Be sure to restart your server when you modify this file.
+
+ActionView::Base.default_form_builder = Foundation::FormBuilder::Rails::FormBuilder

data/lib/foundation/form_builder/rails/version.rb

@@ -1,7 +1,7 @@
 module Foundation
   module FormBuilder
     module Rails
-      VERSION = '0.2.2'
+      VERSION = '0.2.3'
     end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: foundation-formbuilder-rails
 version: !ruby/object:Gem::Version
-  version: 0.2.2
+  version: 0.2.3
 platform: ruby
 authors:
 - Ashley Bye
@@ -24,27 +24,121 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.6'
-- !ruby/object:Gem::Dependency
-  name: foundation-rails
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '5.3'
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 5.3.0.1
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '5.3'
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 5.3.0.1
-description: FormBuilder for the ZURB Foundation 5 CSS Framework
+description: |-
+  # foundation-formbuilder-rails v0.2.3
+
+  This is a custom FormBuilder used to display form elements generated
+  by the `form_for` helpers in the correct style for
+  the [*Foundation 5 Framework*](http://foundation.zurb.com/).
+
+
+  See the Foundation [docs](http://foundation.zurb.com/docs/components/forms.html)
+  for form specifics.
+
+  ## Getting Started
+
+  1.  Add the `foundation-formbuilder-rails` Gem to your project's `Gemfile`:
+
+          gem 'foundation-formbuilder-rails'
+
+  2.  Ensure you are using the FormBuilder in your form:
+
+          form_for @test, builder: Foundation::FormBuilder::Rails::FormBuilder do |f|
+             ...
+          end
+
+  3.  Alternatively, you can set the FormBuilder globally in an initializer,
+      `ActionView::Base.default_form_builder = Foundation::FormBuilder::Rails::FormBuilder`.
+
+  4.  This can be achieved by running:
+
+          rails generate foundation:form_builder:install
+
+  5.  Be sure to restart your application once this has been done. Then you only need:
+
+          form_for @test do |f|
+
+  6.  For usage, see comments in the [source code](https://github.com/ashleybye/foundation-formbuilder-rails/blob/master/lib/foundation/form_builder/rails/form_builder.rb). I will get around to adding proper use examples to the README in the future. However, as a quick reference, the original Rails methods will
+  still return the standard content but prefix with `zurb_` and it will return the content formatted
+  for Foundation:
+
+          form_for @test do |f|
+            f.zurb_text_field :name
+          end
+          # => <form accept-charset="UTF-8" action="/test" class="new_test" id="new_test" method="post">
+                  <div style="display:none">
+                    <input name="utf8" type="hidden" value="&#x2713;" />
+                    <input name="authenticity_token" type="hidden" value="ofJbUSioJ9w+c6EkPy993jtBskYMK/97gp667ACWZDI=" />
+                  </div>
+                  <label for="test">Name
+                    <input id="message_name" name="test[name]" type="text" />
+                  </label>
+                </form>
+
+  ## Complete
+
+  I have completed the builder for all of the Rails FormBuilder and FormOptionsHelper
+  methods. I have also included some Foundation specific methods, but I may remove these
+  before the final release.
+
+  ### FormHelper
+
+  `check_box`
+  `color_field`
+  `date_field`
+  `datetime_field`
+  `datetime_local_field`
+  `email_field`
+  `file_field`
+  `month_field`
+  `number_field`
+  `password_field`
+  `phone_field`
+  `radio_button`
+  `range_field`
+  `search_field`
+  `telephone_field`
+  `time_field`
+  `text_field`
+  `text_area`
+  `url_field`
+  `week_field`
+
+  ### FormOptionsHelper
+
+  `collection_check_boxes`
+  `collection_radio_buttons`
+  `collection_select`
+  `grouped_collection_select`
+  `select`
+  `time_zone_select`
+
+  ### Foundation Specific
+
+  `check_box_group`
+  `radio_button_group`
+
+  (May be removed at a later stage)
+
+  ## Development
+
+  This project is still under development, although the main functionality works. I am still deciding
+  whether to keep the `zurb_` prefix plus the ability to produce field tags that are not wrapped in a
+  label.
+
+  If you wish to contribute please contact me.
+
+  ### Possibilities
+
+  I am still deciding whether it is worth writing builder methods to provide the following:
+
+  `Pre/Postfix labels (Foundation)`
+  `Switches (Foundation)`
+  `Abide Validation (Foundaation)`
+
+  ## Issues
+
+  If you notice any problems with this Gem please file an [issue](https://github.com/ashleybye/foundation-formbuilder-rails/issues).
 email:
 - ashley.bye85@gmail.com
 executables: []
@@ -57,6 +151,8 @@ files:
 - lib/foundation/form_builder/rails.rb
 - lib/foundation/form_builder/rails/engine.rb
 - lib/foundation/form_builder/rails/form_builder.rb
+- lib/foundation/form_builder/rails/generators/install_generator.rb
+- lib/foundation/form_builder/rails/templates/global_formbuilder.rb
 - lib/foundation/form_builder/rails/version.rb
 homepage: https://github.com/ashleybye/foundation-formbuilder-rails
 licenses:
@@ -70,7 +166,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 2.1.2
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="