rtlize 0.1.0

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2012 Marwan Al Jubeh
+
+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,68 @@
+= RTLize
+
+RTLize is a rails plugin that semi-automatically allows you to use the same stylesheet file(s) to produce both left-to-right and right-to-left layouts for your markup. It does this by intelligently switching all the left/right properties and values in the stylesheets you choose to RTLize.
+
+== Usage
+
+=== Adding it to your application
+
+To add RTLize to your Rails application, all you need to do is add the following line to your Gemfile:
+
+  gem 'rtlize', :git => 'git://github.com/maljub01/RTLize.git'
+
+Then run `bundle install` and you'll be all set.
+
+=== Basic usage
+
+RTLize registers a Sprocket's engine to preprocess the '.rtl' extension. This preprocessor expects CSS for input, and will output an RTLized version of the CSS it receives.
+
+For instance, if you want to serve an RTL version of your 'application.css.sass', you can make a symbolic link to it (or just a copy if you must) with the filename 'application-rtl.css.rtl.sass'. The '.rtl' extension is what triggers RTLize's preprocessor (the RTLizer) and must come right after the '.css' extension to work properly. As for the '-rtl' appended to the filename, this is just a convention I've adopted to differentiate RTLized CSS files from non-rtlized CSS files because otherwise they'll both have the same URI, which you definitely don't want. You can choose whichever naming convention you feel comfortable with.
+
+=== Manually overriding the CSS
+
+When writing your CSS, you will often encounter cases where you need to manually override the CSS for rtl, to change a background image for example. To do this, you can use the rtl class. The RTLizer wont transform any CSS rule that mentions the class 'rtl'. Notice that you'll need to manually add an 'rtl' class to your HTML tags that will use this (usually to the html or body tag).
+
+=== Preserving the layout for some sections of your markup
+
+You might also find that you need to perserve the layout on certain parts of your website. To do this, you'll need to tell the RTLizer about the CSS files/rules you don't want switched. You can do this using the no-rtl directive. The way this works is that whenever the RTLizer finds the following comment:
+  /*!= begin(no-rtl) */
+it wont transform all the CSS rules that follow until it reaches the comment:
+  /*!= end(no-rtl) */
+after which it will return to transforming the CSS rules it finds as normal.
+
+A few issues to keep in mind when using the no-rtl directive is that, depending on your CSS preprocessor if you use one, you might need to add an extra !. You should also avoid adding those comments except at the top-level of your nested declarations for them to work properly. For example, using SASS, the no-rtl directives look like this:
+
+  .top-level-class
+    .child-class-1
+      margin-left: 1px // This rule will be transformed to "margin-right: 1px"
+
+  /*!!= begin(no-rtl) */
+  .top-level-class
+    .child-class-2
+       float: left // This rule wont be transformed
+  /*!!= end(no-rtl) */
+
+  .another-top-level-class
+    span
+      padding-right: 5px // This rule will be transformed to "padding-left: 5px"
+
+
+== RTLize in the wild!
+
+Jawaker (an Arabic card game website) uses RTLize to automatically generate CSS files for the right-to-left (Arabic) layout of the website. You can get an idea of how RTLize works by comparing {the English interface}[http://www.jawaker.com/en] with {the Arabic one}[http://www.jawaker.com/ar]. Jawaker utilizes all the main features of RTLize: most the CSS is layout-switched automatically, with some manually-specified switching for images. Also, some parts (the game table, for example) has the same layout in both Arabic and English (to preserve playing order).
+
+== TODO
+
+* Add examples, including a sample application.
+* Use a proper CSS parser.
+* Improve coverage.
+* Improve behavior & documentation of the no-rtl directive.
+* Add helper methods in both Rails & JS that would take a string (or a hash) of CSS declarations and convert them to the equivalent RTLized version. This is in order to extend the RTLization support to inline styles as well as dynamic CSS changes.
+
+== Credits
+
+* This project was inspired by {Dustin Diaz's R2}[http://github.com/ded/R2]. The initial version was in fact not much more than a ruby port of R2.
+
+== License
+
+This project rocks and uses MIT-LICENSE.

data/Rakefile

@@ -0,0 +1,38 @@
+#!/usr/bin/env rake
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+begin
+  require 'rdoc/task'
+rescue LoadError
+  require 'rdoc/rdoc'
+  require 'rake/rdoctask'
+  RDoc::Task = Rake::RDocTask
+end
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'Rtlize'
+  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/lib/rtlize.rb

@@ -0,0 +1,5 @@
+module Rtlize
+end
+
+require 'rtlize/version'
+require 'rtlize/railtie'

data/lib/rtlize/railtie.rb

@@ -0,0 +1,13 @@
+require 'rtlize/rtl_template'
+
+module Rtlize
+  class Railtie < ::Rails::Railtie
+    config.before_initialize do |app|
+      if app.config.assets.enabled
+        require 'sprockets'
+        require 'sprockets/engines'
+        Sprockets.register_engine '.rtl', Rtlize::RtlTemplate
+      end
+    end
+  end
+end

data/lib/rtlize/rtl_template.rb

@@ -0,0 +1,15 @@
+require 'tilt'
+require 'sprockets'
+require 'rtlize/rtlizer'
+
+module Rtlize
+  class RtlTemplate < Tilt::Template
+    self.default_mime_type = 'text/css'
+
+    def prepare; end
+
+    def evaluate(scope, locals, &block)
+      Rtlize::RTLizer.transform(data)
+    end
+  end
+end

data/lib/rtlize/rtlizer.rb

@@ -0,0 +1,154 @@
+module Rtlize
+  # Originally ported from http://github.com/ded/R2
+  class RTLizer
+    @property_map = {
+      'margin-left'                        => 'margin-right',
+      'margin-right'                       => 'margin-left',
+
+      'padding-left'                       => 'padding-right',
+      'padding-right'                      => 'padding-left',
+
+      'border-left'                        => 'border-right',
+      'border-right'                       => 'border-left',
+
+      'border-left-width'                  => 'border-right-width',
+      'border-right-width'                 => 'border-left-width',
+
+      'border-left-style'                  => 'border-right-style',
+      'border-right-style'                 => 'border-left-style',
+
+      'border-left-color'                  => 'border-right-color',
+      'border-right-color'                 => 'border-left-color',
+
+      'border-bottom-right-radius'         => 'border-bottom-left-radius',
+      'border-bottom-left-radius'          => 'border-bottom-right-radius',
+      '-webkit-border-bottom-right-radius' => '-webkit-border-bottom-left-radius',
+      '-webkit-border-bottom-left-radius'  => '-webkit-border-bottom-right-radius',
+      '-moz-border-radius-bottomright'     => '-moz-border-radius-bottomleft',
+      '-moz-border-radius-bottomleft'      => '-moz-border-radius-bottomright',
+
+      'border-top-right-radius'            => 'border-top-left-radius',
+      'border-top-left-radius'             => 'border-top-right-radius',
+      '-webkit-border-top-right-radius'    => '-webkit-border-top-left-radius',
+      '-webkit-border-top-left-radius'     => '-webkit-border-top-right-radius',
+      '-moz-border-radius-topright'        => '-moz-border-radius-topleft',
+      '-moz-border-radius-topleft'         => '-moz-border-radius-topright',
+
+      'left'                               => 'right',
+      'right'                              => 'left',
+    }
+
+    @value_map = {
+      'border-color'          => :quad,
+      'border-style'          => :quad,
+      'border-width'          => :quad,
+      'padding'               => :quad,
+      'margin'                => :quad,
+      'text-align'            => :rtltr,
+      'float'                 => :rtltr,
+      'clear'                 => :rtltr,
+      'direction'             => :direction,
+      'border-radius'         => :quad_radius,
+      '-webkit-border-radius' => :quad_radius,
+      '-moz-border-radius'    => :quad_radius,
+      'box-shadow'            => :box_shadow,
+      '-webkit-box-shadow'    => :box_shadow,
+      '-moz-box-shadow'       => :box_shadow,
+    }
+
+    class << self
+      def transform(css)
+        no_invert = false
+        css.gsub(/([^{]+\{[^}]+\})+?/) do |rule|
+          # Break rule into selector|declaration parts
+          parts = rule.match(/([^{]+)\{([^}]+)/)
+          if parts && !parts[1].gsub(/\/\*[\s\S]+?\*\//, '').match(/\.rtl\b/) # Don't transform rules that include the selector ".rtl" (remove comments first)
+            selector, declarations = parts[1..2]
+
+            # The CSS comment must start with "!" in order to be considered as important by the YUI compressor, otherwise, it will be removed by the asset pipeline before reaching this processor.
+            if selector.match(/\/\*!= begin\(no-rtl\) \*\//)
+              no_invert = true
+              # selector.gsub!(/\/\*!= begin\(no-rtl\) \*\//, '')
+            elsif selector.match(/\/\*!= end\(no-rtl\) \*\//)
+              no_invert = false
+              # selector.gsub!(/\/\*!= end\(no-rtl\) \*\//, '')
+            end
+
+            selector + '{' + self.transform_declarations(declarations, no_invert) + '}'
+          else
+            rule
+          end
+        end
+      end
+
+      def transform_declarations(declarations, no_invert = false)
+        declarations.split(/;(?!base64)/).map do |decl|
+          m = decl.match(/([^:]+):(.+)$/)
+
+          if m && !no_invert
+            prop, val = m[1..2]
+            # Get the property, without comments or spaces, to be able to find it.
+            prop_name = prop.strip.split(' ').last
+            if @property_map[prop_name]
+              prop = prop.sub(prop_name, @property_map[prop_name])
+            end
+
+            if @value_map[prop_name]
+              val = val.sub(val.strip, self.send(@value_map[prop_name], val.strip))
+            end
+
+            prop + ':' + val + ';'
+          elsif m
+            decl + ';'
+          else
+            decl
+          end
+        end.join
+      end
+
+      def rtltr(v)
+        v == 'left' ? 'right' : v == 'right' ? 'left' : v
+      end
+
+      def direction(v)
+        v == 'ltr' ? 'rtl' : v == 'rtl' ? 'ltr' : v
+      end
+
+      def quad(v)
+        # 1px 2px 3px 4px => 1px 4px 3px 2px
+        m = v.split(/\s+/)
+        m.length == 4 ? [m[0], m[3], m[2], m[1]].join(' ') : v
+      end
+
+      def quad_radius(v)
+        # top-left, top-right, bottom-right, bottom-left
+        # when bottom-left is omitted, it takes the value of top-right
+        # when bottom-right is omitted, it takes the value of top-left
+        # when top-right is omitted, it takes the value of top-left
+        m = v.split(/\s+/)
+        case m.length
+        when 4 then [m[1], m[0], m[3], m[2]].join(' ')
+        when 3 then [m[1], m[0], m[1], m[2]].join(' ')
+        when 2 then [m[1], m[0]].join(' ')
+        else v
+        end
+      end
+
+      def box_shadow(v)
+        found = false
+        v.gsub(/rgba\([^)]*\)|,|#\S*|[-0-9px]+/) do |m|
+          if m == ","
+            # this property can take several comma-seperated values, we account for that, and transform each one correctly.
+            found = false
+            m
+          elsif m.match(/rgba\([^)]*\)|#\S*/) || found
+            m
+          else
+            found = true
+            m.to_i.zero? ? m : m.gsub(m.to_i.to_s, (-1 * m.to_i).to_s)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/rtlize/version.rb

@@ -0,0 +1,3 @@
+module Rtlize
+  VERSION = "0.1.0"
+end

data/lib/tasks/rtlize_tasks.rake

@@ -0,0 +1,4 @@
+# desc "Explaining what the task does"
+# task :rtlize do
+#   # Task goes here
+# end

data/test/dummy/README.rdoc

@@ -0,0 +1,261 @@
+== Welcome to Rails
+
+Rails is a web-application framework that includes everything needed to create
+database-backed web applications according to the Model-View-Control pattern.
+
+This pattern splits the view (also called the presentation) into "dumb"
+templates that are primarily responsible for inserting pre-built data in between
+HTML tags. The model contains the "smart" domain objects (such as Account,
+Product, Person, Post) that holds all the business logic and knows how to
+persist themselves to a database. The controller handles the incoming requests
+(such as Save New Account, Update Product, Show Post) by manipulating the model
+and directing data to the view.
+
+In Rails, the model is handled by what's called an object-relational mapping
+layer entitled Active Record. This layer allows you to present the data from
+database rows as objects and embellish these data objects with business logic
+methods. You can read more about Active Record in
+link:files/vendor/rails/activerecord/README.html.
+
+The controller and view are handled by the Action Pack, which handles both
+layers by its two parts: Action View and Action Controller. These two layers
+are bundled in a single package due to their heavy interdependence. This is
+unlike the relationship between the Active Record and Action Pack that is much
+more separate. Each of these packages can be used independently outside of
+Rails. You can read more about Action Pack in
+link:files/vendor/rails/actionpack/README.html.
+
+
+== Getting Started
+
+1. At the command prompt, create a new Rails application:
+       <tt>rails new myapp</tt> (where <tt>myapp</tt> is the application name)
+
+2. Change directory to <tt>myapp</tt> and start the web server:
+       <tt>cd myapp; rails server</tt> (run with --help for options)
+
+3. Go to http://localhost:3000/ and you'll see:
+       "Welcome aboard: You're riding Ruby on Rails!"
+
+4. Follow the guidelines to start developing your application. You can find
+the following resources handy:
+
+* The Getting Started Guide: http://guides.rubyonrails.org/getting_started.html
+* Ruby on Rails Tutorial Book: http://www.railstutorial.org/
+
+
+== Debugging Rails
+
+Sometimes your application goes wrong. Fortunately there are a lot of tools that
+will help you debug it and get it back on the rails.
+
+First area to check is the application log files. Have "tail -f" commands
+running on the server.log and development.log. Rails will automatically display
+debugging and runtime information to these files. Debugging info will also be
+shown in the browser on requests from 127.0.0.1.
+
+You can also log your own messages directly into the log file from your code
+using the Ruby logger class from inside your controllers. Example:
+
+  class WeblogController < ActionController::Base
+    def destroy
+      @weblog = Weblog.find(params[:id])
+      @weblog.destroy
+      logger.info("#{Time.now} Destroyed Weblog ID ##{@weblog.id}!")
+    end
+  end
+
+The result will be a message in your log file along the lines of:
+
+  Mon Oct 08 14:22:29 +1000 2007 Destroyed Weblog ID #1!
+
+More information on how to use the logger is at http://www.ruby-doc.org/core/
+
+Also, Ruby documentation can be found at http://www.ruby-lang.org/. There are
+several books available online as well:
+
+* Programming Ruby: http://www.ruby-doc.org/docs/ProgrammingRuby/ (Pickaxe)
+* Learn to Program: http://pine.fm/LearnToProgram/ (a beginners guide)
+
+These two books will bring you up to speed on the Ruby language and also on
+programming in general.
+
+
+== Debugger
+
+Debugger support is available through the debugger command when you start your
+Mongrel or WEBrick server with --debugger. This means that you can break out of
+execution at any point in the code, investigate and change the model, and then,
+resume execution! You need to install ruby-debug to run the server in debugging
+mode. With gems, use <tt>sudo gem install ruby-debug</tt>. Example:
+
+  class WeblogController < ActionController::Base
+    def index
+      @posts = Post.all
+      debugger
+    end
+  end
+
+So the controller will accept the action, run the first line, then present you
+with a IRB prompt in the server window. Here you can do things like:
+
+  >> @posts.inspect
+  => "[#<Post:0x14a6be8
+          @attributes={"title"=>nil, "body"=>nil, "id"=>"1"}>,
+       #<Post:0x14a6620
+          @attributes={"title"=>"Rails", "body"=>"Only ten..", "id"=>"2"}>]"
+  >> @posts.first.title = "hello from a debugger"
+  => "hello from a debugger"
+
+...and even better, you can examine how your runtime objects actually work:
+
+  >> f = @posts.first
+  => #<Post:0x13630c4 @attributes={"title"=>nil, "body"=>nil, "id"=>"1"}>
+  >> f.
+  Display all 152 possibilities? (y or n)
+
+Finally, when you're ready to resume execution, you can enter "cont".
+
+
+== Console
+
+The console is a Ruby shell, which allows you to interact with your
+application's domain model. Here you'll have all parts of the application
+configured, just like it is when the application is running. You can inspect
+domain models, change values, and save to the database. Starting the script
+without arguments will launch it in the development environment.
+
+To start the console, run <tt>rails console</tt> from the application
+directory.
+
+Options:
+
+* Passing the <tt>-s, --sandbox</tt> argument will rollback any modifications
+  made to the database.
+* Passing an environment name as an argument will load the corresponding
+  environment. Example: <tt>rails console production</tt>.
+
+To reload your controllers and models after launching the console run
+<tt>reload!</tt>
+
+More information about irb can be found at:
+link:http://www.rubycentral.org/pickaxe/irb.html
+
+
+== dbconsole
+
+You can go to the command line of your database directly through <tt>rails
+dbconsole</tt>. You would be connected to the database with the credentials
+defined in database.yml. Starting the script without arguments will connect you
+to the development database. Passing an argument will connect you to a different
+database, like <tt>rails dbconsole production</tt>. Currently works for MySQL,
+PostgreSQL and SQLite 3.
+
+== Description of Contents
+
+The default directory structure of a generated Ruby on Rails application:
+
+  |-- app
+  |   |-- assets
+  |       |-- images
+  |       |-- javascripts
+  |       `-- stylesheets
+  |   |-- controllers
+  |   |-- helpers
+  |   |-- mailers
+  |   |-- models
+  |   `-- views
+  |       `-- layouts
+  |-- config
+  |   |-- environments
+  |   |-- initializers
+  |   `-- locales
+  |-- db
+  |-- doc
+  |-- lib
+  |   `-- tasks
+  |-- log
+  |-- public
+  |-- script
+  |-- test
+  |   |-- fixtures
+  |   |-- functional
+  |   |-- integration
+  |   |-- performance
+  |   `-- unit
+  |-- tmp
+  |   |-- cache
+  |   |-- pids
+  |   |-- sessions
+  |   `-- sockets
+  `-- vendor
+      |-- assets
+          `-- stylesheets
+      `-- plugins
+
+app
+  Holds all the code that's specific to this particular application.
+
+app/assets
+  Contains subdirectories for images, stylesheets, and JavaScript files.
+
+app/controllers
+  Holds controllers that should be named like weblogs_controller.rb for
+  automated URL mapping. All controllers should descend from
+  ApplicationController which itself descends from ActionController::Base.
+
+app/models
+  Holds models that should be named like post.rb. Models descend from
+  ActiveRecord::Base by default.
+
+app/views
+  Holds the template files for the view that should be named like
+  weblogs/index.html.erb for the WeblogsController#index action. All views use
+  eRuby syntax by default.
+
+app/views/layouts
+  Holds the template files for layouts to be used with views. This models the
+  common header/footer method of wrapping views. In your views, define a layout
+  using the <tt>layout :default</tt> and create a file named default.html.erb.
+  Inside default.html.erb, call <% yield %> to render the view using this
+  layout.
+
+app/helpers
+  Holds view helpers that should be named like weblogs_helper.rb. These are
+  generated for you automatically when using generators for controllers.
+  Helpers can be used to wrap functionality for your views into methods.
+
+config
+  Configuration files for the Rails environment, the routing map, the database,
+  and other dependencies.
+
+db
+  Contains the database schema in schema.rb. db/migrate contains all the
+  sequence of Migrations for your schema.
+
+doc
+  This directory is where your application documentation will be stored when
+  generated using <tt>rake doc:app</tt>
+
+lib
+  Application specific libraries. Basically, any kind of custom code that
+  doesn't belong under controllers, models, or helpers. This directory is in
+  the load path.
+
+public
+  The directory available for the web server. Also contains the dispatchers and the
+  default HTML files. This should be set as the DOCUMENT_ROOT of your web
+  server.
+
+script
+  Helper scripts for automation and generation.
+
+test
+  Unit and functional tests along with fixtures. When using the rails generate
+  command, template test files will be generated for you and placed in this
+  directory.
+
+vendor
+  External libraries that the application depends on. Also includes the plugins
+  subdirectory. If the app has frozen rails, those gems also go here, under
+  vendor/rails/. This directory is in the load path.