rtlit 0.0.2 → 0.0.3

data/lib/rtlit/converter.rb

@@ -1,5 +1,7 @@
-module RTLit
+module RTLit #nodoc
 
+  # CSS string LTR to RTL converter
+  #
   module Converter
 
     class << self
@@ -8,7 +10,7 @@ module RTLit
       # Accepts any valid CSS string.
       # Returns a CSS string.
       #
-      # @param [String, #read] css the css string to convert to RTL
+      # @param [String] css the css string to convert to RTL
       # @return [String] the RTL version of the css
       #
       # Example:
@@ -19,7 +21,7 @@ module RTLit
       #         padding-right: 10px;
       #       }"
       #
-      #     to_rtl(css)
+      #     rtl_css = to_rtl(css)
       #
       def to_rtl(css) ''
         place_holder = '|====|'

data/lib/rtlit/util.rb

@@ -1,13 +1,21 @@
-module RTLit
+module RTLit #nodoc
 
+  # Files and directories utilities for converting
+  # CSS-formatted files to RTL
   module Util
 
     class << self
 
-      # Process file <src> and write RTL version to file <dest>
+      # Converts CSS-formatted file to RTL.
+      #
       # Accepts source and destination file paths.
+      #
+      # @param [String] src the source file to convert
+      # @param [String] dest the destination file to write converted CSS to
+      #
       # Example:
       #     process_file('/path/to/file.css', '/path/to/file-rtl.css')
+      #
       def process_file(src, dest)
         puts 'Reading %s' % src
         css = File.open(src,'r'){ |f| f.read }
@@ -16,9 +24,17 @@ module RTLit
         File.open(dest,'w'){ |f| f.write rtl_css }
       end
 
-      # Process all files in directory, optionally filtered by extension <ext>
+      # Converts CSS-formatted files in a directory, optionally filtered by extension, to RTL.
+      #
       # Accepts source and destination directories and an optional file extension string
-      # Exmaple: process_directory('/tmp', '/tmp/rtl', 'less')
+      #
+      # @param [String] src the source directory to convert
+      # @param [String] dest the destination directory to write converted CSS files to
+      # @param [String] ext optional file extension to filter source files by
+      #
+      # Exmaple:
+      #     process_directory('/tmp', '/tmp/rtl', 'less')
+      #
       def process_directory(src, dest, ext = nil)
         src_path = '%s/*.%s' % [File.expand_path(src), ext || '*']
         dest_path = File.expand_path dest
@@ -28,12 +44,19 @@ module RTLit
         end
       end
 
-      # Process file or directory, which can optionally be filtered by file extension
-      # Accepts source and destination paths to file or directory to process and
-      # an optional file extension string
+      # Convert CSS-formatted file or directory containing such files, which can optionally be filtered by file extension.
+      #
+      # Accepts source and destination paths to file or directory to convert and
+      # an optional file extension string to filter by (in case source path is a directory)
+      #
+      # @param [String] src the source directory to convert
+      # @param [String] dest the destination directory to write converted CSS files to
+      # @param [String] ext optional file extension to filter source files by
+      #
       # Example:
-      #  process_file_or_directory('/some/path', '/some/dest', 'less') # process only .less files directory
-      #  process_file_or_directory('/some/file.css','/some/file-rtl.css')
+      #     process_file_or_directory('/some/path', '/some/dest', 'less') # process only .less files directory
+      #     process_file_or_directory('/some/file.css','/some/file-rtl.css')
+      #
       def process_file_or_directory(src, dest, ext = nil)
 
         raise 'Source not given' if src.nil? or not File.exists? src

data/lib/rtlit/version.rb

@@ -1,3 +1,3 @@
 module RTLit
-  VERSION = "0.0.2"
+  VERSION = "0.0.3" #nodoc
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rtlit
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
   prerelease: 
 platform: ruby
 authors:
@@ -48,12 +48,18 @@ required_ruby_version: !ruby/object:Gem::Requirement
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
+      segments:
+      - 0
+      hash: -4536212592836592277
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
+      segments:
+      - 0
+      hash: -4536212592836592277
 requirements: []
 rubyforge_project: rtlit
 rubygems_version: 1.8.17
@@ -65,4 +71,3 @@ test_files:
 - test/assets/rtl.css
 - test/test_file_conversion.rb
 - test/test_ltr_to_rtl.rb
-has_rdoc: