torba 0.7.0 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a22c7a165ee7472c946d1071f7b0b0a7c4435048
-  data.tar.gz: a7df1df4c4f0557d90302c1a76c83e25ef1d0be7
+  metadata.gz: dffb3d16bfcf61e1a3140263cad47fc52626ef52
+  data.tar.gz: 1b60520eed5966d1a4cf78461f3f5676ca65d36b
 SHA512:
-  metadata.gz: 36462194a06c6b4ec1a48508f819ed4057f6ab401fc9a69d356d723dd67a99a64195bc594132309047121ae6e06a5af5079da310e4d42c854b2ff47027a8bcf1
-  data.tar.gz: 07fe683e3025332f05d11f60a735842e2b1f7b8b26c964a516acfd92470a1382090cbf02f8d05e354a86e1b6dc605b41790c76e63847be09fde509f823056115
+  metadata.gz: de9720c5da6dacb684e29e0f2a1d8d4d256e7dfbee348552d073074578bad552e19742ccc768ff1897cfd87c6aa3ff42a8f5025ecc58476f4b28de1820644787
+  data.tar.gz: 90b3a95611f4839a78aebf35e5146f5b510d969cc2c0278a4787f4034f597f7d42767bef40f3b213ac5780fa2ca18d7978083f15a3cdca319375d3c683b25c78

data/.yardopts

@@ -1 +1,3 @@
 --no-private
+-
+CHANGELOG.md

data/CHANGELOG.md

@@ -1,5 +1,35 @@
 ## Unreleased
 
+## Version 1.0.0
+
+### Breaking changes
+
+* Rails support has been removed. Use [torba-rails][torba-rails] instead.
+* `torba/verify` no longer checks, whether it is executed within Rake task
+  or not. This was a workaround for Rails support, which is no longer a goal
+  of this gem.
+* `torba/verify` no longer checks `TORBA_DONT_VERIFY` env variable. Same as
+  above.
+
+### Upgrading notes
+
+If you are a non-Rails user, this should be a non-breaking update. In rare cases,
+when you depend on old behaviour of `torba/verify`, please, add the conditionals
+to your application code.
+
+Rails users should:
+
+1. Replace `gem "torba"` with `gem "torba-rails"` in the Gemfile.
+2. Remove `require "torba/verify"` from `boot.rb`.
+3. Remove `require "torba/rails"` from `application.rb`.
+4. Unset obsolete `TORBA_DONT_VERIFY` env variable if present.
+
+### Enhancements
+
+* Rake task accepts a block to be executed before packing process
+
+[torba-rails]: https://github.com/torba-rb/torba-rails
+
 ## Version 0.7.0
 
 ### Enhancements

data/README.md

@@ -17,7 +17,7 @@ Production ready.
 
 ## Documentation
 
-[Released version](http://rubydoc.info/gems/torba/0.7.0)
+[Released version](http://rubydoc.info/gems/torba/1.0.0)
 
 ## Why
 
@@ -53,29 +53,20 @@ Problems with the Bower:
 
 ## Installation
 
-Add this line to your application's Gemfile and run `bundle`:
+### Rails
 
-```ruby
-gem 'torba'
-```
+Use [torba-rails][torba-rails-github].
 
-### Rails
+### Sinatra
 
-in boot.rb
+See this [example project][sinatra-example].
 
-```diff
- require 'bundler/setup' # Set up gems listed in the Gemfile.
-+require 'torba/verify'
-```
+### Other Ruby application
 
-in config/application.rb
+Add this line to your application's Gemfile and run bundle:
 
-```diff
- # Require the gems listed in Gemfile, including any gems
- # you've limited to :test, :development, or :production.
- Bundler.require(*Rails.groups)
-+
-+require 'torba/rails'
+```ruby
+gem 'torba'
 ```
 
 ## Usage
@@ -87,14 +78,8 @@ in config/application.rb
 3. Add "require" [Sprockets directives][sprockets-directives] to your "application.js"
 and/or "@import" [Sass directives][sass-import] to "application.css".
 
-4. Non JS/CSS assets are automatically added to precompile list, nothing to do here.
-
 If any changes made to the Torbafile, run `bundle exec torba pack` again.
 
-### Examples
-
-See fully configured [Rails application][rails-example].
-
 ### Torbafile
 
 Torbafile is an assets specification. It is a plain text file that contains one or more
@@ -179,6 +164,10 @@ You can omit the name, it will be equal to the package name:
 npm package: "coffee-script", version: "1.9.2"
 ```
 
+### Examples
+
+See [Torbafiles][torbafile-examples] used for testing.
+
 ### "Packing the torba" process
 
 When you run `torba pack` the following happens:
@@ -248,58 +237,6 @@ gh_release "lightslider", source: "sachinchoolur/lightslider", tag: "1.1.2", imp
 
 In addition to this "path/" is treated as a shortcut for "path/**/*" glob pattern.
 
-Be careful to **import only that you really need**. Everything that is non JS or CSS asset is
-going to be precompiled by Sprockets and accessible publicly. See [Rails ticket][rails-ticket-vendoring]
-that explains this problem (and why Rails >= 4 precompiles only application.js/css in vendor by
-default), except that Torba does have a way to specify exact list of files to import.
-
-## 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 Capistrano 3, you can set this up in `config/deploy.rb`:
-```
-set :default_env, { torba_home_path: shared_path.join('vendor/torba') }
-```
-
-### 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/
 [sprockets-load-path]: https://github.com/rails/sprockets#the-load-path
@@ -310,6 +247,7 @@ TORBA_DONT_VERIFY=1 bin/rake assets:precompile
 [rails-assets]: https://rails-assets.org/
 [bower-rails]: https://github.com/rharriso/bower-rails
 [semver]: http://semver.org/
-[rails-ticket-vendoring]: https://github.com/rails/rails/pull/7968
 [npm]: https://npmjs.com
-[rails-example]: https://github.com/torba-rb/rails-example
+[torba-rails-github]: https://github.com/torba-rb/torba-rails
+[sinatra-example]: https://github.com/xfalcox/sinatra-assets-seed
+[torbafile-examples]: https://github.com/torba-rb/torba/tree/master/test/fixtures/torbafiles

data/lib/torba/rake_task.rb

@@ -18,6 +18,12 @@ module Torba
   #   require "torba/rake_task"
   #   Torba::RakeTask.new("torba:pack", :before => "assets:precompile")
   #
+  # You can also provide a block, which will be executed before packing process:
+  #
+  #   Torba::RakeTask.new do
+  #     # some preconfiguration to be run when the "torba:pack" task is executed
+  #   end
+  #
   # 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.
@@ -25,17 +31,18 @@ module Torba
   class RakeTask < Rake::TaskLib
     attr_reader :torba_pack_task_name
 
-    def initialize(name="torba:pack", options={})
+    def initialize(name="torba:pack", options={}, &before_pack)
       @torba_pack_task_name = name
-      define_task
+      define_task(before_pack)
       install_as_prerequisite(options[:before]) if options[:before]
     end
 
     private
 
-    def define_task
+    def define_task(before_pack_proc)
       desc "Download and prepare all packages defined in Torbafile"
       task torba_pack_task_name do
+        before_pack_proc.call if before_pack_proc
         Torba.pretty_errors { Torba.pack }
       end
     end

data/lib/torba/verify.rb

@@ -1,14 +1,7 @@
 require "torba"
 
-# 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
+if STDOUT.tty?
+  Torba.pretty_errors { Torba.verify }
+else
+  Torba.verify
 end

data/test/acceptance-cli/open_test.rb

@@ -15,7 +15,7 @@ module Torba
         "TORBA_EDITOR" => "echo torba_editor", "VISUAL" => "echo visual", "EDITOR" => "echo editor"
       })
       assert status.success?, err
-      compare_dirs "test/fixtures/home_path/01", path_to_packaged("trumbowyg")
+      assert_dirs_equal "test/fixtures/home_path/01", path_to_packaged("trumbowyg")
     end
 
     def test_uses_torba_editor_first

data/test/acceptance-cli/pack_test.rb

@@ -6,28 +6,28 @@ module Torba
       out, err, status = torba("pack", torbafile: "01_zip.rb")
       assert status.success?, err
       assert_includes out, "Torba has been packed!"
-      compare_dirs "test/fixtures/home_path/01", path_to_packaged("trumbowyg")
+      assert_dirs_equal "test/fixtures/home_path/01", path_to_packaged("trumbowyg")
     end
 
     def test_targz
       out, err, status = torba("pack", torbafile: "01_targz.rb")
       assert status.success?, err
       assert_includes out, "Torba has been packed!"
-      compare_dirs "test/fixtures/home_path/01", path_to_packaged("trumbowyg")
+      assert_dirs_equal "test/fixtures/home_path/01", path_to_packaged("trumbowyg")
     end
 
     def test_gh_release
       out, err, status = torba("pack", torbafile: "01_gh_release.rb")
       assert status.success?, err
       assert_includes out, "Torba has been packed!"
-      compare_dirs "test/fixtures/home_path/01", path_to_packaged("trumbowyg")
+      assert_dirs_equal "test/fixtures/home_path/01", path_to_packaged("trumbowyg")
     end
 
     def test_npm
       out, err, status = torba("pack", torbafile: "02_npm.rb")
       assert status.success?, err
       assert_includes out, "Torba has been packed!"
-      compare_dirs "test/fixtures/home_path/02", path_to_packaged("lo_dash")
+      assert_dirs_equal "test/fixtures/home_path/02", path_to_packaged("lo_dash")
     end
 
     def test_without_image_asset_specified_in_import
@@ -43,7 +43,7 @@ OUT
       out, err, status = torba("pack", torbafile: "03_not_existed_assets.rb")
       assert status.success?, err
       assert_includes out, "Torba has been packed!"
-      compare_dirs "test/fixtures/home_path/03", path_to_packaged("bourbon")
+      assert_dirs_equal "test/fixtures/home_path/03", path_to_packaged("bourbon")
     end
   end
 end

data/test/acceptance-cli/show_test.rb

@@ -5,7 +5,7 @@ module Torba
     def test_runs_pack
       out, err, status = torba("show trumbowyg", torbafile: "01_zip.rb")
       assert status.success?, err
-      compare_dirs "test/fixtures/home_path/01", path_to_packaged("trumbowyg")
+      assert_dirs_equal "test/fixtures/home_path/01", path_to_packaged("trumbowyg")
     end
 
     def test_outputs_package_directory

data/test/rake_task_test.rb

@@ -34,6 +34,19 @@ module Torba
       Rake::Task["torba:pack"].invoke
     end
 
+    def test_calls_a_block_before_torba_pack
+      Rake::Task.clear
+
+      configuration = Object.new
+
+      order = sequence("correct order")
+      configuration.expects(:setup).in_sequence(order)
+      Torba.expects(:pack).in_sequence(order)
+
+      task = Torba::RakeTask.new("torba:pack") { configuration.setup }
+      Rake::Task["torba:pack"].invoke
+    end
+
     def test_defines_task_if_doesnt_exist
       Rake::Task.clear
       Torba::RakeTask.new("torba:pack", :before => "something:else")

data/test/test_helper.rb

@@ -3,6 +3,7 @@ require "torba"
 require "torba/remote_sources/common"
 
 require "minitest/autorun"
+require "minitest/assert_dirs_equal"
 require "mocha/mini_test"
 require "tmpdir"
 require "fileutils"
@@ -52,32 +53,6 @@ module Torba
         assert path, "Couldn't find packaged #{name.inspect} in #{home.inspect}"
         path
       end
-
-      def read_without_newline(path)
-        content = File.read(path)
-        content.strip
-      rescue ArgumentError # ignore binary files
-        content
-      end
-
-      def compare_dirs(expected, actual)
-        expected_paths = Dir.glob("#{expected}/**/*").map{ |path| path.sub(expected, "")}
-
-        expected_paths.each do |path|
-          actual_file = File.join(actual, path)
-          assert_exists actual_file
-
-          unless File.directory?(actual_file)
-            expected_file = File.join(expected, path)
-            assert_equal read_without_newline(expected_file), read_without_newline(actual_file), "#{expected_file.inspect} should be equal to #{actual_file.inspect}"
-          end
-        end
-
-        actual_paths = Dir.glob("#{actual}/**/*").map{ |path| path.sub(actual, "")}
-
-        paths_diff = actual_paths - expected_paths
-        assert_empty paths_diff, "#{expected.inspect} contains extra paths #{paths_diff.inspect}"
-      end
     end
 
     module Exec

data/torba.gemspec

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: torba
 version: !ruby/object:Gem::Version
-  version: 0.7.0
+  version: 1.0.0
 platform: ruby
 authors:
 - Andrii Malyshko
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-03-13 00:00:00.000000000 Z
+date: 2016-04-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: thor
@@ -80,6 +80,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: assert_dirs_equal
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
 description: Bundler for Sprockets
 email:
 - mail@nashbridges.me
@@ -104,7 +118,6 @@ files:
 - lib/torba/import_list.rb
 - 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

data/lib/torba/rails.rb

@@ -1,13 +0,0 @@
-module Torba
-  class Engine < Rails::Engine
-    initializer "torba.assets" do |app|
-      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