gamefic-sdk 1.6.0 → 1.7.0

data/lib/gamefic-sdk/platform.rb

@@ -5,6 +5,18 @@ module Gamefic::Sdk
     autoload :Gfic, 'gamefic-sdk/platform/gfic'
     autoload :Web, 'gamefic-sdk/platform/web'
     autoload :Sinatra, 'gamefic-sdk/platform/sinatra'
+
+    #def self.load directory, platform
+    #  config_file = File.join(directory, 'config.yaml')
+    #end
+
+    def self.load config, name
+      target = config.targets[name]
+      raise ArgumentError.new("Config does not have a target '#{name}'") if target.nil?
+      cls = Gamefic::Sdk::Platform.const_get(target['platform'])
+      raise ArgumentError.new("Platform '#{target['platform']}' not found") if target.nil?
+      cls.new(config: config, target: target.merge('name' => name))
+    end
   end
 
 end

data/lib/gamefic-sdk/platform/base.rb

@@ -1,62 +1,64 @@
 require 'gamefic-sdk'
 require 'gamefic-sdk/debug/plot'
-require 'gamefic-sdk/plot_config'
+#require 'gamefic-sdk/plot_config'
+require 'pathname'
 
 module Gamefic::Sdk
   class Platform::Base
-    # @return [Gamefic::Sdk::Debug::Plot]
-    attr_reader :source_dir
-    
-    # @return [Hash]
+    # @return [Gamefic::Sdk::Config]
     attr_reader :config
-    
-    def initialize source_dir, config = {}
-      @source_dir = source_dir
-      @config = defaults.merge(config)
-      @config['target_dir'] ||= "release/#{config['name'] || self.class.to_s.split("::").last}"
-      @config['build_dir'] ||= "build/#{config['name'] || self.class.to_s.split("::").last}"
-      # Convert config directories into absolute paths
-      @config['target_dir'] = File.absolute_path(@config['target_dir'], source_dir)
-      @config['build_dir'] = File.absolute_path(@config['build_dir'], source_dir)
+
+    # @return [Hash]
+    attr_reader :target
+
+    #def initialize config, name = nil
+    def initialize config: Gamefic::Sdk::Config.new, target: {}
+      #@source_dir = source_dir
+      #@name = name
+      #@config = config
+      #@config.freeze
+      @config = config
+      @target = target
     end
-    
-    # @return [PlotConfig]
-    def plot_config
-      @plot_config ||= PlotConfig.new("#{source_dir}/config.yaml")
+
+    def name
+      @name ||= (target['name'] || self.class.to_s.split('::').last.downcase)
+    end
+
+    def build_target
+      @build_target ||= File.join(config.build_path, name)
     end
-    
+
+    def release_target
+      @release_target ||= File.join(config.release_path, name)
+    end
+
+    # @return [Gamefic::Plot]
     def plot
       if @plot.nil?
-        paths = plot_config.script_paths + [Gamefic::Sdk::GLOBAL_SCRIPT_PATH]
+        paths = [config.script_path, config.import_path, Gamefic::Sdk::GLOBAL_SCRIPT_PATH]
+        # @todo: Should really use Gamefic::Sdk::Debug::Plot or just Gamfic::Plot?
         @plot = Gamefic::Sdk::Debug::Plot.new(Gamefic::Source::File.new(*paths))
         @plot.script 'main'
       end
       @plot
     end
-    
-    # Get a hash of default configuration values.
-    # Platforms can overload this method to define their own defaults.
-    # @return [Hash]
-    def defaults
-      @defaults ||= Hash.new
-    end
-    
+
     def build
       # Platforms need to build/compile the deployment here.
       raise "The base Platform class does not have a build method"
     end
-    
+
     def clean
       puts "Nothing to do for this platform."
     end
-    
-    # Get a string of build metadata, represented as a hash.
+
+    # Get a hash of build metadata.
     #
     # @return [Hash]
     def metadata
       hash = {}
-      uuid = File.exist?(source_dir + '/.uuid') ? File.read(source_dir + '/.uuid').strip : ''
-      hash[:uuid] = "#{uuid}"
+      hash[:uuid] = config.uuid
       hash[:gamefic_version] = "#{Gamefic::VERSION}"
       hash[:sdk_version] = "#{Gamefic::Sdk::VERSION}"
       hash[:build_date] = "#{DateTime.now}"

data/lib/gamefic-sdk/platform/gfic.rb

@@ -5,26 +5,9 @@ require 'yaml'
 module Gamefic::Sdk
 
   class Platform::Gfic < Platform::Base
-    def defaults
-      @defaults ||= {
-        :filename => nil,
-        :with_html => true,
-        :with_media => true
-      }
-    end
     def build
-      target_dir = config['target_dir']
-      if config['filename'].to_s == ''
-        if plot_config.title.to_s == ''
-          filename = File.join(target_dir, File.expand_path(source_dir).split('/').delete_if{|i| i.to_s == ''}.last + '.gfic')
-        else
-          filename = File.join(target_dir, plot_config.title.gsub(/ /, '-').downcase + '.gfic')
-        end
-      else
-        filename = File.join(target_dir, config['filename'])
-      end
       FileUtils.rm filename if File.file?(filename)
-      FileUtils.mkdir_p target_dir
+      FileUtils.mkdir_p release_target
       Zip::File.open(filename, Zip::File::CREATE) do |zipfile|
         plot.imported_scripts.each { |script|
           zipfile.add File.join('scripts', "#{script.path}.plot.rb"), script.absolute_path
@@ -35,6 +18,10 @@ module Gamefic::Sdk
         end
       end
     end
+
+    def filename
+      @filename ||= File.join(release_target, (target['filename'] || 'game.gfic'))
+    end
   end
   
 end

data/lib/gamefic-sdk/platform/sinatra.rb

@@ -8,26 +8,22 @@ module Gamefic::Sdk
 
     def build
       STDERR.puts "Building for Sinatra"
-      target_dir = config['target_dir']
-      build_dir = config['build_dir']
-      html_dir = app_config.html_dir
-
-      FileUtils.mkdir_p target_dir
-      copy_html_files target_dir
-      render_index target_dir
-      copy_assets build_dir, target_dir
-      copy_media source_dir, target_dir
-      FileUtils.cp_r File.join(Gamefic::Sdk::HTML_TEMPLATE_PATH, 'sinatra', 'engine.js'), File.join(target_dir, 'core', 'engine.js')
+      FileUtils.mkdir_p release_target
+      copy_html_files
+      render_index
+      copy_assets
+      copy_media
+      FileUtils.cp_r File.join(Gamefic::Sdk::HTML_TEMPLATE_PATH, 'sinatra', 'engine.js'), File.join(release_target, 'core', 'engine.js')
     end
 
-    def clean
-      FileUtils.remove_entry_secure config['build_dir'] if File.exist?(config['build_dir'])
-      FileUtils.mkdir_p config['build_dir']
-      puts "#{config['build_dir']} cleaned."
-    end
+    #def clean
+    #  FileUtils.remove_entry_secure config['build_path'] if File.exist?(config['build_path'])
+    #  FileUtils.mkdir_p config['build_path']
+    #  puts "#{config['build_path']} cleaned."
+    #end
 
     def app_config
-      @app_config ||= AppConfig.new source_dir, config, ["core/engine.js"]
+      @app_config ||= AppConfig.new config.source_dir, config, ["core/engine.js"]
     end
 
     private
@@ -45,52 +41,54 @@ module Gamefic::Sdk
     end
 
     # Copy everything in source except config and template
-    def copy_html_files target_dir
+    def copy_html_files
       Dir.entries(app_config.html_dir).each { |entry|
         if entry != 'index.rb' and entry != 'index.html.erb' and entry != '.' and entry != '..'
-          FileUtils.mkdir_p target_dir + '/' + File.dirname(entry)
-          FileUtils.cp_r "#{app_config.html_dir}/#{entry}", "#{target_dir}/#{entry}"
+          FileUtils.mkdir_p release_target + '/' + File.dirname(entry)
+          FileUtils.cp_r "#{app_config.html_dir}/#{entry}", "#{release_target}/#{entry}"
         end
       }
     end
 
-    def render_index target_dir
+    def render_index
       # Render index
-      File.open(target_dir + "/index.html", "w") do |file|
+      File.open(release_target + "/index.html", "w") do |file|
         file << app_config.render
       end
     end
 
-    def copy_assets build_dir, target_dir
+    def copy_assets
       paths = app_config.resource_paths
-      paths.push build_dir
+      paths.push build_target
       app_config.javascripts.each { |js|
         absolute = resolve(js, paths)
-        FileUtils.mkdir_p target_dir + "/" + File.dirname(js)
-        FileUtils.cp_r absolute, target_dir + "/" + js
+        FileUtils.mkdir_p release_target + "/" + File.dirname(js)
+        FileUtils.cp_r absolute, release_target + "/" + js
       }
       app_config.stylesheets.each { |css|
         absolute = resolve(css, paths)
-        FileUtils.mkdir_p target_dir + "/" + File.dirname(css)
-        FileUtils.cp_r absolute, target_dir + "/" + css
+        FileUtils.mkdir_p release_target + "/" + File.dirname(css)
+        FileUtils.cp_r absolute, release_target + "/" + css
       }
     end
 
-    def copy_media source_dir, target_dir
+=begin
+    def copy_media
       # Copy media
       pc = PlotConfig.new "#{source_dir}/config.yaml"
       pc.media_paths.each { |path|
         if File.directory?(path)
-          FileUtils.mkdir_p target_dir + "/media"
+          FileUtils.mkdir_p release_target + "/media"
           Dir.entries(path).each { |entry|
             if entry != '.' and entry != '..'
-              FileUtils.mkdir_p target_dir + "/media/" + File.dirname(entry)
-              FileUtils.cp_r path + "/" + entry, target_dir + "/media/" + entry
+              FileUtils.mkdir_p release_target + "/media/" + File.dirname(entry)
+              FileUtils.cp_r path + "/" + entry, release_target + "/media/" + entry
             end
           }
         end
       }
     end
+=end
 
     def metadata_code
       "\nGameficOpal.static_plot.metadata = JSON.parse('#{metadata.to_json}')"

data/lib/gamefic-sdk/platform/web.rb

@@ -8,38 +8,38 @@ module Gamefic::Sdk
   class Platform::Web < Platform::Base
     autoload :AppConfig, 'gamefic-sdk/platform/web/app_config'
 
-    def defaults
-      @defaults ||= {
-        'html_skin' => 'standard',
-        'with_media' => true
-      }
-    end
-
     def app_config
-      @app_config ||= AppConfig.new source_dir, config, ["core/opal.js", "core/gamefic.js", "core/static.js", "core/scripts.js", "core/engine.js"]
+      @app_config ||= AppConfig.new config.source_dir, config, ["core/opal.js", "core/gamefic.js", "core/static.js", "core/scripts.js", "core/engine.js"]
     end
 
     def build
-      target_dir = config['target_dir']
-      build_dir = config['build_dir']
-      html_dir = app_config.html_dir
-
-      FileUtils.mkdir_p target_dir
-      copy_html_files target_dir
-      build_opal_js build_dir
-      build_gamefic_js build_dir
-      build_static_js build_dir
-      build_scripts_js build_dir
-      render_index target_dir
-      copy_assets build_dir, target_dir
-      copy_media source_dir, target_dir
-
+      FileUtils.mkdir_p release_target
+      FileUtils.mkdir_p build_target
+      copy_html_files
+      build_opal_js
+      build_gamefic_js
+      build_static_js
+      build_scripts_js
+      render_index
+      copy_assets
+      copy_media
     end
 
     def clean
-      FileUtils.remove_entry_secure config['build_dir'] if File.exist?(config['build_dir'])
-      FileUtils.mkdir_p config['build_dir']
-      puts "#{config['build_dir']} cleaned."
+      FileUtils.remove_entry_secure build_target if File.exist?(build_target)
+      puts "#{name} cleaned."
+    end
+
+    def html_dir
+      if @html_dir.nil?
+        local_dir = (target['html'] ? target['html'] : 'html')
+        @html_dir = Pathname.new(config.source_dir).join(local_dir).to_s
+        @html_dir = nil unless Dir.exist?(@html_dir)
+        if @html_dir.nil?
+          @html_dir = File.join(Gamefic::Sdk::HTML_TEMPLATE_PATH, 'skins', 'standard')
+        end
+      end
+      @html_dir
     end
 
     private
@@ -57,21 +57,22 @@ module Gamefic::Sdk
     end
 
     # Copy everything in source except config and template
-    def copy_html_files target_dir
-      Dir.entries(app_config.html_dir).each { |entry|
+    def copy_html_files
+      #Dir.entries(app_config.html_dir).each { |entry|
+      Dir.entries(html_dir).each { |entry|
         if entry != 'index.rb' and entry != 'index.html.erb' and entry != '.' and entry != '..'
-          FileUtils.mkdir_p target_dir + '/' + File.dirname(entry)
-          FileUtils.cp_r "#{app_config.html_dir}/#{entry}", "#{target_dir}/#{entry}"
+          FileUtils.mkdir_p release_target + '/' + File.dirname(entry)
+          FileUtils.cp_r "#{app_config.html_dir}/#{entry}", "#{release_target}/#{entry}"
         end
       }
     end
 
-    def build_opal_js build_dir
+    def build_opal_js
       # Make sure core exists in build directory
-      FileUtils.mkdir_p build_dir + "/core"
+      FileUtils.mkdir_p build_target + "/core"
       # Opal core
-      if !File.exist?(build_dir + "/core/opal.js")
-        File.open(build_dir + "/core/opal.js", "w") do |file|
+      if !File.exist?(build_target + "/core/opal.js")
+        File.open(build_target + "/core/opal.js", "w") do |file|
           file << Uglifier.compile(
             Opal::Builder.build('opal').to_s + "\n" + Opal::Builder.build('json').to_s + "\n" + Opal::Builder.build('native').to_s
           )
@@ -79,22 +80,20 @@ module Gamefic::Sdk
       end
     end
 
-    def build_gamefic_js build_dir
+    def build_gamefic_js
       # Gamefic core
       Opal.use_gem 'gamefic'
-      if !File.exist?(build_dir + "/core/gamefic.js")
-        File.open(build_dir + "/core/gamefic.js", "w") do |file|
+      if !File.exist?(build_target + "/core/gamefic.js")
+        File.open(build_target + "/core/gamefic.js", "w") do |file|
           file << Uglifier.compile(Opal::Builder.build('gamefic').to_s)
         end
       end
     end
 
-    def build_static_js build_dir
-      # GameficOpal
+    def build_static_js
       Opal.append_path Gamefic::Sdk::LIB_PATH
-      if !File.exist?(build_dir + "/core/static.js")
-        File.open(build_dir + "/core/static.js", "w") do |file|
-          #file << Opal::Builder.build('gamefic-sdk/platform/web/gamefic_opal')
+      if !File.exist?(build_target + "/core/static.js")
+        File.open(build_target + "/core/static.js", "w") do |file|
           file << Uglifier.compile(
             Opal::Builder.build('gamefic-sdk/platform/web/engine').to_s + "\n" + Opal::Builder.build('gamefic-sdk/platform/web/user').to_s
           )
@@ -102,8 +101,12 @@ module Gamefic::Sdk
       end
     end
 
-    def build_scripts_js build_dir
-      File.open("#{build_dir}/scripts.rb", 'w') do |file|
+    def build_scripts_js
+      File.open("#{build_target}/scripts.rb", 'w') do |file|
+        #file << "def Module.const_missing sym\n"
+        #file << "puts 'From Object to Gamefic'\n"
+        #file << "Gamefic.const_get sym\n"
+        #file << "end\n"
         file << "module Gamefic\n"
         file << "$scripts = {}\n"
         plot.imported_scripts.each { |script|
@@ -116,47 +119,51 @@ module Gamefic::Sdk
         file << "$plot.script 'main'\n"
         file << "$engine = Gamefic::Engine::Web.new($plot)\n"
         file << "end\n"
+        file << "$plot.stage do\n"
+        file << "def self.const_missing sym\n"
+        file << "Gamefic.const_get sym\n"
+        file << "end\n"
+        file << "end\n"
+        #file << "def $plot.theater.const_missing sym\n"
+        #file << 'puts "Trying to get #{sym} from object"' + "\n"
+        #file << "Object.const_get sym\n"
+        #file << "end\n"
       end
-      Opal.append_path build_dir
-      File.open(build_dir + "/core/scripts.js", 'w') do |file|
+      Opal.append_path build_target
+      File.open(build_target + "/core/scripts.js", 'w') do |file|
         file << Uglifier.compile(Opal::Builder.build('scripts').to_s)
       end
     end
 
-    def render_index target_dir
+    def render_index
       # Render index
-      File.open(target_dir + "/index.html", "w") do |file|
+      File.open(release_target + "/index.html", "w") do |file|
         file << app_config.render
       end
     end
 
-    def copy_assets build_dir, target_dir
+    def copy_assets
       paths = app_config.resource_paths
-      paths.push build_dir
+      paths.push build_target
       app_config.javascripts.each { |js|
         absolute = resolve(js, paths)
-        FileUtils.mkdir_p target_dir + "/" + File.dirname(js)
-        FileUtils.cp_r absolute, target_dir + "/" + js
+        FileUtils.mkdir_p release_target + "/" + File.dirname(js)
+        FileUtils.cp_r absolute, release_target + "/" + js
       }
       app_config.stylesheets.each { |css|
         absolute = resolve(css, paths)
-        FileUtils.mkdir_p target_dir + "/" + File.dirname(css)
-        FileUtils.cp_r absolute, target_dir + "/" + css
+        FileUtils.mkdir_p release_target + "/" + File.dirname(css)
+        FileUtils.cp_r absolute, release_target + "/" + css
       }
     end
 
-    def copy_media source_dir, target_dir
-      # Copy media
-      pc = PlotConfig.new "#{source_dir}/config.yaml"
-      pc.media_paths.each { |path|
-        if File.directory?(path)
-          FileUtils.mkdir_p target_dir + "/media"
-          Dir.entries(path).each { |entry|
-            if entry != '.' and entry != '..'
-              FileUtils.mkdir_p target_dir + "/media/" + File.dirname(entry)
-              FileUtils.cp_r path + "/" + entry, target_dir + "/media/" + entry
-            end
-          }
+    def copy_media
+      FileUtils.mkdir_p release_target + "/media"
+      return unless File.directory?(config.media_path)
+      Dir.entries(config.media_path).each { |entry|
+        if entry != '.' and entry != '..'
+          FileUtils.mkdir_p release_target + "/media/" + File.dirname(entry)
+          FileUtils.cp_r config.media_path + "/" + entry, release_target + "/media/" + entry
         end
       }
     end