data-writer 0.9.2 → 1.0

data/README.md

@@ -49,14 +49,16 @@ require 'data-writer'
 
 appender = DATAWriter.file("a")
 appender.write " my dear Watson"
-appender.close  # DATA.read => "Elementary my dear Watson"
+appender.close
+
+DATA.read # => "Elementary my dear Watson"
 
 __END__
 Elementary
 ```
 
 If this method is called and DATA is not defined then it will raise a DATANotFoundError exception.
-The file objects returned by this method have their #rewind method changed so that it seeks back to
+The file objects returned by this method have their __#rewind__ method changed so that it seeks back to
 the start of DATA, and not back to the start of the file.
 
 

data/data-writer.gemspec

@@ -1,16 +1,16 @@
 Gem::Specification.new do |s|
-  s.name        	= 'data-writer'
-  s.version     	= '0.9.2'
-  s.date        	= '2012-07-30'
-  s.summary     	= "Allows you to write to DATA"
-  s.description 	= "Normally you can only read from DATA but with data-writer you can also write to it. This allows you to easily persist data in a source file."
-  s.authors     	= ["Kalle Lindstrom"]
-  s.email       	= ["lindstrom.kalle@gmail.com"]
-  s.homepage    	= "https://github.com/kl/data-writer"
-  s.files       	= %w[lib/data-writer.rb README.md data-writer.gemspec Gemfile]
+  s.name          = 'data-writer'
+  s.version       = '1.0'
+  s.date          = '2012-08-01'
+  s.summary       = "Allows you to write to DATA"
+  s.description   = "Normally you can only read from DATA but with data-writer you can also write to it. This allows you to easily persist data in a source file."
+  s.authors       = ["Kalle Lindstrom"]
+  s.email         = ["lindstrom.kalle@gmail.com"]
+  s.homepage      = "https://github.com/kl/data-writer"
+  s.files         = %w[lib/data-writer.rb README.md data-writer.gemspec Gemfile]
   s.require_paths = ['lib']
-  s.has_rdoc 		  = false
+  s.has_rdoc      = false
 
   s.add_development_dependency('rake')
   s.add_development_dependency('minitest')
-end
+end

data/lib/data-writer.rb

@@ -4,20 +4,12 @@ class DATAWriter
 
   class DATANotFoundError < StandardError; end
 
-  #
-  # The position in the file where DATA starts (line after __END__)
-  #
-  def self.data_start_pos
-    @data_start_pos
-  end
-  
   #
   # Factory method for DATA writers. Works simliar to File.new.
   # mode can be both a string like "w" or a number like File::WRONLY
   #
   def self.file(mode, opt={})
-    check_DATA_defined  # raises an exception if DATA is not defined.
-    data_path = File.expand_path(DATA.path)
+    raise_data_not_found unless Object.const_defined?(:DATA)
 
     if mode.is_a?(String)
       valid_mode = get_valid_string_mode(mode)
@@ -25,11 +17,9 @@ class DATAWriter
       valid_mode = get_valid_int_mode(mode)
     end
 
-    file = create_file(data_path, valid_mode, opt)
-
-    @data_start_pos = scan_data_pos
-    file.pos = @data_start_pos        # sets the file pos to the line after __END__.
-    enhanced = enhance_file(file)     # adds specialized methods for this object.
+    file = create_file(get_source_path, valid_mode, opt)
+    file.pos = get_data_pos                                 # sets the file pos to the line after __END__.
+    enhanced = enhance_file(file)                           # adds specialized methods for this object.
 
     if block_given?
       yield(enhanced)
@@ -39,18 +29,34 @@ class DATAWriter
     end
   end
 
+  #
+  # Get the path of the source file.
+  #
+  def self.get_source_path
+    File.expand_path($0)
+  end
+  private_class_method :get_source_path
+
+  #
+  # Returns the position of __END__ in the source file.
+  #
+  def self.get_data_pos
+    if RUBY_PLATFORM =~ /java/i
+      scan_data_pos
+    else
+      DATA.pos
+    end
+  end
+  private_class_method :get_data_pos
+
   #
   # If "w" was specifed as a mode we need to remove that (because it will truncate the whole file)
   # 
   def self.get_valid_string_mode(mode)
     if mode =~ /w/
-      clear_end               # truncate after __END__ only.
-      if mode.include?("+")
-        mode.sub!("w", "r")
-      else
-        mode.sub!("w", "r+")
-      end
-      mode
+      trunc_end                                       # truncate after __END__.
+      sub_with = mode.include?("+") ? "r" : "r+"      # the actual mode will be "r+"
+      mode.sub("w", sub_with)
     else
       mode
     end
@@ -62,7 +68,7 @@ class DATAWriter
   #
   def self.get_valid_int_mode(mode)
     if (mode & File::TRUNC) == File::TRUNC        # mode includes TRUNC
-      clear_end                                   # truncate after __END__ only.
+      trunc_end                                   # truncate after __END__.
       valid_mode = 0
       File::Constants.constants.each do |const|   # build new mode excluding TRUNC
         value = File::const_get(const)
@@ -78,6 +84,17 @@ class DATAWriter
   end
   private_class_method :get_valid_int_mode
 
+  #
+  # Deletes everything after __END__. This is used to simulate the "w" permission mode.
+  #
+  def self.trunc_end
+    file_content = File.read(get_source_path)
+    new_content = file_content[/.+?^__END__$/m] + "\n"    # everything up to and including __END__.
+
+    File.open(get_source_path, "w") { |f| f.write(new_content) }
+  end
+  private_class_method :trunc_end
+
   #
   # Helper method to create a file that works in both 1.8 and 1.9 and different implementations.
   #
@@ -86,16 +103,14 @@ class DATAWriter
 
     if RUBY_PLATFORM =~ /java/i
       if ruby >= "1.9.3"
-        opt = {:encoding => __ENCODING__}.merge(opt)   # Make sure the IO encoding is the same as the source encoding.
-        File.new(path, mode_string, opt)               # Only JRuby 1.7 seem to implement this method the 1.9 way.
+        File.new(path, mode_string, opt_with_encoding(opt))   # Only JRuby 1.7 seem to implement this method the 1.9 way.
       else
         File.new(path, mode_string)
       end
 
     else
       if ruby >= "1.9.0"
-        opt = {:encoding => __ENCODING__}.merge(opt)
-        File.new(path, mode_string, opt)
+        File.new(path, mode_string, opt_with_encoding(opt))
       else
         File.new(path, mode_string)
       end
@@ -104,59 +119,53 @@ class DATAWriter
   private_class_method :create_file
 
   #
-  # Deletes everything after __END__. This is used to simulate the "w" permission mode.
+  # Returns a new options hash that has it's :encoding key set to the source file encoding.
   #
-  def self.clear_end
-    file_path = File.expand_path(DATA.path)
-    file_content = File.read(file_path)
-    new_content = file_content[/.+?^__END__$/m] + "\n"    # everything up to an including __END__.
-
-    File.open(file_path, "w") { |f| f.write(new_content) }
+  def self.opt_with_encoding(opt)
+    {:encoding => __ENCODING__}.merge(opt)
   end
-  private_class_method :clear_end
+  private_class_method :opt_with_encoding
 
   #
-  # Finds the position in the file after __END__. DATA.pos isn't used because of
-  # problems when opening the file in "w" mode.
+  # Finds the position in the file after __END__ (same as DATA.pos)
+  # This method is only used by JRuby since DATA.pos does not work in JRuby.
   #
   def self.scan_data_pos
-    source_file = File.new(File.expand_path($0))
+    source_file = File.new(get_source_path)
 
     until source_file.eof?
       line = source_file.gets
-      if line =~ /^^__END__$/
+      if line =~ /^__END__$/
         pos = source_file.pos
         source_file.close
         return pos
       end
     end
     source_file.close
-    raise DATANotFoundError, "DATA object does not exist. Ensure that the file has __END__"
+    raise_data_not_found
   end
   private_class_method :scan_data_pos
 
   #
   # Adds specialized methods to the DATA writer object.
   #
-  def self.enhance_file(object)
+  def self.enhance_file(file)
 
-    def object.rewind   # so that #rewind will go back to __END__ and not the beginning of the file.
-      self.pos = DATAWriter.data_start_pos
+    file.instance_variable_set(:@DATA_pos, file.pos)
+
+    def file.rewind   # so that #rewind will go back to __END__ and not the beginning of the file.
+      self.pos = @DATA_pos
     end
 
-    object
+    file
   end
   private_class_method :enhance_file
 
   #
-  # Raises a DATANotFoundError exception if DATA is not defined.
+  # Raises a DATANotFoundError exception.
   #
-  def self.check_DATA_defined
-    begin
-      DATA
-    rescue NameError
-      raise DATANotFoundError, "DATA object does not exist. Ensure that the file has __END__"
-    end
+  def self.raise_data_not_found
+    raise DATANotFoundError, "DATA object does not exist. Ensure that the file has __END__"
   end
-  private_class_method :check_DATA_defined
+  private_class_method :raise_data_not_found
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: data-writer
 version: !ruby/object:Gem::Version
-  version: 0.9.2
+  version: '1.0'
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-07-30 00:00:00.000000000 Z
+date: 2012-08-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake