guard-concat 0.0.3 → 0.8.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: aab079ba7fa104c1eb4b72240de8ba89ba54de77
+  data.tar.gz: 3fe2f2958b10bb0d50412b5276450c97f85f2d8f
+SHA512:
+  metadata.gz: 19a5e0b8260075458c866495623cabff8b7d65a302e58b14f20ff6c3c91536517d0fa5dfed2206d4e9e6ec909a1d3e9f800bb90b4d98788a777f5883f1b030a2
+  data.tar.gz: 86a962b27c8b7b65ef2361d0565d605485dd23539c455d53ebcc6c91165a0617d40860894914e672b7925ddee4879d29fd1444db074681827b95c770a90e27df

data/Readme.md

@@ -29,4 +29,30 @@ guard :concat, type: "js", files: %w(b a), input_dir: "public/js", output: "publ
 
 # analog css example
 guard :concat, type: "css", files: %w(c d), input_dir: "public/css", output: "public/css/all"
-```
+
+# js example with *
+
+guard :concat, type: "js", files: %w(vendor/* b a), input_dir: "public/js", output: "public/js/all"
+# will concatenate all files in the vendor dir, then b then a (watch out of dependencies)
+```
+
+Advanced usage:
+
+``` ruby
+# this is a recommended file structure when using *
+# plugins usually need libraries so put libraries like jquery in the libs directory, then your jquery (or another library) plugin(s) in the plugins dir and at the end your main file(s)
+guard :concat, type: "js", files: %w(libs/* plugins/* main), input_dir: "public/js", output: "public/js/all"
+```
+
+it's not possible to use * or ./* alone, you have to use * after a directory name, like this: `dir/*`
+
+## Versions changelog
+- 0.8.1 - add guard runtime dependency correctly (with ~>)
+- 0.8.0 - add debug messages, add support for newer guard, add all_on_start option [yanked from rubygems]
+- 0.0.4 - add star (*) support to load multiple files
+- 0.0.3 - basic version
+
+## Contributors
+
+- [@ezekg](https://github.com/ezekg)
+- [@mikz](https://github.com/mikz)

data/lib/guard/concat.rb

@@ -1,48 +1,104 @@
 require 'guard'
-require 'guard/guard'
+require 'guard/plugin'
 require 'guard/watcher'
 
 module Guard
-  class Concat < Guard
+  class Concat < Plugin
 
-    VERSION = '0.0.3'
-
-    def initialize(watchers=[], opts={})
-      @output = "#{opts[:output]}.#{opts[:type]}"
-      files = opts[:files].join("|")
-      regex = %r{^#{opts[:input_dir]}/(#{files})\.#{opts[:type]}$}
-      watcher = ::Guard::Watcher.new regex
-      watchers << watcher
-      @watchers, @opts = watchers, opts
-      super watchers, opts
+    def initialize(opts={})
+      @opts = opts
+      opts[:watchers] = [] unless opts[:watchers]
+      opts[:watchers] << ::Guard::Watcher.new(matcher_regex)
+      super(opts)
     end
 
-    # # Calls #run_all if the :all_on_start option is present.
-    # def start
-    #   run_all if options[:all_on_start]
-    # end
+    def start
+      run_all if all_on_start?
+    end
 
-    # # Call #run_on_change for all files which match this guard.
-    # def run_all
-    #   run_on_changes(Watcher.match_files(self, Dir.glob('{,**/}*{,.*}').uniq))
-    # end
+    def run_all
+      concat
+    end
 
     def run_on_changes(paths)
       concat
-      UI.info "Concatenated #{@output}"
     end
 
+    # The actual concat method
+    #
+    # scans the :files passed as options
+    # supports * and expands them requiring all files in that path/folder
+
     def concat
-      content = ""
-      files = []
-      @opts[:files].each do |file|
-        files << "#{@opts[:input_dir]}/#{file}.#{@opts[:type]}"
+      file_names = files.map do |file|
+        single?(file) ? full_path(file) : expand(file)
       end
-      files.each do |file|
+
+      content = file_names.flatten.reduce("") do |content, file|
         content << File.read(file)
         content << "\n"
       end
-      File.open(@output, "w"){ |f| f.write content.strip }
+
+      if writes content
+        if @opts[:verbose]
+          UI.info "concat: #{file_names.join(', ')} to #{output_file}"
+        else
+          UI.info "concat: #{output_file}"
+        end
+      else
+        if @opts[:verbose]
+          UI.error "concat: error: #{file_names.join(', ')} to #{output_file} - message: Error, "
+        else
+          UI.error "concat: Error concatenating files to #{output_file}"
+        end
+      end
+    end
+
+    def full_path(file)
+      path = "#{input_dir}/#{file}"
+      path << ".#{type}" unless path =~ /\.#{type}$/
+      path
+    end
+
+    def matcher_regex
+      all_files = files.map{|f| f.sub(/\*$/, '.+') }.join("|")
+      %r|^#{input_dir}/(#{all_files})\.#{type}$|
+    end
+
+    def files
+      @opts.fetch(:files)
+    end
+
+    def input_dir
+      @opts.fetch(:input_dir)
+    end
+
+    def type
+      @opts.fetch(:type)
+    end
+
+    def output_file
+      @output_file ||= "#{@opts.fetch(:output)}.#{type}"
+    end
+
+    def all_on_start?
+      !!@opts[:all_on_start]
+    end
+
+    private
+
+    def writes(content)
+      File.open(output_file, "w"){ |f| f.write content.strip }
+    end
+
+    # handle the star option (*)
+
+    def single?(file)
+      file !~ /\*/
+    end
+
+    def expand(file)
+      Dir.glob full_path(file)
     end
 
   end

data/lib/guard/concat/templates/Guardfile

@@ -1,4 +1,7 @@
 # This will concatenate the javascript files specified in :files to public/js/all.js
+#
+# Specifying every single file in the array like %w(a b c) to maintain the loading order is suggested - See https://github.com/makevoid/guard-concat for more info
+#
 guard :concat, type: "js", files: %w(), input_dir: "public/js", output: "public/js/all"
 
 guard :concat, type: "css", files: %w(), input_dir: "public/css", output: "public/css/all"

data/lib/guard/concat/version.rb

@@ -0,0 +1,5 @@
+module Guard
+    class ConcatVersion
+      VERSION = "0.8.1" # almost 1.0 - requires updated guard >= 2.0
+    end
+end

metadata

@@ -1,67 +1,62 @@
 --- !ruby/object:Gem::Specification
 name: guard-concat
 version: !ruby/object:Gem::Version
-  version: 0.0.3
-  prerelease: 
+  version: 0.8.1
 platform: ruby
 authors:
 - Francesco 'makevoid' Canessa
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-01-23 00:00:00.000000000 Z
+date: 2015-01-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: guard
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.1.0
+        version: '2.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.1.0
-description: ! '    Guard::Concat automatically concatenates files in one when watched
-  files are modified.
-
-'
+        version: '2.0'
+description: |2
+      Guard::Concat automatically concatenates files in one when watched files are modified.
 email: makevoid@gmail.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- Readme.md
 - LICENSE
-- lib/guard/concat/templates/Guardfile
+- Readme.md
 - lib/guard/concat.rb
+- lib/guard/concat/templates/Guardfile
+- lib/guard/concat/version.rb
 homepage: http://github.com/makevoid/guard-concat
 licenses: []
+metadata: {}
 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.24
+rubygems_version: 2.2.2
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: Guard gem for concatenating (js/css) files
 test_files: []