tyrano_dsl 0.1.0 → 0.2.0

data/lib/tyrano_dsl/{elements_writers → export_game/elements_writers}/variables_writer.rb

@@ -1,11 +1,11 @@
-require_relative '../elements/variable'
+require_relative '../../elements/variable'
 require_relative '../file_actions/json_patch'
 require_relative 'elements_writers_module'
 
 # Write a variable
-class TyranoDsl::ElementsWriters::VariablesWriter
+class TyranoDsl::ExportGame::ElementsWriters::VariablesWriter
 
-  include TyranoDsl::ElementsWriters::ElementsWritersModule
+  include TyranoDsl::ExportGame::ElementsWriters::ElementsWritersModule
 
   # @param [TyranoDsl::Elements::World] world
   # @return [Array]
@@ -19,7 +19,7 @@ class TyranoDsl::ElementsWriters::VariablesWriter
       }
     end
     [
-        TyranoDsl::FileActions::JsonPatch.new(
+        TyranoDsl::ExportGame::FileActions::JsonPatch.new(
             'builder_config.json',
             ['map_var'],
             variable_content

data/lib/tyrano_dsl/export_game/export_game.rb

@@ -0,0 +1,4 @@
+module TyranoDsl
+  module ExportGame
+  end
+end

data/lib/tyrano_dsl/{file_actions → export_game/file_actions}/clear_directory.rb

@@ -4,9 +4,9 @@ require_relative 'files_actions_module'
 
 # Remove all files from a directory
 
-class TyranoDsl::FileActions::ClearDirectory
+class TyranoDsl::ExportGame::FileActions::ClearDirectory
 
-  include TyranoDsl::FileActions::FileActionsModule
+  include TyranoDsl::ExportGame::FileActions::FileActionsModule
 
   # @return [String]
   attr_reader :path
@@ -18,6 +18,7 @@ class TyranoDsl::FileActions::ClearDirectory
   end
 
   # @param [String] tyrano_project_path
+  # @return [void]
   def run(tyrano_project_path)
     full_path = File.join(tyrano_project_path, path)
     log {"Cleaning [#{full_path}]"}

data/lib/tyrano_dsl/{file_actions → export_game/file_actions}/create_file.rb

@@ -1,9 +1,9 @@
 require_relative 'files_actions_module'
 
 # Create a file with a custom content
-class TyranoDsl::FileActions::CreateFile
+class TyranoDsl::ExportGame::FileActions::CreateFile
 
-  include TyranoDsl::FileActions::FileActionsModule
+  include TyranoDsl::ExportGame::FileActions::FileActionsModule
 
   # @return [String]
   attr_reader :content
@@ -19,6 +19,7 @@ class TyranoDsl::FileActions::CreateFile
   end
 
   # @param [String] tyrano_project_path
+  # @return [void]
   def run(tyrano_project_path)
     full_path = File.join(tyrano_project_path, path)
     log {"Creating file [#{full_path}]"}

data/lib/tyrano_dsl/{file_actions → export_game/file_actions}/file_copy.rb

@@ -4,15 +4,15 @@ require_relative 'files_actions_module'
 
 
 # Direct copy of a file from a source to a destination
-class TyranoDsl::FileActions::FileCopy
+class TyranoDsl::ExportGame::FileActions::FileCopy
+
+  include TyranoDsl::ExportGame::FileActions::FileActionsModule
 
   # @return [String]
   attr_reader :from_path
   # @return [String]
   attr_reader :to_path
 
-  include TyranoDsl::FileActions::FileActionsModule
-
   # @param [String] from_path
   # @param [String] to_path
   def initialize(from_path, to_path)
@@ -22,9 +22,10 @@ class TyranoDsl::FileActions::FileCopy
   end
 
   # @param [String] tyrano_project_path
+  # @return [void]
   def run(tyrano_project_path)
     full_path = File.join(tyrano_project_path, to_path)
-    log {"Copy file [#{from_path}] to [#{full_path}]"}
+    log {"Copying file [#{from_path}] to [#{full_path}]"}
     create_parent_dir_if_not_exist(full_path)
     FileUtils.copy_file from_path, full_path
   end

data/lib/tyrano_dsl/{file_actions → export_game/file_actions}/files_actions_module.rb

@@ -1,6 +1,8 @@
 require 'logger'
 
-module TyranoDsl
+require_relative '../export_game'
+
+module TyranoDsl::ExportGame
   module FileActions
 
     # Helpers to write file actions

data/lib/tyrano_dsl/{file_actions → export_game/file_actions}/json_patch.rb

@@ -3,9 +3,9 @@ require 'json'
 require_relative 'files_actions_module'
 
 # Path a JSON file
-class TyranoDsl::FileActions::JsonPatch
+class TyranoDsl::ExportGame::FileActions::JsonPatch
 
-  include TyranoDsl::FileActions::FileActionsModule
+  include TyranoDsl::ExportGame::FileActions::FileActionsModule
 
   # @return [String]
   attr_reader :file_path
@@ -25,6 +25,7 @@ class TyranoDsl::FileActions::JsonPatch
   end
 
   # @param [String] tyrano_project_path
+  # @return [void]
   def run(tyrano_project_path)
     full_path = File.join(tyrano_project_path, file_path)
     log {"Patching file [#{full_path}] at #{patching_path}"}
@@ -32,16 +33,20 @@ class TyranoDsl::FileActions::JsonPatch
       raise TyranoDsl::TyranoException, "Missing file [#{full_path}]"
     end
     content = JSON.parse(IO.read(full_path))
+
+    # Going down on the tree …
     current_subtree = content
     0.upto(patching_path.length - 2) do |path_segment_index|
       current_subtree = current_subtree[patching_path[path_segment_index]]
     end
+    # … and patch the leaf
     current_subtree[patching_path.last] = patched_content
+
     File.write(full_path, JSON.pretty_generate(content))
   end
 
   def to_s
-    "Patch JSON [#{file_path}] at #{patching_path}"
+    "Patch [#{file_path}] at #{patching_path}"
   end
 
 end

data/lib/tyrano_dsl/export_game/main.rb

@@ -0,0 +1,26 @@
+require_relative '../parser'
+require_relative '../parsing_context'
+require_relative '../tyrano_dsl'
+require_relative '../tyrano_exception'
+require_relative 'export_game'
+require_relative 'writer'
+
+class TyranoDsl::ExportGame::Main
+
+  # @param [String] file_path path to the DSL file
+  # @return [TyranoDsl::ExportGame::WritingContext]
+  def run(file_path)
+    parsing_context = TyranoDsl::Parser.parse(file_path)
+    TyranoDsl::ExportGame::Writer.new.write(parsing_context.world, parsing_context.words)
+  end
+
+  # @param [TyranoDsl::ExportGame::WritingContext] writing_context
+  # @param [String] tyrano_project_path
+  # @return [void]
+  def apply(writing_context, tyrano_project_path)
+    writing_context.file_actions.each do |file_action|
+      file_action.run(tyrano_project_path)
+    end
+  end
+
+end

data/lib/tyrano_dsl/{writer.rb → export_game/writer.rb}

@@ -1,32 +1,32 @@
 require 'logger'
 
+require_relative '../tyrano_dsl'
+require_relative '../vocabulary'
 require_relative 'elements_writers/background_writer'
 require_relative 'elements_writers/character_writer'
 require_relative 'elements_writers/characters_writer'
 require_relative 'elements_writers/title_screen_writer'
 require_relative 'elements_writers/variables_writer'
-require_relative 'tyrano_dsl'
-require_relative 'vocabulary'
 require_relative 'writing_context'
 
 # Write the content that have been parsed
-class TyranoDsl::Writer
+class TyranoDsl::ExportGame::Writer
 
   def initialize
     @logger = Logger.new(STDOUT)
     @words = {}
-    TyranoDsl::Vocabulary.get_words_class('writing_words') do |word, word_class|
+    TyranoDsl::Vocabulary.get_words_class('export_game/writing_words') do |word, word_class|
       @words[word] = word_class.new
     end
   end
 
   # @param [TyranoDsl::Elements::World] world
   # @param [Array<TyranoDsl::ParsedWord>] parsed_words
-  # @return [TyranoDsl::WritingContext]
+  # @return [TyranoDsl::ExportGame::WritingContext]
   # @raise [TyranoDsl::TyranoException]
   def write(world, parsed_words)
     log {'Writing content'}
-    writing_context = TyranoDsl::WritingContext.new(world)
+    writing_context = TyranoDsl::ExportGame::WritingContext.new(world)
     write_title_screen(writing_context, world)
     write_backgrounds(writing_context, world)
     write_characters(writing_context, world)
@@ -39,58 +39,58 @@ class TyranoDsl::Writer
 
   private
 
-  # @param [TyranoDsl::WritingContext] writing_context
+  # @param [TyranoDsl::ExportGame::WritingContext] writing_context
   # @param [TyranoDsl::Elements::World] world
   # @return [void]
   # @raise [TyranoDsl::TyranoException]
   def write_title_screen(writing_context, world)
-    title_screen_writer = TyranoDsl::ElementsWriters::TitleScreenWriter.new
+    title_screen_writer = TyranoDsl::ExportGame::ElementsWriters::TitleScreenWriter.new
     concat_file_actions(writing_context, title_screen_writer.write(world))
   end
 
-  # @param [TyranoDsl::WritingContext] writing_context
+  # @param [TyranoDsl::ExportGame::WritingContext] writing_context
   # @param [TyranoDsl::Elements::World] world
   # @return [void]
   # @raise [TyranoDsl::TyranoException]
   def write_characters(writing_context, world)
-    character_writer = TyranoDsl::ElementsWriters::CharacterWriter.new
+    character_writer = TyranoDsl::ExportGame::ElementsWriters::CharacterWriter.new
     concat_file_actions(writing_context, character_writer.init_actions)
     world.characters.each_value do |character|
       concat_file_actions(writing_context, character_writer.write(character))
     end
-    characters_writer = TyranoDsl::ElementsWriters::CharactersWriter.new
+    characters_writer = TyranoDsl::ExportGame::ElementsWriters::CharactersWriter.new
     concat_file_actions(writing_context, characters_writer.write(world))
   end
 
-  # @param [TyranoDsl::WritingContext] writing_context
+  # @param [TyranoDsl::ExportGame::WritingContext] writing_context
   # @param [TyranoDsl::Elements::World] world
   # @return [void]
   # @raise [TyranoDsl::TyranoException]
   def write_backgrounds(writing_context, world)
-    background_writer = TyranoDsl::ElementsWriters::BackgroundWriter.new
+    background_writer = TyranoDsl::ExportGame::ElementsWriters::BackgroundWriter.new
     concat_file_actions(writing_context, background_writer.init_actions)
     world.backgrounds.each_value do |background|
       concat_file_actions(writing_context, background_writer.write(background))
     end
   end
 
-  # @param [TyranoDsl::WritingContext] writing_context
+  # @param [TyranoDsl::ExportGame::WritingContext] writing_context
   # @param [TyranoDsl::Elements::World] world
   # @return [void]
   # @raise [TyranoDsl::TyranoException]
   def write_variables(writing_context, world)
-    variables_writer = TyranoDsl::ElementsWriters::VariablesWriter.new
+    variables_writer = TyranoDsl::ExportGame::ElementsWriters::VariablesWriter.new
     concat_file_actions(writing_context, variables_writer.write(world))
   end
 
-  # @param [TyranoDsl::WritingContext] writing_context
+  # @param [TyranoDsl::ExportGame::WritingContext] writing_context
   # @param [Array] file_actions
   # @return [void]
   def concat_file_actions(writing_context, file_actions)
     writing_context.file_actions.concat(file_actions)
   end
 
-  # @param [TyranoDsl::WritingContext] writing_context
+  # @param [TyranoDsl::ExportGame::WritingContext] writing_context
   # @param [Array<TyranoDsl::ParsedWord>] parsed_words
   # @param [TyranoDsl::Elements::World] world
   # @return [void]

data/lib/tyrano_dsl/{writing_context.rb → export_game/writing_context.rb}

@@ -1,12 +1,12 @@
 require 'logger'
 require 'set'
 
+require_relative '../tyrano_dsl'
+require_relative '../tyrano_exception'
 require_relative 'elements_writers/scene_writer'
-require_relative 'tyrano_exception'
-require_relative 'tyrano_dsl'
 
 # Context for writing
-class TyranoDsl::WritingContext
+class TyranoDsl::ExportGame::WritingContext
 
   # @return [Array<String>]
   attr_reader :current_scene_assets
@@ -26,7 +26,7 @@ class TyranoDsl::WritingContext
     @current_scene_name = nil
     @current_scene_assets = nil
     @current_scene_labels = nil
-    @scene_writer = TyranoDsl::ElementsWriters::SceneWriter.new
+    @scene_writer = TyranoDsl::ExportGame::ElementsWriters::SceneWriter.new
   end
 
   # Append some content to the current scene

data/lib/tyrano_dsl/{writing_words → export_game/writing_words}/ask_question.rb

@@ -1,8 +1,8 @@
 require_relative 'writing_words_module'
 
-class TyranoDsl::WritingWords::AskQuestion
+class TyranoDsl::ExportGame::WritingWords::AskQuestion
 
-  include TyranoDsl::WritingWords::WritingWordsModule
+  include TyranoDsl::ExportGame::WritingWords::WritingWordsModule
 
   def run(writing_context, world, word_location, parameters)
     content = []

data/lib/tyrano_dsl/{writing_words → export_game/writing_words}/conditional_jump.rb

@@ -1,8 +1,8 @@
 require_relative 'writing_words_module'
 
-class TyranoDsl::WritingWords::ConditionalJump
+class TyranoDsl::ExportGame::WritingWords::ConditionalJump
 
-  include TyranoDsl::WritingWords::WritingWordsModule
+  include TyranoDsl::ExportGame::WritingWords::WritingWordsModule
 
   OPERATORS_RUBY_TO_TYRANO = {
       '<' => '<',

data/lib/tyrano_dsl/export_game/writing_words/declare_background.rb

@@ -0,0 +1,5 @@
+require_relative 'nop'
+
+class TyranoDsl::ExportGame::WritingWords::DeclareBackground < TyranoDsl::ExportGame::WritingWords::Nop
+
+end

data/lib/tyrano_dsl/export_game/writing_words/declare_character.rb

@@ -0,0 +1,5 @@
+require_relative 'nop'
+
+class TyranoDsl::ExportGame::WritingWords::DeclareCharacter < TyranoDsl::ExportGame::WritingWords::Nop
+
+end

data/lib/tyrano_dsl/{writing_words → export_game/writing_words}/declare_label.rb

@@ -1,6 +1,6 @@
 require_relative 'writing_words_module'
 
-class TyranoDsl::WritingWords::DeclareLabel
+class TyranoDsl::ExportGame::WritingWords::DeclareLabel
 
   def run(writing_context, world, word_location, parameters)
     label_name = parameters[:label_name]

data/lib/tyrano_dsl/export_game/writing_words/declare_variable.rb

@@ -0,0 +1,5 @@
+require_relative 'nop'
+
+class TyranoDsl::ExportGame::WritingWords::DeclareVariable < TyranoDsl::ExportGame::WritingWords::Nop
+
+end

data/lib/tyrano_dsl/{writing_words → export_game/writing_words}/display_text.rb

@@ -1,6 +1,6 @@
 require_relative 'writing_words_module'
 
-class TyranoDsl::WritingWords::DisplayText
+class TyranoDsl::ExportGame::WritingWords::DisplayText
 
   def run(writing_context, world, word_location, parameters)
     character_name = parameters[:character_name]

data/lib/tyrano_dsl/{writing_words → export_game/writing_words}/hide_character.rb

@@ -1,6 +1,6 @@
 require_relative 'writing_words_module'
 
-class TyranoDsl::WritingWords::HideCharacter
+class TyranoDsl::ExportGame::WritingWords::HideCharacter
 
   def run(writing_context, world, word_location, parameters)
     character = world.characters[parameters[:name]]

data/lib/tyrano_dsl/{writing_words → export_game/writing_words}/hide_message_window.rb

@@ -1,6 +1,6 @@
 require_relative 'writing_words_module'
 
-class TyranoDsl::WritingWords::HideMessageWindow
+class TyranoDsl::ExportGame::WritingWords::HideMessageWindow
 
   def run(writing_context, world, word_location, parameters)
     writing_context.append_content(

data/lib/tyrano_dsl/export_game/writing_words/include_file.rb

@@ -0,0 +1,5 @@
+require_relative 'nop'
+
+class TyranoDsl::ExportGame::WritingWords::IncludeFile < TyranoDsl::ExportGame::WritingWords::Nop
+
+end

data/lib/tyrano_dsl/{writing_words → export_game/writing_words}/jump.rb

@@ -1,8 +1,8 @@
 require_relative 'writing_words_module'
 
-class TyranoDsl::WritingWords::Jump
+class TyranoDsl::ExportGame::WritingWords::Jump
 
-  include TyranoDsl::WritingWords::WritingWordsModule
+  include TyranoDsl::ExportGame::WritingWords::WritingWordsModule
 
   def run(writing_context, world, word_location, parameters)
     scene_name = parameters[:scene_name]

data/lib/tyrano_dsl/{writing_words → export_game/writing_words}/nop.rb

@@ -1,6 +1,6 @@
 require_relative 'writing_words_module'
 
-class TyranoDsl::WritingWords::Nop
+class TyranoDsl::ExportGame::WritingWords::Nop
 
   def run(writing_context, world, word_location, parameters)
   end

data/lib/tyrano_dsl/{writing_words → export_game/writing_words}/set_background.rb

@@ -1,7 +1,7 @@
-require_relative '../elements/background'
+require_relative '../../elements/background'
 require_relative 'writing_words_module'
 
-class TyranoDsl::WritingWords::SetBackground
+class TyranoDsl::ExportGame::WritingWords::SetBackground
 
   def run(writing_context, world, word_location, parameters)
     background = world.backgrounds[parameters[:name]]

data/lib/tyrano_dsl/{writing_words → export_game/writing_words}/set_character_stance.rb

@@ -1,7 +1,7 @@
-require_relative '../elements/character'
+require_relative '../../elements/character'
 require_relative 'writing_words_module'
 
-class TyranoDsl::WritingWords::SetCharacterStance
+class TyranoDsl::ExportGame::WritingWords::SetCharacterStance
 
   def run(writing_context, world, word_location, parameters)
     character = world.characters[parameters[:name]]

data/lib/tyrano_dsl/export_game/writing_words/set_title_screen_background.rb

@@ -0,0 +1,4 @@
+require_relative 'nop'
+
+class TyranoDsl::ExportGame::WritingWords::SetTitleScreenBackground < TyranoDsl::ExportGame::WritingWords::Nop
+end