fxos_rails 1.1.0 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: cd2f4d33f4d8450ce9f0291eee1c2fc298f7d07a
-  data.tar.gz: 702d3b59bce3c4456a7b944d793d76f7b66ab254
+  metadata.gz: 20e89d5597fc110f3b7477b65320d0d4a5ff0947
+  data.tar.gz: f98e45f059f9d5cee05aba5b774c9ecaeb85639c
 SHA512:
-  metadata.gz: 5d794331736f2f4462cc8c7e20f114ed3cdb5e39acc64c4828fe04df5b4c8cdb14f40b5bd8d45b65f9da4a5f379af8854ce4566799bbf0b9403195a32a5996d6
-  data.tar.gz: 46126d2477d709a70b211d39141cc67139464b7ab3f830f3dec2ed4a178e489eba27febeaac6af175c7836b28ffbfe8d6c2ac9f2f68ea40b9de0402afeeb61c3
+  metadata.gz: 3f4570aac31eebc8d7ac85ed23cad648243096300fd3c56842d10b6960c97d9b4b4a47a8fc881dc66cd4167dadd707a6e7d54667113ead54abfb2dae736afdfe
+  data.tar.gz: 3274598cb3ecb33fba71cc4cb4cfa13e70f35cb8868d2cb7d553f560e3fa11dcd49f6e8eae8d1e2fe6f0f61b68aab3a278997efc6d5f205ac01144abcc87cab7

data/MIT-LICENSE

@@ -1,4 +1,4 @@
-Copyright 2014 YOURNAME
+Copyright 2014 Pablo Brasero Moreno
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

data/lib/fxos_rails/manifest.rb

@@ -20,7 +20,7 @@ module FxosRails
         },
         type: 'web',
         default_locale: I18n.locale,
-        launch_path: '/index.html',
+        launch_path: '/index.html'
       }
     end
 

data/lib/fxos_rails/packager.rb

@@ -3,33 +3,56 @@ require 'nokogiri'
 module FxosRails
   class Packager
 
+    class Error < StandardError; end
+    class DownloadError < Error; end
+    class BuildError < Error; end
+
+    def clean!
+      system <<-SHELL
+        rm -rf #{tmp_path}/#{app_host} &&
+        rm -rf public/assets
+      SHELL
+    end
+
     def package!
+      check_environment_exists!
       precompile
       with_local_build_server do
         download
       end
+      check_download_success!
       unify_js
       add_manifest
       put_files_in_package
+    rescue Error
+      puts $!.message
     end
 
 
     private
 
+    def build_env
+      'build'
+    end
+
+    def ip
+      '127.0.0.1'
+    end
+
     def port
       3001
     end
 
     def with_local_build_server
       app_url  = "http://#{app_host}/#{launch_path}"
-      puts `./bin/rails server -e production -p #{port} -d`
+      run %{DISABLE_SPRING=1 ./bin/rails server -e #{build_env} -p #{port} -b #{ip} -d}
       yield(app_url)
     ensure
-      system %{kill -TERM `cat tmp/pids/server.pid`}
+      run %{kill -TERM `cat tmp/pids/server.pid`}
     end
 
     def app_host
-      "localhost:#{port}"
+      "#{ip}:#{port}"
     end
 
     def add_manifest
@@ -40,27 +63,74 @@ module FxosRails
     def put_files_in_package
       puts "Packaging..."
       package_path = local_app_path.join(package_filename)
-      system <<-SHELL
-        cd #{local_app_path} &&
-        zip #{package_path} -r .
-      SHELL
+      run %{cd #{local_app_path} && zip #{package_path} -r .}
       puts "Done. The package is now at #{package_path}"
     end
 
     def precompile
-      `RAILS_ENV=production ./bin/rake assets:precompile`
+      run %{RAILS_ENV=#{build_env} ./bin/rake assets:precompile}
+    end
+
+    def check_download_success!
+      return unless download_errors.present?
+      bullet = '  * '
+      errors_list = bullet + download_errors.join("\n" + bullet)
+      msg = <<-EOM
+ERROR: failed to grab some application files. Common causes include:
+  * Your app cannot be accessed at #{launch_path}
+  * Your app doesn't work locally when using the `#{build_env}` environment. For example, it could be missing a `#{build_env}` entry on `config/database.yml`
+  * Your app doesn't serve static files. Ensure the setting `config.serve_static_assets = true` on `config/environments/#{build_env}.rb`
+  * Some third-party assets are not being precompiled. This can happen with assets from gems. Ensure they are listed in the setting `config.assets.precompile` on `config/application.rb`
+
+Specifically, the following URLs returned errors:
+#{errors_list}
+      EOM
+      raise DownloadError, msg
+    end
+
+    def environment_config_path
+      Rails.root.join('config', 'environments', "#{build_env}.rb")
+    end
+
+    def check_environment_exists!
+      return if Rails.root.join(environment_config_path).exist?
+      msg = <<-EOM
+The build process requires a `#{build_env}` environment. Please create it at #{environment_config_path}. You can simply follow these steps:
+  1. Copy the production environment from config/environments/production.rb
+  2. Edit the file to ensure the setting `config.serve_static_assets = true`
+  3. Done!
+EOM
+      raise BuildError, msg
     end
 
     def download
-      system <<-SHELL
-        cd #{tmp_path} &&
-        rm -rf #{app_host} &&
-        wget -r #{launch_url}
-      SHELL
+      run %{cd #{tmp_path} && wget -nv -o #{wget_log_path} -r #{launch_url}}
       remove_query_strings
       add_icons
     end
 
+    def download_errors
+      @download_errors ||= begin
+        last_url = nil
+        url_re = %r{\b(https?://[^ ]+):}
+        timestamp_re = %r{\d\d\d\d-\d\d-\d\d \d\d:\d\d:\d\d}
+        error_re = %r{#{timestamp_re} ERROR}
+        errors = []
+        wget_log_path.open.each_line do |line|
+          if url_re =~ line
+            last_url = $~[1]
+          elsif error_re =~ line
+            errors << last_url
+          end
+        end
+        errors.reject{|url| url =~ %r{/robots.txt$} }
+      end
+    end
+
+    def download_successful?
+      download_errors.blank?
+    end
+
     def remove_query_strings
       Dir[local_app_path + '**' + '*'].each do |path|
         if path['?']
@@ -71,7 +141,9 @@ module FxosRails
 
     def add_icons
       icons_path = Rails.root.join(*%w{app assets images icons})
-      FileUtils.cp_r(icons_path, local_app_path)
+      if icons_path.exist?
+        FileUtils.cp_r(icons_path, local_app_path)
+      end
     end
 
     def unify_js
@@ -80,6 +152,10 @@ module FxosRails
       File.open(local_launch_path, 'r+') do |f|
         doc = Nokogiri::HTML(f)
         doc.css('script').each do |node|
+          type = node['type']
+          if type.present? && type != 'text/javascript'
+            next
+          end
           if src = node['src']
             src.gsub!(%r{^/}, '')
             full_path = local_app_path.join(src)
@@ -110,7 +186,7 @@ module FxosRails
     end
 
     def launch_url
-      app_host + '/' + launch_path
+      'http://' + app_host + '/' + launch_path
     end
 
     def launch_path
@@ -125,5 +201,14 @@ module FxosRails
       local_app_path + launch_path
     end
 
+    def run(command)
+      puts "*** #{command}"
+      system(command)
+    end
+
+    def wget_log_path
+      tmp_path.join('wget.log')
+    end
+
   end
 end

data/lib/fxos_rails/version.rb

@@ -1,3 +1,3 @@
 module FxosRails
-  VERSION = "1.1.0"
+  VERSION = "1.2.0"
 end

data/lib/tasks/fxos_tasks.rake

@@ -1,15 +1,13 @@
+require 'fxos_rails/packager'
+
 namespace :fxos do
   desc "Delete files created by the build process"
   task :clean do
-    system <<-SHELL
-      rm -rf tmp/package &&
-      rm -rf public/assets
-    SHELL
+    FxosRails::Packager.new.clean!
   end
 
   desc "Build your app's package"
   task build: %w{clean environment} do
-    require 'fxos_rails/packager'
     FxosRails::Packager.new.package!
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: fxos_rails
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 1.2.0
 platform: ruby
 authors:
 - Pablo Brasero
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-06-29 00:00:00.000000000 Z
+date: 2015-01-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails