live_set 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 40ccc8116bfe826b52087a95ccdda582b948c7312be95eb282f17c5da7a24c86
+  data.tar.gz: e97386a24aa9dbcee91080e07cd2c9cc4331b65dab5b5080cbd0665b058de37a
+SHA512:
+  metadata.gz: 90def6a620d141ee67449c7c4f66345d65aea8cad97a5ce0a37a8095e223b2ffc214825a5c10e81aa96e62c141fb6ba0df05cc0f3bb56bbf9f115238cad4fed3
+  data.tar.gz: 1f2e4ffa6e835d7021fe5e2d124a758b9cc629071cc1f5d1517cf20915640932966a433f867b92dc1083261aecb8b8fc748c5031dadaef0935a327af4ef9760a

data/.rubocop.yml

@@ -0,0 +1,59 @@
+require:
+  - rubocop-md
+  - rubocop-performance
+  - rubocop-rake
+  - rubocop-rspec
+
+AllCops:
+  Exclude:
+    - binstub/**/*
+    - exe/**/*
+    - vendor/**/*
+    - Gemfile*
+  NewCops: enable
+
+Gemspec/DeprecatedAttributeAssignment:
+  Enabled: false
+
+Gemspec/RequireMFA:
+  Enabled: false
+
+Layout/HashAlignment:
+  EnforcedColonStyle: table
+  EnforcedHashRocketStyle: table
+
+Layout/LineLength:
+  Max: 150
+
+Metrics/AbcSize:
+  Max: 35
+
+Metrics/BlockLength:
+  Exclude:
+    - live_set.gemspec
+  Max: 30
+
+Metrics/CyclomaticComplexity:
+  Max: 15
+
+Metrics/MethodLength:
+  Max: 40
+
+Metrics/ModuleLength:
+  Enabled: false
+
+Metrics/PerceivedComplexity:
+  Max: 15
+
+Naming/FileName:
+  Exclude:
+    - Rakefile
+
+Style/Documentation:
+  Enabled: false
+
+Style/FrozenStringLiteralComment:
+  Enabled: false
+
+Style/TrailingCommaInHashLiteral:
+  EnforcedStyleForMultiline: comma

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+# Change Log
+
+## 0.1.0
+
+* Initial release.

data/README.md

@@ -0,0 +1,131 @@
+# `Live_set` [![Gem Version](https://badge.fury.io/rb/live_set.svg)](https://badge.fury.io/rb/live_set)
+
+This program can report the version of an Ableton Live set,
+and it can changes an Ableton Live set from Live 12 format to Live 11 format.
+
+This program has successfully converted the Ableton Live 12 demo project to Live 11.
+
+
+## Installation
+
+Simply type:
+
+```shell
+$ gem install live_set
+```
+
+
+## Usage
+
+```shell
+$ live_set
+Displays information about a Live set or converts a Live 12 set to Live 11 format.
+
+Syntax: live_set OPTIONS PATH_TO_ALS_FILE
+
+Environment variables used in PATH_TO_ALS_FILE are expanded.
+
+Options are:
+  -11 Convert the Live 12 set to Live 11 format.
+  -f Overwrite any existing Live 11 set.
+  -h Display this help message.
+
+Example:
+  live_set -11 -f $path/to/my_set.als
+```
+
+### Report
+
+Report the version of the Ableton Live set:
+
+```shell
+$ live_set $path/to/my_set.als
+/mnt/c/media/Ableton/Projects/fu Project/fu.als
+  Created by Live v11.0_11300
+  Major version 11.0_11300
+  Revision 5ac24cad7c51ea0671d49e6b4885371f15b57c1e
+  SchemaChangeCount 3
+Tracks:
+  Drums / complete
+  Bass
+  Guitar
+  Horns
+  Keys
+  Vocal Backing
+  Vocal Lead
+  Strings
+```
+
+
+### Convert
+
+Make the Live 12 set compatible with Live 11 and save as `path/to/my_set_11.als`:
+
+```shell
+$ live_set -11 -f path/to/my_set.als
+```
+
+
+## Development
+
+After checking out this git repository, install dependencies by typing:
+
+```shell
+$ bin/setup
+```
+
+You should do the above before running Visual Studio Code.
+
+
+### Run the Tests
+
+```shell
+$ bundle exec rake test
+```
+
+
+### Debug run
+
+Define the `VO_DEBUGGING` environment variable so the code is loaded from the project
+instead of attempting to load the `live_set` gem.
+
+```shell
+$ VO_DEBUGGING=true ruby exe/live_set /path/to/my_set.als
+```
+
+### Interactive Session
+
+The following will allow you to experiment:
+
+```shell
+$ bin/console
+```
+
+
+### Local Installation
+
+To install this gem onto your local machine, type:
+
+```shell
+$ bundle exec rake install
+```
+
+
+### To Release A New Version
+
+To create a git tag for the new version, push git commits and tags,
+and push the new version of the gem to https://rubygems.org, type:
+
+```shell
+$ bundle exec rake release
+```
+
+
+## Contributing
+
+Bug reports and pull requests are welcome at https://github.com/mslinn/live_set.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,40 @@
+require 'bundler/gem_tasks'
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'test'
+  t.libs << 'lib'
+  t.test_files = FileList['test/**/*_test.rb']
+end
+
+desc 'Bump patch version'
+task :patch do
+  system 'gem bump --tag'
+end
+
+desc 'Bump minor version'
+task :minor do
+  system 'gem bump --version minor --tag'
+end
+
+desc 'Bump major version'
+task :major do
+  system 'gem bump --version major --tag'
+end
+
+task publish: [:build] do
+  $VERBOSE = nil
+  load 'live_set/version.rb'
+  system "gem push pkg/live_set-#{LiveSet::VERSION}.gem"
+end
+
+desc 'Bump patch version, create git tag, build the gem and release to geminabox (default)'
+task release_patch: %i[test patch publish]
+
+desc 'Bump minor version, create git tag, build the gem and release to geminabox'
+task release_minor: %i[test minor publish]
+
+desc 'Bump major version, create git tag, build the gem and release to geminabox'
+task release_major: %i[test major publish]
+
+task default: :test

data/exe/live_set

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+
+if ENV['VO_DEBUGGING']
+  require_relative '../lib/live_set'
+else
+  require 'live_set'
+end
+
+require 'colorator'
+require_relative '../lib/options'
+
+def common(command)
+  @options = parse_options command
+  help_show 'Ableton Live set name must be provided.' if ARGV.empty?
+end

data/lib/common.rb

@@ -0,0 +1,18 @@
+require 'colorator'
+require_relative 'options'
+
+def common(command)
+  @options = parse_options command
+  help_show 'The path for the Ableton Set must be provided.' if ARGV.empty?
+end
+
+def show
+  common :show
+  help_show "Too many parameters specified.\n#{ARGV}" if ARGV.length > 2
+
+  set_name = ARGV.join ' '
+  help "#{set_name} does not exist" unless File.exist? set_name
+  help "#{set_name} is a directory" if File.directory? set_name
+
+  LiveSet.new(set_name, **@options).show
+end

data/lib/live_set/version.rb

@@ -0,0 +1,3 @@
+module LiveSetVersion
+  VERSION = '0.1.0'.freeze unless defined? VERSION
+end

data/lib/live_set.rb

@@ -0,0 +1,29 @@
+require_relative 'live_set/version'
+
+# Require all Ruby files in 'lib/', except this file
+Dir[File.join(__dir__, '*.rb')].sort.each do |file|
+  # puts "Requiring #{file}"
+  require file unless file.end_with?('/live_set.rb')
+end
+
+def help(msg = nil)
+  puts "Error: #{msg}" if msg
+  puts 'List files in ableton set'
+  exit 1
+end
+
+help_show if ARGV.empty?
+
+@options = parse_options
+
+set_name = expand_env ARGV.join(' ')
+help_show "#{set_name} does not exist" unless File.exist? set_name
+help_show "#{set_name} is a directory" if File.directory? set_name
+
+live_set = LiveSet.new set_name, **@options
+
+if @options[:convert11]
+  live_set.modify_als
+else
+  live_set.show
+end

data/lib/llive_set_class.rb

@@ -0,0 +1,96 @@
+require 'nokogiri'
+require 'zlib'
+
+class String
+  def to_bool
+    return true if casecmp('true').zero?
+    return false if casecmp('false').zero?
+
+    nil
+  end
+end
+
+class LiveSet
+  def initialize(set_name, **options)
+    @loglevel  = "-loglevel #{options[:loglevel]}"
+    @loglevel += ' -stats' unless options[:loglevel] == 'quiet'
+    @overwrite = options[:force]
+    @set_name = set_name
+    @contents = Zlib::GzipReader.open(set_name, &:readlines)
+    @xml_doc = Nokogiri::Slop @contents.join("\n")
+
+    @ableton = @xml_doc.Ableton
+    @minor_version = @ableton['MinorVersion']
+  end
+
+  def show
+    puts <<~END_SHOW
+      #{@set_name}
+        Created by #{@ableton['Creator']}
+        Major version #{@ableton['MajorVersion']}
+        Minor version v#{@minor_version}
+        SchemaChangeCount #{@ableton['SchemaChangeCount']}
+        Revision #{@ableton['Revision']}
+    END_SHOW
+    tracks = @ableton.LiveSet.Tracks.AudioTrack
+    track_msg = if tracks.empty?
+                  'No tracks'
+                else
+                  all_frozen = all_tracks_frozen(tracks)
+                  track_summary(tracks) +
+                    tracks.map { |x| show_track x, all_frozen }.join("\n  ")
+                end
+    puts track_msg
+  end
+
+  def modify_als
+    if @minor_version.start_with? '11.'
+      puts 'The Live set is already compatible with Live 11.'
+      exit
+    end
+
+    @ableton['Creator'] = 'Ableton Live 11.3.21'
+    @ableton['MajorVersion'] = '5'
+    @ableton['MinorVersion'] = '11.0_11300'
+    @ableton['Revision'] = '5ac24cad7c51ea0671d49e6b4885371f15b57c1e'
+    @ableton['SchemaChangeCount'] = '3'
+
+    ['//ContentLanes', '//ExpressionLanes', '//InstrumentMeld', '//Roar', '//MxPatchRef'].each do |element|
+      @xml_doc.xpath(element).remove
+    end
+    new_contents = @xml_doc.to_xml.to_s
+    new_contents.gsub! 'AudioOut/Main', 'AudioOut/Master'
+
+    set_path = File.dirname @set_name
+    new_set_name = File.basename @set_name, '.als'
+    new_set_path = File.join set_path, "#{new_set_name}_11.als"
+    if @overwrite
+      puts "Overwriting existing #{new_set_path}"
+      File.delete new_set_path
+    else
+      puts "Writing #{new_set_path}"
+    end
+    Zlib::GzipWriter.open(new_set_path) { |gz| gz.write new_contents }
+  end
+
+  private
+
+  def all_tracks_frozen(tracks)
+    tracks.all? { |track| track_is_frozen track }
+  end
+
+  def track_is_frozen(track)
+    track.Freeze['Value'].to_bool
+  end
+
+  def track_summary(tracks)
+    all_frozen_msg = all_tracks_frozen(tracks) ? ' (All are frozen)' : ''
+    "#{tracks.count} tracks#{all_frozen_msg}:\n  "
+  end
+
+  def show_track(audio_track, all_frozen)
+    name = audio_track.Name.EffectiveName['Value']
+    frozen = !all_frozen && track_is_frozen(audio_track) ? ' **frozen**' : ''
+    "#{name}#{frozen}"
+  end
+end

data/lib/options.rb

@@ -0,0 +1,56 @@
+require 'colorator'
+require 'optparse'
+
+VERBOSITY = %w[trace debug verbose info warning error fatal panic quiet].freeze
+
+def help_show(msg = nil)
+  printf "Error: #{msg}\n\n".yellow unless msg.nil?
+  msg = <<~END_HELP
+    Displays information about a Live set or converts a Live 12 set to Live 11 format.
+
+    Syntax: live_set OPTIONS PATH_TO_ALS_FILE
+
+    Environment variables used in PATH_TO_ALS_FILE are expanded.
+
+    Options are:
+      -11 Convert the Live 12 set to Live 11 format.
+      -f Overwrite any existing Live 11 set.
+      -h Display this help message.
+
+    Example:
+      live_set -11 -f $path/to/my_v12_set.als
+  END_HELP
+  printf msg.cyan
+  exit 1
+end
+
+def parse_options
+  options = { loglevel: 'warning' }
+  opts = do_parse
+  opts.order!(into: options)
+
+  help_show "Invalid verbosity value (#{options[:verbose]}), must be one of one of: #{VERBOSITY.join ', '}." \
+    if options[:verbose] && !options[:verbose] in VERBOSITY
+
+  options
+end
+
+
+private
+
+def do_parse
+  OptionParser.new do |parser|
+    parser.program_name = File.basename __FILE__
+    @parser = parser
+
+    parser.on('-11', '--convert11', 'Make a copy of the set that is compatible with Live 11')
+    parser.on('-f', '--force', 'Overwrite the output set if it already exists')
+    parser.on('-s', '--show', 'Display information about the Ableton Live set')
+    parser.on('-l', '--loglevel LOGLEVEL', Integer, "Logging level (#{VERBOSITY.join ', '})")
+    parser.on('-v', '--verbose VERBOSE', 'Zoom percentage')
+
+    parser.on_tail('-h', '--help', 'Show this message') do
+      help_show
+    end
+  end
+end

data/lib/util.rb

@@ -0,0 +1,5 @@
+def self.expand_env(str)
+  str.gsub(/\$([a-zA-Z_][a-zA-Z0-9_]*)|\${\g<1>}|%\g<1>%/) do
+    ENV.fetch(Regexp.last_match(1), nil)
+  end
+end

data/live_set.gemspec

@@ -0,0 +1,36 @@
+require_relative 'lib/live_set/version'
+
+Gem::Specification.new do |spec|
+  host = 'https://github.com/mslinn/live_set'
+
+  spec.authors               = ['Mike Slinn']
+  spec.bindir                = 'exe'
+  spec.executables           = %w[live_set]
+  spec.description           = <<~END_DESC
+    Reports the version of an Ableton Live set, and optionally changes it to v11 format.
+  END_DESC
+  spec.email                 = ['mslinn@mslinn.com']
+  spec.files                 = Dir['.rubocop.yml', 'LICENSE.*', 'Rakefile', '{lib,spec}/**/*', '*.gemspec', '*.md']
+  spec.homepage              = 'https://github.com/mslinn/live_set'
+  spec.license               = 'MIT'
+  spec.metadata = {
+    'allowed_push_host' => 'https://rubygems.org',
+    'bug_tracker_uri'   => "#{host}/issues",
+    'changelog_uri'     => "#{host}/CHANGELOG.md",
+    'homepage_uri'      => spec.homepage,
+    'source_code_uri'   => host,
+  }
+  spec.name                 = 'live_set'
+  spec.post_install_message = <<~END_MESSAGE
+
+    Thanks for installing #{spec.name}!
+
+  END_MESSAGE
+  spec.require_paths         = ['lib']
+  spec.required_ruby_version = '>= 2.7'
+  spec.summary               = 'Reports the version of an Ableton Live set, and optionally changes it to v11 format.'
+  spec.version               = LiveSetVersion::VERSION
+
+  spec.add_dependency 'colorator'
+  spec.add_dependency 'nokogiri'
+end

metadata

@@ -0,0 +1,97 @@
+--- !ruby/object:Gem::Specification
+name: live_set
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Mike Slinn
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2024-03-14 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: colorator
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: nokogiri
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: 'Reports the version of an Ableton Live set, and optionally changes it
+  to v11 format.
+
+  '
+email:
+- mslinn@mslinn.com
+executables:
+- live_set
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rubocop.yml"
+- CHANGELOG.md
+- README.md
+- Rakefile
+- exe/live_set
+- lib/common.rb
+- lib/live_set.rb
+- lib/live_set/version.rb
+- lib/llive_set_class.rb
+- lib/options.rb
+- lib/util.rb
+- live_set.gemspec
+homepage: https://github.com/mslinn/live_set
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+  bug_tracker_uri: https://github.com/mslinn/live_set/issues
+  changelog_uri: https://github.com/mslinn/live_set/CHANGELOG.md
+  homepage_uri: https://github.com/mslinn/live_set
+  source_code_uri: https://github.com/mslinn/live_set
+post_install_message: |2+
+
+  Thanks for installing live_set!
+
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '2.7'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.5.6
+signing_key:
+specification_version: 4
+summary: Reports the version of an Ableton Live set, and optionally changes it to
+  v11 format.
+test_files: []
+...