lessFactor 0.0.1 → 0.0.2

data/README.md

@@ -6,10 +6,6 @@ mainly extracts variables. Variables are recognized by a pattern:
 -   length : number followed by 'px' or 'em'
 -   color : \#xxxxxx or \#xxx
 
-It generates two new files:
-
-      <infile>.refactored.less      - the refactored lessfile
-      <infile>.refactored_vars.less - the new variables file
 
 ## Installation
 
@@ -29,7 +25,13 @@ Or install it yourself as:
 
 1.  run
 
-    lessfactor infile.less varfile.less
+    lessfactor varfile.less infile.less 
+    
+    It generates two new files:
+    
+          <infile>.refactored.less      - the refactored lessfile
+          <infile>.refactored_vars.less - the new variables file
+
 
 2.  identify the semantics of the variables, e.g. by comparing
     'infile.refactored.less' with 'infile.less'
@@ -37,15 +39,31 @@ Or install it yourself as:
 4.  rerun lessfactor to get the new variable names
 5.  merge the refactored files back into your project
 
+    * find ambiguous variable names by "__@"
+    * investigate the highest occurrences first
+
 ## Known Issues
 
 This is a very first shot. Areas of improvements:
 
 * more robust parser
 * option to ignore particular literals from being refactored - no idea how to achieve that
-* do not crate a new variables file but patch the existing one
+* do not create a new variables file but patch the existing one
 * apply the same for sass
 
+## version history
+
+### 0.0.2 
+
+* now forward comments on the variables
+* expose the lines of occurrence for extracted variables
+* concatenate the variable names in case of ambiguity
+* fixed usage screen
+
+### 0.0.1
+
+* initial version
+
 ## Contributing
 
 1.  Fork it

data/lib/lessFactor.rb

@@ -1,51 +1,61 @@
-
+require "lessfactor/version"
 
 
 class LessReplacer
 
-  VAR_PATTERN    = /(@[a-z\-]+):\s*([^;]*);/
+  VAR_PATTERN = /(@[a-z\-]+):\s*([^;]*);(.*)/
   LENGTH_PATTERN = /(\s+|:)([0-9\.]+(em|px|));/
-  COLOR_PATTERN  = /()(#[a-fA-F0-9]+);/
+  COLOR_PATTERN = /()(#[a-fA-F0-9]+);/
 
 
   def initialize
     @vars = {}
     @literals = {}
+    @literalcomments = {}
+    @occurence = {}
   end
 
   def scan_vars(file)
     File.open(file, "r").readlines.each do |l|
-       l.match(VAR_PATTERN) do |m|
-         value =$2.downcase
-         @vars[$1] = value
-         @literals[value] = $1
-       end
+      l.match(VAR_PATTERN) do |m|
+        value =$2.downcase
+        @vars[$1] = {v: value, c: $3}
+        (@literals[value] ||= []).push $1
+      end
     end
   end
 
   def scan_literals(file)
+    line = 0
     File.open(file, "r").readlines.each do |l|
+
+      line +=1
+
       l.match(LENGTH_PATTERN) do |m|
         value =$2.downcase
         unless @literals[value]
-          @literals[value] = "@zz-length-" + "000#{@literals.keys.count}"[-3 .. -1]
+          (@literals[value] ||= []).push "@zz-size-" + "000#{@literals.keys.count}"[-3 .. -1]
         end
+        (@literalcomments[value] ||= []).push line
       end
+
       l.match(COLOR_PATTERN) do |m|
         value =$2.downcase
         unless @literals[value]
-          @literals[value] = "@zz-color-" + "000#{@literals.keys.count}"[-3 .. -1]
+          (@literals[value] ||= []).push "@zz-color-" + "000#{@literals.keys.count}"[-3 .. -1]
         end
+        (@literalcomments[value] ||= []).push line
       end
     end
   end
 
   def replace_vars(infile, outfile)
-    result = File.open(infile, "r").readlines.each.map{|l|
+    result = File.open(infile, "r").readlines.each.map { |l|
       r1 = l.gsub(LENGTH_PATTERN) do |m|
         vn =$2.downcase
         if  @literals[vn]
-          $1 + @literals[vn] + ';'
+          name = @literals[vn].join("__")
+          $1 + name +';'
         else
           m
         end
@@ -54,7 +64,8 @@ class LessReplacer
       r1.gsub(COLOR_PATTERN) do |m|
         vn =$2.downcase
         if  @literals[vn]
-          $1 + @literals[vn] +';'
+          name = @literals[vn].join("__")
+          $1 + name +';'
         else
           m
         end
@@ -69,14 +80,22 @@ class LessReplacer
 
   def save_vars(file)
     File.open(file, "w") do |f|
-      @literals.sort{|a, b| a[1]<=> b[1] }.each{|value, name| f.puts "#{name}: #{value};" }
+      @literals.sort { |a, b| a[1] <=> b[1] }.each { |value, name|
+        the_name = name.first
+        occurrences = @literalcomments[value] || []
+        comment = @vars[the_name] || {c: " // todo: #{occurrences.count}: #{occurrences}"}
+        f.printf "%-25s %-15s %s\n", "#{the_name}:", " #{value};", comment[:c]
+      }
     end
   end
 end
 
 unless ARGV[1]
-  puts %q{
-    usage: lessfactor <infile> <variablesfile>
+  puts %Q{
+
+    this is lessfactor #{LessFactor::VERSION} (#{LessFactor::HOMEPAGE_URL})
+
+    usage: lessfactor  <variablesfile> <infile>
 
     creates 
 

data/lib/lessFactor/version.rb

@@ -1,3 +1,4 @@
 module LessFactor
-  VERSION = "0.0.1"
+  VERSION = "0.0.2"
+  HOMEPAGE_URL = "https://github.com/bwl21/lessfactor"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: lessFactor
 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: 2014-08-16 00:00:00.000000000 Z
+date: 2014-08-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -77,7 +77,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -3672470324399119344
+      hash: -726695259881330046
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -86,7 +86,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -3672470324399119344
+      hash: -726695259881330046
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.25