padrino-form-errors 0.0.3

data/.gitignore

@@ -0,0 +1,24 @@
+## MAC OS
+.DS_Store
+
+## TEXTMATE
+*.tmproj
+tmtags
+
+## EMACS
+*~
+\#*
+.\#*
+
+## VIM
+*.swp
+
+## PROJECT::GENERAL
+coverage
+rdoc
+pkg
+
+## PROJECT::SPECIFIC
+*.gem
+.yardoc
+doc

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 Kriss 'nu7hatch' Kowalik
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.rdoc

@@ -0,0 +1,60 @@
+= Padrino form errors helper
+
+This plugin is overriding standard +error_messages_for+ and +error_message_on+. 
+Now you can decide in which template will be displayed your validation messages. 
+
+== Installation
+
+Install plugin via rubygems:
+
+  gem install padrino-form-errors
+  
+And run generator:
+
+  padrino-gen form_errors
+  
+In your +app/views/shared+ you'll find two new partials:
+
++_error_messages.html.*+ :: template for error_messages_for
++_error_message.html.*+  :: template for error_message_on
+
+== Overriding templates
+
+You can freely modify views listed above. In +_error_messages+ you can use
+following local variables:
+
++object+ :: main object passed in arguments (or associated with form)
++errors+ :: merged list with errors
+
+In +_error_message+ there are following local variables:
+
++object+ :: object passed in arguments (or associated with form)
++field+  :: field name passed in arguments
++error+  :: error message
+
+== Usage
+
+You don't have to learn nothing new about how to use functionalities provided
+by this plugin. Like I said it overrides standard helpers, so when you will
+write... 
+
+  - form_for @user, url(:users_create) do |f|
+    = f.error_messages
+    -# ...
+    
+...then error messages for this form will be displayed using from your shared
+templates. The same is with +error_messages_for+ and +error_message_on+. 
+
+== Note on Patches/Pull Requests
+ 
+* Fork the project.
+* Make your feature addition or bug fix.
+* Add tests for it. This is important so I don't break it in a
+  future version unintentionally.
+* Commit, do not mess with rakefile, version, or history.
+  (if you want to have your own version, that is fine but bump version in a commit by itself I can ignore when I pull)
+* Send me a pull request. Bonus points for topic branches.
+
+== Copyright
+
+Copyright (c) 2010 Kriss 'nu7hatch' Kowalik. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,49 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "padrino-form-errors"
+    gem.summary = %Q{Form validation errors helper for Padrino}
+    gem.description = %Q{Validation errors explanation done in good way for Padrino framework.}
+    gem.email = "kriss.kowalik@gmail.com"
+    gem.homepage = "http://github.com/nu7hatch/padrino-form-errors"
+    gem.authors = ["Kriss 'nu7hatch' Kowalik"]
+    gem.add_dependency "padrino", ">= 0.9.14"
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: gem install jeweler"
+end
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/*_test.rb'
+  test.verbose = true
+end
+
+begin
+  require 'rcov/rcovtask'
+  Rcov::RcovTask.new do |test|
+    test.libs << 'test'
+    test.pattern = 'test/**/*_test.rb'
+    test.verbose = true
+  end
+rescue LoadError
+  task :rcov do
+    abort "RCov is not available. In order to run rcov, you must: sudo gem install spicycode-rcov"
+  end
+end
+
+task :default => :test
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "Padrino errors explanation plugin #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.0.3

data/lib/padrino-form-errors.rb

@@ -0,0 +1,34 @@
+require 'padrino-core'
+require 'padrino-gen'
+require 'padrino-helpers'
+
+FileSet.glob_require('padrino-form-errors/*.rb', __FILE__)
+FileSet.glob_require('padrino-form-errors/helpers/*.rb', __FILE__)
+
+module Padrino
+  ##
+  # This component is used to display flexible error messages in your forms. 
+  #
+  module FormErrors
+    ##
+    # Method used by Padrino::Application when we register the extension
+    #
+    class << self
+      def registered(app)
+        app.helpers Padrino::FormErrors::Helpers::FormHelpers
+      end
+      alias :included :registered
+    end
+  end
+end
+
+##
+# Load our Padrino::Responders locales
+#
+I18n.load_path += Dir["#{File.dirname(__FILE__)}/padrino-form-errors/locale/**/*.yml"]
+
+##
+# Now we need to add form explanations views generators to padrino-gen
+#
+Padrino::Generators.load_paths << Dir[File.dirname(__FILE__) + '/padrino-form-errors/generators/{errors_explanation}.rb']
+

data/lib/padrino-form-errors/generators/defaults.rb

@@ -0,0 +1,32 @@
+module Padrino
+  module FormErrors
+    module Generators
+      class Defaults < Thor::Group
+        # Add this generator to our padrino-gen
+        Padrino::Generators.add_generator(:form_errors, self)
+
+        # Define the source template root
+        def self.source_root; File.expand_path(File.dirname(__FILE__)); end
+        def self.banner; "padrino-gen form_errors"; end
+
+        # Include related modules
+        include Thor::Actions
+        include Padrino::Generators::Actions
+
+        desc "Description:\n\n\tpadrino-gen form_errors"
+
+        # Create default views. 
+        def create_views
+          ext = fetch_component_choice(:renderer)
+          self.destination_root = options[:root]
+          if in_app_root?
+            template "templates/#{ext}/_error_messages.#{ext}.tt", destination_root("/app/views/shared/_error_messages.html.#{ext}")
+            template "templates/#{ext}/_error_message.#{ext}.tt",  destination_root("/app/views/shared/_error_message.html.#{ext}")
+          else
+            say "You are not at the root of a Padrino application! (config/boot.rb not found)"
+          end
+        end
+      end # Defaults
+    end # Generators
+  end # FormErrors
+end # Padrino

data/lib/padrino-form-errors/generators/templates/erb/_error_message.erb.tt

@@ -0,0 +1,3 @@
+<div class="inline-error">
+  <%= error.to_s %>
+</div>

data/lib/padrino-form-errors/generators/templates/erb/_error_messages.erb.tt

@@ -0,0 +1,8 @@
+<div class="errors-explanation">
+  <h3><%= object.class.to_s.underscore %> couldn not be saved</h3>
+  <ul>
+    <%- object.errors.full_messages.each do |msg| %>
+      <li><%= msg %></li>
+    <%- end %>
+  </ul>
+</div>

data/lib/padrino-form-errors/generators/templates/haml/_error_message.haml.tt

@@ -0,0 +1 @@
+.inline-error= error.to_s

data/lib/padrino-form-errors/generators/templates/haml/_error_messages.haml.tt

@@ -0,0 +1,5 @@
+.errors-explanation
+  %h3 #{object.class.to_s.underscore} couldn not be saved
+  %ul
+    - object.errors.full_messages.each do |msg|
+      %li= msg

data/lib/padrino-form-errors/helpers/form_helpers.rb

@@ -0,0 +1,51 @@
+module Padrino
+  module FormErrors
+    module Helpers
+      module FormHelpers
+        ##
+        # It displays validation errors for given object. Here is an HAML example:
+        # 
+        # ==== Examples
+        #
+        #   - form_tag url(:users) do
+        #     = error_messages_for(@user)
+        #     -# ...
+        # 
+        def error_messages_for(*objects)
+          objects.map! do |object| 
+            if object.is_a? Symbol 
+              instance_variable_get("@#{object}")
+            elsif object.respond_to? :object
+              object = object.object
+            else
+              object 
+            end
+          end
+          errors = objects.map {|object| object.errors }.flatten
+          if errors.size > 0
+            partial "shared/error_messages", :locals => { :object => objects.first, :errors => errors }
+          end 
+        end
+        
+        ##
+        # It displays inline error for single field. 
+        #
+        # ==== Examples
+        #
+        #   - form_tag url(:sessions_login) do
+        #     = label "Login", :for => :login
+        #     = text_field_tag :login
+        #     = error_messages_on(@session, :login)
+        #     -# ...
+        #
+        def error_messages_on(object, field)
+          object = instance_variable_get("@#{object}") if object.is_a?(Symbol)
+          error = object.errors[field] rescue nil
+          if error
+            partial "shared/error_message", :locals => { :object => object, :field => field, :error => error }
+          end
+        end
+      end # FormHelpers
+    end # Helpers
+  end # FormErrors
+end # Padrino

metadata

@@ -0,0 +1,94 @@
+--- !ruby/object:Gem::Specification 
+name: padrino-form-errors
+version: !ruby/object:Gem::Version 
+  hash: 25
+  prerelease: false
+  segments: 
+  - 0
+  - 0
+  - 3
+  version: 0.0.3
+platform: ruby
+authors: 
+- Kriss 'nu7hatch' Kowalik
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-09-06 00:00:00 +02:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: padrino
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 39
+        segments: 
+        - 0
+        - 9
+        - 14
+        version: 0.9.14
+  type: :runtime
+  version_requirements: *id001
+description: Validation errors explanation done in good way for Padrino framework.
+email: kriss.kowalik@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.rdoc
+files: 
+- .gitignore
+- LICENSE
+- README.rdoc
+- Rakefile
+- VERSION
+- lib/padrino-form-errors.rb
+- lib/padrino-form-errors/generators/defaults.rb
+- lib/padrino-form-errors/generators/templates/erb/_error_message.erb.tt
+- lib/padrino-form-errors/generators/templates/erb/_error_messages.erb.tt
+- lib/padrino-form-errors/generators/templates/haml/_error_message.haml.tt
+- lib/padrino-form-errors/generators/templates/haml/_error_messages.haml.tt
+- lib/padrino-form-errors/helpers/form_helpers.rb
+has_rdoc: true
+homepage: http://github.com/nu7hatch/padrino-form-errors
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: Form validation errors helper for Padrino
+test_files: []
+