clef 0.1.0 → 1.0.0

data/lib/clef/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Clef
-  VERSION = "0.1.0"
+  VERSION = "1.0.0"
 end

data/lib/clef.rb

@@ -1,20 +1,73 @@
 # frozen_string_literal: true
 
 require_relative "clef/version"
-Dir[File.expand_path("clef/**/*.rb", __dir__)].sort.each do |file|
-  require file unless file.end_with?("version.rb")
-end
+require_relative "clef/core/duration"
+require_relative "clef/core/pitch"
+require_relative "clef/core/time_signature"
+require_relative "clef/core/tempo"
+require_relative "clef/core/clef"
+require_relative "clef/core/key_signature"
+require_relative "clef/core/note"
+require_relative "clef/core/rest"
+require_relative "clef/core/chord"
+require_relative "clef/core/tuplet"
+require_relative "clef/core/voice"
+require_relative "clef/core/measure"
+require_relative "clef/core/metadata"
+require_relative "clef/core/staff"
+require_relative "clef/core/staff_group"
+require_relative "clef/core/validation"
+require_relative "clef/core/score"
+require_relative "clef/notation/articulation"
+require_relative "clef/notation/barline"
+require_relative "clef/notation/beam"
+require_relative "clef/notation/dynamic"
+require_relative "clef/notation/lyric"
+require_relative "clef/notation/slur"
+require_relative "clef/notation/tie"
+require_relative "clef/engraving/rules"
+require_relative "clef/engraving/style"
+require_relative "clef/engraving/glyph_table"
+require_relative "clef/engraving/font_manager"
+require_relative "clef/ir/moment"
+require_relative "clef/ir/event"
+require_relative "clef/ir/timeline"
+require_relative "clef/ir/music_tree"
+require_relative "clef/layout/beam_layout"
+require_relative "clef/layout/item"
+require_relative "clef/layout/line_breaker"
+require_relative "clef/layout/page_breaker"
+require_relative "clef/layout/spacing"
+require_relative "clef/layout/stem"
+require_relative "clef/layout/system_layout"
+require_relative "clef/plugins/base"
+require_relative "clef/plugins/registry"
+require_relative "clef/renderer/base"
+require_relative "clef/renderer/drawing_context"
+require_relative "clef/renderer/notation_helpers"
+require_relative "clef/renderer/pdf_renderer"
+require_relative "clef/renderer/svg_renderer"
+require_relative "clef/midi/channel_map"
+require_relative "clef/midi/exporter"
+require_relative "clef/parser/lilypond_lexer"
+require_relative "clef/parser/dsl"
+require_relative "clef/parser/lilypond_parser"
+require_relative "clef/compiler"
 
 module Clef
   class Error < StandardError; end
 
   class << self
+    attr_reader :last_score
+
     # @yield DSL block
     # @return [Clef::Core::Score]
-    def score(&block)
-      builder = Clef::Parser::DSL::ScoreBuilder.new
-      builder.instance_eval(&block) if block
-      builder.build
+    def score(plugins: Clef.plugins, &block)
+      builder = Clef::Parser::DSL::ScoreBuilder.new(plugins: plugins)
+      if block
+        (block.arity == 1) ? block.call(builder) : builder.instance_eval(&block)
+      end
+      @last_score = builder.build
     end
 
     # @return [Clef::Plugins::Registry]

data/sig/clef.rbs

@@ -0,0 +1,292 @@
+module Clef
+  VERSION: String
+
+  def self.score: (?plugins: Plugins::Registry) { (Parser::DSL::ScoreBuilder) -> void } -> Core::Score
+                | (?plugins: Plugins::Registry) { () -> void } -> Core::Score
+                | (?plugins: Plugins::Registry) -> Core::Score
+  def self.last_score: () -> Core::Score?
+  def self.plugins: () -> Plugins::Registry
+
+  class Error < StandardError
+  end
+
+  class Compiler
+    def initialize: (Core::Score score, ?style: Engraving::Style, ?plugins: Plugins::Registry) -> void
+    def compile_to_pdf: (untyped path) -> untyped
+    def compile_to_svg: (untyped path) -> untyped
+  end
+
+  module Core
+    class Chord
+      attr_reader pitches: Array[Pitch]
+      attr_reader duration: Duration
+
+      def initialize: (Array[Pitch] pitches, Duration duration) -> void
+      def length: () -> Rational
+      def sorted_pitches: () -> Array[Pitch]
+    end
+
+    class Clef
+      attr_reader type: Symbol
+
+      def initialize: (?Symbol type) -> void
+      def reference_pitch: () -> Pitch
+      def reference_line: () -> Integer
+    end
+
+    class Duration
+      attr_reader base: Symbol
+      attr_reader dots: Integer
+
+      def initialize: (Symbol base, ?dots: Integer) -> void
+      def self.from_lilypond: (Integer number, ?Integer dots) -> Duration
+      def self.whole: () -> Duration
+      def self.half: () -> Duration
+      def self.quarter: () -> Duration
+      def self.eighth: () -> Duration
+      def self.sixteenth: () -> Duration
+      def self.thirty_second: () -> Duration
+      def self.sixty_fourth: () -> Duration
+      def self.one_twenty_eighth: () -> Duration
+      def self.two_fifty_sixth: () -> Duration
+
+      def base_value: () -> Rational
+      def length: () -> Rational
+      def to_lilypond: () -> String
+    end
+
+    class KeySignature
+      attr_reader tonic: Pitch
+      attr_reader mode: Symbol
+
+      def initialize: (Pitch | Symbol | String tonic, ?Symbol mode) -> void
+      def accidentals: () -> Hash[Symbol, Symbol | Integer]
+      def preferred_transpose_spelling: () -> Symbol
+    end
+
+    class Measure
+      attr_reader number: Integer
+      attr_reader voices: Hash[Symbol, Voice]
+      attr_accessor key_signature: KeySignature?
+      attr_accessor time_signature: TimeSignature?
+      attr_accessor clef: Clef?
+
+      def initialize: (Integer number, ?time_signature: TimeSignature?) -> void
+      def voice: (?Symbol id) { (Voice) -> void } -> Voice
+               | (?Symbol id) -> Voice
+      def overflowing_voice_ids: () -> Array[Symbol]
+      def underfull_voice_ids: () -> Array[Symbol]
+    end
+
+    class Note
+      attr_reader pitch: Pitch
+      attr_reader duration: Duration
+      attr_reader tie_state: Symbol?
+      attr_reader articulations: Array[Symbol]
+      attr_accessor slur_start: bool
+      attr_accessor slur_end: bool
+      attr_accessor beam_start: bool
+      attr_accessor beam_end: bool
+
+      def initialize: (Pitch pitch, Duration duration, ?articulations: Array[Symbol], ?tied: bool | Symbol?) -> void
+      def length: () -> Rational
+      def tied: () -> bool
+      def tied=: (bool | Symbol? value) -> bool | Symbol?
+      def articulations=: (Array[Symbol] values) -> Array[Symbol]
+      def add_articulation: (Symbol articulation) -> Note
+    end
+
+    class Pitch
+      attr_reader note_name: Symbol
+      attr_reader octave: Integer
+      attr_reader alteration: Integer
+
+      def initialize: (Symbol note_name, Integer octave, ?alteration: Integer) -> void
+      def self.parse: (String str) -> Pitch
+      def self.parse_scientific: (String str) -> Pitch
+      def self.parse_any: (String | Symbol | Pitch value) -> Pitch
+
+      def to_lilypond: () -> String
+      def to_midi: () -> Integer
+      def semitones: () -> Integer
+      def to_frequency: (?tuning: Float) -> Float
+      def transpose: (untyped semitones_or_interval, ?prefer: Symbol?, ?key_signature: KeySignature?) -> Pitch
+      def enharmonic?: (untyped other) -> bool
+    end
+
+    class Rest
+      attr_reader duration: Duration
+      attr_reader kind: Symbol
+      attr_reader measures: Integer
+
+      def initialize: (Duration duration, ?kind: Symbol, ?measures: Integer) -> void
+      def length: () -> Rational
+    end
+
+    class Score
+      attr_reader staff_groups: Array[StaffGroup]
+      attr_reader metadata: Hash[untyped, untyped]
+      attr_accessor title: String?
+      attr_accessor composer: String?
+      attr_accessor tempo: Tempo?
+      attr_accessor plugins: Plugins::Registry?
+
+      def initialize: (?metadata: Hash[untyped, untyped]) -> void
+      def metadata=: (Hash[untyped, untyped] value) -> Hash[untyped, untyped]
+      def set_metadata: (untyped key, untyped value) -> Score
+      def update_metadata: (?Hash[untyped, untyped] value, **untyped kwargs) -> Score
+      def add_staff_group: (StaffGroup staff_group) -> Score
+      def add_staff: (Staff staff) -> Score
+      def staves: () -> Array[Staff]
+      def to_pdf: (untyped path, **untyped options) -> untyped
+      def to_svg: (untyped path, **untyped options) -> untyped
+      def to_midi: (untyped path, **untyped options) -> untyped
+      def to_format: (untyped path, **untyped options) -> untyped
+      def validate: (?strict: bool) -> ValidationResult
+      def validation_warnings: () -> Array[ValidationIssue]
+    end
+
+    class Staff
+      attr_reader id: Symbol
+      attr_reader name: String
+      attr_reader clef: Clef
+      attr_reader measures: Array[Measure]
+      attr_reader metadata: Hash[untyped, untyped]
+      attr_accessor key_signature: KeySignature?
+      attr_accessor time_signature: TimeSignature?
+
+      def initialize: (Symbol id, ?name: String?, ?clef: Clef) -> void
+      def metadata=: (Hash[untyped, untyped] value) -> Hash[untyped, untyped]
+      def set_metadata: (untyped key, untyped value) -> Staff
+      def update_metadata: (?Hash[untyped, untyped] value, **untyped kwargs) -> Staff
+      def add_measure: (Measure measure) -> Staff
+    end
+
+    class StaffGroup
+      attr_reader staves: Array[Staff]
+      attr_reader bracket_type: Symbol
+
+      def initialize: (?Array[Staff] staves, ?bracket_type: Symbol) -> void
+      def add_staff: (Staff staff) -> StaffGroup
+    end
+
+    class Tempo
+      attr_reader beat_unit: Duration
+      attr_reader bpm: Integer
+
+      def initialize: (beat_unit: Duration, bpm: Integer) -> void
+      def length: () -> Rational
+    end
+
+    class TimeSignature
+      attr_reader numerator: Integer
+      attr_reader denominator: Integer
+
+      def initialize: (Integer numerator, Integer denominator) -> void
+      def measure_length: () -> Rational
+    end
+
+    class Tuplet
+      attr_reader actual: Integer
+      attr_reader normal: Integer
+      attr_reader elements: Array[Note | Rest | Chord | Tuplet]
+
+      def initialize: (Integer actual, Integer normal, Array[Note | Rest | Chord | Tuplet] elements) -> void
+      def length: () -> Rational
+      def ratio: () -> Rational
+    end
+
+    class ValidationIssue
+      attr_accessor severity: Symbol
+      attr_accessor message: String
+      attr_accessor path: Array[untyped]
+
+      def warning?: () -> bool
+      def error?: () -> bool
+    end
+
+    class ValidationResult
+      attr_reader issues: Array[ValidationIssue]
+
+      def initialize: (?Array[ValidationIssue] issues) -> void
+      def ok?: () -> bool
+      def errors: () -> Array[ValidationIssue]
+      def warnings: () -> Array[ValidationIssue]
+    end
+
+    class Voice
+      attr_reader id: Symbol
+      attr_reader elements: Array[untyped]
+
+      def initialize: (?id: Symbol) -> void
+      def add: (untyped element) -> Voice
+      def total_length: () -> Rational
+    end
+  end
+
+  module Midi
+    class Exporter
+      attr_reader score: Core::Score
+      attr_reader ppqn: Integer
+      attr_reader instrument_map: Hash[untyped, untyped]
+      attr_reader plugins: Plugins::Registry
+
+      def initialize: (Core::Score score, ?channel_map: ChannelMap, ?ppqn: Integer, ?instrument_map: Hash[untyped, untyped], ?plugins: Plugins::Registry) -> void
+      def export: (untyped target) -> untyped
+    end
+  end
+
+  module Notation
+    class Lyric
+      attr_reader voice_id: Symbol
+      attr_reader text: String
+      attr_reader syllables: Array[String]
+
+      def initialize: (Symbol voice_id, String text) -> void
+      def note_slot_count: () -> Integer
+      def self.note_syllable?: (String syllable) -> bool
+      def self.hyphen?: (String syllable) -> bool
+      def self.extender?: (String syllable) -> bool
+    end
+  end
+
+  module Parser
+    class LilypondParser
+      attr_reader warnings: Array[String]
+      attr_reader plugins: Plugins::Registry
+
+      def initialize: (?plugins: Plugins::Registry) -> void
+      def parse: (String input) -> Core::Score
+    end
+
+    module DSL
+      class Error < StandardError
+      end
+
+      class ScoreBuilder
+        attr_reader score: Core::Score
+      end
+    end
+  end
+
+  module Plugins
+    class Base
+    end
+
+    class Registry
+      attr_reader errors: Array[Hash[Symbol, untyped]]
+
+      def initialize: (?error_policy: Symbol) -> void
+      def plugins: () -> Array[Base]
+      def register: (Class | Base plugin_or_class, *untyped args, ?priority: Integer, **untyped kwargs) -> Base
+      def unregister: (Class | Base | String | Symbol plugin_or_class) -> Base?
+      def clear: () -> Array[untyped]
+      def run_hook: (Symbol hook_name, *untyped args) -> Array[untyped]
+    end
+  end
+
+  module Engraving
+    class Style
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: clef
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 1.0.0
 platform: ruby
 authors:
 - Yudai Takada
@@ -51,11 +51,12 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '4.0'
-description: Clef provides a Ruby DSL, LilyPond-like note input, and basic LilyPond
-  parsing for modeling simple scores and exporting them to PDF, SVG, or MIDI.
+description: Clef provides a Ruby DSL, LilyPond-style note input, and a small LilyPond-style
+  syntax parser for modeling simple scores and exporting them to PDF, SVG, or MIDI.
 email:
 - t.yudai92@gmail.com
-executables: []
+executables:
+- clef
 extensions: []
 extra_rdoc_files: []
 files:
@@ -66,6 +67,7 @@ files:
 - examples/piano_score.rb
 - examples/twinkle.rb
 - examples/vocal_score.rb
+- exe/clef
 - fonts/bravura/README.md
 - lib/clef.rb
 - lib/clef/compiler.rb
@@ -74,6 +76,7 @@ files:
 - lib/clef/core/duration.rb
 - lib/clef/core/key_signature.rb
 - lib/clef/core/measure.rb
+- lib/clef/core/metadata.rb
 - lib/clef/core/note.rb
 - lib/clef/core/pitch.rb
 - lib/clef/core/rest.rb
@@ -82,6 +85,8 @@ files:
 - lib/clef/core/staff_group.rb
 - lib/clef/core/tempo.rb
 - lib/clef/core/time_signature.rb
+- lib/clef/core/tuplet.rb
+- lib/clef/core/validation.rb
 - lib/clef/core/voice.rb
 - lib/clef/engraving/font_manager.rb
 - lib/clef/engraving/glyph_table.rb
@@ -92,10 +97,12 @@ files:
 - lib/clef/ir/music_tree.rb
 - lib/clef/ir/timeline.rb
 - lib/clef/layout/beam_layout.rb
+- lib/clef/layout/item.rb
 - lib/clef/layout/line_breaker.rb
 - lib/clef/layout/page_breaker.rb
 - lib/clef/layout/spacing.rb
 - lib/clef/layout/stem.rb
+- lib/clef/layout/system_layout.rb
 - lib/clef/midi/channel_map.rb
 - lib/clef/midi/exporter.rb
 - lib/clef/notation/articulation.rb
@@ -111,16 +118,18 @@ files:
 - lib/clef/plugins/base.rb
 - lib/clef/plugins/registry.rb
 - lib/clef/renderer/base.rb
+- lib/clef/renderer/drawing_context.rb
 - lib/clef/renderer/notation_helpers.rb
 - lib/clef/renderer/pdf_renderer.rb
 - lib/clef/renderer/svg_renderer.rb
 - lib/clef/version.rb
+- sig/clef.rbs
 homepage: https://github.com/ydah/clef
 licenses:
 - MIT
 metadata:
-  homepage_uri: https://github.com/ydah/clef
   source_code_uri: https://github.com/ydah/clef
+  rubygems_mfa_required: 'true'
 rdoc_options: []
 require_paths:
 - lib