torba 0.4.2 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 0878e9a6c25f1fceb393accb9e2a96aaec4bcf55
-  data.tar.gz: 3b2b74f577118a0c8c029d3b2164571138914e48
+  metadata.gz: 243b26b521d8876f13cb0fc7fcda5caf65250340
+  data.tar.gz: 7f0d92ece3a5cc9a0bc4cd7659c1d719bf8ceaa2
 SHA512:
-  metadata.gz: 5fa8a769f0755c370e4f21ff6bd9872e5d407ed74def48264bb835eba144227bdac4d1c7c5b68effd5b5b22613274e0b9f7a59cd63455aa51aa49d862407a931
-  data.tar.gz: 595971c2856af882d28734f64555e6845420859c23c0118722f52b72049812a8432080f3837a084bdfaa9696f56a0f76a30fc6d2bef835f52d286f9d30ab5c5e
+  metadata.gz: 10938f10db53cb9e5161afda6cc47c7a935039522bb2c8085b6f2a6459af4988b7127b01edc540c8330df6f856348b1d644d8e3426698ad92f38655ab491a63f
+  data.tar.gz: 1acaab48fc64102ee7f550dce7e5fa4d7fbf46dfa9196e9b4b069087c4f45cde780376b7dd313ddfb68cb046b781b6f55cf3675fab05fae1e85129d5904ab67f

data/CHANGELOG.md

@@ -1,5 +1,24 @@
 ## Unreleased
 
+## Version 0.5.0
+
+### Upgrading notes
+
+Rails users are advised to remove manual execution of `torba pack` from
+their deployment scripts, since the command now is a part of
+`rake assets:precompile`.
+
+### Enhancements
+
+* Support deployment to Heroku
+* `torba pack` is automatically injected into `rake assets:precompile`
+  in Rails applications
+* `torba install` command is a mapping for `torba pack`
+
+### Bug fixes
+
+* Retry 5 times if fetching a remote file fails
+
 ## Version 0.4.2
 
 ### Bug fixes

data/README.md

@@ -17,7 +17,7 @@ Production ready.
 
 ## Documentation
 
-[Released version](http://rubydoc.info/gems/torba/0.4.2)
+[Released version](http://rubydoc.info/gems/torba/0.5.0)
 
 ## Why
 
@@ -251,10 +251,53 @@ default), except that Torba does have a way to specify exact list of files to im
 
 ## Deployment
 
-1. Specify `TORBA_HOME_PATH` env variable pointing to a persistent directory writable by your
-   deploy user. For Capistrano it should be `shared/`.
-2. Add `bundle exec torba pack` to your deployment script right after `bundle install`. It's safe
-   and fairly cheap to run it unconditionally on each deployment.
+In Rails apps, Torba automatically hooks into the existing `assets:precompile`
+Rake task to ensure that `torba pack` is executed. This means that Rails
+deployments will "just work", although there are some optimizations you can make
+as explained below.
+
+### Heroku
+
+You will need to specify some config vars to ensure Torba's files are placed in
+locations suitable for the Heroku platform.
+
+`TORBA_HOME_PATH` should be within your app so that Torba's assets are included
+in the slug.
+
+`TORBA_CACHE_PATH` should make use of the `tmp/cache/assets` directory. This is
+where the Ruby buildpack expects cached files to be stored related to the
+`assets:precompile` step. This way Torba doesn't have to download packages fresh
+every time.
+
+```bash
+heroku config:set TORBA_HOME_PATH=vendor/torba TORBA_CACHE_PATH=tmp/cache/assets/torba
+```
+
+Now your Heroku app is good to go.
+
+### Capistrano
+
+Specify the `TORBA_HOME_PATH` env variable pointing to a persistent directory
+writable by your deploy user and shared across releases. Capistrano's `shared`
+directory is good for this.
+
+For example:
+
+```bash
+export TORBA_HOME_PATH=/var/www/my_app/shared/torba
+```
+
+There is no need to add a symlink.
+
+### Troubleshooting
+
+If you are getting an error like `Your Torba is not packed yet` when trying to
+run `rake assets:precompile` (or `bin/rails assets:precompile` in Rails 5),
+set the `TORBA_DONT_VERIFY` environment variable, like this:
+
+```bash
+TORBA_DONT_VERIFY=1 bin/rake assets:precompile
+```
 
 [bower]: http://bower.io/
 [sprockets]: https://github.com/rails/sprockets/

data/lib/torba/cli.rb

@@ -8,6 +8,7 @@ module Torba
       Torba.pretty_errors { Torba.pack }
       Torba.ui.confirm "Torba has been packed!"
     end
+    map install: :pack
 
     desc "verify", "check if all packages are prepared"
     def verify

data/lib/torba/rails.rb

@@ -4,5 +4,10 @@ module Torba
       Rails.application.config.assets.paths.concat(Torba.load_path)
       Rails.application.config.assets.precompile.concat(Torba.non_js_css_logical_paths)
     end
+
+    rake_tasks do
+      require "torba/rake_task"
+      Torba::RakeTask.new("torba:pack", :before => "assets:precompile")
+    end
   end
 end

data/lib/torba/rake_task.rb

@@ -0,0 +1,53 @@
+require "torba"
+require "rake/tasklib"
+
+module Torba
+  # Calling Torba::RakeTask.new defines a "torba:pack" Rake task that does the
+  # same thing as `bundle exec torba pack`. Furthermore, if the :before option
+  # is specified, the "torba:pack" task will be installed as a prerequisite to
+  # the specified task.
+  #
+  # This is useful for deployment because it allows for packing as part of the
+  # "assets:precompile" flow, which platforms like Heroku already know to
+  # invoke. By hooking into "assets:precompile" as a prerequisite, Torba can
+  # participate automatically, with no change to the deployment process.
+  #
+  # Typical use is as follows:
+  #
+  #   # In Rakefile
+  #   require "torba/rake_task"
+  #   Torba::RakeTask.new("torba:pack", :before => "assets:precompile")
+  #
+  # Note that when you require "torba/rails" in a Rails app, this Rake task is
+  # installed for you automatically. You only need to install the task yourself
+  # if you are using something different, like Sinatra.
+  #
+  class RakeTask < Rake::TaskLib
+    attr_reader :torba_pack_task_name
+
+    def initialize(name="torba:pack", options={})
+      @torba_pack_task_name = name
+      define_task
+      install_as_prerequisite(options[:before]) if options[:before]
+    end
+
+    private
+
+    def define_task
+      desc "Download and prepare all packages defined in Torbafile"
+      task torba_pack_task_name do
+        Torba.pretty_errors { Torba.pack }
+      end
+    end
+
+    def install_as_prerequisite(other_task)
+      ensure_task_defined(other_task)
+      Rake::Task[other_task].enhance([torba_pack_task_name])
+    end
+
+    def ensure_task_defined(other_task)
+      return if Rake::Task.task_defined?(other_task)
+      Rake::Task.define_task(other_task)
+    end
+  end
+end

data/lib/torba/remote_sources/get_file.rb

@@ -14,7 +14,7 @@ module Torba
 
         Torba.ui.info "downloading '#{url}'"
 
-        command = "curl -Lf -o #{tempfile.path} #{url}"
+        command = "curl --retry 5 --retry-max-time 60 -Lf -o #{tempfile.path} #{url}"
         system(command) || raise(Errors::ShellCommandFailed.new(command))
 
         tempfile

data/lib/torba/verify.rb

@@ -1,7 +1,14 @@
 require "torba"
 
-if STDOUT.tty?
-  Torba.pretty_errors { Torba.verify }
-else
-  Torba.verify
+# We purposely skip verification during Rake execution, because Rake is used to
+# run the Torba:RakeTask during the "assets:precompile" stage of deployment. In
+# this case it is OK that the Torbafile hasn't been packed yet, because we are
+# about to do so.
+#
+unless ENV["TORBA_DONT_VERIFY"] || defined?(Rake::Task)
+  if STDOUT.tty?
+    Torba.pretty_errors { Torba.verify }
+  else
+    Torba.verify
+  end
 end

data/test/rake_task_test.rb

@@ -0,0 +1,56 @@
+require "test_helper"
+require "torba/rake_task"
+
+module Torba
+  class RakeTaskTest < Minitest::Test
+    include Rake::DSL
+
+    def setup
+      task "environment"
+      task "assets:precompile" => "environment"
+      Torba::RakeTask.new("torba:pack", :before => "assets:precompile")
+    end
+
+    def teardown
+      Rake::Task.clear
+    end
+
+    def test_torba_pack_task_is_defined
+      assert(Rake::Task.task_defined?("torba:pack"))
+    end
+
+    def test_torba_pack_task_has_description
+      torba_task = Rake::Task["torba:pack"]
+      torba_task.comment =~ /Torbafile/
+    end
+
+    def test_torba_pack_is_installed_as_prerequisite
+      precompile_task = Rake::Task["assets:precompile"]
+      assert_equal(%w(environment torba:pack), precompile_task.prerequisites)
+    end
+
+    def test_invoking_torba_pack
+      Torba.expects(:pack).once
+      Rake::Task["torba:pack"].invoke
+    end
+
+    def test_defines_task_if_doesnt_exist
+      Rake::Task.clear
+      Torba::RakeTask.new("torba:pack", :before => "something:else")
+
+      assert(Rake::Task.task_defined?("something:else"))
+      other_task = Rake::Task["something:else"]
+      assert_equal(%w(torba:pack), other_task.prerequisites)
+    end
+
+    def test_alternative_task_name_can_be_specified
+      Rake::Task.clear
+      Torba::RakeTask.new("package")
+
+      assert(Rake::Task.task_defined?("package"))
+
+      Torba.expects(:pack).once
+      Rake::Task["package"].invoke
+    end
+  end
+end

data/test/test_helper.rb

@@ -3,6 +3,7 @@ require "torba"
 require "torba/remote_sources/common"
 
 require "minitest/autorun"
+require "mocha/mini_test"
 require "tmpdir"
 require "fileutils"
 

data/torba.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |spec|
   spec.name          = "torba"
-  spec.version       = "0.4.2"
+  spec.version       = "0.5.0"
   spec.authors       = ["Andrii Malyshko"]
   spec.email         = ["mail@nashbridges.me"]
   spec.description   = "Bundler for Sprockets"
@@ -19,4 +19,5 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "bundler", "~> 1.6"
   spec.add_development_dependency "rake", "~> 10.0"
   spec.add_development_dependency "minitest", "~> 5.4"
+  spec.add_development_dependency "mocha"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: torba
 version: !ruby/object:Gem::Version
-  version: 0.4.2
+  version: 0.5.0
 platform: ruby
 authors:
 - Andrii Malyshko
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-01-19 00:00:00.000000000 Z
+date: 2016-01-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: thor
@@ -66,6 +66,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '5.4'
+- !ruby/object:Gem::Dependency
+  name: mocha
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: Bundler for Sprockets
 email:
 - mail@nashbridges.me
@@ -91,6 +105,7 @@ files:
 - lib/torba/manifest.rb
 - lib/torba/package.rb
 - lib/torba/rails.rb
+- lib/torba/rake_task.rb
 - lib/torba/remote_sources/common.rb
 - lib/torba/remote_sources/get_file.rb
 - lib/torba/remote_sources/github_release.rb
@@ -106,6 +121,7 @@ files:
 - test/package/import_list_test.rb
 - test/package/logical_paths_test.rb
 - test/package_test.rb
+- test/rake_task_test.rb
 - test/remote_sources/common_test.rb
 - test/remote_sources/get_file_test.rb
 - test/remote_sources/github_release_test.rb
@@ -146,6 +162,7 @@ test_files:
 - test/package/import_list_test.rb
 - test/package/logical_paths_test.rb
 - test/package_test.rb
+- test/rake_task_test.rb
 - test/remote_sources/common_test.rb
 - test/remote_sources/get_file_test.rb
 - test/remote_sources/github_release_test.rb