rmxp_extractor 1.7 → 1.8

data/lib/rmxp_extractor/script_handler.rb

@@ -1,85 +1,85 @@
-#!/usr/bin/ruby
-require "zlib"
-
-module RMXPExtractor
-  def self.rpgscript(game_dir, scripts_dir, script_name, extract = false)
-    # Determine version of game engine
-    game_data_dir = File.join(game_dir, "Data")
-    unless Dir.exist? game_data_dir
-      STDERR.puts "error: #{game_dir} does not have a Data subdirectory"
-      exit 1
-    end
-
-    target_path = File.join(game_data_dir, script_name)
-
-    # Generate path of script list
-    list_path = File.join(scripts_dir, "_scripts.txt")
-
-    if extract
-      # Make sure the script directory exists
-      Dir.mkdir(scripts_dir) unless Dir.exists? scripts_dir
-
-      # Keep track of names of scripts extracted so we can warn about duplicates
-      names = Hash.new(0)
-
-      # Read scripts
-      File.open(target_path, "rb") do |fin|
-        File.open(list_path, "w") do |flist|
-          Marshal.load(fin).each_with_index do |script, index|
-            name = script[1].strip
-            data = Zlib::Inflate.inflate(script[2]).rstrip
-              .gsub(/[ \t]*(?:$|\r\n?)/, "\n")
-
-            # Make sure this file doesn't already exist
-            if name.empty?
-              if data.empty? || data == "\n"
-                flist.puts
-                next
-              else
-                name = "UNTITLED"
-              end
-            end
-
-            names[name] += 1
-            if names[name] > 1
-              name << " (#{names[name]})"
-            end
-
-            if data.empty? || data == "\n"
-              # Treat this like a comment
-              flist.puts("# " + name)
-            else
-              # Write to file order list
-              flist.puts(name)
-
-              # Write script file
-              File.open(File.join(scripts_dir, name + ".rb"), "wb") do |fout|
-                fout.write(data)
-              end
-            end
-          end
-        end
-      end
-      #puts "#{target_path} extracted."
-    else
-      # Write scripts
-      scripts = []
-
-      IO.foreach(list_path) do |name|
-        name.strip!
-        next if name.empty? || name.start_with?("#")
-
-        data = File.read(File.join(scripts_dir, name + ".rb")).rstrip.gsub("\n", "\r\n")
-
-        script = Array.new(3)
-        script[0] = 0
-        script[1] = name
-        script[2] = Zlib.deflate(data)
-        scripts << script
-      end
-
-      File.open(target_path, "wb") { |f| f.write(Marshal.dump(scripts)) }
-      #puts "#{target_path} written."
-    end
-  end
-end
+#!/usr/bin/ruby
+require "zlib"
+
+module RMXPExtractor
+  def self.rpgscript(game_dir, scripts_dir, script_name, extract = false)
+    # Determine version of game engine
+    game_data_dir = File.join(game_dir, "Data")
+    unless Dir.exist? game_data_dir
+      STDERR.puts "error: #{game_dir} does not have a Data subdirectory"
+      exit 1
+    end
+
+    target_path = File.join(game_data_dir, script_name)
+
+    # Generate path of script list
+    list_path = File.join(scripts_dir, "_scripts.txt")
+
+    if extract
+      # Make sure the script directory exists
+      Dir.mkdir(scripts_dir) unless Dir.exists? scripts_dir
+
+      # Keep track of names of scripts extracted so we can warn about duplicates
+      names = Hash.new(0)
+
+      # Read scripts
+      File.open(target_path, "rb") do |fin|
+        File.open(list_path, "w") do |flist|
+          Marshal.load(fin).each_with_index do |script, index|
+            name = script[1].strip
+            data = Zlib::Inflate.inflate(script[2]).rstrip
+              .gsub(/[ \t]*(?:$|\r\n?)/, "\n")
+
+            # Make sure this file doesn't already exist
+            if name.empty?
+              if data.empty? || data == "\n"
+                flist.puts
+                next
+              else
+                name = "UNTITLED"
+              end
+            end
+
+            names[name] += 1
+            if names[name] > 1
+              name << " (#{names[name]})"
+            end
+
+            if data.empty? || data == "\n"
+              # Treat this like a comment
+              flist.puts("# " + name)
+            else
+              # Write to file order list
+              flist.puts(name)
+
+              # Write script file
+              File.open(File.join(scripts_dir, name + ".rb"), "wb") do |fout|
+                fout.write(data)
+              end
+            end
+          end
+        end
+      end
+      #puts "#{target_path} extracted."
+    else
+      # Write scripts
+      scripts = []
+
+      IO.foreach(list_path) do |name|
+        name.strip!
+        next if name.empty? || name.start_with?("#")
+
+        data = File.read(File.join(scripts_dir, name + ".rb")).rstrip.gsub("\n", "\r\n")
+
+        script = Array.new(3)
+        script[0] = 0
+        script[1] = name
+        script[2] = Zlib.deflate(data)
+        scripts << script
+      end
+
+      File.open(target_path, "wb") { |f| f.write(Marshal.dump(scripts)) }
+      #puts "#{target_path} written."
+    end
+  end
+end

data/lib/rmxp_extractor/version.rb

@@ -1,3 +1,3 @@
-module RMXPExtractor
-  VERSION = "1.7"
-end
+module RMXPExtractor
+  VERSION = "1.8"
+end

data/lib/rmxp_extractor.rb

@@ -1,46 +1,46 @@
-module RMXPExtractor
-  require "rmxp_extractor/data_export"
-  require "rmxp_extractor/data_import"
-  require "rmxp_extractor/script_handler"
-  require "rmxp_extractor/version"
-
-  FORMATS = ["json", "yaml", "rb", "ron"]
-
-  def self.usage
-    STDERR.puts "usage: rmxp_extractor < -v/--version > import/export <type = json> | scripts"
-    exit 1
-  end
-
-  def self.process(type)
-    RMXPExtractor.usage if type.length < 1
-
-    case type[0]
-    when "-v", "--version"
-      puts VERSION
-    when "import"
-      check_format(type[1])
-      import(type[1])
-    when "export"
-      check_format(type[1])
-      export(type[1])
-    when "scripts"
-      if type.length < 4 || type.length > 5
-        STDERR.puts "usage: rmxp_extractor scripts game_dir scripts_dir scripts_name  [x]"
-        exit 1
-      else
-        puts type.to_s
-        RMXPExtractor.rpgscript(type[1], type[2], type[3], type[4] == "x")
-      end
-    else
-      RMXPExtractor.usage
-    end
-  end
-
-  def self.check_format(format)
-    format = "json" if format.nil?
-    unless FORMATS.include?(format)
-      warn "Allowed formats: #{FORMATS.to_s}"
-      exit 1
-    end
-  end
-end
+module RMXPExtractor
+  require "rmxp_extractor/data_export"
+  require "rmxp_extractor/data_import"
+  require "rmxp_extractor/script_handler"
+  require "rmxp_extractor/version"
+
+  FORMATS = ["json", "yaml", "rb", "ron"]
+
+  def self.usage
+    STDERR.puts "usage: rmxp_extractor < -v/--version > import/export <type = json> | scripts"
+    exit 1
+  end
+
+  def self.process(type)
+    RMXPExtractor.usage if type.length < 1
+
+    case type[0]
+    when "-v", "--version"
+      puts VERSION
+    when "import"
+      check_format(type[1])
+      import(type[1])
+    when "export"
+      check_format(type[1])
+      export(type[1])
+    when "scripts"
+      if type.length < 4 || type.length > 5
+        STDERR.puts "usage: rmxp_extractor scripts game_dir scripts_dir scripts_name  [x]"
+        exit 1
+      else
+        puts type.to_s
+        RMXPExtractor.rpgscript(type[1], type[2], type[3], type[4] == "x")
+      end
+    else
+      RMXPExtractor.usage
+    end
+  end
+
+  def self.check_format(format)
+    format = "json" if format.nil?
+    unless FORMATS.include?(format)
+      warn "Allowed formats: #{FORMATS.to_s}"
+      exit 1
+    end
+  end
+end

data/rmxp_extractor.gemspec

@@ -1,30 +1,30 @@
-require_relative "lib/rmxp_extractor/version"
-
-Gem::Specification.new do |spec|
-  spec.name = "rmxp_extractor"
-  spec.version = RMXPExtractor::VERSION
-  spec.authors = ["Speak2Erase"]
-  spec.email = ["matthew@nowaffles.com"]
-
-  spec.summary = %q{A gem to dump *.rxdata files to JSON}
-  spec.description = %q{A gem to dump and import *.rxdata files to and from JSON}
-  spec.homepage = "https://rubygems.org/gems/rmxp_extractor"
-  spec.required_ruby_version = Gem::Requirement.new(">= 2.7.0")
-  spec.license = "MIT"
-
-  spec.metadata["homepage_uri"] = spec.homepage
-  spec.metadata["source_code_uri"] = "https://github.com/Speak2Erase/RMXP-Extractor"
-
-  # Specify which files should be added to the gem when it is released.
-  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
-  spec.files = Dir["**/**"].grep_v(/.gem$/)
-
-  spec.executables = ["rmxp_extractor"]
-  spec.require_paths = ["lib"]
-  spec.add_dependency "oj"
-  spec.add_dependency "ruby-progressbar"
-  spec.add_dependency "fileutils"
-  spec.add_dependency "pathname"
-  spec.add_dependency "json"
-  spec.add_dependency "zlib"
-end
+require_relative "lib/rmxp_extractor/version"
+
+Gem::Specification.new do |spec|
+  spec.name = "rmxp_extractor"
+  spec.version = RMXPExtractor::VERSION
+  spec.authors = ["Speak2Erase"]
+  spec.email = ["matthew@nowaffles.com"]
+
+  spec.summary = %q{A gem to dump *.rxdata files to JSON}
+  spec.description = %q{A gem to dump and import *.rxdata files to and from JSON}
+  spec.homepage = "https://rubygems.org/gems/rmxp_extractor"
+  spec.required_ruby_version = Gem::Requirement.new(">= 2.7.0")
+  spec.license = "MIT"
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = "https://github.com/Speak2Erase/RMXP-Extractor"
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files = Dir["**/**"].grep_v(/.gem$/)
+
+  spec.executables = ["rmxp_extractor"]
+  spec.require_paths = ["lib"]
+  spec.add_dependency "oj"
+  spec.add_dependency "ruby-progressbar"
+  spec.add_dependency "fileutils"
+  spec.add_dependency "pathname"
+  spec.add_dependency "json"
+  spec.add_dependency "zlib"
+end

data/spec/spec_helper.rb

@@ -1,100 +1,100 @@
-# This file was generated by the `rspec --init` command. Conventionally, all
-# specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.
-# The generated `.rspec` file contains `--require spec_helper` which will cause
-# this file to always be loaded, without a need to explicitly require it in any
-# files.
-#
-# Given that it is always loaded, you are encouraged to keep this file as
-# light-weight as possible. Requiring heavyweight dependencies from this file
-# will add to the boot time of your test suite on EVERY test run, even for an
-# individual file that may not need all of that loaded. Instead, consider making
-# a separate helper file that requires the additional dependencies and performs
-# the additional setup, and require it from the spec files that actually need
-# it.
-#
-# See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
-RSpec.configure do |config|
-  # rspec-expectations config goes here. You can use an alternate
-  # assertion/expectation library such as wrong or the stdlib/minitest
-  # assertions if you prefer.
-  config.expect_with :rspec do |expectations|
-    # This option will default to `true` in RSpec 4. It makes the `description`
-    # and `failure_message` of custom matchers include text for helper methods
-    # defined using `chain`, e.g.:
-    #     be_bigger_than(2).and_smaller_than(4).description
-    #     # => "be bigger than 2 and smaller than 4"
-    # ...rather than:
-    #     # => "be bigger than 2"
-    expectations.include_chain_clauses_in_custom_matcher_descriptions = true
-  end
-
-  # rspec-mocks config goes here. You can use an alternate test double
-  # library (such as bogus or mocha) by changing the `mock_with` option here.
-  config.mock_with :rspec do |mocks|
-    # Prevents you from mocking or stubbing a method that does not exist on
-    # a real object. This is generally recommended, and will default to
-    # `true` in RSpec 4.
-    mocks.verify_partial_doubles = true
-  end
-
-  # This option will default to `:apply_to_host_groups` in RSpec 4 (and will
-  # have no way to turn it off -- the option exists only for backwards
-  # compatibility in RSpec 3). It causes shared context metadata to be
-  # inherited by the metadata hash of host groups and examples, rather than
-  # triggering implicit auto-inclusion in groups with matching metadata.
-  config.shared_context_metadata_behavior = :apply_to_host_groups
-
-# The settings below are suggested to provide a good initial experience
-# with RSpec, but feel free to customize to your heart's content.
-=begin
-  # This allows you to limit a spec run to individual examples or groups
-  # you care about by tagging them with `:focus` metadata. When nothing
-  # is tagged with `:focus`, all examples get run. RSpec also provides
-  # aliases for `it`, `describe`, and `context` that include `:focus`
-  # metadata: `fit`, `fdescribe` and `fcontext`, respectively.
-  config.filter_run_when_matching :focus
-
-  # Allows RSpec to persist some state between runs in order to support
-  # the `--only-failures` and `--next-failure` CLI options. We recommend
-  # you configure your source control system to ignore this file.
-  config.example_status_persistence_file_path = "spec/examples.txt"
-
-  # Limits the available syntax to the non-monkey patched syntax that is
-  # recommended. For more details, see:
-  #   - http://rspec.info/blog/2012/06/rspecs-new-expectation-syntax/
-  #   - http://www.teaisaweso.me/blog/2013/05/27/rspecs-new-message-expectation-syntax/
-  #   - http://rspec.info/blog/2014/05/notable-changes-in-rspec-3/#zero-monkey-patching-mode
-  config.disable_monkey_patching!
-
-  # This setting enables warnings. It's recommended, but in some cases may
-  # be too noisy due to issues in dependencies.
-  config.warnings = true
-
-  # Many RSpec users commonly either run the entire suite or an individual
-  # file, and it's useful to allow more verbose output when running an
-  # individual spec file.
-  if config.files_to_run.one?
-    # Use the documentation formatter for detailed output,
-    # unless a formatter has already been configured
-    # (e.g. via a command-line flag).
-    config.default_formatter = "doc"
-  end
-
-  # Print the 10 slowest examples and example groups at the
-  # end of the spec run, to help surface which specs are running
-  # particularly slow.
-  config.profile_examples = 10
-
-  # Run specs in random order to surface order dependencies. If you find an
-  # order dependency and want to debug it, you can fix the order by providing
-  # the seed, which is printed after each run.
-  #     --seed 1234
-  config.order = :random
-
-  # Seed global randomization in this process using the `--seed` CLI option.
-  # Setting this allows you to use `--seed` to deterministically reproduce
-  # test failures related to randomization by passing the same `--seed` value
-  # as the one that triggered the failure.
-  Kernel.srand config.seed
-=end
-end
+# This file was generated by the `rspec --init` command. Conventionally, all
+# specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.
+# The generated `.rspec` file contains `--require spec_helper` which will cause
+# this file to always be loaded, without a need to explicitly require it in any
+# files.
+#
+# Given that it is always loaded, you are encouraged to keep this file as
+# light-weight as possible. Requiring heavyweight dependencies from this file
+# will add to the boot time of your test suite on EVERY test run, even for an
+# individual file that may not need all of that loaded. Instead, consider making
+# a separate helper file that requires the additional dependencies and performs
+# the additional setup, and require it from the spec files that actually need
+# it.
+#
+# See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
+RSpec.configure do |config|
+  # rspec-expectations config goes here. You can use an alternate
+  # assertion/expectation library such as wrong or the stdlib/minitest
+  # assertions if you prefer.
+  config.expect_with :rspec do |expectations|
+    # This option will default to `true` in RSpec 4. It makes the `description`
+    # and `failure_message` of custom matchers include text for helper methods
+    # defined using `chain`, e.g.:
+    #     be_bigger_than(2).and_smaller_than(4).description
+    #     # => "be bigger than 2 and smaller than 4"
+    # ...rather than:
+    #     # => "be bigger than 2"
+    expectations.include_chain_clauses_in_custom_matcher_descriptions = true
+  end
+
+  # rspec-mocks config goes here. You can use an alternate test double
+  # library (such as bogus or mocha) by changing the `mock_with` option here.
+  config.mock_with :rspec do |mocks|
+    # Prevents you from mocking or stubbing a method that does not exist on
+    # a real object. This is generally recommended, and will default to
+    # `true` in RSpec 4.
+    mocks.verify_partial_doubles = true
+  end
+
+  # This option will default to `:apply_to_host_groups` in RSpec 4 (and will
+  # have no way to turn it off -- the option exists only for backwards
+  # compatibility in RSpec 3). It causes shared context metadata to be
+  # inherited by the metadata hash of host groups and examples, rather than
+  # triggering implicit auto-inclusion in groups with matching metadata.
+  config.shared_context_metadata_behavior = :apply_to_host_groups
+
+# The settings below are suggested to provide a good initial experience
+# with RSpec, but feel free to customize to your heart's content.
+=begin
+  # This allows you to limit a spec run to individual examples or groups
+  # you care about by tagging them with `:focus` metadata. When nothing
+  # is tagged with `:focus`, all examples get run. RSpec also provides
+  # aliases for `it`, `describe`, and `context` that include `:focus`
+  # metadata: `fit`, `fdescribe` and `fcontext`, respectively.
+  config.filter_run_when_matching :focus
+
+  # Allows RSpec to persist some state between runs in order to support
+  # the `--only-failures` and `--next-failure` CLI options. We recommend
+  # you configure your source control system to ignore this file.
+  config.example_status_persistence_file_path = "spec/examples.txt"
+
+  # Limits the available syntax to the non-monkey patched syntax that is
+  # recommended. For more details, see:
+  #   - http://rspec.info/blog/2012/06/rspecs-new-expectation-syntax/
+  #   - http://www.teaisaweso.me/blog/2013/05/27/rspecs-new-message-expectation-syntax/
+  #   - http://rspec.info/blog/2014/05/notable-changes-in-rspec-3/#zero-monkey-patching-mode
+  config.disable_monkey_patching!
+
+  # This setting enables warnings. It's recommended, but in some cases may
+  # be too noisy due to issues in dependencies.
+  config.warnings = true
+
+  # Many RSpec users commonly either run the entire suite or an individual
+  # file, and it's useful to allow more verbose output when running an
+  # individual spec file.
+  if config.files_to_run.one?
+    # Use the documentation formatter for detailed output,
+    # unless a formatter has already been configured
+    # (e.g. via a command-line flag).
+    config.default_formatter = "doc"
+  end
+
+  # Print the 10 slowest examples and example groups at the
+  # end of the spec run, to help surface which specs are running
+  # particularly slow.
+  config.profile_examples = 10
+
+  # Run specs in random order to surface order dependencies. If you find an
+  # order dependency and want to debug it, you can fix the order by providing
+  # the seed, which is printed after each run.
+  #     --seed 1234
+  config.order = :random
+
+  # Seed global randomization in this process using the `--seed` CLI option.
+  # Setting this allows you to use `--seed` to deterministically reproduce
+  # test failures related to randomization by passing the same `--seed` value
+  # as the one that triggered the failure.
+  Kernel.srand config.seed
+=end
+end