RubyGems - styx - Versions diffs - 0.0.1 → 0.0.2 - Mend

styx 0.0.1 → 0.0.2

Files changed (4) hide show

data/README.md CHANGED

@@ -1,18 +1,24 @@
 Styx
 ========
-Bridge between Server (Rails) side and Client (JS) side divided into several modules:
+Bridge between Server (Rails) side and Client (JS) side which is divided into several modules:
 * **Helpers**: set of helpers to support all other modules.
 * **Initializer**: organizes JS into bootstrap classes and allows you to pass data from controller/view.
-* **Forms**: remote validaton engine.
+* **Forms**: remote validation engine.
 Installation
 ------------
-    $ gem install styx
+In your Gemfile, add this line:
+    gem 'styx'
+In your assets application.js include appropriate libs:
+    //= require styx           <- Helpers and Initializers
+    //= require styx.forms     <- Forms
 Basic Usage
 ------------
@@ -32,10 +38,10 @@ Initializer
 ------------
 In common each controller in Rails comes with *app/assets/javascripts/controller_name.js.coffee*.
-Styx.Initializer allows you to separately define bootstrap logic for each Rails action and pass
-some data from server right in.
+**Styx.Initializer** allows you to define bootstrap logic for each Rails action separately and
+pass some data from server right into it.
-To enable initializers bootstrap, add *styx_initialize* line to your layout:
+To enable initializers bootstrap, add *styx_initialize* call into your layout:
 ```erb
   <head>
@@ -87,7 +93,7 @@ Forms
 Forms assist *form_for @foo, :remote => true* to automate server response and UJS callbacks.
 If everything went smooth you can respond with URL for redirect or with JSON for your callback.
-If validation failed appropriate form fields will be wraped with native
+If validation failed appropriate form fields will be wrapped in a native way:
     <div class="field_with_errors">
@@ -112,14 +118,14 @@ error_callback = function() {}          // Form wasn't validated
 Forms.attach('#foo_form', success_callback, error_callback)
 ```
-Note that if success_callback was not given but server responded with some data, Styx.Forms will try
+Note that if success_callback was not given but server responded with some data, **Styx.Forms** will try
 to evaluate it as URL and will try to redirect to it.
-Javascript part goes best with Styx.Initializers.
+Javascript part goes best with **Styx.Initializers**.
 ### Server side
-In common you just want to store your form as model. Styx.Forms come with predefined helper for this:
+In common you just want to store your form as a model. **Styx.Forms** come with a predefined helper for this:
 ```ruby
 # app/controllers/foos_controller.rb
@@ -133,18 +139,18 @@ def create
 end
 ```
-*response* parameter can either be passed as lambda{|x|}.
+*response* parameter can also be passed as lambda{|x|}.
-### What if form was invalid?
+### What if the form was invalid?
-First of all, *success_callback* and server-side block won't be called. *response* won't be return to JS.
-Validation errors for @entity will be returned instead. All invalid form fields will be wraped with
+First of all, *success_callback* and server-side block wouldn't be called. *response* wouldn't be return to JS.
+Instead validation errors for @entity will be returned. All invalid form fields will be wrapped with
     <div class="field_with_errors">
 ### Server side without models
-To work without models (i.e. to serve login form) you can use two helpers
+You can use two helpers to work without models (i.e. to serve login form):
 ```ruby
   styx_form_respond_success(data)
@@ -154,5 +160,28 @@ To work without models (i.e. to serve login form) you can use two helpers
   styx_form_respond_failure(entity_name, fields) # fields = {'field_name' => 'error message'}
 ```
-To choose which fields have to be marked as invalid JS part will concatenate entity_name + field _name. So if
-you don't have entity, simply pass empty string as the first arg.
+JS part will concatenate *entity_name* + *field_name* to locate which fields have to be marked as invalid.
+So if you don't have entity, simply pass empty string as the first arg.
+License
+-------
+    Copyright (C) 2011 by Boris Staal <boris@roundlake.ru>
+    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/lib/styx/helpers.rb CHANGED

@@ -9,15 +9,23 @@ module Styx
     module InstanceMethods
       def this_page?(mask)
-        mask = mask.split('#')
+        mask = [mask] unless mask.is_a?(Array)
-        c = mask[0]
-        a = mask[1]
+        flag = false
-        flag = true
+        mask.each do |m|
+          m = m.to_s.split('#')
-        flag = false if !c.blank? && c != controller_path
-        flag = false if !a.blank? && a != action_name
+          c = m[0]
+          a = m[1]
+          f = true
+          f = false if !c.blank? && c != controller_name
+          f = false if !a.blank? && a != action_name
+          flag ||= f
+        end
         flag
       end

data/styx.gemspec CHANGED

@@ -1,6 +1,6 @@
 SPEC = Gem::Specification.new do |s|
   s.name        = "styx"
-  s.version     = "0.0.1"
+  s.version     = "0.0.2"
   s.platform    = Gem::Platform::RUBY
   s.summary     = "Set of helpers to maintain bridge between Server (Rails) side and Client (JS) side"
   s.email       = "boris@roundlake.ru"

metadata CHANGED

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: styx
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
   prerelease:
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2011-11-22 00:00:00.000000000 Z
+date: 2011-12-02 00:00:00.000000000 Z
 dependencies: []
 description: Set of helpers to maintain bridge between Server (Rails) side and Client
   (JS) side