Class: Torba::Package

Inherits:
Object
  • Object
show all
Defined in:
lib/torba/package.rb

Overview

Represents remote source with explicit paths/files to be imported (i.e. copied from an archive, git repository etc). Stylesheets (if any) are treated specially because static “url(…)” definitions should be replaced with Sprockets-aware “asset_path” helpers.

Since:

  • 0.1.0

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(name, remote_source, options = {}) ⇒ Package

Returns a new instance of Package.

Parameters:

  • name (String) —

    see #name

  • remote_source (#[]) —

    see #remote_source

  • options (Hash) (defaults to: {})

Options Hash (options):

Since:

  • 0.1.0



49
50
51
52
53
54
55
56
57
58
59
 
# File 'lib/torba/package.rb', line 49

def initialize(name, remote_source, options = {})
  @name = name
  @remote_source = remote_source
  @import_paths = (options[:import] || ["**/*"]).sort.map do |path|
    if path.end_with?("/")
      File.join(path, "**/*")
    else
      path
    end
  end
end

Instance Attribute Details

#import_paths ⇒ Array<String> (readonly)

Note:

Put in this list only files that are absolutely necessary to you as Manifest#non_js_css_logical_paths depends on it.

Returns list of file paths to import (relative to remote source root).

Examples:

Direct path to a file

["build/underscore.js"]

Dir.glob pattern

["build/*.js", "**/*.css"]

Any file within directory (including subdirectories)

["build/"] # same as ["build/**/*"]

Returns:

  • (Array<String>) —

    list of file paths to import (relative to remote source root).

See Also:

Since:

  • 0.1.0



43
44
45
 
# File 'lib/torba/package.rb', line 43

def import_paths
  @import_paths
end

#name ⇒ String (readonly)

Returns short package name, acts as as namespace within Sprockets’ load path. Doesn’t need to be equal to remote package name.

Returns:

  • (String) —

    short package name, acts as as namespace within Sprockets’ load path. Doesn’t need to be equal to remote package name.

Since:

  • 0.1.0



28
29
30
 
# File 'lib/torba/package.rb', line 28

def name
  @name
end

#remote_source ⇒ Object (readonly)

Returns instance that implements RemoteSources::Common.

Returns:

Since:

  • 0.1.0



31
32
33
 
# File 'lib/torba/package.rb', line 31

def remote_source
  @remote_source
end

Instance Method Details

#build ⇒ void

Note:

Directories explicitly specified in #import_paths are not preserved after importing, i.e. resulted file tree becomes flatten. This way you can omit build specific directories when requiring assets in your project. If you want to preserve remote source file tree, use glob patterns without mentioning subdirectories in them.

In addition #name is used as a namespace folder within #load_path to protect file names clashing across packages.

package.name #=> "datepicker"
package.import_paths #=> ["css/stylesheet.css", "js/*.js"]
Dir[package.load_path + "/**/*"] #=> ["datepicker/stylesheet.css", "datepicker/script.js"]

package.name #=> "datepicker"
package.import_paths #=> ["**/*.{js,css}"]
Dir[package.load_path + "/**/*"] #=> ["datepicker/css/stylesheet.css", "datepicker/js/script.js"]

This method returns an undefined value.

Cache remote source and import specified assets to #load_path.

Since:

  • 0.1.0



83
84
85
86
87
88
89
90
 
# File 'lib/torba/package.rb', line 83

def build
  return if built?
  process_stylesheets
  process_other_assets
rescue
  remove
  raise
end

#import_list ⇒ ImportList

Returns:

Since:

  • 0.1.0



113
114
115
 
# File 'lib/torba/package.rb', line 113

def import_list
  @import_list ||= build_import_list
end

#load_path ⇒ String

Returns path where processed files of the package reside. It’s located within Torba.home_path directory.

Returns:

  • (String) —

    path where processed files of the package reside. It’s located within Torba.home_path directory.

Since:

  • 0.1.0



94
95
96
 
# File 'lib/torba/package.rb', line 94

def load_path
  @load_path ||= File.join(Torba.home_path, folder_name)
end

#logical_paths ⇒ Array<String>

Returns logical paths that the package contains.

Returns:

Since:

  • 0.3.0



101
102
103
 
# File 'lib/torba/package.rb', line 101

def logical_paths
  import_list.assets.map(&:logical_path)
end

#non_js_css_logical_paths ⇒ Array<String>

Returns logical paths that the package contains except JS ans CSS.

Returns:

  • (Array<String>) —

    logical paths that the package contains except JS ans CSS.

Since:

  • 0.3.0



108
109
110
 
# File 'lib/torba/package.rb', line 108

def non_js_css_logical_paths
  import_list.non_js_css_assets.map(&:logical_path)
end

#remove ⇒ void

This method returns an undefined value.

Remove self from filesystem.

Since:

  • 0.1.0



119
120
121
 
# File 'lib/torba/package.rb', line 119

def remove
  FileUtils.rm_rf(load_path)
end

#verify ⇒ Object

Raises:

Since:

  • 0.1.0



62
63
64
 
# File 'lib/torba/package.rb', line 62

def verify
  raise Errors::UnbuiltPackage.new(name) unless built?
end