RubyGems - ichiban - Versions diffs - 1.2.0 → 1.2.2 - Mend

ichiban 1.2.0 → 1.2.2

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (7) hide show

checksums.yaml +4 -4
data/lib/ichiban/js_compiler.rb +90 -57
data/lib/ichiban/loader.rb +1 -1
data/lib/ichiban/manual_compiler.rb +1 -0
data/lib/ichiban/version.rb +3 -0
data/lib/ichiban.rb +5 -2
metadata +30 -9

checksums.yaml CHANGED Viewed

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a67d27e89bd72f4afd96687d4bdd0497433fc4c4
-  data.tar.gz: 725e54db4c392ce2437c7499aa6674733f7abbf5
+  metadata.gz: 5e9455b270799fb2c632f4457bd396e623c4d235
+  data.tar.gz: dd03bed5cdb8bd51bb2f21b0184dc31738d7a9c0
 SHA512:
-  metadata.gz: b95a07d33bb48d4c6f8b36272d011c661e5253dc578935573fade28f8dc28f26784fe5da7ace00b3cb369942e9c38cbbacd8c94369c24bb760e2cc383ae7efeb
-  data.tar.gz: ec539fd3c4224f33112b85fdff5efe33d4e535d58c53783a6f9dfae15f7055e5e3aa25b2345e96b788bf45a8ef03df725286da3c3eebeede684e644d6da24e18
+  metadata.gz: 4c7f3a21eb7899774c9f0739e7176771085e5d63d8c41936c46494487dae5f7347a9bd160fdbe6e2e91fd4608a516a611c392b8fbe41c5f10a3ff13bd979dca2
+  data.tar.gz: 4a2c29534e6ce1bc8fbe780f6af53f1f891e6411a94dc87539267f28aa1c2e60d065a7a8ddf999743ad495570131aa6b0c5c4d8e19bc943c56ddc4a45cd8a11a

data/lib/ichiban/js_compiler.rb CHANGED Viewed

@@ -1,44 +1,70 @@
 module Ichiban
-  # This class uses source_map and uglifier to concatenate, minify, and source-map JS files.
+  # This class uses the UglifyJS2 binary to concatenate and minify JS source files.
   class JSCompiler
     def compile
       rel = @file.rel_to 'assets/js'
       Ichiban.config.js_manifests.each do |dest, sources|
         if sources.include? rel
-          # Make the source paths absolute.
-          sources = sources.map do |source|
-            abs = File.join Ichiban.project_root, 'assets/js', source
-            unless File.exists? abs
-              raise "Something's wrong with Ichiban.config.js_manifests. JS source file does not exist: #{abs.inspect}"
-            end
-            abs
+          # Make the destination folder if necessary.
+          dest_folder = File.expand_path(File.join(
+            Ichiban.project_root, 'compiled', 'js',
+            File.dirname(dest)
+          ))
+          unless File.exists? dest_folder
+            FileUtils.mkdir_p dest_folder
           end
-          # Make two code strings. The first contains the minified JS. The second
-          # contains the source map.
-          js, map = compile_paths(
-            sources,
-            File.join(Ichiban.config.relative_url_root, 'js'),
-            dest,
-            dest + '.map'
-          )
+          # Build the name of the source map.
+          map_name = File.basename(dest, File.extname(dest)) + '.js.map'
-          # Make sure the JS folder exists.
-          FileUtils.mkdir_p File.join(Ichiban.project_root, 'compiled/js')
+          # Shell out to UglifyJS2.
+          uglify_stdout = `
+            cd #{File.join(Ichiban.project_root, 'assets', 'js')} && \
+            uglifyjs \
+              #{sources.join(' ')} \
+              --output #{File.join(Ichiban.project_root, 'compiled', 'js', dest)} \
+              --source-map #{map_name} \
+              --source-map-url /js/#{map_name} \
+              --source-map-root /js \
+            2>&1 # Redirect STDERR to STDOUT.
+          `
+          unless $?.success?
+            raise UglifyError, "uglifyjs command failed:\n\n#{uglify_stdout}"
+          end
-          # Write the minified JS.
-          compiled_js_path = File.join(Ichiban.project_root, 'compiled/js', dest)
-          File.open(compiled_js_path, 'w') do |f|
-            f << js
+          # Uglify populates the source map's "file" property with the absolute path.
+          # Replace it with the filename.
+          map_path = File.join Ichiban.project_root, 'assets', 'js', map_name
+          map_json = JSON.parse(File.read(map_path))
+          File.open map_path, 'w' do |f|
+            f << JSON.dump(map_json.merge('file' => dest))
           end
-          # Write the source map.
-          File.open(File.join(Ichiban.project_root, 'compiled/js', dest + '.map'), 'w') do |f|
-            f << map
+          # Uglify writes the source map in assets/js.
+          # Move it into compiled/js.
+          FileUtils.mv(
+            File.join(Ichiban.project_root, 'assets', 'js', map_name),
+            File.join(Ichiban.project_root, 'compiled', 'js')
+          )
+          # Copy each of the source files into compiled/js so that JS debuggers
+          # can use them with the source map.
+          sources.each do |filename|
+            folder = File.expand_path(File.join(
+              Ichiban.project_root, 'compiled', 'js',
+              File.dirname(filename)
+            ))
+            unless File.exists? folder
+              FileUtils.mkdir_p folder
+            end
+            FileUtils.cp(
+              File.join(Ichiban.project_root, 'assets', 'js', filename),
+              File.join(Ichiban.project_root, 'compiled', 'js')
+            )
           end
           # Log the compilation of the JS file, but don't log the compilation of the map.
-          Ichiban.logger.compilation(@file.abs, compiled_js_path)
+          Ichiban.logger.compilation(@file.abs, dest)
         end
       end
     end
@@ -50,40 +76,47 @@ module Ichiban
     private
     # Pass in absolute source_paths.
-    def compile_paths(source_paths, source_root, js_filename, map_filename)
-      js, map = concat(
-        source_paths.map { |p| [File.read(p), File.basename(p)] },
-        source_root
-      )
-      js, map = uglify js, map, js_filename
-      map_url = File.join Ichiban.config.relative_url_root, 'js', map_filename
-      js << "\n//# sourceMappingURL=#{map_url}"
-      [js, map]
-    end
+    #def compile_paths(source_paths, source_root, js_filename, map_filename)
+    #  # The Uglify gem, unlike UglifyJS2, doesn't support concatenation as of August 2015.
+    #  # Thus, before we call Uglify, we have to concatenate ourselves. We also generate an
+    #  # intermediate source map for the concatenated JS. Uglify will use the intermediate
+    #  # source map when it creates its own source map.
+    #  js, map = concat(
+    #    source_paths.map { |p| [File.read(p), File.basename(p)] },
+    #    source_root
+    #  )
+    #
+    #  js, map = uglify js, map, js_filename
+    #
+    #  map_url = File.join Ichiban.config.relative_url_root, 'js', map_filename
+    #  js << "\n//# sourceMappingURL=#{map_url}"
+    #
+    #  [js, map]
+    #end
     # Sources should be an array of form: [['alert("foo");', 'alert.js']] Returns a tuple. The
     # first element is the concatenated JS. The second element is the map string.
-    def concat(sources, source_root)
-      js = StringIO.new
-      map = SourceMap.new(
-        generated_output: js,
-        source_root: source_root
-      )
-      sources.each do |source_js, source_filename|
-        map.add_generated source_js, source: source_filename
-      end
-      js.rewind
-      [js.read, map.to_s]
-    end
+    #def concat(sources, source_root)
+    #  js = StringIO.new
+    #  map = SourceMap.new(
+    #    generated_output: js,
+    #    source_root: source_root
+    #  )
+    #  sources.each do |source_js, source_filename|
+    #    map.add_generated source_js, source: File.join(source_filename)
+    #  end
+    #  js.rewind
+    #  puts map.to_s
+    #  [js.read, map.to_s]
+    #end
-    def uglify(js, map, js_filename)
-      Uglifier.new(
-        input_source_map: map,
-        output_filename: js_filename
-      ).compile_with_map(js)
-    end
+    #def uglify(js, map, js_filename)
+    #  Uglifier.new(
+    #    input_source_map: map,
+    #   output_filename: js_filename
+    # ).compile_with_map(js)
+    #end
   end
+  class UglifyError < RuntimeError; end
 end

data/lib/ichiban/loader.rb CHANGED Viewed

@@ -1,6 +1,6 @@
 module Ichiban
   class Loader
-    # Pass in an IchibanFile
+    # Pass in an Ichiban::ProjectFile.
     def change(file)
       if file.is_a?(Ichiban::HelperFile) or file.is_a?(Ichiban::ModelFile)
         delete_all

data/lib/ichiban/manual_compiler.rb CHANGED Viewed

@@ -10,6 +10,7 @@ module Ichiban
     end
     def paths(paths_to_compile)
+      Ichiban::Loader.new
       paths_to_compile.each do |path|
         unless path.start_with? Ichiban.project_root
           path = File.join(Ichiban.project_root, path)

data/lib/ichiban/version.rb ADDED Viewed

@@ -0,0 +1,3 @@
+module Ichiban
+  VERSION = '1.2.2'
+end

data/lib/ichiban.rb CHANGED Viewed

@@ -1,3 +1,8 @@
+if RUBY_VERSION.match(/[0-9]+-[0-9]+-[0-9]+/) and Gem::Version.new(RUBY_VERSION) < Gem::Version.new('2.1.0')
+  puts 'Ichiban requires '
+  exit 1
+end
 # Standard lib
 require 'fileutils'
 require 'json'
@@ -38,8 +43,6 @@ require 'ichiban/markdown'
 require 'ichiban/scripts'
 module Ichiban
-  VERSION = '1.1.0'
   # In addition to setting the variable, this loads the config file
   def self.project_root=(path)
     @project_root = path

metadata CHANGED Viewed

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ichiban
 version: !ruby/object:Gem::Version
-  version: 1.2.0
+  version: 1.2.2
 platform: ruby
 authors:
 - Jarrett Colby
@@ -76,7 +76,7 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 2.7.9
+        version: 2.10.1
     - - "~>"
       - !ruby/object:Gem::Version
         version: '2'
@@ -86,7 +86,7 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 2.7.9
+        version: 2.10.1
     - - "~>"
       - !ruby/object:Gem::Version
         version: '2'
@@ -136,7 +136,7 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 2.5.3
+        version: 2.7.2
     - - "~>"
       - !ruby/object:Gem::Version
         version: '2'
@@ -146,7 +146,7 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 2.5.3
+        version: 2.7.2
     - - "~>"
       - !ruby/object:Gem::Version
         version: '2'
@@ -156,7 +156,7 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.12.1
+        version: 0.12.2
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0'
@@ -166,7 +166,7 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.12.1
+        version: 0.12.2
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0'
@@ -304,6 +304,26 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '2'
+- !ruby/object:Gem::Dependency
+  name: json-compare
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.1.8
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.1.8
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0'
 description: Static website compiler with advanced features, including watcher script.
 email: jarrett@madebyhq.com
 executables:
@@ -347,6 +367,7 @@ files:
 - lib/ichiban/project_file.rb
 - lib/ichiban/project_generator.rb
 - lib/ichiban/scripts.rb
+- lib/ichiban/version.rb
 - lib/ichiban/watcher.rb
 homepage: https://github.com/jarrett/ichiban
 licenses: []
@@ -362,8 +383,8 @@ post_install_message: |2-
   maruku
   rdiscount
-  Ichiban uses Guard (http://github.com/guard/guard).
-  When you run `ichiban watch`, Guard may prompt
+  Ichiban uses Listen (https://github.com/guard/listen).
+  When you run `ichiban watch`, Listen may prompt
   you to install an event listener specific to your
   operating system. Follow its advice.