validate-response 0.0.5

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 91e7b7e133902415a50dcebaeac0245c1b051ac9
+  data.tar.gz: ccb7aa9688e674989eade76de31b35b454bed2d7
+SHA512:
+  metadata.gz: 92661d94472777c380758311a31bd4ccf817b13e44216dcf76faf16a030961c31e3fa69362d7f6fc8e56c60677f6d58a44c510eb6924b7570cfa969958bb41b4
+  data.tar.gz: 8f4f91a97aa37b03747f9a8a2afaf87cc138797f59ba3f0d965c5c9b90d716dd13901c826d9bb24e4c0164fa739e71c7e40353caa3b613f3a64ef2a0bf4588ed

data/.gitignore

@@ -0,0 +1,10 @@
+.bundle/
+log/*.log
+pkg/
+test/dummy/db/*.sqlite3
+test/dummy/db/*.sqlite3-journal
+test/dummy/log/*.log
+test/dummy/tmp/
+test/dummy/.sass-cache
+.idea
+.idea/*

data/Gemfile

@@ -0,0 +1,14 @@
+source "https://rubygems.org"
+
+# Declare your gem's dependencies in validate_response.gemspec.
+# Bundler will treat runtime dependencies like base dependencies, and
+# development dependencies will be added by default to the :development group.
+gemspec
+
+# Declare any dependencies that are still in development here instead of in
+# your gemspec. These might include edge Rails or gems from your path or
+# Git. Remember to move these dependencies to your gemspec before releasing
+# your gem to rubygems.org.
+
+# To use debugger
+# gem 'debugger'

data/Gemfile.lock

@@ -0,0 +1,100 @@
+PATH
+  remote: .
+  specs:
+    validate-response (0.0.5)
+      coffee-rails (>= 3.2)
+      rails (>= 3.2)
+      railties (>= 3.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    actionmailer (4.1.0)
+      actionpack (= 4.1.0)
+      actionview (= 4.1.0)
+      mail (~> 2.5.4)
+    actionpack (4.1.0)
+      actionview (= 4.1.0)
+      activesupport (= 4.1.0)
+      rack (~> 1.5.2)
+      rack-test (~> 0.6.2)
+    actionview (4.1.0)
+      activesupport (= 4.1.0)
+      builder (~> 3.1)
+      erubis (~> 2.7.0)
+    activemodel (4.1.0)
+      activesupport (= 4.1.0)
+      builder (~> 3.1)
+    activerecord (4.1.0)
+      activemodel (= 4.1.0)
+      activesupport (= 4.1.0)
+      arel (~> 5.0.0)
+    activesupport (4.1.0)
+      i18n (~> 0.6, >= 0.6.9)
+      json (~> 1.7, >= 1.7.7)
+      minitest (~> 5.1)
+      thread_safe (~> 0.1)
+      tzinfo (~> 1.1)
+    arel (5.0.1.20140414130214)
+    builder (3.2.2)
+    coffee-rails (4.0.1)
+      coffee-script (>= 2.2.0)
+      railties (>= 4.0.0, < 5.0)
+    coffee-script (2.2.0)
+      coffee-script-source
+      execjs
+    coffee-script-source (1.7.0)
+    erubis (2.7.0)
+    execjs (2.0.2)
+    hike (1.2.3)
+    i18n (0.6.9)
+    json (1.8.1)
+    mail (2.5.4)
+      mime-types (~> 1.16)
+      treetop (~> 1.4.8)
+    mime-types (1.25.1)
+    minitest (5.3.3)
+    multi_json (1.9.2)
+    polyglot (0.3.4)
+    rack (1.5.2)
+    rack-test (0.6.2)
+      rack (>= 1.0)
+    rails (4.1.0)
+      actionmailer (= 4.1.0)
+      actionpack (= 4.1.0)
+      actionview (= 4.1.0)
+      activemodel (= 4.1.0)
+      activerecord (= 4.1.0)
+      activesupport (= 4.1.0)
+      bundler (>= 1.3.0, < 2.0)
+      railties (= 4.1.0)
+      sprockets-rails (~> 2.0)
+    railties (4.1.0)
+      actionpack (= 4.1.0)
+      activesupport (= 4.1.0)
+      rake (>= 0.8.7)
+      thor (>= 0.18.1, < 2.0)
+    rake (10.3.0)
+    sprockets (2.12.0)
+      hike (~> 1.2)
+      multi_json (~> 1.0)
+      rack (~> 1.0)
+      tilt (~> 1.1, != 1.3.0)
+    sprockets-rails (2.1.3)
+      actionpack (>= 3.0)
+      activesupport (>= 3.0)
+      sprockets (~> 2.8)
+    thor (0.19.1)
+    thread_safe (0.3.3)
+    tilt (1.4.1)
+    treetop (1.4.15)
+      polyglot
+      polyglot (>= 0.3.1)
+    tzinfo (1.1.0)
+      thread_safe (~> 0.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  validate-response!

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2014 Alexander Gorbunov (lexgorbunov@gmail.com)
+
+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.md

@@ -0,0 +1,235 @@
+# ValidationResponse
+
+ValidationResponse это библиотека для приведения к единообразной структуре сообщения об ошибках одного или нескольких объектов ActiveRecord
+
++ Подсветка полей с ошибками в формах
+
+## Установка (Installation)
+
+Add this line to your application's Gemfile:
+
+    gem 'validate-response', '~> 0.0.5'
+
+And then execute:
+
+    $ bundle install
+
+Add this line to your application.js
+
+    //= require validate-response
+
+## Как использовать (Usage)
+
+__(!)__ ```nil``` - Используется для обозначения *new_record* записей (еще не сохраненных в базе)
+
+### Пример использования (Usage example):
+#### Сервер (Server):
+
+```ruby
+room = Room.create(params[:room])
+render json: {
+  result: room.valid?,
+  validates: ValidateResponse.new(room)
+}
+```
+#### Клиент (Client):
+
+##### Код
+
+```coffeescreept
+# dom element containing the highlightable fields
+$form = $('.my-form')
+$.ajax
+  url:      '/'
+  type:     'POST'
+  dataType: 'json'
+  success:  (data) ->
+    $(document).trigger ValidateResponse.EVENT_SHOW_ERRORS, [$form, data.validates] if data.validates
+```
+
+##### DOM
+
+```haml
+.my-form
+  %div
+    %label{data: {vr_field: "rooms|#{@room.id}|field1"}} Label 1
+    %input{type: 'text', value: @room.field1, name: 'room[field1]'}
+  %div
+    %label{data: {vr_field: "rooms||field2", vr_way: 'border'}} Label 2
+    %input{type: 'text', value: @room.field2, name: 'room[field2]'}
+```
+
+### Привила настройки форм (Form settings rules)
+
+#### data-vr-field:
+
+    # @room => Модель Room
+    # @room.id => 1
+    
+  vr-field:
+
+    vr-field: 'rooms|1|field_name'
+---
+
+    #@room => Модель Room
+    #@room.id => nil
+
+  vr-field:
+
+    vr-field: 'rooms||field_name'
+
+#### data-vr-way:
+    data-vr-way: 'color'
+      Вслучае ошибки цвет текста станет красным
+    'title'
+      Вслучае ошибки текст всплывающей подсказки будет содержать сообщение об ошибке
+    'outline'
+      Вслучае ошибки цвет внешней рамки станет красным
+    'border'
+      Вслучае ошибки цвет рамки станет красным
+    'background'
+      Вслучае ошибки цвет фона станет красным
+
+  После устранения ошибок для каждого поля все измененные свойства восстанавливаются до первоначального состояния
+
+  __Свойства vr-way можно группировать__
+
+  ``` vr-way: 'color|title' ```
+### Другие примеры (More examples):
+
+```ruby
+render json: {
+  result: @user.update_attributes(params[:user]),
+  validates: ValidateResponse.new(@user.contacts)
+}
+```
+-- or --
+```ruby
+  ValidateResponse.new(
+    Room.create,
+    User.create,
+    User.last.tap{|u| u.email = nil; u.valid?}
+  )
+```
+вернет (return)
+```
+{
+    :rooms => {
+        nil => {
+            :location_id => [
+                [0] "не может быть пустым"
+            ],
+                   :user => [
+                [0] "не может быть пустым"
+            ],
+                  :floor => [
+                [0] "не является числом"
+            ],
+                     :sq => [
+                [0] "не является числом"
+            ],
+              :price_psm => [
+                [0] "не является числом"
+            ],
+             :total_cost => [
+                [0] "не является числом"
+            ]
+        }
+    },
+    :users => {
+        nil => {
+               :email => [
+                [0] "не может быть пустым"
+            ],
+            :password => [
+                [0] "не может быть пустым"
+            ],
+             :city_id => [
+                [0] "не может быть пустым"
+            ],
+             :company => [
+                [0] "не может быть пустым"
+            ]
+        },
+        242 => {
+            :email => [
+                [0] "не может быть пустым"
+            ]
+        }
+    }
+}
+```
+### Поддерживаются объекты разных моделей (Supported object of different AR models at the same time)
+
+```ruby
+a.update_attributes(...)
+b.update_attributes(...)
+ValidateResponse.new(a, b)
+```
+    
+### Примеры заполнения (Filling examples):
+
+#### Пример 1 (Example 1):
+
+```ruby
+  ValidateResponse.new(@user.contacts)
+```
+
+#### Пример 2 (Example 2):
+```ruby
+ValidateResponse.new(@room1, @room2)
+```
+
+#### Пример 3 (Example 3):
+
+```ruby
+x = ValidateResponse.new()
+x << contact1
+x << contact2
+x << contact3 << contact4
+```
+
+#### Пример 4. Ручное заполнение (Example 4 Manual filling):
+
+```ruby
+x = ValidateResponse.new()
+x[:users, 1] = {
+  name: 'ошибка такая-то',
+  age: ['несоответствие 1', 'несоответствие 2']
+}
+x[:users, nil] = {
+  name: 'ошибка такая-то',
+  age: ['несоответствие 1', 'несоответствие 2']
+}
+```
+
+#### Пример 5. Ручное заполнение (Example 5 Manual filling):
+
+```ruby
+x = ValidateResponse.new()
+x[:users] = {
+  1 => {
+    name: 'ошибка такая-то',
+    age: ['несоответствие 1', 'несоответствие 2']
+  },
+  nil => {
+    name: 'ошибка такая-то',
+    age: ['несоответствие 1', 'несоответствие 2']
+  }
+}
+```
+
+#### Пример 6. Ручное заполнение (Example 6 Manual filling):
+
+```ruby
+x = ValidateResponse.new()
+x[:users, nil][:name] = ['несоответствие 1', 'несоответствие 2']
+```
+
+## Для разработчиков (Contributing)
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,32 @@
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+require 'rdoc/task'
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'ValidateResponse'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+
+
+
+Bundler::GemHelper.install_tasks
+
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = false
+end
+
+
+task default: :test

data/app/assets/javascripts/validate-response/index.js

@@ -0,0 +1 @@
+//= require ./validate_response_client

data/app/assets/javascripts/validate-response/validate_response_client.js.coffee

@@ -0,0 +1,91 @@
+(($) ->
+#  $.fn.validate
+
+  $ ->
+    class ValidateResponse
+      WAY_EXPR = /^css:\w+/
+      DEFAULT_WAY: 'color|title'
+      # Events
+      EVENT_SHOW_ERRORS: 'validate-response:show-errors'
+
+      constructor: ->
+#        @EVENT_SHOW_ERRORS = EVENT_SHOW_ERRORS
+        # subscribe on show errors event
+        $(document).on @.EVENT_SHOW_ERRORS, (e, form, validation_data) => @show_errors(form, validation_data)
+
+      show_errors: (form, validation_data) =>
+        $form = $(form)
+        summary = $form.find('[role="vr-summary"]').empty()
+        need_summary = !!summary.length
+        # Adding summary
+        if need_summary
+          summary.addClass('vr-empty-summary')
+          for record_type, records_validations of validation_data
+            record_type_errors = $('<div class="vr-record-type-errors">').addClass("vr-record-type-#{record_type}")
+            for record_id, validations_fields of records_validations
+              record_errors = $('<div class="vr-record-errors">').addClass("vr-record-id-#{record_type}")
+              for field_id, validation_messages of validations_fields
+                field_errors = $('<div class="vr-field-errors">').addClass("vr-field-id-#{field_id}").append($('<div>').html(field_id)).append(field_errors_messages = $('<div>'))
+                for message in validation_messages
+                  field_errors_messages.append $('<div class="vr-error-message">').html(message)
+                record_errors.append field_errors
+              record_type_errors.append record_errors
+            summary.append record_type_errors
+        else
+          summary.removeClass('vr-empty-summary')
+        # Highlight fields
+        @reset_highlight($form)
+        for record_type, records_validations of validation_data
+          for record_id, validations_fields of records_validations
+            for field_id, validation_messages of validations_fields
+              for message in validation_messages
+                field_selector = [record_type, record_id, field_id].join('|')
+                fields = $form.find("[data-vr-field=\"#{field_selector}\"]")
+                for field_element in fields
+                  field = $(field_element)
+                  for way in (field.data('vr-way') || @.DEFAULT_WAY).split('|')
+                    switch way
+                      when 'color'
+                        field.data('vr-backstore-color', (field.css('color') || '#000'))
+                        field.css('color', '#D0413B')
+                      when 'title'
+                        field.data('vr-backstore-title', (field.attr('title') || ''))
+                        field.attr('title', message)
+                      when 'outline'
+                        field.data('vr-backstore-outline', (field.css('outline') || 'none'))
+                        field.css('outline', '1px solid #D0413B')
+                      when 'border'
+                        field.data('vr-backstore-border', (field.css('border') || 'none'))
+                        field.css('border', '1px solid #D0413B')
+                      when 'background'
+                        field.data('vr-backstore-background', (field.css('background') || 'none'))
+                        field.css('background', '1px solid #D0413B')
+                      else
+                        continue
+      # --- end of show_errors ---
+
+      reset_highlight: (form) =>
+        $form = $(form)
+        vr_fields = $form.find('[data-vr-field]')
+        for field in vr_fields
+          $fields = $(field)
+          for field in $fields
+            $field = $(field)
+            for way in ($field.data('vr-way') || @.DEFAULT_WAY).split('|')
+              switch way
+                when 'color'
+                  $field.css('color', vr_backval) if (vr_backval = $field.data('vr-backstore-color'))?
+                when 'title'
+                  $field.attr('title', vr_backval) if (vr_backval = $field.data('vr-backstore-title'))?
+                when 'outline'
+                  $field.css('outline', vr_backval) if (vr_backval = $field.data('vr-backstore-outline'))?
+                when 'border'
+                  $field.css('border', vr_backval) if (vr_backval = $field.data('vr-backstore-border'))?
+                when 'background'
+                  $field.css('background', vr_backval) if (vr_backval = $field.data('vr-backstore-background'))?
+                else
+                  continue
+      # --- end of reset_highlight ---
+
+    window.ValidateResponse = new ValidateResponse()
+)(jQuery)