evil-blocks-rails 0.1.0

data/ChangeLog

@@ -0,0 +1,2 @@
+== 0.1 (The Gadget, 16th July 1945)
+* Initial release.

data/LICENSE

@@ -0,0 +1,165 @@
+                   GNU LESSER GENERAL PUBLIC LICENSE
+                       Version 3, 29 June 2007
+
+ Copyright (C) 2007 Free Software Foundation, Inc. <http://fsf.org/>
+ Everyone is permitted to copy and distribute verbatim copies
+ of this license document, but changing it is not allowed.
+
+
+  This version of the GNU Lesser General Public License incorporates
+the terms and conditions of version 3 of the GNU General Public
+License, supplemented by the additional permissions listed below.
+
+  0. Additional Definitions.
+
+  As used herein, "this License" refers to version 3 of the GNU Lesser
+General Public License, and the "GNU GPL" refers to version 3 of the GNU
+General Public License.
+
+  "The Library" refers to a covered work governed by this License,
+other than an Application or a Combined Work as defined below.
+
+  An "Application" is any work that makes use of an interface provided
+by the Library, but which is not otherwise based on the Library.
+Defining a subclass of a class defined by the Library is deemed a mode
+of using an interface provided by the Library.
+
+  A "Combined Work" is a work produced by combining or linking an
+Application with the Library.  The particular version of the Library
+with which the Combined Work was made is also called the "Linked
+Version".
+
+  The "Minimal Corresponding Source" for a Combined Work means the
+Corresponding Source for the Combined Work, excluding any source code
+for portions of the Combined Work that, considered in isolation, are
+based on the Application, and not on the Linked Version.
+
+  The "Corresponding Application Code" for a Combined Work means the
+object code and/or source code for the Application, including any data
+and utility programs needed for reproducing the Combined Work from the
+Application, but excluding the System Libraries of the Combined Work.
+
+  1. Exception to Section 3 of the GNU GPL.
+
+  You may convey a covered work under sections 3 and 4 of this License
+without being bound by section 3 of the GNU GPL.
+
+  2. Conveying Modified Versions.
+
+  If you modify a copy of the Library, and, in your modifications, a
+facility refers to a function or data to be supplied by an Application
+that uses the facility (other than as an argument passed when the
+facility is invoked), then you may convey a copy of the modified
+version:
+
+   a) under this License, provided that you make a good faith effort to
+   ensure that, in the event an Application does not supply the
+   function or data, the facility still operates, and performs
+   whatever part of its purpose remains meaningful, or
+
+   b) under the GNU GPL, with none of the additional permissions of
+   this License applicable to that copy.
+
+  3. Object Code Incorporating Material from Library Header Files.
+
+  The object code form of an Application may incorporate material from
+a header file that is part of the Library.  You may convey such object
+code under terms of your choice, provided that, if the incorporated
+material is not limited to numerical parameters, data structure
+layouts and accessors, or small macros, inline functions and templates
+(ten or fewer lines in length), you do both of the following:
+
+   a) Give prominent notice with each copy of the object code that the
+   Library is used in it and that the Library and its use are
+   covered by this License.
+
+   b) Accompany the object code with a copy of the GNU GPL and this license
+   document.
+
+  4. Combined Works.
+
+  You may convey a Combined Work under terms of your choice that,
+taken together, effectively do not restrict modification of the
+portions of the Library contained in the Combined Work and reverse
+engineering for debugging such modifications, if you also do each of
+the following:
+
+   a) Give prominent notice with each copy of the Combined Work that
+   the Library is used in it and that the Library and its use are
+   covered by this License.
+
+   b) Accompany the Combined Work with a copy of the GNU GPL and this license
+   document.
+
+   c) For a Combined Work that displays copyright notices during
+   execution, include the copyright notice for the Library among
+   these notices, as well as a reference directing the user to the
+   copies of the GNU GPL and this license document.
+
+   d) Do one of the following:
+
+       0) Convey the Minimal Corresponding Source under the terms of this
+       License, and the Corresponding Application Code in a form
+       suitable for, and under terms that permit, the user to
+       recombine or relink the Application with a modified version of
+       the Linked Version to produce a modified Combined Work, in the
+       manner specified by section 6 of the GNU GPL for conveying
+       Corresponding Source.
+
+       1) Use a suitable shared library mechanism for linking with the
+       Library.  A suitable mechanism is one that (a) uses at run time
+       a copy of the Library already present on the user's computer
+       system, and (b) will operate properly with a modified version
+       of the Library that is interface-compatible with the Linked
+       Version.
+
+   e) Provide Installation Information, but only if you would otherwise
+   be required to provide such information under section 6 of the
+   GNU GPL, and only to the extent that such information is
+   necessary to install and execute a modified version of the
+   Combined Work produced by recombining or relinking the
+   Application with a modified version of the Linked Version. (If
+   you use option 4d0, the Installation Information must accompany
+   the Minimal Corresponding Source and Corresponding Application
+   Code. If you use option 4d1, you must provide the Installation
+   Information in the manner specified by section 6 of the GNU GPL
+   for conveying Corresponding Source.)
+
+  5. Combined Libraries.
+
+  You may place library facilities that are a work based on the
+Library side by side in a single library together with other library
+facilities that are not Applications and are not covered by this
+License, and convey such a combined library under terms of your
+choice, if you do both of the following:
+
+   a) Accompany the combined library with a copy of the same work based
+   on the Library, uncombined with any other library facilities,
+   conveyed under the terms of this License.
+
+   b) Give prominent notice with the combined library that part of it
+   is a work based on the Library, and explaining where to find the
+   accompanying uncombined form of the same work.
+
+  6. Revised Versions of the GNU Lesser General Public License.
+
+  The Free Software Foundation may publish revised and/or new versions
+of the GNU Lesser General Public License from time to time. Such new
+versions will be similar in spirit to the present version, but may
+differ in detail to address new problems or concerns.
+
+  Each version is given a distinguishing version number. If the
+Library as you received it specifies that a certain numbered version
+of the GNU Lesser General Public License "or any later version"
+applies to it, you have the option of following the terms and
+conditions either of that published version or of any later version
+published by the Free Software Foundation. If the Library as you
+received it does not specify a version number of the GNU Lesser
+General Public License, you may choose any version of the GNU Lesser
+General Public License ever published by the Free Software Foundation.
+
+  If the Library as you received it specifies that a proxy can decide
+whether future versions of the GNU Lesser General Public License shall
+apply, that proxy's public statement of acceptance of any version is
+permanent authorization for you to choose that version for the
+Library.

data/README.md

@@ -0,0 +1,135 @@
+# Evil Blocks
+
+Evil Block is a tiny framework for web pages. It splits your application
+to separated blocks with isolated styles and scripts.
+
+Sponsored by [Evil Martians](http://evilmartians.com/).
+Role aliases taken from [role](https://github.com/kossnocorp/role)
+and [role-rails](https://github.com/kossnocorp/role-rails) by Sasha Koss.
+
+## Quick Example
+
+### Slim Template
+
+```haml
+.user-page
+  .title User Name
+  .gallery-control.is-big
+    // Evil Blocks add @data-role alias to Slim
+    // .class to bind styles, @data-role to bind JavaScript
+    a.gallery-left@next-photo href="#"
+    a.gallery-right@prev-photo href="#"
+    img src="photos/1.jpg"
+    img src="photos/2.jpg"
+    img src="photos/3.jpg"
+```
+
+### Sass Styles
+
+```sass
+// Block
+.user-page
+  // All elements must be inside blocks (like in namespaces)
+  .title
+    font-size: 20px
+
+// Block
+.gallery-control
+  position: relative
+  img, .gallery-left, .gallery-right
+    position: absolute
+  // Modificator
+  &.is-big
+    width: 600px
+```
+
+### CoffeeScript
+
+```coffee
+# Will execute callback only if .gallery-control is in current page
+evil.block '.gallery-control', ($, b, block) ->
+  current   = 0
+  showPhoto = (num) ->
+    # b-function finds only inside .gallery-control
+    b('img').hide()
+    b("img:eql(#{ num })").show()
+
+  initState: ->
+    showPhoto(current)
+
+  buttons: ->
+    # Shortcuts for data-role="next-photo"
+    b.nextPhoto.click ->
+      showPhoto(current += 1)
+
+  slideShow: ->
+    # You can communicate between blocks by simple events
+    block.on 'slideshow-start', ->
+      setTimeout( -> b.nextPhoto.click() , 5000)
+
+# Will execute callback only on user page, where .user-page exists
+evil.block '.user-page', ($, b, block) ->
+
+  startSlidehow: ->
+    b('.gallery-control').trigger('slideshow-start')
+```
+
+## Styles
+
+* You split all you tags to “blocks” and “elements”. Elements must belong
+  to block. Blocks can be nested.
+* Blocks classes must have special suffix, that can’t be accidentally used
+  in elements. For example. `-page`, `-layout`, `-control` suffixes
+  (for example, `.user-page`, `.header-layout`, `.gallery-control`).
+* All styles must have block class in condition. For example,
+  `.user-page .title`, `.user-page .edit`. So all you styles is protected
+  from accidentally same classes (it’s important, if you join all your CSS files
+  in one file).
+* If block can be nested in another blocks (like common controls), adds prefix
+  to all its elements (like `.gallery-left`). If block is a root block
+  (like `.user-page` or `.header-layout`) be free to use short classes.
+* Classes to modificate elements or blocks, must be like sentence without a noun
+  (for example, `.is-big`, `.with-header`).
+
+## JavaScript
+
+* Unobtrusive JavaScript.
+* Write animation and states in CSS. JavaScript just changes CSS classes.
+* Avoid rendering. Send from server HTML, not JSON.
+* Wrap scrips to revive blocks in `evil.block(selector, callback)`.
+  It will execute `callback` only if block `selector` exists in current page.
+  So you can be free to join all JS files in one.
+* `evil.block` will send to `callback` three arguments: `$` is jQuery,
+  `b` is “b-function”, `block` is a finded blocks by `selector`.
+* B-function is like jQuery function, but find only inside finded block
+  (alias `b('a') = $('a', selector)`).
+* Bind JavaScript to `data-role` attribute to be free to change styles
+  and classes without dangeros of breaking scripts.
+* You can easy find special`data-role` by b-function. It will has properties
+  for all roles inside block (`@role-name` will be camelized to `b.roleName`).
+* If `callback` return object, `evil-block` will execute all it methods.
+  It’s useful to split your script to several initializer with separated
+  variables scope.
+
+## Install
+
+### Ruby on Rails
+
+Add `evil-block-rails` gem to `Gemfile`:
+```ruby
+gem "evil-blocks-rails"
+```
+
+Load `evil-blocks.js` in your script:
+```js
+//= require evil-blocks
+```
+
+### Others
+
+Add file `lib/evil-blocks.js` to your project.
+
+## See Also
+
+* [Evil Front](https://github.com/ai/evil-front) – pack of helpers and libraries
+  for Ruby on Rails and Evil Blocks.

data/lib/assets/javascripts/evil-blocks.js

@@ -0,0 +1,118 @@
+/*
+ * Copyright 2013 Andrey “A.I.” Sitnik <andrey@sitnik.ru>,
+ * sponsored by Evil Martians.
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU Lesser General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU Lesser General Public License for more details.
+ *
+ * You should have received a copy of the GNU Lesser General Public License
+ * along with this program.  If not, see <http://www.gnu.org/licenses/>.
+ */
+
+;(function ($) {
+    "use strict";
+
+    /*
+     * Add `@data-role` alias to jQuery.
+     *
+     * Copy from jquery.role by Sasha Koss https://github.com/kossnocorp/role
+     */
+
+    var rewriteSelector = function (context, name, pos) {
+        var original = context[name];
+        if ( !original ) {
+            return;
+        }
+
+        context[name] = function () {
+            arguments[pos] = arguments[pos].replace(
+                /@([\w\u00c0-\uFFFF\-]+)/g, '[data-role~="$1"]');
+            return original.apply(context, arguments);
+        };
+
+        $.extend(context[name], original);
+    };
+
+    rewriteSelector($, 'find', 0);
+    rewriteSelector($, 'multiFilter', 0);
+    rewriteSelector($.find, 'matchesSelector', 1);
+    rewriteSelector($.find, 'matches', 0);
+
+    /*
+     * Evil namespace. Also can be used in Evil Front.
+     */
+    if ( !window.evil ) {
+        window.evil = { };
+    }
+
+    /**
+     * Call `callback` only if `selector` was founded on page.
+     * `callback` will receive 3 arguments:
+     * * `$` - jQuery.
+     * * `b` - like jQuery, but find only inside founded blocks.
+     * * `block` - blocks, founded by `selector`.
+     *
+     * All elements with `data-role` will be add as property to `b`.
+     *
+     * `callback` can return hash of inititalizer functions,
+     * `evil.block` will execute them. It is good way to isolate variables
+     * in separated initializers.
+     *
+     *   evil.block '.user-page', ($, b, block) ->
+     *
+     *     editUser: ->
+     *       # Click on `data-role="edit"` inside `.user-page`
+     *       b.edit.click ->
+     *         b('.edit-form').show()
+     *
+     *     delUser: ->
+     *       b.del.click -> b('.delete-form').submit()
+     *
+     *     initGallery: ->
+     *       b.gallery.fotorama()
+     */
+    window.evil.block = function (selector, callback) {
+        $(function () {
+            var block = $(selector);
+            if ( !block.length ) {
+                return;
+            }
+
+            var b = function (subselector) {
+                return $(subselector, block);
+            };
+            var actives = { };
+            block.find('[data-role]').each(function (_, el) {
+                var roles = el.attributes['data-role'].value.split(' ');
+                for ( var i = 0; i < roles.length; i++ ) {
+                    var role = roles[i].replace(/-\w/g, function (s) {
+                        return s[1].toUpperCase();
+                    });
+                    if ( !actives[role] ) {
+                        actives[role] = [];
+                    }
+                    actives[role].push(el);
+                }
+            });
+
+            for ( var role in actives ) {
+                b[role] = $(actives[role]);
+            }
+
+            var inits = callback($, b, block);
+            if ( typeof(inits) == 'object' ) {
+                for ( var i in inits ) {
+                    inits[i]($, b, block);
+                }
+            }
+        });
+    };
+
+})(jQuery);

data/lib/evil-blocks-rails.rb

@@ -0,0 +1,33 @@
+=begin
+Copyright 2013 Andrey “A.I.” Sitnik <andrey@sitnik.ru>,
+sponsored by Evil Martians.
+
+This program is free software: you can redistribute it and/or modify
+it under the terms of the GNU Lesser General Public License as published by
+the Free Software Foundation, either version 3 of the License, or
+(at your option) any later version.
+
+This program is distributed in the hope that it will be useful,
+but WITHOUT ANY WARRANTY; without even the implied warranty of
+MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+GNU Lesser General Public License for more details.
+
+You should have received a copy of the GNU Lesser General Public License
+along with this program.  If not, see <http://www.gnu.org/licenses/>.
+=end
+
+module EvilBlocks
+  # Tell Ruby on Rails to add `evil-block.js` to Rails Admin load paths.
+  class Engine < ::Rails::Engine
+    initializer 'evil-front.slim' do
+      if defined?(Slim::Parser)
+        # Add @data-role alias to Slim.
+        #
+        # Copy from role-rails by Sasha Koss.
+        # https://github.com/kossnocorp/role-rails
+        Slim::Parser.default_options[:shortcut]['@'] = { :attr => 'data-role' }
+        Slim::Engine.default_options[:merge_attrs]['data-role'] = ' '
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,70 @@
+--- !ruby/object:Gem::Specification
+name: evil-blocks-rails
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+  prerelease: 
+platform: ruby
+authors:
+- Andrey "A.I." Sitnik
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-04-29 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: sprockets
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '2'
+description: Evil Block is a tiny framework for web pages. It split your application
+  to separated blocks and isolate their styles and scripts.
+email:
+- andrey@sitnik.ru
+executables: []
+extensions: []
+extra_rdoc_files:
+- LICENSE
+- README.md
+- ChangeLog
+files:
+- lib/assets/javascripts/evil-blocks.js
+- lib/evil-blocks-rails.rb
+- LICENSE
+- README.md
+- ChangeLog
+homepage: https://github.com/ai/evil-blocks
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.23
+signing_key: 
+specification_version: 3
+summary: Tiny framework for web pages to split your app to separated blocks
+test_files: []