javascript.rb in puppet-herald-0.2.0

- old
+ new
@@ -1,34 +1,40 @@
 require 'puppet-herald'
 require 'uglifier'
 
+# A module for Herald
 module PuppetHerald
+  # A javascript processing class
   class Javascript
+    # Initialize JS class
+    def initialize
+      @files = nil
+      @base = 'lib/puppet-herald/public'
+    end
 
-    @@files = nil
-
-    @@base = 'lib/puppet-herald/public'
-
-    def self.files
-      if PuppetHerald::is_in_dev?
-        @@files = nil
-      end
-      if @@files.nil?
-        public_dir = PuppetHerald::relative_dir(@@base)
+    # Returns a list of JS files to be inserted into main HTML
+    # @return [Array] list of JS's
+    def files
+      @files = nil if PuppetHerald.in_dev?
+      if @files.nil?
+        public_dir = PuppetHerald.relative_dir(@base)
         all = Dir.chdir(public_dir) { Dir.glob('**/*.js') }
-        @@files = all.reverse.reject { |file| file.match(/_test\.js$/) }
+        @files = all.reverse.reject { |file| file.match(/_test\.js$/) }
       end
-      return @@files
+      @files
     end
 
-    def self.uglify mapname
-      sources = files.collect { |file| File.read("#{@@base}/#{file}") }
+    # Uglify an application JS's into one minified JS file
+    # @param mapname [String] name of source map to be put into uglified JS
+    # @return [Hash] a hash with uglified JS and source map
+    def uglify(mapname)
+      sources = files.collect { |file| File.read("#{@base}/#{file}") }
       source = sources.join "\n"
-      uglifier = Uglifier.new(:source_map_url => mapname)
+      uglifier = Uglifier.new(source_map_url: mapname)
       uglified, source_map = uglifier.compile_with_map(source)
-      return {
+      {
         'js'     => uglified,
         'js.map' => source_map
       }
     end
   end
-end
\ No newline at end of file
+end