lyp 0.1.8 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f05a307478b3335dc0caa9e0d687b73ec0a1f4f3
-  data.tar.gz: e6811cd8a83c6b05a068ac1b494c41cd0f023917
+  metadata.gz: 95a3a0c7bde875ba4dc99f647f476f3c38c38edc
+  data.tar.gz: a2b2624b43aa5ce75c697c5f3fb29dd3b8141ca9
 SHA512:
-  metadata.gz: 76e91e59d3b126e5e002d7ff0e2df0983a0c59ed72bffd444615fe35a811a8bae2a9e5768aebb5a82372cc245a93bc1bc85250354b79ea87a87f862952f5b0e4
-  data.tar.gz: 471fa1026b5a75d2f4de797117c0f5cfb37872e97ef72b67b7e5855ebc9960ba5c06741f2723f74c97761e9bc77b931173e2b0f963a121da6ddefe8cbdd036b2
+  metadata.gz: 787384a486ddbb0f561404513cbda77fc783d5430428669d31021bf3c84878692fb4d13a2ee4bb0fe3a900ba46aa6711cf1815232b573272ca7b067d36cb12d9
+  data.tar.gz: 0dd250c4b5ce752610d59a17f14de1da74d7d91268cea0fb37cb90767a4395b74cefe88ce4d8a8865651d29c3fe2a45cb0d848d0668858567adad06be5b5872b

data/README.md

@@ -13,14 +13,18 @@ __No hassle Lilypond installation__: With lyp you can also install any version o
 - [Installation](#installation)
   - [How lyp works](#how-lyp-works)
   - [Uninstalling](#uninstalling)
-- [Lilypond packages](#lilypond-packages)
+- [Working with packages](#working-with-packages)
   - [What constitutes a package?](#what-constitutes-a-package)
   - [Installing packages](#installing-packages)
   - [Package references](#package-references)
   - [Version specifiers](#version-specifiers)
   - [Using packages](#using-packages)
-  - [Developing packages](#developing-packages)
-  - [Including files from within packages](#including-files-from-within-packages)
+- [Developing packages](#developing-packages)
+  - [The package interface](#the-package-interface)
+  - [Including files](#including-files)
+  - [Including fonts](#including-fonts)
+  - [Testing packages](#testing-packages)
+  - [Publishing packages](#publishing-packages)
 - [Installing and switching Lilypond versions](#installing-and-switching-lilypond-versions)
 - [Contributing](#contributing)
 
@@ -81,7 +85,7 @@ In order to completely remove all files in `~/.lyp` you can simply delete the di
 rm -rf ~/.lyp
 ```
 
-## Lilypond packages
+## Working with Packages
 
 A package is a library of lilypond code, containing one or more lilypond files, that provide commonly-used functionality for users. A package can be a library of scheme code to extend lilypond, as in openlilylib; or a stylesheet which contains music fonts and additional lilypond code to change the look of the music: font, spacing, line widths, sizes, etc.
 
@@ -181,7 +185,7 @@ To include a package in your lilypond code, use ther `\require` command:
 
 It is important to note that once you use `\require` in your code, you will have to compile it using the lilypond wrapper provided by lyp. It will not pass compilation using plain lilypond.
 
-### Developing packages
+## Developing packages
 
 To create a lilypond package:
 
@@ -191,7 +195,7 @@ To create a lilypond package:
 - Test & debug your code (see below).
 - Publish your package (see below).
 
-To test your package code, you can install it from a local path. Suppose your package is at ~/repo/mypack:
+To test your package with an actual input file, you can install it from a local path (for more on testing [see below](#testing)). Suppose your package is at ~/repo/mypack:
 
 ```bash
 lyp install mypack@dev:~/repo/mypack
@@ -203,29 +207,50 @@ This will create a `mypack@dev` package referencing your local files, which you
 \require "mypack@dev"
 ```
 
-### Including files from within packages
+### The package interface
 
-In order to facilitate writing complex packages, lyp defines a few lilypond commands and scheme variables and commands that allow using relative paths when including files from within packages.
+In order to facilitate writing complex packages, lyp defines a few variables and functions:
 
-The following variables are defined:
+- `lyp:current-package-dir` - the absolute directory path for the current package (at the time the package is loaded)
+- `lyp:input-filename` - the absolute path for the user's file being compiled
+- `lyp:input-dirname` - the absolute directory path for the user's file being compiled
 
-- `lyp-current-package-dir` - the absolute directory path for the current package
-- `lyp-input-filename` - the absolute path for the user's file being compiled
-- `lyp-input-dirname` - the absolute directory path for the user's file being compiled
-- `lyp-cwd` - the current working directory
+### Including files
 
-In addition, lyp provides the `\pinclude` command for including files residing in the current package using relative paths. The `\pinclude` commands loads a given file only once:
+Lyp provides the `\pinclude` and `\pincludeOnce` commands for including files residing in the current package using relative paths. The `\pincludeOnce` commands loads a given file only once:
 
 ```lilypond
-\pinclude "inc/init.ily"
+\pincludeOnce "inc/init.ily"
+\pinclude "inc/template.ily"
 ```
 
-And a `pload` scheme function for loading scheme files using relative paths without manipulating the `%load-path`:
+Lyp also defines a `pload` scheme function for loading scheme files using relative paths without adding directories to the `%load-path`:
 
 ```lilypond
 #(if (not (defined? 'mypack:init))(pload "scm/init.scm"))
 ```
 
+Loading scheme files that way is better, because this way one avoids possible name clashes, which may lead to unexpected behavior.
+
+### Including fonts
+
+Lyp also supports automatic installation of fonts, based on work by [Abraham Leigh](https://github.com/tisimst). When a package is installed, lyp will copy any font files residing in the `fonts` directory into the corresponding `otf` and `svg` directories of all installed versions of lilypond.
+
+**Note**: fonts will be only installed in versions of lilypond starting from than 2.18.2. Lyp automatically patches any version ower than 2.19.12 in order to support custom fonts. 
+
+### Testing Packages
+
+Packages can be tested by using the `lyp test` command, which will compile any file found inside the package directory ending in `_test.ly`:
+
+```bash
+cd mypack
+lyp test .
+```
+
+A test file can either be a simple lilypond file which includes the package files and results in a lilypond score, or a lilypond file that performs unit tests on scheme code.
+
+For more information on testing, see the [lyp-assert](https://github.com/noteflakes/lyp-assert) package, which is meant to be used for unit testing lilypond code, and serves as an example of how to test a package.
+
 ### Publishing packages
 
 In order for your package to be available to all users, you'll need to first push your code to a publically accessible git repository (for example on github). Users will then be able to install your package by using the git URL of the public repository.

data/bin/install_release.sh

@@ -21,7 +21,7 @@ download() {
 }
     
 WORKDIR="/tmp/lyp-release-installer"
-LYP_VERSION="0.1.4"
+LYP_VERSION="0.2.0"
 URL_BASE="https://github.com/noteflakes/lyp/releases/download/v$LYP_VERSION"
 
 PLATFORM=`uname -sp`

data/lib/lyp/package.rb

@@ -85,7 +85,7 @@ module Lyp::Package
     end
     
     LOCAL_PACKAGE_WRAPPER = 
-      "#(set! lyp-current-package-dir \"%s\")\n\\include \"%s\"\n"
+      "#(set! lyp:current-package-dir \"%s\")\n\\include \"%s\"\n"
     
     def install_from_local_files(package, version, opts)
       version =~ /^([^\:]+)\:(.+)$/

data/lib/lyp/templates/deps_wrapper.rb

@@ -16,26 +16,24 @@ current_package_dir = _[:current_package_dir] || FileUtils.pwd
 
 # The wrapper defines a few global variables:
 # 
-# lyp-input-filename      - the absolute path to the input file name
-# lyp-input-dirname       - the absolute path to the input file directory name
-# lyp-cwd                 - the current working directory
-# lyp-current-package-dir - the directory for the package currently being loaded
-# lyp-package-refs        - a hash table mapping package refs to package entry 
+# lyp:input-filename      - the absolute path to the input file name
+# lyp:input-dirname       - the absolute path to the input file directory name
+# lyp:current-package-dir - the directory for the package currently being loaded
+# lyp:package-refs        - a hash table mapping package refs to package entry 
 #                           point absolute paths
-# lyp-package-loaded      - a hash table for keeping track of loaded packages
-# lyp-file-included       - a hash table for keeping track of include files
+# lyp:package-loaded      - a hash table for keeping track of loaded packages
+# lyp:file-included       - a hash table for keeping track of include files
 
 `
 #(begin
-  (define lyp-input-filename "{{user_filename}}")
-  (define lyp-input-dirname "{{user_dirname}}")
-  (define lyp-cwd "{{FileUtils.pwd}}")
-  (define lyp-current-package-dir "{{current_package_dir}}")
-  (define lyp-package-refs (make-hash-table))`
+  (define lyp:input-filename "{{user_filename}}")
+  (define lyp:input-dirname "{{user_dirname}}")
+  (define lyp:current-package-dir "{{current_package_dir}}")
+  (define lyp:package-refs (make-hash-table))`
 
 _[:package_paths].each do |spec, path|
 `
-  (hash-set! lyp-package-refs "{{spec}}" "{{path}}")`
+  (hash-set! lyp:package-refs "{{spec}}" "{{path}}")`
 end
 
 # package-loaded is hash table used for tracking loaded packages, so each
@@ -45,8 +43,8 @@ end
 # package is loaded only once.
 
 `
-  (define lyp-package-loaded (make-hash-table))
-  (define lyp-file-included (make-hash-table))
+  (define lyp:package-loaded (make-hash-table))
+  (define lyp:file-included (make-hash-table))
 )
 `
 
@@ -55,20 +53,20 @@ end
 require = #(define-void-function (parser location package)(string?)
   (let* 
     (
-      (path (hash-ref lyp-package-refs package))
-      (loaded? (hash-ref lyp-package-loaded path))
+      (path (hash-ref lyp:package-refs package))
+      (loaded? (hash-ref lyp:package-loaded path))
       (package-dir (dirname path))
-      (prev-package-dir lyp-current-package-dir)
+      (prev-package-dir lyp:current-package-dir)
     )
     (if (and path (not loaded?)) (begin
       (if (not (file-exists? path)) (
         (ly:error "Failed to load package ~a (file not found ~a)" package path)
       ))
       (ly:debug "Loading package ~a at ~a" package package-dir)
-      (set! lyp-current-package-dir package-dir)
-      (hash-set! lyp-package-loaded path #t)
+      (set! lyp:current-package-dir package-dir)
+      (hash-set! lyp:package-loaded path #t)
       #{ \include #path #}
-      (set! lyp-current-package-dir prev-package-dir)
+      (set! lyp:current-package-dir prev-package-dir)
     ))
   )
 )
@@ -80,14 +78,29 @@ require = #(define-void-function (parser location package)(string?)
 pinclude = #(define-void-function (parser location path)(string?)
   (let* 
     (
-      (full-path (format "~a/~a" lyp-current-package-dir path))
-      (loaded? (hash-ref lyp-file-included full-path))
+      (full-path (format "~a/~a" lyp:current-package-dir path))
+    )
+    (begin
+      (if (not (file-exists? full-path)) (
+        (ly:error "File not found ~a" full-path)
+      ))
+      (hash-set! lyp:file-included full-path #t)
+      #{ \include #full-path #}
+    )
+  )
+)
+
+pincludeOnce = #(define-void-function (parser location path)(string?)
+  (let* 
+    (
+      (full-path (format "~a/~a" lyp:current-package-dir path))
+      (loaded? (hash-ref lyp:file-included full-path))
     )
     (if (and full-path (not loaded?)) (begin
       (if (not (file-exists? full-path)) (
         (ly:error "File not found ~a" full-path)
       ))
-      (hash-set! lyp-file-included full-path #t)
+      (hash-set! lyp:file-included full-path #t)
       #{ \include #full-path #}
     ))
   )
@@ -100,7 +113,7 @@ pinclude = #(define-void-function (parser location path)(string?)
 #(define (pload path)
   (let* 
     (
-      (full-path (format "~a/~a" lyp-current-package-dir path))
+      (full-path (format "~a/~a" lyp:current-package-dir path))
     )
     (load full-path)
   )

data/lib/lyp/version.rb

@@ -1,3 +1,3 @@
 module Lyp
-  VERSION = "0.1.8"
+  VERSION = "0.2.0"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: lyp
 version: !ruby/object:Gem::Version
-  version: 0.1.8
+  version: 0.2.0
 platform: ruby
 authors:
 - Sharon Rosner