high_five 0.3.12 → 0.3.13

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e717e3ca8620ee1a2afe2916de2c8ca47ca01f71
-  data.tar.gz: 075c12499c27c05326aad891f90e8b79df950bb9
+  metadata.gz: 11880f58bb558fd9d63c7b7889c8be0eaf998a7d
+  data.tar.gz: 6b56b204891ec2f281db61db2ab60eccbb746655
 SHA512:
-  metadata.gz: aebc61c694e61cb5e0d09f239b60901db2ceb98c5f6c97413d25a19466a6b50266f04dde818d593e99052b782654d3c06ec9b7c2a72649518a286c4c354f17fe
-  data.tar.gz: b510fd081ca5f8f0fead43f6afb8d16533b7a073caa1e37ff3124362ec73f74a9443473a014c4a3d14f73de64eabccb16058f4001f765958b6d7a13432ea6517
+  metadata.gz: 4e4a48aa33e8f98b8e1e48c87adffef7a2a6abd736b04eb366a743101313d5b359c68c5baeeefd8d11ab9c57373402b0a7621da4027058e0c2e6383056098cef
+  data.tar.gz: 90426b1667821561970d79fef4f1286e5953a617313600b8b43215b4af3ba28e4385fc795e20a6b910f98f6b69753a032ee5a4b5d633a405a932d09cedab9b45

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    high_five (0.3.5)
+    high_five (0.3.12)
       chunky_png
       coffee-script (~> 2.2.0)
       compass (~> 0.12.2)
@@ -17,12 +17,12 @@ PATH
 GEM
   remote: https://rubygems.org/
   specs:
-    chunky_png (1.3.4)
+    chunky_png (1.3.5)
     coderay (1.1.0)
     coffee-script (2.2.0)
       coffee-script-source
       execjs
-    coffee-script-source (1.9.1.1)
+    coffee-script-source (1.10.0)
     compass (0.12.7)
       chunky_png (~> 1.2)
       fssm (>= 0.2.7)
@@ -32,10 +32,10 @@ GEM
     fssm (0.2.10)
     hike (1.2.3)
     method_source (0.8.2)
-    mini_portile (0.6.2)
+    mini_portile2 (2.0.0)
     multi_json (1.11.2)
-    nokogiri (1.6.6.2)
-      mini_portile (~> 0.6.0)
+    nokogiri (1.6.7.1)
+      mini_portile2 (~> 2.0.0.rc2)
     plist (3.1.0)
     pry (0.10.1)
       coderay (~> 1.1.0)

data/README.md

@@ -1,36 +1,270 @@
-High Five
-=========
+# High Five
 
-HTML5 build/deploy tool, usually used with PhoneGap but also for standalone web-based apps
+HTML5 build/deploy tool, usually used with PhoneGap but also for standalone web-based apps.
 
-Ruby
-====
+## Installation
 
-If you're on Windows, you need both Ruby and the Dev tools.  There is a great tutorial here: 
+Add `gem 'high_five'` to your `Gemfile` or run `gem install high_five`.
 
-https://github.com/oneclick/rubyinstaller/wiki/development-kit
+After installing the high\_five gem, run
+
+```
+$ hi5 init
+```
+
+This will bootstrap your project, creating a `config` directory if one isn't present and a few important files inside:
+
+* `config/high_five.rb`
+
+The most most important file. It is the main configuration file and where most configuration takes place. See below for configuration options. It contains sensible defaults.
+
+* `config/high_five/app-common.js`
+
+This is where your shared javascript goes.
+
+If you are using a framework like Sencha, this is where you would include the Sencha files.
+
+At a minimum, you will likely include the main entry point for your app here.
+
+This file is processed with Sprockets, so anything included here will be minified.
+
+Do not add library or remote scripts here. Those should be added with `config/high_five.rb` (see below for how to do this).
+
+* `config/high_five/app-platform.js`
+
+This file is a template and *must* be copied to create `app-<platform>.js` for each platform you have which by default are 'ios' and 'android'.
+
+After creating `app-<platform>.js` for each of your platforms, you can delete this file.
+
+* `config/high_five/index.html.erb`
+
+The entry page for your app.
+
+## Configuration
+
+* `config.app_name`
+
+TODO What does this do? Probably sets some values in some places
+
+* `config.app_id`
+
+TODO What does this do? Probably sets some values in some places
+
+* `config.root`
+
+Defaults to `File.join(File.dirname(__FILE__), '..')` which should be the top-level directory of your app.
+
+* `config.destination`
+
+This is to where high five deploys your app which is set to `www` by default.
+
+If you are using high five with a cordova app, this will need to be set for iOS and Android separately (uncomment the appropriate lines in the platforms section of the config).
+
+* `config.windows!`
+
+Use this if you're on windows and having problems with a strange ExecJS RuntimeError.
+
+* `config.compass_dir`
+
+If set, high five will run `compass compile` in the given directory before doing anything else.
+
+This makes it possible, for example, to write sass in `resources/sass/app.sass` and have it compiled to `resources/css/app.css` which can then be included into your app with the `stylesheets` method (see below).
+
+NB: Make sure you have specified your compass config in `config.rb` in this directory!
+
+* `config.minify`
+
+TODO Write some words about how minifying works and what you might need installed based on the variations options for minifying.
+
+* `config.manifest`
+
+Generate [app cache manifest](http://www.w3schools.com/html/html5_app_cache.asp).
+This is usually specified in the `:web` platform, and the manifest file is only created when the environment is `production`.
+You'll only use this if you're developing a javascript web app (e.g. an ember or angular app).
+
+* `config.dev_index`
+
+Copy generated index.html to given value, index-debug.html by default. The copied file will reference your source files and not the compiled files so that you do not need to deploy between every since code change. You'll only need to deploy when you add/remove a source file.
+
+### Bundling assets into your app
+
+The important high five config options for assets are `assets`, `javascripts`, and `stylesheets`.
+
+* `assets`
+
+This method takes either a directory or file name. When you deploy, those directories/files are copied into `config.destination`.
+
+For example, to include images into your app, first create `resources/images`.
+Then in the config file, add `config.assets "resources/images"`. When you deploy it will create `<destination>/resources/images` containing all of your images.
+You can now reference your images with respect to the `<destination>` directory. So a link to an image in your app would look like `resources/images/foobar.png`.
+
+* `javascripts`, `stylesheets`
+
+To include a javascript file or stylesheet, use the `javascripts` or `stylesheets` method respectively.
+This will add that file to `<destination>/index.html` when deploying.
+See `config/high_five/index.html.erb` to see how this is done.
+
+For example, let's say we want to include [moment.js](http://momentjs.com/).
+First we save the minified<sup>[1]</sup> file somewhere, `resources/vendor/javascripts`, for example.
+Then we add `config.javascripts "resources/vendor/javascripts/moment.min.js"` to our config file.
+When we deploy, that file will be included in `<destination>/index.html`!
+
+The same is true for stylesheets.
+
+Don't forget that the file you give to the `javascripts` and `stylesheets` methods can be anything.
+That means if you want to manage dependencies with npm, for example, you can do `config.javascripts "node_modules/foo/bar.js"`!
+
+[1] NB: hi5 does *not* minify your assets! Make sure you use the minified versions of your assets.
+
+#### Advanced example
 
-Installation
-============
+Let's say we want to add [FontAwesome](http://fontawesome.io) to our mobile app.
 
-  $ gem install high_five
-  $ cd my_mobile_project
-  $ hi5 init
+First, we extract the FontAwesome toolkit to `resources/vendor/font-awesome-4.5.0`, deleting everything except the css and fonts directories.
 
-This will bootstrap your project, creating a ```config``` directory if one isn't present, 
-and also creating a few important files inside, most importantly high_five.rb. 
+Then we have high five include that directory with `config.assets "resources/vendor/font-awesome-4.5.0"`.
 
-Configuration
-=============
+Then we tell high five to include the FontAwesome css file with `config.stylesheets "resources/vendor/font-awesome-4.5.0/css/font-awesome.min.css"`.
+This includes the FontAwesome stylesheet in `<destination>/index.html` which gives us access to the FontAwesome font-family and the `.fa` classes.
 
-```hi5 init``` will create all the directories you need, and almost all of your configuration will happen inside of ```config/high_five.rb```.  It is reasonably well documented and contains a lot of sensible defaults.  I hope to improve the documentation here over time, but for now go read ```high_five.rb```
+That's it!
 
+Follow a similar procedure for any complex resource you wish to include.
 
-Usage
-=====
+* `config.setting`
 
-  $ hi5 deploy <platform> -e <environment> 
+Using the `config.setting` method, you can create key/value pairs which will be made available in your javascript under `HighFive.Settings`.
 
-This will build your application for a specific platform to the directory specified in high_five.rb.  
+For example, `config.setting apiEndpoint: "http://dev.example.com/api"` will make `HighFive.Settings.apiEndpoint` return "http://dev.example.com/api".
 
+* `config.platform`
+
+Using the `config.platform` method defines your target platforms and allows you to create platform-specific configurations.
+Platforms are what you tell high five to deploy with the `hi5 deploy <platform>` command.
+At a minimum this usually includes iOS, Android, and "web" for testing without having to deploy to a device.
+
+The method takes a block whose argument is the same type of config object as the top level config object.
+
+For example, let's say you want to include iOS specific assets into the iOS version of your app.
+```ruby
+config.platform :ios do |ios|
+  ios.assets "resources/ios"
+end
+```
+
+When `hi5 deploy ios` is ran, high five will include `resources/ios` in the destination.
+
+For each platform, you need to make sure `config/high_five/app-<platform>.js` exists.
+See current examples for the minimum contents required in these files.
+This is important for INSERT REASONS HERE.  (TODO Why not just say `ios.javascripts "ios_specific_javascript_file.js"` instead?)
+
+* `config.environment`
+
+Environments function like platforms: they allow you to further specify or override either base or platform-specific settings for each of your environments (production/qa/staging/etc).
+That is, they take precedence over platform configurations.
+
+Their primary purpose is to set your app's endpoint, but can be used for anything.
+e.g. You may want a non-minified asset deployed to your device during development, but the minified version deployed all other times.
+
+An environment is specified with either `-e` or `--environment` when running `hi5 deploy`.
+
+e.g.
+
+  `hi5 deploy <platform> --environment lan`
+
+  `hi5 deploy <platform> -e production`
+
+At a minimum, you will probably want `:lan` (so you can deploy an app which is pointed at a server running on your machine) and an entry for each environment your app has (production/staging/qa/etc).
+```ruby
+config.environment :lan do |lan|
+  ip = Socket.ip_address_list.detect { |intf| intf.ipv4? && !intf.ipv4_loopback? && !intf.ipv4_multicast? }.ip_address
+  lan.setting apiEndpoint: "http://#{ip}:3000" # Or however you specify your server's location.
+  # lan.javascripts "resources/vendor/javascripts/some-library-debug-all.js"
+end
+
+config.environment :dev do |dev|
+  dev.setting apiEndpoint: "http://dev.example.com"
+  # dev.javascripts "lib/some-library-minified.js"
+end
+
+config.environment :production do |production|
+  production.setting apiEndpoint: "http://example.com"
+  # production.javascripts "lib/some-library-minified.js"
+  # production.minify :uglifier # or :yui
+end
+```
+
+## Usage
+
+* `$ hi5 deploy <platform> -e <environment>`
+
+This will build your application for a specific platform with the settings for the given environment to the destination directory specified in `config/high_five.rb`.
+
+* `$ hi5 <android|ios>:set_icon path/to/icon.png`
+
+By default, high\_five uses ChunkyPNG to resize the icon, but this almost always bad icons.
+We highly recommend adding the [rmagick](https://github.com/rmagick/rmagick) gem (which depends on imagemagick) to your Gemfile along with high\_five.
+High Five will detect that you have rmagick installed and will use it to generate good icons.
+
+* `$ hi5 <android|ios>:set_version -v "1.0" -b 200`
+
+This sets the publicly visible "version string" and the build number. They are in either `info.plist` or `AndroidManifest.xml` for iOS and Android, respectively.
+
+* `$ hi5 dist <platform>`
+
+Compiles the native application to an IPA or APK. This is optional, and instead you may use Xcode, Android Studio, gradle, or any other similar tool.
+
+If you pass it the `--install` flag, it will attempt to install to a connected device.
+
+* There's probably more high five commands that should be documented. If you find any not listed here, open an issue or submit a PR.
+
+### Development Usage
+
+#### Build and deploy for browser
+
+`hi5 deploy web`
+
+Then open index-debug.html inside of google chrome with web security disabled (`google-chrome --disable-web-security`)
+
+#### Build and deploy for device
+
+Make sure your device and computer are on the same wifi network (subnet).
+
+Make sure your server accepts connects from devices on the same subnet.
+
+e.g. For rails, start your server like this:
+
+`rails server -b 0.0.0.0`
+
+##### Android
+
+According to Brett, only the _first_ time you put a build on your device, you need to do this (replace the keystore, alias, password, and alias password with the correct values for your app):
+
+`hi5 deploy android --environment lan && hi5 dist android --environment lan --install --ant-flags="-Dkey.store=foobar.keystore -Dkey.alias=foobar -Dkey.store.password=foobar -Dkey.alias.password=foobar"`
+
+TODO: hi5 dist should use the debug android target instead of release by default if it doesn't detect signing parameters. It should also generate a big warning about that.
+
+After that, this should be sufficient:
+
+`hi5 deploy android -e lan && hi5 dist android -e lan --install`
+
+*However*, this did not work for me. I had to always use the first command or else hi5 just kept installing the initial build.
+
+##### iOS
+
+TODO Write words here. Probably something with Xcode.
+
+## Reading the source
+
+TODO Write words here.
+
+## Ruby
+
+If you're on Windows, you need both Ruby and the Dev tools. There is a great tutorial here:
+
+https://github.com/oneclick/rubyinstaller/wiki/development-kit
 
+## TODO
+* Have `hi5 init` create resources/images
+* Confirm the `assets` method can take a file.
+* Just create the app-ios.js and app-android.js files instead of app-platform.js. This would get us a little closer to "just working".

data/lib/high_five/android_helper.rb

@@ -11,7 +11,7 @@ module HighFive
 
     def android_manifest_path
       if options[:platform_path]
-        platform_path = File.join(options[:platform_path], "AndroidManifest.xml")
+        platform_path = Dir[File.join(options[:platform_path], "**/AndroidManifest.xml")][0]
         return platform_path if File.exists?(platform_path)
       end
 

data/lib/high_five/thor/tasks/deploy.rb

@@ -43,7 +43,7 @@ module HighFive
           FileUtils.rm_rf(self.destination_root)
           FileUtils.mkdir_p(self.destination_root)
 
-          #todo add to config
+          # TODO Add to config
           say "Deploying app: <#{@platform}> <#{options[:environment]}>"
           say "\t#{self.destination_root}"
           say " -Weinre url: #{@weinre_url}" if @weinre_url

data/lib/high_five/thor/tasks/dist.rb

@@ -98,6 +98,7 @@ module HighFive
         def system_or_die(cmd)
           system(cmd)
           if $?.exitstatus != 0
+            puts "FATAL: Cannot execute '#{cmd}'"
             exit $?.exitstatus
           end
         end

data/lib/high_five/version.rb

@@ -1,3 +1,3 @@
 module HighFive
-  VERSION = "0.3.12"
+  VERSION = "0.3.13"
 end

data/template/config/high_five/app-common.js

@@ -1,4 +1,5 @@
-//This is where you define the javascripts you include and their include order for your app.
-//Only include app code that you want minified here, add library or remote scripts to config/high_five.rb
+// This is where you define the javascripts you include and their include order for your app.
+// Only include app code that you want minified here, add library or remote scripts to config/high_five.rb
+// For example
 //= require ../../javascripts/app.js
-//= require_tree ../../javascripts/app
+//= require_tree ../../javascripts/app

data/template/config/high_five/index.html.erb

@@ -1,27 +1,29 @@
 <!doctype html>
 <html lang="en">
-    <head>
-        <meta charset="utf-8">
-        <title><%= @meta[:title] %></title>
-        <meta name="description" content="<%= @meta[:description] %>" />
-        <% @stylesheets.each do |ss| -%>
-            <link rel="stylesheet" href="<%= ss %>" type="text/css" />
-        <% end -%>
-        <% if @platform != 'web' -%>
-            <% if @environment == 'development' -%>
-                <script type="text/javascript">
-                    window.onerror = function(e,u,l) {
-                      alert("Error caught" + e + " " + u + ":" + l);
-                    };
-                </script>
-            <% end -%>
-        <% end -%>
-        <%= @high_five_javascript %>
-        <%- @javascripts.each do |js| -%>
-            <script type="text/javascript" src="<%= js %>"></script>
-        <%- end -%>	
+<head>
+  <meta charset="utf-8">
+  <title><%= @meta[:title] %></title>
+  <meta name="description" content="<%= @meta[:description] %>" />
 
-    </head>
-    <body></body>
+  <%- @stylesheets.reverse.each do |ss| -%>
+  <link rel="stylesheet" href="<%= ss %>" type="text/css" />
+  <%- end -%>
+
+  <%- if @platform != 'web' && @environment == 'lan' -%>
+    <script type="text/javascript">
+      window.onerror = function(e,u,l) {
+        alert("Error caught " + e + " " + u + ":" + l);
+      };
+    </script>
+  <%- end -%>
+
+  <%= @high_five_javascript %>
+
+  <%- @javascripts.reverse.each do |js| -%>
+    <script type="text/javascript" src="<%= js %>"></script>
+  <%- end -%>
+</head>
+<body>
+</body>
 </html>
 

data/template/config/high_five.rb

@@ -5,67 +5,84 @@ HighFive::Config.configure do |config|
   config.root = File.join(File.dirname(__FILE__), '..')
   # config.destination = "www"
 
-  # This will run cordova prepare in this directory. Will also default your platform destination to cordova/www
+  # This will run cordova prepare in this directory. Will also default your platform destination to cordova/www.
   # config.cordova_path "cordova"
 
-  # Uncomment this if you're on windows and having problems with a strange ExecJS RuntimeError
+  # Uncomment this if you're on windows and having problems with a strange ExecJS RuntimeError.
   # config.windows!
 
-  # This will add the resources folder to all platforms (stylesheets etc.)
-  # config.assets "resources"
-
-  # Include javascript libraries
-  # These get included before everything else in the app, and are *not* minified
+  # Include assets (images, fonts, etc).
+  # This will add the given directory or file to the <destination>/resources directory.
+  # e.g.
+  # config.assets "resources/images"
+  # config.assets "resources/vendor/font-awesome-4.5.0"
 
+  # Include javascript libraries.
+  # These get included before everything else in the app and are *not* minified.
+  # Make sure you link to the minified versions of your assets if that's what you desire.
+  # e.g.
   # config.javascripts "http://maps.google.com/maps/api/js?sensor=true"
-  # config.javascripts "lib/jquery-min.js"
-
-  # Run `compass compile` in this directory before doing anything
-  # config.compass_dir "resources/sass"
+  # config.javascripts "resources/vendor/javascripts/jquery-min.js"
 
-  # copy and include these stylesheets in the html
+  # Include stylesheets.
+  # e.g.
   # config.stylesheets "resources/css/app.css"
   # config.stylesheets "resources/css/jquery-ui.css"
+  # config.stylesheets "resources/vendor/font-awesome-4.5.0/css/font-awesome.min.css"
 
-  # Basic key/value settings that will be available to your javascript
-  # config.setting base_url: "http://dev.example.com/api" # HighFive.Settings.base_url = "http://dev.example.com/api"
+  # Run `compass compile` in this directory before doing anything.
+  # config.compass_dir "resources/sass"
 
-  # Configure plaform specific settings like this
+  # Basic key, value pairs that will be available to your javascript under HighFive.Settings.
+  # config.setting apiEndpoint: "http://dev.example.com/api" # HighFive.Settings.apiEndpoint will return "http://dev.example.com/api"
+
+  # ===========================================================================
+  # Platforms
+  #   Configure plaform specific settings like this.
+  #   Make sure config/high_five/app-<platform>.js exists. Put platform specific javascript in there.
+  #   See existing files for minimum contents.
+  #   Those files are managed by sprockets and are used to determine the javascript include order.
+  # ===========================================================================
   config.platform :ios do |ios|
-    # ios.destination = "www-ios"
+    # ios.destination = "cordova/platforms/ios/www" # Cordova
     # ios.assets "resources/ios"
   end
 
   config.platform :android do |android|
-    # android.destination = "www-android"
+    # android.destination = "cordova/platforms/android/assets/www" # Cordova
     # android.assets "resources/android"
   end
 
-  config.platform :Web do |web|
+  config.platform :web do |web|
     web.destination = "www"
-    web.manifest = true #generate app cache manifest (production env only)
-    web.dev_index = "index-debug.html" #copy generated index.html to index-debug (development env only)
+    web.setting apiEndpoint: 'http://localhost:3000' # Or however you specify your server's location.
+    web.manifest = true # Generate app cache manifest. This is only done when environment is 'production'.
+    web.dev_index = "index-debug.html" # Copy generated index.html to index-debug.
   end
 
-  # if you need platform-specific javascripts,
-  # simply create app-<platform>.js
-  # these files are managed by sprockets, and are used to determine the javascript include order
+  # ===========================================================================
+  # Environments
+  #   Configure environment specific settings like this.
+  #   Environments work just like platforms and allow you to further customize/override settings.
+  #   These take precedence over the platform overrides.
+  #   e.g.
+  #     You can deploy to an iOS device and point the app at your production server.
+  #     or deploy to an Android device and point the app at your dev/staging/qa server.
+  # ===========================================================================
+  config.environment :lan do |lan|
+    ip = Socket.ip_address_list.detect { |intf| intf.ipv4? && !intf.ipv4_loopback? && !intf.ipv4_multicast? }.ip_address
+    lan.setting apiEndpoint: "http://#{ip}:3000" # Or however you specify your server's location.
+    # lan.javascripts "resources/vendor/javascripts/some-library-debug-all.js"
+  end
 
-  # Environment support: production/development/etc
-  # Environments work just like platforms
-  config.environment :development do |development|
-    # development.javascripts "lib/some-library-debug-all.js"
-    # development.setting base_url: "http://dev.example.com:1234/api/"
+  config.environment :dev do |dev|
+    dev.setting apiEndpoint: "http://dev.example.com"
+    # dev.javascripts "lib/some-library-minified.js"
   end
 
   config.environment :production do |production|
+    production.setting apiEndpoint: "http://example.com"
     # production.javascripts "lib/some-library-minified.js"
-    # production.setting base_url: "http://production.example.com/api/" #these take precedence over the platform overrides
     # production.minify :uglifier # or :yui
   end
-
-  # config.environment :lan do |lan|
-    # ip = Socket.ip_address_list.detect{|intf| intf.ipv4? and !intf.ipv4_loopback? and !intf.ipv4_multicast?}.ip_address
-    # lan.setting apiEndpoint: "http://#{ip}:3000"
-  # end
-end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: high_five
 version: !ruby/object:Gem::Version
-  version: 0.3.12
+  version: 0.3.13
 platform: ruby
 authors:
 - Brian Samson
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-12-14 00:00:00.000000000 Z
+date: 2016-03-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: multi_json