narc 0.0.0 → 1.0.0

data/LICENSE

@@ -0,0 +1,9 @@
+== narc
+
+Copyright (c) 2011 arc_meta
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README

@@ -4,9 +4,19 @@
 This gem provides a simple API for packing/unpacking *NARC* (Nitro ARChive) files, an archive file format commonly used in Nintendo DS games. It also counts with a (very) simple command line interface.
 
 === Known Bugs/Issues
-* Unable to pack/unpack NARC files containing files with filenames and/or folders.
+* Unable to pack/unpack NARC files containing folders.
 
 === Version Log
 
+==== 1.0.0
+* Added support for NARC files with filenamed elements.
+* Now, the filenames of extracted elements of NARC files with no filenames have the format "[element index]_[element index]". E.g:
+    0002_0002
+  While the filenames of extracted elements of NARC files with named elements look like this:
+    0002_elementname
+  This is done so that when the elements are stored back into the narc, they are stored in the correct order. If the NARC is made with filenamed elements, the index number and the underscore won't appear in the elements' names.    
+* Added new command to pack NARC files with element names to the CLI.
+* Added some documentation.
+
 ==== 0.0.0
 * Initial version.

data/Rakefile

@@ -12,17 +12,17 @@ require 'rake/testtask'
 
 spec = Gem::Specification.new do |s|
   s.name = 'narc'
-  s.version = '0.0.0'
+  s.version = '1.0.0'
   s.platform = Gem::Platform::RUBY
   s.has_rdoc = true
-  s.extra_rdoc_files = ['README']
+  s.extra_rdoc_files = ['README', 'LICENSE']
   s.summary = 'A NARC file packing/unpacking gem.'
   s.description = 'This gem provides a simple API for packing/unpacking NARC (Nitro ARChive) files, an archive file format commonly used in Nintendo DS games. It also counts with a (very) simple command line interface.'
   s.author = 'arc_meta'
   s.email = 'arc_nerotech@hotmail.com'
   s.homepage = 'https://rubygems.org/gems/narc'
   s.executables << 'narc'
-  s.files = %w(README Rakefile) + Dir.glob("{bin,lib,spec}/**/*")
+  s.files = %w(LICENSE README Rakefile) + Dir.glob("{bin,lib,spec}/**/*")
   s.require_path = "lib"
   s.bindir = "bin"
 end

data/lib/narc.rb

@@ -15,6 +15,13 @@ require 'narc/cli.rb'
 
 class NarcFile
   attr_accessor :name, :elements
+
+=begin rdoc
+    NarcFile.new( [name] ) => NarcFile
+
+
+Instantiates a new <code>NarcFile</code> object. If <code>name</code> is not specified, the name of the NarcFile object will be just "narc".
+=end
   
   def initialize(name = "narc")
     @name = name
@@ -23,6 +30,13 @@ class NarcFile
     @size_offsets = {}
   end
   
+=begin rdoc
+    NarcFile.open( filename ) => NarcFile
+
+
+Instantiates a new <code>NarcFile</code> object from the contents of a NARC file <code>filename</code>.
+=end
+  
   def self.open(filename)
     io = File.open(filename, "rb")
     narc = self.new(File.basename(filename, ".narc"))
@@ -31,25 +45,39 @@ class NarcFile
     return narc
   end
 
+=begin rdoc
+    narcfile.extract_to_folder( [folder name] ) => nil
+
+
+Dumps the elements of the current <code>NarcFile</code> object to a folder. If <code>folder name</code> is nil or omitted, this folder will be named "ex_<code>[name of the NarcFile object]</code>"
+=end
+
   def extract_to_folder(folder_name = nil)
     folder_name ||= "ex_" + @name
     Dir.mkdir(folder_name) unless Dir.exists?(folder_name)
     Dir.chdir(folder_name) do
-      for element in @elements
-        File.open(element.name, "wb") do |file|
+      @elements.each_with_index do |element, i|
+        File.open(("%04d" % i) + "_" + element.name, "wb") do |file|
           file.write(element.data)
         end
       end
     end
   end
 
+=begin rdoc
+    NarcFile.from_folder( [folder name] ) => NarcFile
+
+
+Instantiates a new <code>NarcFile</code> object from the contents of a folder <code>folder name</code>.
+=end
+  
   def self.from_folder(dir)
     narc = self.new(File.basename(dir))
     files = Dir.entries(dir).sort - [".", ".."]
     narc.elements = Array.new(files.size) do Narc::Element.new end
     Dir.chdir(dir) do
       files.each_with_index do |file, i|
-        narc.elements[i].name = file.split("_")[-1]
+        narc.elements[i].name = file.split("_", 2)[-1]
         File.open(file, "rb") do |f|
           narc.elements[i].data = f.read
         end
@@ -58,18 +86,52 @@ class NarcFile
     return narc
   end
 
+=begin rdoc
+    narcfile.save( [filename] , [include_names?] ) => nil
+
+
+Makes a NARC file <code>filename</code> from the contents of the current <code>NarcFile</code> object.
+
+If <code>filename</code> is nil or omitted, the filename of the new NARC file will be "saved_<code>[name of the NarcFile object]</code>".
+
+If <code>include_names?</code> is true, the elements in the NARC file will be named, else, they won't. <em>Default is false</em>.
+
+
+=end
+  
   def save(filename = nil, include_names = false)
     filename ||= "saved_" + self.name
     File.open(filename, "w+b") do |f|
       write_narc_section(f)
       write_fatb_section(f)
-      write_fntb_section(f)
+      write_fntb_section(f, include_names)
       write_fimg_section(f)
       write_size_data(f)
     end
   end
 
-  def get_data(io)
+=begin rdoc
+    narcfile.get_element( [integer] ) => Narc::Element
+    narcfile.get_element( [string] ) => Narc::Element
+
+If the parameter is a <code>Integer</code>, returns the element of the same index.
+
+If it is a <code>String</code>, returns the first element found whose name is the parameter.
+
+
+=end
+  
+  def get_element(element)
+    if element.is_a?(Integer)
+      return self.elements[element]
+    elsif element.is_a?(String)
+      for elm in self.elements
+        return elm if elm.name == element
+      end
+    end
+  end
+  
+  def get_data(io) # :nodoc:
     check_signature(io)
     get_section_offsets(io)
     get_elements(io)
@@ -94,9 +156,10 @@ class NarcFile
     io.pos = @offsets[:btaf] + 0x8
     @elements = Array.new(io.read(4).unpack('V')[0]) do Narc::Element.new end
     io.pos = @offsets[:btnf] + 0x8
-    names = io.read(4).unpack('V')[0] == 0x00000004 ? false : true
+    names = io.read(4).unpack('V')[0] == 0x00000004 ? false : true                  # Check if the narc file has names
+    if names then get_names(io) end
     @elements.size.times do |i|
-      @elements[i].name = @name + "_" + "%04d" % i
+      @elements[i].name = i.to_s unless names
       io.pos = @offsets[:btaf] + 12 + i * 0x8
       elem_start, elem_end = io.read(8).unpack('V2')
       io.pos = @offsets[:gmif] + 0x8 + elem_start
@@ -105,6 +168,16 @@ class NarcFile
     end
   end
 
+  def get_names(io)
+    io.pos = @offsets[:btnf] + 0x10                                                # Start of filename data
+    i = 0
+    for element in self.elements
+      size = io.read(1).unpack('C')[0]
+      element.name = io.read(size)
+      i += 1
+    end
+  end
+  
   def write_narc_section(file)
     @offsets[:narc] = file.pos
     file.write(Narc::NarcSignature)                  # Signature
@@ -129,10 +202,31 @@ class NarcFile
     end
   end
 
-  def write_fntb_section(file)
+  def write_fntb_section(file, include_fntb)
     @offsets[:btnf] = file.pos
     file.write(Narc::FntbSignature)
-    file.write([0x10, 0x4, 0x10000].pack('V3'))
+    size = 0x10
+    if include_fntb
+      @size_offsets[:fntb] = file.pos
+      file.write([0x0, 0x8, 0x10000].pack('V3'))
+      for element in self.elements
+        elmname = element.name
+        namesize = elmname.length
+        size += namesize + 1
+        file.write([namesize].pack('C'))
+        file.write(elmname)
+      end
+      until size % 4 == 0
+        file.write([0x0].pack('C'))
+        size += 1
+      end
+      temp = file.pos
+      file.pos = @size_offsets[:fntb]
+      file.write([size].pack('V'))
+      file.pos = temp
+    else
+      file.write([0x10, 0x4, 0x10000].pack('V3'))
+    end
   end
 
   def write_fimg_section(file)
@@ -158,7 +252,7 @@ class NarcFile
     file.write([filesize].pack('V'))
     file.pos = @size_offsets[:fatb]
     file.write([0x8 + 0x4 + (self.elements.size * 8)].pack('V'))
-
+    # FNTB size was already written in the write_fntb_section method
     fimgsize = get_fimg_size(file)
     file.pos = @size_offsets[:fimg]
     file.write([fimgsize].pack('V'))

data/lib/narc/cli.rb

@@ -15,10 +15,27 @@ narc -c <input folder> <narc file>
     file> is absent, the name of the narc file will be the same as the input 
     folder name.
 
+ Options:
+ n (only used with the -c parameter): Creates a narc file with named elements.
+
+Examples:
+
+narc -x n.narc
+    Extracts the contents of n.narc to a folder named "ex_n" (because no folder
+      name was specified)
+
+narc -c folder 1.narc
+    Creates a file named "1.narc" (with unnamed elements) with the contents in
+    "folder". 
+
+narc -cn folder 1.narc
+    Creates a file named "1.narc" (with named elements) with the contents in
+    "folder".
+
 DOC
 
 module Narc
-  class CLI
+  class CLI # :nodoc:
     def initialize(args)
       @args = args
       process_cmds
@@ -47,6 +64,15 @@ module Narc
         narc = NarcFile.from_folder(@args[1])
         narc.save(@args[2])
         puts "Narc file was created successfully."
+      when '-cn'
+        unless @args[1]
+          puts "You must provide the path of the folder as argument." 
+          return
+        end
+        puts "Creating narc file..."
+        narc = NarcFile.from_folder(@args[1])
+        narc.save(@args[2], true)
+        puts "Narc file was created successfully."
       end
     end
   end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: narc
 version: !ruby/object:Gem::Version
-  version: 0.0.0
+  version: 1.0.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-08-08 00:00:00.000000000Z
+date: 2011-08-10 00:00:00.000000000Z
 dependencies: []
 description: This gem provides a simple API for packing/unpacking NARC (Nitro ARChive)
   files, an archive file format commonly used in Nintendo DS games. It also counts
@@ -20,7 +20,9 @@ executables:
 extensions: []
 extra_rdoc_files:
 - README
+- LICENSE
 files:
+- LICENSE
 - README
 - Rakefile
 - bin/narc