twee2 0.2.0 → 0.2.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: fc099c1156382f87238efc566265e62b16c48c51
-  data.tar.gz: 414eb7bca8f1fc560f59ef2bb894d85f5c380846
+  metadata.gz: b63cd0490f4dff22a79e5d67a667c6a433d899ba
+  data.tar.gz: db0132a07a752ac8700e44c2062550808ba74c26
 SHA512:
-  metadata.gz: b47926ce7ea8e0808672bb8d6bdff78debe866f6149e9f5d7239d3cbed7c8eccc9a315842e77edc0f59459b8b228bec90f997fd86d988ddd6ce44fa7a76c361b
-  data.tar.gz: 93a12dc5f04f465e955007f7d19e4824a659586c6c0725da2761f2e765b97742e76eabe9430aa6f0ea2061ac67042854fadd9941852803c0109e86fada238b1b
+  metadata.gz: 74b26f90671c6f4b7e380ee4fab5f5ee0b8bc716dfaa863d85a5b0611eab6831834ecd3de0ab39ce9db69ba11ea364f7c822cecca08193bcbb946d7bdd283b2c
+  data.tar.gz: 9eeba4d00780facc6c2c112b7305596853f6771d53cebb51733d3612e1267f7da5b85c7408a36bb9158f4d154a69522f09ef4be4437b86ed371167f4e0ce1efe

data/lib/twee2.rb

@@ -1,93 +1,23 @@
-Encoding.default_external = Encoding::UTF_8
-Encoding.default_internal = Encoding::UTF_8
-
-require "twee2/version"
+Encoding.default_external = Encoding.default_internal = Encoding::UTF_8
 
 # Prerequisites (managed by bundler)
-require 'rubygems'
-require 'bundler/setup'
-require 'thor'
-require 'json'
-require 'builder'
-require 'filewatcher'
-require 'haml'
-require 'coffee_script'
+%w{rubygems bundler/setup thor json builder filewatcher haml coffee_script
+   twee2/version twee2/story_format twee2/story_file}.each do |prerequisite|
+  require prerequisite
+end
 
 module Twee2
   # Constants
   DEFAULT_FORMAT = 'Harlowe'
-  HAML_OPTIONS = {
-    remove_whitespace: true
-  }
 
   def self.build(input, output, options = {})
     # Read and parse format file
-    format_file = File::read(buildpath("storyFormats/#{options[:format]}/format.js"))
-    format_data = format_file.match(/(["'])source\1 *: *(["']).*?[^\\]\2/)[0]
-    format_data_for_json = "\{#{format_data}\}"
-    result = JSON.parse(format_data_for_json)['source']
+    story_format = StoryFormat::new(options[:format])
     # Read and parse input file
-    passages, current_passage = {}, nil
-    File::read(input).each_line do |line| # REFACTOR: switch this to using regular expressions, why not?
-      if line =~ /^:: *([^\[]*?) *(\[(.*?)\])? *[\r\n]+$/
-        passages[current_passage = $1.strip] = { tags: ($3 || '').split(' '), content: '', exclude_from_output: false, pid: nil}
-      elsif current_passage
-        passages[current_passage][:content] << line
-      end
-    end
-    passages.each_key{|k| passages[k][:content].strip!} # Strip excessive trailing whitespace
-    # Run each passage through a preprocessor, if required
-    passages.each_key do |k|
-      # HAML
-      if passages[k][:tags].include? 'haml'
-        passages[k][:content] = Haml::Engine.new(passages[k][:content], HAML_OPTIONS).render
-        passages[k][:tags].delete 'haml'
-      end
-      # Coffeescript
-      if passages[k][:tags].include? 'coffee'
-        passages[k][:content] = CoffeeScript.compile(passages[k][:content])
-        passages[k][:tags].delete 'coffee'
-      end
-    end
-    # Extract 'special' passages and mark them as not being included in output
-    story_name, story_css, story_js, pid, story_start_pid = 'An unnamed story', '', '', 0, 1
-    passages.each_key do |k|
-      if k == 'StoryTitle'
-        story_name = passages[k][:content]
-        passages[k][:exclude_from_output] = true
-      elsif %w{StorySubtitle StoryAuthor StoryMenu StorySettings StoryIncludes}.include? k
-        puts "WARNING: ignoring passage '#{k}'"
-        passages[k][:exclude_from_output] = true
-      elsif passages[k][:tags].include? 'stylesheet'
-        story_css << "#{passages[k][:content]}\n"
-        passages[k][:exclude_from_output] = true
-      elsif passages[k][:tags].include? 'script'
-        story_js << "#{passages[k][:content]}\n"
-        passages[k][:exclude_from_output] = true
-      elsif k == 'Start'
-        passages[k][:pid] = (pid += 1)
-        story_start_pid = pid
-      else
-        passages[k][:pid] = (pid += 1)
-      end
-    end
-    # Generate XML in Twine 2 format
-    story_data = Builder::XmlMarkup.new
-    # TODO: what is tw-storydata's "options" attribute for?
-    story_data.tag!('tw-storydata', { name: story_name, startnode: story_start_pid, creator: 'Twee2', 'creator-version' => Twee2::VERSION, ifid: 'TODO', format: options[:format], options: '' }) do
-      story_data.style(story_css, role: 'stylesheet', id: 'twine-user-stylesheet', type: 'text/twine-css')
-      story_data.script(story_js, role: 'script', id: 'twine-user-script', type: 'text/twine-javascript')
-      passages.each do |k,v|
-        unless v[:exclude_from_output]
-          story_data.tag!('tw-passagedata', { pid: v[:pid], name: k, tags: v[:tags].join(' ') }, v[:content])
-        end
-      end
-    end
+    story_file = StoryFile::new(input)
     # Produce output file
-    result.gsub!('{{STORY_NAME}}', story_name)
-    result.gsub!('{{STORY_DATA}}', story_data.target!)
     File::open(output, 'w') do |out|
-      out.print result
+      out.print story_format.compile(story_file)
     end
     puts "Done"
   end
@@ -104,7 +34,7 @@ module Twee2
 
   def self.formats
     puts "I understand the following output formats:"
-    puts Dir.open(buildpath('storyFormats')).to_a.sort.reject{|d|d=~/^\./}.map{|f|" * #{f}"}.join("\n")
+    puts StoryFormat.known_names.join("\n")
   end
 
   def self.help

data/lib/twee2/story_file.rb

@@ -0,0 +1,84 @@
+module Twee2
+  class StoryFileNotFoundException < Exception; end
+
+  class StoryFile
+    HAML_OPTIONS = {
+      remove_whitespace: true
+    }
+    Tilt::CoffeeScriptTemplate.default_bare = true # bare mode for HAML :coffeescript blocks
+    COFFEESCRIPT_OPTIONS = {
+      bare: true
+    }
+
+    # Loads the StoryFile with the given name
+    def initialize(filename)
+      raise(StoryFileNotFoundException) if !File::exists?(filename)
+      @passages, current_passage = {}, nil
+      File::read(filename).each_line do |line| # REFACTOR: switch this to using regular expressions, why not?
+        if line =~ /^:: *([^\[]*?) *(\[(.*?)\])? *[\r\n]+$/
+          @passages[current_passage = $1.strip] = { tags: ($3 || '').split(' '), content: '', exclude_from_output: false, pid: nil}
+        elsif current_passage
+          @passages[current_passage][:content] << line
+        end
+      end
+      @passages.each_key{|k| @passages[k][:content].strip!} # Strip excessive trailing whitespace
+      # Run each passage through a preprocessor, if required
+      @passages.each_key do |k|
+        # HAML
+        if @passages[k][:tags].include? 'haml'
+          @passages[k][:content] = Haml::Engine.new(@passages[k][:content], HAML_OPTIONS).render
+          @passages[k][:tags].delete 'haml'
+        end
+        # Coffeescript
+        if @passages[k][:tags].include? 'coffee'
+          @passages[k][:content] = CoffeeScript.compile(@passages[k][:content], COFFEESCRIPT_OPTIONS)
+          @passages[k][:tags].delete 'coffee'
+        end
+      end
+      # Extract 'special' passages and mark them as not being included in output
+      @story_name, story_css, story_js, pid, story_start_pid = 'An unnamed story', '', '', 0, 1
+      @passages.each_key do |k|
+        if k == 'StoryTitle'
+          @story_name = @passages[k][:content]
+          @passages[k][:exclude_from_output] = true
+        elsif %w{StorySubtitle StoryAuthor StoryMenu StorySettings StoryIncludes}.include? k
+          puts "WARNING: ignoring passage '#{k}'"
+          @passages[k][:exclude_from_output] = true
+        elsif @passages[k][:tags].include? 'stylesheet'
+          story_css << "#{@passages[k][:content]}\n"
+          @passages[k][:exclude_from_output] = true
+        elsif @passages[k][:tags].include? 'script'
+          story_js << "#{@passages[k][:content]}\n"
+          @passages[k][:exclude_from_output] = true
+        elsif k == 'Start'
+          @passages[k][:pid] = (pid += 1)
+          story_start_pid = pid
+        else
+          @passages[k][:pid] = (pid += 1)
+        end
+      end
+      # Generate XML in Twine 2 format
+      @story_data = Builder::XmlMarkup.new
+      # TODO: what is tw-storydata's "options" attribute for?
+      @story_data.tag!('tw-storydata', { name: @story_name, startnode: story_start_pid, creator: 'Twee2', 'creator-version' => Twee2::VERSION, ifid: 'TODO', format: '{{STORY_FORMAT}}', options: '' }) do
+        @story_data.style(story_css, role: 'stylesheet', id: 'twine-user-stylesheet', type: 'text/twine-css')
+        @story_data.script(story_js, role: 'script', id: 'twine-user-script', type: 'text/twine-javascript')
+        @passages.each do |k,v|
+          unless v[:exclude_from_output]
+            @story_data.tag!('tw-passagedata', { pid: v[:pid], name: k, tags: v[:tags].join(' ') }, v[:content])
+          end
+        end
+      end
+    end
+
+    # Returns the title of this story
+    def title
+      @story_name
+    end
+
+    # Returns the rendered XML that represents this story
+    def xmldata
+      @story_data.target!
+    end
+  end
+end

data/lib/twee2/story_format.rb

@@ -0,0 +1,25 @@
+module Twee2
+  class StoryFormatNotFoundException < Exception; end
+
+  class StoryFormat
+    # Loads the StoryFormat with the specified name
+    def initialize(name)
+      raise(StoryFormatNotFoundException) if !File::exists?(format_file_path = Twee2::buildpath("storyFormats/#{name}/format.js"))
+      @name = name
+      format_file = File::read(format_file_path)
+      format_data = format_file.match(/(["'])source\1 *: *(["']).*?[^\\]\2/)[0]
+      format_data_for_json = "\{#{format_data}\}"
+      @source = JSON.parse(format_data_for_json)['source']
+    end
+
+    # Given a story file, injects it into the StoryFormat and returns the HTML results
+    def compile(story_file)
+      @source.gsub('{{STORY_NAME}}', story_file.title).gsub('{{STORY_DATA}}', story_file.xmldata).gsub('{{STORY_FORMAT}}', @name)
+    end
+
+    # Returns an array containing the known StoryFormat names
+    def self.known_names
+      Dir.open(Twee2::buildpath('storyFormats')).to_a.sort.reject{|d|d=~/^\./}.map{|f|" * #{f}"}
+    end
+  end
+end

data/lib/twee2/version.rb

@@ -1,3 +1,3 @@
 module Twee2
-  VERSION = "0.2.0"
+  VERSION = "0.2.2"
 end

data/twee2.gemspec

@@ -25,10 +25,16 @@ Gem::Specification.new do |spec|
 
   spec.required_ruby_version = '~> 2'
 
-  spec.add_development_dependency "bundler", "~> 1.6"
-  spec.add_development_dependency "rake", '~> 10'
+  spec.add_development_dependency 'rake', '~> 10'
 
   spec.add_runtime_dependency 'builder', '~> 3.2', '>= 3.2.2'
+  spec.add_runtime_dependency 'bundler', '~> 1.6'
+  spec.add_runtime_dependency 'coffee-script', '~> 2.4', '>= 2.4.1'
+  spec.add_runtime_dependency 'coffee-script-source', '~> 1.9', '>= 1.9.1.1'
+  spec.add_runtime_dependency 'execjs', '~> 2.6', '>= 2.6.0'
   spec.add_runtime_dependency 'filewatcher', '~> 0.5', '>= 0.5.2'
+  spec.add_runtime_dependency 'haml', '~> 4.0', '>= 4.0.7'
   spec.add_runtime_dependency 'thor', '~> 0.19', '>= 0.19.1'
+  spec.add_runtime_dependency 'tilt', '~> 2.0', '>= 2.0.1'
+  spec.add_runtime_dependency 'trollop', '~> 2.1', '>= 2.1.2'
 end

metadata

@@ -1,15 +1,49 @@
 --- !ruby/object:Gem::Specification
 name: twee2
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.2.2
 platform: ruby
 authors:
 - Dan Q
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-08-20 00:00:00.000000000 Z
+date: 2015-08-21 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10'
+- !ruby/object:Gem::Dependency
+  name: builder
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.2'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.2.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.2'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.2.2
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -17,7 +51,7 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.6'
-  type: :development
+  type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
@@ -25,39 +59,65 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '1.6'
 - !ruby/object:Gem::Dependency
-  name: rake
+  name: coffee-script
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10'
-  type: :development
+        version: '2.4'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.4.1
+  type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10'
+        version: '2.4'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.4.1
 - !ruby/object:Gem::Dependency
-  name: builder
+  name: coffee-script-source
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.2'
+        version: '1.9'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 3.2.2
+        version: 1.9.1.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.2'
+        version: '1.9'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 3.2.2
+        version: 1.9.1.1
+- !ruby/object:Gem::Dependency
+  name: execjs
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.6'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.6.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.6'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.6.0
 - !ruby/object:Gem::Dependency
   name: filewatcher
   requirement: !ruby/object:Gem::Requirement
@@ -78,6 +138,26 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 0.5.2
+- !ruby/object:Gem::Dependency
+  name: haml
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.0.7
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.0.7
 - !ruby/object:Gem::Dependency
   name: thor
   requirement: !ruby/object:Gem::Requirement
@@ -98,6 +178,46 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 0.19.1
+- !ruby/object:Gem::Dependency
+  name: tilt
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.0.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.0.1
+- !ruby/object:Gem::Dependency
+  name: trollop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.1.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.1.2
 description: |2
       Designed for those who preferred the Twee (for Twine 1) approach to source management, because the command-line is awesome,
       but who want to take advantage of the new features in Twine 2.
@@ -118,6 +238,8 @@ files:
 - bin/twee2
 - doc/usage.txt
 - lib/twee2.rb
+- lib/twee2/story_file.rb
+- lib/twee2/story_format.rb
 - lib/twee2/version.rb
 - storyFormats/Harlowe/format.js
 - storyFormats/Harlowe/icon.svg