twee2 0.2.2 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b63cd0490f4dff22a79e5d67a667c6a433d899ba
-  data.tar.gz: db0132a07a752ac8700e44c2062550808ba74c26
+  metadata.gz: 56109f63237dee796f2278bfd81de350dfaa5785
+  data.tar.gz: 83c1d18094f0ecfac641f6bb439c4ca430067ae8
 SHA512:
-  metadata.gz: 74b26f90671c6f4b7e380ee4fab5f5ee0b8bc716dfaa863d85a5b0611eab6831834ecd3de0ab39ce9db69ba11ea364f7c822cecca08193bcbb946d7bdd283b2c
-  data.tar.gz: 9eeba4d00780facc6c2c112b7305596853f6771d53cebb51733d3612e1267f7da5b85c7408a36bb9158f4d154a69522f09ef4be4437b86ed371167f4e0ce1efe
+  metadata.gz: 12ac1e5acc8b98dfa4fcdf4916537a7a0038a4eec8e8fc145b1ea028d0ad56b3fdeb1ea71ba69d07c9e38610c42c2f13bba771f6ccdcf3d7adb787da91768013
+  data.tar.gz: 9287dd8b3fe73f71245823da9d3a73d163d50b2420a529e250fec79a7d2392b25702c1f9d1a8dc21c2428b49ffc03c4ee9551801d7ead50272975def7f40e4af

data/Gemfile

@@ -4,4 +4,6 @@ gem 'thor'
 gem 'builder'
 gem 'filewatcher'
 gem 'haml'
-gem 'coffee-script'
+gem 'coffee-script'
+gem 'nokogiri'
+gem 'sass'

data/README.md

@@ -14,6 +14,10 @@ Right now Twee2 doesn't even support the diversity of original Twee, and it's po
 
 I'd love to hear your thoughts about the future of this gem.
 
+## Prerequisites
+
+You'll need Ruby. Instructions on easily installing it on MacOS, Windows, and Linux can be found at https://www.ruby-lang.org/en/documentation/installation/.
+
 ## Installation
 
 Install using gem
@@ -22,6 +26,10 @@ Install using gem
 
 ## Usage
 
+To see usage examples and fuller instructions (documentation on this page is lacking, but as-yet no documentation is complete):
+
+    twee2
+
 To compile a Twee file into a HTML file using the default format (Harlowe):
 
     twee2 build inputfile.twee outputfile.html
@@ -36,6 +44,31 @@ For additional features (e.g. listing known formats, watch-for-changes mode), ru
 
 Aside from the regular Twee features, Twee2 provides the following enhancements:
 
+### Multi-file inclusion (super-experimental)
+
+You can combine multiple input files into one via either (or both!) of two different methods:
+
+#### StoryIncludes
+
+Borrowed from Twee: simply list the files to include in the special StoryIncludes passage. Each will be appended to the end of your source file on compilation.
+
+```
+::StoryIncludes
+my-sub-story.tw2
+```
+
+Looking for something more-powerful? Use ::@include-syntax, e.g.:
+
+```
+::IncompleteRoom [haml]
+%p
+  This room is incomplete. Come back later.
+:coffeescript
+  ::@include incomplete-room-js.coffee
+```
+
+The requested file will be nested directly in place. Indent levels will be preserved, which makes it safe for use within HAML, Coffeescript, and SASS. This makes it easy to re-use content throughout your story by simply inserting it in multiple places.
+
 ### HAML support
 
 You can declare your passages using [HAML markup](http://haml.info/docs/yardoc/file.REFERENCE.html) by applying a 'haml' tag to the passage, e.g.:
@@ -56,6 +89,21 @@ If you'd rather write your Javascript in [Coffeescript](http://coffeescript.org/
     alert 'Welcome to my game!'
 ```
 
+### SASS/SCSS stylesheets
+
+Prefer SASS for your stylesheets? Just use a 'sass' or 'scss' tag alongside your 'stylesheet' tag, or use a :sass or :scss block in HAML:
+
+```
+::MyStylesheet [scss stylesheet]
+body {
+  color: #eee;
+}
+tw-passage {
+  tw-link {
+    color: red;
+  }
+}
+
 ## Notes
 
 * This is not a Twee to Harlowe converter. You'll still need to change your macros as described at http://twine2.neocities.org/, and/or rewrite them as Javascript code.

data/bin/twee2

@@ -24,6 +24,11 @@ class Twee2CLI < Thor
     Twee2::formats
   end
 
+  desc 'decompile [URL] [OUTPUT]', 'reverse-engineers Twee2/Twine 2 HTML output into a Twee2 source file'
+  def decompile(url, output)
+    Twee2::decompile(url, output)
+  end
+
   desc 'help', 'shows usage instructions'
   def help
     Twee2::help

data/doc/usage.txt

@@ -13,5 +13,9 @@ Usage:
   twee2 formats
     Lists the output formats that are understood.
 
+  twee2 decompile [URL] [output.tw2]
+    Decompiles a Twee2/Twine 2 HTML output file at a specified URL into
+    a Twee2 source file.
+
   twee2 help
     Displays this message.

data/lib/twee2.rb

@@ -1,8 +1,8 @@
 Encoding.default_external = Encoding.default_internal = Encoding::UTF_8
 
 # Prerequisites (managed by bundler)
-%w{rubygems bundler/setup thor json builder filewatcher haml coffee_script
-   twee2/version twee2/story_format twee2/story_file}.each do |prerequisite|
+%w{rubygems bundler/setup thor json builder filewatcher haml coffee_script nokogiri open-uri singleton sass
+   twee2/version twee2/story_format twee2/story_file twee2/decompiler twee2/build_config}.each do |prerequisite|
   require prerequisite
 end
 
@@ -12,12 +12,12 @@ module Twee2
 
   def self.build(input, output, options = {})
     # Read and parse format file
-    story_format = StoryFormat::new(options[:format])
+    build_config.story_format = StoryFormat::new(options[:format])
     # Read and parse input file
-    story_file = StoryFile::new(input)
+    build_config.story_file = StoryFile::new(input)
     # Produce output file
     File::open(output, 'w') do |out|
-      out.print story_format.compile(story_file)
+      out.print build_config.story_format.compile
     end
     puts "Done"
   end
@@ -37,6 +37,14 @@ module Twee2
     puts StoryFormat.known_names.join("\n")
   end
 
+  # Reverse-engineers a Twee2/Twine 2 output HTML file into a Twee2 source file
+  def self.decompile(url, output)
+    File::open(output, 'w') do |out|
+      out.print Decompiler::decompile(url)
+    end
+    puts "Done"
+  end
+
   def self.help
     puts "Twee2 #{Twee2::VERSION}"
     puts File.read(buildpath('doc/usage.txt'))

data/lib/twee2/build_config.rb

@@ -0,0 +1,16 @@
+module Twee2
+  class BuildConfig
+    include Singleton
+
+    attr_accessor :story_format, :story_file, :story_name
+
+    # Set defaults
+    def initialize
+      @story_name = 'An unnamed story'
+    end
+  end
+
+  def self.build_config
+    BuildConfig::instance
+  end
+end

data/lib/twee2/decompiler.rb

@@ -0,0 +1,48 @@
+module Twee2
+  class DecompilationFailedException < Exception; end
+
+  class Decompiler
+    def self.decompile(url)
+      result = ''
+      # Load the compiled HTML and sanity-check it
+      html = Nokogiri::HTML(open(url))
+      raise(DecompilationFailedException, 'tw-storydata not found') unless storydata = html.at_css('tw-storydata')
+      # Extract the tw-storydata#name (StoryTitle) and #startnode
+      result << "::StoryTitle\n#{storydata[:name].strip}\n\n"
+      startnode_pid, startnode_name = storydata[:startnode].strip, nil
+      # Extract the custom CSS and Javascript, if applicable
+      if (css = storydata.at_css('#twine-user-stylesheet')) && ((css_content = css.content.strip) != '')
+        result << "::StoryCSS [stylesheet]\n#{css_content}\n\n"
+      end
+      if (js = storydata.at_css('#twine-user-script')) && ((js_content = js.content.strip) != '')
+        result << "::StoryJS [script]\n#{js.content}\n\n"
+      end
+      # Extract each passage
+      storydata.css('tw-passagedata').each do |passagedata|
+        # Check if this is the start passage and record this accordingly
+        startnode_name = passagedata[:name] if(startnode_pid == passagedata[:pid])
+        # Write the passage out
+        result << "::#{passagedata[:name].strip}"
+        result << " [#{passagedata[:tags].strip}]" if passagedata[:tags].strip != ''
+        result << " <#{passagedata[:position].strip}>" if passagedata[:position].strip != ''
+        result << "\n#{tidyup_passagedata(passagedata.content.strip)}\n\n"
+      end
+      # Write the Twee2 settings out (compatability layer)
+      result << "::Twee2Settings [twee2]\n"
+      result << "@story_start_name = '#{startnode_name.gsub("'", "\\'")}'\n" if startnode_name
+      result << "\n"
+      # Return the result
+      result
+    end
+
+    protected
+
+    # Fixes common problems with decompiled passage content
+    def self.tidyup_passagedata(passagedata_content)
+      passagedata_content.gsub(/\[\[ *(.*?) *\]\]/, '[[\1]]').                # remove excess spacing within links: not suitable for Twee-style source
+                          gsub(/\[\[ *(.*?) *<- *(.*?) *\]\]/, '[[\1<-\2]]'). # ditto
+                          gsub(/\[\[ *(.*?) *-> *(.*?) *\]\]/, '[[\1->\2]]'). # ditto
+                          gsub(/\[\[ *(.*?) *\| *(.*?) *\]\]/, '[[\1|\2]]')   # ditto
+    end
+  end
+end

data/lib/twee2/story_file.rb

@@ -2,6 +2,8 @@ module Twee2
   class StoryFileNotFoundException < Exception; end
 
   class StoryFile
+    attr_accessor :passages
+
     HAML_OPTIONS = {
       remove_whitespace: true
     }
@@ -14,34 +16,55 @@ module Twee2
     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}
+      # Load file into memory to begin with
+      lines = File::read(filename).split(/\r?\n/)
+      # First pass - go through and perform 'includes'
+      i, in_story_includes_section = 0, false
+      while i < lines.length
+        line = lines[i]
+        if line =~ /^:: *StoryIncludes */
+          in_story_includes_section = true
+        elsif line =~ /^::/
+          in_story_includes_section = false
+        elsif in_story_includes_section && (line.strip != '')
+          # include a file here because we're in the StoryIncludes section
+          if File::exists?(line.strip)
+            lines.push(*File::read(line.strip).split(/\r?\n/)) # add it on to the end
+          else
+            puts "WARNING: tried to include file '#{line.strip}' via StoryIncludes but file was not found."
+          end
+        elsif line =~ /^( *)::@include (.*)$/
+          # include a file here because an @include directive was spotted
+          prefix, filename = $1, $2.strip
+          if File::exists?(filename)
+            lines[i,1] = File::read(filename).split(/\r?\n/).map{|l|"#{prefix}#{l}"} # insert in-place, with prefix of appropriate amount of whitespace
+            i-=1 # process this line again, in case of ::@include nesting
+          else
+            puts "WARNING: tried to ::@include file '#{filename}' but file was not found."
+          end
+        end
+        i+=1
+      end
+      # Second pass - parse the file
+      lines.each do |line|
+        if line =~ /^:: *([^\[]*?) *(\[(.*?)\])? *(<(.*?)>)? *$/
+          @passages[current_passage = $1.strip] = { tags: ($3 || '').split(' '), position: $5, content: '', exclude_from_output: false, pid: nil}
         elsif current_passage
-          @passages[current_passage][:content] << line
+          @passages[current_passage][:content] << "#{line}\n"
         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
+      run_preprocessors
       # 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
+      story_css, story_js, pid, @story_start_pid, @story_start_name = '', '', 0, nil, 'Start'
       @passages.each_key do |k|
         if k == 'StoryTitle'
-          @story_name = @passages[k][:content]
+          Twee2::build_config.story_name = @passages[k][:content]
           @passages[k][:exclude_from_output] = true
-        elsif %w{StorySubtitle StoryAuthor StoryMenu StorySettings StoryIncludes}.include? k
+        elsif k == 'StoryIncludes'
+          @passages[k][:exclude_from_output] = true # includes should already have been handled above
+        elsif %w{StorySubtitle StoryAuthor StoryMenu StorySettings}.include? k
           puts "WARNING: ignoring passage '#{k}'"
           @passages[k][:exclude_from_output] = true
         elsif @passages[k][:tags].include? 'stylesheet'
@@ -50,35 +73,54 @@ module Twee2
         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
+        elsif @passages[k][:tags].include? 'twee2'
+          eval @passages[k][:content]
+          @passages[k][:exclude_from_output] = true
         else
           @passages[k][:pid] = (pid += 1)
         end
       end
+      @story_start_pid = (@passages[@story_start_name] || {pid: 1})[:pid]
       # 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.tag!('tw-storydata', { name: Twee2::build_config.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])
+            @story_data.tag!('tw-passagedata', { pid: v[:pid], name: k, tags: v[:tags].join(' '), position: v[:position] }, 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
+
+    # Runs HAML, Coffeescript etc. preprocessors across each applicable passage
+    def run_preprocessors
+      @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
+        # SASS / SCSS
+        if @passages[k][:tags].include? 'sass'
+          @passages[k][:content] =  Sass::Engine.new(@passages[k][:content], :syntax => :sass).render
+        end
+        if @passages[k][:tags].include? 'scss'
+          @passages[k][:content] =  Sass::Engine.new(@passages[k][:content], :syntax => :scss).render
+        end
+      end
+    end
   end
 end

data/lib/twee2/story_format.rb

@@ -13,8 +13,8 @@ module Twee2
     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)
+    def compile
+      @source.gsub('{{STORY_NAME}}', Twee2::build_config.story_name).gsub('{{STORY_DATA}}', Twee2::build_config.story_file.xmldata).gsub('{{STORY_FORMAT}}', @name)
     end
 
     # Returns an array containing the known StoryFormat names

data/lib/twee2/version.rb

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

data/twee2.gemspec

@@ -34,6 +34,8 @@ Gem::Specification.new do |spec|
   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 'nokogiri', '~> 1.6', '>= 1.6.6.2'
+  spec.add_runtime_dependency 'sass', '~> 3.2', '>= 3.2.19'
   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'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: twee2
 version: !ruby/object:Gem::Version
-  version: 0.2.2
+  version: 0.3.0
 platform: ruby
 authors:
 - Dan Q
@@ -158,6 +158,46 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 4.0.7
+- !ruby/object:Gem::Dependency
+  name: nokogiri
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.6.6.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.6.6.2
+- !ruby/object:Gem::Dependency
+  name: sass
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.2'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.2.19
+  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.19
 - !ruby/object:Gem::Dependency
   name: thor
   requirement: !ruby/object:Gem::Requirement
@@ -238,6 +278,8 @@ files:
 - bin/twee2
 - doc/usage.txt
 - lib/twee2.rb
+- lib/twee2/build_config.rb
+- lib/twee2/decompiler.rb
 - lib/twee2/story_file.rb
 - lib/twee2/story_format.rb
 - lib/twee2/version.rb