torba 0.5.1 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 23e2abb7390731963e44e6ebdcb5bedd5d27e57f
-  data.tar.gz: 9a9489f4884a201b605276a00020608dd3a64818
+SHA256:
+  metadata.gz: 69ed394ec8286280a4b97265fb95dd36abb8bc5a57439ae1941963105186a433
+  data.tar.gz: f46c8d171e7b3c5e2771cf58358db711b3fe3b1c05b1a55b5bff79da76485bab
 SHA512:
-  metadata.gz: 72a08348248dd5590983fc017f4c6852fd47d566a17f15e23602f1cb86548ad518392bf62fe860e3229d388ec52a55c3bff3f0139ce4c81f92492361b659057b
-  data.tar.gz: 3349f620649fad89b2767ad4ff1be60e443459b212d2cf7b236122897f85de603db9b0e5d73a5a7366a50443cb04e936cd511e2ff8a1aae5cb9f940d38a139a2
+  metadata.gz: 7e44c0cf8d1026f64f4dc75b8c5e6bda0f684c5ea8a5359f3238a057b5427562f819f5762a563f85989d450b3a1593a2d730797f25202276685667b6ccebb7a4
+  data.tar.gz: cfa4245b61895fad5fd22449e56933cfa001adeb140412ac298807aeb3fc4f12335737f748959c50c18140f68b494148745ae072821e8057d7062898607bf2ee

data/.gitignore

@@ -1,4 +1,3 @@
-test/Torbafile
 /.bundle/
 /.yardoc
 /Gemfile.lock

data/.travis.yml

@@ -4,6 +4,10 @@ rvm:
   - 2.0.0
   - 2.1
   - 2.2
-  - jruby-19mode
-  - rbx-2
+  - 2.3
+  - 2.4
+  - 2.5
+  - 2.6
+  - 2.7
+  - jruby
 bundler_args: --without doc debug

data/.yardopts

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

data/CHANGELOG.md

@@ -1,5 +1,64 @@
 ## Unreleased
 
+## Version 1.1.0
+
+### Enhancements
+
+* Thor dependency has been relaxed to support Rails 6.x.
+
+## Version 1.0.1
+
+### Bug fixes
+
+* Fix unpacking tar.gz when running on unpriveleged containers
+
+## 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
+
+* `torba show` command
+* `torba open` command
+
+## Version 0.6.0
+
+### Enhancements
+
+* Torba.cache_path= setter
+
+### Bug fixes
+
+* Handle stylesheets that mention nonexisting assets (e.g. with SCSS variables)
+
 ## Version 0.5.1
 
 ### Bug fixes

data/README.md

@@ -17,7 +17,7 @@ Production ready.
 
 ## Documentation
 
-[Released version](http://rubydoc.info/gems/torba/0.5.1)
+[Released version](http://rubydoc.info/gems/torba/1.1.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.rb

@@ -30,6 +30,14 @@ module Torba
     @cache_path ||= ENV["TORBA_CACHE_PATH"] || File.join(home_path, "cache")
   end
 
+  # Override cache path with a new value
+  # @param val [String] new cache path
+  # @return [void]
+  # @since 0.6.0
+  def self.cache_path=(val)
+    @cache_path = val
+  end
+
   # @return [Ui]
   def self.ui
     @ui ||= Ui.new
@@ -70,6 +78,12 @@ module Torba
     Digest::SHA1.hexdigest(string)[0..7]
   end
 
+  # @see Manifest#find_packages_by_name
+  # @since 0.7.0
+  def self.find_packages_by_name(name)
+    manifest.find_packages_by_name(name)
+  end
+
   # @yield a block, converts common exceptions into useful messages
   def self.pretty_errors
     yield
@@ -90,7 +104,7 @@ module Torba
     ui.suggest "Make sure that the path has trailing '/' if its a directory."
     exit(false)
   rescue Errors::AssetNotFound => e
-    ui.error "Couldn't find an asset with path '#{e.message}'."
+    ui.error "Unknown asset to process with path '#{e.message}'."
     ui.suggest "Make sure that you've imported all image/font assets mentioned in a stylesheet(-s)."
     exit(false)
   end

data/lib/torba/cli.rb

@@ -1,4 +1,5 @@
 require "thor"
+require "shellwords"
 require "torba"
 
 module Torba
@@ -15,5 +16,49 @@ module Torba
       Torba.pretty_errors { Torba.verify }
       Torba.ui.confirm "Torba is prepared!"
     end
+
+    desc "show PACKAGE", "show the source location of a particular package"
+    def show(name)
+      Torba.pretty_errors do
+        Torba.pack
+        Torba.ui.info(find_package(name).load_path)
+      end
+    end
+
+    desc "open PACKAGE", "open a particular package in editor"
+    def open(name)
+      editor = [ENV["TORBA_EDITOR"], ENV["VISUAL"], ENV["EDITOR"]].find { |e| !e.nil? && !e.empty? }
+      unless editor
+        Torba.ui.error("To open a package, set $EDITOR or $TORBA_EDITOR")
+        exit(false)
+      end
+
+      Torba.pretty_errors do
+        Torba.pack
+
+        command = Shellwords.split(editor) << find_package(name).load_path
+        system(*command) || Torba.ui.error("Could not run '#{command.join(" ")}'")
+      end
+    end
+
+    private
+
+    def find_package(name)
+      packages = Torba.find_packages_by_name(name)
+      case packages.size
+      when 0
+        Torba.ui.error "Could not find package '#{name}'."
+        exit(false)
+      when 1
+        packages.first
+      else
+        index = Torba.ui.choose_one(packages.map(&:name))
+        if index
+          packages[index]
+        else
+          exit(false)
+        end
+      end
+    end
   end
 end

data/lib/torba/css_url_to_erb_asset_path.rb

@@ -52,7 +52,11 @@ module Torba
       content.gsub(URL_RE) do
         absolute_image_file_path = File.expand_path($2, File.dirname(file_path))
         sprockets_file_path = yield absolute_image_file_path
-        "#{$1}<%= asset_path('#{sprockets_file_path}') %>#{$3}"
+        if sprockets_file_path
+          "#{$1}<%= asset_path('#{sprockets_file_path}') %>#{$3}"
+        else
+          $&
+        end
       end
     end
   end

data/lib/torba/manifest.rb

@@ -15,6 +15,7 @@ module Torba
       end
     end
   end
+
   # Represents Torbafile.
   class Manifest
     # all packages defined in Torbafile
@@ -28,7 +29,7 @@ module Torba
     #
     # @overload self.build
     #   Reads Torbafile from current directory
-    def self.build(file_path = nil)
+    def self.build(file_path = ENV["TORBA_FILE"])
       file_path ||= File.join(Dir.pwd, "Torbafile")
 
       manifest = new
@@ -120,5 +121,14 @@ module Torba
         raise Errors::MissingPackages.new(missing)
       end
     end
+
+    # @return [Array<Package>] where each package name at least partially matches given name.
+    # @since 0.7.0
+    def find_packages_by_name(name)
+      re = Regexp.new(name, Regexp::IGNORECASE)
+      packages.find_all do |package|
+        package.name =~ re
+      end
+    end
   end
 end

data/lib/torba/package.rb

@@ -155,18 +155,22 @@ module Torba
     end
 
     def process_stylesheets
-      import_list.css_assets.each do |asset|
-        content = File.read(asset.absolute_path)
-
-        new_content = CssUrlToErbAssetPath.call(content, asset.absolute_path) do |image_file_path|
-          image_asset = import_list.find_by_absolute_path(image_file_path)
-          image_asset.logical_path
+      import_list.css_assets.each do |css_asset|
+        content = File.read(css_asset.absolute_path)
+
+        new_content = CssUrlToErbAssetPath.call(content, css_asset.absolute_path) do |asset_file_path|
+          if File.exist?(asset_file_path)
+            asset = import_list.find_by_absolute_path(asset_file_path)
+            asset.logical_path
+          else
+            nil
+          end
         end
 
         if content == new_content
-          new_absolute_path = File.join(load_path, asset.logical_path)
+          new_absolute_path = File.join(load_path, css_asset.logical_path)
         else
-          new_absolute_path = File.join(load_path, asset.logical_path + ".erb")
+          new_absolute_path = File.join(load_path, css_asset.logical_path + ".erb")
         end
 
         ensure_directory(new_absolute_path)

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