guard-less 0.0.4 → 0.1.0

data/README.md

@@ -21,16 +21,59 @@ Please read [Guard usage doc](https://github.com/guard/guard#readme).
 
 ## Guardfile
 
-    guard 'less', :all_on_start => true, :all_after_change => true do
-      watch(/.*\.less$/)
-    end
+```ruby
+guard 'less', :all_on_start => true, :all_after_change => true do
+  watch(%r{^.*\.less$})
+end
+```
 
 Please read [Guard doc](https://github.com/guard/guard#readme) for more info about Guardfile DSL.
 
 ## Options
 
-    :all_after_change => [true|false]   # run on all files after any changed files, default: true
-    :all_on_start => [true|false]     # run on all the files at startup, default: true
+```ruby
+:all_after_change => [true|false]   # run on all files after any changed files
+                                    # default: true
+
+:all_on_start => [true|false]       # run on all the files at startup
+                                    # default: true
+
+:output => 'relative/path'          # base directory for output CSS files; if unset,
+                                    # .css files are generated in the same directories
+                                    # as their corresponding .less file
+                                    # default: nil
+
+:import_paths => ['lib/styles']     # an array of additional load paths to pass to the
+                                    # LESS parser, used when resolving `@import`
+                                    # statements
+                                    # default: [] (see below)
+```
+
+### Output option
+
+By default, `.css` files will be generated in the same directories as their
+corresponding `.less` files (partials beginning with `_` are always excluded).
+To customize the output location, pass the `:output` option as described above,
+and be sure to use a match group in the regular expression in your watch to
+capture nested structure that will be preserved, i.e.
+
+```ruby
+guard 'less', :output => 'public/stylesheets' do
+  watch(%r{^app/stylesheets/(.+\.less)$})
+end
+```
+
+will result in `app/stylesheets/forums/main.less` producing CSS at
+`public/stylesheets/forums/main.css`.
+
+### Import paths option
+
+As each `.less` file is parsed, the directory containing the file is
+automatically prepended to the import paths, so imports relative to your watched
+dirs like `@import 'shared/_type-styles'` should always work. You can supply
+additional paths with this option so that, for the `['lib/styles']` example, a
+file at `lib/styles/reset.less` could be imported without a qualified path as
+`@import 'reset'`.
 
 # License
 

data/lib/guard/less.rb

@@ -11,44 +11,132 @@ module Guard
     # = Guard method =
     # ================
     def initialize(watchers=[], options={})
-      super
-      @all_after_change = options.delete(:all_after_change)
-      @all_on_start = options.delete(:all_on_start)
+      defaults = {
+        :all_after_change => true,
+        :all_on_start => true,
+        :output => nil,
+        :import_paths => []
+      }
+
+      super(watchers, defaults.merge(options))
     end
 
     def start
       UI.info "Guard::Less #{LessVersion::VERSION} is on the job!"
-      run_all unless @all_on_start == false
+      run_all if options[:all_on_start]
     end
 
     # Call with Ctrl-/ signal
     # This method should be principally used for long action like running all specs/tests/...
     def run_all
-       patterns = @watchers.map { |w| w.pattern }
-       files = Dir.glob('**/*.*')
-       paths = []
-       files.each do |file|
-         patterns.each do |pattern|
-           paths << file if file.match(Regexp.new(pattern))
-         end
-       end
-       run(paths)
+      UI.info "Guard::Less: compiling all files"
+      patterns = watchers.map { |w| w.pattern }
+      files = Dir.glob('**/*.*')
+      paths = []
+      files.each do |file|
+        patterns.each do |pattern|
+          paths << file if file.match(Regexp.new(pattern))
+        end
+      end
+      run(paths)
     end
 
     # Call on file(s) modifications
     def run_on_change(paths)
-      run_all if run(paths) && (@all_after_change != false)
+      options[:all_after_change] ? run_all : run(paths)
     end
 
     def run(paths)
-      last_passed = false
-      paths.each do |file|
-        unless File.basename(file)[0] == "_"
-          UI.info "lessc - #{file}\n"
-          last_passed = system("lessc #{file} --verbose")
+      directories = nested_directory_map(paths)
+
+      directories.each do |destination, stylesheets|
+        stylesheets.each do |lessfile|
+          # Skip partials
+          basename = File.basename(lessfile)
+          next if basename[0,1] == "_"
+
+          cssfile = File.join(destination, basename.gsub(/\.less$/, '.css'))
+
+          # Just in case
+          if cssfile == lessfile
+            UI.info "Guard::Less: Skipping #{lessfile} since the output would overwrite the original file"
+          elsif mtime(cssfile) >= mtime_including_imports(lessfile)
+            UI.info "Guard::Less: Skipping #{lessfile} because #{cssfile} is already up-to-date"
+          else
+            UI.info "Guard::Less: #{lessfile} -> #{cssfile}\n"
+            FileUtils.mkdir_p(File.expand_path(destination))
+            compile(lessfile, cssfile)
+          end
+        end
+      end
+    end
+
+    private
+
+    # Parse the source lessfile and write to target cssfile
+    def compile(lessfile, cssfile)
+      import_paths = options[:import_paths].unshift(File.dirname(lessfile))
+      parser = ::Less::Parser.new :paths => import_paths, :filename => lessfile
+      File.open(lessfile,'r') do |infile|
+        File.open(cssfile,'w') do |outfile|
+          tree = parser.parse(infile.read)
+          outfile << tree.to_css
+        end
+      end
+      true
+    rescue Exception => e
+      UI.info "Guard::Less: Compiling #{lessfile} failed with message: #{e.message}"
+      false
+    end
+
+    # Creates a hash of changed files keyed by their target nested directory,
+    # which is based on either the original source directory or the :output
+    # option, plus the regex match group in a watcher like:
+    #
+    #    %r{^app/stylesheets/(.+\.less)$}
+    def nested_directory_map(paths)
+      directories = {}
+
+      watchers.product(paths).each do |watcher, path|
+        if matches = path.match(watcher.pattern)
+          target = options[:output] || File.dirname(path)
+          if subpath = matches[1]
+            target = File.join(target, File.dirname(subpath)).gsub(/\/\.$/, '')
+          end
+
+          if directories[target]
+            directories[target] << path
+          else
+            directories[target] = [path]
+          end
+        end
+      end
+
+      directories
+    end
+
+    # mtime checking borrowed from the old official LESS Rails plugin:
+    #    https://github.com/cloudhead/more
+    def mtime(file)
+      return 0 unless File.file?(file)
+      File.mtime(file).to_i
+    end
+
+    # consider imports for mtime
+    # just 1 level deep so we do not get any looping/nesting errors
+    def mtime_including_imports(file)
+      mtimes = [mtime(file)]
+      File.readlines(file).each do |line|
+        if line =~ /^\s*@import ['"]([^'"]+)/
+          imported = File.join(File.dirname(file), $1)
+          mtimes << if imported =~ /\.le?ss$/ # complete path given ?
+            mtime(imported)
+          else # we need to add .less or .lss
+            [mtime("#{imported}.less"), mtime("#{imported}.lss")].max
+          end
         end
       end
-      last_passed
+      mtimes.max
     end
 
   end

data/lib/guard/less/templates/Guardfile

@@ -1,3 +1,3 @@
-guard 'less', :all_on_start => true, :all_after_pass => true do
-  watch(/.*\.less$/)
+guard 'less', :all_on_start => true, :all_after_change => true do
+  watch(%r{^.+\.less$})
 end

data/lib/guard/less/version.rb

@@ -1,5 +1,5 @@
 module Guard
   module LessVersion
-    VERSION = "0.0.4"
+    VERSION = "0.1.0"
   end
 end

metadata

@@ -4,9 +4,9 @@ version: !ruby/object:Gem::Version
   prerelease: false
   segments: 
   - 0
+  - 1
   - 0
-  - 4
-  version: 0.0.4
+  version: 0.1.0
 platform: ruby
 authors: 
 - Brendan Erwin
@@ -14,7 +14,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-04-23 00:00:00 -04:00
+date: 2011-08-23 00:00:00 -04:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -41,11 +41,68 @@ dependencies:
     - - ~>
       - !ruby/object:Gem::Version 
         segments: 
-        - 1
         - 2
-        version: "1.2"
+        - 0
+        - 5
+        version: 2.0.5
   type: :runtime
   version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: bundler
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 1
+        - 0
+        version: "1.0"
+  type: :development
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  name: fakefs
+  prerelease: false
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        - 3
+        version: "0.3"
+  type: :development
+  version_requirements: *id004
+- !ruby/object:Gem::Dependency 
+  name: guard-rspec
+  prerelease: false
+  requirement: &id005 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        - 4
+        version: "0.4"
+  type: :development
+  version_requirements: *id005
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id006 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 2
+        - 6
+        version: "2.6"
+  type: :development
+  version_requirements: *id006
 description: Guard::Less automatically compiles less (like lessc --watch)
 email: 
 - brendanjerwin@gmail.com