Adoptable Cookbooks List

Looking for a cookbook to adopt? You can now see a list of cookbooks available for adoption!
List of Adoptable Cookbooks

Supermarket Belongs to the Community

Supermarket belongs to the community. While Chef has the responsibility to keep it running and be stewards of its functionality, what it does and how it works is driven by the community. The chef/supermarket repository will continue to be where development of the Supermarket application takes place. Come be part of shaping the direction of Supermarket by opening issues and pull requests or by joining us on the Chef Mailing List.

Select Badges

Select Supported Platforms

RSS

js (2) Versions 0.0.8

light weight resource for installing java script applications/libraries

Berkshelf/Librarian
Policyfile
Knife
cookbook 'js', '~> 0.0.8'
cookbook 'js', '~> 0.0.8', :supermarket
knife cookbook site install js
knife cookbook site download js
README
Dependencies
Quality

Description

light weight resource for installing java script applications/libraries

Requirements

  • tar
  • wget

Attributes

Usage

js_application 'my JavaScript application' do
    tarball 'http://some.ftp.host/my-application.tar.gz'
    install_base '/home/user/my-application/root/'
    dirs [ { :source => 'www_files'  } ]
    action :install
end

Resource parameters

  • tarball - http url to tarball where distribution files where are placed
  • cookbook - contrariwise one may store distribution files as cookbook's files in files/default/js-app directory. so 'cookbook' is the name of the cookbook, see 'Installing from cookbook files' section.

  • user - the owner for files to be installed, default value is nil

  • group - the group for files to be installed, default value is nil

  • install_base - installation root, default value is nil, so you need to define it or rely upon $PERL_MB_OPT environment var, see "Installing with default install_base"

  • document_root - will be added to install_base, default value is 'htdocs', so everything is installed into 'install_base/document_root/'

  • dirs - list of directories to be installed, see "Installing directories" section

  • files - list of files to be installed, see "Installing files" section

  • templates - list of templates to be installed, see "Installing templates" section

  • variables - hash of variables to get used in templates files and :destination template strings, see "Installing templates" and "Destination template strings" sections

  • cleanup - whether to delete "install_base/document_root" directory before installing, default value is 'false'

Examples of usage

Installing with default install_base

one my choose not to define install_base explicitly and setup environment via perl local::lib tool:

eval $(perl -Mlocal::lib=/home/user/my-application/root/)
chef-client

this will result in installing into '/home/user/my-application/root/'

Installing from tarball

tarball 'ftp://some.ftp.host/my-application.tar.gz'    

my-application.tar.gz should contain 'my-application' directory - standard way of packaging

Installing from cookbook files

cookbook 'my-application'

cookbook 'my-application' should contain files/default/js-app/ directory with files to install and is treated as chef remote_directory resource

Installing from local source

local_source_dir '/home/user/src/my-application/'

local_source_dir should be directory with files to install, this way of installing is used in cucumber tests

Installing files

files [
    { :source => 'web_files/index.html', },
    { :source => 'web_files/css/main.css', :destination => 'css/' }
    { :source => 'web_files/img/picture.gif', :destination => 'images/my_picture.gif' }
]

this will install files:

  • 'web_files/index.html' as 'install_base/document_root/index.html'
  • 'web_files/css/main.css' as 'install_base/document_root/css/main.css'
  • 'web_files/img/picture.gif' as 'install_base/document_root/images/my_picture.gif'

Installing directories

dirs [
    { :source => 'web_files', },
    { :source => 'css', :destination => 'css2/' }
]

this will install directories content:

  • 'web_files/' into 'install_base/document_root/'
  • 'css/' into 'install_base/document_root/css2/'

Installing templates

in the way of installing templates are the files. The only difference variables gets interpolated into templates content:

templates [
    { :source => 'templates/index.erb', :destination => 'index.html' }
]
variables => {
    :foo => 'foo-value'
}

this will install template 'templates/index.erb' as 'install_base/document_root/index.html' and given that template contains "<%= @params[:foo] %>" :foo variable gets interpolated with 'foo-value'

Destination template strings

:destination keys in dir/files/templates lists could contain arbitrary numbers of %template% strings:

dirs [
    { :source => 'css', :destination => 'css/%prefix%' }
]

variables => {
    :prefix => 'beta'
}

this will install directories content 'css/' into 'install_base/document_root/css/beta/'

the only exception is %version% template string which result in a little bit different substitution:

dirs [
    { :source => 'css', :destination => '%version%/css' }
]

variables => {
    :version => '0.0.1'
}

this will install directories content 'css/' into 'install_base/document_root/version-0.0.1/css/', also version_dir variable will be passed into any templates

Changing document_root

by default document_root is 'htdocs', you can change it with:

document_root 'public'

Dependent cookbooks

This cookbook has no specified dependencies.

Contingent cookbooks

There are no cookbooks that are contingent upon this one.

Collaborator Number Metric
            

0.0.8 failed this metric

Failure: Cookbook has 0 collaborators. A cookbook must have at least 2 collaborators to pass this metric.

Contributing File Metric
            

0.0.8 failed this metric

Failure: To pass this metric, your cookbook metadata must include a source url, the source url must be in the form of https://github.com/user/repo, and your repo must contain a CONTRIBUTING.md file

Foodcritic Metric
            

0.0.8 failed this metric

FC016: LWRP does not declare a default action: js/resources/application.rb:1
FC059: LWRP provider does not declare use_inline_resources: js/providers/application.rb:1
FC064: Ensure issues_url is set in metadata: js/metadata.rb:1
FC065: Ensure source_url is set in metadata: js/metadata.rb:1
FC066: Ensure chef_version is set in metadata: js/metadata.rb:1
FC067: Ensure at least one platform supported in metadata: js/metadata.rb:1
Run with Foodcritic Version 11.1.0 with tags metadata,correctness ~FC031 ~FC045 and failure tags any

License Metric
            

0.0.8 failed this metric

js does not have a valid open source license.
Acceptable licenses include Apache-2.0, apachev2, Apache 2.0, MIT, mit, GPL-2.0, gplv2, GNU Public License 2.0, GPL-3.0, gplv3, GNU Public License 3.0.

No Binaries Metric
            

0.0.8 passed this metric

Publish Metric
            

0.0.8 passed this metric

Supported Platforms Metric
            

0.0.8 failed this metric

js should declare what platform(s) it supports.

Testing File Metric
            

0.0.8 failed this metric

Failure: To pass this metric, your cookbook metadata must include a source url, the source url must be in the form of https://github.com/user/repo, and your repo must contain a TESTING.md file

Version Tag Metric
            

0.0.8 failed this metric

Failure: To pass this metric, your cookbook metadata must include a source url, the source url must be in the form of https://github.com/user/repo, and your repo must include a tag that matches this cookbook version number