torba 0.1.0

data/lib/torba/rails.rb

@@ -0,0 +1,7 @@
+module Torba
+  class Engine < Rails::Engine
+    initializer "torba.assets" do |app|
+      Rails.application.config.assets.paths.concat(Torba.load_path)
+    end
+  end
+end

data/lib/torba/remote_sources/common.rb

@@ -0,0 +1,33 @@
+module Torba
+  module RemoteSources
+    module Common
+      # Expands pattern inside content of the remote source.
+      # @return [Array<Array(String, String)>] where first element of the tuple is an absolute
+      #   path to cached file and second element is the same path relative to cache directory.
+      # @param pattern [String] see {http://www.rubydoc.info/stdlib/core/Dir#glob-class_method Dir.glob}
+      #   for pattern examples
+      # @note Unlike Dir.glob doesn't include directories.
+      def [](pattern)
+        ensure_cached
+
+        Dir.glob(File.join(cache_path, pattern)).reject{ |path| File.directory?(path) }.map do |path|
+          [path, path.sub(/#{cache_path}\/?/, "")]
+        end
+      end
+
+      def digest
+        raise NotImplementedError
+      end
+
+      private
+
+      def cache_path
+        raise NotImplementedError
+      end
+
+      def ensure_cached
+        raise NotImplementedError
+      end
+    end
+  end
+end

data/lib/torba/remote_sources/github_release.rb

@@ -0,0 +1,26 @@
+require "torba/remote_sources/zip"
+
+module Torba
+  module RemoteSources
+    # Represents {https://help.github.com/articles/about-releases/ Github release}.
+    class GithubRelease < Zip
+      # @return [String] repository user and name.
+      # @example
+      #   "jashkenas/underscore"
+      attr_reader :source
+
+      # @return [String] repository tag.
+      # @example
+      #   "v1.8.3"
+      attr_reader :tag
+
+      # @param source see {#source}
+      # @param tag see {#tag}
+      def initialize(source, tag)
+        @source = source
+        @tag = tag
+        super("https://github.com/#{source}/archive/#{tag}.zip")
+      end
+    end
+  end
+end

data/lib/torba/remote_sources/zip.rb

@@ -0,0 +1,65 @@
+require "tempfile"
+require "fileutils"
+
+require "torba/remote_sources/common"
+
+module Torba
+  module Errors
+    ShellCommandFailed = Class.new(StandardError)
+  end
+
+  module RemoteSources
+    # Represents remote zip archive.
+    class Zip
+      include Common
+
+      attr_reader :url
+
+      def initialize(url)
+        @url = url
+      end
+
+      def digest
+        Torba.digest(url)
+      end
+
+      private
+
+      def cache_path
+        @cache_path ||= File.join(Torba.cache_path, digest)
+      end
+
+      def ensure_cached
+        unless Dir.exist?(cache_path)
+          FileUtils.mkdir_p(cache_path)
+
+          tempfile = Tempfile.new("torba")
+          tempfile.close
+
+          Torba.ui.info "downloading '#{url}'"
+
+          [
+            "curl -L -o #{tempfile.path} #{url}",
+            "unzip -oqq -d #{cache_path} #{tempfile.path}",
+          ].each do |command|
+            system(command) || raise(Errors::ShellCommandFailed.new(command))
+          end
+
+          get_rid_of_top_level_directory
+        end
+      rescue
+        FileUtils.rm_rf(cache_path)
+        raise
+      end
+
+      def get_rid_of_top_level_directory
+        top_level_content = Dir.glob("#{cache_path}/*")
+        if top_level_content.size == 1 && File.directory?(top_level_content.first)
+          top_level_dir = top_level_content.first
+          FileUtils.cp_r("#{top_level_dir}/.", cache_path)
+          FileUtils.rm_rf(top_level_dir)
+        end
+      end
+    end
+  end
+end

data/lib/torba/ui.rb

@@ -0,0 +1,26 @@
+require "thor/shell"
+
+module Torba
+  # Thin wrapper around Thor::Shell.
+  class Ui
+    def initialize
+      @shell = Thor::Base.shell.new
+    end
+
+    def info(message)
+      @shell.say(message)
+    end
+
+    def confirm(message)
+      @shell.say(message, :green)
+    end
+
+    def suggest(message)
+      @shell.say(message, :yellow)
+    end
+
+    def error(message)
+      @shell.say(message, :red)
+    end
+  end
+end

data/lib/torba/verify.rb

@@ -0,0 +1,2 @@
+require "torba"
+Torba.pretty_errors { Torba.verify }

data/lib/torba.rb

@@ -0,0 +1,80 @@
+require "digest"
+
+require "torba/ui"
+require "torba/manifest"
+
+# @since 0.1.0
+module Torba
+  # @return [String] root path to prepared asset packages. By default it's ".torba" within
+  #   your OS home directory (i.e. packages are shared between projects).
+  # @note use "TORBA_HOME_PATH" env variable to override default value
+  def self.home_path
+    @home_path ||= ENV["TORBA_HOME_PATH"] || File.join(Dir.home, ".torba")
+  end
+
+  # Override home path with a new value
+  # @param val [String] new home path
+  # @return [void]
+  def self.home_path=(val)
+    @home_path = val
+  end
+
+  # @return [String] root path to downloaded yet unprocessed asset packages. By default
+  #   it's "cache" within {.home_path}.
+  # @note use "TORBA_CACHE_PATH" env variable to override default value
+  def self.cache_path
+    @cache_path ||= ENV["TORBA_CACHE_PATH"] || File.join(home_path, "cache")
+  end
+
+  # @return [Ui]
+  def self.ui
+    @ui ||= Ui.new
+  end
+
+  # @return [Manifest]
+  def self.manifest
+    @manifest ||= Manifest.build
+  end
+
+  # @see Manifest#pack
+  def self.pack
+    manifest.pack
+  end
+
+  # @see Manifest#load_path
+  def self.load_path
+    manifest.load_path
+  end
+
+  # @see Manifest#verify
+  def self.verify
+    manifest.verify
+  end
+
+  # @return [String] unique short fingerprint/hash for given string
+  # @param [String] string to be hashed
+  #
+  # @example
+  #   Torba.digest("path/to/hash") #=> "23e3e63c"
+  def self.digest(string)
+    Digest::SHA1.hexdigest(string)[0..7]
+  end
+
+  # @yield a block, converts common exceptions into useful messages
+  def self.pretty_errors
+    yield
+  rescue Torba::Errors::UnbuiltPackage
+    ui.error "Your Torba is not packed yet."
+    ui.suggest "Run `bundle exec torba pack` to install missing packages."
+    exit(false)
+  rescue Torba::Errors::NothingToImport => e
+    ui.error "Couldn't import an asset(-s) '#{e.path}' from import list in '#{e.package}'."
+    ui.suggest "Check for typos."
+    ui.suggest "Make sure that the path has trailing '/' if its a directory."
+    exit(false)
+  rescue Torba::Errors::AssetNotFound => e
+    ui.error "Couldn't found an asset with path '#{e.message}'."
+    ui.suggest "Make sure that you've imported all image assets mentioned in a stylesheet(-s)."
+    exit(false)
+  end
+end

data/test/Torbafile

@@ -0,0 +1,5 @@
+gh_release "trumbowyg", source: "torba-rb/Trumbowyg", tag: "1.1.7", import: %w[
+  dist/trumbowyg.js
+  dist/ui/*.css
+  dist/ui/images/
+]

data/test/acceptance_test.rb

@@ -0,0 +1,26 @@
+require "test_helper"
+
+module Torba
+  class AcceptanceTest < Minitest::Test
+    def manifest
+      @manifest ||= Manifest.build("test/Torbafile")
+    end
+
+    def assert_exists(file_path)
+      super File.join(manifest.load_path, file_path)
+    end
+
+    def test_pack
+      manifest.pack
+
+      assert_exists "trumbowyg/trumbowyg.js"
+      assert_exists "trumbowyg/trumbowyg.css.erb"
+      assert_exists "trumbowyg/icons.png"
+      assert_exists "trumbowyg/icons-2x.png"
+
+      css = File.read File.join(manifest.load_path, "trumbowyg/trumbowyg.css.erb")
+      assert_includes css, "background: transparent url('<%= asset_path('trumbowyg/icons.png') %>') no-repeat;"
+      assert_includes css, "background-image: url('<%= asset_path('trumbowyg/icons-2x.png') %>')"
+    end
+  end
+end

data/test/css_url_to_erb_asset_path_test.rb

@@ -0,0 +1,75 @@
+require "test_helper"
+
+module Torba
+  class CssUrlToErbAssetPathTest < Minitest::Test
+    def filter
+      CssUrlToErbAssetPath
+    end
+
+    def test_no_url
+      css = "p { margin: 0; }"
+      assert_equal css, filter.call(css, "/current/file")
+    end
+
+    def test_url_with_data
+      css = "background-image: url(data:image/svg+xml;base64,PHN2ZyB4bWxucz0iaskip);"
+      assert_equal css, filter.call(css, "/current/file")
+    end
+
+    def test_absolute_url
+      css = "background-image: url('/icons.png');"
+      assert_equal "background-image: url('/icons.png');", filter.call(css, "/current_file")
+    end
+
+    def test_stylesheet_and_image_in_same_directory
+      current_file = "/home/package/dist/ui/stylesheet.css"
+      css = "background-image: url('icons.png');"
+
+      new_content = filter.call(css, current_file) do |image_full_url|
+        assert_equal "/home/package/dist/ui/icons.png", image_full_url
+        "ui/icons.png"
+      end
+      assert_equal "background-image: url('<%= asset_path('ui/icons.png') %>');", new_content
+    end
+
+    def test_url_double_quotes
+      current_file = "/home/package/dist/ui/stylesheet.css"
+      css = 'background-image: url("icons.png");'
+
+      filter.call(css, current_file) do |image_full_url|
+        assert_equal "/home/package/dist/ui/icons.png", image_full_url
+      end
+    end
+
+    def test_minified
+      current_file = "/home/package/dist/ui/stylesheet.css"
+      css = ".image{background-image:url(icons.png)}.border{border(1px solid)};"
+
+      filter.call(css, current_file) do |image_full_url|
+        assert_equal "/home/package/dist/ui/icons.png", image_full_url
+      end
+    end
+
+    def test_stylesheet_and_image_in_sibling_directories
+      current_file = "/home/package/dist/ui/stylesheet.css"
+      css = "background-image: url('../images/icons.png');"
+
+      new_content = filter.call(css, current_file) do |image_full_url|
+        assert_equal "/home/package/dist/images/icons.png", image_full_url
+        "images/icons.png"
+      end
+      assert_equal "background-image: url('<%= asset_path('images/icons.png') %>');", new_content
+    end
+
+    def test_image_in_child_directory_of_stylesheet
+      current_file = "/home/package/dist/ui/stylesheet.css"
+      css = "background-image: url('./images/icons.png');"
+
+      new_content = filter.call(css, current_file) do |image_full_url|
+        assert_equal "/home/package/dist/ui/images/icons.png", image_full_url
+        "ui/images/icons.png"
+      end
+      assert_equal "background-image: url('<%= asset_path('ui/images/icons.png') %>');", new_content
+    end
+  end
+end

data/test/import_list_test.rb

@@ -0,0 +1,39 @@
+require "test_helper"
+
+module Torba
+  class ImportListTest < Minitest::Test
+    def test_find_by_absolute_path
+      item = ImportList::Asset.new("/dir/subdir/file.jpg", "file.jpg")
+      list = ImportList.new([item])
+
+      found = list.find_by_absolute_path("/dir/subdir/file.jpg")
+      assert_equal item, found
+    end
+
+    def test_find_by_absolute_path_missing
+      list = ImportList.new([])
+
+      assert_raises(Errors::AssetNotFound) do
+        list.find_by_absolute_path("file.jpg")
+      end
+    end
+
+    def js_asset
+      ImportList::Asset.new("/dir/script.js", "script.js")
+    end
+
+    def css_asset
+      ImportList::Asset.new("/dir/stylesheet.css", "stylesheet.css")
+    end
+
+    def test_css_assets
+      list = ImportList.new([js_asset, css_asset])
+      assert [css_asset], list.css_assets
+    end
+
+    def test_non_css_assets
+      list = ImportList.new([js_asset, css_asset])
+      assert [js_asset], list.non_css_assets
+    end
+  end
+end

data/test/manifest_test.rb

@@ -0,0 +1,54 @@
+require "test_helper"
+
+module Torba
+  class ManifestTest < Minitest::Test
+    def manifest
+      @manifest ||= Manifest.new
+    end
+
+    def test_zip
+      manifest.zip "angular", url: "http://angularjs.com/angularjs.zip"
+
+      assert_equal 1, manifest.packages.size
+
+      package = manifest.packages.first
+      assert_equal "angular", package.name
+
+      remote = package.remote_source
+      assert_instance_of RemoteSources::Zip, remote
+      assert_equal "http://angularjs.com/angularjs.zip", remote.url
+    end
+
+    def test_zip_wo_url
+      assert_raises(KeyError) do
+        manifest.zip "angular"
+      end
+    end
+
+    def test_gh_release
+      manifest.gh_release "underscore", source: "jashkenas/underscore", tag: "1.8.3"
+
+      assert_equal 1, manifest.packages.size
+
+      package = manifest.packages.first
+      assert_equal "underscore", package.name
+
+      remote = package.remote_source
+      assert_instance_of RemoteSources::GithubRelease, remote
+      assert_equal "jashkenas/underscore", remote.source
+      assert_equal "1.8.3", remote.tag
+    end
+
+    def test_gh_release_wo_source
+      assert_raises(KeyError) do
+        manifest.gh_release "underscore", tag: "1.8.3"
+      end
+    end
+
+    def test_gh_release_wo_tag
+      assert_raises(KeyError) do
+        manifest.gh_release "underscore", source: "jashkenas/underscore"
+      end
+    end
+  end
+end

data/test/package/import_list_test.rb

@@ -0,0 +1,143 @@
+require "test_helper"
+require "fileutils"
+require "torba/remote_sources/common"
+
+module Torba
+  class PackageImportListTest < Minitest::Test
+    def source_dir
+      @source_dir ||= begin
+        dir = File.join(Torba.home_path, "source")
+        FileUtils.mkdir_p(dir)
+        dir
+      end
+    end
+
+    def touch(path)
+      absolute_path = File.join(source_dir, path)
+      FileUtils.mkdir_p(File.dirname(absolute_path))
+      FileUtils.touch(absolute_path)
+    end
+
+    class RemoteSource
+      include RemoteSources::Common
+
+      attr_reader :cache_path
+
+      def initialize(cache_path)
+        @cache_path = cache_path
+      end
+
+      def ensure_cached; end
+    end
+
+    def remote_source
+      @remote_source ||= RemoteSource.new(source_dir)
+    end
+
+    def test_single_file_path
+      touch("hello.js")
+
+      list = Package.new("package", remote_source, import: ["hello.js"]).import_list
+      assert_equal 1, list.assets.size
+      item = list.assets.first
+      assert_equal "hello.js", item.subpath
+      assert_equal File.join(source_dir, "hello.js"), item.absolute_path
+    end
+
+    def test_single_file_path_with_subdir
+      touch("build/hello.js")
+
+      list = Package.new("package", remote_source, import: ["build/hello.js"]).import_list
+      assert_equal 1, list.assets.size
+      item = list.assets.first
+      assert_equal "hello.js", item.subpath
+      assert_equal File.join(source_dir, "build/hello.js"), item.absolute_path
+
+      touch("build/standalone/hello.js")
+
+      list = Package.new("package", remote_source, import: ["build/standalone/hello.js"]).import_list
+      assert_equal 1, list.assets.size
+      item = list.assets.first
+      assert_equal "hello.js", item.subpath
+      assert_equal File.join(source_dir, "build/standalone/hello.js"), item.absolute_path
+    end
+
+    def test_directory
+      touch("build/standalone/hello.js")
+
+      list = Package.new("package", remote_source, import: ["build/"]).import_list
+      assert_equal 1, list.assets.size
+      item = list.assets.first
+      assert_equal "standalone/hello.js", item.subpath
+      assert_equal File.join(source_dir, "build/standalone/hello.js"), item.absolute_path
+
+
+      list = Package.new("package", remote_source, import: ["build/standalone/"]).import_list
+      assert_equal 1, list.assets.size
+      item = list.assets.first
+      assert_equal "hello.js", item.subpath
+      assert_equal File.join(source_dir, "build/standalone/hello.js"), item.absolute_path
+    end
+
+    def test_multiple_files
+      touch("build/images/first.png")
+      touch("build/images/second.png")
+
+      list = Package.new("package", remote_source, import: ["build/"]).import_list
+      assert_equal 2, list.assets.size
+
+      first_item = list.assets[0]
+      assert_equal "images/first.png", first_item.subpath
+      assert_equal File.join(source_dir, "build/images/first.png"), first_item.absolute_path
+
+      second_item = list.assets[1]
+      assert_equal "images/second.png", second_item.subpath
+      assert_equal File.join(source_dir, "build/images/second.png"), second_item.absolute_path
+    end
+
+    def test_multiple_import_paths
+      touch("images/one.jpg")
+      touch("js/script.js")
+
+      list = Package.new("package", remote_source, import: ["images/", "js/script.js"]).import_list
+      assert_equal 2, list.assets.size
+
+      first_item = list.assets[0]
+      assert_equal "one.jpg", first_item.subpath
+      assert_equal File.join(source_dir, "images/one.jpg"), first_item.absolute_path
+
+      second_item = list.assets[1]
+      assert_equal "script.js", second_item.subpath
+      assert_equal File.join(source_dir, "js/script.js"), second_item.absolute_path
+    end
+
+    def test_glob_pattern
+      touch("js/hello.js")
+      touch("build/css/bye.css")
+
+      list = Package.new("package", remote_source, import: ["**/*.{js,coffee}"]).import_list
+      assert_equal 1, list.assets.size
+      item = list.assets.first
+      assert_equal "js/hello.js", item.subpath
+      assert_equal File.join(source_dir, "js/hello.js"), item.absolute_path
+
+      list = Package.new("package", remote_source, import: ["build/**/*.css"]).import_list
+      assert_equal 1, list.assets.size
+      item = list.assets.first
+      assert_equal "css/bye.css", item.subpath
+      assert_equal File.join(source_dir, "build/css/bye.css"), item.absolute_path
+    end
+
+    def test_missing_file
+      assert_raises(Torba::Errors::NothingToImport) do
+        Package.new("package", remote_source, import: ["hello.js"]).import_list
+      end
+
+      touch("hello.js")
+
+      assert_raises(Torba::Errors::NothingToImport) do
+        Package.new("package", remote_source, import: ["hello.js", "another_missing.js"]).import_list
+      end
+    end
+  end
+end

data/test/remote_sources/github_release_test.rb

@@ -0,0 +1,21 @@
+require "test_helper"
+
+module Torba
+  class GithubReleaseTest < Minitest::Test
+    def remote
+      RemoteSources::GithubRelease.new("repo/user", "v.2.0.0")
+    end
+
+    def test_source
+      assert_equal "repo/user", remote.source
+    end
+
+    def test_tag
+      assert_equal "v.2.0.0", remote.tag
+    end
+
+    def test_url
+      assert_equal "https://github.com/repo/user/archive/v.2.0.0.zip", remote.url
+    end
+  end
+end

data/test/remote_sources/zip_test.rb

@@ -0,0 +1,21 @@
+require "test_helper"
+
+module Torba
+  class ZipTest < Minitest::Test
+    def test_url
+      remote = RemoteSources::Zip.new("http://jquery.com/jquery.zip")
+      assert_equal "http://jquery.com/jquery.zip", remote.url
+    end
+
+    def test_digest
+      remote = RemoteSources::Zip.new("http://jquery.com/jquery.zip")
+      same_remote = RemoteSources::Zip.new("http://jquery.com/jquery.zip")
+
+      assert_equal remote.digest, same_remote.digest
+
+      another_remote = RemoteSources::Zip.new("http://angularjs.com/angular.zip")
+
+      refute_equal remote.digest, another_remote.digest
+    end
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,37 @@
+require "bundler/setup"
+require "torba"
+
+require "minitest/autorun"
+require "tmpdir"
+
+module Torba
+  module Test
+    module TempHome
+      def before_setup
+        Torba.home_path = @_torba_tmp_dir = Dir.mktmpdir("torba")
+        super
+      end
+
+      def after_teardown
+        FileUtils.rm_rf(@_torba_tmp_dir)
+        Torba.home_path = nil
+        super
+      end
+    end
+
+    module AssertExists
+      def assert_exists(file_path)
+        assert File.exists?(file_path)
+      end
+
+      def refute_exists(file_path)
+        refute File.exists?(file_path)
+      end
+    end
+  end
+end
+
+class Minitest::Test
+  include Torba::Test::TempHome
+  include Torba::Test::AssertExists
+end