maxy-gen 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 6544b65a84167acfcb482cfe7f86524bafd8cd3c
-  data.tar.gz: 37c1356e292db87822fa7f51361c2b13b3e5c0f8
+SHA256:
+  metadata.gz: 18b01a3a7a4bcf740f5e37429e3788908eb8ab0e3014d820246f84f312ea6bac
+  data.tar.gz: 1faa519a006291dca4f6ce83d826ee4be619d550936a5c2a6a19a83bb3443340
 SHA512:
-  metadata.gz: c543c5183934c2fc99105118515a60340b8b0695889ddbbcfacf20363ea234f1e7ed724fd4a23ef16e90379c673fbe1f3d61ff08d4ca0d88f52c5c8c9151fb8a
-  data.tar.gz: 57e90872d4b36183206526d12b480d9a876177ffe7e53fdb6a5002a3163d8626364fefd77c29873c319f1acb3ccb95d29e6eca67aaf90af199dd2d909104793f
+  metadata.gz: 1e5767968b0aa0bfd3d305b8b9a03953e0d46ee8bd8bbcc7ecfa66765c603f5780653153f5227cf2e17d9475609b5abe513962bf52e42e9f1456725d18e6c3a3
+  data.tar.gz: dd557899776137ee503c0e0da9839463b370366af5976bd5af297336c5994a96e4bbb84b7b6416414c64c68cc4887d6624320ba2d27ad278620983343ecda9f2

data/.ruby-version

@@ -0,0 +1 @@
+2.5.1

data/Gemfile.lock

@@ -1,7 +1,8 @@
 PATH
   remote: .
   specs:
-    maxy-gen (0.1.0)
+    maxy-gen (0.2.0)
+      nokogiri
       thor
 
 GEM
@@ -38,8 +39,11 @@ GEM
     diff-lcs (1.3)
     ffi (1.9.23)
     gherkin (5.1.0)
+    mini_portile2 (2.3.0)
     multi_json (1.13.1)
     multi_test (0.1.2)
+    nokogiri (1.8.2)
+      mini_portile2 (~> 2.3.0)
     rake (10.5.0)
     rspec (3.7.0)
       rspec-core (~> 3.7.0)
@@ -68,4 +72,4 @@ DEPENDENCIES
   rspec (~> 3.0)
 
 BUNDLED WITH
-   1.14.6
+   1.16.2

data/README.md

@@ -2,6 +2,8 @@
 
 A commandline tool to generate max patches in an emmet-like fashion
 
+![](https://s3.eu-central-1.amazonaws.com/maxy-gen/maxygen-demo.gif)
+
 ## Installation
 
 Requires `ruby` installed, of course. This gem was built with v.2.3.3.
@@ -9,6 +11,18 @@ Requires `ruby` installed, of course. This gem was built with v.2.3.3.
 Install the gem:
 
     $ gem install maxy-gen       
+    
+This version depends on your local Max installation. Install max object definitions like so:
+
+    $ maxy-gen install
+    
+Or simply
+
+    $ maxy-gen i
+    
+You will be asked for the path to your `refpages` directory. Just hit Enter if you installed Max in your Applications folder.
+
+Note: This is totally untested on Windows!    
 
 ## Usage
 
@@ -16,6 +30,7 @@ Use an [emmet](https://emmet.io/)-like pattern to generate a max patch, e.g.
 
     $ maxy-gen generate 'cycle~{440.}-*~{0.2}-ezdac~' > test.maxpat
     
+(or shorter, `maxy-gen g ...`)
         
 ... and open it in Max. 
 
@@ -24,21 +39,27 @@ As of now you can use
 - `-` dashes to indicate patch chords 
 - `{}` curly braces to denote arguments passed to objects
 
-This gem is under heavy development and needs a library of max objects to function. 
+A couple of objects need escaping (with `\`), because some characters are taken, obviously. These are:
+
+- `\-`
+- `\+`
+- `\*`
+- `\-~`
+- `\+=~`
+- `\+~`
+- `\*~`
 
-This early prototype supports
-- `cycle~`
-- `ezdac~`
-- `sig~`
-- `*~` 
      
-- (later, you will be able to use escaped identifiers, such as `\-~`, because `-{}` are taken, obviously )     
+
+This gem is under heavy development!
 
 ## Contributing
 
 Bug reports and pull requests are welcome on GitHub at https://github.com/julianrubisch/maxy-gen.
 
 Please include:
+- your platform
+- your ruby version
 - a description of what didn't work
 - the patch produced by maxy-gen
 - the patch as you'd have expected it

data/lib/maxy/gen/cli.rb

@@ -1,11 +1,16 @@
 require 'thor'
 require 'psych'
 require 'json'
+require 'fileutils'
+require 'nokogiri'
 require 'maxy/gen'
 
 module Maxy
   module Gen
     class CLI < Thor
+      map "g" => :generate
+      map "i" => :install
+
       desc "generate PATTERN", "Generates a Max Patch JSON from an emmet-style pattern"
       method_option :blank, aliases: "-b"
       def generate(pattern='')
@@ -16,6 +21,53 @@ module Maxy
 
         puts Generator.new.generate(tree)
       end
+
+      desc "install", "Generate max objects library from local maxref pages"
+      def install
+        library = {objects: {}}
+        maxref_xml_root = '/Applications/Max.app/Contents/Resources/C74/docs/refpages'
+
+        print "Path to Max Refpages [#{maxref_xml_root}]:"
+        case choice = $stdin.gets.chomp
+        when ''
+        when /\A.+/i
+          maxref_xml_root = choice
+        else fail "cannot understand `#{choice}'"
+        end
+
+        Dir.foreach(maxref_xml_root) do |mod|
+          next if mod =~ /\.\.?/
+          if File.directory?("#{maxref_xml_root}/#{mod}")
+            Dir.glob("#{maxref_xml_root}/#{mod}/*.maxref.xml").each do |maxref|
+              doc = File.open(maxref) { |f| Nokogiri::XML(f) }
+
+              obj_name = doc.xpath('//c74object/@name').to_s
+              inlets = doc.xpath('//inlet')
+              outlets = doc.xpath('//outlet')
+
+              library[:objects][obj_name] = {}
+              library[:objects][obj_name]['maxclass'] = 'newobj'
+              library[:objects][obj_name]['style'] = ''
+              library[:objects][obj_name]['text'] = obj_name
+              library[:objects][obj_name]['numinlets'] = inlets.size
+              library[:objects][obj_name]['numoutlets'] = outlets.size
+            end
+          end
+        end
+
+        library[:objects].select { |k,v| k.match?(/\A^[-+*{}].*/)  }.each do |k,v|
+          key = "\\#{k}"
+          library[:objects][key] = library[:objects].delete k
+        end
+
+        unless File.directory?("#{ENV['HOME']}/.maxy-gen")
+          FileUtils.mkdir_p("#{ENV['HOME']}/.maxy-gen")
+        end
+        File.open("#{ENV['HOME']}/.maxy-gen/library.yml", 'w') {|f| f.write library.to_yaml }
+
+        print "Successfully installed max object definitions."
+
+      end
     end
   end
 end

data/lib/maxy/gen/generator.rb

@@ -5,16 +5,20 @@ module Maxy
   module Gen
     class Generator
       TEMPLATE = Psych.load_file(File.join(__dir__, '../../../assets/blank.yml')).freeze
-      LIBRARY = Psych.load_file(File.join(__dir__, '../../../assets/library.yml')).freeze
       OFFSET_X = 20
       OFFSET_Y = 20
       STEP_Y = 40
       HEIGHT = 22
       WIDTH = 50
 
+      attr_accessor :library
+
       def initialize
+        raise RuntimeError.new('No object definitions were found. please run `maxy-gen install` first') unless File.exist?("#{ENV['HOME']}/.maxy-gen/library.yml")
+
         @object_count = 1
         @patch = TEMPLATE.freeze
+        @library = Psych.load_file("#{ENV['HOME']}/.maxy-gen/library.yml").freeze
       end
 
       def generate(node)
@@ -36,7 +40,7 @@ module Maxy
       end
 
       def make_box(node, id)
-        box = LIBRARY['objects'][node.name]
+        box = @library[:objects][node.name]
         box['id'] = id
         box['patching_rect'] = [OFFSET_X, OFFSET_Y + @object_count * STEP_Y, box['width'] || WIDTH, box['height'] || HEIGHT]
         unless box['text'].nil?

data/lib/maxy/gen/parser.rb

@@ -2,6 +2,9 @@ module Maxy
   module Gen
     class Parser
       def initialize(tokens)
+        raise RuntimeError.new('No object definitions were found. please run `maxy-gen install` first') unless File.exist?("#{ENV['HOME']}/.maxy-gen/library.yml")
+
+        @library = Psych.load_file("#{ENV['HOME']}/.maxy-gen/library.yml").freeze
         @tokens = tokens
       end
 
@@ -12,7 +15,16 @@ module Maxy
       def parse_obj(obj_node=nil)
         return if @tokens.length == 0
 
-        obj_name = consume(:identifier).value
+        if peek(:identifier)
+          obj_name = consume(:identifier).value
+        else
+          if peek(:escaped_identifier)
+            obj_name = consume(:escaped_identifier).value
+          end
+        end
+
+        raise RuntimeError.new("Could not find #{obj_name} in object definitions.") if @library[:objects][obj_name].nil?
+
         arguments = ''
         if peek(:arguments)
           arguments = parse_arguments

data/lib/maxy/gen/tokenizer.rb

@@ -3,8 +3,8 @@ module Maxy
     class Tokenizer
       TOKEN_TYPES = [
           [:arguments, /({[^{}]*})/],
-          [:escaped_identifier, /(\\[\S]+)(?=[-+{}])/],
-          [:identifier, /([^-+{}()\\]+)(?=[-+{}])?/],
+          [:escaped_identifier, /(\\[\S]+)(?=[-+*{}])/],
+          [:identifier, /([^-+{}()\\]+)(?=[-+*{}])?/],
           [:dash, /(-)/]
       ]
 

data/lib/maxy/gen/version.rb

@@ -1,5 +1,5 @@
 module Maxy
   module Gen
-    VERSION = "0.1.0"
+    VERSION = "0.2.0"
   end
 end

data/maxy-gen.gemspec

@@ -36,4 +36,5 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "aruba"
 
   spec.add_dependency "thor"
+  spec.add_dependency "nokogiri"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: maxy-gen
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Julian Rubisch
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-06-01 00:00:00.000000000 Z
+date: 2018-06-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -94,6 +94,20 @@ dependencies:
     - - ">="
       - !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: A commandline tool to generate max patches in an emmet-like fashion
 email:
 - julian@julianrubisch.at
@@ -104,13 +118,13 @@ extra_rdoc_files: []
 files:
 - ".gitignore"
 - ".rspec"
+- ".ruby-version"
 - ".travis.yml"
 - Gemfile
 - Gemfile.lock
 - README.md
 - Rakefile
 - assets/blank.yml
-- assets/library.yml
 - bin/console
 - bin/setup
 - exe/maxy-gen
@@ -140,7 +154,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.14
+rubygems_version: 2.7.6
 signing_key: 
 specification_version: 4
 summary: A commandline tool to generate max patches in an emmet-like fashion

data/assets/library.yml

@@ -1,32 +0,0 @@
-objects:
-  'cycle~':
-    maxclass: "newobj"
-    numinlets: 2
-    numoutlets: 1
-    outlettype:
-      - "signal"
-    style: ""
-    text: "cycle~"
-  'ezdac~':
-    maxclass: 'ezdac~'
-    numinlets: 2
-    numoutlets: 0
-    width: 45
-    height: 45
-    style: ''
-  'sig~':
-    maxclass: 'newobj'
-    numinlets: 1
-    numoutlets: 1
-    outlettype:
-      - "signal"
-    style: ""
-    text: "sig~"
-  '*~':
-    maxclass: 'newobj'
-    numinlets: 2
-    numoutlets: 1
-    outlettype:
-      - "signal"
-    style: ""
-    text: "*~"