jcheck_rails 0.2.0 → 0.5.0

data/.bundle/config

@@ -0,0 +1,2 @@
+--- 
+BUNDLE_DISABLE_SHARED_GEMS: "1"

data/README.textile

@@ -1,7 +1,7 @@
 h1. jCheck Rails
 
 jCheck Rails provide a ease way to generate "jCheck":http://jcheck.net code
-to validate form according to ActiveModel record validations.
+to validate forms according to ActiveModel record validations.
 
 h2. Installation
 
@@ -11,30 +11,53 @@ bc. gem 'jcheck_rails'
 
 h2. Basic Usage
 
-To make a basic usage of @jcheck_rails@ is really simple, first you need to
-setup your application view to use jcheck, to make it just go to "jCheck site":http://jcheck.net,
-download the latest version, drop the files in your public directory (the zip
-contains the correct folders, js in javascripts folder and css in stylesheets
-folder), and them add there files in you layout.
+You can easily download latest version of jcheck using the provided rake task:
 
-With the front-end setup done, go to your form and do:
+bc. rake jcheck:setup
 
-bc. <%= jcheck_for @post %>
+This will download latest version of jcheck and will extract in correct directories for you. Them you just need to include files in your view layout.
 
-Replace the @@post@ with variable of your object to current form. This will
-make a reflection into your model validations and will write the respective
-ones using @jCheck@.
+With the library included, on your form views add the following:
 
-It's highly recommendable that you read the @jCheck@ documentation at
+bc. <%= jcheck_for resource %>
+
+Replace @resource@ with the instance variable of the resource for form e.g. @@user@. This will
+use reflection, to detect the model validations and will convert these to @jCheck@.
+
+It's highly recommended that you read the @jCheck@ documentation at
 "http://jcheck.net/documentation":http://jcheck.net/documentation for a full
-knowledge on @jCheck@.
+overview on @jCheck@.
 
 h2. TODO
 
-* Option to filter fields that should has exposed validations
-* Get messages from i18n and append automatic
-* Get field names from i18n and use automatic
+* Get messages from i18n and append automatically
+
+h2. Change Log
+
+h3. 0.2.0
+
+* Added rake task for setup
+
+h3. 0.1.1
+
+* Initial Release
+
+h2. Maintainers
+
+* Wilker Lucio (http://github.com/wilkerlucio/jcheck)
+
+h2. License
+
+	Copyright 2010 Wilker Lucio.
+
+	Licensed under the Apache License, Version 2.0 (the "License");
+	you may not use this file except in compliance with the License.
+	You may obtain a copy of the License at
 
-h2. Copyright
+	    http://www.apache.org/licenses/LICENSE-2.0
 
-Copyright (c) 2010 Wilker Lucio. See LICENSE for details.
+	Unless required by applicable law or agreed to in writing, software
+	distributed under the License is distributed on an "AS IS" BASIS,
+	WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+	See the License for the specific language governing permissions and
+	limitations under the License.

data/VERSION

@@ -1 +1 @@
-0.2.0
+0.5.0

data/jcheck_rails.gemspec

@@ -5,23 +5,22 @@
 
 Gem::Specification.new do |s|
   s.name = %q{jcheck_rails}
-  s.version = "0.2.0"
+  s.version = "0.5.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Wilker Lucio"]
-  s.date = %q{2010-08-17}
+  s.date = %q{2010-08-22}
   s.description = %q{Generate jCheck code according to ActiveModel validations}
   s.email = %q{wilkerlucio@gmail.com}
   s.extra_rdoc_files = [
-    "LICENSE",
-     "README.textile"
+    "README.textile"
   ]
   s.files = [
-    ".document",
+    ".bundle/config",
+     ".document",
      ".gitignore",
      "Gemfile",
      "Gemfile.lock",
-     "LICENSE",
      "README.textile",
      "Rakefile",
      "VERSION",

data/lib/jcheck_rails.rb

@@ -9,12 +9,15 @@ module JcheckRails
   
   extend self
   
+  KNOW_VALIDATORS = [:acceptance, :confirmation, :exclusion, :format, :inclusion, :length, :numericality, :presence]
+  
   # This will reflect into your model and generate correct jCheck validations
   # for you. In first argument you should send the current object of model, if
   # you want to get just the validations for an given attribute, send the
   # attribute name as second parameter. In third parameter you can send options
   # to be used in jCheck initialization, but there some special keys that can
-  # be sent in the options.
+  # be sent in the options. You can also send options as second parameter, in
+  # this case the attribute will be considered nil.
   #
   #   <%= form_for(@object) do |f| %>
   #     ...
@@ -25,37 +28,64 @@ module JcheckRails
   # * <tt>:variable</tt> - Variable name to be used in javascript (default is: "validator")
   # * <tt>:form_id</tt> - The id of form in html to be used in jQuery selector (default is same behaviour as +form_for+ do to generate form id)
   # * <tt>:field_prefix</tt> - Field prefix to be used into jCheck, send nil to avoid field_prefix (default is same prefix as form_for will do)
+  # * <tt>:generate_field_names</tt> - Define if it should generate field custom_label for jCheck (default is true)
+  # * <tt>:only_attributes</tt> - Filter the attributes that should be reflected (default nil)
+  # * <tt>:exclude_attributes</tt> - Filter the attributes that should not be reflected (default nil)
   #
   # Also, any other configuration option will be sent to jCheck() initializer.
   #
-  def jcheck_for(object, attribute = nil, options = {})
+  def jcheck_for(*args)
+    options = args.extract_options!
+    object = args.shift
+    attribute = args.length > 0 ? args[0] : nil
+    
     return jcheck_for_object_attribute(object, attribute) if attribute
     
     options.reverse_merge!(
       :variable => "validator",
       :form_id => ActionController::RecordIdentifier.dom_id(object, (object.respond_to?(:persisted?) && object.persisted? ? :edit : nil)),
-      :field_prefix => ActiveModel::Naming.singular(object)
+      :field_prefix => ActiveModel::Naming.singular(object),
+      :generate_field_names => true,
+      :only_attributes => nil,
+      :exclude_attributes => nil
     )
     
+    only_attributes = options.delete :only_attributes
+    exclude_attributes = options.delete :exclude_attributes
     variable = options.delete :variable
     form_id = options.delete :form_id
+    generate_field_names = options.delete :generate_field_names
     
     validations = []
+    field_names = []
     
     object.class._validators.each do |attribute, validators|
+      next if only_attributes and !(only_attributes.include?(attribute))
+      next if exclude_attributes and exclude_attributes.include?(attribute)
+      
       attr_validations = jcheck_for_object_attribute(object, attribute)
       
+      field_names << "#{variable}.field(#{Encoder.convert_to_javascript attribute}).custom_label = #{Encoder.convert_to_javascript jcheck_attribute_name(object, attribute)};" if generate_field_names
       validations << "#{variable}.validates(#{Encoder.convert_to_javascript attribute}, #{attr_validations});"
     end
     
-    %{<script type="text/javascript"> jQuery(function() { var #{variable} = jQuery('##{form_id}').jcheck(#{Encoder.convert_to_javascript(options)}); #{validations.join(" ")} }); </script>}.html_safe
+    %{<script type="text/javascript"> jQuery(function() { var #{variable} = jQuery('##{form_id}').jcheck(#{Encoder.convert_to_javascript(options)}); #{validations.join(" ")} #{field_names.join(" ")} }); </script>}.html_safe
+  end
+  
+  def jcheck_attribute_name(object, attribute)
+    if object.class.respond_to? :human_attribute_name
+      object.class.human_attribute_name(attribute)
+    else
+      attribute.to_s.humanize
+    end
   end
   
   def jcheck_for_object_attribute(object, attribute)
     validations = object.class._validators[attribute].inject([]) do |acc, validator|
       options = filter_validator_options(validator)
       
-      acc << "#{Encoder.convert_to_javascript validator.kind}: #{Encoder.convert_to_javascript(options)}"
+      acc << "#{Encoder.convert_to_javascript validator.kind}: #{Encoder.convert_to_javascript(options)}" if KNOW_VALIDATORS.include? validator.kind
+      acc
     end
     
     "{#{validations.join(', ')}}"

data/spec/jcheck_rails_spec.rb

@@ -186,6 +186,58 @@ describe "JcheckRails" do
         jcheck(m, :name).should == "{'presence': true}"
       end
     end
+    
+    it "should not generate for other validations" do
+      m = mock_model do
+        attr_accessor :name
+        validates_presence_of :name
+        validates_sample_of :name
+      end
+      
+      jcheck(m, :name).should == "{'presence': true}"
+    end
+  end
+  
+  context "i18n" do
+    context "field names" do
+      it "should get result of humanized attribute" do
+        m = mock_model do
+          def self.human_attribute_name(attribute)
+            attribute == "name" ? "Nome" : attribute.to_s.humanize
+          end
+        end
+        
+        JcheckRails::jcheck_attribute_name(m, "name").should == "Nome"
+        JcheckRails::jcheck_attribute_name(m, "other").should == "Other"
+      end
+      
+      it "should generate field names for attributes with validations" do
+        m = mock_model do
+          attr_accessor :name, :email, :main_address
+          
+          validates_presence_of :name, :main_address
+        end
+        
+        T = m.class
+        
+        output = jcheck(m)
+        output.should include("validator.field('name').custom_label = 'Name'", "validator.field('main_address').custom_label = 'Main address'")
+        output.should_not include("validator.field('email')")
+      end
+      
+      it "should not generate field names if it's disabled by option" do
+        m = mock_model do
+          attr_accessor :name, :email, :main_address
+          
+          validates_presence_of :name
+        end
+        
+        T2 = m.class
+        
+        output = jcheck(m, nil, :generate_field_names => false)
+        output.should_not include("validator.field('name').custom_label = 'Name'")
+      end
+    end
   end
   
   context "generating all script for model" do
@@ -194,37 +246,53 @@ describe "JcheckRails" do
         attr_accessor :name
         
         validates_presence_of :name
-        
-        def persisted?
-          false
-        end
-        
-        def to_key
-          nil
-        end
       end
       
       SampleModel = @m.class
     end
     
     it "should generate all data" do
-      jcheck(@m).should == "<script type=\"text/javascript\"> jQuery(function() { var validator = jQuery('#new_sample_model').jcheck({'field_prefix': 'sample_model'}); validator.validates('name', {'presence': true}); }); </script>"
+      jcheck(@m).should == "<script type=\"text/javascript\"> jQuery(function() { var validator = jQuery('#new_sample_model').jcheck({'field_prefix': 'sample_model'}); validator.validates('name', {'presence': true}); validator.field('name').custom_label = 'Name'; }); </script>"
+    end
+    
+    context "filtering attributes" do
+      before :all do
+        @md = mock_model do
+          attr_accessor :name, :email, :address
+          
+          validates_presence_of :name, :email, :address
+        end
+        
+        FilterTest = @md.class
+      end
+      
+      it "should get only some attributes if using only_attributes option" do
+        output = jcheck(@md, :only_attributes => [:name, :email])
+        output.should include("validates('name'", "validates('email'")
+        output.should_not include("validates('address'")
+      end
+      
+      it "should exclude some attributes if it's sent" do
+        output = jcheck(@md, :exclude_attributes => [:name, :address])
+        output.should include("validates('email'")
+        output.should_not include("validates('name'", "validates('address'")
+      end
     end
     
     it "should be able to customize form id" do
-      jcheck(@m, nil, :form_id => "custom_form_id").should include("jQuery('#custom_form_id')")
+      jcheck(@m, :form_id => "custom_form_id").should include("jQuery('#custom_form_id')")
     end
     
     it "should be able to customize field prefix" do
-      jcheck(@m, nil, :field_prefix => "custom_field_prefix").should include("'field_prefix': 'custom_field_prefix'")
+      jcheck(@m, :field_prefix => "custom_field_prefix").should include("'field_prefix': 'custom_field_prefix'")
     end
     
     it "should be able to add custom values" do
-      jcheck(@m, nil, :notifiers => ["custom_notifier"], :prevent_submit => false).should include("'notifiers': ['custom_notifier']", "'prevent_submit': false")
+      jcheck(@m, :notifiers => ["custom_notifier"], :prevent_submit => false).should include("'notifiers': ['custom_notifier']", "'prevent_submit': false")
     end
     
     it "should be able customize javascript variable name" do
-      jcheck(@m, nil, :variable => "v").should include("var v = jQuery", "v.validates")
+      jcheck(@m, :variable => "v").should include("var v = jQuery", "v.validates")
     end
   end
   
@@ -247,7 +315,7 @@ describe "JcheckRails" do
       
       CusCla = m.class
       
-      jcheck(m).should == "<script type=\"text/javascript\"> jQuery(function() { var validator = jQuery('#new_cus_cla').jcheck({'field_prefix': 'cus_cla'}); validator.validates('name', {'presence': true}); }); </script>"
+      jcheck(m, :generate_field_names => false).should == "<script type=\"text/javascript\"> jQuery(function() { var validator = jQuery('#new_cus_cla').jcheck({'field_prefix': 'cus_cla'}); validator.validates('name', {'presence': true});  }); </script>"
     end
   end
 end

data/spec/spec_helper.rb

@@ -19,8 +19,33 @@ def jcheck(*args)
 end
 
 def mock_model(&block)
-  cls = Class.new
+  cls = Class.new do
+    def persisted?
+      false
+    end
+    
+    def to_key
+      nil
+    end
+  end
   cls.send :include, ActiveModel::Validations
   cls.class_eval &block
   cls.new
 end
+
+module ActiveModel
+  module Validations
+    class SampleValidator < EachValidator
+      def validate_each(record, attribute, value)
+        record.errors.add(attribute, "test")
+      end
+    end
+    
+    module HelperMethods
+      def validates_sample_of(*attr_names)
+        validates_with SampleValidator, _merge_attributes(attr_names)
+      end
+    end
+  end
+end
+

metadata

@@ -4,9 +4,9 @@ version: !ruby/object:Gem::Version
   prerelease: false
   segments: 
   - 0
-  - 2
+  - 5
   - 0
-  version: 0.2.0
+  version: 0.5.0
 platform: ruby
 authors: 
 - Wilker Lucio
@@ -14,7 +14,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-08-17 00:00:00 -03:00
+date: 2010-08-22 00:00:00 -03:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -39,14 +39,13 @@ executables: []
 extensions: []
 
 extra_rdoc_files: 
-- LICENSE
 - README.textile
 files: 
+- .bundle/config
 - .document
 - .gitignore
 - Gemfile
 - Gemfile.lock
-- LICENSE
 - README.textile
 - Rakefile
 - VERSION
@@ -72,7 +71,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      hash: -654179293814273617
+      hash: 430536012187104030
       segments: 
       - 0
       version: "0"

data/LICENSE

@@ -1,202 +0,0 @@
-
-                                 Apache License
-                           Version 2.0, January 2004
-                        http://www.apache.org/licenses/
-
-   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
-
-   1. Definitions.
-
-      "License" shall mean the terms and conditions for use, reproduction,
-      and distribution as defined by Sections 1 through 9 of this document.
-
-      "Licensor" shall mean the copyright owner or entity authorized by
-      the copyright owner that is granting the License.
-
-      "Legal Entity" shall mean the union of the acting entity and all
-      other entities that control, are controlled by, or are under common
-      control with that entity. For the purposes of this definition,
-      "control" means (i) the power, direct or indirect, to cause the
-      direction or management of such entity, whether by contract or
-      otherwise, or (ii) ownership of fifty percent (50%) or more of the
-      outstanding shares, or (iii) beneficial ownership of such entity.
-
-      "You" (or "Your") shall mean an individual or Legal Entity
-      exercising permissions granted by this License.
-
-      "Source" form shall mean the preferred form for making modifications,
-      including but not limited to software source code, documentation
-      source, and configuration files.
-
-      "Object" form shall mean any form resulting from mechanical
-      transformation or translation of a Source form, including but
-      not limited to compiled object code, generated documentation,
-      and conversions to other media types.
-
-      "Work" shall mean the work of authorship, whether in Source or
-      Object form, made available under the License, as indicated by a
-      copyright notice that is included in or attached to the work
-      (an example is provided in the Appendix below).
-
-      "Derivative Works" shall mean any work, whether in Source or Object
-      form, that is based on (or derived from) the Work and for which the
-      editorial revisions, annotations, elaborations, or other modifications
-      represent, as a whole, an original work of authorship. For the purposes
-      of this License, Derivative Works shall not include works that remain
-      separable from, or merely link (or bind by name) to the interfaces of,
-      the Work and Derivative Works thereof.
-
-      "Contribution" shall mean any work of authorship, including
-      the original version of the Work and any modifications or additions
-      to that Work or Derivative Works thereof, that is intentionally
-      submitted to Licensor for inclusion in the Work by the copyright owner
-      or by an individual or Legal Entity authorized to submit on behalf of
-      the copyright owner. For the purposes of this definition, "submitted"
-      means any form of electronic, verbal, or written communication sent
-      to the Licensor or its representatives, including but not limited to
-      communication on electronic mailing lists, source code control systems,
-      and issue tracking systems that are managed by, or on behalf of, the
-      Licensor for the purpose of discussing and improving the Work, but
-      excluding communication that is conspicuously marked or otherwise
-      designated in writing by the copyright owner as "Not a Contribution."
-
-      "Contributor" shall mean Licensor and any individual or Legal Entity
-      on behalf of whom a Contribution has been received by Licensor and
-      subsequently incorporated within the Work.
-
-   2. Grant of Copyright License. Subject to the terms and conditions of
-      this License, each Contributor hereby grants to You a perpetual,
-      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
-      copyright license to reproduce, prepare Derivative Works of,
-      publicly display, publicly perform, sublicense, and distribute the
-      Work and such Derivative Works in Source or Object form.
-
-   3. Grant of Patent License. Subject to the terms and conditions of
-      this License, each Contributor hereby grants to You a perpetual,
-      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
-      (except as stated in this section) patent license to make, have made,
-      use, offer to sell, sell, import, and otherwise transfer the Work,
-      where such license applies only to those patent claims licensable
-      by such Contributor that are necessarily infringed by their
-      Contribution(s) alone or by combination of their Contribution(s)
-      with the Work to which such Contribution(s) was submitted. If You
-      institute patent litigation against any entity (including a
-      cross-claim or counterclaim in a lawsuit) alleging that the Work
-      or a Contribution incorporated within the Work constitutes direct
-      or contributory patent infringement, then any patent licenses
-      granted to You under this License for that Work shall terminate
-      as of the date such litigation is filed.
-
-   4. Redistribution. You may reproduce and distribute copies of the
-      Work or Derivative Works thereof in any medium, with or without
-      modifications, and in Source or Object form, provided that You
-      meet the following conditions:
-
-      (a) You must give any other recipients of the Work or
-          Derivative Works a copy of this License; and
-
-      (b) You must cause any modified files to carry prominent notices
-          stating that You changed the files; and
-
-      (c) You must retain, in the Source form of any Derivative Works
-          that You distribute, all copyright, patent, trademark, and
-          attribution notices from the Source form of the Work,
-          excluding those notices that do not pertain to any part of
-          the Derivative Works; and
-
-      (d) If the Work includes a "NOTICE" text file as part of its
-          distribution, then any Derivative Works that You distribute must
-          include a readable copy of the attribution notices contained
-          within such NOTICE file, excluding those notices that do not
-          pertain to any part of the Derivative Works, in at least one
-          of the following places: within a NOTICE text file distributed
-          as part of the Derivative Works; within the Source form or
-          documentation, if provided along with the Derivative Works; or,
-          within a display generated by the Derivative Works, if and
-          wherever such third-party notices normally appear. The contents
-          of the NOTICE file are for informational purposes only and
-          do not modify the License. You may add Your own attribution
-          notices within Derivative Works that You distribute, alongside
-          or as an addendum to the NOTICE text from the Work, provided
-          that such additional attribution notices cannot be construed
-          as modifying the License.
-
-      You may add Your own copyright statement to Your modifications and
-      may provide additional or different license terms and conditions
-      for use, reproduction, or distribution of Your modifications, or
-      for any such Derivative Works as a whole, provided Your use,
-      reproduction, and distribution of the Work otherwise complies with
-      the conditions stated in this License.
-
-   5. Submission of Contributions. Unless You explicitly state otherwise,
-      any Contribution intentionally submitted for inclusion in the Work
-      by You to the Licensor shall be under the terms and conditions of
-      this License, without any additional terms or conditions.
-      Notwithstanding the above, nothing herein shall supersede or modify
-      the terms of any separate license agreement you may have executed
-      with Licensor regarding such Contributions.
-
-   6. Trademarks. This License does not grant permission to use the trade
-      names, trademarks, service marks, or product names of the Licensor,
-      except as required for reasonable and customary use in describing the
-      origin of the Work and reproducing the content of the NOTICE file.
-
-   7. Disclaimer of Warranty. Unless required by applicable law or
-      agreed to in writing, Licensor provides the Work (and each
-      Contributor provides its Contributions) on an "AS IS" BASIS,
-      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
-      implied, including, without limitation, any warranties or conditions
-      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
-      PARTICULAR PURPOSE. You are solely responsible for determining the
-      appropriateness of using or redistributing the Work and assume any
-      risks associated with Your exercise of permissions under this License.
-
-   8. Limitation of Liability. In no event and under no legal theory,
-      whether in tort (including negligence), contract, or otherwise,
-      unless required by applicable law (such as deliberate and grossly
-      negligent acts) or agreed to in writing, shall any Contributor be
-      liable to You for damages, including any direct, indirect, special,
-      incidental, or consequential damages of any character arising as a
-      result of this License or out of the use or inability to use the
-      Work (including but not limited to damages for loss of goodwill,
-      work stoppage, computer failure or malfunction, or any and all
-      other commercial damages or losses), even if such Contributor
-      has been advised of the possibility of such damages.
-
-   9. Accepting Warranty or Additional Liability. While redistributing
-      the Work or Derivative Works thereof, You may choose to offer,
-      and charge a fee for, acceptance of support, warranty, indemnity,
-      or other liability obligations and/or rights consistent with this
-      License. However, in accepting such obligations, You may act only
-      on Your own behalf and on Your sole responsibility, not on behalf
-      of any other Contributor, and only if You agree to indemnify,
-      defend, and hold each Contributor harmless for any liability
-      incurred by, or claims asserted against, such Contributor by reason
-      of your accepting any such warranty or additional liability.
-
-   END OF TERMS AND CONDITIONS
-
-   APPENDIX: How to apply the Apache License to your work.
-
-      To apply the Apache License to your work, attach the following
-      boilerplate notice, with the fields enclosed by brackets "[]"
-      replaced with your own identifying information. (Don't include
-      the brackets!)  The text should be enclosed in the appropriate
-      comment syntax for the file format. We also recommend that a
-      file or class name and description of purpose be included on the
-      same "printed page" as the copyright notice for easier
-      identification within third-party archives.
-
-   Copyright (c) 2010 Wilker Lúcio <wilkerlucio@gmail.com>
-
-   Licensed under the Apache License, Version 2.0 (the "License");
-   you may not use this file except in compliance with the License.
-   You may obtain a copy of the License at
-
-       http://www.apache.org/licenses/LICENSE-2.0
-
-   Unless required by applicable law or agreed to in writing, software
-   distributed under the License is distributed on an "AS IS" BASIS,
-   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-   See the License for the specific language governing permissions and
-   limitations under the License.