lyp 0.0.2 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 84b01737c53394d03c21532706f716bc76dc2d5a
-  data.tar.gz: 419c7e10f0803a56bdbb8b93552134d6e9b93769
+  metadata.gz: 237b06c5018520e73c24a410d350343e806dd4c5
+  data.tar.gz: 67060615bc34efded14ca9ff3b1e8b9134c2f414
 SHA512:
-  metadata.gz: 06fedcc0128648cec7a4125e0f418c223a0b75bd461f3dc580e3645052da8c11f9a1cb56c580a23ecc3c7328efbc61a82c2f87a591ba522d7314cd9c928d24e2
-  data.tar.gz: f8495a11a1f8a7a7a1dcd42bcca97598049b6e77690e871f5e1b65d5822ac189fa1d967a630b26ba6a7c045d3cc964598ee2539ccb8c6a87cccac6673a59b546
+  metadata.gz: 4b9325b66427152575d3b7340c7bfea283cad9816d4a330defe75ab88ee6e2d9610b888e1a57b3010dd839455f794b344f7df18e2d3c96b81156edef5701db4b
+  data.tar.gz: cfa5bf20c687e24c95a2b7c225b0fb2afe00ffe34e8e06c19b12df583d42458173f3b0adfb9929f84357a80b9d2818174e5e3e588d2f32145a2c1a38b3f5a977

data/README.md

@@ -1,9 +1,95 @@
 [![Build Status](https://travis-ci.org/ciconia/lyp.svg?branch=master)](https://travis-ci.org/ciconia/lyp)
 
-# lyp
+# lyp - a package manager for lilypond
 
-lyp is a package manager for lilypond.
+lyp is a tool to install and manage packages for lilypond, and install versions of lilypond.
 
-Initial spec is [here](https://github.com/ciconia/lyp/wiki/General-spec).
+lyp lets you install lilypond packages that act as code libraries and can be used to enhance your lilypond files with additional functionality. Packages can depend on other packages. Lyp resolves the direct and transitive package dependencies, and selects the correct version to use for each package.
 
+With lyp you can also install any version of lilypond on your machine with a single command, without having to visit the lilypond website, clicking a link and then copying files around. In addition, lyp lets you install multiple versions of lilypond and easily switch between them.
 
+## What is a lilypond package?
+
+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.
+
+The difference between merely copying and including a lilypond file in your music, and using a lilypond package is that you can easily share your music file with anyone and let them compile your music without having to download and copy additional code. lyp takes care of installing and resolving any dependencies in your lilypond files, so that you can compile your lilypond files anywhere without schlepping around a bunch of include files. Also, because packages are versioned, repeatable compilation using external code becomes trivial. 
+
+## How to add a package to your lilypond file?
+
+Lilypond packages are simply git repositories. As such they can be identified by the repository's URL, or by the github repository path. To add a package dependency to your code, use the <code>\require</code> command:
+
+```lilypond
+\require "lypco/lilyjazz" % repository is at: github.com/lypco/lilyjazz
+\require "github.com/lypco/poormans_henle"
+```
+
+Versions can be specified either as specific versions, or as version specifiers which denote a range of versions:
+
+```lilypond
+\require "lypco/lilyjazz@0.3.2"
+
+% highest version higher than 0.3.2
+\require "lypco/lilyjazz@>=0.3.2"
+
+% highest version higher than 0.4.5 but lower than 0.5.0
+\require "lypco/lilyjazz@~>0.4.5"
+```
+
+Once the dependencies are specified, packages can be installed either using the <install> command:
+  
+```bash
+lyp install "lypco/lilyjazz@0.3.2" % OR:
+lyp install "lypco/lilyjazz@>=0.3.2"
+```
+
+... or the <code>resolve</code> command, which scans the user's file for dependencies and then installs them:
+
+```bash
+lyp resolve maitre_sans_marteau.ly
+```
+
+## Installation
+
+If you have Ruby on your machine, you can simply install the lyp gem, and run the install self command:
+
+```bash
+gem install lyp
+lyp install self
+```
+
+## Installing packages with lyp
+
+
+
+## Installing and managing versions of lilypond
+
+When installing lilypond, the specific version to download can be specified in different ways:
+
+```bash
+lyp install lilypond % latest stable version
+lyp install lilypond@stable % latest stable version
+lyp install lilypond@unstable % latest stable version
+lyp install lilypond@latest % latest version
+lyp install lilypond@2.18.1 % version 2.18.1
+lyp install lilypond@>=2.19.27 % highest version higher than 2.19.27
+lyp install lilypond@~>2.18.1 % highest 2.18 version higher than 2.18.1
+```
+
+To display all installed versions of lilypond, use the <code>list</code> command:
+  
+```bash
+lyp list lilypond
+```
+
+To switch between versions use the <code>use</code>. The same version specifiers could be used as for the <code>install</code> command:
+
+```bash
+lyp use lilypond@2.18.2 % or without the 'lilypond' identifier:
+lyp use stable % use latest stable version 
+```
+
+To show all versions available for download, use the <code>search</code> command:
+  
+```bash
+lyp search lilypond
+```

data/bin/lilypond

@@ -1,15 +1,19 @@
 #!/usr/bin/env ruby
 
-require File.expand_path("../lib/lyp/version", File.dirname(__FILE__))
+require 'lyp/version'
+require 'lyp/directories'
+require 'lyp/settings'
+require 'lyp/lilypond'
 
-require File.expand_path("../lib/lyp/directories", File.dirname(__FILE__))
-require File.expand_path("../lib/lyp/settings", File.dirname(__FILE__))
-require File.expand_path("../lib/lyp/lilypond", File.dirname(__FILE__))
+STDERR.puts "Lyp version #{Lyp::VERSION}"
 
 lilypond_path = Lyp::Lilypond.current_lilypond
+unless lilypond_path && File.file?(lilypond_path)
+  STDERR.puts "No version of lilypond found. To install lilypond run 'lyp install lilypond'."
+  exit 1
+end
 
 if (ARGV == ['-v']) || (ARGV == ['--warranty'])
-  puts "Lyp version #{Lyp::VERSION}"
   # Show lilypond version and exit
   exec("#{lilypond_path} #{ARGV.join(' ')}")
 end

data/bin/lyp

@@ -1,4 +1,5 @@
 #!/usr/bin/env ruby
 
+require "lyp"
 require "lyp/cli"
 

data/lib/lyp.rb

@@ -1,8 +1,6 @@
 %w{
-  output
-  env
-  
   directories
+  system
   settings
   
   template

data/lib/lyp/cli.rb

@@ -1,26 +1,5 @@
-require "lyp"
-require "lyp/version"
-
-INSTALL_MSG = <<EOF
-Lyp is currently not installed. In order to use lyp, ~/.lyp/bin has to
-be included in the shell $PATH.
-EOF
-
-# test installation
-unless Lyp::ENV.installed?
-  require 'highline'
-
-  cli = HighLine.new
-  STDERR.puts INSTALL_MSG.gsub("\n", " ")
-
-  if cli.agree("Would you like to install lyp now? (yes/no)")
-    Lyp::ENV.install!
-    STDERR.puts "To finish installation please open a new shell"
-    exit
-  end
-end
-
 require 'commander/import'
+require "lyp/version"
 
 program :name,            'lyp'
 program :version,         Lyp::VERSION

data/lib/lyp/cli/commands.rb

@@ -42,6 +42,8 @@ command :list do |c|
   c.syntax =      "list [PATTERN]"
   c.description = "Lists installed versions of packages whose name matches PATTERN"
   c.action do |args, opts|
+    Lyp::System.test_installed_status!
+
     pattern = args.first
     if pattern.nil? || pattern == 'lilypond'
       STDOUT.puts LILYPOND_PREAMBLE
@@ -57,6 +59,8 @@ command :compile do |c|
   c.syntax = "compile <FILE>"
   c.description = "Resolves package dependencies and invokes lilypond"
   c.action do |args, opts|
+    Lyp::System.test_installed_status!
+    
     begin
       raise "File not specified" if args.empty?
       Lyp::Lilypond.compile(ARGV[1..-1])
@@ -71,6 +75,8 @@ command :search do |c|
   c.syntax = "search <PATTERN>"
   c.description = "Search for a package or a version of lilypond"
   c.action do |args, opts|
+    Lyp::System.test_installed_status!
+
     pattern = args.first
     if pattern == 'lilypond'
       begin
@@ -89,17 +95,22 @@ command :install do |c|
   c.description = "Install a package or a version of lilypond"
   c.option "-d", "--default", "Set default version"
   c.action do |args, opts|
+    
     begin
       raise "No package specified" if args.empty?
       
       args.each do |package|
-        if package =~ /^lilypond(?:@(.+))?$/
+        case package
+        when 'self'
+          Lyp::System.install!
+        when /^lilypond(?:@(.+))?$/
+          Lyp::System.test_installed_status!
           Lyp::Lilypond.install($1, opts.__hash__)
         end
       end
-    rescue => e
-      STDERR.puts e.message
-      exit 1
+    # rescue => e
+    #   STDERR.puts e.message
+    #   exit 1
     end
   end
 end
@@ -110,6 +121,8 @@ command :use do |c|
   c.option "-d", "--default", "Set default version"
 
   c.action do |args, opts|
+    Lyp::System.test_installed_status!
+
     begin
       version = args.first
       if version =~ /^lilypond@(.+)$/
@@ -130,11 +143,17 @@ command :uninstall do |c|
   c.description = "Uninstall a package or version of lilypond"
 
   c.action do |args, opts|
+    Lyp::System.test_installed_status!
+
     begin
       raise "No package specified" if args.empty?
       
       args.each do |package|
-        if package =~ /^lilypond(?:@(.+))?$/
+        case package
+        when 'self'
+          Lyp::System.uninstall!
+        when /^lilypond(?:@(.+))?$/
+          Lyp::System.test_installed_status!
           Lyp::Lilypond.uninstall($1)
         end
       end

data/lib/lyp/directories.rb

@@ -1,26 +1,34 @@
+require 'fileutils'
+
 module Lyp
   # A package specifier is of the form <package>@<version specifier>, where
   # the version specifier can be simply a version number, or include an operator
   # before the version number. Accepted operators: >=, ~>
   PACKAGE_RE = /^([^@]+)(?:@(.+))?$/
 
-  LYPACK_DIRECTORY = File.expand_path('~/.lyp')
-  LYPACK_BIN_DIRECTORY = File.join(LYPACK_DIRECTORY, 'bin')
-  DEFAULT_PACKAGE_DIRECTORY = File.join(LYPACK_DIRECTORY, 'packages')
-  DEFAULT_LILYPONDS_DIRECTORY = File.join(LYPACK_DIRECTORY, 'lilyponds')
+  LYP_DIRECTORY = File.expand_path('~/.lyp')
+  LYP_BIN_DIRECTORY = File.join(LYP_DIRECTORY, 'bin')
+  DEFAULT_PACKAGE_DIRECTORY = File.join(LYP_DIRECTORY, 'packages')
+  DEFAULT_LILYPONDS_DIRECTORY = File.join(LYP_DIRECTORY, 'lilyponds')
   
   SETTINGS_FILENAME = 'settings.yml'
 
   def self.packages_dir
-    DEFAULT_PACKAGE_DIRECTORY
+    ensure_dir(DEFAULT_PACKAGE_DIRECTORY)
   end
   
   def self.lilyponds_dir
-    DEFAULT_LILYPONDS_DIRECTORY
+    ensure_dir(DEFAULT_LILYPONDS_DIRECTORY)
   end
 
   def self.settings_file
-    File.join(LYPACK_DIRECTORY, SETTINGS_FILENAME)
+    ensure_dir(LYP_DIRECTORY)
+    File.join(LYP_DIRECTORY, SETTINGS_FILENAME)
+  end
+  
+  def self.ensure_dir(dir)
+    FileUtils.mkdir_p(dir) unless File.directory?(dir)
+    dir
   end
 end
 

data/lib/lyp/lilypond.rb

@@ -135,7 +135,7 @@ module Lyp::Lilypond
       list = `which -a lilypond`
       list = list.lines.map {|f| f.chomp}.reject do |l|
         dir = File.dirname(l)
-        (dir == Lyp::LYPACK_BIN_DIRECTORY) || (dir == self_bin_dir)
+        (dir == Lyp::LYP_BIN_DIRECTORY) || (dir == self_bin_dir)
       end
     end
     
@@ -174,7 +174,8 @@ module Lyp::Lilypond
     def install(version_specifier, opts = {})
       version = detect_version_from_specifier(version_specifier)
       raise "No version found matching specifier #{version_specifier}" unless version
-
+      
+      STDERR.puts "Installing version #{version}" unless opts[:silent]
       install_version(version, opts)
 
       lilypond_path = "#{Lyp.lilyponds_dir}/#{version}/bin/lilypond"
@@ -186,7 +187,7 @@ module Lyp::Lilypond
       case version_specifier
       when /^\d/
         version_specifier
-      when 'stable'
+      when nil, 'stable'
         latest_stable_version
       when 'unstable'
         latest_unstable_version
@@ -262,30 +263,34 @@ module Lyp::Lilypond
     end
   
     def install_lilypond_files(fn, platform, version, opts)
+      tmp_target = "/tmp/lyp-lilypond-#{version}"
+      FileUtils.mkdir_p(tmp_target)
+
       case platform
       when /darwin/
-        install_lilypond_files_osx(fn, version, opts)
+        install_lilypond_files_osx(fn, tmp_target, platform, version, opts)
       when /linux/
-        install_lilypond_files_linux(fn, platform, version, opts)
+        install_lilypond_files_linux(fn, tmp_target, platform, version, opts)
       end
+      
+    ensure
+      FileUtils.rm_rf(tmp_target)
     end
   
-    def install_lilypond_files_osx(fn, version, opts)
-      target = "/tmp/lyp/installer/lilypond"
-      FileUtils.mkdir_p(target)
-    
+    def install_lilypond_files_osx(fn, target, platform, version, opts)
       STDERR.puts "Extracting..." unless opts[:silent]
       exec "tar -xjf #{fn} -C #{target}"
     
       copy_lilypond_files("#{target}/LilyPond.app/Contents/Resources", version, opts)
     end
   
-    def install_lilypond_files_linux(fn, platform, version, opts)
-      target = "/tmp/lyp/installer/lilypond"
-      FileUtils.mkdir_p(target)
-    
-      # create temp directory in which to untar file
-      tmp_dir = "/tmp/lyp/#{Time.now.to_f}"
+    # Since linux versions are distributed as sh archives, we need first to 
+    # extract the sh archive, then extract the resulting tar file
+    def install_lilypond_files_linux(fn, target, platform, version, opts)
+      STDERR.puts "Extracting..." unless opts[:silent]
+
+      # create temp directory in which to extract .sh file
+      tmp_dir = "/tmp/lyp-#{Time.now.to_f}"
       FileUtils.mkdir_p(tmp_dir)
     
       FileUtils.cd(tmp_dir) do
@@ -294,10 +299,11 @@ module Lyp::Lilypond
       
       tmp_fn = "#{tmp_dir}/lilypond-#{version}-1.#{platform}.tar.bz2"
       
-      STDERR.puts "Extracting..." unless opts[:silent]
       exec "tar -xjf #{tmp_fn} -C #{target}"
     
       copy_lilypond_files("#{target}/usr", version, opts)
+    ensure
+      FileUtils.rm_rf(tmp_dir)
     end
 
     def copy_lilypond_files(base_path, version, opts)

data/lib/lyp/system.rb

@@ -0,0 +1,116 @@
+require 'fileutils'
+
+module Lyp::System
+  class << self
+    INSTALL_MSG = <<EOF
+
+lyp is not yet properly installed in your home directory. 
+
+To install lyp run 'lyp install self'. lyp will then:
+  1. Setup ~/.lyp as its base directory.
+  2. Add ~/.lyp/bin to $PATH.
+  
+You can uninstall lyp at any time by running 'lyp uninstall self'.
+
+EOF
+
+    def test_installed_status!
+      unless installed?
+        puts INSTALL_MSG
+        exit 1
+      end
+    end
+    
+    def installed?(opts = {})
+      path_is_there = ":#{::ENV['PATH']}:" =~ /#{Lyp::LYP_BIN_DIRECTORY}/
+      file_is_there = File.file?("#{Lyp::LYP_BIN_DIRECTORY}/lyp")
+      
+      (opts[:no_path_check] || path_is_there) && file_is_there
+    end
+    
+    # Adds ~/.lyp/bin to $PATH to the first profile file that exists, then
+    # returns the profile filename
+    def install!
+      puts "\nInstalling lyp...\n\nAdding ~/.lyp/bin to $PATH..."
+      profile_fn = setup_bin_path
+      puts "Setting up binary scripts..."
+      setup_bin_scripts
+      
+      if installed?(no_path_check: true)
+        puts "\nTo finish installation, open a new shell or run 'source ~/#{File.basename(profile_fn)}'.\n\n"
+      else
+        raise "Failed to install lyp"
+      end
+    end
+    
+    PROFILE_FILES = %w{
+      .profile .bash_profile .bash_login .bashrc .zshenv .zshrc .mkshrc
+    }.map {|fn| File.join(Dir.home, fn)}
+
+    LYP_LOAD_CODE = <<EOF
+
+[[ ":${PATH}:" == *":${HOME}/.lyp/bin:"* ]] || PATH="$HOME/.lyp/bin:$PATH"
+EOF
+
+    def setup_bin_path
+      fn = PROFILE_FILES.find {|f| File.file?(f)}
+      unless fn
+        raise "Could not find a shell profile file"
+      end
+      
+      unless (IO.read(fn) =~ /\.lyp\/bin/)
+        File.open(fn, 'a') {|f| f << LYP_LOAD_CODE}
+      end
+      fn
+    end
+    
+    def setup_bin_scripts
+      bin_dir = File.expand_path(File.dirname($0))
+      
+      if is_gem?(bin_dir)
+        setup_gem_bin_scripts(bin_dir)
+      else
+        setup_release_bin_scripts(bin_dir)
+      end
+    end
+    
+    RELEASE_BIN_PATH = "lib/app/bin/"
+    
+    def is_gem?(bin_dir)
+      bin_dir !~ /#{RELEASE_BIN_PATH}[a-z]+$/
+    end
+    
+    def setup_gem_bin_scripts(bin_dir)
+      FileUtils.mkdir_p(Lyp::LYP_BIN_DIRECTORY)
+      %w{lyp lilypond}.each do |fn|
+        FileUtils.ln_sf("#{bin_dir}/#{fn}", "#{Lyp::LYP_BIN_DIRECTORY}/#{fn}")
+      end
+    end
+    
+    def setup_release_bin_scripts(bin_dir)
+      # to be implemented
+    end
+    
+    def uninstall!
+      puts "\nUninstalling lyp...\n\nRemoving ~/.lyp/bin from $PATH..."
+      
+      # Remove ~/.lyp/bin from $PATH
+      PROFILE_FILES.each do |fn|
+        next unless File.file?(fn)
+        
+        content = IO.read(fn)
+        if (content =~ /\.lyp\/bin/)
+          content.gsub!(/\n?.*\.lyp\/bin.*\n/, '')
+          File.open(fn, 'w+') {|f| f << content}
+        end
+      end
+      
+      puts "Removing binary scripts..."
+      # Delete bin scripts
+      FileUtils.rm("#{Lyp::LYP_BIN_DIRECTORY}/*") rescue nil
+      
+      puts "\nTo completely remove installed packages and lilyponds run 'rm -rf ~/.lyp'.\n\n"
+    end
+  end
+end
+

data/lib/lyp/version.rb

@@ -1,3 +1,3 @@
 module Lyp
-  VERSION = "0.0.2"
+  VERSION = "0.0.3"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: lyp
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
 platform: ruby
 authors:
 - Sharon Rosner
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-01-07 00:00:00.000000000 Z
+date: 2016-01-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: highline
@@ -126,12 +126,11 @@ files:
 - lib/lyp/cli.rb
 - lib/lyp/cli/commands.rb
 - lib/lyp/directories.rb
-- lib/lyp/env.rb
 - lib/lyp/lilypond.rb
-- lib/lyp/output.rb
 - lib/lyp/package.rb
 - lib/lyp/resolver.rb
 - lib/lyp/settings.rb
+- lib/lyp/system.rb
 - lib/lyp/template.rb
 - lib/lyp/templates/deps_wrapper.rb
 - lib/lyp/version.rb

data/lib/lyp/env.rb

@@ -1,32 +0,0 @@
-module Lyp::ENV
-  class << self
-    PROFILE_FILES = %w{
-      .profile .bash_profile .bash_login .bashrc .zshenv .zshrc .mkshrc
-    }.map {|fn| File.join(Dir.home, fn)}
-
-    LYPACK_LOAD_CODE = <<EOF
-
-[[ ":${PATH}:" == *":${HOME}/.lyp/bin:"* ]] || PATH="$HOME/.lyp/bin:$PATH"
-EOF
-
-    def install!
-      # Install lyp in environment
-
-      PROFILE_FILES.each do |fn|
-        next unless File.file?(fn)
-        unless IO.read(fn) =~ /\.lyp\/bin/
-          begin
-            File.open(fn, 'a') {|f| f << LYPACK_LOAD_CODE}
-          rescue
-            # ignore
-          end
-        end
-      end
-    end
-    
-    def installed?
-      ":#{::ENV['PATH']}:" =~ /#{Lyp::LYPACK_BIN_DIRECTORY}/
-    end
-  end
-end
-

data/lib/lyp/output.rb

@@ -1,18 +0,0 @@
-require 'ruby-progressbar'
-
-module Lyp
-  PROGRESS_FORMAT = '%t:%B:%p%%'
-  
-  # Simple wrapper around ProgressBar
-  def self.show_progress(title, total)
-    $progress_bar = ProgressBar.create(
-      title: title,
-      total: total,
-      format: PROGRESS_FORMAT,
-    )
-    yield $progress_bar
-  ensure
-    $progress_bar.stop
-    $progress_bar = nil
-  end
-end